Compare commits
5
Commits
0.6.0
..
a8f1a05db2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a8f1a05db2 | ||
|
|
675fd0bb54 | ||
|
|
ce287b384f | ||
|
|
aaeeef1e11 | ||
|
|
3b5269f9e1 |
No files matched your search
+9
-1
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.7.0] - 2026-09-23
|
||||||
|
|
||||||
|
- reject broad universes (`string`, `number`, template literals) and
|
||||||
|
value/stringification collisions (`true | "true"`, `1 | "1"`) at the factory
|
||||||
|
- type handler parameters by the matched member, so a
|
||||||
|
standalone `"true"` universe is typed `"true"` rather than `true`
|
||||||
|
|
||||||
## [0.6.0] - 2026-09-22
|
## [0.6.0] - 2026-09-22
|
||||||
|
|
||||||
- add `getTaggedUnionMatcher` / `getTaggedUnionMatcherW` for discriminated unions
|
- add `getTaggedUnionMatcher` / `getTaggedUnionMatcherW` for discriminated unions
|
||||||
@@ -75,7 +82,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
- basic setup
|
- basic setup
|
||||||
|
|
||||||
[Unreleased]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.6.0...main
|
[Unreleased]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.7.0...main
|
||||||
|
[0.7.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.6.0...0.7.0
|
||||||
[0.6.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.5.0...0.6.0
|
[0.6.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.5.0...0.6.0
|
||||||
[0.5.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.4.0...0.5.0
|
[0.5.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.4.0...0.5.0
|
||||||
[0.4.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.3.0...0.4.0
|
[0.4.0]: https://gitea.e1nsnull.de/tmu/tiny-pattern-ts/compare/0.3.0...0.4.0
|
||||||
|
|||||||
@@ -25,10 +25,15 @@ Yet to be implemented
|
|||||||
|
|
||||||
## Caveats
|
## Caveats
|
||||||
|
|
||||||
- **A value and its stringification collide.** Object keys stringify, so a
|
- **Only finite universes are supported.** The factory must be given a finite
|
||||||
universe that mixes a member with the string it stringifies to — `1 | "1"`,
|
union of literals; `string`, `number` and template literals are rejected. This
|
||||||
`true | "true"`, `null | "null"` — collapses to a single handler key and both
|
is what lets the exhaustive overload be proven, so the runtime `dispatch`
|
||||||
members are routed to it. Use one form or the other.
|
throw stays unreachable through the typed API.
|
||||||
|
- **A value and its stringification must not both be present.** Object keys
|
||||||
|
stringify, so a universe containing both a member and the string it
|
||||||
|
stringifies to — `1 | "1"`, `true | "true"`, `null | "null"` — is rejected at
|
||||||
|
the factory. Either form alone is fine, and one value's string form may
|
||||||
|
coexist with a _different_ value's bare form (`"true" | false`).
|
||||||
- **`symbol` and `bigint` are not supported.** A `symbol` brand is a
|
- **`symbol` and `bigint` are not supported.** A `symbol` brand is a
|
||||||
compile-time phantom with nothing to match at runtime, and a `bigint` is not a
|
compile-time phantom with nothing to match at runtime, and a `bigint` is not a
|
||||||
valid property key; neither satisfies the matcher's universe constraint.
|
valid property key; neither satisfies the matcher's universe constraint.
|
||||||
|
|||||||
+6
-6
@@ -37,12 +37,12 @@ Testing:
|
|||||||
✔ Rewrite `src/util/__tests__/lsp-completion.ts` onto `createMessageConnection` and typed requests @done
|
✔ Rewrite `src/util/__tests__/lsp-completion.ts` onto `createMessageConnection` and typed requests @done
|
||||||
✔ Update `development/testing.md § Autocomplete` for the new client @done
|
✔ Update `development/testing.md § Autocomplete` for the new client @done
|
||||||
✔ Run `npm run verify` and check the task off @done
|
✔ Run `npm run verify` and check the task off @done
|
||||||
☐ Test a literal union widened with `(string & {})` — `"red" | "green" | "yellow" | (string & {})` @medium
|
✘ Test a literal union widened with `(string & {})` — `"red" | "green" | "yellow" | (string & {})` @medium @cancelled
|
||||||
→ autocomplete should still offer the literals; arbitrary strings stay assignable and fall through to the fallback
|
→ broad universes are rejected; the rejection is covered by the broad-universe gate tests
|
||||||
☐ Type hole when using broad types like string as a universe @high
|
✔ Type hole when using broad types like string as a universe @high @done
|
||||||
☐ handlers cannot be exhaustive, yet it is possible to not have a fallback
|
→ decided: broad universes are rejected at the factory, so the exhaustive overload can always be proven
|
||||||
☐ one test even exploits this, I think for a negative test
|
→ value/stringification collisions (`true | "true"`, `1 | "1"`) are rejected too; handler params are typed by `Member<T, K>`
|
||||||
☐ does the same type hole exist for tagged-union matchers or primitive-union matchers only?
|
→ see development/library.md § Supported universes
|
||||||
|
|
||||||
Matcher:
|
Matcher:
|
||||||
✔ Clean up: adopt the 3-overload matcher (`src/prototype-ac2.ts`) and delete the prototypes @high @done
|
✔ Clean up: adopt the 3-overload matcher (`src/prototype-ac2.ts`) and delete the prototypes @high @done
|
||||||
|
|||||||
+3
-1
@@ -43,7 +43,9 @@
|
|||||||
"silverwind",
|
"silverwind",
|
||||||
"idris",
|
"idris",
|
||||||
"todotasks",
|
"todotasks",
|
||||||
"connor"
|
"connor",
|
||||||
|
"injective",
|
||||||
|
"injectivity"
|
||||||
],
|
],
|
||||||
"ignorePaths": ["dist", "node_modules", "coverage", "*.svg", ".gitignore"]
|
"ignorePaths": ["dist", "node_modules", "coverage", "*.svg", ".gitignore"]
|
||||||
}
|
}
|
||||||
+79
-17
@@ -97,9 +97,11 @@ Each factory is two overloads whose order is load-bearing:
|
|||||||
|
|
||||||
#### Decision (2026-09)
|
#### Decision (2026-09)
|
||||||
|
|
||||||
`src/matcher-shared.ts` holds the seven universe-agnostic pieces both matchers
|
`src/matcher-shared.ts` holds the universe-agnostic pieces both matchers use:
|
||||||
use: `UnaryFn`, `PatternReturns`, `RedundantFallback`, `HandlerMap`, the shared
|
`UnaryFn`, `PatternReturns`, `RedundantFallback`, `HandlerMap`, the shared
|
||||||
`Matchable` universe, and the `PatternKey` / `PatternParam` key projection.
|
`Matchable` universe, the `PatternKey` key projection and its `Member` inverse,
|
||||||
|
and the `Stringified` / `Collisions` / `UnsupportedReason` / `UnsupportedUniverse`
|
||||||
|
/ `UniverseGate` universe gate.
|
||||||
|
|
||||||
#### Why
|
#### Why
|
||||||
|
|
||||||
@@ -118,8 +120,65 @@ use: `UnaryFn`, `PatternReturns`, `RedundantFallback`, `HandlerMap`, the shared
|
|||||||
`Fallback` and `MustBePartial`.** Each is built from its own universe
|
`Fallback` and `MustBePartial`.** Each is built from its own universe
|
||||||
(`Tags`/`MapTaggedUnion` vs the primitive values); abstracting over the
|
(`Tags`/`MapTaggedUnion` vs the primitive values); abstracting over the
|
||||||
F-bounded `Handled` constraint that makes the remainder work risks the
|
F-bounded `Handled` constraint that makes the remainder work risks the
|
||||||
contextual typing it exists to preserve. `Matchable` and the `PatternKey` /
|
contextual typing it exists to preserve. `Matchable`, the `PatternKey` /
|
||||||
`PatternParam` projection are the pieces both universes genuinely share.
|
`Member` projection and the `UniverseGate` are the pieces both universes
|
||||||
|
genuinely share.
|
||||||
|
|
||||||
|
## Supported universes
|
||||||
|
|
||||||
|
#### Decision (2026-09)
|
||||||
|
|
||||||
|
A universe must be a **finite union of literals** with **no
|
||||||
|
value/stringification collision**. Broad types (`string`, `number`, a template
|
||||||
|
literal) and `"true" | true` / `1 | "1"` are rejected; the factory intersects
|
||||||
|
`UniverseGate<T>` (the `UnsupportedUniverse<Reason>` diagnostic) into the
|
||||||
|
handler and fallback parameters. `Member<T, K>` replaces the `PatternParam<K>`
|
||||||
|
inversion: the handler parameter is the member(s) of `T` whose `PatternKey` is
|
||||||
|
`K`, so a standalone `"true"` is `"true"`, not `true`.
|
||||||
|
|
||||||
|
#### Why
|
||||||
|
|
||||||
|
- **`PatternKey` is not injective.** `"true"` and `true` (and `1` / `"1"`)
|
||||||
|
share a runtime key, so `PatternParam<K>` cannot recover the member.
|
||||||
|
`Member<T, K>` inverts against `T`, which is exact.
|
||||||
|
- **Broad types cannot be proven exhaustive.** An index-like map lets a partial
|
||||||
|
object satisfy the exhaustive overload and reaches the `dispatch` throw.
|
||||||
|
Rejecting at the boundary avoids threading an open/closed branch through
|
||||||
|
`Handlers`, `Fallback` and `MustBePartial`.
|
||||||
|
- **Collisions are rejected, not merged.** `Member<T, K>` would be sound (the
|
||||||
|
handler gets the union), but the API is one handler per member; rejecting
|
||||||
|
keeps `Member` a singleton and the remainder exact.
|
||||||
|
- **The collision predicate is type-checkable.** `Collisions<T> =
|
||||||
|
Extract<T, Stringified<T>>` catches numeric collisions too.
|
||||||
|
- **The gate is an intersection, not a branch,** so `R` inference and the popup
|
||||||
|
survive; a conditional parameter type would not.
|
||||||
|
|
||||||
|
#### Rejected
|
||||||
|
|
||||||
|
- **Open universes with a required fallback** (`fix/open-universe-*`): sound,
|
||||||
|
but left the collision hole and added an `IsLiteral` /
|
||||||
|
`OpenUniverseNeedsFallback` branch through every handler type. Findings, kept
|
||||||
|
so they are not re-run: `{}` satisfies an index signature (and `Exact` misses
|
||||||
|
it); an index signature dominates contextual typing; `R` infers only from a
|
||||||
|
non-self-referential parameter type (`{ [K in keyof H]: … R … }` gives
|
||||||
|
`unknown`); an F-bounded guard referencing `keyof Handled` in `Handled`'s own
|
||||||
|
constraint sees the constraint, not the map; all handlers share one `R` (only
|
||||||
|
the fallback widens it); `IsLiteral` is the finite-literal predicate.
|
||||||
|
- **`Member<T, K>` without the gate:** sound, but a colliding handler gets a
|
||||||
|
union and `1 | "1"` stays one runtime key.
|
||||||
|
- **A round-trip injectivity gate** (`IsEqual<T, PatternParam<PatternKey<T>>>`):
|
||||||
|
over-rejects standalone `"true"` / `"false"` / `"null"` / `"undefined"`.
|
||||||
|
- **A case-list / ts-pattern builder:** removes the collision class but drops
|
||||||
|
the object map (footprint, popup) and reimplements an existing library.
|
||||||
|
- **Normalize numeric keys to strings:** makes `PatternKey` injective but
|
||||||
|
changes "numeric keys stay numbers" and defeats the numeric dispatch fast
|
||||||
|
path.
|
||||||
|
|
||||||
|
#### Known issue
|
||||||
|
|
||||||
|
- A multi-collision universe lists every collision in the diagnostic.
|
||||||
|
- The `dispatch` throw is unreachable through the typed API; the throw tests
|
||||||
|
widen the factory to `Function` to reach it.
|
||||||
|
|
||||||
## Tagged-union matcher
|
## Tagged-union matcher
|
||||||
|
|
||||||
@@ -160,17 +219,19 @@ The key is a separate call because `K` is inferred from its literal argument and
|
|||||||
- **`MapTaggedUnion` distributes with `Extract`.** A duplicated tag yields a
|
- **`MapTaggedUnion` distributes with `Extract`.** A duplicated tag yields a
|
||||||
union of members instead of dropping one.
|
union of members instead of dropping one.
|
||||||
- **A `boolean` / `null` / `undefined` tag goes through the shared
|
- **A `boolean` / `null` / `undefined` tag goes through the shared
|
||||||
`PatternKey` / `PatternParam` projection.** `Discriminated` admits those tags
|
`PatternKey` / `Member` projection.** `Discriminated` admits those tags
|
||||||
(they are in `Tag`), but they cannot key a mapped type, so the handler map is
|
(they are in `Tag`), but they cannot key a mapped type, so the handler map is
|
||||||
keyed by the stringified form (`true` → `"true"`) and `PatternParam` inverts
|
keyed by the stringified form (`true` → `"true"`) and `Member` inverts it
|
||||||
it to recover the member. This is the same projection the primitive-union
|
against the tag set to recover the member. This is the same projection the
|
||||||
matcher uses over its universe, which is why it lives in `matcher-shared.ts`.
|
primitive-union matcher uses over its universe, which is why it lives in
|
||||||
|
`matcher-shared.ts`.
|
||||||
|
|
||||||
#### Known issue
|
#### Known issue
|
||||||
|
|
||||||
- A member's tag must be unique across the union; two members with the same tag
|
- A member's tag must be unique across the union; two members with the same tag
|
||||||
collapse to a union under one handler. The same holds for a tag colliding with
|
collapse to a union under one handler. A tag colliding with its
|
||||||
its stringification (`true | "true"`) — see [README § Caveats](../README.md#caveats).
|
stringification (`true | "true"`) is rejected by the universe gate — see
|
||||||
|
§ Supported universes.
|
||||||
|
|
||||||
## Primitive universe
|
## Primitive universe
|
||||||
|
|
||||||
@@ -180,11 +241,12 @@ The universe (`Matchable`) is `string | number | boolean | null | undefined`,
|
|||||||
with `boolean` admitted as `true | false`.
|
with `boolean` admitted as `true | false`.
|
||||||
|
|
||||||
`boolean`/`null`/`undefined` are not property keys, so handler-map keys are a
|
`boolean`/`null`/`undefined` are not property keys, so handler-map keys are a
|
||||||
projection (`PatternKey`: each member stringified) and `PatternParam` inverts
|
projection (`PatternKey`: each member stringified) and `Member` inverts it
|
||||||
it, so callbacks receive the real member (`true`, not `"true"`). The popup
|
against the universe, so callbacks receive the real member (`true`, not
|
||||||
offers `true`, `false`, `null`, `undefined` by name (verified over LSP). The
|
`"true"`; the standalone string `"true"` stays `"true"`). The popup offers
|
||||||
same projection is shared with the tagged-union matcher; see
|
`true`, `false`, `null`, `undefined` by name (verified over LSP). The same
|
||||||
§ Tagged-union matcher.
|
projection is shared with the tagged-union matcher; see § Tagged-union matcher.
|
||||||
|
The supported universes are constrained as described in § Supported universes.
|
||||||
|
|
||||||
#### Why
|
#### Why
|
||||||
|
|
||||||
@@ -194,5 +256,5 @@ same projection is shared with the tagged-union matcher; see
|
|||||||
`String()` defeats V8's numeric-key path: measured ~2× on number-keyed
|
`String()` defeats V8's numeric-key path: measured ~2× on number-keyed
|
||||||
dispatch).
|
dispatch).
|
||||||
- `symbol`/`bigint`/`NaN`/`-0` are rejected, and a member colliding with its
|
- `symbol`/`bigint`/`NaN`/`-0` are rejected, and a member colliding with its
|
||||||
stringification is unguarded: user-facing, stated once in
|
stringification is rejected by the gate: user-facing, stated once in
|
||||||
[README § Caveats](../README.md#caveats).
|
[README § Caveats](../README.md#caveats).
|
||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "tiny-pattern-ts",
|
"name": "tiny-pattern-ts",
|
||||||
"version": "0.6.0",
|
"version": "0.7.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "tiny-pattern-ts",
|
"name": "tiny-pattern-ts",
|
||||||
"version": "0.6.0",
|
"version": "0.7.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"type-fest": "^5.9.0"
|
"type-fest": "^5.9.0"
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "tiny-pattern-ts",
|
"name": "tiny-pattern-ts",
|
||||||
"version": "0.6.0",
|
"version": "0.7.0",
|
||||||
"description": "Pattern matching for TypeScript/ESM environments (F#-style, not regex)",
|
"description": "Pattern matching for TypeScript/ESM environments (F#-style, not regex)",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"adt",
|
"adt",
|
||||||
|
|||||||
+56
-15
@@ -1,4 +1,4 @@
|
|||||||
import type { ValueOf } from "type-fest";
|
import type { IsLiteral, IsNever, ValueOf } from "type-fest";
|
||||||
|
|
||||||
// The primitive-union and tagged-union matchers differ in their universe, but the
|
// The primitive-union and tagged-union matchers differ in their universe, but the
|
||||||
// handler/fallback plumbing is identical; these are the shared pieces. The
|
// handler/fallback plumbing is identical; these are the shared pieces. The
|
||||||
@@ -16,11 +16,11 @@ export type Matchable = string | number | boolean | null | undefined;
|
|||||||
|
|
||||||
// `boolean`, `null` and `undefined` cannot be property keys, so a mapped type
|
// `boolean`, `null` and `undefined` cannot be property keys, so a mapped type
|
||||||
// over a universe that includes one keys each such member by its
|
// over a universe that includes one keys each such member by its
|
||||||
// stringification. `PatternParam` inverts that projection, so a handler callback
|
// stringification. `Member` inverts that projection against the universe, so a
|
||||||
// still receives the *real* member (`true`, not `"true"`). Both matchers use the
|
// handler callback still receives the *real* member (`true`, not `"true"`).
|
||||||
// projection: the primitive-union matcher over its universe, the tagged-union
|
// Both matchers use the projection: the primitive-union matcher over its
|
||||||
// matcher over a discriminant property's values. See README § Caveats for the
|
// universe, the tagged-union matcher over a discriminant property's values. See
|
||||||
// limits.
|
// README § Caveats for the limits.
|
||||||
export type PatternKey<T> = T extends boolean
|
export type PatternKey<T> = T extends boolean
|
||||||
? T extends true
|
? T extends true
|
||||||
? "true"
|
? "true"
|
||||||
@@ -30,15 +30,56 @@ export type PatternKey<T> = T extends boolean
|
|||||||
: T extends undefined
|
: T extends undefined
|
||||||
? "undefined"
|
? "undefined"
|
||||||
: T;
|
: T;
|
||||||
export type PatternParam<K> = K extends "true"
|
|
||||||
? true
|
// The member(s) of `T` whose `PatternKey` is `K`: the universe-keyed inverse of
|
||||||
: K extends "false"
|
// `PatternKey`. The key alone cannot recover the member (`"true"` and `true`
|
||||||
? false
|
// share it), so the handler parameter is derived from `T` instead. For a
|
||||||
: K extends "null"
|
// supported (injective) universe the result is a single member.
|
||||||
? null
|
export type Member<
|
||||||
: K extends "undefined"
|
T extends Matchable,
|
||||||
? undefined
|
K extends PropertyKey,
|
||||||
: K;
|
> = T extends Matchable ? (PatternKey<T> extends K ? T : never) : never;
|
||||||
|
|
||||||
|
// The property key a `Matchable` member takes at runtime: booleans, `null` and
|
||||||
|
// `undefined` stringify, and a numeric literal becomes its decimal string.
|
||||||
|
export type Stringified<T> = T extends boolean
|
||||||
|
? T extends true
|
||||||
|
? "true"
|
||||||
|
: "false"
|
||||||
|
: T extends null
|
||||||
|
? "null"
|
||||||
|
: T extends undefined
|
||||||
|
? "undefined"
|
||||||
|
: T extends number
|
||||||
|
? `${T}`
|
||||||
|
: never;
|
||||||
|
|
||||||
|
// The members of `T` that are also the stringification of another member, so
|
||||||
|
// `PatternKey` cannot invert them. `never` means the universe is injective.
|
||||||
|
export type Collisions<T> = Extract<T, Stringified<T>>;
|
||||||
|
|
||||||
|
// Why `T` is not a supported universe, or `never` when it is. A supported
|
||||||
|
// universe is a finite union of literals with no value/stringification
|
||||||
|
// collision: only then can `PatternKey` be inverted unambiguously.
|
||||||
|
export type UnsupportedReason<T extends Matchable> =
|
||||||
|
IsLiteral<PatternKey<T>> extends false
|
||||||
|
? "broad types like string, number and template literals are not supported"
|
||||||
|
: [Collisions<T>] extends [never]
|
||||||
|
? never
|
||||||
|
: `a value and its stringification collide. Value is "${Collisions<T> & string}"`;
|
||||||
|
|
||||||
|
// The diagnostic for an unsupported universe. Extends `HandlerMap` so the
|
||||||
|
// implementation's `handlers: HandlerMap` stays assignable when the gate is
|
||||||
|
// intersected into a parameter; the property name is the message.
|
||||||
|
export type UnsupportedUniverse<Reason extends string> = HandlerMap &
|
||||||
|
Readonly<Record<`unsupported universe: ${Reason}`, never>>;
|
||||||
|
|
||||||
|
// `unknown` for a supported universe (an intersection no-op), the diagnostic
|
||||||
|
// otherwise. Intersecting rather than branching keeps `R` inference intact.
|
||||||
|
export type UniverseGate<T extends Matchable> =
|
||||||
|
IsNever<UnsupportedReason<T>> extends true
|
||||||
|
? unknown
|
||||||
|
: UnsupportedUniverse<UnsupportedReason<T>>;
|
||||||
|
|
||||||
// `Extract` drops optional handlers (`undefined`) so `PatternReturns` also works
|
// `Extract` drops optional handlers (`undefined`) so `PatternReturns` also works
|
||||||
// when `P`'s constraint has optional keys.
|
// when `P`'s constraint has optional keys.
|
||||||
|
|||||||
+391
-32
@@ -495,26 +495,392 @@ test("getPrimitiveUnionMatcher factory rejects non-exhaustive boolean and nullis
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("getPrimitiveUnionMatcher: an open universe keeps the fallback's remainder open", () => {
|
test("getPrimitiveUnionMatcher: a standalone stringified literal is typed by the member, not its key", () => {
|
||||||
|
// `"true"` is a string member whose `PatternKey` is `"true"`; inverting the
|
||||||
|
// key must recover the string, not the boolean that also stringifies to it.
|
||||||
// Arrange
|
// Arrange
|
||||||
const factory = getPrimitiveUnionMatcher<string>();
|
const factory = getPrimitiveUnionMatcher<"true" | "1">();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
const matcher = factory({ a: () => 1 }, (s) => {
|
const matcher = factory({
|
||||||
// The map's literal keys do not close an open universe, so the
|
true: (s) => {
|
||||||
// remainder stays `string` and the fallback is not redundant.
|
expectTypeOf(s).toEqualTypeOf<"true">();
|
||||||
expectTypeOf(s).toEqualTypeOf<string>();
|
assert.equal(s, "true");
|
||||||
// A strict pattern fixes one `R` for every handler, so this fallback
|
return 1;
|
||||||
// cannot return its shape; `typeof` is the strongest claim the value
|
},
|
||||||
// makes on its own — any string passes, including `""`.
|
"1": (s) => {
|
||||||
assert.equal(typeof s, "string");
|
expectTypeOf(s).toEqualTypeOf<"1">();
|
||||||
return 2 as const;
|
assert.equal(s, "1");
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
expectTypeOf(matcher).toEqualTypeOf<(shape: string) => number>();
|
assert.equal(matcher("true"), 1);
|
||||||
assert.equal(matcher("a"), 1);
|
assert.equal(matcher("1"), 2);
|
||||||
assert.equal(matcher("b"), 2);
|
});
|
||||||
|
|
||||||
|
test("getPrimitiveUnionMatcher: a broad universe is rejected", () => {
|
||||||
|
// Act / Assert — the calls below must not compile
|
||||||
|
// @ts-expect-error `string` is not a finite union of literals
|
||||||
|
getPrimitiveUnionMatcher<string>()({ a: () => 1 });
|
||||||
|
// @ts-expect-error `number` is not a finite union of literals
|
||||||
|
getPrimitiveUnionMatcher<number>()({ 1: () => 1 });
|
||||||
|
// @ts-expect-error a template literal is open
|
||||||
|
getPrimitiveUnionMatcher<`a${string}`>()({ a: () => 1 });
|
||||||
|
// @ts-expect-error `string | boolean` is open because of `string`
|
||||||
|
getPrimitiveUnionMatcher<string | boolean>()({ true: () => 1 });
|
||||||
|
// @ts-expect-error the widening factory rejects broad universes too
|
||||||
|
getPrimitiveUnionMatcherW<string>()({ a: () => 1 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getPrimitiveUnionMatcher: a value/stringification collision is rejected", () => {
|
||||||
|
// Act / Assert — the calls below must not compile
|
||||||
|
// @ts-expect-error `true` collides with the string `"true"`
|
||||||
|
getPrimitiveUnionMatcher<"true" | true>()({ true: () => 1 });
|
||||||
|
// @ts-expect-error `false` collides with the string `"false"`
|
||||||
|
getPrimitiveUnionMatcher<"false" | false>()({ false: () => 1 });
|
||||||
|
// @ts-expect-error `null` collides with the string `"null"`
|
||||||
|
getPrimitiveUnionMatcher<"null" | null>()({ null: () => 1 });
|
||||||
|
// @ts-expect-error `undefined` collides with the string `"undefined"`
|
||||||
|
getPrimitiveUnionMatcher<"undefined" | undefined>()({
|
||||||
|
undefined: () => 1,
|
||||||
|
});
|
||||||
|
// @ts-expect-error the number `1` collides with the string `"1"`
|
||||||
|
getPrimitiveUnionMatcher<1 | "1">()({ 1: () => 1 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getPrimitiveUnionMatcher: a collision is rejected beside legal members", () => {
|
||||||
|
// Act / Assert — the calls below must not compile; the legal members do not
|
||||||
|
// mask the collision. Each map is otherwise complete, so only the collision
|
||||||
|
// can make it invalid.
|
||||||
|
// @ts-expect-error `true` collides with `"true"` beside legal members
|
||||||
|
getPrimitiveUnionMatcher<"true" | true | "a" | 2>()({
|
||||||
|
true: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
2: () => 3,
|
||||||
|
});
|
||||||
|
// @ts-expect-error `false` collides with `"false"` beside legal members
|
||||||
|
getPrimitiveUnionMatcher<"false" | false | "a" | 2>()({
|
||||||
|
false: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
2: () => 3,
|
||||||
|
});
|
||||||
|
// @ts-expect-error `null` collides with `"null"` beside legal members
|
||||||
|
getPrimitiveUnionMatcher<"null" | null | "a" | 2>()({
|
||||||
|
null: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
2: () => 3,
|
||||||
|
});
|
||||||
|
// @ts-expect-error `undefined` collides with `"undefined"` beside legal members
|
||||||
|
getPrimitiveUnionMatcher<"undefined" | undefined | "a" | 2>()({
|
||||||
|
undefined: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
2: () => 3,
|
||||||
|
});
|
||||||
|
// @ts-expect-error `1` collides with `"1"` beside legal members
|
||||||
|
getPrimitiveUnionMatcher<1 | "1" | "a" | true>()({
|
||||||
|
1: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
true: () => 3,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getPrimitiveUnionMatcher: `"true"` and a bare `false` are legal together', () => {
|
||||||
|
// Arrange — `false` stringifies to `"false"`, so it does not collide with
|
||||||
|
// the string member `"true"`.
|
||||||
|
const factory = getPrimitiveUnionMatcher<"true" | false | "a" | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"true">();
|
||||||
|
assert.equal(s, "true");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<false>();
|
||||||
|
assert.equal(s, false);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
assert.equal(s, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher("true"), 1);
|
||||||
|
assert.equal(matcher(false), 2);
|
||||||
|
assert.equal(matcher("a"), 3);
|
||||||
|
assert.equal(matcher(2), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getPrimitiveUnionMatcher: `"false"` and a bare `true` are legal together', () => {
|
||||||
|
// Arrange — `true` stringifies to `"true"`, not `"false"`.
|
||||||
|
const factory = getPrimitiveUnionMatcher<"false" | true | "a" | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"false">();
|
||||||
|
assert.equal(s, "false");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<true>();
|
||||||
|
assert.equal(s, true);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
assert.equal(s, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher("false"), 1);
|
||||||
|
assert.equal(matcher(true), 2);
|
||||||
|
assert.equal(matcher("a"), 3);
|
||||||
|
assert.equal(matcher(2), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getPrimitiveUnionMatcher: `"null"` and a bare `undefined` are legal together', () => {
|
||||||
|
// Arrange — `undefined` stringifies to `"undefined"`, not `"null"`.
|
||||||
|
const factory = getPrimitiveUnionMatcher<"null" | undefined | "a" | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"null">();
|
||||||
|
assert.equal(s, "null");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<undefined>();
|
||||||
|
assert.equal(s, undefined);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
assert.equal(s, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher("null"), 1);
|
||||||
|
assert.equal(matcher(undefined), 2);
|
||||||
|
assert.equal(matcher("a"), 3);
|
||||||
|
assert.equal(matcher(2), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getPrimitiveUnionMatcher: `"undefined"` and a bare `null` are legal together', () => {
|
||||||
|
// Arrange — `null` stringifies to `"null"`, not `"undefined"`.
|
||||||
|
const factory = getPrimitiveUnionMatcher<"undefined" | null | "a" | 2>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"undefined">();
|
||||||
|
assert.equal(s, "undefined");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<null>();
|
||||||
|
assert.equal(s, null);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
assert.equal(s, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher("undefined"), 1);
|
||||||
|
assert.equal(matcher(null), 2);
|
||||||
|
assert.equal(matcher("a"), 3);
|
||||||
|
assert.equal(matcher(2), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getPrimitiveUnionMatcher: `"1"` beside other numbers and strings is legal', () => {
|
||||||
|
// Arrange — the task's example: `"1"` is the string member, `2` and `3`
|
||||||
|
// are bare numbers, `"4"` is another string. No stringification lands on
|
||||||
|
// another member.
|
||||||
|
const factory = getPrimitiveUnionMatcher<"1" | 2 | 3 | "4">();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
"1": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"1">();
|
||||||
|
assert.equal(s, "1");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
3: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<3>();
|
||||||
|
assert.equal(s, 3);
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
"4": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"4">();
|
||||||
|
assert.equal(s, "4");
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher("1"), 1);
|
||||||
|
assert.equal(matcher(2), 2);
|
||||||
|
assert.equal(matcher(3), 3);
|
||||||
|
assert.equal(matcher("4"), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The maximum legal universe needs one handler per member; the statement count
|
||||||
|
// is inherent to the case.
|
||||||
|
// oxlint-disable-next-line max-statements
|
||||||
|
test("getPrimitiveUnionMatcher: the maximum legal universe is supported", () => {
|
||||||
|
// Arrange — every Matchable kind, one representation per value, plus extra
|
||||||
|
// literals. No member's stringification is another member.
|
||||||
|
type Legal =
|
||||||
|
| "true"
|
||||||
|
| false
|
||||||
|
| null
|
||||||
|
| undefined
|
||||||
|
| "1"
|
||||||
|
| 2
|
||||||
|
| 3
|
||||||
|
| "a"
|
||||||
|
| "b"
|
||||||
|
| "4";
|
||||||
|
const factory = getPrimitiveUnionMatcher<Legal>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"true">();
|
||||||
|
assert.equal(s, "true");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<false>();
|
||||||
|
assert.equal(s, false);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<null>();
|
||||||
|
assert.equal(s, null);
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<undefined>();
|
||||||
|
assert.equal(s, undefined);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
"1": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"1">();
|
||||||
|
assert.equal(s, "1");
|
||||||
|
return 5;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<2>();
|
||||||
|
assert.equal(s, 2);
|
||||||
|
return 6;
|
||||||
|
},
|
||||||
|
3: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<3>();
|
||||||
|
assert.equal(s, 3);
|
||||||
|
return 7;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"a">();
|
||||||
|
assert.equal(s, "a");
|
||||||
|
return 8;
|
||||||
|
},
|
||||||
|
b: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"b">();
|
||||||
|
assert.equal(s, "b");
|
||||||
|
return 9;
|
||||||
|
},
|
||||||
|
"4": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<"4">();
|
||||||
|
assert.equal(s, "4");
|
||||||
|
return 10;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: Legal) => number>();
|
||||||
|
assert.equal(matcher("true"), 1);
|
||||||
|
assert.equal(matcher(false), 2);
|
||||||
|
assert.equal(matcher(null), 3);
|
||||||
|
assert.equal(matcher(undefined), 4);
|
||||||
|
assert.equal(matcher("1"), 5);
|
||||||
|
assert.equal(matcher(2), 6);
|
||||||
|
assert.equal(matcher(3), 7);
|
||||||
|
assert.equal(matcher("a"), 8);
|
||||||
|
assert.equal(matcher("b"), 9);
|
||||||
|
assert.equal(matcher("4"), 10);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getPrimitiveUnionMatcher: the maximum illegal universe is rejected", () => {
|
||||||
|
// Arrange — every value paired with its stringification.
|
||||||
|
type Illegal =
|
||||||
|
| "true"
|
||||||
|
| true
|
||||||
|
| "false"
|
||||||
|
| false
|
||||||
|
| "null"
|
||||||
|
| null
|
||||||
|
| "undefined"
|
||||||
|
| undefined
|
||||||
|
| "1"
|
||||||
|
| 1;
|
||||||
|
|
||||||
|
// Act / Assert — the call below must not compile
|
||||||
|
// @ts-expect-error every value collides with its stringification
|
||||||
|
getPrimitiveUnionMatcher<Illegal>()({
|
||||||
|
true: () => 1,
|
||||||
|
false: () => 2,
|
||||||
|
null: () => 3,
|
||||||
|
undefined: () => 4,
|
||||||
|
"1": () => 5,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getPrimitiveUnionMatcher: an open universe is rejected with a fallback too", () => {
|
||||||
|
// Act / Assert — the call below must not compile; a broad universe is
|
||||||
|
// unsupported whether or not a fallback is supplied.
|
||||||
|
// @ts-expect-error `string` is not a finite union of literals
|
||||||
|
getPrimitiveUnionMatcher<string>()({ a: () => 1 }, () => 2);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("getPrimitiveUnionMatcherW factory rejects patterns outside its contract", () => {
|
test("getPrimitiveUnionMatcherW factory rejects patterns outside its contract", () => {
|
||||||
@@ -539,16 +905,11 @@ test("getPrimitiveUnionMatcherW factory rejects patterns outside its contract",
|
|||||||
// ============================================================================
|
// ============================================================================
|
||||||
|
|
||||||
test("getPrimitiveUnionMatcher: an unhandled shape throws without a fallback", () => {
|
test("getPrimitiveUnionMatcher: an unhandled shape throws without a fallback", () => {
|
||||||
// Arrange — an open universe types its handler map as an index signature,
|
// Arrange — a finite universe is exhaustive through the typed API, so the
|
||||||
// so the type system cannot prove the runtime map is exhaustive.
|
// defensive throw is reachable only by widening the factory and dropping a
|
||||||
const handlers: Record<string, (shape: unknown) => number> = {
|
// handler.
|
||||||
a: (shape) => {
|
const bypass: Function = getPrimitiveUnionMatcher<"a" | "b">();
|
||||||
// The raw shape reaches the handler, not the property key's text.
|
const matcher: (shape: "a" | "b") => number = bypass({ a: () => 1 });
|
||||||
assert.equal(shape, "a");
|
|
||||||
return 1;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
const matcher = getPrimitiveUnionMatcher<string>()(handlers);
|
|
||||||
|
|
||||||
// Act / Assert
|
// Act / Assert
|
||||||
assert.equal(matcher("a"), 1);
|
assert.equal(matcher("a"), 1);
|
||||||
@@ -556,17 +917,15 @@ test("getPrimitiveUnionMatcher: an unhandled shape throws without a fallback", (
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("getPrimitiveUnionMatcher: an unhandled boolean shape throws without a fallback", () => {
|
test("getPrimitiveUnionMatcher: an unhandled boolean shape throws without a fallback", () => {
|
||||||
// Arrange — an `string | boolean` universe widens its handler map to an
|
// Arrange — as above; `true` indexes the map as the property `"true"`, but
|
||||||
// index signature, so the runtime map's exhaustiveness is not provable.
|
// the handler is still called with the boolean.
|
||||||
const handlers: Record<string, (shape: unknown) => number> = {
|
const bypass: Function = getPrimitiveUnionMatcher<true | false>();
|
||||||
true: (shape) => {
|
const matcher: (shape: boolean) => number = bypass({
|
||||||
// `true` indexes the map as the property `"true"`, but the handler
|
true: (shape: boolean) => {
|
||||||
// is still called with the boolean.
|
|
||||||
assert.equal(shape, true);
|
assert.equal(shape, true);
|
||||||
return 1;
|
return 1;
|
||||||
},
|
},
|
||||||
};
|
});
|
||||||
const matcher = getPrimitiveUnionMatcher<string | boolean>()(handlers);
|
|
||||||
|
|
||||||
// Act / Assert
|
// Act / Assert
|
||||||
assert.equal(matcher(true), 1);
|
assert.equal(matcher(true), 1);
|
||||||
|
|||||||
+11
-10
@@ -3,25 +3,26 @@ import type { Exact } from "type-fest";
|
|||||||
import type {
|
import type {
|
||||||
HandlerMap,
|
HandlerMap,
|
||||||
Matchable,
|
Matchable,
|
||||||
|
Member,
|
||||||
PatternKey,
|
PatternKey,
|
||||||
PatternParam,
|
|
||||||
PatternReturns,
|
PatternReturns,
|
||||||
RedundantFallback,
|
RedundantFallback,
|
||||||
UnaryFn,
|
UnaryFn,
|
||||||
|
UniverseGate,
|
||||||
} from "./matcher-shared.ts";
|
} from "./matcher-shared.ts";
|
||||||
|
|
||||||
type Handlers<T extends Matchable, R> = {
|
type Handlers<T extends Matchable, R> = {
|
||||||
[K in PatternKey<T>]: UnaryFn<PatternParam<K>, R>;
|
[K in PatternKey<T>]: UnaryFn<Member<T, K>, R>;
|
||||||
};
|
};
|
||||||
|
|
||||||
// The fallback is a *second argument*, not a property of the handler map,
|
// The fallback is a *second argument*, not a property of the handler map,
|
||||||
// because its parameter is the remainder `Exclude<T, keyof Handled>` and TypeScript
|
// because its parameter is the remainder `Exclude<T, Member<T, keyof Handled>>` and TypeScript
|
||||||
// fixes a property's contextual type before it infers its sibling keys. A later
|
// fixes a property's contextual type before it infers its sibling keys. A later
|
||||||
// argument, by contrast, is contextually typed from inference on an earlier
|
// argument, by contrast, is contextually typed from inference on an earlier
|
||||||
// one, so the split is what makes the remainder expressible at all.
|
// one, so the split is what makes the remainder expressible at all.
|
||||||
// See development/library.md.
|
// See development/library.md.
|
||||||
type Fallback<T extends Matchable, Handled, R> = UnaryFn<
|
type Fallback<T extends Matchable, Handled, R> = UnaryFn<
|
||||||
Exclude<T, PatternParam<keyof Handled>>,
|
Exclude<T, Member<T, keyof Handled>>,
|
||||||
R
|
R
|
||||||
>;
|
>;
|
||||||
|
|
||||||
@@ -44,14 +45,14 @@ type MustBePartial<T extends Matchable, Handled> =
|
|||||||
// #1 Handlers (first) -> the exhaustive form and the autocomplete popup
|
// #1 Handlers (first) -> the exhaustive form and the autocomplete popup
|
||||||
// #2 Fallback (last) -> accepts a partial handler map plus a fallback
|
// #2 Fallback (last) -> accepts a partial handler map plus a fallback
|
||||||
interface PrimitiveUnionMatcherStrict<T extends Matchable> {
|
interface PrimitiveUnionMatcherStrict<T extends Matchable> {
|
||||||
<R>(handlers: Handlers<T, R>): UnaryFn<T, R>;
|
<R>(handlers: Handlers<T, R> & UniverseGate<T>): UnaryFn<T, R>;
|
||||||
<
|
<
|
||||||
R,
|
R,
|
||||||
Handled extends Exact<Partial<Handlers<T, R>>, Handled> &
|
Handled extends Exact<Partial<Handlers<T, R>>, Handled> &
|
||||||
MustBePartial<T, Handled>,
|
MustBePartial<T, Handled>,
|
||||||
>(
|
>(
|
||||||
handlers: Handled & Partial<Handlers<T, R>>,
|
handlers: Handled & Partial<Handlers<T, R>> & UniverseGate<T>,
|
||||||
fallback: Fallback<T, Handled, R>,
|
fallback: Fallback<T, Handled, R> & UniverseGate<T>,
|
||||||
): UnaryFn<T, R>;
|
): UnaryFn<T, R>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,15 +61,15 @@ interface PrimitiveUnionMatcherStrict<T extends Matchable> {
|
|||||||
// contextual/autocomplete type.
|
// contextual/autocomplete type.
|
||||||
interface PrimitiveUnionMatcherWidening<T extends Matchable> {
|
interface PrimitiveUnionMatcherWidening<T extends Matchable> {
|
||||||
<P extends Exact<Handlers<T, unknown>, P>>(
|
<P extends Exact<Handlers<T, unknown>, P>>(
|
||||||
handlers: P,
|
handlers: P & UniverseGate<T>,
|
||||||
): UnaryFn<T, PatternReturns<P>>;
|
): UnaryFn<T, PatternReturns<P>>;
|
||||||
<
|
<
|
||||||
R,
|
R,
|
||||||
Handled extends Exact<Partial<Handlers<T, unknown>>, Handled> &
|
Handled extends Exact<Partial<Handlers<T, unknown>>, Handled> &
|
||||||
MustBePartial<T, Handled>,
|
MustBePartial<T, Handled>,
|
||||||
>(
|
>(
|
||||||
handlers: Handled,
|
handlers: Handled & UniverseGate<T>,
|
||||||
fallback: Fallback<T, Handled, R>,
|
fallback: Fallback<T, Handled, R> & UniverseGate<T>,
|
||||||
): UnaryFn<T, PatternReturns<Handled> | R>;
|
): UnaryFn<T, PatternReturns<Handled> | R>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+475
-24
@@ -273,27 +273,17 @@ test("getTaggedUnionMatcher: a fallback receives the unhandled members", () => {
|
|||||||
assert.equal(area({ kind: "triangle", base: 1, height: 1 }), 2);
|
assert.equal(area({ kind: "triangle", base: 1, height: 1 }), 2);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("getTaggedUnionMatcher: an open discriminant keeps the fallback open", () => {
|
test("getTaggedUnionMatcher: an open discriminant is rejected with a fallback too", () => {
|
||||||
// Arrange
|
// Arrange
|
||||||
interface Message {
|
interface Message {
|
||||||
readonly kind: string;
|
readonly kind: string;
|
||||||
readonly text: string;
|
readonly text: string;
|
||||||
}
|
}
|
||||||
const factory = getTaggedUnionMatcher<Message>()("kind");
|
|
||||||
|
|
||||||
// Act
|
// Act / Assert — the call below must not compile; a broad tag is unsupported
|
||||||
const matcher = factory({ info: () => 1 as const }, (s) => {
|
// whether or not a fallback is supplied.
|
||||||
// The map's literal key does not close an open discriminant, so the
|
// @ts-expect-error `string` tags are not a finite union of literals
|
||||||
// remainder stays `Message` and the fallback is not redundant.
|
getTaggedUnionMatcher<Message>()("kind")({ info: () => 1 }, () => 2);
|
||||||
expectTypeOf(s).toEqualTypeOf<Message>();
|
|
||||||
assert.equal(typeof s.text, "string");
|
|
||||||
return 2 as const;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
expectTypeOf(matcher).toEqualTypeOf<(shape: Message) => 1 | 2>();
|
|
||||||
assert.equal(matcher({ kind: "info", text: "" }), 1);
|
|
||||||
assert.equal(matcher({ kind: "warn", text: "" }), 2);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
@@ -446,28 +436,489 @@ test("getTaggedUnionMatcherW factory rejects patterns outside its contract", ()
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("getTaggedUnionMatcher: a standalone stringified tag is typed by the member, not its key", () => {
|
||||||
|
// `kind: "true"` is a string tag whose `PatternKey` is `"true"`; inverting
|
||||||
|
// the key must recover the member, not the boolean tag.
|
||||||
|
// Arrange
|
||||||
|
interface StringTag {
|
||||||
|
readonly kind: "true";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
const factory = getTaggedUnionMatcher<StringTag>()("kind");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = factory({
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<StringTag>();
|
||||||
|
assert.equal(s.kind, "true");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "true", a: 1 }), 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getTaggedUnionMatcher: a broad tag is rejected", () => {
|
||||||
|
// Arrange
|
||||||
|
interface Message {
|
||||||
|
readonly kind: string;
|
||||||
|
}
|
||||||
|
interface Count {
|
||||||
|
readonly kind: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Act / Assert — the calls below must not compile
|
||||||
|
// @ts-expect-error `string` tags are not a finite union of literals
|
||||||
|
getTaggedUnionMatcher<Message>()("kind")({ a: () => 1 });
|
||||||
|
// @ts-expect-error `number` tags are not a finite union of literals
|
||||||
|
getTaggedUnionMatcher<Count>()("kind")({ 1: () => 1 });
|
||||||
|
// @ts-expect-error the widening factory rejects broad tags too
|
||||||
|
getTaggedUnionMatcherW<Message>()("kind")({ a: () => 1 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getTaggedUnionMatcher: a value/stringification tag collision is rejected", () => {
|
||||||
|
// Arrange
|
||||||
|
type Colliding =
|
||||||
|
| { readonly kind: "true"; readonly a: number }
|
||||||
|
| { readonly kind: true; readonly b: number };
|
||||||
|
type NumericColliding =
|
||||||
|
| { readonly kind: "1"; readonly a: number }
|
||||||
|
| { readonly kind: 1; readonly b: number };
|
||||||
|
|
||||||
|
// Act / Assert — the calls below must not compile
|
||||||
|
// @ts-expect-error `true` collides with the string tag `"true"`
|
||||||
|
getTaggedUnionMatcher<Colliding>()("kind")({ true: () => 1 });
|
||||||
|
// @ts-expect-error the number tag `1` collides with the string tag `"1"`
|
||||||
|
getTaggedUnionMatcher<NumericColliding>()("kind")({ "1": () => 1 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getTaggedUnionMatcher: a tag collision is rejected beside legal members", () => {
|
||||||
|
// Act / Assert — the calls below must not compile. Each map is otherwise
|
||||||
|
// complete, so only the collision can make it invalid.
|
||||||
|
type TrueColliding =
|
||||||
|
| { readonly kind: "true"; readonly a: number }
|
||||||
|
| { readonly kind: true; readonly b: number }
|
||||||
|
| { readonly kind: "a"; readonly c: number };
|
||||||
|
// @ts-expect-error `true` collides with the string tag `"true"`
|
||||||
|
getTaggedUnionMatcher<TrueColliding>()("kind")({
|
||||||
|
true: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
});
|
||||||
|
|
||||||
|
type FalseColliding =
|
||||||
|
| { readonly kind: "false"; readonly a: number }
|
||||||
|
| { readonly kind: false; readonly b: number }
|
||||||
|
| { readonly kind: "a"; readonly c: number };
|
||||||
|
// @ts-expect-error `false` collides with the string tag `"false"`
|
||||||
|
getTaggedUnionMatcher<FalseColliding>()("kind")({
|
||||||
|
false: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
});
|
||||||
|
|
||||||
|
type NullColliding =
|
||||||
|
| { readonly kind: "null"; readonly a: number }
|
||||||
|
| { readonly kind: null; readonly b: number }
|
||||||
|
| { readonly kind: "a"; readonly c: number };
|
||||||
|
// @ts-expect-error `null` collides with the string tag `"null"`
|
||||||
|
getTaggedUnionMatcher<NullColliding>()("kind")({
|
||||||
|
null: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
});
|
||||||
|
|
||||||
|
type UndefinedColliding =
|
||||||
|
| { readonly kind: "undefined"; readonly a: number }
|
||||||
|
| { readonly kind: undefined; readonly b: number }
|
||||||
|
| { readonly kind: "a"; readonly c: number };
|
||||||
|
// @ts-expect-error `undefined` collides with the string tag `"undefined"`
|
||||||
|
getTaggedUnionMatcher<UndefinedColliding>()("kind")({
|
||||||
|
undefined: () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
});
|
||||||
|
|
||||||
|
type NumericColliding =
|
||||||
|
| { readonly kind: "1"; readonly a: number }
|
||||||
|
| { readonly kind: 1; readonly b: number }
|
||||||
|
| { readonly kind: "a"; readonly c: number };
|
||||||
|
// @ts-expect-error the number tag `1` collides with the string tag `"1"`
|
||||||
|
getTaggedUnionMatcher<NumericColliding>()("kind")({
|
||||||
|
"1": () => 1,
|
||||||
|
a: () => 2,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getTaggedUnionMatcher: a `"true"` tag and a `false` tag are legal together', () => {
|
||||||
|
// Arrange
|
||||||
|
interface TrueString {
|
||||||
|
readonly kind: "true";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
interface FalseBare {
|
||||||
|
readonly kind: false;
|
||||||
|
readonly b: number;
|
||||||
|
}
|
||||||
|
interface Extra {
|
||||||
|
readonly kind: "a";
|
||||||
|
readonly c: number;
|
||||||
|
}
|
||||||
|
type Legal = TrueString | FalseBare | Extra;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<TrueString>();
|
||||||
|
assert.equal(s.kind, "true");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<FalseBare>();
|
||||||
|
assert.equal(s.kind, false);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<Extra>();
|
||||||
|
assert.equal(s.kind, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "true", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: false, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: "a", c: 3 }), 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getTaggedUnionMatcher: a `"false"` tag and a `true` tag are legal together', () => {
|
||||||
|
// Arrange
|
||||||
|
interface FalseString {
|
||||||
|
readonly kind: "false";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
interface TrueBare {
|
||||||
|
readonly kind: true;
|
||||||
|
readonly b: number;
|
||||||
|
}
|
||||||
|
interface Extra {
|
||||||
|
readonly kind: "a";
|
||||||
|
readonly c: number;
|
||||||
|
}
|
||||||
|
type Legal = FalseString | TrueBare | Extra;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<FalseString>();
|
||||||
|
assert.equal(s.kind, "false");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<TrueBare>();
|
||||||
|
assert.equal(s.kind, true);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<Extra>();
|
||||||
|
assert.equal(s.kind, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "false", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: true, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: "a", c: 3 }), 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getTaggedUnionMatcher: a `"null"` tag and an `undefined` tag are legal together', () => {
|
||||||
|
// Arrange
|
||||||
|
interface NullString {
|
||||||
|
readonly kind: "null";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
interface UndefinedBare {
|
||||||
|
readonly kind: undefined;
|
||||||
|
readonly b: number;
|
||||||
|
}
|
||||||
|
interface Extra {
|
||||||
|
readonly kind: "a";
|
||||||
|
readonly c: number;
|
||||||
|
}
|
||||||
|
type Legal = NullString | UndefinedBare | Extra;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<NullString>();
|
||||||
|
assert.equal(s.kind, "null");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<UndefinedBare>();
|
||||||
|
assert.equal(s.kind, undefined);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<Extra>();
|
||||||
|
assert.equal(s.kind, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "null", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: undefined, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: "a", c: 3 }), 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getTaggedUnionMatcher: an `"undefined"` tag and a `null` tag are legal together', () => {
|
||||||
|
// Arrange
|
||||||
|
interface UndefinedString {
|
||||||
|
readonly kind: "undefined";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
interface NullBare {
|
||||||
|
readonly kind: null;
|
||||||
|
readonly b: number;
|
||||||
|
}
|
||||||
|
interface Extra {
|
||||||
|
readonly kind: "a";
|
||||||
|
readonly c: number;
|
||||||
|
}
|
||||||
|
type Legal = UndefinedString | NullBare | Extra;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<UndefinedString>();
|
||||||
|
assert.equal(s.kind, "undefined");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<NullBare>();
|
||||||
|
assert.equal(s.kind, null);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<Extra>();
|
||||||
|
assert.equal(s.kind, "a");
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "undefined", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: null, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: "a", c: 3 }), 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('getTaggedUnionMatcher: a `"1"` tag beside other tags is legal', () => {
|
||||||
|
// Arrange
|
||||||
|
interface OneString {
|
||||||
|
readonly kind: "1";
|
||||||
|
readonly a: number;
|
||||||
|
}
|
||||||
|
interface TwoBare {
|
||||||
|
readonly kind: 2;
|
||||||
|
readonly b: number;
|
||||||
|
}
|
||||||
|
interface ThreeBare {
|
||||||
|
readonly kind: 3;
|
||||||
|
readonly c: number;
|
||||||
|
}
|
||||||
|
interface FourString {
|
||||||
|
readonly kind: "4";
|
||||||
|
readonly d: number;
|
||||||
|
}
|
||||||
|
type Legal = OneString | TwoBare | ThreeBare | FourString;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
"1": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<OneString>();
|
||||||
|
assert.equal(s.kind, "1");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<TwoBare>();
|
||||||
|
assert.equal(s.kind, 2);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
3: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<ThreeBare>();
|
||||||
|
assert.equal(s.kind, 3);
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
"4": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<FourString>();
|
||||||
|
assert.equal(s.kind, "4");
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert.equal(matcher({ kind: "1", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: 2, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: 3, c: 3 }), 3);
|
||||||
|
assert.equal(matcher({ kind: "4", d: 4 }), 4);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The maximum legal tag universe needs one handler per member; the statement
|
||||||
|
// count is inherent to the case.
|
||||||
|
// oxlint-disable-next-line max-statements
|
||||||
|
test("getTaggedUnionMatcher: the maximum legal tag universe is supported", () => {
|
||||||
|
// Arrange — every tag kind, one representation per value, plus extra tags.
|
||||||
|
interface M1 {
|
||||||
|
readonly kind: "true";
|
||||||
|
readonly a: 1;
|
||||||
|
}
|
||||||
|
interface M2 {
|
||||||
|
readonly kind: false;
|
||||||
|
readonly b: 2;
|
||||||
|
}
|
||||||
|
interface M3 {
|
||||||
|
readonly kind: null;
|
||||||
|
readonly c: 3;
|
||||||
|
}
|
||||||
|
interface M4 {
|
||||||
|
readonly kind: undefined;
|
||||||
|
readonly d: 4;
|
||||||
|
}
|
||||||
|
interface M5 {
|
||||||
|
readonly kind: "1";
|
||||||
|
readonly e: 5;
|
||||||
|
}
|
||||||
|
interface M6 {
|
||||||
|
readonly kind: 2;
|
||||||
|
readonly f: 6;
|
||||||
|
}
|
||||||
|
interface M7 {
|
||||||
|
readonly kind: 3;
|
||||||
|
readonly g: 7;
|
||||||
|
}
|
||||||
|
interface M8 {
|
||||||
|
readonly kind: "a";
|
||||||
|
readonly h: 8;
|
||||||
|
}
|
||||||
|
interface M9 {
|
||||||
|
readonly kind: "b";
|
||||||
|
readonly i: 9;
|
||||||
|
}
|
||||||
|
type Legal = M1 | M2 | M3 | M4 | M5 | M6 | M7 | M8 | M9;
|
||||||
|
|
||||||
|
// Act
|
||||||
|
const matcher = getTaggedUnionMatcher<Legal>()("kind")({
|
||||||
|
true: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M1>();
|
||||||
|
assert.equal(s.kind, "true");
|
||||||
|
return 1;
|
||||||
|
},
|
||||||
|
false: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M2>();
|
||||||
|
assert.equal(s.kind, false);
|
||||||
|
return 2;
|
||||||
|
},
|
||||||
|
null: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M3>();
|
||||||
|
assert.equal(s.kind, null);
|
||||||
|
return 3;
|
||||||
|
},
|
||||||
|
undefined: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M4>();
|
||||||
|
assert.equal(s.kind, undefined);
|
||||||
|
return 4;
|
||||||
|
},
|
||||||
|
"1": (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M5>();
|
||||||
|
assert.equal(s.kind, "1");
|
||||||
|
return 5;
|
||||||
|
},
|
||||||
|
2: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M6>();
|
||||||
|
assert.equal(s.kind, 2);
|
||||||
|
return 6;
|
||||||
|
},
|
||||||
|
3: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M7>();
|
||||||
|
assert.equal(s.kind, 3);
|
||||||
|
return 7;
|
||||||
|
},
|
||||||
|
a: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M8>();
|
||||||
|
assert.equal(s.kind, "a");
|
||||||
|
return 8;
|
||||||
|
},
|
||||||
|
b: (s) => {
|
||||||
|
expectTypeOf(s).toEqualTypeOf<M9>();
|
||||||
|
assert.equal(s.kind, "b");
|
||||||
|
return 9;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
expectTypeOf(matcher).toEqualTypeOf<(shape: Legal) => number>();
|
||||||
|
assert.equal(matcher({ kind: "true", a: 1 }), 1);
|
||||||
|
assert.equal(matcher({ kind: false, b: 2 }), 2);
|
||||||
|
assert.equal(matcher({ kind: null, c: 3 }), 3);
|
||||||
|
assert.equal(matcher({ kind: undefined, d: 4 }), 4);
|
||||||
|
assert.equal(matcher({ kind: "1", e: 5 }), 5);
|
||||||
|
assert.equal(matcher({ kind: 2, f: 6 }), 6);
|
||||||
|
assert.equal(matcher({ kind: 3, g: 7 }), 7);
|
||||||
|
assert.equal(matcher({ kind: "a", h: 8 }), 8);
|
||||||
|
assert.equal(matcher({ kind: "b", i: 9 }), 9);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("getTaggedUnionMatcher: the maximum illegal tag universe is rejected", () => {
|
||||||
|
// Arrange — every tag paired with its stringification.
|
||||||
|
type Illegal =
|
||||||
|
| { readonly kind: "true"; readonly a: 1 }
|
||||||
|
| { readonly kind: true; readonly a: 1 }
|
||||||
|
| { readonly kind: "false"; readonly b: 2 }
|
||||||
|
| { readonly kind: false; readonly b: 2 }
|
||||||
|
| { readonly kind: "null"; readonly c: 3 }
|
||||||
|
| { readonly kind: null; readonly c: 3 }
|
||||||
|
| { readonly kind: "undefined"; readonly d: 4 }
|
||||||
|
| { readonly kind: undefined; readonly d: 4 }
|
||||||
|
| { readonly kind: "1"; readonly e: 5 }
|
||||||
|
| { readonly kind: 1; readonly e: 5 };
|
||||||
|
|
||||||
|
// Act / Assert — the call below must not compile
|
||||||
|
// @ts-expect-error every tag collides with its stringification
|
||||||
|
getTaggedUnionMatcher<Illegal>()("kind")({
|
||||||
|
true: () => 1,
|
||||||
|
false: () => 2,
|
||||||
|
null: () => 3,
|
||||||
|
undefined: () => 4,
|
||||||
|
"1": () => 5,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
// Dispatch — runtime behavior
|
// Dispatch — runtime behavior
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
|
|
||||||
test("getTaggedUnionMatcher: an unhandled tag throws without a fallback", () => {
|
test("getTaggedUnionMatcher: an unhandled tag throws without a fallback", () => {
|
||||||
// Arrange — an open discriminant widens its handler map to an index
|
// Arrange — a finite tag set is exhaustive through the typed API, so the
|
||||||
// signature, so the type system cannot prove the runtime map is exhaustive.
|
// defensive throw is reachable only by widening the factory and dropping a
|
||||||
|
// handler.
|
||||||
interface Message {
|
interface Message {
|
||||||
readonly kind: string;
|
readonly kind: "info" | "warn";
|
||||||
|
readonly text: string;
|
||||||
}
|
}
|
||||||
const handlers: Record<string, (shape: Message) => number> = {
|
const bypass: Function = getTaggedUnionMatcher<Message>()("kind");
|
||||||
info: (shape) => {
|
const matcher: (shape: Message) => number = bypass({
|
||||||
|
info: (shape: Message) => {
|
||||||
// The full member reaches the handler, not its tag.
|
// The full member reaches the handler, not its tag.
|
||||||
assert.equal(shape.kind, "info");
|
assert.equal(shape.kind, "info");
|
||||||
return 1;
|
return 1;
|
||||||
},
|
},
|
||||||
};
|
});
|
||||||
const matcher = getTaggedUnionMatcher<Message>()("kind")(handlers);
|
|
||||||
|
|
||||||
// Act / Assert
|
// Act / Assert
|
||||||
assert.equal(matcher({ kind: "info" }), 1);
|
assert.equal(matcher({ kind: "info", text: "" }), 1);
|
||||||
assert.throws(() => matcher({ kind: "warn" }), /Unhandled tag: warn/);
|
assert.throws(
|
||||||
|
() => matcher({ kind: "warn", text: "" }),
|
||||||
|
/Unhandled tag: warn/,
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
|
|||||||
+17
-13
@@ -3,11 +3,12 @@ import type { Exact, UnknownRecord } from "type-fest";
|
|||||||
import type {
|
import type {
|
||||||
HandlerMap,
|
HandlerMap,
|
||||||
Matchable,
|
Matchable,
|
||||||
|
Member,
|
||||||
PatternKey,
|
PatternKey,
|
||||||
PatternParam,
|
|
||||||
PatternReturns,
|
PatternReturns,
|
||||||
RedundantFallback,
|
RedundantFallback,
|
||||||
UnaryFn,
|
UnaryFn,
|
||||||
|
UniverseGate,
|
||||||
} from "./matcher-shared.ts";
|
} from "./matcher-shared.ts";
|
||||||
|
|
||||||
// A tagged union is discriminated by one property whose values are the tags (a
|
// A tagged union is discriminated by one property whose values are the tags (a
|
||||||
@@ -17,8 +18,8 @@ import type {
|
|||||||
// to write a handler under, and `bigint` is not a property key.
|
// to write a handler under, and `bigint` is not a property key.
|
||||||
|
|
||||||
// The discriminant values of `T` under `K`. `Extract` keeps the finite literal
|
// The discriminant values of `T` under `K`. `Extract` keeps the finite literal
|
||||||
// tags and leaves a widened `string`/`number` as itself, so an open universe
|
// tags and leaves a widened `string`/`number` as itself; a broad tag is then
|
||||||
// keeps an open fallback.
|
// rejected by the universe gate.
|
||||||
type Tags<T extends object, K extends keyof T> = Extract<T[K], Matchable>;
|
type Tags<T extends object, K extends keyof T> = Extract<T[K], Matchable>;
|
||||||
|
|
||||||
// The keys of `T` that can act as a discriminant. `getTaggedUnionMatcher<T>()`
|
// The keys of `T` that can act as a discriminant. `getTaggedUnionMatcher<T>()`
|
||||||
@@ -30,9 +31,10 @@ type Discriminated<T extends object> = {
|
|||||||
// The member(s) of `T` tagged `V`. `Extract` distributes over the union, so a
|
// The member(s) of `T` tagged `V`. `Extract` distributes over the union, so a
|
||||||
// duplicated tag maps to a union of members rather than silently dropping one.
|
// duplicated tag maps to a union of members rather than silently dropping one.
|
||||||
// Keyed by `PatternKey`, so `boolean`/`null`/`undefined` tags can key a mapped
|
// Keyed by `PatternKey`, so `boolean`/`null`/`undefined` tags can key a mapped
|
||||||
// type; `PatternParam` inverts the projection to recover the member.
|
// type; `Member` inverts the projection against the tag set to recover the
|
||||||
|
// member.
|
||||||
type MapTaggedUnion<T extends object, K extends keyof T> = {
|
type MapTaggedUnion<T extends object, K extends keyof T> = {
|
||||||
[P in PatternKey<Tags<T, K>>]: Extract<T, Record<K, PatternParam<P>>>;
|
[P in PatternKey<Tags<T, K>>]: Extract<T, Record<K, Member<Tags<T, K>, P>>>;
|
||||||
};
|
};
|
||||||
|
|
||||||
type Handlers<T extends object, K extends keyof T, R> = {
|
type Handlers<T extends object, K extends keyof T, R> = {
|
||||||
@@ -43,7 +45,7 @@ type Handlers<T extends object, K extends keyof T, R> = {
|
|||||||
// index within `MapTaggedUnion`'s keys, and the conditional drops a stray key
|
// index within `MapTaggedUnion`'s keys, and the conditional drops a stray key
|
||||||
// outside `T` so it cannot widen the remainder. The remainder is
|
// outside `T` so it cannot widen the remainder. The remainder is
|
||||||
// `Exclude<T, …>`, mirroring the primitive-union matcher's
|
// `Exclude<T, …>`, mirroring the primitive-union matcher's
|
||||||
// `Exclude<T, PatternParam<keyof Handled>>`.
|
// `Exclude<T, Member<T, keyof Handled>>`.
|
||||||
type HandledMembers<T extends object, K extends keyof T, Handled> = {
|
type HandledMembers<T extends object, K extends keyof T, Handled> = {
|
||||||
[P in PatternKey<Tags<T, K>>]: P extends keyof Handled
|
[P in PatternKey<Tags<T, K>>]: P extends keyof Handled
|
||||||
? MapTaggedUnion<T, K>[P]
|
? MapTaggedUnion<T, K>[P]
|
||||||
@@ -51,7 +53,7 @@ type HandledMembers<T extends object, K extends keyof T, Handled> = {
|
|||||||
}[PatternKey<Tags<T, K>>];
|
}[PatternKey<Tags<T, K>>];
|
||||||
|
|
||||||
// The fallback is a *second argument*, not a property of the handler map, so
|
// The fallback is a *second argument*, not a property of the handler map, so
|
||||||
// its parameter can be the remainder the map left open. See development/library.md.
|
// its parameter can be the remainder the map left uncovered. See development/library.md.
|
||||||
type Fallback<T extends object, K extends keyof T, Handled, R> = UnaryFn<
|
type Fallback<T extends object, K extends keyof T, Handled, R> = UnaryFn<
|
||||||
Exclude<T, HandledMembers<T, K, Handled>>,
|
Exclude<T, HandledMembers<T, K, Handled>>,
|
||||||
R
|
R
|
||||||
@@ -71,14 +73,16 @@ type MustBePartial<T extends object, K extends keyof T, Handled> =
|
|||||||
// #1 Handlers (first) -> the exhaustive form and the autocomplete popup
|
// #1 Handlers (first) -> the exhaustive form and the autocomplete popup
|
||||||
// #2 Fallback (last) -> accepts a partial handler map plus a fallback
|
// #2 Fallback (last) -> accepts a partial handler map plus a fallback
|
||||||
interface TaggedUnionMatcherStrict<T extends object, K extends keyof T> {
|
interface TaggedUnionMatcherStrict<T extends object, K extends keyof T> {
|
||||||
<R>(handlers: Handlers<T, K, R>): UnaryFn<T, R>;
|
<R>(handlers: Handlers<T, K, R> & UniverseGate<Tags<T, K>>): UnaryFn<T, R>;
|
||||||
<
|
<
|
||||||
R,
|
R,
|
||||||
Handled extends Exact<Partial<Handlers<T, K, R>>, Handled> &
|
Handled extends Exact<Partial<Handlers<T, K, R>>, Handled> &
|
||||||
MustBePartial<T, K, Handled>,
|
MustBePartial<T, K, Handled>,
|
||||||
>(
|
>(
|
||||||
handlers: Handled & Partial<Handlers<T, K, R>>,
|
handlers: Handled &
|
||||||
fallback: Fallback<T, K, Handled, R>,
|
Partial<Handlers<T, K, R>> &
|
||||||
|
UniverseGate<Tags<T, K>>,
|
||||||
|
fallback: Fallback<T, K, Handled, R> & UniverseGate<Tags<T, K>>,
|
||||||
): UnaryFn<T, R>;
|
): UnaryFn<T, R>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,15 +91,15 @@ interface TaggedUnionMatcherStrict<T extends object, K extends keyof T> {
|
|||||||
// contextual/autocomplete type.
|
// contextual/autocomplete type.
|
||||||
interface TaggedUnionMatcherWidening<T extends object, K extends keyof T> {
|
interface TaggedUnionMatcherWidening<T extends object, K extends keyof T> {
|
||||||
<P extends Exact<Handlers<T, K, unknown>, P>>(
|
<P extends Exact<Handlers<T, K, unknown>, P>>(
|
||||||
handlers: P,
|
handlers: P & UniverseGate<Tags<T, K>>,
|
||||||
): UnaryFn<T, PatternReturns<P>>;
|
): UnaryFn<T, PatternReturns<P>>;
|
||||||
<
|
<
|
||||||
R,
|
R,
|
||||||
Handled extends Exact<Partial<Handlers<T, K, unknown>>, Handled> &
|
Handled extends Exact<Partial<Handlers<T, K, unknown>>, Handled> &
|
||||||
MustBePartial<T, K, Handled>,
|
MustBePartial<T, K, Handled>,
|
||||||
>(
|
>(
|
||||||
handlers: Handled,
|
handlers: Handled & UniverseGate<Tags<T, K>>,
|
||||||
fallback: Fallback<T, K, Handled, R>,
|
fallback: Fallback<T, K, Handled, R> & UniverseGate<Tags<T, K>>,
|
||||||
): UnaryFn<T, PatternReturns<Handled> | R>;
|
): UnaryFn<T, PatternReturns<Handled> | R>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user