@jterrazz/test 15.3.0 → 16.1.0

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

@@ -0,0 +1,216 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: ServiceHandle
+
+```ts
+type ServiceHandle = object;
+```
+
+Defined in: [src/model/ports/service.port.ts:8](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L8)
+
+A service handle — returned by factory functions like postgres(), redis().
+Mutable: connectionString is populated after the orchestrator starts containers.
+
+## Properties
+
+### buildConnectionString
+
+```ts
+buildConnectionString: (host, port) => string;
+```
+
+Defined in: [src/model/ports/service.port.ts:37](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L37)
+
+Build the connection string from host and port.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `host` | `string` |
+| `port` | `number` |
+
+#### Returns
+
+`string`
+
+***
+
+### connectionString
+
+```ts
+connectionString: string;
+```
+
+Defined in: [src/model/ports/service.port.ts:31](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L31)
+
+Connection string — populated after start.
+
+***
+
+### createDatabaseAdapter
+
+```ts
+createDatabaseAdapter: () => DatabasePort | null;
+```
+
+Defined in: [src/model/ports/service.port.ts:40](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L40)
+
+Create a DatabasePort adapter (if this is a database). Returns null otherwise.
+
+#### Returns
+
+[`DatabasePort`](DatabasePort.md) \| `null`
+
+***
+
+### defaultImage
+
+```ts
+readonly defaultImage: string;
+```
+
+Defined in: [src/model/ports/service.port.ts:25](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L25)
+
+Default Docker image for this service type.
+
+***
+
+### defaultPort
+
+```ts
+readonly defaultPort: number;
+```
+
+Defined in: [src/model/ports/service.port.ts:22](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L22)
+
+Default container port for this service type.
+
+***
+
+### environment
+
+```ts
+readonly environment: Record<string, string>;
+```
+
+Defined in: [src/model/ports/service.port.ts:28](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L28)
+
+Environment variables to pass to the container.
+
+***
+
+### healthcheck
+
+```ts
+healthcheck: () => Promise<void>;
+```
+
+Defined in: [src/model/ports/service.port.ts:43](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L43)
+
+Verify the service is ready and accepting connections. Throws with context if not.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### initialize
+
+```ts
+initialize: (dockerDir, root) => Promise<void>;
+```
+
+Defined in: [src/model/ports/service.port.ts:55](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L55)
+
+Run initialization scripts (e.g., init.sql). Throws with SQL error
+context if it fails.
+
+`dockerDir` is `<root>/docker` — where a service reads its `init.sql`
+from, under its own name. `root` is the project root the specification resolved
+(A9), handed down so a service that CACHES something writes it under the
+project's own `.artifacts/`, never in a machine-global directory two
+checkouts would share.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `dockerDir` | `string` |
+| `root` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### isolation
+
+```ts
+isolation: () => IsolationStrategy;
+```
+
+Defined in: [src/model/ports/service.port.ts:61](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L61)
+
+Get the isolation strategy for parallel test execution.
+
+#### Returns
+
+[`IsolationStrategy`](IsolationStrategy.md)
+
+***
+
+### reset
+
+```ts
+reset: () => Promise<void>;
+```
+
+Defined in: [src/model/ports/service.port.ts:58](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L58)
+
+Reset state between tests (truncate tables, flush cache, etc.)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### serviceName
+
+```ts
+serviceName: null | string;
+```
+
+Defined in: [src/model/ports/service.port.ts:19](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L19)
+
+The name this handle is known by. Left `null` until the orchestrator
+assigns it at start time: it is the kebab-case form of the RECORD KEY,
+so `{ analyticsDb: postgres() }` reports as `analytics-db` and reads its
+init script from `docker/analytics-db/`. The key is the only name a
+specification writes; a handle carries no second one of its own.
+
+***
+
+### started
+
+```ts
+started: boolean;
+```
+
+Defined in: [src/model/ports/service.port.ts:34](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L34)
+
+Whether this service has been started.
+
+***
+
+### type
+
+```ts
+readonly type: string;
+```
+
+Defined in: [src/model/ports/service.port.ts:10](https://github.com/jterrazz/package-test/blob/main/src/model/ports/service.port.ts#L10)
+
+Service type identifier.

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

@@ -0,0 +1,12 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: ServiceRecord
+
+```ts
+type ServiceRecord = Record<string, ServiceHandle>;
+```
+
+Defined in: [src/model/chain/services.ts:16](https://github.com/jterrazz/package-test/blob/main/src/model/chain/services.ts#L16)
+
+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.

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

@@ -0,0 +1,84 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecDocument
+
+```ts
+type SpecDocument = object;
+```
+
+Defined in: [src/model/literate/spec-document.ts:134](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L134)
+
+A parsed `<case>.spec.yaml`.
+
+## Properties
+
+### description
+
+```ts
+description: string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:136](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L136)
+
+The vitest test title.
+
+***
+
+### descriptionLine
+
+```ts
+descriptionLine: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:138](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L138)
+
+1-based line of the `description:` key.
+
+***
+
+### env
+
+```ts
+env: SpecEnvToken[];
+```
+
+Defined in: [src/model/literate/spec-document.ts:139](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L139)
+
+***
+
+### fixtures
+
+```ts
+fixtures: SpecFixture[];
+```
+
+Defined in: [src/model/literate/spec-document.ts:140](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L140)
+
+***
+
+### kind
+
+```ts
+kind: SpecKind;
+```
+
+Defined in: [src/model/literate/spec-document.ts:141](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L141)
+
+***
+
+### runs
+
+```ts
+runs: SpecRun[];
+```
+
+Defined in: [src/model/literate/spec-document.ts:142](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L142)
+
+***
+
+### serve
+
+```ts
+serve: SpecServeEntry[];
+```
+
+Defined in: [src/model/literate/spec-document.ts:143](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L143)

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

@@ -0,0 +1,21 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecEnvToken
+
+```ts
+type SpecEnvToken = 
+  | {
+  key: string;
+  kind: "pair";
+  line: number;
+  value: string;
+}
+  | {
+  kind: "set";
+  line: number;
+  name: string;
+};
+```
+
+Defined in: [src/model/literate/spec-document.ts:80](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L80)
+
+One `env:` entry — a bare word naming a registered set, or a `KEY=value` pair.

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

@@ -0,0 +1,27 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecFileAssertion
+
+```ts
+type SpecFileAssertion = 
+  | {
+  contains: SpecStream[];
+  equals: null | SpecStream;
+  kind: "content";
+  line: number;
+  path: string;
+}
+  | {
+  kind: "absent";
+  line: number;
+  path: string;
+}
+  | {
+  kind: "exists";
+  line: number;
+  path: string;
+};
+```
+
+Defined in: [src/model/literate/spec-document.ts:105](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L105)
+
+One `files:` assertion, keyed by a workdir-relative path.

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

@@ -0,0 +1,30 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecFixture
+
+```ts
+type SpecFixture = object;
+```
+
+Defined in: [src/model/literate/spec-document.ts:92](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L92)
+
+One `fixture:` entry — a path with the line it was declared on.
+
+## Properties
+
+### line
+
+```ts
+line: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:93](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L93)
+
+***
+
+### path
+
+```ts
+path: string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:94](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L94)

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

@@ -0,0 +1,8 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecKind
+
+```ts
+type SpecKind = typeof SPEC_KINDS[number];
+```
+
+Defined in: [src/model/literate/spec-document.ts:77](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L77)

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

@@ -0,0 +1,108 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecRun
+
+```ts
+type SpecRun = object;
+```
+
+Defined in: [src/model/literate/spec-document.ts:117](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L117)
+
+One run: a command, what it must exit with, and what it must have produced.
+
+## Properties
+
+### command
+
+```ts
+command: string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:118](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L118)
+
+***
+
+### commandLine
+
+```ts
+commandLine: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:120](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L120)
+
+1-based line of the `command:` key — the frame a failure points at.
+
+***
+
+### exitCode
+
+```ts
+exitCode: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:121](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L121)
+
+***
+
+### files
+
+```ts
+files: SpecFileAssertion[];
+```
+
+Defined in: [src/model/literate/spec-document.ts:122](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L122)
+
+***
+
+### stderr
+
+```ts
+stderr: null | SpecStream;
+```
+
+Defined in: [src/model/literate/spec-document.ts:124](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L124)
+
+`null` when the key is absent, which asserts an empty stream.
+
+***
+
+### stdin
+
+```ts
+stdin: null | string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:126](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L126)
+
+Written to the child then closed; `null` keeps the empty-pipe EOF.
+
+***
+
+### stdout
+
+```ts
+stdout: null | SpecStream;
+```
+
+Defined in: [src/model/literate/spec-document.ts:127](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L127)
+
+***
+
+### timeout
+
+```ts
+timeout: null | number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:128](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L128)
+
+***
+
+### waitFor
+
+```ts
+waitFor: null | string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:130](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L130)
+
+Only ever on the LAST run — a long-running command ends the session.

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

@@ -0,0 +1,40 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecServeEntry
+
+```ts
+type SpecServeEntry = object;
+```
+
+Defined in: [src/model/literate/spec-document.ts:85](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L85)
+
+One `serve:` entry — a registered server plus the extra env it is started with.
+
+## Properties
+
+### env
+
+```ts
+env: Record<string, string>;
+```
+
+Defined in: [src/model/literate/spec-document.ts:86](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L86)
+
+***
+
+### line
+
+```ts
+line: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:87](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L87)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:88](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L88)

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

@@ -0,0 +1,32 @@
+<!-- GENERATED by `typescript docs` — DO NOT EDIT -->
+# Type Alias: SpecStream
+
+```ts
+type SpecStream = object;
+```
+
+Defined in: [src/model/literate/spec-document.ts:98](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L98)
+
+An expected stream: its text, and the first line of that text in the file.
+
+## Properties
+
+### line
+
+```ts
+line: number;
+```
+
+Defined in: [src/model/literate/spec-document.ts:100](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L100)
+
+1-based line the scalar's content starts on — where a token defect is reported.
+
+***
+
+### text
+
+```ts
+text: string;
+```
+
+Defined in: [src/model/literate/spec-document.ts:101](https://github.com/jterrazz/package-test/blob/main/src/model/literate/spec-document.ts#L101)