Removing SDK package and updating README

[GTFalcao]

Summary by CodeRabbit

• Documentation
  • Added a top-note in the SDK README pointing users to the maintained repository.
• Removed
  • Deleted SDK examples, changelog, contributing guide, browser/server demos, build/test configs, workflows, and package manifest.
  • Removed SDK public API surface, TypeScript declarations, CLI, and tests.
• Breaking Changes
  • The SDK package and its published metadata are no longer present; related runtime, examples, and tooling have been removed.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
pipedream-docs	Ignored			Nov 21, 2025 5:16pm
pipedream-docs-redirect-do-not-edit	Ignored			Nov 21, 2025 5:16pm

[coderabbitai]

Walkthrough

Removed the SDK package contents: package manifest, build/test configs, TypeScript configs, browser/server entrypoints and clients, shared types/exports, examples, tests, scripts, CI workflows, ignore rules; added a README notice pointing to the pipedream-sdk-typescript repository.

Changes

Cohort / File(s)	Summary
Repository notice packages/sdk/README.md	Added a top-of-file note linking to the pipedream-sdk-typescript repository as the canonical maintenance location.
Package manifest & metadata packages/sdk/package.json, packages/sdk/CHANGELOG.md, packages/sdk/CONTRIBUTING.md, packages/sdk/.tool-versions	Deleted package.json, removed CHANGELOG.md and CONTRIBUTING.md, and removed the nodejs 22.10.0 entry from .tool-versions.
Build & bundler configs packages/sdk/tsup.browser.config.js, packages/sdk/tsup.server.cjs.config.js, packages/sdk/tsup.server.esm.config.js, packages/sdk/tsconfig.browser.json, packages/sdk/tsconfig.node.json, packages/sdk/jest.config.js	Removed tsup build configs (browser + server), TypeScript configs (browser + node), and the Jest configuration file.
Source: server-side implementation packages/sdk/src/server/index.ts, packages/sdk/src/server/cli.ts	Deleted server client implementation and CLI — removed BackendClient, createBackendClient, OAuth/token flows, API methods, types, and CLI commands.
Source: browser-side implementation packages/sdk/src/browser/index.ts, packages/sdk/src/version.ts	Deleted the browser entrypoint, browser client exports, and the exported version constant.
Shared types & index exports packages/sdk/src/shared/index.ts, packages/sdk/src/shared/component.ts, packages/sdk/src/shared/shims.d.ts	Removed the shared public API surface: types, interfaces, BaseClient and helpers, component prop typings, and global shims.
Examples & sample artifacts packages/sdk/examples/*, packages/sdk/examples/browser/index.html, packages/sdk/examples/browser/Makefile, packages/sdk/examples/server/index.mjs, packages/sdk/examples/server/Makefile	Deleted browser and server example files and removed Makefile targets.
Tests & scripts packages/sdk/src/server/__tests__/server.test.ts, packages/sdk/scripts/updateVersion.js	Removed the server test file and the version update script.
Ignore rules packages/sdk/.eslintignore, packages/sdk/.gitignore	Deleted .eslintignore; removed ignore patterns (dist, node_modules, *.env*) from .gitignore.
CI workflows .github/workflows/pipedream-sdk-markdown-lint.yaml, .github/workflows/pipedream-sdk-test.yaml	Deleted SDK-specific GitHub Actions workflows for markdown linting and tests.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45–90 minutes

Areas to focus review on:

• packages/sdk/src/shared/index.ts — large API surface removal; verify all downstream imports and type consumers.
• packages/sdk/src/server/index.ts and packages/sdk/src/browser/index.ts — removal of client implementations and OAuth/token flows; check consumers and runtime expectations.
• packages/sdk/package.json deletion — impacts publishing, package exports, and any CI/build references.
• Build and CI removals (tsup*, tsconfig.*, jest.config.js, workflows) — confirm repo-level build/CI handles package removal.
• Documentation deletions (CONTRIBUTING.md, CHANGELOG.md) and example removals — ensure information exists elsewhere if needed.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title 'Removing SDK package and updating README' is partially related but misleading. While the README was updated, the primary change is a massive removal of the entire SDK package (files, source code, configs), not just an update.	Revise the title to accurately reflect the main scope: 'Remove SDK package from monorepo' or similar, as the title should emphasize the primary change (removal) rather than suggesting a minor README update.
Description check	⚠️ Warning	The pull request description is empty. The template requires a 'WHY' section to explain the rationale for these substantial changes, but no description was provided by the author.	Add a comprehensive pull request description explaining why the entire SDK package is being removed from the monorepo, the impact on users, and any migration guidance or related changes.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch sdk-package-readme-update

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54f3f4f and 92eecdb.

📒 Files selected for processing (2)

• .github/workflows/pipedream-sdk-markdown-lint.yaml (0 hunks)
• .github/workflows/pipedream-sdk-test.yaml (0 hunks)

💤 Files with no reviewable changes (2)

• .github/workflows/pipedream-sdk-markdown-lint.yaml
• .github/workflows/pipedream-sdk-test.yaml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Lint Code Base

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f9a2f5 and 7e77002.

📒 Files selected for processing (1)

• packages/sdk/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-12-12T19:23:09.039Z

Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 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.

Applied to files:

• packages/sdk/README.md

🪛 GitHub Actions: Lint SDK Markdown Files

packages/sdk/README.md

[error] 1-1: markdownlint: MD013/line-length Line length [Expected: 80; Actual: 199]

🪛 GitHub Check: test

packages/sdk/README.md

[failure] 1-1: First line in a file should be a top-level heading
packages/sdk/README.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "Note: this package is now ..."] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md

---

[failure] 1-1: Line length
packages/sdk/README.md:1:81 MD013/line-length Line length [Expected: 80; Actual: 199] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e77002 and 97454ce.

📒 Files selected for processing (1)

• packages/sdk/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-12-12T19:23:09.039Z

Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 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.

Applied to files:

• packages/sdk/README.md

🪛 GitHub Actions: Lint SDK Markdown Files

packages/sdk/README.md

[error] 7-7: MD024/no-duplicate-heading: Multiple headings with the same content. Context: "@pipedream/sdk"

🪛 GitHub Check: test

packages/sdk/README.md

[failure] 7-7: Multiple top-level headings in the same document
packages/sdk/README.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "@pipedream/sdk"] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md025.md

---

[failure] 7-7: Multiple headings with the same content
packages/sdk/README.md:7 MD024/no-duplicate-heading Multiple headings with the same content [Context: "@pipedream/sdk"] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md024.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 97454ce and 7d26629.

📒 Files selected for processing (1)

• packages/sdk/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-12-12T19:23:09.039Z

Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 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.

Applied to files:

• packages/sdk/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Lint Code Base

🔇 Additional comments (1)

packages/sdk/README.md (1)

1-7: Structure and previous feedback correctly addressed.

The README now correctly places the H1 heading first (line 1), includes the blockquote note (lines 3–6) after a blank line, and contains no duplicate headings. This structure satisfies the MD041 linting requirement flagged in the previous review.

[coderabbitai]

🧹 Nitpick | 🔵 Trivial

Minor: Consider clarifying the pronoun in the note.

Line 5 reads "Visit that to view the most up-to-date code…", where "that" is a forward reference to the repository mentioned on line 4. This works, but could be marginally clearer as "Visit there to view" or "Visit that repository to view" for improved readability.

This is optional; the current wording is acceptable.

🤖 Prompt for AI Agents

packages/sdk/README.md lines 3-6: the pronoun "that" in "Visit that to view the
most up-to-date code…" is a bit ambiguous; change it to a clearer phrase such as
"there" or "that repository" so the sentence reads e.g. "Visit that repository
to view the most up-to-date code of the SDK." Ensure only the wording is
adjusted and punctuation remains correct.