@jterrazz/test 16.1.1 → 18.0.0

package/docs/reference/interfaces/CliResult.md

@@ -1,253 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: CliResult
-
-Defined in: [src/facets/cli/cli.result.ts:33](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L33)
-
-Result from a command action (`.exec()`).
-
-When the runner was configured with a `docker` option, the result also
-exposes container accessors and participates in `Symbol.asyncDispose`
-cleanup. The Docker shell-outs are **lazy**: a test that never calls
-`.container(...)` never queries the Docker daemon, so command-only tests
-pay zero Docker cost even when the runner is Docker-aware.
-
-Dispose always runs one final label-filtered `docker ps` to catch
-containers that were spawned during `.exec` but never asserted on —
-tests still get leak-free cleanup even if they forget to reach into
-a container.
-
-## Extends
-
-- [`BaseResult`](BaseResult.md)
-
-## Accessors
-
-### containerIds
-
-#### Get Signature
-
-```ts
-get containerIds(): string[];
-```
-
-Defined in: [src/facets/cli/cli.result.ts:117](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L117)
-
-All captured container IDs. Triggers the same lazy query as `container()`.
-
-##### Returns
-
-`string`[]
-
-***
-
-### exitCode
-
-#### Get Signature
-
-```ts
-get exitCode(): number;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:57](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L57)
-
-The process exit code.
-
-##### Returns
-
-`number`
-
-***
-
-### filesystem
-
-#### Get Signature
-
-```ts
-get filesystem(): FilesystemAccessor;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:88](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L88)
-
-Accessor for the temporary working directory the command ran in.
-
-##### Returns
-
-[`FilesystemAccessor`](FilesystemAccessor.md)
-
-***
-
-### json
-
-#### Get Signature
-
-```ts
-get json(): JsonAccessor;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:78](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L78)
-
-Accessor for parsing stdout as JSON and asserting against JSON fixtures.
-
-##### Returns
-
-[`JsonAccessor`](JsonAccessor.md)
-
-***
-
-### stderr
-
-#### Get Signature
-
-```ts
-get stderr(): TextAccessor;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:70](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L70)
-
-Accessor for the captured standard error with file-based assertions.
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-***
-
-### stdout
-
-#### Get Signature
-
-```ts
-get stdout(): TextAccessor;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:62](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L62)
-
-Accessor for the captured standard output with file-based assertions.
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-## Methods
-
-### \[asyncDispose\]()
-
-```ts
-asyncDispose: Promise<void>;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:123](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L123)
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### container()
-
-```ts
-container(name): ContainerAccessor;
-```
-
-Defined in: [src/facets/cli/cli.result.ts:106](https://github.com/jterrazz/package-test/blob/main/src/facets/cli/cli.result.ts#L106)
-
-Look up a container the command spawned during this run by the value of
-its name-label (as declared in the `docker.nameLabel` of the
-`specification.cli()` options).
-First access triggers a one-shot `docker ps` + `docker inspect`
-query and caches the result for the rest of the result's lifetime.
-Tests that don't call this never touch Docker.
-
-Returns an accessor with `.exists === false` when no container
-carries that name — callers can still assert absence without a try.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-
-#### Returns
-
-[`ContainerAccessor`](ContainerAccessor.md)
-
-***
-
-### directory()
-
-```ts
-directory(path?): DirectoryAccessor;
-```
-
-Defined in: [src/model/result/result.ts:55](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L55)
-
-Access a directory (relative to the working directory) for snapshot assertions.
-
-#### Parameters
-
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `path` | `string` | `'.'` |
-
-#### Returns
-
-[`DirectoryAccessor`](DirectoryAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`directory`](BaseResult.md#directory)
-
-***
-
-### file()
-
-```ts
-file(path): FileAccessor;
-```
-
-Defined in: [src/model/result/result.ts:61](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L61)
-
-Access a single file (relative to the working directory) for content assertions.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-
-#### Returns
-
-[`FileAccessor`](../type-aliases/FileAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`file`](BaseResult.md#file)
-
-***
-
-### table()
-
-```ts
-table(tableName, options?): TableAccessor;
-```
-
-Defined in: [src/model/result/result.ts:86](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L86)
-
-Access a database table for row-level assertions via expect() matchers.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `tableName` | `string` |
-| `options?` | \{ `database?`: `string`; \} |
-| `options.database?` | `string` |
-
-#### Returns
-
-[`TableAccessor`](TableAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`table`](BaseResult.md#table)

package/docs/reference/interfaces/ContainerAccessor.md

@@ -1,166 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: ContainerAccessor
-
-Defined in: [src/seams/docker/container-accessor.ts:32](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L32)
-
-Assertion accessor for a single Docker container captured by the docker()
-spec mode. Mirrors the shape of [CliResult](CliResult.md) so tests use the same
-vocabulary (`stdout.toContain`, `file(...).content`, etc.) regardless
-of where output came from.
-
-Sync state (`exists`, `running`, `status`) is derived from the `docker
-inspect` payload captured at result-construction time. Logs are fetched
-lazily on first access to `stdout`/`stderr`.
-
-## Properties
-
-### exists
-
-```ts
-readonly exists: boolean;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:35](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L35)
-
-***
-
-### running
-
-```ts
-readonly running: boolean;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:37](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L37)
-
-***
-
-### status
-
-```ts
-readonly status: string;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:38](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L38)
-
-## Accessors
-
-### id
-
-#### Get Signature
-
-```ts
-get id(): string | null;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:48](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L48)
-
-Underlying Docker container ID, or `null` if no container was captured
-for this name. Useful when a follow-up CLI command needs to reference
-the container by id (e.g. `spwn world inspect <id>`). Prefer the other
-accessors for common reads — pulling the raw id is the escape hatch.
-
-##### Returns
-
-`string` \| `null`
-
-***
-
-### inspect
-
-#### Get Signature
-
-```ts
-get inspect(): JsonAccessor;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:77](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L77)
-
-Raw `docker inspect` object for this container. Throws if the container
-was not captured (i.e. `.exists === false`).
-
-##### Returns
-
-[`JsonAccessor`](JsonAccessor.md)
-
-***
-
-### stderr
-
-#### Get Signature
-
-```ts
-get stderr(): TextAccessor;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:91](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L91)
-
-Captured logs (stdout+stderr combined for v1).
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-***
-
-### stdout
-
-#### Get Signature
-
-```ts
-get stdout(): TextAccessor;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:83](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L83)
-
-Captured logs (stdout+stderr combined for v1).
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-## Methods
-
-### exec()
-
-```ts
-exec(cmd): Promise<CliResult>;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:132](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L132)
-
-Run a shell command inside the container and get back the same
-[CliResult](CliResult.md) used for host-side executions.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `cmd` | `string` |
-
-#### Returns
-
-`Promise`\<[`CliResult`](CliResult.md)\>
-
-***
-
-### file()
-
-```ts
-file(path): FileAccessor;
-```
-
-Defined in: [src/seams/docker/container-accessor.ts:103](https://github.com/jterrazz/package-test/blob/main/src/seams/docker/container-accessor.ts#L103)
-
-Read a file from inside the container via `docker exec cat`. The
-returned object satisfies the same [FileAccessor](../type-aliases/FileAccessor.md) shape used by
-the host filesystem accessor, so tests do not need to learn a new API.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-
-#### Returns
-
-[`FileAccessor`](../type-aliases/FileAccessor.md)

package/docs/reference/interfaces/DirectoryAccessor.md

@@ -1,33 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: DirectoryAccessor
-
-Defined in: [src/model/result/directory.ts:97](https://github.com/jterrazz/package-test/blob/main/src/model/result/directory.ts#L97)
-
-Read-only accessor for a directory produced by a spec action.
-
-Assertions go through `expect()` (async — they walk the disk):
-`await expect(result.directory('out')).toMatch('scaffold/out')`
-compares the tree against the fixture directory `_expected/<name>/`.
-
-## Methods
-
-### files()
-
-```ts
-files(options?): Promise<string[]>;
-```
-
-Defined in: [src/model/result/directory.ts:112](https://github.com/jterrazz/package-test/blob/main/src/model/result/directory.ts#L112)
-
-List all files (recursively) under the directory, sorted.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | \{ `ignore?`: `string`[]; \} |
-| `options.ignore?` | `string`[] |
-
-#### Returns
-
-`Promise`\<`string`[]\>

package/docs/reference/interfaces/FetchResult.md

@@ -1,180 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: FetchResult
-
-Defined in: [src/facets/website/website.result.ts:19](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L19)
-
-Result from a raw `.fetch()` action (robots.txt, sitemaps, redirects).
-
-## Extends
-
-- [`BaseResult`](BaseResult.md)
-
-## Accessors
-
-### body
-
-#### Get Signature
-
-```ts
-get body(): TextAccessor;
-```
-
-Defined in: [src/facets/website/website.result.ts:32](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L32)
-
-The response body as a text accessor (`toMatch('robots.txt')`, `.grep()`).
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-***
-
-### headers
-
-#### Get Signature
-
-```ts
-get headers(): Record<string, string>;
-```
-
-Defined in: [src/facets/website/website.result.ts:40](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L40)
-
-Response headers as a flat, lower-cased key-value map.
-
-##### Returns
-
-`Record`\<`string`, `string`\>
-
-***
-
-### json
-
-#### Get Signature
-
-```ts
-get json(): JsonAccessor;
-```
-
-Defined in: [src/facets/website/website.result.ts:45](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L45)
-
-The response body parsed as JSON.
-
-##### Returns
-
-[`JsonAccessor`](JsonAccessor.md)
-
-***
-
-### location
-
-#### Get Signature
-
-```ts
-get location(): string | undefined;
-```
-
-Defined in: [src/facets/website/website.result.ts:55](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L55)
-
-The `location` header of a redirect response, or undefined.
-
-##### Returns
-
-`string` \| `undefined`
-
-***
-
-### status
-
-#### Get Signature
-
-```ts
-get status(): number;
-```
-
-Defined in: [src/facets/website/website.result.ts:60](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L60)
-
-The HTTP response status code — redirects surface as 3xx, never followed.
-
-##### Returns
-
-`number`
-
-## Methods
-
-### directory()
-
-```ts
-directory(path?): DirectoryAccessor;
-```
-
-Defined in: [src/model/result/result.ts:55](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L55)
-
-Access a directory (relative to the working directory) for snapshot assertions.
-
-#### Parameters
-
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `path` | `string` | `'.'` |
-
-#### Returns
-
-[`DirectoryAccessor`](DirectoryAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`directory`](BaseResult.md#directory)
-
-***
-
-### file()
-
-```ts
-file(path): FileAccessor;
-```
-
-Defined in: [src/model/result/result.ts:61](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L61)
-
-Access a single file (relative to the working directory) for content assertions.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-
-#### Returns
-
-[`FileAccessor`](../type-aliases/FileAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`file`](BaseResult.md#file)
-
-***
-
-### table()
-
-```ts
-table(tableName, options?): TableAccessor;
-```
-
-Defined in: [src/model/result/result.ts:86](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L86)
-
-Access a database table for row-level assertions via expect() matchers.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `tableName` | `string` |
-| `options?` | \{ `database?`: `string`; \} |
-| `options.database?` | `string` |
-
-#### Returns
-
-[`TableAccessor`](TableAccessor.md)
-
-#### Inherited from
-
-[`BaseResult`](BaseResult.md).[`table`](BaseResult.md#table)

package/docs/reference/interfaces/FilesystemAccessor.md

@@ -1,46 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: FilesystemAccessor
-
-Defined in: [src/model/result/filesystem.ts:12](https://github.com/jterrazz/package-test/blob/main/src/model/result/filesystem.ts#L12)
-
-Read-only accessor for the whole temporary working directory used by a
-command spec.
-
-Assertions go through `expect()` (async — they walk the disk):
-`await expect(result.filesystem).toMatch('scaffolded')` compares the
-tree against the fixture directory `_expected/<name>/`.
-
-## Properties
-
-### cwd
-
-```ts
-readonly cwd: string;
-```
-
-Defined in: [src/model/result/filesystem.ts:16](https://github.com/jterrazz/package-test/blob/main/src/model/result/filesystem.ts#L16)
-
-The absolute path of the temporary working directory.
-
-## Methods
-
-### files()
-
-```ts
-files(options?): Promise<string[]>;
-```
-
-Defined in: [src/model/result/filesystem.ts:27](https://github.com/jterrazz/package-test/blob/main/src/model/result/filesystem.ts#L27)
-
-List all files (recursively) under the working directory, sorted.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `options` | \{ `ignore?`: `string`[]; \} |
-| `options.ignore?` | `string`[] |
-
-#### Returns
-
-`Promise`\<`string`[]\>