@wordrhyme/auto-crud-server 1.0.3 → 1.0.5

package/dist/index.cjs

@@ -500,7 +500,7 @@ const filterItemSchema = zod.z.object({
 	operator: zod.z.enum(dataTableConfig.operators),
 	filterId: zod.z.string()
 });
-const listInputSchema = zod.z.object({
+const baseListInputSchema = zod.z.object({
 	page: zod.z.number().min(1).default(1),
 	perPage: zod.z.number().min(1).max(100).default(10),
 	sort: zod.z.array(zod.z.object({
@@ -510,7 +510,9 @@ const listInputSchema = zod.z.object({
 	filters: zod.z.array(filterItemSchema).optional(),
 	joinOperator: zod.z.enum(["and", "or"]).default("and")
 });
-const exportInputSchema = zod.z.object({
+const baseGetInputSchema = zod.z.object({ id: zod.z.string() });
+const defaultGetInputSchema = zod.z.union([zod.z.string(), baseGetInputSchema]);
+const baseExportInputSchema = zod.z.object({
 	sort: zod.z.array(zod.z.object({
 		id: zod.z.string(),
 		desc: zod.z.boolean()
@@ -613,6 +615,9 @@ function createCrudRouter(config) {
 	});
 	const resolved = resolveConfig(config);
 	const softDelete = resolveSoftDelete(softDeleteOption);
+	const resolvedListInputSchema = config.listInputSchema ?? baseListInputSchema;
+	const resolvedGetInputSchema = config.getInputSchema ? zod.z.union([zod.z.string(), config.getInputSchema]) : defaultGetInputSchema;
+	const resolvedExportInputSchema = config.exportInputSchema ?? baseExportInputSchema;
 	const m = middleware;
 	const getIdColumn = () => table[idField];
 	const getSoftDeleteColumn = () => softDelete ? table[softDelete.column] : null;
@@ -654,7 +659,7 @@ function createCrudRouter(config) {
 		});
 	};
 	const procedures = {
-		list: resolved.procedureFactory("list").input(listInputSchema).output(listOutputSchema).query(async ({ ctx, input }) => {
+		list: resolved.procedureFactory("list").input(resolvedListInputSchema).output(listOutputSchema).query(async ({ ctx, input }) => {
 			await withGuard(ctx, "list");
 			const doList = async (listInput$1) => {
 				const offset = (listInput$1.page - 1) * listInput$1.perPage;
@@ -693,20 +698,23 @@ function createCrudRouter(config) {
 			});
 			return doList(listInput);
 		}),
-		get: resolved.procedureFactory("get").input(zod.z.string()).output(entityOutputSchema.nullable()).query(async ({ ctx, input }) => {
+		get: resolved.procedureFactory("get").input(resolvedGetInputSchema).output(entityOutputSchema.nullable()).query(async ({ ctx, input }) => {
 			await withGuard(ctx, "get");
-			const doGet = async () => {
-				const where = buildWhere(ctx, "get", (0, drizzle_orm.eq)(getIdColumn(), input));
+			const doGet = async (getInput) => {
+				const id$1 = typeof getInput === "string" ? getInput : getInput.id;
+				const where = buildWhere(ctx, "get", (0, drizzle_orm.eq)(getIdColumn(), id$1));
 				const [item] = await ctx.db.select().from(table).where(where);
 				await withAuthorize(ctx, item, "get");
 				return item ?? null;
 			};
+			const id = typeof input === "string" ? input : input.id;
 			if (m.get) return m.get({
 				ctx,
-				id: input,
-				next: doGet
+				id,
+				input,
+				next: async (modifiedInput) => doGet(modifiedInput ?? input)
 			});
-			return doGet();
+			return doGet(input);
 		}),
 		create: resolved.procedureFactory("create").input(schema).output(entityOutputSchema).mutation(async ({ ctx, input }) => {
 			await withGuard(ctx, "create");
@@ -852,7 +860,7 @@ function createCrudRouter(config) {
 			});
 			return doUpsert(input);
 		}),
-		export: resolved.procedureFactory("export").input(exportInputSchema).output(exportOutputSchema).query(async ({ ctx, input }) => {
+		export: resolved.procedureFactory("export").input(resolvedExportInputSchema).output(exportOutputSchema).query(async ({ ctx, input }) => {
 			await withGuard(ctx, "export");
 			const doExport = async (exportInput$1) => {
 				const effectiveLimit = Math.min(Math.max(exportInput$1.limit ?? maxExportSize, 1), maxExportSize);
@@ -1057,6 +1065,9 @@ const appRouter = router({});
 //#endregion
 exports.afterMiddleware = afterMiddleware;
 exports.appRouter = appRouter;
+exports.baseExportInputSchema = baseExportInputSchema;
+exports.baseGetInputSchema = baseGetInputSchema;
+exports.baseListInputSchema = baseListInputSchema;
 exports.beforeMiddleware = beforeMiddleware;
 exports.composeMiddleware = composeMiddleware;
 exports.createCrudRouter = createCrudRouter;

package/dist/index.d.cts

@@ -1,8 +1,8 @@
+import { z } from "zod";
 import { PgTable } from "drizzle-orm/pg-core";
 import * as _trpc_server2 from "@trpc/server";
 import { PostgresJsDatabase } from "drizzle-orm/postgres-js";
 import { SQL } from "drizzle-orm";
-import { z } from "zod";
 
 //#region src/trpc.d.ts
 /**
@@ -21,13 +21,13 @@ declare const router: _trpc_server2.TRPCRouterBuilder<{
 declare const publicProcedure: _trpc_server2.TRPCProcedureBuilder<Context, object, object, _trpc_server2.TRPCUnsetMarker, _trpc_server2.TRPCUnsetMarker, _trpc_server2.TRPCUnsetMarker, _trpc_server2.TRPCUnsetMarker, false>;
 //#endregion
 //#region src/types/config.d.ts
-type CrudOperation = "list" | "get" | "create" | "update" | "delete" | "deleteMany" | "updateMany" | "upsert" | "export" | "import" | "createMany";
-type WriteOperation = "create" | "update";
+type CrudOperation = 'list' | 'get' | 'create' | 'update' | 'delete' | 'deleteMany' | 'updateMany' | 'upsert' | 'export' | 'import' | 'createMany';
+type WriteOperation = 'create' | 'update';
 /**
  * 表字段键类型提取
  * 用于 omitFields 的强类型支持
  */
-type TableColumnKeys<T extends PgTable> = keyof T["_"]["columns"];
+type TableColumnKeys<T extends PgTable> = keyof T['_']['columns'];
 type AnyProcedure = any;
 interface SoftDeleteConfig {
   /** 软删除标记列名 */
@@ -63,7 +63,7 @@ interface ListInput {
     operator: string;
     filterId: string;
   }>;
-  joinOperator: "and" | "or";
+  joinOperator: 'and' | 'or';
 }
 /**
  * 列表查询结果类型
@@ -75,6 +75,14 @@ interface ListResult<TSelect> {
   perPage: number;
   pageCount: number;
 }
+/**
+ * 单条查询输入类型
+ * - string: 兼容旧的 get(id) 调用
+ * - object: 支持通过 getInputSchema 扩展 include 等控制参数
+ */
+type GetInput = string | {
+  id: string;
+};
 /**
  * 导出查询输入类型（复用 ListInput 的筛选/排序，无分页）
  */
@@ -90,7 +98,7 @@ interface ExportInput {
     operator: string;
     filterId: string;
   }>;
-  joinOperator?: "and" | "or";
+  joinOperator?: 'and' | 'or';
   /** 导出数量限制，会被 clamp 到 [1, maxExportSize] */
   limit?: number;
 }
@@ -137,17 +145,18 @@ interface ImportInput {
    * - "upsert": 存在则更新，不存在则新建
    * - "error": 冲突行计入失败
    */
-  onConflict?: "skip" | "upsert" | "error";
+  onConflict?: 'skip' | 'upsert' | 'error';
 }
-interface ListMiddlewareParams<TContext, TSelect> {
+interface ListMiddlewareParams<TContext, TSelect, TListInput extends ListInput = ListInput> {
   ctx: TContext;
-  input: ListInput;
-  next: (input?: ListInput) => Promise<ListResult<TSelect>>;
+  input: TListInput;
+  next: (input?: TListInput) => Promise<ListResult<TSelect>>;
 }
-interface GetMiddlewareParams<TContext, TSelect> {
+interface GetMiddlewareParams<TContext, TSelect, TGetInput extends GetInput = GetInput> {
   ctx: TContext;
   id: string;
-  next: () => Promise<TSelect | null>;
+  input: TGetInput;
+  next: (input?: TGetInput) => Promise<TSelect | null>;
 }
 interface CreateMiddlewareParams<TContext, TSelect, TInsert> {
   ctx: TContext;
@@ -190,10 +199,10 @@ interface UpsertMiddlewareParams<TContext, TSelect, TInsert> {
     isNew: boolean;
   }>;
 }
-interface ExportMiddlewareParams<TContext, TSelect> {
+interface ExportMiddlewareParams<TContext, TSelect, TExportInput extends ExportInput = ExportInput> {
   ctx: TContext;
-  input: ExportInput;
-  next: (input?: ExportInput) => Promise<ExportResult<TSelect>>;
+  input: TExportInput;
+  next: (input?: TExportInput) => Promise<ExportResult<TSelect>>;
 }
 interface ImportMiddlewareParams<TContext> {
   ctx: TContext;
@@ -234,15 +243,15 @@ interface CreateManyMiddlewareParams<TContext, TSelect, TInsert> {
  *   },
  * }
  */
-interface CrudMiddleware<TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown> {
+interface CrudMiddleware<TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown, TListInput extends ListInput = ListInput, TGetInput extends GetInput = GetInput, TExportInput extends ExportInput = ExportInput> {
   /**
    * 列表查询包装器
    */
-  list?: (params: ListMiddlewareParams<TContext, TSelect>) => Promise<ListResult<TSelect>>;
+  list?: (params: ListMiddlewareParams<TContext, TSelect, TListInput>) => Promise<ListResult<TSelect>>;
   /**
    * 单条查询包装器
    */
-  get?: (params: GetMiddlewareParams<TContext, TSelect>) => Promise<TSelect | null>;
+  get?: (params: GetMiddlewareParams<TContext, TSelect, TGetInput>) => Promise<TSelect | null>;
   /**
    * 创建包装器
    */
@@ -281,7 +290,7 @@ interface CrudMiddleware<TContext = unknown, TSelect = unknown, TInsert = unknow
    * 导出包装器
    * 可用于审计日志、限流、异步队列调度
    */
-  export?: (params: ExportMiddlewareParams<TContext, TSelect>) => Promise<ExportResult<TSelect>>;
+  export?: (params: ExportMiddlewareParams<TContext, TSelect, TExportInput>) => Promise<ExportResult<TSelect>>;
   /**
    * 导入包装器
    * 可用于审计日志、限流、异步队列调度
@@ -377,7 +386,7 @@ type ProcedureConfig = AnyProcedure | ProcedureMap | ProcedureFactory;
  *   authorize: (ctx, resource) => resource.ownerId === ctx.user.id,
  * })
  */
-interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown> {
+interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown, TListInput extends ListInput = ListInput, TGetInput extends GetInput = GetInput, TExportInput extends ExportInput = ExportInput> {
   /** Drizzle 表定义 */
   table: TTable;
   /**
@@ -408,6 +417,35 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
   updateSchema?: z.ZodType<TUpdate>;
   /** 查询返回 Schema */
   selectSchema?: z.ZodType<TSelect>;
+  /**
+   * 列表查询输入 Schema（可选）
+   * - 默认使用内置基础列表输入：page、perPage、sort、filters、joinOperator
+   * - 业务侧可以基于 baseListInputSchema.extend(...) 增加自定义参数
+   * - 默认查询逻辑只读取基础字段，额外字段会保留给 middleware.list 使用
+   *
+   * @example
+   * listInputSchema: baseListInputSchema.extend({
+   *   include: z.object({ skus: z.boolean().optional() }).optional(),
+   * })
+   */
+  listInputSchema?: z.ZodType<TListInput>;
+  /**
+   * 单条查询输入 Schema（可选）
+   * - 默认兼容 get(id) 和 get({ id })
+   * - 业务侧可以基于 baseGetInputSchema.extend(...) 增加 include 等控制参数
+   * - 配置后仍保留 get(id) 字符串调用兼容性
+   * - 默认查询逻辑只读取 id，额外字段会保留给 middleware.get 使用
+   */
+  getInputSchema?: z.ZodType<Extract<TGetInput, {
+    id: string;
+  }>>;
+  /**
+   * 导出查询输入 Schema（可选）
+   * - 默认使用内置基础导出输入：sort、filters、joinOperator、limit
+   * - 业务侧可以基于 baseExportInputSchema.extend(...) 增加自定义参数
+   * - 默认查询逻辑只读取基础字段，额外字段会保留给 middleware.export 使用
+   */
+  exportInputSchema?: z.ZodType<TExportInput>;
   /**
    * Procedure 配置（统一字段）
    *
@@ -516,7 +554,7 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
    *   }),
    * }
    */
-  middleware?: CrudMiddleware<TContext, TSelect, TInsert, TUpdate>;
+  middleware?: CrudMiddleware<TContext, TSelect, TInsert, TUpdate, TListInput, TGetInput, TExportInput>;
 }
 interface CrudProcedures {
   list: AnyProcedure;
@@ -540,6 +578,94 @@ interface CrudProcedures {
 type CrudRouterReturn = ReturnType<typeof router> & {
   procedures: CrudProcedures;
 };
+declare const baseListInputSchema: z.ZodObject<{
+  page: z.ZodDefault<z.ZodNumber>;
+  perPage: z.ZodDefault<z.ZodNumber>;
+  sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    desc: z.ZodBoolean;
+  }, z.core.$strip>>>;
+  filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    variant: z.ZodEnum<{
+      number: "number";
+      boolean: "boolean";
+      date: "date";
+      text: "text";
+      range: "range";
+      dateRange: "dateRange";
+      select: "select";
+      multiSelect: "multiSelect";
+    }>;
+    operator: z.ZodEnum<{
+      iLike: "iLike";
+      notILike: "notILike";
+      eq: "eq";
+      ne: "ne";
+      isEmpty: "isEmpty";
+      isNotEmpty: "isNotEmpty";
+      lt: "lt";
+      lte: "lte";
+      gt: "gt";
+      gte: "gte";
+      isBetween: "isBetween";
+      isRelativeToToday: "isRelativeToToday";
+      inArray: "inArray";
+      notInArray: "notInArray";
+    }>;
+    filterId: z.ZodString;
+  }, z.core.$strip>>>;
+  joinOperator: z.ZodDefault<z.ZodEnum<{
+    and: "and";
+    or: "or";
+  }>>;
+}, z.core.$strip>;
+declare const baseGetInputSchema: z.ZodObject<{
+  id: z.ZodString;
+}, z.core.$strip>;
+declare const baseExportInputSchema: z.ZodObject<{
+  sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    desc: z.ZodBoolean;
+  }, z.core.$strip>>>;
+  filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    variant: z.ZodEnum<{
+      number: "number";
+      boolean: "boolean";
+      date: "date";
+      text: "text";
+      range: "range";
+      dateRange: "dateRange";
+      select: "select";
+      multiSelect: "multiSelect";
+    }>;
+    operator: z.ZodEnum<{
+      iLike: "iLike";
+      notILike: "notILike";
+      eq: "eq";
+      ne: "ne";
+      isEmpty: "isEmpty";
+      isNotEmpty: "isNotEmpty";
+      lt: "lt";
+      lte: "lte";
+      gt: "gt";
+      gte: "gte";
+      isBetween: "isBetween";
+      isRelativeToToday: "isRelativeToToday";
+      inArray: "inArray";
+      notInArray: "notInArray";
+    }>;
+    filterId: z.ZodString;
+  }, z.core.$strip>>>;
+  joinOperator: z.ZodDefault<z.ZodEnum<{
+    and: "and";
+    or: "or";
+  }>>;
+  limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
 /**
  * 创建 CRUD Router
  *
@@ -552,7 +678,7 @@ type CrudRouterReturn = ReturnType<typeof router> & {
  * @typeParam TInsert - 创建输入类型
  * @typeParam TUpdate - 更新输入类型
  */
-declare function createCrudRouter<TTable extends PgTable = PgTable, TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown>(config: CrudRouterConfig<TTable, TContext, TSelect, TInsert, TUpdate>): CrudRouterReturn;
+declare function createCrudRouter<TTable extends PgTable = PgTable, TContext = unknown, TSelect = unknown, TInsert = unknown, TUpdate = unknown, TListInput extends ListInput = ListInput, TGetInput extends GetInput = GetInput, TExportInput extends ExportInput = ExportInput>(config: CrudRouterConfig<TTable, TContext, TSelect, TInsert, TUpdate, TListInput, TGetInput, TExportInput>): CrudRouterReturn;
 //#endregion
 //#region src/lib/middleware-helpers.d.ts
 /**
@@ -611,6 +737,39 @@ type AnyMiddlewareParams<TContext> = {
  */
 declare function composeMiddleware<TContext, TResult>(...middlewares: Array<(params: AnyMiddlewareParams<TContext>) => Promise<any>>): (params: AnyMiddlewareParams<TContext>) => Promise<TResult>;
 //#endregion
+//#region src/types/hook-types.d.ts
+/**
+ * 从 CRUD Schema 类型自动推导 Hook 事件映射
+ *
+ * 生成两类 hook:
+ * 1. 生命周期 hook（beforeCreate / afterCreate 等）— 由 tRPC middleware 自动 emit
+ * 2. Procedure hook（create / update / list 等）— 供 emit 自动映射 tRPC 路由使用
+ *
+ * @typeParam PluginId    - 插件标识（如 'crm', 'shop'）
+ * @typeParam ResourceName - 资源名称（如 'customers', 'products'）
+ * @typeParam TCreate     - 创建输入类型（z.infer<typeof createSchema>）
+ * @typeParam TUpdate     - 更新输入类型（z.infer<typeof updateSchema>）
+ * @typeParam TSelect     - 查询返回类型（InferSelectModel<typeof table>）
+ * @typeParam TListInput  - list procedure 输入类型
+ * @typeParam TGetInput   - get procedure 输入类型
+ * @typeParam TExportInput - export procedure 输入类型
+ */
+type CrudHookEventMap<PluginId extends string, ResourceName extends string, TCreate, TUpdate, TSelect, TListInput extends ListInput = ListInput, TGetInput extends GetInput = string, TExportInput extends ExportInput = ExportInput> = { [K in `${PluginId}.${ResourceName}.beforeCreate`]: TCreate } & { [K in `${PluginId}.${ResourceName}.afterCreate`]: TSelect } & { [K in `${PluginId}.${ResourceName}.beforeUpdate`]: {
+  id: string;
+  data: TUpdate;
+} } & { [K in `${PluginId}.${ResourceName}.afterUpdate`]: TSelect } & { [K in `${PluginId}.${ResourceName}.beforeDelete`]: {
+  id: string;
+} } & { [K in `${PluginId}.${ResourceName}.afterDelete`]: TSelect } & { [K in `${PluginId}.${ResourceName}.create`]: TCreate } & { [K in `${PluginId}.${ResourceName}.update`]: {
+  id: string;
+  data: TUpdate;
+} } & { [K in `${PluginId}.${ResourceName}.delete`]: string } & { [K in `${PluginId}.${ResourceName}.deleteMany`]: string[] } & { [K in `${PluginId}.${ResourceName}.updateMany`]: {
+  ids: string[];
+  data: TUpdate;
+} } & { [K in `${PluginId}.${ResourceName}.upsert`]: TCreate } & { [K in `${PluginId}.${ResourceName}.get`]: TGetInput } & { [K in `${PluginId}.${ResourceName}.list`]: TListInput } & { [K in `${PluginId}.${ResourceName}.export`]: TExportInput } & { [K in `${PluginId}.${ResourceName}.import`]: {
+  rows: unknown[];
+  onConflict?: 'skip' | 'upsert' | 'error';
+} } & { [K in `${PluginId}.${ResourceName}.createMany`]: TCreate[] };
+//#endregion
 //#region src/routers/index.d.ts
 declare const appRouter: _trpc_server2.TRPCBuiltRouter<{
   ctx: Context;
@@ -620,4 +779,4 @@ declare const appRouter: _trpc_server2.TRPCBuiltRouter<{
 }, _trpc_server2.TRPCDecorateCreateRouterOptions<{}>>;
 type AppRouter = typeof appRouter;
 //#endregion
-export { type AnyProcedure, type AppRouter, type CreateManyMiddlewareParams, type CreateMiddlewareParams, type CrudMiddleware, type CrudOperation, type CrudProcedures, type CrudRouterConfig, type DeleteManyMiddlewareParams, type DeleteMiddlewareParams, type ExportInput, type ExportMiddlewareParams, type ExportResult, type GetMiddlewareParams, type ImportFailedRow, type ImportInput, type ImportMiddlewareParams, type ImportResult, type ListInput, type ListMiddlewareParams, type ListResult, type ProcedureConfig, type ProcedureFactory, type ProcedureMap, type SoftDeleteConfig, type SoftDeleteOption, type UpdateManyMiddlewareParams, type UpdateMiddlewareParams, type UpsertMiddlewareParams, type WriteOperation, afterMiddleware, appRouter, beforeMiddleware, composeMiddleware, createCrudRouter, publicProcedure, router };
+export { type AnyProcedure, type AppRouter, type CreateManyMiddlewareParams, type CreateMiddlewareParams, type CrudHookEventMap, type CrudMiddleware, type CrudOperation, type CrudProcedures, type CrudRouterConfig, type DeleteManyMiddlewareParams, type DeleteMiddlewareParams, type ExportInput, type ExportMiddlewareParams, type ExportResult, type GetInput, type GetMiddlewareParams, type ImportFailedRow, type ImportInput, type ImportMiddlewareParams, type ImportResult, type ListInput, type ListMiddlewareParams, type ListResult, type ProcedureConfig, type ProcedureFactory, type ProcedureMap, type SoftDeleteConfig, type SoftDeleteOption, type UpdateManyMiddlewareParams, type UpdateMiddlewareParams, type UpsertMiddlewareParams, type WriteOperation, afterMiddleware, appRouter, baseExportInputSchema, baseGetInputSchema, baseListInputSchema, beforeMiddleware, composeMiddleware, createCrudRouter, publicProcedure, router };