@sponson/sim 0.0.0-stage → 0.5.0

package/dist/routes/planetscale.js

@@ -0,0 +1,234 @@
+/**
+ * Simulated PlanetScale: organizations, databases, branches and branch passwords (Vitess / MySQL databases).
+ *
+ * Assumptions about the real API that this fake encodes, each marked with how far it is checked. "Verified" means
+ * against PlanetScale's published OpenAPI document (https://planetscale.com/docs/openapi.yaml, fetched 2026-10-11)
+ * or the documentation page cited; see docs/api-verification.md, section "PlanetScale". The ones a wrong guess
+ * would break are pinned in scenarios/contract.test.ts.
+ *   PS1. Authentication is `Authorization: <SERVICE_TOKEN_ID>:<SERVICE_TOKEN>`, no scheme word (verified:
+ *        https://planetscale.com/docs/api/reference/service-tokens). The sim answers 401 to any other form,
+ *        including `Bearer …`. The CLI's variable names, PLANETSCALE_SERVICE_TOKEN_ID and PLANETSCALE_SERVICE_TOKEN,
+ *        are the ones the adapter reads (verified: https://planetscale.com/docs/cli/service-tokens.md).
+ *   PS2. Every path is under `/organizations/{organization}/databases/{database}`, and branches are addressed by
+ *        name, not id: GET and DELETE `/branches/{branch}` (verified: path parameter "The name of the branch").
+ *   PS3. Lists (`list_branches`, `list_passwords`) are `{ data, next_page, … }`; the next page is `?page=<n>`
+ *        and `next_page` is null on the last page; `per_page` defaults to 25 (verified). The sim pages at 25, or
+ *        at chaos `page_size` when set.
+ *   PS4. POST `/branches` with `{ name, parent_branch }` answers 201 with the branch (verified), which is not
+ *        ready yet: `ready: false`, `state: "pending"` (fields and enum verified; that a new branch starts not
+ *        ready is verified only through the CLI's `--wait`, "Wait until the branch is ready",
+ *        https://planetscale.com/docs/cli/branch.md). How long it takes is unverified; the sim reports ready
+ *        from the first GET, or after chaos `planetscale_ready_ms`.
+ *   PS5. Creating a branch whose name exists answers 422 (unverified: the spec lists 401/403/404/422/429/500 and
+ *        no 409; the body's wording is unknown). The adapter re-reads the branch by name after any 409 or 422.
+ *   PS6. A parent branch that does not exist answers 404 here (unverified); the adapter checks the parent with
+ *        GET first, so the exact answer does not matter to it.
+ *   PS7. DELETE `/branches/{branch}` answers 204 (verified) and the branch is gone at once (unverified: needs a
+ *        live account). Deleting a branch deletes its passwords (unverified).
+ *   PS8. POST `/branches/{branch}/passwords` with `{ name, role }` answers 201 with `id`, `name`, `role`,
+ *        `username`, `access_host_url` and `plain_text` (verified). `plain_text` is null in every other response
+ *        (verified: "Null except in the response from the create endpoint"); the CLI docs say the password "is
+ *        shown once … and cannot be retrieved afterwards" (https://planetscale.com/docs/cli/password.md).
+ *   PS9. Password names are not unique (unverified: the spec calls `name` "Optional name of the password" and
+ *        documents no uniqueness). The sim accepts duplicates; the adapter refuses to guess between two.
+ *   PS10. A password's role cannot be changed in place: PATCH takes only `name` and `cidrs` (verified).
+ *   PS11. DELETE `/branches/{branch}/passwords/{id}` answers 204 (verified); a password that does not exist, 404.
+ *   PS12. Creating a password on a branch that is not ready yet is refused (unverified: the real behaviour is
+ *        unknown, so the sim takes the strict reading and answers 422); the adapter waits for `ready` first.
+ *   PS13. Error bodies are `{ code, message }` (unverified; not in the spec). The adapter never reads them.
+ *   PS14. Branch names: the sim accepts any non-empty name. Which characters the real API accepts is
+ *        unverified; the adapter's default name uses only lowercase letters, digits and dashes.
+ */
+import { Reply, route, router } from "../provider.js";
+/** The access host every simulated password hands out (the real API's `access_host_url`). */
+export const PLANETSCALE_SIM_HOST = "aws.connect.psdb.sim";
+/** The simulated PlanetScale API, registered in `PROVIDERS` (packages/sim/src/state.ts) and served under `/planetscale`. */
+export const planetscaleSim = {
+    env: { token: "PLANETSCALE_SERVICE_TOKEN", url: "PLANETSCALE_API_URL", testToken: "tok_planetscale", more: { PLANETSCALE_SERVICE_TOKEN_ID: "tokid_planetscale" } },
+    defaultSeed: { organizations: { acme: { app: [{ name: "main", production: true }] } } },
+    /** PS1: `Authorization: <id>:<token>`, no `Bearer`. */
+    authorized(headers) {
+        return /^[^\s:]+:\S+$/.test(headers.authorization ?? "");
+    },
+    reset(core, seed) {
+        const organizations = {};
+        for (const [org, dbs] of Object.entries(seed?.organizations ?? {})) {
+            const databases = {};
+            for (const [db, branches] of Object.entries(dbs)) {
+                const list = [];
+                for (const b of branches) {
+                    const branch = createPsBranch(core, list, b.name, b.parent ?? null, "sim", b.production === true);
+                    for (const pw of b.passwords ?? [])
+                        createPsPassword(core, branch, pw.name, pw.role ?? "admin", "sim");
+                }
+                databases[db] = { branches: list };
+            }
+            organizations[org] = { databases };
+        }
+        return { organizations };
+    },
+    /**
+     * `branch.<name>` or `password.<branch>.<name>` (or `planetscale:<organization>.…`): "delete", or "recreate"
+     * (same name, new id; a re-created password has a new plaintext) — what a human in the console would do.
+     */
+    drift(core, state, { key, rest, value, only }) {
+        const [kind, ...path] = rest.split(".");
+        if (kind !== "branch" && kind !== "password")
+            return false;
+        if (value !== "delete" && value !== "recreate")
+            throw new Error(`drift ${key}: only "delete" and "recreate" are supported`);
+        let hit = false;
+        for (const [org, o] of Object.entries(state.organizations)) {
+            if (only !== undefined && org !== only)
+                continue;
+            for (const d of Object.values(o.databases))
+                hit = (kind === "branch" ? driftBranch(core, d.branches, path.join("."), value) : driftPassword(core, d.branches, path, value)) || hit;
+        }
+        if (!hit)
+            throw new Error(`drift ${key}: nothing named ${path.join(".")}`);
+        return true;
+    },
+    routes(core, state, req) {
+        return routes(core, state, req);
+    },
+};
+function driftBranch(core, branches, name, value) {
+    const i = branches.findIndex((b) => b.name === name);
+    if (i < 0)
+        return false;
+    const [old] = branches.splice(i, 1);
+    if (value === "recreate")
+        createPsBranch(core, branches, old.name, old.parent_branch, "sim", old.production);
+    return true;
+}
+function driftPassword(core, branches, path, value) {
+    const [branchName, ...rest] = path;
+    const b = branches.find((x) => x.name === branchName);
+    const pw = b?.passwords.find((p) => p.name === rest.join("."));
+    if (!b || !pw)
+        return false;
+    b.passwords = b.passwords.filter((p) => p !== pw);
+    if (value === "recreate")
+        createPsPassword(core, b, pw.name, pw.role, "sim");
+    return true;
+}
+function dbOf(state, org, db) {
+    return state.organizations[org]?.databases[db];
+}
+const ROLES = new Set(["reader", "writer", "admin", "readwriter"]);
+/** One route per method and path; `:name` segments arrive URI-decoded in `params`. */
+const routes = router([
+    route("GET", "/organizations/:org/databases/:db/branches", ({ core, state, params, url }) => {
+        const d = dbOf(state, params.org, params.db);
+        return d ? listReply(core, d.branches.map(publicBranch), url) : notFound();
+    }),
+    route("POST", "/organizations/:org/databases/:db/branches", ({ core, state, params, body }) => {
+        const d = dbOf(state, params.org, params.db);
+        if (!d)
+            return notFound();
+        const b = (body ?? {});
+        if (typeof b.name !== "string" || b.name === "")
+            return unprocessable("Name can't be blank");
+        if (d.branches.some((x) => x.name === b.name))
+            return unprocessable("Name has already been taken"); // PS5
+        const parent = typeof b.parent_branch === "string" ? b.parent_branch : (d.branches.find((x) => x.production)?.name ?? null);
+        if (parent !== null && !d.branches.some((x) => x.name === parent))
+            return notFound(); // PS6
+        const branch = createPsBranch(core, d.branches, b.name, parent, "api", false);
+        branch.readyAt = Date.now() + core.chaos.planetscale_ready_ms;
+        // PS4: the create answer always reports a branch that is still being provisioned.
+        return new Reply(201, { ...publicBranch(branch), ready: false, state: "pending" });
+    }),
+    route("GET", "/organizations/:org/databases/:db/branches/:branch", ({ state, params }) => {
+        const b = dbOf(state, params.org, params.db)?.branches.find((x) => x.name === params.branch);
+        return b ? new Reply(200, publicBranch(b)) : notFound();
+    }),
+    route("DELETE", "/organizations/:org/databases/:db/branches/:branch", ({ state, params }) => {
+        const d = dbOf(state, params.org, params.db);
+        const b = d?.branches.find((x) => x.name === params.branch);
+        if (!d || !b)
+            return notFound();
+        if (b.production)
+            return unprocessable("Cannot delete a production branch");
+        d.branches.splice(d.branches.indexOf(b), 1); // PS7
+        return new Reply(204, undefined);
+    }),
+    route("GET", "/organizations/:org/databases/:db/branches/:branch/passwords", ({ core, state, params, url }) => {
+        const b = dbOf(state, params.org, params.db)?.branches.find((x) => x.name === params.branch);
+        return b ? listReply(core, b.passwords.map((p) => publicPassword(b, p)), url) : notFound();
+    }),
+    route("POST", "/organizations/:org/databases/:db/branches/:branch/passwords", ({ core, state, params, body }) => {
+        const b = dbOf(state, params.org, params.db)?.branches.find((x) => x.name === params.branch);
+        if (!b)
+            return notFound();
+        if (Date.now() < b.readyAt)
+            return unprocessable("Branch is not ready yet"); // PS12
+        const p = (body ?? {});
+        const role = p.role === undefined ? "admin" : p.role;
+        if (typeof role !== "string" || !ROLES.has(role))
+            return unprocessable("Role is not included in the list");
+        const pw = createPsPassword(core, b, typeof p.name === "string" ? p.name : "", role, "api");
+        return new Reply(201, { ...publicPassword(b, pw), plain_text: pw.plainText }); // PS8
+    }),
+    route("GET", "/organizations/:org/databases/:db/branches/:branch/passwords/:id", ({ state, params }) => {
+        const b = dbOf(state, params.org, params.db)?.branches.find((x) => x.name === params.branch);
+        const pw = b?.passwords.find((p) => p.id === params.id);
+        return b && pw ? new Reply(200, publicPassword(b, pw)) : notFound();
+    }),
+    route("DELETE", "/organizations/:org/databases/:db/branches/:branch/passwords/:id", ({ state, params }) => {
+        const b = dbOf(state, params.org, params.db)?.branches.find((x) => x.name === params.branch);
+        const pw = b?.passwords.find((p) => p.id === params.id);
+        if (!b || !pw)
+            return notFound(); // PS11
+        b.passwords = b.passwords.filter((p) => p !== pw);
+        return new Reply(204, undefined);
+    }),
+], () => notFound());
+/** PS3: page-numbered lists, 25 per page unless chaos `page_size` or `per_page` says otherwise. */
+function listReply(core, items, url) {
+    const perPage = core.chaos.page_size > 0 ? core.chaos.page_size : Number(url.searchParams.get("per_page") ?? 25) || 25;
+    const pageNo = Math.max(1, Number(url.searchParams.get("page") ?? 1) || 1);
+    const data = items.slice((pageNo - 1) * perPage, pageNo * perPage);
+    const last = pageNo * perPage >= items.length;
+    return new Reply(200, { type: "list", current_page: pageNo, per_page: perPage, next_page: last ? null : pageNo + 1, prev_page: pageNo > 1 ? pageNo - 1 : null, data });
+}
+/**
+ * Add a branch as PlanetScale would. Tests use it to seed "someone else's" branch. A seeded branch is ready at once.
+ */
+export function createPsBranch(core, branches, name, parent, createdBy, production) {
+    const branch = { id: core.nextId("psbr_"), name, parent_branch: parent, production, readyAt: 0, created_at: new Date().toISOString(), passwords: [], createdBy };
+    branches.push(branch);
+    return branch;
+}
+/** Add a password to a branch. Its plaintext starts `pscale_pw_`, like the real ones (PS8). */
+export function createPsPassword(core, branch, name, role, createdBy) {
+    const id = core.nextId("pspw_");
+    const pw = { id, name, role, username: `user_${id}`, plainText: `pscale_pw_sim_${id}`, createdAt: Date.now(), createdBy };
+    branch.passwords.push(pw);
+    return pw;
+}
+function publicBranch(b) {
+    const ready = Date.now() >= b.readyAt;
+    return { id: b.id, name: b.name, kind: "mysql", parent_branch: b.parent_branch, production: b.production, ready, state: ready ? "ready" : "pending", created_at: b.created_at, updated_at: b.created_at };
+}
+function publicPassword(b, p) {
+    return {
+        id: p.id,
+        name: p.name,
+        role: p.role,
+        username: p.username,
+        access_host_url: PLANETSCALE_SIM_HOST,
+        plain_text: null,
+        expired: false,
+        database_branch: { id: b.id, name: b.name, production: b.production },
+        created_at: new Date(p.createdAt).toISOString(),
+    };
+}
+/** PS13: `{ code, message }`. */
+function notFound() {
+    return new Reply(404, { code: "not_found", message: "Not Found" });
+}
+function unprocessable(message) {
+    return new Reply(422, { code: "unprocessable", message });
+}
+//# sourceMappingURL=planetscale.js.map

package/dist/routes/planetscale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"planetscale.js","sourceRoot":"","sources":["../../src/routes/planetscale.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAkD,MAAM,gBAAgB,CAAC;AAqCtG,6FAA6F;AAC7F,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAE3D,4HAA4H;AAC5H,MAAM,CAAC,MAAM,cAAc,GAAmD;IAC5E,GAAG,EAAE,EAAE,KAAK,EAAE,2BAA2B,EAAE,GAAG,EAAE,qBAAqB,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,EAAE;IAClK,WAAW,EAAE,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;IAEvF,uDAAuD;IACvD,UAAU,CAAC,OAAO;QAChB,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,IAAI,EAAE,IAAI;QACd,MAAM,aAAa,GAAsC,EAAE,CAAC;QAC5D,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,IAAI,EAAE,CAAC,EAAE,CAAC;YACnE,MAAM,SAAS,GAA2D,EAAE,CAAC;YAC7E,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,GAAwB,EAAE,CAAC;gBACrC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;oBACzB,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;oBAClG,KAAK,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,IAAI,EAAE;wBAAE,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,OAAO,EAAE,KAAK,CAAC,CAAC;gBACzG,CAAC;gBACD,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YACrC,CAAC;YACD,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,aAAa,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;QAC3C,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAC3D,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,GAAG,8CAA8C,CAAC,CAAC;QAC5H,IAAI,GAAG,GAAG,KAAK,CAAC;QAChB,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3D,IAAI,IAAI,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;gBAAE,SAAS;YACjD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;gBAAE,GAAG,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;QACrL,CAAC;QACD,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,GAAG,mBAAmB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG;QACrB,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;CACF,CAAC;AAEF,SAAS,WAAW,CAAC,IAAa,EAAE,QAA6B,EAAE,IAAY,EAAE,KAAa;IAC5F,MAAM,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACxB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,IAAI,KAAK,KAAK,UAAU;QAAE,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAI,CAAC,IAAI,EAAE,GAAI,CAAC,aAAa,EAAE,KAAK,EAAE,GAAI,CAAC,UAAU,CAAC,CAAC;IAChH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,IAAa,EAAE,QAA6B,EAAE,IAAc,EAAE,KAAa;IAChG,MAAM,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACnC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACtD,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5B,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAClD,IAAI,KAAK,KAAK,UAAU;QAAE,gBAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7E,OAAO,IAAI,CAAC;AACd,CAAC;AAID,SAAS,IAAI,CAAC,KAAuB,EAAE,GAAW,EAAE,EAAU;IAC5D,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;AAEnE,sFAAsF;AACtF,MAAM,MAAM,GAAG,MAAM,CACnB;IACE,KAAK,CAAC,KAAK,EAAE,4CAA4C,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE;QAC1F,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC7E,CAAC,CAAC;IAEF,KAAK,CAAC,MAAM,EAAE,4CAA4C,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC5F,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;YAAE,OAAO,QAAQ,EAAE,CAAC;QAC1B,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAgD,CAAC;QACtE,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,EAAE;YAAE,OAAO,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC7F,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC;YAAE,OAAO,aAAa,CAAC,6BAA6B,CAAC,CAAC,CAAC,MAAM;QAC1G,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC;QAC5H,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;YAAE,OAAO,QAAQ,EAAE,CAAC,CAAC,MAAM;QAC5F,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9E,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC;QAC9D,kFAAkF;QAClF,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACrF,CAAC,CAAC;IAEF,KAAK,CAAC,KAAK,EAAE,oDAAoD,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QACvF,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7F,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1D,CAAC,CAAC;IAEF,KAAK,CAAC,QAAQ,EAAE,oDAAoD,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QAC1F,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;YAAE,OAAO,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,CAAC,UAAU;YAAE,OAAO,aAAa,CAAC,mCAAmC,CAAC,CAAC;QAC5E,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM;QACnD,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,KAAK,CAAC,KAAK,EAAE,8DAA8D,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE;QAC5G,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7F,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC7F,CAAC,CAAC;IAEF,KAAK,CAAC,MAAM,EAAE,8DAA8D,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC9G,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7F,IAAI,CAAC,CAAC;YAAE,OAAO,QAAQ,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO;YAAE,OAAO,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO;QACpF,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAuC,CAAC;QAC7D,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACrD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,aAAa,CAAC,kCAAkC,CAAC,CAAC;QAC3G,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5F,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM;IACvF,CAAC,CAAC;IAEF,KAAK,CAAC,KAAK,EAAE,kEAAkE,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QACrG,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7F,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtE,CAAC,CAAC;IAEF,KAAK,CAAC,QAAQ,EAAE,kEAAkE,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QACxG,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7F,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE;YAAE,OAAO,QAAQ,EAAE,CAAC,CAAC,OAAO;QACzC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC,CAAC;CACH,EACD,GAAG,EAAE,CAAC,QAAQ,EAAE,CACjB,CAAC;AAEF,mGAAmG;AACnG,SAAS,SAAS,CAAC,IAAa,EAAE,KAAgB,EAAE,GAAQ;IAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;IACvH,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC;IAC9C,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AACzK,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,QAA6B,EAAE,IAAY,EAAE,MAAqB,EAAE,SAAoB,EAAE,UAAmB;IACzJ,MAAM,MAAM,GAAsB,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;IACpL,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,gBAAgB,CAAC,IAAa,EAAE,MAAyB,EAAE,IAAY,EAAE,IAAY,EAAE,SAAoB;IACzH,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,EAAE,GAAwB,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC;IAC/I,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,YAAY,CAAC,CAAoB;IACxC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC;IACtC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;AAC5M,CAAC;AAED,SAAS,cAAc,CAAC,CAAoB,EAAE,CAAsB;IAClE,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,eAAe,EAAE,oBAAoB;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE;QACrE,UAAU,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE;KAChD,CAAC;AACJ,CAAC;AAED,iCAAiC;AACjC,SAAS,QAAQ;IACf,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC;AAC5D,CAAC"}

package/dist/routes/railway.d.ts

@@ -0,0 +1,24 @@
+import { type ProviderSim } from "../provider.js";
+/** One environment: its project and name (a PR environment is named after the pull request). */
+export interface RailwayEnvironment {
+    projectId: string;
+    name: string;
+}
+/** Simulated Railway state: environments, and variables by `<environmentId>/<serviceId or "">`. */
+export interface RailwayState {
+    environments: Record<string, RailwayEnvironment>;
+    variables: Record<string, Record<string, string>>;
+}
+/** Initial Railway state. */
+export interface RailwaySeed {
+    environments?: Record<string, RailwayEnvironment>;
+    variables?: Record<string, Record<string, string>>;
+}
+/** The project and PR environment of the default seed. */
+export declare const RAILWAY_DEMO: {
+    readonly projectId: "prj-railway-demo";
+    readonly environmentId: "env-pr-42";
+    readonly serviceId: "svc-web";
+};
+/** Simulated Railway GraphQL API; see the assumptions at the top of this file. */
+export declare const railwaySim: ProviderSim<RailwayState, RailwaySeed>;

package/dist/routes/railway.js

@@ -0,0 +1,112 @@
+/**
+ * Simulated Railway public GraphQL API (`POST https://backboard.railway.com/graphql/v2`), the subset that sets the
+ * variables of a service in an environment (a pull-request environment Railway created): enough to test the generic
+ * `http` adapter's GraphQL requests against Railway's real operation shapes.
+ *
+ * Assumptions (docs/api-verification.md, "Railway and Fly.io through the generic adapter"):
+ *   RW1. One endpoint; `Authorization: Bearer <account or workspace token>` (a project token goes in
+ *        `Project-Access-Token`). Verified: docs.railway.com/reference/public-api.
+ *   RW2. Failures are HTTP 200 with `errors[]` (`message`, `extensions.code`); a refused token is
+ *        `INTERNAL_SERVER_ERROR` "Not Authorized". Verified: same page ("Always inspect the errors array").
+ *   RW3. `variables(projectId: String!, environmentId: String!, serviceId: String, unrendered: Boolean)` answers the
+ *        `EnvironmentVariables` scalar, a flat map of name → string; without `serviceId`, the shared variables.
+ *        Verified: railwayapp/cli src/gql/schema.json.
+ *   RW4. `variableUpsert(input: VariableUpsertInput!): Boolean!` (projectId, environmentId, serviceId?, name, value,
+ *        skipDeploys?) creates or replaces one variable; `variableDelete(input: VariableDeleteInput!): Boolean!`
+ *        (projectId, environmentId, name, serviceId?) removes it. Verified: same schema. Deleting a variable that
+ *        does not exist answers `true` here: unverified (the adapter treats "not found" as gone either way).
+ *   RW5. An unknown project or environment is an error "Environment not found". Unverified wording.
+ */
+import { graphqlData, graphqlError, graphqlOperation, isMutation } from "../graphql.js";
+import { Reply, route, router } from "../provider.js";
+/** The project and PR environment of the default seed. */
+export const RAILWAY_DEMO = { projectId: "prj-railway-demo", environmentId: "env-pr-42", serviceId: "svc-web" };
+/** Simulated Railway GraphQL API; see the assumptions at the top of this file. */
+export const railwaySim = {
+    env: { token: "RAILWAY_TOKEN", url: "RAILWAY_API_URL", testToken: "tok_railway" },
+    defaultSeed: { environments: { [RAILWAY_DEMO.environmentId]: { projectId: RAILWAY_DEMO.projectId, name: "pr-42" } } },
+    reset(_core, seed) {
+        return { environments: structuredClone(seed?.environments ?? {}), variables: structuredClone(seed?.variables ?? {}) };
+    },
+    /** `vars.<environmentId>.<serviceId or "shared">.<NAME>`: a new value, or "delete". */
+    drift(_core, state, { key, rest, value, only }) {
+        if (only !== undefined)
+            return false;
+        const [kind, env, service, name] = rest.split(".");
+        if (kind !== "vars" || !env || !service || !name)
+            return false;
+        const k = `${env}/${service === "shared" ? "" : service}`;
+        const vars = (state.variables[k] ??= {});
+        if (value === "delete") {
+            if (!(name in vars))
+                throw new Error(`drift ${key}: no variable ${name}`);
+            delete vars[name];
+        }
+        else
+            vars[name] = value;
+        return true;
+    },
+    isWrite(req) {
+        return isMutation(req.body);
+    },
+    routes(core, state, req) {
+        return routes(core, state, req);
+    },
+};
+function str(v) {
+    return typeof v === "string" && v !== "" ? v : undefined;
+}
+/** The variable map a request addresses (RW3, RW5). */
+function scopeOf(state, a) {
+    const projectId = str(a.projectId);
+    const environmentId = str(a.environmentId);
+    if (!projectId || !environmentId)
+        return graphqlError("projectId and environmentId are required", "BAD_USER_INPUT", 400);
+    const env = state.environments[environmentId];
+    if (!env || env.projectId !== projectId)
+        return graphqlError("Environment not found", "NOT_FOUND");
+    return { key: `${environmentId}/${str(a.serviceId) ?? ""}` };
+}
+function input(v) {
+    return typeof v.input === "object" && v.input !== null ? v.input : {};
+}
+const RESOLVERS = {
+    variables(state, v) {
+        const scope = scopeOf(state, v);
+        if (scope instanceof Reply)
+            return scope;
+        return graphqlData({ variables: { ...(state.variables[scope.key] ?? {}) } });
+    },
+    variableUpsert(state, v) {
+        const i = input(v);
+        const scope = scopeOf(state, i);
+        if (scope instanceof Reply)
+            return scope;
+        const name = str(i.name);
+        if (!name || typeof i.value !== "string")
+            return graphqlError("name and value are required", "BAD_USER_INPUT", 400);
+        (state.variables[scope.key] ??= {})[name] = i.value;
+        return graphqlData({ variableUpsert: true });
+    },
+    variableDelete(state, v) {
+        const i = input(v);
+        const scope = scopeOf(state, i);
+        if (scope instanceof Reply)
+            return scope;
+        const name = str(i.name);
+        if (!name)
+            return graphqlError("name is required", "BAD_USER_INPUT", 400);
+        delete state.variables[scope.key]?.[name];
+        return graphqlData({ variableDelete: true });
+    },
+};
+const routes = router([
+    route("POST", "/", ({ state, body }) => {
+        const op = graphqlOperation(body);
+        if (op instanceof Reply)
+            return op;
+        const resolve = RESOLVERS[op.root];
+        return resolve ? resolve(state, op.variables) : graphqlError(`Cannot query field "${op.root}" (not simulated)`, "GRAPHQL_VALIDATION_FAILED", 400);
+    }),
+], () => new Reply(404, { error: "not found" }));
+//# sourceMappingURL=railway.js.map

package/dist/routes/railway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"railway.js","sourceRoot":"","sources":["../../src/routes/railway.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAoB,MAAM,gBAAgB,CAAC;AAoBxE,0DAA0D;AAC1D,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,kBAAkB,EAAE,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAW,CAAC;AAEzH,kFAAkF;AAClF,MAAM,CAAC,MAAM,UAAU,GAA2C;IAChE,GAAG,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE;IACjF,WAAW,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;IAErH,KAAK,CAAC,KAAK,EAAE,IAAI;QACf,OAAO,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,EAAE,YAAY,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,eAAe,CAAC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;IACxH,CAAC;IAED,uFAAuF;IACvF,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;QAC5C,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACrC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,IAAI,KAAK,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QAC/D,MAAM,CAAC,GAAG,GAAG,GAAG,IAAI,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvB,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,SAAS,GAAG,iBAAiB,IAAI,EAAE,CAAC,CAAC;YAC1E,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;;YAAM,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,GAAG;QACT,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG;QACrB,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;CACF,CAAC;AAEF,SAAS,GAAG,CAAC,CAAU;IACrB,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAID,uDAAuD;AACvD,SAAS,OAAO,CAAC,KAAmB,EAAE,CAA0B;IAC9D,MAAM,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAC3C,IAAI,CAAC,SAAS,IAAI,CAAC,aAAa;QAAE,OAAO,YAAY,CAAC,0CAA0C,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC;IACzH,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAC9C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC,uBAAuB,EAAE,WAAW,CAAC,CAAC;IACnG,OAAO,EAAE,GAAG,EAAE,GAAG,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,KAAK,CAAC,CAA0B;IACvC,OAAO,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,KAAiC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrG,CAAC;AAED,MAAM,SAAS,GAAuF;IACpG,SAAS,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChC,IAAI,KAAK,YAAY,KAAK;YAAE,OAAO,KAAK,CAAC;QACzC,OAAO,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/E,CAAC;IACD,cAAc,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChC,IAAI,KAAK,YAAY,KAAK;YAAE,OAAO,KAAK,CAAC;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO,YAAY,CAAC,6BAA6B,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACpH,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;QACpD,OAAO,WAAW,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IACD,cAAc,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChC,IAAI,KAAK,YAAY,KAAK;YAAE,OAAO,KAAK,CAAC;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI;YAAE,OAAO,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC;QAC1E,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,WAAW,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,GAAG,MAAM,CACnB;IACE,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QACrC,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,EAAE,YAAY,KAAK;YAAE,OAAO,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,CAAC,IAAI,mBAAmB,EAAE,2BAA2B,EAAE,GAAG,CAAC,CAAC;IACpJ,CAAC,CAAC;CACH,EACD,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAC7C,CAAC"}

package/dist/routes/rest.d.ts

@@ -0,0 +1,138 @@
+import { type DigestConfig, type IssuedToken, type SigV4Config } from "../auth.js";
+import { type ProviderSim } from "../provider.js";
+/** One object of a collection, as stored and answered: its id (under the style's id field) and every field a client wrote. */
+export type RestItem = Record<string, unknown>;
+/**
+ * How one collection answers (assumption R2). Every member is optional; the defaults are the conventional shape:
+ * `{ data: <object> }`, `{ data: [...], next_cursor }`, string ids under `id`.
+ */
+export interface RestStyle {
+    /** JSON pointer where a list answer holds the array. Default `/data`; `""` answers the bare array. */
+    list_path?: string;
+    /** JSON pointer where a single-object answer holds the object. Default `/data`; `""` answers it bare. */
+    item_path?: string;
+    /** JSON pointer of the next page's cursor in a list answer. Default `/next_cursor`; null: no cursor and no paging. */
+    next_path?: string | null;
+    /** The field holding the id. Default `id`. */
+    id_field?: string;
+    /** The body field a create may choose the id with. Default: the id field. */
+    id_from?: string;
+    /** Assign integer ids instead of `it_<n>`. */
+    numeric_ids?: boolean;
+    /** Read form-encoded `true`/`false` and numbers as booleans and numbers (assumption R4). */
+    form_types?: boolean;
+    /** Fields generated on create and shown only in its answer (assumption R6). */
+    once_fields?: string[];
+    /** A query parameter that names an object of the collection by id (`url`), assumption R3. */
+    item_query?: string;
+    /** For an object: top-level fields a write names otherwise than a read, written name → stored name (R2). */
+    write_fields?: Record<string, string>;
+    /**
+     * Request headers (lower-case names) whose values a create or update stores as fields, for an API that takes an
+     * object's settings in headers (QStash: `upstash-cron` → `cron`, `upstash-schedule-id` → `scheduleId`).
+     */
+    header_fields?: Record<string, string>;
+    /**
+     * A POST to `<collection>/<suffix>` creates the object with the suffix (a URL, kept as written) in this field, or
+     * updates the one whose id the request chooses (an upsert): QStash's `POST /v2/schedules/<destination>`.
+     */
+    suffix_field?: string;
+    /** Fields (JSON pointers, `/ApiTokens/0`) generated on create and stored (assumption R10). */
+    generated?: string[];
+}
+/** A path whose POST deletes objects its body names (assumption R11): the collection, and where the ids are. */
+export interface RestBulkDelete {
+    collection: string;
+    /** JSON pointer to the id, or to a list of ids, in the body. */
+    ids: string;
+}
+/** A one-off action's endpoint (assumption R9): a fixed answer to every method, and whether it needs a credential. */
+export interface RestEndpoint {
+    /** Default 200. */
+    status?: number;
+    /** Default `{}`. */
+    reply?: unknown;
+    /** Answers without a credential (an app's own endpoint). */
+    public?: boolean;
+}
+/** One call to a seeded endpoint (R9), as received. */
+export interface RestCall {
+    method: string;
+    path: string;
+    /** Lower-case names. */
+    headers: Record<string, string>;
+    body: unknown;
+}
+/** Simulated REST API state, by path: collections of objects, objects that are not in a collection, and styles. */
+export interface RestState {
+    collections: Record<string, RestItem[]>;
+    objects: Record<string, Record<string, unknown>>;
+    styles: Record<string, RestStyle>;
+    /** Paths whose POST deletes the objects its body names (R11). */
+    deletes: Record<string, RestBulkDelete>;
+    /** Every value generated for a style's `generated` fields (R10). */
+    generated: string[];
+    /** Paths that name a collection kept under another path, by path: a create posted elsewhere
+     * (`/gates/g/rule` adds to `/gates/g/rules`), or a list at another URL (`/settings/all` lists `/settings`). */
+    aliases: Record<string, string>;
+    /** Further header names (lower-case) that carry a credential (assumption R1). */
+    auth_headers: string[];
+    /** Paths read with a POST, by path: the object each answers (assumption R8). */
+    reads: Record<string, string>;
+    /** Present when the seed configures real credentials (R7). */
+    auth?: RestAuthState;
+    /** One-off action endpoints by path (R9), and every call they received. */
+    endpoints: Record<string, RestEndpoint>;
+    calls: RestCall[];
+}
+/**
+ * Real credentials for the REST sim (R7). Each key enables one scheme; with none of them, R1 applies (any
+ * non-empty credential).
+ */
+export interface RestAuthSeed {
+    /** OAuth2 clients the token endpoint accepts: client id → client secret. */
+    clients?: Record<string, string>;
+    /** Lifetime of the tokens it issues, in seconds (default 3600). */
+    token_ttl?: number;
+    /** Bearer tokens accepted as they are (the token a CLI such as `gcloud auth print-access-token` prints). */
+    tokens?: string[];
+    /**
+     * Accepted sets of header values (lower-case name → exact value), each complete on its own: a key behind a scheme
+     * prefix (`Api-Key <key>`), or an API key together with an application key.
+     */
+    headers?: Array<Record<string, string>>;
+    /** Digest users (name → password), the algorithm (`MD5` by default) and the realm. */
+    digest?: DigestConfig;
+    /** SigV4 access keys (id → secret) and the region and service requests must be signed for. */
+    sigv4?: Omit<SigV4Config, "now">;
+    /** A header (lower-case) accepted when it carries a value the sim generated (R10): another object's token. */
+    generated_header?: string;
+}
+/** The REST sim's credential state: what was seeded, every token issued and every Digest nonce handed out. */
+export interface RestAuthState extends RestAuthSeed {
+    issued: IssuedToken[];
+    nonces: string[];
+    /** Requests answered 401, for assertions ("the expired token was refused once"). */
+    refused: number;
+}
+/** Initial REST state, by path: objects per collection (ids assigned when absent), stand-alone objects, styles. */
+export interface RestSeed {
+    collections?: Record<string, Array<Record<string, unknown>>>;
+    objects?: Record<string, Record<string, unknown>>;
+    /** How each collection answers, by collection path (assumption R2). */
+    styles?: Record<string, RestStyle>;
+    /** Paths that name a collection kept under another path, by path: `{ "/gates/g/rule": "/gates/g/rules" }`. */
+    aliases?: Record<string, string>;
+    /** Further header names that carry a credential, for an API whose header is not named `*-Key` or `*-Token`. */
+    auth_headers?: string[];
+    /** Paths read with a POST (an ARM list action), by path: the object each answers (assumption R8). */
+    reads?: Record<string, string>;
+    /** Real credentials (R7). */
+    auth?: RestAuthSeed;
+    /** One-off action endpoints by path (R9). */
+    endpoints?: Record<string, RestEndpoint>;
+    /** Paths whose POST deletes the objects its body names (R11), by path. */
+    deletes?: Record<string, RestBulkDelete>;
+}
+/** Simulated generic REST API; see the assumptions at the top of this file. */
+export declare const restSim: ProviderSim<RestState, RestSeed>;