@nocobase/flow-engine 2.0.0-alpha.7 → 2.0.0-alpha.71

package/lib/flowContext.d.ts

@@ -18,7 +18,8 @@ import type { Location } from 'react-router-dom';
 import { DataSourceManager } from './data-source';
 import { FlowEngine } from './flowEngine';
 import { JSRunner, JSRunnerOptions } from './JSRunner';
-import { FlowModel, ForkFlowModel } from './models';
+import type { FlowModel } from './models/flowModel';
+import type { ForkFlowModel } from './models/forkFlowModel';
 import { FlowResource, FlowSQLRepository } from './resources';
 import type { ActionDefinition, EventDefinition, ResourceType } from './types';
 import { JSONValue } from './utils/params-resolvers';
@@ -30,10 +31,12 @@ export interface MetaTreeNode {
     title: string;
     type: string;
     interface?: string;
+    options?: any;
     uiSchema?: ISchema;
     render?: (props: any) => JSX.Element;
     paths: string[];
     parentTitles?: string[];
+    hidden?: boolean | (() => boolean);
     disabled?: boolean | (() => boolean);
     disabledReason?: string | (() => string | undefined);
     children?: MetaTreeNode[] | (() => Promise<MetaTreeNode[]>);
@@ -42,12 +45,14 @@ export interface PropertyMeta {
     type: string;
     title: string;
     interface?: string;
+    options?: any;
     uiSchema?: ISchema;
     render?: (props: any) => JSX.Element;
     sort?: number;
     properties?: Record<string, PropertyMeta> | (() => Promise<Record<string, PropertyMeta>>);
     disabled?: boolean | (() => boolean);
     disabledReason?: string | (() => string | undefined);
+    hidden?: boolean | (() => boolean);
     buildVariablesParams?: (ctx: FlowContext) => RecordRef | Record<string, any> | Promise<RecordRef | Record<string, any> | undefined> | undefined;
 }
 export type PropertyMetaFactory = {
@@ -71,6 +76,7 @@ export interface PropertyOptions {
     observable?: boolean;
     meta?: PropertyMetaOrFactory;
     resolveOnServer?: boolean | ((subPath: string) => boolean);
+    serverOnlyWhenContextParams?: boolean;
 }
 type RouteOptions = {
     name?: string;
@@ -137,22 +143,46 @@ export declare class FlowContext {
      * @returns 属性定义选项，或 undefined（未定义）
      */
     getPropertyOptions(key: string): PropertyOptions | undefined;
-}
-export declare class FlowRunjsContext extends FlowContext {
-    constructor(delegate: FlowContext);
+    /**
+     * 获取当前上下文可用的顶层 API 信息（主要用于编辑器补全/工具）。
+     *
+     * 注意：
+     * - 目前返回值以“尽量可用”为目标，允许不完整。
+     * - 该方法不会展开变量 meta（变量结构应由 `getPropertyMetaTree()`/VariableInput 等机制负责）。
+     */
+    getApiInfos(options?: {
+        version?: string;
+    }): Promise<Record<string, any>>;
+    /**
+     * 变量结构信息（保留给编辑器/工具使用）。
+     * 当前实现为保底空对象，避免 RunJS doc 中补全到该方法时调用报错。
+     */
+    getVarInfos(_options?: {
+        path?: string | string[];
+        maxDepth?: number;
+    }): Promise<Record<string, any>>;
+    /**
+     * 运行时环境信息（保留给编辑器/工具使用）。
+     * 当前实现为保底空对象，避免 RunJS doc 中补全到该方法时调用报错。
+     */
+    getEnvInfos(): Promise<Record<string, any>>;
 }
 declare class BaseFlowEngineContext extends FlowContext {
     router: Router;
     dataSourceManager: DataSourceManager;
     requireAsync: (url: string) => Promise<any>;
-    createJSRunner: (options?: JSRunnerOptions) => JSRunner;
+    importAsync: (url: string) => Promise<any>;
+    createJSRunner: (options?: JSRunnerOptions) => Promise<JSRunner>;
+    pageInfo: {
+        version?: 'v1' | 'v2';
+    };
     /**
      * @deprecated use `resolveJsonTemplate` instead
      */
     renderJson: (template: JSONValue) => Promise<any>;
     resolveJsonTemplate: (template: JSONValue) => Promise<any>;
+    getVar: (path: string) => Promise<any>;
     runjs: (code: string, variables?: Record<string, any>, options?: JSRunnerOptions) => Promise<any>;
-    copyToClipboard: (text: string) => Promise<void>;
     getAction: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>(name: string) => ActionDefinition<TModel, TCtx> | undefined;
     getActions: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>() => Map<string, ActionDefinition<TModel, TCtx>>;
     getEvents: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>() => Map<string, EventDefinition<TModel, TCtx>>;
@@ -168,6 +198,7 @@ declare class BaseFlowEngineContext extends FlowContext {
     location: Location;
     sql: FlowSQLRepository;
     logger: pino.Logger;
+    constructor();
 }
 declare class BaseFlowModelContext extends BaseFlowEngineContext {
     model: FlowModel;
@@ -212,4 +243,72 @@ export declare class FlowRuntimeContext<TModel extends FlowModel = FlowModel, TM
     get mode(): TMode;
 }
 export type FlowSettingsContext<TModel extends FlowModel = FlowModel> = FlowRuntimeContext<TModel, 'settings'>;
+export type FlowContextDocRef = string | {
+    url: string;
+    title?: string;
+};
+export type FlowDeprecationDoc = boolean | {
+    message?: string;
+    replacedBy?: string | string[];
+    since?: string;
+    removedIn?: string;
+    ref?: FlowContextDocRef;
+};
+export type FlowContextDocParam = {
+    name: string;
+    description?: string;
+    type?: string;
+    optional?: boolean;
+    default?: JSONValue;
+};
+export type FlowContextDocReturn = {
+    description?: string;
+    type?: string;
+};
+export type RunJSDocCompletionDoc = {
+    insertText?: string;
+};
+export type RunJSDocHiddenDoc = boolean | ((ctx: any) => boolean | Promise<boolean>);
+export type RunJSDocHiddenOrPathsDoc = boolean | string[] | ((ctx: any) => boolean | string[] | Promise<boolean | string[]>);
+export type RunJSDocPropertyDoc = string | {
+    description?: string;
+    detail?: string;
+    type?: string;
+    examples?: string[];
+    completion?: RunJSDocCompletionDoc;
+    ref?: FlowContextDocRef;
+    deprecated?: FlowDeprecationDoc;
+    params?: FlowContextDocParam[];
+    returns?: FlowContextDocReturn;
+    properties?: Record<string, RunJSDocPropertyDoc>;
+    hidden?: RunJSDocHiddenOrPathsDoc;
+    disabled?: boolean | ((ctx: any) => boolean | Promise<boolean>);
+    disabledReason?: string | ((ctx: any) => string | undefined | Promise<string | undefined>);
+};
+export type RunJSDocMethodDoc = string | {
+    description?: string;
+    detail?: string;
+    examples?: string[];
+    completion?: RunJSDocCompletionDoc;
+    ref?: FlowContextDocRef;
+    deprecated?: FlowDeprecationDoc;
+    params?: FlowContextDocParam[];
+    returns?: FlowContextDocReturn;
+    hidden?: RunJSDocHiddenDoc;
+    disabled?: boolean | ((ctx: any) => boolean | Promise<boolean>);
+    disabledReason?: string | ((ctx: any) => string | undefined | Promise<string | undefined>);
+};
+export type RunJSDocMeta = {
+    label?: string;
+    properties?: Record<string, RunJSDocPropertyDoc>;
+    methods?: Record<string, RunJSDocMethodDoc>;
+    snippets?: Record<string, any>;
+};
+export declare class FlowRunJSContext extends FlowContext {
+    constructor(delegate: FlowContext);
+    static define(meta: RunJSDocMeta, options?: {
+        locale?: string;
+    }): void;
+    static getDoc(locale?: string): RunJSDocMeta;
+}
 export {};