@jterrazz/test 16.1.1 → 18.0.0

package/docs/reference/variables/http.md

@@ -1,40 +0,0 @@
-<!-- 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

@@ -1,11 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,8 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,21 +0,0 @@
-<!-- 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

@@ -1,17 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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

@@ -1,10 +0,0 @@
-<!-- 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.

package/docs/reference/variables/specification.md

@@ -1,8 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Variable: specification
-
-```ts
-const specification: Specification;
-```
-
-Defined in: [src/facets/specification.ts:42](https://github.com/jterrazz/package-test/blob/main/src/facets/specification.ts#L42)

package/docs/reference/variables/status.md

@@ -1,10 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Variable: status
-
-```ts
-const status: LandmarkFactory;
-```
-
-Defined in: [src/model/elements/elements.ts:130](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L130)
-
-A live region announcing a result — `role="status"`, an `<output>`.

package/docs/reference/variables/table.md

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