@wordrhyme/auto-crud-server 1.0.7 → 1.0.9

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';
@@ -81,6 +81,7 @@ interface ListInput {
     id: string;
     desc: boolean;
   }>;
+  search?: string;
   filters?: Array<{
     id: string;
     value: string | string[];
@@ -116,6 +117,7 @@ interface ExportInput {
     id: string;
     desc: boolean;
   }>;
+  search?: string;
   filters?: Array<{
     id: string;
     value: string | string[];
@@ -127,6 +129,48 @@ interface ExportInput {
   /** 导出数量限制，会被 clamp 到 [1, maxExportSize] */
   limit?: number;
 }
+interface CrudExtensionMetadata {
+  schema?: unknown;
+  fields?: Record<string, unknown>;
+  errors?: string[];
+}
+interface CrudExtensionFilter {
+  id: string;
+  value: string | string[];
+  variant: string;
+  operator: string;
+  filterId?: string | undefined;
+}
+interface CrudExtensionsProvider {
+  getMetadata?: (input: {
+    id: string;
+  }) => Promise<CrudExtensionMetadata>;
+  saveExtraValues?: (input: {
+    id: string;
+    entityId: string;
+    rawValues: Record<string, unknown>;
+    baseValues: Record<string, unknown>;
+    extraValues: Record<string, unknown>;
+    tx?: unknown;
+  }) => Promise<void>;
+  readProjection?: (input: {
+    id: string;
+    entityIds: string[];
+    fields?: string[];
+  }) => Promise<Record<string, Record<string, unknown>>>;
+  matchEntityIds?: (input: {
+    id: string;
+    filters: CrudExtensionFilter[];
+    joinOperator?: 'and' | 'or';
+    limit?: number;
+  }) => Promise<string[]>;
+  searchEntityIds?: (input: {
+    id: string;
+    search: string;
+    limit?: number;
+  }) => Promise<string[]>;
+}
+type CrudExtensionsConfig<TContext = unknown> = false | CrudExtensionsProvider | ((ctx: TContext) => CrudExtensionsProvider | null | undefined);
 /**
  * 导出查询结果类型
  */
@@ -334,6 +378,7 @@ interface CrudMiddleware<TContext = unknown, TSelect = unknown, TInsert = unknow
  * 按操作指定不同的 procedure，支持 default 回退
  */
 interface ProcedureMap {
+  meta?: AnyProcedure;
   list?: AnyProcedure;
   get?: AnyProcedure;
   create?: AnyProcedure;
@@ -414,6 +459,26 @@ type ProcedureConfig = AnyProcedure | ProcedureMap | ProcedureFactory;
 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;
+  /**
+   * Globally unique extension target id for this CRUD.
+   *
+   * Optional. Only consumers that enable entity extension fields need this.
+   * CRUDs without an explicit id keep the normal AutoCrud behavior and ignore
+   * field extensions.
+   *
+   * Example: "com.example.shop.stores".
+   */
+  id?: string;
+  /**
+   * Optional dynamic field provider.
+   *
+   * - undefined: when `id` is present, `createCrudRouter` will use
+   *   `ctx.crudExtensions` if the request context provides it.
+   * - false: disable dynamic fields for this CRUD even if the context has a
+   *   provider.
+   * - provider/function: explicitly use this provider.
+   */
+  extensions?: CrudExtensionsConfig<TContext>;
   /**
    * 主 Schema（用于 create/upsert 输入验证）
    * - 如果不传，自动从 table 派生并排除 omitFields
@@ -597,6 +662,7 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
   middleware?: CrudMiddleware<TContext, TSelect, TInsert, TUpdate, TListInput, TGetInput, TExportInput>;
 }
 interface CrudProcedures {
+  meta: AnyProcedure;
   list: AnyProcedure;
   get: AnyProcedure;
   create: AnyProcedure;
@@ -625,6 +691,7 @@ declare const baseListInputSchema: z.ZodObject<{
     id: z.ZodString;
     desc: z.ZodBoolean;
   }, z.core.$strip>>>;
+  search: z.ZodOptional<z.ZodString>;
   filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
@@ -669,6 +736,7 @@ declare const baseExportInputSchema: z.ZodObject<{
     id: z.ZodString;
     desc: z.ZodBoolean;
   }, z.core.$strip>>>;
+  search: z.ZodOptional<z.ZodString>;
   filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
@@ -811,12 +879,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 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 };
+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

@@ -82,6 +82,7 @@ interface ListInput {
     id: string;
     desc: boolean;
   }>;
+  search?: string;
   filters?: Array<{
     id: string;
     value: string | string[];
@@ -117,6 +118,7 @@ interface ExportInput {
     id: string;
     desc: boolean;
   }>;
+  search?: string;
   filters?: Array<{
     id: string;
     value: string | string[];
@@ -128,6 +130,48 @@ interface ExportInput {
   /** 导出数量限制，会被 clamp 到 [1, maxExportSize] */
   limit?: number;
 }
+interface CrudExtensionMetadata {
+  schema?: unknown;
+  fields?: Record<string, unknown>;
+  errors?: string[];
+}
+interface CrudExtensionFilter {
+  id: string;
+  value: string | string[];
+  variant: string;
+  operator: string;
+  filterId?: string | undefined;
+}
+interface CrudExtensionsProvider {
+  getMetadata?: (input: {
+    id: string;
+  }) => Promise<CrudExtensionMetadata>;
+  saveExtraValues?: (input: {
+    id: string;
+    entityId: string;
+    rawValues: Record<string, unknown>;
+    baseValues: Record<string, unknown>;
+    extraValues: Record<string, unknown>;
+    tx?: unknown;
+  }) => Promise<void>;
+  readProjection?: (input: {
+    id: string;
+    entityIds: string[];
+    fields?: string[];
+  }) => Promise<Record<string, Record<string, unknown>>>;
+  matchEntityIds?: (input: {
+    id: string;
+    filters: CrudExtensionFilter[];
+    joinOperator?: 'and' | 'or';
+    limit?: number;
+  }) => Promise<string[]>;
+  searchEntityIds?: (input: {
+    id: string;
+    search: string;
+    limit?: number;
+  }) => Promise<string[]>;
+}
+type CrudExtensionsConfig<TContext = unknown> = false | CrudExtensionsProvider | ((ctx: TContext) => CrudExtensionsProvider | null | undefined);
 /**
  * 导出查询结果类型
  */
@@ -335,6 +379,7 @@ interface CrudMiddleware<TContext = unknown, TSelect = unknown, TInsert = unknow
  * 按操作指定不同的 procedure，支持 default 回退
  */
 interface ProcedureMap {
+  meta?: AnyProcedure;
   list?: AnyProcedure;
   get?: AnyProcedure;
   create?: AnyProcedure;
@@ -415,6 +460,26 @@ type ProcedureConfig = AnyProcedure | ProcedureMap | ProcedureFactory;
 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;
+  /**
+   * Globally unique extension target id for this CRUD.
+   *
+   * Optional. Only consumers that enable entity extension fields need this.
+   * CRUDs without an explicit id keep the normal AutoCrud behavior and ignore
+   * field extensions.
+   *
+   * Example: "com.example.shop.stores".
+   */
+  id?: string;
+  /**
+   * Optional dynamic field provider.
+   *
+   * - undefined: when `id` is present, `createCrudRouter` will use
+   *   `ctx.crudExtensions` if the request context provides it.
+   * - false: disable dynamic fields for this CRUD even if the context has a
+   *   provider.
+   * - provider/function: explicitly use this provider.
+   */
+  extensions?: CrudExtensionsConfig<TContext>;
   /**
    * 主 Schema（用于 create/upsert 输入验证）
    * - 如果不传，自动从 table 派生并排除 omitFields
@@ -598,6 +663,7 @@ interface CrudRouterConfig<TTable extends PgTable = PgTable, TContext = unknown,
   middleware?: CrudMiddleware<TContext, TSelect, TInsert, TUpdate, TListInput, TGetInput, TExportInput>;
 }
 interface CrudProcedures {
+  meta: AnyProcedure;
   list: AnyProcedure;
   get: AnyProcedure;
   create: AnyProcedure;
@@ -626,6 +692,7 @@ declare const baseListInputSchema: z.ZodObject<{
     id: z.ZodString;
     desc: z.ZodBoolean;
   }, z.core.$strip>>>;
+  search: z.ZodOptional<z.ZodString>;
   filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
@@ -670,6 +737,7 @@ declare const baseExportInputSchema: z.ZodObject<{
     id: z.ZodString;
     desc: z.ZodBoolean;
   }, z.core.$strip>>>;
+  search: z.ZodOptional<z.ZodString>;
   filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
@@ -820,4 +888,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 CrudColumnConfig, type CrudColumnExpression, type CrudColumnRef, 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 };
+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 };