@jterrazz/test 16.1.1 → 18.0.0

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

@@ -1,13 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ContractInput
-
-```ts
-type ContractInput = 
-  | Contract
-  | Contract[]
-  | Contracts;
-```
-
-Defined in: [src/model/contracts/contract.ts:50](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/contract.ts#L50)
-
-Any accepted contract input: one, a list, or a composite.

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

@@ -1,95 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ContractRequest
-
-```ts
-type ContractRequest = object;
-```
-
-Defined in: [src/model/contracts/types.ts:26](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L26)
-
-The request half of a contract: which outgoing call it speaks for.
-
-`url` is either an absolute URL (string or RegExp), or a PATH FORM starting
-with `/` (`/articles/{{uuid}}`) which matches any origin — the shape a
-website/mobile app's own backend calls take. `{{token}}` segments compare
-structurally, declared query params are a subset of the observed ones.
-
-## Properties
-
-### adapter
-
-```ts
-adapter: string;
-```
-
-Defined in: [src/model/contracts/types.ts:28](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L28)
-
-Adapter name — `http` | `openai` | `anthropic`.
-
-***
-
-### match?
-
-```ts
-optional match?: (request) => boolean;
-```
-
-Defined in: [src/model/contracts/types.ts:34](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L34)
-
-Optional request matcher — the contract only fires if this returns true.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`MatchableRequest`](MatchableRequest.md) |
-
-#### Returns
-
-`boolean`
-
-***
-
-### method
-
-```ts
-method: string;
-```
-
-Defined in: [src/model/contracts/types.ts:30](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L30)
-
-HTTP method to match. `*` matches any method.
-
-***
-
-### url
-
-```ts
-url: RegExp | string;
-```
-
-Defined in: [src/model/contracts/types.ts:32](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L32)
-
-Absolute URL (string | RegExp) or an any-origin path form (`/articles/{{uuid}}`).
-
-***
-
-### wrap
-
-```ts
-wrap: (data) => ContractResponse;
-```
-
-Defined in: [src/model/contracts/types.ts:36](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L36)
-
-Transform raw data into a provider-specific response envelope.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `unknown` |
-
-#### Returns
-
-[`ContractResponse`](ContractResponse.md)

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

@@ -1,23 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ContractResponder
-
-```ts
-type ContractResponder = (request) => ContractResponse;
-```
-
-Defined in: [src/model/contracts/types.ts:105](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L105)
-
-A dynamic response: computed from the observed request at the moment the
-contract is served, rather than fixed ahead of time. Handed the same
-[MatchableRequest](MatchableRequest.md) the request half matched on, so the reply can echo
-or derive from the body/headers/url.
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`MatchableRequest`](MatchableRequest.md) |
-
-## Returns
-
-[`ContractResponse`](ContractResponse.md)

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

@@ -1,78 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ContractResponse
-
-```ts
-type ContractResponse = object;
-```
-
-Defined in: [src/model/contracts/types.ts:42](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L42)
-
-The response half of a contract: what to reply when the request matches.
-
-## Properties
-
-### body
-
-```ts
-body: unknown;
-```
-
-Defined in: [src/model/contracts/types.ts:50](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L50)
-
-Response body — an object is JSON, a string is text, `null`/`undefined`
-is empty, and a [StreamBody](StreamBody.md) (built by `http.stream()` /
-`http.sse()`) arrives in pieces.
-
-***
-
-### delay?
-
-```ts
-optional delay?: number;
-```
-
-Defined in: [src/model/contracts/types.ts:54](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L54)
-
-Delay in ms before responding (for timeout testing).
-
-***
-
-### headers?
-
-```ts
-optional headers?: Record<string, string>;
-```
-
-Defined in: [src/model/contracts/types.ts:52](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L52)
-
-Response headers.
-
-***
-
-### status?
-
-```ts
-optional status?: number;
-```
-
-Defined in: [src/model/contracts/types.ts:44](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L44)
-
-HTTP status code (default: 200).
-
-***
-
-### transport?
-
-```ts
-optional transport?: "network-error";
-```
-
-Defined in: [src/model/contracts/types.ts:64](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L64)
-
-A transport failure instead of a reply: the request never reached a
-server, so `fetch` rejects. `status`, `body` and `headers` say nothing
-here — there is no response to carry them.
-
-The one thing a status code cannot express. A component's "the server did
-not answer, check that it is running" branch is reached by a rejected
-`fetch`, and a 503 stand-in tests the other branch entirely.

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

@@ -1,13 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ContractResponseValue
-
-```ts
-type ContractResponseValue = 
-  | ContractResponder
-  | ContractResponse;
-```
-
-Defined in: [src/model/contracts/types.ts:111](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/types.ts#L111)
-
-What a contract replies with: either a fixed [ContractResponse](ContractResponse.md) or a
-[ContractResponder](ContractResponder.md) evaluated per served request.

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

@@ -1,48 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: Contracts
-
-```ts
-type Contracts = object;
-```
-
-Defined in: [src/model/contracts/contract.ts:37](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/contract.ts#L37)
-
-A composite of contracts — the unit tests import. Flat, ordered, immutable;
-`.with()` derives a variant without touching the original.
-
-## Properties
-
-### contracts
-
-```ts
-readonly contracts: readonly Contract[];
-```
-
-Defined in: [src/model/contracts/contract.ts:39](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/contract.ts#L39)
-
-The flattened contracts, in selection order.
-
-***
-
-### with
-
-```ts
-with: (...overrides) => Contracts;
-```
-
-Defined in: [src/model/contracts/contract.ts:46](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/contract.ts#L46)
-
-Derive a new composite: every base contract sharing a route with an
-override is REPLACED, and the overrides are PREPENDED — so a
-more-specific override wins first-match selection over a generic base
-route it does not replace.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| ...`overrides` | ([`Contract`](Contract.md) \| [`Contract`](Contract.md)[] \| `Contracts`)[] |
-
-#### Returns
-
-`Contracts`

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

@@ -1,16 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DatabaseKeys\<Services\>
-
-```ts
-type DatabaseKeys<Services> = { [K in keyof Services]: Services[K] extends DatabasePort ? K & string : never }[keyof Services];
-```
-
-Defined in: [src/model/chain/services.ts:19](https://github.com/jterrazz/package-test/blob/main/src/model/chain/services.ts#L19)
-
-Keys of a services record whose handles are databases.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `Services` *extends* [`ServiceRecord`](ServiceRecord.md) |

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

@@ -1,72 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DatabasePort
-
-```ts
-type DatabasePort = object;
-```
-
-Defined in: [src/model/ports/database.port.ts:5](https://github.com/jterrazz/package-test/blob/main/src/model/ports/database.port.ts#L5)
-
-Abstract database interface for specification runners.
-Implement this to plug in your database stack (e.g. Postgres, SQLite).
-
-## Properties
-
-### query
-
-```ts
-query: (table, columns) => Promise<unknown[][]>;
-```
-
-Defined in: [src/model/ports/database.port.ts:10](https://github.com/jterrazz/package-test/blob/main/src/model/ports/database.port.ts#L10)
-
-Query a table and return rows as arrays of values.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `table` | `string` |
-| `columns` | `string`[] |
-
-#### Returns
-
-`Promise`\<`unknown`[][]\>
-
-***
-
-### reset
-
-```ts
-reset: () => Promise<void>;
-```
-
-Defined in: [src/model/ports/database.port.ts:13](https://github.com/jterrazz/package-test/blob/main/src/model/ports/database.port.ts#L13)
-
-Reset database to clean state between tests.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### seed
-
-```ts
-seed: (sql) => Promise<void>;
-```
-
-Defined in: [src/model/ports/database.port.ts:7](https://github.com/jterrazz/package-test/blob/main/src/model/ports/database.port.ts#L7)
-
-Execute raw SQL (for seeding test data).
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `sql` | `string` |
-
-#### Returns
-
-`Promise`\<`void`\>

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

@@ -1,46 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DeviceOpenOptions
-
-```ts
-type DeviceOpenOptions = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:89](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L89)
-
-Per-open options forwarded to the device session.
-
-## Properties
-
-### bundleId
-
-```ts
-bundleId: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:91](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L91)
-
-The app under test — terminated and relaunched for a fresh, deterministic state.
-
-***
-
-### deepLink?
-
-```ts
-optional deepLink?: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:93](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L93)
-
-Deep link applied after the relaunch (`news://events`); absent opens the app plainly.
-
-***
-
-### scenario?
-
-```ts
-optional scenario?: MobileScenario;
-```
-
-Defined in: [src/model/ports/device.port.ts:95](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L95)
-
-The interaction scenario to run after launch; the capture reflects the final state.

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

@@ -1,51 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DevicePort
-
-```ts
-type DevicePort = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:123](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L123)
-
-Abstract device interface for the mobile specification runner.
-One implementation lives in `integrations/appium/` — a single driver
-session per runner, created on the first `open()` and reused; each open
-terminates and relaunches the app for a deterministic fresh state.
-
-## Properties
-
-### close
-
-```ts
-close: () => Promise<void>;
-```
-
-Defined in: [src/model/ports/device.port.ts:125](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L125)
-
-End the driver session (idempotent).
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### open
-
-```ts
-open: (options) => Promise<DeviceScreen>;
-```
-
-Defined in: [src/model/ports/device.port.ts:127](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L127)
-
-Relaunch the app, apply the deep link, run the scenario, capture the final screen.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | [`DeviceOpenOptions`](DeviceOpenOptions.md) |
-
-#### Returns
-
-`Promise`\<[`DeviceScreen`](DeviceScreen.md)\>

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

@@ -1,32 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DeviceScreen
-
-```ts
-type DeviceScreen = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:83](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L83)
-
-The screen captured by a device open — the FINAL state when a scenario
-ran. The tree is the projected page source; `texts` are the visible
-labels/values in document order, consecutive duplicates collapsed.
-
-## Properties
-
-### texts
-
-```ts
-texts: string[];
-```
-
-Defined in: [src/model/ports/device.port.ts:84](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L84)
-
-***
-
-### tree
-
-```ts
-tree: ScreenNode;
-```
-
-Defined in: [src/model/ports/device.port.ts:85](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L85)

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

@@ -1,39 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DeviceTimeouts
-
-```ts
-type DeviceTimeouts = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:104](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L104)
-
-How long a device session waits, in milliseconds. Every field is optional
-and falls back to the framework's own default, so a runner states only the
-wait it needs to move — the defaults suit a release build, and a project
-that drives a DEV build pays for its bundler's cold boot.
-
-## Properties
-
-### action?
-
-```ts
-optional action?: number;
-```
-
-Defined in: [src/model/ports/device.port.ts:109](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L109)
-
-How long every verb polls for a visible match before refusing.
-Default: `30_000` — enough for a cold app boot on a release bundle.
-
-***
-
-### launch?
-
-```ts
-optional launch?: number;
-```
-
-Defined in: [src/model/ports/device.port.ts:114](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L114)
-
-How long the FIRST session waits for WebDriverAgent to build and
-launch on the simulator. Default: `240_000`.

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

@@ -1,43 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DockerSpecConfig
-
-```ts
-type DockerSpecConfig = object;
-```
-
-Defined in: [src/model/chain/builder.ts:47](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L47)
-
-Configuration for the docker-aware cli mode. When set on
-[SpecificationConfig](SpecificationConfig.md), the cli runner generates a test-run id, injects
-it into the child env under `envVar`, then queries Docker for every
-container carrying `testRunLabel=<id>` after the command exits.
-
-## Properties
-
-### envVar
-
-```ts
-envVar: string;
-```
-
-Defined in: [src/model/chain/builder.ts:48](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L48)
-
-***
-
-### nameLabel
-
-```ts
-nameLabel: string;
-```
-
-Defined in: [src/model/chain/builder.ts:49](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L49)
-
-***
-
-### testRunLabel
-
-```ts
-testRunLabel: string;
-```
-
-Defined in: [src/model/chain/builder.ts:50](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L50)

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

@@ -1,21 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: DomMount
-
-```ts
-type DomMount = (container) => (() => void) | void;
-```
-
-Defined in: [src/seams/vitest-browser/ui.ts:18](https://github.com/jterrazz/package-test/blob/main/src/seams/vitest-browser/ui.ts#L18)
-
-A vanilla DOM subject: a function handed the container it must fill. Its
-optional return is the teardown, the way a DOM library states one.
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `container` | `HTMLElement` |
-
-## Returns
-
-(() => `void`) \| `void`

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

@@ -1,27 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ElementKind
-
-```ts
-type ElementKind = 
-  | "button"
-  | "dialog"
-  | "field"
-  | "heading"
-  | "link"
-  | "listitem"
-  | "option"
-  | "row"
-  | "status"
-  | "table"
-  | "testId"
-  | "text";
-```
-
-Defined in: [src/model/ports/browser.port.ts:24](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L24)
-
-The interactive/textual element kinds — what a visitor actually acts on.
-
-`dialog`, `status`, `table`, `row`, `listitem` and `option` are ARIA roles
-like the landmarks, but they are not CONTAINERS of a page: they are things a
-visitor reads and acts on, and they are the roles the estate's UI specs were
-already reaching for through `getByRole` or, worse, through `.first()`.