@docsxai/engine 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,130 @@
+# @docsxai/engine
+
+LLM-agnostic engine: flow-file parser + runtime, calibration helpers, target-site auth strategies, and the full `docsxai` CLI.
+
+The engine **never** calls a model API. Calibration-time inference is supplied by the host agent (Claude Code, Codex, anything that speaks MCP) through the plugin's skill surface; execution is deterministic and replays a doc pack through headless Playwright.
+
+## Surface
+
+- **Flow-file** — declarative YAML at `<workspace>/flows/<name>.flow.yaml`: `prerequisites` + `locators` + `steps[]` (`action`, `target`, `wait_for`, `success`, `annotation` / `annotations`, per-step `redactions`). Hand-editable; schema-validated. `extends:` composition for shared preambles (with `environment` merged per-key, child wins; `redactions` concatenated).
+- **Execution environment** — optional `environment` block (`EnvironmentSpec`): frozen `clock` (Playwright clock API), `locale`, `timezone`, `viewport` (`VIEWPORT_PRESETS`: desktop / tablet / mobile, or explicit size), `color_scheme`, `reduced_motion`. Applied at context creation by `launchPlaywrightSession({ environment })`; on CDP-attached sessions only the clock applies (one stderr warning lists skipped fields). `contextOptions` passes `httpCredentials` / `clientCertificates` / `extraHTTPHeaders` through to `browser.newContext`.
+- **Redactions** — flow-level + per-step `RedactionSpec[]` (`{ selector }` or `{ region }`, style `box` | `pixelate`) masked deterministically before any screenshot (halt shots included) hits disk. The pure pixel transform is `applyRedactions` in `redact.ts`.
+- **`BrowserDriver`** interface — what the runtime needs from a browser. The `PlaywrightDriver` implementation includes the `actionable()` predicate (see [`docs/actionability-contract.md`](../../docs/actionability-contract.md)) that browser-bridge consumers can mirror, plus a real `element_stable` wait (bounding-box polling, 10 s best-effort budget).
+- **Auth strategies** — `auth/strategy.yaml` descriptor + a catalogue of scripted strategies (`api-login`, `ui-form` with a TOTP hop, `email-otp`, `webauthn`, `jwt-injection`, `http-basic`, `pat-header`, `mtls`, `test-backdoor`) alongside the human-in-the-loop `manual-capture`. See [Auth strategies](#auth-strategies) below.
+- **CLI** — `docsxai <command>`. See `--help` or the [top-level README](../../README.md) for the full surface; this package's `dist/cli.js` is the binary.
+
+## CLI commands
+
+```
+init           scaffold a workspace
+capture-auth   cache an authed session
+calibrate      extract a flow-file from a structured guide
+inspect        discover [data-testid] locators on the live page
+run            execute flows headless; emit annotations + screenshots
+render         build the static viewer (spawns the @docsxai/viewer bin)
+lint           static checks across flow-files (R001-R010; `extraRules` injectable via `lintFlow`)
+flow-tree      visualise the `extends` graph
+diagnose       halt-context + recommendations after a halt
+doctor         environment + workspace health-check (✓/✗ + one-line fixes; no plugin code runs)
+style          init/validate style.yaml; --check scans for jargon leaks
+zip            package the doc pack for hand-off
+baseline       snapshot the doc pack (flows, prose, annotations, screenshots, locators) for drift comparison
+diff           deterministic drift report against a baseline (--fail-on warn|fail gates CI)
+export         project the doc pack to a publisher format (`export adf` — Confluence ADF; `export playwright` — Playwright specs)
+```
+
+`run` has a sub-3-second iteration mode for long-async flows: `--start-from <step-id> --cdp <endpoint>` skips every step before the target and attaches to an already-warm Chrome.
+
+`zip` packages the doc pack in-process (via fflate) — no system `zip` binary required — and **deterministically**: entries are sorted, every entry's mtime is pinned to the zip epoch (1980-01-01), and the compression level is fixed, so the same doc pack always produces a byte-identical archive. Includes `flows/`, `docs/`, `.docsxai.json`, `auth/strategy.yaml`, `README.md`; excludes `.auth/`, `**/halts/`, and (unless `--include-viewer`) `.viewer/`. Symlinks that point outside the workspace are never followed into the archive.
+
+`export adf` projects the doc pack to Confluence Cloud ADF (`projectDocPackToAdf` from the library surface) — pure and deterministic, zero HTTP. Default `--mode single` emits one consolidated document (flows as anchored H2 sections); `--mode page-tree` emits a parent overview plus one document per flow. Output lands in `<workspace>/.export/adf/` as `projection.json` + `attachments.json` (file name, source path, sha256 per burned screenshot — falling back to the clean screenshot with a warning when no burned PNG exists). A host agent hands these to the Atlassian MCP, or the `@docsxai/plugin-confluence` publisher (`confluence:push`) consumes them; **all** Confluence HTTP lives in that capability-declared plugin, never in the engine.
+
+`baseline` + `diff` are the drift-detection pair. `baseline` snapshots `flows/` + `docs/` (step `.md`s, `annotations.json`, `screenshots/`, `locators.yaml`) into `<workspace>/.baseline/` (or `--out <dir>`); `diff` compares the live workspace against it (`diffDocPacks` on the library surface) and emits a deterministic `docsxai/drift@1` report — per flow: id-keyed step field deltas, annotation moves beyond a pixel tolerance, screenshot pixel diffs via pngjs (changed-pixel count / pct / changed-region bbox; dimension changes flagged distinctly; `ignore_regions` excluded), prose line-change counts, and locator changes. `--format md` (`formatDriftReportMarkdown`) is PR-comment-ready; `--fail-on warn|fail` exits 1 at/above the threshold (defaults: ≥1% changed pixels = warn, ≥5% = fail, structural change = warn). The engine detects and reports; proposing flow-file patches stays with the host agent (`diagnose`).
+
+`export playwright` renders each flow (with `extends` resolved) as a self-contained Playwright `.spec.ts` (`exportFlowAsPlaywrightTest`) into `<workspace>/.export/tests/`: locator consts, steps as page actions, `wait_for` as waits, `success` as `expect()` assertions, `environment` as `test.use()` + `page.clock.setFixedTime`, `optional` steps in try/catch. Deterministic; generated files carry a "regenerate, don't hand-edit" header.
+
+`render` locates the viewer bin in order: `DOCSX_VIEWER_BIN` (path to the viewer's bin script or an executable), the `@docsxai/viewer` package installed next to the engine (its `bin` run with the current Node), then `docsxai-viewer` on PATH. A launch failure reports all three attempts.
+
+## Auth strategies
+
+Target-site auth lives in `src/auth/` (one module per strategy) behind the `src/auth.ts` re-export shim. Every strategy implements `AuthStrategy.authenticate(ctx) → AuthResult` and reduces to the same universal artifact: a **`storageState`** (cookies + localStorage) the runtime seeds the browser context with, plus — for connection-level schemes — `contextOptions` (`httpCredentials` / `extraHTTPHeaders` / `clientCertificates`) passed through to `browser.newContext`. Roles are declared in `<workspace>/auth/strategy.yaml` (`docsxai/auth-strategy@1`): per-role `strategy`, `creds_env` (credential **keys → env-var names**, never values), `options`, and `cache` (local/backend store, `ttl`, `auth_cookie` expiry pinning).
+
+| Strategy         | Scheme                                                                                                                                                                                                             | Browser needed |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
+| `api-login`      | POST creds to the login endpoint; cookies collected across the redirect chain (own RFC-6265 jar)                                                                                                                   | no             |
+| `ui-form`        | drive the app's own login form: fill, submit, success marker, snapshot; `pre_steps` dismiss pre-login chrome; `options.totp` adds an RFC-6238 hop (dep-free `generateTotp`/`verifyTotp` primitives exported)       | headless       |
+| `email-otp`      | `ui-form` whose code arrives by mail; an `InboxProvider` polls the inbox (`http-json` built-in: Mailpit-style `{ messages: [{to, received_at, body}] }`); `code_pattern` extracts the code (default `\b(\d{6})\b`) | headless       |
+| `webauthn`       | passkey via a CDP virtual authenticator (ctap2 / internal / user-verifying), attached **before** navigation; `trigger_selector` starts the ceremony                                                                | headless       |
+| `jwt-injection`  | static token (`token_env`) or OAuth2 client-credentials mint (`token_url`); injected into localStorage and/or cookies via `{{token}}` templates                                                                    | no             |
+| `http-basic`     | connection-level `httpCredentials`                                                                                                                                                                                 | no             |
+| `pat-header`     | token header via `extraHTTPHeaders` (`value_template`, default `Bearer {{token}}`)                                                                                                                                 | no             |
+| `mtls`           | client certificate via `clientCertificates` (`creds_env` maps `cert`/`key` to PEM file paths)                                                                                                                      | no             |
+| `test-backdoor`  | POST a shared secret to a test-only endpoint                                                                                                                                                                       | no             |
+| `manual-capture` | instrumented Chrome; a human logs in and triggers capture                                                                                                                                                          | headed         |
+
+Cross-cutting contracts:
+
+- **Secrets stay out of band.** Strategies read env-var _names_ from the descriptor and resolve values at run time; error messages mask values as `<SET>`/`<UNSET>` and never echo them.
+- **User pools.** Any credential env value may be comma-separated (`u1,u2,u3`); `resolveCreds({ workerIndex })` gives parallel worker N entry `N % len`, consistently across every pooled variable.
+- **`expiresAt` when derivable.** From the named / lone real-expiry cookie (`jarAuthExpiry`), the JWT `exp` claim, or the token endpoint's `expires_in`; the cache's `auth_cookie` / `ttl` rules cover the rest.
+- **Registries.** `registerAuthStrategy(name, impl)` adds or overrides a scheme (consulted before the built-ins — the plugins-runtime hook); `registerInboxProvider(name, factory)` adds `email-otp` inbox shapes.
+- **One Playwright import site.** Browser-driving strategies depend on the narrow `AuthPage` interface (`src/auth/browser-session.ts`); the default launcher routes through `launchPlaywrightSession`, so unit tests fake the page and `playwright-driver.ts` remains the engine's single Playwright integration point.
+
+## Plugins
+
+The engine hosts a workspace plugin runtime (v1) with four extension points: **publishers**, **renderers**, **lint-rules**, and **auth-strategies**. Plugins are normal npm packages: a `docsxai` field on `package.json` plus a module exporting `register(api)`. They run **in-process and unsandboxed** — `trust` is a review signal, not a boundary — and the no-model-API rule binds them exactly as it binds the engine.
+
+### Manifest (`package.json#docsxai`)
+
+```json
+{
+  "name": "@docsxai/plugin-confluence",
+  "version": "0.1.0",
+  "docsxai": {
+    "apiVersion": "1.0.0",
+    "namespace": "confluence",
+    "register": "./dist/register.js",
+    "kinds": ["publisher"],
+    "capabilities": ["egress:*.atlassian.net"],
+    "dependsOn": [],
+    "trust": "kalebtec"
+  }
+}
+```
+
+- `apiVersion` — exact semver of the runtime contract the plugin codes against. Must share the engine's `RUNTIME_API_VERSION` major with minor ≤ the runtime's, or the plugin load-errors.
+- `namespace` — mandatory, `/^[a-z][a-z0-9-]*$/`. Every registered artifact is exposed as `<namespace>:<name>` (the runtime prefixes; plugins pass bare names). Reserved: `site-docs`, `docsxai`, `core`, `plugins`. Two plugins claiming one namespace are **both** disabled.
+- `kinds` — the extension points the plugin registers (≥1). Registering an undeclared kind throws and load-errors the plugin (capability-disclosure honesty).
+- `capabilities` — `egress:<host-glob>` declarations, subset-checked against the workspace's `plugin_capabilities`. Mismatch disables the plugin (status, not fatal). Publisher plugins are the **only** wiki/VCS egress path in the engine.
+- `dependsOn` — `{ plugin, version }` entries (package name + `^`/`~`/exact range). Load order is topological; cycles are rejected as a unit.
+
+### `register(api)`
+
+The register module exports a `register(api)` function (named or default). `api` exposes `namespace`, `declaredKinds`, `declaredCapabilities`, `registerPublisher(name, impl)`, `registerRenderer(name, impl)`, `registerLintRules(name, rules)`, `registerAuthStrategy(name, impl)`, a stderr logger (`api.log`, prefixed `[plugin:<ns>]`), and `api.workspacePath(...segments)` — the only filesystem root a plugin may touch (escape attempts throw). The extension-point contracts (`PublisherPlugin`, `RendererPlugin`, `AuthStrategyPlugin`, `PluginLintRule`) are exported from this package.
+
+### Workspace config + lock
+
+Two optional `.docsxai.json` keys wire plugins into a workspace:
+
+```json
+{
+  "plugins": [{ "package": "@docsxai/plugin-confluence" }, { "path": "../my-local-plugin" }],
+  "plugin_capabilities": ["egress:*.atlassian.net"]
+}
+```
+
+`plugins-lock.json` (schema `docsxai/plugins-lock@1`, next to the config) pins each plugin's register-module sha256. When it exists, every resolve verifies the bytes **before** importing; a mismatch fails closed with a "run `docsxai plugins sync`" message.
+
+### CLI
+
+```
+docsxai plugins list <workspace>             status table (loaded / disabled reasons); exit 1 if any plugin isn't loaded
+docsxai plugins info <workspace> <namespace> manifest + registered artifact names
+docsxai plugins sync <workspace>             (re)write plugins-lock.json — never executes plugin code
+```
+
+All three accept `--format json`. Plugins are resolved once per CLI invocation — there is no hot reload. See `docs/ai-context/plugin-runtime/lifecycle-and-namespacing.md` for the full lifecycle contract.
+
+## License
+
+[Apache-2.0](../../LICENSE).

package/dist/auth/api-login.d.ts

@@ -0,0 +1,69 @@
+import { z } from "zod";
+import { type AuthContext, type AuthResult, type AuthStrategy } from "./types.js";
+export declare const ApiLoginOptions: z.ZodObject<{
+    /** Login endpoint; resolved against the target's base URL when relative. */
+    login_url: z.ZodString;
+    method: z.ZodDefault<z.ZodString>;
+    /** How the creds map is encoded into the request body. */
+    body_format: z.ZodDefault<z.ZodEnum<["json", "form"]>>;
+    /**
+     * What "logged in" means. `cookie`: the jar must contain it after the redirect chain.
+     * `status`: the final response status must equal it. `json_path`: the final JSON body at
+     * the dotted path must equal `equals`. Default: final status < 400.
+     */
+    success_check: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        cookie: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        cookie: string;
+    }, {
+        cookie: string;
+    }>, z.ZodObject<{
+        status: z.ZodNumber;
+    }, "strict", z.ZodTypeAny, {
+        status: number;
+    }, {
+        status: number;
+    }>, z.ZodObject<{
+        json_path: z.ZodString;
+        equals: z.ZodUnknown;
+    }, "strict", z.ZodTypeAny, {
+        json_path: string;
+        equals?: unknown;
+    }, {
+        json_path: string;
+        equals?: unknown;
+    }>]>>;
+}, "strict", z.ZodTypeAny, {
+    method: string;
+    login_url: string;
+    body_format: "json" | "form";
+    success_check?: {
+        cookie: string;
+    } | {
+        status: number;
+    } | {
+        json_path: string;
+        equals?: unknown;
+    } | undefined;
+}, {
+    login_url: string;
+    method?: string | undefined;
+    body_format?: "json" | "form" | undefined;
+    success_check?: {
+        cookie: string;
+    } | {
+        status: number;
+    } | {
+        json_path: string;
+        equals?: unknown;
+    } | undefined;
+}>;
+export type ApiLoginOptions = z.infer<typeof ApiLoginOptions>;
+/** Walk a dotted path (`a.b.c`) through a parsed JSON value. */
+export declare function getJsonPath(value: unknown, dottedPath: string): unknown;
+export declare class ApiLoginStrategy implements AuthStrategy {
+    private readonly fetchImpl;
+    readonly name: "api-login";
+    constructor(fetchImpl?: typeof fetch);
+    authenticate(ctx: AuthContext): Promise<AuthResult>;
+}

package/dist/auth/api-login.js

@@ -0,0 +1,95 @@
+// `api-login` — POST the role's credentials to the app's login endpoint and keep the session
+// cookies. Pure node fetch; no browser. The strategy of choice when the target has a JSON or
+// form login API the operator may call directly.
+import { z } from "zod";
+import { fetchCollectingCookies, jarAuthExpiry } from "./cookie-jar.js";
+import { AuthStrategyConfigError, parseStrategyOptions, } from "./types.js";
+export const ApiLoginOptions = z
+    .object({
+    /** Login endpoint; resolved against the target's base URL when relative. */
+    login_url: z.string().min(1),
+    method: z.string().default("POST"),
+    /** How the creds map is encoded into the request body. */
+    body_format: z.enum(["json", "form"]).default("json"),
+    /**
+     * What "logged in" means. `cookie`: the jar must contain it after the redirect chain.
+     * `status`: the final response status must equal it. `json_path`: the final JSON body at
+     * the dotted path must equal `equals`. Default: final status < 400.
+     */
+    success_check: z
+        .union([
+        z.object({ cookie: z.string().min(1) }).strict(),
+        z.object({ status: z.number().int() }).strict(),
+        z.object({ json_path: z.string().min(1), equals: z.unknown() }).strict(),
+    ])
+        .optional(),
+})
+    .strict();
+/** Walk a dotted path (`a.b.c`) through a parsed JSON value. */
+export function getJsonPath(value, dottedPath) {
+    let cur = value;
+    for (const segment of dottedPath.split(".")) {
+        if (cur === null || typeof cur !== "object")
+            return undefined;
+        cur = cur[segment];
+    }
+    return cur;
+}
+export class ApiLoginStrategy {
+    fetchImpl;
+    name = "api-login";
+    constructor(fetchImpl = fetch) {
+        this.fetchImpl = fetchImpl;
+    }
+    async authenticate(ctx) {
+        const opts = parseStrategyOptions(this.name, ApiLoginOptions, ctx.options);
+        const url = new URL(opts.login_url, ctx.baseURL);
+        const isJson = opts.body_format === "json";
+        const body = isJson ? JSON.stringify(ctx.creds) : new URLSearchParams(ctx.creds).toString();
+        const result = await fetchCollectingCookies(url, {
+            method: opts.method,
+            headers: {
+                "content-type": isJson ? "application/json" : "application/x-www-form-urlencoded",
+                accept: "application/json, text/html;q=0.9, */*;q=0.8",
+            },
+            body,
+        }, { fetchImpl: this.fetchImpl });
+        // Failure messages name the endpoint and the check — never the credential values.
+        const check = opts.success_check;
+        if (check === undefined) {
+            if (result.status >= 400) {
+                throw new AuthStrategyConfigError(`api-login: ${url.href} answered ${result.status} — login rejected (credentials read from env; values not shown)`);
+            }
+        }
+        else if ("cookie" in check) {
+            if (!result.jar.has(check.cookie)) {
+                const got = result.jar
+                    .cookies()
+                    .map((c) => c.name)
+                    .join(", ");
+                throw new AuthStrategyConfigError(`api-login: expected cookie "${check.cookie}" was not set by ${url.href} (status ${result.status}; jar: ${got || "(empty)"})`);
+            }
+        }
+        else if ("status" in check) {
+            if (result.status !== check.status) {
+                throw new AuthStrategyConfigError(`api-login: expected status ${check.status} from ${url.href}, got ${result.status}`);
+            }
+        }
+        else {
+            let parsed;
+            try {
+                parsed = JSON.parse(result.body);
+            }
+            catch {
+                throw new AuthStrategyConfigError(`api-login: success_check.json_path needs a JSON response, but ${result.url} (status ${result.status}) did not return valid JSON`);
+            }
+            const actual = getJsonPath(parsed, check.json_path);
+            if (JSON.stringify(actual) !== JSON.stringify(check.equals)) {
+                throw new AuthStrategyConfigError(`api-login: success_check json_path "${check.json_path}" is ${JSON.stringify(actual)}, expected ${JSON.stringify(check.equals)}`);
+            }
+        }
+        const storageState = result.jar.toStorageState();
+        const expiresAt = jarAuthExpiry(storageState, check && "cookie" in check ? check.cookie : undefined);
+        return { storageState, ...(expiresAt !== undefined ? { expiresAt } : {}) };
+    }
+}

package/dist/auth/browser-session.d.ts

@@ -0,0 +1,28 @@
+import { type StorageState } from "./types.js";
+export interface AuthPageOptions {
+    baseURL: string;
+    /** Accept self-signed / invalid TLS (the target's local dev cert). Default false. */
+    ignoreHTTPSErrors?: boolean;
+}
+export interface AuthPage {
+    /** Navigate (relative URLs resolve against the launch baseURL). */
+    goto(url: string): Promise<void>;
+    fill(selector: string, value: string): Promise<void>;
+    click(selector: string): Promise<void>;
+    /** Resolve when the selector is visible; reject on timeout. */
+    waitForSelector(selector: string, opts?: {
+        timeoutMs?: number;
+    }): Promise<void>;
+    /** Resolve when the page URL matches; reject on timeout. */
+    waitForUrl(pattern: RegExp, opts?: {
+        timeoutMs?: number;
+    }): Promise<void>;
+    /** Attach a CDP WebAuthn virtual authenticator (ctap2 / internal / user-verifying) to the page. */
+    enableVirtualAuthenticator(): Promise<void>;
+    /** Snapshot the context's storageState. */
+    storageState(): Promise<StorageState>;
+    close(): Promise<void>;
+}
+export type AuthPageLauncher = (opts: AuthPageOptions) => Promise<AuthPage>;
+/** Default launcher: a fresh headless Chromium context via the engine's Playwright session. */
+export declare const launchAuthPage: AuthPageLauncher;

package/dist/auth/browser-session.js

@@ -0,0 +1,43 @@
+// The narrow page surface browser-driving auth strategies (ui-form, email-otp, webauthn) need.
+//
+// Mirrors the `InstrumentedBrowser` pattern: strategies depend on this interface so unit tests
+// fake it; the Playwright-backed default launcher routes through `launchPlaywrightSession` —
+// `playwright-driver.ts` stays the engine's one Playwright import site.
+import { launchPlaywrightSession } from "../playwright-driver.js";
+/** Default launcher: a fresh headless Chromium context via the engine's Playwright session. */
+export const launchAuthPage = async (opts) => {
+    const session = await launchPlaywrightSession({
+        baseURL: opts.baseURL,
+        ...(opts.ignoreHTTPSErrors ? { ignoreHTTPSErrors: true } : {}),
+    });
+    return {
+        goto: async (url) => {
+            await session.page.goto(url);
+        },
+        fill: (selector, value) => session.page.fill(selector, value),
+        click: (selector) => session.page.click(selector),
+        waitForSelector: async (selector, o) => {
+            await session.page.waitForSelector(selector, {
+                state: "visible",
+                ...(o?.timeoutMs !== undefined ? { timeout: o.timeoutMs } : {}),
+            });
+        },
+        waitForUrl: (pattern, o) => session.page.waitForURL(pattern, o?.timeoutMs !== undefined ? { timeout: o.timeoutMs } : {}),
+        enableVirtualAuthenticator: async () => {
+            const cdp = await session.context.newCDPSession(session.page);
+            await cdp.send("WebAuthn.enable");
+            await cdp.send("WebAuthn.addVirtualAuthenticator", {
+                options: {
+                    protocol: "ctap2",
+                    transport: "internal",
+                    hasResidentKey: true,
+                    hasUserVerification: true,
+                    isUserVerified: true,
+                    automaticPresenceSimulation: true,
+                },
+            });
+        },
+        storageState: () => session.storageState(),
+        close: () => session.close(),
+    };
+};

package/dist/auth/cookie-jar.d.ts

@@ -0,0 +1,58 @@
+import { type StorageState, type StorageStateCookie } from "./types.js";
+/**
+ * Parse one `Set-Cookie` header into a {@link StorageStateCookie}.
+ * Domain defaults to the request host (host-only); a `Domain` attribute gets the conventional
+ * leading dot (subdomain-matching, mirroring Playwright's representation). `Max-Age` beats
+ * `Expires`; absent both, the cookie is a session cookie (`expires: -1`).
+ * Returns `null` for an unparsable header.
+ */
+export declare function parseSetCookie(header: string, requestUrl: URL, now?: number): StorageStateCookie | null;
+export declare class CookieJar {
+    private readonly store;
+    private key;
+    /** Store a cookie; an already-expired one (`Max-Age=0` deletion) removes the match instead. */
+    add(cookie: StorageStateCookie, now?: number): void;
+    /** Parse + store every `Set-Cookie` header from one response. */
+    addFromHeaders(setCookieHeaders: string[], requestUrl: URL, now?: number): void;
+    /** First stored cookie with this name, regardless of domain/path. */
+    get(name: string): StorageStateCookie | undefined;
+    has(name: string): boolean;
+    cookies(): StorageStateCookie[];
+    /** `Cookie:` header value for a request to `url` — domain/path/secure/expiry-matched. Empty string if none apply. */
+    cookieHeaderFor(url: URL, now?: number): string;
+    toStorageState(): StorageState;
+}
+export interface CollectingFetchInit {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+}
+export interface CollectingFetchResult {
+    jar: CookieJar;
+    /** Final (post-redirect) response status. */
+    status: number;
+    /** Final URL after redirects. */
+    url: string;
+    /** Final response body text. */
+    body: string;
+    /** Redirect hops followed. */
+    hops: number;
+}
+/**
+ * Fetch with `redirect: "manual"`, following up to `maxRedirects` hops (default 5) while
+ * collecting `Set-Cookie` headers into a {@link CookieJar} and replaying matching cookies on
+ * each hop. 303 — and 301/302 on a non-GET — switch the method to GET and drop the body,
+ * matching browser behaviour.
+ */
+export declare function fetchCollectingCookies(url: string | URL, init?: CollectingFetchInit, opts?: {
+    maxRedirects?: number;
+    jar?: CookieJar;
+    fetchImpl?: typeof fetch;
+    now?: () => number;
+}): Promise<CollectingFetchResult>;
+/**
+ * The expiry a login strategy can credibly report: the named cookie's expiry when the caller
+ * knows which cookie is the session, else — only when the jar has exactly one real-expiry
+ * cookie — that one. Ambiguous jars report `undefined` (the cache's `ttl` takes over).
+ */
+export declare function jarAuthExpiry(state: StorageState, preferredCookie?: string): number | undefined;