@wordrhyme/auto-crud-server 1.1.5 → 1.1.8

package/README.md

@@ -83,7 +83,7 @@ import { tasks } from '@/db/schema';
 // 🚀 零配置！一行代码生成完整 CRUD 路由
 export const tasksRouter = createCrudRouter({
   table: tasks,
-  // Schema 自动从 table 派生，排除 id, createdAt, updatedAt
+  // Schema 自动从 table 派生，排除平台托管字段
 });
 ```
 
@@ -169,6 +169,9 @@ export { handler as GET, handler as POST };
 }
 ```
 
+未传 `sort` 或传空数组时，如果表存在 `createdAt` 且未被 `sortableColumns`
+白名单排除，列表默认按 `createdAt` 降序返回。
+
 **输出**:
 
 ```typescript
@@ -491,18 +494,18 @@ interface CrudRouterConfig<TTable, TSelect, TInsert, TUpdate> {
   idField?: string; // ID 字段名，默认 "id"
   filterableColumns?: CrudColumnRef<TTable>[]; // 可过滤字段白名单
   sortableColumns?: CrudColumnRef<TTable>[]; // 可排序字段白名单
-  omitFields?: string[]; // 自动派生时排除的字段
-  // 默认 ["id", "createdAt", "updatedAt"]
+  omitFields?: string[]; // 自动派生时额外排除的业务字段
+  // 默认已排除 ["id", "createdAt", "updatedAt", "createdBy", "createdByType", "updatedBy", "updatedByType"]
 }
 ```
 
 #### Schema 派生规则
 
-| 配置              | 派生行为                                    |
-| ----------------- | ------------------------------------------- |
-| 无 `schema`       | 从 `table` 自动派生，排除 `omitFields`      |
-| 无 `updateSchema` | 从 `schema.partial().refine(nonEmpty)` 派生 |
-| 无 `selectSchema` | 若有 `schema` 则使用它，否则从 `table` 派生 |
+| 配置              | 派生行为                                             |
+| ----------------- | ---------------------------------------------------- |
+| 无 `schema`       | 从 `table` 自动派生，排除默认托管字段和 `omitFields` |
+| 无 `updateSchema` | 从 `schema.partial().refine(nonEmpty)` 派生          |
+| 无 `selectSchema` | 若有 `schema` 则使用它，否则从 `table` 派生          |
 
 #### 使用示例
 
@@ -528,7 +531,7 @@ const usersRouter = createCrudRouter({
 // 4. 自定义排除字段
 const ordersRouter = createCrudRouter({
   table: orders,
-  omitFields: ['id', 'createdAt', 'updatedAt', 'internalCode'],
+  omitFields: ['internalCode'],
 });
 ```
 
@@ -992,8 +995,8 @@ export const usersRouter = createCrudRouter({
 ```typescript
 export const ordersRouter = createCrudRouter({
   table: orders,
-  // 自动派生 schema 时排除这些字段
-  omitFields: ['id', 'createdAt', 'updatedAt', 'internalCode'],
+  // 自动派生 schema 时额外排除这些字段；默认托管字段无需重复写
+  omitFields: ['internalCode'],
 });
 ```
 

package/dist/index.cjs

@@ -432,6 +432,9 @@ function nonEmpty(value) {
 
 //#endregion
 //#region src/routers/_factory.ts
+function normalizePluginRouteId(pluginId) {
+	return pluginId.replace(/^com\.wordrhyme\./, "").replace(/\./g, "-");
+}
 function resolveSoftDelete(option) {
 	if (!option) return null;
 	if (option === true) return {
@@ -559,7 +562,11 @@ const importInputSchema = zod.z.object({
 const DEFAULT_OMIT_FIELDS = [
 	"id",
 	"createdAt",
-	"updatedAt"
+	"updatedAt",
+	"createdBy",
+	"createdByType",
+	"updatedBy",
+	"updatedByType"
 ];
 function shouldEnableCrudExtensionSchema(config) {
 	return Boolean(config.id) && config.extensions !== false;
@@ -573,19 +580,30 @@ function withCrudExtensionInput(schema, config) {
 * - 优先使用显式传入的 Schema
 * - 否则从 Drizzle table 自动派生
 */
-function resolveSchemas(config) {
-	const { table, omitFields = DEFAULT_OMIT_FIELDS } = config;
+function resolveSchemas(config, idField = "id") {
+	const { table } = config;
+	const omitFields = [...new Set([...DEFAULT_OMIT_FIELDS, ...config.omitFields ?? []])];
 	let schema;
+	let upsertSchema;
+	let importSchema;
 	if (config.schema) {
 		if (!isZodObject(config.schema)) throw new Error("[createCrudRouter] schema must be a ZodObject (not ZodEffects or other types). If you're using .refine() or .transform(), please remove them from schema.");
 		schema = config.schema;
+		upsertSchema = schema;
+		importSchema = schema;
 	} else {
 		const rawSchema = (0, drizzle_zod.createInsertSchema)(table);
 		if (!isZodObject(rawSchema)) throw new Error("[createCrudRouter] drizzle-zod returned non-ZodObject schema. This may be due to table refinements. Please provide schema explicitly.");
-		const omitConfig = Object.fromEntries(omitFields.map((f) => [f, true]));
+		const omitConfig = Object.fromEntries(omitFields.filter((field) => field in rawSchema.shape).map((field) => [field, true]));
 		schema = rawSchema.omit(omitConfig);
+		const idSchema = rawSchema.shape[idField];
+		const schemaWithOptionalId = idSchema && !(idField in schema.shape) ? schema.extend({ [idField]: idSchema.optional() }) : schema;
+		upsertSchema = schemaWithOptionalId;
+		importSchema = schemaWithOptionalId;
 	}
 	schema = withCrudExtensionInput(schema, config);
+	upsertSchema = withCrudExtensionInput(upsertSchema, config);
+	importSchema = withCrudExtensionInput(importSchema, config);
 	let selectSchema;
 	if (config.selectSchema) selectSchema = config.selectSchema;
 	else if (config.schema) selectSchema = schema;
@@ -594,6 +612,8 @@ function resolveSchemas(config) {
 	return {
 		selectSchema,
 		schema,
+		upsertSchema,
+		importSchema,
 		updateSchema
 	};
 }
@@ -648,9 +668,14 @@ function readCrudTarget(config) {
 	if (!id) return null;
 	return { id };
 }
-function buildCrudLifecycleHookId(config, operation) {
+function buildCrudLifecycleHookId(config, operation, ctx) {
 	const target = readCrudTarget(config);
 	if (!target) return null;
+	const pluginId = ctx?.pluginId;
+	if (typeof pluginId === "string" && target.id.startsWith(`${pluginId}.`)) {
+		const resourceId = target.id.slice(pluginId.length + 1);
+		if (resourceId) return `${normalizePluginRouteId(pluginId)}.${resourceId}.${operation}`;
+	}
 	return `${target.id}.${operation}`;
 }
 function getCrudLifecycleHooks(ctx) {
@@ -658,10 +683,10 @@ function getCrudLifecycleHooks(ctx) {
 	return typeof hooks?.emit === "function" ? hooks : null;
 }
 function shouldWrapCrudLifecycleTransaction(ctx, config) {
-	return Boolean(buildCrudLifecycleHookId(config, "create") && getCrudLifecycleHooks(ctx));
+	return Boolean(buildCrudLifecycleHookId(config, "create", ctx) && getCrudLifecycleHooks(ctx));
 }
 async function emitCrudWriteLifecycle(ctx, config, operation, payload) {
-	const hookId = buildCrudLifecycleHookId(config, operation);
+	const hookId = buildCrudLifecycleHookId(config, operation, ctx);
 	const hooks = getCrudLifecycleHooks(ctx);
 	if (!hookId || !hooks) return;
 	await hooks.emit(hookId, payload, {
@@ -919,7 +944,7 @@ function combineConditions(...conditions) {
 */
 function createCrudRouter(config) {
 	const { table, idField = "id", filterableColumns, searchColumns, sortableColumns, maxBatchSize = 100, maxExportSize = 5e3, softDelete: softDeleteOption, middleware = {} } = config;
-	const { selectSchema, schema, updateSchema } = resolveSchemas(config);
+	const { selectSchema, schema, upsertSchema, importSchema, updateSchema } = resolveSchemas(config, idField);
 	const entityOutputSchema = withCrudExtensionInput(selectSchema, config);
 	const listOutputSchema = zod.z.object({
 		data: zod.z.array(entityOutputSchema),
@@ -1039,9 +1064,12 @@ function createCrudRouter(config) {
 				})));
 				let query = ctx.db.select().from(table).$dynamic();
 				if (where) query = query.where(where);
-				if (effectiveInput.sort?.length) {
-					const sortField = effectiveInput.sort[0];
-					if (sortField && validateColumn(sortField.id, sortableColumns)) {
+				const sortField = effectiveInput.sort?.[0] ?? (getTableColumn(table, "createdAt") ? {
+					id: "createdAt",
+					desc: true
+				} : void 0);
+				if (sortField) {
+					if (validateColumn(sortField.id, sortableColumns)) {
 						const column = resolveColumnTarget({
 							table,
 							columnId: sortField.id,
@@ -1247,7 +1275,7 @@ function createCrudRouter(config) {
 			});
 			return doUpdateMany(input.data);
 		}),
-		upsert: resolved.procedureFactory("upsert").input(schema).output(upsertOutputSchema).mutation(async ({ ctx, input }) => {
+		upsert: resolved.procedureFactory("upsert").input(upsertSchema).output(upsertOutputSchema).mutation(async ({ ctx, input }) => {
 			await withGuard(ctx, "upsert");
 			const doUpsert = async (inputData) => {
 				const splitInput = splitCrudExtensionWriteInput(inputData, tableColumnNames);
@@ -1392,7 +1420,7 @@ function createCrudRouter(config) {
 				const failed = [];
 				for (let i = 0; i < importData$1.rows.length; i++) {
 					const row = importData$1.rows[i];
-					const result = schema.safeParse(row);
+					const result = importSchema.safeParse(row);
 					if (result.success) {
 						const splitRow = splitCrudExtensionWriteInput(result.data, tableColumnNames);
 						validRows.push(splitRow);

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { PgTable } from "drizzle-orm/pg-core";
-import * as _trpc_server0 from "@trpc/server";
+import * as _trpc_server2 from "@trpc/server";
 import { PostgresJsDatabase } from "drizzle-orm/postgres-js";
 import { AnyColumn, SQL } from "drizzle-orm";
 
@@ -12,13 +12,13 @@ import { AnyColumn, SQL } from "drizzle-orm";
 interface Context {
   db: PostgresJsDatabase<Record<string, never>>;
 }
-declare const router: _trpc_server0.TRPCRouterBuilder<{
+declare const router: _trpc_server2.TRPCRouterBuilder<{
   ctx: Context;
   meta: object;
-  errorShape: _trpc_server0.TRPCDefaultErrorShape;
+  errorShape: _trpc_server2.TRPCDefaultErrorShape;
   transformer: true;
 }>;
-declare const publicProcedure: _trpc_server0.TRPCProcedureBuilder<Context, object, object, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, false>;
+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';
@@ -581,7 +581,7 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
   authorize?: (ctx: TContext, resource: TSelect, operation: CrudOperation) => boolean | Promise<boolean>;
   /**
    * 要从 schema 排除的字段（自动派生时使用）
-   * @default ["id", "createdAt", "updatedAt"]
+   * @default ["id", "createdAt", "updatedAt", "createdBy", "createdByType", "updatedBy", "updatedByType"]
    */
   omitFields?: TableColumnKeys<TTable>[];
   /** ID 字段名，默认 "id" */
@@ -890,12 +890,12 @@ type CrudHookEventMap<PluginId extends string, ResourceName extends string, TCre
 } } & { [K in `${PluginId}.${ResourceName}.createMany`]: TCreate[] };
 //#endregion
 //#region src/routers/index.d.ts
-declare const appRouter: _trpc_server0.TRPCBuiltRouter<{
+declare const appRouter: _trpc_server2.TRPCBuiltRouter<{
   ctx: Context;
   meta: object;
-  errorShape: _trpc_server0.TRPCDefaultErrorShape;
+  errorShape: _trpc_server2.TRPCDefaultErrorShape;
   transformer: true;
-}, _trpc_server0.TRPCDecorateCreateRouterOptions<{}>>;
+}, _trpc_server2.TRPCDecorateCreateRouterOptions<{}>>;
 type AppRouter = typeof appRouter;
 //#endregion
 export { type AnyProcedure, type AppRouter, type CreateManyMiddlewareParams, type CreateMiddlewareParams, type CrudColumnConfig, type CrudColumnExpression, type CrudColumnRef, type CrudExtensionFilter, type CrudExtensionMetadata, type CrudExtensionsConfig, type CrudExtensionsProvider, 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 };

package/dist/index.d.ts

@@ -582,7 +582,7 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
   authorize?: (ctx: TContext, resource: TSelect, operation: CrudOperation) => boolean | Promise<boolean>;
   /**
    * 要从 schema 排除的字段（自动派生时使用）
-   * @default ["id", "createdAt", "updatedAt"]
+   * @default ["id", "createdAt", "updatedAt", "createdBy", "createdByType", "updatedBy", "updatedByType"]
    */
   omitFields?: TableColumnKeys<TTable>[];
   /** ID 字段名，默认 "id" */

package/dist/index.js

@@ -403,6 +403,9 @@ function nonEmpty(value) {
 
 //#endregion
 //#region src/routers/_factory.ts
+function normalizePluginRouteId(pluginId) {
+	return pluginId.replace(/^com\.wordrhyme\./, "").replace(/\./g, "-");
+}
 function resolveSoftDelete(option) {
 	if (!option) return null;
 	if (option === true) return {
@@ -530,7 +533,11 @@ const importInputSchema = z.object({
 const DEFAULT_OMIT_FIELDS = [
 	"id",
 	"createdAt",
-	"updatedAt"
+	"updatedAt",
+	"createdBy",
+	"createdByType",
+	"updatedBy",
+	"updatedByType"
 ];
 function shouldEnableCrudExtensionSchema(config) {
 	return Boolean(config.id) && config.extensions !== false;
@@ -544,19 +551,30 @@ function withCrudExtensionInput(schema, config) {
 * - 优先使用显式传入的 Schema
 * - 否则从 Drizzle table 自动派生
 */
-function resolveSchemas(config) {
-	const { table, omitFields = DEFAULT_OMIT_FIELDS } = config;
+function resolveSchemas(config, idField = "id") {
+	const { table } = config;
+	const omitFields = [...new Set([...DEFAULT_OMIT_FIELDS, ...config.omitFields ?? []])];
 	let schema;
+	let upsertSchema;
+	let importSchema;
 	if (config.schema) {
 		if (!isZodObject(config.schema)) throw new Error("[createCrudRouter] schema must be a ZodObject (not ZodEffects or other types). If you're using .refine() or .transform(), please remove them from schema.");
 		schema = config.schema;
+		upsertSchema = schema;
+		importSchema = schema;
 	} else {
 		const rawSchema = createInsertSchema(table);
 		if (!isZodObject(rawSchema)) throw new Error("[createCrudRouter] drizzle-zod returned non-ZodObject schema. This may be due to table refinements. Please provide schema explicitly.");
-		const omitConfig = Object.fromEntries(omitFields.map((f) => [f, true]));
+		const omitConfig = Object.fromEntries(omitFields.filter((field) => field in rawSchema.shape).map((field) => [field, true]));
 		schema = rawSchema.omit(omitConfig);
+		const idSchema = rawSchema.shape[idField];
+		const schemaWithOptionalId = idSchema && !(idField in schema.shape) ? schema.extend({ [idField]: idSchema.optional() }) : schema;
+		upsertSchema = schemaWithOptionalId;
+		importSchema = schemaWithOptionalId;
 	}
 	schema = withCrudExtensionInput(schema, config);
+	upsertSchema = withCrudExtensionInput(upsertSchema, config);
+	importSchema = withCrudExtensionInput(importSchema, config);
 	let selectSchema;
 	if (config.selectSchema) selectSchema = config.selectSchema;
 	else if (config.schema) selectSchema = schema;
@@ -565,6 +583,8 @@ function resolveSchemas(config) {
 	return {
 		selectSchema,
 		schema,
+		upsertSchema,
+		importSchema,
 		updateSchema
 	};
 }
@@ -619,9 +639,14 @@ function readCrudTarget(config) {
 	if (!id) return null;
 	return { id };
 }
-function buildCrudLifecycleHookId(config, operation) {
+function buildCrudLifecycleHookId(config, operation, ctx) {
 	const target = readCrudTarget(config);
 	if (!target) return null;
+	const pluginId = ctx?.pluginId;
+	if (typeof pluginId === "string" && target.id.startsWith(`${pluginId}.`)) {
+		const resourceId = target.id.slice(pluginId.length + 1);
+		if (resourceId) return `${normalizePluginRouteId(pluginId)}.${resourceId}.${operation}`;
+	}
 	return `${target.id}.${operation}`;
 }
 function getCrudLifecycleHooks(ctx) {
@@ -629,10 +654,10 @@ function getCrudLifecycleHooks(ctx) {
 	return typeof hooks?.emit === "function" ? hooks : null;
 }
 function shouldWrapCrudLifecycleTransaction(ctx, config) {
-	return Boolean(buildCrudLifecycleHookId(config, "create") && getCrudLifecycleHooks(ctx));
+	return Boolean(buildCrudLifecycleHookId(config, "create", ctx) && getCrudLifecycleHooks(ctx));
 }
 async function emitCrudWriteLifecycle(ctx, config, operation, payload) {
-	const hookId = buildCrudLifecycleHookId(config, operation);
+	const hookId = buildCrudLifecycleHookId(config, operation, ctx);
 	const hooks = getCrudLifecycleHooks(ctx);
 	if (!hookId || !hooks) return;
 	await hooks.emit(hookId, payload, {
@@ -890,7 +915,7 @@ function combineConditions(...conditions) {
 */
 function createCrudRouter(config) {
 	const { table, idField = "id", filterableColumns, searchColumns, sortableColumns, maxBatchSize = 100, maxExportSize = 5e3, softDelete: softDeleteOption, middleware = {} } = config;
-	const { selectSchema, schema, updateSchema } = resolveSchemas(config);
+	const { selectSchema, schema, upsertSchema, importSchema, updateSchema } = resolveSchemas(config, idField);
 	const entityOutputSchema = withCrudExtensionInput(selectSchema, config);
 	const listOutputSchema = z.object({
 		data: z.array(entityOutputSchema),
@@ -1010,9 +1035,12 @@ function createCrudRouter(config) {
 				})));
 				let query = ctx.db.select().from(table).$dynamic();
 				if (where) query = query.where(where);
-				if (effectiveInput.sort?.length) {
-					const sortField = effectiveInput.sort[0];
-					if (sortField && validateColumn(sortField.id, sortableColumns)) {
+				const sortField = effectiveInput.sort?.[0] ?? (getTableColumn(table, "createdAt") ? {
+					id: "createdAt",
+					desc: true
+				} : void 0);
+				if (sortField) {
+					if (validateColumn(sortField.id, sortableColumns)) {
 						const column = resolveColumnTarget({
 							table,
 							columnId: sortField.id,
@@ -1218,7 +1246,7 @@ function createCrudRouter(config) {
 			});
 			return doUpdateMany(input.data);
 		}),
-		upsert: resolved.procedureFactory("upsert").input(schema).output(upsertOutputSchema).mutation(async ({ ctx, input }) => {
+		upsert: resolved.procedureFactory("upsert").input(upsertSchema).output(upsertOutputSchema).mutation(async ({ ctx, input }) => {
 			await withGuard(ctx, "upsert");
 			const doUpsert = async (inputData) => {
 				const splitInput = splitCrudExtensionWriteInput(inputData, tableColumnNames);
@@ -1363,7 +1391,7 @@ function createCrudRouter(config) {
 				const failed = [];
 				for (let i = 0; i < importData$1.rows.length; i++) {
 					const row = importData$1.rows[i];
-					const result = schema.safeParse(row);
+					const result = importSchema.safeParse(row);
 					if (result.success) {
 						const splitRow = splitCrudExtensionWriteInput(result.data, tableColumnNames);
 						validRows.push(splitRow);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wordrhyme/auto-crud-server",
   "type": "module",
-  "version": "1.1.5",
+  "version": "1.1.8",
   "description": "tRPC server utilities for auto-crud - automatic CRUD routers for Drizzle ORM",
   "author": "wordrhyme",
   "license": "MIT",
@@ -49,9 +49,9 @@
     "vitest": "^4.0.18",
     "zod": "^4.3.6",
     "@internal/eslint-config": "0.3.0",
-    "@internal/tsdown-config": "0.1.0",
-    "@internal/vitest-config": "0.1.0",
     "@internal/tsconfig": "0.1.0",
+    "@internal/vitest-config": "0.1.0",
+    "@internal/tsdown-config": "0.1.0",
     "@internal/prettier-config": "0.0.1"
   },
   "prettier": "@internal/prettier-config",