@pipelex/sdk 0.33.0 → 0.34.0

package/dist/cli/present.js

@@ -0,0 +1,191 @@
+/**
+ * What the command prints: a finished run's result on stdout, and every failure on stderr.
+ *
+ * A failure is worded by the command from the error's typed fields, never from an SDK message
+ * whose wording is the SDK's own, wherever the fields carry what a person needs: the API's reason,
+ * the next step it advises and the request id support asks for. That keeps the two commands, this
+ * one and its Python twin, saying the same thing for the same answer, which is what the recorded
+ * case table holds them to.
+ */
+import { ApiResponseError, ApiUnreachableError, InputPreparationError, InvalidInputValueError, InvalidLocalSourceError, MethodLoadError, PipelineRequestError, RejectedAssetError, RunFailedError, UnsupportedUploadCapabilityError, UploadAuthenticationError, UploadTransportError, } from "../index.js";
+import { CommandError, EXIT_FAILED, EXIT_USAGE } from "./io.js";
+/** Word any failure for stderr and choose its exit code. */
+export function presentError(error) {
+    if (error instanceof CommandError) {
+        const first = error.bare ? error.message : `Error: ${error.message}`;
+        return { lines: [first, ...error.details], exitCode: error.exitCode };
+    }
+    if (error instanceof RunFailedError) {
+        const report = error.error;
+        const lines = [`Error: run ${error.runId} ended with status ${error.status}.`];
+        lines.push(`Reason: ${report?.message ?? error.message}`);
+        if (report?.user_action?.detail)
+            lines.push(`Next step: ${report.user_action.detail}`);
+        return { lines, exitCode: EXIT_FAILED };
+    }
+    if (error instanceof InvalidLocalSourceError) {
+        // A file the inputs name that cannot be read is the inputs' fault, as an unreadable inputs
+        // file is, so it is a usage error.
+        return {
+            lines: [
+                `Error: ${error.message}`,
+                "A relative path in the inputs resolves against the current directory.",
+            ],
+            exitCode: EXIT_USAGE,
+        };
+    }
+    if (error instanceof InvalidInputValueError) {
+        // A value at a file input that is no file, such as a data: URL that does not decode or a
+        // number, is the inputs' fault too.
+        return {
+            lines: [
+                "Error: the inputs hold a value at a file input that cannot be read as a file.",
+                `Reason: ${error.message}`,
+                FILE_INPUT_FORMS,
+            ],
+            exitCode: EXIT_USAGE,
+        };
+    }
+    if (error instanceof MethodLoadError) {
+        // The same lines whichever route said so: the input preparation here, the pipe I/O call of
+        // `--inputs-template` and `script` in `source.ts`.
+        return {
+            lines: [
+                METHOD_DOES_NOT_LOAD,
+                ...loadFailureLines(error.validationErrors, error.serverMessage),
+            ],
+            exitCode: EXIT_FAILED,
+        };
+    }
+    if (error instanceof RejectedAssetError ||
+        error instanceof UploadAuthenticationError ||
+        error instanceof UnsupportedUploadCapabilityError ||
+        error instanceof UploadTransportError) {
+        return presentUploadFailure(error);
+    }
+    if (error instanceof InputPreparationError && error.cause instanceof ApiResponseError) {
+        return presentRefusal(error.cause);
+    }
+    if (error instanceof ApiResponseError) {
+        return presentRefusal(error);
+    }
+    if (error instanceof ApiUnreachableError) {
+        return {
+            lines: [
+                `Error: could not reach the Pipelex API at ${error.apiUrl} (${error.code ?? "network error"}).`,
+            ],
+            exitCode: EXIT_FAILED,
+        };
+    }
+    if (error instanceof PipelineRequestError) {
+        return { lines: [`Error: ${error.message}`], exitCode: EXIT_FAILED };
+    }
+    const detail = error instanceof Error ? `${error.name}: ${error.message}` : String(error);
+    return { lines: [`Error: unexpected failure, ${detail}`], exitCode: EXIT_FAILED };
+}
+/**
+ * A file the inputs name that could not be uploaded: which file, the status the upload route
+ * answered when it answered, and the SDK's own sentence, which says what the status means for an
+ * upload (a file past the size limit, a deployment without upload), followed by the advice and the
+ * request id of the API's answer when it carries them.
+ */
+function presentUploadFailure(error) {
+    const cause = error.cause instanceof ApiResponseError ? error.cause : undefined;
+    const status = "status" in error && typeof error.status === "number" ? error.status : cause?.status;
+    const what = error.filename === undefined ? "an upload failed" : `the upload of "${error.filename}" failed`;
+    const lines = [`Error: ${what}${status === undefined ? "" : ` (status ${status})`}.`];
+    lines.push(`Reason: ${error.message}`);
+    if (cause?.userAction?.detail)
+        lines.push(`Next step: ${cause.userAction.detail}`);
+    if (cause?.requestId)
+        lines.push(`Request id: ${cause.requestId}`);
+    return { lines, exitCode: EXIT_FAILED };
+}
+/** An answer the API gave instead of a result: its status, its reason and its advice. */
+function presentRefusal(error) {
+    const lines = error.status >= 200 && error.status < 300
+        ? [`Error: the API's answer could not be read (status ${error.status}).`]
+        : [`Error: the API refused the request (status ${error.status}).`];
+    lines.push(`Reason: ${error.serverMessage ?? error.title ?? "the answer gives no reason"}`);
+    for (const item of error.validationErrors ?? [])
+        lines.push(validationLine(item));
+    if (error.userAction?.detail)
+        lines.push(`Next step: ${error.userAction.detail}`);
+    if (error.requestId)
+        lines.push(`Request id: ${error.requestId}`);
+    return { lines, exitCode: EXIT_FAILED };
+}
+/** What a file input takes, the hint under a value it cannot take. */
+const FILE_INPUT_FORMS = 'A file input takes a local path, an http(s) or pipelex-storage:// URL, a data: URL, or an object whose "url" is one of these.';
+/** The first line of a method that does not load, after `Error: `. */
+export const METHOD_DOES_NOT_LOAD_SENTENCE = "the method does not load.";
+const METHOD_DOES_NOT_LOAD = `Error: ${METHOD_DOES_NOT_LOAD_SENTENCE}`;
+/**
+ * The lines under "the method does not load": one per validation item that carries a string
+ * `category` and `message`, the rule the SDK reads a failed load's items by, and when there is
+ * none, the answer's own message.
+ */
+export function loadFailureLines(items, message) {
+    const lines = (Array.isArray(items) ? items : []).filter(isLoadItem).map(validationLine);
+    if (lines.length === 0) {
+        lines.push(`  - ${typeof message === "string" ? message : "the answer gives no reason"}`);
+    }
+    return lines;
+}
+function isLoadItem(value) {
+    return (isPlainObject(value) && typeof value.category === "string" && typeof value.message === "string");
+}
+/** One validation error, as an indented line naming its file when it has one. */
+export function validationLine(item) {
+    const source = typeof item.source === "string" && item.source !== "" ? `${item.source}: ` : "";
+    return `  - ${source}${item.message}`;
+}
+/** The keys of the runtime's absence document, and no other. */
+const ABSENCE_KEYS = ["absent", "variable_name", "kind", "reason", "producing_pipe", "upstream"];
+const ABSENCE_KINDS = ["declared_absent", "skipped", "not_provided"];
+function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Whether a run's main output is the absence of one: nothing at all, or the runtime's absence
+ * document, matched by its whole shape (exactly its keys, each of the type the runtime writes) and
+ * never by its `absent` key alone, since a method's own output may carry such a field. The same
+ * rule `cli-python` applies.
+ */
+export function isAbsence(mainStuff) {
+    if (mainStuff === null || mainStuff === undefined)
+        return true;
+    if (!isPlainObject(mainStuff))
+        return false;
+    const keys = Object.keys(mainStuff);
+    if (keys.length !== ABSENCE_KEYS.length || !ABSENCE_KEYS.every((key) => keys.includes(key))) {
+        return false;
+    }
+    const { absent, variable_name, kind, reason, producing_pipe, upstream } = mainStuff;
+    return (absent === true &&
+        typeof variable_name === "string" &&
+        typeof kind === "string" &&
+        ABSENCE_KINDS.includes(kind) &&
+        typeof reason === "string" &&
+        (producing_pipe === null || typeof producing_pipe === "string") &&
+        (upstream === null || isPlainObject(upstream)));
+}
+/**
+ * Print a finished run's main output on stdout, as the method produced it: indented JSON,
+ * unvalidated and unrepaired, a list included whichever shape it arrived in. An output the method
+ * left absent prints `null`, and a line on stderr says so.
+ */
+export function printResult(mainStuff, io) {
+    if (isAbsence(mainStuff)) {
+        io.writeStdout("null\n");
+        if (isPlainObject(mainStuff)) {
+            io.writeStderr(`The method left its output "${String(mainStuff.variable_name)}" absent (${String(mainStuff.reason)}), so the result is null.\n`);
+        }
+        else {
+            io.writeStderr("The method produced no output, so the result is null.\n");
+        }
+        return;
+    }
+    io.writeStdout(`${JSON.stringify(mainStuff, null, 2)}\n`);
+}
+//# sourceMappingURL=present.js.map

package/dist/cli/present.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"present.js","sourceRoot":"","sources":["../../src/cli/present.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAShE,4DAA4D;AAC5D,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,OAAO,EAAE,CAAC;QACrE,OAAO,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;IACxE,CAAC;IACD,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC3B,MAAM,KAAK,GAAG,CAAC,cAAc,KAAK,CAAC,KAAK,sBAAsB,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,WAAW,EAAE,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;QACvF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IAC1C,CAAC;IACD,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;QAC7C,2FAA2F;QAC3F,mCAAmC;QACnC,OAAO;YACL,KAAK,EAAE;gBACL,UAAU,KAAK,CAAC,OAAO,EAAE;gBACzB,uEAAuE;aACxE;YACD,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,YAAY,sBAAsB,EAAE,CAAC;QAC5C,yFAAyF;QACzF,oCAAoC;QACpC,OAAO;YACL,KAAK,EAAE;gBACL,+EAA+E;gBAC/E,WAAW,KAAK,CAAC,OAAO,EAAE;gBAC1B,gBAAgB;aACjB;YACD,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;QACrC,2FAA2F;QAC3F,mDAAmD;QACnD,OAAO;YACL,KAAK,EAAE;gBACL,oBAAoB;gBACpB,GAAG,gBAAgB,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,aAAa,CAAC;aACjE;YACD,QAAQ,EAAE,WAAW;SACtB,CAAC;IACJ,CAAC;IACD,IACE,KAAK,YAAY,kBAAkB;QACnC,KAAK,YAAY,yBAAyB;QAC1C,KAAK,YAAY,gCAAgC;QACjD,KAAK,YAAY,oBAAoB,EACrC,CAAC;QACD,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,KAAK,YAAY,qBAAqB,IAAI,KAAK,CAAC,KAAK,YAAY,gBAAgB,EAAE,CAAC;QACtF,OAAO,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;QACtC,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,YAAY,mBAAmB,EAAE,CAAC;QACzC,OAAO;YACL,KAAK,EAAE;gBACL,6CAA6C,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,IAAI,eAAe,IAAI;aAChG;YACD,QAAQ,EAAE,WAAW;SACtB,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;QAC1C,OAAO,EAAE,KAAK,EAAE,CAAC,UAAU,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IACvE,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1F,OAAO,EAAE,KAAK,EAAE,CAAC,8BAA8B,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACpF,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAC3B,KAIwB;IAExB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,YAAY,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAChF,MAAM,MAAM,GACV,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC;IACvF,MAAM,IAAI,GACR,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,kBAAkB,KAAK,CAAC,QAAQ,UAAU,CAAC;IACjG,MAAM,KAAK,GAAG,CAAC,UAAU,IAAI,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,MAAM,GAAG,GAAG,CAAC,CAAC;IACtF,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACvC,IAAI,KAAK,EAAE,UAAU,EAAE,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;IACnF,IAAI,KAAK,EAAE,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,eAAe,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IACnE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAC1C,CAAC;AAED,yFAAyF;AACzF,SAAS,cAAc,CAAC,KAAuB;IAC7C,MAAM,KAAK,GACT,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;QACvC,CAAC,CAAC,CAAC,qDAAqD,KAAK,CAAC,MAAM,IAAI,CAAC;QACzE,CAAC,CAAC,CAAC,8CAA8C,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IACvE,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,IAAI,4BAA4B,EAAE,CAAC,CAAC;IAC5F,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,gBAAgB,IAAI,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IAClF,IAAI,KAAK,CAAC,UAAU,EAAE,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;IAClF,IAAI,KAAK,CAAC,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,eAAe,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IAClE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAC1C,CAAC;AAED,sEAAsE;AACtE,MAAM,gBAAgB,GACpB,+HAA+H,CAAC;AAElI,sEAAsE;AACtE,MAAM,CAAC,MAAM,6BAA6B,GAAG,2BAA2B,CAAC;AACzE,MAAM,oBAAoB,GAAG,UAAU,6BAA6B,EAAE,CAAC;AAEvE;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc,EAAE,OAAgB;IAC/D,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACzF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CACL,aAAa,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAChG,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,cAAc,CAC5B,IAAiE;IAEjE,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/F,OAAO,OAAO,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;AACxC,CAAC;AAED,gEAAgE;AAChE,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;AACjG,MAAM,aAAa,GAAG,CAAC,iBAAiB,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;AAErE,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,SAAkB;IAC1C,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC/D,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5F,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IACpF,OAAO,CACL,MAAM,KAAK,IAAI;QACf,OAAO,aAAa,KAAK,QAAQ;QACjC,OAAO,IAAI,KAAK,QAAQ;QACxB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC5B,OAAO,MAAM,KAAK,QAAQ;QAC1B,CAAC,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,CAAC;QAC/D,CAAC,QAAQ,KAAK,IAAI,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,SAAkB,EAAE,EAAa;IAC3D,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzB,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,EAAE,CAAC,WAAW,CACZ,+BAA+B,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,aAAa,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,6BAA6B,CACjI,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,WAAW,CAAC,yDAAyD,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO;IACT,CAAC;IACD,EAAE,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC"}

package/dist/cli/run.d.ts

@@ -0,0 +1,17 @@
+/**
+ * `pipelex-sdk run`: run one method and print its main output.
+ *
+ * Every check that needs no request comes first, in this order, so that a mistake costs nothing:
+ * the flags, `--pipe`'s form, the method (a path is read from disk), the inputs, the poll interval
+ * and the key. Then the inputs are prepared, which uploads each local file at a file input; the
+ * run is started through the SDK's start-and-wait, whose `onStarted` gives the run id to stderr
+ * as soon as the run exists; and the main output reaches stdout once the run completes, however
+ * long that takes.
+ */
+import type { CommandIO } from "./io.js";
+/** Run `pipelex-sdk run` and return its exit code. */
+export declare function runCommandRun(args: readonly string[], io: CommandIO): Promise<number>;
+/** The line under a failure that leaves it unknown whether a run was created. */
+export declare const RUN_MAY_HAVE_STARTED_LINE = "A run may have started on the server without the command learning of it, so check before starting it again.";
+/** The line under a failure met while waiting on a run that exists. */
+export declare function runStillGoingLine(runId: string): string;

package/dist/cli/run.js

@@ -0,0 +1,290 @@
+/**
+ * `pipelex-sdk run`: run one method and print its main output.
+ *
+ * Every check that needs no request comes first, in this order, so that a mistake costs nothing:
+ * the flags, `--pipe`'s form, the method (a path is read from disk), the inputs, the poll interval
+ * and the key. Then the inputs are prepared, which uploads each local file at a file input; the
+ * run is started through the SDK's start-and-wait, whose `onStarted` gives the run id to stderr
+ * as soon as the run exists; and the main output reaches stdout once the run completes, however
+ * long that takes.
+ */
+import { ApiResponseError, ApiUnreachableError, MissingMainStuffError, PipelineExecuteTimeoutError, RunFailedError, isGatewayCutOff, renderInputsTemplate, } from "../index.js";
+import { parseFlags } from "./args.js";
+import { readBundle } from "./bundle.js";
+import { makeClient, readPollInterval } from "./environment.js";
+import { RUN_HELP } from "./help.js";
+import { readInputs } from "./inputs.js";
+import { CommandError, EXIT_INTERRUPTED, EXIT_OK, Interrupted, untilInterrupted, usageError, writeLines, } from "./io.js";
+import { checkPipeRef, classifyMethod } from "./method.js";
+import { presentError, printResult } from "./present.js";
+import { crateSelector, describePipe, runSelector } from "./source.js";
+const RUN_FLAGS = {
+    method: { type: "string" },
+    pipe: { type: "string" },
+    inputs: { type: "string" },
+    "inputs-template": { type: "boolean" },
+};
+/** Run `pipelex-sdk run` and return its exit code. */
+export async function runCommandRun(args, io) {
+    const flags = parseFlags("run", args, RUN_FLAGS);
+    if (flags.help) {
+        io.writeStdout(RUN_HELP);
+        return EXIT_OK;
+    }
+    const method = flags.strings.get("method");
+    if (method === undefined) {
+        throw usageError("--method is required.", ["Run 'pipelex-sdk run --help' to see its flags."]);
+    }
+    const inputsSource = flags.strings.get("inputs");
+    const templateOnly = flags.booleans.has("inputs-template");
+    if (templateOnly && inputsSource !== undefined) {
+        throw usageError("--inputs-template prints the inputs a run takes, so it takes no --inputs.");
+    }
+    const pipe = flags.strings.get("pipe");
+    if (pipe !== undefined)
+        checkPipeRef(pipe);
+    let stage = { kind: "local" };
+    try {
+        // Raced like the inputs read: a bundle on a stalled mount must not hold the command.
+        const source = await untilInterrupted(() => methodSource(method), io.interrupt);
+        const inputs = inputsSource === undefined ? undefined : await readInputs(inputsSource, io);
+        const intervalMs = readPollInterval(io);
+        const client = makeClient(io);
+        if (templateOnly) {
+            const described = await describePipe(client, source, pipe, io.interrupt);
+            const template = renderInputsTemplate(described.descriptor, {
+                explicit: false,
+                format: "json",
+            });
+            io.writeStdout(`${template}\n`);
+            return EXIT_OK;
+        }
+        const prepared = await prepare(client, source, pipe, inputs, io);
+        const results = await untilInterrupted(() => {
+            return client.startAndWaitForResult({
+                ...runSelector(source),
+                ...(pipe === undefined ? {} : { pipe_code: pipe }),
+                ...(prepared === undefined ? {} : { inputs: prepared }),
+            }, {
+                // A run takes as long as it takes: the command waits for it until it ends or the
+                // person interrupts.
+                timeoutMs: Number.POSITIVE_INFINITY,
+                ...(intervalMs === undefined ? {} : { intervalMs }),
+                signal: io.interrupt,
+                artifacts: ["main_stuff"],
+                onStarting: () => {
+                    // Only once a request that may create a run is about to leave: an interrupt before
+                    // it, during the version handshake included, starts nothing, and the command says so.
+                    stage = { kind: "starting", since: performance.now() };
+                },
+                onStarted: (ack) => {
+                    if (io.interrupt.aborted)
+                        return;
+                    stage = { kind: "started", runId: ack.pipeline_run_id };
+                    io.writeStderr(`Run started: ${ack.pipeline_run_id}\n`);
+                },
+            });
+        }, io.interrupt);
+        printResult(results.main_stuff, io);
+        return EXIT_OK;
+    }
+    catch (error) {
+        if (!(error instanceof Interrupted)) {
+            const runId = waitedOnRun(stage, error);
+            const warning = runId !== undefined
+                ? runStillGoingLine(runId)
+                : mayHaveStarted(stage, error)
+                    ? RUN_MAY_HAVE_STARTED_LINE
+                    : undefined;
+            if (warning === undefined)
+                throw error;
+            // A failure that says nothing of a run that exists, or may: a wrapper must not read it as a
+            // failed run and pay for another.
+            const presented = presentError(error);
+            writeLines(io, [...presented.lines, warning]);
+            return presented.exitCode;
+        }
+        throw new CommandError(interruptMessage(stage, templateOnly), {
+            exitCode: EXIT_INTERRUPTED,
+            bare: true,
+        });
+    }
+}
+/**
+ * The run a failure leaves going on the server: the run that exists when the failure is not its
+ * own outcome, a failed run or a completed one without its output, but an unreachable API or a
+ * refused poll.
+ */
+function waitedOnRun(stage, error) {
+    if (stage.kind !== "started")
+        return undefined;
+    if (error instanceof RunFailedError || error instanceof MissingMainStuffError)
+        return undefined;
+    return stage.runId;
+}
+/**
+ * Whether a transport failure proves the request never left, so that no run was created by it: it
+ * names a step of the connection's set-up, which no request follows. That is the name lookup or
+ * the connection itself failing (the system calls `getaddrinfo` and `connect`: an unknown host, a
+ * refused connection, no route to the host or the network, the system's connect time limit),
+ * undici's own connect time limit, which covers the TLS handshake, and a server certificate the
+ * TLS handshake refused. Several addresses each failing so, which Node reports together as an
+ * `AggregateError`, prove it too. A host that drops packets is a connection that never comes:
+ * undici gives it up after ten seconds (`UND_ERR_CONNECT_TIMEOUT`), before the time limit of any
+ * request the command sends, as the Python command meets httpx's connect timeout first and reads
+ * it the same way.
+ *
+ * Anything else may have come once the request had left, the Python command reading the same
+ * failures the same way. A reset (`ECONNRESET`) comes from a `read` whether the connection dropped
+ * during the TLS handshake or after the request, and so does an `EHOSTUNREACH` met once connected,
+ * so neither proves anything; nor does another TLS failure, which may come after the handshake;
+ * nor does the SDK's own time limit (`ABORT_TIMEOUT`), which fetch cannot place before or after
+ * the connection was made. Every request the command sends has a limit longer than undici's
+ * connect limit, so with Node's own dispatcher it runs out only once the request has left.
+ */
+function provesNothingSent(error) {
+    // The SDK keeps fetch's own failure as `cause`, and undici gives the transport's under it.
+    const fetchFailure = error.cause;
+    return fetchFailure instanceof Error && isConnectionSetupFailure(fetchFailure.cause);
+}
+function isConnectionSetupFailure(failure) {
+    if (failure instanceof AggregateError) {
+        return failure.errors.length > 0 && failure.errors.every(isConnectionSetupFailure);
+    }
+    if (typeof failure !== "object" || failure === null)
+        return false;
+    const { code, syscall } = failure;
+    if (typeof code === "string" && CONNECTION_SETUP_CODES.has(code))
+        return true;
+    return typeof syscall === "string" && CONNECTION_SETUP_CALLS.has(syscall);
+}
+/** The system calls that resolve the host's name and open the connection. */
+const CONNECTION_SETUP_CALLS = new Set(["getaddrinfo", "connect"]);
+/**
+ * The codes only a step of the connection's set-up gives: the name lookup's and the connect call's
+ * own (set even where Node reports several addresses together, without a system call), undici's
+ * connect time limit, Node's limit on one attempt among several addresses, Node's own check of the
+ * host's name, and every code Node gives a server certificate the TLS handshake refused.
+ */
+const CONNECTION_SETUP_CODES = new Set([
+    "ECONNREFUSED",
+    "ENOTFOUND",
+    "EAI_AGAIN",
+    "UND_ERR_CONNECT_TIMEOUT",
+    "ERR_SOCKET_CONNECTION_TIMEOUT",
+    "ERR_TLS_CERT_ALTNAME_INVALID",
+    "ERR_TLS_CERT_ALTNAME_FORMAT",
+    // Node names the verdicts of OpenSSL's certificate check from a fixed table, the "X509 certificate
+    // error codes" of its `tls` docs, and gives every other verdict, such as an unhandled critical
+    // extension or a CA certificate that may not sign certificates, the code `UNSPECIFIED`. The
+    // error carries nothing else that marks it, so these codes are the mark: the table as Node 24
+    // compiles it, in its order, then its default. The Python command reads every
+    // `ssl.SSLCertVerificationError` the same way.
+    "UNABLE_TO_GET_ISSUER_CERT",
+    "UNABLE_TO_GET_CRL",
+    "UNABLE_TO_DECRYPT_CERT_SIGNATURE",
+    "UNABLE_TO_DECRYPT_CRL_SIGNATURE",
+    "UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY",
+    "CERT_SIGNATURE_FAILURE",
+    "CRL_SIGNATURE_FAILURE",
+    "CERT_NOT_YET_VALID",
+    "CERT_HAS_EXPIRED",
+    "CRL_NOT_YET_VALID",
+    "CRL_HAS_EXPIRED",
+    "ERROR_IN_CERT_NOT_BEFORE_FIELD",
+    "ERROR_IN_CERT_NOT_AFTER_FIELD",
+    "ERROR_IN_CRL_LAST_UPDATE_FIELD",
+    "ERROR_IN_CRL_NEXT_UPDATE_FIELD",
+    "OUT_OF_MEM",
+    "DEPTH_ZERO_SELF_SIGNED_CERT",
+    "SELF_SIGNED_CERT_IN_CHAIN",
+    "UNABLE_TO_GET_ISSUER_CERT_LOCALLY",
+    "UNABLE_TO_VERIFY_LEAF_SIGNATURE",
+    "CERT_CHAIN_TOO_LONG",
+    "CERT_REVOKED",
+    "INVALID_CA",
+    "PATH_LENGTH_EXCEEDED",
+    "INVALID_PURPOSE",
+    "CERT_UNTRUSTED",
+    "CERT_REJECTED",
+    "HOSTNAME_MISMATCH",
+    "UNSPECIFIED",
+]);
+/**
+ * Whether a failure met once a request that may create a run was sent, and before the API named
+ * the run, leaves it unknown whether one was created: its answer was lost to a time limit, a
+ * connection that closed once the request had left or a gateway that cut the request off, or it
+ * came back unreadable, or a gateway answered that it lost or never got the server's answer
+ * (`502`, `504`, RFC 9110). A gateway cuts a request off at ~30 seconds, whether a blocking
+ * execute or a start the server is still handling, such as one fetching a `method_ref`'s package:
+ * the SDK's `isGatewayCutOff` tells it, past its threshold, from the time since `onStarting`. Any
+ * other answer from the API, a `503` that came back before that saying the request was not handled
+ * included, and a failure that proves nothing was sent, say no run was created.
+ */
+function mayHaveStarted(stage, error) {
+    if (stage.kind !== "starting")
+        return false;
+    if (error instanceof PipelineExecuteTimeoutError)
+        return true;
+    if (error instanceof ApiUnreachableError)
+        return !provesNothingSent(error);
+    if (!(error instanceof ApiResponseError))
+        return false;
+    if (error.status >= 200 && error.status < 300)
+        return true;
+    return (GATEWAY_LOST_ANSWER.has(error.status) || isGatewayCutOff(error, performance.now() - stage.since));
+}
+/** The gateway statuses that say the server's answer was lost or never came (RFC 9110). */
+const GATEWAY_LOST_ANSWER = new Set([502, 504]);
+/** The line under a failure that leaves it unknown whether a run was created. */
+export const RUN_MAY_HAVE_STARTED_LINE = "A run may have started on the server without the command learning of it, so check before starting it again.";
+/** The line under a failure met while waiting on a run that exists. */
+export function runStillGoingLine(runId) {
+    return `Run ${runId} may still be going on the server, so do not start it again.`;
+}
+/** The method `--method` names, a path being read from disk. */
+async function methodSource(method) {
+    const selector = classifyMethod(method);
+    switch (selector.kind) {
+        case "address":
+            return { kind: "address", methodRef: selector.methodRef };
+        case "catalog":
+            return { kind: "catalog", methodId: selector.methodId };
+        case "path":
+            return { kind: "bundle", files: await readBundle(selector.path) };
+    }
+}
+/**
+ * Upload the local files the inputs name at the method's file inputs, through the SDK's input
+ * preparation, and report each upload on stderr. Inputs that are absent or empty are sent as they
+ * are, with no request: there is nothing to upload.
+ */
+async function prepare(client, source, pipe, inputs, io) {
+    if (inputs === undefined || Object.keys(inputs).length === 0)
+        return inputs;
+    const prepared = await untilInterrupted(() => client.prepareInputs({
+        ...crateSelector(source),
+        ...(pipe === undefined ? {} : { pipe_ref: pipe }),
+        inputs,
+        // Once interrupted, no upload starts after the pipe I/O answer arrives.
+        signal: io.interrupt,
+    }), io.interrupt);
+    for (const upload of prepared.uploads) {
+        io.writeStderr(`Uploaded ${upload.filename} as ${upload.uri}\n`);
+    }
+    return prepared.inputs;
+}
+/** What an interrupt says, by where the run stood. */
+function interruptMessage(stage, templateOnly) {
+    if (templateOnly)
+        return "Interrupted.";
+    switch (stage.kind) {
+        case "local":
+            return "Interrupted. No run was started.";
+        case "starting":
+            return "Interrupted before the API answered with a run id. A run may or may not have started on the server.";
+        case "started":
+            return `Interrupted. Run ${stage.runId} keeps going on the server.`;
+    }
+}
+//# sourceMappingURL=run.js.map

package/dist/cli/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/cli/run.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,cAAc,EACd,eAAe,EACf,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,UAAU,GACX,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGvE,MAAM,SAAS,GAAG;IAChB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1B,iBAAiB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;CAC9B,CAAC;AAYX,sDAAsD;AACtD,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAuB,EAAE,EAAa;IACxE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,UAAU,CAAC,uBAAuB,EAAE,CAAC,gDAAgD,CAAC,CAAC,CAAC;IAChG,CAAC;IACD,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3D,IAAI,YAAY,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/C,MAAM,UAAU,CAAC,2EAA2E,CAAC,CAAC;IAChG,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,IAAI,KAAK,SAAS;QAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,KAAK,GAAU,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACrC,IAAI,CAAC;QACH,qFAAqF;QACrF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;QAChF,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3F,MAAM,UAAU,GAAG,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAE9B,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,SAAS,CAAC,UAAU,EAAE;gBAC1D,QAAQ,EAAE,KAAK;gBACf,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,EAAE,CAAC,WAAW,CAAC,GAAG,QAAQ,IAAI,CAAC,CAAC;YAChC,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACjE,MAAM,OAAO,GAAe,MAAM,gBAAgB,CAAC,GAAG,EAAE;YACtD,OAAO,MAAM,CAAC,qBAAqB,CACjC;gBACE,GAAG,WAAW,CAAC,MAAM,CAAC;gBACtB,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;gBAClD,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;aACxD,EACD;gBACE,iFAAiF;gBACjF,qBAAqB;gBACrB,SAAS,EAAE,MAAM,CAAC,iBAAiB;gBACnC,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;gBACnD,MAAM,EAAE,EAAE,CAAC,SAAS;gBACpB,SAAS,EAAE,CAAC,YAAY,CAAC;gBACzB,UAAU,EAAE,GAAG,EAAE;oBACf,mFAAmF;oBACnF,sFAAsF;oBACtF,KAAK,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC;gBACzD,CAAC;gBACD,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;oBACjB,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO;wBAAE,OAAO;oBACjC,KAAK,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,eAAe,EAAE,CAAC;oBACxD,EAAE,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC,eAAe,IAAI,CAAC,CAAC;gBAC1D,CAAC;aACF,CACF,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;QACjB,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxC,MAAM,OAAO,GACX,KAAK,KAAK,SAAS;gBACjB,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC;gBAC1B,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC;oBAC5B,CAAC,CAAC,yBAAyB;oBAC3B,CAAC,CAAC,SAAS,CAAC;YAClB,IAAI,OAAO,KAAK,SAAS;gBAAE,MAAM,KAAK,CAAC;YACvC,4FAA4F;YAC5F,kCAAkC;YAClC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;YACtC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;YAC9C,OAAO,SAAS,CAAC,QAAQ,CAAC;QAC5B,CAAC;QACD,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE;YAC5D,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,KAAY,EAAE,KAAc;IAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC/C,IAAI,KAAK,YAAY,cAAc,IAAI,KAAK,YAAY,qBAAqB;QAAE,OAAO,SAAS,CAAC;IAChG,OAAO,KAAK,CAAC,KAAK,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAS,iBAAiB,CAAC,KAA0B;IACnD,2FAA2F;IAC3F,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC;IACjC,OAAO,YAAY,YAAY,KAAK,IAAI,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AACvF,CAAC;AAED,SAAS,wBAAwB,CAAC,OAAgB;IAChD,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;QACtC,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAClE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAgD,CAAC;IAC3E,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9E,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED,6EAA6E;AAC7E,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC;IAC1D,cAAc;IACd,WAAW;IACX,WAAW;IACX,yBAAyB;IACzB,+BAA+B;IAC/B,8BAA8B;IAC9B,6BAA6B;IAC7B,mGAAmG;IACnG,+FAA+F;IAC/F,4FAA4F;IAC5F,8FAA8F;IAC9F,8EAA8E;IAC9E,+CAA+C;IAC/C,2BAA2B;IAC3B,mBAAmB;IACnB,kCAAkC;IAClC,iCAAiC;IACjC,oCAAoC;IACpC,wBAAwB;IACxB,uBAAuB;IACvB,oBAAoB;IACpB,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,gCAAgC;IAChC,+BAA+B;IAC/B,gCAAgC;IAChC,gCAAgC;IAChC,YAAY;IACZ,6BAA6B;IAC7B,2BAA2B;IAC3B,mCAAmC;IACnC,iCAAiC;IACjC,qBAAqB;IACrB,cAAc;IACd,YAAY;IACZ,sBAAsB;IACtB,iBAAiB;IACjB,gBAAgB;IAChB,eAAe;IACf,mBAAmB;IACnB,aAAa;CACd,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,KAAY,EAAE,KAAc;IAClD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,YAAY,2BAA2B;QAAE,OAAO,IAAI,CAAC;IAC9D,IAAI,KAAK,YAAY,mBAAmB;QAAE,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3E,IAAI,CAAC,CAAC,KAAK,YAAY,gBAAgB,CAAC;QAAE,OAAO,KAAK,CAAC;IACvD,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;QAAE,OAAO,IAAI,CAAC;IAC3D,OAAO,CACL,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CACjG,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAErE,iFAAiF;AACjF,MAAM,CAAC,MAAM,yBAAyB,GACpC,6GAA6G,CAAC;AAEhH,uEAAuE;AACvE,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,OAAO,OAAO,KAAK,8DAA8D,CAAC;AACpF,CAAC;AAED,gEAAgE;AAChE,KAAK,UAAU,YAAY,CAAC,MAAc;IACxC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACxC,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC5D,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC1D,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IACtE,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,OAAO,CACpB,MAAwB,EACxB,MAAoB,EACpB,IAAwB,EACxB,MAA2C,EAC3C,EAAa;IAEb,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAC5E,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CACrC,GAAG,EAAE,CACH,MAAM,CAAC,aAAa,CAAC;QACnB,GAAG,aAAa,CAAC,MAAM,CAAC;QACxB,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACjD,MAAM;QACN,wEAAwE;QACxE,MAAM,EAAE,EAAE,CAAC,SAAS;KACrB,CAAC,EACJ,EAAE,CAAC,SAAS,CACb,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACtC,EAAE,CAAC,WAAW,CAAC,YAAY,MAAM,CAAC,QAAQ,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC;AACzB,CAAC;AAED,sDAAsD;AACtD,SAAS,gBAAgB,CAAC,KAAY,EAAE,YAAqB;IAC3D,IAAI,YAAY;QAAE,OAAO,cAAc,CAAC;IACxC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,OAAO;YACV,OAAO,kCAAkC,CAAC;QAC5C,KAAK,UAAU;YACb,OAAO,qGAAqG,CAAC;QAC/G,KAAK,SAAS;YACZ,OAAO,oBAAoB,KAAK,CAAC,KAAK,6BAA6B,CAAC;IACxE,CAAC;AACH,CAAC"}

package/dist/cli/script.d.ts

@@ -0,0 +1,23 @@
+/**
+ * `pipelex-sdk script`: write the per-method command, a short shell script that runs one method
+ * through this SDK's `run`, its version pinned.
+ *
+ * The checks that need no request come first, in this order: the flags, `--pipe`'s form, a
+ * control character in any value the script would carry, the method's form (a local bundle is
+ * refused), `--name`, `--dir`, the target file when its name is already known, and the key. Then
+ * one pipe I/O call checks the method and the pipe, which spends no inference; a catalog id with
+ * no `--name` is named from its catalog entry; and the file is written, never over an existing
+ * one, with the permissions of an executable, an interrupt meanwhile waiting until it is whole.
+ */
+import type { CommandIO } from "./io.js";
+/** The package a written script runs, and what its runner needs. */
+export declare const SCRIPT_RUNNER = "npx --yes @pipelex/sdk@0.34.0";
+export declare const SCRIPT_WRITER = "@pipelex/sdk";
+export declare const SCRIPT_NEEDS = "Node 22.12 or later";
+/** Run `pipelex-sdk script` and return its exit code. */
+export declare function runCommandScript(args: readonly string[], io: CommandIO): Promise<number>;
+/**
+ * The script's text: the shebang, a header saying what it runs, which SDK wrote it, what it needs
+ * and how to use it, and the one line that runs it, every value single-quoted.
+ */
+export declare function scriptBody(name: string, method: string, pipe: string | undefined): string;