@longzai-intelligence/pagination 0.0.2 → 0.0.3

package/README.md

@@ -10,213 +10,42 @@ bun add @longzai-intelligence/pagination
 
 ## 特性
 
-- 类型安全的分页参数定义
-- 支持 page/pageSize 和 limit/offset 两种分页风格
-- 支持游标分页
-- 提供参数验证工具
-- 提供 TypeORM 适配器（可选）
-
-## 快速开始
-
-### 基本使用
-
-```typescript
-import {
-  normalizePagination,
-  calculateOffset,
-  createPaginatedResult,
-  type PaginationParams,
-  type PaginatedResult,
-} from '@longzai-intelligence/pagination';
-
-// 规范化分页参数
-const params: PaginationParams = { page: 2, pageSize: 20 };
-const { page, pageSize } = normalizePagination(params);
-
-// 计算偏移量
-const offset = calculateOffset(page, pageSize);
-
-// 创建分页结果
-const result: PaginatedResult<User> = createPaginatedResult(
-  users,
-  total,
-  page,
-  pageSize,
-);
-```
-
-### 参数验证
-
-```typescript
-import {
-  isValidPage,
-  isValidPageSize,
-  isValidPagination,
-} from '@longzai-intelligence/pagination';
-
-if (isValidPagination(params)) {
-  // 参数有效
-}
-
-if (isValidPage(1) && isValidPageSize(20)) {
-  // 页码和页面大小有效
-}
-```
-
-### TypeORM 适配器
-
-TypeORM 适配器通过子路径导出，需要单独导入：
-
-```typescript
-import {
-  paginateWithRepository,
-  paginateWithQueryBuilder,
-} from '@longzai-intelligence/pagination/typeorm';
-
-// 使用 Repository 分页
-const result = await paginateWithRepository(userRepository, {
-  page: 1,
-  pageSize: 20,
-}, {
-  where: { active: true },
-  order: { createdAt: 'DESC' },
-});
-
-// 使用 QueryBuilder 分页
-const qb = userRepository.createQueryBuilder('user');
-const result = await paginateWithQueryBuilder(qb, { page: 1, pageSize: 20 });
-```
-
-**注意**：TypeORM 适配器需要安装 `typeorm` 作为 peerDependency。
-
-## API 文档
-
-### 类型
-
-#### PaginationParams
-
-```typescript
-interface PaginationParams {
-  page?: number;      // 页码，从 1 开始
-  pageSize?: number;  // 每页数量
-}
-```
-
-#### OffsetPaginationParams
-
-```typescript
-interface OffsetPaginationParams {
-  limit?: number;   // 每页数量
-  offset?: number;  // 偏移量
-}
-```
-
-#### PaginatedResult
-
-```typescript
-interface PaginatedResult<T> {
-  items: T[];           // 数据项
-  total: number;        // 总记录数
-  page: number;         // 当前页码
-  pageSize: number;     // 每页数量
-  totalPages: number;   // 总页数
-  hasNextPage: boolean;    // 是否有下一页
-  hasPreviousPage: boolean; // 是否有上一页
-}
-```
-
-#### SortParams
-
-```typescript
-interface SortParams<T extends string = string> {
-  sortBy?: T;                 // 排序字段
-  sortOrder?: 'asc' | 'desc'; // 排序方向
-}
-```
-
-### 常量
-
-#### PAGINATION_DEFAULTS
-
-```typescript
-const PAGINATION_DEFAULTS = {
-  page: 1,
-  pageSize: 20,
-  maxPageSize: 100,
-  minPageSize: 1,
-} as const;
-```
-
-### 工具函数
-
-#### normalizePagination(params?)
-
-规范化分页参数，确保参数在有效范围内。
-
-```typescript
-const { page, pageSize } = normalizePagination({ page: 2, pageSize: 50 });
-```
-
-#### calculateOffset(page, pageSize)
-
-计算偏移量。
-
-```typescript
-const offset = calculateOffset(2, 20); // 20
-```
-
-#### calculateTotalPages(total, pageSize)
-
-计算总页数。
-
-```typescript
-const totalPages = calculateTotalPages(100, 20); // 5
-```
-
-#### hasNextPage(page, totalPages) / hasPreviousPage(page)
-
-判断是否有下一页/上一页。
-
-```typescript
-hasNextPage(1, 5);     // true
-hasPreviousPage(1);    // false
-```
-
-#### offsetToPage(offset, limit) / pageToOffset(page, pageSize)
-
-分页风格转换。
-
-```typescript
-offsetToPage(20, 20);  // { page: 2, pageSize: 20 }
-pageToOffset(2, 20);   // { offset: 20, limit: 20 }
-```
-
-### 验证函数
-
-#### isValidPage(page)
-
-验证页码是否有效（正整数）。
-
-#### isValidPageSize(pageSize)
-
-验证每页数量是否有效（1-100 之间的整数）。
-
-#### isValidOffset(offset)
-
-验证偏移量是否有效（非负整数）。
-
-#### isValidLimit(limit)
-
-验证限制数量是否有效（1-100 之间的整数）。
-
-#### isValidPagination(params)
-
-验证分页参数对象是否有效。
-
-#### isValidOffsetPagination(params)
-
-验证 offset 分页参数对象是否有效。
+- 类型安全的分页参数定义（page/pageSize、limit/offset、cursor）
+- Schema 工厂函数动态创建分页 Schema
+- 预设函数提供场景化分页方案
+- 参数验证工具
+- TypeORM 适配器（可选）
+- Hono 适配器（可选）
+
+## 导出概览
+
+### 主入口 `@longzai-intelligence/pagination`
+
+| 分类 | 导出 |
+|------|------|
+| 参数类型 | `PaginationParams`、`OffsetPaginationParams`、`CursorPaginationParams` |
+| 结果类型 | `PaginatedResult`、`OffsetPaginatedResult`、`CursorPaginatedResult`、`CompactPaginatedResult` |
+| 排序类型 | `SortOrder`、`SortParams`、`MultiSortParams` |
+| Schema 工厂 | `createPaginationSchema`、`createResultSchema` |
+| 预设函数 | `createTablePreset`、`createInfiniteScrollPreset`、`createTimelinePreset`、`createCompactListPreset` |
+| 工具函数 | `normalizePagination`、`calculateOffset`、`createPaginatedResult`、`createPaginationDefaults` |
+| 验证函数 | `isValidPage`、`isValidPageSize`、`isValidPagination` 等 |
+
+### 子路径导出
+
+| 路径 | 说明 |
+|------|------|
+| `@longzai-intelligence/pagination/typeorm` | TypeORM 适配器 |
+| `@longzai-intelligence/pagination/hono` | Hono 适配器 |
+
+## 依赖要求
+
+| 包 | 版本 | 说明 |
+|------|------|------|
+| typeorm | `^0.3.0` | 可选，使用 TypeORM 适配器时需要 |
+| zod | `^4.0.0` | 可选，使用 Schema 功能时需要 |
+| hono | `^4.0.0` | 可选，使用 Hono 适配器时需要 |
 
 ## 许可证
 
-MIT
+UNLICENSED

package/dist/hono.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`zod`);function t(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function n(n,r){let i=r.shape,a={};for(let[r]of Object.entries(i))if(n[r]!==void 0){let o=i[r];o instanceof e.z.ZodNumber||o instanceof e.z.ZodOptional&&o.unwrap()instanceof e.z.ZodNumber?a[r]=t(n[r]):a[r]=n[r]}return r.parse(a)}function r(e,t){let n=e.sortBy,r=e.sortOrder;if(n&&t&&!t.includes(n))return{};if(r&&r!==`asc`&&r!==`desc`)return{sortBy:n};let i={};return n&&(i.sortBy=n),r&&(i.sortOrder=r),i}exports.parsePaginationFromQuery=n,exports.parseSortFromQuery=r;

package/dist/hono.d.cts

@@ -0,0 +1,15 @@
+import { s as SortParams } from "./index-DpbbjAwO.cjs";
+import * as _$zod from "zod";
+import { z } from "zod";
+
+//#region src/adapters/hono/parse-query.d.ts
+declare function parsePaginationFromQuery(query: Record<string, string | undefined>, schema: z.ZodObject<Record<string, z.ZodTypeAny>>): Record<string, unknown>;
+declare function parseSortFromQuery(query: Record<string, string | undefined>, allowedFields?: readonly string[]): SortParams;
+//#endregion
+//#region src/adapters/hono/types.d.ts
+type HonoParseQueryOptions = {
+  paginationSchema?: _$zod.ZodObject<Record<string, _$zod.ZodTypeAny>>;
+  sortFields?: readonly string[];
+};
+//#endregion
+export { type HonoParseQueryOptions, parsePaginationFromQuery, parseSortFromQuery };

package/dist/hono.d.mts

@@ -0,0 +1,15 @@
+import { s as SortParams } from "./index-C4IwIpFc.mjs";
+import * as _$zod from "zod";
+import { z } from "zod";
+
+//#region src/adapters/hono/parse-query.d.ts
+declare function parsePaginationFromQuery(query: Record<string, string | undefined>, schema: z.ZodObject<Record<string, z.ZodTypeAny>>): Record<string, unknown>;
+declare function parseSortFromQuery(query: Record<string, string | undefined>, allowedFields?: readonly string[]): SortParams;
+//#endregion
+//#region src/adapters/hono/types.d.ts
+type HonoParseQueryOptions = {
+  paginationSchema?: _$zod.ZodObject<Record<string, _$zod.ZodTypeAny>>;
+  sortFields?: readonly string[];
+};
+//#endregion
+export { type HonoParseQueryOptions, parsePaginationFromQuery, parseSortFromQuery };

package/dist/hono.mjs

@@ -0,0 +1 @@
+import{z as e}from"zod";function t(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function n(n,r){let i=r.shape,a={};for(let[r]of Object.entries(i))if(n[r]!==void 0){let o=i[r];o instanceof e.ZodNumber||o instanceof e.ZodOptional&&o.unwrap()instanceof e.ZodNumber?a[r]=t(n[r]):a[r]=n[r]}return r.parse(a)}function r(e,t){let n=e.sortBy,r=e.sortOrder;if(n&&t&&!t.includes(n))return{};if(r&&r!==`asc`&&r!==`desc`)return{sortBy:n};let i={};return n&&(i.sortBy=n),r&&(i.sortOrder=r),i}export{n as parsePaginationFromQuery,r as parseSortFromQuery};

package/dist/{index-C8FaNzej.d.mts → index-C4IwIpFc.d.mts}

@@ -23,6 +23,27 @@ declare const CursorPaginationParamsSchema: z.ZodObject<{
   limit: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 type CursorPaginationParams = z.infer<typeof CursorPaginationParamsSchema>;
+type CreatePaginationSchemaOptions = {
+  mode: 'page' | 'offset' | 'cursor';
+  pageSizeField?: string;
+  cursorField?: string;
+  fields?: {
+    page?: boolean;
+    pageSize?: boolean;
+    limit?: boolean;
+    offset?: boolean;
+    cursor?: boolean;
+  };
+};
+declare function createPaginationSchema(options: CreatePaginationSchemaOptions): z.ZodObject<{
+  page: z.ZodOptional<z.ZodNumber>;
+} | {
+  page?: undefined;
+}, z.core.$strip> | z.ZodObject<{
+  limit: z.ZodOptional<z.ZodNumber>;
+} | {
+  limit?: undefined;
+}, z.core.$strip>;
 //#endregion
 //#region src/types/pagination.types.d.ts
 declare const PAGINATION_DEFAULTS: {
@@ -77,6 +98,39 @@ type CursorPaginatedResult<T> = {
   previousCursor: string | null;
   hasMore: boolean;
 };
+type CompactPaginatedResult<T> = {
+  items: T[];
+  total: number;
+  hasMore: boolean;
+};
+declare function createCompactPaginatedResultSchema<T extends z.ZodTypeAny>(itemSchema: T): z.ZodObject<{
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip>;
+type CreateResultSchemaOptions = {
+  mode: 'page' | 'offset' | 'cursor' | 'compact';
+  pageSizeField?: string;
+  metadata?: ('total' | 'totalPages' | 'hasNextPage' | 'hasPreviousPage' | 'hasMore')[];
+};
+declare function createResultSchema<T extends z.ZodTypeAny>(itemSchema: T, options: CreateResultSchemaOptions): z.ZodObject<{
+  [x: string]: z.ZodNumber | z.ZodBoolean | z.ZodArray<T>;
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  totalPages: z.ZodNumber;
+  hasNextPage: z.ZodBoolean;
+  hasPreviousPage: z.ZodBoolean;
+}, z.core.$strip> | z.ZodObject<{
+  items: z.ZodArray<T>;
+  nextCursor: z.ZodNullable<z.ZodString>;
+  previousCursor: z.ZodNullable<z.ZodString>;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip> | z.ZodObject<{
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip>;
 //#endregion
 //#region src/schemas/sort.schemas.d.ts
 declare const SortOrderSchema: z.ZodEnum<{
@@ -142,4 +196,4 @@ declare const MultiSortParamsSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 //#endregion
-export { PaginationDefaults as C, PaginationParamsSchema as E, OffsetPaginationParamsSchema as S, PaginationParams as T, createPaginatedResultSchema as _, SortOrder as a, CursorPaginationParamsSchema as b, SortParamsSchema as c, createSortParamsSchema as d, CursorPaginatedResult as f, createOffsetPaginatedResultSchema as g, createCursorPaginatedResultSchema as h, SortItemSchema as i, createMultiSortParamsSchema as l, PaginatedResult as m, MultiSortParamsSchema as n, SortOrderSchema as o, OffsetPaginatedResult as p, SortItem as r, SortParams as s, MultiSortParams as t, createSortItemSchema as u, PAGINATION_DEFAULTS as v, PaginationDefaultsSchema as w, OffsetPaginationParams as x, CursorPaginationParams as y };
+export { createPaginationSchema as A, CursorPaginationParamsSchema as C, PaginationDefaultsSchema as D, PaginationDefaults as E, PaginationParams as O, CursorPaginationParams as S, OffsetPaginationParamsSchema as T, createCursorPaginatedResultSchema as _, SortOrder as a, createResultSchema as b, SortParamsSchema as c, createSortParamsSchema as d, CompactPaginatedResult as f, createCompactPaginatedResultSchema as g, PaginatedResult as h, SortItemSchema as i, PaginationParamsSchema as k, createMultiSortParamsSchema as l, OffsetPaginatedResult as m, MultiSortParamsSchema as n, SortOrderSchema as o, CursorPaginatedResult as p, SortItem as r, SortParams as s, MultiSortParams as t, createSortItemSchema as u, createOffsetPaginatedResultSchema as v, OffsetPaginationParams as w, PAGINATION_DEFAULTS as x, createPaginatedResultSchema as y };

package/dist/{index-CMiyhlfm.d.cts → index-DpbbjAwO.d.cts}

@@ -23,6 +23,27 @@ declare const CursorPaginationParamsSchema: z.ZodObject<{
   limit: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 type CursorPaginationParams = z.infer<typeof CursorPaginationParamsSchema>;
+type CreatePaginationSchemaOptions = {
+  mode: 'page' | 'offset' | 'cursor';
+  pageSizeField?: string;
+  cursorField?: string;
+  fields?: {
+    page?: boolean;
+    pageSize?: boolean;
+    limit?: boolean;
+    offset?: boolean;
+    cursor?: boolean;
+  };
+};
+declare function createPaginationSchema(options: CreatePaginationSchemaOptions): z.ZodObject<{
+  page: z.ZodOptional<z.ZodNumber>;
+} | {
+  page?: undefined;
+}, z.core.$strip> | z.ZodObject<{
+  limit: z.ZodOptional<z.ZodNumber>;
+} | {
+  limit?: undefined;
+}, z.core.$strip>;
 //#endregion
 //#region src/types/pagination.types.d.ts
 declare const PAGINATION_DEFAULTS: {
@@ -77,6 +98,39 @@ type CursorPaginatedResult<T> = {
   previousCursor: string | null;
   hasMore: boolean;
 };
+type CompactPaginatedResult<T> = {
+  items: T[];
+  total: number;
+  hasMore: boolean;
+};
+declare function createCompactPaginatedResultSchema<T extends z.ZodTypeAny>(itemSchema: T): z.ZodObject<{
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip>;
+type CreateResultSchemaOptions = {
+  mode: 'page' | 'offset' | 'cursor' | 'compact';
+  pageSizeField?: string;
+  metadata?: ('total' | 'totalPages' | 'hasNextPage' | 'hasPreviousPage' | 'hasMore')[];
+};
+declare function createResultSchema<T extends z.ZodTypeAny>(itemSchema: T, options: CreateResultSchemaOptions): z.ZodObject<{
+  [x: string]: z.ZodNumber | z.ZodBoolean | z.ZodArray<T>;
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  totalPages: z.ZodNumber;
+  hasNextPage: z.ZodBoolean;
+  hasPreviousPage: z.ZodBoolean;
+}, z.core.$strip> | z.ZodObject<{
+  items: z.ZodArray<T>;
+  nextCursor: z.ZodNullable<z.ZodString>;
+  previousCursor: z.ZodNullable<z.ZodString>;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip> | z.ZodObject<{
+  items: z.ZodArray<T>;
+  total: z.ZodNumber;
+  hasMore: z.ZodBoolean;
+}, z.core.$strip>;
 //#endregion
 //#region src/schemas/sort.schemas.d.ts
 declare const SortOrderSchema: z.ZodEnum<{
@@ -142,4 +196,4 @@ declare const MultiSortParamsSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 //#endregion
-export { PaginationDefaults as C, PaginationParamsSchema as E, OffsetPaginationParamsSchema as S, PaginationParams as T, createPaginatedResultSchema as _, SortOrder as a, CursorPaginationParamsSchema as b, SortParamsSchema as c, createSortParamsSchema as d, CursorPaginatedResult as f, createOffsetPaginatedResultSchema as g, createCursorPaginatedResultSchema as h, SortItemSchema as i, createMultiSortParamsSchema as l, PaginatedResult as m, MultiSortParamsSchema as n, SortOrderSchema as o, OffsetPaginatedResult as p, SortItem as r, SortParams as s, MultiSortParams as t, createSortItemSchema as u, PAGINATION_DEFAULTS as v, PaginationDefaultsSchema as w, OffsetPaginationParams as x, CursorPaginationParams as y };
+export { createPaginationSchema as A, CursorPaginationParamsSchema as C, PaginationDefaultsSchema as D, PaginationDefaults as E, PaginationParams as O, CursorPaginationParams as S, OffsetPaginationParamsSchema as T, createCursorPaginatedResultSchema as _, SortOrder as a, createResultSchema as b, SortParamsSchema as c, createSortParamsSchema as d, CompactPaginatedResult as f, createCompactPaginatedResultSchema as g, PaginatedResult as h, SortItemSchema as i, PaginationParamsSchema as k, createMultiSortParamsSchema as l, OffsetPaginatedResult as m, MultiSortParamsSchema as n, SortOrderSchema as o, CursorPaginatedResult as p, SortItem as r, SortParams as s, MultiSortParams as t, createSortItemSchema as u, createOffsetPaginatedResultSchema as v, OffsetPaginationParams as w, PAGINATION_DEFAULTS as x, createPaginatedResultSchema as y };

package/dist/index.cjs

@@ -1,33 +1 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_utils = require('./utils-DazsDMMu.cjs');
-
-exports.CursorPaginationParamsSchema = require_utils.CursorPaginationParamsSchema;
-exports.MultiSortParamsSchema = require_utils.MultiSortParamsSchema;
-exports.OffsetPaginationParamsSchema = require_utils.OffsetPaginationParamsSchema;
-exports.PAGINATION_DEFAULTS = require_utils.PAGINATION_DEFAULTS;
-exports.PaginationDefaultsSchema = require_utils.PaginationDefaultsSchema;
-exports.PaginationParamsSchema = require_utils.PaginationParamsSchema;
-exports.SortItemSchema = require_utils.SortItemSchema;
-exports.SortOrderSchema = require_utils.SortOrderSchema;
-exports.SortParamsSchema = require_utils.SortParamsSchema;
-exports.calculateOffset = require_utils.calculateOffset;
-exports.calculateTotalPages = require_utils.calculateTotalPages;
-exports.createCursorPaginatedResultSchema = require_utils.createCursorPaginatedResultSchema;
-exports.createMultiSortParamsSchema = require_utils.createMultiSortParamsSchema;
-exports.createOffsetPaginatedResultSchema = require_utils.createOffsetPaginatedResultSchema;
-exports.createPaginatedResult = require_utils.createPaginatedResult;
-exports.createPaginatedResultSchema = require_utils.createPaginatedResultSchema;
-exports.createSortItemSchema = require_utils.createSortItemSchema;
-exports.createSortParamsSchema = require_utils.createSortParamsSchema;
-exports.hasNextPage = require_utils.hasNextPage;
-exports.hasPreviousPage = require_utils.hasPreviousPage;
-exports.isValidLimit = require_utils.isValidLimit;
-exports.isValidOffset = require_utils.isValidOffset;
-exports.isValidOffsetPagination = require_utils.isValidOffsetPagination;
-exports.isValidPage = require_utils.isValidPage;
-exports.isValidPageSize = require_utils.isValidPageSize;
-exports.isValidPagination = require_utils.isValidPagination;
-exports.normalizeOffsetPagination = require_utils.normalizeOffsetPagination;
-exports.normalizePagination = require_utils.normalizePagination;
-exports.offsetToPage = require_utils.offsetToPage;
-exports.pageToOffset = require_utils.pageToOffset;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./utils-B200OLT-.cjs`);let t=require(`zod`);function n(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function r(r){let i=r?.pageSizeField??`pageSize`,a=e.u({pageSize:r?.defaultPageSize,maxPageSize:r?.maxPageSize}),o=e.P({mode:`page`,pageSizeField:i}),s=r?.sortFields?e.C([...r.sortFields]):t.z.object({}),c=o.merge(s).extend(r?.businessFields??{});return{querySchema:c,resultSchema:e.O(t.z.unknown(),{mode:`page`,pageSizeField:i}),defaults:a,normalize(e){return a.normalize({page:e?.page,pageSize:e?.[i]})},parseQuery(e){let t={};if(e.page!==void 0&&(t.page=n(e.page)),e[i]!==void 0&&(t[i]=n(e[i])),e.sortBy!==void 0&&(t.sortBy=e.sortBy),e.sortOrder!==void 0&&(t.sortOrder=e.sortOrder),r?.businessFields)for(let n of Object.keys(r.businessFields))e[n]!==void 0&&(t[n]=e[n]);return c.parse(t)},buildResult(t,n,r,i){return e.l(t,n,r,i)}}}function i(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function a(n){let r=n?.cursorField??`cursor`,a=e.P({mode:`cursor`,cursorField:r}).extend(n?.businessFields??{});return{querySchema:a,resultSchema:e.O(t.z.unknown(),{mode:`cursor`}),parseQuery(e){let t={};if(e[r]!==void 0&&(t[r]=e[r]),e.limit!==void 0&&(t.limit=i(e.limit)),n?.businessFields)for(let r of Object.keys(n.businessFields))e[r]!==void 0&&(t[r]=e[r]);return a.parse(t)},buildResult(e,t,n){return{items:e,nextCursor:t,previousCursor:null,hasMore:n}}}}function o(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function s(n){let r=e.P({mode:`offset`,fields:{limit:!0,offset:!1}}).extend(n?.businessFields??{});return{querySchema:r,resultSchema:e.O(t.z.unknown(),{mode:`compact`}),parseQuery(e){let t={};if(e.limit!==void 0&&(t.limit=o(e.limit)),n?.businessFields)for(let r of Object.keys(n.businessFields))e[r]!==void 0&&(t[r]=e[r]);return r.parse(t)},buildResult(e,t,n){return{items:e,total:t,hasMore:n}}}}function c(e){if(e===void 0)return;let t=Number(e);return Number.isNaN(t)?void 0:t}function l(n){let r=n?.mode??`page`,i=n?.pageSizeField??`pageSize`,a=e.P({mode:r,pageSizeField:i}).extend(n?.businessFields??{});return{querySchema:a,resultSchema:e.O(t.z.unknown(),{mode:`compact`}),parseQuery(e){let t={};if(r===`page`?(e.page!==void 0&&(t.page=c(e.page)),e[i]!==void 0&&(t[i]=c(e[i]))):(e.limit!==void 0&&(t.limit=c(e.limit)),e.offset!==void 0&&(t.offset=c(e.offset))),n?.businessFields)for(let r of Object.keys(n.businessFields))e[r]!==void 0&&(t[r]=e[r]);return a.parse(t)},buildResult(e,t,n){return{items:e,total:t,hasMore:n}}}}exports.CursorPaginationParamsSchema=e.A,exports.MultiSortParamsSchema=e._,exports.OffsetPaginationParamsSchema=e.j,exports.PAGINATION_DEFAULTS=e.k,exports.PaginationDefaultsSchema=e.M,exports.PaginationParamsSchema=e.N,exports.SortItemSchema=e.v,exports.SortOrderSchema=e.y,exports.SortParamsSchema=e.b,exports.calculateOffset=e.s,exports.calculateTotalPages=e.c,exports.createCompactListPreset=l,exports.createCompactPaginatedResultSchema=e.w,exports.createCursorPaginatedResultSchema=e.T,exports.createInfiniteScrollPreset=a,exports.createMultiSortParamsSchema=e.x,exports.createOffsetPaginatedResultSchema=e.E,exports.createPaginatedResult=e.l,exports.createPaginatedResultSchema=e.D,exports.createPaginationDefaults=e.u,exports.createPaginationSchema=e.P,exports.createResultSchema=e.O,exports.createSortItemSchema=e.S,exports.createSortParamsSchema=e.C,exports.createTablePreset=r,exports.createTimelinePreset=s,exports.hasNextPage=e.d,exports.hasPreviousPage=e.f,exports.isValidLimit=e.t,exports.isValidOffset=e.n,exports.isValidOffsetPagination=e.r,exports.isValidPage=e.i,exports.isValidPageSize=e.a,exports.isValidPagination=e.o,exports.normalizeOffsetPagination=e.p,exports.normalizePagination=e.m,exports.offsetToPage=e.h,exports.pageToOffset=e.g;

package/dist/index.d.cts

@@ -1,4 +1,6 @@
-import { C as PaginationDefaults, E as PaginationParamsSchema, S as OffsetPaginationParamsSchema, T as PaginationParams, _ as createPaginatedResultSchema, a as SortOrder, b as CursorPaginationParamsSchema, c as SortParamsSchema, d as createSortParamsSchema, f as CursorPaginatedResult, g as createOffsetPaginatedResultSchema, h as createCursorPaginatedResultSchema, i as SortItemSchema, l as createMultiSortParamsSchema, m as PaginatedResult, n as MultiSortParamsSchema, o as SortOrderSchema, p as OffsetPaginatedResult, r as SortItem, s as SortParams, t as MultiSortParams, u as createSortItemSchema, v as PAGINATION_DEFAULTS, w as PaginationDefaultsSchema, x as OffsetPaginationParams, y as CursorPaginationParams } from "./index-CMiyhlfm.cjs";
+import { A as createPaginationSchema, C as CursorPaginationParamsSchema, D as PaginationDefaultsSchema, E as PaginationDefaults, O as PaginationParams, S as CursorPaginationParams, T as OffsetPaginationParamsSchema, _ as createCursorPaginatedResultSchema, a as SortOrder, b as createResultSchema, c as SortParamsSchema, d as createSortParamsSchema, f as CompactPaginatedResult, g as createCompactPaginatedResultSchema, h as PaginatedResult, i as SortItemSchema, k as PaginationParamsSchema, l as createMultiSortParamsSchema, m as OffsetPaginatedResult, n as MultiSortParamsSchema, o as SortOrderSchema, p as CursorPaginatedResult, r as SortItem, s as SortParams, t as MultiSortParams, u as createSortItemSchema, v as createOffsetPaginatedResultSchema, w as OffsetPaginationParams, x as PAGINATION_DEFAULTS, y as createPaginatedResultSchema } from "./index-DpbbjAwO.cjs";
+import * as _$zod from "zod";
+import { z } from "zod";
 
 //#region src/utils/pagination.util.d.ts
 type OffsetPaginationResult = {
@@ -18,6 +20,20 @@ declare function hasPreviousPage(page: number): boolean;
 declare function offsetToPage(offset: number, limit: number): OffsetPaginationResult;
 declare function pageToOffset(page: number, pageSize: number): PagePaginationResult;
 declare function createPaginatedResult<T>(items: T[], total: number, page: number, pageSize: number): PaginatedResult<T>;
+type PaginationDefaultsOverrides = {
+  page?: number;
+  pageSize?: number;
+  maxPageSize?: number;
+  minPageSize?: number;
+};
+declare function createPaginationDefaults(overrides?: PaginationDefaultsOverrides): {
+  normalize(params?: PaginationParams): Required<PaginationParams>;
+  normalizeOffset(params?: OffsetPaginationParams): Required<OffsetPaginationParams>;
+  page: number;
+  pageSize: number;
+  maxPageSize: number;
+  minPageSize: number;
+};
 //#endregion
 //#region src/utils/validation.util.d.ts
 type PaginationValidationResult = {
@@ -35,4 +51,66 @@ declare function isValidLimit(limit: unknown): limit is number;
 declare function isValidPagination(params: unknown): params is PaginationValidationResult;
 declare function isValidOffsetPagination(params: unknown): params is OffsetPaginationValidationResult;
 //#endregion
-export { type CursorPaginatedResult, type CursorPaginationParams, CursorPaginationParamsSchema, type MultiSortParams, MultiSortParamsSchema, type OffsetPaginatedResult, type OffsetPaginationParams, OffsetPaginationParamsSchema, type OffsetPaginationResult, type OffsetPaginationValidationResult, PAGINATION_DEFAULTS, type PagePaginationResult, type PaginatedResult, type PaginationDefaults, PaginationDefaultsSchema, type PaginationParams, PaginationParamsSchema, type PaginationValidationResult, type SortItem, SortItemSchema, type SortOrder, SortOrderSchema, type SortParams, SortParamsSchema, calculateOffset, calculateTotalPages, createCursorPaginatedResultSchema, createMultiSortParamsSchema, createOffsetPaginatedResultSchema, createPaginatedResult, createPaginatedResultSchema, createSortItemSchema, createSortParamsSchema, hasNextPage, hasPreviousPage, isValidLimit, isValidOffset, isValidOffsetPagination, isValidPage, isValidPageSize, isValidPagination, normalizeOffsetPagination, normalizePagination, offsetToPage, pageToOffset };
+//#region src/presets/types.d.ts
+type PaginationPreset<Q, R> = {
+  querySchema: _$zod.ZodTypeAny;
+  resultSchema: _$zod.ZodTypeAny;
+  parseQuery(query: Record<string, string | undefined>): Q;
+  buildResult(...args: unknown[]): R;
+};
+type TablePresetConfig = {
+  pageSizeField?: 'pageSize' | 'limit';
+  defaultPageSize?: number;
+  maxPageSize?: number;
+  sortFields?: readonly [string, ...string[]];
+  businessFields?: Record<string, _$zod.ZodTypeAny>;
+};
+type TablePreset<Q = Record<string, unknown>> = PaginationPreset<Q, PaginatedResult<unknown>> & {
+  defaults: ReturnType<typeof createPaginationDefaults>;
+  normalize(params?: Record<string, unknown>): {
+    page: number;
+    pageSize: number;
+  };
+};
+type InfiniteScrollPresetConfig = {
+  cursorField?: string;
+  defaultPageSize?: number;
+  businessFields?: Record<string, _$zod.ZodTypeAny>;
+};
+type InfiniteScrollPreset<Q = Record<string, unknown>> = PaginationPreset<Q, CursorPaginatedResult<unknown>>;
+type TimelinePresetConfig = {
+  defaultLimit?: number;
+  maxLimit?: number;
+  businessFields?: Record<string, _$zod.ZodTypeAny>;
+};
+type TimelinePreset<Q = Record<string, unknown>> = PaginationPreset<Q, CompactPaginatedResult<unknown>>;
+type CompactListPresetConfig = {
+  mode?: 'page' | 'offset';
+  pageSizeField?: string;
+  defaultPageSize?: number;
+  businessFields?: Record<string, _$zod.ZodTypeAny>;
+};
+type CompactListPreset<Q = Record<string, unknown>> = PaginationPreset<Q, CompactPaginatedResult<unknown>>;
+//#endregion
+//#region src/presets/table.preset.d.ts
+declare function createTablePreset<TSort extends readonly [string, ...string[]], TBusiness extends Record<string, z.ZodTypeAny>>(config?: TablePresetConfig & {
+  sortFields?: TSort;
+  businessFields?: TBusiness;
+}): TablePreset;
+//#endregion
+//#region src/presets/infinite-scroll.preset.d.ts
+declare function createInfiniteScrollPreset<TBusiness extends Record<string, z.ZodTypeAny>>(config?: InfiniteScrollPresetConfig & {
+  businessFields?: TBusiness;
+}): InfiniteScrollPreset;
+//#endregion
+//#region src/presets/timeline.preset.d.ts
+declare function createTimelinePreset<TBusiness extends Record<string, z.ZodTypeAny>>(config?: TimelinePresetConfig & {
+  businessFields?: TBusiness;
+}): TimelinePreset;
+//#endregion
+//#region src/presets/compact-list.preset.d.ts
+declare function createCompactListPreset<TBusiness extends Record<string, z.ZodTypeAny>>(config?: CompactListPresetConfig & {
+  businessFields?: TBusiness;
+}): CompactListPreset;
+//#endregion
+export { type CompactListPreset, type CompactListPresetConfig, type CompactPaginatedResult, type CursorPaginatedResult, type CursorPaginationParams, CursorPaginationParamsSchema, type InfiniteScrollPreset, type InfiniteScrollPresetConfig, type MultiSortParams, MultiSortParamsSchema, type OffsetPaginatedResult, type OffsetPaginationParams, OffsetPaginationParamsSchema, type OffsetPaginationResult, type OffsetPaginationValidationResult, PAGINATION_DEFAULTS, type PagePaginationResult, type PaginatedResult, type PaginationDefaults, PaginationDefaultsSchema, type PaginationParams, PaginationParamsSchema, type PaginationPreset, type PaginationValidationResult, type SortItem, SortItemSchema, type SortOrder, SortOrderSchema, type SortParams, SortParamsSchema, type TablePreset, type TablePresetConfig, type TimelinePreset, type TimelinePresetConfig, calculateOffset, calculateTotalPages, createCompactListPreset, createCompactPaginatedResultSchema, createCursorPaginatedResultSchema, createInfiniteScrollPreset, createMultiSortParamsSchema, createOffsetPaginatedResultSchema, createPaginatedResult, createPaginatedResultSchema, createPaginationDefaults, createPaginationSchema, createResultSchema, createSortItemSchema, createSortParamsSchema, createTablePreset, createTimelinePreset, hasNextPage, hasPreviousPage, isValidLimit, isValidOffset, isValidOffsetPagination, isValidPage, isValidPageSize, isValidPagination, normalizeOffsetPagination, normalizePagination, offsetToPage, pageToOffset };