@authhero/cloudflare-adapter 2.7.5 → 2.8.0

package/dist/cloudflare-adapter.d.ts

@@ -2,6 +2,11 @@
 
 import { z } from '@hono/zod-openapi';
 
+export interface Totals {
+	start: number;
+	limit: number;
+	length: number;
+}
 declare const customDomainInsertSchema: z.ZodObject<{
 	domain: z.ZodString;
 	custom_domain_id: z.ZodOptional<z.ZodString>;
@@ -229,6 +234,214 @@ declare const customDomainWithTenantIdSchema: z.ZodObject<{
 	} | undefined;
 }>;
 export type CustomDomainWithTenantId = z.infer<typeof customDomainWithTenantIdSchema>;
+export interface ListParams {
+	page?: number;
+	per_page?: number;
+	include_totals?: boolean;
+	q?: string;
+	sort?: {
+		sort_by: string;
+		sort_order: "asc" | "desc";
+	};
+}
+declare const logInsertSchema: z.ZodObject<{
+	type: z.ZodEffects<z.ZodString, "acls_summary" | "actions_execution_failed" | "api_limit" | "api_limit_warning" | "appi" | "ciba_exchange_failed" | "ciba_exchange_succeeded" | "ciba_start_failed" | "ciba_start_succeeded" | "cls" | "cs" | "depnote" | "f" | "fc" | "fce" | "fco" | "fcoa" | "fcp" | "fcph" | "fcpn" | "fcpr" | "fcpro" | "fcu" | "fd" | "fdeac" | "fdeaz" | "fdecc" | "fdu" | "feacft" | "feccft" | "fecte" | "fede" | "federated_logout_failed" | "fens" | "feoobft" | "feotpft" | "fepft" | "fepotpft" | "fercft" | "ferrt" | "fertft" | "fh" | "fi" | "flo" | "flows_execution_completed" | "flows_execution_failed" | "fn" | "forms_submission_failed" | "forms_submission_succeeded" | "fp" | "fpar" | "fpurh" | "fs" | "fsa" | "fu" | "fui" | "fv" | "fvr" | "gd_auth_email_verification" | "gd_auth_fail_email_verification" | "gd_auth_failed" | "gd_auth_rejected" | "gd_auth_succeed" | "gd_enrollment_complete" | "gd_otp_rate_limit_exceed" | "gd_recovery_failed" | "gd_recovery_rate_limit_exceed" | "gd_recovery_succeed" | "gd_send_email" | "gd_send_email_verification" | "gd_send_email_verification_failure" | "gd_send_pn" | "gd_send_pn_failure" | "gd_send_sms" | "gd_send_sms_failure" | "gd_send_voice" | "gd_send_voice_failure" | "gd_start_auth" | "gd_start_enroll" | "gd_start_enroll_failed" | "gd_tenant_update" | "gd_unenroll" | "gd_update_device_account" | "gd_webauthn_challenge_failed" | "gd_webauthn_enrollment_failed" | "kms_key_management_failure" | "kms_key_management_success" | "kms_key_state_changed" | "limit_delegation" | "limit_mu" | "limit_sul" | "limit_wc" | "mfar" | "mgmt_api_read" | "my_account_authentication_method_failed" | "my_account_authentication_method_succeeded" | "oidc_backchannel_logout_failed" | "oidc_backchannel_logout_succeeded" | "organization_member_added" | "passkey_challenge_failed" | "passkey_challenge_started" | "pla" | "pwd_leak" | "reset_pwd_leak" | "resource_cleanup" | "rich_consents_access_error" | "s" | "sapi" | "sce" | "scoa" | "scp" | "scpn" | "scpr" | "scu" | "scv" | "sd" | "sdu" | "seacft" | "seccft" | "secte" | "sede" | "sens" | "seoobft" | "seotpft" | "sepft" | "sepkoobft" | "sepkotpft" | "sepkrcft" | "sercft" | "sertft" | "si" | "signup_pwd_leak" | "slo" | "srrt" | "ss" | "ss_sso_failure" | "ss_sso_info" | "ss_sso_success" | "ssa" | "sscim" | "sui" | "sv" | "svr" | "too_many_records" | "ublkdu" | "universal_logout_failed" | "universal_logout_succeeded" | "w" | "wn" | "wum", string>;
+	date: z.ZodString;
+	description: z.ZodOptional<z.ZodString>;
+	ip: z.ZodOptional<z.ZodString>;
+	user_agent: z.ZodString;
+	details: z.ZodOptional<z.ZodAny>;
+	isMobile: z.ZodBoolean;
+	user_id: z.ZodOptional<z.ZodString>;
+	user_name: z.ZodOptional<z.ZodString>;
+	connection: z.ZodOptional<z.ZodString>;
+	connection_id: z.ZodOptional<z.ZodString>;
+	client_id: z.ZodOptional<z.ZodString>;
+	client_name: z.ZodOptional<z.ZodString>;
+	audience: z.ZodOptional<z.ZodString>;
+	scope: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+	strategy: z.ZodOptional<z.ZodString>;
+	strategy_type: z.ZodOptional<z.ZodString>;
+	hostname: z.ZodOptional<z.ZodString>;
+	auth0_client: z.ZodOptional<z.ZodObject<{
+		name: z.ZodString;
+		version: z.ZodString;
+		env: z.ZodOptional<z.ZodObject<{
+			node: z.ZodOptional<z.ZodString>;
+		}, "strip", z.ZodTypeAny, {
+			node?: string | undefined;
+		}, {
+			node?: string | undefined;
+		}>>;
+	}, "strip", z.ZodTypeAny, {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	}, {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	}>>;
+	log_id: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+	type: "acls_summary" | "actions_execution_failed" | "api_limit" | "api_limit_warning" | "appi" | "ciba_exchange_failed" | "ciba_exchange_succeeded" | "ciba_start_failed" | "ciba_start_succeeded" | "cls" | "cs" | "depnote" | "f" | "fc" | "fce" | "fco" | "fcoa" | "fcp" | "fcph" | "fcpn" | "fcpr" | "fcpro" | "fcu" | "fd" | "fdeac" | "fdeaz" | "fdecc" | "fdu" | "feacft" | "feccft" | "fecte" | "fede" | "federated_logout_failed" | "fens" | "feoobft" | "feotpft" | "fepft" | "fepotpft" | "fercft" | "ferrt" | "fertft" | "fh" | "fi" | "flo" | "flows_execution_completed" | "flows_execution_failed" | "fn" | "forms_submission_failed" | "forms_submission_succeeded" | "fp" | "fpar" | "fpurh" | "fs" | "fsa" | "fu" | "fui" | "fv" | "fvr" | "gd_auth_email_verification" | "gd_auth_fail_email_verification" | "gd_auth_failed" | "gd_auth_rejected" | "gd_auth_succeed" | "gd_enrollment_complete" | "gd_otp_rate_limit_exceed" | "gd_recovery_failed" | "gd_recovery_rate_limit_exceed" | "gd_recovery_succeed" | "gd_send_email" | "gd_send_email_verification" | "gd_send_email_verification_failure" | "gd_send_pn" | "gd_send_pn_failure" | "gd_send_sms" | "gd_send_sms_failure" | "gd_send_voice" | "gd_send_voice_failure" | "gd_start_auth" | "gd_start_enroll" | "gd_start_enroll_failed" | "gd_tenant_update" | "gd_unenroll" | "gd_update_device_account" | "gd_webauthn_challenge_failed" | "gd_webauthn_enrollment_failed" | "kms_key_management_failure" | "kms_key_management_success" | "kms_key_state_changed" | "limit_delegation" | "limit_mu" | "limit_sul" | "limit_wc" | "mfar" | "mgmt_api_read" | "my_account_authentication_method_failed" | "my_account_authentication_method_succeeded" | "oidc_backchannel_logout_failed" | "oidc_backchannel_logout_succeeded" | "organization_member_added" | "passkey_challenge_failed" | "passkey_challenge_started" | "pla" | "pwd_leak" | "reset_pwd_leak" | "resource_cleanup" | "rich_consents_access_error" | "s" | "sapi" | "sce" | "scoa" | "scp" | "scpn" | "scpr" | "scu" | "scv" | "sd" | "sdu" | "seacft" | "seccft" | "secte" | "sede" | "sens" | "seoobft" | "seotpft" | "sepft" | "sepkoobft" | "sepkotpft" | "sepkrcft" | "sercft" | "sertft" | "si" | "signup_pwd_leak" | "slo" | "srrt" | "ss" | "ss_sso_failure" | "ss_sso_info" | "ss_sso_success" | "ssa" | "sscim" | "sui" | "sv" | "svr" | "too_many_records" | "ublkdu" | "universal_logout_failed" | "universal_logout_succeeded" | "w" | "wn" | "wum";
+	date: string;
+	user_agent: string;
+	isMobile: boolean;
+	description?: string | undefined;
+	connection?: string | undefined;
+	user_id?: string | undefined;
+	client_id?: string | undefined;
+	audience?: string | undefined;
+	scope?: string[] | undefined;
+	strategy?: string | undefined;
+	connection_id?: string | undefined;
+	ip?: string | undefined;
+	details?: any;
+	user_name?: string | undefined;
+	client_name?: string | undefined;
+	strategy_type?: string | undefined;
+	hostname?: string | undefined;
+	auth0_client?: {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	} | undefined;
+	log_id?: string | undefined;
+}, {
+	type: string;
+	date: string;
+	user_agent: string;
+	isMobile: boolean;
+	description?: string | undefined;
+	connection?: string | undefined;
+	user_id?: string | undefined;
+	client_id?: string | undefined;
+	audience?: string | undefined;
+	scope?: string[] | undefined;
+	strategy?: string | undefined;
+	connection_id?: string | undefined;
+	ip?: string | undefined;
+	details?: any;
+	user_name?: string | undefined;
+	client_name?: string | undefined;
+	strategy_type?: string | undefined;
+	hostname?: string | undefined;
+	auth0_client?: {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	} | undefined;
+	log_id?: string | undefined;
+}>;
+export type LogInsert = z.infer<typeof logInsertSchema>;
+declare const logSchema: z.ZodObject<{
+	log_id: z.ZodString;
+	type: z.ZodEffects<z.ZodString, "acls_summary" | "actions_execution_failed" | "api_limit" | "api_limit_warning" | "appi" | "ciba_exchange_failed" | "ciba_exchange_succeeded" | "ciba_start_failed" | "ciba_start_succeeded" | "cls" | "cs" | "depnote" | "f" | "fc" | "fce" | "fco" | "fcoa" | "fcp" | "fcph" | "fcpn" | "fcpr" | "fcpro" | "fcu" | "fd" | "fdeac" | "fdeaz" | "fdecc" | "fdu" | "feacft" | "feccft" | "fecte" | "fede" | "federated_logout_failed" | "fens" | "feoobft" | "feotpft" | "fepft" | "fepotpft" | "fercft" | "ferrt" | "fertft" | "fh" | "fi" | "flo" | "flows_execution_completed" | "flows_execution_failed" | "fn" | "forms_submission_failed" | "forms_submission_succeeded" | "fp" | "fpar" | "fpurh" | "fs" | "fsa" | "fu" | "fui" | "fv" | "fvr" | "gd_auth_email_verification" | "gd_auth_fail_email_verification" | "gd_auth_failed" | "gd_auth_rejected" | "gd_auth_succeed" | "gd_enrollment_complete" | "gd_otp_rate_limit_exceed" | "gd_recovery_failed" | "gd_recovery_rate_limit_exceed" | "gd_recovery_succeed" | "gd_send_email" | "gd_send_email_verification" | "gd_send_email_verification_failure" | "gd_send_pn" | "gd_send_pn_failure" | "gd_send_sms" | "gd_send_sms_failure" | "gd_send_voice" | "gd_send_voice_failure" | "gd_start_auth" | "gd_start_enroll" | "gd_start_enroll_failed" | "gd_tenant_update" | "gd_unenroll" | "gd_update_device_account" | "gd_webauthn_challenge_failed" | "gd_webauthn_enrollment_failed" | "kms_key_management_failure" | "kms_key_management_success" | "kms_key_state_changed" | "limit_delegation" | "limit_mu" | "limit_sul" | "limit_wc" | "mfar" | "mgmt_api_read" | "my_account_authentication_method_failed" | "my_account_authentication_method_succeeded" | "oidc_backchannel_logout_failed" | "oidc_backchannel_logout_succeeded" | "organization_member_added" | "passkey_challenge_failed" | "passkey_challenge_started" | "pla" | "pwd_leak" | "reset_pwd_leak" | "resource_cleanup" | "rich_consents_access_error" | "s" | "sapi" | "sce" | "scoa" | "scp" | "scpn" | "scpr" | "scu" | "scv" | "sd" | "sdu" | "seacft" | "seccft" | "secte" | "sede" | "sens" | "seoobft" | "seotpft" | "sepft" | "sepkoobft" | "sepkotpft" | "sepkrcft" | "sercft" | "sertft" | "si" | "signup_pwd_leak" | "slo" | "srrt" | "ss" | "ss_sso_failure" | "ss_sso_info" | "ss_sso_success" | "ssa" | "sscim" | "sui" | "sv" | "svr" | "too_many_records" | "ublkdu" | "universal_logout_failed" | "universal_logout_succeeded" | "w" | "wn" | "wum", string>;
+	date: z.ZodString;
+	description: z.ZodOptional<z.ZodString>;
+	ip: z.ZodOptional<z.ZodString>;
+	user_agent: z.ZodString;
+	details: z.ZodOptional<z.ZodAny>;
+	isMobile: z.ZodBoolean;
+	user_id: z.ZodOptional<z.ZodString>;
+	user_name: z.ZodOptional<z.ZodString>;
+	connection: z.ZodOptional<z.ZodString>;
+	connection_id: z.ZodOptional<z.ZodString>;
+	client_id: z.ZodOptional<z.ZodString>;
+	client_name: z.ZodOptional<z.ZodString>;
+	audience: z.ZodOptional<z.ZodString>;
+	scope: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+	strategy: z.ZodOptional<z.ZodString>;
+	strategy_type: z.ZodOptional<z.ZodString>;
+	hostname: z.ZodOptional<z.ZodString>;
+	auth0_client: z.ZodOptional<z.ZodObject<{
+		name: z.ZodString;
+		version: z.ZodString;
+		env: z.ZodOptional<z.ZodObject<{
+			node: z.ZodOptional<z.ZodString>;
+		}, "strip", z.ZodTypeAny, {
+			node?: string | undefined;
+		}, {
+			node?: string | undefined;
+		}>>;
+	}, "strip", z.ZodTypeAny, {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	}, {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	}>>;
+}, "strip", z.ZodTypeAny, {
+	type: "acls_summary" | "actions_execution_failed" | "api_limit" | "api_limit_warning" | "appi" | "ciba_exchange_failed" | "ciba_exchange_succeeded" | "ciba_start_failed" | "ciba_start_succeeded" | "cls" | "cs" | "depnote" | "f" | "fc" | "fce" | "fco" | "fcoa" | "fcp" | "fcph" | "fcpn" | "fcpr" | "fcpro" | "fcu" | "fd" | "fdeac" | "fdeaz" | "fdecc" | "fdu" | "feacft" | "feccft" | "fecte" | "fede" | "federated_logout_failed" | "fens" | "feoobft" | "feotpft" | "fepft" | "fepotpft" | "fercft" | "ferrt" | "fertft" | "fh" | "fi" | "flo" | "flows_execution_completed" | "flows_execution_failed" | "fn" | "forms_submission_failed" | "forms_submission_succeeded" | "fp" | "fpar" | "fpurh" | "fs" | "fsa" | "fu" | "fui" | "fv" | "fvr" | "gd_auth_email_verification" | "gd_auth_fail_email_verification" | "gd_auth_failed" | "gd_auth_rejected" | "gd_auth_succeed" | "gd_enrollment_complete" | "gd_otp_rate_limit_exceed" | "gd_recovery_failed" | "gd_recovery_rate_limit_exceed" | "gd_recovery_succeed" | "gd_send_email" | "gd_send_email_verification" | "gd_send_email_verification_failure" | "gd_send_pn" | "gd_send_pn_failure" | "gd_send_sms" | "gd_send_sms_failure" | "gd_send_voice" | "gd_send_voice_failure" | "gd_start_auth" | "gd_start_enroll" | "gd_start_enroll_failed" | "gd_tenant_update" | "gd_unenroll" | "gd_update_device_account" | "gd_webauthn_challenge_failed" | "gd_webauthn_enrollment_failed" | "kms_key_management_failure" | "kms_key_management_success" | "kms_key_state_changed" | "limit_delegation" | "limit_mu" | "limit_sul" | "limit_wc" | "mfar" | "mgmt_api_read" | "my_account_authentication_method_failed" | "my_account_authentication_method_succeeded" | "oidc_backchannel_logout_failed" | "oidc_backchannel_logout_succeeded" | "organization_member_added" | "passkey_challenge_failed" | "passkey_challenge_started" | "pla" | "pwd_leak" | "reset_pwd_leak" | "resource_cleanup" | "rich_consents_access_error" | "s" | "sapi" | "sce" | "scoa" | "scp" | "scpn" | "scpr" | "scu" | "scv" | "sd" | "sdu" | "seacft" | "seccft" | "secte" | "sede" | "sens" | "seoobft" | "seotpft" | "sepft" | "sepkoobft" | "sepkotpft" | "sepkrcft" | "sercft" | "sertft" | "si" | "signup_pwd_leak" | "slo" | "srrt" | "ss" | "ss_sso_failure" | "ss_sso_info" | "ss_sso_success" | "ssa" | "sscim" | "sui" | "sv" | "svr" | "too_many_records" | "ublkdu" | "universal_logout_failed" | "universal_logout_succeeded" | "w" | "wn" | "wum";
+	date: string;
+	user_agent: string;
+	isMobile: boolean;
+	log_id: string;
+	description?: string | undefined;
+	connection?: string | undefined;
+	user_id?: string | undefined;
+	client_id?: string | undefined;
+	audience?: string | undefined;
+	scope?: string[] | undefined;
+	strategy?: string | undefined;
+	connection_id?: string | undefined;
+	ip?: string | undefined;
+	details?: any;
+	user_name?: string | undefined;
+	client_name?: string | undefined;
+	strategy_type?: string | undefined;
+	hostname?: string | undefined;
+	auth0_client?: {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	} | undefined;
+}, {
+	type: string;
+	date: string;
+	user_agent: string;
+	isMobile: boolean;
+	log_id: string;
+	description?: string | undefined;
+	connection?: string | undefined;
+	user_id?: string | undefined;
+	client_id?: string | undefined;
+	audience?: string | undefined;
+	scope?: string[] | undefined;
+	strategy?: string | undefined;
+	connection_id?: string | undefined;
+	ip?: string | undefined;
+	details?: any;
+	user_name?: string | undefined;
+	client_name?: string | undefined;
+	strategy_type?: string | undefined;
+	hostname?: string | undefined;
+	auth0_client?: {
+		name: string;
+		version: string;
+		env?: {
+			node?: string | undefined;
+		} | undefined;
+	} | undefined;
+}>;
+export type Log = z.infer<typeof logSchema>;
 export interface CacheAdapter {
 	/**
 	 * Get a value from the cache
@@ -254,6 +467,14 @@ export interface CacheAdapter {
 	 */
 	clear(): Promise<void>;
 }
+export interface ListLogsResponse extends Totals {
+	logs: Log[];
+}
+export interface LogsDataAdapter {
+	create(tenantId: string, params: LogInsert): Promise<Log>;
+	list(tenantId: string, params?: ListParams): Promise<ListLogsResponse>;
+	get(tenantId: string, logId: string): Promise<Log | null>;
+}
 export interface CustomDomainsAdapter {
 	create: (tenant_id: string, custom_domain: CustomDomainInsert) => Promise<CustomDomain>;
 	get: (tenant_id: string, id: string) => Promise<CustomDomain | null>;
@@ -262,6 +483,59 @@ export interface CustomDomainsAdapter {
 	remove: (tenant_id: string, id: string) => Promise<boolean>;
 	update: (tenant_id: string, id: string, custom_domain: Partial<CustomDomain>) => Promise<boolean>;
 }
+export interface R2SQLLogsAdapterConfig {
+	/**
+	 * Cloudflare Pipeline HTTP endpoint URL for ingesting logs
+	 * Example: "https://{stream-id}.ingest.cloudflare.com"
+	 * Optional if using pipelineBinding or baseAdapter
+	 */
+	pipelineEndpoint?: string;
+	/**
+	 * Cloudflare service binding for Pipeline (for Workers)
+	 * Use this instead of pipelineEndpoint when running in a Worker
+	 * Must have a fetch() method
+	 */
+	pipelineBinding?: {
+		fetch: typeof fetch;
+	};
+	/**
+	 * Base logs adapter to wrap (passthrough mode)
+	 * When provided, logs will be sent to both the Pipeline and the base adapter
+	 */
+	baseAdapter?: {
+		create: (tenantId: string, log: any) => Promise<any>;
+		get: (tenantId: string, logId: string) => Promise<any>;
+		list: (tenantId: string, params?: any) => Promise<any>;
+	};
+	/**
+	 * Cloudflare account ID for R2 SQL API
+	 * Required for the official API endpoint
+	 * Can be passed via environment variable: CLOUDFLARE_ACCOUNT_ID
+	 */
+	accountId: string;
+	/**
+	 * Cloudflare R2 SQL API token for querying logs
+	 * Can be passed via environment variable: R2_SQL_AUTH_TOKEN
+	 */
+	authToken: string;
+	/**
+	 * R2 warehouse name (e.g., "default")
+	 * Can be passed via environment variable: R2_WAREHOUSE_NAME
+	 */
+	warehouseName: string;
+	/**
+	 * Catalog database/namespace for logs (default: "default")
+	 */
+	namespace?: string;
+	/**
+	 * Catalog table name for logs (default: "logs")
+	 */
+	tableName?: string;
+	/**
+	 * HTTP timeout in milliseconds (default: 30000)
+	 */
+	timeout?: number;
+}
 export interface CloudflareConfig {
 	zoneId: string;
 	authKey: string;
@@ -280,11 +554,17 @@ export interface CloudflareConfig {
 	 * Key prefix to namespace cache entries (optional)
 	 */
 	keyPrefix?: string;
+	/**
+	 * R2 SQL logs adapter configuration (optional)
+	 */
+	r2SqlLogs?: R2SQLLogsAdapterConfig;
 }
-declare function createAdapters(config: CloudflareConfig): {
+export interface CloudflareAdapters {
 	customDomains: CustomDomainsAdapter;
 	cache: CacheAdapter;
-};
+	logs?: LogsDataAdapter;
+}
+declare function createAdapters(config: CloudflareConfig): CloudflareAdapters;
 
 export {
 	createAdapters as default,