@jterrazz/test 16.1.1 → 17.0.0

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

@@ -1,28 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileBackendOptions
-
-```ts
-type MobileBackendOptions = object;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:23](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L23)
-
-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.
-
-## Properties
-
-### port?
-
-```ts
-optional port?: number;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:29](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L29)
-
-Fixed port — pins a stable stub URL across runs. Metro inlines
-`EXPO_PUBLIC_*` values at bundle-serve time; a stable port lets a warm
-Metro survive between runs. Default: a free OS-assigned port.

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

@@ -1,14 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileElementKind
-
-```ts
-type MobileElementKind = "button" | "field" | "testId" | "text";
-```
-
-Defined in: [src/model/ports/device.port.ts:10](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L10)
-
-The element kinds a mobile screen can designate — the structural subset of
-[ElementRef](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.

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

@@ -1,60 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileElementMatch
-
-```ts
-type MobileElementMatch = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:32](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L32)
-
-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.
-
-## Properties
-
-### identifier?
-
-```ts
-optional identifier?: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:34](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L34)
-
-The accessibility identifier (`testId()` target), when one is set.
-
-***
-
-### label?
-
-```ts
-optional label?: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:36](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L36)
-
-The accessible label, whitespace-collapsed and truncated.
-
-***
-
-### type
-
-```ts
-type: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:38](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L38)
-
-Element type without the `XCUIElementType` prefix — `Button`, `StaticText`.
-
-***
-
-### value?
-
-```ts
-optional value?: string;
-```
-
-Defined in: [src/model/ports/device.port.ts:40](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L40)
-
-The element value (text-field content, adjustable value), when present.

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

@@ -1,20 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileElementRef
-
-```ts
-type MobileElementRef = ElementRef;
-```
-
-Defined in: [src/model/ports/device.port.ts:25](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L25)
-
-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](MobileElementKind.md) (the ARIA
-landmarks) are refused at runtime with a message naming the boundary.
-
-A descriptor must designate exactly ONE element when a verb ACTS on it
-(`tap`, `fill`) — see [MobileElementMatch](MobileElementMatch.md) and CONVENTIONS W3.
-`see()` acts on nothing, so any visible match satisfies it: XCUITest trees
-legitimately duplicate a label across container and child.

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

@@ -1,65 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileHandle
-
-```ts
-type MobileHandle = object;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:83](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L83)
-
-The record returned by startMobile \| specification.mobile.
-Destructure with the canonical names (CONVENTIONS A3):
-
-    const { mobile, cleanup, udid } = await specification.mobile(…);
-
-## Properties
-
-### backendUrl?
-
-```ts
-optional backendUrl?: string;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:89](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L89)
-
-Base URL of the declared stub backend — present only with the
-`backend` option. The caller injects it into its own bundler env
-(e.g. `EXPO_PUBLIC_API_URL`); the framework never touches the bundler.
-
-***
-
-### cleanup
-
-```ts
-cleanup: () => Promise<void>;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:91](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L91)
-
-End the driver session, stop the appium server and the stub backend.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### mobile
-
-```ts
-mobile: MobileSpecification;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:92](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L92)
-
-***
-
-### udid
-
-```ts
-udid: string;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:94](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L94)
-
-The resolved simulator UDID the specs run against.

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

@@ -1,20 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileScenario
-
-```ts
-type MobileScenario = (visitor) => Promise<void>;
-```
-
-Defined in: [src/model/ports/device.port.ts:60](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L60)
-
-The behavior of an open — the When of the spec; assertions stay in the Then.
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `visitor` | [`MobileVisitor`](MobileVisitor.md) |
-
-## Returns
-
-`Promise`\<`void`\>

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

@@ -1,51 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileSpecification
-
-```ts
-type MobileSpecification = object;
-```
-
-Defined in: [src/model/chain/builder.ts:332](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L332)
-
-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.
-
-## Properties
-
-### intercept
-
-```ts
-intercept: InterceptMethod<MobileSpecification>;
-```
-
-Defined in: [src/model/chain/builder.ts:337](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L337)
-
-Declare the chain's backend contracts — served by the declared stub
-backend (requires the runner's `backend` option). Multiple calls append.
-
-***
-
-### open
-
-```ts
-open: (deepLink?, scenario?) => Promise<ScreenResult>;
-```
-
-Defined in: [src/model/chain/builder.ts:344](https://github.com/jterrazz/package-test/blob/main/src/model/chain/builder.ts#L344)
-
-Relaunch the app and resolve with the captured screen. With a deep
-link, the app opens on it; with a scenario, the visitor interacts
-first (the When) and the capture reflects the FINAL screen state.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `deepLink?` | `string` |
-| `scenario?` | [`MobileScenario`](MobileScenario.md) |
-
-#### Returns
-
-`Promise`\<[`ScreenResult`](../interfaces/ScreenResult.md)\>

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

@@ -1,126 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileSpecificationOptions\<Services\>
-
-```ts
-type MobileSpecificationOptions<Services> = object;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:33](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L33)
-
-Options for startMobile \| specification.mobile.
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `Services` *extends* [`ServiceRecord`](ServiceRecord.md) | [`ServiceRecord`](ServiceRecord.md) |
-
-## Properties
-
-### app
-
-```ts
-app: object;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:35](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L35)
-
-The app under test — terminated and relaunched by every `.open()`.
-
-#### bundleId
-
-```ts
-bundleId: string;
-```
-
-Bundle id of the installed app (`com.example.app`).
-
-***
-
-### backend?
-
-```ts
-optional backend?: MobileBackendOptions;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:44](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L44)
-
-Declared stub backend: started with the runner, serving the contracts
-each chain declares via `.intercept(...)`. The handle gains
-`backendUrl` — inject it into your bundler env yourself.
-
-***
-
-### device
-
-```ts
-device: object;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:46](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L46)
-
-The simulator to run on — resolved through `xcrun simctl`.
-
-#### name
-
-```ts
-name: string;
-```
-
-Simulator name, matched exactly (`iPhone 17`).
-
-#### os?
-
-```ts
-optional os?: string;
-```
-
-OS narrowing when the name exists on several runtimes — `'26.5'` or `'iOS 26.5'`.
-
-#### udid?
-
-```ts
-optional udid?: string;
-```
-
-Explicit UDID — skips name/os resolution entirely.
-
-***
-
-### root?
-
-```ts
-optional root?: string;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:59](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L59)
-
-Project-root override (CONVENTIONS A9): where the appium binary is
-resolved from (`node_modules/.bin`). Auto-discovered from the calling
-file when absent.
-
-***
-
-### services?
-
-```ts
-optional services?: Services;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:73](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L73)
-
-Named services started with the runner and stopped with it — a
-`process()` for the bundler the app loads from, a database a dev build
-reads. Metro stops being a `beforeAll` the repository maintains: it is
-`process({ command: 'expo start', ready: /Metro waiting on .*:(\\d+)/ })`
-like every other external process the framework owns.
-
-***
-
-### timeouts?
-
-```ts
-optional timeouts?: DeviceTimeouts;
-```
-
-Defined in: [src/facets/mobile/mobile.specification.ts:74](https://github.com/jterrazz/package-test/blob/main/src/facets/mobile/mobile.specification.ts#L74)

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

@@ -1,81 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MobileVisitor
-
-```ts
-type MobileVisitor = object;
-```
-
-Defined in: [src/model/ports/device.port.ts:50](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L50)
-
-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.
-
-## Properties
-
-### fill
-
-```ts
-fill: (element, value) => Promise<void>;
-```
-
-Defined in: [src/model/ports/device.port.ts:52](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L52)
-
-Fill a text field with a value.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `element` | [`MobileElementRef`](MobileElementRef.md) |
-| `value` | `string` |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### see
-
-```ts
-see: (element) => Promise<void>;
-```
-
-Defined in: [src/model/ports/device.port.ts:54](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L54)
-
-Wait until the element is visible — the only synchronization primitive.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `element` | [`MobileElementRef`](MobileElementRef.md) |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### tap
-
-```ts
-tap: (element) => Promise<void>;
-```
-
-Defined in: [src/model/ports/device.port.ts:56](https://github.com/jterrazz/package-test/blob/main/src/model/ports/device.port.ts#L56)
-
-Tap the element.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `element` | [`MobileElementRef`](MobileElementRef.md) |
-
-#### Returns
-
-`Promise`\<`void`\>

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

@@ -1,26 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MockOfOptions
-
-```ts
-type MockOfOptions = object;
-```
-
-Defined in: [src/model/doubles/mock-of.ts:5](https://github.com/jterrazz/package-test/blob/main/src/model/doubles/mock-of.ts#L5)
-
-How much of the port the double answers for.
-
-## Properties
-
-### deep?
-
-```ts
-optional deep?: boolean;
-```
-
-Defined in: [src/model/doubles/mock-of.ts:13](https://github.com/jterrazz/package-test/blob/main/src/model/doubles/mock-of.ts#L13)
-
-Deep (the default): reading a member that was never stubbed hands back
-another double, however far down the port nests. `false` gives the flat
-proxy — every member of `T` and nothing beneath them, which is what a
-port with a nested namespace wants when the test only ever touches the
-first level.

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

@@ -1,10 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: MockPort
-
-```ts
-type MockPort = typeof mockOf;
-```
-
-Defined in: [src/model/doubles/mock-of.ts:35](https://github.com/jterrazz/package-test/blob/main/src/model/doubles/mock-of.ts#L35)
-
-The factory's own shape — kept as a name so a consumer can annotate with it.

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

@@ -1,10 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: PinnedClock
-
-```ts
-type PinnedClock = Disposable;
-```
-
-Defined in: [src/model/clock/clock.ts:23](https://github.com/jterrazz/package-test/blob/main/src/model/clock/clock.ts#L23)
-
-A pinned clock — released when the `using` scope that declared it ends.

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

@@ -1,32 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: PostgresOptions
-
-```ts
-type PostgresOptions = object;
-```
-
-Defined in: [src/seams/postgres/postgres.ts:23](https://github.com/jterrazz/package-test/blob/main/src/seams/postgres/postgres.ts#L23)
-
-## Properties
-
-### env?
-
-```ts
-optional env?: Record<string, string>;
-```
-
-Defined in: [src/seams/postgres/postgres.ts:27](https://github.com/jterrazz/package-test/blob/main/src/seams/postgres/postgres.ts#L27)
-
-Override environment variables.
-
-***
-
-### image?
-
-```ts
-optional image?: string;
-```
-
-Defined in: [src/seams/postgres/postgres.ts:25](https://github.com/jterrazz/package-test/blob/main/src/seams/postgres/postgres.ts#L25)
-
-Override image.

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

@@ -1,112 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: ProcessOptions
-
-```ts
-type ProcessOptions = object;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:18](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L18)
-
-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.
-
-## Properties
-
-### before?
-
-```ts
-optional before?: string;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:24](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L24)
-
-A one-shot command run ONCE per specification, before the process is
-spawned, which must exit 0 — a build, a migration, a fixture load. Its
-failure is the specification's, and it says so.
-
-***
-
-### command
-
-```ts
-command: string;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:26](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L26)
-
-Shell command that starts the process. Receives the chosen port as `PORT`.
-
-***
-
-### cwd?
-
-```ts
-optional cwd?: string;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:28](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L28)
-
-Working directory, relative to the project root. Default: the root itself.
-
-***
-
-### env?
-
-```ts
-optional env?: 
-  | ((services) => Record<string, string>)
-| Record<string, string>;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:34](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L34)
-
-Environment for the child, on top of the runner's own. A function
-receives the services already started beside this one, so a process can
-be handed a sibling's connection string.
-
-***
-
-### port?
-
-```ts
-optional port?: number;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:38](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L38)
-
-Fixed port. Default: an OS-assigned free port, injected as `PORT`.
-
-***
-
-### ready?
-
-```ts
-optional ready?: RegExp | string;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:50](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L50)
-
-How readiness is observed. Two forms:
-
-- a **path** (or nothing) — the framework picks the port, injects it as
-  `PORT`, and polls `<baseUrl><path>` until it answers any HTTP status
-  (default `/`). This is `specification.website()`'s form.
-- a **regex over the child's output** with ONE capture group holding the
-  port the server chose itself. Nothing is injected as `PORT`: the server
-  announces its port and the framework reads it from the banner. This is
-  the form a literate `serve:` registration uses.
-
-***
-
-### timeout?
-
-```ts
-optional timeout?: number;
-```
-
-Defined in: [src/seams/process/serve.adapter.ts:52](https://github.com/jterrazz/package-test/blob/main/src/seams/process/serve.adapter.ts#L52)
-
-Readiness budget in milliseconds. Default 30 000.

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

@@ -1,20 +0,0 @@
-<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
-# Type Alias: RedisOptions
-
-```ts
-type RedisOptions = object;
-```
-
-Defined in: [src/seams/redis/redis.ts:6](https://github.com/jterrazz/package-test/blob/main/src/seams/redis/redis.ts#L6)
-
-## Properties
-
-### image?
-
-```ts
-optional image?: string;
-```
-
-Defined in: [src/seams/redis/redis.ts:8](https://github.com/jterrazz/package-test/blob/main/src/seams/redis/redis.ts#L8)
-
-Override image.