(docs) Adding unpkg

[dylburger]

WHY

Summary by CodeRabbit

• New Features
  • Enhanced installation instructions for the Pipedream TypeScript SDK, including npm installation and client-side loading via <script> tag.
  • Provided examples for both the latest version and specific version loading methods.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 19, 2024 3:51am
pipedream	❌ Failed (Inspect)			Sep 19, 2024 3:51am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs	⬜️ Ignored (Inspect)			Sep 19, 2024 3:51am
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Sep 19, 2024 3:51am

[coderabbitai]

Walkthrough

The changes made to the documentation enhance the installation instructions for the Pipedream TypeScript SDK. A new subheading for npm installation has been added, detailing the command to install the SDK. Additionally, instructions for loading the SDK using a <script> tag have been introduced, including examples for both the latest version and a specific version. These updates aim to improve clarity and accessibility for users.

Changes

Files	Change Summary
docs-v2/pages/connect/api.mdx	Added installation instructions for the TypeScript SDK via <script> tag and npm.

Poem

In the land of code, where rabbits hop,
The SDK now shines, it’s ready to pop!
With npm and scripts, so easy to see,
Installing with joy, as happy as can be.
Let’s code and create, in a world so bright,
With Pipedream’s magic, we’ll take flight! 🐇✨

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

docs-v2/pages/connect/api.mdx (1)

30-43: Recommend Adding Subresource Integrity (SRI) Attributes to <script> Tags for Enhanced Security

When loading scripts from a CDN, it's best practice to include integrity and crossorigin attributes to enable Subresource Integrity (SRI). This ensures the script hasn't been tampered with and protects users from potential attacks.

You can modify the <script> tags as follows:

-<script src="https://unpkg.com/@pipedream/sdk/dist/browser/index.js"></script>
+<script src="https://unpkg.com/@pipedream/sdk/dist/browser/index.js" integrity="sha384-..." crossorigin="anonymous"></script>

-<script src="https://unpkg.com/@pipedream/[email protected]/dist/browser/index.js"></script>
+<script src="https://unpkg.com/@pipedream/[email protected]/dist/browser/index.js" integrity="sha384-..." crossorigin="anonymous"></script>

Replace sha384-... with the actual integrity hash of the script. You can obtain the hash using a command like:

curl -s https://unpkg.com/@pipedream/sdk/dist/browser/index.js | openssl dgst -sha384 -binary | openssl base64 -A

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2a1c48 and 73274cc.

Files selected for processing (1)

• docs-v2/pages/connect/api.mdx (1 hunks)

Additional comments not posted (1)

docs-v2/pages/connect/api.mdx (1)

20-24: Clear Addition of npm Installation Instructions

The inclusion of npm installation instructions enhances the accessibility of the SDK for users preferring package managers.