[YomiCasual]

Summary

Final release of @runware/sdk-js (v1.3.3) before the package is deprecated and this repository is archived in favour of @runware/sdk (runware-typescript).

Jira: RUN-12934

Decision (Slack thread, Ian Lunn / Abiodun Onisade / Sebastian Dugudae): archive rather than maintain, but ship the dependency bumps first so users who have not migrated are not left on vulnerable dependencies. End of life date: 2027-01-31.

Changes

• Deprecation notice in readme.md: red CAUTION block with the end-of-life date and a link to the migration section.
• Migration notes: new "Migrating to @runware/sdk" section in readme.md (before/after example plus a method mapping table), derived from the TypeScript SDK docs. No migration notes existed anywhere else.
• Version 1.3.2 → 1.3.3 (final). package-lock.json regenerated on top of the merged dependency bumps; it differs from main only by the version lines.
• prepublishOnly: npm run build so a publish can never ship a stale dist/.
• WebSocket payload fix: serializeWebsocketMessage strips the SDK-only skipResponse and additionalProperties fields before they reach the wire (Runware/Runware-base.ts, Runware/Runware-server.ts), with a unit test in tests/Runware/connection/websocket-payload.test.ts.
• Changelog entry for v1.3.3 in readme.md.

Already merged to main ahead of this PR: #58 (ws 8.18.0 → 8.21.3) and #59 (uuid ^9.0.1 → ^11.1.1, the last uuid line with a CommonJS build).

Verification

• npm run lint: clean (only pre-existing errors in the gitignored tests/script.ts).
• npx vitest run tests/Runware/connection/websocket-payload.test.ts tests/Runware/retry: 6/6 pass. The other test files need a real API_KEY and fail in CI on every branch, including main; that is not a regression from this PR.
• npm run build: ESM + CJS + types build.
• npm pack --dry-run: 8 files, dist/*, package.json, readme.md only.
• require("./dist/index.cjs") and import("./dist/index.js") both load and resolve uuid 11.1.1.
• npm audit --omit=dev: 0 vulnerabilities. npm ls ws uuid: 8.21.3 / 11.1.1.

Release checklist (after this PR is merged, in this order)

1. Publish v1.3.3 to npm

Owner: whoever holds publish rights on @runware/sdk-js. Requires npm login first.

• git checkout main && git pull --ff-only && npm ci
• npm whoami (confirm the account has publish rights)
• npm publish (prepublishOnly runs the build)
• npm dist-tag add @runware/sdk-js@1.3.3 beta (so @beta no longer resolves to 1.3.2-beta.1)
• npm view @runware/sdk-js version dist-tags shows latest: 1.3.3, beta: 1.3.3

2. Tag and GitHub release

• git tag v1.3.3 && git push origin v1.3.3
• gh release create v1.3.3 --title "v1.3.3 (final release)" --notes-file <changelog excerpt>

3. Deprecate the package on npm

This single command puts the red "deprecated" banner on npmjs.com and prints npm WARN deprecated on every install, which covers both "update the deprecation notice" and "warning on npm install" from the ticket. Deprecate all versions, including 1.3.3, otherwise the version everyone installs stays silent.

• Run:

  npm deprecate "@runware/sdk-js@*" "@runware/sdk-js is deprecated and reaches end of life on 2027-01-31; it receives no further updates. Migrate to @runware/sdk (npm install @runware/sdk). Migration notes: https://github.com/Runware/sdk-js#migrating-to-runwaresdk"

• npm view @runware/sdk-js deprecated returns the message

• In a scratch directory, npm init -y && npm i @runware/sdk-js prints the npm WARN deprecated line

• Undo if the wording needs changing: npm deprecate "@runware/sdk-js@*" ""

4. Notify internal consumers

These repos still depend on @runware/sdk-js and will start seeing the install warning. Comment on RUN-12934 with the migration link so their owners are not surprised:

• Runware/fe-playground
• Runware/runware.ai-website
• Runware/incubator
• Runware/dash-v0
• Runware/fastsd3.runware.ai-website

Archiving does not block them: the npm package stays installable, only the GitHub repo becomes read-only.

5. Archive the repository (last step)

Needs an org admin on Runware/sdk-js. Do this only after everything above is done, because an archived repo rejects pushes.

• Confirm no open PRs or branches are still needed (remaining open PRs Make functions more type aware #24, Update with new funcitionalities #32, Update feature page link 404 error #33, Fix retry logic #43, Add sentry to sdk, Fix zombie connection and dry run #54 are stale and conflicting; close them with a note pointing to @runware/sdk)
• gh repo archive Runware/sdk-js -y (or Settings → Danger Zone → Archive this repository)
• Update RUN-12934: tick all tasks, move to Done

If a regression in 1.3.3 surfaces after archiving

Unarchive → fix → publish 1.3.4 → re-run the deprecate command → re-archive.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. To trigger a review, include coderabbit-review in the PR description. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 8401706f-d38c-4e4b-b894-6ab3ae9fef48

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

[Copilot]

🟡 Changes recommended

The migration table contains an invalid task type and misrepresents skipResponse behavior.

2 open findings

• Use the replacement SDK's correct ControlNet task type · New
• Clarify that skipResponse has no direct SDK equivalent · New

What changed in this PR

Prepares the final @runware/sdk-js release and guides users toward @runware/sdk.

Changes:

• Adds deprecation and migration guidance.
• Removes SDK-only fields from WebSocket payloads with test coverage.
• Bumps version and builds automatically before publishing.

File	Description
Runware/​Runware-base.ts	Sanitizes WebSocket payloads.
Runware/​Runware-server.ts	Uses shared payload serialization.
tests/​Runware/​connection/​websocket-payload.test.ts	Tests payload sanitization.
readme.md	Adds deprecation, migration, and changelog notes.
package.json	Bumps version and adds prepublish build.
package-lock.json	Synchronizes package version.

🧠 Review effort: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.