@nocobase/plugin-flow-engine 2.1.0-alpha.12 → 2.1.0-alpha.14

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

@@ -0,0 +1,530 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * 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 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';
+type FlowSurfaceAddFieldResult = {
+    uid?: string;
+    parentUid?: string;
+    subKey?: string;
+    fieldUse?: string;
+    type?: string;
+    renderer?: string;
+    defaultTargetUid?: string;
+    associationPathName?: string;
+    fieldPath?: string;
+    wrapperUid?: string;
+    fieldUid?: string;
+    innerFieldUid?: string;
+    popupPageUid?: string;
+    popupTabUid?: string;
+    popupGridUid?: string;
+};
+export declare class FlowSurfacesService {
+    private readonly plugin;
+    constructor(plugin: Plugin);
+    get db(): import("@nocobase/database").default;
+    get repository(): FlowModelRepository;
+    get locator(): SurfaceLocator;
+    private get routeSync();
+    private get contractGuard();
+    private get surfaceContext();
+    private loadEnabledPluginPackages;
+    private resolveEnabledPluginPackages;
+    private allocateRouteSortValue;
+    private readRouteField;
+    private readRouteOptions;
+    private findMenuRouteById;
+    private assertMenuParentIsGroup;
+    private assertMenuRouteBindable;
+    private assertMenuRouteUpdatable;
+    private assertMenuParentNotSelfOrDescendant;
+    private buildMenuResult;
+    private createFlowMenuGroup;
+    private createFlowMenuItem;
+    private sanitizePublicCreateMenuValues;
+    private loadRouteBackedPageStructure;
+    private isBindableMenuRoutePendingInitialization;
+    private isRouteBackedPageInitialized;
+    catalog(input: {
+        target?: FlowSurfaceWriteTarget;
+    }, 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;
+    }>;
+    private buildCatalogBlockItem;
+    private isCollectionBlockUse;
+    private isPopupFieldHostUse;
+    private formatPopupSupportedBindings;
+    private isCatalogBlockVisibleForPopupProfile;
+    private getPopupCollectionBlockScenes;
+    private isPopupCollectionBlockSceneUnsupported;
+    private isPopupCollectionBlockVisibleForScene;
+    private resolveFieldAssociationContextFromBinding;
+    private resolvePopupHostFieldAssociationContext;
+    private normalizePopupScene;
+    private resolvePopupScene;
+    private resolvePopupHostProfileContext;
+    private buildPopupBlockResourceBindings;
+    private listPopupAssociatedRecordFields;
+    private resolvePopupBlockProfile;
+    private resolvePopupAssociationFields;
+    private findPopupHostNode;
+    private getBlockKeyByUse;
+    private describePopupKind;
+    private normalizeResourceInput;
+    private assertRequiredBlockResourceInit;
+    private describeComposeBlock;
+    private resolvePopupCollectionBlockResourceInit;
+    private compilePopupSemanticResourceInit;
+    private assertPopupRawResourceInit;
+    private validatePopupRawResourceInit;
+    private getCollectionFilterTargetKey;
+    private normalizeFlowContextTemplateValue;
+    private isSameConfiguredFlowContextValue;
+    private isPopupAssociatedRecordsSourceIdMatch;
+    private classifyPopupRawResourceInit;
+    private resolvePopupAssociationField;
+    private buildAssociatedRecordsResourceInit;
+    context(values: FlowSurfaceContextValues, options?: {
+        transaction?: any;
+    }): Promise<import("./types").FlowSurfaceContextResponse>;
+    get(input: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<Record<string, any>>;
+    compose(values: FlowSurfaceComposeValues, 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;
+        }[];
+    }>;
+    configure(values: FlowSurfaceConfigureValues, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: any;
+        updated?: undefined;
+    } | {
+        uid: any;
+        updated: string[];
+    }>;
+    createMenu(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        routeId: any;
+        type: any;
+        parentMenuRouteId: any;
+    }>;
+    updateMenu(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        routeId: any;
+        type: any;
+        parentMenuRouteId: any;
+    }>;
+    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;
+    }>;
+    destroyPage(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
+    }>;
+    addTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        pageUid: string;
+        tabSchemaUid: any;
+        tabRouteId: any;
+        tabSchemaName: any;
+        gridUid: any;
+    }>;
+    updateTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
+        routeId: any;
+        title: any;
+        icon: any;
+    }>;
+    moveTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        sourceUid: string;
+        targetUid: string;
+        position: string;
+    }>;
+    removeTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
+    }>;
+    addPopupTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        popupPageUid: any;
+        popupTabUid: string;
+        popupGridUid: string;
+    }>;
+    updatePopupTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<_.Dictionary<any>>;
+    movePopupTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        sourceUid: string;
+        targetUid: string;
+        position: string;
+    }>;
+    removePopupTab(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: any;
+    }>;
+    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;
+    }>;
+    addField(values: Record<string, any>, options?: {
+        transaction?: any;
+        enabledPackages?: ReadonlySet<string>;
+    }): Promise<FlowSurfaceAddFieldResult>;
+    addAction(values: Record<string, any>, options?: {
+        transaction?: any;
+        enabledPackages?: ReadonlySet<string>;
+    }): Promise<{
+        uid: string;
+        parentUid: any;
+        subKey: string;
+        scope: import("./types").FlowSurfaceActionScope;
+    }>;
+    addRecordAction(values: Record<string, any>, options?: {
+        transaction?: any;
+        enabledPackages?: ReadonlySet<string>;
+    }): Promise<{
+        uid: string;
+        parentUid: any;
+        subKey: string;
+        scope: import("./types").FlowSurfaceActionScope;
+    }>;
+    addBlocks(values: Record<string, any>): Promise<{
+        [x: string]: number | Record<string, any>[];
+        successCount: number;
+        errorCount: number;
+    }>;
+    addFields(values: Record<string, any>): Promise<{
+        [x: string]: number | Record<string, any>[];
+        successCount: number;
+        errorCount: number;
+    }>;
+    addActions(values: Record<string, any>): Promise<{
+        [x: string]: number | Record<string, any>[];
+        successCount: number;
+        errorCount: number;
+    }>;
+    addRecordActions(values: Record<string, any>): Promise<{
+        [x: string]: number | Record<string, any>[];
+        successCount: number;
+        errorCount: number;
+    }>;
+    private normalizeInlineSettings;
+    private normalizeInlinePopup;
+    private peekInlineFieldSettingsOpenView;
+    private assertOpenViewUidTarget;
+    private normalizeOpenView;
+    private isExternalPopupOpenView;
+    private loadFieldHostNodes;
+    private resolveFieldOpenViewContext;
+    private applyFieldOpenViewContext;
+    private buildDefaultFieldOpenView;
+    private ensureLocalFieldPopupSurface;
+    private applyInlineNodeSettings;
+    private applyInlineFieldPopup;
+    private applyInlineFieldSettings;
+    private applyInlineStandaloneFieldSettings;
+    private applyInlineActionPopup;
+    updateSettings(values: Record<string, any>, options?: {
+        transaction?: any;
+        replaceChartCardSettings?: boolean;
+    }): Promise<{
+        uid: any;
+        updated?: undefined;
+    } | {
+        uid: any;
+        updated: string[];
+    }>;
+    private syncMirroredStepParamsForUpdateSettings;
+    private normalizeOpenViewForUpdateSettings;
+    private syncChartConfigureForUpdateSettings;
+    private validateChartConfigureForUpdateSettings;
+    private stripChartSqlForInspection;
+    private normalizeReadOnlyChartSql;
+    private buildChartSqlPreviewQuery;
+    private buildChartSqlPreviewMetadataQuery;
+    private runChartSqlPreviewRaw;
+    private extractSqlChartPreviewAliases;
+    private inferSqlChartOutputType;
+    private mergeChartHintLists;
+    private resolveSqlChartPreview;
+    private syncChartCardRuntimeStepParamsForUpdateSettings;
+    private stripLegacyChartCardChromeForUpdateSettings;
+    setEventFlows(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
+        flowRegistry: any;
+    }>;
+    setLayout(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: any;
+        rows: any;
+        sizes: any;
+        rowOrder: any;
+    }>;
+    moveNode(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        sourceUid: string;
+        targetUid: string;
+        position: string;
+    }>;
+    removeNode(values: Record<string, any>, options?: {
+        transaction?: any;
+    }): Promise<{
+        uid: string;
+    }>;
+    mutate(values: FlowSurfaceMutateValues, options?: {
+        transaction?: any;
+    }): Promise<{
+        results: {
+            opId?: string;
+            result: any;
+        }[];
+        clientKeyToUid: Record<string, string>;
+    }>;
+    apply(values: FlowSurfaceApplyValues, options?: {
+        transaction?: any;
+    }): Promise<{
+        clientKeyToUid: {
+            [x: string]: string;
+        };
+        results: {
+            opId?: string;
+            result: any;
+        }[];
+    }>;
+    transaction<T>(callback: (transaction: any) => Promise<T>): Promise<T>;
+    private dispatchOp;
+    private assertApplyMode;
+    private assertComposeMode;
+    private assertMutateAtomicFlag;
+    private normalizeWriteTarget;
+    private normalizeRootUidValue;
+    private assertRouteBackedPageUidTarget;
+    private assertRouteBackedTabUidTarget;
+    private assertPopupPageUidTarget;
+    private assertPopupTabUidTarget;
+    private normalizeRemoveNodeTarget;
+    private assertRemoveNodeResolvedTarget;
+    private normalizeGetTarget;
+    private normalizeContextPath;
+    private normalizeContextMaxDepth;
+    private buildReadTargetSummary;
+    private tryResolveActionCatalogItem;
+    private resolveAddActionCatalogItem;
+    private resolveAddRecordActionCatalogItem;
+    private resolveComposeBlockActionCatalogItem;
+    private resolveComposeRecordActionCatalogItem;
+    private resolveRecordActionContainer;
+    private runBatchCreate;
+    private normalizeComposeBlock;
+    private resolveComposeTargetRef;
+    private resolveComposeActionContainerUid;
+    private resolveComposeFieldContainerUid;
+    private resolveComposeRecordActionContainerUid;
+    private validateComposeActionGroups;
+    private buildComposeLayoutPayload;
+    private buildAppendGridLayoutPayload;
+    private readGridLayout;
+    private isGridLayoutValid;
+    private hasMaterialGridLayout;
+    private appendRowsToLayout;
+    private collectComposeActionRefs;
+    private collectPopupSurfaceRefs;
+    private removeNodeTreeWithBindings;
+    private cleanupNodeBindings;
+    private configurePage;
+    private configureTab;
+    private configureTableBlock;
+    private configureFormBlock;
+    private configureDetailsBlock;
+    private configureFilterFormBlock;
+    private configureListBlock;
+    private configureGridCardBlock;
+    private configureMarkdownBlock;
+    private configureIframeBlock;
+    private configureChartBlock;
+    private stripBasicSqlVisualWhenPreviewUnavailable;
+    private configureActionPanelBlock;
+    private configureJSBlock;
+    private configureActionColumn;
+    private configureJSColumn;
+    private configureJSItem;
+    private configureFieldWrapper;
+    private configureFieldNode;
+    private configureActionNode;
+    private buildFieldCatalog;
+    private getFieldMenuCatalogMode;
+    private resolveAssociationLeafDisplaySemantics;
+    private buildFieldMenuDirectCandidates;
+    private collectFieldMenuAssociationLeafCandidates;
+    private buildFieldMenuCandidates;
+    private findFieldMenuCandidate;
+    private buildFieldCatalogEntriesForResource;
+    private buildLegacyFieldCatalogEntriesForResource;
+    private findOwningBlockGrid;
+    private isFilterFormFieldPathAvailableForResource;
+    private persistFilterFormConnectConfig;
+    private removeFilterFormConnectConfig;
+    private removeFilterFormTargetBindings;
+    private collectChartBlockUidsFromTree;
+    private removeFlowSqlBindingsForChartUids;
+    private removeFlowSqlBindingsForNodeTree;
+    private persistChartSqlBinding;
+    private syncChartDataBindingsForNode;
+    private syncFilterFormConnectConfigForNode;
+    private syncFieldBindingSettingsForNode;
+    private buildFilterFormTargetPaths;
+    private getEditableDomains;
+    private resolveContextSemantic;
+    private loadContextAncestorChain;
+    private resolveCollectionFromInit;
+    private buildChartContextSemantic;
+    private resolveChartQueryOutputType;
+    private resolveContextOwnerCollection;
+    private resolveItemContextCollection;
+    private resolvePopupHostOpenView;
+    private resolvePopupSourceRecordCollectionName;
+    private resolvePopupContextLevel;
+    private getCollection;
+    private resolveFieldDefinition;
+    private getAssociationDefaultTitleFieldName;
+    private resolvePreferredFieldForCapability;
+    private ensureGridChild;
+    private ensureTableActionsColumn;
+    private ensurePopupSurface;
+    private ensureFlowRoutePageSchemaShell;
+    private removeFlowRoutePageSchemaShell;
+    private normalizeDisplayFieldBinding;
+    private buildExactFieldSettingsInitPayload;
+    private patchFieldSettingsInitExact;
+    private inferFieldComponentFlowDomain;
+    private resolveFieldComponentFieldSource;
+    private assertSupportedFieldComponentUse;
+    private syncFieldComponentStepParams;
+    private rebuildFieldSubModelOnServer;
+    private parseFieldPath;
+    private loadResolvedNode;
+    private normalizePopupTreeShape;
+}
+export {};