Je/dj 3281 update get components return type add ctok getter

[jsendo]

WHY

Summary by CodeRabbit

• New Features
  • Added a new property to access the raw token in the BrowserClient.
  • Component data responses now include configurable properties.
• Documentation
  • Updated the changelog to reflect new features in version 1.6.1.
• Chores
  • Incremented the SDK version to 1.6.1.

[linear]

DJ-3281 update Pipedream SDK types for getComponents to reflect configurable_props being returned, add method to get token from browser client

[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)			May 20, 2025 3:30pm
pipedream-docs	⬜️ Ignored (Inspect)			May 20, 2025 3:30pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			May 20, 2025 3:30pm

[coderabbitai]

Walkthrough

This update increments the SDK version to 1.6.1, introduces a new rawToken getter in the BrowserClient class, and modifies the GetComponentsResponse type to include the configurable_props property in its data array. Documentation and metadata are updated accordingly.

Changes

File(s)	Change Summary
packages/sdk/CHANGELOG.md	Added changelog entry for version 1.6.1, describing new getter and type definition update.
packages/sdk/package.json	Incremented package version from 1.6.0 to 1.6.1.
packages/sdk/src/browser/index.ts	Added public rawToken() getter to BrowserClient class.
packages/sdk/src/shared/index.ts	Updated GetComponentsResponse type to include configurable_props in V1Component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BrowserClient

    User->>BrowserClient: Access rawToken property
    BrowserClient-->>User: Return _token value or undefined

Loading

Poem

A hop, a skip, a version bump,
New tokens peek from out the stump.
Components now with props galore,
SDK 1.6.1 opens the door.
Changelog scribbled, code refined,
Another carrot for the code-inclined! 🥕

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/browser/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:163:49)

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:163:49)

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ab2aa4f and 2472db2.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (4)

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

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

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

• V1Component (131-138)

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

• GitHub Check: Lint Code Base
• GitHub Check: test
• GitHub Check: pnpm publish

🔇 Additional comments (4)

packages/sdk/package.json (1)

4-4: Version increment correctly reflects the new features.

The version bump from 1.6.0 to 1.6.1 follows semantic versioning principles, indicating a minor patch with backward-compatible additions.

packages/sdk/src/browser/index.ts (1)

201-208: Good addition of a token accessor method.

The implementation of the rawToken() getter method is clean and properly documented. This provides a way for consumers to access the current token when needed, which can be useful for integrations with other authentication systems.

packages/sdk/CHANGELOG.md (1)

5-14: Well-structured changelog entry.

The changelog entry properly documents both changes in this release - the new rawToken getter and the updated type definition for GetComponentsResponse. It follows the established format with appropriate categorization into "Added" and "Changed" sections.

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

531-531: Type definition correctly updated to include configurable_props.

The change to the GetComponentsResponse type ensures that the configurable_props property is included in the returned component data, aligning the type definition with the actual API response structure. This improves type safety for consumers of the SDK.

✨ 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.
  • 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.