[PR #147] [MERGED] docs(changelog): cut 0.3.0, and put two entries back where they belong #150

New issue

Closed

opened 2026-10-31 22:05:02 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:05:02 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/147
Author: @mattmillerai
Created: 9/14/2026
Status: ✅ Merged
Merged: 9/14/2026
Merged by: @mattmillerai

Base: main ← Head: matt/cut-0.3.0

📝 Commits (1)

c92dc9e docs(changelog): cut 0.3.0, and put two entries back where they belong

📊 Changes

1 file changed (+51 additions, -26 deletions)

View changed files

📝 CHANGELOG.md (+51 -26)

📄 Description

ELI-5

Everything under ## [Unreleased] moves under a ## [0.3.0] - 2026-09-14 heading, so the next GitHub Release (tag v0.3.0) has a matching changelog section. Nothing else changes — the version is injected from the tag at publish time, so package.json stays a placeholder per CONTRIBUTING.md.

Two entries also get put back where they belong on the way through, which is the part worth a look.

The 0.2.0 section is wrong on `main` today

#133's changelog entries — queued model delivery, and routerErrors.errorFromCompletion — are filed under the already-released ## [0.2.0] - 2026-09-10 heading rather than under ## [Unreleased]. That branch was cut before the 0.2.0 heading existed, so the hunk applied at the same line offset and landed one section too low. Nothing catches this: the changelog has no gate.

The published 0.2.0 does not contain that surface —

$ git ls-tree v0.2.0 --name-only src/sdk/ | grep modelRequests
(nothing)

— so the released section currently advertises an API that tag cannot run. Moved into 0.3.0, which is where the code actually ships.

#138 shipped with no entry at all

comfy.models.schema() and comfy.models.list() are the SDK's only way to ask Router what it runs and what each model takes, plus twelve new exports. Written up now, including the note that neither method exists in the Python SDK yet.

What ships in 0.3.0

comfy.models.submit / subscribe / handle — queued model delivery, with RequestHandle and routerErrors.errorFromCompletion (#133)
comfy.models.schema() and comfy.models.list() — Router model discovery (#138)
A binary 200 from models.run returns bytes instead of throwing unexpected_response — the ElevenLabs audio models were unusable before it (#139)
models.run caps the response body it will buffer, with maxBytes / DEFAULT_MAX_RESPONSE_BYTES (#145)

Why 0.3.0 rather than 0.2.1

The release carries a declared breaking type change: RunResult is now a discriminated union, so existing code needs a result.kind === "json" narrowing before data is the supplied TData again. The runtime shape of a JSON result only gains kind, so callers that do not typecheck against it keep working — but the types break, and the changelog says so under Changed.

Edit the heading in this PR if a different number is preferred.

Verification

pnpm format:check — clean (oxfmt formats Markdown, so a docs-only change can fail the test job)
node scripts/check-public-repo-hygiene.mjs — clean
The 0.2.0, 0.1.9 and older sections are otherwise byte-identical; the only lines that leave 0.2.0 are the two that were never its own.

Provenance

Authored by: Claude Code, from a "are we ready to cut a release?" check that turned up the misfiling.
Follow-up, not in this PR: #146 is stale — the kind: "json" fix it carries already landed via #138, main typechecks green at 5aeed3a, and its branch is ~2,600 lines behind. It should be closed rather than merged.

🤖 Generated with Claude Code

Summary by CodeRabbit

New Features
- Added model discovery capabilities for listing available models and retrieving model schemas.
- Added support for configurable model discovery options and standardized result types.
- Added queued model delivery APIs.
Improvements
- Added clearer completion error mapping.
- Documented response-size limits.
Documentation
- Updated the changelog with the 0.3.0 release details.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-typescript-sdk/pull/147 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 9/14/2026 **Status:** ✅ Merged **Merged:** 9/14/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `matt/cut-0.3.0` --- ### 📝 Commits (1) - [`c92dc9e`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/c92dc9e50242168576a1a77a890f78274b7647c4) docs(changelog): cut 0.3.0, and put two entries back where they belong ### 📊 Changes **1 file changed** (+51 additions, -26 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+51 -26) </details> ### 📄 Description ## ELI-5 Everything under `## [Unreleased]` moves under a `## [0.3.0] - 2026-09-14` heading, so the next GitHub Release (tag `v0.3.0`) has a matching changelog section. Nothing else changes — the version is injected from the tag at publish time, so `package.json` stays a placeholder per CONTRIBUTING.md. Two entries also get put back where they belong on the way through, which is the part worth a look. ## The 0.2.0 section is wrong on `main` today #133's changelog entries — queued model delivery, and `routerErrors.errorFromCompletion` — are filed under the already-released `## [0.2.0] - 2026-09-10` heading rather than under `## [Unreleased]`. That branch was cut before the 0.2.0 heading existed, so the hunk applied at the same line offset and landed one section too low. Nothing catches this: the changelog has no gate. The published 0.2.0 does not contain that surface — ``` $ git ls-tree v0.2.0 --name-only src/sdk/ | grep modelRequests (nothing) ``` — so the released section currently advertises an API that tag cannot run. Moved into 0.3.0, which is where the code actually ships. ## #138 shipped with no entry at all `comfy.models.schema()` and `comfy.models.list()` are the SDK's only way to ask Router what it runs and what each model takes, plus twelve new exports. Written up now, including the note that neither method exists in the Python SDK yet. ## What ships in 0.3.0 - `comfy.models.submit` / `subscribe` / `handle` — queued model delivery, with `RequestHandle` and `routerErrors.errorFromCompletion` (#133) - `comfy.models.schema()` and `comfy.models.list()` — Router model discovery (#138) - A binary `200` from `models.run` returns bytes instead of throwing `unexpected_response` — the ElevenLabs audio models were unusable before it (#139) - `models.run` caps the response body it will buffer, with `maxBytes` / `DEFAULT_MAX_RESPONSE_BYTES` (#145) ## Why 0.3.0 rather than 0.2.1 The release carries a declared breaking type change: `RunResult` is now a discriminated union, so existing code needs a `result.kind === "json"` narrowing before `data` is the supplied `TData` again. The runtime shape of a JSON result only gains `kind`, so callers that do not typecheck against it keep working — but the types break, and the changelog says so under **Changed**. Edit the heading in this PR if a different number is preferred. ## Verification - `pnpm format:check` — clean (`oxfmt` formats Markdown, so a docs-only change can fail the `test` job) - `node scripts/check-public-repo-hygiene.mjs` — clean - The 0.2.0, 0.1.9 and older sections are otherwise byte-identical; the only lines that leave 0.2.0 are the two that were never its own. ## Provenance - **Authored by:** Claude Code, from a "are we ready to cut a release?" check that turned up the misfiling. - **Follow-up, not in this PR:** #146 is stale — the `kind: "json"` fix it carries already landed via #138, `main` typechecks green at `5aeed3a`, and its branch is ~2,600 lines behind. It should be closed rather than merged. 🤖 Generated with [Claude Code](https://claude.com/claude-code)  ## Summary by CodeRabbit - **New Features** - Added model discovery capabilities for listing available models and retrieving model schemas. - Added support for configurable model discovery options and standardized result types. - Added queued model delivery APIs. - **Improvements** - Added clearer completion error mapping. - Documented response-size limits. - **Documentation** - Updated the changelog with the 0.3.0 release details.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:05:02 +00:00