fix(sdk+connect-react): string_options -> stringOptions

[tjk]

Summary by CodeRabbit

Release Notes

• New Features
  • Updated changelogs for connect-react and sdk packages to reflect recent changes and fixes.
• Bug Fixes
  • Corrected casing for stringOptions in various components and SDK responses for consistency.
  • Enhanced error handling in the RemoteOptionsContainer component for better user feedback.
• Documentation
  • Changelog entries now include detailed descriptions of changes across different versions.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)			Dec 5, 2024 11:10pm
pipedream-docs	⬜️ Ignored (Inspect)			Dec 5, 2024 11:10pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Dec 5, 2024 11:10pm

[coderabbitai]

Walkthrough

The changes in this pull request include updates to the connect-react and sdk packages. The connect-react package has a new changelog entry for version 1.0.0-preview.7, highlighting the adjustment of the stringOptions casing. The package.json for connect-react reflects a version bump and a change in the dependency specification for @pipedream/sdk. The sdk package also sees a version increment to 1.0.10 and updates to the ComponentConfigureResponse type, aligning property naming conventions. Error handling and query key structures in RemoteOptionsContainer have been refined.

Changes

File Path	Change Summary
packages/connect-react/CHANGELOG.md	Updated to include version 1.0.0-preview.7 with details on stringOptions casing adjustment.
packages/connect-react/package.json	Version updated from 1.0.0-preview.6 to 1.0.0-preview.7; dependency for @pipedream/sdk changed to workspace:^.
packages/connect-react/src/components/RemoteOptionsContainer.tsx	Updated string_options to stringOptions; enhanced error handling; clarified queryKeyInput structure.
packages/sdk/CHANGELOG.md	Added entry for version 1.0.10 detailing the correction of stringOptions casing.
packages/sdk/package.json	Version updated from 1.0.9 to 1.0.10; no other changes.
packages/sdk/src/shared/index.ts	Renamed string_options to stringOptions in ComponentConfigureResponse; updated return type for componentConfigure.

Possibly related PRs

• Backend request improvements #14642: This PR involves changes to the @pipedream/sdk package, specifically the deprecation of the environment_name field and the introduction of a fullResponse option, which relates to the handling of responses in the SDK.

Suggested labels

enhancement, pd-api, javascript, tracked internally, prioritized

Suggested reviewers

• dylburger
• GTFalcao

Poem

🐇 In the meadow where options bloom,
A change in casing dispels the gloom.
From string_options to stringOptions bright,
Our code now dances in clearer light.
With every update, we hop with glee,
Enhancements abound, as happy as can be! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 74a3ff3 and 89317f1.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (6)

• packages/connect-react/CHANGELOG.md (1 hunks)
• packages/connect-react/package.json (2 hunks)
• packages/connect-react/src/components/RemoteOptionsContainer.tsx (1 hunks)
• packages/sdk/CHANGELOG.md (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/src/shared/index.ts (2 hunks)

✅ Files skipped from review due to trivial changes (3)

• packages/sdk/package.json
• packages/sdk/CHANGELOG.md
• packages/connect-react/CHANGELOG.md

🔇 Additional comments (4)

packages/connect-react/package.json (1)

3-3: LGTM! Version bump and dependency update look good.

The version bump to 1.0.0-preview.7 is appropriate for the property naming change, and switching to a workspace dependency is a good practice in monorepos.

Also applies to: 30-30

packages/connect-react/src/components/RemoteOptionsContainer.tsx (1)

73-73: LGTM! Property destructuring updated correctly.

The destructuring of the response has been updated to use stringOptions instead of string_options, maintaining consistency with the SDK changes.

packages/sdk/src/shared/index.ts (2)

94-94: LGTM! Type definition updated correctly.

The property rename from string_options to stringOptions in ComponentConfigureResponse type maintains better consistency with JavaScript/TypeScript naming conventions.

---

583-583: Verify impact of breaking change.

The explicit return type ComponentConfigureResponse improves type clarity. However, since this renames a property from string_options to stringOptions, it's a breaking change that might affect consumers.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.