@qawolf/api-contracts 0.42.0 → 0.48.0

package/dist/v1/email/send.js

@@ -0,0 +1,62 @@
+import { z } from "zod";
+import { resource } from "../resource.js";
+import { emailUrlFieldDescription, makeEmailSummaryFields, } from "./resource.js";
+const recipientsSchema = z.array(z.email()).max(50);
+const maxAttachments = 10;
+/**
+ * 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 const maxEmailAttachmentsBase64Length = 30 * 1024 * 1024;
+const attachmentsBase64Length = (attachments) => Object.values(attachments).reduce((total, content) => total + content.length, 0);
+export const makeSendEmailContract = (ids) => {
+    const input = z
+        .object({
+        // A record rather than a list: the CLI expresses a record of strings
+        // as one repeatable flag, and cannot express a list of objects.
+        attachments: z
+            .record(z.string().min(1), z.base64())
+            .refine((attachments) => Object.keys(attachments).length <= maxAttachments, { message: `Send at most ${maxAttachments} attachments.` })
+            // A cap here answers with a 400 before the payload reaches the
+            // emailer, whatever the state of the size guard behind it.
+            .refine((attachments) => attachmentsBase64Length(attachments) <=
+            maxEmailAttachmentsBase64Length, { message: "Send at most 30 MB of attachments." })
+            .optional()
+            .describe("Files to attach, as file name to base64 content, at most 30 MB in total. The MIME type comes from the file name's extension."),
+        bcc: recipientsSchema.optional(),
+        cc: recipientsSchema.optional(),
+        from: z
+            .email()
+            .optional()
+            .describe("The workspace inbox address to send from, or a plus-suffixed form of one. Defaults to the workspace's default inbox address. See email.listAddresses."),
+        html: z.string().optional().describe("The HTML body."),
+        inReplyTo: z
+            .string()
+            .min(1)
+            .optional()
+            .describe("The id of an email of the workspace to reply to, from email.find. The reply threads under that message."),
+        replyTo: recipientsSchema
+            .optional()
+            .describe("Where replies should go instead of the from address."),
+        subject: z.string().min(1),
+        text: z.string().optional().describe("The plain text body."),
+        to: recipientsSchema.min(1),
+        workspaceId: ids.workspace
+            .optional()
+            .describe("The workspace to send from. Required when authenticating with an organization or user API key."),
+    })
+        .refine((email) => email.html || email.text, {
+        message: "Provide text, html, or both.",
+    });
+    const output = resource(makeEmailSummaryFields(), {
+        urlFieldDescription: emailUrlFieldDescription,
+    });
+    return {
+        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.",
+        input,
+        kind: "write",
+        name: "email.send",
+        output,
+    };
+};
+//# sourceMappingURL=send.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../../../src/v1/email/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EACL,wBAAwB,EACxB,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAEpD,MAAM,cAAc,GAAG,EAAE,CAAC;AAE1B;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhE,MAAM,uBAAuB,GAAG,CAAC,WAAmC,EAAE,EAAE,CACtE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAC/B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,EAC1C,CAAC,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAqC,GAEzE,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,CAAC;SACZ,MAAM,CAAC;QACN,qEAAqE;QACrE,gEAAgE;QAChE,WAAW,EAAE,CAAC;aACX,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;aACrC,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,cAAc,EAClE,EAAE,OAAO,EAAE,gBAAgB,cAAc,eAAe,EAAE,CAC3D;YACD,+DAA+D;YAC/D,2DAA2D;aAC1D,MAAM,CACL,CAAC,WAAW,EAAE,EAAE,CACd,uBAAuB,CAAC,WAAW,CAAC;YACpC,+BAA+B,EACjC,EAAE,OAAO,EAAE,oCAAoC,EAAE,CAClD;aACA,QAAQ,EAAE;aACV,QAAQ,CACP,8HAA8H,CAC/H;QACH,GAAG,EAAE,gBAAgB,CAAC,QAAQ,EAAE;QAChC,EAAE,EAAE,gBAAgB,CAAC,QAAQ,EAAE;QAC/B,IAAI,EAAE,CAAC;aACJ,KAAK,EAAE;aACP,QAAQ,EAAE;aACV,QAAQ,CACP,uJAAuJ,CACxJ;QACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QACtD,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,yGAAyG,CAC1G;QACH,OAAO,EAAE,gBAAgB;aACtB,QAAQ,EAAE;aACV,QAAQ,CAAC,sDAAsD,CAAC;QACnE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QAC5D,EAAE,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,WAAW,EAAE,GAAG,CAAC,SAAS;aACvB,QAAQ,EAAE;aACV,QAAQ,CACP,gGAAgG,CACjG;KACJ,CAAC;SACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;QAC3C,OAAO,EAAE,8BAA8B;KACxC,CAAC,CAAC;IACL,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,EAAE,EAAE;QAChD,mBAAmB,EAAE,wBAAwB;KAC9C,CAAC,CAAC;IAEH,OAAO;QACL,WAAW,EACT,8KAA8K;QAChL,KAAK;QACL,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,YAAY;QAClB,MAAM;KAMP,CAAC;AACJ,CAAC,CAAC"}