@wordrhyme/auto-crud-server 0.4.0 → 0.6.0

package/dist/index.d.cts

@@ -72,89 +72,107 @@ interface ListResult<TSelect> {
   pageCount: number;
 }
 /**
- * CRUD 生命周期钩子
+ * 操作包装器 - 类似 tRPC middleware 的 next 模式
+ *
+ * 功能：
+ * - 修改输入数据（传参给 next）
+ * - 修改返回值（处理 next 的结果）
+ * - 执行副作用（日志、通知、审计）
+ * - 条件拦截（不调用 next 直接返回/抛错）
+ * - 包装事务（try/catch 包裹 next）
  *
  * @example
- * hooks: {
- *   beforeCreate: async (ctx, data) => {
- *     // 修改数据
- *     return { ...data, slug: slugify(data.title) };
- *   },
- *   afterCreate: async (ctx, created) => {
- *     // 发送通知
- *     await sendNotification(created);
+ * // 修改输入 + 执行副作用
+ * middleware: {
+ *   create: async ({ ctx, input, next }) => {
+ *     const data = { ...input, slug: slugify(input.title) };
+ *     const result = await next(data);
+ *     await sendNotification(result);
+ *     return result;
  *   },
  * }
+ *
+ * @example
+ * // 简单副作用 - 使用工具函数
+ * import { afterMiddleware } from "@wordrhyme/auto-crud-server";
+ *
+ * middleware: {
+ *   create: afterMiddleware(async (ctx, result) => {
+ *     await sendEmail(result);
+ *   }),
+ * }
  */
-interface CrudHooks<TContext = unknown> {
-  /**
-   * 列表查询前
-   * 可修改查询参数
-   */
-  beforeList?: (ctx: TContext, input: ListInput) => ListInput | void | Promise<ListInput | void>;
-  /**
-   * 列表查询后
-   * 可修改返回结果
-   */
-  afterList?: <TSelect>(ctx: TContext, result: ListResult<TSelect>) => ListResult<TSelect> | void | Promise<ListResult<TSelect> | void>;
-  /**
-   * 单条查询前
-   */
-  beforeGet?: (ctx: TContext, id: string) => void | Promise<void>;
-  /**
-   * 单条查询后
-   * 可修改返回结果
-   */
-  afterGet?: <TSelect>(ctx: TContext, result: TSelect | null) => TSelect | null | void | Promise<TSelect | null | void>;
-  /**
-   * 创建前
-   * 可修改输入数据，返回新数据或抛出错误阻止创建
-   */
-  beforeCreate?: <TInsert>(ctx: TContext, data: TInsert) => TInsert | void | Promise<TInsert | void>;
+interface CrudMiddleware<TContext = unknown> {
   /**
-   * 创建后
-   * 用于副作用（日志、通知、同步等）
+   * 列表查询包装器
    */
-  afterCreate?: <TSelect>(ctx: TContext, created: TSelect) => void | Promise<void>;
+  list?: (params: {
+    ctx: TContext;
+    input: ListInput;
+    next: (input?: ListInput) => Promise<ListResult<unknown>>;
+  }) => Promise<ListResult<unknown>>;
   /**
-   * 更新前
-   * 可修改输入数据，existing 为更新前的记录
+   * 单条查询包装器
    */
-  beforeUpdate?: <TUpdate, TSelect>(ctx: TContext, id: string, data: TUpdate, existing: TSelect) => TUpdate | void | Promise<TUpdate | void>;
-  /**
-   * 更新后
-   */
-  afterUpdate?: <TSelect>(ctx: TContext, updated: TSelect) => void | Promise<void>;
+  get?: (params: {
+    ctx: TContext;
+    id: string;
+    next: () => Promise<unknown | null>;
+  }) => Promise<unknown | null>;
   /**
-   * 删除前
-   * existing 为删除前的记录，可抛出错误阻止删除
+   * 创建包装器
    */
-  beforeDelete?: <TSelect>(ctx: TContext, id: string, existing: TSelect) => void | Promise<void>;
+  create?: (params: {
+    ctx: TContext;
+    input: unknown;
+    next: (input?: unknown) => Promise<unknown>;
+  }) => Promise<unknown>;
   /**
-   * 删除后
+   * 更新包装器
+   * existing: 更新前的记录
    */
-  afterDelete?: <TSelect>(ctx: TContext, deleted: TSelect) => void | Promise<void>;
+  update?: (params: {
+    ctx: TContext;
+    id: string;
+    data: unknown;
+    existing: unknown;
+    next: (data?: unknown) => Promise<unknown>;
+  }) => Promise<unknown>;
   /**
-   * 批量删除前
+   * 删除包装器
+   * existing: 删除前的记录
    */
-  beforeDeleteMany?: (ctx: TContext, ids: string[]) => void | Promise<void>;
+  delete?: (params: {
+    ctx: TContext;
+    id: string;
+    existing: unknown;
+    next: () => Promise<unknown>;
+  }) => Promise<unknown>;
   /**
-   * 批量删除后
+   * 批量删除包装器
    */
-  afterDeleteMany?: (ctx: TContext, result: {
+  deleteMany?: (params: {
+    ctx: TContext;
+    ids: string[];
+    next: () => Promise<{
+      deleted: number;
+    }>;
+  }) => Promise<{
     deleted: number;
-  }) => void | Promise<void>;
-  /**
-   * 批量更新前
-   * 可修改输入数据
-   */
-  beforeUpdateMany?: <TUpdate>(ctx: TContext, ids: string[], data: TUpdate) => TUpdate | void | Promise<TUpdate | void>;
+  }>;
   /**
-   * 批量更新后
+   * 批量更新包装器
    */
-  afterUpdateMany?: (ctx: TContext, result: {
+  updateMany?: (params: {
+    ctx: TContext;
+    ids: string[];
+    data: unknown;
+    next: (data?: unknown) => Promise<{
+      updated: number;
+    }>;
+  }) => Promise<{
     updated: number;
-  }) => void | Promise<void>;
+  }>;
 }
 interface CrudRouterConfigBase<TContext = unknown> {
   /** Drizzle 表定义 */
@@ -192,20 +210,34 @@ interface CrudRouterConfigBase<TContext = unknown> {
    */
   softDelete?: SoftDeleteOption;
   /**
-   * 生命周期钩子
-   * 在 CRUD 操作前后注入自定义逻辑
+   * 操作中间件
+   * 类似 tRPC middleware 的 next 模式，完全控制操作流程
    *
    * @example
-   * hooks: {
-   *   beforeCreate: async (ctx, data) => {
-   *     return { ...data, slug: slugify(data.title) };
-   *   },
-   *   afterCreate: async (ctx, created) => {
-   *     await sendNotification(created);
+   * // 完整控制
+   * middleware: {
+   *   create: async ({ ctx, input, next }) => {
+   *     const data = { ...input, slug: slugify(input.title) };
+   *     const result = await next(data);
+   *     await sendNotification(result);
+   *     return result;
    *   },
    * }
+   *
+   * @example
+   * // 使用工具函数简化
+   * import { afterMiddleware, beforeMiddleware } from "@wordrhyme/auto-crud-server";
+   *
+   * middleware: {
+   *   create: afterMiddleware(async (ctx, result) => {
+   *     await sendEmail(result);
+   *   }),
+   *   update: beforeMiddleware(async (ctx, data) => {
+   *     return { ...data, updatedAt: new Date() };
+   *   }),
+   * }
    */
-  hooks?: CrudHooks<TContext>;
+  middleware?: CrudMiddleware<TContext>;
 }
 interface DeclarativeConfig<TContext = unknown> extends CrudRouterConfigBase<TContext> {
   mode?: "declarative";
@@ -326,6 +358,134 @@ declare function createCrudRouter<TContext = unknown>(config: CrudRouterConfig<T
   };
 };
 //#endregion
+//#region src/lib/middleware-helpers.d.ts
+type NextFn<TInput, TResult> = (input?: TInput) => Promise<TResult>;
+interface MiddlewareParams<TContext, TInput, TResult> {
+  ctx: TContext;
+  input?: TInput;
+  next: NextFn<TInput, TResult>;
+}
+/**
+ * 创建 after-only 的 middleware（最常见场景）
+ * 在操作完成后执行副作用，不修改返回值
+ *
+ * @example
+ * middleware: {
+ *   create: afterMiddleware(async (ctx, result) => {
+ *     await sendEmail(result);
+ *     await logAudit(ctx.user, 'create', result);
+ *   }),
+ * }
+ */
+declare function afterMiddleware<TContext, TResult>(fn: (ctx: TContext, result: TResult) => void | Promise<void>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<TResult>;
+}) => Promise<TResult>;
+/**
+ * 创建 after-only 的 middleware，可修改返回值
+ *
+ * @example
+ * middleware: {
+ *   get: afterMiddlewareTransform(async (ctx, result) => {
+ *     return { ...result, computed: calculateSomething(result) };
+ *   }),
+ * }
+ */
+declare function afterMiddlewareTransform<TContext, TResult>(fn: (ctx: TContext, result: TResult) => TResult | Promise<TResult>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<TResult>;
+}) => Promise<TResult>;
+/**
+ * 创建 before-only 的 middleware
+ * 在操作执行前修改输入数据
+ *
+ * @example
+ * middleware: {
+ *   create: beforeMiddleware(async (ctx, input) => {
+ *     return { ...input, slug: slugify(input.title), createdBy: ctx.user.id };
+ *   }),
+ * }
+ */
+declare function beforeMiddleware<TContext, TInput>(fn: (ctx: TContext, input: TInput) => TInput | Promise<TInput>): <TResult>({
+  ctx,
+  input,
+  next
+}: MiddlewareParams<TContext, TInput, TResult>) => Promise<TResult>;
+/**
+ * 组合多个 middleware 为一个
+ *
+ * @example
+ * middleware: {
+ *   create: composeMiddleware(
+ *     beforeMiddleware((ctx, input) => ({ ...input, slug: slugify(input.title) })),
+ *     afterMiddleware((ctx, result) => sendEmail(result)),
+ *   ),
+ * }
+ */
+declare function composeMiddleware<TContext, TInput, TResult>(...middlewares: Array<(params: MiddlewareParams<TContext, TInput, TResult>) => Promise<TResult>>): (params: MiddlewareParams<TContext, TInput, TResult>) => Promise<TResult>;
+/**
+ * 创建 list 操作的 after middleware
+ */
+declare function afterList<TContext, TSelect>(fn: (ctx: TContext, result: ListResult<TSelect>) => void | Promise<void>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<ListResult<TSelect>>;
+}) => Promise<ListResult<TSelect>>;
+/**
+ * 创建 list 操作的 before middleware
+ */
+declare function beforeList<TContext>(fn: (ctx: TContext, input: ListInput) => ListInput | Promise<ListInput>): <TResult>({
+  ctx,
+  input,
+  next
+}: MiddlewareParams<TContext, ListInput, TResult>) => Promise<TResult>;
+/**
+ * 创建 create 操作的 after middleware
+ */
+declare function afterCreate<TContext, TSelect>(fn: (ctx: TContext, created: TSelect) => void | Promise<void>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<TSelect>;
+}) => Promise<TSelect>;
+/**
+ * 创建 create 操作的 before middleware
+ */
+declare function beforeCreate<TContext, TInsert>(fn: (ctx: TContext, input: TInsert) => TInsert | Promise<TInsert>): <TResult>({
+  ctx,
+  input,
+  next
+}: MiddlewareParams<TContext, TInsert, TResult>) => Promise<TResult>;
+/**
+ * 创建 update 操作的 after middleware
+ */
+declare function afterUpdate<TContext, TSelect>(fn: (ctx: TContext, updated: TSelect) => void | Promise<void>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<TSelect>;
+}) => Promise<TSelect>;
+/**
+ * 创建 delete 操作的 after middleware
+ */
+declare function afterDelete<TContext, TSelect>(fn: (ctx: TContext, deleted: TSelect) => void | Promise<void>): ({
+  ctx,
+  next
+}: {
+  ctx: TContext;
+  next: () => Promise<TSelect>;
+}) => Promise<TSelect>;
+//#endregion
 //#region src/routers/index.d.ts
 declare const appRouter: _trpc_server5.TRPCBuiltRouter<{
   ctx: Context;
@@ -335,4 +495,4 @@ declare const appRouter: _trpc_server5.TRPCBuiltRouter<{
 }, _trpc_server5.TRPCDecorateCreateRouterOptions<{}>>;
 type AppRouter = typeof appRouter;
 //#endregion
-export { type AnyProcedure, type AppRouter, type CrudHooks, type CrudOperation, type CrudRouterConfig, type DeclarativeConfig, type FactoryConfig, type ListInput, type ListResult, type ProceduresConfig, type SoftDeleteConfig, type SoftDeleteOption, type WriteOperation, appRouter, createCrudRouter, publicProcedure, router };
+export { type AnyProcedure, type AppRouter, type CrudMiddleware, type CrudOperation, type CrudRouterConfig, type DeclarativeConfig, type FactoryConfig, type ListInput, type ListResult, type ProceduresConfig, type SoftDeleteConfig, type SoftDeleteOption, type WriteOperation, afterCreate, afterDelete, afterList, afterMiddleware, afterMiddlewareTransform, afterUpdate, appRouter, beforeCreate, beforeList, beforeMiddleware, composeMiddleware, createCrudRouter, publicProcedure, router };