@authhero/cloudflare-adapter 2.29.1 → 2.30.0

package/dist/cloudflare-adapter.d.ts

@@ -2,6 +2,262 @@
 
 import { z } from '@hono/zod-openapi';
 
+declare const actionExecutionSchema: z.ZodObject<{
+	id: z.ZodString;
+	tenant_id: z.ZodString;
+	trigger_id: z.ZodString;
+	status: z.ZodEnum<[
+		"unspecified",
+		"pending",
+		"final",
+		"partial",
+		"canceled",
+		"suspended"
+	]>;
+	results: z.ZodArray<z.ZodObject<{
+		action_name: z.ZodString;
+		error: z.ZodNullable<z.ZodObject<{
+			id: z.ZodString;
+			msg: z.ZodString;
+			url: z.ZodOptional<z.ZodString>;
+		}, "strip", z.ZodTypeAny, {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		}, {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		}>>;
+		started_at: z.ZodString;
+		ended_at: z.ZodString;
+	}, "strip", z.ZodTypeAny, {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}, {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}>, "many">;
+	logs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+		action_name: z.ZodString;
+		lines: z.ZodArray<z.ZodObject<{
+			level: z.ZodEnum<[
+				"log",
+				"info",
+				"warn",
+				"error",
+				"debug"
+			]>;
+			message: z.ZodString;
+		}, "strip", z.ZodTypeAny, {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}, {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}>, "many">;
+	}, "strip", z.ZodTypeAny, {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}, {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}>, "many">>;
+	created_at: z.ZodString;
+	updated_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+	created_at: string;
+	updated_at: string;
+	status: "unspecified" | "pending" | "final" | "partial" | "canceled" | "suspended";
+	id: string;
+	tenant_id: string;
+	trigger_id: string;
+	results: {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}[];
+	logs?: {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}[] | undefined;
+}, {
+	created_at: string;
+	updated_at: string;
+	status: "unspecified" | "pending" | "final" | "partial" | "canceled" | "suspended";
+	id: string;
+	tenant_id: string;
+	trigger_id: string;
+	results: {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}[];
+	logs?: {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}[] | undefined;
+}>;
+export type ActionExecution = z.infer<typeof actionExecutionSchema>;
+declare const actionExecutionInsertSchema: z.ZodObject<Omit<{
+	id: z.ZodString;
+	tenant_id: z.ZodString;
+	trigger_id: z.ZodString;
+	status: z.ZodEnum<[
+		"unspecified",
+		"pending",
+		"final",
+		"partial",
+		"canceled",
+		"suspended"
+	]>;
+	results: z.ZodArray<z.ZodObject<{
+		action_name: z.ZodString;
+		error: z.ZodNullable<z.ZodObject<{
+			id: z.ZodString;
+			msg: z.ZodString;
+			url: z.ZodOptional<z.ZodString>;
+		}, "strip", z.ZodTypeAny, {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		}, {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		}>>;
+		started_at: z.ZodString;
+		ended_at: z.ZodString;
+	}, "strip", z.ZodTypeAny, {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}, {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}>, "many">;
+	logs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+		action_name: z.ZodString;
+		lines: z.ZodArray<z.ZodObject<{
+			level: z.ZodEnum<[
+				"log",
+				"info",
+				"warn",
+				"error",
+				"debug"
+			]>;
+			message: z.ZodString;
+		}, "strip", z.ZodTypeAny, {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}, {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}>, "many">;
+	}, "strip", z.ZodTypeAny, {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}, {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}>, "many">>;
+	created_at: z.ZodString;
+	updated_at: z.ZodString;
+}, "created_at" | "updated_at" | "tenant_id">, "strip", z.ZodTypeAny, {
+	status: "unspecified" | "pending" | "final" | "partial" | "canceled" | "suspended";
+	id: string;
+	trigger_id: string;
+	results: {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}[];
+	logs?: {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}[] | undefined;
+}, {
+	status: "unspecified" | "pending" | "final" | "partial" | "canceled" | "suspended";
+	id: string;
+	trigger_id: string;
+	results: {
+		action_name: string;
+		error: {
+			id: string;
+			msg: string;
+			url?: string | undefined;
+		} | null;
+		started_at: string;
+		ended_at: string;
+	}[];
+	logs?: {
+		action_name: string;
+		lines: {
+			message: string;
+			level: "error" | "log" | "info" | "warn" | "debug";
+		}[];
+	}[] | undefined;
+}>;
+export type ActionExecutionInsert = z.infer<typeof actionExecutionInsertSchema>;
 export interface Totals {
 	start: number;
 	limit: number;
@@ -675,6 +931,10 @@ export interface AnalyticsQueryResponse {
 		bytes_read?: number;
 	};
 }
+export interface ActionExecutionsAdapter {
+	create: (tenant_id: string, execution: ActionExecutionInsert) => Promise<ActionExecution>;
+	get: (tenant_id: string, execution_id: string) => Promise<ActionExecution | null>;
+}
 export interface CacheAdapter {
 	/**
 	 * Get a value from the cache
@@ -1033,6 +1293,60 @@ export declare function createAnalyticsEngineAnalyticsAdapter(config: AnalyticsE
  * ```
  */
 export declare function createAnalyticsEngineLogsAdapter(config: AnalyticsEngineLogsAdapterConfig): LogsDataAdapter;
+export interface AnalyticsEngineActionExecutionsAdapterConfig {
+	/**
+	 * Cloudflare Analytics Engine dataset binding (for Workers).
+	 * Pass the Analytics Engine dataset object from env (e.g.
+	 * env.AUTH_ACTION_EXECUTIONS).
+	 */
+	analyticsEngineBinding?: AnalyticsEngineDataset;
+	/**
+	 * Cloudflare account ID for querying via the SQL API.
+	 * Can be passed via environment variable: CLOUDFLARE_ACCOUNT_ID.
+	 */
+	accountId: string;
+	/**
+	 * Cloudflare API token for querying via the SQL API.
+	 * Must have Analytics Engine SQL API permissions.
+	 * Can be passed via environment variable: ANALYTICS_ENGINE_API_TOKEN.
+	 */
+	apiToken: string;
+	/**
+	 * Analytics Engine dataset name (default: "authhero_action_executions").
+	 * Should match the dataset name configured in wrangler.toml.
+	 */
+	dataset?: string;
+	/**
+	 * HTTP timeout in milliseconds for SQL API queries (default: 30000).
+	 */
+	timeout?: number;
+}
+/**
+ * Create an Analytics Engine action_executions adapter.
+ *
+ * Persists Auth0-shaped action execution records (one row per execution) into
+ * a Cloudflare Analytics Engine dataset and reads them back via the AE SQL
+ * API. Pair with `createAnalyticsEngineLogsAdapter` so logs and the
+ * executions they reference live in the same place.
+ *
+ * @example
+ * ```typescript
+ * // wrangler.toml:
+ * // [[analytics_engine_datasets]]
+ * // binding = "AUTH_ACTION_EXECUTIONS"
+ * // dataset = "authhero_action_executions"
+ *
+ * import { createAnalyticsEngineActionExecutionsAdapter } from "@authhero/cloudflare-adapter";
+ *
+ * const adapter = createAnalyticsEngineActionExecutionsAdapter({
+ *   analyticsEngineBinding: env.AUTH_ACTION_EXECUTIONS,
+ *   accountId: env.CLOUDFLARE_ACCOUNT_ID,
+ *   apiToken: env.ANALYTICS_ENGINE_API_TOKEN,
+ *   dataset: "authhero_action_executions",
+ * });
+ * ```
+ */
+export declare function createAnalyticsEngineActionExecutionsAdapter(config: AnalyticsEngineActionExecutionsAdapterConfig): ActionExecutionsAdapter;
 /**
  * Minimal shape of the Cloudflare Workers Rate Limiter binding. We declare
  * it locally rather than depending on `@cloudflare/workers-types` so the
@@ -1090,6 +1404,12 @@ export interface CloudflareConfig {
 	 * Use this for low-latency log writes with Cloudflare Analytics Engine
 	 */
 	analyticsEngineLogs?: AnalyticsEngineLogsAdapterConfig;
+	/**
+	 * Analytics Engine action_executions adapter configuration (optional).
+	 * Stores Auth0-shaped action execution records in a dedicated AE dataset
+	 * so logs and the executions they reference can both live in AE.
+	 */
+	analyticsEngineActionExecutions?: AnalyticsEngineActionExecutionsAdapterConfig;
 	/**
 	 * Cloudflare Workers Rate Limiter bindings, keyed by logical scope.
 	 * Each binding's `limit` and `period` are baked in at deploy time; this
@@ -1275,6 +1595,7 @@ export interface CloudflareAdapters {
 	analytics?: AnalyticsAdapter;
 	geo?: GeoAdapter;
 	rateLimit?: RateLimitAdapter;
+	actionExecutions?: ActionExecutionsAdapter;
 }
 declare function createAdapters(config: CloudflareConfig): CloudflareAdapters;