primitive-admin 1.2.0-alpha.5 → 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.5",
+  "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.5",
+    "js-bao": "0.12.0-alpha.7",
     "mime-types": "^2.1.35",
     "open": "^10.0.3",
     "smol-toml": "1.7.0",