@jterrazz/test 16.1.1 → 17.0.0

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

@@ -1,74 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ElementMatch
-
-```ts
-type ElementMatch = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:100](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L100)
-
-One candidate captured when a descriptor matched more than one element —
-the evidence the ambiguity error enumerates so the author can disambiguate
-without opening a browser.
-
-## Properties
-
-### accessibleName?
-
-```ts
-optional accessibleName?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:106](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L106)
-
-The accessible name, when it differs from the text — an `aria-label` is
-what a role descriptor MATCHED on, and printing the text alone sends the
-author to disambiguate a name they cannot see.
-
-***
-
-### context?
-
-```ts
-optional context?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:108](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L108)
-
-Nearest landmark ancestor (`nav`, `footer`, `main`…), when there is one.
-
-***
-
-### detail?
-
-```ts
-optional detail?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:110](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L110)
-
-The attribute that disambiguates most — `href` for links, `name` for fields.
-
-***
-
-### tag
-
-```ts
-tag: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:112](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L112)
-
-Tag name, lower-cased.
-
-***
-
-### text
-
-```ts
-text: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:114](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L114)
-
-Text content, whitespace-collapsed and truncated.

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

@@ -1,29 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ElementOptions
-
-```ts
-type ElementOptions = object;
-```
-
-Defined in: [src/model/elements/elements.ts:16](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L16)
-
-Options accepted by every named descriptor.
-
-## Properties
-
-### exact?
-
-```ts
-optional exact?: boolean;
-```
-
-Defined in: [src/model/elements/elements.ts:27](https://github.com/jterrazz/package-test/blob/main/src/model/elements/elements.ts#L27)
-
-Match the accessible name as a whole string. `true` by default since
-16.0.
-
-A substring match is what a person does NOT mean: `link('Articles')`
-designated "Read Articles" as readily as "Articles", so a test could pass
-for years against the element beside the one it named. `{ exact: false }`
-is the opt-out, for a name that genuinely carries a variable part the
-test does not control.

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

@@ -1,128 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ElementRef
-
-```ts
-type ElementRef = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:47](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L47)
-
-A user-facing element descriptor — pure data, built by the element
-vocabulary (`button()`, `link()`, `field()`, …) and translated into
-concrete locators by the browser integration. CSS/XPath selectors are
-deliberately not expressible: user-facing elements are the only surface.
-
-A descriptor must designate exactly ONE element at action time; see
-[ElementMatch](ElementMatch.md) and CONVENTIONS W3.
-
-## Properties
-
-### disabled?
-
-```ts
-optional disabled?: boolean;
-```
-
-Defined in: [src/model/ports/browser.port.ts:71](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L71)
-
-Narrows to "and it is (not) accepting input" — built by `disabled(x)` /
-`enabled(x)`. Like `focused`, a STATE the vocabulary can already name the
-element of; unlike it, one the ARIA tree carries too (`[disabled]`), so
-this modifier is what names the ONE control a test is about, and it
-reaches the direction a behavioural substitute cannot — clicking a
-disabled control is a timeout, never an answer.
-
-***
-
-### exact?
-
-```ts
-optional exact?: boolean;
-```
-
-Defined in: [src/model/ports/browser.port.ts:56](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L56)
-
-Match the accessible name as a whole string rather than a substring.
-
-ABSENT means "the author said nothing", which the adapters read as the
-default — exact — while keeping the information that no choice was made,
-so a name that matches only as a substring can be reported once with the
-transitional warning.
-
-***
-
-### focused?
-
-```ts
-optional focused?: boolean;
-```
-
-Defined in: [src/model/ports/browser.port.ts:62](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L62)
-
-Assert about the element's FOCUS rather than its presence — built by
-`focused(element)`. The accessibility tree carries no focus state, so
-where the keyboard is cannot be goldened; it is asserted by a verb.
-
-***
-
-### kind
-
-```ts
-kind: ElementKind | LandmarkKind;
-```
-
-Defined in: [src/model/ports/browser.port.ts:72](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L72)
-
-***
-
-### name?
-
-```ts
-optional name?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:74](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L74)
-
-Landmarks may be anonymous (`main()`, `banner()`); everything else is named.
-
-***
-
-### scope?
-
-```ts
-optional scope?: ElementRef;
-```
-
-Defined in: [src/model/ports/browser.port.ts:92](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L92)
-
-Restrict the search to the elements of another descriptor — built by
-`within(scope, target)`. Chains: a scope may itself carry a scope.
-
-***
-
-### selected?
-
-```ts
-optional selected?: boolean;
-```
-
-Defined in: [src/model/ports/browser.port.ts:81](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L81)
-
-Narrows to "and it is (not) the chosen one" — built by `selected(x)`.
-An option of a COLLAPSED select is in the tree and in the document, and
-it has no box on the screen, so this facet of it is read from the node
-(`:checked`) rather than from what a visitor could point at.
-
-***
-
-### value?
-
-```ts
-optional value?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:87](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L87)
-
-The value the field must hold — built by `valued(field('Title'), '…')`.
-A field's value is a PROPERTY of the node: a controlled input's `value`
-attribute never moves, so nothing but the live value answers for it.

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

@@ -1,37 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ExecOptions
-
-```ts
-type ExecOptions = object;
-```
-
-Defined in: [src/model/ports/cli.port.ts:19](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L19)
-
-Options for the long-running form of `.exec()` (CONVENTIONS B2). When
-either option is present the process is spawned and observed: it resolves
-as soon as `waitFor` appears in stdout/stderr, and is killed when `timeout`
-elapses (exit code 124).
-
-## Properties
-
-### timeout?
-
-```ts
-optional timeout?: number;
-```
-
-Defined in: [src/model/ports/cli.port.ts:23](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L23)
-
-Kill the process after this many milliseconds. Defaults to 10 000.
-
-***
-
-### waitFor?
-
-```ts
-optional waitFor?: string;
-```
-
-Defined in: [src/model/ports/cli.port.ts:21](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L21)
-
-Resolve (exit code 0) when stdout/stderr contains this string.

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

@@ -1,54 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: FileAccessor
-
-```ts
-type FileAccessor = object;
-```
-
-Defined in: [src/model/result/result.ts:13](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L13)
-
-Read-only handle to a single file produced by a spec action.
-
-## Properties
-
-### content
-
-```ts
-readonly content: string;
-```
-
-Defined in: [src/model/result/result.ts:15](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L15)
-
-The UTF-8 text content. Throws if the file does not exist.
-
-***
-
-### exists
-
-```ts
-readonly exists: boolean;
-```
-
-Defined in: [src/model/result/result.ts:16](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L16)
-
-***
-
-### grep
-
-```ts
-grep: (pattern) => TextAccessor;
-```
-
-Defined in: [src/model/result/result.ts:18](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L18)
-
-The file text as a [TextAccessor](../interfaces/TextAccessor.md), keeping only blocks matching `pattern`.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `pattern` | `string` |
-
-#### Returns
-
-[`TextAccessor`](../interfaces/TextAccessor.md)

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

@@ -1,31 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: HonoApp
-
-```ts
-type HonoApp = object;
-```
-
-Defined in: [src/facets/api/api.specification.ts:20](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L20)
-
-Any object with a request method compatible with Hono's app.request().
-
-## Properties
-
-### request
-
-```ts
-request: (path, init?) => Promise<Response> | Response;
-```
-
-Defined in: [src/facets/api/api.specification.ts:21](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L21)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `init?` | `RequestInit` |
-
-#### Returns
-
-`Promise`\<`Response`\> \| `Response`

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

@@ -1,49 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: HttpContractFilter
-
-```ts
-type HttpContractFilter = object;
-```
-
-Defined in: [src/model/contracts/http.ts:18](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L18)
-
-Request filters for the generic HTTP provider. Every field is a subset
-constraint — a request matches when all provided fields match.
-
-## Properties
-
-### body?
-
-```ts
-optional body?: object | RegExp | string;
-```
-
-Defined in: [src/model/contracts/http.ts:24](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L24)
-
-Body constraint. An object is a deep SUBSET match (toMatchObject-style)
-whose leaf values may be `match.*` matchers; a string is a containment
-test and a RegExp a `test()` over the raw text body.
-
-***
-
-### headers?
-
-```ts
-optional headers?: Record<string, RegExp | string>;
-```
-
-Defined in: [src/model/contracts/http.ts:26](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L26)
-
-Header subset. Names are case-insensitive; string = exact value, RegExp = `test()`.
-
-***
-
-### query?
-
-```ts
-optional query?: Record<string, RegExp | string>;
-```
-
-Defined in: [src/model/contracts/http.ts:28](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L28)
-
-Query-param subset. string = exact value, RegExp = `test()`.

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

@@ -1,46 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: HttpResponseInit
-
-```ts
-type HttpResponseInit = object;
-```
-
-Defined in: [src/model/contracts/http.ts:77](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L77)
-
-Init options shared by the response builders.
-
-## Properties
-
-### delay?
-
-```ts
-optional delay?: number;
-```
-
-Defined in: [src/model/contracts/http.ts:79](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L79)
-
-Delay in ms before responding (for timeout testing).
-
-***
-
-### headers?
-
-```ts
-optional headers?: Record<string, string>;
-```
-
-Defined in: [src/model/contracts/http.ts:81](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L81)
-
-Response headers, merged over the builder's own.
-
-***
-
-### status?
-
-```ts
-optional status?: number;
-```
-
-Defined in: [src/model/contracts/http.ts:83](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L83)
-
-HTTP status code.

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

@@ -1,58 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: HttpStreamInit
-
-```ts
-type HttpStreamInit = object;
-```
-
-Defined in: [src/model/contracts/http.ts:32](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L32)
-
-Init options for a streamed reply.
-
-## Properties
-
-### contentType?
-
-```ts
-optional contentType?: string;
-```
-
-Defined in: [src/model/contracts/http.ts:34](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L34)
-
-The `content-type` the stream is served under. Default `application/octet-stream`.
-
-***
-
-### delay?
-
-```ts
-optional delay?: number;
-```
-
-Defined in: [src/model/contracts/http.ts:36](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L36)
-
-Milliseconds between two chunks. Default 0 — every chunk at once.
-
-***
-
-### headers?
-
-```ts
-optional headers?: Record<string, string>;
-```
-
-Defined in: [src/model/contracts/http.ts:38](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L38)
-
-Response headers, merged over the builder's own.
-
-***
-
-### status?
-
-```ts
-optional status?: number;
-```
-
-Defined in: [src/model/contracts/http.ts:40](https://github.com/jterrazz/package-test/blob/main/src/model/contracts/http.ts#L40)
-
-HTTP status code. Default 200.

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

@@ -1,46 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: IntegrationHandle\<Services, DatabaseKey\>
-
-```ts
-type IntegrationHandle<Services, DatabaseKey> = object;
-```
-
-Defined in: [src/facets/integration/integration.specification.ts:34](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.specification.ts#L34)
-
-The record returned by startIntegration \| specification.integration.
-Destructure with the canonical names (CONVENTIONS A3):
-
-    const { integration, cleanup } = await specification.integration(…);
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `Services` *extends* [`ServiceRecord`](ServiceRecord.md) | [`ServiceRecord`](ServiceRecord.md) |
-| `DatabaseKey` *extends* `string` | `string` |
-
-## Properties
-
-### cleanup
-
-```ts
-cleanup: () => Promise<void>;
-```
-
-Defined in: [src/facets/integration/integration.specification.ts:39](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.specification.ts#L39)
-
-Stop all infrastructure started by this specification.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### integration
-
-```ts
-integration: IntegrationSpecification<Services, DatabaseKey>;
-```
-
-Defined in: [src/facets/integration/integration.specification.ts:40](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.specification.ts#L40)

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

@@ -1,111 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: IntegrationSpecification\<Services, DatabaseKey\>
-
-```ts
-type IntegrationSpecification<Services, DatabaseKey> = object;
-```
-
-Defined in: [src/model/chain/builder.ts:237](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L237)
-
-The `integration` facet — the in-process chain handed out by
-`specification.integration()`.
-
-The subject is a MODULE, not an entry: no HTTP, no binary, no page. What
-makes it a spec rather than a module test is what it stands on — real
-services, declared contracts, a golden — so it takes the same setups as
-every other facet and ends on the one action a module has: being called.
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `Services` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
-| `DatabaseKey` *extends* `string` | `string` |
-
-## Properties
-
-### call
-
-```ts
-call: <T>(subject) => Promise<CallResult<T>>;
-```
-
-Defined in: [src/model/chain/builder.ts:256](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L256)
-
-Call the module and resolve with what it produced. The started services
-record is handed in, so the subject is constructed with the real
-connection strings rather than with a double.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `subject` | (`services`) => `Promise`\<`T`\> \| `T` |
-
-#### Returns
-
-`Promise`\<[`CallResult`](../interfaces/CallResult.md)\<`T`\>\>
-
-***
-
-### clock
-
-```ts
-clock: (iso) => IntegrationSpecification<Services, DatabaseKey>;
-```
-
-Defined in: [src/model/chain/builder.ts:242](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L242)
-
-Pin the module's `Date` at `iso` for this chain.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `iso` | `string` |
-
-#### Returns
-
-`IntegrationSpecification`\<`Services`, `DatabaseKey`\>
-
-***
-
-### intercept
-
-```ts
-intercept: InterceptMethod<IntegrationSpecification<Services, DatabaseKey>>;
-```
-
-Defined in: [src/model/chain/builder.ts:244](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L244)
-
-Declare outgoing calls — a contract, a list, a composite, or an inline request + response pair.
-
-***
-
-### seed
-
-```ts
-seed: (file, options?) => IntegrationSpecification<Services, DatabaseKey>;
-```
-
-Defined in: [src/model/chain/builder.ts:246](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L246)
-
-Queue a SQL seed file from `_seeds/` to run before the call.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `file` | `string` |
-| `options?` | \{ `database?`: `DatabaseKey`; \} |
-| `options.database?` | `DatabaseKey` |
-
-#### Returns
-
-`IntegrationSpecification`\<`Services`, `DatabaseKey`\>