@qawolf/api-contracts 0.20.0 → 0.22.0

package/dist/v1/index.js

@@ -1,12 +1,29 @@
 export { identityResponse } from "./identity/index.js";
 export { defaultIdSchemas, } from "./ids.js";
 export { makeFlowSelectionSchema } from "./run/index.js";
+// Carries the reservation of QA Wolf's own variable names, which the server
+// validates with rather than restating — a second copy of that rule is how the
+// reservation comes to differ from what is actually stamped.
+export { runEnvironmentSchema } from "./runner/environment.js";
+// The travel rule for files bound for a runner: which files travel, how much may
+// travel, and what environment a run may carry. A client needs the predicate and
+// the size bounds to collect and pre-check with; the schemas are also what the
+// server and the runner validate with, so they are shared rather than restated.
+export { isShippableRunFilePath, runFilePathSchema, runPackageJsonPath, shippableRunFileExtensions, } from "./runner/files.js";
+export { makeRunnerSchema, runnerIdSchema, runnerNameSchema, } from "./runner/identity.js";
+// A journal read is answered verbatim by the public API, so its wire shapes are
+// published here and the private journal package imports them from here.
+export { journalEntrySchema, journalStreamSchema, knownJournalStreams, maxJournalStreamNameLength, readJournalRequestSchema, readJournalResponseSchema, } from "./runner/journal.js";
+export { maxRunFilesByteLength, maxRunnerRequestEncodedByteLength, runFilesByteLength, runFilesSchema, } from "./runner/payloadSize.js";
 import { makeAutomateContract } from "./automate/index.js";
 import { makeDeleteEnvironmentVariableContract } from "./environment/deleteVariable.js";
 import { makeFindEnvironmentsContract } from "./environment/find.js";
+import { makeGetEnvironmentVariableContract } from "./environment/getVariable.js";
 import { makeCreateEnvironmentContract, makeGetEnvironmentContract, makeListEnvironmentVariableNamesContract, makeSetEnvironmentVariableContract, } from "./environment/index.js";
+import { makeUpdateEnvironmentContract } from "./environment/update.js";
 import { makeAddTagToFlowsContract } from "./flow/addTag.js";
 import { makeListFlowsContract } from "./flow/index.js";
+import { makeUpdateFlowContract } from "./flow/update.js";
 import { defaultIdSchemas, } from "./ids.js";
 import { makeCreateIssueContract } from "./issue/create.js";
 import { makeFindIssuesContract, makeGetIssueContract } from "./issue/index.js";
@@ -14,6 +31,10 @@ import { makeUpdateIssueContract } from "./issue/update.js";
 import { makeFindRunsContract } from "./run/find.js";
 import { makeGetRunContract } from "./run/get.js";
 import { makeCreateRunContract } from "./run/index.js";
+import { makeEvaluateSnippetOnRunnerContract } from "./runner/evaluateSnippet.js";
+import { makeLaunchRunnerContract, makeStopRunnerContract, } from "./runner/index.js";
+import { makeReadRunnerJournalContract } from "./runner/readJournal.js";
+import { makeRunFlowOnRunnerContract } from "./runner/runFlow.js";
 import { makeCreateTagContract } from "./tag/index.js";
 import { makeListTagsContract } from "./tag/list.js";
 /**
@@ -34,12 +55,15 @@ export const makeContractsV1 = (ids) => {
             deleteVariable: makeDeleteEnvironmentVariableContract(resolvedIds),
             find: makeFindEnvironmentsContract(resolvedIds),
             get: makeGetEnvironmentContract(resolvedIds),
+            getVariable: makeGetEnvironmentVariableContract(resolvedIds),
             listVariableNames: makeListEnvironmentVariableNamesContract(resolvedIds),
             setVariable: makeSetEnvironmentVariableContract(resolvedIds),
+            update: makeUpdateEnvironmentContract(resolvedIds),
         },
         flow: {
             addTag: makeAddTagToFlowsContract(resolvedIds),
             list: makeListFlowsContract(resolvedIds),
+            update: makeUpdateFlowContract(resolvedIds),
         },
         issue: {
             create: makeCreateIssueContract(resolvedIds),
@@ -52,6 +76,13 @@ export const makeContractsV1 = (ids) => {
             find: makeFindRunsContract(resolvedIds),
             get: makeGetRunContract(resolvedIds),
         },
+        runner: {
+            evaluateSnippet: makeEvaluateSnippetOnRunnerContract(),
+            launch: makeLaunchRunnerContract(),
+            readJournal: makeReadRunnerJournalContract(),
+            runFlow: makeRunFlowOnRunnerContract(),
+            stop: makeStopRunnerContract(),
+        },
         tag: {
             create: makeCreateTagContract(),
             list: makeListTagsContract(resolvedIds),

package/dist/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAyB,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,qCAAqC,EAAE,MAAM,iCAAiC,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EACL,6BAA6B,EAC7B,0BAA0B,EAC1B,wCAAwC,EACxC,kCAAkC,GACnC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAUrD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAQ7B,GAOC,EACD,EAAE;IACF,MAAM,WAAW,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,GAAG,EAAE,CAAC;IACpD,OAAO;QACL,qEAAqE;QACrE,0CAA0C;QAC1C,QAAQ,EAAE,oBAAoB,CAAC,WAAW,CAAC;QAC3C,WAAW,EAAE;YACX,MAAM,EAAE,6BAA6B,CAAC,WAAW,CAAC;YAClD,cAAc,EAAE,qCAAqC,CAAC,WAAW,CAAC;YAClE,IAAI,EAAE,4BAA4B,CAAC,WAAW,CAAC;YAC/C,GAAG,EAAE,0BAA0B,CAAC,WAAW,CAAC;YAC5C,iBAAiB,EAAE,wCAAwC,CAAC,WAAW,CAAC;YACxE,WAAW,EAAE,kCAAkC,CAAC,WAAW,CAAC;SAC7D;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,yBAAyB,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,qBAAqB,CAAC,WAAW,CAAC;SACzC;QACD,KAAK,EAAE;YACL,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,sBAAsB,CAAC,WAAW,CAAC;YACzC,GAAG,EAAE,oBAAoB,CAAC,WAAW,CAAC;YACtC,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC;SAC7C;QACD,GAAG,EAAE;YACH,MAAM,EAAE,qBAAqB,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC;YACvC,GAAG,EAAE,kBAAkB,CAAC,WAAW,CAAC;SACrC;QACD,GAAG,EAAE;YACH,MAAM,EAAE,qBAAqB,EAAE;YAC/B,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC;SACxC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAyB,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,4EAA4E;AAC5E,+EAA+E;AAC/E,6DAA6D;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,iFAAiF;AACjF,iFAAiF;AACjF,+EAA+E;AAC/E,gFAAgF;AAChF,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,GAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,gFAAgF;AAChF,yEAAyE;AACzE,OAAO,EAML,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,qBAAqB,EACrB,iCAAiC,EACjC,kBAAkB,EAClB,cAAc,GACf,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,qCAAqC,EAAE,MAAM,iCAAiC,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,6BAA6B,EAC7B,0BAA0B,EAC1B,wCAAwC,EACxC,kCAAkC,GACnC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,mCAAmC,EAAE,MAAM,6BAA6B,CAAC;AAClF,OAAO,EACL,wBAAwB,EACxB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAUrD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAQ7B,GAOC,EACD,EAAE;IACF,MAAM,WAAW,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,GAAG,EAAE,CAAC;IACpD,OAAO;QACL,qEAAqE;QACrE,0CAA0C;QAC1C,QAAQ,EAAE,oBAAoB,CAAC,WAAW,CAAC;QAC3C,WAAW,EAAE;YACX,MAAM,EAAE,6BAA6B,CAAC,WAAW,CAAC;YAClD,cAAc,EAAE,qCAAqC,CAAC,WAAW,CAAC;YAClE,IAAI,EAAE,4BAA4B,CAAC,WAAW,CAAC;YAC/C,GAAG,EAAE,0BAA0B,CAAC,WAAW,CAAC;YAC5C,WAAW,EAAE,kCAAkC,CAAC,WAAW,CAAC;YAC5D,iBAAiB,EAAE,wCAAwC,CAAC,WAAW,CAAC;YACxE,WAAW,EAAE,kCAAkC,CAAC,WAAW,CAAC;YAC5D,MAAM,EAAE,6BAA6B,CAAC,WAAW,CAAC;SACnD;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,yBAAyB,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,qBAAqB,CAAC,WAAW,CAAC;YACxC,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC;SAC5C;QACD,KAAK,EAAE;YACL,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,sBAAsB,CAAC,WAAW,CAAC;YACzC,GAAG,EAAE,oBAAoB,CAAC,WAAW,CAAC;YACtC,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC;SAC7C;QACD,GAAG,EAAE;YACH,MAAM,EAAE,qBAAqB,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC;YACvC,GAAG,EAAE,kBAAkB,CAAC,WAAW,CAAC;SACrC;QACD,MAAM,EAAE;YACN,eAAe,EAAE,mCAAmC,EAAE;YACtD,MAAM,EAAE,wBAAwB,EAAE;YAClC,WAAW,EAAE,6BAA6B,EAAE;YAC5C,OAAO,EAAE,2BAA2B,EAAE;YACtC,IAAI,EAAE,sBAAsB,EAAE;SAC/B;QACD,GAAG,EAAE;YACH,MAAM,EAAE,qBAAqB,EAAE;YAC/B,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC;SACxC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC"}

package/dist/v1/run/get.d.ts

@@ -29,6 +29,7 @@ export declare const makeGetRunContract: <FlowId extends PublicIdSchema, RunId e
                 passed: "passed";
             }>;
         }, z.core.$strip>], "status">>;
+        runId: RunId;
         completedAt: z.ZodOptional<z.ZodISODateTime>;
         createdAt: z.ZodISODateTime;
         git: z.ZodObject<{
@@ -37,7 +38,6 @@ export declare const makeGetRunContract: <FlowId extends PublicIdSchema, RunId e
             commitSha: z.ZodOptional<z.ZodString>;
             commitUrl: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>;
-        runId: RunId;
         status: z.ZodEnum<{
             running: "running";
             canceled: "canceled";

package/dist/v1/run/get.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/v1/run/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,kBAAkB,GAC7B,MAAM,SAAS,cAAc,EAC7B,KAAK,SAAS,cAAc,EAC5B,KAAK;IACL,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DA,CAAC"}
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/v1/run/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,kBAAkB,GAC7B,MAAM,SAAS,cAAc,EAC7B,KAAK,SAAS,cAAc,EAC5B,KAAK;IACL,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkEA,CAAC"}

package/dist/v1/run/get.js

@@ -43,6 +43,9 @@ export const makeGetRunContract = (ids) => {
     const output = resource({
         ...makeRunSummaryFields(ids),
         flows,
+        // Overrides the shared field: only this endpoint takes a run id, so only
+        // here can the answer describe a different run than the one requested.
+        runId: ids.run.describe("The run this response describes. Treat it as canonical: it can differ from the id you asked for. A deploy notification returns a run id before the run exists, and if a second notification for the same commit is folded into an earlier run, that id resolves to the earlier run instead."),
     }, { urlFieldDescription: "Absolute URL of the run page." });
     return {
         description: "Get a run's status, per-flow results, and links.",

package/dist/v1/run/get.js.map

@@ -1 +1 @@
-{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/v1/run/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAGhC,GAID,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,KAAK,EAAE,GAAG,CAAC,GAAG;KACf,CAAC,CAAC;IAEH,0EAA0E;IAC1E,8EAA8E;IAC9E,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,sEAAsE;IACtE,4BAA4B;IAC5B,0EAA0E;IAC1E,8EAA8E;IAC9E,4EAA4E;IAC5E,iEAAiE;IACjE,2EAA2E;IAC3E,4CAA4C;IAC5C,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;QAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;YAChB,0EAA0E;YAC1E,2EAA2E;YAC3E,yEAAyE;YACzE,+DAA+D;YAC/D,oEAAoE;YACpE,oDAAoD;YACpD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB,CAAC;QACF,MAAM,EAAE,GAAG,CAAC,IAAI;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC5B,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;QAC7B,MAAM,EAAE,GAAG,CAAC,IAAI;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;KAC5D,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,CAAC;SACZ,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;SAClE,QAAQ,CAAC,kDAAkD,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,QAAQ,CACrB;QACE,GAAG,oBAAoB,CAAC,GAAG,CAAC;QAC5B,KAAK;KACN,EACD,EAAE,mBAAmB,EAAE,+BAA+B,EAAE,CACzD,CAAC;IAEF,OAAO;QACL,WAAW,EAAE,kDAAkD;QAC/D,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,SAAS;QACf,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/v1/run/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAGhC,GAID,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,KAAK,EAAE,GAAG,CAAC,GAAG;KACf,CAAC,CAAC;IAEH,0EAA0E;IAC1E,8EAA8E;IAC9E,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,sEAAsE;IACtE,4BAA4B;IAC5B,0EAA0E;IAC1E,8EAA8E;IAC9E,4EAA4E;IAC5E,iEAAiE;IACjE,2EAA2E;IAC3E,4CAA4C;IAC5C,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;QAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;YAChB,0EAA0E;YAC1E,2EAA2E;YAC3E,yEAAyE;YACzE,+DAA+D;YAC/D,oEAAoE;YACpE,oDAAoD;YACpD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB,CAAC;QACF,MAAM,EAAE,GAAG,CAAC,IAAI;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC5B,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;QAC7B,MAAM,EAAE,GAAG,CAAC,IAAI;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;KAC5D,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,CAAC;SACZ,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;SAClE,QAAQ,CAAC,kDAAkD,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,QAAQ,CACrB;QACE,GAAG,oBAAoB,CAAC,GAAG,CAAC;QAC5B,KAAK;QACL,yEAAyE;QACzE,uEAAuE;QACvE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CACrB,6RAA6R,CAC9R;KACF,EACD,EAAE,mBAAmB,EAAE,+BAA+B,EAAE,CACzD,CAAC;IAEF,OAAO;QACL,WAAW,EAAE,kDAAkD;QAC/D,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,SAAS;QACf,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/run/summary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,oBAAoB,GAAI,KAAK,SAAS,cAAc,EAAE,KAAK;IACtE,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;CA+BC,CAAC"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,oBAAoB,GAAI,KAAK,SAAS,cAAc,EAAE,KAAK;IACtE,GAAG,EAAE,KAAK,CAAC;CACZ;;;;;;;;;;;;;;;;;CAkCC,CAAC"}

package/dist/v1/run/summary.js

@@ -23,6 +23,9 @@ export const makeRunSummaryFields = (ids) => ({
             .describe("Link to the commit on the code host."),
     })
         .describe("The branch and commit under test. The fields are present when a deploy notification started the run, and absent for runs started another way, for example manually or with run.create."),
+    // Deliberately not described here: run.find builds its rows from this factory
+    // too, and its rows answer no requested id, so wording about the id you asked
+    // for belongs on run.get alone.
     runId: ids.run,
     status: z
         .enum(["queued", "running", "passed", "failed", "canceled"])

package/dist/v1/run/summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,6EAA6E;AAC7E,2EAA2E;AAC3E,sCAAsC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAA+B,GAElE,EAAE,EAAE,CAAC,CAAC;IACL,WAAW,EAAE,CAAC,CAAC,GAAG;SACf,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,+KAA+K,CAChL;IACH,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,CAAC;SACH,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,wEAAwE;QACxE,uEAAuE;QACvE,sEAAsE;QACtE,mDAAmD;QACnD,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,sCAAsC,CAAC;KACpD,CAAC;SACD,QAAQ,CACP,wLAAwL,CACzL;IACH,KAAK,EAAE,GAAG,CAAC,GAAG;IACd,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;SAC3D,QAAQ,CACP,kGAAkG,CACnG;CACJ,CAAC,CAAC"}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/v1/run/summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,6EAA6E;AAC7E,2EAA2E;AAC3E,sCAAsC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAA+B,GAElE,EAAE,EAAE,CAAC,CAAC;IACL,WAAW,EAAE,CAAC,CAAC,GAAG;SACf,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,+KAA+K,CAChL;IACH,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,CAAC;SACH,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,wEAAwE;QACxE,uEAAuE;QACvE,sEAAsE;QACtE,mDAAmD;QACnD,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,sCAAsC,CAAC;KACpD,CAAC;SACD,QAAQ,CACP,wLAAwL,CACzL;IACH,8EAA8E;IAC9E,8EAA8E;IAC9E,gCAAgC;IAChC,KAAK,EAAE,GAAG,CAAC,GAAG;IACd,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;SAC3D,QAAQ,CACP,kGAAkG,CACnG;CACJ,CAAC,CAAC"}

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

@@ -0,0 +1,4 @@
+import { z } from "zod";
+/** Bounded on its own, so a large project is never refused for its environment. */
+export declare const runEnvironmentSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+//# sourceMappingURL=environment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkCxB,mFAAmF;AACnF,eAAO,MAAM,oBAAoB,uCAmB9B,CAAC"}

package/dist/v1/runner/environment.js

@@ -0,0 +1,46 @@
+import { z } from "zod";
+/**
+ * The environment variables a caller may give a run, and the names they may not.
+ */
+/**
+ * The prefix QA Wolf reserves for the variables it sets on a run itself. A
+ * caller-supplied value under it is refused, and would be overridden anyway.
+ */
+const reservedRunEnvironmentVariablePrefix = "QAWOLF_";
+/**
+ * A name becomes a name in the run's process environment, so it is held to what
+ * a shell accepts — and may not be one of QA Wolf's own. A refusal rather than
+ * a key schema, whose message would reach the caller as a bare "invalid key in
+ * record".
+ */
+function refusalForRunEnvironmentVariableName(name) {
+    if (name.length < 1 || name.length > 256)
+        return "An environment variable name must be between 1 and 256 characters.";
+    if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(name))
+        return "An environment variable name may contain only letters, digits and underscores, and must not start with a digit.";
+    // Case-insensitively, so the reservation cannot be worked around by case.
+    if (name.toUpperCase().startsWith(reservedRunEnvironmentVariablePrefix))
+        return `Environment variable names beginning with ${reservedRunEnvironmentVariablePrefix} are reserved by QA Wolf and set for you.`;
+    return undefined;
+}
+const maxRunEnvironmentVariables = 100;
+const maxRunEnvironmentValueLength = 8 * 1024;
+/** Bounded on its own, so a large project is never refused for its environment. */
+export const runEnvironmentSchema = z
+    .record(z.string(), z.string().max(maxRunEnvironmentValueLength))
+    .superRefine((environment, refinementContext) => {
+    for (const name of Object.keys(environment)) {
+        const refusal = refusalForRunEnvironmentVariableName(name);
+        if (refusal === undefined)
+            continue;
+        refinementContext.addIssue({
+            code: "custom",
+            message: refusal,
+            path: [name],
+        });
+    }
+})
+    .refine((environment) => Object.keys(environment).length <= maxRunEnvironmentVariables, {
+    error: `At most ${maxRunEnvironmentVariables} environment variables may be supplied.`,
+});
+//# sourceMappingURL=environment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../src/v1/runner/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AAEH;;;GAGG;AACH,MAAM,oCAAoC,GAAG,SAAS,CAAC;AAEvD;;;;;GAKG;AACH,SAAS,oCAAoC,CAC3C,IAAY;IAEZ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG;QACtC,OAAO,oEAAoE,CAAC;IAC9E,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;QACxC,OAAO,iHAAiH,CAAC;IAC3H,0EAA0E;IAC1E,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,oCAAoC,CAAC;QACrE,OAAO,6CAA6C,oCAAoC,2CAA2C,CAAC;IACtI,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,0BAA0B,GAAG,GAAG,CAAC;AACvC,MAAM,4BAA4B,GAAG,CAAC,GAAG,IAAI,CAAC;AAE9C,mFAAmF;AACnF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;KAChE,WAAW,CAAC,CAAC,WAAW,EAAE,iBAAiB,EAAE,EAAE;IAC9C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,oCAAoC,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,OAAO,KAAK,SAAS;YAAE,SAAS;QACpC,iBAAiB,CAAC,QAAQ,CAAC;YACzB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,CAAC,IAAI,CAAC;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;KACD,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,0BAA0B,EAC/D;IACE,KAAK,EAAE,WAAW,0BAA0B,yCAAyC;CACtF,CACF,CAAC"}

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

@@ -0,0 +1,24 @@
+import { z } from "zod";
+export declare const makeEvaluateSnippetOnRunnerContract: () => {
+    readonly description: "Evaluate a snippet against whatever the runner's browser is showing right now. Answers whether the snippet ran, and its error if it threw — not the value it evaluated to, so read anything you want back out of the runner's journal (a snippet's `console.log` lands in the `console` stream). A snippet starts no run and leaves no run-scoped journal entries of its own. `runner-unreachable` if the runner could not be reached or could not evaluate: as well as a runner that is still starting, has terminated after inactivity, or is busy, this covers a runner with no live page to evaluate against — which will never clear, so check that the runner you launched is one that runs a browser before retrying. It is NOT proof the snippet did not run: a snippet that outlives the answer window is still executing when you read this, so do not blindly resubmit one that mutates what the page is looking at.";
+    readonly input: z.ZodObject<{
+        code: z.ZodString;
+        filePath: z.ZodOptional<z.ZodString>;
+        files: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly kind: "write";
+    readonly name: "runner.evaluateSnippet";
+    readonly output: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        errorMessage: z.ZodOptional<z.ZodString>;
+        outcome: z.ZodLiteral<"evaluated">;
+        result: z.ZodEnum<{
+            success: "success";
+            error: "error";
+            stopped: "stopped";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        outcome: z.ZodLiteral<"runner-unreachable">;
+    }, z.core.$strip>], "outcome">;
+};
+//# sourceMappingURL=evaluateSnippet.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"evaluateSnippet.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/evaluateSnippet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAgBxB,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;CA+D/C,CAAC"}

package/dist/v1/runner/evaluateSnippet.js

@@ -0,0 +1,54 @@
+import { z } from "zod";
+import { runFilePathSchema } from "./files.js";
+import { runnerIdSchema } from "./identity.js";
+import { runFilesSchema } from "./payloadSize.js";
+import { runnerUnreachableSchema } from "./unreachable.js";
+/**
+ * A snippet is one expression or a handful of statements, not a program: it is
+ * bounded so a caller cannot smuggle a whole project through as code instead of
+ * as files, where the travel rule applies.
+ */
+const maxSnippetCodeLength = 64 * 1024;
+export const makeEvaluateSnippetOnRunnerContract = () => {
+    const input = z
+        .object({
+        code: z
+            .string()
+            .min(1)
+            .max(maxSnippetCodeLength)
+            .describe("The code to evaluate against the runner's live page, in the scope of `filePath` when one is given."),
+        filePath: runFilePathSchema
+            .optional()
+            .describe("Path of the file the snippet is evaluated in the scope of. Omit to evaluate a snippet that imports nothing of yours."),
+        files: runFilesSchema
+            .optional()
+            .describe("The file named by `filePath` and everything it imports. A runner holds no copy of your project, so a snippet's scope has to travel with it."),
+        id: runnerIdSchema.describe("Id of the runner to evaluate the snippet on."),
+    })
+        .refine((request) => request.filePath === undefined ||
+        Object.hasOwn(request.files ?? {}, request.filePath), {
+        error: "A snippet naming a file must carry that file in files.",
+        path: ["files"],
+    });
+    const output = z.discriminatedUnion("outcome", [
+        z.object({
+            errorMessage: z
+                .string()
+                .optional()
+                .describe("Present when `result` is `error`."),
+            outcome: z.literal("evaluated"),
+            result: z
+                .enum(["success", "stopped", "error"])
+                .describe("`success` if the snippet ran to completion, `stopped` if it was interrupted, `error` if it threw. Whether it ran, not what it evaluated to."),
+        }),
+        runnerUnreachableSchema,
+    ]);
+    return {
+        description: "Evaluate a snippet against whatever the runner's browser is showing right now. Answers whether the snippet ran, and its error if it threw — not the value it evaluated to, so read anything you want back out of the runner's journal (a snippet's `console.log` lands in the `console` stream). A snippet starts no run and leaves no run-scoped journal entries of its own. `runner-unreachable` if the runner could not be reached or could not evaluate: as well as a runner that is still starting, has terminated after inactivity, or is busy, this covers a runner with no live page to evaluate against — which will never clear, so check that the runner you launched is one that runs a browser before retrying. It is NOT proof the snippet did not run: a snippet that outlives the answer window is still executing when you read this, so do not blindly resubmit one that mutates what the page is looking at.",
+        input,
+        kind: "write",
+        name: "runner.evaluateSnippet",
+        output,
+    };
+};
+//# sourceMappingURL=evaluateSnippet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"evaluateSnippet.js","sourceRoot":"","sources":["../../../src/v1/runner/evaluateSnippet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,oBAAoB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEvC,MAAM,CAAC,MAAM,mCAAmC,GAAG,GAAG,EAAE;IACtD,MAAM,KAAK,GAAG,CAAC;SACZ,MAAM,CAAC;QACN,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,oBAAoB,CAAC;aACzB,QAAQ,CACP,oGAAoG,CACrG;QACH,QAAQ,EAAE,iBAAiB;aACxB,QAAQ,EAAE;aACV,QAAQ,CACP,sHAAsH,CACvH;QACH,KAAK,EAAE,cAAc;aAClB,QAAQ,EAAE;aACV,QAAQ,CACP,6IAA6I,CAC9I;QACH,EAAE,EAAE,cAAc,CAAC,QAAQ,CACzB,8CAA8C,CAC/C;KACF,CAAC;SACD,MAAM,CACL,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,QAAQ,KAAK,SAAS;QAC9B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,OAAO,CAAC,QAAQ,CAAC,EACtD;QACE,KAAK,EAAE,wDAAwD;QAC/D,IAAI,EAAE,CAAC,OAAO,CAAC;KAChB,CACF,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE;QAC7C,CAAC,CAAC,MAAM,CAAC;YACP,YAAY,EAAE,CAAC;iBACZ,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,mCAAmC,CAAC;YAChD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;YAC/B,MAAM,EAAE,CAAC;iBACN,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;iBACrC,QAAQ,CACP,6IAA6I,CAC9I;SACJ,CAAC;QACF,uBAAuB;KACxB,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,i4BAAi4B;QACn4B,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,wBAAwB;QAC9B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

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

@@ -0,0 +1,26 @@
+import { z } from "zod";
+/**
+ * Which of a project's files travel to a runner. Published so a client collects
+ * with exactly what the server validates with; the predicate is the schema
+ * asked as a question. How much may travel is in `payloadSize.ts`.
+ */
+/**
+ * An allowlist, because everything here is written into the run program and
+ * some of it is transformed — and one that can be widened later, which a
+ * stricter rule could not be.
+ */
+export declare const shippableRunFileExtensions: readonly [".cjs", ".js", ".json", ".mjs", ".ts", ".tsx"];
+/** Whether this file travels to a runner. Filter a working tree with it. */
+export declare function isShippableRunFilePath(path: string): boolean;
+/**
+ * Exported because `runFilesSchema` checks record keys as a refinement — a key
+ * schema's message would reach the caller as a bare "invalid key in record".
+ */
+export declare const runFilePathRefusal: string;
+export declare const runFilePathSchema: z.ZodString;
+/**
+ * The file a runner reads npm dependencies from. It travels like any other file
+ * and is not written to the run program: the runner writes its own.
+ */
+export declare const runPackageJsonPath = "package.json";
+//# sourceMappingURL=files.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AAEH;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,0DAO7B,CAAC;AAuBX,4EAA4E;AAC5E,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAW5D;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAuR,CAAC;AAEvT,eAAO,MAAM,iBAAiB,aAE5B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB,iBAAiB,CAAC"}

package/dist/v1/runner/files.js

@@ -0,0 +1,65 @@
+import { z } from "zod";
+/**
+ * Which of a project's files travel to a runner. Published so a client collects
+ * with exactly what the server validates with; the predicate is the schema
+ * asked as a question. How much may travel is in `payloadSize.ts`.
+ */
+/**
+ * An allowlist, because everything here is written into the run program and
+ * some of it is transformed — and one that can be widened later, which a
+ * stricter rule could not be.
+ */
+export const shippableRunFileExtensions = [
+    ".cjs",
+    ".js",
+    ".json",
+    ".mjs",
+    ".ts",
+    ".tsx",
+];
+/** A path becomes a filesystem path on the runner, so it is bounded. */
+const maxRunFilePathLength = 1024;
+/**
+ * A denylist of what would make the path address somewhere outside the run
+ * program: `.`/`..` navigate, a leading dot ships `.env` and `.git`, an empty
+ * segment is an absolute or doubled separator, a backslash can smuggle a
+ * separator past the check, and control characters confuse the tooling.
+ * Everything else — including non-ASCII names — travels.
+ */
+function isShippableRunFilePathSegment(segment) {
+    if (segment === "" || segment === "." || segment === "..")
+        return false;
+    if (segment.startsWith("."))
+        return false;
+    if (segment.includes("\\"))
+        return false;
+    // eslint-disable-next-line no-control-regex -- refusing control characters is the point
+    return !/[\u0000-\u001f\u007f]/.test(segment);
+}
+/** The runner installs dependencies itself, so `node_modules` never ships. */
+const neverShippedPathSegments = new Set(["node_modules"]);
+/** Whether this file travels to a runner. Filter a working tree with it. */
+export function isShippableRunFilePath(path) {
+    if (path.length < 1 || path.length > maxRunFilePathLength)
+        return false;
+    if (!shippableRunFileExtensions.some((extension) => path.endsWith(extension)))
+        return false;
+    return path
+        .split("/")
+        .every((segment) => isShippableRunFilePathSegment(segment) &&
+        !neverShippedPathSegments.has(segment));
+}
+/**
+ * Exported because `runFilesSchema` checks record keys as a refinement — a key
+ * schema's message would reach the caller as a bare "invalid key in record".
+ */
+export const runFilePathRefusal = `A run file path must end in one of ${shippableRunFileExtensions.join(", ")}, be at most ${maxRunFilePathLength} characters, and be a relative path whose segments are none of: empty, "." or "..", dot-prefixed, "node_modules", or containing a backslash or a control character.`;
+export const runFilePathSchema = z.string().refine(isShippableRunFilePath, {
+    error: runFilePathRefusal,
+});
+/**
+ * The file a runner reads npm dependencies from. It travels like any other file
+ * and is not written to the run program: the runner writes its own.
+ */
+export const runPackageJsonPath = "package.json";
+//# sourceMappingURL=files.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/v1/runner/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,MAAM;IACN,KAAK;IACL,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;CACE,CAAC;AAEX,wEAAwE;AACxE,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC;;;;;;GAMG;AACH,SAAS,6BAA6B,CAAC,OAAe;IACpD,IAAI,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,wFAAwF;IACxF,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAChD,CAAC;AAED,8EAA8E;AAC9E,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;AAE3D,4EAA4E;AAC5E,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CACJ,CAAC,OAAO,EAAE,EAAE,CACV,6BAA6B,CAAC,OAAO,CAAC;QACtC,CAAC,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,CACzC,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,sCAAsC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,oBAAoB,qKAAqK,CAAC;AAEvT,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,sBAAsB,EAAE;IACzE,KAAK,EAAE,kBAAkB;CAC1B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,cAAc,CAAC"}

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

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export declare const runnerNameSchema: z.ZodEnum<{
+    node20Basic: "node20Basic";
+    node20WithAndroid: "node20WithAndroid";
+    node20WithIos: "node20WithIos";
+    node20WithPlaywright: "node20WithPlaywright";
+}>;
+export type RunnerNameForPublicApi = z.infer<typeof runnerNameSchema>;
+export declare const runnerIdSchema: z.ZodString;
+/** The shared interactive runner shape. */
+export declare const makeRunnerSchema: () => z.ZodObject<{
+    gpuAccelerated: z.ZodBoolean;
+    id: z.ZodString;
+    runnerName: z.ZodEnum<{
+        node20Basic: "node20Basic";
+        node20WithAndroid: "node20WithAndroid";
+        node20WithIos: "node20WithIos";
+        node20WithPlaywright: "node20WithPlaywright";
+    }>;
+}, z.core.$strip>;
+//# sourceMappingURL=identity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/identity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,gBAAgB;;;;;EAK3B,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,eAAO,MAAM,cAAc,aAOxB,CAAC;AAEJ,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;;;;;;;;;iBAazB,CAAC"}

package/dist/v1/runner/identity.js

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export const runnerNameSchema = z.enum([
+    "node20Basic",
+    "node20WithAndroid",
+    "node20WithIos",
+    "node20WithPlaywright",
+]);
+export const runnerIdSchema = z
+    .string()
+    .min(1)
+    .max(63)
+    .regex(/^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/, "A runner id may contain only lowercase letters, digits and dashes, and must start and end with a letter or digit.");
+/** The shared interactive runner shape. */
+export const makeRunnerSchema = () => z.object({
+    gpuAccelerated: z
+        .boolean()
+        .describe("Whether the runner was placed on GPU hardware. Chosen by QA Wolf from the team's configuration and what the fleet can provide, not requested."),
+    id: runnerIdSchema.describe("The runner's id, as supplied when launching it."),
+    runnerName: runnerNameSchema.describe("The image requested when the runner was launched. QA Wolf may place it on faster hardware, reported in gpuAccelerated."),
+});
+//# sourceMappingURL=identity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../../src/v1/runner/identity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC;IACrC,aAAa;IACb,mBAAmB;IACnB,eAAe;IACf,sBAAsB;CACvB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,EAAE,CAAC;KACP,KAAK,CACJ,iCAAiC,EACjC,mHAAmH,CACpH,CAAC;AAEJ,2CAA2C;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CACnC,CAAC,CAAC,MAAM,CAAC;IACP,cAAc,EAAE,CAAC;SACd,OAAO,EAAE;SACT,QAAQ,CACP,+IAA+I,CAChJ;IACH,EAAE,EAAE,cAAc,CAAC,QAAQ,CACzB,iDAAiD,CAClD;IACD,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CACnC,wHAAwH,CACzH;CACF,CAAC,CAAC"}

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

@@ -0,0 +1,45 @@
+import { z } from "zod";
+export declare const makeLaunchRunnerContract: () => {
+    readonly description: "Launch an interactive runner on the caller's team under an id the caller chooses. Launching the same id again returns the runner already running rather than starting a second one, and the same id with a different runnerName is refused. A runner is not permanent: it terminates on its own after a period of inactivity, and launching the same id after that starts and bills a new runner — so read `outcome` to tell which happened.";
+    readonly input: z.ZodObject<{
+        id: z.ZodString;
+        runnerName: z.ZodOptional<z.ZodEnum<{
+            node20Basic: "node20Basic";
+            node20WithAndroid: "node20WithAndroid";
+            node20WithIos: "node20WithIos";
+            node20WithPlaywright: "node20WithPlaywright";
+        }>>;
+    }, z.core.$strip>;
+    readonly kind: "write";
+    readonly name: "runner.launch";
+    readonly output: z.ZodObject<{
+        gpuAccelerated: z.ZodBoolean;
+        id: z.ZodString;
+        runnerName: z.ZodEnum<{
+            node20Basic: "node20Basic";
+            node20WithAndroid: "node20WithAndroid";
+            node20WithIos: "node20WithIos";
+            node20WithPlaywright: "node20WithPlaywright";
+        }>;
+        outcome: z.ZodEnum<{
+            launched: "launched";
+            "already-running": "already-running";
+        }>;
+    }, z.core.$strip>;
+};
+export declare const makeStopRunnerContract: () => {
+    readonly description: "Stop an interactive runner on the caller's team. Stopping a runner that is not running succeeds and reports `not-running`, so a retry needs no special handling.";
+    readonly input: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly kind: "write";
+    readonly name: "runner.stop";
+    readonly output: z.ZodObject<{
+        id: z.ZodString;
+        outcome: z.ZodEnum<{
+            stopped: "stopped";
+            "not-running": "not-running";
+        }>;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v1/runner/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAUxB,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCpC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;CA0BlC,CAAC"}

package/dist/v1/runner/index.js

@@ -0,0 +1,41 @@
+import { z } from "zod";
+import { makeRunnerSchema, runnerIdSchema, runnerNameSchema, } from "./identity.js";
+export const makeLaunchRunnerContract = () => {
+    const input = z.object({
+        id: runnerIdSchema.describe("Id to launch the runner under, chosen by the caller. Launching the same id again returns the runner already running under it."),
+        runnerName: runnerNameSchema
+            .optional()
+            .describe("Image to run. Defaults to the standard web image, node20WithPlaywright."),
+    });
+    const output = makeRunnerSchema().extend({
+        outcome: z
+            .enum(["launched", "already-running"])
+            .describe("`launched` if this call started the runner. `already-running` if a runner was already running under this id and was returned unchanged — no second runner was started."),
+    });
+    return {
+        description: "Launch an interactive runner on the caller's team under an id the caller chooses. Launching the same id again returns the runner already running rather than starting a second one, and the same id with a different runnerName is refused. A runner is not permanent: it terminates on its own after a period of inactivity, and launching the same id after that starts and bills a new runner — so read `outcome` to tell which happened.",
+        input,
+        kind: "write",
+        name: "runner.launch",
+        output,
+    };
+};
+export const makeStopRunnerContract = () => {
+    const input = z.object({
+        id: runnerIdSchema.describe("Id of the runner to stop."),
+    });
+    const output = z.object({
+        id: runnerIdSchema.describe("Id of the runner the call addressed."),
+        outcome: z
+            .enum(["stopped", "not-running"])
+            .describe("`stopped` if the runner was running and has been stopped. `not-running` if no running runner has this id — it was already stopped, was never launched, or terminated on its own after inactivity; these are not distinguished, because the run system keeps no record of a runner once it is gone."),
+    });
+    return {
+        description: "Stop an interactive runner on the caller's team. Stopping a runner that is not running succeeds and reports `not-running`, so a retry needs no special handling.",
+        input,
+        kind: "write",
+        name: "runner.stop",
+        output,
+    };
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/runner/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,GACjB,MAAM,eAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC3C,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,cAAc,CAAC,QAAQ,CACzB,+HAA+H,CAChI;QACD,UAAU,EAAE,gBAAgB;aACzB,QAAQ,EAAE;aACV,QAAQ,CACP,yEAAyE,CAC1E;KACJ,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC,MAAM,CAAC;QACvC,OAAO,EAAE,CAAC;aACP,IAAI,CAAC,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;aACrC,QAAQ,CACP,wKAAwK,CACzK;KACJ,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,8aAA8a;QAChb,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,eAAe;QACrB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,2BAA2B,CAAC;KACzD,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,sCAAsC,CAAC;QACnE,OAAO,EAAE,CAAC;aACP,IAAI,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;aAChC,QAAQ,CACP,oSAAoS,CACrS;KACJ,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,kKAAkK;QACpK,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,aAAa;QACnB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}