@automate.ax/integration-contracts 0.152.5 → 0.153.0

package/dist/close/events.d.ts

@@ -1687,8 +1687,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1751,8 +1751,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1795,8 +1795,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1839,8 +1839,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1883,8 +1883,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1927,8 +1927,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1971,8 +1971,8 @@ export declare const closeTriggerContracts: {
                 status: z.ZodOptional<z.ZodEnum<{
                     error: "error";
                     active: "active";
-                    paused: "paused";
                     finished: "finished";
+                    paused: "paused";
                     goal: "goal";
                 }>>;
                 statusReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;

package/dist/close/schemas.d.ts

@@ -1863,8 +1863,8 @@ export declare const CLOSE_SEQUENCE_SUBSCRIPTION_SCHEMA: z.ZodObject<{
     status: z.ZodEnum<{
         error: "error";
         active: "active";
-        paused: "paused";
         finished: "finished";
+        paused: "paused";
         goal: "goal";
     }>;
     statusReason: z.ZodNullable<z.ZodString>;

package/dist/cloudflare/api.d.ts

@@ -20,13 +20,30 @@ export interface CloudflareResolvedAccount {
 export interface CloudflareRequestOptions<TSchema extends z.ZodType> {
     /** Public camelCase JSON body. */
     body?: Encodable;
+    /** Provider request-key convention. Defaults to Cloudflare snake_case. */
+    keyFormat?: "browser-rendering";
     /** HTTP verb. Defaults to `GET`. */
     method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
     /** Public camelCase query parameters. */
     query?: Record<string, CloudflareQueryValue>;
+    /** Provider result-key convention. Defaults to recursive camelCase. */
+    responseKeyFormat?: "preserve";
     /** Schema for the normalized provider result. */
     responseSchema: TSchema;
 }
+/** Options for one authenticated Cloudflare binary REST request. */
+export interface CloudflareBlobRequestOptions {
+    /** Expected response media type. */
+    accept: string;
+    /** Public camelCase JSON body. */
+    body?: Encodable;
+    /** Provider request-key convention. Defaults to Cloudflare snake_case. */
+    keyFormat?: "browser-rendering";
+    /** HTTP verb. Defaults to `GET`. */
+    method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
+    /** Public camelCase query parameters. */
+    query?: Record<string, CloudflareQueryValue>;
+}
 /** One normalized Cloudflare result page. */
 export interface CloudflarePage<T> {
     result: T;
@@ -76,6 +93,7 @@ export declare class CloudflareApiError extends Error {
  */
 export declare function getCloudflareApi(account: CloudflareResolvedAccount): {
     request: <TSchema extends z.ZodType>(path: string, options: CloudflareRequestOptions<TSchema>) => Promise<z.output<TSchema>>;
+    requestBlob: (path: string, options: CloudflareBlobRequestOptions) => Promise<Blob>;
     requestPage: <TSchema extends z.ZodType>(path: string, options: CloudflareRequestOptions<TSchema>) => Promise<CloudflarePage<z.output<TSchema>>>;
 };
 /**
@@ -84,6 +102,12 @@ export declare function getCloudflareApi(account: CloudflareResolvedAccount): {
  * @param value - Codec-safe public value.
  */
 export declare function toCloudflare(value: Encodable): Encodable;
+/**
+ * Converts public JSON to Cloudflare Browser Run's mixed wire keys.
+ *
+ * @param value - Codec-safe public value.
+ */
+export declare function toCloudflareBrowserRendering(value: Encodable): Encodable;
 /**
  * Converts Cloudflare wire JSON to public camelCase keys.
  *

package/dist/cloudflare/api.js

@@ -101,20 +101,63 @@ export function getCloudflareApi(account) {
      * @param options - Method, parameters, and response schema.
      */
     async function requestPage(path, options) {
+        const response = await runRequest(path, options, "application/json");
+        const parsed = CLOUDFLARE_ENVELOPE_SCHEMA.safeParse(parseJson(await response.text()));
+        if (!response.ok || !parsed.success || !parsed.data.success) {
+            throw createApiError(response, parsed.success ? parsed.data.errors : []);
+        }
+        return {
+            result: options.responseSchema.parse(options.responseKeyFormat === "preserve"
+                ? convertFromCloudflare(parsed.data.result, true)
+                : fromCloudflare(parsed.data.result)),
+            ...(parsed.data.result_info && {
+                resultInfo: CLOUDFLARE_RESULT_INFO_SCHEMA.parse(fromCloudflare(parsed.data.result_info)),
+            }),
+        };
+    }
+    /**
+     * Runs one request and returns a binary response body.
+     *
+     * @param path - Cloudflare API path relative to the v4 root.
+     * @param options - Method, parameters, and expected media type.
+     */
+    async function requestBlob(path, options) {
+        const response = await runRequest(path, options, options.accept);
+        if (!response.ok ||
+            response.headers.get("Content-Type")?.includes("application/json")) {
+            const parsed = CLOUDFLARE_ENVELOPE_SCHEMA.safeParse(parseJson(await response.text()));
+            if (!response.ok || !parsed.success || !parsed.data.success)
+                throw createApiError(response, parsed.success ? parsed.data.errors : []);
+            throw new Error("Cloudflare returned JSON instead of binary content.");
+        }
+        return response.blob();
+    }
+    /**
+     * Runs one authenticated Cloudflare request.
+     *
+     * @param path - Cloudflare API path relative to the v4 root.
+     * @param options - Method, body, and query parameters.
+     * @param accept - Expected response media type.
+     */
+    async function runRequest(path, options, accept) {
         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));
+                url.searchParams.set(options.keyFormat === "browser-rendering"
+                    ? toBrowserRenderingQueryKey(name)
+                    : toSnakeCase(name), String(value));
         }
-        const response = await fetch(url, {
+        return fetch(url, {
             body: options.body === undefined
                 ? undefined
-                : JSON.stringify(toCloudflare(options.body)),
+                : JSON.stringify(options.keyFormat === "browser-rendering"
+                    ? toCloudflareBrowserRendering(options.body)
+                    : toCloudflare(options.body)),
             headers: {
-                Accept: "application/json",
+                Accept: accept,
                 Authorization: `Bearer ${accessToken}`,
                 ...(options.body === undefined
                     ? {}
@@ -122,24 +165,23 @@ export function getCloudflareApi(account) {
             },
             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 };
+    return { request, requestBlob, requestPage };
+}
+/**
+ * Creates a structured error from one Cloudflare response.
+ *
+ * @param response - Failed Cloudflare response.
+ * @param errors - Parsed provider errors.
+ */
+function createApiError(response, errors) {
+    return new CloudflareApiError({
+        errors,
+        rateLimit: response.headers.get("Ratelimit") ?? undefined,
+        rateLimitPolicy: response.headers.get("Ratelimit-Policy") ?? undefined,
+        retryAfter: parseFiniteNumber(response.headers.get("Retry-After")),
+        status: response.status,
+    });
 }
 /**
  * Converts public camelCase JSON to Cloudflare wire keys.
@@ -149,6 +191,32 @@ export function getCloudflareApi(account) {
 export function toCloudflare(value) {
     return convertToCloudflare(value, false);
 }
+/**
+ * Converts public JSON to Cloudflare Browser Run's mixed wire keys.
+ *
+ * @param value - Codec-safe public value.
+ */
+export function toCloudflareBrowserRendering(value) {
+    return convertToCloudflareBrowserRendering(value, false);
+}
+/**
+ * Converts one Browser Run value while optionally preserving arbitrary keys.
+ *
+ * @param value - Public value to convert.
+ * @param preserveKeys - Whether this object is a user-defined map.
+ */
+function convertToCloudflareBrowserRendering(value, preserveKeys) {
+    if (value instanceof Date)
+        return value.toISOString();
+    if (Array.isArray(value))
+        return value.map((item) => convertToCloudflareBrowserRendering(item, preserveKeys));
+    if (!isPlainObject(value))
+        return value;
+    return Object.fromEntries(Object.entries(value).map(([key, item]) => [
+        preserveKeys ? key : toBrowserRenderingKey(key),
+        convertToCloudflareBrowserRendering(item, preserveKeys || key === "jsonSchema" || key === "setExtraHttpHeaders"),
+    ]));
+}
 /**
  * Converts one value while optionally preserving object keys.
  *
@@ -164,7 +232,7 @@ function convertToCloudflare(value, preserveKeys) {
         return value;
     return Object.fromEntries(Object.entries(value).map(([key, item]) => [
         preserveKeys ? key : toSnakeCase(key),
-        convertToCloudflare(item, key === "header" || key === "headers"),
+        convertToCloudflare(item, preserveKeys || preservesNestedKeys(key)),
     ]));
 }
 /**
@@ -188,9 +256,25 @@ function convertFromCloudflare(value, preserveKeys) {
         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"),
+        convertFromCloudflare(item, preserveKeys || preservesNestedKeys(key)),
     ]));
 }
+/**
+ * Returns whether a provider-defined object map must retain its keys.
+ *
+ * @param key - Public or provider parent key.
+ */
+function preservesNestedKeys(key) {
+    return [
+        "header",
+        "headers",
+        "json",
+        "jsonSchema",
+        "json_schema",
+        "setExtraHttpHeaders",
+        "set_extra_http_headers",
+    ].includes(key);
+}
 const CLOUDFLARE_VALUE_SCHEMA = z.union([
     z.boolean(),
     z.number(),
@@ -248,3 +332,27 @@ function toSnakeCase(value) {
         .replace(/([a-zA-Z])([0-9])/g, "$1_$2")
         .replace(/[A-Z]/g, (character) => `_${character.toLowerCase()}`);
 }
+/**
+ * Converts a public query key to Cloudflare's endpoint spelling.
+ *
+ * @param value - Public query key.
+ */
+function toBrowserRenderingQueryKey(value) {
+    return value === "cacheTtl" ? "cacheTTL" : toSnakeCase(value);
+}
+/**
+ * Converts one public Browser Run body key to its exact provider spelling.
+ *
+ * @param value - Public key.
+ */
+function toBrowserRenderingKey(value) {
+    if (value === "customAi")
+        return "custom_ai";
+    if (value === "jsonSchema")
+        return "json_schema";
+    if (value === "responseFormat")
+        return "response_format";
+    if (value === "setExtraHttpHeaders")
+        return "setExtraHTTPHeaders";
+    return value;
+}