diff --git a/.changeset/api-types-facade-docs.md b/.changeset/api-types-facade-docs.md deleted file mode 100644 index d202d70..0000000 --- a/.changeset/api-types-facade-docs.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -"unthrown": patch ---- - -Polish the generated API reference (comment-only): give the `Types`-section -aliases practical framing and examples (`OkView`/`ErrView`/`DefectView` note what -each guard narrows to; `OkOf`/`ErrOf`/`AsyncOkOf`/`AsyncErrOf` show a type-extraction -example), and group the `Result`/`AsyncResult` **type** aliases under the `Facade` -category alongside their companion objects, cross-linked so the value+type pairing -is clear. diff --git a/.changeset/docs-beginner-friendly.md b/.changeset/docs-beginner-friendly.md deleted file mode 100644 index 3b1d751..0000000 --- a/.changeset/docs-beginner-friendly.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -"unthrown": patch ---- - -Improve the generated API reference: add `@category` grouping (Constructors, -Guards, Interop, Aggregate, Tagged errors, Facade, Types, …) to every exported -symbol, and give the standalone functions richer, convention-following `@example` -blocks (both Ok and Err branches, `// =>` output comments). Comment-only — no -runtime or type changes. diff --git a/.changeset/document-combinator-surface.md b/.changeset/document-combinator-surface.md deleted file mode 100644 index c9608bd..0000000 --- a/.changeset/document-combinator-surface.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -"unthrown": patch ---- - -Document the fluent combinators on the generated API reference. The method -surface every `Result` / `AsyncResult` carries is now exported as two -**documentation-only** types — `ResultMethods` (sync) and `AsyncResultMethods` -(async, with the `AsyncResult`/`Promise`-returning signatures) — categorized -under `Methods`, so the reference lists every combinator's signature and prose. -The `Result` / `AsyncResult` aliases and the `OkView`/`ErrView`/`DefectView` -variants link to them, and the async method docs link to their sync counterparts. -The "Choosing a combinator" guide stays the "which one do I reach for?" -cheat-sheet and links to these API sections. diff --git a/.changeset/fix-review-findings.md b/.changeset/fix-review-findings.md deleted file mode 100644 index e06ed4a..0000000 --- a/.changeset/fix-review-findings.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -"unthrown": patch ---- - -Fixes from a whole-repo review: - -- **`unthrown`** — `TaggedError` now reserves `name`: a payload field named `name` - can no longer shadow the display label (it was silently clobbered at runtime - while the instance type still promised it). `name` is excluded from the payload - type, consistent with how `_tag` is authoritative. -- **`@unthrown/vitest`** — the matchers now reject a foreign `Result`-like object - (e.g. a neverthrow/Boxed result) via core's canonical `isResult` instead of a - loose `isOk`-duck-type, so such a value fails clearly as "not an unthrown - Result" rather than being mistaken for an `Err`. -- **`@unthrown/oxlint`** — `no-ambiguous-error-type` resolves a bare `Error` - through scope analysis, so a locally-declared `type Error` or a generic - `` parameter is no longer a false positive. -- **`@unthrown/standard-schema`** — async-schema detection uses a structural - thenable check instead of `instanceof Promise`, so a promise from another realm - (vm/worker) is correctly caught instead of silently producing `Ok(undefined)`. diff --git a/packages/boxed/CHANGELOG.md b/packages/boxed/CHANGELOG.md index e46082e..d489dc8 100644 --- a/packages/boxed/CHANGELOG.md +++ b/packages/boxed/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/boxed +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/boxed/package.json b/packages/boxed/package.json index c95deb5..b293830 100644 --- a/packages/boxed/package.json +++ b/packages/boxed/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/boxed", - "version": "3.0.1", + "version": "3.0.2", "description": "Boxed interop for unthrown", "keywords": [ "boxed", diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index 76fe19e..b00beeb 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,46 @@ # unthrown +## 3.0.2 + +### Patch Changes + +- 199c543: Polish the generated API reference (comment-only): give the `Types`-section + aliases practical framing and examples (`OkView`/`ErrView`/`DefectView` note what + each guard narrows to; `OkOf`/`ErrOf`/`AsyncOkOf`/`AsyncErrOf` show a type-extraction + example), and group the `Result`/`AsyncResult` **type** aliases under the `Facade` + category alongside their companion objects, cross-linked so the value+type pairing + is clear. +- 4b6754a: Improve the generated API reference: add `@category` grouping (Constructors, + Guards, Interop, Aggregate, Tagged errors, Facade, Types, …) to every exported + symbol, and give the standalone functions richer, convention-following `@example` + blocks (both Ok and Err branches, `// =>` output comments). Comment-only — no + runtime or type changes. +- 3fb471b: Document the fluent combinators on the generated API reference. The method + surface every `Result` / `AsyncResult` carries is now exported as two + **documentation-only** types — `ResultMethods` (sync) and `AsyncResultMethods` + (async, with the `AsyncResult`/`Promise`-returning signatures) — categorized + under `Methods`, so the reference lists every combinator's signature and prose. + The `Result` / `AsyncResult` aliases and the `OkView`/`ErrView`/`DefectView` + variants link to them, and the async method docs link to their sync counterparts. + The "Choosing a combinator" guide stays the "which one do I reach for?" + cheat-sheet and links to these API sections. +- 52997b3: Fixes from a whole-repo review: + + - **`unthrown`** — `TaggedError` now reserves `name`: a payload field named `name` + can no longer shadow the display label (it was silently clobbered at runtime + while the instance type still promised it). `name` is excluded from the payload + type, consistent with how `_tag` is authoritative. + - **`@unthrown/vitest`** — the matchers now reject a foreign `Result`-like object + (e.g. a neverthrow/Boxed result) via core's canonical `isResult` instead of a + loose `isOk`-duck-type, so such a value fails clearly as "not an unthrown + Result" rather than being mistaken for an `Err`. + - **`@unthrown/oxlint`** — `no-ambiguous-error-type` resolves a bare `Error` + through scope analysis, so a locally-declared `type Error` or a generic + `` parameter is no longer a false positive. + - **`@unthrown/standard-schema`** — async-schema detection uses a structural + thenable check instead of `instanceof Promise`, so a promise from another realm + (vm/worker) is correctly caught instead of silently producing `Ok(undefined)`. + ## 3.0.1 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index 666ba2b..3d27ff4 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "unthrown", - "version": "3.0.1", + "version": "3.0.2", "description": "Explicit errors as values, with a separate defect (panic) channel", "keywords": [ "defect", diff --git a/packages/effect/CHANGELOG.md b/packages/effect/CHANGELOG.md index 4ab271a..4102a97 100644 --- a/packages/effect/CHANGELOG.md +++ b/packages/effect/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/effect +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/effect/package.json b/packages/effect/package.json index 9b8cd8e..8c29bc1 100644 --- a/packages/effect/package.json +++ b/packages/effect/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/effect", - "version": "3.0.1", + "version": "3.0.2", "description": "Effect interop for unthrown", "keywords": [ "effect", diff --git a/packages/neverthrow/CHANGELOG.md b/packages/neverthrow/CHANGELOG.md index d7e99fe..e410245 100644 --- a/packages/neverthrow/CHANGELOG.md +++ b/packages/neverthrow/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/neverthrow +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/neverthrow/package.json b/packages/neverthrow/package.json index 4c135ca..0cb3359 100644 --- a/packages/neverthrow/package.json +++ b/packages/neverthrow/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/neverthrow", - "version": "3.0.1", + "version": "3.0.2", "description": "neverthrow interop for unthrown", "keywords": [ "errors-as-values", diff --git a/packages/oxlint/CHANGELOG.md b/packages/oxlint/CHANGELOG.md index dcdd6f7..dd3da6a 100644 --- a/packages/oxlint/CHANGELOG.md +++ b/packages/oxlint/CHANGELOG.md @@ -1,5 +1,7 @@ # @unthrown/oxlint +## 3.0.2 + ## 3.0.1 ## 3.0.0 diff --git a/packages/oxlint/package.json b/packages/oxlint/package.json index c2c35b9..7b2fd68 100644 --- a/packages/oxlint/package.json +++ b/packages/oxlint/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/oxlint", - "version": "3.0.1", + "version": "3.0.2", "description": "oxlint plugin enforcing unthrown's conventions", "keywords": [ "errors-as-values", diff --git a/packages/pattern/CHANGELOG.md b/packages/pattern/CHANGELOG.md index 4c84edb..cda7614 100644 --- a/packages/pattern/CHANGELOG.md +++ b/packages/pattern/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/pattern +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/pattern/package.json b/packages/pattern/package.json index 92e2ac4..ef29b78 100644 --- a/packages/pattern/package.json +++ b/packages/pattern/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/pattern", - "version": "3.0.1", + "version": "3.0.2", "description": "ts-pattern integration for unthrown", "keywords": [ "errors-as-values", diff --git a/packages/standard-schema/CHANGELOG.md b/packages/standard-schema/CHANGELOG.md index 0c7a29b..2f0b239 100644 --- a/packages/standard-schema/CHANGELOG.md +++ b/packages/standard-schema/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/standard-schema +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/standard-schema/package.json b/packages/standard-schema/package.json index 1561c5f..20c01d0 100644 --- a/packages/standard-schema/package.json +++ b/packages/standard-schema/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/standard-schema", - "version": "3.0.1", + "version": "3.0.2", "description": "Standard Schema (Zod, Valibot, ArkType, …) interop for unthrown", "keywords": [ "arktype", diff --git a/packages/vitest/CHANGELOG.md b/packages/vitest/CHANGELOG.md index dfb5edb..ab913e2 100644 --- a/packages/vitest/CHANGELOG.md +++ b/packages/vitest/CHANGELOG.md @@ -1,5 +1,15 @@ # @unthrown/vitest +## 3.0.2 + +### Patch Changes + +- Updated dependencies [199c543] +- Updated dependencies [4b6754a] +- Updated dependencies [3fb471b] +- Updated dependencies [52997b3] + - unthrown@3.0.2 + ## 3.0.1 ### Patch Changes diff --git a/packages/vitest/package.json b/packages/vitest/package.json index d321a40..6f54c75 100644 --- a/packages/vitest/package.json +++ b/packages/vitest/package.json @@ -1,6 +1,6 @@ { "name": "@unthrown/vitest", - "version": "3.0.1", + "version": "3.0.2", "description": "Vitest matchers for unthrown", "keywords": [ "errors-as-values",