@authhero/adapter-interfaces 3.8.0 → 3.10.0

package/dist/types/adapters/Users.d.ts

@@ -1,9 +1,28 @@
 import { User, Totals, UserInsert } from "../types";
+import { AuditEventInsert } from "../types/AuditEvent";
 import { ListParams } from "../types/ListParams";
 import { CreateOptions } from "../types/ImportMetadata";
 export interface ListUsersResponse extends Totals {
     users: User[];
 }
+/**
+ * An outbox event to persist atomically with a business write. It carries a
+ * caller-assigned `id` so the enqueuer can relay it (push it onto the request's
+ * outbox-event list for delivery) without a return round-trip from the adapter.
+ */
+export type OutboxEventInsert = AuditEventInsert & {
+    id: string;
+};
+/**
+ * Options common to the event-emitting user writes. When `outboxEvents` are
+ * supplied, the adapter MUST persist them in the same atomic unit as the
+ * business write — a single `db.batch()` on D1, one transaction on
+ * kysely/better-sqlite3 — so the business row and its event row commit together
+ * or not at all (the defining guarantee of the transactional outbox pattern).
+ */
+export interface WriteOptions {
+    outboxEvents?: OutboxEventInsert[];
+}
 export interface UserDataAdapter {
     get(tenant_id: string, id: string): Promise<User | null>;
     create(tenantId: string, user: UserInsert, options?: CreateOptions): Promise<User>;
@@ -12,10 +31,13 @@ export interface UserDataAdapter {
      * registration hooks, linking, webhooks, etc.). Intended to be called from
      * inside a registration pipeline that owns hook orchestration and transaction
      * boundaries itself. The DB-level behavior is identical to `create`.
+     *
+     * Pass `options.outboxEvents` to persist post-registration outbox events in
+     * the same atomic unit as the user row.
      */
-    rawCreate(tenantId: string, user: UserInsert): Promise<User>;
-    remove(tenantId: string, id: string): Promise<boolean>;
+    rawCreate(tenantId: string, user: UserInsert, options?: WriteOptions): Promise<User>;
+    remove(tenantId: string, id: string, options?: WriteOptions): Promise<boolean>;
     list(tenantId: string, params?: ListParams): Promise<ListUsersResponse>;
-    update(tenantId: string, id: string, user: Partial<User>): Promise<boolean>;
+    update(tenantId: string, id: string, user: Partial<User>, options?: WriteOptions): Promise<boolean>;
     unlink(tenantId: string, id: string, provider: string, linked_user_id: string): Promise<boolean>;
 }

package/dist/types/types/auth0/Totals.d.ts

@@ -4,10 +4,17 @@ export declare const totalsSchema: z.ZodObject<{
     limit: z.ZodNumber;
     length: z.ZodNumber;
     total: z.ZodOptional<z.ZodNumber>;
+    next: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export interface Totals {
     start: number;
     limit: number;
     length: number;
     total?: number;
+    /**
+     * Opaque keyset cursor for the next page. Set only when the caller paginated
+     * with from/take and more rows may follow; absent on the last page and for
+     * offset (page/per_page) pagination.
+     */
+    next?: string;
 }

package/dist/types/utils/base64url.d.ts

@@ -0,0 +1,22 @@
+/**
+ * URL-safe base64 ("base64url", RFC 4648 §5) without padding.
+ *
+ * This is the canonical base64url implementation for the AuthHero packages.
+ * It lives in `adapter-interfaces` (the lowest package) so every other package
+ * can depend on it, replacing scattered hand-rolled `btoa/atob` variants and
+ * the `oslo/encoding` dependency we are migrating away from.
+ *
+ * Both byte- and string-oriented helpers are provided:
+ *  - `encodeBase64Url` / `decodeBase64Url` work on raw bytes (`Uint8Array`),
+ *    matching how most callers use it (hashes, random bytes, JWT segments).
+ *  - `encodeBase64UrlString` / `decodeBase64UrlString` wrap those with UTF-8
+ *    (de)coding for the common "encode a JSON/text payload" case.
+ */
+/** Encode raw bytes as a padding-free base64url string. */
+export declare function encodeBase64Url(bytes: Uint8Array): string;
+/** Decode a base64url string (with or without padding) back to raw bytes. */
+export declare function decodeBase64Url(input: string): Uint8Array;
+/** Encode a UTF-8 string as a padding-free base64url string. */
+export declare function encodeBase64UrlString(input: string): string;
+/** Decode a base64url string produced from UTF-8 text back to that string. */
+export declare function decodeBase64UrlString(input: string): string;

package/dist/types/utils/cursor.d.ts

@@ -0,0 +1,20 @@
+export interface CursorPayload {
+    /**
+     * Value of the sort column on the last row of the previous page. `null` when
+     * that column was null on the boundary row. Absent for id-only ordering.
+     */
+    s?: string | number | null;
+    /** Id of the last row of the previous page — the unique tiebreaker. */
+    i: string;
+}
+/**
+ * Encode a keyset position into an opaque cursor token suitable for returning
+ * as `next` and accepting back as `from`.
+ */
+export declare function encodeCursor(payload: CursorPayload): string;
+/**
+ * Decode an opaque cursor token. Returns `null` for malformed or unparseable
+ * tokens so callers can fall back gracefully (e.g. start from the beginning)
+ * instead of throwing on client-supplied input.
+ */
+export declare function decodeCursor(token: string): CursorPayload | null;

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

@@ -2,3 +2,5 @@ export * from "./user-id";
 export * from "./passthrough";
 export * from "./connection-attributes";
 export * from "./guards";
+export * from "./base64url";
+export * from "./cursor";

package/package.json

@@ -11,7 +11,7 @@
     "type": "git",
     "url": "https://github.com/markusahlstrand/authhero"
   },
-  "version": "3.8.0",
+  "version": "3.10.0",
   "files": [
     "dist"
   ],