@jterrazz/test 16.0.0 → 16.1.0

package/docs/reference/interfaces/PageResult.md

@@ -0,0 +1,356 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: PageResult
+
+Defined in: [src/facets/website/website.result.ts:77](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L77)
+
+Result from a rendered `.visit()` action — the page as a browser saw it.
+
+## Extends
+
+- [`BaseResult`](BaseResult.md)
+
+## Accessors
+
+### alternates
+
+#### Get Signature
+
+```ts
+get alternates(): Record<string, string>;
+```
+
+Defined in: [src/facets/website/website.result.ts:86](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L86)
+
+Hreflang alternates declared in the head, keyed by language code.
+
+##### Returns
+
+`Record`\<`string`, `string`\>
+
+***
+
+### canonical
+
+#### Get Signature
+
+```ts
+get canonical(): string | null;
+```
+
+Defined in: [src/facets/website/website.result.ts:97](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L97)
+
+The canonical URL declared in the head, or null.
+
+##### Returns
+
+`string` \| `null`
+
+***
+
+### console
+
+#### Get Signature
+
+```ts
+get console(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:106](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L106)
+
+The browser console as a stream — one message per line, prefixed by
+its type — same shape as `stdout` on a cli result. Assert emptiness
+with `toBeEmpty()`, or snapshot with `toMatch('home.console.txt')`.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### content
+
+#### Get Signature
+
+```ts
+get content(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:183](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L183)
+
+Rendered body text as a text accessor.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### errors
+
+#### Get Signature
+
+```ts
+get errors(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:119](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L119)
+
+Console messages of type `error` only — the stream you usually want
+empty: `expect(result.errors).toBeEmpty()`. Same shape as `stderr` on
+a cli result.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### head
+
+#### Get Signature
+
+```ts
+get head(): JsonAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:135](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L135)
+
+The document-head projection as a JSON accessor — title, canonical,
+hreflang alternates, and named metas — for one golden per page:
+`expect(result.head).toMatch('home.head.json')`.
+
+##### Returns
+
+[`JsonAccessor`](JsonAccessor.md)
+
+***
+
+### html
+
+#### Get Signature
+
+```ts
+get html(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:151](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L151)
+
+The rendered DOM serialization as a text accessor.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### jsonLd
+
+#### Get Signature
+
+```ts
+get jsonLd(): JsonAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:162](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L162)
+
+Every `application/ld+json` block of the page, parsed, as one JSON
+array — `expect(result.jsonLd).toMatch('article.jsonld.json')`.
+
+##### Returns
+
+[`JsonAccessor`](JsonAccessor.md)
+
+***
+
+### links
+
+#### Get Signature
+
+```ts
+get links(): BrowserLinkElement[];
+```
+
+Defined in: [src/facets/website/website.result.ts:168](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L168)
+
+`<link>` elements of the head, in DOM order.
+
+##### Returns
+
+[`BrowserLinkElement`](../type-aliases/BrowserLinkElement.md)[]
+
+***
+
+### status
+
+#### Get Signature
+
+```ts
+get status(): number;
+```
+
+Defined in: [src/facets/website/website.result.ts:178](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L178)
+
+HTTP status of the main document response.
+
+##### Returns
+
+`number`
+
+***
+
+### title
+
+#### Get Signature
+
+```ts
+get title(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:203](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L203)
+
+The document title as a text accessor.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### tree
+
+#### Get Signature
+
+```ts
+get tree(): TextAccessor;
+```
+
+Defined in: [src/facets/website/website.result.ts:196](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L196)
+
+The ARIA snapshot of the rendered `<body>` — the page's outline, as the
+accessibility tree draws it, and the one golden a rendered surface pins.
+Deterministic where a screenshot is not, and the SAME dialect a component
+spec asserts, so a page and the components inside it read alike.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### url
+
+#### Get Signature
+
+```ts
+get url(): string;
+```
+
+Defined in: [src/facets/website/website.result.ts:210](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L210)
+
+Final URL after redirects.
+
+##### Returns
+
+`string`
+
+## 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)
+
+***
+
+### meta()
+
+```ts
+meta(name): string | undefined;
+```
+
+Defined in: [src/facets/website/website.result.ts:173](https://github.com/jterrazz/package-test/blob/main/src/facets/website/website.result.ts#L173)
+
+The content of a named meta — `meta('description')`, `meta('og:image')`.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+
+#### Returns
+
+`string` \| `undefined`
+
+***
+
+### 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/RenderResult.md

@@ -0,0 +1,72 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: RenderResult
+
+Defined in: [src/facets/component/component.result.ts:12](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L12)
+
+What a render resolves to — the component as the page saw it, after the
+scenario ran.
+
+Five accessors and no more: the ARIA outline a golden pins, the two
+renderings a probe reads, and the two streams a spec wants silent. Nothing
+here reaches back into React — a spec that needs the component's internals
+is asserting the implementation, not the surface a user meets.
+
+## Properties
+
+### console
+
+```ts
+readonly console: RenderedText;
+```
+
+Defined in: [src/facets/component/component.result.ts:14](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L14)
+
+The browser console as a stream — one `[type] text` line per message.
+
+***
+
+### content
+
+```ts
+readonly content: RenderedText;
+```
+
+Defined in: [src/facets/component/component.result.ts:16](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L16)
+
+Rendered text of the whole document body (`innerText`).
+
+***
+
+### errors
+
+```ts
+readonly errors: RenderedText;
+```
+
+Defined in: [src/facets/component/component.result.ts:18](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L18)
+
+Console messages of type `error` only, plus any uncaught page error.
+
+***
+
+### html
+
+```ts
+readonly html: RenderedText;
+```
+
+Defined in: [src/facets/component/component.result.ts:20](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L20)
+
+The mounted markup, serialised — the escape hatch for a class or an attribute.
+
+***
+
+### tree
+
+```ts
+readonly tree: RenderedText;
+```
+
+Defined in: [src/facets/component/component.result.ts:22](https://github.com/jterrazz/package-test/blob/main/src/facets/component/component.result.ts#L22)
+
+The ARIA snapshot of the rendered body — the outline a golden pins.

package/docs/reference/interfaces/RenderedText.md

@@ -0,0 +1,110 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: RenderedText
+
+Defined in: [src/facets/component/rendered-text.ts:12](https://github.com/jterrazz/package-test/blob/main/src/facets/component/rendered-text.ts#L12)
+
+A stream captured INSIDE the page.
+
+Structurally identical to any other [TextAccessor](TextAccessor.md) — the same
+`{{token}}` grammar, the same ANSI stripping, the same `.grep()` — and
+marked so the matcher augmentation can say the one thing that differs: its
+golden lives on the server, so `toMatch` is awaited here where it is
+synchronous everywhere else.
+
+## Extends
+
+- [`TextAccessor`](TextAccessor.md)
+
+## Properties
+
+### capturedInPage
+
+```ts
+readonly capturedInPage: true;
+```
+
+Defined in: [src/facets/component/rendered-text.ts:14](https://github.com/jterrazz/package-test/blob/main/src/facets/component/rendered-text.ts#L14)
+
+The marker the `toMatch` overload reads. Never asserted on directly.
+
+***
+
+### 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).
+
+#### Inherited from
+
+[`TextAccessor`](TextAccessor.md).[`text`](TextAccessor.md#text)
+
+## 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`](TextAccessor.md)
+
+#### Inherited from
+
+[`TextAccessor`](TextAccessor.md).[`grep`](TextAccessor.md#grep)
+
+***
+
+### 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`
+
+#### Inherited from
+
+[`TextAccessor`](TextAccessor.md).[`toString`](TextAccessor.md#tostring)
+
+***
+
+### 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`
+
+#### Inherited from
+
+[`TextAccessor`](TextAccessor.md).[`valueOf`](TextAccessor.md#valueof)

package/docs/reference/interfaces/ResponseAccessor.md

@@ -0,0 +1,47 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: ResponseAccessor
+
+Defined in: [src/model/result/response.ts:12](https://github.com/jterrazz/package-test/blob/main/src/model/result/response.ts#L12)
+
+Read-only accessor for an HTTP response.
+
+Assertions go through `expect()`:
+`expect(result.response).toMatch('created.http')` compares status,
+a subset of headers, and the JSON body against `_expected/<name>` —
+with `{{placeholder}}` support in all three.
+
+## Properties
+
+### body
+
+```ts
+readonly body: unknown;
+```
+
+Defined in: [src/model/result/response.ts:14](https://github.com/jterrazz/package-test/blob/main/src/model/result/response.ts#L14)
+
+The parsed JSON response body (null when parsing failed).
+
+***
+
+### headers
+
+```ts
+readonly headers: Record<string, string>;
+```
+
+Defined in: [src/model/result/response.ts:18](https://github.com/jterrazz/package-test/blob/main/src/model/result/response.ts#L18)
+
+Response headers as a flat, lower-cased key-value map.
+
+***
+
+### status
+
+```ts
+readonly status: number;
+```
+
+Defined in: [src/model/result/response.ts:20](https://github.com/jterrazz/package-test/blob/main/src/model/result/response.ts#L20)
+
+The HTTP response status code.

package/docs/reference/interfaces/ScreenResult.md

@@ -0,0 +1,128 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Interface: ScreenResult
+
+Defined in: [src/facets/mobile/mobile.result.ts:8](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.result.ts#L8)
+
+Result from a `.open()` action — the screen as the device saw it, final state.
+
+## Extends
+
+- [`BaseResult`](BaseResult.md)
+
+## Accessors
+
+### content
+
+#### Get Signature
+
+```ts
+get content(): TextAccessor;
+```
+
+Defined in: [src/facets/mobile/mobile.result.ts:20](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.result.ts#L20)
+
+The visible screen texts as one stream, in reading order — the scalpel
+for a targeted probe: `expect(result.content).toContain('Bookmarked')`.
+
+##### Returns
+
+[`TextAccessor`](TextAccessor.md)
+
+***
+
+### screen
+
+#### Get Signature
+
+```ts
+get screen(): JsonAccessor;
+```
+
+Defined in: [src/facets/mobile/mobile.result.ts:30](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.result.ts#L30)
+
+The projected accessibility tree as a JSON accessor — the one golden
+per screen: `expect(result.screen).toMatch('events.screen.json')`.
+
+##### Returns
+
+[`JsonAccessor`](JsonAccessor.md)
+
+## 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)