Sdk support for private connect component listing #16867

danhsiung · 2025-05-28T16:42:13Z

WHY

Summary by CodeRabbit

New Features
- Added the ability to filter apps and components by private connect status when retrieving lists and performing actions.
Chores
- Updated the SDK package version to 1.6.4.

coderabbitai · 2025-05-28T16:42:23Z

Walkthrough

The update introduces an optional privateConnect boolean parameter to multiple option types and extends BaseClient methods (getApps, getComponents, getComponentWithOpts, configureComponent, runAction) to include this parameter in API requests. The package version in package.json is incremented from "1.6.3" to "1.6.4".

Changes

File(s)	Change Summary
packages/sdk/package.json	Incremented version from "1.6.3" to "1.6.4".
packages/sdk/src/shared/index.ts	Added optional `privateConnect` to multiple option types; added new type `GetComponentOpts2`; added new method `getComponentWithOpts`; updated `BaseClient` methods to handle `private_connect` query parameter.

Sequence Diagram(s)

sequenceDiagram
    participant Client as BaseClient
    participant API as Remote API

    Client->>API: getApps({ privateConnect })
    alt privateConnect defined
        API-->>Client: Returns apps filtered by private_connect (1 or 0)
    else
        API-->>Client: Returns all apps
    end

    Client->>API: getComponents({ privateConnect })
    alt privateConnect defined
        API-->>Client: Returns components filtered by private_connect (1 or 0)
    else
        API-->>Client: Returns all components
    end

    Client->>API: getComponentWithOpts({ key, privateConnect })
    alt privateConnect defined
        API-->>Client: Returns component filtered by private_connect (1 or 0)
    else
        API-->>Client: Returns component
    end

    Client->>API: configureComponent({ ..., privateConnect })
    Client->>API: runAction({ ..., privateConnect })

Poem

A hop and a skip, a version anew,
With privateConnect, more filtering to do!
Apps and components, now easy to find,
Whether public or private, all neatly aligned.
SDK grows stronger—oh what a delight,
The code rabbits cheer as they code through the night! 🐇✨

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 Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170: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 e55d8a6 and 3a32d62.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

packages/sdk/src/shared/index.ts

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

GitHub Check: pnpm publish

✨ 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

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

vercel · 2025-05-28T16:42:28Z

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

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview	May 29, 2025 10:45pm
pipedream-docs	⬜️ Ignored (Inspect)		May 29, 2025 10:45pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)		May 29, 2025 10:45pm

Dan Hsiung added 2 commits May 28, 2025 09:14

sdk support for listing private connect enabled components

dfe7184

pnpm lock

e55d8a6

Dan Hsiung added 2 commits May 29, 2025 15:42

enable more sdk calls for private connect use cases

5a70d0e

pnpm-lock

3a32d62

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sdk support for private connect component listing #16867

Sdk support for private connect component listing #16867

Uh oh!

danhsiung commented May 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 28, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

vercel bot commented May 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Sdk support for private connect component listing #16867

Are you sure you want to change the base?

Sdk support for private connect component listing #16867

Uh oh!

Conversation

danhsiung commented May 28, 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!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

danhsiung commented May 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented May 28, 2025 •

edited

Loading