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

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

@@ -10,7 +10,9 @@ import type { Plugin } from '@nocobase/server';
 import _ from 'lodash';
 import FlowModelRepository from '../repository';
 import { SurfaceLocator } from './locator';
-import type { FlowSurfaceApplyValues, FlowSurfaceComposeMode, FlowSurfaceComposeValues, FlowSurfaceConfigureValues, FlowSurfaceContextValues, FlowSurfaceMutateValues, FlowSurfaceNodeDomain, FlowSurfaceResourceBindingOption, FlowSurfaceResolvedTarget, FlowSurfaceWriteTarget } from './types';
+import type { FlowSurfaceActionLinkageRule, FlowSurfaceBlockLinkageRule, FlowSurfaceFieldLinkageRule, FlowSurfaceFieldValueRule, FlowSurfaceGetReactionMetaResult, FlowSurfaceGetReactionMetaValues, FlowSurfaceReactionWriteResult, FlowSurfaceReactionWriteValues } from './reaction/types';
+import { type FlowSurfaceTemplateListValues, type FlowSurfaceTemplateRow } from './template-service-utils';
+import type { FlowSurfaceApplyValues, FlowSurfaceCatalogResponse, FlowSurfaceCatalogValues, FlowSurfaceComposeValues, FlowSurfaceConfigureValues, FlowSurfaceContextValues, FlowSurfaceDescribeValues, FlowSurfaceMutateValues } from './types';
 type FlowSurfaceAddFieldResult = {
     uid?: string;
     parentUid?: string;
@@ -35,6 +37,10 @@ export declare class FlowSurfacesService {
     get repository(): FlowModelRepository;
     get locator(): SurfaceLocator;
     private get routeSync();
+    private getFlowTemplateRepository;
+    private getFlowTemplateUsageRepository;
+    private getFlowTemplateUsageModel;
+    private getFlowTemplateUsageRepositorySafe;
     private get contractGuard();
     private get surfaceContext();
     private loadEnabledPluginPackages;
@@ -43,6 +49,7 @@ export declare class FlowSurfacesService {
     private readRouteField;
     private readRouteOptions;
     private findMenuRouteById;
+    private findMenuGroupRoutesByTitle;
     private assertMenuParentIsGroup;
     private assertMenuRouteBindable;
     private assertMenuRouteUpdatable;
@@ -54,60 +61,13 @@ export declare class FlowSurfacesService {
     private loadRouteBackedPageStructure;
     private isBindableMenuRoutePendingInitialization;
     private isRouteBackedPageInitialized;
-    catalog(input: {
-        target?: FlowSurfaceWriteTarget;
-    }, options?: {
+    catalog(input: FlowSurfaceCatalogValues, options?: {
         transaction?: any;
         enabledPackages?: ReadonlySet<string>;
-    }): Promise<{
-        target: FlowSurfaceResolvedTarget;
-        blocks: any[];
-        fields: {
-            configureOptions: import("./types").FlowSurfaceConfigureOptions;
-        }[];
-        actions: {
-            configureOptions: import("./types").FlowSurfaceConfigureOptions;
-            key: string;
-            label: string;
-            use: string;
-            kind: "block" | "page" | "tab" | "field" | "action";
-            scope?: import("./types").FlowSurfaceActionScope;
-            scene?: string;
-            requiredInitParams?: string[];
-            allowedContainerUses?: string[];
-            editableDomains: FlowSurfaceNodeDomain[];
-            settingsSchema: Record<string, any>;
-            settingsContract?: Partial<Record<FlowSurfaceNodeDomain, import("./types").FlowSurfaceDomainContract>>;
-            resourceBindings?: FlowSurfaceResourceBindingOption[];
-            eventCapabilities?: import("./types").FlowSurfaceEventCapabilities;
-            layoutCapabilities?: import("./types").FlowSurfaceLayoutCapabilities;
-            createSupported?: boolean;
-        }[];
-        recordActions: {
-            configureOptions: import("./types").FlowSurfaceConfigureOptions;
-            key: string;
-            label: string;
-            use: string;
-            kind: "block" | "page" | "tab" | "field" | "action";
-            scope?: import("./types").FlowSurfaceActionScope;
-            scene?: string;
-            requiredInitParams?: string[];
-            allowedContainerUses?: string[];
-            editableDomains: FlowSurfaceNodeDomain[];
-            settingsSchema: Record<string, any>;
-            settingsContract?: Partial<Record<FlowSurfaceNodeDomain, import("./types").FlowSurfaceDomainContract>>;
-            resourceBindings?: FlowSurfaceResourceBindingOption[];
-            eventCapabilities?: import("./types").FlowSurfaceEventCapabilities;
-            layoutCapabilities?: import("./types").FlowSurfaceLayoutCapabilities;
-            createSupported?: boolean;
-        }[];
-        editableDomains: FlowSurfaceNodeDomain[];
-        configureOptions: import("./types").FlowSurfaceConfigureOptions;
-        settingsSchema: Record<string, any>;
-        settingsContract: Partial<Record<FlowSurfaceNodeDomain, import("./types").FlowSurfaceDomainContract>>;
-        eventCapabilities: import("./types").FlowSurfaceEventCapabilities;
-        layoutCapabilities: import("./types").FlowSurfaceLayoutCapabilities;
-    }>;
+    }): Promise<FlowSurfaceCatalogResponse>;
+    private analyzeCatalogTarget;
+    private projectCatalogNode;
+    private projectCatalogItem;
     private buildCatalogBlockItem;
     private isCollectionBlockUse;
     private isPopupFieldHostUse;
@@ -145,34 +105,139 @@ export declare class FlowSurfacesService {
     context(values: FlowSurfaceContextValues, options?: {
         transaction?: any;
     }): Promise<import("./types").FlowSurfaceContextResponse>;
+    private extractReactionCanonicalRules;
+    private buildReactionFieldPathMaps;
+    private requireReactionFieldUid;
+    private buildReactionRuleNormalizers;
+    private buildReactionFingerprintForSlot;
+    private assertReactionFingerprint;
+    private resolveReactionRequest;
+    private persistReactionSlot;
+    private buildLinkageWriteResult;
+    private getLiveLinkageCapability;
+    getReactionMeta(values: FlowSurfaceGetReactionMetaValues, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceGetReactionMetaResult>;
+    setFieldValueRules(values: FlowSurfaceReactionWriteValues<FlowSurfaceFieldValueRule>, options?: {
+        transaction?: any;
+    }): Promise<import("./reaction/field-value").FlowSurfaceFieldValueCompileResult>;
+    setBlockLinkageRules(values: FlowSurfaceReactionWriteValues<FlowSurfaceBlockLinkageRule>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceReactionWriteResult<FlowSurfaceBlockLinkageRule>>;
+    setFieldLinkageRules(values: FlowSurfaceReactionWriteValues<FlowSurfaceFieldLinkageRule>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceReactionWriteResult<FlowSurfaceFieldLinkageRule>>;
+    setActionLinkageRules(values: FlowSurfaceReactionWriteValues<FlowSurfaceActionLinkageRule>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceReactionWriteResult<FlowSurfaceActionLinkageRule>>;
+    private buildStableFingerprintString;
+    private buildSurfaceFingerprint;
+    private getDeclaredKeyFromNode;
+    private stripInternalSurfaceMetaFromNodeTree;
+    private buildSurfaceReadPayload;
+    private buildSurfaceContextFingerprint;
     get(input: Record<string, any>, options?: {
         transaction?: any;
     }): Promise<Record<string, any>>;
-    compose(values: FlowSurfaceComposeValues, options?: {
+    private getDeclaredKeyPersistenceDeps;
+    private patchDeclaredKeyModel;
+    private persistCreatedKeysForAction;
+    private buildPlanningRuntimeDeps;
+    describeSurface(values: FlowSurfaceDescribeValues, options?: {
+        transaction?: any;
+    }): Promise<any>;
+    private dispatchPlanOnlyAction;
+    private resolveApplyBlueprintReplaceTargetInfo;
+    private resolveApplyBlueprintCreateNavigationGroup;
+    private prepareApplyBlueprintRequest;
+    applyBlueprint(values: Record<string, any>, options?: {
         transaction?: any;
-        enabledPackages?: ReadonlySet<string>;
     }): Promise<{
-        layout?: any;
-        target: {
-            uid: any;
-        };
-        mode: FlowSurfaceComposeMode;
-        keyToUid: {
-            [k: string]: any;
-        };
-        blocks: {
-            key: any;
-            type: any;
-            uid: any;
-            gridUid: any;
-            itemUid: any;
-            itemGridUid: any;
-            actionsColumnUid: any;
-            fields: any;
-            actions: any;
-            recordActions: any;
-        }[];
+        version: string;
+        mode: import("./blueprint").FlowSurfaceApplyBlueprintMode;
+        target: _.Dictionary<any>;
+        surface: Record<string, any>;
+    }>;
+    private resolveTemplateResourceInfo;
+    private resolveBlockTemplateExpectedResourceInfo;
+    private getTemplateResourceCompatibilityDisabledReason;
+    private getFieldsTemplateDisabledReason;
+    private assertFieldsTemplateCompatibility;
+    private loadTemplateListTargetContext;
+    private inferTemplateListCurrentRecordCapability;
+    private normalizeOptionalTemplateListActionType;
+    private normalizeOptionalTemplateListActionScope;
+    private assertTemplateListPopupActionScopeSupported;
+    private resolveTemplateListPopupActionItem;
+    private resolveTemplateListPopupActionContext;
+    private getBlockTemplateDisabledReason;
+    private assertBlockTemplateCompatibility;
+    private getPopupTemplateDisabledReason;
+    private getTemplateListDisabledReason;
+    private withTemplateAvailability;
+    private assertPopupTemplateCompatibility;
+    private normalizeOptionalFlowTemplateType;
+    private withFlowTemplateUsageCounts;
+    listTemplates(values?: FlowSurfaceTemplateListValues, options?: {
+        transaction?: any;
+    }): Promise<{
+        rows: FlowSurfaceTemplateRow[];
+        count: number;
+        page: number;
+        pageSize: number;
+        totalPage: number;
+    }>;
+    getTemplate(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceTemplateRow>;
+    private inferSaveTemplateTarget;
+    private createFlowTemplateReferenceBlockModel;
+    private buildPopupTemplateReferenceOpenView;
+    private clearFlowTemplateUsagesByModelUids;
+    private clearFlowTemplateUsagesForNodeTree;
+    private syncFlowTemplateUsagesForNodeTree;
+    private clearFlowTemplateUsagesForRouteSchemaUid;
+    private syncTemplateMetaToReferencedModels;
+    private resolveFlowModelAttachPosition;
+    private repositionFlowModelInParent;
+    private convertBlockSourceToTemplateReference;
+    private convertPopupSourceToTemplateReference;
+    saveTemplate(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceTemplateRow>;
+    updateTemplate(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<FlowSurfaceTemplateRow>;
+    destroyTemplate(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
     }>;
+    private resolveTemplateCopySource;
+    private duplicateDetachedFlowModelTree;
+    private cloneFlowModelTree;
+    convertTemplateToCopy(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: any;
+        type: string;
+        popupUid: string;
+    } | {
+        gridUid: string;
+        uid: string;
+        type: string;
+        popupUid?: undefined;
+    } | {
+        uid: any;
+        type: string;
+        popupUid?: undefined;
+    }>;
+    private buildPopupSurfaceSummaryFromHost;
+    private decorateTemplateReadbackTree;
+    compose(values: FlowSurfaceComposeValues, options?: {
+        transaction?: any;
+        enabledPackages?: ReadonlySet<string>;
+    }): Promise<import("./compose-runtime").FlowSurfaceComposeExecutionResult>;
     configure(values: FlowSurfaceConfigureValues, options?: {
         transaction?: any;
     }): Promise<{
@@ -199,16 +264,7 @@ export declare class FlowSurfacesService {
     private initializeFlowPageForRoute;
     createPage(values: Record<string, any>, options?: {
         transaction?: any;
-    }): Promise<{
-        routeId: any;
-        parentMenuRouteId: any;
-        pageSchemaUid: any;
-        pageUid: string;
-        tabSchemaUid: any;
-        tabRouteId: any;
-        tabSchemaName: any;
-        gridUid: any;
-    }>;
+    }): Promise<any>;
     destroyPage(values: Record<string, any>, options?: {
         transaction?: any;
     }): Promise<{
@@ -265,25 +321,19 @@ export declare class FlowSurfacesService {
     }): Promise<{
         uid: any;
     }>;
+    private buildFlowTemplateReferenceBlockTree;
+    private patchCopiedTemplateGridFromRoot;
+    private buildBlockCreateResult;
+    private appendAddedBlockLayout;
+    private applyTemplateFieldsToBlock;
+    private addBlockFromFieldsTemplate;
+    private addBlockFromTemplate;
+    private addFieldFromTemplate;
     addBlock(values: Record<string, any>, options?: {
         transaction?: any;
         deferAutoLayout?: boolean;
         enabledPackages?: ReadonlySet<string>;
-    }): Promise<{
-        pageUid?: any;
-        tabUid?: any;
-        popupPageUid?: any;
-        popupTabUid?: any;
-        popupGridUid?: any;
-        actionsColumnUid?: any;
-        itemGridUid?: string;
-        itemUid?: string;
-        blockGridUid?: string;
-        gridUid?: any;
-        uid: string;
-        parentUid: any;
-        subKey: any;
-    }>;
+    }): any;
     addField(values: Record<string, any>, options?: {
         transaction?: any;
         enabledPackages?: ReadonlySet<string>;
@@ -291,6 +341,7 @@ export declare class FlowSurfacesService {
     addAction(values: Record<string, any>, options?: {
         transaction?: any;
         enabledPackages?: ReadonlySet<string>;
+        autoCompleteDefaultPopup?: boolean;
     }): Promise<{
         uid: string;
         parentUid: any;
@@ -300,6 +351,7 @@ export declare class FlowSurfacesService {
     addRecordAction(values: Record<string, any>, options?: {
         transaction?: any;
         enabledPackages?: ReadonlySet<string>;
+        autoCompleteDefaultPopup?: boolean;
     }): Promise<{
         uid: string;
         parentUid: any;
@@ -328,8 +380,18 @@ export declare class FlowSurfacesService {
     }>;
     private normalizeInlineSettings;
     private normalizeInlinePopup;
+    private buildInlinePopupTemplateOpenView;
     private peekInlineFieldSettingsOpenView;
     private assertOpenViewUidTarget;
+    private normalizeFlowTemplateMode;
+    private normalizeFlowTemplateUsage;
+    private normalizeFlowTemplateReference;
+    private getFlowTemplateOrThrow;
+    private buildPopupTemplateOpenView;
+    private resolveExternalPopupHostUid;
+    private resolveDetachedPopupCopyUid;
+    private cleanupLocalPopupSurfaceForHost;
+    private reconcilePopupOpenViewTransition;
     private normalizeOpenView;
     private isExternalPopupOpenView;
     private loadFieldHostNodes;
@@ -341,10 +403,29 @@ export declare class FlowSurfacesService {
     private applyInlineFieldPopup;
     private applyInlineFieldSettings;
     private applyInlineStandaloneFieldSettings;
+    private getActionButtonTitle;
+    private isSemanticallyEmptyInlinePopup;
+    private shouldAutoCompleteDefaultActionPopup;
+    private buildDefaultActionPopupFieldPaths;
+    private buildDefaultActionPopupNamespace;
+    private buildDefaultActionPopupKeyMap;
+    private remapDefaultActionPopupField;
+    private remapDefaultActionPopupBlocks;
+    private remapDefaultActionPopupLayout;
+    private buildDefaultActionPopupBlocks;
+    private buildDefaultActionPopupComposeValues;
+    private resolveDefaultActionPopupSurfaceState;
+    private shouldResetDefaultActionPopupFormLinkageRules;
+    private resetDefaultActionPopupFormLinkageRules;
+    private resolvePopupTabTitle;
+    private syncDefaultActionPopupTabTitle;
+    private applyDefaultActionPopupContent;
     private applyInlineActionPopup;
     updateSettings(values: Record<string, any>, options?: {
         transaction?: any;
         replaceChartCardSettings?: boolean;
+        openViewActionName?: string;
+        popupTemplateHostUid?: string;
     }): Promise<{
         uid: any;
         updated?: undefined;
@@ -435,10 +516,19 @@ export declare class FlowSurfacesService {
     private resolveAddRecordActionCatalogItem;
     private resolveComposeBlockActionCatalogItem;
     private resolveComposeRecordActionCatalogItem;
-    private resolveRecordActionContainer;
+    private isAddChildCatalogItem;
+    private isTreeCollection;
+    private isTreeTableEnabled;
+    private resolveAddChildOwnerNode;
+    private resolveOwnerCollectionForAddChild;
+    private canUseAddChildOnOwnerNode;
+    private assertAddChildSupportedForOwnerNode;
+    private filterTargetRecordActions;
+    private inspectRecordActionContainer;
+    private materializeRecordActionContainer;
     private runBatchCreate;
     private normalizeComposeBlock;
-    private resolveComposeTargetRef;
+    private normalizeComposeBlocks;
     private resolveComposeActionContainerUid;
     private resolveComposeFieldContainerUid;
     private resolveComposeRecordActionContainerUid;
@@ -449,8 +539,8 @@ export declare class FlowSurfacesService {
     private isGridLayoutValid;
     private hasMaterialGridLayout;
     private appendRowsToLayout;
-    private collectComposeActionRefs;
-    private collectPopupSurfaceRefs;
+    private collectComposeActionKeys;
+    private collectPopupSurfaceKeys;
     private removeNodeTreeWithBindings;
     private cleanupNodeBindings;
     private configurePage;
@@ -475,11 +565,13 @@ export declare class FlowSurfacesService {
     private configureActionNode;
     private buildFieldCatalog;
     private getFieldMenuCatalogMode;
+    private resolveRegisteredFieldBinding;
     private resolveAssociationLeafDisplaySemantics;
     private buildFieldMenuDirectCandidates;
     private collectFieldMenuAssociationLeafCandidates;
     private buildFieldMenuCandidates;
     private findFieldMenuCandidate;
+    private buildCatalogItemOptionalFields;
     private buildFieldCatalogEntriesForResource;
     private buildLegacyFieldCatalogEntriesForResource;
     private findOwningBlockGrid;
@@ -509,6 +601,9 @@ export declare class FlowSurfacesService {
     private getCollection;
     private resolveFieldDefinition;
     private getAssociationDefaultTitleFieldName;
+    private getAssociationTitleFieldTargetCollection;
+    private buildAssociationTitleFieldUnavailableMessage;
+    private resolveTitleFieldSyncDecision;
     private resolvePreferredFieldForCapability;
     private ensureGridChild;
     private ensureTableActionsColumn;