@authhero/kysely-adapter 11.15.0 → 11.16.0

package/dist/types/src/helpers/paginate.d.ts

@@ -0,0 +1,31 @@
+import { SelectQueryBuilder } from "kysely";
+import { ListParams } from "@authhero/adapter-interfaces";
+/**
+ * Keyset (checkpoint) pagination for list queries — the Auth0 `from`/`take`
+ * style. `from` is an OPAQUE cursor (see encodeCursor), decoded to a
+ * `(sortValue, id)` position; `take` is the page size. We fetch `take + 1`
+ * rows to detect whether another page follows and emit a `next` cursor,
+ * absent on the last page.
+ *
+ * This is intentionally keyset-only. Offset pagination (page/per_page + total),
+ * which the admin UI uses and which honors arbitrary user sort, stays in each
+ * adapter untouched. Callers branch to this helper only when `from`/`take` is
+ * present. The helper owns ORDER BY (sortColumn then idColumn as a unique
+ * tiebreaker), so the passed query must not be pre-ordered.
+ */
+export declare function isKeysetRequest(params?: ListParams): boolean;
+export interface KeysetOptions {
+    /** Column to sort by. Must be a real column on the queried table. */
+    sortColumn: string;
+    sortOrder: "asc" | "desc";
+    /** Unique tiebreaker column; defaults to "id". */
+    idColumn?: string;
+}
+export interface KeysetResult<Row> {
+    rows: Row[];
+    /** Page size actually applied. */
+    limit: number;
+    /** Opaque cursor for the next page; set only when more rows follow. */
+    next?: string;
+}
+export declare function keysetPaginate<DB, TB extends keyof DB, O>(query: SelectQueryBuilder<DB, TB, O>, params: ListParams | undefined, options: KeysetOptions): Promise<KeysetResult<O>>;