@longzai-intelligence/pagination 0.0.1 → 0.0.2

package/src/schemas/sort.schemas.ts

@@ -0,0 +1,153 @@
+/**
+ * 排序参数 Zod Schema 定义
+ */
+
+import { z } from 'zod';
+
+/**
+ * 排序方向 Schema
+ */
+export const SortOrderSchema = z.enum(['asc', 'desc']);
+
+/**
+ * 排序方向类型
+ */
+export type SortOrder = z.infer<typeof SortOrderSchema>;
+
+/**
+ * 排序参数类型
+ */
+export type SortParams<T extends string = string> = {
+  /**
+   * 排序字段
+   */
+  sortBy?: T;
+
+  /**
+   * 排序方向
+   */
+  sortOrder?: SortOrder;
+};
+
+/**
+ * 创建排序参数 Schema
+ *
+ * 单字段排序参数
+ *
+ * @typeParam T - 排序字段枚举类型
+ */
+export function createSortParamsSchema<T extends [string, ...string[]]>(fields: T) {
+  return z.object({
+    /**
+     * 排序字段
+     */
+    sortBy: z.enum(fields).optional(),
+
+    /**
+     * 排序方向
+     */
+    sortOrder: SortOrderSchema.optional(),
+  });
+}
+
+/**
+ * 默认排序参数 Schema（字符串字段）
+ */
+export const SortParamsSchema = z.object({
+  /**
+   * 排序字段
+   */
+  sortBy: z.string().optional(),
+
+  /**
+   * 排序方向
+   */
+  sortOrder: SortOrderSchema.optional(),
+});
+
+/**
+ * 多字段排序项类型
+ */
+export type SortItem<T extends string = string> = {
+  /**
+   * 排序字段
+   */
+  field: T;
+
+  /**
+   * 排序方向
+   */
+  order: SortOrder;
+};
+
+/**
+ * 创建多字段排序项 Schema
+ *
+ * 单个排序项定义
+ *
+ * @typeParam T - 排序字段枚举类型
+ */
+export function createSortItemSchema<T extends [string, ...string[]]>(fields: T) {
+  return z.object({
+    /**
+     * 排序字段
+     */
+    field: z.enum(fields),
+
+    /**
+     * 排序方向
+     */
+    order: SortOrderSchema,
+  });
+}
+
+/**
+ * 默认排序项 Schema（字符串字段）
+ */
+export const SortItemSchema = z.object({
+  /**
+   * 排序字段
+   */
+  field: z.string(),
+
+  /**
+   * 排序方向
+   */
+  order: SortOrderSchema,
+});
+
+/**
+ * 多字段排序参数类型
+ */
+export type MultiSortParams<T extends string = string> = {
+  /**
+   * 排序项数组
+   */
+  sort?: SortItem<T>[];
+};
+
+/**
+ * 创建多字段排序参数 Schema
+ *
+ * 支持多个字段的排序
+ *
+ * @typeParam T - 排序字段枚举类型
+ */
+export function createMultiSortParamsSchema<T extends [string, ...string[]]>(fields: T) {
+  return z.object({
+    /**
+     * 排序项数组
+     */
+    sort: z.array(createSortItemSchema(fields)).optional(),
+  });
+}
+
+/**
+ * 默认多字段排序参数 Schema（字符串字段）
+ */
+export const MultiSortParamsSchema = z.object({
+  /**
+   * 排序项数组
+   */
+  sort: z.array(SortItemSchema).optional(),
+});

package/src/typeorm.ts

@@ -0,0 +1,23 @@
+/**
+ * TypeORM 适配器入口
+ *
+ * 提供 TypeORM 分页查询功能，需要安装 typeorm 作为 peerDependency。
+ *
+ * @example
+ * ```typescript
+ * import { paginateWithRepository } from '@longzai-intelligence/pagination/typeorm';
+ *
+ * const result = await paginateWithRepository(userRepository, {
+ *   page: 1,
+ *   pageSize: 20,
+ * });
+ * ```
+ */
+
+export type { EntityMapper, TypeOrmPaginateOptions } from './adapters/typeorm';
+
+export {
+  paginateWithRepository,
+  paginateWithQueryBuilder,
+  createPaginationQueryBuilder,
+} from './adapters/typeorm';

package/src/types/index.ts

@@ -9,8 +9,30 @@ export type {
   PaginationDefaults,
 } from './pagination.types';
 
-export { PAGINATION_DEFAULTS } from './pagination.types';
+export {
+  PAGINATION_DEFAULTS,
+  PaginationDefaultsSchema,
+  PaginationParamsSchema,
+  OffsetPaginationParamsSchema,
+  CursorPaginationParamsSchema,
+} from './pagination.types';
 
 export type { PaginatedResult, OffsetPaginatedResult, CursorPaginatedResult } from './result.types';
 
+export {
+  createPaginatedResultSchema,
+  createOffsetPaginatedResultSchema,
+  createCursorPaginatedResultSchema,
+} from './result.types';
+
 export type { SortOrder, SortParams, SortItem, MultiSortParams } from './sort.types';
+
+export {
+  SortOrderSchema,
+  SortParamsSchema,
+  SortItemSchema,
+  MultiSortParamsSchema,
+  createSortParamsSchema,
+  createSortItemSchema,
+  createMultiSortParamsSchema,
+} from './sort.types';

package/src/types/pagination.types.ts

@@ -1,60 +1,24 @@
 /**
  * 分页参数类型定义
- */
-
-/**
- * 分页参数（page 风格，推荐使用）
- *
- * 适用于用户界面分页场景
- */
-export type PaginationParams = {
-  /**
-   * 页码（从 1 开始）
-   */
-  page?: number;
-
-  /**
-   * 每页数量
-   */
-  pageSize?: number;
-};
-
-/**
- * 分页参数（offset 风格）
  *
- * 适用于 API 调用、数据库查询等场景
+ * 类型从 zod schemas 推导导出
  */
-export type OffsetPaginationParams = {
-  /**
-   * 限制数量
-   */
-  limit?: number;
 
-  /**
-   * 偏移量
-   */
-  offset?: number;
-};
+export {
+  PaginationDefaultsSchema,
+  PaginationParamsSchema,
+  OffsetPaginationParamsSchema,
+  CursorPaginationParamsSchema,
+  type PaginationDefaults,
+  type PaginationParams,
+  type OffsetPaginationParams,
+  type CursorPaginationParams,
+} from '../schemas/pagination.schemas';
 
 /**
- * 游标分页参数
+ * 默认分页配置值
  *
- * 适用于无限滚动、实时数据流场景
- */
-export type CursorPaginationParams = {
-  /**
-   * 游标
-   */
-  cursor?: string;
-
-  /**
-   * 限制数量
-   */
-  limit?: number;
-};
-
-/**
- * 默认分页配置
+ * 用于运行时验证和默认值设置
  */
 export const PAGINATION_DEFAULTS = {
   page: 1,
@@ -62,8 +26,3 @@ export const PAGINATION_DEFAULTS = {
   maxPageSize: 100,
   minPageSize: 1,
 } as const;
-
-/**
- * 默认分页参数类型
- */
-export type PaginationDefaults = typeof PAGINATION_DEFAULTS;

package/src/types/result.types.ts

@@ -1,110 +1,14 @@
 /**
  * 分页结果类型定义
- */
-
-/**
- * 分页结果
- *
- * 包含分页数据和分页信息的完整结果
- *
- * @typeParam T - 数据项类型
- */
-export type PaginatedResult<T> = {
-  /**
-   * 数据项数组
-   */
-  items: T[];
-
-  /**
-   * 总记录数
-   */
-  total: number;
-
-  /**
-   * 当前页码
-   */
-  page: number;
-
-  /**
-   * 每页数量
-   */
-  pageSize: number;
-
-  /**
-   * 总页数
-   */
-  totalPages: number;
-
-  /**
-   * 是否有下一页
-   */
-  hasNextPage: boolean;
-
-  /**
-   * 是否有上一页
-   */
-  hasPreviousPage: boolean;
-};
-
-/**
- * Offset 风格分页结果
- *
- * 包含偏移量分页数据和分页信息
  *
- * @typeParam T - 数据项类型
+ * 类型从 zod schemas 推导导出
  */
-export type OffsetPaginatedResult<T> = {
-  /**
-   * 数据项数组
-   */
-  items: T[];
-
-  /**
-   * 总记录数
-   */
-  total: number;
-
-  /**
-   * 限制数量
-   */
-  limit: number;
-
-  /**
-   * 偏移量
-   */
-  offset: number;
-
-  /**
-   * 是否有更多数据
-   */
-  hasMore: boolean;
-};
-
-/**
- * 游标分页结果
- *
- * 包含游标分页数据和分页信息
- *
- * @typeParam T - 数据项类型
- */
-export type CursorPaginatedResult<T> = {
-  /**
-   * 数据项数组
-   */
-  items: T[];
-
-  /**
-   * 下一页游标
-   */
-  nextCursor: string | null;
-
-  /**
-   * 上一页游标
-   */
-  previousCursor: string | null;
 
-  /**
-   * 是否有更多数据
-   */
-  hasMore: boolean;
-};
+export {
+  createPaginatedResultSchema,
+  createOffsetPaginatedResultSchema,
+  createCursorPaginatedResultSchema,
+  type PaginatedResult,
+  type OffsetPaginatedResult,
+  type CursorPaginatedResult,
+} from '../schemas/result.schemas';

package/src/types/sort.types.ts

@@ -1,60 +1,19 @@
 /**
  * 排序类型定义
- */
-
-/**
- * 排序方向
- */
-export type SortOrder = 'asc' | 'desc';
-
-/**
- * 排序参数
- *
- * 单字段排序参数
- *
- * @typeParam T - 排序字段类型
- */
-export type SortParams<T extends string = string> = {
-  /**
-   * 排序字段
-   */
-  sortBy?: T;
-
-  /**
-   * 排序方向
-   */
-  sortOrder?: SortOrder;
-};
-
-/**
- * 多字段排序项
  *
- * 单个排序项定义
- *
- * @typeParam T - 排序字段类型
+ * 类型从 zod schemas 推导导出
  */
-export type SortItem<T extends string = string> = {
-  /**
-   * 排序字段
-   */
-  field: T;
-
-  /**
-   * 排序方向
-   */
-  order: SortOrder;
-};
 
-/**
- * 多字段排序参数
- *
- * 支持多个字段的排序
- *
- * @typeParam T - 排序字段类型
- */
-export type MultiSortParams<T extends string = string> = {
-  /**
-   * 排序项数组
-   */
-  sort?: SortItem<T>[];
-};
+export {
+  SortOrderSchema,
+  SortParamsSchema,
+  SortItemSchema,
+  MultiSortParamsSchema,
+  createSortParamsSchema,
+  createSortItemSchema,
+  createMultiSortParamsSchema,
+  type SortOrder,
+  type SortParams,
+  type SortItem,
+  type MultiSortParams,
+} from '../schemas/sort.schemas';