@automate.ax/integration-contracts 0.104.0 → 0.107.0

package/dist/slack/schemas.d.ts

@@ -110,8 +110,8 @@ export declare const SLACK_REACTION_ITEM_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodO
     conversationId: z.ZodString;
     conversationType: z.ZodOptional<z.ZodEnum<{
         group: "group";
-        channel: "channel";
         im: "im";
+        channel: "channel";
         mpim: "mpim";
     }>>;
     messageTimestamp: z.ZodString;

package/dist/teams/schemas.d.ts

@@ -56,11 +56,11 @@ export declare const TEAMS_CHANNEL_SCHEMA: z.ZodObject<{
     channelId: z.ZodString;
     isArchived: z.ZodPrefault<z.ZodBoolean>;
     membershipType: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        standard: "standard";
         private: "private";
         shared: "shared";
         unknownFutureValue: "unknownFutureValue";
-        standard: "standard";
-    }>>>, z.ZodTransform<"private" | "shared" | "unknownFutureValue" | "standard" | undefined, "private" | "shared" | "unknownFutureValue" | "standard" | null | undefined>>;
+    }>>>, z.ZodTransform<"standard" | "private" | "shared" | "unknownFutureValue" | undefined, "standard" | "private" | "shared" | "unknownFutureValue" | null | undefined>>;
     webUrl: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | undefined, string | null | undefined>>;
 }, z.core.$strip>;
 export declare const GRAPH_CHANNEL_SCHEMA: z.ZodPipe<z.ZodObject<{
@@ -71,10 +71,10 @@ export declare const GRAPH_CHANNEL_SCHEMA: z.ZodPipe<z.ZodObject<{
     id: z.ZodString;
     isArchived: z.ZodOptional<z.ZodBoolean>;
     membershipType: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        standard: "standard";
         private: "private";
         shared: "shared";
         unknownFutureValue: "unknownFutureValue";
-        standard: "standard";
     }>>>;
     webUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$loose>, z.ZodTransform<{
@@ -84,7 +84,7 @@ export declare const GRAPH_CHANNEL_SCHEMA: z.ZodPipe<z.ZodObject<{
     email: string | undefined;
     channelId: string;
     isArchived: boolean;
-    membershipType: "private" | "shared" | "unknownFutureValue" | "standard" | undefined;
+    membershipType: "standard" | "private" | "shared" | "unknownFutureValue" | undefined;
     webUrl: string | undefined;
 }, {
     [x: string]: unknown;
@@ -94,7 +94,7 @@ export declare const GRAPH_CHANNEL_SCHEMA: z.ZodPipe<z.ZodObject<{
     description?: string | null | undefined;
     email?: string | null | undefined;
     isArchived?: boolean | undefined;
-    membershipType?: "private" | "shared" | "unknownFutureValue" | "standard" | null | undefined;
+    membershipType?: "standard" | "private" | "shared" | "unknownFutureValue" | null | undefined;
     webUrl?: string | null | undefined;
 }>>;
 export declare const TEAMS_MEMBER_SCHEMA: z.ZodObject<{

package/dist/triggers.d.ts

@@ -4,6 +4,7 @@ import type { asanaTriggerContracts } from "./asana/index.js";
 import type { brevoTriggerContracts } from "./brevo/index.js";
 import type { convexTriggerContracts } from "./convex/index.js";
 import type { closeTriggerContracts } from "./close/index.js";
+import type { cloudflareTriggerContracts } from "./cloudflare/index.js";
 import type { githubTriggerContracts } from "./github/index.js";
 import type { gmailTriggerContracts } from "./gmail/index.js";
 import type { googleCalendarTriggerContracts } from "./google-calendar/index.js";
@@ -21,7 +22,7 @@ import type { vercelTriggerContracts } from "./vercel/index.js";
 import type { webflowTriggerContracts } from "./webflow/index.js";
 import type { whatsappTriggerContracts } from "./whatsapp/index.js";
 import type { z } from "zod";
-export type TriggerContractMap = typeof airtableTriggerContracts & typeof automateTriggerContracts & typeof asanaTriggerContracts & typeof brevoTriggerContracts & typeof convexTriggerContracts & typeof closeTriggerContracts & typeof githubTriggerContracts & typeof gmailTriggerContracts & typeof googleCalendarTriggerContracts & typeof googleFormsTriggerContracts & typeof googleMeetTriggerContracts & typeof linearTriggerContracts & typeof notionTriggerContracts & typeof outlookTriggerContracts & typeof resendTriggerContracts & typeof slackTriggerContracts & typeof stripeTriggerContracts & typeof teamsTriggerContracts & typeof trelloTriggerContracts & typeof vercelTriggerContracts & typeof webflowTriggerContracts & typeof whatsappTriggerContracts;
+export type TriggerContractMap = typeof airtableTriggerContracts & typeof automateTriggerContracts & typeof asanaTriggerContracts & typeof brevoTriggerContracts & typeof convexTriggerContracts & typeof closeTriggerContracts & typeof cloudflareTriggerContracts & typeof githubTriggerContracts & typeof gmailTriggerContracts & typeof googleCalendarTriggerContracts & typeof googleFormsTriggerContracts & typeof googleMeetTriggerContracts & typeof linearTriggerContracts & typeof notionTriggerContracts & typeof outlookTriggerContracts & typeof resendTriggerContracts & typeof slackTriggerContracts & typeof stripeTriggerContracts & typeof teamsTriggerContracts & typeof trelloTriggerContracts & typeof vercelTriggerContracts & typeof webflowTriggerContracts & typeof whatsappTriggerContracts;
 export type IntegrationTriggerType = keyof TriggerContractMap;
 /** Canonical authoring configuration for one integration trigger type. */
 export type TriggerConfig<TType extends IntegrationTriggerType> = z.input<TriggerContractMap[TType]["configSchema"]> extends Record<string, never> ? object : z.input<TriggerContractMap[TType]["configSchema"]>;

package/dist/whatsapp/index.d.ts

@@ -324,8 +324,8 @@ export declare const whatsappTriggerContracts: {
                 type: z.ZodEnum<{
                     unknown: "unknown";
                     text: "text";
-                    document: "document";
                     audio: "audio";
+                    document: "document";
                     image: "image";
                     video: "video";
                     location: "location";
@@ -419,8 +419,8 @@ export declare const whatsappTriggerContracts: {
                 type: z.ZodEnum<{
                     unknown: "unknown";
                     text: "text";
-                    document: "document";
                     audio: "audio";
+                    document: "document";
                     image: "image";
                     video: "video";
                     location: "location";

package/dist/whatsapp/schemas.d.ts

@@ -90,8 +90,8 @@ export declare const WHATSAPP_WEBHOOK_SCHEMA: z.ZodObject<{
                     type: z.ZodEnum<{
                         unknown: "unknown";
                         text: "text";
-                        document: "document";
                         audio: "audio";
+                        document: "document";
                         image: "image";
                         video: "video";
                         location: "location";
@@ -183,8 +183,8 @@ export declare const WHATSAPP_MESSAGE_RECEIVED_EVENT_SCHEMA: z.ZodObject<{
         type: z.ZodEnum<{
             unknown: "unknown";
             text: "text";
-            document: "document";
             audio: "audio";
+            document: "document";
             image: "image";
             video: "video";
             location: "location";
@@ -278,8 +278,8 @@ export declare const WHATSAPP_MESSAGE_RECEIVED_EVENT_SCHEMA: z.ZodObject<{
         type: z.ZodEnum<{
             unknown: "unknown";
             text: "text";
-            document: "document";
             audio: "audio";
+            document: "document";
             image: "image";
             video: "video";
             location: "location";
@@ -768,7 +768,7 @@ export declare function normalizeWhatsAppWebhook(input: unknown): {
         message: {
             id: string;
             timestamp: string;
-            type: "unknown" | "text" | "document" | "audio" | "image" | "video" | "location" | "system" | "order" | "reaction" | "button" | "contacts" | "interactive" | "sticker" | "unsupported";
+            type: "unknown" | "text" | "audio" | "document" | "image" | "video" | "location" | "system" | "order" | "reaction" | "button" | "contacts" | "interactive" | "sticker" | "unsupported";
             content?: z.core.util.JSONType | undefined;
             context?: {
                 messageId: string;
@@ -781,7 +781,7 @@ export declare function normalizeWhatsAppWebhook(input: unknown): {
             from: string;
             id: string;
             timestamp: string;
-            type: "unknown" | "text" | "document" | "audio" | "image" | "video" | "location" | "system" | "order" | "reaction" | "button" | "contacts" | "interactive" | "sticker" | "unsupported";
+            type: "unknown" | "text" | "audio" | "document" | "image" | "video" | "location" | "system" | "order" | "reaction" | "button" | "contacts" | "interactive" | "sticker" | "unsupported";
             audio?: {
                 id: string;
                 mime_type?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.104.0",
+  "version": "0.107.0",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -22,6 +22,7 @@
       "./automate": "./src/automate/index.ts",
       "./asana": "./src/asana/index.ts",
       "./brevo": "./src/brevo/index.ts",
+      "./cloudflare": "./src/cloudflare/index.ts",
       "./convex": "./src/convex/index.ts",
       "./close": "./src/close/index.ts",
       "./gmail": "./src/gmail/index.ts",
@@ -49,7 +50,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/codec": "0.104.0",
+    "@automate.ax/codec": "0.107.0",
     "@cfworker/json-schema": "^4.1.1",
     "@googleapis/calendar": "^15.0.0",
     "@googleapis/forms": "^6.0.1",
@@ -120,6 +121,11 @@
       "types": "./dist/brevo/index.d.ts",
       "default": "./dist/brevo/index.js"
     },
+    "./cloudflare": {
+      "bun": "./src/cloudflare/index.ts",
+      "types": "./dist/cloudflare/index.d.ts",
+      "default": "./dist/cloudflare/index.js"
+    },
     "./convex": {
       "bun": "./src/convex/index.ts",
       "types": "./dist/convex/index.d.ts",

package/src/cloudflare/api.ts

@@ -0,0 +1,340 @@
+import type { Encodable } from "@automate.ax/codec"
+import * as z from "zod"
+
+const CLOUDFLARE_API_BASE_URL = "https://api.cloudflare.com/client/v4/"
+const CLOUDFLARE_API_ORIGIN = new URL(CLOUDFLARE_API_BASE_URL).origin
+const CLOUDFLARE_API_TOKEN_SECRET_SCHEMA = z.object({
+  apiKey: z.string().min(1),
+})
+const CLOUDFLARE_OAUTH_SECRET_SCHEMA = z.object({
+  accessToken: z.string().min(1),
+})
+const CLOUDFLARE_RESPONSE_INFO_SCHEMA = z.looseObject({
+  code: z.number().optional(),
+  documentation_url: z.string().optional(),
+  message: z.string(),
+  source: z.object({ pointer: z.string().optional() }).optional(),
+})
+const CLOUDFLARE_ENVELOPE_SCHEMA = z.looseObject({
+  errors: CLOUDFLARE_RESPONSE_INFO_SCHEMA.array().default([]),
+  messages: CLOUDFLARE_RESPONSE_INFO_SCHEMA.array().default([]),
+  result: z.unknown().optional(),
+  result_info: z
+    .looseObject({
+      count: z.number().int().nonnegative().optional(),
+      page: z.number().int().positive().optional(),
+      per_page: z.number().int().positive().optional(),
+      total_count: z.number().int().nonnegative().optional(),
+      total_pages: z.number().int().nonnegative().optional(),
+    })
+    .optional(),
+  success: z.boolean(),
+})
+const CLOUDFLARE_RESULT_INFO_SCHEMA = z.looseObject({
+  count: z.number().int().nonnegative().optional(),
+  page: z.number().int().positive().optional(),
+  perPage: z.number().int().positive().optional(),
+  totalCount: z.number().int().nonnegative().optional(),
+  totalPages: z.number().int().nonnegative().optional(),
+})
+
+/** Scalar query value supported by the Cloudflare client. */
+type CloudflareQueryValue = boolean | number | string | undefined
+
+/** Resolved Cloudflare account accepted by the shared API client. */
+export interface CloudflareResolvedAccount {
+  connectionMethodId: string
+  secret: Record<string, unknown>
+  serviceId: "cloudflare"
+}
+
+/** Options for one authenticated Cloudflare REST request. */
+export interface CloudflareRequestOptions<TSchema extends z.ZodType> {
+  /** Public camelCase JSON body. */
+  body?: Encodable
+
+  /** HTTP verb. Defaults to `GET`. */
+  method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT"
+
+  /** Public camelCase query parameters. */
+  query?: Record<string, CloudflareQueryValue>
+
+  /** Schema for the normalized provider result. */
+  responseSchema: TSchema
+}
+
+/** One normalized Cloudflare result page. */
+export interface CloudflarePage<T> {
+  result: T
+  resultInfo?: {
+    count?: number
+    page?: number
+    perPage?: number
+    totalCount?: number
+    totalPages?: number
+  }
+}
+
+/** Structured Cloudflare REST error. */
+export class CloudflareApiError extends Error {
+  /** Provider error records. */
+  readonly errors: z.output<typeof CLOUDFLARE_RESPONSE_INFO_SCHEMA>[]
+
+  /** Parsed Cloudflare rate-limit header, when present. */
+  readonly rateLimit?: string
+
+  /** Parsed Cloudflare rate-limit policy header, when present. */
+  readonly rateLimitPolicy?: string
+
+  /** Retry delay in seconds, when Cloudflare returned one. */
+  readonly retryAfter?: number
+
+  /** HTTP status returned by Cloudflare. */
+  readonly status: number
+
+  /**
+   * Creates a structured error from one Cloudflare response.
+   *
+   * @param options - Response status, provider errors, and limit metadata.
+   * @param options.errors - Provider error records.
+   * @param options.rateLimit - Current rate-limit header.
+   * @param options.rateLimitPolicy - Current rate-limit policy header.
+   * @param options.retryAfter - Retry delay in seconds.
+   * @param options.status - HTTP response status.
+   */
+  constructor(options: {
+    errors?: z.output<typeof CLOUDFLARE_RESPONSE_INFO_SCHEMA>[]
+    rateLimit?: string
+    rateLimitPolicy?: string
+    retryAfter?: number
+    status: number
+  }) {
+    const errors = options.errors ?? []
+    super(
+      errors[0]?.message
+        ? `Cloudflare API error (${options.status}): ${errors[0].message}`
+        : `Cloudflare API request failed with status ${options.status}.`,
+    )
+    this.name = "CloudflareApiError"
+    this.errors = errors
+    this.rateLimit = options.rateLimit
+    this.rateLimitPolicy = options.rateLimitPolicy
+    this.retryAfter = options.retryAfter
+    this.status = options.status
+  }
+}
+
+/**
+ * Creates an authenticated Cloudflare REST client.
+ *
+ * @param account - Resolved OAuth or API-token account.
+ * @throws When the connection method or secret shape is unsupported.
+ */
+export function getCloudflareApi(account: CloudflareResolvedAccount) {
+  const accessToken =
+    account.connectionMethodId === "oauth"
+      ? CLOUDFLARE_OAUTH_SECRET_SCHEMA.parse(account.secret).accessToken
+      : account.connectionMethodId === "api-token"
+        ? CLOUDFLARE_API_TOKEN_SECRET_SCHEMA.parse(account.secret).apiKey
+        : undefined
+  if (!accessToken) {
+    throw new Error(
+      `Unsupported Cloudflare connection method: ${account.connectionMethodId}`,
+    )
+  }
+
+  /**
+   * Runs one request and returns its normalized result.
+   *
+   * @param path - Cloudflare API path relative to the v4 root.
+   * @param options - Method, parameters, and response schema.
+   */
+  async function request<TSchema extends z.ZodType>(
+    path: string,
+    options: CloudflareRequestOptions<TSchema>,
+  ): Promise<z.output<TSchema>> {
+    return (await requestPage(path, options)).result
+  }
+
+  /**
+   * Runs one request and preserves Cloudflare page metadata.
+   *
+   * @param path - Cloudflare API path relative to the v4 root.
+   * @param options - Method, parameters, and response schema.
+   */
+  async function requestPage<TSchema extends z.ZodType>(
+    path: string,
+    options: CloudflareRequestOptions<TSchema>,
+  ): Promise<CloudflarePage<z.output<TSchema>>> {
+    const url = new URL(path.replace(/^\//, ""), CLOUDFLARE_API_BASE_URL)
+    if (url.origin !== CLOUDFLARE_API_ORIGIN) {
+      throw new Error(
+        "Cloudflare API paths must use the Cloudflare API origin.",
+      )
+    }
+    for (const [name, value] of Object.entries(options.query ?? {})) {
+      if (value !== undefined)
+        url.searchParams.set(toSnakeCase(name), String(value))
+    }
+    const response = await fetch(url, {
+      body:
+        options.body === undefined
+          ? undefined
+          : JSON.stringify(toCloudflare(options.body)),
+      headers: {
+        Accept: "application/json",
+        Authorization: `Bearer ${accessToken}`,
+        ...(options.body === undefined
+          ? {}
+          : { "Content-Type": "application/json" }),
+      },
+      method: options.method ?? "GET",
+    })
+    const parsed = CLOUDFLARE_ENVELOPE_SCHEMA.safeParse(
+      parseJson(await response.text()),
+    )
+    if (!response.ok || !parsed.success || !parsed.data.success) {
+      throw new CloudflareApiError({
+        errors: parsed.success ? parsed.data.errors : undefined,
+        rateLimit: response.headers.get("Ratelimit") ?? undefined,
+        rateLimitPolicy: response.headers.get("Ratelimit-Policy") ?? undefined,
+        retryAfter: parseFiniteNumber(response.headers.get("Retry-After")),
+        status: response.status,
+      })
+    }
+    return {
+      result: options.responseSchema.parse(fromCloudflare(parsed.data.result)),
+      ...(parsed.data.result_info && {
+        resultInfo: CLOUDFLARE_RESULT_INFO_SCHEMA.parse(
+          fromCloudflare(parsed.data.result_info),
+        ),
+      }),
+    }
+  }
+
+  return { request, requestPage }
+}
+
+/**
+ * Converts public camelCase JSON to Cloudflare wire keys.
+ *
+ * @param value - Codec-safe public value.
+ */
+export function toCloudflare(value: Encodable): Encodable {
+  return convertToCloudflare(value, false)
+}
+
+/**
+ * Converts one value while optionally preserving object keys.
+ *
+ * @param value - Public value to convert.
+ * @param preserveKeys - Whether this object is a provider-defined map.
+ */
+function convertToCloudflare(
+  value: Encodable,
+  preserveKeys: boolean,
+): Encodable {
+  if (value instanceof Date) return value.toISOString()
+  if (Array.isArray(value))
+    return value.map((item) => convertToCloudflare(item, preserveKeys))
+  if (!isPlainObject(value)) return value
+  return Object.fromEntries(
+    Object.entries(value).map(([key, item]) => [
+      preserveKeys ? key : toSnakeCase(key),
+      convertToCloudflare(item, key === "header" || key === "headers"),
+    ]),
+  )
+}
+
+/**
+ * Converts Cloudflare wire JSON to public camelCase keys.
+ *
+ * @param value - Untrusted provider JSON value.
+ */
+export function fromCloudflare(value: unknown): Encodable {
+  return convertFromCloudflare(value, false)
+}
+
+/**
+ * Converts one provider value while optionally preserving object keys.
+ *
+ * @param value - Provider value to convert.
+ * @param preserveKeys - Whether this object is a provider-defined map.
+ */
+function convertFromCloudflare(
+  value: unknown,
+  preserveKeys: boolean,
+): Encodable {
+  if (Array.isArray(value))
+    return value.map((item) => convertFromCloudflare(item, preserveKeys))
+  if (!isPlainObject(value)) return CLOUDFLARE_VALUE_SCHEMA.parse(value)
+  return Object.fromEntries(
+    Object.entries(value).map(([key, item]) => [
+      preserveKeys ? key : toCamelCase(key),
+      convertFromCloudflare(item, key === "header" || key === "headers"),
+    ]),
+  )
+}
+
+const CLOUDFLARE_VALUE_SCHEMA = z.union([
+  z.boolean(),
+  z.number(),
+  z.string(),
+  z.null(),
+  z.undefined(),
+])
+
+/**
+ * Returns whether a value is a plain JSON object.
+ *
+ * @param value - Candidate value.
+ */
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
+/**
+ * Parses JSON without obscuring the eventual structured API error.
+ *
+ * @param value - Raw response text.
+ */
+function parseJson(value: string): unknown {
+  try {
+    return JSON.parse(value)
+  } catch {
+    return undefined
+  }
+}
+
+/**
+ * Parses a finite numeric response header.
+ *
+ * @param value - Header value.
+ */
+function parseFiniteNumber(value: string | null) {
+  if (value === null) return undefined
+  const number = Number(value)
+  return Number.isFinite(number) ? number : undefined
+}
+
+/**
+ * Converts one Cloudflare snake_case key to camelCase.
+ *
+ * @param value - Provider key.
+ */
+function toCamelCase(value: string) {
+  return value.replace(/_([a-z0-9])/g, (_match, character: string) =>
+    character.toUpperCase(),
+  )
+}
+
+/**
+ * Converts one public camelCase key to snake_case.
+ *
+ * @param value - Public key.
+ */
+function toSnakeCase(value: string) {
+  return value
+    .replace(/([a-zA-Z])([0-9])/g, "$1_$2")
+    .replace(/[A-Z]/g, (character) => `_${character.toLowerCase()}`)
+}