@authhero/adapter-interfaces 4.20.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/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/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/package.json

@@ -11,7 +11,7 @@
     "type": "git",
     "url": "https://github.com/sesamyab/authhero"
   },
-  "version": "4.20.0",
+  "version": "4.21.0",
   "files": [
     "dist"
   ],