@jterrazz/test 16.1.1 → 17.0.0

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

@@ -1,50 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: BrowserLinkElement
-
-```ts
-type BrowserLinkElement = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:118](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L118)
-
-A `<link>` element captured from the rendered document's head.
-
-## Properties
-
-### href
-
-```ts
-href: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:119](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L119)
-
-***
-
-### hreflang?
-
-```ts
-optional hreflang?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:120](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L120)
-
-***
-
-### rel
-
-```ts
-rel: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:121](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L121)
-
-***
-
-### type?
-
-```ts
-optional type?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:122](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L122)

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

@@ -1,40 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: BrowserMetaElement
-
-```ts
-type BrowserMetaElement = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:126](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L126)
-
-A `<meta>` element captured from the rendered document's head.
-
-## Properties
-
-### content
-
-```ts
-content: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:127](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L127)
-
-***
-
-### name?
-
-```ts
-optional name?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:128](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L128)
-
-***
-
-### property?
-
-```ts
-optional property?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:129](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L129)

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

@@ -1,87 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: BrowserOpenOptions
-
-```ts
-type BrowserOpenOptions = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:173](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L173)
-
-Per-visit options forwarded to the browser context.
-
-## Properties
-
-### allowedOrigins?
-
-```ts
-optional allowedOrigins?: string[];
-```
-
-Defined in: [src/model/ports/browser.port.ts:178](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L178)
-
-Extra origins the `external: 'block'` policy lets through — the
-declared stub backend the page legitimately fetches from.
-
-***
-
-### baseUrl
-
-```ts
-baseUrl: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:183](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L183)
-
-Base URL of the site under test — the origin `goto()` resolves against
-and the boundary of the `external` policy.
-
-***
-
-### clock?
-
-```ts
-optional clock?: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:188](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L188)
-
-Pin the page's own `Date` at this instant before the first byte is
-parsed — the calendar the site's scripts read. `.clock()` on the chain.
-
-***
-
-### external
-
-```ts
-external: "allow" | "block";
-```
-
-Defined in: [src/model/ports/browser.port.ts:194](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L194)
-
-Cross-origin request policy. `'block'` aborts every request leaving
-the site under test (analytics, CDNs) — the browser-side analog of
-strict intercepts. `'allow'` lets them through (deployed-site mode).
-
-***
-
-### headers?
-
-```ts
-optional headers?: Record<string, string>;
-```
-
-Defined in: [src/model/ports/browser.port.ts:196](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L196)
-
-Extra HTTP headers sent with every request of the visit (incl. User-Agent overrides).
-
-***
-
-### scenario?
-
-```ts
-optional scenario?: VisitScenario;
-```
-
-Defined in: [src/model/ports/browser.port.ts:198](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L198)
-
-The interaction scenario to run after load; the capture reflects the final state.

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

@@ -1,132 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: BrowserPage
-
-```ts
-type BrowserPage = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:206](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L206)
-
-The rendered page captured by a browser visit — the FINAL state when a
-scenario ran. Extraction happens in-page (the browser IS the HTML
-parser); interpretation of the raw elements belongs to the model.
-
-## Properties
-
-### consoleMessages
-
-```ts
-consoleMessages: BrowserConsoleMessage[];
-```
-
-Defined in: [src/model/ports/browser.port.ts:208](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L208)
-
-Console messages emitted while loading and interacting, in order.
-
-***
-
-### html
-
-```ts
-html: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:210](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L210)
-
-Serialized DOM after rendering (`document.documentElement.outerHTML`).
-
-***
-
-### jsonLdBlocks
-
-```ts
-jsonLdBlocks: string[];
-```
-
-Defined in: [src/model/ports/browser.port.ts:212](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L212)
-
-Raw text content of every `application/ld+json` script, in DOM order.
-
-***
-
-### links
-
-```ts
-links: BrowserLinkElement[];
-```
-
-Defined in: [src/model/ports/browser.port.ts:214](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L214)
-
-`<link>` elements of the head, in DOM order.
-
-***
-
-### metas
-
-```ts
-metas: BrowserMetaElement[];
-```
-
-Defined in: [src/model/ports/browser.port.ts:216](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L216)
-
-`<meta>` elements of the head, in DOM order.
-
-***
-
-### status
-
-```ts
-status: number;
-```
-
-Defined in: [src/model/ports/browser.port.ts:218](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L218)
-
-HTTP status of the main document response (0 when unavailable).
-
-***
-
-### text
-
-```ts
-text: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:220](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L220)
-
-Rendered `document.body.innerText`.
-
-***
-
-### title
-
-```ts
-title: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:224](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L224)
-
-`document.title` after rendering.
-
-***
-
-### tree
-
-```ts
-tree: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:222](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L222)
-
-The ARIA snapshot of the rendered `<body>` — the outline a golden pins.
-
-***
-
-### url
-
-```ts
-url: string;
-```
-
-Defined in: [src/model/ports/browser.port.ts:226](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L226)
-
-Final URL after redirects and scenario navigation.

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

@@ -1,51 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: BrowserPort
-
-```ts
-type BrowserPort = object;
-```
-
-Defined in: [src/model/ports/browser.port.ts:234](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L234)
-
-Abstract browser interface for the website specification runner.
-One implementation lives in `integrations/playwright/` — a single shared
-browser instance per runner; each `open()` gets a fresh, isolated context.
-
-## Properties
-
-### close
-
-```ts
-close: () => Promise<void>;
-```
-
-Defined in: [src/model/ports/browser.port.ts:236](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L236)
-
-Close the shared browser instance (idempotent).
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### open
-
-```ts
-open: (url, options) => Promise<BrowserPage>;
-```
-
-Defined in: [src/model/ports/browser.port.ts:238](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L238)
-
-Load `url` in a fresh context, run the scenario, capture the final page.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `url` | `string` |
-| `options` | [`BrowserOpenOptions`](BrowserOpenOptions.md) |
-
-#### Returns
-
-`Promise`\<[`BrowserPage`](BrowserPage.md)\>

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

@@ -1,11 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: CliEnv
-
-```ts
-type CliEnv = Record<string, null | string>;
-```
-
-Defined in: [src/model/ports/cli.port.ts:30](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L30)
-
-Extra environment variables to set for the child process.
-Values are merged on top of process.env. A `null` value unsets the variable.

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

@@ -1,80 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: CliHandle\<DatabaseKey\>
-
-```ts
-type CliHandle<DatabaseKey> = object;
-```
-
-Defined in: [src/facets/cli/cli.specification.ts:84](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.specification.ts#L84)
-
-The record returned by startCli \| specification.cli. Destructure
-with the canonical names (CONVENTIONS A3):
-
-    const { cli, cleanup, docker } = await specification.cli(…);
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `DatabaseKey` *extends* `string` | `string` |
-
-## Properties
-
-### cleanup
-
-```ts
-cleanup: () => Promise<void>;
-```
-
-Defined in: [src/facets/cli/cli.specification.ts:86](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.specification.ts#L86)
-
-Stop all infrastructure started by this specification.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### cli
-
-```ts
-cli: CliSpecification<DatabaseKey>;
-```
-
-Defined in: [src/facets/cli/cli.specification.ts:87](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.specification.ts#L87)
-
-***
-
-### docker
-
-```ts
-docker: (containerId) => ContainerAccessor;
-```
-
-Defined in: [src/facets/cli/cli.specification.ts:92](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.specification.ts#L92)
-
-Read a running container by id — returns a [ContainerAccessor](../interfaces/ContainerAccessor.md)
-usable with `await expect(...).toBeRunning()` and read accessors.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `containerId` | `string` |
-
-#### Returns
-
-[`ContainerAccessor`](../interfaces/ContainerAccessor.md)
-
-***
-
-### orchestrator
-
-```ts
-orchestrator: null | Orchestrator;
-```
-
-Defined in: [src/facets/cli/cli.specification.ts:94](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.specification.ts#L94)
-
-The orchestrator managing the test infrastructure lifecycle.

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

@@ -1,36 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: CliInput
-
-```ts
-type CliInput = object;
-```
-
-Defined in: [src/model/ports/cli.port.ts:41](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L41)
-
-What one invocation is handed beyond its arguments — the two per-run inputs a
-spec document may state. Both are absent by default: the child gets an
-immediately-closed stdin (never a TTY) and the adapter's own timeout.
-
-## Properties
-
-### stdin?
-
-```ts
-optional stdin?: string;
-```
-
-Defined in: [src/model/ports/cli.port.ts:43](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L43)
-
-Written to the child's stdin, which is then closed.
-
-***
-
-### timeout?
-
-```ts
-optional timeout?: number;
-```
-
-Defined in: [src/model/ports/cli.port.ts:45](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L45)
-
-Milliseconds after which the run is killed (exit code 124).

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

@@ -1,46 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: CliOutput
-
-```ts
-type CliOutput = object;
-```
-
-Defined in: [src/model/ports/cli.port.ts:4](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L4)
-
-Raw output from a command execution, including exit code and captured output streams.
-
-## Properties
-
-### exitCode
-
-```ts
-exitCode: number;
-```
-
-Defined in: [src/model/ports/cli.port.ts:6](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L6)
-
-Process exit code (0 = success).
-
-***
-
-### stderr
-
-```ts
-stderr: string;
-```
-
-Defined in: [src/model/ports/cli.port.ts:10](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L10)
-
-Captured standard error.
-
-***
-
-### stdout
-
-```ts
-stdout: string;
-```
-
-Defined in: [src/model/ports/cli.port.ts:8](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L8)
-
-Captured standard output.

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

@@ -1,58 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: CliPort
-
-```ts
-type CliPort = object;
-```
-
-Defined in: [src/model/ports/cli.port.ts:48](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L48)
-
-## Properties
-
-### exec
-
-```ts
-exec: (args, cwd, env?, input?) => Promise<CliOutput>;
-```
-
-Defined in: [src/model/ports/cli.port.ts:50](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L50)
-
-Execute a command with the given arguments in the given working directory.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `args` | `string` |
-| `cwd` | `string` |
-| `env?` | [`CliEnv`](CliEnv.md) |
-| `input?` | [`CliInput`](CliInput.md) |
-
-#### Returns
-
-`Promise`\<[`CliOutput`](CliOutput.md)\>
-
-***
-
-### watch
-
-```ts
-watch: (args, cwd, options, env?) => Promise<CliOutput>;
-```
-
-Defined in: [src/model/ports/cli.port.ts:53](https://github.com/jterrazz/package-test/blob/main/src/model/ports/cli.port.ts#L53)
-
-Run a long-running process and wait for a pattern or timeout.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `args` | `string` |
-| `cwd` | `string` |
-| `options` | [`ExecOptions`](ExecOptions.md) |
-| `env?` | [`CliEnv`](CliEnv.md) |
-
-#### Returns
-
-`Promise`\<[`CliOutput`](CliOutput.md)\>