@vielzeug/codex 3.0.2 → 3.0.4

package/data/packages/illusionist.json

@@ -0,0 +1,132 @@
+{
+  "apiSource": "export * from './commerce/commerce';\nexport * from './date/date';\nexport * from './errors';\nexport * from './factory';\nexport * from './finance/finance';\nexport * from './internet/internet';\nexport * from './location/location';\nexport * from './lorem/lorem';\nexport * from './person/person';\nexport * from './seed/create-seed';\nexport * from './seed/mulberry32';\nexport * from './types';\n",
+  "docs": {
+    "index": "---\ntitle: Illusionist — Fake Data Generator for TypeScript\ndescription: Typed, deterministic, locale-aware fake data generator with a seeded PRNG, eight data categories, and zero external runtime dependencies.\npackage: illusionist\ncategory: data\nkeywords: [fake-data, mock, seed, faker, test-fixtures, deterministic]\nexports: [createIllusion, createSeed, mulberry32]\nrelated: [arsenal, coins, tempo]\nenvironments: [browser, node, ssr]\n---\n\n<!-- markdownlint-disable MD025 MD033 MD060 -->\n\n<PackageHero package=\"illusionist\" />\n\n## Why Illusionist?\n\nIllusionist generates realistic fake data from a single seeded random source. The same seed always produces the same output, so test fixtures and snapshots stay reproducible across runs, machines, and CI. Every category shares one bound instance with one locale, so a person, their email, and their address stay internally consistent.\n\n```ts\n// Before\nconst user = {\n  name: 'Test User',\n  email: 'test@example.com',\n  address: '123 Main St',\n};\n\n// After\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 12345, locale: en });\n\nconst user = {\n  name: illusion.person.fullName(),\n  email: illusion.internet.email(),\n  address: illusion.location.streetAddress(),\n};\n\n```\n\n| Feature | Illusionist | Faker.js | @faker-js/faker |\n| --- | --- | --- | --- |\n| Bundle size | <PackageInfo package=\"illusionist\" type=\"size\" /> | External dependency | External dependency |\n| Zero external dependencies | <ore-icon name=\"check\" size=\"16\"></ore-icon> | <ore-icon name=\"x\" size=\"16\"></ore-icon> | <ore-icon name=\"x\" size=\"16\"></ore-icon> |\n| Seeded determinism | <ore-icon name=\"check\" size=\"16\"></ore-icon> | Partial | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| Locale-aware datasets | <ore-icon name=\"check\" size=\"16\"></ore-icon> | <ore-icon name=\"check\" size=\"16\"></ore-icon> | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| TypeScript-native types | <ore-icon name=\"check\" size=\"16\"></ore-icon> | <ore-icon name=\"x\" size=\"16\"></ore-icon> | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n\n<div class=\"decision-callout\">\n\n**Use Illusionist when** test fixtures, mock APIs, or database seeds must be realistic and reproducible from a single seed value.\n\n**Consider @faker-js/faker when** you need a large catalog of locale datasets beyond `en` and `de` or a community plugin ecosystem.\n\n</div>\n\n## Installation\n\n::: code-group\n\n```sh [pnpm]\npnpm add @vielzeug/illusionist\n```\n\n```sh [npm]\nnpm install @vielzeug/illusionist\n```\n\n```sh [yarn]\nyarn add @vielzeug/illusionist\n```\n\n:::\n\n## Quick Start\n\nCreate a bound instance with a seed and locale. All categories share that seed, so output is deterministic.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 12345, locale: en });\n\nillusion.person.fullName();        // 'Ashley Harris'\nillusion.internet.email();         // 'samantha.sanchez@mail.com'\nillusion.commerce.price();         // Money { amount: 76640n, currency: USD }\nillusion.date.past({ years: 2 });  // Temporal.ZonedDateTime\n\n```\n\n## Features\n\n<div class=\"features-grid\">\n\n- **`person`**: names, gender, prefixes, suffixes, job titles\n- **`internet`**: emails, usernames, passwords, URLs, IPs, MACs, HTTP metadata\n- **`commerce`**: product names, departments, prices as coins `Money`\n- **`date`**: past, future, recent, between, birthday as tempo `Temporal` objects\n- **`finance`**: amounts, IBANs, BICs, credit cards, crypto addresses\n- **`location`**: cities, streets, states, countries, GPS coordinates\n- **`lorem`**: words, sentences, paragraphs, slugs\n- **`system`**: file paths, semver, UUIDs, ports, cron expressions\n\n</div>\n\n## Documentation\n\n<div class=\"doc-links\">\n\n- [Usage Guide](./usage.md)\n- [API Reference](./api.md)\n- [Examples](./examples.md)\n- [Migration Guide](./migration.md)\n\n</div>\n\n## See Also\n\n<div class=\"see-also\">\n\n- [Arsenal](/arsenal/) — random primitives (`RandomSource`, `uuid`) that Illusionist builds on.\n- [Coins](/coins/) — exact money type returned by `commerce.price()` and `finance.amount()`.\n- [Tempo](/tempo/) — `Temporal` date utilities returned by every `date` function.\n\n</div>\n\n<!-- markdownlint-enable MD025 MD033 MD060 -->\n",
+    "api": "---\ntitle: Illusionist — API Reference\ndescription: createIllusion, all category functions, seed utilities, types, and errors.\n---\n\n[[toc]]\n\n## API Overview\n\n| Symbol | Purpose | Execution | Common gotcha |\n| --- | --- | --- | --- |\n| `createIllusion` | Create a bound, seeded instance | Sync | Locale is fixed for the instance lifetime |\n| `person.*` | Names, gender, job titles | Sync | Locale-specific datasets (`en`, `de`) |\n| `internet.*` | Emails, URLs, IPs, HTTP metadata | Sync | `ip()` defaults to IPv4 |\n| `commerce.*` | Product names, prices | Sync | `price()` returns coins `Money` |\n| `date.*` | Past, future, recent, birthday | Sync | Returns tempo `Temporal` objects |\n| `finance.*` | IBANs, cards, crypto addresses | Sync | IBANs pass mod-97; cards pass Luhn |\n| `location.*` | Cities, streets, GPS | Sync | Locale-specific datasets |\n| `lorem.*` | Words, sentences, paragraphs | Sync | Word pool is fixed |\n| `system.*` | Files, semver, UUIDs, ports | Sync | `port()` avoids well-known ports by default |\n| `createSeed` | Build a `RandomSource` from a seed | Sync | Non-finite numeric seeds throw |\n| `mulberry32` | Low-level 32-bit PRNG | Sync | Not cryptographically secure |\n\n## Package Entry Point\n\n| Import | Purpose |\n| --- | --- |\n| `@vielzeug/illusionist` | `createIllusion`, `Illusionist`, `IllusionistOptions`, `IllusionistLocale`, error classes |\n| `@vielzeug/illusionist/locales` | Tree-shakeable barrel — `en`, `de` locale objects |\n| `@vielzeug/illusionist/locales/en` | English locale object only |\n| `@vielzeug/illusionist/locales/de` | German locale object only |\n| `@vielzeug/illusionist/seed` | `createSeed`, `mulberry32` |\n| `@vielzeug/illusionist/person` | Person category functions |\n| `@vielzeug/illusionist/internet` | Internet category functions |\n| `@vielzeug/illusionist/commerce` | Commerce category functions |\n| `@vielzeug/illusionist/date` | Date category functions |\n| `@vielzeug/illusionist/finance` | Finance category functions |\n| `@vielzeug/illusionist/location` | Location category functions |\n| `@vielzeug/illusionist/lorem` | Lorem category functions |\n| `@vielzeug/illusionist/system` | System category functions |\n\n## createIllusion\n\n```ts\nfunction createIllusion(options: IllusionistOptions): Illusionist;\n```\n\nCreates a bound instance. All categories share one seeded random source and one locale. Locale data is included only when its dedicated subpath is imported; the root entry does not statically import a default locale. For dynamic switching, use `await import('@vielzeug/illusionist/locales')` before calling this synchronous factory.\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `seed` | `number \\| string` | `undefined` | Seed for deterministic output. Omit for cryptographic randomness. |\n| `locale` | `IllusionistLocale` | Required | Explicit locale object for locale-aware categories. |\n\n**Returns:** `Illusionist` — an object with `person`, `internet`, `commerce`, `date`, `finance`, `location`, `lorem`, and `system` categories, plus readonly `seed` and `locale` values. It owns no external resources and requires no cleanup.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 12345, locale: en });\nillusion.person.fullName();\n```\n\n---\n\n## Person\n\n### `person.firstName()`\n\n```ts\nfunction firstName(): string;\n```\n\nReturns a random first name from the locale dataset.\n\n### `person.lastName()`\n\n```ts\nfunction lastName(): string;\n```\n\nReturns a random last name from the locale dataset.\n\n### `person.fullName()`\n\n```ts\nfunction fullName(): string;\n```\n\nReturns a first and last name separated by a space.\n\n### `person.gender()`\n\n```ts\nfunction gender(): string;\n```\n\nReturns a random gender label from the locale dataset.\n\n### `person.prefix()`\n\n```ts\nfunction prefix(): string;\n```\n\nReturns a random name prefix (e.g. `Mr.`, `Dr.`).\n\n### `person.suffix()`\n\n```ts\nfunction suffix(): string;\n```\n\nReturns a random name suffix. Returns an empty string when the locale dataset has no suffixes.\n\n### `person.jobTitle()`\n\n```ts\nfunction jobTitle(): string;\n```\n\nReturns a job area and job type joined by a space.\n\n---\n\n## Internet\n\n### `internet.email()`\n\n```ts\nfunction email(): string;\n```\n\nReturns an email of the form `firstname.lastname@domain.tld`.\n\n### `internet.username()`\n\n```ts\nfunction username(): string;\n```\n\nReturns either a random alphanumeric string or a `firstname.lastname` pattern.\n\n### `internet.password(options?)`\n\n```ts\nfunction password(options?: PasswordOptions): string;\n```\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `length` | `number` | `12` | Password length. |\n| `memorable` | `boolean` | `false` | Build from name fragments and digits. |\n\nReturns a password mixing upper/lowercase letters, digits, and special characters.\n\n### `internet.url()`\n\n```ts\nfunction url(): string;\n```\n\nReturns a URL of the form `protocol://sub.domain.tld/path/...`.\n\n### `internet.domainName()`\n\n```ts\nfunction domainName(): string;\n```\n\nReturns a domain of the form `domain.tld`.\n\n### `internet.ip(version?)`\n\n```ts\nfunction ip(version?: 4 | 6): string;\n```\n\nReturns an IPv4 or IPv6 address. Defaults to IPv4.\n\n### `internet.mac()`\n\n```ts\nfunction mac(): string;\n```\n\nReturns a MAC address of the form `XX:XX:XX:XX:XX:XX`.\n\n### `internet.userAgent()`\n\n```ts\nfunction userAgent(): string;\n```\n\nReturns a random user agent string.\n\n### `internet.httpMethod()`\n\n```ts\nfunction httpMethod(): string;\n```\n\nReturns a random HTTP method.\n\n### `internet.statusCode()`\n\n```ts\nfunction statusCode(): number;\n```\n\nReturns a random HTTP status code.\n\n### `internet.mimeType()`\n\n```ts\nfunction mimeType(): string;\n```\n\nReturns a random MIME type.\n\n---\n\n## Commerce\n\n### `commerce.productAdjective()`\n\n```ts\nfunction productAdjective(): string;\n```\n\nReturns a random product adjective.\n\n### `commerce.productMaterial()`\n\n```ts\nfunction productMaterial(): string;\n```\n\nReturns a random product material.\n\n### `commerce.productNoun()`\n\n```ts\nfunction productNoun(): string;\n```\n\nReturns a random product noun.\n\n### `commerce.productName()`\n\n```ts\nfunction productName(): string;\n```\n\nReturns an adjective, material, and noun joined by spaces.\n\n### `commerce.department()`\n\n```ts\nfunction department(): string;\n```\n\nReturns a random department name.\n\n### `commerce.price(options?)`\n\n```ts\nfunction price(options?: PriceOptions): Money;\n```\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `min` | `number` | `0.01` | Minimum price. |\n| `max` | `number` | `1000` | Maximum price. |\n| `currency` | `'USD' \\| 'EUR' \\| 'GBP'` | `'USD'` | Currency code. |\n\nReturns a coins `Money` value with two decimal places.\n\n### `commerce.productDescription()`\n\n```ts\nfunction productDescription(): string;\n```\n\nReturns one or two sentences describing a product.\n\n---\n\n## Date\n\nAll date functions return tempo `Temporal` objects.\n\n### `date.past(options?)`\n\n```ts\nfunction past(options?: { years?: number; ref?: Temporal.ZonedDateTime }): Temporal.ZonedDateTime;\n```\n\nReturns a date in the past within `years` (default `1`) from `ref` (default now).\n\n### `date.future(options?)`\n\n```ts\nfunction future(options?: { years?: number; ref?: Temporal.ZonedDateTime }): Temporal.ZonedDateTime;\n```\n\nReturns a date in the future within `years` (default `1`) from `ref` (default now).\n\n### `date.recent(options?)`\n\n```ts\nfunction recent(options?: { days?: number; ref?: Temporal.ZonedDateTime }): Temporal.ZonedDateTime;\n```\n\nReturns a date within `days` (default `1`) in the past from `ref` (default now).\n\n### `date.between(from, to)`\n\n```ts\nfunction between(from: Temporal.ZonedDateTime, to: Temporal.ZonedDateTime): Temporal.ZonedDateTime;\n```\n\nReturns a date between `from` and `to`. Returns `from` if `from` is after `to`.\n\n### `date.birthday(options?)`\n\n```ts\nfunction birthday(options?: { minAge?: number; maxAge?: number; ref?: Temporal.ZonedDateTime }): Temporal.PlainDate;\n```\n\nReturns a `PlainDate` with a random age between `minAge` (default `18`) and `maxAge` (default `80`).\n\n### `date.weekday(locale?)`\n\n```ts\nfunction weekday(locale?: string): string;\n```\n\nReturns a random weekday name. Uses the instance locale unless overridden.\n\n### `date.month(locale?)`\n\n```ts\nfunction month(locale?: string): string;\n```\n\nReturns a random month name. Uses the instance locale unless overridden.\n\n---\n\n## Finance\n\n### `finance.amount(options?)`\n\n```ts\nfunction amount(options?: AmountOptions): Money;\n```\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `min` | `number` | `100` | Minimum amount. |\n| `max` | `number` | `10000` | Maximum amount. |\n| `currency` | `'USD' \\| 'EUR' \\| 'GBP'` | `'USD'` | Currency code. |\n\nReturns a coins `Money` value with two decimal places.\n\n### `finance.iban(countryCode?)`\n\n```ts\nfunction iban(countryCode?: string): string;\n```\n\nReturns an IBAN. Pass a country code to fix the country; otherwise a random supported country is chosen. The check digits are computed so the IBAN passes mod-97 validation.\n\n### `finance.bic()`\n\n```ts\nfunction bic(): string;\n```\n\nReturns a BIC/SWIFT code of 8 or 11 characters.\n\n### `finance.creditCardNumber(type?)`\n\n```ts\nfunction creditCardNumber(type?: 'visa' | 'mastercard' | 'amex'): string;\n```\n\nReturns a card number with a valid Luhn check digit. Amex returns 15 digits; others return 16.\n\n### `finance.creditCardCVV(type?)`\n\n```ts\nfunction creditCardCVV(type?: 'visa' | 'mastercard' | 'amex'): string;\n```\n\nReturns a CVV. Amex returns 4 digits; others return 3.\n\n### `finance.bitcoinAddress()`\n\n```ts\nfunction bitcoinAddress(): string;\n```\n\nReturns a Bitcoin address with a `1`, `3`, or `bc1` prefix.\n\n### `finance.ethereumAddress()`\n\n```ts\nfunction ethereumAddress(): string;\n```\n\nReturns a 42-character Ethereum address prefixed with `0x`.\n\n### `finance.transactionType()`\n\n```ts\nfunction transactionType(): string;\n```\n\nReturns a random transaction type label.\n\n### `finance.bank()`\n\n```ts\nfunction bank(): string;\n```\n\nReturns a random bank name.\n\n---\n\n## Location\n\n### `location.city()`\n\n```ts\nfunction city(): string;\n```\n\nReturns a random city from the locale dataset.\n\n### `location.street()`\n\n```ts\nfunction street(): string;\n```\n\nReturns a random street from the locale dataset.\n\n### `location.streetAddress()`\n\n```ts\nfunction streetAddress(): string;\n```\n\nReturns a house number (1–999) followed by a street name.\n\n### `location.zipCode()`\n\n```ts\nfunction zipCode(): string;\n```\n\nReturns a ZIP code matching the locale's pattern.\n\n### `location.state()`\n\n```ts\nfunction state(): string;\n```\n\nReturns a random state or region from the locale dataset.\n\n### `location.country()`\n\n```ts\nfunction country(): string;\n```\n\nReturns a random country from the locale dataset.\n\n### `location.latitude()`\n\n```ts\nfunction latitude(): number;\n```\n\nReturns a latitude in the range `[-90, 90]`.\n\n### `location.longitude()`\n\n```ts\nfunction longitude(): number;\n```\n\nReturns a longitude in the range `[-180, 180]`.\n\n### `location.nearbyGPSCoordinate(ref?)`\n\n```ts\nfunction nearbyGPSCoordinate(ref?: Coordinate): Coordinate;\n```\n\nReturns a coordinate within ~1 degree of `ref`. When `ref` is omitted, a random coordinate is used as the base.\n\n---\n\n## Lorem\n\n### `lorem.word()`\n\n```ts\nfunction word(): string;\n```\n\nReturns a single random word.\n\n### `lorem.words(count?)`\n\n```ts\nfunction words(count?: number): string;\n```\n\nReturns `count` (default `3`) space-joined words.\n\n### `lorem.sentence(wordCount?)`\n\n```ts\nfunction sentence(wordCount?: number): string;\n```\n\nReturns a sentence of `wordCount` words (default 6–12) with a capital first letter and trailing period.\n\n### `lorem.sentences(count?)`\n\n```ts\nfunction sentences(count?: number): string;\n```\n\nReturns `count` (default `3`) space-joined sentences.\n\n### `lorem.paragraph(sentenceCount?)`\n\n```ts\nfunction paragraph(sentenceCount?: number): string;\n```\n\nReturns a paragraph of `sentenceCount` sentences (default 3–7).\n\n### `lorem.paragraphs(count?)`\n\n```ts\nfunction paragraphs(count?: number): string;\n```\n\nReturns `count` (default `3`) newline-joined paragraphs.\n\n### `lorem.slug(wordCount?)`\n\n```ts\nfunction slug(wordCount?: number): string;\n```\n\nReturns a hyphen-joined slug of `wordCount` (default `3`) words.\n\n### `lorem.lines(count?)`\n\n```ts\nfunction lines(count?: number): string;\n```\n\nReturns `count` (default `5`) newline-joined lines, each a sentence.\n\n---\n\n## System\n\n### `system.fileExtension()`\n\n```ts\nfunction fileExtension(): string;\n```\n\nReturns a random file extension.\n\n### `system.fileName()`\n\n```ts\nfunction fileName(): string;\n```\n\nReturns a random file name with extension.\n\n### `system.filePath()`\n\n```ts\nfunction filePath(): string;\n```\n\nReturns a path with 1–4 directory segments and a file name.\n\n### `system.mimeType()`\n\n```ts\nfunction mimeType(): string;\n```\n\nReturns a random MIME type.\n\n### `system.semver(options?)`\n\n```ts\nfunction semver(options?: { maxMajor?: number; includePrerelease?: boolean }): string;\n```\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `maxMajor` | `number` | `20` | Maximum major version. |\n| `includePrerelease` | `boolean` | `false` | Occasionally append a prerelease label. |\n\nReturns a semver string.\n\n### `system.uuid()`\n\n```ts\nfunction uuid(): string;\n```\n\nReturns a random UUID via `crypto.randomUUID()`. **Not deterministic** — ignores the seeded `RandomSource`. Use only when uniqueness matters more than reproducibility.\n\n### `system.port(options?)`\n\n```ts\nfunction port(options?: { min?: number; max?: number }): number;\n```\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `min` | `number` | `1024` | Minimum port. |\n| `max` | `number` | `65535` | Maximum port. |\n\nReturns a random port number.\n\n### `system.cron()`\n\n```ts\nfunction cron(): string;\n```\n\nReturns a random cron expression from common patterns.\n\n### `system.process()`\n\n```ts\nfunction process(): string;\n```\n\nReturns a random process name of the form `prefix_suffix`.\n\n---\n\n## Seed\n\nImport from the `seed` subpath:\n\n```ts\nimport { createSeed, mulberry32 } from '@vielzeug/illusionist/seed';\n```\n\n### `createSeed(seed?)`\n\n```ts\nfunction createSeed(seed?: number | string): RandomSource;\n```\n\nCreates a `RandomSource` from a seed. Number seeds are used directly as mulberry32 state. String seeds are hashed to a 32-bit integer. Omit the seed for cryptographic randomness via `crypto.getRandomValues`. Throws `IllusionistSeedError` for non-finite numeric seeds.\n\n```ts\nconst a = createSeed(12345);    // deterministic\nconst b = createSeed('hello');  // deterministic (hashed)\nconst c = createSeed();         // cryptographic\n```\n\n### `mulberry32(seed)`\n\n```ts\nfunction mulberry32(seed: number): RandomSource;\n```\n\nLow-level 32-bit PRNG. Not cryptographically secure. Returns a `RandomSource` producing floats in `[0, 1)`.\n\n---\n\n## Types\n\n```ts\ntype PersonLocaleData = {\n  readonly firstNameFemale: readonly string[];\n  readonly firstNameMale: readonly string[];\n  readonly gender: readonly string[];\n  readonly jobAreas: readonly string[];\n  readonly jobTypes: readonly string[];\n  readonly lastName: readonly string[];\n  readonly prefix: readonly string[];\n  readonly suffix: readonly string[];\n};\n\ntype LocationLocaleData = {\n  readonly cities: readonly string[];\n  readonly countries: readonly string[];\n  readonly states: readonly string[];\n  readonly streets: readonly string[];\n  readonly zipPattern: string;\n};\n\ntype IllusionistLocale = {\n  readonly code: string;\n  readonly person: PersonLocaleData;\n  readonly location: LocationLocaleData;\n};\n\ntype IllusionistOptions = {\n  seed?: number | string;\n  locale: IllusionistLocale;\n};\n\ntype Illusionist = {\n  readonly person: typeof person;\n  readonly internet: typeof internet;\n  readonly commerce: typeof commerce;\n  readonly date: typeof date;\n  readonly finance: typeof finance;\n  readonly location: typeof location;\n  readonly lorem: typeof lorem;\n  readonly system: typeof system;\n  readonly seed: number | string | undefined;\n  readonly locale: IllusionistLocale;\n};\n\ntype Coordinate = {\n  lat: number;\n  lng: number;\n};\n\ntype PasswordOptions = {\n  length?: number;\n  memorable?: boolean;\n};\n\ntype PriceOptions = {\n  readonly min?: number;\n  readonly max?: number;\n  readonly currency?: 'USD' | 'EUR' | 'GBP';\n};\n\ntype AmountOptions = {\n  readonly min?: number;\n  readonly max?: number;\n  readonly currency?: 'USD' | 'EUR' | 'GBP';\n};\n\n// Re-exported from @vielzeug/arsenal\ntype RandomSource = {\n  next(): number; // finite float in [0, 1)\n};\n```\n\nCategory helpers throw `RangeError` when a custom source returns a non-finite value or a value outside `[0, 1)`.\n\n## Errors\n\nAll errors extend `IllusionistError`, which extends `Error`. Use `instanceof IllusionistError` to catch any illusionist-originated error.\n\n| Error | Trigger | Notable properties |\n| --- | --- | --- |\n| `IllusionistError` | Base class for all illusionist errors | `name`, `message` |\n| `IllusionistSeedError` | Non-finite numeric seed passed to `createSeed` (`NaN`, `Infinity`, `-Infinity`) | `name`, `message` |\n\n```ts\nimport { IllusionistError, IllusionistSeedError, createSeed } from '@vielzeug/illusionist';\n\ntry {\n  createSeed(Number.NaN);\n} catch (error) {\n  if (error instanceof IllusionistSeedError) {\n    console.log(error.message);\n  }\n}\n```\n",
+    "usage": "---\ntitle: Illusionist — Usage Guide\ndescription: Generate deterministic, locale-aware fake data with Illusionist.\n---\n\n[[toc]]\n\n## Basic Usage\n\nCreate an illusionist instance with `createIllusion`. Access data through the eight bound categories. Each call consumes from the shared random source, so output is deterministic for a given seed.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 12345, locale: en });\n\nillusion.person.firstName();       // 'Ashley'\nillusion.internet.username();      // 'fVEv9zc638m'\nillusion.commerce.productName();   // 'Intelligent Granite Table'\nillusion.date.recent({ days: 7 }); // Temporal.ZonedDateTime within the last week\nillusion.lorem.sentence();         // 'Enim ex non ea minim amet sint laborum proident nisi anim officia.'\n\n```\n\n## Seeded Determinism\n\nPass a number or string seed to make output reproducible. The same seed always produces the same sequence across runs, machines, and Node versions.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst a = createIllusion({ seed: 12345, locale: en });\nconst b = createIllusion({ seed: 12345, locale: en });\n\na.person.fullName() === b.person.fullName(); // true\n\nconst c = createIllusion({ seed: 'my-test-suite', locale: en });\nconst d = createIllusion({ seed: 'my-test-suite', locale: en });\n\nc.internet.email() === d.internet.email(); // true — string seeds are hashed\n```\n\nOmit the seed for cryptographic randomness backed by `crypto.getRandomValues`. Output is then non-deterministic and unsuitable for snapshots.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst random = createIllusion({ locale: en });\nrandom.person.fullName(); // different every run\n```\n\n## Locale Support\n\nImport a locale object and pass it at creation time. The `person` and `location` categories draw from that object's datasets. The `date.weekday` and `date.month` functions use its locale code.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { de, en } from '@vielzeug/illusionist/locales';\n\nconst english = createIllusion({ seed: 1, locale: en });\nconst german = createIllusion({ seed: 1, locale: de });\n\nenglish.person.firstName(); // 'Mary'\ngerman.person.firstName();  // 'Mia'\n\nenglish.location.city(); // 'Austin'\ngerman.location.city();  // 'Bremen'\n\nenglish.date.month(); // 'December'\ngerman.date.month();  // 'Dezember'\n```\n\nThe locale is fixed for the lifetime of an instance. Each locale is a separate subpath, so locale data ships only when that subpath is imported; the root package does not statically include English or German data. Create a new instance to switch locales.\n\nFor dynamic app switching, load the desired locale before calling the synchronous factory:\n\n```ts\nconst { de } = await import('@vielzeug/illusionist/locales/de');\nconst german = createIllusion({ locale: de });\n```\n\n### Custom Locales\n\nThe shipped `en` and `de` objects are just plain data that `satisfies IllusionistLocale`. Build your own the same way — import the type, assemble the `person` and `location` datasets, and pass the result to `createIllusion`. No registration step; the factory accepts any object that matches the shape.\n\n```ts\nimport { createIllusion, type IllusionistLocale } from '@vielzeug/illusionist';\n\nconst fr: IllusionistLocale = {\n  code: 'fr',\n  person: {\n    firstNameFemale: ['Marie', 'Camille', 'Sophie'],\n    firstNameMale: ['Louis', 'Hugo', 'Léo'],\n    lastName: ['Martin', 'Bernard', 'Dubois'],\n    gender: ['féminin', 'masculin', 'non-binaire'],\n    jobAreas: ['marketing', 'ingénierie', 'ventes'],\n    jobTypes: ['directeur', 'ingénieur', 'analyste'],\n    prefix: ['M.', 'Mme', 'Dr.'],\n    suffix: ['PhD', 'Jr.'],\n  },\n  location: {\n    cities: ['Paris', 'Lyon', 'Marseille'],\n    countries: ['France', 'Belgique', 'Suisse'],\n    states: ['Île-de-France', 'Auvergne-Rhône-Alpes', 'Provence-Alpes-Côte d\\'Azur'],\n    streets: ['rue de la Paix', 'avenue des Champs-Élysées', 'boulevard Saint-Germain'],\n    zipPattern: '#####',\n  },\n};\n\nconst illusion = createIllusion({ seed: 42, locale: fr });\n\nillusion.person.fullName();    // 'Camille Dubois'\nillusion.location.city();      // 'Marseille'\nillusion.person.jobTitle();    // 'marketing ingénieur'\n```\n\n`date.weekday()` and `date.month()` currently ship English and German name arrays only; a custom locale code falls through to the English set. For other languages, format a generated `Temporal` date with `@vielzeug/tempo`'s `format()` and your own `Intl.DateTimeFormat` options.\n\nUse `satisfies IllusionistLocale` instead of a bare type annotation to get error locality — TypeScript points at the offending field rather than the whole object.\n\n## Category Overview\n\n| Category | Example call                        | Returns |\n| --- |-------------------------------------| --- |\n| `person` | `illusion.person.fullName()`        | `string` |\n| `internet` | `illusion.internet.email()`         | `string` |\n| `commerce` | `illusion.commerce.price()`         | `Money` (coins) |\n| `date` | `illusion.date.past({ years: 1 })`  | `Temporal.ZonedDateTime` (tempo) |\n| `finance` | `illusion.finance.iban()`           | `string` |\n| `location` | `illusion.location.streetAddress()` | `string` |\n| `lorem` | `illusion.lorem.paragraph()`        | `string` |\n| `system` | `illusion.system.uuid()`            | `string` |\n\n## Working with Other Vielzeug Libraries\n\nIllusionist integrates with other Vielzeug packages at the return-type level. `commerce.price()` and `finance.amount()` return coins `Money`, so you can format, add, or allocate them directly. `date` functions return tempo `Temporal` objects, so you can shift, compare, or format them.\n\n```ts\nimport { format, add, money } from '@vielzeug/coins';\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\nimport { formatZonedDateTimeISO } from '@vielzeug/tempo';\n\nconst illusion = createIllusion({ seed: 42, locale: en });\n\nconst price = illusion.commerce.price({ min: 10, max: 50, currency: 'EUR' });\nconst tax = money('5.00', price.currency);\nconst total = add(price, tax);\n\nconsole.log(format(total, { locale: 'de-DE' }));\n\nconst orderDate = illusion.date.recent({ days: 30 });\nconsole.log(formatZonedDateTimeISO(orderDate));\n```\n\n## Best Practices\n\n- Pass a seed in tests and CI; omit it only for one-off non-reproducible mocks.\n- Create one instance per test case so each test starts from a known random state.\n- Treat instances as ordinary stateful values; they own no resources and require no cleanup.\n- Fix the locale at creation time; create a new instance to switch locales rather than mixing.\n- Use string seeds for named test suites — they are self-documenting and hash to a stable number.\n- Combine `person`, `internet`, and `location` to build internally consistent mock entities.\n- Treat `Money` and `Temporal` return values as first-class — pass them to coins and tempo functions directly.\n- Avoid sharing a single instance across concurrent async tasks; each call advances the shared random source.\n- `system.uuid()` uses `crypto.randomUUID()`, not the seeded source. Do not use it in deterministic fixtures or snapshot tests.\n",
+    "examples": "---\ntitle: Illusionist — Examples\ndescription: Practical examples and recipes for @vielzeug/illusionist.\n---\n\n[[toc]]\n\n## Generating Test Fixtures\n\nBuild a batch of realistic records from a fixed seed. The same seed reproduces the same fixtures in every run. For a full Vitest setup, see the [Test Fixtures recipe](./examples/test-fixtures.md).\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 'fixtures-v1', locale: en });\n\nconst users = Array.from({ length: 10 }, () => ({\n  name: illusion.person.fullName(),\n  email: illusion.internet.email(),\n  address: illusion.location.streetAddress(),\n  city: illusion.location.city(),\n  zip: illusion.location.zipCode(),\n}));\n\n```\n\n## Seeded Test Data for Snapshot Testing\n\nUse a named string seed so snapshot output is stable across CI runs. Each test creates its own instance to avoid cross-test random-state drift.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\ntest('order receipt snapshot', () => {\n  const illusion = createIllusion({ seed: 'order-receipt', locale: en });\n\n  const order = {\n    customer: illusion.person.fullName(),\n    product: illusion.commerce.productName(),\n    price: illusion.commerce.price({ min: 5, max: 50 }),\n    date: illusion.date.recent({ days: 7 }),\n  };\n\n  expect(order).toMatchInlineSnapshot();\n  });\n```\n\n## Locale-Specific Data (German)\n\nImport the German locale object to draw names, cities, and weekday labels from its dataset.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { de } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 42, locale: de });\n\nillusion.person.fullName();  // 'Mathilda Scholz'\nillusion.location.city();    // 'Nürnberg'\nillusion.location.zipCode(); // '15268'\nillusion.date.weekday();     // 'Donnerstag'\nillusion.date.month();       // 'März'\n\n```\n\n## E-commerce Mock Data\n\nCombine `person`, `commerce`, and `location` to build a consistent customer-order-shipping record. `commerce.price()` returns coins `Money`, so you can format it directly.\n\n```ts\nimport { format } from '@vielzeug/coins';\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 'ecommerce-mock', locale: en });\n\nconst order = {\n  customer: {\n    name: illusion.person.fullName(),\n    email: illusion.internet.email(),\n  },\n  item: illusion.commerce.productName(),\n  price: illusion.commerce.price({ min: 20, max: 200, currency: 'EUR' }),\n  shipping: {\n    address: illusion.location.streetAddress(),\n    city: illusion.location.city(),\n    zip: illusion.location.zipCode(),\n    country: illusion.location.country(),\n  },\n};\n\nconsole.log(format(order.price, { locale: 'de-DE' }));\n```\n\n## Database Seeding Pattern\n\nGenerate rows for a database seed script. Use a stable seed so the seed file is reproducible and reviewable.\n\n```ts\nimport { createIllusion } from '@vielzeug/illusionist';\nimport { en } from '@vielzeug/illusionist/locales';\n\nconst illusion = createIllusion({ seed: 'db-seed-2024', locale: en });\n\nconst products = Array.from({ length: 50 }, () => ({\n  name: illusion.commerce.productName(),\n  department: illusion.commerce.department(),\n  price: illusion.commerce.price({ min: 1, max: 500 }),\n  description: illusion.commerce.productDescription(),\n}));\n\nconst customers = Array.from({ length: 100 }, () => ({\n  firstName: illusion.person.firstName(),\n  lastName: illusion.person.lastName(),\n  email: illusion.internet.email(),\n  createdAt: illusion.date.past({ years: 2 }),\n}));\n\n```\n"
+  },
+  "examples": [
+    {
+      "id": "commerce-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.commerce.productName())\nconsole.log(illusion.commerce.department())\nconsole.log(illusion.commerce.price({ min: 10, max: 50, currency: 'EUR' }))\nconsole.log(illusion.commerce.productDescription())",
+      "name": "commerce - Products, departments, and prices"
+    },
+    {
+      "id": "date-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.date.past({ years: 2 }).toString())\nconsole.log(illusion.date.future({ years: 1 }).toString())\nconsole.log(illusion.date.recent({ days: 7 }).toString())\nconsole.log(illusion.date.birthday({ minAge: 25, maxAge: 35 }).toString())\nconsole.log(illusion.date.weekday())\nconsole.log(illusion.date.month())",
+      "name": "date - Past, future, birthdays, and locale labels"
+    },
+    {
+      "id": "determinism-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst a = createIllusion({ seed: 'test-fixture', locale: en })\nconst b = createIllusion({ seed: 'test-fixture', locale: en })\n\nconsole.log(a.person.fullName() === b.person.fullName())\nconsole.log(a.internet.email() === b.internet.email())",
+      "name": "seed - Deterministic output from the same seed"
+    },
+    {
+      "id": "finance-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.finance.iban())\nconsole.log(illusion.finance.iban('DE'))\nconsole.log(illusion.finance.bic())\nconsole.log(illusion.finance.creditCardNumber('visa'))\nconsole.log(illusion.finance.creditCardCVV('amex'))\nconsole.log(illusion.finance.ethereumAddress())",
+      "name": "finance - IBANs, cards, BICs, and crypto addresses"
+    },
+    {
+      "id": "internet-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.internet.email())\nconsole.log(illusion.internet.username())\nconsole.log(illusion.internet.url())\nconsole.log(illusion.internet.ip())\nconsole.log(illusion.internet.ip(6))\nconsole.log(illusion.internet.mac())",
+      "name": "internet - Emails, URLs, and network addresses"
+    },
+    {
+      "id": "locale-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en, de } from '@vielzeug/illusionist/locales'\n\nconst illusion = {\n  en: createIllusion({ seed: 42, locale: en }),\n  de: createIllusion({ seed: 42, locale: de })\n};\n\nconsole.log(illusion.en.person.fullName())\nconsole.log(illusion.de.person.fullName())\nconsole.log(illusion.en.location.city())\nconsole.log(illusion.de.location.city())\nconsole.log(illusion.en.date.month())\nconsole.log(illusion.de.date.month())",
+      "name": "locales - English and German side-by-side"
+    },
+    {
+      "id": "location-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.location.city())\nconsole.log(illusion.location.streetAddress())\nconsole.log(illusion.location.zipCode())\nconsole.log(illusion.location.state())\nconsole.log(illusion.location.country())\nconsole.log(illusion.location.latitude())\nconsole.log(illusion.location.longitude())",
+      "name": "location - Addresses, regions, and coordinates"
+    },
+    {
+      "id": "person-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.person.fullName())\nconsole.log(illusion.person.firstName())\nconsole.log(illusion.person.lastName())\nconsole.log(illusion.person.jobTitle())\nconsole.log(illusion.person.gender())",
+      "name": "person - Names, gender, and job titles"
+    },
+    {
+      "id": "system-basic",
+      "code": "import { createIllusion } from '@vielzeug/illusionist'\nimport { en } from '@vielzeug/illusionist/locales'\n\nconst illusion = createIllusion({ seed: 12345, locale: en })\n\nconsole.log(illusion.system.filePath())\nconsole.log(illusion.system.semver({ includePrerelease: true }))\nconsole.log(illusion.system.uuid())\nconsole.log(illusion.system.port())\nconsole.log(illusion.system.cron())\nconsole.log(illusion.system.process())",
+      "name": "system - Files, semver, UUIDs, ports, and cron"
+    }
+  ],
+  "typeSignatures": {
+    "PriceOptions": "export type PriceOptions = {\n  readonly min?: number;\n  readonly max?: number;\n  readonly currency?: 'USD' | 'EUR' | 'GBP';\n};",
+    "productAdjective": "export function productAdjective(ctx: IllusionistContext): string {\n  return pick(COMMERCE_DATA.productAdjectives, ctx.source)!;\n}",
+    "productMaterial": "export function productMaterial(ctx: IllusionistContext): string {\n  return pick(COMMERCE_DATA.productMaterials, ctx.source)!;\n}",
+    "productNoun": "export function productNoun(ctx: IllusionistContext): string {\n  return pick(COMMERCE_DATA.productNouns, ctx.source)!;\n}",
+    "productName": "export function productName(ctx: IllusionistContext): string {\n  return `${productAdjective(ctx)} ${productMaterial(ctx)} ${productNoun(ctx)}`;\n}",
+    "department": "export function department(ctx: IllusionistContext): string {\n  return pick(COMMERCE_DATA.departments, ctx.source)!;\n}",
+    "price": "export function price(ctx: IllusionistContext, opts: PriceOptions = {}): Money {\n  const min = opts.min ?? 0.01;\n  const max = opts.max ?? 1000;\n  const code = opts.currency ?? 'USD';\n  const amount = floatFixed(min, max, 2, ctx.source);\n\n  return money(amount.toFixed(2), CURRENCIES[code]);\n}",
+    "productDescription": "export function productDescription(ctx: IllusionistContext): string {\n  const sentences = int(1, 2, ctx.source);\n  const parts: string[] = [];\n\n  for (let i = 0; i < sentences; i++) {\n    const adjective = pick(COMMERCE_DATA.productAdjectives, ctx.source)!;\n    const material = pick(COMMERCE_DATA.productMaterials, ctx.source)!;\n    const noun = pick(COMMERCE_DATA.productNouns, ctx.source)!;\n    const department = pick(COMMERCE_DATA.departments, ctx.source)!;\n\n    parts.push(\n      `The ${adjective.toLowerCase()} ${material.toLowerCase()} ${noun.toLowerCase()} is a great choice for your ${department.toLowerCase()} needs.`,\n    );\n  }\n\n  return parts.join(' ');\n}",
+    "past": "export function past(ctx: IllusionistContext, options?: DateOptions): Temporal.ZonedDateTime {\n  const ref = resolveRef(options?.ref);\n  const years = options?.years ?? 1;\n  const maxSeconds = years * 365 * 24 * 60 * 60;\n  const minSeconds = 1;\n\n  return ref.add({ seconds: -int(minSeconds, maxSeconds, ctx.source) });\n}",
+    "future": "export function future(ctx: IllusionistContext, options?: DateOptions): Temporal.ZonedDateTime {\n  const ref = resolveRef(options?.ref);\n  const years = options?.years ?? 1;\n  const maxSeconds = years * 365 * 24 * 60 * 60;\n\n  return ref.add({ seconds: int(1, maxSeconds, ctx.source) });\n}",
+    "recent": "export function recent(\n  ctx: IllusionistContext,\n  options?: { days?: number; ref?: Temporal.ZonedDateTime },\n): Temporal.ZonedDateTime {\n  const ref = resolveRef(options?.ref);\n  const days = options?.days ?? 1;\n  const maxSeconds = days * 24 * 60 * 60;\n\n  return ref.add({ seconds: -int(1, maxSeconds, ctx.source) });\n}",
+    "between": "export function between(\n  ctx: IllusionistContext,\n  from: Temporal.ZonedDateTime,\n  to: Temporal.ZonedDateTime,\n): Temporal.ZonedDateTime {\n  const fromNs = from.toInstant().epochNanoseconds;\n  const toNs = to.toInstant().epochNanoseconds;\n\n  if (fromNs > toNs) {\n    return from;\n  }\n\n  const spanNs = toNs - fromNs;\n  const spanSeconds = Number(spanNs / 1_000_000_000n);\n  const offsetSeconds = Math.floor(ctx.source.next() * spanSeconds);\n\n  return from.add({ seconds: offsetSeconds });\n}",
+    "birthday": "export function birthday(\n  ctx: IllusionistContext,\n  options?: { minAge?: number; maxAge?: number; ref?: Temporal.ZonedDateTime },\n): Temporal.PlainDate {\n  const ref = resolveRef(options?.ref);\n  const minAge = options?.minAge ?? 18;\n  const maxAge = options?.maxAge ?? 80;\n  const age = int(minAge, maxAge, ctx.source);\n  const month = int(1, 12, ctx.source);\n  const day = int(1, 28, ctx.source);\n\n  return ref.toPlainDate().subtract({ years: age }).with({ day, month });\n}",
+    "weekday": "export function weekday(ctx: IllusionistContext, locale?: string): string {\n  const days = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'];\n  const loc = locale ?? ctx.locale.code;\n  const localized =\n    loc === 'de' ? ['Montag', 'Dienstag', 'Mittwoch', 'Donnerstag', 'Freitag', 'Samstag', 'Sonntag'] : days;\n\n  return localized[int(0, 6, ctx.source)]!;\n}",
+    "month": "export function month(ctx: IllusionistContext, locale?: string): string {\n  const months = [\n    'January',\n    'February',\n    'March',\n    'April',\n    'May',\n    'June',\n    'July',\n    'August',\n    'September',\n    'October',\n    'November',\n    'December',\n  ];\n  const loc = locale ?? ctx.locale.code;\n  const localized =\n    loc === 'de'\n      ? [\n          'Januar',\n          'Februar',\n          'März',\n          'April',\n          'Mai',\n          'Juni',\n          'Juli',\n          'August',\n          'September',\n          'Oktober',\n          'November',\n          'Dezember',\n        ]\n      : months;\n\n  return localized[int(0, 11, ctx.source)]!;\n}",
+    "IllusionistError": "export class IllusionistError extends Error {\n  constructor(message: string, opts?: ErrorOptions) {\n    super(message, opts);\n    this.name = new.target.name;\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n}",
+    "IllusionistSeedError": "export class IllusionistSeedError extends IllusionistError {}",
+    "IllusionistOptions": "export type { IllusionistOptions } from './types';\n\nexport type IllusionistOptions = {\n  /** Numeric or string seed for deterministic output. Omit for cryptographic randomness. */\n  seed?: number | string;\n  /** Locale data for locale-aware categories. */\n  locale: IllusionistLocale;\n};",
+    "Illusionist": "export type Illusionist = {\n  readonly person: BoundApi<typeof personApi>;\n  readonly internet: BoundApi<typeof internetApi>;\n  readonly commerce: BoundApi<typeof commerceApi>;\n  readonly date: BoundApi<typeof dateApi>;\n  readonly finance: BoundApi<typeof financeApi>;\n  readonly location: BoundApi<typeof locationApi>;\n  readonly lorem: BoundApi<typeof loremApi>;\n  readonly system: BoundApi<typeof systemApi>;\n\n  /** The seed used to initialize this instance, or `undefined` for cryptographic randomness. */\n  readonly seed: number | string | undefined;\n  /** The active locale data. */\n  readonly locale: IllusionistLocale;\n};",
+    "createIllusion": "export function createIllusion(options: IllusionistOptions): Illusionist {\n  const { locale, seed } = options;\n  const source: RandomSource = createSeed(seed);\n\n  const ctx: IllusionistContext = { locale, source };\n\n  const bind = <T extends Record<string, (ctx: IllusionistContext, ...args: never[]) => unknown>>(\n    api: T,\n  ): BoundApi<T> => {\n    const bound = {} as Record<string, (...args: never[]) => unknown>;\n\n    for (const [key, fn] of Object.entries(api)) {\n      if (typeof fn === 'function') {\n        bound[key] = (...args: never[]) => (fn as (ctx: IllusionistContext, ...args: never[]) => unknown)(ctx, ...args);\n      }\n    }\n\n    return bound as unknown as BoundApi<T>;\n  };\n\n  return {\n    commerce: bind(commerceApi),\n    date: bind(dateApi),\n    finance: bind(financeApi),\n    internet: bind(internetApi),\n    locale,\n    location: bind(locationApi),\n    lorem: bind(loremApi),\n    person: bind(personApi),\n    seed,\n    system: bind(systemApi),\n  };\n}",
+    "AmountOptions": "export type AmountOptions = {\n  readonly min?: number;\n  readonly max?: number;\n  readonly currency?: 'USD' | 'EUR' | 'GBP';\n};",
+    "amount": "export function amount(ctx: IllusionistContext, opts: AmountOptions = {}): Money {\n  const min = opts.min ?? 100;\n  const max = opts.max ?? 10000;\n  const code = opts.currency ?? 'USD';\n  const value = floatFixed(min, max, 2, ctx.source);\n\n  return money(value.toFixed(2), CURRENCIES[code]);\n}",
+    "iban": "export function iban(ctx: IllusionistContext, countryCode?: string): string {\n  const country = (countryCode ?? pick(IBAN_COUNTRIES, ctx.source)!) as keyof typeof FINANCE_DATA.ibanLengths;\n\n  if (!(country in FINANCE_DATA.ibanLengths)) {\n    throw new RangeError(`iban: unsupported country code \"${countryCode}\". Supported: ${IBAN_COUNTRIES.join(', ')}`);\n  }\n\n  const totalLength = FINANCE_DATA.ibanLengths[country];\n  const bbanLength = totalLength - 4;\n  const bban = numericString(bbanLength, ctx.source);\n  const checkDigits = ibanCheckDigits(country, bban);\n\n  return `${country}${checkDigits}${bban}`;\n}",
+    "bic": "export function bic(ctx: IllusionistContext): string {\n  const bankCode = letters(4, ctx);\n  const country = letters(2, ctx);\n  const location = alphanumeric(2, ctx.source).toUpperCase();\n  const useBranch = int(0, 1, ctx.source) === 1;\n  const branch = useBranch ? alphanumeric(3, ctx.source).toUpperCase() : '';\n\n  return `${bankCode}${country}${location}${branch}`;\n}",
+    "creditCardNumber": "export function creditCardNumber(ctx: IllusionistContext, type?: CreditCardType): string {\n  const cardType = type ?? pick(CREDIT_CARD_TYPES, ctx.source)!;\n  const iin = pick(FINANCE_DATA.creditCardIins[cardType], ctx.source)!;\n  const totalLength = cardType === 'amex' ? 15 : 16;\n  const partial = iin + numericString(totalLength - iin.length - 1, ctx.source);\n  const checkDigit = luhnCheckDigit(partial);\n\n  return `${partial}${checkDigit}`;\n}",
+    "creditCardCVV": "export function creditCardCVV(ctx: IllusionistContext, type?: CreditCardType): string {\n  const cardType = type ?? pick(CREDIT_CARD_TYPES, ctx.source)!;\n  const length = cardType === 'amex' ? 4 : 3;\n\n  return numericString(length, ctx.source);\n}",
+    "bitcoinAddress": "export function bitcoinAddress(ctx: IllusionistContext): string {\n  const prefix = pick(['1', '3', 'bc1'], ctx.source)!;\n  const suffixLength = int(25, 34, ctx.source);\n\n  return `${prefix}${base58String(suffixLength, ctx.source)}`;\n}",
+    "ethereumAddress": "export function ethereumAddress(ctx: IllusionistContext): string {\n  return `0x${hexString(40, ctx.source)}`;\n}",
+    "transactionType": "export function transactionType(ctx: IllusionistContext): string {\n  return pick(FINANCE_DATA.transactionTypes, ctx.source)!;\n}",
+    "bank": "export function bank(ctx: IllusionistContext): string {\n  return pick(FINANCE_DATA.banks, ctx.source)!;\n}",
+    "email": "export function email(ctx: IllusionistContext): string {\n  const first = (\n    pick(ctx.locale.person.firstNameFemale, ctx.source) ??\n    pick(ctx.locale.person.firstNameMale, ctx.source) ??\n    'user'\n  ).toLowerCase();\n  const last = (pick(ctx.locale.person.lastName, ctx.source) ?? 'name').toLowerCase();\n  const domain = pick(INTERNET_DATA.domains, ctx.source) ?? 'example';\n  const tld = pick(INTERNET_DATA.tlds, ctx.source) ?? 'com';\n  return `${first}.${last}@${domain}.${tld}`;\n}",
+    "username": "export function username(ctx: IllusionistContext): string {\n  if (int(0, 1, ctx.source) === 0) {\n    return alphanumeric(int(6, 12, ctx.source), ctx.source);\n  }\n  const first = (\n    pick(ctx.locale.person.firstNameFemale, ctx.source) ??\n    pick(ctx.locale.person.firstNameMale, ctx.source) ??\n    'user'\n  ).toLowerCase();\n  const last = (pick(ctx.locale.person.lastName, ctx.source) ?? 'name').toLowerCase();\n  return `${first}.${last}`;\n}",
+    "PasswordOptions": "export type PasswordOptions = {\n  /** Password length. Defaults to `12`. */\n  length?: number;\n  /** When `true`, builds a memorable password from name fragments and digits. */\n  memorable?: boolean;\n};",
+    "password": "export function password(ctx: IllusionistContext, opts: PasswordOptions = {}): string {\n  const length = opts.length ?? 12;\n\n  if (opts.memorable) {\n    const first = (\n      pick(ctx.locale.person.firstNameFemale, ctx.source) ??\n      pick(ctx.locale.person.firstNameMale, ctx.source) ??\n      'user'\n    ).toLowerCase();\n    const last = (pick(ctx.locale.person.lastName, ctx.source) ?? 'name').toLowerCase();\n    const num = String(int(10, 99, ctx.source));\n    const special = pick(SPECIAL_CHARS.split(''), ctx.source) ?? '!';\n    const base = `${first}${last}${num}${special}`;\n    if (base.length <= length) return base + alphanumeric(length - base.length, ctx.source);\n    // Truncation would cut the special char/number — put them first, then fill from the name.\n    const essential = `${num}${special}`;\n    const remaining = length - essential.length;\n    const namePart = remaining > 0 ? (first + last).slice(0, remaining) : '';\n    const result = essential + namePart;\n\n    return result.length < length ? result + alphanumeric(length - result.length, ctx.source) : result.slice(0, length);\n  }\n\n  const upper = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';\n  const lower = 'abcdefghijklmnopqrstuvwxyz';\n  const digits = '0123456789';\n  const pools = [upper, lower, digits, SPECIAL_CHARS];\n\n  // Guarantee at least one char from each pool, then fill the rest randomly.\n  const chars: string[] = [];\n  for (const pool of pools) {\n    chars.push(pick(pool.split(''), ctx.source)!);\n  }\n  const all = upper + lower + digits + SPECIAL_CHARS;\n  while (chars.length < length) {\n    chars.push(pick(all.split(''), ctx.source)!);\n  }\n\n  // Shuffle via Fisher-Yates using ctx.source.\n  for (let i = chars.length - 1; i > 0; i--) {\n    const j = int(0, i, ctx.source);\n    [chars[i], chars[j]] = [chars[j]!, chars[i]!];\n  }\n\n  return chars.slice(0, length).join('');\n}",
+    "url": "export function url(ctx: IllusionistContext): string {\n  const protocol = pick(INTERNET_DATA.protocols, ctx.source) ?? 'https';\n  const sub = pick(['www', 'api', 'app', 'mail', 'static', 'cdn'], ctx.source) ?? 'www';\n  const domain = pick(INTERNET_DATA.domains, ctx.source) ?? 'example';\n  const tld = pick(INTERNET_DATA.tlds, ctx.source) ?? 'com';\n  const host = `${sub}.${domain}.${tld}`;\n\n  const segmentCount = int(1, 4, ctx.source);\n  const segments: string[] = [];\n  for (let i = 0; i < segmentCount; i++) {\n    const word = pick(URL_PATH_WORDS, ctx.source) ?? 'api';\n    // Occasionally append a numeric or short alphanumeric suffix to a segment.\n    if (int(0, 2, ctx.source) === 0) {\n      segments.push(`${word}-${alphanumeric(int(2, 5), ctx.source).toLowerCase()}`);\n    } else {\n      segments.push(word);\n    }\n  }\n\n  return `${protocol}://${host}/${segments.join('/')}`;\n}",
+    "domainName": "export function domainName(ctx: IllusionistContext): string {\n  const domain = pick(INTERNET_DATA.domains, ctx.source) ?? 'example';\n  const tld = pick(INTERNET_DATA.tlds, ctx.source) ?? 'com';\n  return `${domain}.${tld}`;\n}",
+    "ip": "export function ip(ctx: IllusionistContext, version: 4 | 6 = 4): string {\n  if (version === 6) {\n    const groups: string[] = [];\n    for (let i = 0; i < 8; i++) {\n      groups.push(hexString(4, ctx.source));\n    }\n    return groups.join(':');\n  }\n  const octets: number[] = [];\n  for (let i = 0; i < 4; i++) {\n    octets.push(int(0, 255, ctx.source));\n  }\n  return octets.join('.');\n}",
+    "mac": "export function mac(ctx: IllusionistContext): string {\n  const parts: string[] = [];\n  for (let i = 0; i < 6; i++) {\n    parts.push(hexString(2, ctx.source));\n  }\n  return parts.join(':');\n}",
+    "userAgent": "export function userAgent(ctx: IllusionistContext): string {\n  return pick(INTERNET_DATA.userAgents, ctx.source) ?? INTERNET_DATA.userAgents[0]!;\n}",
+    "httpMethod": "export function httpMethod(ctx: IllusionistContext): string {\n  return pick(INTERNET_DATA.httpMethods, ctx.source) ?? 'GET';\n}",
+    "statusCode": "export function statusCode(ctx: IllusionistContext): number {\n  return pick(INTERNET_DATA.statusCodes, ctx.source) ?? 200;\n}",
+    "mimeType": "export function mimeType(ctx: IllusionistContext): string {\n  return pick(INTERNET_DATA.mimeTypes, ctx.source) ?? 'text/plain';\n}",
+    "Coordinate": "export type Coordinate = {\n  lat: number;\n  lng: number;\n};",
+    "city": "export function city(ctx: IllusionistContext): string {\n  return pick(data(ctx).cities, ctx.source)!;\n}",
+    "street": "export function street(ctx: IllusionistContext): string {\n  return pick(data(ctx).streets, ctx.source)!;\n}",
+    "streetAddress": "export function streetAddress(ctx: IllusionistContext): string {\n  const houseNumber = Math.floor(float(1, 1000, ctx.source));\n  return `${houseNumber} ${street(ctx)}`;\n}",
+    "zipCode": "export function zipCode(ctx: IllusionistContext): string {\n  const pattern = data(ctx).zipPattern;\n\n  return pattern.replace(/#/g, () => String(Math.floor(nextFloat(ctx.source) * 10)));\n}",
+    "state": "export function state(ctx: IllusionistContext): string {\n  return pick(data(ctx).states, ctx.source)!;\n}",
+    "country": "export function country(ctx: IllusionistContext): string {\n  return pick(data(ctx).countries, ctx.source)!;\n}",
+    "latitude": "export function latitude(ctx: IllusionistContext): number {\n  return float(-90, 90, ctx.source);\n}",
+    "longitude": "export function longitude(ctx: IllusionistContext): number {\n  return float(-180, 180, ctx.source);\n}",
+    "nearbyGPSCoordinate": "export function nearbyGPSCoordinate(ctx: IllusionistContext, ref?: Coordinate): Coordinate {\n  const base = ref ?? { lat: latitude(ctx), lng: longitude(ctx) };\n  return {\n    lat: float(base.lat - 1, base.lat + 1, ctx.source),\n    lng: float(base.lng - 1, base.lng + 1, ctx.source),\n  };\n}",
+    "word": "export function word(ctx: IllusionistContext): string {\n  return pick(LOREM_DATA.words, ctx.source)!;\n}",
+    "words": "export function words(ctx: IllusionistContext, count = 3): string {\n  const out: string[] = [];\n  for (let i = 0; i < count; i++) {\n    out.push(word(ctx));\n  }\n  return out.join(' ');\n}",
+    "sentence": "export function sentence(ctx: IllusionistContext, wordCount?: number): string {\n  const count = wordCount ?? Math.floor(float(6, 13, ctx.source));\n  const text = words(ctx, count);\n  return `${text.charAt(0).toUpperCase()}${text.slice(1)}.`;\n}",
+    "sentences": "export function sentences(ctx: IllusionistContext, count = 3): string {\n  const out: string[] = [];\n  for (let i = 0; i < count; i++) {\n    out.push(sentence(ctx));\n  }\n  return out.join(' ');\n}",
+    "paragraph": "export function paragraph(ctx: IllusionistContext, sentenceCount?: number): string {\n  const count = sentenceCount ?? Math.floor(float(3, 8, ctx.source));\n  return sentences(ctx, count);\n}",
+    "paragraphs": "export function paragraphs(ctx: IllusionistContext, count = 3): string {\n  const out: string[] = [];\n  for (let i = 0; i < count; i++) {\n    out.push(paragraph(ctx));\n  }\n  return out.join('\\n');\n}",
+    "slug": "export function slug(ctx: IllusionistContext, wordCount = 3): string {\n  const out: string[] = [];\n  for (let i = 0; i < wordCount; i++) {\n    out.push(word(ctx));\n  }\n  return out.join('-');\n}",
+    "lines": "export function lines(ctx: IllusionistContext, count = 5): string {\n  const out: string[] = [];\n  for (let i = 0; i < count; i++) {\n    out.push(sentence(ctx));\n  }\n  return out.join('\\n');\n}",
+    "firstName": "export function firstName(ctx: IllusionistContext): string {\n  const d = data(ctx);\n  const pool = boolean(ctx.source) ? d.firstNameMale : d.firstNameFemale;\n  return pick(pool, ctx.source)!;\n}",
+    "lastName": "export function lastName(ctx: IllusionistContext): string {\n  return pick(data(ctx).lastName, ctx.source)!;\n}",
+    "fullName": "export function fullName(ctx: IllusionistContext): string {\n  return `${firstName(ctx)} ${lastName(ctx)}`;\n}",
+    "gender": "export function gender(ctx: IllusionistContext): string {\n  return pick(data(ctx).gender, ctx.source)!;\n}",
+    "prefix": "export function prefix(ctx: IllusionistContext): string {\n  return pick(data(ctx).prefix, ctx.source)!;\n}",
+    "suffix": "export function suffix(ctx: IllusionistContext): string {\n  const d = data(ctx);\n  if (d.suffix.length === 0) return '';\n  return pick(d.suffix, ctx.source)!;\n}",
+    "jobTitle": "export function jobTitle(ctx: IllusionistContext): string {\n  const d = data(ctx);\n  return `${pick(d.jobAreas, ctx.source)!} ${pick(d.jobTypes, ctx.source)!}`;\n}",
+    "createSeed": "export function createSeed(seed?: number | string): RandomSource {\n  if (seed == null) return cryptoSource();\n\n  if (typeof seed === 'number') {\n    if (!Number.isFinite(seed)) throw new IllusionistSeedError(`createSeed: numeric seed must be finite, got ${seed}`);\n\n    return mulberry32(Math.trunc(seed));\n  }\n\n  const hashed = JSON.stringify(seed);\n\n  // FNV-1a-ish fold from the hash string into a 32-bit integer.\n  let state = 0;\n\n  for (let i = 0; i < hashed.length; i++) {\n    state = (Math.imul(state, 31) + hashed.charCodeAt(i)) >>> 0;\n  }\n\n  return mulberry32(state);\n}",
+    "mulberry32": "export function mulberry32(seed: number): RandomSource {\n  let state = seed >>> 0;\n\n  return {\n    next(): number {\n      state = (state + 0x6d2b79f5) >>> 0;\n      let t = state;\n\n      t = Math.imul(t ^ (t >>> 15), t | 1);\n      t ^= t + Math.imul(t ^ (t >>> 7), t | 61);\n\n      return ((t ^ (t >>> 14)) >>> 0) / 4294967296;\n    },\n  };\n}",
+    "RandomSource": "export type { RandomSource };",
+    "PersonLocaleData": "export type PersonLocaleData = {\n  readonly firstNameFemale: readonly string[];\n  readonly firstNameMale: readonly string[];\n  readonly gender: readonly string[];\n  readonly jobAreas: readonly string[];\n  readonly jobTypes: readonly string[];\n  readonly lastName: readonly string[];\n  readonly prefix: readonly string[];\n  readonly suffix: readonly string[];\n};",
+    "LocationLocaleData": "export type LocationLocaleData = {\n  readonly cities: readonly string[];\n  readonly countries: readonly string[];\n  readonly states: readonly string[];\n  readonly streets: readonly string[];\n  readonly zipPattern: string;\n};",
+    "IllusionistLocale": "export type IllusionistLocale = {\n  readonly code: string;\n  readonly person: PersonLocaleData;\n  readonly location: LocationLocaleData;\n};",
+    "IllusionistContext": "export type IllusionistContext = {\n  readonly source: RandomSource;\n  readonly locale: IllusionistLocale;\n};"
+  }
+}

package/data/packages/keymap.json

@@ -0,0 +1,51 @@
+{
+  "apiSource": "// Core API — most users only need these\nexport type { ConflictOptions } from './conflicts';\nexport { findShortcutConflicts } from './conflicts';\nexport { KeymapError, KeymapParseError } from './errors';\nexport { formatShortcut } from './format';\nexport { createKeymap } from './keymap';\nexport type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';\n",
+  "docs": {
+    "index": "---\ntitle: Keymap — Headless keyboard shortcut manager\ndescription: Target-local keyboard shortcut manager with chords, event-aware guards, modifier aliases, and terminal disposal.\npackage: keymap\ncategory: app-infrastructure\nkeywords: [keyboard, shortcuts, hotkeys, chord, keybinding, headless, accessibility]\nexports:\n  [\n    createKeymap,\n    findShortcutConflicts,\n    formatShortcut,\n    KeymapError,\n    KeymapParseError,\n  ]\nrelated: [herald, refine, ore]\nenvironments: [browser, node, ssr, deno]\n---\n\n<!-- markdownlint-disable MD025 MD033 MD060 -->\n\n<PackageHero package=\"keymap\" />\n\n## Why Keymap?\n\nBrowser keyboard handling needs modifier normalization, chord state, context policy, and listener ownership. Keymap keeps those concerns in one headless, zero-dependency handle.\n\n```ts\n// Before\nwindow.addEventListener('keydown', (event) => {\n  if ((event.ctrlKey || event.metaKey) && event.key === 's') event.preventDefault();\n});\n\n// After\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([\n  { id: 'save', shortcut: 'mod+s', handler: () => console.log('save') },\n]);\nconst unmount = map.mount(document);\n\nunmount();\nmap.dispose();\n```\n\n| Feature             | Raw `addEventListener`                       | Keymap                                       |\n| ------------------- | -------------------------------------------- | -------------------------------------------- |\n| Bundle size         | 0 B (built-in)                               | <PackageInfo package=\"keymap\" type=\"size\" /> |\n| Zero dependencies   | <ore-icon name=\"check\" size=\"16\"></ore-icon> | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| Chord sequences     | <ore-icon name=\"x\" size=\"16\"></ore-icon>     | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| Modifier aliases    | <ore-icon name=\"x\" size=\"16\"></ore-icon>     | `cmd`, `win`, `option` → canonical           |\n| Context guards      | Manual `if` in handler                       | Event-aware `when(event)` predicate          |\n| Chord ownership     | Application-managed state                    | Per mounted target                           |\n| Per-binding control | Manual `preventDefault`/`stopPropagation`    | Per-binding `preventDefault`/`stopPropagation` with safe defaults |\n| Disposable          | Manual `removeEventListener`                 | Terminal `dispose()` + `[Symbol.dispose]()`  |\n\n<div class=\"decision-callout\">\n\n**Use Keymap when** you need chord sequences (`g g`, `ctrl+k ctrl+s`), modifier aliases, or context-scoped hotkeys that can be cleanly mounted and unmounted.\n\n**Consider raw `addEventListener` when** you have a single, static, never-removed hotkey and don't need chords.\n\n</div>\n\n## Installation\n\n::: code-group\n\n```sh [pnpm]\npnpm add @vielzeug/keymap\n```\n\n```sh [npm]\nnpm install @vielzeug/keymap\n```\n\n```sh [yarn]\nyarn add @vielzeug/keymap\n```\n\n:::\n\n## Quick Start\n\nCreate, mount, then dispose one map owned by your UI scope.\n\n```ts\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([\n  { id: 'save', shortcut: 'mod+k mod+s', handler: () => console.log('save') },\n  { id: 'palette', shortcut: 'mod+shift+p', handler: () => console.log('open palette') },\n  { id: 'top', shortcut: 'g g', handler: () => window.scrollTo({ top: 0 }) },\n  { id: 'close', shortcut: 'escape', handler: () => console.log('close panel') },\n]);\n\nconst unmount = map.mount(document);\n\nunmount();\nmap.dispose();\n```\n\n## Features\n\n<div class=\"features-grid\">\n\n- `createKeymap()` — Create a keymap from an ordered binding array; mount to any `EventTarget`\n- Chord sequences — `\"g g\"`, `\"ctrl+k ctrl+s\"` with configurable timeout (default 1 s)\n- Modifier aliases — `cmd`/`command`/`win` → `meta`; `opt`/`option` → `alt`; `mod` → platform-aware\n- `Binding` objects — each binding has an explicit `id`, `shortcut`, `handler`, and optional `trigger`, `when`, `preventDefault`, `stopPropagation`\n- Per-binding `preventDefault`/`stopPropagation` — safe defaults (`true`/`false`) applied to completed shortcuts and intermediate chord steps\n- `tap()` — observe chord progress, timeout, matches, and disposal without changing behavior\n- `modKey` option — explicit platform override for SSR and cross-platform tests\n- `formatShortcut()` — platform-aware display (`⇧⌘P` on Mac, `Ctrl+Shift+P` elsewhere)\n- `@vielzeug/keymap/parse` subpath — `parseShortcut()`, `parseStep()`, `matchStep()`, `canonicalizeShortcut()`, `detectModKey()` for custom tooling\n- `listBindings()` — snapshot all active bindings (id, shortcut, trigger, preventDefault, stopPropagation) for palette UIs\n- `findShortcutConflicts()` — detect prefix/duplicate conflicts before binding a user-customized shortcut\n- Disposable — `dispose()` + `[Symbol.dispose]` for `using` declarations\n\n</div>\n\n## Documentation\n\n<div class=\"doc-links\">\n\n- [Usage Guide](./usage.md)\n- [API Reference](./api.md)\n- [Examples](./examples.md)\n- [Migration Guide](./migration.md)\n\n</div>\n\n## See Also\n\n<div class=\"see-also\">\n\n- [Herald](/herald/) — Typed event bus; pair with Keymap by publishing shortcut events to a bus instead of calling handlers directly\n- [Refine](/refine/) — `ore-command-palette` uses Keymap internally; register your own shortcuts alongside it\n- [Ore](/ore/) — Attach a keymap inside a `define()` setup function for component-scoped shortcuts\n\n</div>\n\n<!-- markdownlint-enable MD025 MD033 MD060 -->\n",
+    "api": "---\ntitle: Keymap — API Reference\ndescription: Complete API reference for @vielzeug/keymap bindings, chords, parsing, formatting, and lifecycle.\n---\n\n[[toc]]\n\n## API Overview\n\n### Core API (Most Users)\n\n| Symbol | Purpose | Execution mode | Common gotcha |\n| --- | --- | --- | --- |\n| `createKeymap()` | Create shortcut manager from an ordered binding array | Sync | `dispose()` is terminal |\n| `findShortcutConflicts()` | Find duplicate and prefix paths | Sync | Invalid non-empty input throws |\n| `formatShortcut()` | Format shortcut labels | Sync | Invalid input returns `''` |\n| `tap()` | Observe chord lifecycle, matches, and disposal | Sync | Observer failures are swallowed |\n| `Binding` | Per-binding config type (id, shortcut, handler, trigger, when, preventDefault, stopPropagation) | — | Reusing an `id` replaces its binding |\n\n### Parser Subpath (`@vielzeug/keymap/parse`)\n\nUse the parser subpath if you're building keyboard-aware config validators, custom UI, or framework integrations.\n\n| Symbol | Purpose | Execution mode | Common gotcha |\n| --- | --- | --- | --- |\n| `parseShortcut()` | Strictly parse full shortcut | Sync | Empty input throws |\n| `parseStep()` | Parse one step without throwing | Sync | Invalid input returns `null` |\n| `canonicalizeShortcut()` | Create stable shortcut key | Sync | Input must already be parsed |\n| `matchStep()` | Test event against parsed step | Sync | Extra modifiers prevent a match |\n| `detectModKey()` | Resolve platform primary modifier | Sync | Returns `ctrl` without `navigator` |\n\n### Errors\n\n| Symbol | Purpose | Execution mode | Common gotcha |\n| --- | --- | --- | --- |\n| `KeymapError` | Base Keymap error | Sync | Includes parse and lifecycle errors |\n| `KeymapParseError` | Strict parser error | Sync | `parseStep()` never throws it |\n\n## Package Entry Points\n\n| Import | Purpose |\n| --- | --- |\n| `@vielzeug/keymap` | Root entry point for `createKeymap`, `formatShortcut`, `findShortcutConflicts`, errors, and public types. |\n| `@vielzeug/keymap/parse` | Parser internals subpath for custom tooling: `parseShortcut`, `parseStep`, `matchStep`, `canonicalizeShortcut`, `detectModKey`. |\n\n## Core Manager\n\n### `createKeymap()`\n\n```ts\nfunction createKeymap(\n  bindings?: readonly Binding[],\n  options?: KeymapOptions,\n): Keymap;\n```\n\nCreates shortcut manager with independent chord state for each mounted target.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `bindings` | `readonly Binding[]` | Ordered array of bindings. Each binding has an explicit `id`, `shortcut`, and `handler`. |\n| `options` | `KeymapOptions` | Chord, modifier, and global-guard configuration. |\n\n**Returns:** `Keymap`.\n\n```ts\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([\n  { id: 'save', shortcut: 'ctrl+s', handler: () => console.log('save') },\n]);\nconst unmount = map.mount(document);\n\nunmount();\nmap.dispose();\n```\n\n| `Keymap` member | Return | Contract |\n| --- | --- | --- |\n| `bind(binding)` | `() => void` | Adds or replaces a binding with the same `id`. Returned callback removes that binding while active. |\n| `mount(target)` | `() => void` | Adds target listener. Repeat mounts of same target are reference-counted. |\n| `unbind(id)` | `void` | Removes binding by id. Warns in development when unknown. |\n| `listBindings()` | `readonly BindingEntry[]` | Returns a detached binding snapshot. |\n| `tap(handler, options?)` | `() => void` | Observes chord lifecycle, matches, and disposal. Supports signal-owned teardown. |\n| `dispose()` | `void` | Removes all listeners, aborts signal, and permanently disposes map. Idempotent. |\n| `disposed` | `boolean` | `true` after first `dispose()`. |\n| `disposalSignal` | `AbortSignal` | Aborts when map is disposed. |\n| `[Symbol.dispose]()` | `void` | Calls `dispose()`. |\n\nAfter disposal, `bind()`, `unbind()`, and `mount()` throw `KeymapError`.\n\n## Runtime Observation\n\n### `tap()`\n\n```ts\nfunction tap(\n  handler: (event: KeymapEvent) => void,\n  options?: { signal?: AbortSignal },\n): () => void;\n```\n\nObserves chord progress, cancellation, completed matches, timeouts, and disposal without affecting shortcut behavior.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `handler` | `(event: KeymapEvent) => void` | Receives each runtime event synchronously. Errors are swallowed. |\n| `options.signal` | `AbortSignal` | Detaches the handler when aborted. |\n\n**Returns:** An idempotent detach function.\n\n```ts\nconst stop = map.tap((event) => {\n  if (event.type === 'chord-start') showChordHint(event.step);\n  if (event.type === 'chord-cancel' || event.type === 'chord-timeout' || event.type === 'match') hideChordHint();\n});\n```\n\n## Conflict Analysis\n\n### `findShortcutConflicts()`\n\n```ts\nfunction findShortcutConflicts(\n  shortcut: string,\n  entries: readonly BindingEntry[],\n  options?: ConflictOptions,\n): BindingEntry[];\n```\n\nReturns entries with same-trigger exact or prefix-conflicting shortcut paths.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `shortcut` | `string` | Proposed shortcut. Empty or whitespace-only input returns no conflicts. |\n| `entries` | `readonly BindingEntry[]` | Bindings to compare, commonly `map.listBindings()`. |\n| `options` | `ConflictOptions` | Optional modifier resolution and trigger filter. |\n\n**Returns:** Matching entries. Returns `[]` when no conflict exists.\n\n```ts\nimport { createKeymap, findShortcutConflicts } from '@vielzeug/keymap';\n\nconst map = createKeymap([{ id: 'top', shortcut: 'g', handler: () => console.log('top') }]);\nconst conflicts = findShortcutConflicts('g g', map.listBindings());\n\nconsole.log(conflicts.length); // 1\n```\n\n## Formatting\n\n### `formatShortcut()`\n\n```ts\nfunction formatShortcut(shortcut: string, modKey?: 'ctrl' | 'meta'): string;\n```\n\nFormats parsed shortcut into Mac symbols for `meta` or word labels for `ctrl`.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `shortcut` | `string` | Shortcut string to format. |\n| `modKey` | `'ctrl' \\| 'meta'` | Platform primary modifier. Defaults to `detectModKey()`. |\n\n**Returns:** Display label, or `''` for invalid input.\n\n```ts\nimport { formatShortcut } from '@vielzeug/keymap';\n\nformatShortcut('mod+shift+p', 'meta'); // ⇧⌘P\nformatShortcut('mod+shift+p', 'ctrl'); // Ctrl+Shift+P\n```\n\n## Parser Subpath (`@vielzeug/keymap/parse`)\n\n### `parseShortcut()`\n\n```ts\nfunction parseShortcut(raw: string, modKey?: 'ctrl' | 'meta'): Shortcut;\n```\n\nStrictly parses one or more space-separated shortcut steps.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `raw` | `string` | Full shortcut string. |\n| `modKey` | `'ctrl' \\| 'meta'` | Platform primary modifier. Defaults to `detectModKey()`. |\n\n**Returns:** Parsed `Shortcut`.\n\n```ts\nimport { parseShortcut } from '@vielzeug/keymap/parse';\n\nconst shortcut = parseShortcut('ctrl+k ctrl+s', 'ctrl');\nconsole.log(shortcut.length); // 2\n```\n\nThrows `KeymapParseError` for empty, modifier-only, or ambiguous steps.\n\n---\n\n### `parseStep()`\n\n```ts\nfunction parseStep(raw: string, modKey?: 'ctrl' | 'meta'): ShortcutStep | null;\n```\n\nParses one shortcut step without throwing.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `raw` | `string` | One shortcut step. |\n| `modKey` | `'ctrl' \\| 'meta'` | Platform primary modifier. Defaults to `detectModKey()`. |\n\n**Returns:** Parsed `ShortcutStep`, or `null` for empty, modifier-only, or ambiguous input.\n\n```ts\nimport { parseStep } from '@vielzeug/keymap/parse';\n\nparseStep('ctrl+k', 'ctrl'); // { key: 'k', modifiers: Set(['ctrl']) }\nparseStep('ctrl+k+j', 'ctrl'); // null\n```\n\n---\n\n### `canonicalizeShortcut()`\n\n```ts\nfunction canonicalizeShortcut(steps: readonly ShortcutStep[]): string;\n```\n\nConverts parsed steps into stable canonical string with sorted modifier order.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `steps` | `readonly ShortcutStep[]` | Parsed shortcut steps. |\n\n**Returns:** Canonical shortcut string.\n\n```ts\nimport { canonicalizeShortcut, parseShortcut } from '@vielzeug/keymap/parse';\n\ncanonicalizeShortcut(parseShortcut('shift+ctrl+k', 'ctrl')); // ctrl+shift+k\n```\n\n---\n\n### `matchStep()`\n\n```ts\nfunction matchStep(event: KeyboardEvent, step: ShortcutStep): boolean;\n```\n\nTests exact key and modifier equality for one parsed step.\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `event` | `KeyboardEvent` | Event to match. Missing runtime `key` returns `false`. |\n| `step` | `ShortcutStep` | Parsed step. |\n\n**Returns:** `true` only when key and all modifier states match.\n\n```ts\nimport { matchStep, parseStep } from '@vielzeug/keymap/parse';\n\nconst step = parseStep('ctrl+k', 'ctrl')!;\nmatchStep(new KeyboardEvent('keydown', { ctrlKey: true, key: 'k' }), step); // true\n```\n\n---\n\n### `detectModKey()`\n\n```ts\nfunction detectModKey(): 'ctrl' | 'meta';\n```\n\nDetects Mac platform from `navigator` and otherwise returns `ctrl`.\n\n**Returns:** `'meta'` on Mac platforms; `'ctrl'` elsewhere or without `navigator`.\n\n```ts\nimport { detectModKey } from '@vielzeug/keymap/parse';\n\nconst modKey = detectModKey();\n```\n\n## Types\n\n### `Keymap`\n\nStateful shortcut manager returned by `createKeymap()`.\n\n```ts\ninterface Keymap {\n  [Symbol.dispose](): void;\n  bind(binding: Binding): () => void;\n  dispose(): void;\n  readonly disposalSignal: AbortSignal;\n  readonly disposed: boolean;\n  listBindings(): readonly BindingEntry[];\n  mount(target: EventTarget): () => void;\n  tap(handler: (event: KeymapEvent) => void, options?: { signal?: AbortSignal }): () => void;\n  unbind(id: string): void;\n}\n```\n\n### `KeymapOptions`\n\nOptions applied to every binding owned by one manager.\n\n```ts\ninterface KeymapOptions {\n  chordTimeout?: number;\n  modKey?: 'ctrl' | 'meta';\n  when?: When;\n}\n```\n\n- `when`: Guard function called for all bindings. When combined with per-binding `when` guards, both must return `true` for the handler to fire (AND composition). Global guard is checked first.\n\n### `KeymapEvent`\n\nRuntime event observed through `tap()`.\n\n```ts\ntype KeymapEvent =\n  | { type: 'chord-cancel'; target: EventTarget; trigger: 'keydown' | 'keyup' }\n  | { type: 'chord-start'; step: ShortcutStep; target: EventTarget; trigger: 'keydown' | 'keyup' }\n  | { type: 'chord-progress'; steps: readonly ShortcutStep[]; target: EventTarget; trigger: 'keydown' | 'keyup' }\n  | { type: 'chord-timeout'; target: EventTarget; trigger: 'keydown' | 'keyup' }\n  | { type: 'match'; binding: BindingEntry; target: EventTarget; trigger: 'keydown' | 'keyup' }\n  | { type: 'dispose' };\n```\n\n`step`, `steps`, and `binding` are detached snapshots. Mutating them does not affect matching.\n\n### `Binding`\n\nPer-binding configuration. Each binding has an explicit `id` so duplicate shortcuts can coexist. Reusing an ID replaces its binding; among duplicate shortcuts, the first binding whose guard passes wins.\n\n```ts\ninterface Binding {\n  id: string;\n  shortcut: string;\n  handler: Handler;\n  trigger?: 'keydown' | 'keyup';\n  when?: When;\n  preventDefault?: boolean;\n  stopPropagation?: boolean;\n}\n```\n\n- `trigger`: Defaults to `'keydown'`.\n- `preventDefault`: Defaults to `true`. Set to `false` for shortcuts that must retain browser behavior.\n- `stopPropagation`: Defaults to `false`.\n\n### `Handler` and `When`\n\n```ts\ntype Handler = (event: KeyboardEvent) => void;\ntype When = (event: KeyboardEvent) => boolean;\n```\n\n### `BindingEntry`\n\nDetached binding metadata returned by `listBindings()`.\n\n```ts\ntype BindingEntry = {\n  readonly id: string;\n  readonly shortcut: readonly ShortcutStep[];\n  readonly trigger: 'keydown' | 'keyup';\n  readonly preventDefault: boolean;\n  readonly stopPropagation: boolean;\n};\n```\n\n### `ModifierKey`, `Shortcut`, and `ShortcutStep`\n\nParser types used by `parseShortcut()`, `parseStep()`, `matchStep()`, and `canonicalizeShortcut()`. Available from `@vielzeug/keymap/parse`.\n\n```ts\ntype ModifierKey = 'alt' | 'ctrl' | 'meta' | 'shift';\n\ntype ShortcutStep = {\n  key: string;\n  modifiers: Set<ModifierKey>;\n};\n\ntype Shortcut = ShortcutStep[];\n```\n\n### `ConflictOptions`\n\nComparison options for `findShortcutConflicts()`.\n\n```ts\ninterface ConflictOptions {\n  modKey?: 'ctrl' | 'meta';\n  trigger?: 'keydown' | 'keyup';\n}\n```\n\n## Errors\n\n| Error | Trigger | Notable properties |\n| --- | --- | --- |\n| `KeymapError` | Lifecycle operation after disposal | Use `instanceof KeymapError` to narrow Keymap errors. |\n| `KeymapParseError` | Strict shortcut parser receives invalid input | Extends `KeymapError`. |\n",
+    "usage": "---\ntitle: Keymap — Usage Guide\ndescription: Bind keyboard shortcuts, chords, event-aware guards, and target-local listeners with @vielzeug/keymap.\n---\n\n[[toc]]\n\n## Basic Usage\n\nMount one keymap, then release its target listener and dispose its owner during teardown.\n\n```ts\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([\n  { id: 'save', shortcut: 'ctrl+s', handler: () => console.log('save') },\n  { id: 'undo', shortcut: 'ctrl+z', handler: () => console.log('undo') },\n  { id: 'close', shortcut: 'escape', handler: () => console.log('close') },\n]);\n\nconst unmount = map.mount(document);\n\n// Call this when the owning UI scope ends.\nunmount();\nmap.dispose();\n```\n\n`unmount()` only releases that target. `dispose()` releases every target, aborts `disposalSignal`, and makes `bind()`, `unbind()`, and `mount()` unavailable.\n\n## Modifier Aliases\n\nUse aliases to accept platform terminology while Keymap stores one canonical shortcut.\n\n| Input | Canonical modifier |\n| --- | --- |\n| `cmd`, `command`, `win` | `meta` |\n| `opt`, `option` | `alt` |\n| `ctrl`, `control` | `ctrl` |\n| `mod` | `meta` on Mac; `ctrl` elsewhere |\n\nPass `modKey` when rendering or testing a specific platform.\n\n```ts\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap(\n  [{ id: 'palette', shortcut: 'mod+k', handler: () => console.log('open palette') }],\n  { modKey: 'ctrl' },\n);\n\nmap.mount(document);\n```\n\n## Chord Sequences\n\nSeparate chord steps with spaces. Keymap resets an incomplete sequence after `chordTimeout` milliseconds.\n\n```ts\nconst map = createKeymap(\n  [\n    { id: 'save', shortcut: 'ctrl+k ctrl+s', handler: () => console.log('save') },\n    { id: 'top', shortcut: 'g g', handler: () => window.scrollTo({ top: 0 }) },\n    { id: 'end', shortcut: 'g e', handler: () => window.scrollTo({ top: document.body.scrollHeight }) },\n  ],\n  { chordTimeout: 800 },\n);\n```\n\nDo not bind a complete shortcut and a longer chord beginning with that shortcut. `g` fires immediately, so `g g` cannot complete. Check proposed user bindings with `findShortcutConflicts()`.\n\n## Binding Options\n\nEach binding is an object with an explicit `id`, `shortcut`, and `handler`. Add a guard, choose `keyup`, or control event behavior with optional fields.\n\n```ts\nconst map = createKeymap([\n  { id: 'save', shortcut: 'ctrl+s', handler: () => saveDocument() },\n  { id: 'close', shortcut: 'escape', handler: closePanel, when: (event) => event.target === panel },\n  { id: 'play', shortcut: 'space', handler: togglePlayback, trigger: 'keyup' },\n  { id: 'inspect', shortcut: 'f12', handler: inspectElement, preventDefault: false },\n]);\n```\n\n### Per-Binding preventDefault and stopPropagation\n\nEach binding controls `preventDefault` and `stopPropagation` independently:\n\n- `preventDefault` defaults to `true` — completed shortcuts and matched chord prefixes suppress browser defaults.\n- `stopPropagation` defaults to `false` — events continue bubbling unless explicitly stopped.\n\nSet `preventDefault: false` for shortcuts that must coexist with native controls (e.g. developer tools, accessibility features).\n\n## Context Guards\n\nUse global `when(event)` for policy shared by every binding. Use per-binding `when(event)` when one shortcut needs a narrower policy.\n\n```ts\nconst map = createKeymap(\n  [\n    { id: 'close', shortcut: 'escape', handler: closePanel, when: (event) => event.target === panel },\n    { id: 'save', shortcut: 'ctrl+s', handler: () => saveDocument() },\n  ],\n  { when: (event) => !modalIsOpen() && event.isTrusted },\n);\n```\n\nAccept `KeyboardEvent` when guard logic needs target, modifier, composition, or shadow-DOM context.\n\n### Guard Composition: Global + Per-Binding\n\nWhen you provide both a global `when` (in `KeymapOptions`) and per-binding `when` guards, both must return `true` for the handler to fire. This is AND composition.\n\n**Guard evaluation and chord tracking order:**\n\n1. **Global guard runs first.** If it returns `false`, the target's pending chord state resets.\n2. **Per-binding guards select candidates.** A binding participates in each chord step only while its guard passes.\n3. **Chord state advances for eligible candidates.** The first completed candidate in binding order runs.\n\nA chord cannot begin while its map is disabled and finish after the global guard becomes active.\n\n```ts\nconst map = createKeymap(\n  [\n    { id: 'close', shortcut: 'escape', handler: closePanel, when: (event) => event.target === panel },\n    { id: 'save', shortcut: 'ctrl+s', handler: () => saveDocument() },\n  ],\n  { when: (event) => !isModalOpen() && event.isTrusted },\n);\n\n// Global guard runs first; if false, both bindings are skipped (handler doesn't fire).\n// If global passes:\n//   - 'save' handler fires immediately.\n//   - 'close' handler fires only if event.target is the panel.\n```\n\n### Preserve Native Text Editing\n\nUse `event.composedPath()` to keep browser undo and redo inside inputs, textareas, and `contenteditable` elements. CRM app shell uses this policy for its global undo and redo shortcuts.\n\n```ts\nconst isTypingInField = (event: KeyboardEvent): boolean =>\n  event.composedPath().some(\n    (target) =>\n      target instanceof HTMLElement &&\n      (target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement || target.isContentEditable),\n  );\n\nconst map = createKeymap(\n  [\n    { id: 'undo', shortcut: 'mod+z', handler: () => undo() },\n    { id: 'redo', shortcut: 'mod+shift+z', handler: () => redo() },\n  ],\n  { when: (event) => !isTypingInField(event) },\n);\n```\n\nDo not make editable-field suppression a hidden package default. Applications may intentionally bind shortcuts inside editable controls.\n\n## Trigger Control\n\nBind on `keyup` when an action must run after key release.\n\n```ts\nconst map = createKeymap([\n  { id: 'confirm', shortcut: 'space', handler: confirmAction, trigger: 'keyup' },\n]);\n```\n\n`keydown` and `keyup` maintain independent chord state.\n\n## Replace Bindings at Runtime\n\n`bind(binding)` adds or replaces a binding with the same `id` and returns a targeted removal callback.\n\n```ts\nconst map = createKeymap([{ id: 'palette', shortcut: 'ctrl+k', handler: defaultAction }]);\nconst removePluginBinding = map.bind({ id: 'palette', shortcut: 'ctrl+k', handler: pluginAction });\n\nremovePluginBinding();\nmap.bind({ id: 'palette', shortcut: 'ctrl+k', handler: defaultAction });\n```\n\n`unbind(id)` removes the binding with that id and warns in development when no binding exists.\n\n### Duplicate Shortcuts with Different IDs\n\nEach binding has an explicit `id`, so duplicate shortcuts can coexist. Keymap evaluates them in insertion order and fires the first binding whose guard passes.\n\n```ts\nconst map = createKeymap([\n  { id: 'primary', shortcut: 'ctrl+k', handler: primaryAction },\n  { id: 'fallback', shortcut: 'ctrl+k', handler: fallbackAction },\n]);\n\n// 'primary' fires while eligible; use mutually exclusive guards for contextual fallback.\n```\n\n## Format Shortcut Labels\n\nFormat labels with explicit platform behavior when your UI is cross-platform.\n\n```ts\nimport { formatShortcut } from '@vielzeug/keymap';\n\nconsole.log(formatShortcut('mod+shift+p', 'meta')); // ⇧⌘P\nconsole.log(formatShortcut('mod+shift+p', 'ctrl')); // Ctrl+Shift+P\n```\n\n`formatShortcut()` returns `''` and emits a development warning for invalid input.\n\n## Detect Conflicts\n\nCheck a custom shortcut before binding it to prevent duplicate or unreachable chord paths.\n\n```ts\nimport { createKeymap, findShortcutConflicts } from '@vielzeug/keymap';\n\nconst map = createKeymap([{ id: 'top', shortcut: 'g', handler: () => scrollToTop() }]);\nconst conflicts = findShortcutConflicts('g g', map.listBindings());\n\nif (conflicts.length === 0) map.bind({ id: 'bottom', shortcut: 'g g', handler: () => scrollToBottom() });\n```\n\nConflict detection compares only bindings with same trigger. An empty proposal returns no conflicts; other invalid proposals throw `KeymapParseError`.\n\n## Parser Subpath\n\nFor custom tooling, validators, or framework integrations that need direct access to the shortcut parser, import from `@vielzeug/keymap/parse`:\n\n```ts\nimport { parseShortcut, parseStep, matchStep, canonicalizeShortcut, detectModKey } from '@vielzeug/keymap/parse';\n\nconst steps = parseShortcut('ctrl+k ctrl+s', 'ctrl');\nconst step = parseStep('ctrl+k', 'ctrl');\nconst isMatch = matchStep(new KeyboardEvent('keydown', { ctrlKey: true, key: 'k' }), steps[0]);\n```\n\nThese functions are not exported from the root entry point to keep the common API surface small.\n\n## Mount Targets\n\nMount one keymap on multiple independent targets when each target should own its own chord progression.\n\n```ts\nconst map = createKeymap([{ id: 'top', shortcut: 'g g', handler: () => console.log('go to top') }]);\nconst unmountEditor = map.mount(editor);\nconst unmountPreview = map.mount(preview);\n```\n\nA chord started on `editor` cannot complete on `preview`. Repeated `mount(editor)` calls share one listener and require one unmount call each. For nested targets, Keymap handles one bubbled event at its innermost mounted target.\n\n## Scoped Maps\n\nCreate separate keymaps for separate UI owners. If maps share a target and shortcut, guards must be mutually exclusive because Keymap has no implicit layer precedence.\n\n```ts\nconst baseMap = createKeymap(\n  [{ id: 'close-sidebar', shortcut: 'escape', handler: () => closeSidebar() }],\n  { when: () => !modalIsOpen() },\n);\n\nconst modalMap = createKeymap(\n  [{ id: 'close-modal', shortcut: 'escape', handler: () => closeModal() }],\n  { when: () => modalIsOpen() },\n);\n\nconst unmountBase = baseMap.mount(document);\nconst unmountModal = modalMap.mount(document);\n```\n\n## Observe Chord Activity\n\nUse `tap()` for chord hints, diagnostics, and matched-binding telemetry. Observers cannot alter shortcut behavior.\n\n```ts\nconst stopTrace = map.tap((event) => {\n  if (event.type === 'chord-start') showChordHint(event.step);\n  if (event.type === 'chord-progress') updateChordHint(event.steps);\n  if (event.type === 'chord-cancel' || event.type === 'chord-timeout' || event.type === 'match') hideChordHint();\n}, { signal: owner.signal });\n```\n\nTap handlers receive detached shortcut and binding snapshots. Handler errors are swallowed, and disposal emits a final `dispose` event before observers are cleared.\n\n## Testing\n\nDispatch `KeyboardEvent` instances against a mounted DOM target to test handlers and default prevention.\n\n```ts\nimport { expect, it, vi } from 'vitest';\n\nimport { createKeymap } from '@vielzeug/keymap';\n\nit('handles save', () => {\n  const save = vi.fn();\n  const target = document.createElement('button');\n  const map = createKeymap([{ id: 'save', shortcut: 'ctrl+s', handler: save }]);\n  const unmount = map.mount(target);\n\n  target.dispatchEvent(new KeyboardEvent('keydown', { bubbles: true, ctrlKey: true, key: 's' }));\n\n  expect(save).toHaveBeenCalledOnce();\n  unmount();\n  map.dispose();\n});\n```\n\nMount nested DOM targets in tests when your application uses both a container and a descendant listener. This verifies one bubbled event cannot complete a chord twice.\n\n## Framework Integration\n\nCreate map during framework lifecycle, then dispose it during teardown.\n\n::: code-group\n\n```tsx [React]\nimport { useEffect } from 'react';\n\nimport { createKeymap } from '@vielzeug/keymap';\n\nexport function App() {\n  useEffect(() => {\n    const map = createKeymap([{ id: 'palette', shortcut: 'ctrl+k', handler: () => console.log('open palette') }]);\n    const unmount = map.mount(document);\n\n    return () => {\n      unmount();\n      map.dispose();\n    };\n  }, []);\n\n  return null;\n}\n```\n\n```vue [Vue 3]\n<script setup lang=\"ts\">\nimport { onMounted, onUnmounted } from 'vue';\n\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([{ id: 'close', shortcut: 'escape', handler: () => console.log('close palette') }]);\nlet unmount: (() => void) | undefined;\n\nonMounted(() => {\n  unmount = map.mount(document);\n});\n\nonUnmounted(() => {\n  unmount?.();\n  map.dispose();\n});\n</script>\n```\n\n```ts [Svelte]\nimport { onMount } from 'svelte';\n\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst map = createKeymap([{ id: 'close', shortcut: 'escape', handler: () => console.log('close palette') }]);\n\nonMount(() => {\n  const unmount = map.mount(document);\n\n  return () => {\n    unmount();\n    map.dispose();\n  };\n});\n```\n\n:::\n\n## Working with Other Vielzeug Libraries\n\n### Keymap + Ledger\n\nConnect undo and redo handlers to a Ledger owner.\n\n```ts\nimport { createKeymap } from '@vielzeug/keymap';\nimport { createLedger } from '@vielzeug/ledger';\n\nconst ledger = createLedger();\nconst reportHistoryError = (error: unknown): void => console.error(error);\nconst map = createKeymap([\n  { id: 'undo', shortcut: 'mod+z', handler: () => void ledger.undo().catch(reportHistoryError) },\n  { id: 'redo', shortcut: 'mod+shift+z', handler: () => void ledger.redo().catch(reportHistoryError) },\n]);\n\nmap.mount(document);\n```\n\n### Keymap + Herald\n\nEmit domain events instead of calling application actions from shortcut handlers.\n\n```ts\nimport { createBus } from '@vielzeug/herald';\nimport { createKeymap } from '@vielzeug/keymap';\n\nconst bus = createBus<{ 'shortcut:save': void }>();\nconst map = createKeymap([\n  { id: 'save', shortcut: 'ctrl+s', handler: () => bus.emit('shortcut:save') },\n]);\n\nmap.mount(document);\n```\n\n## Best Practices\n\n- **Dispose** every map when its owner ends.\n- **Unmount** temporary target listeners instead of disposing reusable maps.\n- **Guard** global text-editing shortcuts with `event.composedPath()`.\n- **Check** conflicts before accepting customized shortcuts.\n- **Keep** shared-target guards mutually exclusive.\n- **Use** `mod` for primary cross-platform shortcuts.\n- **Avoid** prefix pairs such as `g` and `g g`.\n- **Use** unique `id`s for each binding and mutually exclusive guards for intentional duplicate shortcuts.\n",
+    "examples": "---\ntitle: Keymap — Examples\ndescription: Worked examples for @vielzeug/keymap.\n---\n\n## Examples\n\n- [Global Shortcuts](./examples/global-shortcuts.md)\n- [Vim-style Navigation](./examples/vim-navigation.md)\n"
+  },
+  "examples": [
+    {
+      "id": "basic-shortcuts",
+      "code": "import { createKeymap, formatShortcut } from '@vielzeug/keymap'\n\n// Create a keymap — each binding has an explicit id, shortcut, and handler.\n// Bindings fire on keydown by default; preventDefault defaults to true.\nconst map = createKeymap([\n  { id: 'save',   shortcut: 'ctrl+s', handler: () => console.log('save triggered') },\n  { id: 'close',  shortcut: 'escape', handler: () => console.log('close panel'), when: () => true },\n  { id: 'play',   shortcut: 'space',  handler: () => console.log('toggle play'), trigger: 'keyup' },\n], { modKey: 'ctrl' })\n\n// Mount to document (required for event listening).\nconst unmount = map.mount(document)\n\n// Simulate events for demonstration.\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 's', ctrlKey: true, bubbles: true }))\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true }))\ndocument.dispatchEvent(new KeyboardEvent('keyup',   { key: ' ', bubbles: true }))\n\n// Format shortcuts for display in UI tooltips or menus.\nconsole.log(formatShortcut('ctrl+s', 'ctrl'))         // 'Ctrl+S'\nconsole.log(formatShortcut('mod+shift+p', 'meta'))    // '⇧⌘P'\nconsole.log(formatShortcut('ctrl+k ctrl+s', 'ctrl'))  // 'Ctrl+K Ctrl+S'\n\nunmount()",
+      "name": "Basic Shortcuts"
+    },
+    {
+      "id": "chord-sequences",
+      "code": "import { createKeymap, findShortcutConflicts } from '@vielzeug/keymap'\n\n// Chord sequences fire only after all steps are pressed in order within the timeout.\n// Shortcut strings are lowercased before matching, so 'g g' and 'g G' are equivalent.\n// Different ids let both coexist, but the first eligible binding wins. Vim's actual 'G'\n// is shift+g, a single keystroke rather than a 'g'-prefixed chord.\nconst map = createKeymap([\n  { id: 'save-all', shortcut: 'ctrl+k ctrl+s', handler: () => console.log('save all (VS Code-style)') },\n  { id: 'top',      shortcut: 'g g',           handler: () => console.log('go to top (Vim-style)') },\n  { id: 'bottom',   shortcut: 'shift+g',       handler: () => console.log('go to bottom') },\n], { chordTimeout: 800, modKey: 'ctrl' })\n\nconst unmount = map.mount(document)\n\n// Simulate completing 'ctrl+k ctrl+s' chord.\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 'k', ctrlKey: true, bubbles: true }))\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 's', ctrlKey: true, bubbles: true }))\n\n// Simulate Vim 'g g' chord.\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 'g', bubbles: true }))\ndocument.dispatchEvent(new KeyboardEvent('keydown', { key: 'g', bubbles: true }))\n\n// Gotcha: a single-key binding sharing a chord's first step always wins immediately,\n// making the longer chord unreachable — findShortcutConflicts() catches this up front.\nconsole.log('Would ctrl+k (alone) conflict with the chord above?')\nconsole.log(findShortcutConflicts('ctrl+k', map.listBindings()))\n\nunmount()",
+      "name": "Chord Sequences"
+    },
+    {
+      "id": "conflict-detection",
+      "code": "import { createKeymap, findShortcutConflicts } from '@vielzeug/keymap'\n\n// findShortcutConflicts() catches unreachable bindings before you register them —\n// useful for a shortcut-customization UI driven by user input.\nconst map = createKeymap([\n  { id: 'top', shortcut: 'g', handler: () => console.log('go to top') },\n])\n\nconst proposed = 'g g'\nconst conflicts = findShortcutConflicts(proposed, map.listBindings())\n\nif (conflicts.length > 0) {\n  console.log(`\"${proposed}\" would never fire — shadowed by an existing binding`)\n} else {\n  map.bind({ id: 'bottom', shortcut: proposed, handler: () => console.log('go to bottom') })\n}\n\n// A shortcut with no relationship to existing bindings reports no conflicts.\nconsole.log('ctrl+s conflicts:', findShortcutConflicts('ctrl+s', map.listBindings()).length)\n\n// keydown and keyup bindings never conflict — they're matched independently.\nconst withKeyup = createKeymap([\n  { id: 'space-up', shortcut: 'space', handler: () => {}, trigger: 'keyup' },\n])\nconsole.log(\n  'space (keydown) vs space (keyup):',\n  findShortcutConflicts('space', withKeyup.listBindings(), { trigger: 'keydown' }).length,\n)",
+      "name": "Conflict Detection"
+    },
+    {
+      "id": "format-and-conflicts",
+      "code": "import { KeymapError, KeymapParseError, formatShortcut, findShortcutConflicts, createKeymap } from '@vielzeug/keymap'\n\n// formatShortcut turns a shortcut string into a display label.\nconst shortcuts = [\n  ['mod+shift+p', 'meta'],\n  ['mod+shift+p', 'ctrl'],\n  ['ctrl+k ctrl+s', 'ctrl'],\n  ['escape', 'ctrl'],\n  ['space', 'meta'],\n]\n\nfor (const [shortcut, modKey] of shortcuts) {\n  console.log(shortcut, '→', formatShortcut(shortcut, modKey))\n}\n\n// createKeymap() throws KeymapParseError for ambiguous or invalid steps.\n// Catch it with instanceof KeymapError to handle any keymap error.\ntry {\n  createKeymap([{ id: 'bad', shortcut: 'ctrl+k+j', handler: () => {} }], { modKey: 'ctrl' })\n} catch (err) {\n  console.log('Caught:', err instanceof KeymapError, err instanceof KeymapParseError, err.message)\n}\n\n// findShortcutConflicts() detects prefix/duplicate conflicts before binding.\nconst map = createKeymap([\n  { id: 'top', shortcut: 'g', handler: () => console.log('go to top') },\n])\n\nconsole.log('Would \"g g\" conflict?', findShortcutConflicts('g g', map.listBindings()).length > 0)\nconsole.log('Would \"x\" conflict?', findShortcutConflicts('x', map.listBindings()).length > 0)",
+      "name": "Format & Conflicts"
+    },
+    {
+      "id": "shortcut-utilities",
+      "code": "import { createKeymap, formatShortcut, findShortcutConflicts } from '@vielzeug/keymap'\n\n// listBindings() — inspect active bindings at runtime.\n// Each entry has id, shortcut (parsed steps), trigger, preventDefault, and stopPropagation.\nconst map = createKeymap(\n  [\n    { id: 'ctrl-k', shortcut: 'ctrl+k', handler: () => console.log('ctrl+k fired') },\n    { id: 'save', shortcut: 'ctrl+shift+s', handler: () => console.log('save fired'), trigger: 'keyup' },\n    { id: 'close', shortcut: 'escape', handler: () => console.log('close'), preventDefault: false },\n  ],\n  { modKey: 'ctrl' },\n)\n\nconst entries = map.listBindings()\nconsole.log('Bindings:', entries.length)\n\nfor (const entry of entries) {\n  console.log(`  ${entry.id}: trigger=${entry.trigger}, preventDefault=${entry.preventDefault}, stopPropagation=${entry.stopPropagation}`)\n}\n\n// formatShortcut() — display labels for UI tooltips or menus.\nconsole.log(formatShortcut('ctrl+k', 'ctrl'))         // 'Ctrl+K'\nconsole.log(formatShortcut('mod+shift+p', 'meta'))    // '⇧⌘P'\n\n// bind() returns an unbind closure — removes by binding id.\nconst unbind = map.bind({ id: 'ctrl-j', shortcut: 'ctrl+j', handler: () => console.log('ctrl+j') })\nconsole.log('After bind:', map.listBindings().length)\n\nunbind()\nconsole.log('After unbind:', map.listBindings().length)\n\n// unbind() removes by id, not by shortcut string — duplicate shortcuts coexist.\nmap.bind({ id: 'dup-a', shortcut: 'ctrl+d', handler: () => console.log('a') })\nmap.bind({ id: 'dup-b', shortcut: 'ctrl+d', handler: () => console.log('b') })\nconsole.log('Duplicate shortcut bindings:', map.listBindings().filter(e => e.shortcut.length === 1 && e.shortcut[0].key === 'd').length)\n\nmap.unbind('dup-a')\nconsole.log('After unbind dup-a:', map.listBindings().filter(e => e.shortcut.length === 1 && e.shortcut[0].key === 'd').length)\n\n// findShortcutConflicts() — check before binding a user-customized shortcut.\nconsole.log('ctrl+k conflicts:', findShortcutConflicts('ctrl+k', map.listBindings()).length)",
+      "name": "Shortcut Utilities"
+    }
+  ],
+  "typeSignatures": {
+    "ConflictOptions": "export type { ConflictOptions } from './conflicts';",
+    "findShortcutConflicts": "export { findShortcutConflicts } from './conflicts';",
+    "KeymapError": "export { KeymapError, KeymapParseError } from './errors';",
+    "KeymapParseError": "export { KeymapError, KeymapParseError } from './errors';",
+    "formatShortcut": "export { formatShortcut } from './format';",
+    "createKeymap": "export { createKeymap } from './keymap';",
+    "Binding": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "BindingEntry": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "Handler": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "Keymap": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "KeymapEvent": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "KeymapOptions": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';",
+    "When": "export type { Binding, BindingEntry, Handler, Keymap, KeymapEvent, KeymapOptions, When } from './types';"
+  }
+}

package/data/packages/ledger.json

@@ -0,0 +1,60 @@
+{
+  "apiSource": "export { compose } from './compose';\nexport {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';\nexport { createLedger } from './ledger';\nexport type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';\n",
+  "docs": {
+    "index": "---\ntitle: Ledger — Reversible async history\ndescription: Serialized reversible command history with cancellation ownership and atomic reactive snapshots.\npackage: ledger\ncategory: utilities\nkeywords: [undo, redo, history, commands, async, reactive, ripple]\nexports: [compose, createLedger, LedgerError, LedgerCancelledError, LedgerConfigurationError, LedgerDisposedError, LedgerExecutionError, LedgerRollbackError]\nrelated: [ripple, keymap, forge, vault]\nenvironments: [browser, node, ssr, deno]\n---\n\n<!-- markdownlint-disable MD025 MD033 MD060 -->\n\n<PackageHero package=\"ledger\" />\n\n## Why Ledger?\n\nUndo and redo require more than array manipulation when operations are asynchronous, cancellable, and visible in a UI. Ledger serializes only reversible commands, owns queue lifecycle, and publishes one atomic framework-neutral state snapshot without a reactive runtime dependency.\n\n```ts\n// Before\nconst undo = () => changes.pop()?.revert();\n\n// After\nimport { createLedger } from '@vielzeug/ledger';\n\nconst ledger = createLedger();\nawait ledger.do({ apply: saveNext, revert: restorePrevious });\nawait ledger.undo();\n```\n\n| Feature | Roll your own | Ledger |\n| --- | --- | --- |\n| Bundle size | 0 B | <PackageInfo package=\"ledger\" type=\"size\" /> |\n| Reversible history | Manual arrays | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| Serialized async work | Manual queue | <ore-icon name=\"check\" size=\"16\"></ore-icon> |\n| Queue cancellation | Manual ownership | Abort-aware lifecycle |\n| Framework-neutral state | Manual events | Structural `LedgerReadable<LedgerState>` |\n| Composition | Custom transaction code | `compose()` |\n\n<div class=\"decision-callout\">\n\n**Use Ledger when** you own reversible asynchronous state transitions and need undo, redo, or history UI.\n\n**Consider direct application code when** work is irreversible, fire-and-forget, or does not need history.\n\n</div>\n\n## Installation\n\n::: code-group\n\n```sh [pnpm]\npnpm add @vielzeug/ledger\n```\n\n```sh [npm]\nnpm install @vielzeug/ledger\n```\n\n```sh [yarn]\nyarn add @vielzeug/ledger\n```\n\n:::\n\n## Quick Start\n\nSubmit a reversible command, read state, then dispose its owner.\n\n```ts\nimport { createLedger } from '@vielzeug/ledger';\n\nlet value = 'before';\nconst ledger = createLedger();\n\nawait ledger.do({\n  apply: () => { value = 'after'; },\n  label: 'Rename value',\n  revert: () => { value = 'before'; },\n});\n\nawait ledger.undo();\nconsole.log(ledger.state.value.undo.length); // 0\nledger.dispose();\n```\n\n## Features\n\n<div class=\"features-grid\">\n\n- `createLedger()` — Create serialized reversible command history\n- `state` — Read atomic queue, undo, redo, and acceptance state\n- `compose()` — Combine reversible commands into one reversible command\n- `whenIdle()` — Await queued and active operation settlement\n- `LedgerCancelledError` — Distinguish cancellation from execution failure\n- `maxHistory` — Keep a non-negative safe-integer undo depth\n- `[Symbol.dispose]()` — Seal, abort, and clear a ledger owner\n\n</div>\n\n## Documentation\n\n<div class=\"doc-links\">\n\n- [Usage Guide](./usage.md)\n- [API Reference](./api.md)\n- [Examples](./examples.md)\n- [Migration Guide](./migration.md)\n\n</div>\n\n## See Also\n\n<div class=\"see-also\">\n\n- [Ripple](/ripple/) — Project Ledger's structural state readable into a signal when reactive derivations are needed.\n- [Keymap](/keymap/) — Route undo and redo shortcuts to a Ledger error boundary.\n- [Forge](/forge/) — Record reversible form transitions.\n- [Vault](/vault/) — Persist application snapshots outside transient undo history.\n\n</div>\n\n<!-- markdownlint-enable MD025 MD033 MD060 -->\n",
+    "api": "---\ntitle: Ledger — API Reference\ndescription: Reference for serialized reversible commands, history state, composition, cancellation, disposal, and errors.\n---\n\n[[toc]]\n\n## API Overview\n\n| Symbol | Purpose | Execution | Common gotcha |\n| --- | --- | --- | --- |\n| `createLedger()` | Create serialized reversible history | Sync construction | Every operation method is queued |\n| `compose()` | Combine commands into one history entry | Sync construction | Child metadata is not aggregated |\n| `ledger.do()` | Apply and record a command | Async | Failed or cancelled apply is not recorded |\n| `ledger.undo()` / `redo()` | Move the latest history entry | Async | Failures leave history on its original side |\n| `ledger.clear()` | Remove history without reverting | Async | Serialized behind earlier work |\n| `ledger.whenIdle()` | Await an empty operation queue | Async | Cannot force non-cooperative work to settle |\n\n## Package Entry Point\n\n| Import | Purpose |\n| --- | --- |\n| `@vielzeug/ledger` | Complete Ledger runtime, error hierarchy, state-readable contract, unsubscribe type, and command/history types |\n\n## `createLedger()`\n\n```ts\nfunction createLedger<TMeta = undefined>(options?: LedgerOptions): Ledger<TMeta>\n```\n\nCreates a ledger with one submission-order operation queue and one atomic state readable.\n\n```ts\nimport { createLedger } from '@vielzeug/ledger';\n\nconst ledger = createLedger<{ field: string }>({ maxHistory: 50 });\n```\n\n### `LedgerOptions`\n\n```ts\ninterface LedgerOptions {\n  maxHistory?: number;\n}\n```\n\n`maxHistory` defaults to `100`. It must be a non-negative safe integer. `0` executes commands without retaining history.\n\n## `compose()`\n\n```ts\nfunction compose<TMeta = undefined>(\n  commands: readonly ReversibleCommand<TMeta>[],\n  label?: string,\n): ReversibleCommand<TMeta>\n```\n\nSnapshots child command callbacks, applies children in order, and reverts them in reverse order. The result creates one history entry with the supplied label and `meta: undefined`.\n\nIf child application fails, completed children are compensated in reverse order. Compensation attempts continue after failures. Combined apply and compensation failures are preserved in an `AggregateError`, which Ledger exposes as `LedgerExecutionError.cause`. Normal composed reversion also attempts every child and reports failures through `LedgerRollbackError.cause` as an `AggregateError`.\n\n## `Ledger`\n\n```ts\ninterface Ledger<TMeta = undefined> {\n  clear(): Promise<void>;\n  readonly disposalSignal: AbortSignal;\n  dispose(): void;\n  readonly disposed: boolean;\n  do(command: ReversibleCommand<TMeta>, options?: LedgerCallOptions): Promise<void>;\n  redo(options?: LedgerCallOptions): Promise<void>;\n  readonly state: LedgerReadable<LedgerState<TMeta>>;\n  undo(options?: LedgerCallOptions): Promise<void>;\n  whenIdle(): Promise<void>;\n  [Symbol.dispose](): void;\n}\n```\n\nAll operation methods are serialized in call order.\n\n### `do()`\n\nSnapshots the command's `apply`, `revert`, `label`, and metadata reference when submitted. On successful apply it appends one undo entry, evicts the oldest entry beyond `maxHistory`, and clears redo history. Apply failure rejects with `LedgerExecutionError` and records nothing. Ledger does not automatically revert a failed individual command.\n\n### `undo()`\n\nReverts the final undo entry. Success moves it to the end of redo history. If no undo entry exists, the queued operation resolves without changing history. Revert failure rejects with `LedgerRollbackError` and leaves the entry in undo history.\n\n### `redo()`\n\nApplies the final redo entry. Success moves it to the end of undo history. If no redo entry exists, it resolves without changing history. Apply failure rejects with `LedgerExecutionError` and leaves the entry in redo history.\n\n### `clear()`\n\nQueues removal of all undo and redo entries. It does not call command revert functions and does not cancel earlier work.\n\n### `whenIdle()`\n\nResolves immediately when `queued` and `running` are zero, otherwise resolves after both reach zero. Multiple waiters are supported. It does not reject on disposal or cancel operations.\n\n### Disposal\n\n`dispose()` is permanent and idempotent. It sets `accepting: false`, clears undo and redo history, aborts active command contexts, and rejects queued operations that have not started with `LedgerDisposedError`. Active commands must observe their signal and settle before `running` reaches zero. `[Symbol.dispose]()` delegates to `dispose()`.\n\n## Command Types\n\n### `ReversibleCommand`\n\n```ts\ninterface ReversibleCommand<TMeta = undefined> {\n  readonly apply: (context: CommandContext) => Promise<void> | void;\n  readonly label?: string;\n  readonly meta?: TMeta;\n  readonly revert: (context: CommandContext) => Promise<void> | void;\n}\n```\n\n`apply` and `revert` may be synchronous or asynchronous. Metadata is retained by reference; Ledger does not deep-clone or deep-freeze it.\n\n### `CommandContext`\n\n```ts\ninterface CommandContext {\n  readonly signal: AbortSignal;\n}\n```\n\nThe signal combines ledger disposal with the operation signal. Queued cancellation prevents user code from running. Active cancellation is cooperative. If user code ignores abort and completes, the operation still rejects with `LedgerCancelledError` and its history transition is not committed.\n\n### `LedgerCallOptions`\n\n```ts\ninterface LedgerCallOptions {\n  signal?: AbortSignal;\n}\n```\n\nSupported by `do()`, `undo()`, and `redo()`. `clear()` has no call options.\n\n## State Types\n\n### `LedgerState`\n\n```ts\ninterface LedgerState<TMeta = undefined> {\n  readonly accepting: boolean;\n  readonly queued: number;\n  readonly redo: readonly HistoryEntry<TMeta>[];\n  readonly running: number;\n  readonly undo: readonly HistoryEntry<TMeta>[];\n}\n```\n\n| Field | Meaning |\n| --- | --- |\n| `accepting` | `true` until permanent disposal |\n| `queued` | Submitted operations that have not started |\n| `running` | Currently executing operation; serialization keeps this at 0 or 1 |\n| `undo` | Chronological successfully applied history; final entry is next to undo |\n| `redo` | Chronological reverted history; final entry is next to redo |\n\nState objects and history arrays are frozen replacements.\n\n### `HistoryEntry`\n\n```ts\ninterface HistoryEntry<TMeta = undefined> {\n  readonly label: string | undefined;\n  readonly meta: TMeta | undefined;\n}\n```\n\nHistory entries are frozen and intentionally omit command callbacks.\n\n### `LedgerReadable` and `Unsubscribe`\n\n`Ledger.state` implements this framework-neutral structural contract. Both names are root type exports.\n\n```ts\ntype Unsubscribe = () => void;\n\ninterface LedgerReadable<T> {\n  peek(): T;\n  subscribe(listener: () => void): Unsubscribe;\n  readonly value: T;\n}\n```\n\nSubscriptions are not immediate and receive no value argument. Listeners run synchronously from a snapshot after state replacement. A listener failure does not interrupt Ledger bookkeeping or later listeners; it is rethrown in a microtask.\n\n## Errors\n\n| Error | Trigger | History result |\n| --- | --- | --- |\n| `LedgerCancelledError` | Queued signal cancellation or active cooperative cancellation | No transition committed |\n| `LedgerDisposedError` | Submission after disposal or queued work rejected by disposal | History already cleared by disposal |\n| `LedgerExecutionError` | `apply()` fails during `do()` or `redo()` | New command absent, or redo entry retained |\n| `LedgerRollbackError` | `revert()` fails during `undo()` | Undo entry retained |\n| `LedgerConfigurationError` | Invalid `maxHistory` | Construction fails |\n| `LedgerError` | Base class and internal history corruption | Depends on operation |\n\nWrapped operation failures preserve the original value in `.cause`. Use `instanceof LedgerError` to catch the hierarchy, then narrow to a specific subtype.\n",
+    "usage": "---\ntitle: Ledger — Usage Guide\ndescription: Record reversible commands, observe serialized history, handle failures, and own cancellation and disposal.\n---\n\n[[toc]]\n\n## Basic Usage\n\nCapture both sides of a reversible transition before submitting it.\n\n```ts\nimport { createLedger } from '@vielzeug/ledger';\n\nusing ledger = createLedger();\nconst item = { name: 'Old name' };\nconst previous = item.name;\nconst next = 'New name';\n\nawait ledger.do({\n  apply: () => { item.name = next; },\n  label: 'Rename item',\n  revert: () => { item.name = previous; },\n});\n\nawait ledger.undo();\nawait ledger.redo();\n```\n\nAll `do()`, `undo()`, `redo()`, and `clear()` calls join one submission-order queue. Keep irreversible effects outside commands unless they have a real compensating operation.\n\n## Read Atomic State\n\n`state` is a framework-neutral `LedgerReadable`, not a Ripple signal. Read `value` or `peek()`, and subscribe to invalidation callbacks.\n\n```ts\nfunction renderHistory(): void {\n  const { accepting, queued, redo, running, undo } = ledger.state.value;\n  undoButton.disabled = undo.length === 0 || !accepting;\n  redoButton.disabled = redo.length === 0 || !accepting;\n  spinner.hidden = queued + running === 0;\n}\n\nrenderHistory();\nconst stop = ledger.state.subscribe(renderHistory);\n```\n\nSubscriptions are not immediate and receive no value argument. They run synchronously from a listener snapshot after every state replacement. A failure is rethrown in a microtask without interrupting Ledger bookkeeping or later subscribers.\n\nState objects, history arrays, and history entries are frozen snapshots. `undo` and `redo` are chronological; the next command to undo or redo is the final item. Metadata values are retained by reference rather than deep-cloned.\n\n## Attach History Metadata\n\nSet `label` for presentation and use the ledger's metadata type for application context.\n\n```ts\nconst ledger = createLedger<{ field: string }>();\n\nawait ledger.do({\n  apply: () => { form.email = next; },\n  label: 'Edit email',\n  meta: { field: 'email' },\n  revert: () => { form.email = previous; },\n});\n\nconsole.log(ledger.state.value.undo.at(-1));\n```\n\nLedger snapshots command callbacks, label, and metadata references when `do()` is submitted. Later mutation of the command object does not replace the captured callbacks.\n\n## Compose Reversible Commands\n\n`compose()` produces one command and one history entry. Children apply in order and revert in reverse order.\n\n```ts\nimport { compose } from '@vielzeug/ledger';\n\nawait ledger.do(\n  compose([\n    { apply: () => { node.x = nextX; }, revert: () => { node.x = previousX; } },\n    { apply: () => { node.y = nextY; }, revert: () => { node.y = previousY; } },\n  ], 'Move node'),\n);\n```\n\nIf a child apply fails, already-applied children are compensated in reverse order. Compensation continues after failures. If application and compensation both fail, `LedgerExecutionError.cause` is an `AggregateError` containing all failures. A composed command records the supplied label but does not aggregate child metadata.\n\n## Handle Operation Failures\n\n```ts\nimport {\n  LedgerCancelledError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from '@vielzeug/ledger';\n\ntry {\n  await ledger.undo();\n} catch (error) {\n  if (error instanceof LedgerCancelledError) {\n    // Expected cancellation.\n  } else if (error instanceof LedgerRollbackError) {\n    showUndoError(error.cause);\n  } else if (error instanceof LedgerExecutionError) {\n    showApplyError(error.cause);\n  } else {\n    throw error;\n  }\n}\n```\n\nA failed `do()` is not recorded and is not automatically reverted. A failed `undo()` remains in undo history; a failed `redo()` remains in redo history, allowing retry after the underlying problem is corrected.\n\n## Cancel Work\n\nPass a signal per operation. Queued cancellation prevents user code from starting. Active work receives a combined signal and must stop cooperatively.\n\n```ts\nconst controller = new AbortController();\nconst operation = ledger.do(\n  {\n    apply: ({ signal }) => saveDraft(nextDraft, { signal }),\n    revert: ({ signal }) => saveDraft(previousDraft, { signal }),\n  },\n  { signal: controller.signal },\n);\n\ncontroller.abort();\nawait operation.catch(handleHistoryFailure);\n```\n\nIf active user code ignores cancellation and finishes, Ledger rejects with `LedgerCancelledError` and does not record or move history. It does not compensate partial effects automatically, so command implementations must check or forward `context.signal` before committing changes.\n\n## Limit and Clear History\n\n`maxHistory` defaults to `100` and accepts non-negative safe integers. Successful commands beyond the cap evict the oldest undo entries. `0` executes commands without retaining undo or redo history.\n\n```ts\nconst ledger = createLedger({ maxHistory: 30 });\nawait ledger.clear();\n```\n\n`clear()` is serialized behind earlier work and clears both history arrays without reverting commands.\n\n## Drain and Dispose\n\n`whenIdle()` resolves when both `queued` and `running` reach zero. It does not cancel work.\n\n```ts\nconst operation = ledger.do(command);\nconst idle = ledger.whenIdle();\n\nledger.dispose();\nawait operation.catch(handleHistoryFailure);\nawait idle;\n```\n\nDisposal is permanent and idempotent. It immediately sets `accepting: false`, clears history, aborts active contexts, and rejects queued work with `LedgerDisposedError`. Active operations settle cooperatively; `whenIdle()` waits for them. Work that never settles can keep `whenIdle()` pending.\n\n## Framework Integration\n\nKeep one ledger per owning scope and adapt its structural readable through the framework's subscription API.\n\n::: code-group\n\n```tsx [React]\nimport { useEffect, useMemo, useSyncExternalStore } from 'react';\nimport { createLedger } from '@vielzeug/ledger';\n\nexport function UndoStatus() {\n  const ledger = useMemo(() => createLedger(), []);\n  const state = useSyncExternalStore(\n    (notify) => ledger.state.subscribe(notify),\n    () => ledger.state.value,\n    () => ledger.state.value,\n  );\n\n  useEffect(() => () => ledger.dispose(), [ledger]);\n  return <span>{state.undo.length} undo / {state.redo.length} redo</span>;\n}\n```\n\n```ts [Vue 3]\nimport { onUnmounted, shallowRef } from 'vue';\nimport { createLedger } from '@vielzeug/ledger';\n\nconst ledger = createLedger();\nconst state = shallowRef(ledger.state.value);\nconst stop = ledger.state.subscribe(() => { state.value = ledger.state.value; });\n\nonUnmounted(() => {\n  stop();\n  ledger.dispose();\n});\n```\n\n```ts [Ripple]\nimport { signal } from '@vielzeug/ripple';\nimport { createLedger } from '@vielzeug/ledger';\n\nconst ledger = createLedger();\nconst state = signal(ledger.state.value);\nconst stop = ledger.state.subscribe(() => { state.value = ledger.state.value; });\n\nfunction dispose(): void {\n  stop();\n  ledger.dispose();\n}\n```\n\n:::\n\n## Working with Other Vielzeug Libraries\n\nUse Keymap to route keyboard shortcuts into `undo()` and `redo()`. Project `ledger.state` into Ripple when reactive derivations are needed. Persist application snapshots with Vault; Ledger history itself is transient.\n\n## Best Practices\n\n- Capture previous and next values before submitting a command.\n- Keep irreversible effects outside Ledger commands.\n- Forward or check `context.signal` in asynchronous command work.\n- Catch every operation promise at the application boundary.\n- Read one `state` snapshot per render.\n- Keep state subscribers synchronous and handle failures through the application's global error boundary.\n- Use `whenIdle()` before releasing owners that require a drain boundary.\n- Dispose each owner-scoped ledger.\n",
+    "examples": "---\ntitle: Ledger — Examples\ndescription: Recipes for reversible editor and form history with Ledger.\n---\n\n## Examples\n\n- [Text Editor History](./examples/text-editor.md)\n- [Form History](./examples/form-history.md)\n"
+  },
+  "examples": [
+    {
+      "id": "cancellation",
+      "code": "import { LedgerCancelledError, createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger()\nconst controller = new AbortController()\n\nconst save = ledger.do(\n  {\n    apply: async ({ signal }) => {\n      if (signal.aborted) throw new Error('save aborted')\n      await new Promise((resolve) => setTimeout(resolve, 50))\n    },\n    revert: () => {},\n  },\n  { signal: controller.signal },\n)\n\ncontroller.abort()\n\ntry {\n  await save\n} catch (error) {\n  console.log('cancelled:', error instanceof LedgerCancelledError)\n}\n\nconsole.log('undo entries:', ledger.state.value.undo.length)\nledger.dispose()",
+      "name": "Cancellation"
+    },
+    {
+      "id": "command-data",
+      "code": "import { createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger()\nconst documentState = { title: 'Untitled' }\nconst previous = documentState.title\n\nawait ledger.do({\n  apply: () => { documentState.title = 'Hello World' },\n  label: 'Set title',\n  meta: { after: 'Hello World', before: previous, field: 'title' },\n  revert: () => { documentState.title = previous },\n})\n\nconsole.log('state:', documentState)\nconsole.log('history meta:', ledger.state.value.undo.at(-1)?.meta)\nconsole.log('queued:', ledger.state.value.queued)\nconsole.log('running:', ledger.state.value.running)\n\nawait ledger.undo()\nconsole.log('after undo:', documentState)\nledger.dispose()",
+      "name": "History Metadata & State"
+    },
+    {
+      "id": "compose-commands",
+      "code": "import { compose, createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger()\nconst node = { x: 0, y: 0 }\n\nawait ledger.do(compose([\n  {\n    apply: () => { node.x = 100 },\n    revert: () => { node.x = 0 },\n  },\n  {\n    apply: () => { node.y = 50 },\n    revert: () => { node.y = 0 },\n  },\n], 'Move node'))\n\nconsole.log('after apply:', node)\nconsole.log('undo entries:', ledger.state.value.undo.length)\n\nawait ledger.undo()\nconsole.log('after revert:', node)\nledger.dispose()",
+      "name": "Compose Reversible Commands"
+    },
+    {
+      "id": "do-undo-redo",
+      "code": "import { createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger()\nlet counter = 0\n\nasync function increment() {\n  const previous = counter\n  const next = previous + 1\n\n  await ledger.do({\n    apply: () => { counter = next },\n    label: 'Increment',\n    revert: () => { counter = previous },\n  })\n}\n\nawait increment()\nawait increment()\nawait increment()\nconsole.log('after increments:', counter)\nconsole.log('undo entries:', ledger.state.value.undo.length)\n\nawait ledger.undo()\nconsole.log('after undo:', counter)\n\nawait ledger.redo()\nconsole.log('after redo:', counter)\nledger.dispose()",
+      "name": "do / undo / redo"
+    },
+    {
+      "id": "reactive-signals",
+      "code": "import { createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger({ maxHistory: 5 })\nconst snapshots = []\nconst stop = ledger.state.subscribe(() => {\n  snapshots.push(ledger.state.value)\n})\nlet value = 0\n\nfor (const label of ['Increase', 'Increase again']) {\n  const previous = value\n  await ledger.do({\n    apply: () => { value += 1 },\n    label,\n    revert: () => { value = previous },\n  })\n}\n\nconsole.log('undo labels:', ledger.state.value.undo.map(entry => entry.label))\nconsole.log('queued/running:', ledger.state.value.queued, ledger.state.value.running)\n\nawait ledger.clear()\nconsole.log('undo entries after clear:', ledger.state.value.undo.length)\nconsole.log('state replacements:', snapshots.length)\nstop()\nledger.dispose()",
+      "name": "Structural State Subscription"
+    },
+    {
+      "id": "rollback-error",
+      "code": "import { LedgerRollbackError, createLedger } from '@vielzeug/ledger'\n\nconst ledger = createLedger()\n\nawait ledger.do({\n  apply: () => console.log('applied'),\n  label: 'Update draft',\n  revert: () => { throw new Error('draft is locked') },\n})\n\ntry {\n  await ledger.undo()\n} catch (error) {\n  if (error instanceof LedgerRollbackError) {\n    console.log('revert failed:', error.message)\n  }\n}\n\nconsole.log('undo entries:', ledger.state.value.undo.length)\nledger.dispose()",
+      "name": "Rollback Error"
+    }
+  ],
+  "typeSignatures": {
+    "compose": "export { compose } from './compose';",
+    "LedgerCancelledError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "LedgerConfigurationError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "LedgerDisposedError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "LedgerError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "LedgerExecutionError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "LedgerRollbackError": "export {\n  LedgerCancelledError,\n  LedgerConfigurationError,\n  LedgerDisposedError,\n  LedgerError,\n  LedgerExecutionError,\n  LedgerRollbackError,\n} from './errors';",
+    "createLedger": "export { createLedger } from './ledger';",
+    "CommandContext": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "HistoryEntry": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "Ledger": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "LedgerCallOptions": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "LedgerOptions": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "LedgerReadable": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "LedgerState": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "ReversibleCommand": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';",
+    "Unsubscribe": "export type {\n  CommandContext,\n  HistoryEntry,\n  Ledger,\n  LedgerCallOptions,\n  LedgerOptions,\n  LedgerReadable,\n  LedgerState,\n  ReversibleCommand,\n  Unsubscribe,\n} from './types';"
+  }
+}