@automate.ax/catalog 0.63.0 → 0.64.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { airtableService, anthropicService, apolloService, asanaService, brevoService, cerebrasService, cloudflareService, cohereService, deepinfraService, deepseekService, firecrawlService, fireworksService, getIntegrationService, githubService, googleGenaiService, googleService, groqService, huggingfaceService, integrationCatalog, linearService, microsoftService, millionverifierService, mistralService, openaiService, openrouterService, perplexityService, postgresService, resendService, scrapflyService, slackService, tidycalService, togetheraiService, trelloService, vercelAiGatewayService, vercelService, whatsappService, xaiService, type IntegrationServiceId, } from "./catalog.js";
 export { defineIntegrationCatalog, defineIntegrationService, integrationScope, type IntegrationAccountConnectionOption, type IntegrationAccountRequirement, type IntegrationConnectionDefinition, type IntegrationFormField, type IntegrationScopeRequirement, type IntegrationServiceDefinition, type ScopeRequirementGroup, type TriggerDefinition, type TriggerPresentation, type TriggerPresentationContext, type TriggerPresentationDetail, type TriggerScopePresentation, type TriggerPresentationValue, } from "./types.js";
-export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, type TriggerType, } from "./triggers/index.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getMailhookAddress, getMailhookAddressKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, PLATFORM_EMAIL_DOMAIN, triggerCatalog, triggerDefinitions, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, type MailhookAddressOptions, type MailhookScope, type TriggerType, } from "./triggers/index.js";

package/dist/index.js

@@ -1,3 +1,3 @@
 export { airtableService, anthropicService, apolloService, asanaService, brevoService, cerebrasService, cloudflareService, cohereService, deepinfraService, deepseekService, firecrawlService, fireworksService, getIntegrationService, githubService, googleGenaiService, googleService, groqService, huggingfaceService, integrationCatalog, linearService, microsoftService, millionverifierService, mistralService, openaiService, openrouterService, perplexityService, postgresService, resendService, scrapflyService, slackService, tidycalService, togetheraiService, trelloService, vercelAiGatewayService, vercelService, whatsappService, xaiService, } from "./catalog.js";
 export { defineIntegrationCatalog, defineIntegrationService, integrationScope, } from "./types.js";
-export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, } from "./triggers/index.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getMailhookAddress, getMailhookAddressKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, PLATFORM_EMAIL_DOMAIN, triggerCatalog, triggerDefinitions, } from "./triggers/index.js";

package/dist/triggers/core.d.ts

@@ -70,6 +70,15 @@ export declare const coreTriggerDefinitions: {
         readonly name: "HTTP request";
         readonly type: "http.request";
     };
+    readonly mailhookEmailReceived: {
+        readonly getPrimary: ({ automationId, config, hookSlot, projectId, scopePath }: import("..").TriggerPresentationContext) => {
+            copyable: true;
+            value: string;
+        };
+        readonly icon: "webhook";
+        readonly name: "Mailhook";
+        readonly type: "mailhook.email.received";
+    };
     readonly dashboardRun: {
         readonly getDetails: ({ config }: import("..").TriggerPresentationContext) => {
             label: string;
@@ -127,6 +136,8 @@ export interface DashboardRunEndpointOptions {
     scopePath?: readonly number[];
 }
 export type HttpTriggerScope = "trigger" | "automation" | "project";
+export type MailhookScope = HttpTriggerScope;
+export declare const PLATFORM_EMAIL_DOMAIN = "automations.automate.ax";
 export interface HttpTriggerEndpointOptions {
     appOrigin: string;
     automationId: string;
@@ -135,6 +146,14 @@ export interface HttpTriggerEndpointOptions {
     scope: HttpTriggerScope;
     scopePath?: readonly number[];
 }
+export interface MailhookAddressOptions {
+    automationId: string;
+    hookSlot: number;
+    plusPath?: string;
+    projectId: string;
+    scope: MailhookScope;
+    scopePath?: readonly number[];
+}
 /**
  * Returns the public URL for one deployed HTTP trigger.
  *
@@ -147,6 +166,21 @@ export declare function getHttpTriggerEndpoint(options: HttpTriggerEndpointOptio
  * @param options - Trigger and owning resource identity.
  */
 export declare function getHttpTriggerEndpointKey(options: Omit<HttpTriggerEndpointOptions, "appOrigin">): string;
+/**
+ * Returns the unique inbound address for one deployed mailhook.
+ *
+ * Add `+suffix` before the `@` to carry a routing value into the event.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ * @throws When the generated local part exceeds the email size limit.
+ */
+export declare function getMailhookAddress(options: MailhookAddressOptions): string;
+/**
+ * Returns the local-part router key for one configured mailhook scope.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ */
+export declare function getMailhookAddressKey(options: MailhookAddressOptions): string;
 /**
  * Returns the organization-authenticated submission endpoint for one dashboard
  * run.

package/dist/triggers/core.js

@@ -1,4 +1,6 @@
 import * as z from "zod/mini";
+const MAX_EMAIL_LOCAL_PART_BYTES = 64;
+const EMAIL_SCHEMA = z.email();
 const CRON_PRESENTATION_CONFIG_SCHEMA = z.object({
     schedule: z.string(),
     timeZone: z.prefault(z.string(), "UTC"),
@@ -6,6 +8,9 @@ const CRON_PRESENTATION_CONFIG_SCHEMA = z.object({
 const HTTP_PRESENTATION_CONFIG_SCHEMA = z.object({
     scope: z.prefault(z.enum(["trigger", "automation", "project"]), "trigger"),
 });
+const MAILHOOK_PRESENTATION_CONFIG_SCHEMA = z.object({
+    scope: z.prefault(z.enum(["trigger", "automation", "project"]), "trigger"),
+});
 const INVOCATION_PRESENTATION_CONFIG_SCHEMA = z.object({
     entrypoint: z.string(),
 });
@@ -103,6 +108,21 @@ export const coreTriggerDefinitions = {
         name: "HTTP request",
         type: "http.request",
     },
+    mailhookEmailReceived: {
+        getPrimary: ({ automationId, config, hookSlot, projectId, scopePath }) => ({
+            copyable: true,
+            value: getMailhookAddress({
+                automationId,
+                hookSlot,
+                projectId,
+                scope: MAILHOOK_PRESENTATION_CONFIG_SCHEMA.parse(config).scope,
+                scopePath,
+            }),
+        }),
+        icon: "webhook",
+        name: "Mailhook",
+        type: "mailhook.email.received",
+    },
     dashboardRun: {
         getDetails: ({ config }) => [
             {
@@ -115,6 +135,7 @@ export const coreTriggerDefinitions = {
         type: "dashboard.run",
     },
 };
+export const PLATFORM_EMAIL_DOMAIN = "automations.automate.ax";
 /**
  * Returns the public URL for one deployed HTTP trigger.
  *
@@ -138,6 +159,39 @@ export function getHttpTriggerEndpointKey(options) {
         options.hookSlot,
     ].join(".")}`;
 }
+/**
+ * Returns the unique inbound address for one deployed mailhook.
+ *
+ * Add `+suffix` before the `@` to carry a routing value into the event.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ * @throws When the generated local part exceeds the email size limit.
+ */
+export function getMailhookAddress(options) {
+    const localPart = `${getMailhookAddressKey(options)}${options.plusPath ? `+${options.plusPath}` : ""}`;
+    if (new TextEncoder().encode(localPart).length > MAX_EMAIL_LOCAL_PART_BYTES) {
+        throw new RangeError("Mailhook address local part exceeds 64 bytes.");
+    }
+    return EMAIL_SCHEMA.parse(`${localPart}@${PLATFORM_EMAIL_DOMAIN}`);
+}
+/**
+ * Returns the local-part router key for one configured mailhook scope.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ */
+export function getMailhookAddressKey(options) {
+    if (options.scope === "project")
+        return `p${typeIdSuffix(options.projectId)}`;
+    if (options.scope === "automation") {
+        return `a${typeIdSuffix(options.automationId)}`;
+    }
+    return `a${typeIdSuffix(options.automationId)}.${[
+        ...(options.scopePath ?? []),
+        options.hookSlot,
+    ]
+        .map((segment) => segment.toString(36))
+        .join(".")}`;
+}
 /**
  * Returns the organization-authenticated submission endpoint for one dashboard
  * run.
@@ -158,3 +212,11 @@ export function getDashboardRunEndpointKey(options) {
         options.hookSlot,
     ].join(".")}`;
 }
+/**
+ * Removes the redundant TypeID prefix from an address router.
+ *
+ * @param id - Project or automation TypeID.
+ */
+function typeIdSuffix(id) {
+    return id.includes("_") ? id.slice(id.indexOf("_") + 1) : id;
+}

package/dist/triggers/index.d.ts

@@ -1,5 +1,5 @@
 import type { TriggerDefinition, TriggerPresentation, TriggerPresentationContext, TriggerScopePresentation } from "../types.js";
-export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, } from "./core.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getMailhookAddress, getMailhookAddressKey, PLATFORM_EMAIL_DOMAIN, DASHBOARD_RUN_CONFIG_SCHEMA, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, type MailhookAddressOptions, type MailhookScope, } from "./core.js";
 /** Plain shared definitions for every public trigger type. */
 export declare const triggerDefinitions: {
     readonly whatsappMessageDelivered: {
@@ -1075,6 +1075,15 @@ export declare const triggerDefinitions: {
         readonly name: "HTTP request";
         readonly type: "http.request";
     };
+    readonly mailhookEmailReceived: {
+        readonly getPrimary: ({ automationId, config, hookSlot, projectId, scopePath }: TriggerPresentationContext) => {
+            copyable: true;
+            value: string;
+        };
+        readonly icon: "webhook";
+        readonly name: "Mailhook";
+        readonly type: "mailhook.email.received";
+    };
     readonly dashboardRun: {
         readonly getDetails: ({ config }: TriggerPresentationContext) => {
             label: string;
@@ -1564,6 +1573,14 @@ export declare const triggerCatalog: ({
     };
     icon: "webhook";
     type: "http.request";
+} | {
+    name: string;
+    getPrimary: ({ automationId, config, hookSlot, projectId, scopePath }: TriggerPresentationContext) => {
+        copyable: true;
+        value: string;
+    };
+    icon: "webhook";
+    type: "mailhook.email.received";
 } | {
     name: string;
     getDetails: ({ config }: TriggerPresentationContext) => {

package/dist/triggers/index.js

@@ -12,7 +12,7 @@ import { trelloTriggerDefinitions } from "./trello.js";
 import { vercelTriggerDefinitions } from "./vercel.js";
 import { whatsappTriggerDefinitions } from "./whatsapp.js";
 import { getIntegrationService } from "../catalog.js";
-export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, } from "./core.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getMailhookAddress, getMailhookAddressKey, PLATFORM_EMAIL_DOMAIN, DASHBOARD_RUN_CONFIG_SCHEMA, } from "./core.js";
 /** Plain shared definitions for every public trigger type. */
 export const triggerDefinitions = {
     ...airtableTriggerDefinitions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/catalog",
-  "version": "0.63.0",
+  "version": "0.64.0",
   "description": "Shared integration service and trigger definitions for Automate.ax.",
   "license": "MIT",
   "repository": {

package/src/index.ts

@@ -61,11 +61,14 @@ export {
   getDashboardRunEndpointKey,
   getHttpTriggerEndpoint,
   getHttpTriggerEndpointKey,
+  getMailhookAddress,
+  getMailhookAddressKey,
   DASHBOARD_RUN_CONFIG_SCHEMA,
   getTriggerDefinition,
   getTriggerName,
   getTriggerPresentation,
   isTriggerVisible,
+  PLATFORM_EMAIL_DOMAIN,
   triggerCatalog,
   triggerDefinitions,
   type DashboardRunConfig,
@@ -73,5 +76,7 @@ export {
   type DashboardRunField,
   type HttpTriggerEndpointOptions,
   type HttpTriggerScope,
+  type MailhookAddressOptions,
+  type MailhookScope,
   type TriggerType,
 } from "./triggers"

package/src/triggers/core.ts

@@ -1,6 +1,8 @@
 import type { TriggerDefinition } from "../types"
 import * as z from "zod/mini"
 
+const MAX_EMAIL_LOCAL_PART_BYTES = 64
+const EMAIL_SCHEMA = z.email()
 const CRON_PRESENTATION_CONFIG_SCHEMA = z.object({
   schedule: z.string(),
   timeZone: z.prefault(z.string(), "UTC"),
@@ -8,6 +10,9 @@ const CRON_PRESENTATION_CONFIG_SCHEMA = z.object({
 const HTTP_PRESENTATION_CONFIG_SCHEMA = z.object({
   scope: z.prefault(z.enum(["trigger", "automation", "project"]), "trigger"),
 })
+const MAILHOOK_PRESENTATION_CONFIG_SCHEMA = z.object({
+  scope: z.prefault(z.enum(["trigger", "automation", "project"]), "trigger"),
+})
 const INVOCATION_PRESENTATION_CONFIG_SCHEMA = z.object({
   entrypoint: z.string(),
 })
@@ -123,6 +128,21 @@ export const coreTriggerDefinitions = {
     name: "HTTP request",
     type: "http.request",
   },
+  mailhookEmailReceived: {
+    getPrimary: ({ automationId, config, hookSlot, projectId, scopePath }) => ({
+      copyable: true,
+      value: getMailhookAddress({
+        automationId,
+        hookSlot,
+        projectId,
+        scope: MAILHOOK_PRESENTATION_CONFIG_SCHEMA.parse(config).scope,
+        scopePath,
+      }),
+    }),
+    icon: "webhook",
+    name: "Mailhook",
+    type: "mailhook.email.received",
+  },
   dashboardRun: {
     getDetails: ({ config }) => [
       {
@@ -199,6 +219,9 @@ export interface DashboardRunEndpointOptions {
 }
 
 export type HttpTriggerScope = "trigger" | "automation" | "project"
+export type MailhookScope = HttpTriggerScope
+
+export const PLATFORM_EMAIL_DOMAIN = "automations.automate.ax"
 
 export interface HttpTriggerEndpointOptions {
   appOrigin: string
@@ -209,6 +232,15 @@ export interface HttpTriggerEndpointOptions {
   scopePath?: readonly number[]
 }
 
+export interface MailhookAddressOptions {
+  automationId: string
+  hookSlot: number
+  plusPath?: string
+  projectId: string
+  scope: MailhookScope
+  scopePath?: readonly number[]
+}
+
 /**
  * Returns the public URL for one deployed HTTP trigger.
  *
@@ -237,6 +269,42 @@ export function getHttpTriggerEndpointKey(
   ].join(".")}`
 }
 
+/**
+ * Returns the unique inbound address for one deployed mailhook.
+ *
+ * Add `+suffix` before the `@` to carry a routing value into the event.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ * @throws When the generated local part exceeds the email size limit.
+ */
+export function getMailhookAddress(options: MailhookAddressOptions) {
+  const localPart = `${getMailhookAddressKey(options)}${options.plusPath ? `+${options.plusPath}` : ""}`
+  if (new TextEncoder().encode(localPart).length > MAX_EMAIL_LOCAL_PART_BYTES) {
+    throw new RangeError("Mailhook address local part exceeds 64 bytes.")
+  }
+
+  return EMAIL_SCHEMA.parse(`${localPart}@${PLATFORM_EMAIL_DOMAIN}`)
+}
+
+/**
+ * Returns the local-part router key for one configured mailhook scope.
+ *
+ * @param options - Mailhook identity and sharing scope.
+ */
+export function getMailhookAddressKey(options: MailhookAddressOptions) {
+  if (options.scope === "project") return `p${typeIdSuffix(options.projectId)}`
+  if (options.scope === "automation") {
+    return `a${typeIdSuffix(options.automationId)}`
+  }
+
+  return `a${typeIdSuffix(options.automationId)}.${[
+    ...(options.scopePath ?? []),
+    options.hookSlot,
+  ]
+    .map((segment) => segment.toString(36))
+    .join(".")}`
+}
+
 /**
  * Returns the organization-authenticated submission endpoint for one dashboard
  * run.
@@ -263,3 +331,12 @@ export function getDashboardRunEndpointKey(
     options.hookSlot,
   ].join(".")}`
 }
+
+/**
+ * Removes the redundant TypeID prefix from an address router.
+ *
+ * @param id - Project or automation TypeID.
+ */
+function typeIdSuffix(id: string) {
+  return id.includes("_") ? id.slice(id.indexOf("_") + 1) : id
+}

package/src/triggers/index.ts

@@ -24,12 +24,17 @@ export {
   getDashboardRunEndpointKey,
   getHttpTriggerEndpoint,
   getHttpTriggerEndpointKey,
+  getMailhookAddress,
+  getMailhookAddressKey,
+  PLATFORM_EMAIL_DOMAIN,
   DASHBOARD_RUN_CONFIG_SCHEMA,
   type DashboardRunConfig,
   type DashboardRunEndpointOptions,
   type DashboardRunField,
   type HttpTriggerEndpointOptions,
   type HttpTriggerScope,
+  type MailhookAddressOptions,
+  type MailhookScope,
 } from "./core"
 
 /** Plain shared definitions for every public trigger type. */