@jterrazz/test 16.1.0 → 17.0.0

package/docs/reference/index.md

@@ -1,196 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# @jterrazz/test
-
-## Classes
-
-| Class | Description |
-| ------ | ------ |
-| [Matcher](classes/Matcher.md) | A dynamic-value matcher. Created via the [match](variables/match.md) factories — never constructed directly by user code. |
-| [ProcessHandle](classes/ProcessHandle.md) | An external process, declared like any other service. |
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [BaseResult](interfaces/BaseResult.md) | Base result - common accessors available after any action type. Extended by HttpResult, CliResult, and used directly by job results. |
-| [CallResult](interfaces/CallResult.md) | The result of an in-process call — the integration facet's whole surface. |
-| [CaptureScope](interfaces/CaptureScope.md) | Named captures recorded by `match.ref()` / `{{type#ref}}` placeholders. One scope lives on each spec result — every assertion chained off the same result shares it, and a new chain starts fresh. |
-| [CliResult](interfaces/CliResult.md) | Result from a command action (`.exec()`). |
-| [ContainerAccessor](interfaces/ContainerAccessor.md) | Assertion accessor for a single Docker container captured by the docker() spec mode. Mirrors the shape of [CliResult](interfaces/CliResult.md) so tests use the same vocabulary (`stdout.toContain`, `file(...).content`, etc.) regardless of where output came from. |
-| [DirectoryAccessor](interfaces/DirectoryAccessor.md) | Read-only accessor for a directory produced by a spec action. |
-| [FetchResult](interfaces/FetchResult.md) | Result from a raw `.fetch()` action (robots.txt, sitemaps, redirects). |
-| [FilesystemAccessor](interfaces/FilesystemAccessor.md) | Read-only accessor for the whole temporary working directory used by a command spec. |
-| [HttpResult](interfaces/HttpResult.md) | Result from an HTTP action (.request(), .get(), .post(), .put(), .delete()). |
-| [JsonAccessor](interfaces/JsonAccessor.md) | Read-only accessor for a JSON payload parsed from a text stream (stdout). |
-| [PageResult](interfaces/PageResult.md) | Result from a rendered `.visit()` action — the page as a browser saw it. |
-| [RenderedText](interfaces/RenderedText.md) | A stream captured INSIDE the page. |
-| [RenderResult](interfaces/RenderResult.md) | What a render resolves to — the component as the page saw it, after the scenario ran. |
-| [ResponseAccessor](interfaces/ResponseAccessor.md) | Read-only accessor for an HTTP response. |
-| [ScreenResult](interfaces/ScreenResult.md) | Result from a `.open()` action — the screen as the device saw it, final state. |
-| [TableAccessor](interfaces/TableAccessor.md) | Read-only accessor for a database table after a specification run. |
-| [TextAccessor](interfaces/TextAccessor.md) | Read-only accessor for a captured text handle — THE universal one: stdout, stderr, container logs, and file text all surface as a `TextAccessor`. |
-
-## Type Aliases
-
-| Type Alias | Description |
-| ------ | ------ |
-| [ApiHandle](type-aliases/ApiHandle.md) | The record returned by startApi \| specification.api. Destructure with the canonical names (CONVENTIONS A3): |
-| [ApiSpecification](type-aliases/ApiSpecification.md) | 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. |
-| [ApiSpecificationOptions](type-aliases/ApiSpecificationOptions.md) | Options for startApi \| specification.api. |
-| [BrowserConsoleMessage](type-aliases/BrowserConsoleMessage.md) | A console message emitted while the page loaded or the scenario ran. |
-| [BrowserLinkElement](type-aliases/BrowserLinkElement.md) | A `<link>` element captured from the rendered document's head. |
-| [BrowserMetaElement](type-aliases/BrowserMetaElement.md) | A `<meta>` element captured from the rendered document's head. |
-| [BrowserOpenOptions](type-aliases/BrowserOpenOptions.md) | Per-visit options forwarded to the browser context. |
-| [BrowserPage](type-aliases/BrowserPage.md) | 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. |
-| [BrowserPort](type-aliases/BrowserPort.md) | 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. |
-| [CliEnv](type-aliases/CliEnv.md) | Extra environment variables to set for the child process. Values are merged on top of process.env. A `null` value unsets the variable. |
-| [CliHandle](type-aliases/CliHandle.md) | The record returned by startCli \| specification.cli. Destructure with the canonical names (CONVENTIONS A3): |
-| [CliInput](type-aliases/CliInput.md) | 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. |
-| [CliOutput](type-aliases/CliOutput.md) | Raw output from a command execution, including exit code and captured output streams. |
-| [CliPort](type-aliases/CliPort.md) | - |
-| [CliSpecification](type-aliases/CliSpecification.md) | The `cli` facet — command chain entry handed out by `specification.cli()`. Setup methods chain; `.exec()` is the single terminal action (CONVENTIONS B2) — `{ waitFor?, timeout? }` covers long-running processes. |
-| [CliSpecificationOptions](type-aliases/CliSpecificationOptions.md) | Options for startCli \| specification.cli. |
-| [ComponentChain](type-aliases/ComponentChain.md) | The chain. Every setup returns a new one, so the handle a spec imports never carries the previous test's contracts, wrapper or clock. |
-| [ComponentScenario](type-aliases/ComponentScenario.md) | The behaviour of a render; assertions stay in the Then, on the result (W1). |
-| [ComponentUi](type-aliases/ComponentUi.md) | Represents all of the things React can render. |
-| [ComponentVisitor](type-aliases/ComponentVisitor.md) | The interaction vocabulary a render scenario is handed — the When. |
-| [ContainerPort](type-aliases/ContainerPort.md) | Abstract container interface. Represents a running service (database, cache, etc.) |
-| [Contract](type-aliases/Contract.md) | A declared external interaction: what to match (`request`) and what to reply (`response`), together in one named artifact. Contracts live in TypeScript files under `contracts/` next to the tests that use them, so the business payload (prompts, JSON responses) is visible at a glance while the real HTTP call stays mocked underneath. |
-| [ContractInput](type-aliases/ContractInput.md) | Any accepted contract input: one, a list, or a composite. |
-| [ContractRequest](type-aliases/ContractRequest.md) | The request half of a contract: which outgoing call it speaks for. |
-| [ContractResponder](type-aliases/ContractResponder.md) | A dynamic response: computed from the observed request at the moment the contract is served, rather than fixed ahead of time. Handed the same [MatchableRequest](type-aliases/MatchableRequest.md) the request half matched on, so the reply can echo or derive from the body/headers/url. |
-| [ContractResponse](type-aliases/ContractResponse.md) | The response half of a contract: what to reply when the request matches. |
-| [ContractResponseValue](type-aliases/ContractResponseValue.md) | What a contract replies with: either a fixed [ContractResponse](type-aliases/ContractResponse.md) or a [ContractResponder](type-aliases/ContractResponder.md) evaluated per served request. |
-| [Contracts](type-aliases/Contracts.md) | A composite of contracts — the unit tests import. Flat, ordered, immutable; `.with()` derives a variant without touching the original. |
-| [DatabaseKeys](type-aliases/DatabaseKeys.md) | Keys of a services record whose handles are databases. |
-| [DatabasePort](type-aliases/DatabasePort.md) | Abstract database interface for specification runners. Implement this to plug in your database stack (e.g. Postgres, SQLite). |
-| [DeviceOpenOptions](type-aliases/DeviceOpenOptions.md) | Per-open options forwarded to the device session. |
-| [DevicePort](type-aliases/DevicePort.md) | Abstract device interface for the mobile specification runner. One implementation lives in `integrations/appium/` — a single driver session per runner, created on the first `open()` and reused; each open terminates and relaunches the app for a deterministic fresh state. |
-| [DeviceScreen](type-aliases/DeviceScreen.md) | The screen captured by a device open — the FINAL state when a scenario ran. The tree is the projected page source; `texts` are the visible labels/values in document order, consecutive duplicates collapsed. |
-| [DeviceTimeouts](type-aliases/DeviceTimeouts.md) | How long a device session waits, in milliseconds. Every field is optional and falls back to the framework's own default, so a runner states only the wait it needs to move — the defaults suit a release build, and a project that drives a DEV build pays for its bundler's cold boot. |
-| [DockerSpecConfig](type-aliases/DockerSpecConfig.md) | Configuration for the docker-aware cli mode. When set on [SpecificationConfig](type-aliases/SpecificationConfig.md), the cli runner generates a test-run id, injects it into the child env under `envVar`, then queries Docker for every container carrying `testRunLabel=<id>` after the command exits. |
-| [DomMount](type-aliases/DomMount.md) | A vanilla DOM subject: a function handed the container it must fill. Its optional return is the teardown, the way a DOM library states one. |
-| [ElementKind](type-aliases/ElementKind.md) | The interactive/textual element kinds — what a visitor actually acts on. |
-| [ElementMatch](type-aliases/ElementMatch.md) | One candidate captured when a descriptor matched more than one element — the evidence the ambiguity error enumerates so the author can disambiguate without opening a browser. |
-| [ElementOptions](type-aliases/ElementOptions.md) | Options accepted by every named descriptor. |
-| [ElementRef](type-aliases/ElementRef.md) | A user-facing element descriptor — pure data, built by the element vocabulary (`button()`, `link()`, `field()`, …) and translated into concrete locators by the browser integration. CSS/XPath selectors are deliberately not expressible: user-facing elements are the only surface. |
-| [ExecOptions](type-aliases/ExecOptions.md) | Options for the long-running form of `.exec()` (CONVENTIONS B2). When either option is present the process is spawned and observed: it resolves as soon as `waitFor` appears in stdout/stderr, and is killed when `timeout` elapses (exit code 124). |
-| [FileAccessor](type-aliases/FileAccessor.md) | Read-only handle to a single file produced by a spec action. |
-| [HonoApp](type-aliases/HonoApp.md) | Any object with a request method compatible with Hono's app.request(). |
-| [HttpContractFilter](type-aliases/HttpContractFilter.md) | Request filters for the generic HTTP provider. Every field is a subset constraint — a request matches when all provided fields match. |
-| [HttpResponseInit](type-aliases/HttpResponseInit.md) | Init options shared by the response builders. |
-| [HttpStreamInit](type-aliases/HttpStreamInit.md) | Init options for a streamed reply. |
-| [IntegrationHandle](type-aliases/IntegrationHandle.md) | The record returned by startIntegration \| specification.integration. Destructure with the canonical names (CONVENTIONS A3): |
-| [IntegrationSpecification](type-aliases/IntegrationSpecification.md) | The `integration` facet — the in-process chain handed out by `specification.integration()`. |
-| [IntegrationSpecificationOptions](type-aliases/IntegrationSpecificationOptions.md) | Options for startIntegration \| specification.integration. |
-| [Intercept](type-aliases/Intercept.md) | The module-scope network double. Resolves once the engine is listening — which is why it is a promise, and why the canonical form awaits it: |
-| [InterceptOptions](type-aliases/InterceptOptions.md) | What a scope may state about the network it declares. |
-| [InterceptScope](type-aliases/InterceptScope.md) | One block's worth of declared network. Disposed at the end of the scope that declared it: the handlers are dropped, and an unmatched request is thrown. |
-| [IsolationStrategy](type-aliases/IsolationStrategy.md) | Strategy for isolating service state across parallel test workers. |
-| [JobHandle](type-aliases/JobHandle.md) | A named job that can be triggered via jobs.trigger(). |
-| [JobsHandle](type-aliases/JobsHandle.md) | The record returned by startJobs \| specification.jobs. Destructure with the canonical names (CONVENTIONS A3): |
-| [JobsResult](type-aliases/JobsResult.md) | What a triggered job HANDS BACK. |
-| [JobsSpecification](type-aliases/JobsSpecification.md) | - |
-| [JobsSpecificationOptions](type-aliases/JobsSpecificationOptions.md) | Options for startJobs \| specification.jobs. |
-| [LandmarkKind](type-aliases/LandmarkKind.md) | The landmark roles — the standard set of page regions, and the only containers a scope can name. Closed on purpose: ARIA defines exactly these, so `within()` never becomes a second selector language. |
-| [LiterateRunFlags](type-aliases/LiterateRunFlags.md) | Per-call options for runSpecDocument / `cli.run()`. |
-| [LiterateServeRegistration](type-aliases/LiterateServeRegistration.md) | A server a document may start by name (`serve: mcp`), registered once per app in the `serve` option of `specification.cli()`. |
-| [MatchableRequest](type-aliases/MatchableRequest.md) | The observed outgoing request, reduced to what contract matchers inspect. Built once per request by the engine (MSW on api/jobs, the stub backend on website/mobile) and handed to [ContractRequest.match](type-aliases/ContractRequest.md#match) and to a [ContractResponder](type-aliases/ContractResponder.md). |
-| [MatcherKind](type-aliases/MatcherKind.md) | The frozen token vocabulary (CONVENTIONS D4) plus the code-only kinds. |
-| [MatchFixtureOptions](type-aliases/MatchFixtureOptions.md) | Per-call options for the fixture-file `toMatch` subjects. `frozen` opts a single fixture OUT of update-mode rewriting: a frozen fixture is NEVER written under `TEST_UPDATE=1` (or vitest `-u`) — in update mode a frozen mismatch still throws its diff, and a frozen missing fixture still throws its "does not exist" error. This is what makes a DELIBERATELY-WRONG fixture (the subject of a negative test that asserts the mismatch/error rendering) survivable across update runs instead of being silently overwritten with the actual output. |
-| [MobileBackendOptions](type-aliases/MobileBackendOptions.md) | The declared stub backend behind the app under test. The framework owns the simulator and appium but NOT the JS bundler (Metro belongs to the caller's repo, like `next build` belongs to a website's) — so nothing is injected: the handle exposes `backendUrl` and the CALLER wires it into its own bundler env. |
-| [MobileElementKind](type-aliases/MobileElementKind.md) | The element kinds a mobile screen can designate — the structural subset of [ElementRef](type-aliases/ElementRef.md) kinds that map onto the XCUITest accessibility tree. There is ONE element vocabulary across facets: `button('Bookmark')` works in a visit scenario and a mobile scenario alike. Landmarks have no iOS analog — passing one to a mobile verb refuses at runtime. |
-| [MobileElementMatch](type-aliases/MobileElementMatch.md) | One candidate captured when a descriptor matched more than one element — the evidence the ambiguity error enumerates so the author can disambiguate without opening the simulator. |
-| [MobileElementRef](type-aliases/MobileElementRef.md) | A user-facing element descriptor for mobile scenarios — pure data, built by the shared element vocabulary (`button()`, `field()`, `content()`, `testId()`, `within()`) and translated into iOS predicate strings by the device integration. Structurally the same ref type as the browser's, so the vocabulary stays single; kinds outside [MobileElementKind](type-aliases/MobileElementKind.md) (the ARIA landmarks) are refused at runtime with a message naming the boundary. |
-| [MobileHandle](type-aliases/MobileHandle.md) | The record returned by startMobile \| specification.mobile. Destructure with the canonical names (CONVENTIONS A3): |
-| [MobileScenario](type-aliases/MobileScenario.md) | The behavior of an open — the When of the spec; assertions stay in the Then. |
-| [MobileSpecification](type-aliases/MobileSpecification.md) | The `mobile` facet — screen chain entry handed out by `specification.mobile()`. `.open()` is the single, terminal action: it terminates and relaunches the app (deterministic fresh state), applies the deep link, runs the scenario, and captures the final screen. |
-| [MobileSpecificationOptions](type-aliases/MobileSpecificationOptions.md) | Options for startMobile \| specification.mobile. |
-| [MobileVisitor](type-aliases/MobileVisitor.md) | The visitor — the interaction vocabulary handed to a mobile scenario. Every verb auto-waits by polling until a visible match exists; acting verbs then enforce exactly-one (W3), while `see()` — the single synchronization primitive — is satisfied by any visible match. There is no sleep and no conditional helper. |
-| [MockOfOptions](type-aliases/MockOfOptions.md) | How much of the port the double answers for. |
-| [MockPort](type-aliases/MockPort.md) | The factory's own shape — kept as a name so a consumer can annotate with it. |
-| [PinnedClock](type-aliases/PinnedClock.md) | A pinned clock — released when the `using` scope that declared it ends. |
-| [PostgresOptions](type-aliases/PostgresOptions.md) | - |
-| [ProcessOptions](type-aliases/ProcessOptions.md) | The ONE shape an external process takes — the site under test, a backend a page talks to, a bundler a simulator loads from. Built by `process()` (chapter 17) and accepted wherever a facet starts something outside this process: `website({ server })`, `services: { api: process(…) }`, and the literate `serve:` registry. |
-| [RedisOptions](type-aliases/RedisOptions.md) | - |
-| [RenderSubject](type-aliases/RenderSubject.md) | What `.render()` mounts. A React tree is an element (`<PostTable />`); a vanilla DOM subject is the FUNCTION that fills a container, which is how a DOM-only module is called in production too. |
-| [ScreenNode](type-aliases/ScreenNode.md) | One node of the projected accessibility tree — the XCUITest page source with its noise collapsed: unlabeled, identifier-less, valueless wrapper nodes are dropped and their children hoisted, so the projection stays stable and golden-friendly. Type names lose the `XCUIElementType` prefix. |
-| [ServerPort](type-aliases/ServerPort.md) | Abstract server interface for specification runners. Integration mode uses an in-process Hono app; E2E mode uses real HTTP via fetch. |
-| [ServerResponse](type-aliases/ServerResponse.md) | HTTP response returned by a server port, with parsed JSON body. |
-| [ServerSpec](type-aliases/ServerSpec.md) | What `server` may be handed as, and what it resolves to. |
-| [ServiceHandle](type-aliases/ServiceHandle.md) | A service handle — returned by factory functions like postgres(), redis(). Mutable: connectionString is populated after the orchestrator starts containers. |
-| [ServiceRecord](type-aliases/ServiceRecord.md) | Infrastructure services declared as a named record. Keys become the typed vocabulary of the whole spec: the server factory receives the same record, and `.seed()` / `.table()` target databases by key. |
-| [SpecDocument](type-aliases/SpecDocument.md) | A parsed `<case>.spec.yaml`. |
-| [SpecEnvToken](type-aliases/SpecEnvToken.md) | One `env:` entry — a bare word naming a registered set, or a `KEY=value` pair. |
-| [SpecFileAssertion](type-aliases/SpecFileAssertion.md) | One `files:` assertion, keyed by a workdir-relative path. |
-| [SpecFixture](type-aliases/SpecFixture.md) | One `fixture:` entry — a path with the line it was declared on. |
-| [SpecificationConfig](type-aliases/SpecificationConfig.md) | Adapter configuration passed to the specification facets at setup time. |
-| [SpecKind](type-aliases/SpecKind.md) | - |
-| [SpecRun](type-aliases/SpecRun.md) | One run: a command, what it must exit with, and what it must have produced. |
-| [SpecServeEntry](type-aliases/SpecServeEntry.md) | One `serve:` entry — a registered server plus the extra env it is started with. |
-| [SpecStream](type-aliases/SpecStream.md) | An expected stream: its text, and the first line of that text in the file. |
-| [SqliteOptions](type-aliases/SqliteOptions.md) | - |
-| [SseEvent](type-aliases/SseEvent.md) | One server-sent event, as `http.sse()` frames it. |
-| [StreamBody](type-aliases/StreamBody.md) | A body that arrives in pieces — what `http.stream()` and `http.sse()` build. |
-| [TextFilter](type-aliases/TextFilter.md) | A text filter on a provider request builder (`openai.chat({ user })`, `anthropic.messages({ system })`, …). |
-| [Visitor](type-aliases/Visitor.md) | The visitor — the interaction vocabulary handed to a visit scenario. Every action auto-waits (playwright actionability); `see()` is the single synchronization primitive: it retries until the element is visible and fails at the timeout. There is no sleep and no conditional helper. |
-| [VisitScenario](type-aliases/VisitScenario.md) | The behavior of a visit — the When of the spec; assertions stay in the Then. |
-| [WaitUntilOptions](type-aliases/WaitUntilOptions.md) | How long to wait, and how often to look. |
-| [WebsiteBackendOptions](type-aliases/WebsiteBackendOptions.md) | The declared stub backend behind the site under test — started before the server command, torn down with the runner. Its URL is injected into the server child's environment under `env`; the contracts each chain declares via `.intercept(...)` are what it serves. |
-| [WebsiteHandle](type-aliases/WebsiteHandle.md) | The record returned by startWebsite \| specification.website. Destructure with the canonical names (CONVENTIONS A3): |
-| [WebsiteSpecification](type-aliases/WebsiteSpecification.md) | The `website` facet — page chain entry handed out by `specification.website()`. Setup methods chain; action methods are terminal. `.visit()` renders the page in the shared browser; `.fetch()` performs one raw HTTP exchange and never follows redirects. |
-| [WebsiteSpecificationOptions](type-aliases/WebsiteSpecificationOptions.md) | Options for startWebsite \| specification.website. `server` (start the site locally) and `url` (target a running site) are mutually exclusive BY TYPE — the union makes the invalid combinations inexpressible rather than runtime-checked. `backend` requires `server` mode for the same reason: a deployed site cannot be pointed at a local stub. |
-
-## Variables
-
-| Variable | Description |
-| ------ | ------ |
-| [anthropic](variables/anthropic.md) | Anthropic API intercept helpers. |
-| [banner](variables/banner.md) | The `banner` landmark — the page header. |
-| [button](variables/button.md) | A button (or element with the button role), by accessible name. |
-| [clock](variables/clock.md) | - |
-| [complementary](variables/complementary.md) | The `complementary` landmark — an `<aside>`, a sidebar. |
-| [component](variables/component.md) | Present, typed, and refusing — every setup and the terminal action alike. |
-| [content](variables/content.md) | An element containing the given text. |
-| [contentinfo](variables/contentinfo.md) | The `contentinfo` landmark — the page footer. |
-| [dialog](variables/dialog.md) | A modal or non-modal `<dialog>`, by accessible name. A closed one is absent. |
-| [field](variables/field.md) | A form field, by label. |
-| [form](variables/form.md) | The `form` landmark — a form carrying an accessible name. |
-| [heading](variables/heading.md) | A heading, by accessible name. |
-| [http](variables/http.md) | Generic HTTP contract helpers for any URL. The url is absolute (string or RegExp), or a PATH FORM starting with `/` — `http.get('/articles/{{uuid}}')` matches that path on ANY origin, which is what an app calling its own backend needs. An optional [HttpContractFilter](type-aliases/HttpContractFilter.md) narrows matching by body, headers, or query — a request that hits the URL/method but fails the filter counts as unmatched (strict contracts, CONVENTIONS D7). |
-| [intercept](variables/intercept.md) | The module-scope network double, on msw's node server — what a test with no chain to hang contracts on reaches for (chapter 16). |
-| [link](variables/link.md) | A link, by accessible name. |
-| [listitem](variables/listitem.md) | An item of a list, by its text. Retires the `.first()` of an unnamed `<li>`. |
-| [main](variables/main.md) | The `main` landmark — the primary content of the document. |
-| [match](variables/match.md) | - |
-| [navigation](variables/navigation.md) | The `navigation` landmark — a `<nav>`. Name it when a page has several. |
-| [openai](variables/openai.md) | OpenAI API intercept helpers. |
-| [option](variables/option.md) | An option of a select or a listbox, by its label — named inside the field that holds it: `within(field('Channel'), option('LinkedIn'))`. |
-| [region](variables/region.md) | The `region` landmark — a `<section>` carrying an accessible name. |
-| [row](variables/row.md) | A row of a table or grid, by the text of its cells. |
-| [search](variables/search.md) | The `search` landmark. |
-| [specification](variables/specification.md) | - |
-| [status](variables/status.md) | A live region announcing a result — `role="status"`, an `<output>`. |
-| [table](variables/table.md) | A table, by its caption or accessible name. |
-
-## Functions
-
-| Function | Description |
-| ------ | ------ |
-| [defineContract](functions/defineContract.md) | Declare one contract. Identity function — its value is the enforced shape and the naming convention: |
-| [defineContracts](functions/defineContracts.md) | Compose contracts into the artifact a test imports — it's contracts all the way down: a composite may extend contracts, lists, and other composites, recursively, order preserved. |
-| [disabled](functions/disabled.md) | Whether the element accepts input: `see(disabled(button('Delete')))` asserts it refuses, `see(enabled(button('Delete')))` that it takes it. |
-| [enabled](functions/enabled.md) | The other direction of [disabled](functions/disabled.md) — the element takes input. |
-| [focused](functions/focused.md) | Where the keyboard is: `see(focused(button('Open')))` asserts the element has focus, `gone(focused(x))` that it does not. |
-| [mockOf](functions/mockOf.md) | A typed double for an injected port — the fourth rung of the doubles ladder (docs/18-conventions.md), and the only one a module test may build itself. |
-| [postgres](functions/postgres.md) | Create a PostgreSQL service handle. |
-| [process](functions/process.md) | Declare an external process the framework owns for the life of the specification. |
-| [redis](functions/redis.md) | Create a Redis service handle. |
-| [required](functions/required.md) | The value, or a failure that says what was missing and why it mattered. |
-| [selected](functions/selected.md) | Which option the field is on: `see(selected(option('LinkedIn')))`, and `gone(selected(option('X')))` for the one it left. |
-| [sqlite](functions/sqlite.md) | Create a SQLite service handle. Uses file-copy isolation for parallel tests. |
-| [testId](functions/testId.md) | The escape hatch: an element by `data-testid`. Prefer user-facing elements. |
-| [text](functions/text.md) | Wrap an arbitrary string into a [TextAccessor](interfaces/TextAccessor.md) anchored on the calling test's directory — the same caller-detection the builders use. |
-| [valued](functions/valued.md) | What the field holds: `see(valued(field('Title'), 'Launch teaser'))`, and `gone(valued(field('Title'), '…'))` for a value it no longer holds. |
-| [waitUntil](functions/waitUntil.md) | Wait until a condition holds — the sanctioned answer to "the thing I am specifying is not ready yet". |
-| [within](functions/within.md) | Restrict a descriptor to the inside of another — the answer to ambiguity, and the one the framework prefers over a test id. |

package/docs/reference/interfaces/BaseResult.md

@@ -1,87 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: BaseResult
-
-Defined in: [src/model/result/result.ts:34](https://github.com/jterrazz/package-test/blob/main/src/model/result/result.ts#L34)
-
-Base result - common accessors available after any action type.
-Extended by HttpResult, CliResult, and used directly by job results.
-
-Every result carries a fresh [CaptureScope](CaptureScope.md): `match.ref()` captures
-and `{{type#ref}}` placeholders are scoped to one spec execution.
-
-## Extended by
-
-- [`CliResult`](CliResult.md)
-- [`CallResult`](CallResult.md)
-- [`HttpResult`](HttpResult.md)
-- [`ScreenResult`](ScreenResult.md)
-- [`FetchResult`](FetchResult.md)
-- [`PageResult`](PageResult.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)
-
-***
-
-### 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)
-
-***
-
-### 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)

package/docs/reference/interfaces/CallResult.md

@@ -1,160 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: CallResult\<Returned\>
-
-Defined in: [src/facets/integration/integration.result.ts:60](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.result.ts#L60)
-
-The result of an in-process call — the integration facet's whole surface.
-
-Two readings, never both: `value` is what the call RETURNED, `error` is
-what it THREW. A module that refuses is specified the same way a module
-that answers is, and neither needs a `try`/`catch` in the test — a shape
-that costs a refusal spec three times the size of the happy one, and that
-quietly passes when nothing throws at all.
-
-Both are the package's ordinary accessors, so the golden mechanism reaches
-them, and `Returned` is what `.call<T>()` returned — `result.value.value` is
-that type, not `unknown`, so a one-field reading needs no golden file: `toMatch('<name>.json'|'<name>.txt')`, the `{{token}}` grammar,
-`{ frozen }` and `TEST_UPDATE=1` all work here exactly as on an HTTP
-response or a command's stdout.
-
-## Extends
-
-- [`BaseResult`](BaseResult.md)
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `Returned` | `unknown` |
-
-## Accessors
-
-### error
-
-#### Get Signature
-
-```ts
-get error(): TextAccessor;
-```
-
-Defined in: [src/facets/integration/integration.result.ts:78](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.result.ts#L78)
-
-What the call THREW, as text — the message of an `Error`, the value
-itself when something else was thrown, and empty when it returned.
-
-Empty rather than absent on purpose: `await expect(result.error).toBeEmpty()`
-is how a spec says "and it did not refuse" — awaited, because the
-matcher answers a promise on every subject it takes, and a dropped one
-passes the test while the failure surfaces as an unhandled rejection
-(D2 refuses the bare form).
-
-##### Returns
-
-[`TextAccessor`](TextAccessor.md)
-
-***
-
-### value
-
-#### Get Signature
-
-```ts
-get value(): CallValue<Returned>;
-```
-
-Defined in: [src/facets/integration/integration.result.ts:96](https://github.com/jterrazz/package-test/blob/main/src/facets/integration/integration.result.ts#L96)
-
-What the call RETURNED. A string reads as a stream (`<name>.txt`),
-anything else as JSON (`<name>.json`) — the same two subjects every
-other facet's results are built from, chosen on the value in hand and
-typed by CallValue, which answers for the three ways a type can
-relate to `string`.
-
-A call that threw has no value to choose an accessor on, so `value` is
-the JSON reading of `null` whatever the declared type promises: what a
-refusal produced is [CallResult.error](#error), and that is where a spec
-reads it.
-
-##### Returns
-
-`CallValue`\<`Returned`\>
-
-## 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/CaptureScope.md

@@ -1,82 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Interface: CaptureScope
-
-Defined in: [src/model/matching/match.ts:221](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L221)
-
-Named captures recorded by `match.ref()` / `{{type#ref}}` placeholders.
-One scope lives on each spec result — every assertion chained off the same
-result shares it, and a new chain starts fresh.
-
-## Properties
-
-### workdir?
-
-```ts
-optional workdir?: string;
-```
-
-Defined in: [src/model/matching/match.ts:227](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L227)
-
-The exact working directory of the current spec, when the framework
-knows it (cli mode). Drives the `{{workdir}}` token / `match.workdir()`.
-
-## Methods
-
-### get()
-
-```ts
-get(name): unknown;
-```
-
-Defined in: [src/model/matching/match.ts:233](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L233)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-
-#### Returns
-
-`unknown`
-
-***
-
-### has()
-
-```ts
-has(name): boolean;
-```
-
-Defined in: [src/model/matching/match.ts:237](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L237)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-
-#### Returns
-
-`boolean`
-
-***
-
-### set()
-
-```ts
-set(name, value): void;
-```
-
-Defined in: [src/model/matching/match.ts:241](https://github.com/jterrazz/package-test/blob/main/src/model/matching/match.ts#L241)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `name` | `string` |
-| `value` | `unknown` |
-
-#### Returns
-
-`void`