@qawolf/api-contracts 0.26.0 → 0.27.0

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/package.json

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