@qawolf/api-contracts 0.1.0 → 0.2.0

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

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import type { PublicIdSchema, PublicIdSchemasOf } from "../ids.js";
+export declare const makeListFlowsContract: <EnvironmentId extends PublicIdSchema, FlowId extends PublicIdSchema, RunId extends PublicIdSchema>(ids: PublicIdSchemasOf<EnvironmentId, FlowId, RunId>) => {
+    readonly description: "List the flows of an environment at its latest reconciled commit.";
+    readonly input: z.ZodObject<{
+        environmentId: EnvironmentId;
+        includeDrafts: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>;
+    readonly kind: "read";
+    readonly name: "flow.list";
+    readonly output: z.ZodObject<{
+        flows: z.ZodArray<z.ZodObject<{
+            executionTarget: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+            flowId: FlowId;
+            name: z.ZodString;
+            path: z.ZodString;
+            tags: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v1/flow/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEnE,eAAO,MAAM,qBAAqB,GAChC,aAAa,SAAS,cAAc,EACpC,MAAM,SAAS,cAAc,EAC7B,KAAK,SAAS,cAAc,EAE5B,KAAK,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;CAqCrD,CAAC"}

package/dist/v1/flow/index.js

@@ -0,0 +1,30 @@
+import { z } from "zod";
+export const makeListFlowsContract = (ids) => {
+    const input = z.object({
+        environmentId: ids.environment,
+        includeDrafts: z
+            .boolean()
+            .default(false)
+            .describe("Include draft flows in the listing."),
+    });
+    const executionTarget = z
+        .union([z.string().min(1), z.record(z.string(), z.unknown())])
+        .describe("The target the flow executes against, as a preset or object.");
+    const output = z.object({
+        flows: z.array(z.object({
+            executionTarget,
+            flowId: ids.flow,
+            name: z.string(),
+            path: z.string().describe("The flow file path, relative to the repo."),
+            tags: z.array(z.string()),
+        })),
+    });
+    return {
+        description: "List the flows of an environment at its latest reconciled commit.",
+        input,
+        kind: "read",
+        name: "flow.list",
+        output,
+    };
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/flow/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAKnC,GAAoD,EACpD,EAAE;IACF,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,aAAa,EAAE,GAAG,CAAC,WAAW;QAC9B,aAAa,EAAE,CAAC;aACb,OAAO,EAAE;aACT,OAAO,CAAC,KAAK,CAAC;aACd,QAAQ,CAAC,qCAAqC,CAAC;KACnD,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,CAAC;SACtB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAC7D,QAAQ,CAAC,8DAA8D,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,CAAC,CAAC,MAAM,CAAC;YACP,eAAe;YACf,MAAM,EAAE,GAAG,CAAC,IAAI;YAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;YACtE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAC1B,CAAC,CACH;KACF,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,mEAAmE;QACrE,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,WAAW;QACjB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/index.d.ts

@@ -13,6 +13,26 @@ export type PublicApiOutput<Api extends AnyPublicApiContract> = z.infer<Api["out
  * never drift between the two while validation strictness stays server-owned.
  */
 export declare const makeContractsV1: <EnvironmentId extends PublicIdSchema, FlowId extends PublicIdSchema, RunId extends PublicIdSchema>(ids: PublicIdSchemasOf<EnvironmentId, FlowId, RunId>) => {
+    flow: {
+        list: {
+            readonly description: "List the flows of an environment at its latest reconciled commit.";
+            readonly input: z.ZodObject<{
+                environmentId: EnvironmentId;
+                includeDrafts: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strip>;
+            readonly kind: "read";
+            readonly name: "flow.list";
+            readonly output: z.ZodObject<{
+                flows: z.ZodArray<z.ZodObject<{
+                    executionTarget: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+                    flowId: FlowId;
+                    name: z.ZodString;
+                    path: z.ZodString;
+                    tags: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        };
+    };
     run: {
         create: {
             readonly description: "Create a run for selected flows in an environment.";
@@ -31,6 +51,26 @@ export declare const makeContractsV1: <EnvironmentId extends PublicIdSchema, Flo
     };
 };
 export declare const publicContractsV1: {
+    flow: {
+        list: {
+            readonly description: "List the flows of an environment at its latest reconciled commit.";
+            readonly input: z.ZodObject<{
+                environmentId: PublicIdSchema;
+                includeDrafts: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strip>;
+            readonly kind: "read";
+            readonly name: "flow.list";
+            readonly output: z.ZodObject<{
+                flows: z.ZodArray<z.ZodObject<{
+                    executionTarget: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+                    flowId: PublicIdSchema;
+                    name: z.ZodString;
+                    path: z.ZodString;
+                    tags: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        };
+    };
     run: {
         create: {
             readonly description: "Create a run for selected flows in an environment.";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,iBAAiB,EAEvB,MAAM,UAAU,CAAC;AAGlB,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,oBAAoB,IAAI,CAAC,CAAC,KAAK,CACpE,GAAG,CAAC,OAAO,CAAC,CACb,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,oBAAoB,IAAI,CAAC,CAAC,KAAK,CACrE,GAAG,CAAC,QAAQ,CAAC,CACd,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,aAAa,SAAS,cAAc,EACpC,MAAM,SAAS,cAAc,EAC7B,KAAK,SAAS,cAAc,EAE5B,KAAK,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;CAKpD,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAoC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5D,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,iBAAiB,EAEvB,MAAM,UAAU,CAAC;AAGlB,MAAM,MAAM,cAAc,CAAC,GAAG,SAAS,oBAAoB,IAAI,CAAC,CAAC,KAAK,CACpE,GAAG,CAAC,OAAO,CAAC,CACb,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,oBAAoB,IAAI,CAAC,CAAC,KAAK,CACrE,GAAG,CAAC,QAAQ,CAAC,CACd,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,aAAa,SAAS,cAAc,EACpC,MAAM,SAAS,cAAc,EAC7B,KAAK,SAAS,cAAc,EAE5B,KAAK,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQpD,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAoC,CAAC"}

package/dist/v1/index.js

@@ -1,4 +1,5 @@
 export { defaultIdSchemas, } from "./ids.js";
+import { makeListFlowsContract } from "./flow/index.js";
 import { defaultIdSchemas, } from "./ids.js";
 import { makeCreateRunContract } from "./run/index.js";
 /**
@@ -9,6 +10,9 @@ import { makeCreateRunContract } from "./run/index.js";
  * never drift between the two while validation strictness stays server-owned.
  */
 export const makeContractsV1 = (ids) => ({
+    flow: {
+        list: makeListFlowsContract(ids),
+    },
     run: {
         create: makeCreateRunContract(ids),
     },

package/dist/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAGlB,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAUvD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAK7B,GAAoD,EACpD,EAAE,CAAC,CAAC;IACJ,GAAG,EAAE;QACH,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC;KACnC;CACF,CAAC,CAAC;AAEH,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,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAGL,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAUvD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAK7B,GAAoD,EACpD,EAAE,CAAC,CAAC;IACJ,IAAI,EAAE;QACJ,IAAI,EAAE,qBAAqB,CAAC,GAAG,CAAC;KACjC;IACD,GAAG,EAAE;QACH,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC;KACnC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/api-contracts",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": false,
   "description": "Versioned contracts for the QA Wolf public API",
   "repository": {
@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@typescript/native-preview": "^7.0.0-dev.20260416.1",
-    "typescript": "^5.9.2",
+    "typescript": "^5.9.3",
     "zod": "^4.1.11"
   },
   "peerDependencies": {