@nocobase/plugin-flow-engine 3.0.0-alpha.5 → 3.0.0-alpha.7

package/dist/server/variables/registry.d.ts

@@ -6,8 +6,10 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { HttpRequestContext } from '../template/contexts';
 import { ResourcerContext } from '@nocobase/resourcer';
+import { HttpRequestContext } from '../template/contexts';
+import { type PathSegment, type VariablePathRef } from '../template/variable-expression';
+import { type AuthorizedRecordBinding, type RecordBindingPlan } from './record-bindings';
 export type JSONValue = string | {
     [key: string]: JSONValue;
 } | JSONValue[];
@@ -15,38 +17,59 @@ export type VarScope = 'global' | 'request';
 export interface RequiredParamSpec {
     name: string;
     required?: boolean;
-    defaultValue?: any;
+    defaultValue?: unknown;
 }
+export type ValidateContextParamsOptions = {
+    contextParams: Record<string, unknown>;
+    flowModelUid?: string;
+    koaCtx: ResourcerContext;
+    usage: readonly VariablePathRef[];
+    varName: string;
+};
+export type ValidateContextParamsResult = {
+    allowed?: boolean;
+    contextParams?: Record<string, unknown>;
+    requireFlowModel?: boolean;
+};
 export interface VariableDef {
     name: string;
     scope: VarScope;
     requiredParams?: RequiredParamSpec[];
-    attach: (ctx: HttpRequestContext, koaCtx: ResourcerContext, params?: any, usage?: VarUsage) => Promise<void> | void;
+    attach: (ctx: HttpRequestContext, koaCtx: ResourcerContext, params?: unknown, usage?: VarUsage) => Promise<void> | void;
+    validateContextParams?: (options: ValidateContextParamsOptions) => Promise<ValidateContextParamsResult | void> | ValidateContextParamsResult | void;
 }
-export type VarUsage = {
-    [varName: string]: string[];
-};
+export type VarUsage = Readonly<Record<string, readonly VariablePathRef[]>>;
+type LegacyVarUsage = Record<string, string[]>;
 declare class VariableRegistry {
     private vars;
     register(def: VariableDef): void;
     get(name: string): VariableDef;
     list(): VariableDef[];
-    extractUsage(template: JSONValue): VarUsage;
-    validate(template: JSONValue, contextParams: any): {
+    extractUsage(template: JSONValue): LegacyVarUsage;
+    validate(template: JSONValue, contextParams: unknown): {
         ok: boolean;
         missing?: string[];
     };
-    attachUsedVariables(ctx: HttpRequestContext, koaCtx: ResourcerContext, template: JSONValue, contextParams: any): Promise<void>;
+    attachUsedVariables(ctx: HttpRequestContext, koaCtx: ResourcerContext, template: JSONValue, contextParams: Record<string, unknown>): Promise<void>;
+    attachUsedVariablesFromUsage(ctx: HttpRequestContext, koaCtx: ResourcerContext, usage: VarUsage, contextParams: Record<string, unknown>): Promise<void>;
+    attachUsedVariablesFromPlan(ctx: HttpRequestContext, koaCtx: ResourcerContext, usage: VarUsage, plan: RecordBindingPlan): Promise<void>;
 }
 export declare const variables: VariableRegistry;
 /** 仅测试使用：重置变量注册表为内置默认集 */
+export declare function omitVariableContextParams(contextParams: Record<string, unknown>, varName: string): Record<string, unknown>;
+export declare function sanitizeRegisteredVariableContextParams(contextParams: Record<string, unknown>, registry?: {
+    get?: (name: string) => VariableDef | undefined;
+    list?: () => VariableDef[];
+}): Record<string, unknown>;
 /**
  * 从使用路径推断查询所需的 fields 与 appends。
  * @param paths 使用到的子路径数组
  * @param params 显式参数（仅用于兼容签名）
  */
-export declare function inferSelectsFromUsage(paths?: string[], _params?: unknown): {
+export declare function inferSelectsFromUsage(paths?: readonly (string | readonly PathSegment[])[], _params?: unknown): {
     generatedAppends?: string[];
     generatedFields?: string[];
 };
+export declare function isSafeRecordBinding(binding: AuthorizedRecordBinding): boolean;
+export declare function registerBuiltInVariables(reg: VariableRegistry): void;
 export {};