@sparkwing/sdk 0.0.0-stage → 0.68.2

package/README.md

@@ -1,3 +1,184 @@
-# Temporary Holding Version
+# @sparkwing/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Declare Sparkwing pipelines in TypeScript. The host schedules jobs and owns
+placement, retries, risk authorization, storage and credentials. SDK processes
+build declarations and execute the bodies and closures the host requests.
+
+```ts
+import { definePipeline, main } from "@sparkwing/sdk";
+
+definePipeline({
+  name: "check",
+  args: [{ name: "target", type: "string", default: "all" }],
+  secrets: [{ name: "DEPLOY_TOKEN", optional: true }],
+  plan(plan, run) {
+    const build = plan
+      .job("build", async (ctx) => {
+        await ctx.exec(["npm", "run", "build"]).run();
+        return { target: run.args.target };
+      })
+      .artifacts("dist/**");
+    plan
+      .job("report", async (ctx) => {
+        const output = await ctx.output(build);
+        await ctx.summary(`Built ${output?.target}`);
+      })
+      .needs(build)
+      .consumes(build, { into: "build-output" });
+  },
+});
+
+await main();
+```
+
+`name` is the registration key. The `entrypoint` of a `sparkwing.yaml`
+pipeline names it, and the run context's `pipeline` carries the invoked name.
+
+Declare allowed child runs with `job.startsChildren("deploy")` for the parent
+repository or `job.startsChildrenIn("gh:123", "publish")` for an explicit canonical
+repository key. Calls append targets and can be chained.
+
+Use an exact package version in `.sparkwing/package.json`. Its version selects
+the matching engine. The package requires Node.js 22.18 or later. The public
+API is [index.d.ts](index.d.ts).
+
+Numeric duration options use milliseconds. Memory uses bytes. Omitted options
+remain unset. Explicit zero remains zero, including an
+indefinite approval timeout. Argument values stay strings, including `int64`.
+The host validates arguments after describe and before planning. Empty defaults
+mean no default. Required arguments with non-empty defaults are refused. NaN and
+infinity are refused. Help and describe inspect declarations without requiring
+invocation values. Errors come from host preparation as `invalid_args`.
+Duration arguments use Go syntax such as `1h30m`, including `0`, `+0` and `-0`.
+String-array arguments use comma splitting, trimming and empty-item removal in
+both the raw argument map and typed values. The host trims enum choices and checks
+each list item. Scalar string values keep their whitespace.
+SDK declarations and direct `toDoc()` calls rely on host validation of argument
+schemas, plan graphs and secret declarations. Generated jobs carry argument
+declarations in their job specification. The host validates and prepares values
+from the accepted run snapshot after generation, then sends them with execution
+requests. Enable `extra` for supplied flags that only a generator declares. Annotation locations are validated
+by the host service; TypeScript retains transport type checks.
+Initial jobs may only use argument declarations discovered by zero-input describe,
+with job IDs allowed to change. The gated expansion path registers secrets for new
+generated declarations before execution.
+
+`Context` provides lazy secrets and plain variables, typed outputs, references,
+annotations, summaries, acknowledged masking, OIDC, child runs and cleanup.
+Command, Git, Docker, service and filesystem helpers use the same context
+and cancellation signal. Memo helpers declare input recipes for host evaluation. Plan callbacks declare work; helpers that perform I/O
+refuse calls during planning. Generated jobs reconstruct from recorded source
+output. The host validates the reconstructed declarations against accepted state.
+
+Step output reads stay within the current attempt. Before a step condition or
+body runs, the host supplies the terminal predecessor state. A skipped predecessor
+has no local output. A terminal step cannot run again in the same attempt.
+Run facts stay read-only across planning and retries, including trigger details
+and nested pull-request facts.
+Cancellation reaches bodies and every closure kind. A callback that finishes
+after cancellation still reports a failed invocation. The SDK acknowledges
+cancellation after the selected operations finish and receive their own replies.
+Closure evaluations run in request order. Canceling a queued evaluation returns
+without calling its author code or waiting for the running closure. Overlapping
+generator replays return the recorded declaration after the first evaluation.
+Service scopes also reject after cancellation when their callback returns normally.
+They remove their containers before rejecting. If removal fails, host cleanup
+stays registered and the cancellation error is preserved.
+
+Git fileset hashes omit files beneath literal directory paths in `.dockerignore`,
+including paths written without a trailing slash. Included file edits still
+change the hash.
+
+The host starts `node <entry> --sw-node-protocol`. Protocol 2 begins with hello,
+which supplies granted runner identity and an optional in-memory service binding.
+Requests and frames use private pipes. Standard output and error remain author
+output. No preload or environment bearer is used. The SDK does not filter debug
+logs or assign job identity to log frames.
+
+Every encoded frame must fit the 17 MiB wire limit. Oversized logs fail before
+writing. Typed job and step outputs also have a separate 16 MiB limit.
+Generated declarations use the frame budget. The Sparkwing host masks output and
+protocol payloads after receiving them from the SDK. Pipeline code run without a
+Sparkwing host has unmasked logs and errors.
+
+Memo helpers declare recipes in the plan. The executing host evaluates them
+against its checkout and effective job environment, under the job admission
+permit. Tracked inputs encode paths, entry types and file bytes or symlink target
+text. Tree inputs include regular files and skip symlinks. Custom callbacks return
+JSON values for host hashing. `memoKey` collects parts and performs no hashing.
+
+On Windows, the host supplies decimal handles through
+`--sw-protocol-handles <request>,<frame>`. A packaged native bridge converts them
+to Node descriptors and clears inheritance before SDK tools spawn. Independently
+imported modules may execute before SDK initialization.
+
+Build and verify each bridge in its matching native Windows MSVC environment,
+with Node and Go running on that architecture:
+
+```sh
+npm run release:native -- --version <engine-version> --headers <node-headers/include/node> --node-lib <node.lib> --arch x64
+```
+
+Repeat with `--arch arm64` on native Windows arm64. The command stamps both npm
+manifests, builds the bridge and runs `TestNativeProtocol` and
+`TestNativeConformance`. Missing, skipped or failed native tests stop the build.
+Each output directory contains `protocol.node` and a `verification.json` record
+bound to the engine version, bridge bytes and SDK sources.
+
+Build both architectures from the same source and version. Transfer their output
+directories to the package checkout, then assemble the package:
+
+```sh
+npm run release:pack -- --version <engine-version> --destination <output-directory>
+```
+
+The release package must contain `native/win32-x64/protocol.node` and
+`native/win32-arm64/protocol.node`. `npm pack` refuses the development version
+and inconsistent lockfile versions. It also checks both bridge files and their
+architecture and DLL headers. Both matching native verification records are
+required because header checks cannot prove that Node can load and use a bridge.
+The bridge source is in [native/protocol.c](native/protocol.c). End users need
+no compiler.
+
+## Local dogfooding
+
+On Linux or macOS, build a local package without Windows bridges:
+
+```sh
+npm ci
+npm run pack:local -- --version <engine-version> --destination <output-directory>
+```
+
+This command builds the SDK and stamps a temporary package with the exact engine
+release version. It leaves the source manifests unchanged. The tarball carries
+`private: true`, so npm refuses publication even with `--ignore-scripts`.
+Use `release:pack` with verified Windows bridges for published packages.
+Local packages support Linux and macOS. They cannot run on Windows.
+
+In the pipeline's package manifest, pin the tarball with
+`"@sparkwing/sdk": "file:vendor/sparkwing-sdk-<engine-version>.tgz"` and run
+`npm install` to record it in the lockfile. The tarball's package version selects
+the exact engine, including any prerelease suffix. Commit the tarball inside the
+repository if fetched checkouts need it. An editable SDK directory can use
+`file:../sdk` after building and stamping that directory's package version.
+
+For development, run `npm ci`, `npm run typecheck`, `npm test` and `npm run build`.
+The build emits ESM into `dist/`; package exports expose only the public root.
+The release process stamps `package.json` and its lockfile with the engine
+release version. Hello reads that package version.
+
+Run `npm run test:native` from this directory with the repository's Go toolchain
+installed and `GOWORK=off` when a parent workspace points at another checkout.
+The tests build the SDK and launch public-package fixtures with inherited
+Unix descriptors or Windows argv handles. It exchanges requests and replies
+using the Go contract types and check that a child tool cannot access the
+protocol pipes. A second fixture runs the same v2 corpus as the Go SDK, including
+strict plan validation, generated hashes, replay and canonical error envelopes. Use Node and Go for the same CPU architecture. On Windows,
+build the matching native bridge first. Missing Node, TypeScript dependencies
+or bridge binaries fail the test.
+
+The Go acceptance suite also runs SDK boundary tests for the protocol scenarios.
+These tests use native pipes, fake bound services and a temporary Git file remote.
+Run the native pipe test on Windows to verify raw handles there. Controller
+authorization, store transitions, artifact/memo persistence, real DinD and the
+six placement paths require their corresponding integration hosts.

package/dist/command.js

@@ -0,0 +1,272 @@
+import { spawn } from "node:child_process";
+import { randomUUID } from "node:crypto";
+import { isAbsolute, resolve } from "node:path";
+import { assertExecution, projectRoot } from "./scope.js";
+export const exitNotStarted = -1;
+const bindings = new WeakMap();
+export class ExecError extends Error {
+    command;
+    stdout;
+    stderr;
+    exitCode;
+    terminated;
+    constructor(result, terminated = "", cause) {
+        let message = terminated
+            ? `command terminated by ${terminated}: ${result.command}`
+            : result.exitCode === exitNotStarted
+                ? `command failed to start: ${result.command}`
+                : `command failed (exit ${result.exitCode}): ${result.command}`;
+        const output = result.stderr.trim() || result.stdout.trim();
+        if (cause instanceof Error && (terminated || result.exitCode === exitNotStarted))
+            message += `: ${cause.message}`;
+        else if (output)
+            message += `\n${output}`;
+        super(message, cause === undefined ? undefined : { cause });
+        this.name = "ExecError";
+        this.command = result.command;
+        this.stdout = result.stdout;
+        this.stderr = result.stderr;
+        this.exitCode = result.exitCode;
+        this.terminated = terminated;
+    }
+}
+export function registerCommandContext(ctx, emit, env = {}) {
+    bindings.set(ctx, { emit, env: { ...env } });
+}
+function binding(ctx) {
+    return bindings.get(ctx) ?? { emit: (event, attrs) => ctx.log.info(event, attrs), env: {} };
+}
+function deriveContext(ctx, signal, env) {
+    const derived = Object.create(ctx);
+    const registered = bindings.has(ctx);
+    Object.defineProperties(derived, {
+        signal: { value: signal, enumerable: true },
+        exec: {
+            value: (argv, options) => registered ? createCommand(derived, argv, options) : ctx.exec.call(derived, argv, { ...options, env: { ...env, ...options?.env } }),
+        },
+        bash: {
+            value: (script, options) => registered
+                ? createCommand(derived, ["bash", "-c", script], options)
+                : ctx.bash.call(derived, script, { ...options, env: { ...env, ...options?.env } }),
+        },
+    });
+    if (registered)
+        registerCommandContext(derived, binding(ctx).emit, env);
+    return derived;
+}
+export function withCommandEnv(ctx, env) {
+    return deriveContext(ctx, ctx.signal, { ...binding(ctx).env, ...env });
+}
+export function withSignal(ctx, signal) {
+    return deriveContext(ctx, signal, binding(ctx).env);
+}
+export function cleanupContext(ctx) {
+    return withSignal(ctx, new AbortController().signal);
+}
+export function createCommand(ctx, argv, options = {}) {
+    let cwd = options.cwd;
+    const env = Object.assign(Object.create(null), options.env);
+    const args = [argv[0], ...argv.slice(1)];
+    const execute = (capture) => runCommand(ctx, args, { ...(cwd === undefined ? {} : { cwd }), env, capture });
+    return {
+        dir(value) {
+            cwd = value;
+            return this;
+        },
+        env(name, value) {
+            env[name] = value;
+            return this;
+        },
+        envMap(values) {
+            Object.assign(env, values);
+            return this;
+        },
+        run() {
+            return execute(false);
+        },
+        capture() {
+            return execute(true);
+        },
+        async string() {
+            return (await execute(true)).stdout.trim();
+        },
+        async lines() {
+            return (await execute(true)).stdout
+                .split("\n")
+                .map((line) => line.trim())
+                .filter(Boolean);
+        },
+        async json() {
+            const result = await execute(true);
+            try {
+                return JSON.parse(result.stdout);
+            }
+            catch (cause) {
+                throw new Error(`parse JSON from ${result.command}`, { cause });
+            }
+        },
+        async mustBeEmpty(reason) {
+            const output = (await execute(true)).stdout.trim();
+            if (output)
+                throw new Error(`${reason}:\n${output}`);
+        },
+    };
+}
+const protocolEnv = new Set([
+    "SPARKWING_NODE_TOKEN",
+    "SPARKWING_AGENT_TOKEN",
+    "SPARKWING_CACHE_GRANT",
+    "SPARKWING_SOURCE_TOKEN",
+    "SPARKWING_API_TOKEN",
+    "SPARKWING_LEASE_TOKEN",
+    "SPARKWING_SECRETS_KEY",
+    "SPARKWING_SECRETS_PREVIOUS_KEY",
+    "SPARKWING_RELEASE_SIGNING_KEY",
+    "SPARKWING_NODE_URL",
+    "SPARKWING_PROTOCOL_HANDLES",
+    "SPARKWING_CONTROLLER_URL",
+]);
+function commandEnv(ctx, options) {
+    const env = Object.create(null);
+    for (const layer of [process.env, binding(ctx).env, options.env ?? {}]) {
+        for (const [name, value] of Object.entries(layer)) {
+            const key = process.platform === "win32" ? name.toUpperCase() : name;
+            if (!protocolEnv.has(key) && !key.startsWith("SPARKWING_NODE_CLAIM_"))
+                env[key] = value;
+        }
+    }
+    return env;
+}
+export function runInput(ctx, argv, input, options = {}) {
+    return runCommand(ctx, argv, { ...options, input, capture: true });
+}
+export async function runCommand(ctx, argv, options = {}) {
+    assertExecution();
+    const command = argv[0] === "bash" && argv[1] === "-c" && argv.length === 3 ? argv[2] : argv.join(" ");
+    const emit = binding(ctx).emit;
+    const started = performance.now();
+    let result = { command, stdout: "", stderr: "", exitCode: exitNotStarted };
+    let terminated = "";
+    emit("exec_start", { command });
+    try {
+        if (ctx.signal.aborted)
+            throw new ExecError(result, "cancellation", ctx.signal.reason);
+        const cwd = options.cwd !== undefined && isAbsolute(options.cwd) ? options.cwd : resolve(projectRoot(), options.cwd ?? "");
+        const child = spawn(argv[0], argv.slice(1), {
+            cwd,
+            env: commandEnv(ctx, options),
+            detached: process.platform !== "win32",
+            // safety: Only these three handles are inherited; protocol handles never enter a tool.
+            stdio: [options.input === undefined ? "ignore" : "pipe", "pipe", "pipe"],
+            windowsHide: true,
+        });
+        const completion = await collectCommand(ctx, child, options, emit);
+        result = { command, stdout: completion.stdout, stderr: completion.stderr, exitCode: completion.exitCode };
+        terminated = completion.terminated;
+        if (completion.cause !== undefined || result.exitCode !== 0 || terminated)
+            throw new ExecError(result, terminated, completion.cause);
+        return result;
+    }
+    catch (cause) {
+        const error = cause instanceof ExecError ? cause : new ExecError(result, terminated, cause);
+        terminated = error.terminated;
+        throw error;
+    }
+    finally {
+        emit("exec_end", { command, exit_code: result.exitCode, duration_ms: performance.now() - started, terminated });
+    }
+}
+function collectCommand(ctx, child, options, emit) {
+    return new Promise((resolveDone) => {
+        let cause;
+        let cancelled = false;
+        const kill = () => {
+            try {
+                terminate(child, commandEnv(ctx, {}));
+            }
+            catch (error) {
+                cause ??= error;
+            }
+        };
+        const abort = () => {
+            cancelled = true;
+            kill();
+        };
+        const onError = (error) => {
+            cause ??= error;
+            kill();
+        };
+        const commandID = randomUUID();
+        const stdout = collectStream(child.stdout, "stdout", `${commandID}:stdout`, options.stdout, options.capture === true, emit, onError);
+        const stderr = collectStream(child.stderr, "stderr", `${commandID}:stderr`, options.stderr, options.capture === true, emit, onError);
+        child.on("error", (error) => {
+            cause ??= error;
+        });
+        ctx.signal.addEventListener("abort", abort, { once: true });
+        if (ctx.signal.aborted)
+            abort();
+        child.once("close", (code, signal) => {
+            ctx.signal.removeEventListener("abort", abort);
+            resolveDone({
+                stdout: stdout(),
+                stderr: stderr(),
+                exitCode: cancelled || code === null || code < 0 ? exitNotStarted : code,
+                terminated: cancelled ? "cancellation" : signal ? "signal" : "",
+                cause: cancelled ? ctx.signal.reason : (cause ?? (signal ? new Error(`process received ${signal}`) : undefined)),
+            });
+        });
+        if (child.stdin) {
+            child.stdin.on("error", onError);
+            child.stdin.end(options.input);
+        }
+    });
+}
+function collectStream(stream, name, streamID, callback, silent, emit, onError) {
+    const chunks = [];
+    stream?.on("data", (chunk) => {
+        chunks.push(Buffer.from(chunk));
+        try {
+            callback?.(chunk);
+            if (!silent)
+                emit("exec_chunk", { stream: streamID, source: name, data: chunk.toString("base64") });
+        }
+        catch (error) {
+            onError(error);
+        }
+    });
+    stream?.on("error", onError);
+    stream?.once("end", () => {
+        if (silent)
+            return;
+        try {
+            emit("exec_chunk", { stream: streamID, source: name, end: true });
+        }
+        catch (error) {
+            onError(error);
+        }
+    });
+    return () => Buffer.concat(chunks).toString("utf8");
+}
+function terminate(child, env) {
+    if (child.pid === undefined)
+        return;
+    if (process.platform === "win32") {
+        const killer = spawn("taskkill", ["/pid", String(child.pid), "/T", "/F"], { env, stdio: "ignore", windowsHide: true });
+        killer.once("error", () => {
+            child.kill("SIGKILL");
+        });
+        killer.once("exit", (code) => {
+            if (code !== 0)
+                child.kill("SIGKILL");
+        });
+        return;
+    }
+    try {
+        process.kill(-child.pid, "SIGKILL");
+    }
+    catch (error) {
+        if (!(error instanceof Error && "code" in error && error.code === "ESRCH"))
+            throw error;
+    }
+}
+//# sourceMappingURL=command.js.map

package/dist/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC;AAOjC,MAAM,QAAQ,GAAG,IAAI,OAAO,EAA2B,CAAC;AAExD,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,UAAU,CAAc;IAEjC,YAAY,MAAkB,EAAE,aAA0B,EAAE,EAAE,KAAe;QAC3E,IAAI,OAAO,GAAG,UAAU;YACtB,CAAC,CAAC,yBAAyB,UAAU,KAAK,MAAM,CAAC,OAAO,EAAE;YAC1D,CAAC,CAAC,MAAM,CAAC,QAAQ,KAAK,cAAc;gBAClC,CAAC,CAAC,4BAA4B,MAAM,CAAC,OAAO,EAAE;gBAC9C,CAAC,CAAC,wBAAwB,MAAM,CAAC,QAAQ,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5D,IAAI,KAAK,YAAY,KAAK,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,QAAQ,KAAK,cAAc,CAAC;YAAE,OAAO,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;aAC7G,IAAI,MAAM;YAAE,OAAO,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1C,KAAK,CAAC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAY,EAAE,IAAa,EAAE,MAAwC,EAAE;IAC5G,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,OAAO,CAAC,GAAY;IAC3B,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;AAC9F,CAAC;AAED,SAAS,aAAa,CAAC,GAAY,EAAE,MAAmB,EAAE,GAAqC;IAC7F,MAAM,OAAO,GAAY,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE;QAC/B,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE;QAC3C,IAAI,EAAE;YACJ,KAAK,EAAE,CAAC,IAAoC,EAAE,OAAqB,EAAE,EAAE,CACrE,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC;SACtI;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,CAAC,MAAc,EAAE,OAAqB,EAAE,EAAE,CAC/C,UAAU;gBACR,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC;gBACzD,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC;SACvF;KACF,CAAC,CAAC;IACH,IAAI,UAAU;QAAE,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACxE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAY,EAAE,GAAqC;IAChF,OAAO,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAY,EAAE,MAAmB;IAC1D,OAAO,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,OAAO,UAAU,CAAC,GAAG,EAAE,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAY,EAAE,IAAoC,EAAE,UAAuB,EAAE;IACzG,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACtB,MAAM,GAAG,GAA2B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACpF,MAAM,IAAI,GAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IACrH,OAAO;QACL,GAAG,CAAC,KAAK;YACP,GAAG,GAAG,KAAK,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG,CAAC,IAAI,EAAE,KAAK;YACb,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,MAAM;YACX,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG;YACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,OAAO;YACL,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,KAAK,CAAC,MAAM;YACV,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,KAAK;YACT,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;iBAChC,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC1B,MAAM,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QACD,KAAK,CAAC,IAAI;YACR,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAM,CAAC;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QACD,KAAK,CAAC,WAAW,CAAC,MAAM;YACtB,MAAM,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,MAAM,MAAM,EAAE,CAAC,CAAC;QACvD,CAAC;KACF,CAAC;AACJ,CAAC;AASD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC;IAC1B,sBAAsB;IACtB,uBAAuB;IACvB,uBAAuB;IACvB,wBAAwB;IACxB,qBAAqB;IACrB,uBAAuB;IACvB,uBAAuB;IACvB,gCAAgC;IAChC,+BAA+B;IAC/B,oBAAoB;IACpB,4BAA4B;IAC5B,0BAA0B;CAC3B,CAAC,CAAC;AAEH,SAAS,UAAU,CAAC,GAAY,EAAE,OAAoB;IACpD,MAAM,GAAG,GAAsB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnD,KAAK,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,CAAC;QACvE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAClD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC1F,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,QAAQ,CACtB,GAAY,EACZ,IAAoC,EACpC,KAAa,EACb,UAAuB,EAAE;IAEzB,OAAO,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAY,EAAE,IAAoC,EAAE,UAA0B,EAAE;IAC/G,eAAe,EAAE,CAAC;IAClB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxG,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC/B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAClC,IAAI,MAAM,GAAe,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;IACvF,IAAI,UAAU,GAAgB,EAAE,CAAC;IACjC,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAChC,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO;YAAE,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;QAC3H,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YAC1C,GAAG;YACH,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,KAAK,OAAO;YACtC,uFAAuF;YACvF,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;YACxE,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC1G,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACnC,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,IAAI,UAAU;YAAE,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACrI,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,KAAK,YAAY,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5F,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAC9B,MAAM,KAAK,CAAC;IACd,CAAC;YAAS,CAAC;QACT,IAAI,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAClH,CAAC;AACH,CAAC;AAUD,SAAS,cAAc,CAAC,GAAY,EAAE,KAAmB,EAAE,OAAuB,EAAE,IAAa;IAC/F,OAAO,IAAI,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QACjC,IAAI,KAAc,CAAC;QACnB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,IAAI,CAAC;gBACH,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,KAAK,KAAK,KAAK,CAAC;YAClB,CAAC;QACH,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,SAAS,GAAG,IAAI,CAAC;YACjB,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAE,EAAE;YACjC,KAAK,KAAK,KAAK,CAAC;YAChB,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACrI,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACrI,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,KAAK,KAAK,KAAK,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO;YAAE,KAAK,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACnC,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC/C,WAAW,CAAC;gBACV,MAAM,EAAE,MAAM,EAAE;gBAChB,MAAM,EAAE,MAAM,EAAE;gBAChB,QAAQ,EAAE,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI;gBACxE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gBAC/D,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aACjH,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,aAAa,CACpB,MAA8B,EAC9B,IAAyB,EACzB,QAAgB,EAChB,QAAkC,EAClC,MAAe,EACf,IAAa,EACb,OAAiC;IAEjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;QACnC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC;YACH,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC;YAClB,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACtG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,EAAE,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7B,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE;QACvB,IAAI,MAAM;YAAE,OAAO;QACnB,IAAI,CAAC;YACH,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,SAAS,CAAC,KAAmB,EAAE,GAAsB;IAC5D,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS;QAAE,OAAO;IACpC,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACvH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YACxB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAI,IAAI,KAAK,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;YAAE,MAAM,KAAK,CAAC;IAC1F,CAAC;AACH,CAAC"}

package/dist/context.js

@@ -0,0 +1,69 @@
+import { createCommand, registerCommandContext } from "./command.js";
+import { SDKError, failure } from "./errors.js";
+import { LogWriter } from "./log.js";
+export function makeContext(options) {
+    const { run, signal, jobId } = options;
+    const log = new LogWriter(options.frames, options.stepId);
+    const services = () => {
+        signal.throwIfAborted();
+        if (!options.services)
+            throw failure("unavailable", "this process has no bound host services");
+        return options.services;
+    };
+    const read = async (name, variable) => {
+        const declaration = options.definition.secrets?.find((s) => s.name === name && Boolean(s.variable) === variable);
+        if (!declaration)
+            throw failure("forbidden", "value was not declared by this pipeline", { reason: "secret_undeclared" });
+        try {
+            return await services().secret(name, signal);
+        }
+        catch (error) {
+            if (declaration.optional && error instanceof SDKError && error.code === "not_found")
+                return undefined;
+            throw error;
+        }
+    };
+    const ctx = {
+        run,
+        jobId,
+        args: options.args,
+        dryRun: run.dryRun,
+        runner: run.runner,
+        signal,
+        log,
+        ...(options.stepId === undefined ? {} : { stepId: options.stepId }),
+        ...(options.failure === undefined ? {} : { failure: options.failure }),
+        secret: (name) => read(name, false),
+        variable: (name) => read(name, true),
+        output: (job) => services().output(typeof job === "string" ? job : job.id, signal),
+        stepOutput: (step) => options.outputs.get(typeof step === "string" ? step : step.id),
+        annotate: async (annotation) => {
+            checkAnnotation(annotation);
+            await services().annotate(annotation, signal, options.stepId);
+        },
+        summary: async (markdown) => {
+            if (typeof markdown !== "string")
+                throw failure("bad_request", "summary markdown must be a string");
+            await services().summary(markdown, signal, options.stepId);
+        },
+        mask: (value) => services().mask(value, signal),
+        oidcToken: (audience) => services().oidcToken(audience, signal),
+        runPipeline: (pipeline, job, child = {}) => services().runPipeline(pipeline, job, child, signal),
+        latest: (ref) => services().latest(ref, signal),
+        cleanup: (spec) => services().cleanup(spec, signal),
+        exec: (argv, opts) => createCommand(ctx, argv, opts),
+        bash: (script, opts) => createCommand(ctx, ["bash", "-c", script], opts),
+    };
+    registerCommandContext(ctx, (event, attrs) => log.event(event, attrs), options.bodyEnv);
+    return ctx;
+}
+function checkAnnotation(annotation) {
+    if (typeof annotation.message !== "string")
+        throw failure("bad_request", "annotation message must be a string");
+    if (annotation.level !== undefined && typeof annotation.level !== "string")
+        throw failure("bad_request", "annotation level must be a string");
+    for (const value of [annotation.line, annotation.endLine, annotation.column])
+        if (value !== undefined && !Number.isSafeInteger(value))
+            throw failure("bad_request", "annotation location must be an integer");
+}
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,SAAS,EAAiB,MAAM,UAAU,CAAC;AAgBpD,MAAM,UAAU,WAAW,CAAC,OAAuB;IACjD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACvC,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,GAAiB,EAAE;QAClC,MAAM,CAAC,cAAc,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,QAAQ;YAAE,MAAM,OAAO,CAAC,aAAa,EAAE,yCAAyC,CAAC,CAAC;QAC/F,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC1B,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,KAAK,EAAE,IAAY,EAAE,QAAiB,EAA+B,EAAE;QAClF,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAAC;QACjH,IAAI,CAAC,WAAW;YAAE,MAAM,OAAO,CAAC,WAAW,EAAE,yCAAyC,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;QACzH,IAAI,CAAC;YACH,OAAO,MAAM,QAAQ,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,WAAW,CAAC,QAAQ,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;gBAAE,OAAO,SAAS,CAAC;YACtG,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IACF,MAAM,GAAG,GAAY;QACnB,GAAG;QACH,KAAK;QACL,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,MAAM;QACN,GAAG;QACH,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACnE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;QACtE,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;QACnC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;QACpC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC;QAClF,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAU;QAC7F,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YAC7B,eAAe,CAAC,UAAU,CAAC,CAAC;YAC5B,MAAM,QAAQ,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC1B,IAAI,OAAO,QAAQ,KAAK,QAAQ;gBAAE,MAAM,OAAO,CAAC,aAAa,EAAE,mCAAmC,CAAC,CAAC;YACpG,MAAM,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;QAC/C,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC/D,WAAW,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAChG,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC;QAC/C,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;QACnD,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC;QACpD,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC;KACzE,CAAC;IACF,sBAAsB,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxF,OAAO,GAAG,CAAC;AACb,CAAC;AACD,SAAS,eAAe,CAAC,UAAsB;IAC7C,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ;QAAE,MAAM,OAAO,CAAC,aAAa,EAAE,qCAAqC,CAAC,CAAC;IAChH,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ;QAAE,MAAM,OAAO,CAAC,aAAa,EAAE,mCAAmC,CAAC,CAAC;IAC9I,KAAK,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC;QAC1E,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC;YACrD,MAAM,OAAO,CAAC,aAAa,EAAE,wCAAwC,CAAC,CAAC;AAC7E,CAAC"}

package/dist/describe.js

@@ -0,0 +1,70 @@
+import { Plan, pipelines } from "./plan.js";
+import { SDKError, errorFields } from "./errors.js";
+export function argument(spec, jobID) {
+    const arg = { name: spec.name, type: spec.type, required: spec.required ?? false };
+    if (spec.short !== undefined)
+        arg.short = spec.short;
+    if (spec.description !== undefined)
+        arg.desc = spec.description;
+    if (spec.default !== undefined && spec.default !== "")
+        arg.default = spec.default;
+    if (spec.enum !== undefined)
+        arg.enum = [...spec.enum];
+    if (spec.secret !== undefined)
+        arg.secret = spec.secret;
+    if (jobID !== undefined)
+        arg.job_id = jobID;
+    return arg;
+}
+export async function describe(run) {
+    const descriptions = [];
+    const definitions = pipelines();
+    for (const definition of definitions) {
+        const plan = new Plan();
+        try {
+            const entry = { name: definition.name, args: (definition.args ?? []).map((spec) => argument(spec)) };
+            if (definition.short !== undefined)
+                entry.short = definition.short;
+            const help = definition.help ?? definition.description;
+            if (help !== undefined)
+                entry.help = help;
+            if (definition.extra !== undefined)
+                entry.extra = definition.extra;
+            if (definition.examples)
+                entry.examples = definition.examples.map((example) => ({ command: example.command, comment: example.comment ?? "" }));
+            if (definition.envVars)
+                entry.env_vars = definition.envVars.map((env) => ({ ...env }));
+            if (definition.secrets)
+                entry.secrets = definition.secrets.map((secret) => ({
+                    name: secret.name,
+                    ...(secret.optional === undefined ? {} : { optional: secret.optional }),
+                }));
+            const args = {};
+            await definition.plan(plan, { ...run, pipeline: definition.name, args });
+            const risks = new Set();
+            const byStep = [];
+            for (const job of plan.jobs()) {
+                entry.args.push(...job.argSpecs().map((spec) => argument(spec, job.id)));
+                for (const step of job.steps()) {
+                    const labels = step.toSpec().risks ?? [];
+                    if (labels.length)
+                        byStep.push({ job_id: job.id, step_id: step.id, labels });
+                    for (const label of labels)
+                        risks.add(label);
+                }
+            }
+            if (risks.size)
+                entry.risks = [...risks].sort();
+            if (byStep.length)
+                entry.risks_by_step = byStep;
+            plan.seal();
+            descriptions.push(entry);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            descriptions.push({ name: definition.name, args: [], error: errorFields(new SDKError(`describe pipeline ${JSON.stringify(definition.name)}: ${message}`, { code: "plan_failed" })) });
+        }
+    }
+    return { pipelines: descriptions };
+}
+//# sourceMappingURL=describe.js.map

package/dist/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAoB,MAAM,aAAa,CAAC;AA8BtE,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,KAAc;IACpD,MAAM,GAAG,GAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC;IAChG,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;QAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACrD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IAChE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE;QAAE,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAClF,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;QAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACxD,IAAI,KAAK,KAAK,SAAS;QAAE,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC;IAC5C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAe;IAC5C,MAAM,YAAY,GAAuB,EAAE,CAAC;IAC5C,MAAM,WAAW,GAAG,SAAS,EAAE,CAAC;IAChC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACvH,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;gBAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YACnE,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,WAAW,CAAC;YACvD,IAAI,IAAI,KAAK,SAAS;gBAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;YAC1C,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;gBAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YACnE,IAAI,UAAU,CAAC,QAAQ;gBACrB,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YACxH,IAAI,UAAU,CAAC,OAAO;gBAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;YACvF,IAAI,UAAU,CAAC,OAAO;gBACpB,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;oBAClD,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;iBACxE,CAAC,CAAC,CAAC;YACN,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACzE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;YAChC,MAAM,MAAM,GAAmD,EAAE,CAAC;YAClE,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACzE,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC;oBAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAM,CAAC,MAAM;wBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;oBAC7E,KAAK,MAAM,KAAK,IAAI,MAAM;wBAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;YACD,IAAI,KAAK,CAAC,IAAI;gBAAE,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;YAChD,IAAI,MAAM,CAAC,MAAM;gBAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC;YAChD,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,QAAQ,CAAC,qBAAqB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACxL,CAAC;IACH,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;AACrC,CAAC"}