@authhero/cloudflare-adapter 3.0.12 → 3.1.0

package/dist/types/analytics-engine-outbox-metrics/index.d.ts

@@ -0,0 +1,61 @@
+import { AnalyticsEngineDataset } from "../analytics-engine-logs/types";
+/**
+ * One metric emission from the authhero outbox relay.
+ *
+ * Structurally identical to authhero's `OutboxMetric`. It is redeclared here
+ * so this adapter keeps working without `authhero` installed — it is only an
+ * optional peer dependency of this package.
+ */
+export interface OutboxMetricRecord {
+    /**
+     * `outbox_events_processed_total`, `outbox_events_dead_lettered_total` or
+     * `outbox_retry_delay_seconds`.
+     */
+    name: string;
+    /** Counter increment, or the observed retry delay in seconds. */
+    value: number;
+    tenantId: string;
+    eventType: string;
+    source: "request" | "cron";
+    destination?: string;
+    error?: string;
+    retryCount?: number;
+}
+export interface AnalyticsEngineOutboxMetricsConfig {
+    /**
+     * Cloudflare Analytics Engine dataset binding (e.g. `env.OUTBOX_METRICS`).
+     * When absent the sink is a no-op, so the same wiring works locally.
+     */
+    analyticsEngineBinding?: AnalyticsEngineDataset;
+}
+/**
+ * Create an Analytics Engine sink for outbox relay metrics.
+ *
+ * Pass the returned function to `init({ outbox: { metrics } })` and to
+ * `runOutboxRelay({ metrics })` so both the inline per-request relay and the
+ * cron drain report to the same dataset. Rows are indexed by tenant, matching
+ * `createAnalyticsEngineLogsAdapter`.
+ *
+ * Column layout:
+ * - blob1 `name`, blob2 `tenant_id`, blob3 `event_type`, blob4 `source`,
+ *   blob5 `destination`, blob6 `error`
+ * - double1 `value`, double2 `retry_count`, double3 `timestamp` (ms)
+ * - index1 `tenant_id`
+ *
+ * @example
+ * ```typescript
+ * // wrangler.toml:
+ * // [[analytics_engine_datasets]]
+ * // binding = "OUTBOX_METRICS"
+ * // dataset = "authhero_outbox_metrics"
+ *
+ * import { createAnalyticsEngineOutboxMetricsSink } from "@authhero/cloudflare-adapter";
+ *
+ * const metrics = createAnalyticsEngineOutboxMetricsSink({
+ *   analyticsEngineBinding: env.OUTBOX_METRICS,
+ * });
+ *
+ * const app = init({ dataAdapter, outbox: { enabled: true, metrics } });
+ * ```
+ */
+export declare function createAnalyticsEngineOutboxMetricsSink(config: AnalyticsEngineOutboxMetricsConfig): (metric: OutboxMetricRecord) => void;

package/dist/types/customDomains/index.d.ts

@@ -1,3 +1,26 @@
-import { CustomDomainsAdapter } from "@authhero/adapter-interfaces";
+import { CustomDomain, CustomDomainsAdapter } from "@authhero/adapter-interfaces";
 import { CloudflareConfig } from "../types/CloudflareConfig";
+import { CustomDomainResult } from "../types/CustomDomain";
+/** @internal Shared with the `syncCustomDomains` sweep. */
+export declare function getClient(config: CloudflareConfig): import("wretch").Wretch<unknown, unknown, undefined, undefined, never>;
+/**
+ * Merge a fresh Cloudflare hostname result onto the stored row and mirror the
+ * result back to the DB, so `list()` and `getByDomain()` — which never call
+ * Cloudflare — converge on it.
+ *
+ * Shared by `get()` and `syncCustomDomains()` so the interactive refresh and
+ * the cron sweep can never drift apart on what a Cloudflare payload means.
+ *
+ * Never throws — both callers are refresh paths, and neither should fail
+ * because Cloudflare returned something surprising. Failure is reported in
+ * `outcome` rather than raised, and is kept distinct from `"unchanged"`: a
+ * sweep whose writebacks are all failing (a varchar overflow on `verification`
+ * is one we have actually seen) would otherwise be indistinguishable from a
+ * sweep that found nothing to do.
+ */
+export type RefreshOutcome = "unchanged" | "updated" | "failed";
+export declare function refreshFromCloudflare(config: CloudflareConfig, tenant_id: string, stored: CustomDomain, result: CustomDomainResult): Promise<{
+    domain: CustomDomain;
+    outcome: RefreshOutcome;
+}>;
 export declare function createCustomDomainsAdapter(config: CloudflareConfig): CustomDomainsAdapter;

package/dist/types/customDomains/sync.d.ts

@@ -0,0 +1,78 @@
+import { CloudflareConfig } from "../types/CloudflareConfig";
+export interface SyncCustomDomainsOptions {
+    /**
+     * Hostnames fetched per Cloudflare API call. Cloudflare accepts 5 to 1000
+     * (its own default is 20); values outside that are clamped rather than
+     * rejected, since a cron should not die on a config typo. Defaults to 50.
+     */
+    perPage?: number;
+    /**
+     * Safety stop, in pages. A zone larger than `perPage * maxPages` is swept
+     * partially rather than looping forever on a paginating API that never
+     * reports a short page. Default 200 (10 000 hostnames at the default size).
+     */
+    maxPages?: number;
+}
+export interface SyncCustomDomainsResult {
+    /** Hostnames returned by Cloudflare across every page. */
+    scanned: number;
+    /** Hostnames that matched a stored custom-domain row. */
+    matched: number;
+    /** Rows whose `status` or `verification` actually changed. */
+    updated: number;
+    /**
+     * Hostnames in the zone with no stored row. Expected to be 0 in a zone
+     * AuthHero owns exclusively; a non-zero count means either a hostname
+     * registered outside AuthHero or a `create` that died between the Cloudflare
+     * call and the DB write.
+     */
+    unknown: number;
+    /**
+     * Stored rows whose `custom_domain_id` no longer matches the hostname's id
+     * at the edge — the hostname was deleted and re-registered behind our back.
+     * Left untouched: adopting the new id would rewrite a primary key that
+     * `proxy_routes` and the KV host blobs point at.
+     */
+    mismatched: number;
+    /**
+     * Hostnames that could not be reconciled — a throw, or a merge/writeback
+     * that failed without throwing. Each one is logged. A sweep reporting
+     * `updated: 0` is only healthy when this is 0 too.
+     */
+    errors: number;
+}
+/**
+ * Reconcile every custom hostname in the Cloudflare zone against the stored
+ * custom-domain rows.
+ *
+ * Without this, `status` and `verification` only ever refresh when someone
+ * reads a single domain by id (`get()`): `list()` and `getByDomain()` are
+ * deliberately DB-only so they stay fast and survive a Cloudflare outage. A
+ * hostname that finishes validation at the edge therefore stays `pending` in
+ * the database until a human happens to open its detail page. This closes that
+ * gap on a schedule.
+ *
+ * Enumerates Cloudflare-first — one paginated list call per 50 hostnames,
+ * rather than one request per stored domain — then resolves each hostname's
+ * tenant through `getByDomain`, which every adapter indexes because it is the
+ * request-routing path.
+ *
+ * One hostname's failure never aborts the sweep, and the result is returned
+ * rather than thrown: a cron that dies halfway leaves the rest of the zone
+ * stale until the next run.
+ *
+ * Deletion is deliberately out of scope. A hostname removed at the edge simply
+ * stops appearing in the listing, and "absent from a page I may have failed to
+ * fetch" is not evidence a domain is gone — removals go through `remove()`.
+ *
+ * @example
+ * ```ts
+ * export default {
+ *   async scheduled(event, env) {
+ *     const config = buildCloudflareConfig(env);
+ *     console.log("custom domain sync", await syncCustomDomains(config));
+ *   },
+ * };
+ * ```
+ */
+export declare function syncCustomDomains(config: CloudflareConfig, options?: SyncCustomDomainsOptions): Promise<SyncCustomDomainsResult>;

package/dist/types/index.d.ts

@@ -10,6 +10,8 @@ export type { AnalyticsEngineActionExecutionsAdapterConfig };
 export type { CloudflareRateLimitBinding, CloudflareRateLimitBindings };
 export { createCloudflareRateLimitAdapter } from "./rate-limit";
 export type { CloudflareConfig };
+export { syncCustomDomains } from "./customDomains/sync";
+export type { SyncCustomDomainsOptions, SyncCustomDomainsResult, } from "./customDomains/sync";
 export { DispatchNamespaceCodeExecutor, type DispatchNamespaceCodeExecutorConfig, type DispatchNamespace, CloudflareCodeExecutor, type CloudflareCodeExecutorConfig, } from "./code-executor";
 export { generateWorkerScript } from "./code-executor/worker-template";
 export { WorkerLoaderCodeExecutor, type WorkerLoader, type WorkerCode, type WorkerStub, type WorkerLoaderCodeExecutorOptions, } from "./code-executor/worker-loader";
@@ -17,6 +19,8 @@ export { createAnalyticsEngineLogsAdapter } from "./analytics-engine-logs";
 export { createAnalyticsEngineStatsAdapter } from "./analytics-engine-logs";
 export { createAnalyticsEngineAnalyticsAdapter } from "./analytics-engine-logs";
 export { createAnalyticsEngineActionExecutionsAdapter } from "./analytics-engine-action-executions";
+export { createAnalyticsEngineOutboxMetricsSink } from "./analytics-engine-outbox-metrics";
+export type { AnalyticsEngineOutboxMetricsConfig, OutboxMetricRecord, } from "./analytics-engine-outbox-metrics";
 export { createR2SQLLogsAdapter } from "./r2-sql-logs";
 export { createR2SQLStatsAdapter } from "./r2-sql-logs";
 export { createCloudflareWfpD1Provisioner, createWfpProvisionerSteps, createWfpTenantProvisioningHook, createWfpForwardMiddleware, CloudflareApiClient, CloudflareApiError, } from "./wfp-provisioner";

package/package.json

@@ -11,7 +11,7 @@
     "type": "git",
     "url": "https://github.com/markusahlstrand/authhero"
   },
-  "version": "3.0.12",
+  "version": "3.1.0",
   "files": [
     "dist"
   ],
@@ -47,8 +47,8 @@
     "typescript": "^5.9.3",
     "vite": "^8.0.14",
     "vitest": "^4.1.7",
-    "@authhero/multi-tenancy": "15.0.0",
-    "authhero": "9.9.1"
+    "@authhero/multi-tenancy": "15.0.1",
+    "authhero": "9.10.0"
   },
   "peerDependencies": {
     "@authhero/multi-tenancy": "^14.0.0",
@@ -67,8 +67,8 @@
   "dependencies": {
     "nanoid": "^5.1.11",
     "wretch": "^3.0.8",
-    "@authhero/kysely-adapter": "12.6.1",
-    "@authhero/adapter-interfaces": "4.11.0"
+    "@authhero/adapter-interfaces": "4.12.0",
+    "@authhero/kysely-adapter": "12.6.2"
   },
   "license": "AGPL-3.0-only",
   "scripts": {