Skip to content

Conversation

@jverce
Copy link
Contributor

@jverce jverce commented Jan 6, 2025

Description

This change fixes the following issues from the SDK v1.1.3: https://publint.dev/@pipedream/[email protected]

Summary by CodeRabbit

  • Chores
    • Updated SDK package version to 1.1.4
    • Added commonjs type configuration
    • Updated TypeScript type definitions for server and browser exports

This change fixes the following issues from the SDK v1.1.3:
https://publint.dev/@pipedream/[email protected]
@jverce jverce added bug Something isn't working dependencies Pull requests that update a dependency file teams request Request from a Teams customer javascript Pull requests that update Javascript code tracked internally Issue is also tracked in our internal issue tracker prioritized Prioritized issue user request labels Jan 6, 2025
@jverce jverce self-assigned this Jan 6, 2025
@vercel
Copy link

vercel bot commented Jan 6, 2025

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Jan 6, 2025

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

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jan 6, 2025 10:21pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Walkthrough

This pull request involves updates to the @pipedream/sdk package's package.json file. The changes include incrementing the package version from 1.1.3 to 1.1.4, adding the type field with commonjs value, and modifying the exports section to include explicit types entries for server and browser paths. These modifications aim to improve the package's type definition and module resolution configuration.

Changes

File Change Summary
packages/sdk/package.json - Version bumped from 1.1.3 to 1.1.4
- Added "type": "commonjs"
- Updated exports section with new types entries for server and browser paths

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • dylburger

Poem

🐰 A rabbit's tale of SDK delight,
Version bumped with type-safe might,
Exports refined, paths now clear,
TypeScript dancing without fear,
Package magic, version takes flight! 📦✨


📜 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 af6dda5 and 1ea5525.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • packages/sdk/package.json (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test
  • GitHub Check: pnpm publish
  • GitHub Check: Lint Code Base
🔇 Additional comments (2)
packages/sdk/package.json (2)

3-3: LGTM! Version bump and module type declaration look good.

  • Version bump to 1.1.4 follows semver for fixes
  • Adding "type": "commonjs" explicitly declares the module system, which is good practice

Also applies to: 5-5


15-15: LGTM! Exports configuration properly declares TypeScript types.

The explicit types entries in the exports map will help resolve TypeScript definitions correctly for both server and browser environments.

Let's verify the TypeScript definition files exist in the correct locations after build:

Also applies to: 17-17, 20-20, 22-22

✅ Verification successful

✓ Types configuration is valid and matches source structure

The types entries in exports map correctly align with the TypeScript source files:

  • ./dist/server/server/index.d.ts will be generated from src/server/index.ts
  • ./dist/browser/browser/index.d.ts will be generated from src/browser/index.ts
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the TypeScript definition files exist in the correct locations
# after running the build script

# Check if the .d.ts files exist in the expected locations
fd -e d.ts -p \
  "dist/server/server/index.d.ts" \
  "dist/browser/browser/index.d.ts" \
  --max-depth 4

Length of output: 210


Script:

#!/bin/bash
# Check for TypeScript source files and build configuration
echo "=== Searching for source files ==="
fd -e ts -e tsx server/index browser/index

echo -e "\n=== Checking build configuration ==="
fd tsconfig.json
cat $(fd tsconfig.json)

echo -e "\n=== Checking package structure ==="
fd -t f -d 1 . packages/sdk/

Length of output: 71314


Script:

#!/bin/bash
# Check source files and package structure in packages/sdk
echo "=== Checking source files ==="
fd -t f . packages/sdk/src/

echo -e "\n=== Checking package.json configuration ==="
cat packages/sdk/package.json

Length of output: 2350


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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@jverce jverce closed this Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code prioritized Prioritized issue teams request Request from a Teams customer tracked internally Issue is also tracked in our internal issue tracker user request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant