@longzai-intelligence/pagination 0.0.2 → 0.0.3

package/src/types/index.ts

@@ -1,38 +0,0 @@
-/**
- * 类型导出入口
- */
-
-export type {
-  PaginationParams,
-  OffsetPaginationParams,
-  CursorPaginationParams,
-  PaginationDefaults,
-} 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,28 +0,0 @@
-/**
- * 分页参数类型定义
- *
- * 类型从 zod schemas 推导导出
- */
-
-export {
-  PaginationDefaultsSchema,
-  PaginationParamsSchema,
-  OffsetPaginationParamsSchema,
-  CursorPaginationParamsSchema,
-  type PaginationDefaults,
-  type PaginationParams,
-  type OffsetPaginationParams,
-  type CursorPaginationParams,
-} from '../schemas/pagination.schemas';
-
-/**
- * 默认分页配置值
- *
- * 用于运行时验证和默认值设置
- */
-export const PAGINATION_DEFAULTS = {
-  page: 1,
-  pageSize: 20,
-  maxPageSize: 100,
-  minPageSize: 1,
-} as const;

package/src/types/result.types.ts

@@ -1,14 +0,0 @@
-/**
- * 分页结果类型定义
- *
- * 类型从 zod schemas 推导导出
- */
-
-export {
-  createPaginatedResultSchema,
-  createOffsetPaginatedResultSchema,
-  createCursorPaginatedResultSchema,
-  type PaginatedResult,
-  type OffsetPaginatedResult,
-  type CursorPaginatedResult,
-} from '../schemas/result.schemas';

package/src/types/sort.types.ts

@@ -1,19 +0,0 @@
-/**
- * 排序类型定义
- *
- * 类型从 zod schemas 推导导出
- */
-
-export {
-  SortOrderSchema,
-  SortParamsSchema,
-  SortItemSchema,
-  MultiSortParamsSchema,
-  createSortParamsSchema,
-  createSortItemSchema,
-  createMultiSortParamsSchema,
-  type SortOrder,
-  type SortParams,
-  type SortItem,
-  type MultiSortParams,
-} from '../schemas/sort.schemas';

package/src/utils/index.ts

@@ -1,31 +0,0 @@
-/**
- * 工具函数导出入口
- */
-
-export type { OffsetPaginationResult, PagePaginationResult } from './pagination.util';
-
-export type {
-  PaginationValidationResult,
-  OffsetPaginationValidationResult,
-} from './validation.util';
-
-export {
-  normalizePagination,
-  normalizeOffsetPagination,
-  calculateOffset,
-  calculateTotalPages,
-  hasNextPage,
-  hasPreviousPage,
-  offsetToPage,
-  pageToOffset,
-  createPaginatedResult,
-} from './pagination.util';
-
-export {
-  isValidPage,
-  isValidPageSize,
-  isValidOffset,
-  isValidLimit,
-  isValidPagination,
-  isValidOffsetPagination,
-} from './validation.util';

package/src/utils/pagination.util.ts

@@ -1,206 +0,0 @@
-/**
- * 分页计算工具函数
- */
-
-import { PAGINATION_DEFAULTS, type PaginationParams, type OffsetPaginationParams } from '../types';
-
-/**
- * Offset 风格分页参数
- */
-export type OffsetPaginationResult = {
-  /**
-   * 页码
-   */
-  page: number;
-
-  /**
-   * 每页数量
-   */
-  pageSize: number;
-};
-
-/**
- * Page 风格分页参数
- */
-export type PagePaginationResult = {
-  /**
-   * 偏移量
-   */
-  offset: number;
-
-  /**
-   * 限制数量
-   */
-  limit: number;
-};
-
-/**
- * 规范化分页参数
- * 确保参数在有效范围内
- *
- * @param params - 原始分页参数
- * @returns 规范化后的分页参数
- */
-export function normalizePagination(params?: PaginationParams): Required<PaginationParams> {
-  /**
-   * 规范化后的页码
-   */
-  const page = Math.max(1, Math.floor(params?.page ?? PAGINATION_DEFAULTS.page));
-
-  /**
-   * 规范化后的每页数量
-   */
-  const pageSize = Math.min(
-    PAGINATION_DEFAULTS.maxPageSize,
-    Math.max(
-      PAGINATION_DEFAULTS.minPageSize,
-      Math.floor(params?.pageSize ?? PAGINATION_DEFAULTS.pageSize),
-    ),
-  );
-  return { page, pageSize };
-}
-
-/**
- * 规范化 offset 分页参数
- *
- * @param params - 原始 offset 分页参数
- * @returns 规范化后的 offset 分页参数
- */
-export function normalizeOffsetPagination(
-  params?: OffsetPaginationParams,
-): Required<OffsetPaginationParams> {
-  /**
-   * 规范化后的限制数量
-   */
-  const limit = Math.min(
-    PAGINATION_DEFAULTS.maxPageSize,
-    Math.max(
-      PAGINATION_DEFAULTS.minPageSize,
-      Math.floor(params?.limit ?? PAGINATION_DEFAULTS.pageSize),
-    ),
-  );
-
-  /**
-   * 规范化后的偏移量
-   */
-  const offset = Math.max(0, Math.floor(params?.offset ?? 0));
-  return { limit, offset };
-}
-
-/**
- * 计算偏移量
- *
- * @param page - 页码（从 1 开始）
- * @param pageSize - 每页数量
- * @returns 偏移量
- */
-export function calculateOffset(page: number, pageSize: number): number {
-  return (page - 1) * pageSize;
-}
-
-/**
- * 计算总页数
- *
- * @param total - 总记录数
- * @param pageSize - 每页数量
- * @returns 总页数
- */
-export function calculateTotalPages(total: number, pageSize: number): number {
-  if (pageSize <= 0) {
-    return 0;
-  }
-  return Math.ceil(total / pageSize);
-}
-
-/**
- * 判断是否有下一页
- *
- * @param page - 当前页码
- * @param totalPages - 总页数
- * @returns 是否有下一页
- */
-export function hasNextPage(page: number, totalPages: number): boolean {
-  return page < totalPages;
-}
-
-/**
- * 判断是否有上一页
- *
- * @param page - 当前页码
- * @returns 是否有上一页
- */
-export function hasPreviousPage(page: number): boolean {
-  return page > 1;
-}
-
-/**
- * offset 风格转 page 风格
- *
- * @param offset - 偏移量
- * @param limit - 每页数量
- * @returns page 风格参数
- */
-export function offsetToPage(offset: number, limit: number): OffsetPaginationResult {
-  /**
-   * 规范化后的限制数量
-   */
-  const safeLimit = Math.max(1, limit);
-  return {
-    page: Math.floor(offset / safeLimit) + 1,
-    pageSize: safeLimit,
-  };
-}
-
-/**
- * page 风格转 offset 风格
- *
- * @param page - 页码
- * @param pageSize - 每页数量
- * @returns offset 风格参数
- */
-export function pageToOffset(page: number, pageSize: number): PagePaginationResult {
-  /**
-   * 规范化后的页码
-   */
-  const safePage = Math.max(1, page);
-
-  /**
-   * 规范化后的每页数量
-   */
-  const safePageSize = Math.max(1, pageSize);
-  return {
-    offset: (safePage - 1) * safePageSize,
-    limit: safePageSize,
-  };
-}
-
-/**
- * 创建分页结果对象
- *
- * @typeParam T - 数据项类型
- * @param items - 数据项数组
- * @param total - 总记录数
- * @param page - 当前页码
- * @param pageSize - 每页数量
- * @returns 分页结果
- */
-export function createPaginatedResult<T>(
-  items: T[],
-  total: number,
-  page: number,
-  pageSize: number,
-): import('../types').PaginatedResult<T> {
-  /**
-   * 计算的总页数
-   */
-  const totalPages = calculateTotalPages(total, pageSize);
-  return {
-    items,
-    total,
-    page,
-    pageSize,
-    totalPages,
-    hasNextPage: hasNextPage(page, totalPages),
-    hasPreviousPage: hasPreviousPage(page),
-  };
-}

package/src/utils/validation.util.ts

@@ -1,150 +0,0 @@
-/**
- * 分页参数验证工具函数
- */
-
-import { PAGINATION_DEFAULTS } from '../types';
-
-/**
- * 检查值是否为对象类型
- *
- * @param value - 待检查的值
- * @returns 是否为对象类型
- */
-function isObject(value: unknown): value is Record<string, unknown> {
-  return typeof value === 'object' && value !== null;
-}
-
-/**
- * Page 风格分页参数
- */
-export type PaginationValidationResult = {
-  /**
-   * 页码
-   */
-  page: number;
-
-  /**
-   * 每页数量
-   */
-  pageSize: number;
-};
-
-/**
- * Offset 风格分页参数
- */
-export type OffsetPaginationValidationResult = {
-  /**
-   * 限制数量
-   */
-  limit: number;
-
-  /**
-   * 偏移量
-   */
-  offset: number;
-};
-
-/**
- * 验证页码是否有效
- *
- * @param page - 页码
- * @returns 是否有效
- */
-export function isValidPage(page: unknown): page is number {
-  return typeof page === 'number' && Number.isInteger(page) && page >= 1;
-}
-
-/**
- * 验证每页数量是否有效
- *
- * @param pageSize - 每页数量
- * @returns 是否有效
- */
-export function isValidPageSize(pageSize: unknown): pageSize is number {
-  return (
-    typeof pageSize === 'number' &&
-    Number.isInteger(pageSize) &&
-    pageSize >= PAGINATION_DEFAULTS.minPageSize &&
-    pageSize <= PAGINATION_DEFAULTS.maxPageSize
-  );
-}
-
-/**
- * 验证偏移量是否有效
- *
- * @param offset - 偏移量
- * @returns 是否有效
- */
-export function isValidOffset(offset: unknown): offset is number {
-  return typeof offset === 'number' && Number.isInteger(offset) && offset >= 0;
-}
-
-/**
- * 验证 limit 是否有效
- *
- * @param limit - 限制数量
- * @returns 是否有效
- */
-export function isValidLimit(limit: unknown): limit is number {
-  return (
-    typeof limit === 'number' &&
-    Number.isInteger(limit) &&
-    limit >= PAGINATION_DEFAULTS.minPageSize &&
-    limit <= PAGINATION_DEFAULTS.maxPageSize
-  );
-}
-
-/**
- * 验证分页参数是否有效
- *
- * @param params - 分页参数
- * @returns 是否有效
- */
-export function isValidPagination(params: unknown): params is PaginationValidationResult {
-  if (!isObject(params)) {
-    return false;
-  }
-
-  /**
-   * 提取的页码
-   */
-  const page = params.page;
-
-  /**
-   * 提取的每页数量
-   */
-  const pageSize = params.pageSize;
-
-  return (
-    (page === undefined || isValidPage(page)) &&
-    (pageSize === undefined || isValidPageSize(pageSize))
-  );
-}
-
-/**
- * 验证 offset 分页参数是否有效
- *
- * @param params - offset 分页参数
- * @returns 是否有效
- */
-export function isValidOffsetPagination(
-  params: unknown,
-): params is OffsetPaginationValidationResult {
-  if (!isObject(params)) {
-    return false;
-  }
-
-  /**
-   * 提取的限制数量
-   */
-  const limit = params.limit;
-
-  /**
-   * 提取的偏移量
-   */
-  const offset = params.offset;
-
-  return (
-    (limit === undefined || isValidLimit(limit)) && (offset === undefined || isValidOffset(offset))
-  );
-}