All files / src/schemas result.schemas.ts

100% Statements 3/3
100% Branches 0/0
100% Functions 3/3
100% Lines 3/3

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214                            3x                                                                                                                                                                           2x                                                                                                                                   3x                                                                                              
/**
 * 分页结果 Zod Schema 定义
 */
 
import { z } from 'zod';
 
/**
 * 创建分页结果 Schema
 *
 * 包含分页数据和分页信息的完整结果
 *
 * @typeParam T - 数据项 Schema 类型
 */
export function createPaginatedResultSchema<T extends z.ZodTypeAny>(itemSchema: T) {
  return z.object({
    /**
     * 数据项数组
     */
    items: z.array(itemSchema),
 
    /**
     * 总记录数
     */
    total: z.number().int().nonnegative(),
 
    /**
     * 当前页码
     */
    page: z.number().int().positive(),
 
    /**
     * 每页数量
     */
    pageSize: z.number().int().positive(),
 
    /**
     * 总页数
     */
    totalPages: z.number().int().nonnegative(),
 
    /**
     * 是否有下一页
     */
    hasNextPage: z.boolean(),
 
    /**
     * 是否有上一页
     */
    hasPreviousPage: z.boolean(),
  });
}
 
/**
 * 分页结果类型(泛型版本)
 */
export type PaginatedResult<T> = {
  /**
   * 数据项数组
   */
  items: T[];
 
  /**
   * 总记录数
   */
  total: number;
 
  /**
   * 当前页码
   */
  page: number;
 
  /**
   * 每页数量
   */
  pageSize: number;
 
  /**
   * 总页数
   */
  totalPages: number;
 
  /**
   * 是否有下一页
   */
  hasNextPage: boolean;
 
  /**
   * 是否有上一页
   */
  hasPreviousPage: boolean;
};
 
/**
 * 创建 Offset 风格分页结果 Schema
 *
 * 包含偏移量分页数据和分页信息
 *
 * @typeParam T - 数据项 Schema 类型
 */
export function createOffsetPaginatedResultSchema<T extends z.ZodTypeAny>(itemSchema: T) {
  return z.object({
    /**
     * 数据项数组
     */
    items: z.array(itemSchema),
 
    /**
     * 总记录数
     */
    total: z.number().int().nonnegative(),
 
    /**
     * 限制数量
     */
    limit: z.number().int().nonnegative(),
 
    /**
     * 偏移量
     */
    offset: z.number().int().nonnegative(),
 
    /**
     * 是否有更多数据
     */
    hasMore: z.boolean(),
  });
}
 
/**
 * Offset 风格分页结果类型(泛型版本)
 */
export type OffsetPaginatedResult<T> = {
  /**
   * 数据项数组
   */
  items: T[];
 
  /**
   * 总记录数
   */
  total: number;
 
  /**
   * 限制数量
   */
  limit: number;
 
  /**
   * 偏移量
   */
  offset: number;
 
  /**
   * 是否有更多数据
   */
  hasMore: boolean;
};
 
/**
 * 创建游标分页结果 Schema
 *
 * 包含游标分页数据和分页信息
 *
 * @typeParam T - 数据项 Schema 类型
 */
export function createCursorPaginatedResultSchema<T extends z.ZodTypeAny>(itemSchema: T) {
  return z.object({
    /**
     * 数据项数组
     */
    items: z.array(itemSchema),
 
    /**
     * 下一页游标
     */
    nextCursor: z.string().nullable(),
 
    /**
     * 上一页游标
     */
    previousCursor: z.string().nullable(),
 
    /**
     * 是否有更多数据
     */
    hasMore: z.boolean(),
  });
}
 
/**
 * 游标分页结果类型(泛型版本)
 */
export type CursorPaginatedResult<T> = {
  /**
   * 数据项数组
   */
  items: T[];
 
  /**
   * 下一页游标
   */
  nextCursor: string | null;
 
  /**
   * 上一页游标
   */
  previousCursor: string | null;
 
  /**
   * 是否有更多数据
   */
  hasMore: boolean;
};