@taicode/common-server 1.0.2 → 1.0.4

package/output/index.d.ts

@@ -1,2 +1,2 @@
-export * from './mock';
+export * from './schema';
 //# sourceMappingURL=index.d.ts.map

package/output/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AACA,cAAc,QAAQ,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AACA,cAAc,UAAU,CAAA"}

package/output/index.js

@@ -1,2 +1,2 @@
 // 根 index.ts，统一导出 mock 目录下所有能力
-export * from './mock';
+export * from './schema';

package/output/schema/index.d.ts

@@ -0,0 +1,91 @@
+import { z, ZodEnum, ZodType } from 'zod';
+/**
+ * 查询结果 Schema
+ * 用于定义分页查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export declare function queryResultSchema<T extends ZodType>(t: T): z.ZodObject<{
+    total: z.ZodNumber;
+    list: z.ZodArray<T>;
+}, z.core.$strip>;
+/**
+ * 列表结果 Schema
+ * 用于定义列表查询的返回结果结构（与 queryResultSchema 功能相同）
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export declare function listResultSchema<T extends ZodType>(t: T): z.ZodObject<{
+    total: z.ZodNumber;
+    list: z.ZodArray<T>;
+}, z.core.$strip>;
+/**
+ * 标准查询请求体 Schema
+ * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 查询请求体的 Schema
+ */
+export declare function queryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+    filter: F;
+    paging: z.ZodObject<{
+        size: z.ZodNumber;
+        index: z.ZodNumber;
+    }, z.core.$strip>;
+    sort: z.ZodArray<z.ZodObject<{
+        key: E;
+        order: z.ZodEnum<{
+            ASC: "ASC";
+            DESC: "DESC";
+        }>;
+    }, z.core.$strip>> | z.ZodUndefined;
+}, z.core.$strip>;
+/**
+ * 范围查询请求体 Schema
+ * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 范围查询请求体的 Schema
+ */
+export declare function rangeQueryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+    filter: F;
+    sort: z.ZodUndefined | z.ZodArray<z.ZodObject<{
+        key: E;
+        order: z.ZodEnum<{
+            ASC: "ASC";
+            DESC: "DESC";
+        }>;
+    }, z.core.$strip>>;
+    range: z.ZodTuple<[z.ZodISODateTime, z.ZodISODateTime], null>;
+}, z.core.$strip>;
+/**
+ * 模糊查询请求体 Schema
+ * 用于定义包含模糊搜索关键词、时间范围和排序条件的查询请求
+ * @param f - 过滤条件的类型（此处为字符串类型，用作搜索关键词）
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 模糊查询请求体的 Schema
+ */
+export declare function fuzzQueryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+    filter: F;
+    sort: z.ZodUndefined | z.ZodArray<z.ZodObject<{
+        key: E;
+        order: z.ZodEnum<{
+            ASC: "ASC";
+            DESC: "DESC";
+        }>;
+    }, z.core.$strip>>;
+    range: z.ZodTuple<[z.ZodISODateTime, z.ZodISODateTime], null>;
+}, z.core.$strip>;
+/**
+ * 标准响应 Schema
+ * 用于定义统一的 API 响应结构
+ * @param t - 响应数据的类型
+ * @param s - 状态码的枚举类型
+ * @returns 标准响应的 Schema
+ */
+export declare function responseSchema<T extends ZodType, S extends ZodEnum>(t: T, s: S): z.ZodObject<{
+    data: T;
+    status: S;
+    message: z.ZodString;
+}, z.core.$strip>;
+//# sourceMappingURL=index.d.ts.map

package/output/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AA2BzC;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;kBAKxD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;kBAKvD;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;;;;kBAMhF;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;kBAMrF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;kBAMpF;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;;;;kBAM9E"}

package/output/schema/index.js

@@ -0,0 +1,104 @@
+import { z } from 'zod';
+/**
+ * 分页查询参数 Schema
+ * 用于定义分页查询时的页面大小和页面索引
+ * @private
+ */
+function _pagingSchema() {
+    return z.object({
+        size: z.number().max(100).describe('每页数据量，最大100条'),
+        index: z.number().min(1).describe('页面索引，从1开始')
+    });
+}
+/**
+ * 排序查询参数 Schema
+ * 用于定义排序条件，支持多字段排序
+ * @private
+ * @param t - 排序字段的枚举类型
+ */
+function _sortSchema(t) {
+    return z.array(z.object({
+        key: t.describe('排序字段'),
+        order: z.enum(['ASC', 'DESC']).describe('排序方向：ASC-升序，DESC-降序')
+    }));
+}
+/**
+ * 查询结果 Schema
+ * 用于定义分页查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export function queryResultSchema(t) {
+    return z.object({
+        total: z.number().describe('数据总数'),
+        list: z.array(t).describe('数据列表')
+    });
+}
+/**
+ * 列表结果 Schema
+ * 用于定义列表查询的返回结果结构（与 queryResultSchema 功能相同）
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export function listResultSchema(t) {
+    return z.object({
+        total: z.number().describe('数据总数'),
+        list: z.array(t).describe('数据列表')
+    });
+}
+/**
+ * 标准查询请求体 Schema
+ * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 查询请求体的 Schema
+ */
+export function queryBodySchema(f, e) {
+    return z.object({
+        filter: f.describe('过滤条件'),
+        paging: _pagingSchema().describe('分页参数'),
+        sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+    });
+}
+/**
+ * 范围查询请求体 Schema
+ * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 范围查询请求体的 Schema
+ */
+export function rangeQueryBodySchema(f, e) {
+    return z.object({
+        filter: f.describe('过滤条件'),
+        sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+        range: z.tuple([z.iso.datetime(), z.iso.datetime()]).describe('时间范围，格式为 [开始时间, 结束时间]'),
+    });
+}
+/**
+ * 模糊查询请求体 Schema
+ * 用于定义包含模糊搜索关键词、时间范围和排序条件的查询请求
+ * @param f - 过滤条件的类型（此处为字符串类型，用作搜索关键词）
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 模糊查询请求体的 Schema
+ */
+export function fuzzQueryBodySchema(f, e) {
+    return z.object({
+        filter: f.describe('模糊搜索关键词，长度1-50字符'),
+        sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+        range: z.tuple([z.iso.datetime(), z.iso.datetime()]).describe('时间范围，格式为 [开始时间, 结束时间]'),
+    });
+}
+/**
+ * 标准响应 Schema
+ * 用于定义统一的 API 响应结构
+ * @param t - 响应数据的类型
+ * @param s - 状态码的枚举类型
+ * @returns 标准响应的 Schema
+ */
+export function responseSchema(t, s) {
+    return z.object({
+        data: t.describe('响应数据'),
+        status: s.describe('响应状态码'),
+        message: z.string().describe('响应消息'),
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taicode/common-server",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "author": "Alain",
   "license": "ISC",
   "description": "",
@@ -12,16 +12,6 @@
       "import": "./output/index.js",
       "require": "./output/index.js"
     },
-    "./mock": {
-      "types": "./output/mock/index.d.ts",
-      "import": "./output/mock/index.js",
-      "require": "./output/mock/index.js"
-    },
-    "./mock/*": {
-      "types": "./output/mock/*/index.d.ts",
-      "import": "./output/mock/*/index.js",
-      "require": "./output/mock/*/index.js"
-    },
     "./*": {
       "types": "./output/*/index.d.ts",
       "import": "./output/*/index.js",
@@ -37,10 +27,12 @@
   "files": [
     "output"
   ],
+  "peerDependencies": {
+    "zod": "^4.1.0",
+    "fastify": "^5.5.0",
+    "@taicode/common-base": "^1.7.0"
+  },
   "devDependencies": {
     "vitest": "^3.2.4"
-  },
-  "optionalDependencies": {
-    "@prisma/client": ">=4.20.0"
   }
 }