add scope as an optional parameter to backendClient

[jsendo]

WHY

Summary by CodeRabbit

• New Features

  • Added support for specifying OAuth scopes when creating a backend client.

• Documentation

  • Updated changelog to reflect the new optional scope parameter and version bump to 1.7.0.

[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)	Visit Preview		Jul 3, 2025 10:56pm
pipedream-docs	⬜️ Ignored (Inspect)			Jul 3, 2025 10:56pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jul 3, 2025 10:56pm

[coderabbitai]

Walkthrough

The changes introduce an optional scope parameter to the BackendClientOpts type and update the BackendClient class to handle OAuth token requests with this scope. The changelog and package version are updated to reflect these changes, which allow specifying OAuth scopes and include additional parameters in token requests.

Changes

File(s)	Change Summary
packages/sdk/CHANGELOG.md	Added changelog entry for version 1.7.0, documenting the new optional scope parameter.
packages/sdk/package.json	Updated version from 1.6.11 to 1.7.0.
packages/sdk/src/server/index.ts	Added optional scope to BackendClientOpts and BackendClient; updated OAuth token request to use it and include project_id and environment.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BackendClient
    participant OAuthServer

    User->>BackendClient: Instantiate with BackendClientOpts (may include scope)
    BackendClient->>OAuthServer: Request access token (includes scope, project_id, environment)
    OAuthServer-->>BackendClient: Return access token
    BackendClient-->>User: Use access token for further operations

Loading

Poem

A rabbit hopped through SDK land,
With "scope" in its gentle paw,
Now tokens fetch with purpose grand,
Project, environment—ooh la la!
Changelog fresh, new version too,
1.7.0, we hop anew!
🐇✨

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/server/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:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202: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 eb08d0a and 07b88d9.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (3)

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

🧰 Additional context used

🧠 Learnings (1)

packages/sdk/package.json (1)

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

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

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

🔇 Additional comments (6)

packages/sdk/src/server/index.ts (4)

59-63: Well-implemented OAuth scope parameter.

The optional scope parameter follows OAuth 2.0 standards by accepting an array of strings. The type definition and documentation are clear and appropriate for the intended use case.

---

205-205: Property declaration is consistent.

The private scope property correctly matches the optional type definition from BackendClientOpts.

---

218-218: Constructor assignment is straightforward.

The assignment follows the established pattern used for other optional parameters in the constructor.

---

304-308: OAuth scope implementation follows standards.

The implementation correctly:

• Checks for scope existence and non-empty array
• Joins scopes with spaces (per OAuth 2.0 RFC)
• Includes project_id and environment parameters for context

The logic properly handles the optional nature of the scope parameter.

packages/sdk/CHANGELOG.md (1)

5-10: Changelog entry accurately documents the new feature.

The entry follows the established format and clearly describes the addition of the optional scope parameter to backendClient creation.

packages/sdk/package.json (1)

4-4: Appropriate version bump for new optional feature.

The minor version increment from 1.6.11 to 1.7.0 correctly reflects the addition of new optional functionality without breaking changes, following semantic versioning principles.

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