@danielhritcu/zenstack-orm 3.5.7 → 3.5.8

package/dist/index.d.cts

@@ -2242,6 +2242,47 @@ interface Diagnostics {
     slowQueries: QueryInfo[];
 }
 
+/**
+ * Offset pagination result.
+ */
+interface PaginatedOffset<T> {
+    items: T[];
+    pagination: {
+        count: number;
+        page: {
+            size: number;
+            current: number;
+            next: number | null;
+            prev: number | null;
+            total: number;
+        };
+        has: {
+            next: boolean;
+            prev: boolean;
+        };
+    };
+}
+/**
+ * Cursor pagination result.
+ */
+interface PaginatedCursor<T> {
+    items: T[];
+    pagination: {
+        count: number;
+        page: {
+            size: number;
+        };
+        has: {
+            next: boolean;
+            prev: boolean;
+        };
+        cursor: {
+            next: string | null;
+            prev: string | null;
+        };
+    };
+}
+
 /**
  * A promise that only executes when it's awaited or .then() is called.
  */
@@ -3002,6 +3043,29 @@ type CommonModelOperations<Schema extends SchemaDef, Model extends GetModels<Sch
      * }); // result: `boolean`
      */
     exists<T extends ExistsArgs<Schema, Model, Options, ExtQueryArgs>>(args?: Subset<T, ExistsArgs<Schema, Model, Options, ExtQueryArgs>>): ZenStackPromise<Schema, boolean>;
+    /**
+     * Returns paginated results with metadata.
+     *
+     * Offset mode (pass `page`):
+     * ```ts
+     * const result = await db.user.paginate({ page: 1, pageSize: 20 });
+     * // result.items, result.pagination.page.current, result.pagination.has.next
+     * ```
+     *
+     * Cursor mode (pass `cursor`):
+     * ```ts
+     * const result = await db.user.paginate({ cursor: lastId, pageSize: 20 });
+     * // result.items, result.pagination.cursor.next, result.pagination.has.next
+     * ```
+     */
+    paginate<T extends FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>(args: Omit<SelectSubset<T, FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>, 'skip' | 'take' | 'cursor'> & {
+        page: number;
+        pageSize?: number;
+    }): ZenStackPromise<Schema, PaginatedOffset<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>>>;
+    paginate<T extends FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>(args: Omit<SelectSubset<T, FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>, 'skip' | 'take' | 'cursor'> & {
+        cursor: string;
+        pageSize?: number;
+    }): ZenStackPromise<Schema, PaginatedCursor<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>>>;
 };
 type OperationsRequiringCreate = 'create' | 'createMany' | 'createManyAndReturn' | 'upsert';
 type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}, ExtResult extends ExtResultBase<Schema> = {}> = SliceOperations<AllModelOperations<Schema, Model, Options, ExtQueryArgs, ExtResult>, Schema, Model, Options>;
@@ -3375,47 +3439,6 @@ declare namespace queryUtils {
   export { queryUtils_TEMP_ALIAS_PREFIX as TEMP_ALIAS_PREFIX, queryUtils_aggregate as aggregate, queryUtils_buildJoinPairs as buildJoinPairs, queryUtils_ensureArray as ensureArray, queryUtils_extractFieldName as extractFieldName, queryUtils_extractIdFields as extractIdFields, queryUtils_extractModelName as extractModelName, queryUtils_fieldHasDefaultValue as fieldHasDefaultValue, queryUtils_flattenCompoundUniqueFilters as flattenCompoundUniqueFilters, queryUtils_getDelegateDescendantModels as getDelegateDescendantModels, queryUtils_getDiscriminatorField as getDiscriminatorField, queryUtils_getEnum as getEnum, queryUtils_getField as getField, queryUtils_getIdFields as getIdFields, queryUtils_getIdValues as getIdValues, queryUtils_getManyToManyRelation as getManyToManyRelation, queryUtils_getModel as getModel, queryUtils_getModelFields as getModelFields, queryUtils_getRelationForeignKeyFieldPairs as getRelationForeignKeyFieldPairs, queryUtils_getTypeDef as getTypeDef, queryUtils_getUniqueFields as getUniqueFields, queryUtils_hasModel as hasModel, queryUtils_isEnum as isEnum, queryUtils_isForeignKeyField as isForeignKeyField, queryUtils_isInheritedField as isInheritedField, queryUtils_isRelationField as isRelationField, queryUtils_isScalarField as isScalarField, queryUtils_isTypeDef as isTypeDef, queryUtils_isUnsupportedField as isUnsupportedField, queryUtils_makeDefaultOrderBy as makeDefaultOrderBy, queryUtils_requireField as requireField, queryUtils_requireIdFields as requireIdFields, queryUtils_requireModel as requireModel, queryUtils_requireTypeDef as requireTypeDef, queryUtils_stripAlias as stripAlias, queryUtils_tmpAlias as tmpAlias };
 }
 
-/**
- * Offset pagination result.
- */
-interface PaginatedOffset<T> {
-    items: T[];
-    pagination: {
-        count: number;
-        page: {
-            size: number;
-            current: number;
-            next: number | null;
-            prev: number | null;
-            total: number;
-        };
-        has: {
-            next: boolean;
-            prev: boolean;
-        };
-    };
-}
-/**
- * Cursor pagination result.
- */
-interface PaginatedCursor<T> {
-    items: T[];
-    pagination: {
-        count: number;
-        page: {
-            size: number;
-        };
-        has: {
-            next: boolean;
-            prev: boolean;
-        };
-        cursor: {
-            next: string | null;
-            prev: string | null;
-        };
-    };
-}
-
 type VisitResult = void | {
     abort: true;
 };

package/dist/index.d.ts

@@ -2242,6 +2242,47 @@ interface Diagnostics {
     slowQueries: QueryInfo[];
 }
 
+/**
+ * Offset pagination result.
+ */
+interface PaginatedOffset<T> {
+    items: T[];
+    pagination: {
+        count: number;
+        page: {
+            size: number;
+            current: number;
+            next: number | null;
+            prev: number | null;
+            total: number;
+        };
+        has: {
+            next: boolean;
+            prev: boolean;
+        };
+    };
+}
+/**
+ * Cursor pagination result.
+ */
+interface PaginatedCursor<T> {
+    items: T[];
+    pagination: {
+        count: number;
+        page: {
+            size: number;
+        };
+        has: {
+            next: boolean;
+            prev: boolean;
+        };
+        cursor: {
+            next: string | null;
+            prev: string | null;
+        };
+    };
+}
+
 /**
  * A promise that only executes when it's awaited or .then() is called.
  */
@@ -3002,6 +3043,29 @@ type CommonModelOperations<Schema extends SchemaDef, Model extends GetModels<Sch
      * }); // result: `boolean`
      */
     exists<T extends ExistsArgs<Schema, Model, Options, ExtQueryArgs>>(args?: Subset<T, ExistsArgs<Schema, Model, Options, ExtQueryArgs>>): ZenStackPromise<Schema, boolean>;
+    /**
+     * Returns paginated results with metadata.
+     *
+     * Offset mode (pass `page`):
+     * ```ts
+     * const result = await db.user.paginate({ page: 1, pageSize: 20 });
+     * // result.items, result.pagination.page.current, result.pagination.has.next
+     * ```
+     *
+     * Cursor mode (pass `cursor`):
+     * ```ts
+     * const result = await db.user.paginate({ cursor: lastId, pageSize: 20 });
+     * // result.items, result.pagination.cursor.next, result.pagination.has.next
+     * ```
+     */
+    paginate<T extends FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>(args: Omit<SelectSubset<T, FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>, 'skip' | 'take' | 'cursor'> & {
+        page: number;
+        pageSize?: number;
+    }): ZenStackPromise<Schema, PaginatedOffset<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>>>;
+    paginate<T extends FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>(args: Omit<SelectSubset<T, FindManyArgs<Schema, Model, Options, ExtQueryArgs, ExtResult>>, 'skip' | 'take' | 'cursor'> & {
+        cursor: string;
+        pageSize?: number;
+    }): ZenStackPromise<Schema, PaginatedCursor<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>>>;
 };
 type OperationsRequiringCreate = 'create' | 'createMany' | 'createManyAndReturn' | 'upsert';
 type ModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>, Options extends ClientOptions<Schema> = ClientOptions<Schema>, ExtQueryArgs extends ExtQueryArgsBase = {}, ExtResult extends ExtResultBase<Schema> = {}> = SliceOperations<AllModelOperations<Schema, Model, Options, ExtQueryArgs, ExtResult>, Schema, Model, Options>;
@@ -3375,47 +3439,6 @@ declare namespace queryUtils {
   export { queryUtils_TEMP_ALIAS_PREFIX as TEMP_ALIAS_PREFIX, queryUtils_aggregate as aggregate, queryUtils_buildJoinPairs as buildJoinPairs, queryUtils_ensureArray as ensureArray, queryUtils_extractFieldName as extractFieldName, queryUtils_extractIdFields as extractIdFields, queryUtils_extractModelName as extractModelName, queryUtils_fieldHasDefaultValue as fieldHasDefaultValue, queryUtils_flattenCompoundUniqueFilters as flattenCompoundUniqueFilters, queryUtils_getDelegateDescendantModels as getDelegateDescendantModels, queryUtils_getDiscriminatorField as getDiscriminatorField, queryUtils_getEnum as getEnum, queryUtils_getField as getField, queryUtils_getIdFields as getIdFields, queryUtils_getIdValues as getIdValues, queryUtils_getManyToManyRelation as getManyToManyRelation, queryUtils_getModel as getModel, queryUtils_getModelFields as getModelFields, queryUtils_getRelationForeignKeyFieldPairs as getRelationForeignKeyFieldPairs, queryUtils_getTypeDef as getTypeDef, queryUtils_getUniqueFields as getUniqueFields, queryUtils_hasModel as hasModel, queryUtils_isEnum as isEnum, queryUtils_isForeignKeyField as isForeignKeyField, queryUtils_isInheritedField as isInheritedField, queryUtils_isRelationField as isRelationField, queryUtils_isScalarField as isScalarField, queryUtils_isTypeDef as isTypeDef, queryUtils_isUnsupportedField as isUnsupportedField, queryUtils_makeDefaultOrderBy as makeDefaultOrderBy, queryUtils_requireField as requireField, queryUtils_requireIdFields as requireIdFields, queryUtils_requireModel as requireModel, queryUtils_requireTypeDef as requireTypeDef, queryUtils_stripAlias as stripAlias, queryUtils_tmpAlias as tmpAlias };
 }
 
-/**
- * Offset pagination result.
- */
-interface PaginatedOffset<T> {
-    items: T[];
-    pagination: {
-        count: number;
-        page: {
-            size: number;
-            current: number;
-            next: number | null;
-            prev: number | null;
-            total: number;
-        };
-        has: {
-            next: boolean;
-            prev: boolean;
-        };
-    };
-}
-/**
- * Cursor pagination result.
- */
-interface PaginatedCursor<T> {
-    items: T[];
-    pagination: {
-        count: number;
-        page: {
-            size: number;
-        };
-        has: {
-            next: boolean;
-            prev: boolean;
-        };
-        cursor: {
-            next: string | null;
-            prev: string | null;
-        };
-    };
-}
-
 type VisitResult = void | {
     abort: true;
 };