@qawolf/api-contracts 0.26.0 → 0.29.0

package/dist/v1/runner/screen.d.ts

@@ -1,14 +1,5 @@
-import { z } from "zod";
-export declare const runnerScreenNotReadySchema: z.ZodObject<{
-    outcome: z.ZodLiteral<"screen-not-ready">;
-}, z.core.$strip>;
+export declare const screenFailureReasons: readonly ["runner-has-no-screen", "screen-needs-a-run", "screen-not-ready"];
 export declare const screenNotReadyDescription = "`screen-not-ready` if the runner has a screen that cannot serve this instant. Retry in a second or two: the desktop restarts when a run changes the display size, and it serves one see-or-act request at a time, so a screenshot or action already in flight is the usual reason. Do not submit a run to clear this \u2014 a run may restart the display and discard what is on it.";
-export declare const runnerScreenNeedsARunSchema: z.ZodObject<{
-    outcome: z.ZodLiteral<"screen-needs-a-run">;
-}, z.core.$strip>;
 export declare const screenNeedsARunDescription = "`screen-needs-a-run` if the runner's virtual desktop has never started. Waiting will not change this and retrying is pointless \u2014 call `runner.runFlow` with a flow that opens a browser, then ask for the screen again. On a runner image with a browser that has never run anything, any `runner.performAction` also starts the browser itself. Evaluating a snippet does not start the desktop.";
-export declare const runnerHasNoScreenSchema: z.ZodObject<{
-    outcome: z.ZodLiteral<"runner-has-no-screen">;
-}, z.core.$strip>;
-export declare const runnerHasNoScreenDescription = "`runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help \u2014 launch a `node20WithPlaywright` runner instead.";
+export declare const runnerHasNoScreenDescription = "`runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help \u2014 launch a `playwright` runner instead.";
 //# sourceMappingURL=screen.d.ts.map

package/dist/v1/runner/screen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/screen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,0BAA0B;;iBAErC,CAAC;AAEH,eAAO,MAAM,yBAAyB,yXAC6U,CAAC;AAIpX,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AAEH,eAAO,MAAM,0BAA0B,2YAC8V,CAAC;AAEtY,eAAO,MAAM,uBAAuB;;iBAElC,CAAC;AAEH,eAAO,MAAM,4BAA4B,2NAC4K,CAAC"}
+{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/screen.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,6EAIvB,CAAC;AAEX,eAAO,MAAM,yBAAyB,yXAC6U,CAAC;AAIpX,eAAO,MAAM,0BAA0B,2YAC8V,CAAC;AAEtY,eAAO,MAAM,4BAA4B,iNACkK,CAAC"}

package/dist/v1/runner/screen.js

@@ -1,16 +1,11 @@
-import { z } from "zod";
-export const runnerScreenNotReadySchema = z.object({
-    outcome: z.literal("screen-not-ready"),
-});
+export const screenFailureReasons = [
+    "runner-has-no-screen",
+    "screen-needs-a-run",
+    "screen-not-ready",
+];
 export const screenNotReadyDescription = "`screen-not-ready` if the runner has a screen that cannot serve this instant. Retry in a second or two: the desktop restarts when a run changes the display size, and it serves one see-or-act request at a time, so a screenshot or action already in flight is the usual reason. Do not submit a run to clear this — a run may restart the display and discard what is on it.";
-// Its own outcome, not a sentence inside `screen-not-ready`: the callers here are
+// Its own reason, not a sentence inside `screen-not-ready`: the callers here are
 // models, and an instruction that only exists in prose is one they may not follow.
-export const runnerScreenNeedsARunSchema = z.object({
-    outcome: z.literal("screen-needs-a-run"),
-});
 export const screenNeedsARunDescription = "`screen-needs-a-run` if the runner's virtual desktop has never started. Waiting will not change this and retrying is pointless — call `runner.runFlow` with a flow that opens a browser, then ask for the screen again. On a runner image with a browser that has never run anything, any `runner.performAction` also starts the browser itself. Evaluating a snippet does not start the desktop.";
-export const runnerHasNoScreenSchema = z.object({
-    outcome: z.literal("runner-has-no-screen"),
-});
-export const runnerHasNoScreenDescription = "`runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help — launch a `node20WithPlaywright` runner instead.";
+export const runnerHasNoScreenDescription = "`runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help — launch a `playwright` runner instead.";
 //# sourceMappingURL=screen.js.map

package/dist/v1/runner/screen.js.map

@@ -1 +1 @@
-{"version":3,"file":"screen.js","sourceRoot":"","sources":["../../../src/v1/runner/screen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;CACvC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GACpC,iXAAiX,CAAC;AAEpX,kFAAkF;AAClF,mFAAmF;AACnF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GACrC,mYAAmY,CAAC;AAEtY,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC;CAC3C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GACvC,mNAAmN,CAAC"}
+{"version":3,"file":"screen.js","sourceRoot":"","sources":["../../../src/v1/runner/screen.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,sBAAsB;IACtB,oBAAoB;IACpB,kBAAkB;CACV,CAAC;AAEX,MAAM,CAAC,MAAM,yBAAyB,GACpC,iXAAiX,CAAC;AAEpX,iFAAiF;AACjF,mFAAmF;AACnF,MAAM,CAAC,MAAM,0BAA0B,GACrC,mYAAmY,CAAC;AAEtY,MAAM,CAAC,MAAM,4BAA4B,GACvC,yMAAyM,CAAC"}

package/dist/v1/runner/stopRun.d.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+export declare const makeStopRunOnRunnerContract: () => {
+    readonly description: "Stop what a runner is currently executing, leaving the runner up and its browser on whatever page the run reached. Succeeds whether or not anything was running, and `wasRunning` says which. This is the counterpart of `runner.terminate`, which ends the runner itself. The run stops where it is, so the journal's `run-status` settles it as stopped rather than passed or failed. `runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. The stop may still have landed, but stopping a runner that is already idle does nothing, so retrying is safe.";
+    readonly input: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly kind: "write";
+    readonly name: "runner.stopRun";
+    readonly output: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        outcome: z.ZodLiteral<"success">;
+        wasRunning: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodObject<{
+        failureReason: z.ZodEnum<{
+            "runner-unreachable": "runner-unreachable";
+        }>;
+        outcome: z.ZodLiteral<"failure">;
+    }, z.core.$strip>], "outcome">;
+};
+//# sourceMappingURL=stopRun.d.ts.map

package/dist/v1/runner/stopRun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stopRun.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/stopRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;CA8BvC,CAAC"}

package/dist/v1/runner/stopRun.js

@@ -0,0 +1,26 @@
+import { z } from "zod";
+import { runnerIdSchema } from "./identity.js";
+import { makeRunnerFailureSchema } from "./outcome.js";
+import { runnerUnreachableFailureReason } from "./unreachable.js";
+export const makeStopRunOnRunnerContract = () => {
+    const input = z.object({
+        id: runnerIdSchema.describe("Id of the runner to stop the run on."),
+    });
+    const output = z.discriminatedUnion("outcome", [
+        z.object({
+            outcome: z.literal("success"),
+            wasRunning: z
+                .boolean()
+                .describe("False when the runner had nothing to stop: the run had already finished, or none had been submitted. Not an error."),
+        }),
+        makeRunnerFailureSchema([runnerUnreachableFailureReason]),
+    ]);
+    return {
+        description: "Stop what a runner is currently executing, leaving the runner up and its browser on whatever page the run reached. Succeeds whether or not anything was running, and `wasRunning` says which. This is the counterpart of `runner.terminate`, which ends the runner itself. The run stops where it is, so the journal's `run-status` settles it as stopped rather than passed or failed. `runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. The stop may still have landed, but stopping a runner that is already idle does nothing, so retrying is safe.",
+        input,
+        kind: "write",
+        name: "runner.stopRun",
+        output,
+    };
+};
+//# sourceMappingURL=stopRun.js.map

package/dist/v1/runner/stopRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stopRun.js","sourceRoot":"","sources":["../../../src/v1/runner/stopRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAC;AAElE,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,EAAE;IAC9C,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,sCAAsC,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE;QAC7C,CAAC,CAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YAC7B,UAAU,EAAE,CAAC;iBACV,OAAO,EAAE;iBACT,QAAQ,CACP,oHAAoH,CACrH;SACJ,CAAC;QACF,uBAAuB,CAAC,CAAC,8BAA8B,CAAC,CAAC;KAC1D,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,ooBAAooB;QACtoB,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,gBAAgB;QACtB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/runner/takeScreenshot.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 export declare const makeTakeScreenshotOnRunnerContract: () => {
-    readonly description: "Take one screenshot of an interactive runner's screen. The image is the runner's whole virtual desktop, browser window and all. `screen-needs-a-run` if the runner's virtual desktop has never started. Waiting will not change this and retrying is pointless — call `runner.runFlow` with a flow that opens a browser, then ask for the screen again. On a runner image with a browser that has never run anything, any `runner.performAction` also starts the browser itself. Evaluating a snippet does not start the desktop. `screen-not-ready` if the runner has a screen that cannot serve this instant. Retry in a second or two: the desktop restarts when a run changes the display size, and it serves one see-or-act request at a time, so a screenshot or action already in flight is the usual reason. Do not submit a run to clear this — a run may restart the display and discard what is on it. `runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help — launch a `node20WithPlaywright` runner instead. `runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. Nothing was changed, so retrying is safe; if it persists, launch the runner again.";
+    readonly description: "Take one screenshot of an interactive runner's screen. The image is the runner's whole virtual desktop, browser window and all. `screen-needs-a-run` if the runner's virtual desktop has never started. Waiting will not change this and retrying is pointless — call `runner.runFlow` with a flow that opens a browser, then ask for the screen again. On a runner image with a browser that has never run anything, any `runner.performAction` also starts the browser itself. Evaluating a snippet does not start the desktop. `screen-not-ready` if the runner has a screen that cannot serve this instant. Retry in a second or two: the desktop restarts when a run changes the display size, and it serves one see-or-act request at a time, so a screenshot or action already in flight is the usual reason. Do not submit a run to clear this — a run may restart the display and discard what is on it. `runner-has-no-screen` if this runner is not one that runs a browser on a virtual desktop. Nothing about it can be seen or driven, and retrying will never help — launch a `playwright` runner instead. `runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. Nothing was changed, so retrying is safe; if it persists, launch the runner again.";
     readonly input: z.ZodObject<{
         id: z.ZodString;
     }, z.core.$strip>;
@@ -8,15 +8,15 @@ export declare const makeTakeScreenshotOnRunnerContract: () => {
     readonly name: "runner.takeScreenshot";
     readonly output: z.ZodDiscriminatedUnion<[z.ZodObject<{
         imageJpegBase64: z.ZodString;
-        outcome: z.ZodLiteral<"captured">;
+        outcome: z.ZodLiteral<"success">;
     }, z.core.$strip>, z.ZodObject<{
-        outcome: z.ZodLiteral<"screen-needs-a-run">;
-    }, z.core.$strip>, z.ZodObject<{
-        outcome: z.ZodLiteral<"screen-not-ready">;
-    }, z.core.$strip>, z.ZodObject<{
-        outcome: z.ZodLiteral<"runner-has-no-screen">;
-    }, z.core.$strip>, z.ZodObject<{
-        outcome: z.ZodLiteral<"runner-unreachable">;
+        failureReason: z.ZodEnum<{
+            "runner-unreachable": "runner-unreachable";
+            "runner-has-no-screen": "runner-has-no-screen";
+            "screen-needs-a-run": "screen-needs-a-run";
+            "screen-not-ready": "screen-not-ready";
+        }>;
+        outcome: z.ZodLiteral<"failure">;
     }, z.core.$strip>], "outcome">;
 };
 //# sourceMappingURL=takeScreenshot.d.ts.map

package/dist/v1/runner/takeScreenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"takeScreenshot.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/takeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkBxB,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;CAqC9C,CAAC"}
+{"version":3,"file":"takeScreenshot.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/takeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;CAqC9C,CAAC"}

package/dist/v1/runner/takeScreenshot.js

@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { runnerIdSchema } from "./identity.js";
-import { runnerHasNoScreenDescription, runnerHasNoScreenSchema, runnerScreenNeedsARunSchema, runnerScreenNotReadySchema, screenNeedsARunDescription, screenNotReadyDescription, } from "./screen.js";
-import { retryableRunnerUnreachableDescription, runnerUnreachableSchema, } from "./unreachable.js";
+import { makeRunnerFailureSchema } from "./outcome.js";
+import { runnerHasNoScreenDescription, screenFailureReasons, screenNeedsARunDescription, screenNotReadyDescription, } from "./screen.js";
+import { retryableRunnerUnreachableDescription, runnerUnreachableFailureReason, } from "./unreachable.js";
 export const makeTakeScreenshotOnRunnerContract = () => {
     const input = z.object({
         id: runnerIdSchema.describe("Id of the runner to take a screenshot of."),
@@ -16,12 +17,12 @@ export const makeTakeScreenshotOnRunnerContract = () => {
                 .string()
                 .min(1)
                 .describe("The screenshot, as a base64-encoded JPEG. Decode it and write the bytes to a `.jpg` file — writing this string to the file leaves you with base64 text rather than an image."),
-            outcome: z.literal("captured"),
+            outcome: z.literal("success"),
         }),
-        runnerScreenNeedsARunSchema,
-        runnerScreenNotReadySchema,
-        runnerHasNoScreenSchema,
-        runnerUnreachableSchema,
+        makeRunnerFailureSchema([
+            ...screenFailureReasons,
+            runnerUnreachableFailureReason,
+        ]),
     ]);
     return {
         description: `Take one screenshot of an interactive runner's screen. The image is the runner's whole virtual desktop, browser window and all. ${screenNeedsARunDescription} ${screenNotReadyDescription} ${runnerHasNoScreenDescription} ${retryableRunnerUnreachableDescription}`,

package/dist/v1/runner/takeScreenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"takeScreenshot.js","sourceRoot":"","sources":["../../../src/v1/runner/takeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,EACvB,2BAA2B,EAC3B,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,qCAAqC,EACrC,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,kCAAkC,GAAG,GAAG,EAAE;IACrD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,2CAA2C,CAAC;KACzE,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE;QAC7C,CAAC,CAAC,MAAM,CAAC;YACP,uEAAuE;YACvE,iEAAiE;YACjE,uEAAuE;YACvE,wBAAwB;YACxB,eAAe,EAAE,CAAC;iBACf,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,8KAA8K,CAC/K;YACH,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;SAC/B,CAAC;QACF,2BAA2B;QAC3B,0BAA0B;QAC1B,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EAAE,mIAAmI,0BAA0B,IAAI,yBAAyB,IAAI,4BAA4B,IAAI,qCAAqC,EAAE;QAClR,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,uBAAuB;QAC7B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"takeScreenshot.js","sourceRoot":"","sources":["../../../src/v1/runner/takeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EACL,4BAA4B,EAC5B,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,qCAAqC,EACrC,8BAA8B,GAC/B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,kCAAkC,GAAG,GAAG,EAAE;IACrD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,2CAA2C,CAAC;KACzE,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE;QAC7C,CAAC,CAAC,MAAM,CAAC;YACP,uEAAuE;YACvE,iEAAiE;YACjE,uEAAuE;YACvE,wBAAwB;YACxB,eAAe,EAAE,CAAC;iBACf,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,8KAA8K,CAC/K;YACH,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;SAC9B,CAAC;QACF,uBAAuB,CAAC;YACtB,GAAG,oBAAoB;YACvB,8BAA8B;SAC/B,CAAC;KACH,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EAAE,mIAAmI,0BAA0B,IAAI,yBAAyB,IAAI,4BAA4B,IAAI,qCAAqC,EAAE;QAClR,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,uBAAuB;QAC7B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/runner/unreachable.d.ts

@@ -1,16 +1,13 @@
-import { z } from "zod";
 /**
  * The one answer every verb that talks to a live runner can give instead of
  * doing the work. One condition, because telling pod states apart would commit
- * a published contract to a taxonomy of transient ones. Carries no advice —
- * whether a retry is safe differs per verb, and each verb says so itself.
+ * a published contract to a taxonomy of transient ones. Carries no advice,
+ * because whether a retry is safe differs per verb and each verb says so itself.
  */
-export declare const runnerUnreachableSchema: z.ZodObject<{
-    outcome: z.ZodLiteral<"runner-unreachable">;
-}, z.core.$strip>;
+export declare const runnerUnreachableFailureReason = "runner-unreachable";
 /**
  * For verbs that change nothing when they fail. A verb that may already have
- * taken effect must not use this — see `runner.runFlow`.
+ * taken effect must not use this. See `runner.runFlow`.
  */
 export declare const retryableRunnerUnreachableDescription = "`runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. Nothing was changed, so retrying is safe; if it persists, launch the runner again.";
 //# sourceMappingURL=unreachable.d.ts.map

package/dist/v1/runner/unreachable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unreachable.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/unreachable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;;iBAElC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,qCAAqC,oPACiM,CAAC"}
+{"version":3,"file":"unreachable.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/unreachable.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,uBAAuB,CAAC;AAEnE;;;GAGG;AACH,eAAO,MAAM,qCAAqC,oPACiM,CAAC"}

package/dist/v1/runner/unreachable.js

@@ -1,16 +1,13 @@
-import { z } from "zod";
 /**
  * The one answer every verb that talks to a live runner can give instead of
  * doing the work. One condition, because telling pod states apart would commit
- * a published contract to a taxonomy of transient ones. Carries no advice —
- * whether a retry is safe differs per verb, and each verb says so itself.
+ * a published contract to a taxonomy of transient ones. Carries no advice,
+ * because whether a retry is safe differs per verb and each verb says so itself.
  */
-export const runnerUnreachableSchema = z.object({
-    outcome: z.literal("runner-unreachable"),
-});
+export const runnerUnreachableFailureReason = "runner-unreachable";
 /**
  * For verbs that change nothing when they fail. A verb that may already have
- * taken effect must not use this — see `runner.runFlow`.
+ * taken effect must not use this. See `runner.runFlow`.
  */
 export const retryableRunnerUnreachableDescription = "`runner-unreachable` if the runner could not be reached: it may still be starting, it may have terminated after inactivity, or it may be too busy to answer. Nothing was changed, so retrying is safe; if it persists, launch the runner again.";
 //# sourceMappingURL=unreachable.js.map

package/dist/v1/runner/unreachable.js.map

@@ -1 +1 @@
-{"version":3,"file":"unreachable.js","sourceRoot":"","sources":["../../../src/v1/runner/unreachable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;CACzC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAChD,iPAAiP,CAAC"}
+{"version":3,"file":"unreachable.js","sourceRoot":"","sources":["../../../src/v1/runner/unreachable.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,oBAAoB,CAAC;AAEnE;;;GAGG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAChD,iPAAiP,CAAC"}

package/dist/v1/tag/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
 /**
  * The shared tag resource. Tag names are the public handle; there is no
  * public tag id.
@@ -8,10 +9,13 @@ export declare const makeTagResourceSchema: () => z.ZodObject<{
     name: z.ZodString;
     url: z.ZodURL;
 }, z.core.$strip>;
-export declare const makeCreateTagContract: () => {
+export declare const makeCreateTagContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
     readonly description: "Create a tag on the caller's team. Tags select flows in run.create.";
     readonly input: z.ZodObject<{
         name: z.ZodString;
+        workspaceId: z.ZodOptional<WorkspaceId>;
     }, z.core.$strip>;
     readonly kind: "write";
     readonly name: "tag.create";

package/dist/v1/tag/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v1/tag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;iBAiB/B,CAAC;AAEJ,eAAO,MAAM,qBAAqB;;;;;;;;;;;;CA6BjC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v1/tag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;iBAiB/B,CAAC;AAEJ,eAAO,MAAM,qBAAqB,GAAI,WAAW,SAAS,cAAc,EAAE,KAAK;IAC7E,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;CAkCA,CAAC"}

package/dist/v1/tag/index.js

@@ -18,7 +18,7 @@ export const makeTagResourceSchema = () => resource({
     // Every tag on a team shares this URL: the app has no per-tag page.
     urlFieldDescription: "Absolute URL of the team's tag settings page.",
 });
-export const makeCreateTagContract = () => {
+export const makeCreateTagContract = (ids) => {
     const input = z.object({
         name: z
             .string()
@@ -28,6 +28,9 @@ export const makeCreateTagContract = () => {
             // name must fail here, not as a database error.
             .max(255)
             .refine((name) => !name.includes(","), "Tag names cannot include commas."),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace to create the tag in. Required when authenticating with an organization or user API key."),
     });
     const output = makeTagResourceSchema();
     return {

package/dist/v1/tag/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/tag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,yEAAyE;AACzE,sDAAsD;AACtD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE,CACxC,QAAQ,CACN;IACE,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;QACT,qEAAqE;QACrE,gEAAgE;SAC/D,KAAK,CAAC,mBAAmB,CAAC;SAC1B,QAAQ,CACP,6DAA6D,CAC9D;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,EACD;IACE,oEAAoE;IACpE,mBAAmB,EAAE,+CAA+C;CACrE,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACxC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC;YACP,oEAAoE;YACpE,gDAAgD;aAC/C,GAAG,CAAC,GAAG,CAAC;aACR,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC7B,kCAAkC,CACnC;KACJ,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAC;IAEvC,OAAO;QACL,WAAW,EACT,qEAAqE;QACvE,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,YAAY;QAClB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/tag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,yEAAyE;AACzE,sDAAsD;AACtD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE,CACxC,QAAQ,CACN;IACE,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;QACT,qEAAqE;QACrE,gEAAgE;SAC/D,KAAK,CAAC,mBAAmB,CAAC;SAC1B,QAAQ,CACP,6DAA6D,CAC9D;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,EACD;IACE,oEAAoE;IACpE,mBAAmB,EAAE,+CAA+C;CACrE,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAqC,GAEzE,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC;YACP,oEAAoE;YACpE,gDAAgD;aAC/C,GAAG,CAAC,GAAG,CAAC;aACR,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC7B,kCAAkC,CACnC;QACH,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,wGAAwG,CACzG;KACJ,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAC;IAEvC,OAAO;QACL,WAAW,EACT,qEAAqE;QACvE,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,YAAY;QAClB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/tag/list.d.ts

@@ -1,7 +1,8 @@
 import { z } from "zod";
 import type { PublicIdSchema } from "../ids.js";
-export declare const makeListTagsContract: <FlowId extends PublicIdSchema>(ids: {
+export declare const makeListTagsContract: <FlowId extends PublicIdSchema, WorkspaceId extends PublicIdSchema>(ids: {
     flow: FlowId;
+    workspace: WorkspaceId;
 }) => {
     readonly description: "List the team's tags, alphabetical by name. Tag names select flows in run.create.";
     readonly input: z.ZodObject<{
@@ -9,6 +10,7 @@ export declare const makeListTagsContract: <FlowId extends PublicIdSchema>(ids:
         limit: z.ZodDefault<z.ZodNumber>;
         includeFlowIds: z.ZodDefault<z.ZodBoolean>;
         names: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        workspaceId: z.ZodOptional<WorkspaceId>;
     }, z.core.$strip>;
     readonly kind: "read";
     readonly name: "tag.list";

package/dist/v1/tag/list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/v1/tag/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,oBAAoB,GAAI,MAAM,SAAS,cAAc,EAAE,KAAK;IACvE,IAAI,EAAE,MAAM,CAAC;CACd;;;;;;;;;;;;;;;;;;;CA6CA,CAAC"}
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/v1/tag/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,oBAAoB,GAC/B,MAAM,SAAS,cAAc,EAC7B,WAAW,SAAS,cAAc,EAClC,KAAK;IACL,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;;;;CAkDA,CAAC"}

package/dist/v1/tag/list.js

@@ -13,6 +13,9 @@ export const makeListTagsContract = (ids) => {
             .max(100)
             .optional()
             .describe("Only list tags with these names. Matching is case sensitive. Omit to list all tags."),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace to list tags from. Required when authenticating with an organization or user API key."),
         ...makePaginationInputFields({ defaultLimit: 20, maxLimit: 100 }),
     });
     const output = z.object({

package/dist/v1/tag/list.js.map

@@ -1 +1 @@
-{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/v1/tag/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAgC,GAEnE,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,cAAc,EAAE,CAAC;aACd,OAAO,EAAE;aACT,OAAO,CAAC,KAAK,CAAC;aACd,QAAQ,CAAC,uDAAuD,CAAC;QACpE,KAAK,EAAE,CAAC;aACL,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,qFAAqF,CACtF;QACH,GAAG,yBAAyB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;KAClE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,UAAU,EAAE,gBAAgB;QAC5B,IAAI,EAAE,CAAC;aACJ,KAAK,CACJ,qBAAqB,EAAE,CAAC,MAAM,CAAC;YAC7B,OAAO,EAAE,CAAC;iBACP,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;iBACf,QAAQ,EAAE;iBACV,QAAQ,CACP,+EAA+E,CAChF;SACJ,CAAC,CACH;aACA,QAAQ,CAAC,wCAAwC,CAAC;KACtD,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,mFAAmF;QACrF,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,UAAU;QAChB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/v1/tag/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAGlC,GAGD,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,cAAc,EAAE,CAAC;aACd,OAAO,EAAE;aACT,OAAO,CAAC,KAAK,CAAC;aACd,QAAQ,CAAC,uDAAuD,CAAC;QACpE,KAAK,EAAE,CAAC;aACL,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,qFAAqF,CACtF;QACH,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,qGAAqG,CACtG;QACH,GAAG,yBAAyB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;KAClE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,UAAU,EAAE,gBAAgB;QAC5B,IAAI,EAAE,CAAC;aACJ,KAAK,CACJ,qBAAqB,EAAE,CAAC,MAAM,CAAC;YAC7B,OAAO,EAAE,CAAC;iBACP,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;iBACf,QAAQ,EAAE;iBACV,QAAQ,CACP,+EAA+E,CAChF;SACJ,CAAC,CACH;aACA,QAAQ,CAAC,wCAAwC,CAAC;KACtD,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,mFAAmF;QACrF,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,UAAU;QAChB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/api-contracts",
-  "version": "0.26.0",
+  "version": "0.29.0",
   "private": false,
   "description": "Versioned contracts for the QA Wolf public API",
   "repository": {