@authhero/cloudflare-adapter 2.27.0 → 2.28.0

package/dist/cloudflare-adapter.d.ts

@@ -606,6 +606,73 @@ declare const dailyStatsSchema: z.ZodObject<{
 	leaked_passwords: number;
 }>;
 export type DailyStats = z.infer<typeof dailyStatsSchema>;
+declare const analyticsResourceSchema: z.ZodEnum<[
+	"active-users",
+	"logins",
+	"signups",
+	"refresh-tokens",
+	"sessions"
+]>;
+export type AnalyticsResource = z.infer<typeof analyticsResourceSchema>;
+declare const analyticsIntervalSchema: z.ZodEnum<[
+	"hour",
+	"day",
+	"week",
+	"month"
+]>;
+export type AnalyticsInterval = z.infer<typeof analyticsIntervalSchema>;
+declare const analyticsGroupBySchema: z.ZodEnum<[
+	"time",
+	"connection",
+	"client_id",
+	"user_type",
+	"event"
+]>;
+export type AnalyticsGroupBy = z.infer<typeof analyticsGroupBySchema>;
+declare const analyticsUserTypeSchema: z.ZodEnum<[
+	"password",
+	"social",
+	"passwordless",
+	"enterprise"
+]>;
+export type AnalyticsUserType = z.infer<typeof analyticsUserTypeSchema>;
+export interface AnalyticsFilters {
+	connection?: string[];
+	client_id?: string[];
+	user_type?: AnalyticsUserType[];
+	user_id?: string[];
+}
+export interface AnalyticsQueryParams {
+	/** Inclusive lower bound, ISO 8601 datetime in UTC */
+	from: string;
+	/** Exclusive upper bound, ISO 8601 datetime in UTC */
+	to: string;
+	interval: AnalyticsInterval;
+	/** IANA timezone for bucket boundaries */
+	tz: string;
+	filters: AnalyticsFilters;
+	group_by: AnalyticsGroupBy[];
+	limit: number;
+	offset: number;
+	/** Column name, prefix with `-` for descending */
+	order_by?: string;
+}
+export interface AnalyticsColumnMeta {
+	name: string;
+	/** ClickHouse-style type label (e.g. "Date", "String", "UInt64", "DateTime") */
+	type: string;
+}
+export interface AnalyticsQueryResponse {
+	meta: AnalyticsColumnMeta[];
+	data: Array<Record<string, unknown>>;
+	rows: number;
+	rows_before_limit_at_least?: number;
+	statistics?: {
+		elapsed: number;
+		rows_read?: number;
+		bytes_read?: number;
+	};
+}
 export interface CacheAdapter {
 	/**
 	 * Get a value from the cache
@@ -683,6 +750,14 @@ export interface StatsAdapter {
 	 */
 	getActiveUsers(tenantId: string): Promise<number>;
 }
+export interface AnalyticsAdapter {
+	/**
+	 * Run an analytics query for a tenant. The adapter is responsible for
+	 * injecting the tenant_id predicate; the route handler never trusts a
+	 * tenant value from a client-controlled source.
+	 */
+	query(tenantId: string, resource: AnalyticsResource, params: AnalyticsQueryParams): Promise<AnalyticsQueryResponse>;
+}
 /**
  * Logical buckets that consumers can rate-limit against. Backends decide
  * how each scope is enforced (e.g. mapping to a separate Cloudflare Workers
@@ -907,6 +982,7 @@ export interface AnalyticsEngineLogsAdapterConfig {
  * Create a stats adapter that queries Analytics Engine
  */
 export declare function createAnalyticsEngineStatsAdapter(config: AnalyticsEngineLogsAdapterConfig): StatsAdapter;
+export declare function createAnalyticsEngineAnalyticsAdapter(config: AnalyticsEngineLogsAdapterConfig): AnalyticsAdapter;
 /**
  * Create an Analytics Engine logs adapter
  *