Add pagination parameters to component configuration #15233

bzwrk · 2025-01-08T23:30:24Z

WHY

Summary by CodeRabbit

Chores
- Updated SDK package version from 1.1.3 to 1.1.4
New Features
- Added optional pagination support to component configuration options
- Introduced new configuration properties for enhanced API request flexibility

linear · 2025-01-08T23:30:28Z

DJ-2787 Support pagination in async options API

vercel · 2025-01-08T23:30:29Z

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

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	❌ Failed (Inspect)			Jan 8, 2025 11:44pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Jan 8, 2025 11:44pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jan 8, 2025 11:44pm

coderabbitai · 2025-01-08T23:30:33Z

Walkthrough

This pull request introduces updates to the Pipedream SDK, specifically a version increment for the @pipedream/sdk package from 1.1.3 to 1.1.4. Additionally, it modifies the ConfigureComponentOpts type in the shared index file by adding two optional properties: page, a number for pagination, and prevContext, defined as never. These changes enhance the SDK's capability to handle pagination in component configuration requests.

Changes

File	Change Summary
`packages/sdk/package.json`	Version updated from `1.1.3` to `1.1.4`
`packages/sdk/src/shared/index.ts`	Added optional `page` (number) and `prevContext` (never) properties to `ConfigureComponentOpts` type

Possibly related PRs

Amend the Component API methods in the SDK #14883: This PR updates the package.json file for the @pipedream/sdk package, similar to the main PR, which also updates the version in the same file. Additionally, both PRs involve changes to the packages/sdk/src/shared/index.ts file, with the latter introducing new types and methods that enhance the API's functionality, which relates to the changes made in the main PR regarding the ConfigureComponentOpts type.

Suggested labels

enhancement, pd-api, tracked internally, prioritized

Suggested reviewers

dylburger

Poem

🐰 A SDK update hops along the way,
Version bumped with pagination's sway,
New options bloom like spring's first light,
Configuring components with technical might,
A rabbit's code dance, precise and bright! 🚀

Finishing Touches

📝 Generate Docstrings

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: 2

🔭 Outside diff range comments (1)

packages/sdk/src/shared/index.ts (1)
Line range hint 803-803: Fix ternary expression formatting to comply with linting rules.

The pipeline is failing due to a missing newline between the test and consequent of the ternary expression.

Apply this diff to fix the formatting:
-    const id = typeof componentId === "object" ? componentId.key : componentId;
+    const id = typeof componentId === "object"
+      ? componentId.key
+      : componentId;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7246f75 and 208a3fe.

📒 Files selected for processing (2)

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

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

packages/sdk/package.json

🧰 Additional context used

🪛 GitHub Actions: Pull Request Checks

packages/sdk/src/shared/index.ts

[error] 803-803: Expected newline between test and consequent of ternary expression (multiline-ternary)

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

GitHub Check: pnpm publish

coderabbitai

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 208a3fe and 381a5a2.

📒 Files selected for processing (1)

packages/sdk/src/shared/index.ts (3 hunks)

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

GitHub Check: Lint Code Base
GitHub Check: pnpm publish

packages/sdk/src/shared/index.ts

…tions-api

Add pagination parameters to component configuration

208a3fe

vercel bot had a problem deploying to Preview – docs-v2 January 8, 2025 23:30 Failure

Add pagination parameters to component configuration

b6fa1c0

coderabbitai bot reviewed Jan 8, 2025

View reviewed changes

Fix linter errors

381a5a2

vercel bot had a problem deploying to Preview – docs-v2 January 8, 2025 23:41 Failure

jverce approved these changes Jan 8, 2025

View reviewed changes

coderabbitai bot reviewed Jan 8, 2025

View reviewed changes

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

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

Merge branch 'master' into biz/dj-2787-support-pagination-in-async-op…

bdd09d9

…tions-api

vercel bot had a problem deploying to Preview – docs-v2 January 8, 2025 23:44 Failure

bzwrk merged commit 17e2fbe into master Jan 8, 2025
8 of 9 checks passed

bzwrk deleted the biz/dj-2787-support-pagination-in-async-options-api branch January 8, 2025 23:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add pagination parameters to component configuration #15233

Add pagination parameters to component configuration #15233

Uh oh!

bzwrk commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

linear bot commented Jan 8, 2025

Uh oh!

vercel bot commented Jan 8, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

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!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add pagination parameters to component configuration #15233

Add pagination parameters to component configuration #15233

Uh oh!

Conversation

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

Uh oh!

WHY

Summary by CodeRabbit

Uh oh!

linear bot commented Jan 8, 2025

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Finishing Touches

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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bzwrk commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jan 8, 2025 •

edited

Loading

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)