Fixing @pipedream/sdk imports

[dylburger]

Summary by CodeRabbit

Release Notes

• Documentation Updates
  • Updated Pipedream Connect API and SDK documentation to reflect the new SDK version and import paths.
  • Clarified usage of development and production environments, including OAuth client usage.
  • Enhanced migration guide for transitioning from project keys to OAuth authentication.
  • Improved instructions for running workflows, including error handling and testing guidelines.
  • Expanded details on API authentication methods, emphasizing OAuth and User API keys.
  • Added new sections on HTTP triggers and handling request data in workflow documentation.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Nov 22, 2024 4:54am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Nov 22, 2024 4:54am
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Nov 22, 2024 4:54am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant updates to the documentation for the Pipedream Connect API and SDK. Key changes include the updating of SDK import paths to specify server and browser contexts, along with a version change from 0.0.13 to 1.0.6. The documentation clarifies the support for development and production environments, emphasizes the use of OAuth for authentication, and provides updated examples for creating SDK clients and managing workflows. Overall, the updates ensure accurate guidance on SDK usage and environment configuration.

Changes

File Path	Change Summary
docs-v2/pages/connect/api.mdx	Updated SDK version in <script> tag to 1.0.6, modified import paths for createBackendClient and createFrontendClient.
docs-v2/pages/connect/environments.mdx	Clarified support for development and production environments, updated import path for createBackendClient.
docs-v2/pages/connect/migrating-from-project-keys-to-oauth.mdx	Documented migration from project keys to OAuth, introduced new methods and updated client creation methods.
docs-v2/pages/connect/quickstart.mdx	Added import for VideoPlayer, updated import paths for SDK clients to reflect server and browser contexts.
docs-v2/pages/connect/workflows.mdx	Enhanced instructions for running workflows, updated import paths for backend client usage.
docs-v2/pages/rest-api/auth.mdx	Clarified OAuth and User API keys usage, updated import path for createBackendClient.
docs-v2/pages/workflows/triggers.mdx	Added section on HTTP triggers, updated import path for createBackendClient and HTTPAuthType.

Possibly related PRs

• Abstract OAuth implementation in the SDK #13983: Enhances the SDK to handle OAuth client requests effectively, related to the OAuth changes in the main PR.
• Updating quickstart in docs based on apps UI  #13987: Updates quickstart documentation, aligning with the main PR's focus on SDK usage and import paths.
• Initial commit of workflow SDK / OAuth docs #14053: Introduces initial documentation for the workflow SDK and OAuth, relevant to the main PR's updates.
• Small bug fixes, refactors in workflow invocation based on Danny's tests #14054: Includes bug fixes and refactors in workflow invocation, relating to overall improvements in SDK documentation.
• Fixes DJ-2470 #14106: Addresses SDK changes impacting documentation structure, particularly for workflows and OAuth.
• (docs) Invoke workflows for external users #14589: Focuses on invoking workflows for external users, relevant to updates in the Connect API documentation.
• Require project environment in SDK #14679: Requires project environment in the SDK, pertinent to the emphasis on proper SDK usage.
• feat(sdk-package): call apis directly from client sdk #14699: Enhances SDK for direct API calls from the client SDK, related to updates on SDK documentation.
• Removing references to Apps tab #14713: Removes references to the Apps tab, potentially affecting clarity in user navigation in the main PR.

Suggested labels

enhancement, dependencies, pd-api, javascript, User submitted

Suggested reviewers

• jverce

🐇 In the meadow, we hop and play,
With SDK updates brightening our day!
OAuth now leads the way so clear,
For frontend and backend, have no fear!
Documentation shines, guiding us right,
Pipedream Connect, a joyful sight! 🌼

---

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

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