@jterrazz/test 16.0.0 → 16.1.1

package/docs/reference/interfaces/TableAccessor.md

@@ -0,0 +1,26 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: TableAccessor
+
+Defined in: [src/model/result/table.ts:15](https://github.com/jterrazz/package-test/blob/main/src/model/result/table.ts#L15)
+
+Read-only accessor for a database table after a specification run.
+
+Assertions go through `expect()` (async — they query the database):
+
+    await expect(result.table('users', { database: 'db' })).toMatchRows({
+        columns: ['name'],
+        rows: [['Alice']],
+    });
+    await expect(result.table('users', { database: 'db' })).toBeEmpty();
+
+## Properties
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [src/model/result/table.ts:21](https://github.com/jterrazz/package-test/blob/main/src/model/result/table.ts#L21)
+
+The table name this accessor reads.

package/docs/reference/interfaces/TextAccessor.md

@@ -0,0 +1,96 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: TextAccessor
+
+Defined in: [src/model/result/text.ts:35](https://github.com/jterrazz/package-test/blob/main/src/model/result/text.ts#L35)
+
+Read-only accessor for a captured text handle — THE universal one: stdout,
+stderr, container logs, and file text all surface as a `TextAccessor`.
+
+Backed by a primitive string, exposed via [text](RenderedText.md#text), but also provides
+`toString()` / `valueOf()` for string coercion, so common patterns like
+`String(result.stdout)` and template-literal interpolation still work.
+
+ANSI escape sequences are stripped by default before every comparison
+(CONVENTIONS D6) — `.text` stays raw. The runner `transform` option remains
+an escape hatch for application noise not covered by the `{{token}}`
+grammar.
+
+Text operations are **closed** over the type: `.grep(pattern)` returns a
+`TextAccessor` (not a bare string), preserving the `_expected/`-resolution
+context and the `transform`, so results are chainable
+(`result.stdout.grep(a).grep(b)`) and snapshot-able
+(`expect(result.stdout.grep('users.ts')).toMatch('block.txt')`).
+
+Assertions go through `expect()` matchers: `expect(result.stdout).toContain(...)`
+and `expect(result.stdout).toMatch('name.txt')` (resolved against
+`_expected/<name>`, flat — with `{{token}}` support, CONVENTIONS D4).
+
+## Extended by
+
+- [`RenderedText`](RenderedText.md)
+
+## Properties
+
+### text
+
+```ts
+readonly text: string;
+```
+
+Defined in: [src/model/result/text.ts:43](https://github.com/jterrazz/package-test/blob/main/src/model/result/text.ts#L43)
+
+The raw captured text (never transformed, ANSI preserved).
+
+## Methods
+
+### grep()
+
+```ts
+grep(pattern): TextAccessor;
+```
+
+Defined in: [src/model/result/text.ts:76](https://github.com/jterrazz/package-test/blob/main/src/model/result/text.ts#L76)
+
+Keep only the blank-line-separated blocks of the text that contain
+`pattern` (how linter/compiler output is structured), returned as a new
+`TextAccessor` — the same subject type, so the result is chainable and
+snapshot-able. The scalpel for probing large tool outputs; snapshot the
+whole surface by default, reach for `.grep()` for targeted checks.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `pattern` | `string` |
+
+#### Returns
+
+`TextAccessor`
+
+***
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+Defined in: [src/model/result/text.ts:83](https://github.com/jterrazz/package-test/blob/main/src/model/result/text.ts#L83)
+
+#### Returns
+
+`string`
+
+***
+
+### valueOf()
+
+```ts
+valueOf(): string;
+```
+
+Defined in: [src/model/result/text.ts:87](https://github.com/jterrazz/package-test/blob/main/src/model/result/text.ts#L87)
+
+#### Returns
+
+`string`

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

@@ -0,0 +1,68 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: ApiHandle\<DatabaseKey\>
+
+```ts
+type ApiHandle<DatabaseKey> = object;
+```
+
+Defined in: [src/facets/api/api.specification.ts:52](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L52)
+
+The record returned by startApi \| specification.api. Destructure
+with the canonical names (CONVENTIONS A3):
+
+    const { api, cleanup, docker } = await specification.api(…);
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `DatabaseKey` *extends* `string` | `string` |
+
+## Properties
+
+### api
+
+```ts
+api: ApiSpecification<DatabaseKey>;
+```
+
+Defined in: [src/facets/api/api.specification.ts:53](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L53)
+
+***
+
+### cleanup
+
+```ts
+cleanup: () => Promise<void>;
+```
+
+Defined in: [src/facets/api/api.specification.ts:55](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L55)
+
+Stop all infrastructure started by this specification.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### docker
+
+```ts
+docker: (containerId) => ContainerAccessor;
+```
+
+Defined in: [src/facets/api/api.specification.ts:60](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L60)
+
+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)

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

@@ -0,0 +1,213 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: ApiSpecification\<DatabaseKey\>
+
+```ts
+type ApiSpecification<DatabaseKey> = object;
+```
+
+Defined in: [src/model/chain/builder.ts:179](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L179)
+
+The `api` facet — HTTP chain entry handed out by `specification.api()`.
+Setup methods chain; action methods are terminal: they execute the spec
+and resolve to the result.
+
+The `DatabaseKey` parameter is the typed vocabulary of `.seed()`: the keys
+of the declared services record that are databases.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `DatabaseKey` *extends* `string` | `string` |
+
+## Properties
+
+### clock
+
+```ts
+clock: (iso) => ApiSpecification<DatabaseKey>;
+```
+
+Defined in: [src/model/chain/builder.ts:181](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L181)
+
+Pin the app's `Date` at `iso` for this chain — the calendar the app reads.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `iso` | `string` |
+
+#### Returns
+
+`ApiSpecification`\<`DatabaseKey`\>
+
+***
+
+### delete
+
+```ts
+delete: (path) => Promise<HttpResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:190](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L190)
+
+Send a DELETE request and resolve with the result.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`\<[`HttpResult`](../interfaces/HttpResult.md)\>
+
+***
+
+### get
+
+```ts
+get: (path) => Promise<HttpResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:192](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L192)
+
+Send a GET request and resolve with the result.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+#### Returns
+
+`Promise`\<[`HttpResult`](../interfaces/HttpResult.md)\>
+
+***
+
+### headers
+
+```ts
+headers: (headers) => ApiSpecification<DatabaseKey>;
+```
+
+Defined in: [src/model/chain/builder.ts:183](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L183)
+
+Set HTTP headers for the request. Multiple calls merge.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `headers` | `Record`\<`string`, `string`\> |
+
+#### Returns
+
+`ApiSpecification`\<`DatabaseKey`\>
+
+***
+
+### intercept
+
+```ts
+intercept: InterceptMethod<ApiSpecification<DatabaseKey>>;
+```
+
+Defined in: [src/model/chain/builder.ts:185](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L185)
+
+Declare outgoing calls — a contract, a list, a composite, or an inline request + response pair.
+
+***
+
+### post
+
+```ts
+post: (path, body?) => Promise<HttpResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:194](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L194)
+
+Send a POST request (optional inline JSON body) and resolve with the result.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `body?` | `unknown` |
+
+#### Returns
+
+`Promise`\<[`HttpResult`](../interfaces/HttpResult.md)\>
+
+***
+
+### put
+
+```ts
+put: (path, body?) => Promise<HttpResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:196](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L196)
+
+Send a PUT request (optional inline JSON body) and resolve with the result.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `body?` | `unknown` |
+
+#### Returns
+
+`Promise`\<[`HttpResult`](../interfaces/HttpResult.md)\>
+
+***
+
+### request
+
+```ts
+request: (file) => Promise<HttpResult>;
+```
+
+Defined in: [src/model/chain/builder.ts:198](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L198)
+
+Send the complete request described by `_requests/<file>` (.http format).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `file` | `string` |
+
+#### Returns
+
+`Promise`\<[`HttpResult`](../interfaces/HttpResult.md)\>
+
+***
+
+### seed
+
+```ts
+seed: (file, options?) => ApiSpecification<DatabaseKey>;
+```
+
+Defined in: [src/model/chain/builder.ts:187](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L187)
+
+Queue a SQL seed file from `_seeds/` to run before the action.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `file` | `string` |
+| `options?` | \{ `database?`: `DatabaseKey`; \} |
+| `options.database?` | `DatabaseKey` |
+
+#### Returns
+
+`ApiSpecification`\<`DatabaseKey`\>

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

@@ -0,0 +1,68 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: ApiSpecificationOptions\<Services\>
+
+```ts
+type ApiSpecificationOptions<Services> = object;
+```
+
+Defined in: [src/facets/api/api.specification.ts:25](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L25)
+
+Options for startApi \| specification.api.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `Services` *extends* [`ServiceRecord`](ServiceRecord.md) | [`ServiceRecord`](ServiceRecord.md) |
+
+## Properties
+
+### root?
+
+```ts
+optional root?: string;
+```
+
+Defined in: [src/facets/api/api.specification.ts:31](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L31)
+
+Project root override for init scripts and artefact paths. When absent,
+the root is auto-discovered by walking up from the calling specification
+file to the first directory containing `package.json` (CONVENTIONS A9).
+
+***
+
+### server
+
+```ts
+server: (services) => HonoApp;
+```
+
+Defined in: [src/facets/api/api.specification.ts:36](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L36)
+
+The app factory — receives the started services record (fully typed)
+and returns the Hono app.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `services` | `Services` |
+
+#### Returns
+
+[`HonoApp`](HonoApp.md)
+
+***
+
+### services?
+
+```ts
+optional services?: Services;
+```
+
+Defined in: [src/facets/api/api.specification.ts:43](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.specification.ts#L43)
+
+Named infrastructure record. Keys become the `database` vocabulary of
+`.seed()` / `.table()`, and, kebab-cased, the folder each service reads
+its init script from (`{ analyticsDb: postgres() }` →
+`docker/analytics-db/init.sql`).

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

@@ -0,0 +1,30 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: BrowserConsoleMessage
+
+```ts
+type BrowserConsoleMessage = object;
+```
+
+Defined in: [src/model/ports/browser.port.ts:133](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L133)
+
+A console message emitted while the page loaded or the scenario ran.
+
+## Properties
+
+### text
+
+```ts
+text: string;
+```
+
+Defined in: [src/model/ports/browser.port.ts:134](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L134)
+
+***
+
+### type
+
+```ts
+type: string;
+```
+
+Defined in: [src/model/ports/browser.port.ts:135](https://github.com/jterrazz/package-test/blob/main/src/model/ports/browser.port.ts#L135)

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

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

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

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