@nocobase/plugin-flow-engine 2.1.0-alpha.15 → 2.1.0-alpha.17

package/dist/server/flow-surfaces/types.d.ts

@@ -6,16 +6,35 @@
  * 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 { FLOW_SURFACE_MUTATE_OP_TYPES } from './constants';
+import { FLOW_SURFACE_MUTATE_OP_TYPES, FLOW_SURFACE_PLAN_STEP_ACTIONS } from './constants';
 export type FlowSurfaceNodeDomain = 'props' | 'decoratorProps' | 'stepParams' | 'flowRegistry';
 export type FlowSurfaceMergeStrategy = 'deep' | 'replace';
 export type FlowSurfaceActionScope = 'block' | 'record' | 'form' | 'filterForm' | 'actionPanel';
+export type FlowSurfaceContainerKind = 'page' | 'tab' | 'grid' | 'block' | 'node';
 export type FlowSurfaceReadLocator = {
     uid?: string;
     pageSchemaUid?: string;
     tabSchemaUid?: string;
     routeId?: string;
 };
+export type FlowSurfacePlanStepLink = {
+    step: string;
+    path?: string;
+};
+export type FlowSurfaceKeySelector = {
+    key: string;
+};
+export type FlowSurfaceLocatorSelector = {
+    locator: FlowSurfaceReadLocator;
+};
+export type FlowSurfaceSurfaceSelector = FlowSurfaceKeySelector | FlowSurfaceLocatorSelector;
+export type FlowSurfacePlanSelector = FlowSurfaceSurfaceSelector | FlowSurfacePlanStepLink;
+export type FlowSurfaceBindKey = {
+    key: string;
+    locator: FlowSurfaceReadLocator;
+    expectedKind?: 'page' | 'tab' | 'grid' | 'block' | 'fieldHost' | 'action' | 'popupHost' | 'popupPage' | 'popupTab' | 'node';
+    rebind?: boolean;
+};
 export type FlowSurfaceWriteTarget = {
     uid: string;
 };
@@ -29,34 +48,11 @@ export type FlowSurfaceConfigureOption = {
     supportsFlowContext?: boolean;
 };
 export type FlowSurfaceConfigureOptions = Record<string, FlowSurfaceConfigureOption>;
-export type FlowSurfaceResourceBindingKey = 'currentCollection' | 'currentRecord' | 'associatedRecords' | 'otherRecords';
-export type FlowSurfaceResourceBindingAssociationField = {
-    key: string;
-    label: string;
-    collectionName: string;
-    associationName?: string;
-};
-export type FlowSurfaceResourceBindingOption = {
-    key: FlowSurfaceResourceBindingKey;
-    label: string;
-    description?: string;
-    requires?: string[];
-    dataSourceKey?: string;
-    collectionName?: string;
-    associationFields?: FlowSurfaceResourceBindingAssociationField[];
-};
-export type FlowSurfaceSemanticResourceInput = {
-    binding: FlowSurfaceResourceBindingKey;
-    dataSourceKey?: string;
-    collectionName?: string;
-    associationField?: string;
-};
 export type FlowSurfaceReadTarget = {
     locator: FlowSurfaceReadLocator;
     uid: string;
     kind: FlowSurfaceContainerKind;
 };
-export type FlowSurfaceContainerKind = 'page' | 'tab' | 'grid' | 'block' | 'node';
 export type FlowSurfaceDomainContract = {
     allowedKeys: string[];
     wildcard?: boolean;
@@ -89,6 +85,28 @@ export type FlowSurfaceNodeContract = {
     layoutCapabilities?: FlowSurfaceLayoutCapabilities;
     eventBindings?: Record<string, FlowSurfaceEventBindingContract>;
 };
+export type FlowSurfaceResourceBindingKey = 'currentCollection' | 'currentRecord' | 'associatedRecords' | 'otherRecords';
+export type FlowSurfaceResourceBindingAssociationField = {
+    key: string;
+    label: string;
+    collectionName: string;
+    associationName?: string;
+};
+export type FlowSurfaceResourceBindingOption = {
+    key: FlowSurfaceResourceBindingKey;
+    label: string;
+    description?: string;
+    requires?: string[];
+    dataSourceKey?: string;
+    collectionName?: string;
+    associationFields?: FlowSurfaceResourceBindingAssociationField[];
+};
+export type FlowSurfaceSemanticResourceInput = {
+    binding: FlowSurfaceResourceBindingKey;
+    dataSourceKey?: string;
+    collectionName?: string;
+    associationField?: string;
+};
 export type FlowSurfaceCatalogItem = {
     key: string;
     label: string;
@@ -98,18 +116,82 @@ export type FlowSurfaceCatalogItem = {
     scene?: string;
     requiredInitParams?: string[];
     allowedContainerUses?: string[];
-    editableDomains: FlowSurfaceNodeDomain[];
-    settingsSchema: Record<string, any>;
+    editableDomains?: FlowSurfaceNodeDomain[];
+    settingsSchema?: Record<string, any>;
     settingsContract?: Partial<Record<FlowSurfaceNodeDomain, FlowSurfaceDomainContract>>;
     configureOptions?: FlowSurfaceConfigureOptions;
     resourceBindings?: FlowSurfaceResourceBindingOption[];
     eventCapabilities?: FlowSurfaceEventCapabilities;
     layoutCapabilities?: FlowSurfaceLayoutCapabilities;
     createSupported?: boolean;
+    fieldUse?: string;
+    wrapperUse?: string;
+    renderer?: string;
+    type?: string;
+    associationPathName?: string;
+    defaultTargetUid?: string;
+    targetBlockUid?: string;
+};
+export type FlowSurfaceCatalogSection = 'blocks' | 'fields' | 'actions' | 'recordActions' | 'node';
+export type FlowSurfaceCatalogExpand = 'item.configureOptions' | 'item.contracts' | 'item.allowedContainerUses' | 'node.contracts';
+export type FlowSurfaceCatalogPopupScenario = {
+    kind: 'plainPopup' | 'recordPopup' | 'associationPopup';
+    scene: 'new' | 'one' | 'many' | 'select' | 'subForm' | 'bulkEditForm' | 'generic';
+    hasCurrentRecord: boolean;
+    hasAssociationContext: boolean;
+};
+export type FlowSurfaceCatalogFieldContainerScenario = {
+    kind: 'form' | 'details' | 'table' | 'filter-form';
+    targetMode?: 'single' | 'multiple';
+};
+export type FlowSurfaceCatalogActionContainerScenario = {
+    scope: FlowSurfaceActionScope;
+    ownerUse?: string;
+    recordActionContainerUse?: string;
+};
+export type FlowSurfaceCatalogScenario = {
+    surfaceKind: 'global' | FlowSurfaceContainerKind;
+    popup?: FlowSurfaceCatalogPopupScenario;
+    fieldContainer?: FlowSurfaceCatalogFieldContainerScenario;
+    actionContainer?: FlowSurfaceCatalogActionContainerScenario;
+};
+export type FlowSurfaceCatalogNodeInfo = {
+    editableDomains: FlowSurfaceNodeDomain[];
+    configureOptions: FlowSurfaceConfigureOptions;
+    settingsSchema?: Record<string, any>;
+    settingsContract?: Partial<Record<FlowSurfaceNodeDomain, FlowSurfaceDomainContract>>;
+    eventCapabilities?: FlowSurfaceEventCapabilities;
+    layoutCapabilities?: FlowSurfaceLayoutCapabilities;
+};
+export type FlowSurfaceCatalogValues = {
+    target?: FlowSurfaceWriteTarget;
+    sections?: FlowSurfaceCatalogSection[];
+    expand?: FlowSurfaceCatalogExpand[];
+};
+export type FlowSurfaceResolvedTarget = {
+    target: FlowSurfaceResolveTarget;
+    uid: string;
+    kind: FlowSurfaceContainerKind;
+    node?: any;
+    route?: any;
+    pageRoute?: any;
+    tabRoute?: any;
+    pageModel?: any;
+};
+export type FlowSurfaceCatalogResponse = {
+    target: FlowSurfaceResolvedTarget | null;
+    scenario: FlowSurfaceCatalogScenario;
+    selectedSections: FlowSurfaceCatalogSection[];
+    blocks?: FlowSurfaceCatalogItem[];
+    fields?: FlowSurfaceCatalogItem[];
+    actions?: FlowSurfaceCatalogItem[];
+    recordActions?: FlowSurfaceCatalogItem[];
+    node?: FlowSurfaceCatalogNodeInfo;
 };
 export type FlowSurfaceNodeSpec = {
     uid?: string;
     clientKey?: string;
+    sortIndex?: number;
     use: string;
     props?: Record<string, any>;
     decoratorProps?: Record<string, any>;
@@ -168,6 +250,26 @@ export type FlowSurfaceContextValues = {
 export type FlowSurfaceContextResponse = {
     vars: Record<string, FlowSurfaceContextVarInfo>;
 };
+export type FlowSurfaceDescribeValues = {
+    locator: FlowSurfaceReadLocator;
+    bindKeys?: FlowSurfaceBindKey[];
+};
+export type FlowSurfacePlanStepAction = (typeof FLOW_SURFACE_PLAN_STEP_ACTIONS)[number];
+export type FlowSurfacePlanStep = {
+    id?: string;
+    action: FlowSurfacePlanStepAction;
+    selectors?: {
+        target?: FlowSurfacePlanSelector;
+        source?: FlowSurfacePlanSelector;
+    };
+    values?: Record<string, any>;
+};
+export type FlowSurfacePlanRequestValues = {
+    surface?: FlowSurfaceSurfaceSelector;
+    plan: {
+        steps?: FlowSurfacePlanStep[];
+    };
+};
 export type FlowSurfaceMutateOpType = (typeof FLOW_SURFACE_MUTATE_OP_TYPES)[number];
 export type FlowSurfaceMutateOp = {
     opId?: string;
@@ -175,18 +277,8 @@ export type FlowSurfaceMutateOp = {
     target?: FlowSurfaceWriteTarget;
     values?: Record<string, any>;
 };
-export type FlowSurfaceResolvedTarget = {
-    target: FlowSurfaceResolveTarget;
-    uid: string;
-    kind: FlowSurfaceContainerKind;
-    node?: any;
-    route?: any;
-    pageRoute?: any;
-    tabRoute?: any;
-    pageModel?: any;
-};
 export type FlowSurfaceExecutorContext = {
     transaction?: any;
-    refs: Map<string, any>;
+    keys: Map<string, any>;
     clientKeyToUid: Record<string, string>;
 };