@jterrazz/test 16.0.0 → 16.1.0

package/docs/reference/interfaces/FetchResult.md

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

@@ -0,0 +1,46 @@
+<!-- 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`[]\>

package/docs/reference/interfaces/HttpResult.md

@@ -0,0 +1,126 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: HttpResult
+
+Defined in: [src/facets/api/api.result.ts:7](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.result.ts#L7)
+
+Result from an HTTP action (.request(), .get(), .post(), .put(), .delete()).
+
+## Extends
+
+- [`BaseResult`](BaseResult.md)
+
+## Accessors
+
+### response
+
+#### Get Signature
+
+```ts
+get response(): ResponseAccessor;
+```
+
+Defined in: [src/facets/api/api.result.ts:20](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.result.ts#L20)
+
+Access the HTTP response (status, headers, body) for assertions.
+
+##### Returns
+
+[`ResponseAccessor`](ResponseAccessor.md)
+
+***
+
+### status
+
+#### Get Signature
+
+```ts
+get status(): number;
+```
+
+Defined in: [src/facets/api/api.result.ts:25](https://github.com/jterrazz/package-test/blob/main/src/facets/api/api.result.ts#L25)
+
+The HTTP response status code.
+
+##### 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/JsonAccessor.md

@@ -0,0 +1,46 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: JsonAccessor\<Value\>
+
+Defined in: [src/model/result/json.ts:19](https://github.com/jterrazz/package-test/blob/main/src/model/result/json.ts#L19)
+
+Read-only accessor for a JSON payload parsed from a text stream (stdout).
+
+Lazily parses the JSON on first use; parse errors are deferred until the
+value is read so that callers can still read the raw stream text without
+triggering a throw.
+
+ANSI escape sequences are stripped by default before `JSON.parse`
+(CONVENTIONS D6). When a `transform` is configured on the spec runner, it
+runs on the stripped text — an escape hatch for application noise not
+covered by the `{{token}}` grammar.
+
+Assertions go through `expect()`: `expect(result.json).toMatch('name.json')`
+(deep-equal against `_expected/<name>`, with `{{placeholder}}` support).
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `Value` | `unknown` |
+
+## Accessors
+
+### value
+
+#### Get Signature
+
+```ts
+get value(): Value;
+```
+
+Defined in: [src/model/result/json.ts:48](https://github.com/jterrazz/package-test/blob/main/src/model/result/json.ts#L48)
+
+The parsed JSON value. Throws if the text is not valid JSON.
+
+`Value` is `unknown` unless the subject that produced this accessor
+knows better — `.call<T>()` does, and hands its T straight through so a
+one-field reading needs no cast in the test.
+
+##### Returns
+
+`Value`