Skip to content

feat(sdk): add configuredProps arg to updateTrigger method #16490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 6, 2025

Conversation

js07
Copy link
Contributor

@js07 js07 commented Apr 30, 2025

WHY

The API now supports updating a deployed trigger's configured props.

Summary by CodeRabbit

  • Documentation

    • Updated the changelog to reflect version 1.6.0 and recent improvements.
  • New Features

    • Enhanced trigger update functionality with support for configurable properties.
  • Refactor

    • Improved the accuracy of trigger update responses and refined property type definitions.

@js07 js07 added enhancement New feature or request javascript Pull requests that update Javascript code labels Apr 30, 2025
Copy link

vercel bot commented Apr 30, 2025

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) Visit Preview Apr 30, 2025 6:57pm
pipedream-docs ⬜️ Ignored (Inspect) Apr 30, 2025 6:57pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Apr 30, 2025 6:57pm

Copy link
Contributor

coderabbitai bot commented Apr 30, 2025

Walkthrough

The changes introduce version 1.6.0 of the SDK, updating both the changelog and package metadata. The main functional update is the extension of the updateTrigger method in the SDK: it now accepts an additional optional argument, configuredProps, and its return type has been corrected to GetTriggerResponse. The relevant type definitions and method signatures have been updated accordingly to reflect these changes.

Changes

File(s) Change Summary
packages/sdk/CHANGELOG.md Added entry for version 1.6.0, documenting the new configuredProps argument and corrected return type.
packages/sdk/package.json Updated package version from 1.5.5 to 1.6.0.
packages/sdk/src/shared/index.ts Changed ConfigureComponentContext type from any to unknown; extended UpdateTriggerOpts with optional configuredProps; updated updateTrigger method signature and return type.

Poem

A hop, a skip, a version jump—
The SDK now sports a shiny bump!
With configuredProps in the trigger’s call,
And return types tidied for one and all.
Rabbits rejoice in orderly code,
As 1.6.0 hops down the road!
🐇✨


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
🪧 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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
packages/sdk/CHANGELOG.md (3)

7-10: Enhance “Added” entry clarity
The “Added” subsection correctly highlights the new configuredProps argument for updateTrigger. To improve traceability, consider appending the PR number or issue link (e.g. (#16490)) so consumers can quickly locate the implementation details.


13-13: Specify original and new return types
The bullet “Corrected the return type of updateTrigger” is concise but could be more informative. You might list the previous type (V1DeployedComponent) and the new type (GetTriggerResponse) to give readers immediate context.


14-15: Grammar: pluralize “type” to “types”
In “Changed the type of property values of ConfigureComponentContext…”, pluralizing type to types better reflects that multiple property-value types are affected.

🧰 Tools
🪛 LanguageTool

[grammar] ~14-~14: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ... type of updateTrigger. - Changed the type of property values of ConfigureComponentContext from e...

(TYPE_OF_PLURAL)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3d352e and 48354cf.

📒 Files selected for processing (1)
  • packages/sdk/CHANGELOG.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/sdk/CHANGELOG.md

[grammar] ~14-~14: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ... type of updateTrigger. - Changed the type of property values of ConfigureComponentContext from e...

(TYPE_OF_PLURAL)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Lint Code Base
  • GitHub Check: test
  • GitHub Check: pnpm publish
🔇 Additional comments (1)
packages/sdk/CHANGELOG.md (1)

5-6: Confirm version bump and date
The new section for 1.6.0 dated 2025-04-30 aligns with the package.json bump. Verify that this release date matches your CI/CD tag or GitHub release for consistency.

Copy link
Contributor

@jverce jverce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@js07 js07 merged commit d319472 into master May 6, 2025
12 checks passed
@js07 js07 deleted the feat/connect-update-trigger-props branch May 6, 2025 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants