primitive-admin 1.2.0-alpha.6 → 1.2.0-alpha.7

package/dist/src/lib/vars-override.js

@@ -0,0 +1,143 @@
+/**
+ * A child app's own config var values: `vars.<name>.override.toml` (#4485).
+ *
+ * A machine-local environment `<name>` (#4117) shares the committed
+ * environment's `primitive/<tree>/`, so the `vars.toml` there holds the
+ * parent's values. Vars whose value belongs to one app — its database ids, a
+ * webhook URL embedding its app id, an OAuth origin — need a place of their
+ * own that survives a push, a diff and a pull without touching what merges to
+ * main. That place is `primitive/<tree>/vars.<name>.override.toml`, a flat
+ * `KEY = "value"` table under the same rules as `vars.toml`:
+ *
+ * - It is read only when `<name>` is the SELECTED environment. A committed
+ *   environment has no override, so a file named for one is never read.
+ * - It LAYERS over `vars.toml`: its keys replace or add, every other key keeps
+ *   `vars.toml`'s value, and no key can be made absent on the child.
+ * - It is machine-local and git-ignored (`primitive/*\/*.override.toml`).
+ *
+ * Everything here is pure apart from `readLocalVars`, which reads the two
+ * files; the commands own the writes.
+ */
+import { existsSync, readFileSync } from "fs";
+import { basename, join } from "path";
+import { parseConfigToml, stringifyConfigToml } from "./config-toml.js";
+import { assertSafePathComponent } from "./sync-paths.js";
+/** The tree's shared var file. */
+export const VARS_FILE_NAME = "vars.toml";
+/**
+ * The gitignore pattern that keeps every override file out of a commit,
+ * written by `primitive init` and carried by both app templates.
+ */
+export const VARS_OVERRIDE_GITIGNORE_PATTERN = "primitive/*/*.override.toml";
+/** `vars.<name>.override.toml` — the override file's name inside the tree. */
+export function varsOverrideFileName(name) {
+    assertSafePathComponent(name, "environment name");
+    return `vars.${name}.override.toml`;
+}
+/**
+ * The override file for `env` in the tree `configDir`, or `null` for a
+ * committed environment, which never has one. Refuses a name that is not a
+ * safe path component.
+ */
+export function varsOverridePath(configDir, env) {
+    if (!env.local)
+        return null;
+    return join(configDir, varsOverrideFileName(env.name));
+}
+/**
+ * `base` with `override`'s keys replacing or adding to it. Either side may be
+ * absent; the result is a new table.
+ */
+export function layerVars(base, override) {
+    return { ...(base ?? {}), ...(override ?? {}) };
+}
+function readVarTable(path) {
+    if (!existsSync(path))
+        return null;
+    try {
+        return parseConfigToml(readFileSync(path, "utf-8"));
+    }
+    catch (err) {
+        throw new Error(`${basename(path)}: ${err?.message || String(err)}`);
+    }
+}
+/**
+ * Reads `vars.toml` in `configDir` and the override at `overridePath`, and
+ * layers them. A file that cannot be parsed throws an error naming it.
+ */
+export function readLocalVars(configDir, overridePath) {
+    const basePath = join(configDir, VARS_FILE_NAME);
+    const base = readVarTable(basePath);
+    const override = overridePath ? readVarTable(overridePath) : null;
+    const overrideKeys = Object.keys(override ?? {}).sort();
+    return {
+        basePath,
+        base,
+        overridePath,
+        override,
+        layered: layerVars(base, override),
+        overridingKeys: overrideKeys.filter((key) => base !== null && key in base),
+        addedKeys: overrideKeys.filter((key) => base === null || !(key in base)),
+    };
+}
+/**
+ * The override file's body: a header saying what the file is, then the keys
+ * sorted. An empty table is a comment-only file.
+ */
+export function serializeVarsOverride(vars, target) {
+    const sorted = {};
+    for (const key of Object.keys(vars).sort())
+        sorted[key] = vars[key];
+    const header = `# Config var values for the machine-local environment "${target.name}" only.\n` +
+        `# Layered over primitive/${target.tree}/${VARS_FILE_NAME} when "${target.name}" is\n` +
+        "# selected: a key here replaces or adds to that file's value. Machine-local —\n" +
+        "# never commit this file. Non-secret values only; use `primitive secrets`\n" +
+        "# for credentials.\n\n";
+    return header + stringifyConfigToml(sorted);
+}
+/**
+ * What `config pull` on a machine-local environment writes into its override
+ * file. `vars.toml` is never written by such a pull, so each pulled key —
+ * every key on the server or in the override, or only `selectedKeys` — is
+ * resolved against it: a server value equal to `vars.toml`'s is dropped from
+ * the override, any other server value is held there, and a key the server no
+ * longer has is removed. Keys outside the selection stay as they are.
+ */
+export function planVarsOverridePull(serverVars, baseVars, selectedKeys, currentOverride, target) {
+    const server = new Map(serverVars.map((v) => [v.key, String(v.value ?? "")]));
+    const vars = {};
+    for (const [key, value] of Object.entries(currentOverride))
+        vars[key] = String(value);
+    const pulled = selectedKeys ?? new Set([...server.keys(), ...Object.keys(currentOverride)]);
+    for (const key of pulled) {
+        const value = server.get(key);
+        if (value === undefined || (key in baseVars && String(baseVars[key]) === value)) {
+            delete vars[key];
+        }
+        else {
+            vars[key] = value;
+        }
+    }
+    return { vars, content: serializeVarsOverride(vars, target) };
+}
+/** The one line push, diff and pull print when an override is in play. */
+export function varsOverrideSummaryLine(fileName, keys) {
+    return (`Vars override: ${fileName} (${keys.overridingKeys.length} overriding ${VARS_FILE_NAME}, ` +
+        `${keys.addedKeys.length} added)`);
+}
+/**
+ * The note a push on a child with an override prints when it changed the
+ * value of a var that already existed and left at least one function as it
+ * was. Functions read vars through a cache keyed by function version, so an
+ * unchanged function keeps the value it first read until a new version of it
+ * is pushed or its isolate is recycled. `null` when neither applies.
+ */
+export function cachedVarsNote(changedKeys, skippedFunctionCount) {
+    if (changedKeys.length === 0 || skippedFunctionCount === 0)
+        return null;
+    const keys = [...changedKeys].sort().join(", ");
+    return (`Note: changed var value(s) ${keys}; ${skippedFunctionCount} unchanged function(s) were not re-pushed. ` +
+        "A running function version caches the vars it has read, so it keeps the old value " +
+        "until a new version of it is pushed (any change to its code or TOML) or its isolate recycles.");
+}
+//# sourceMappingURL=vars-override.js.map

package/dist/src/lib/vars-override.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vars-override.js","sourceRoot":"","sources":["../../../src/lib/vars-override.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAE1D,kCAAkC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,6BAA6B,CAAC;AAK7E,8EAA8E;AAC9E,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,uBAAuB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IAClD,OAAO,QAAQ,IAAI,gBAAgB,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,SAAiB,EACjB,GAAqC;IAErC,IAAI,CAAC,GAAG,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAC5B,OAAO,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CACvB,IAAoC,EACpC,QAAwC;IAExC,OAAO,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;AAClD,CAAC;AAmBD,SAAS,YAAY,CAAC,IAAY;IAChC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAA4B,CAAC;IACjF,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB,EAAE,YAA2B;IAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACxD,OAAO;QACL,QAAQ;QACR,IAAI;QACJ,YAAY;QACZ,QAAQ;QACR,OAAO,EAAE,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC;QAClC,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,IAAI,IAAI,CAAC;QAC1E,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;KACzE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAAc,EACd,MAAsC;IAEtC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;QAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACpE,MAAM,MAAM,GACV,0DAA0D,MAAM,CAAC,IAAI,WAAW;QAChF,4BAA4B,MAAM,CAAC,IAAI,IAAI,cAAc,UAAU,MAAM,CAAC,IAAI,QAAQ;QACtF,iFAAiF;QACjF,6EAA6E;QAC7E,wBAAwB,CAAC;IAC3B,OAAO,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA0D,EAC1D,QAAiC,EACjC,YAAwC,EACxC,eAAwC,EACxC,MAAsC;IAEtC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;QAAE,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACtF,MAAM,MAAM,GAAG,YAAY,IAAI,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5F,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,GAAG,IAAI,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YAChF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;AAChE,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,uBAAuB,CACrC,QAAgB,EAChB,IAAyE;IAEzE,OAAO,CACL,kBAAkB,QAAQ,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,eAAe,cAAc,IAAI;QAC1F,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,SAAS,CAClC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,WAA8B,EAC9B,oBAA4B;IAE5B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,oBAAoB,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACxE,MAAM,IAAI,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,OAAO,CACL,8BAA8B,IAAI,KAAK,oBAAoB,6CAA6C;QACxG,oFAAoF;QACpF,+FAA+F,CAChG,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "primitive-admin",
-  "version": "1.2.0-alpha.6",
+  "version": "1.2.0-alpha.7",
   "description": "CLI for administering Primitive applications",
   "type": "module",
   "bin": {
@@ -58,7 +58,7 @@
     "commander": "^12.1.0",
     "esbuild": "0.25.12",
     "inquirer": "^9.2.12",
-    "js-bao": "0.12.0-alpha.6",
+    "js-bao": "0.12.0-alpha.7",
     "mime-types": "^2.1.35",
     "open": "^10.0.3",
     "smol-toml": "1.7.0",

package/dist/src/lib/generated-workflow-model-fields.d.ts

@@ -1,20 +0,0 @@
-/**
- * GENERATED FILE — DO NOT EDIT BY HAND.
- *
- * Source of truth: the `WorkflowDefinition` model in the repo-root
- * `models.yaml` — the one statically-parseable server anchor for the
- * `[workflow]`-level config surface (issue #2326, Phase 1 of #1976).
- *
- * Regenerate with:
- *   node cli/scripts/gen-workflow-fields.mjs   (runs automatically at CLI prebuild)
- *
- * A CI freshness guard (`cli/scripts/gen-workflow-fields.mjs --check`, also
- * asserted by `cli/tests/unit/workflow-field-descriptor-drift-guard.test.ts`)
- * fails if this committed artifact does not match a fresh parse of
- * `models.yaml`. The same test asserts every field below is classified in
- * `cli/src/lib/workflow-field-descriptor.ts` as synced, structural, or
- * internal — so a new server-side workflow field cannot be silently ignored by
- * the CLI.
- */
-/** Every `WorkflowDefinition` field, in `models.yaml` declaration order (#2326). */
-export declare const GENERATED_WORKFLOW_MODEL_FIELDS: readonly string[];

package/dist/src/lib/generated-workflow-model-fields.js

@@ -1,53 +0,0 @@
-/**
- * GENERATED FILE — DO NOT EDIT BY HAND.
- *
- * Source of truth: the `WorkflowDefinition` model in the repo-root
- * `models.yaml` — the one statically-parseable server anchor for the
- * `[workflow]`-level config surface (issue #2326, Phase 1 of #1976).
- *
- * Regenerate with:
- *   node cli/scripts/gen-workflow-fields.mjs   (runs automatically at CLI prebuild)
- *
- * A CI freshness guard (`cli/scripts/gen-workflow-fields.mjs --check`, also
- * asserted by `cli/tests/unit/workflow-field-descriptor-drift-guard.test.ts`)
- * fails if this committed artifact does not match a fresh parse of
- * `models.yaml`. The same test asserts every field below is classified in
- * `cli/src/lib/workflow-field-descriptor.ts` as synced, structural, or
- * internal — so a new server-side workflow field cannot be silently ignored by
- * the CLI.
- */
-/** Every `WorkflowDefinition` field, in `models.yaml` declaration order (#2326). */
-export const GENERATED_WORKFLOW_MODEL_FIELDS = [
-    "workflowId",
-    "appId",
-    "workflowKey",
-    "name",
-    "status",
-    "latestRevision",
-    "description",
-    "stepsR2Key",
-    "draftStepsR2Key",
-    "draftInputSchema",
-    "draftOutputSchema",
-    "draftModifiedAt",
-    "activeConfigId",
-    "inputSchema",
-    "outputSchema",
-    "perUserMaxRunning",
-    "perUserMaxQueued",
-    "perAppMaxRunning",
-    "perAppMaxQueued",
-    "queueTtlSeconds",
-    "dequeueOrder",
-    "requiresClientApply",
-    "syncCallable",
-    "accessRule",
-    "metadataManifest",
-    "runAs",
-    "lock",
-    "capabilities",
-    "createdBy",
-    "createdAt",
-    "modifiedAt",
-];
-//# sourceMappingURL=generated-workflow-model-fields.js.map

package/dist/src/lib/generated-workflow-model-fields.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generated-workflow-model-fields.js","sourceRoot":"","sources":["../../../src/lib/generated-workflow-model-fields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,oFAAoF;AACpF,MAAM,CAAC,MAAM,+BAA+B,GAAsB;IAChE,YAAY;IACZ,OAAO;IACP,aAAa;IACb,MAAM;IACN,QAAQ;IACR,gBAAgB;IAChB,aAAa;IACb,YAAY;IACZ,iBAAiB;IACjB,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,gBAAgB;IAChB,aAAa;IACb,cAAc;IACd,mBAAmB;IACnB,kBAAkB;IAClB,kBAAkB;IAClB,iBAAiB;IACjB,iBAAiB;IACjB,cAAc;IACd,qBAAqB;IACrB,cAAc;IACd,YAAY;IACZ,kBAAkB;IAClB,OAAO;IACP,MAAM;IACN,cAAc;IACd,WAAW;IACX,WAAW;IACX,YAAY;CACb,CAAC"}

package/dist/src/lib/workflow-field-descriptor.d.ts

@@ -1,91 +0,0 @@
-/**
- * Classification of the `WorkflowDefinition` field surface (issue #2326,
- * Phase 1 of #1976).
- *
- * Purpose: give the CLI a mechanical trip-wire for the drift that keeps
- * happening — the server grows a `[workflow]`-level config field (`syncCallable`
- * #807, `accessRule` #571, `runAs` #1081, `capabilities` #1172, `lock` #1518)
- * and the CLI silently drops it on `sync push` / `sync pull`. Every field of the
- * `WorkflowDefinition` model must appear in exactly one of the three groups
- * below. The generated artifact `generated-workflow-model-fields.ts` carries the
- * model's real field list (parsed from `models.yaml` at build time), and
- * `cli/tests/unit/workflow-field-descriptor-drift-guard.test.ts` asserts
- *
- *     synced ∪ structural ∪ internal  ===  the model's fields
- *
- * so a new field hard-fails the guard until someone classifies it.
- *
- * ── Scope: declarative classification and coverage ONLY ──────────────────
- * Decision of record (#1976, 2026-07-23): this table records WHICH fields
- * exist, whether each is synced / structural / internal, and its `[workflow]`
- * TOML key. Anything with real BEHAVIOR gets an explicit per-field handler or
- * stays outside the table. In particular this file deliberately does NOT encode
- * as boolean knobs:
- *   - the schema fields' native-TOML-table-vs-JSON-string parsing
- *     (`buildWorkflowPayloadFromToml` / `safeJsonParse` own that),
- *   - `syncCallable`'s deferred second PATCH on update (#807 — `applyWorkflowBody`
- *     owns that),
- *   - the `metadataManifest` (#1304) and `expr.cel` (#1614) structural side
- *     channels, which are attached alongside the steps write and are not
- *     `[workflow]`-table keys at all.
- * `cli/src/lib/app-settings-descriptor.ts` is the shape being matched:
- * deliberately narrow.
- *
- * ── What Phase 1 does and does not do ───────────────────────────────────
- * Phase 1 (this file) is the guard only. Making the push builder
- * (`workflow-payload.ts`) and the pull serializer (`serializeWorkflow` in
- * `commands/sync.ts`) *consume* this table is Phase 2 (#2327).
- * `synced` therefore means "belongs in the `[workflow]` TOML table", NOT
- * "already round-trips" — see `SYNCED_NOT_YET_WIRED` below.
- */
-/** Value shape of a synced `[workflow]` key. Descriptive; behavior lives in the handlers. */
-export type WorkflowFieldType = "string" | "number" | "boolean" | "string[]" | "json";
-export interface WorkflowFieldDescriptor {
-    /** `WorkflowDefinition` model field name === the server payload key. */
-    field: string;
-    /** Key under the `[workflow]` table in workflow TOML (usually === `field`). */
-    tomlKey: string;
-    /** Value shape, for the Phase 2 handlers and for documentation. */
-    type: WorkflowFieldType;
-}
-/**
- * The author-facing `[workflow]`-table config fields — the ones a workflow
- * author manages as code and the CLI must round-trip.
- */
-export declare const WORKFLOW_FIELD_DESCRIPTOR: readonly WorkflowFieldDescriptor[];
-/**
- * Fields that ARE author-controlled but do not live in the `[workflow]` table —
- * they travel through their own structural channel. Kept distinct from
- * `WORKFLOW_FIELDS_INTERNAL` so "internal" keeps meaning "not author-facing".
- */
-export declare const WORKFLOW_FIELDS_STRUCTURAL: ReadonlySet<string>;
-/**
- * Fields the server owns: identity, ownership, timestamps, computed pointers,
- * and the deprecated draft/revision slot. None of these are ever sent by the
- * CLI, and none belong in workflow TOML.
- */
-export declare const WORKFLOW_FIELDS_INTERNAL: ReadonlySet<string>;
-/**
- * Synced fields the CLI does NOT round-trip yet — Phase 2 (#2327) wires them.
- * Recorded explicitly so "classified" is never mistaken for "implemented".
- * `lock` was wired by #1972; `templateMissingMarker` was removed from the
- * platform by #2643, so the set is now empty.
- */
-export declare const SYNCED_NOT_YET_WIRED: ReadonlySet<string>;
-/** Descriptor `field` names, for coverage/parity checks. */
-export declare const WORKFLOW_SYNCED_FIELDS: ReadonlySet<string>;
-/** Look up a synced field's descriptor by model field name. */
-export declare function getWorkflowFieldDescriptor(field: string): WorkflowFieldDescriptor | undefined;
-/**
- * Model fields that are classified in NONE of synced / structural / internal —
- * i.e. a field someone added to `models.yaml` without deciding how the CLI
- * treats it. Non-empty is a hard failure in the drift guard.
- */
-export declare function findUnclassifiedWorkflowFields(modelFields: readonly string[]): string[];
-/**
- * Classifications that no longer correspond to a model field — i.e. a field
- * removed from `models.yaml` while the CLI still classifies it. Also a hard
- * failure: a stale classification must not silently pass, or the coverage
- * claim quietly stops meaning anything.
- */
-export declare function findStaleWorkflowClassifications(modelFields: readonly string[]): string[];

package/dist/src/lib/workflow-field-descriptor.js

@@ -1,153 +0,0 @@
-/**
- * Classification of the `WorkflowDefinition` field surface (issue #2326,
- * Phase 1 of #1976).
- *
- * Purpose: give the CLI a mechanical trip-wire for the drift that keeps
- * happening — the server grows a `[workflow]`-level config field (`syncCallable`
- * #807, `accessRule` #571, `runAs` #1081, `capabilities` #1172, `lock` #1518)
- * and the CLI silently drops it on `sync push` / `sync pull`. Every field of the
- * `WorkflowDefinition` model must appear in exactly one of the three groups
- * below. The generated artifact `generated-workflow-model-fields.ts` carries the
- * model's real field list (parsed from `models.yaml` at build time), and
- * `cli/tests/unit/workflow-field-descriptor-drift-guard.test.ts` asserts
- *
- *     synced ∪ structural ∪ internal  ===  the model's fields
- *
- * so a new field hard-fails the guard until someone classifies it.
- *
- * ── Scope: declarative classification and coverage ONLY ──────────────────
- * Decision of record (#1976, 2026-07-23): this table records WHICH fields
- * exist, whether each is synced / structural / internal, and its `[workflow]`
- * TOML key. Anything with real BEHAVIOR gets an explicit per-field handler or
- * stays outside the table. In particular this file deliberately does NOT encode
- * as boolean knobs:
- *   - the schema fields' native-TOML-table-vs-JSON-string parsing
- *     (`buildWorkflowPayloadFromToml` / `safeJsonParse` own that),
- *   - `syncCallable`'s deferred second PATCH on update (#807 — `applyWorkflowBody`
- *     owns that),
- *   - the `metadataManifest` (#1304) and `expr.cel` (#1614) structural side
- *     channels, which are attached alongside the steps write and are not
- *     `[workflow]`-table keys at all.
- * `cli/src/lib/app-settings-descriptor.ts` is the shape being matched:
- * deliberately narrow.
- *
- * ── What Phase 1 does and does not do ───────────────────────────────────
- * Phase 1 (this file) is the guard only. Making the push builder
- * (`workflow-payload.ts`) and the pull serializer (`serializeWorkflow` in
- * `commands/sync.ts`) *consume* this table is Phase 2 (#2327).
- * `synced` therefore means "belongs in the `[workflow]` TOML table", NOT
- * "already round-trips" — see `SYNCED_NOT_YET_WIRED` below.
- */
-/**
- * The author-facing `[workflow]`-table config fields — the ones a workflow
- * author manages as code and the CLI must round-trip.
- */
-export const WORKFLOW_FIELD_DESCRIPTOR = [
-    { field: "name", tomlKey: "name", type: "string" },
-    { field: "status", tomlKey: "status", type: "string" },
-    { field: "description", tomlKey: "description", type: "string" },
-    // JSON Schema objects. TOML may present them as an inline table OR as a
-    // JSON string; the push builder owns that parse (not a knob here).
-    { field: "inputSchema", tomlKey: "inputSchema", type: "json" },
-    { field: "outputSchema", tomlKey: "outputSchema", type: "json" },
-    { field: "perUserMaxRunning", tomlKey: "perUserMaxRunning", type: "number" },
-    { field: "perUserMaxQueued", tomlKey: "perUserMaxQueued", type: "number" },
-    { field: "perAppMaxRunning", tomlKey: "perAppMaxRunning", type: "number" },
-    { field: "perAppMaxQueued", tomlKey: "perAppMaxQueued", type: "number" },
-    { field: "queueTtlSeconds", tomlKey: "queueTtlSeconds", type: "number" },
-    { field: "dequeueOrder", tomlKey: "dequeueOrder", type: "string" },
-    {
-        field: "requiresClientApply",
-        tomlKey: "requiresClientApply",
-        type: "boolean",
-    },
-    // Create-only on the wire (#807: update sends it as a deferred second PATCH
-    // once the new steps are live). That sequencing is the payload builder's job.
-    { field: "syncCallable", tomlKey: "syncCallable", type: "boolean" },
-    { field: "accessRule", tomlKey: "accessRule", type: "string" },
-    { field: "runAs", tomlKey: "runAs", type: "string" },
-    // #1518/#1972 — declarative run-scoped lock. `[workflow.lock]` inline table
-    // on the TOML side, JSON on the wire; validated server-side by
-    // `parseWorkflowLock` (decision of record #6: no client-side mirror validator).
-    { field: "lock", tomlKey: "lock", type: "json" },
-    // #1078 Tier 1b — StringSetField on the model, string array in TOML/JSON.
-    { field: "capabilities", tomlKey: "capabilities", type: "string[]" },
-];
-/**
- * Fields that ARE author-controlled but do not live in the `[workflow]` table —
- * they travel through their own structural channel. Kept distinct from
- * `WORKFLOW_FIELDS_INTERNAL` so "internal" keeps meaning "not author-facing".
- */
-export const WORKFLOW_FIELDS_STRUCTURAL = new Set([
-    // The workflow's identity. Comes from the TOML file name / `--key`, and is
-    // attached by the caller rather than spread from the `[workflow]` table.
-    "workflowKey",
-    // #1304 — JSON declared-access manifest, derived from the workflow's CEL
-    // fields and attached alongside the steps write, not typed by the author.
-    "metadataManifest",
-]);
-/**
- * Fields the server owns: identity, ownership, timestamps, computed pointers,
- * and the deprecated draft/revision slot. None of these are ever sent by the
- * CLI, and none belong in workflow TOML.
- */
-export const WORKFLOW_FIELDS_INTERNAL = new Set([
-    // Identity / ownership / timestamps — assigned by the server.
-    "workflowId",
-    "appId",
-    "createdBy",
-    "createdAt",
-    "modifiedAt",
-    // Pointer to the active WorkflowConfiguration — server-computed on publish.
-    "activeConfigId",
-    // DEPRECATED in models.yaml: the legacy revision + draft slot, kept for
-    // migration/backward compatibility. Server-managed; never author-authored.
-    "latestRevision",
-    "stepsR2Key",
-    "draftStepsR2Key",
-    "draftInputSchema",
-    "draftOutputSchema",
-    "draftModifiedAt",
-]);
-/**
- * Synced fields the CLI does NOT round-trip yet — Phase 2 (#2327) wires them.
- * Recorded explicitly so "classified" is never mistaken for "implemented".
- * `lock` was wired by #1972; `templateMissingMarker` was removed from the
- * platform by #2643, so the set is now empty.
- */
-export const SYNCED_NOT_YET_WIRED = new Set([]);
-/** Descriptor `field` names, for coverage/parity checks. */
-export const WORKFLOW_SYNCED_FIELDS = new Set(WORKFLOW_FIELD_DESCRIPTOR.map((d) => d.field));
-/** Look up a synced field's descriptor by model field name. */
-export function getWorkflowFieldDescriptor(field) {
-    return WORKFLOW_FIELD_DESCRIPTOR.find((d) => d.field === field);
-}
-/**
- * Model fields that are classified in NONE of synced / structural / internal —
- * i.e. a field someone added to `models.yaml` without deciding how the CLI
- * treats it. Non-empty is a hard failure in the drift guard.
- */
-export function findUnclassifiedWorkflowFields(modelFields) {
-    return modelFields
-        .filter((f) => !WORKFLOW_SYNCED_FIELDS.has(f) &&
-        !WORKFLOW_FIELDS_STRUCTURAL.has(f) &&
-        !WORKFLOW_FIELDS_INTERNAL.has(f))
-        .sort();
-}
-/**
- * Classifications that no longer correspond to a model field — i.e. a field
- * removed from `models.yaml` while the CLI still classifies it. Also a hard
- * failure: a stale classification must not silently pass, or the coverage
- * claim quietly stops meaning anything.
- */
-export function findStaleWorkflowClassifications(modelFields) {
-    const known = new Set(modelFields);
-    return [
-        ...WORKFLOW_SYNCED_FIELDS,
-        ...WORKFLOW_FIELDS_STRUCTURAL,
-        ...WORKFLOW_FIELDS_INTERNAL,
-    ]
-        .filter((f) => !known.has(f))
-        .sort();
-}
-//# sourceMappingURL=workflow-field-descriptor.js.map

package/dist/src/lib/workflow-field-descriptor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflow-field-descriptor.js","sourceRoot":"","sources":["../../../src/lib/workflow-field-descriptor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAmBH;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAuC;IAC3E,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClD,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;IACtD,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE;IAChE,wEAAwE;IACxE,mEAAmE;IACnE,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE;IAC9D,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE;IAChE,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC5E,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1E,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1E,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxE,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxE,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE;IAClE;QACE,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,qBAAqB;QAC9B,IAAI,EAAE,SAAS;KAChB;IACD,4EAA4E;IAC5E,8EAA8E;IAC9E,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE;IACnE,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC9D,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;IACpD,4EAA4E;IAC5E,+DAA+D;IAC/D,gFAAgF;IAChF,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;IAChD,0EAA0E;IAC1E,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE;CAC5D,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAwB,IAAI,GAAG,CAAC;IACrE,2EAA2E;IAC3E,yEAAyE;IACzE,aAAa;IACb,yEAAyE;IACzE,0EAA0E;IAC1E,kBAAkB;CACnB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAwB,IAAI,GAAG,CAAC;IACnE,8DAA8D;IAC9D,YAAY;IACZ,OAAO;IACP,WAAW;IACX,WAAW;IACX,YAAY;IACZ,4EAA4E;IAC5E,gBAAgB;IAChB,wEAAwE;IACxE,2EAA2E;IAC3E,gBAAgB;IAChB,YAAY;IACZ,iBAAiB;IACjB,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;CAClB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAwB,IAAI,GAAG,CAAS,EAAE,CAAC,CAAC;AAE7E,4DAA4D;AAC5D,MAAM,CAAC,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAChE,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAC9C,CAAC;AAEF,+DAA+D;AAC/D,MAAM,UAAU,0BAA0B,CACxC,KAAa;IAEb,OAAO,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,WAA8B;IAE9B,OAAO,WAAW;SACf,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;QAClC,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,CACnC;SACA,IAAI,EAAE,CAAC;AACZ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAC9C,WAA8B;IAE9B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACnC,OAAO;QACL,GAAG,sBAAsB;QACzB,GAAG,0BAA0B;QAC7B,GAAG,wBAAwB;KAC5B;SACE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SAC5B,IAAI,EAAE,CAAC;AACZ,CAAC"}