@jterrazz/test 15.3.0 → 16.1.0

package/docs/reference/type-aliases/WaitUntilOptions.md

@@ -0,0 +1,46 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: WaitUntilOptions
+
+```ts
+type WaitUntilOptions = object;
+```
+
+Defined in: [src/model/assertions/wait-until.ts:4](https://github.com/jterrazz/package-test/blob/main/src/model/assertions/wait-until.ts#L4)
+
+How long to wait, and how often to look.
+
+## Properties
+
+### interval?
+
+```ts
+optional interval?: number;
+```
+
+Defined in: [src/model/assertions/wait-until.ts:6](https://github.com/jterrazz/package-test/blob/main/src/model/assertions/wait-until.ts#L6)
+
+Milliseconds between two readings. Default 50.
+
+***
+
+### timeout?
+
+```ts
+optional timeout?: number;
+```
+
+Defined in: [src/model/assertions/wait-until.ts:8](https://github.com/jterrazz/package-test/blob/main/src/model/assertions/wait-until.ts#L8)
+
+How long the condition has to become true. Default 5 000 ms.
+
+***
+
+### why?
+
+```ts
+optional why?: string;
+```
+
+Defined in: [src/model/assertions/wait-until.ts:10](https://github.com/jterrazz/package-test/blob/main/src/model/assertions/wait-until.ts#L10)
+
+What the condition is, named in the failure. Default: the predicate's source.

package/docs/reference/type-aliases/WebsiteBackendOptions.md

@@ -0,0 +1,37 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: WebsiteBackendOptions
+
+```ts
+type WebsiteBackendOptions = object;
+```
+
+Defined in: [src/facets/website/website.specification.ts:62](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L62)
+
+The declared stub backend behind the site under test — started before the
+server command, torn down with the runner. Its URL is injected into the
+server child's environment under `env`; the contracts each chain declares
+via `.intercept(...)` are what it serves.
+
+## Properties
+
+### env
+
+```ts
+env: string;
+```
+
+Defined in: [src/facets/website/website.specification.ts:64](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L64)
+
+Env var receiving the stub's URL in the server child (e.g. `'API_URL'`).
+
+***
+
+### port?
+
+```ts
+optional port?: number;
+```
+
+Defined in: [src/facets/website/website.specification.ts:66](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L66)
+
+Fixed port — pins a stable stub URL across runs. Default: a free OS-assigned port.

package/docs/reference/type-aliases/WebsiteHandle.md

@@ -0,0 +1,51 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: WebsiteHandle
+
+```ts
+type WebsiteHandle = object;
+```
+
+Defined in: [src/facets/website/website.specification.ts:213](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L213)
+
+The record returned by startWebsite \| specification.website.
+Destructure with the canonical names (CONVENTIONS A3):
+
+    const { website, cleanup } = await specification.website(…);
+
+## Properties
+
+### cleanup
+
+```ts
+cleanup: () => Promise<void>;
+```
+
+Defined in: [src/facets/website/website.specification.ts:215](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L215)
+
+Stop the server process and the shared browser instance.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### url
+
+```ts
+url: string;
+```
+
+Defined in: [src/facets/website/website.specification.ts:217](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L217)
+
+The base URL the specs run against.
+
+***
+
+### website
+
+```ts
+website: WebsiteSpecification;
+```
+
+Defined in: [src/facets/website/website.specification.ts:218](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L218)

package/docs/reference/type-aliases/WebsiteSpecification.md

@@ -0,0 +1,118 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: WebsiteSpecification
+
+```ts
+type WebsiteSpecification = object;
+```
+
+Defined in: [src/model/chain/builder.ts:302](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L302)
+
+The `website` facet — page chain entry handed out by
+`specification.website()`. Setup methods chain; action methods are
+terminal. `.visit()` renders the page in the shared browser; `.fetch()`
+performs one raw HTTP exchange and never follows redirects.
+
+## Properties
+
+### clock
+
+```ts
+clock: (iso) => WebsiteSpecification;
+```
+
+Defined in: [src/model/chain/builder.ts:307](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L307)
+
+Pin the PAGE's `Date` at `iso` for this chain — what the site's own
+scripts read. A `.fetch()` opens no page and refuses the setup.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `iso` | `string` |
+
+#### Returns
+
+`WebsiteSpecification`
+
+***
+
+### fetch
+
+```ts
+fetch: (path) => Promise<FetchResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:317](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L317)
+
+Perform one raw HTTP GET — redirects surface as 3xx results, never followed.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`\<[`FetchResult`](../interfaces/FetchResult.md)\>
+
+***
+
+### headers
+
+```ts
+headers: (headers) => WebsiteSpecification;
+```
+
+Defined in: [src/model/chain/builder.ts:309](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L309)
+
+Set HTTP headers for the exchange (incl. User-Agent overrides). Multiple calls merge.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `headers` | `Record`\<`string`, `string`\> |
+
+#### Returns
+
+`WebsiteSpecification`
+
+***
+
+### intercept
+
+```ts
+intercept: InterceptMethod<WebsiteSpecification>;
+```
+
+Defined in: [src/model/chain/builder.ts:314](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L314)
+
+Declare the chain's backend contracts — served by the declared stub
+backend (requires the runner's `backend` option). Multiple calls append.
+
+***
+
+### visit
+
+```ts
+visit: (path, scenario?) => Promise<PageResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:323](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L323)
+
+Render the page in the shared browser and resolve with the captured
+document. With a scenario, the visitor interacts first (the When) and
+the capture reflects the FINAL page state.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `scenario?` | [`VisitScenario`](VisitScenario.md) |
+
+#### Returns
+
+`Promise`\<[`PageResult`](../interfaces/PageResult.md)\>

package/docs/reference/type-aliases/WebsiteSpecificationOptions.md

@@ -0,0 +1,40 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: WebsiteSpecificationOptions\<Services\>
+
+```ts
+type WebsiteSpecificationOptions<Services> = object & 
+  | {
+  backend?: WebsiteBackendOptions;
+  server: ServerSpec<Services>;
+  url?: never;
+}
+  | {
+  backend?: never;
+  server?: never;
+  url: string;
+};
+```
+
+Defined in: [src/facets/website/website.specification.ts:77](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L77)
+
+Options for startWebsite \| specification.website. `server` (start
+the site locally) and `url` (target a running site) are mutually
+exclusive BY TYPE — the union makes the invalid combinations
+inexpressible rather than runtime-checked. `backend` requires `server`
+mode for the same reason: a deployed site cannot be pointed at a local
+stub.
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `external?` | `"allow"` \| `"block"` | Cross-origin request policy for visits. Default: `'block'` with a local `server` (deterministic — analytics and CDNs never leave the machine), `'allow'` with a deployed `url`. | [src/facets/website/website.specification.ts:83](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L83) |
+| `root?` | `string` | Project-root override (CONVENTIONS A9): the working directory of the `server` command. Auto-discovered from the calling file when absent. | [src/facets/website/website.specification.ts:88](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L88) |
+| `services?` | `Services` | Named services started with the runner, before the site is: a database the site reads, a `process()` backend it calls. They are started in declaration order and stopped with the specification, and `server` may be a function of them — which is how a site is handed the URL of the API it was started beside. | [src/facets/website/website.specification.ts:96](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L96) |
+| `transform()?` | (`text`) => `string` | Escape hatch: normaliser applied to every compared reading of a result — the head projection and the json-ld among them — before the comparison (CONVENTIONS D6). Does NOT mutate the raw `.text` accessor. Prefer `{{token}}` placeholders in fixtures; this is for what a token cannot name, a meta a FRAMEWORK owns and the page never asked for. | [src/facets/website/website.specification.ts:104](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.specification.ts#L104) |
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `Services` *extends* [`ServiceRecord`](ServiceRecord.md) | [`ServiceRecord`](ServiceRecord.md) |

package/docs/reference/variables/anthropic.md

@@ -0,0 +1,19 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: anthropic
+
+```ts
+const anthropic: object;
+```
+
+Defined in: [src/seams/anthropic/anthropic.ts:55](https://github.com/jterrazz/package-test/blob/main/src/seams/anthropic/anthropic.ts#L55)
+
+Anthropic API intercept helpers.
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `error()` | (`status`, `message?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: return an Anthropic error. | [src/seams/anthropic/anthropic.ts:91](https://github.com/jterrazz/package-test/blob/main/src/seams/anthropic/anthropic.ts#L91) |
+| `messages()` | (`filter?`, `url?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | Request: match Messages API calls, optionally routed through a custom gateway URL. When used with a JSON fixture file, the data is returned as-is (no wrapping) because Anthropic fixtures are typically already in the Messages API response shape. **Example** `anthropic.messages() anthropic.messages({ system: /classify/ }) anthropic.messages({ user: buildPrompt() }) // string = EXACT equality anthropic.messages({ user: /classify/ }, GATEWAY)` | [src/seams/anthropic/anthropic.ts:68](https://github.com/jterrazz/package-test/blob/main/src/seams/anthropic/anthropic.ts#L68) |
+| `reply()` | (`data`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: wrap data in Anthropic messages format. | [src/seams/anthropic/anthropic.ts:86](https://github.com/jterrazz/package-test/blob/main/src/seams/anthropic/anthropic.ts#L86) |
+| `timeout()` | () => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: simulate a timeout. | [src/seams/anthropic/anthropic.ts:105](https://github.com/jterrazz/package-test/blob/main/src/seams/anthropic/anthropic.ts#L105) |

package/docs/reference/variables/banner.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: banner
+
+```ts
+const banner: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:80](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L80)
+
+The `banner` landmark — the page header.

package/docs/reference/variables/button.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: button
+
+```ts
+const button: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:45](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L45)
+
+A button (or element with the button role), by accessible name.

package/docs/reference/variables/clock.md

@@ -0,0 +1,16 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: clock
+
+```ts
+const clock: object;
+```
+
+Defined in: [src/model/clock/clock.ts:62](https://github.com/jterrazz/package-test/blob/main/src/model/clock/clock.ts#L62)
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `advance()` | (`ms`) => `Promise`\<`void`\> | Move the pinned clock forward by `ms` — and, under [clock.run](#run), fire every callback that came due, awaiting what each of them started. Only a pinned clock moves: called with no clock taken, it says so rather than silently doing nothing to the real one. | [src/model/clock/clock.ts:70](https://github.com/jterrazz/package-test/blob/main/src/model/clock/clock.ts#L70) |
+| `at()` | (`iso`) => `Disposable` | Pin `Date` at `iso` for the current scope. `Date` ONLY: the scheduler stays real, so a subject that awaits, renders or polls keeps running. **Example** `using _ = clock.at('2026-03-04T09:30:00Z'); expect(stampedAt()).toBe('2026-03-04T09:30:00.000Z');` | [src/model/clock/clock.ts:88](https://github.com/jterrazz/package-test/blob/main/src/model/clock/clock.ts#L88) |
+| `run()` | (`iso?`) => `Disposable` | Take the scheduler as well as the calendar: `setTimeout`, `setInterval` and their friends queue instead of firing, and [clock.advance](#advance) is what makes them due. For a subject whose behaviour IS elapsed time — a debounce, a retry backoff, a poll — where waiting for real would be the arbitrary sleep J2 forbids. **Example** `using _ = clock.run('2026-03-04T09:30:00Z'); const pending = retrying(failsTwice); await clock.advance(5_000); await expect(pending).resolves.toBe('ok');` | [src/model/clock/clock.ts:105](https://github.com/jterrazz/package-test/blob/main/src/model/clock/clock.ts#L105) |

package/docs/reference/variables/complementary.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: complementary
+
+```ts
+const complementary: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:83](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L83)
+
+The `complementary` landmark — an `<aside>`, a sidebar.

package/docs/reference/variables/component.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: component
+
+```ts
+const component: ComponentChain;
+```
+
+Defined in: [src/facets/component/component.specification.ts:21](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.specification.ts#L21)
+
+Present, typed, and refusing — every setup and the terminal action alike.

package/docs/reference/variables/content.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: content
+
+```ts
+const content: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:57](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L57)
+
+An element containing the given text.

package/docs/reference/variables/contentinfo.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: contentinfo
+
+```ts
+const contentinfo: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:86](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L86)
+
+The `contentinfo` landmark — the page footer.

package/docs/reference/variables/dialog.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: dialog
+
+```ts
+const dialog: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:127](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L127)
+
+A modal or non-modal `<dialog>`, by accessible name. A closed one is absent.

package/docs/reference/variables/field.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: field
+
+```ts
+const field: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:48](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L48)
+
+A form field, by label.

package/docs/reference/variables/form.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: form
+
+```ts
+const form: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:89](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L89)
+
+The `form` landmark — a form carrying an accessible name.

package/docs/reference/variables/heading.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: heading
+
+```ts
+const heading: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:51](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L51)
+
+A heading, by accessible name.

package/docs/reference/variables/http.md

@@ -0,0 +1,40 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: http
+
+```ts
+const http: object;
+```
+
+Defined in: [src/model/contracts/http.ts:164](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L164)
+
+Generic HTTP contract helpers for any URL. The url is absolute (string or
+RegExp), or a PATH FORM starting with `/` — `http.get('/articles/{{uuid}}')`
+matches that path on ANY origin, which is what an app calling its own
+backend needs. An optional [HttpContractFilter](../type-aliases/HttpContractFilter.md) narrows matching by
+body, headers, or query — a request that hits the URL/method but fails the
+filter counts as unmatched (strict contracts, CONVENTIONS D7).
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `any()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:165](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L165) |
+| `delete()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:169](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L169) |
+| `empty()` | (`status?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: a body-less reply (204 by default). | [src/model/contracts/http.ts:190](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L190) |
+| `error()` | (`status`, `body?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: an error status. Without a body, `{ error: 'HTTP <status>' }`. | [src/model/contracts/http.ts:195](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L195) |
+| `get()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:173](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L173) |
+| `json()` | (`body`, `init?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: a JSON body (200 by default). | [src/model/contracts/http.ts:200](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L200) |
+| `patch()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:177](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L177) |
+| `post()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:181](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L181) |
+| `put()` | (`url`, `filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | - | [src/model/contracts/http.ts:185](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L185) |
+| `sse()` | (`events`, `init?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: a server-sent event stream — one chunk per event, framed the way an `EventSource` reads them, served as `text/event-stream`. **Example** `http.sse([{ data: { token: 'Hel' } }, { data: { token: 'lo' } }, { event: 'done', data: '' }])` | [src/model/contracts/http.ts:249](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L249) |
+| `stream()` | (`chunks`, `init?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: a body that arrives in PIECES, written in order. A subject that reads a response as it lands — a token-by-token render, a progress bar, a reconnect on a half-read body — is specified by the chunks and their order, which a single serialised body cannot state. Honoured by all three engines: msw's server, msw's worker, and the `node:http` stub the website and mobile facets serve from. **Example** `http.stream(['Hel', 'lo, ', 'world'], { contentType: 'text/plain', delay: 10 })` | [src/model/contracts/http.ts:229](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L229) |
+| `text()` | (`body`, `init?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: a text body, served as `text/plain` (200 by default). | [src/model/contracts/http.ts:263](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L263) |
+| `unreachable()` | () => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: no response at all — the request fails in transport, the way a server that is not running fails it. `fetch` rejects; no status is served. | [src/model/contracts/http.ts:213](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L213) |
+
+## Example
+
+```ts
+defineContract({ request: http.get('/articles/{{uuid}}'), response: http.json(article) })
+  defineContract({ request: http.post(URL, { body: { user: 'alice' } }), response: http.empty() })
+```

package/docs/reference/variables/intercept.md

@@ -0,0 +1,11 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: intercept
+
+```ts
+const intercept: Intercept;
+```
+
+Defined in: [src/index.ts:16](https://github.com/jterrazz/package-test/blob/main/src/index.ts#L16)
+
+The module-scope network double, on msw's node server — what a test with no
+chain to hang contracts on reaches for (chapter 16).

package/docs/reference/variables/link.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: link
+
+```ts
+const link: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:54](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L54)
+
+A link, by accessible name.

package/docs/reference/variables/listitem.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: listitem
+
+```ts
+const listitem: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:139](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L139)
+
+An item of a list, by its text. Retires the `.first()` of an unnamed `<li>`.

package/docs/reference/variables/main.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: main
+
+```ts
+const main: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:92](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L92)
+
+The `main` landmark — the primary content of the document.

package/docs/reference/variables/match.md

@@ -0,0 +1,8 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: match
+
+```ts
+const match: MatchFactories;
+```
+
+Defined in: [src/model/matching/match.ts:150](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L150)

package/docs/reference/variables/navigation.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: navigation
+
+```ts
+const navigation: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:95](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L95)
+
+The `navigation` landmark — a `<nav>`. Name it when a page has several.

package/docs/reference/variables/openai.md

@@ -0,0 +1,21 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: openai
+
+```ts
+const openai: object;
+```
+
+Defined in: [src/seams/openai/openai.ts:128](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L128)
+
+OpenAI API intercept helpers.
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `chat()` | (`filter?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | Request: match Chat Completions API calls. STRING filters mean EXACT equality (pass the app's own prompt builder); loosen deliberately with a RegExp or `match.includes(...)`. **Example** `openai.chat() // any chat call openai.chat({ model: 'gpt-4o' }) // exact model openai.chat({ system: buildPrompt() }) // exact system prompt openai.chat({ system: /classify/ }) // pattern` | [src/seams/openai/openai.ts:140](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L140) |
+| `error()` | (`status`, `message?`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: return an OpenAI error. | [src/seams/openai/openai.ts:183](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L183) |
+| `malformed()` | (`content`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: return malformed content. | [src/seams/openai/openai.ts:197](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L197) |
+| `reply()` | (`data`) => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: wrap data in Chat Completions format. **Example** `openai.reply({ categories: ['TECH'] })` | [src/seams/openai/openai.ts:178](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L178) |
+| `responses()` | (`filter?`, `url?`) => [`ContractRequest`](../type-aliases/ContractRequest.md) | Request: match Responses API calls (AI SDK v5+) with auto-wrapping. String filters mean EXACT equality (see [openai.chat](#chat)). When used with a JSON file, the data is automatically wrapped in the Responses API envelope. **Example** `openai.responses({ user: /Report Ingestion/ }, GATEWAY)` | [src/seams/openai/openai.ts:162](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L162) |
+| `timeout()` | () => [`ContractResponse`](../type-aliases/ContractResponse.md) | Response: simulate a timeout. | [src/seams/openai/openai.ts:202](https://github.com/jterrazz/package-test/blob/main/src/seams/openai/openai.ts#L202) |

package/docs/reference/variables/option.md

@@ -0,0 +1,17 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: option
+
+```ts
+const option: ElementFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:151](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L151)
+
+An option of a select or a listbox, by its label — named inside the field
+that holds it: `within(field('Channel'), option('LinkedIn'))`.
+
+Asserted by PRESENCE, not by visibility: the options of a collapsed
+`<select>` are in the document and in the accessibility tree, and none of
+them has a box on the screen until it is opened. `see(option('LinkedIn'))`
+therefore asks "is it offered", and `see(selected(option('LinkedIn')))`
+asks which one the field is on.

package/docs/reference/variables/region.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: region
+
+```ts
+const region: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:98](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L98)
+
+The `region` landmark — a `<section>` carrying an accessible name.

package/docs/reference/variables/row.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: row
+
+```ts
+const row: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:136](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L136)
+
+A row of a table or grid, by the text of its cells.

package/docs/reference/variables/search.md

@@ -0,0 +1,10 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Variable: search
+
+```ts
+const search: LandmarkFactory;
+```
+
+Defined in: [src/model/elements/elements.ts:101](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L101)
+
+The `search` landmark.