@qawolf/api-contracts 0.42.0 → 0.48.0

package/dist/v1/auth/config.d.ts

@@ -2,16 +2,24 @@ import { z } from "zod";
 /**
  * The configuration a client needs before it can authenticate.
  *
- * A client must send a WorkOS client id to start the device authorization
- * grant, and the token it receives verifies only against the client the backend
- * checks. The id differs per environment, so a client reads it from the host it
- * points at.
+ * `workOsClientId` identifies the deployment's WorkOS environment for legacy
+ * sign-in. `workOsConnectClientId` identifies the public OAuth application for
+ * Connect sign-in. Clients read these deployment-specific identifiers from
+ * the host they use.
  *
- * This carries no secret. A WorkOS client id is a public identifier, and the
- * device grant is designed for public clients that hold no secret.
+ * `authorizationServer` is the OAuth 2.1 authorization server, the AuthKit
+ * domain that serves WorkOS Connect. A client discovers the grant endpoints
+ * from its `/.well-known/oauth-authorization-server` document. It is absent
+ * when the environment does not trust Connect tokens yet.
+ *
+ * This carries no secret. A WorkOS client id and an issuer URL are public
+ * identifiers, and the device grant is designed for public clients that hold
+ * no secret.
  */
 export declare const authConfigResponse: z.ZodObject<{
+    authorizationServer: z.ZodOptional<z.ZodString>;
     workOsClientId: z.ZodString;
+    workOsConnectClientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type AuthConfigResponse = z.infer<typeof authConfigResponse>;
 //# sourceMappingURL=config.d.ts.map

package/dist/v1/auth/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/v1/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB;;iBAE7B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/v1/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,kBAAkB;;;;iBAK7B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/v1/auth/config.js

@@ -2,15 +2,24 @@ import { z } from "zod";
 /**
  * The configuration a client needs before it can authenticate.
  *
- * A client must send a WorkOS client id to start the device authorization
- * grant, and the token it receives verifies only against the client the backend
- * checks. The id differs per environment, so a client reads it from the host it
- * points at.
+ * `workOsClientId` identifies the deployment's WorkOS environment for legacy
+ * sign-in. `workOsConnectClientId` identifies the public OAuth application for
+ * Connect sign-in. Clients read these deployment-specific identifiers from
+ * the host they use.
  *
- * This carries no secret. A WorkOS client id is a public identifier, and the
- * device grant is designed for public clients that hold no secret.
+ * `authorizationServer` is the OAuth 2.1 authorization server, the AuthKit
+ * domain that serves WorkOS Connect. A client discovers the grant endpoints
+ * from its `/.well-known/oauth-authorization-server` document. It is absent
+ * when the environment does not trust Connect tokens yet.
+ *
+ * This carries no secret. A WorkOS client id and an issuer URL are public
+ * identifiers, and the device grant is designed for public clients that hold
+ * no secret.
  */
 export const authConfigResponse = z.object({
+    authorizationServer: z.string().optional(),
     workOsClientId: z.string(),
+    /** Public Connect application client ID used with authorizationServer. */
+    workOsConnectClientId: z.string().optional(),
 });
 //# sourceMappingURL=config.js.map

package/dist/v1/auth/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/v1/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/v1/auth/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,0EAA0E;IAC1E,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC"}

package/dist/v1/email/find.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
+export declare const makeFindEmailsContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
+    readonly description: "List the workspace's inbox, or its sent mail, newest first. Read a message body with email.get.";
+    readonly input: z.ZodObject<{
+        cursor: z.ZodOptional<z.ZodString>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        address: z.ZodOptional<z.ZodEmail>;
+        createdAfter: z.ZodOptional<z.ZodISODateTime>;
+        direction: z.ZodDefault<z.ZodEnum<{
+            inbound: "inbound";
+            outbound: "outbound";
+        }>>;
+        workspaceId: z.ZodOptional<WorkspaceId>;
+    }, z.core.$strip>;
+    readonly kind: "read";
+    readonly name: "email.find";
+    readonly output: z.ZodObject<{
+        emails: z.ZodArray<z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            direction: z.ZodEnum<{
+                inbound: "inbound";
+                outbound: "outbound";
+            }>;
+            from: z.ZodObject<{
+                address: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            id: z.ZodString;
+            subject: z.ZodOptional<z.ZodString>;
+            to: z.ZodArray<z.ZodObject<{
+                address: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            url: z.ZodURL;
+        }, z.core.$strip>>;
+        nextCursor: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=find.d.ts.map

package/dist/v1/email/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/v1/email/find.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAUhD,eAAO,MAAM,sBAAsB,GACjC,WAAW,SAAS,cAAc,EAClC,KAAK;IACL,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyDA,CAAC"}

package/dist/v1/email/find.js

@@ -0,0 +1,44 @@
+import { z } from "zod";
+import { makePaginationInputFields, nextCursorSchema } from "../pagination.js";
+import { resource } from "../resource.js";
+import { emailDirectionSchema, emailUrlFieldDescription, makeEmailSummaryFields, } from "./resource.js";
+export const makeFindEmailsContract = (ids) => {
+    const input = z.object({
+        address: z
+            .email()
+            .optional()
+            .describe("Only emails delivered to this exact address (inbound) or sent from it (outbound). Mail to a plus-suffixed address such as inbox+abc@example.com is found by that full address, not by inbox@example.com."),
+        // `offset: true` accepts all ISO 8601 datetimes, with `Z` or with a
+        // timezone offset. Without it, zod rejects valid inputs such as
+        // `2026-07-01T00:00:00+02:00`.
+        createdAfter: z.iso
+            .datetime({ offset: true })
+            .optional()
+            .describe("Only include emails received or sent after this instant, e.g. since a flow submitted a sign-up form."),
+        direction: emailDirectionSchema
+            .default("inbound")
+            .describe("inbound lists the mail the workspace received: its inbox. outbound lists the mail it sent."),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace whose emails to list. Required when authenticating with an organization or user API key."),
+        // Every row the emailer returns carries its full bodies and attachments,
+        // even though the listing drops them. The cap stays below the usual 100.
+        ...makePaginationInputFields({ defaultLimit: 20, maxLimit: 50 }),
+    });
+    const output = z.object({
+        emails: z
+            .array(resource(makeEmailSummaryFields(), {
+            urlFieldDescription: emailUrlFieldDescription,
+        }))
+            .describe("The workspace's emails, newest first. Bodies are available via email.get."),
+        nextCursor: nextCursorSchema,
+    });
+    return {
+        description: "List the workspace's inbox, or its sent mail, newest first. Read a message body with email.get.",
+        input,
+        kind: "read",
+        name: "email.find",
+        output,
+    };
+};
+//# sourceMappingURL=find.js.map

package/dist/v1/email/find.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../src/v1/email/find.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAEpC,GAED,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,CAAC;aACP,KAAK,EAAE;aACP,QAAQ,EAAE;aACV,QAAQ,CACP,0MAA0M,CAC3M;QACH,oEAAoE;QACpE,gEAAgE;QAChE,+BAA+B;QAC/B,YAAY,EAAE,CAAC,CAAC,GAAG;aAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;aAC1B,QAAQ,EAAE;aACV,QAAQ,CACP,sGAAsG,CACvG;QACH,SAAS,EAAE,oBAAoB;aAC5B,OAAO,CAAC,SAAS,CAAC;aAClB,QAAQ,CACP,4FAA4F,CAC7F;QACH,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,wGAAwG,CACzG;QACH,yEAAyE;QACzE,yEAAyE;QACzE,GAAG,yBAAyB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;KACjE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,MAAM,EAAE,CAAC;aACN,KAAK,CACJ,QAAQ,CAAC,sBAAsB,EAAE,EAAE;YACjC,mBAAmB,EAAE,wBAAwB;SAC9C,CAAC,CACH;aACA,QAAQ,CACP,2EAA2E,CAC5E;QACH,UAAU,EAAE,gBAAgB;KAC7B,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,iGAAiG;QACnG,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,YAAY;QAClB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

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

@@ -0,0 +1,52 @@
+import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
+export declare const makeGetEmailContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
+    readonly description: "Read one email of the workspace, with its plain text and HTML bodies. Use it to pull a sign-in code or a verification link out of a message.";
+    readonly input: z.ZodObject<{
+        id: z.ZodString;
+        workspaceId: z.ZodOptional<WorkspaceId>;
+    }, z.core.$strip>;
+    readonly kind: "read";
+    readonly name: "email.get";
+    readonly output: z.ZodObject<{
+        attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            fileName: z.ZodString;
+            index: z.ZodNumber;
+            type: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        bcc: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        cc: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        html: z.ZodOptional<z.ZodString>;
+        links: z.ZodArray<z.ZodString>;
+        replyTo: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        text: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        direction: z.ZodEnum<{
+            inbound: "inbound";
+            outbound: "outbound";
+        }>;
+        from: z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        id: z.ZodString;
+        subject: z.ZodOptional<z.ZodString>;
+        to: z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        url: z.ZodURL;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=get.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/v1/email/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAIhD,eAAO,MAAM,oBAAoB,GAAI,WAAW,SAAS,cAAc,EAAE,KAAK;IAC5E,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwBA,CAAC"}

package/dist/v1/email/get.js

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { makeEmailResourceSchema } from "./resource.js";
+export const makeGetEmailContract = (ids) => {
+    const input = z.object({
+        id: z.string().min(1).describe("The id of the email, from email.find."),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace the email belongs to. Required when authenticating with an organization or user API key."),
+    });
+    const output = makeEmailResourceSchema();
+    return {
+        description: "Read one email of the workspace, with its plain text and HTML bodies. Use it to pull a sign-in code or a verification link out of a message.",
+        input,
+        kind: "read",
+        name: "email.get",
+        output,
+    };
+};
+//# sourceMappingURL=get.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/v1/email/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAExD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAqC,GAExE,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC;QACvE,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,wGAAwG,CACzG;KACJ,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC;IAEzC,OAAO;QACL,WAAW,EACT,8IAA8I;QAChJ,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,WAAW;QACjB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/email/getAttachment.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
+export declare const makeGetEmailAttachmentContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
+    readonly description: "Read one attachment of a workspace email as base64 content, by file name or by position. email.get lists both.";
+    readonly input: z.ZodObject<{
+        fileName: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        index: z.ZodOptional<z.ZodNumber>;
+        workspaceId: z.ZodOptional<WorkspaceId>;
+    }, z.core.$strip>;
+    readonly kind: "read";
+    readonly name: "email.getAttachment";
+    readonly output: z.ZodObject<{
+        contentBase64: z.ZodString;
+        fileName: z.ZodString;
+        index: z.ZodNumber;
+        type: z.ZodOptional<z.ZodString>;
+        url: z.ZodURL;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=getAttachment.d.ts.map

package/dist/v1/email/getAttachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAttachment.d.ts","sourceRoot":"","sources":["../../../src/v1/email/getAttachment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKhD,eAAO,MAAM,8BAA8B,GACzC,WAAW,SAAS,cAAc,EAClC,KAAK;IACL,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;CA4DA,CAAC"}

package/dist/v1/email/getAttachment.js

@@ -0,0 +1,46 @@
+import { z } from "zod";
+import { resource } from "../resource.js";
+import { emailUrlFieldDescription } from "./resource.js";
+export const makeGetEmailAttachmentContract = (ids) => {
+    const input = z
+        .object({
+        fileName: z
+            .string()
+            .min(1)
+            .optional()
+            .describe("The attachment's file name, as email.get lists it. The first attachment with that name is returned."),
+        id: z.string().min(1).describe("The id of the email, from email.find."),
+        index: z
+            .number()
+            .int()
+            .min(0)
+            .optional()
+            .describe("The attachment's position in the email, from 0, as email.get lists it. Use it when file names repeat."),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace the email belongs to. Required when authenticating with an organization or user API key."),
+    })
+        .refine((input) => (input.fileName === undefined) !== (input.index === undefined), { message: "Provide fileName or index, not both." });
+    const output = resource({
+        // Not `z.base64()`: every response is parsed with this schema, on the
+        // server and in each client, and the content comes from the emailer's
+        // own encoder, so a scan of the whole file buys nothing. The same
+        // choice as runner/takeScreenshot.ts.
+        contentBase64: z.string().describe("The file content, base64 encoded."),
+        fileName: z.string(),
+        index: z
+            .number()
+            .int()
+            .min(0)
+            .describe("The position of the attachment in the email, from 0."),
+        type: z.string().optional().describe("The MIME type."),
+    }, { urlFieldDescription: emailUrlFieldDescription });
+    return {
+        description: "Read one attachment of a workspace email as base64 content, by file name or by position. email.get lists both.",
+        input,
+        kind: "read",
+        name: "email.getAttachment",
+        output,
+    };
+};
+//# sourceMappingURL=getAttachment.js.map

package/dist/v1/email/getAttachment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAttachment.js","sourceRoot":"","sources":["../../../src/v1/email/getAttachment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAEzD,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAE5C,GAED,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC;SACZ,MAAM,CAAC;QACN,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,qGAAqG,CACtG;QACH,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC;QACvE,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;QACH,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,wGAAwG,CACzG;KACJ,CAAC;SACD,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,EACzE,EAAE,OAAO,EAAE,sCAAsC,EAAE,CACpD,CAAC;IACJ,MAAM,MAAM,GAAG,QAAQ,CACrB;QACE,sEAAsE;QACtE,sEAAsE;QACtE,kEAAkE;QAClE,sCAAsC;QACtC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QACvE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,sDAAsD,CAAC;QACnE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;KACvD,EACD,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,CAClD,CAAC;IAEF,OAAO;QACL,WAAW,EACT,gHAAgH;QAClH,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,qBAAqB;QAC3B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/email/listAddresses.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
+export declare const makeListEmailAddressesContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
+    readonly description: "List the workspace's inbox addresses, alphabetical. A flow can sign up with a plus-suffixed form of any of them, and email.find reads what arrives.";
+    readonly input: z.ZodObject<{
+        cursor: z.ZodOptional<z.ZodString>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        workspaceId: z.ZodOptional<WorkspaceId>;
+    }, z.core.$strip>;
+    readonly kind: "read";
+    readonly name: "email.listAddresses";
+    readonly output: z.ZodObject<{
+        addresses: z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            isDefault: z.ZodBoolean;
+            url: z.ZodURL;
+        }, z.core.$strip>>;
+        nextCursor: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=listAddresses.d.ts.map

package/dist/v1/email/listAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listAddresses.d.ts","sourceRoot":"","sources":["../../../src/v1/email/listAddresses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAMhD,eAAO,MAAM,8BAA8B,GACzC,WAAW,SAAS,cAAc,EAClC,KAAK;IACL,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;CA6CA,CAAC"}

package/dist/v1/email/listAddresses.js

@@ -0,0 +1,33 @@
+import { z } from "zod";
+import { makePaginationInputFields, nextCursorSchema } from "../pagination.js";
+import { resource } from "../resource.js";
+import { emailUrlFieldDescription } from "./resource.js";
+export const makeListEmailAddressesContract = (ids) => {
+    const input = z.object({
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace whose inbox addresses to list. Required when authenticating with an organization or user API key."),
+        ...makePaginationInputFields({ defaultLimit: 20, maxLimit: 50 }),
+    });
+    const output = z.object({
+        addresses: z
+            .array(resource({
+            address: z
+                .string()
+                .describe("The inbox address. Mail sent to any plus-suffixed form, such as inbox+abc@example.com, lands in the same inbox."),
+            isDefault: z
+                .boolean()
+                .describe("Whether this is the workspace's default inbox address."),
+        }, { urlFieldDescription: emailUrlFieldDescription }))
+            .describe("The workspace's permanent inbox addresses, alphabetical."),
+        nextCursor: nextCursorSchema,
+    });
+    return {
+        description: "List the workspace's inbox addresses, alphabetical. A flow can sign up with a plus-suffixed form of any of them, and email.find reads what arrives.",
+        input,
+        kind: "read",
+        name: "email.listAddresses",
+        output,
+    };
+};
+//# sourceMappingURL=listAddresses.js.map

package/dist/v1/email/listAddresses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listAddresses.js","sourceRoot":"","sources":["../../../src/v1/email/listAddresses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAEzD,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAE5C,GAED,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;QACrB,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,iHAAiH,CAClH;QACH,GAAG,yBAAyB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;KACjE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACtB,SAAS,EAAE,CAAC;aACT,KAAK,CACJ,QAAQ,CACN;YACE,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,QAAQ,CACP,iHAAiH,CAClH;YACH,SAAS,EAAE,CAAC;iBACT,OAAO,EAAE;iBACT,QAAQ,CACP,wDAAwD,CACzD;SACJ,EACD,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,CAClD,CACF;aACA,QAAQ,CAAC,0DAA0D,CAAC;QACvE,UAAU,EAAE,gBAAgB;KAC7B,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,qJAAqJ;QACvJ,KAAK;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,qBAAqB;QAC3B,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}

package/dist/v1/email/resource.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+export declare const emailDirectionSchema: z.ZodEnum<{
+    inbound: "inbound";
+    outbound: "outbound";
+}>;
+export type EmailDirection = z.infer<typeof emailDirectionSchema>;
+export declare const namedAddressSchema: z.ZodObject<{
+    address: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const emailUrlFieldDescription = "Absolute URL of the workspace. The inbox opens from the app header.";
+export declare const makeEmailSummaryFields: () => {
+    createdAt: z.ZodISODateTime;
+    direction: z.ZodEnum<{
+        inbound: "inbound";
+        outbound: "outbound";
+    }>;
+    from: z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    id: z.ZodString;
+    subject: z.ZodOptional<z.ZodString>;
+    to: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+};
+export declare const makeEmailResourceSchema: () => z.ZodObject<{
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        fileName: z.ZodString;
+        index: z.ZodNumber;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    bcc: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    cc: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    html: z.ZodOptional<z.ZodString>;
+    links: z.ZodArray<z.ZodString>;
+    replyTo: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    text: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+    direction: z.ZodEnum<{
+        inbound: "inbound";
+        outbound: "outbound";
+    }>;
+    from: z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    id: z.ZodString;
+    subject: z.ZodOptional<z.ZodString>;
+    to: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    url: z.ZodURL;
+}, z.core.$strip>;
+//# sourceMappingURL=resource.d.ts.map

package/dist/v1/email/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/v1/email/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,oBAAoB;;;EAAkC,CAAC;AAEpE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAIlE,eAAO,MAAM,kBAAkB;;;iBAM7B,CAAC;AAIH,eAAO,MAAM,wBAAwB,wEACkC,CAAC;AAIxE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;CAgBjC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkCjC,CAAC"}

package/dist/v1/email/resource.js

@@ -0,0 +1,56 @@
+import { z } from "zod";
+import { resource } from "../resource.js";
+export const emailDirectionSchema = z.enum(["inbound", "outbound"]);
+// Output addresses are loose strings, not `z.email()`. Inbound mail arrives
+// from the wild, and one odd sender address must not fail a whole page.
+export const namedAddressSchema = z.object({
+    address: z.string().describe("The email address."),
+    name: z
+        .string()
+        .optional()
+        .describe("The display name, when the message carried one."),
+});
+// Every email resource shares the workspace URL: the inbox is a drawer in the
+// app header, and there is no per-email page.
+export const emailUrlFieldDescription = "Absolute URL of the workspace. The inbox opens from the app header.";
+// email.find returns these fields as rows. email.get adds the bodies to them.
+// Both shapes come from this one factory, so the shapes cannot drift.
+export const makeEmailSummaryFields = () => ({
+    // `offset: true` keeps the output valid for any ISO 8601 form the emailer
+    // may serialize, so one timestamp format cannot fail a page.
+    createdAt: z.iso
+        .datetime({ offset: true })
+        .describe("When QA Wolf received or sent the email."),
+    direction: emailDirectionSchema.describe("inbound for mail the workspace received, outbound for mail it sent."),
+    from: namedAddressSchema,
+    id: z
+        .string()
+        .min(1)
+        .describe("The id of the email. Pass it to email.get to read the body."),
+    subject: z.string().optional(),
+    to: z.array(namedAddressSchema),
+});
+export const makeEmailResourceSchema = () => resource({
+    ...makeEmailSummaryFields(),
+    attachments: z
+        .array(z.object({
+        fileName: z.string(),
+        index: z
+            .number()
+            .int()
+            .min(0)
+            .describe("The position of the attachment in the email, from 0. Pass it to email.getAttachment when file names repeat."),
+        type: z.string().optional().describe("The MIME type."),
+    }))
+        .optional()
+        .describe("Attachment names, positions, and types. Read the content with email.getAttachment."),
+    bcc: z.array(namedAddressSchema).optional(),
+    cc: z.array(namedAddressSchema).optional(),
+    html: z.string().optional().describe("The HTML body."),
+    links: z
+        .array(z.string())
+        .describe("The links of the email, in order: HTML anchors, then images, then bare URLs of the plain text body. Follow one to confirm a sign-up or reset a password."),
+    replyTo: z.array(namedAddressSchema).optional(),
+    text: z.string().optional().describe("The plain text body."),
+}, { urlFieldDescription: emailUrlFieldDescription });
+//# sourceMappingURL=resource.js.map

package/dist/v1/email/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../src/v1/email/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;AAIpE,4EAA4E;AAC5E,wEAAwE;AACxE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAClD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,iDAAiD,CAAC;CAC/D,CAAC,CAAC;AAEH,8EAA8E;AAC9E,8CAA8C;AAC9C,MAAM,CAAC,MAAM,wBAAwB,GACnC,qEAAqE,CAAC;AAExE,8EAA8E;AAC9E,sEAAsE;AACtE,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,CAAC;IAC3C,0EAA0E;IAC1E,6DAA6D;IAC7D,SAAS,EAAE,CAAC,CAAC,GAAG;SACb,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SAC1B,QAAQ,CAAC,0CAA0C,CAAC;IACvD,SAAS,EAAE,oBAAoB,CAAC,QAAQ,CACtC,qEAAqE,CACtE;IACD,IAAI,EAAE,kBAAkB;IACxB,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE,CAC1C,QAAQ,CACN;IACE,GAAG,sBAAsB,EAAE;IAC3B,WAAW,EAAE,CAAC;SACX,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,6GAA6G,CAC9G;QACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;KACvD,CAAC,CACH;SACA,QAAQ,EAAE;SACV,QAAQ,CACP,oFAAoF,CACrF;IACH,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IAC3C,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACtD,KAAK,EAAE,CAAC;SACL,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,0JAA0J,CAC3J;IACH,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IAC/C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CAC7D,EACD,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,CAClD,CAAC"}

package/dist/v1/email/send.d.ts

@@ -0,0 +1,46 @@
+import { z } from "zod";
+import type { PublicIdSchema } from "../ids.js";
+/**
+ * The most base64 content the attachments of one email may carry together.
+ * SendGrid refuses a message over 30 MB, and base64 is the form on the wire.
+ */
+export declare const maxEmailAttachmentsBase64Length: number;
+export declare const makeSendEmailContract: <WorkspaceId extends PublicIdSchema>(ids: {
+    workspace: WorkspaceId;
+}) => {
+    readonly description: "Send an email from one of the workspace's inbox addresses, for example to exercise a flow that reacts to incoming mail. Returns the sent email; read it back with email.get.";
+    readonly input: z.ZodObject<{
+        attachments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBase64>>;
+        bcc: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
+        cc: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
+        from: z.ZodOptional<z.ZodEmail>;
+        html: z.ZodOptional<z.ZodString>;
+        inReplyTo: z.ZodOptional<z.ZodString>;
+        replyTo: z.ZodOptional<z.ZodArray<z.ZodEmail>>;
+        subject: z.ZodString;
+        text: z.ZodOptional<z.ZodString>;
+        to: z.ZodArray<z.ZodEmail>;
+        workspaceId: z.ZodOptional<WorkspaceId>;
+    }, z.core.$strip>;
+    readonly kind: "write";
+    readonly name: "email.send";
+    readonly output: z.ZodObject<{
+        createdAt: z.ZodISODateTime;
+        direction: z.ZodEnum<{
+            inbound: "inbound";
+            outbound: "outbound";
+        }>;
+        from: z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        id: z.ZodString;
+        subject: z.ZodOptional<z.ZodString>;
+        to: z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        url: z.ZodURL;
+    }, z.core.$strip>;
+};
+//# sourceMappingURL=send.d.ts.map

package/dist/v1/email/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../../../src/v1/email/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAYhD;;;GAGG;AACH,eAAO,MAAM,+BAA+B,QAAmB,CAAC;AAQhE,eAAO,MAAM,qBAAqB,GAAI,WAAW,SAAS,cAAc,EAAE,KAAK;IAC7E,SAAS,EAAE,WAAW,CAAC;CACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuEA,CAAC"}