@automate.ax/integration-contracts 0.68.0 → 0.68.2

package/dist/gmail/gmail.d.ts

@@ -5,6 +5,8 @@ import { ATTACHMENT_INPUT_SCHEMA, DRAFT_IDENTIFIER_SCHEMA, LABEL_SCHEMA, MESSAGE
 export declare const AUTOMATE_AX_EMAIL_HEADER = "X-Sent-From-Automate-Ax";
 /** Internal options for constructing one RFC 5322 message. */
 export interface BuildMessageOptions {
+    /** Signed identity of the automation composing the message. */
+    automationOriginToken?: string;
     /** Files and inline MIME parts attached to the message. */
     attachments?: z.input<typeof ATTACHMENT_INPUT_SCHEMA>[];
     /** Blind-copy recipients. */
@@ -46,6 +48,14 @@ export declare function getGmailApi(secret: Record<string, unknown>): gmail_v1.G
  * @param options - Message recipients, content, headers, and attachments.
  */
 export declare function buildRawMessage(options: BuildMessageOptions): Promise<string>;
+/**
+ * Replaces Automate.ax's origin header without changing the MIME body.
+ *
+ * @param raw - Base64url-encoded RFC 5322 message.
+ * @param token - Signed automation-origin token.
+ * @throws When the message has no RFC 5322 header boundary.
+ */
+export declare function setRawMessageAutomationOrigin(raw: string, token: string): string;
 /**
  * Resolves a Gmail label name or ID to its canonical ID.
  *
@@ -117,8 +127,9 @@ export declare function toMessageMetadata(message: gmail_v1.Schema$Message, oper
  * @param gmailApi - Authenticated Gmail client.
  * @param original - Message receiving the reply.
  * @param input - Reply body, recipients, headers, and attachments.
+ * @param automationOriginToken - Signed identity of the sending automation.
  */
-export declare function sendReply(gmailApi: gmail_v1.Gmail, original: gmail_v1.Schema$Message, input: z.input<typeof REPLY_OPTIONS_SCHEMA>): Promise<{
+export declare function sendReply(gmailApi: gmail_v1.Gmail, original: gmail_v1.Schema$Message, input: z.input<typeof REPLY_OPTIONS_SCHEMA>, automationOriginToken?: string): Promise<{
     messageId: string;
     threadId: string;
     labelIds: string[];

package/dist/gmail/gmail.js

@@ -4,9 +4,9 @@ import MailComposer from "nodemailer/lib/mail-composer";
 import PostalMime, { addressParser, } from "postal-mime";
 import { z } from "zod";
 export const AUTOMATE_AX_EMAIL_HEADER = "X-Sent-From-Automate-Ax";
+const AUTOMATE_AX_EMAIL_HEADER_LOWERCASE = AUTOMATE_AX_EMAIL_HEADER.toLowerCase();
 const AUTOMATE_EMAIL_HEADERS = {
     "X-Mailer": "Automate.ax",
-    [AUTOMATE_AX_EMAIL_HEADER]: "true",
 };
 const HTML_TO_TEXT = compile({ wordwrap: false });
 const GMAIL_SECRET_SCHEMA = z.object({
@@ -56,8 +56,11 @@ export async function buildRawMessage(options) {
         cc: options.cc,
         from: options.from,
         headers: {
-            ...options.headers,
+            ...Object.fromEntries(Object.entries(options.headers ?? {}).filter(([name]) => name.toLowerCase() !== AUTOMATE_AX_EMAIL_HEADER_LOWERCASE)),
             ...AUTOMATE_EMAIL_HEADERS,
+            ...(options.automationOriginToken && {
+                [AUTOMATE_AX_EMAIL_HEADER]: options.automationOriginToken,
+            }),
         },
         html: options.html,
         inReplyTo: options.inReplyTo,
@@ -73,6 +76,37 @@ export async function buildRawMessage(options) {
     message.keepBcc = true;
     return (await message.build()).toString("base64url");
 }
+/**
+ * Replaces Automate.ax's origin header without changing the MIME body.
+ *
+ * @param raw - Base64url-encoded RFC 5322 message.
+ * @param token - Signed automation-origin token.
+ * @throws When the message has no RFC 5322 header boundary.
+ */
+export function setRawMessageAutomationOrigin(raw, token) {
+    const message = Buffer.from(raw, "base64url").toString("latin1");
+    const headerSeparator = message.includes("\r\n\r\n") ? "\r\n" : "\n";
+    const headerEnd = message.indexOf(`${headerSeparator}${headerSeparator}`);
+    if (headerEnd === -1)
+        throw new Error("Email message has no header boundary.");
+    const headers = [];
+    let removesCurrentHeader = false;
+    for (const line of message.slice(0, headerEnd).split(headerSeparator)) {
+        if (/^[\t ]/.test(line)) {
+            if (!removesCurrentHeader)
+                headers.push(line);
+            continue;
+        }
+        const colon = line.indexOf(":");
+        removesCurrentHeader =
+            colon !== -1 &&
+                line.slice(0, colon).toLowerCase() === AUTOMATE_AX_EMAIL_HEADER_LOWERCASE;
+        if (!removesCurrentHeader)
+            headers.push(line);
+    }
+    headers.push(`${AUTOMATE_AX_EMAIL_HEADER}: ${token}`);
+    return Buffer.from(`${headers.join(headerSeparator)}${headerSeparator}${headerSeparator}${message.slice(headerEnd + headerSeparator.length * 2)}`, "latin1").toString("base64url");
+}
 /**
  * Resolves a Gmail label name or ID to its canonical ID.
  *
@@ -235,13 +269,15 @@ export function toMessageMetadata(message, operation) {
  * @param gmailApi - Authenticated Gmail client.
  * @param original - Message receiving the reply.
  * @param input - Reply body, recipients, headers, and attachments.
+ * @param automationOriginToken - Signed identity of the sending automation.
  */
-export async function sendReply(gmailApi, original, input) {
+export async function sendReply(gmailApi, original, input, automationOriginToken) {
     const replyOptions = await getReplyOptions(gmailApi, original, input.replyAll ?? false);
     return toMessageMetadata((await gmailApi.users.messages.send({
         requestBody: {
             raw: await buildRawMessage({
                 ...getReplyMessageOptions(replyOptions, input),
+                automationOriginToken,
                 bcc: input.bcc,
                 from: input.from,
                 headers: input.headers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.68.0",
+  "version": "0.68.2",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -41,7 +41,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/codec": "0.68.0",
+    "@automate.ax/codec": "0.68.2",
     "@googleapis/calendar": "^15.0.0",
     "@googleapis/forms": "^6.0.1",
     "@googleapis/gmail": "^12.0.0",

package/src/gmail/gmail.ts

@@ -19,9 +19,10 @@ import {
 } from "./schemas"
 
 export const AUTOMATE_AX_EMAIL_HEADER = "X-Sent-From-Automate-Ax"
+const AUTOMATE_AX_EMAIL_HEADER_LOWERCASE =
+  AUTOMATE_AX_EMAIL_HEADER.toLowerCase()
 const AUTOMATE_EMAIL_HEADERS = {
   "X-Mailer": "Automate.ax",
-  [AUTOMATE_AX_EMAIL_HEADER]: "true",
 }
 const HTML_TO_TEXT = compile({ wordwrap: false })
 const GMAIL_SECRET_SCHEMA = z.object({
@@ -37,6 +38,9 @@ const LABEL_TYPE_SCHEMA = z.enum(["system", "user"])
 
 /** Internal options for constructing one RFC 5322 message. */
 export interface BuildMessageOptions {
+  /** Signed identity of the automation composing the message. */
+  automationOriginToken?: string
+
   /** Files and inline MIME parts attached to the message. */
   attachments?: z.input<typeof ATTACHMENT_INPUT_SCHEMA>[]
 
@@ -120,8 +124,15 @@ export async function buildRawMessage(options: BuildMessageOptions) {
     cc: options.cc,
     from: options.from,
     headers: {
-      ...options.headers,
+      ...Object.fromEntries(
+        Object.entries(options.headers ?? {}).filter(
+          ([name]) => name.toLowerCase() !== AUTOMATE_AX_EMAIL_HEADER_LOWERCASE,
+        ),
+      ),
       ...AUTOMATE_EMAIL_HEADERS,
+      ...(options.automationOriginToken && {
+        [AUTOMATE_AX_EMAIL_HEADER]: options.automationOriginToken,
+      }),
     },
     html: options.html,
     inReplyTo: options.inReplyTo,
@@ -140,6 +151,41 @@ export async function buildRawMessage(options: BuildMessageOptions) {
   return (await message.build()).toString("base64url")
 }
 
+/**
+ * Replaces Automate.ax's origin header without changing the MIME body.
+ *
+ * @param raw - Base64url-encoded RFC 5322 message.
+ * @param token - Signed automation-origin token.
+ * @throws When the message has no RFC 5322 header boundary.
+ */
+export function setRawMessageAutomationOrigin(raw: string, token: string) {
+  const message = Buffer.from(raw, "base64url").toString("latin1")
+  const headerSeparator = message.includes("\r\n\r\n") ? "\r\n" : "\n"
+  const headerEnd = message.indexOf(`${headerSeparator}${headerSeparator}`)
+  if (headerEnd === -1) throw new Error("Email message has no header boundary.")
+
+  const headers: string[] = []
+  let removesCurrentHeader = false
+  for (const line of message.slice(0, headerEnd).split(headerSeparator)) {
+    if (/^[\t ]/.test(line)) {
+      if (!removesCurrentHeader) headers.push(line)
+      continue
+    }
+
+    const colon = line.indexOf(":")
+    removesCurrentHeader =
+      colon !== -1 &&
+      line.slice(0, colon).toLowerCase() === AUTOMATE_AX_EMAIL_HEADER_LOWERCASE
+    if (!removesCurrentHeader) headers.push(line)
+  }
+  headers.push(`${AUTOMATE_AX_EMAIL_HEADER}: ${token}`)
+
+  return Buffer.from(
+    `${headers.join(headerSeparator)}${headerSeparator}${headerSeparator}${message.slice(headerEnd + headerSeparator.length * 2)}`,
+    "latin1",
+  ).toString("base64url")
+}
+
 /**
  * Resolves a Gmail label name or ID to its canonical ID.
  *
@@ -345,11 +391,13 @@ export function toMessageMetadata(
  * @param gmailApi - Authenticated Gmail client.
  * @param original - Message receiving the reply.
  * @param input - Reply body, recipients, headers, and attachments.
+ * @param automationOriginToken - Signed identity of the sending automation.
  */
 export async function sendReply(
   gmailApi: gmail_v1.Gmail,
   original: gmail_v1.Schema$Message,
   input: z.input<typeof REPLY_OPTIONS_SCHEMA>,
+  automationOriginToken?: string,
 ) {
   const replyOptions = await getReplyOptions(
     gmailApi,
@@ -362,6 +410,7 @@ export async function sendReply(
         requestBody: {
           raw: await buildRawMessage({
             ...getReplyMessageOptions(replyOptions, input),
+            automationOriginToken,
             bcc: input.bcc,
             from: input.from,
             headers: input.headers,