feat(sdk): support query option for the configureComponent method

[js07]

Summary by CodeRabbit

• New Features

  • Enhanced component configurations to support API-based searches with an optional query parameter.

• Chores

  • Updated the release version to 1.5.0, with corresponding changelog adjustments.

[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)			Apr 8, 2025 7:55pm
pipedream-docs	⬜️ Ignored (Inspect)			Apr 8, 2025 7:55pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Apr 8, 2025 7:55pm

[coderabbitai]

Walkthrough

This update bumps the SDK version from 1.4.0 to 1.5.0 and introduces support for an optional query parameter in the configureComponent method. The changes include a new changelog entry, a version update in the package file, and modifications to the shared type definitions and method implementation, allowing API calls to incorporate dynamic query inputs.

Changes

File(s)	Change Summary
packages/sdk/CHANGELOG.md, packages/sdk/package.json	Updated version information to 1.5.0 with a new release entry detailing the added query option in the configureComponent method.
packages/sdk/.../index.ts	Added optional query?: string to ConfigureComponentOpts and updated the configureComponent method to include the query property in the request payload.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SDK
    participant API
    Client->>SDK: Call configureComponent(opts) with optional query
    SDK->>API: POST /components/configure { query: opts.query, ... }
    API-->>SDK: Return configuration response
    SDK-->>Client: Deliver configuration results

Loading

Poem

I’m a rabbit with a joyful hop,
In the realm of code, I never stop.
A query now joins the lively dance,
Bringing new features at every glance.
Version 1.5.0 makes the garden bloom,
Hop along in bytes—let’s all zoom! 🐇✨
Enjoy the magic in every room!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/sdk/src/shared/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d637019 and 4f85881.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (3)

• packages/sdk/CHANGELOG.md (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/src/shared/index.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: pnpm publish

🔇 Additional comments (4)

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

397-401: Good addition of the query parameter!

The new query property is well-documented and properly typed as an optional string. The JSDoc comment clearly explains its purpose for use with APIs that return items based on a query or search parameter.

---

1235-1236: Implementation correctly integrates the new query parameter

The new query property is properly added to the request body construction, maintaining consistency with the existing code pattern.

packages/sdk/CHANGELOG.md (1)

5-11: Well-formatted changelog entry

The changelog entry properly follows the established format and clearly describes the new feature. This helps users understand what's changed in this version.

packages/sdk/package.json (1)

4-4: Version number correctly updated

The version has been properly incremented from 1.4.0 to 1.5.0, which matches the changelog entry and reflects the addition of a new feature.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.