@authhero/adapter-interfaces 4.19.0 → 4.21.0

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

@@ -1,8 +1,23 @@
 import { OrganizationConnection, OrganizationConnectionInsert } from "../types";
 import { CreateOptions } from "../types/ImportMetadata";
+import { ListParams } from "../types/ListParams";
+export interface ListOrganizationConnectionsCheckpointResponse {
+    connections: OrganizationConnection[];
+    /** Opaque checkpoint cursor for the next page; absent on the last page. */
+    next?: string;
+}
 export interface OrganizationConnectionsAdapter {
     create(tenant_id: string, organization_id: string, params: OrganizationConnectionInsert, options?: CreateOptions): Promise<OrganizationConnection>;
     list(tenant_id: string, organization_id: string): Promise<OrganizationConnection[]>;
+    /**
+     * Checkpoint (from/take) pagination over an organization's enabled
+     * connections, ordered by connection id ascending (unique per organization).
+     * Separate from `list` because that returns a bare array with nowhere to
+     * carry `next`. Optional so existing adapter implementations keep compiling;
+     * the management API answers checkpoint requests with 501 when it is
+     * missing.
+     */
+    listCheckpoint?(tenant_id: string, organization_id: string, params?: ListParams): Promise<ListOrganizationConnectionsCheckpointResponse>;
     get(tenant_id: string, organization_id: string, connection_id: string): Promise<OrganizationConnection | null>;
     update(tenant_id: string, organization_id: string, connection_id: string, params: Partial<Omit<OrganizationConnectionInsert, "connection_id">>): Promise<OrganizationConnection | null>;
     remove(tenant_id: string, organization_id: string, connection_id: string): Promise<boolean>;

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

@@ -21,6 +21,11 @@ export interface ListFailedEventsResponse {
     start: number;
     limit: number;
     length: number;
+    /**
+     * Opaque keyset cursor for the next page. Set only when the caller paginated
+     * with from/take and more rows may follow.
+     */
+    next?: string;
 }
 export interface OutboxAdapter {
     /** Write an audit event to the outbox. Returns the event ID. */

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

@@ -0,0 +1,9 @@
+import { CreateOptions, PromptPartials } from "../types";
+export interface PromptPartialsAdapter {
+    get(tenant_id: string, prompt: string): Promise<PromptPartials | null>;
+    /** Replace all partials stored for a prompt. */
+    set(tenant_id: string, prompt: string, partials: PromptPartials, options?: CreateOptions): Promise<void>;
+    delete(tenant_id: string, prompt: string): Promise<void>;
+    /** List prompts with stored partials for tenant export. */
+    list(tenant_id: string): Promise<string[]>;
+}

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

@@ -16,18 +16,6 @@ export interface RefreshTokenListParams extends ListParams {
 export interface ListRefreshTokenResponse extends Totals {
     refresh_tokens: RefreshToken[];
 }
-export interface UpdateRefreshTokenOptions {
-    /**
-     * When provided, the adapter also extends the parent login_session's
-     * `expires_at` to `expires_at` (only if the current value is smaller).
-     * The caller is expected to compute the new expiry so the adapter can
-     * avoid a read-before-write and parallelise the two UPDATEs.
-     */
-    loginSessionBump?: {
-        login_id: string;
-        expires_at: string;
-    };
-}
 /**
  * Update payload for a refresh token.
  *
@@ -55,7 +43,7 @@ export interface RefreshTokensAdapter {
      */
     getByLookup: (tenant_id: string, token_lookup: string) => Promise<RefreshToken | null>;
     list(tenant_id: string, params?: RefreshTokenListParams): Promise<ListRefreshTokenResponse>;
-    update: (tenant_id: string, id: string, refresh_token: RefreshTokenUpdate, options?: UpdateRefreshTokenOptions) => Promise<boolean>;
+    update: (tenant_id: string, id: string, refresh_token: RefreshTokenUpdate) => Promise<boolean>;
     remove: (tenant_id: string, id: string) => Promise<boolean>;
     /**
      * Soft-revoke every refresh token belonging to a user that isn't already

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

@@ -1,8 +1,22 @@
 import { ListParams } from "../types/ListParams";
 import { UserPermissionInsert, UserPermissionWithDetailsList } from "../types";
 import { CreateOptions } from "../types/ImportMetadata";
+export interface ListUserPermissionsCheckpointResponse {
+    permissions: UserPermissionWithDetailsList;
+    /** Opaque checkpoint cursor for the next page; absent on the last page. */
+    next?: string;
+}
 export interface UserPermissionsAdapter {
     create(tenant_id: string, user_id: string, permission: UserPermissionInsert, organization_id?: string, options?: CreateOptions): Promise<boolean>;
     remove(tenant_id: string, user_id: string, permission: Pick<UserPermissionInsert, "resource_server_identifier" | "permission_name">, organization_id?: string): Promise<boolean>;
     list(tenant_id: string, user_id: string, params?: ListParams, organization_id?: string): Promise<UserPermissionWithDetailsList>;
+    /**
+     * Checkpoint (from/take) pagination over a user's permissions, ordered by
+     * (resource_server_identifier, permission_name, organization_id) ascending —
+     * the composite key. Separate from `list` because that returns a bare array
+     * with nowhere to carry `next`. Optional so existing adapter implementations
+     * keep compiling; the management API answers checkpoint requests with 501
+     * when it is missing.
+     */
+    listCheckpoint?(tenant_id: string, user_id: string, params?: ListParams, organization_id?: string): Promise<ListUserPermissionsCheckpointResponse>;
 }

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

@@ -7,6 +7,11 @@ export interface ListUserRolesResponse {
     limit: number;
     length: number;
 }
+export interface ListUserRolesCheckpointResponse {
+    roles: Role[];
+    /** Opaque checkpoint cursor for the next page; absent on the last page. */
+    next?: string;
+}
 export interface ListRoleUsersResponse {
     /** Distinct user ids holding the role, ordered by user_id ascending. */
     userIds: string[];
@@ -35,6 +40,15 @@ export interface UserRolesAdapter {
      * lookups (see #1198).
      */
     list(tenantId: string, userId: string, params?: ListParams, organizationId?: string): Promise<Role[]>;
+    /**
+     * Checkpoint (from/take) pagination over the roles assigned to a user,
+     * ordered by role id ascending. Roles are distinct: one held under several
+     * organization scopes appears once (unlike `list`, which returns one row per
+     * assignment). `organizationId` filters exactly as it does for `list`.
+     * Optional so existing adapter implementations keep compiling; the
+     * management API answers checkpoint requests with 501 when it is missing.
+     */
+    listCheckpoint?(tenantId: string, userId: string, params?: ListParams, organizationId?: string): Promise<ListUserRolesCheckpointResponse>;
     /**
      * List the distinct users assigned to a role, across all organization
      * scopes (a user holding the role in several organizations appears once).

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

@@ -50,6 +50,7 @@ import { StatsAdapter } from "./Stats";
 import { AnalyticsAdapter } from "./Analytics";
 import { UniversalLoginTemplatesAdapter } from "./UniversalLoginTemplates";
 import { CustomTextAdapter } from "./CustomText";
+import { PromptPartialsAdapter } from "./PromptPartials";
 import { EmailServiceAdapter } from "./EmailService";
 import { SmsServiceAdapter } from "./SmsService";
 import { OutboxAdapter } from "./Outbox";
@@ -100,6 +101,8 @@ export interface DataAdapters {
     migrationSources?: MigrationSourcesAdapter;
     passwords: PasswordsAdapter;
     promptSettings: PromptSettingsAdapter;
+    /** Optional tenant-level storage for Auth0-compatible prompt partials. */
+    promptPartials?: PromptPartialsAdapter;
     /**
      * Optional adapter for managing reverse-proxy route configuration per tenant.
      * When set, AuthHero mounts the `/api/v2/proxy-routes` management API. A
@@ -248,6 +251,7 @@ export * from "./ActionVersions";
 export * from "./Flows";
 export * from "./Cache";
 export * from "./Clients";
+export * from "./PromptPartials";
 export * from "./ClientConnections";
 export * from "./ClientGrants";
 export * from "./ClientRegistrationTokens";

package/dist/types/types/AuditEvent.d.ts

@@ -137,6 +137,8 @@ export declare const auditEventInsertSchema: z.ZodObject<{
     hostname: z.ZodString;
     is_mobile: z.ZodOptional<z.ZodBoolean>;
     execution_id: z.ZodOptional<z.ZodString>;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    login_session_id: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodString;
 }, z.core.$strip>;
 export type AuditEventInsert = z.infer<typeof auditEventInsertSchema>;
@@ -214,6 +216,8 @@ export declare const auditEventSchema: z.ZodObject<{
     hostname: z.ZodString;
     is_mobile: z.ZodOptional<z.ZodBoolean>;
     execution_id: z.ZodOptional<z.ZodString>;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    login_session_id: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodString;
     id: z.ZodString;
 }, z.core.$strip>;

package/dist/types/types/Forms.d.ts

@@ -1,4 +1,5 @@
 import { z } from "@hono/zod-openapi";
+import type { PromptPartialInsertionPoint } from "./PromptPartials";
 declare const dividerComponent: z.ZodObject<{
     id: z.ZodString;
     order: z.ZodOptional<z.ZodNumber>;
@@ -4651,6 +4652,13 @@ export declare const screenLinkSchema: z.ZodObject<{
     linkText: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type ScreenLink = z.infer<typeof screenLinkSchema>;
+/**
+ * Auth0 prompt partials attached to a rendered screen.
+ *
+ * This is a single screen's insertion points, rather than the complete
+ * prompt -> screen -> insertion point object persisted by adapters.
+ */
+export declare const uiScreenPartialsSchema: z.ZodType<Partial<Record<PromptPartialInsertionPoint, string>>>;
 /**
  * Screen sent to the widget (simplified STEP for rendering)
  * This is what the API returns to the widget - no flow routing logic
@@ -5288,6 +5296,7 @@ export declare const uiScreenSchema: z.ZodObject<{
         href: z.ZodString;
         linkText: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
+    partials: z.ZodOptional<z.ZodType<Partial<Record<"form-content-start" | "form-content-end" | "form-footer-start" | "form-footer-end" | "secondary-actions-start" | "secondary-actions-end", string>>, unknown, z.core.$ZodTypeInternals<Partial<Record<"form-content-start" | "form-content-end" | "form-footer-start" | "form-footer-end" | "secondary-actions-start" | "secondary-actions-end", string>>, unknown>>>;
     footer: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type UiScreen = z.infer<typeof uiScreenSchema>;

package/dist/types/types/PromptPartials.d.ts

@@ -0,0 +1,22 @@
+import { z } from "@hono/zod-openapi";
+export declare const promptPartialInsertionPoints: readonly ["form-content-start", "form-content-end", "form-footer-start", "form-footer-end", "secondary-actions-start", "secondary-actions-end"];
+export type PromptPartialInsertionPoint = (typeof promptPartialInsertionPoints)[number];
+/**
+ * Auth0-compatible prompt partials, keyed by screen and insertion point.
+ *
+ * @example
+ * ```ts
+ * {
+ *   signup: {
+ *     "form-content-end": "<input name=\"ulp-first-name\">"
+ *   }
+ * }
+ * ```
+ */
+export type PromptPartials = Record<string, Partial<Record<PromptPartialInsertionPoint, string>>>;
+export declare const promptPartialsSchema: z.ZodType<PromptPartials>;
+export declare const promptPartialsEntrySchema: z.ZodObject<{
+    prompt: z.ZodString;
+    partials: z.ZodType<PromptPartials, unknown, z.core.$ZodTypeInternals<PromptPartials, unknown>>;
+}, z.core.$strip>;
+export type PromptPartialsEntry = z.infer<typeof promptPartialsEntrySchema>;

package/dist/types/types/ProxyRoute.d.ts

@@ -50,7 +50,6 @@ export declare const proxyRouteSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type ProxyRoute = z.infer<typeof proxyRouteSchema>;
 export declare const proxyRouteUpdateSchema: z.ZodObject<{
-    priority: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     match: z.ZodOptional<z.ZodObject<{
         hosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
         methods: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -58,6 +57,7 @@ export declare const proxyRouteUpdateSchema: z.ZodObject<{
         headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>>;
+    priority: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     handlers: z.ZodOptional<z.ZodArray<z.ZodObject<{
         type: z.ZodString;
         options: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;

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

@@ -60,6 +60,7 @@ export * from "./TenantSettings";
 export * from "./Stats";
 export * from "./Analytics";
 export * from "./CustomText";
+export * from "./PromptPartials";
 export * from "./Strategy";
 export * from "./AuthenticationMethod";
 export * from "./ImportMetadata";

package/package.json

@@ -9,9 +9,9 @@
   "homepage": "https://authhero.net",
   "repository": {
     "type": "git",
-    "url": "https://github.com/markusahlstrand/authhero"
+    "url": "https://github.com/sesamyab/authhero"
   },
-  "version": "4.19.0",
+  "version": "4.21.0",
   "files": [
     "dist"
   ],