npm - @taicode/common-server - Versions diffs - 1.0.7 → 1.0.9 - Mend

@taicode/common-server 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/output/schema/index.d.ts +77 -22
package/output/schema/index.d.ts.map +1 -1
package/output/schema/index.js +69 -11
package/package.json +1 -1

package/output/schema/index.d.ts CHANGED Viewed

@@ -1,5 +1,26 @@
 import { FastifySchema } from 'fastify';
 import { z, ZodEnum, ZodType } from 'zod';
+/**
+ * 标准查询请求体 Schema
+ * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 查询请求体的 Schema
+ */
+export declare function queryParamsSchema<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
  * 用于定义分页查询的返回结果结构
@@ -10,6 +31,12 @@ export declare function queryResultSchema<T extends ZodType>(t: T): z.ZodObject<
     total: z.ZodNumber;
     list: z.ZodArray<T>;
 }, z.core.$strip>;
+/**
+ * 列表查询参数 Schema
+ * 一次性列出全部数据
+ * @returns 列表查询参数的 Schema
+ */
+export declare function listParamsSchema(): z.ZodNullable<z.ZodUndefined>;
 /**
  * 列表结果 Schema
  * 用于定义列表查询的返回结果结构（与 queryResultSchema 功能相同）
@@ -21,44 +48,62 @@ export declare function listResultSchema<T extends ZodType>(t: T): z.ZodObject<{
     list: z.ZodArray<T>;
 }, z.core.$strip>;
 /**
- * 标准查询请求体 Schema
- * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * 指定时间范围查询请求体 Schema
+ * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
  * @param f - 过滤条件的类型
  * @param e - 排序字段的枚举类型（可选）
- * @returns 查询请求体的 Schema
+ * @returns 范围查询请求体的 Schema
  */
-export declare function queryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+export declare function rangeQueryParamsSchema<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<{
+    sort: z.ZodUndefined | z.ZodArray<z.ZodObject<{
         key: E;
         order: z.ZodEnum<{
             ASC: "ASC";
             DESC: "DESC";
         }>;
-    }, z.core.$strip>> | z.ZodUndefined;
+    }, z.core.$strip>>;
+    range: z.ZodTuple<[z.ZodISODateTime, z.ZodISODateTime], null>;
 }, z.core.$strip>;
 /**
- * 范围查询请求体 Schema
- * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
+ * 范围查询结果 Schema
+ * 用于定义范围查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含时间点和数据的数组 Schema
+ */
+export declare function rangeQueryResultSchema<T extends ZodType>(t: T): z.ZodArray<z.ZodObject<{
+    data: T;
+    time: z.ZodISODateTime;
+}, z.core.$strip>>;
+/**
+ * 统计查询参数 Schema
+ * 用于定义统计查询的请求参数
  * @param f - 过滤条件的类型
  * @param e - 排序字段的枚举类型（可选）
- * @returns 范围查询请求体的 Schema
+ * @returns 统计查询参数的 Schema
  */
-export declare function rangeQueryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+export declare function statisticQueryParamsSchema<F extends ZodType>(f: F): z.ZodObject<{
     filter: F;
-    sort: z.ZodUndefined | z.ZodArray<z.ZodObject<{
-        key: E;
-        order: z.ZodEnum<{
-            ASC: "ASC";
-            DESC: "DESC";
-        }>;
-    }, z.core.$strip>>;
+    step: z.ZodEnum<{
+        minute: "minute";
+        hour: "hour";
+        day: "day";
+        week: "week";
+        month: "month";
+        year: "year";
+    }>;
     range: z.ZodTuple<[z.ZodISODateTime, z.ZodISODateTime], null>;
 }, z.core.$strip>;
+/**
+ * 统计查询结果 Schema
+ * 用于定义统计查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含时间点和数据的数组 Schema
+ */
+export declare function statisticQueryResultSchema<T extends ZodType>(t: T): z.ZodArray<z.ZodObject<{
+    data: T;
+    time: z.ZodISODateTime;
+}, z.core.$strip>>;
 /**
  * 模糊查询请求体 Schema
  * 用于定义包含模糊搜索关键词、时间范围和排序条件的查询请求
@@ -66,7 +111,7 @@ export declare function rangeQueryBodySchema<F extends ZodType, E extends ZodEnu
  * @param e - 排序字段的枚举类型（可选）
  * @returns 模糊查询请求体的 Schema
  */
-export declare function fuzzQueryBodySchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
+export declare function fuzzQueryParamsSchema<F extends ZodType, E extends ZodEnum>(f: F, e?: E): z.ZodObject<{
     filter: F;
     paging: z.ZodObject<{
         size: z.ZodNumber;
@@ -80,6 +125,16 @@ export declare function fuzzQueryBodySchema<F extends ZodType, E extends ZodEnum
         }>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * 模糊查询结果 Schema
+ * 用于定义模糊查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export declare function fuzzQueryResultSchema<T extends ZodType>(t: T): z.ZodObject<{
+    total: z.ZodNumber;
+    list: z.ZodArray<T>;
+}, z.core.$strip>;
 /**
  * 标准响应数据内容 Schema
  * 用于定义统一的 API 响应结构

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

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACvC,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~~;AAGD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;;;;kBAMlF;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;;;;;;;;;;;;;;;;;;EAMvG;AAED,UAAU,YAAa,SAAQ,aAAa;IAC1C,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAY/F"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../source/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AA2BzC;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;;;;kBAMlF;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;kBAKxD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,kCAE/B;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;kBAKvD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;kBAMvF;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;mBAK7D;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;;;;;;;;;kBAMjE;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;mBAKjE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;;;;;;;;;;;;;kBAMtF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;;;kBAK5D;AAGD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;;;;kBAMlF;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;;;;;;;;;;;;;;;;;;EAMvG;AAED,UAAU,YAAa,SAAQ,aAAa;IAC1C,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAY/F"}

package/output/schema/index.js CHANGED Viewed

@@ -22,6 +22,20 @@ function _sortSchema(t) {
         order: z.enum(['ASC', 'DESC']).describe('排序方向：ASC-升序，DESC-降序')
     }));
 }
+/**
+ * 标准查询请求体 Schema
+ * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * @param f - 过滤条件的类型
+ * @param e - 排序字段的枚举类型（可选）
+ * @returns 查询请求体的 Schema
+ */
+export function queryParamsSchema(f, e) {
+    return z.object({
+        filter: f.describe('过滤条件'),
+        paging: _pagingSchema().describe('分页参数'),
+        sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+    });
+}
 /**
  * 查询结果 Schema
  * 用于定义分页查询的返回结果结构
@@ -34,6 +48,14 @@ export function queryResultSchema(t) {
         list: z.array(t).describe('数据列表')
     });
 }
+/**
+ * 列表查询参数 Schema
+ * 一次性列出全部数据
+ * @returns 列表查询参数的 Schema
+ */
+export function listParamsSchema() {
+    return z.undefined().nullable();
+}
 /**
  * 列表结果 Schema
  * 用于定义列表查询的返回结果结构（与 queryResultSchema 功能相同）
@@ -47,33 +69,57 @@ export function listResultSchema(t) {
     });
 }
 /**
- * 标准查询请求体 Schema
- * 用于定义包含过滤条件、分页参数和排序条件的查询请求
+ * 指定时间范围查询请求体 Schema
+ * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
  * @param f - 过滤条件的类型
  * @param e - 排序字段的枚举类型（可选）
- * @returns 查询请求体的 Schema
+ * @returns 范围查询请求体的 Schema
  */
-export function queryBodySchema(f, e) {
+export function rangeQueryParamsSchema(f, e) {
     return z.object({
         filter: f.describe('过滤条件'),
-        paging: _pagingSchema().describe('分页参数'),
         sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+        range: z.tuple([z.iso.datetime(), z.iso.datetime()]).describe('时间范围，格式为 [开始时间, 结束时间]'),
     });
 }
 /**
- * 范围查询请求体 Schema
- * 用于定义包含过滤条件、时间范围和排序条件的查询请求（不包含分页）
+ * 范围查询结果 Schema
+ * 用于定义范围查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含时间点和数据的数组 Schema
+ */
+export function rangeQueryResultSchema(t) {
+    return z.array(z.object({
+        data: t,
+        time: z.iso.datetime().describe('时间点'),
+    }));
+}
+/**
+ * 统计查询参数 Schema
+ * 用于定义统计查询的请求参数
  * @param f - 过滤条件的类型
  * @param e - 排序字段的枚举类型（可选）
- * @returns 范围查询请求体的 Schema
+ * @returns 统计查询参数的 Schema
  */
-export function rangeQueryBodySchema(f, e) {
+export function statisticQueryParamsSchema(f) {
     return z.object({
         filter: f.describe('过滤条件'),
-        sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
+        step: z.enum(['minute', 'hour', 'day', 'week', 'month', 'year']).describe('统计粒度'),
         range: z.tuple([z.iso.datetime(), z.iso.datetime()]).describe('时间范围，格式为 [开始时间, 结束时间]'),
     });
 }
+/**
+ * 统计查询结果 Schema
+ * 用于定义统计查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含时间点和数据的数组 Schema
+ */
+export function statisticQueryResultSchema(t) {
+    return z.array(z.object({
+        data: t,
+        time: z.iso.datetime().describe('时间点'),
+    }));
+}
 /**
  * 模糊查询请求体 Schema
  * 用于定义包含模糊搜索关键词、时间范围和排序条件的查询请求
@@ -81,13 +127,25 @@ export function rangeQueryBodySchema(f, e) {
  * @param e - 排序字段的枚举类型（可选）
  * @returns 模糊查询请求体的 Schema
  */
-export function fuzzQueryBodySchema(f, e) {
+export function fuzzQueryParamsSchema(f, e) {
     return z.object({
         filter: f.describe('模糊搜索关键词，长度1-50字符'),
         paging: _pagingSchema().describe('分页参数'),
         sort: e ? _sortSchema(e).describe('排序条件') : z.undefined(),
     });
 }
+/**
+ * 模糊查询结果 Schema
+ * 用于定义模糊查询的返回结果结构
+ * @param t - 数据项的类型
+ * @returns 包含总数和数据列表的 Schema
+ */
+export function fuzzQueryResultSchema(t) {
+    return z.object({
+        total: z.number().describe('数据总数'),
+        list: z.array(t).describe('数据列表')
+    });
+}
 /**
  * 标准响应数据内容 Schema
  * 用于定义统一的 API 响应结构

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@taicode/common-server",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "author": "Alain",
   "license": "ISC",
   "description": "",