@wordrhyme/auto-crud-server 0.6.0 → 0.6.2

package/README.md

@@ -136,7 +136,7 @@ export { handler as GET, handler as POST };
 
 ## 📖 自动生成的路由
 
-`createCrudRouter` 会自动生成以下 7 个路由：
+`createCrudRouter` 会自动生成以下 8 个路由：
 
 ### 1. `list` - 列表查询
 
@@ -299,6 +299,42 @@ await trpc.tasks.updateMany({
 });
 ```
 
+### 8. `upsert` - 存在则更新，不存在则创建
+
+**输入**:
+```typescript
+Omit<Task, "createdAt" | "updatedAt">  // 需要包含 id
+```
+
+**输出**:
+```typescript
+{
+  data: Task;       // 创建或更新后的记录
+  isNew: boolean;   // true = 新建, false = 更新
+}
+```
+
+**示例**:
+```typescript
+// 如果 id="123" 存在则更新，不存在则创建
+const { data, isNew } = await trpc.tasks.upsert({
+  id: "123",
+  title: "My Task",
+  status: "todo",
+});
+
+if (isNew) {
+  console.log("Created new task");
+} else {
+  console.log("Updated existing task");
+}
+```
+
+**适用场景**：
+- 同步外部数据
+- 幂等导入
+- 配置项更新
+
 ---
 
 ## 🎯 高级过滤

package/dist/index.cjs

@@ -474,6 +474,14 @@ function validateColumn(columnId, allowedColumns) {
 	if (!allowedColumns || allowedColumns.length === 0) return true;
 	return allowedColumns.includes(columnId);
 }
+/**
+* 创建 CRUD Router
+*
+* @typeParam TContext - 上下文类型（包含 db）
+* @typeParam TSelect - 查询返回类型（从 selectSchema 或 insertSchema 推断）
+* @typeParam TInsert - 创建输入类型（从 insertSchema 推断）
+* @typeParam TUpdate - 更新输入类型（从 updateSchema 推断）
+*/
 function createCrudRouter(config) {
 	const { table, insertSchema, updateSchema, idField = "id", filterableColumns, sortableColumns, maxBatchSize = 100, softDelete: softDeleteOption, middleware = {} } = config;
 	const resolved = resolveConfig(config);
@@ -485,7 +493,7 @@ function createCrudRouter(config) {
 		const conditions = [];
 		const scopeCondition = resolved.getScope(ctx, table, operation);
 		if (scopeCondition) conditions.push(scopeCondition);
-		if (softDelete && (operation === "list" || operation === "get")) {
+		if (softDelete) {
 			const col = getSoftDeleteColumn();
 			if (col) conditions.push((0, drizzle_orm.isNull)(col));
 		}
@@ -496,12 +504,27 @@ function createCrudRouter(config) {
 	};
 	const withGuard = async (ctx, operation) => {
 		if (resolved.guard) {
-			if (!await resolved.guard(ctx, operation)) throw new Error(`Forbidden: ${operation} not allowed`);
+			if (operation === "upsert") {
+				const canCreate = await resolved.guard(ctx, "create");
+				const canUpdate = await resolved.guard(ctx, "update");
+				if (!canCreate || !canUpdate) throw new __trpc_server.TRPCError({
+					code: "FORBIDDEN",
+					message: "Forbidden: upsert requires both create and update permissions"
+				});
+				return;
+			}
+			if (!await resolved.guard(ctx, operation)) throw new __trpc_server.TRPCError({
+				code: "FORBIDDEN",
+				message: `Forbidden: ${operation} not allowed`
+			});
 		}
 	};
 	const withAuthorize = async (ctx, resource, operation) => {
 		if (!resource) return;
-		if (!await resolved.checkAuthorize(ctx, resource, operation)) throw new Error(`Forbidden: Cannot ${operation} this resource`);
+		if (!await resolved.checkAuthorize(ctx, resource, operation)) throw new __trpc_server.TRPCError({
+			code: "FORBIDDEN",
+			message: `Forbidden: Cannot ${operation} this resource`
+		});
 	};
 	const procedures = {
 		list: resolved.procedureFactory("list").input(listInputSchema).query(async ({ ctx, input }) => {
@@ -543,7 +566,7 @@ function createCrudRouter(config) {
 			});
 			return doList(listInput);
 		}),
-		getById: resolved.procedureFactory("get").input(zod.z.string()).query(async ({ ctx, input }) => {
+		get: resolved.procedureFactory("get").input(zod.z.string()).query(async ({ ctx, input }) => {
 			await withGuard(ctx, "get");
 			const doGet = async () => {
 				const where = buildWhere(ctx, "get", (0, drizzle_orm.eq)(getIdColumn(), input));
@@ -584,7 +607,10 @@ function createCrudRouter(config) {
 			const where = buildWhere(ctx, "update", (0, drizzle_orm.eq)(getIdColumn(), input.id));
 			const [existing] = await ctx.db.select().from(table).where(where);
 			await withAuthorize(ctx, existing, "update");
-			if (!existing) throw new Error("Resource not found or access denied");
+			if (!existing) throw new __trpc_server.TRPCError({
+				code: "NOT_FOUND",
+				message: "Resource not found or access denied"
+			});
 			const doUpdate = async (updateData) => {
 				const injectData = resolved.getInject(ctx, "update");
 				const data = {
@@ -608,7 +634,10 @@ function createCrudRouter(config) {
 			const where = buildWhere(ctx, "delete", (0, drizzle_orm.eq)(getIdColumn(), input));
 			const [existing] = await ctx.db.select().from(table).where(where);
 			await withAuthorize(ctx, existing, "delete");
-			if (!existing) throw new Error("Resource not found or access denied");
+			if (!existing) throw new __trpc_server.TRPCError({
+				code: "NOT_FOUND",
+				message: "Resource not found or access denied"
+			});
 			const doDelete = async () => {
 				let deleted;
 				if (softDelete) [deleted] = await ctx.db.update(table).set({ [softDelete.column]: softDelete.getValue() }).where(where).returning();
@@ -627,8 +656,8 @@ function createCrudRouter(config) {
 			await withGuard(ctx, "deleteMany");
 			const where = buildWhere(ctx, "deleteMany", (0, drizzle_orm.inArray)(getIdColumn(), input));
 			const doDeleteMany = async () => {
-				if (softDelete) return { deleted: (await ctx.db.update(table).set({ [softDelete.column]: softDelete.getValue() }).where(where).returning()).length };
-				else return { deleted: (await ctx.db.delete(table).where(where).returning()).length };
+				if (softDelete) return { deleted: (await ctx.db.update(table).set({ [softDelete.column]: softDelete.getValue() }).where(where).returning({ id: getIdColumn() })).length };
+				else return { deleted: (await ctx.db.delete(table).where(where).returning({ id: getIdColumn() })).length };
 			};
 			if (m.deleteMany) return m.deleteMany({
 				ctx,
@@ -649,7 +678,7 @@ function createCrudRouter(config) {
 					...updateData,
 					...injectData
 				};
-				return { updated: (await ctx.db.update(table).set(data).where(where).returning()).length };
+				return { updated: (await ctx.db.update(table).set(data).where(where).returning({ id: getIdColumn() })).length };
 			};
 			if (m.updateMany) return m.updateMany({
 				ctx,
@@ -658,6 +687,43 @@ function createCrudRouter(config) {
 				next: async (modifiedData) => doUpdateMany(modifiedData ?? input.data)
 			});
 			return doUpdateMany(input.data);
+		}),
+		upsert: resolved.procedureFactory("upsert").input(insertSchema).mutation(async ({ ctx, input }) => {
+			await withGuard(ctx, "upsert");
+			const doUpsert = async (inputData) => {
+				const inputId = inputData[idField];
+				let isNew = true;
+				let existing = null;
+				if (inputId) {
+					const where = buildWhere(ctx, "get", (0, drizzle_orm.eq)(getIdColumn(), inputId));
+					const [found] = await ctx.db.select().from(table).where(where);
+					existing = found;
+					isNew = !existing;
+					if (!isNew && existing) await withAuthorize(ctx, existing, "update");
+				}
+				const injectData = resolved.getInject(ctx, isNew ? "create" : "update");
+				const data = {
+					...inputData,
+					...injectData
+				};
+				const [result] = await ctx.db.insert(table).values(data).onConflictDoUpdate({
+					target: getIdColumn(),
+					set: {
+						...inputData,
+						...resolved.getInject(ctx, "update")
+					}
+				}).returning();
+				return {
+					data: result,
+					isNew
+				};
+			};
+			if (m.upsert) return m.upsert({
+				ctx,
+				input,
+				next: async (modifiedInput) => doUpsert(modifiedInput ?? input)
+			});
+			return doUpsert(input);
 		})
 	};
 	const crudRouter = router(procedures);
@@ -667,6 +733,10 @@ function createCrudRouter(config) {
 //#endregion
 //#region src/lib/middleware-helpers.ts
 /**
+* Middleware 便捷工具函数
+* 简化常见场景的 middleware 创建
+*/
+/**
 * 创建 after-only 的 middleware（最常见场景）
 * 在操作完成后执行副作用，不修改返回值
 *
@@ -679,28 +749,13 @@ function createCrudRouter(config) {
 * }
 */
 function afterMiddleware(fn) {
-	return async ({ ctx, next }) => {
-		const result = await next();
-		await fn(ctx, result);
+	return async (params) => {
+		const result = await params.next();
+		await fn(params.ctx, result);
 		return result;
 	};
 }
 /**
-* 创建 after-only 的 middleware，可修改返回值
-*
-* @example
-* middleware: {
-*   get: afterMiddlewareTransform(async (ctx, result) => {
-*     return { ...result, computed: calculateSomething(result) };
-*   }),
-* }
-*/
-function afterMiddlewareTransform(fn) {
-	return async ({ ctx, next }) => {
-		return fn(ctx, await next());
-	};
-}
-/**
 * 创建 before-only 的 middleware
 * 在操作执行前修改输入数据
 *
@@ -712,8 +767,9 @@ function afterMiddlewareTransform(fn) {
 * }
 */
 function beforeMiddleware(fn) {
-	return async ({ ctx, input, next }) => {
-		return next(await fn(ctx, input));
+	return async (params) => {
+		const modifiedInput = await fn(params.ctx, params.input);
+		return params.next(modifiedInput);
 	};
 }
 /**
@@ -730,69 +786,25 @@ function beforeMiddleware(fn) {
 function composeMiddleware(...middlewares) {
 	return async (params) => {
 		let index = 0;
-		const executeNext = async (input) => {
-			if (index >= middlewares.length) return params.next(input);
+		const executeNext = async (...args) => {
+			if (index >= middlewares.length) return params.next(...args);
 			const currentMiddleware = middlewares[index++];
 			return currentMiddleware({
-				ctx: params.ctx,
-				input,
+				...params,
 				next: executeNext
 			});
 		};
-		return executeNext(params.input);
+		return executeNext();
 	};
 }
-/**
-* 创建 list 操作的 after middleware
-*/
-function afterList(fn) {
-	return afterMiddleware(fn);
-}
-/**
-* 创建 list 操作的 before middleware
-*/
-function beforeList(fn) {
-	return beforeMiddleware(fn);
-}
-/**
-* 创建 create 操作的 after middleware
-*/
-function afterCreate(fn) {
-	return afterMiddleware(fn);
-}
-/**
-* 创建 create 操作的 before middleware
-*/
-function beforeCreate(fn) {
-	return beforeMiddleware(fn);
-}
-/**
-* 创建 update 操作的 after middleware
-*/
-function afterUpdate(fn) {
-	return afterMiddleware(fn);
-}
-/**
-* 创建 delete 操作的 after middleware
-*/
-function afterDelete(fn) {
-	return afterMiddleware(fn);
-}
 
 //#endregion
 //#region src/routers/index.ts
 const appRouter = router({});
 
 //#endregion
-exports.afterCreate = afterCreate;
-exports.afterDelete = afterDelete;
-exports.afterList = afterList;
 exports.afterMiddleware = afterMiddleware;
-exports.afterMiddlewareTransform = afterMiddlewareTransform;
-exports.afterUpdate = afterUpdate;
 exports.appRouter = appRouter;
-exports.beforeCreate = beforeCreate;
-exports.beforeList = beforeList;
 exports.beforeMiddleware = beforeMiddleware;
 exports.composeMiddleware = composeMiddleware;
 exports.createCrudRouter = createCrudRouter;