@camunda8/cli 4.0.0-alpha.1 → 4.0.0-alpha.3

package/dist/utils/shared/variables-input.js

@@ -0,0 +1,177 @@
+/**
+ * Shared parser for `--variables` JSON input (#528).
+ *
+ * Passing inline JSON through a shell is quoting-hostile — PowerShell in
+ * particular strips the double quotes of a native command argument before
+ * the process ever sees it, so `{"a":"b"}` arrives as `{a:b}`.
+ *
+ * Three defences, in order:
+ *  1. Valid JSON is parsed as-is, however large or deeply nested.
+ *  2. Inline input that arrived with *every* quote stripped is re-quoted
+ *     and re-parsed, with a warning naming the repaired payload.
+ *  3. Anything still unparseable — e.g. a payload the shell also split on
+ *     spaces — fails with a hint pointing at the quoting-proof `@file` /
+ *     `@-` (stdin) forms.
+ */
+import { readFileSync } from "node:fs";
+import { getLogger, isRecord } from "../../core/index.js";
+const QUOTING_HINT = "Hint: read the JSON from a file instead of quoting it inline: " +
+    "--variables @vars.json (or --variables @- to read stdin). " +
+    "Some shells (notably PowerShell) strip or re-split the quotes of inline JSON.";
+/**
+ * Bare tokens that must stay unquoted when re-quoting a stripped payload:
+ * JSON numbers and the three literals.
+ */
+const JSON_LITERAL = /^(?:-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?|true|false|null)$/;
+const STRUCTURAL = new Set(["{", "}", "[", "]", ":", ","]);
+/**
+ * Normalise a filesystem path to forward slashes so Windows backslashes
+ * survive JSON serialisation in error messages without being doubled.
+ */
+export function toDisplayPath(path) {
+    return path.replaceAll("\\", "/");
+}
+/**
+ * Does this look like a JSON object whose double quotes the shell removed?
+ * Requires the object braces to have survived — anything else is a typo or
+ * a payload the shell also split on spaces, neither of which is repairable.
+ */
+function looksQuoteStripped(text) {
+    const value = text.trim();
+    return !value.includes('"') && value.startsWith("{") && value.endsWith("}");
+}
+/**
+ * Re-quote a payload whose double quotes were stripped by the shell, e.g.
+ * PowerShell turning `{"a":"b"}` into `{a:b}`.
+ *
+ * Only attempted for an object payload that contains no `"` at all — a
+ * payload that kept some of its quotes was mangled some other way, and
+ * guessing would be unsafe. Structural characters delimit bare tokens;
+ * every token that is not a JSON number/`true`/`false`/`null` is
+ * re-quoted. Ambiguous input (a stripped string that itself contained `:`
+ * or `,`) reassembles into invalid JSON and is rejected by the caller's
+ * re-parse.
+ *
+ * Returns the repaired text, or `null` when no repair is applicable.
+ */
+function requoteStrippedJson(text) {
+    if (!looksQuoteStripped(text))
+        return null;
+    let out = "";
+    let token = "";
+    const flushToken = () => {
+        const value = token.trim();
+        token = "";
+        if (!value)
+            return;
+        out += JSON_LITERAL.test(value) ? value : JSON.stringify(value);
+    };
+    for (const char of text) {
+        if (STRUCTURAL.has(char)) {
+            flushToken();
+            out += char;
+        }
+        else {
+            token += char;
+        }
+    }
+    flushToken();
+    return out === text ? null : out;
+}
+/**
+ * Resolve the raw flag value to JSON text, following an `@file` / `@-`
+ * reference when present.
+ */
+function readVariablesSource(raw) {
+    const value = raw.trim();
+    if (!value.startsWith("@"))
+        return { text: value };
+    const ref = value.slice(1);
+    if (ref === "-") {
+        if (process.stdin.isTTY) {
+            throw new Error("--variables @- expects JSON on stdin, but stdin is a terminal");
+        }
+        // Blocking read of fd 0 until EOF, the same contract as `cat -`:
+        // the producer of the pipe is expected to close it. Reading stdin
+        // synchronously here is safe because `--variables` is parsed once
+        // per invocation, before any other stdin consumer runs.
+        return { text: readFileSync(0, "utf-8"), origin: "stdin" };
+    }
+    if (!ref) {
+        throw new Error("--variables @ requires a file path (e.g. @vars.json)");
+    }
+    const normalised = toDisplayPath(ref);
+    try {
+        return { text: readFileSync(ref, "utf-8"), origin: `'${normalised}'` };
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        throw new Error(`Cannot read variables file '${normalised}': ${msg}`);
+    }
+}
+/**
+ * Parse a `--variables` flag value into a JSON object.
+ *
+ * Accepts inline JSON, `@path/to/file.json`, or `@-` for stdin. Throws an
+ * `Error` (never exits) so the framework's error handler owns the exit code.
+ */
+export function parseVariablesFlag({ raw, label = "variables", }) {
+    const { text, origin } = readVariablesSource(raw);
+    // Name the input source so a bad file or piped payload is not mistaken
+    // for a bad inline argument.
+    const from = origin ? ` (read from ${origin})` : "";
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch (error) {
+        // Inline input only: an `@file` / `@-` payload never went through
+        // shell quoting, so a repair there would be guesswork.
+        const repair = origin ? null : tryRequote(text);
+        if (!repair) {
+            const msg = error instanceof Error ? error.message : String(error);
+            if (origin) {
+                throw new Error(`Invalid JSON for ${label}${from}: ${msg}`);
+            }
+            // A payload with no quotes left at all reached us stripped; say so
+            // rather than leaving the user to decode a parser position.
+            const stripped = looksQuoteStripped(text)
+                ? " The value lost its quotes on the way in and could not be " +
+                    "restored unambiguously."
+                : "";
+            throw new Error(`Invalid JSON for ${label}: ${msg}.${stripped} ${QUOTING_HINT}`);
+        }
+        // Announce the repair: re-quoting cannot recover the original
+        // string/number distinction (`{a:1}` could have been `{"a":1}` or
+        // `{"a":"1"}`), so the user gets to see what was sent.
+        getLogger().warn(`--variables: restored quotes stripped by the shell -> ${repair.json}. ` +
+            "Use --variables @file.json or @- to pass JSON verbatim.");
+        parsed = repair.value;
+    }
+    if (!isRecord(parsed)) {
+        throw new Error(Array.isArray(parsed)
+            ? `--variables must be a JSON object (not an array)${from}`
+            : `--variables must be a JSON object${from}`);
+    }
+    return parsed;
+}
+/**
+ * Attempt the quote-stripping repair and parse the result.
+ *
+ * Pure: returns both the repaired JSON text (for the caller's warning) and
+ * the value it parsed to, or `null` when the input is not repairable. The
+ * wrapper object keeps the "not repairable" sentinel distinct from a
+ * payload that legitimately parsed to `null`.
+ */
+function tryRequote(text) {
+    const json = requoteStrippedJson(text);
+    if (json === null)
+        return null;
+    try {
+        return { json, value: JSON.parse(json) };
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=variables-input.js.map

package/dist/utils/shared/variables-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables-input.js","sourceRoot":"","sources":["../../../src/utils/shared/variables-input.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,YAAY,GACjB,gEAAgE;IAChE,4DAA4D;IAC5D,+EAA+E,CAAC;AAEjF;;;GAGG;AACH,MAAM,YAAY,GACjB,mEAAmE,CAAC;AAErE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,IAAY;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,mBAAmB,CAAC,IAAY;IACxC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAE3C,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,UAAU,GAAG,GAAG,EAAE;QACvB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC3B,KAAK,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,UAAU,EAAE,CAAC;YACb,GAAG,IAAI,IAAI,CAAC;QACb,CAAC;aAAM,CAAC;YACP,KAAK,IAAI,IAAI,CAAC;QACf,CAAC;IACF,CAAC;IACD,UAAU,EAAE,CAAC;IAEb,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;AAClC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,GAAW;IACvC,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAEnD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QACjB,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACd,+DAA+D,CAC/D,CAAC;QACH,CAAC;QACD,iEAAiE;QACjE,kEAAkE;QAClE,kEAAkE;QAClE,wDAAwD;QACxD,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC5D,CAAC;IACD,IAAI,CAAC,GAAG,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,CAAC;QACJ,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,UAAU,GAAG,EAAE,CAAC;IACxE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnE,MAAM,IAAI,KAAK,CAAC,+BAA+B,UAAU,MAAM,GAAG,EAAE,CAAC,CAAC;IACvE,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAClC,GAAG,EACH,KAAK,GAAG,WAAW,GAInB;IACA,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAClD,uEAAuE;IACvE,6BAA6B;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,eAAe,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpD,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACJ,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,kEAAkE;QAClE,uDAAuD;QACvD,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,GAAG,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC;YAC7D,CAAC;YACD,mEAAmE;YACnE,4DAA4D;YAC5D,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC;gBACxC,CAAC,CAAC,4DAA4D;oBAC7D,yBAAyB;gBAC1B,CAAC,CAAC,EAAE,CAAC;YACN,MAAM,IAAI,KAAK,CACd,oBAAoB,KAAK,KAAK,GAAG,IAAI,QAAQ,IAAI,YAAY,EAAE,CAC/D,CAAC;QACH,CAAC;QACD,8DAA8D;QAC9D,kEAAkE;QAClE,uDAAuD;QACvD,SAAS,EAAE,CAAC,IAAI,CACf,yDAAyD,MAAM,CAAC,IAAI,IAAI;YACvE,yDAAyD,CAC1D,CAAC;QACF,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;IACvB,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACd,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC,mDAAmD,IAAI,EAAE;YAC3D,CAAC,CAAC,oCAAoC,IAAI,EAAE,CAC7C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,IAAY;IAC/B,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAE/B,IAAI,CAAC;QACJ,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC"}