Update SDK with new endpoints for triggers #15385

jverce · 2025-01-23T20:19:50Z

Changelog

Add new methods to manipulate deployed Connect triggers
Document the new methods (JSDoc only)
Bump minor version

WHY

So that the new endpoints in our API are available via the SDK.

Summary by CodeRabbit

Release Notes for @pipedream/sdk v1.2.0

New Features
- Enhanced trigger management capabilities
- Added methods for retrieving, updating, and deleting triggers
- Expanded support for trigger-related operations like workflow and webhook management
Improvements
- Introduced new type definitions for more robust event and trigger handling
- Increased flexibility in request parameter management
Version Update
- SDK version bumped from 1.1.6 to 1.2.0

* Add new methods to manipulate deployed Connect triggers * Document the new methods (JSDoc only) * Bump minor version

vercel · 2025-01-23T20:19:58Z

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Jan 23, 2025 9:18pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jan 23, 2025 9:18pm

vercel · 2025-01-23T20:19:59Z

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2025-01-23T20:20:00Z

Warning

Rate limit exceeded

@jverce has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 23 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d9eb9e1 and 97c48f2.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (2)

packages/sdk/CHANGELOG.md (1 hunks)
packages/sdk/src/shared/index.ts (4 hunks)

Walkthrough

This pull request introduces significant enhancements to the Pipedream SDK, focusing on expanding trigger management capabilities. The changes include adding new type definitions and methods in the SDK's shared components, specifically introducing comprehensive trigger-related operations. The package version has been bumped from 1.1.6 to 1.2.0, reflecting the substantial functional improvements.

Changes

File	Change Summary
`packages/sdk/package.json`	Version updated from `1.1.6` to `1.2.0`
`packages/sdk/src/shared/component.ts`	Added `V1EmittedEvent` type definition for event structures
`packages/sdk/src/shared/index.ts`	- Added multiple trigger-related types and methods - Expanded `BaseClient` with trigger management methods - Modified `RequestOptions` to allow `null` values

Sequence Diagram

sequenceDiagram
    participant Client
    participant SDK
    participant TriggerService
    
    Client->>SDK: getTriggers()
    SDK->>TriggerService: Request trigger list
    TriggerService-->>SDK: Return trigger details
    SDK-->>Client: Provide trigger information

    Client->>SDK: updateTriggerWorkflows()
    SDK->>TriggerService: Update trigger workflows
    TriggerService-->>SDK: Confirm update
    SDK-->>Client: Return update result

Possibly related PRs

Abstract OAuth implementation in the SDK #13983: SDK package.json version update from 0.0.13 to 0.1.0
Backend request improvements #14642: SDK package.json version bump from 1.0.1 to 1.0.2
Amend the Component API methods in the SDK #14883: SDK package.json version change from 1.0.10 to 1.1.0

Suggested labels

pd-api

Suggested reviewers

dylburger

Poem

🐰 Triggers dance, SDK leaps high,
New methods bloom across the sky,
Version one-point-two takes flight,
Empowering workflows with delight!
Code rabbit hops with pure glee 🚀

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

🪧 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. (Beta)
@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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (4)

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

651-652: Correct the grammatical error in JSDoc for workflowIds.

The comment should read: "The workflow IDs that should receive events emitted by the trigger."

679-680: Correct the grammatical error in JSDoc for webhookUrls.

The comment should read: "The webhook URLs that should receive events emitted by the trigger."

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

116-116: Consider specifying a more precise type for the event payload e.

Defining e as Record<string, any> reduces type safety. If the structure of the event payload is known, consider defining a specific interface or type for e to enhance type checking and maintainability.

121-121: Use a literal type for k if its value is constant.

If k is always "emit", you can define it as a literal type k: "emit"; to improve type safety and clarity.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c1ae19 and d9eb9e1.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (3)

packages/sdk/package.json (1 hunks)
packages/sdk/src/shared/component.ts (1 hunks)
packages/sdk/src/shared/index.ts (4 hunks)

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

packages/sdk/package.json

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

GitHub Check: pnpm publish

packages/sdk/src/shared/index.ts

Co-authored-by: Danny Roosevelt <[email protected]>

Update SDK with new endpoints for triggers

d9eb9e1

* Add new methods to manipulate deployed Connect triggers * Document the new methods (JSDoc only) * Bump minor version

jverce added enhancement New feature or request docs javascript Pull requests that update Javascript code tracked internally Issue is also tracked in our internal issue tracker prioritized Prioritized issue labels Jan 23, 2025

jverce self-assigned this Jan 23, 2025

coderabbitai bot reviewed Jan 23, 2025

View reviewed changes

packages/sdk/src/shared/index.ts Show resolved Hide resolved

dannyroosevelt reviewed Jan 23, 2025

View reviewed changes

packages/sdk/src/shared/index.ts Outdated Show resolved Hide resolved

dannyroosevelt previously approved these changes Jan 23, 2025

View reviewed changes

packages/sdk/src/shared/index.ts Outdated Show resolved Hide resolved

Apply suggestions from Danny

7968c67

Co-authored-by: Danny Roosevelt <[email protected]>

jverce dismissed dannyroosevelt’s stale review via 7968c67 January 23, 2025 21:11

jverce and others added 3 commits January 23, 2025 13:12

Merge branch 'master' into jay/dj-2824-update-sdk

e683e08

Update changelog

824ff21

Merge branch 'master' into jay/dj-2824-update-sdk

97c48f2

jsendo approved these changes Jan 23, 2025

View reviewed changes

jverce merged commit 29d795a into PipedreamHQ:master Jan 23, 2025
9 of 10 checks passed

jverce deleted the jay/dj-2824-update-sdk branch January 23, 2025 23:00

coderabbitai bot mentioned this pull request Jan 24, 2025

Update docs for the components API #15387

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update SDK with new endpoints for triggers #15385

Update SDK with new endpoints for triggers #15385

Uh oh!

jverce commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jan 23, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jan 23, 2025

Uh oh!

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Update SDK with new endpoints for triggers #15385

Update SDK with new endpoints for triggers #15385

Uh oh!

Conversation

jverce commented Jan 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

WHY

Summary by CodeRabbit

Release Notes for @pipedream/sdk v1.2.0

Uh oh!

vercel bot commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jan 23, 2025

Uh oh!

coderabbitai bot commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jverce commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jan 23, 2025 •

edited

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)