@nocobase/plugin-flow-engine 2.1.0-alpha.3 → 2.1.0-alpha.31

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

@@ -0,0 +1,201 @@
+/**
+ * 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 { FlowSurfacePlanStep, FlowSurfaceReadLocator, FlowSurfaceSurfaceSelector, FlowSurfaceResourceBindingKey } from '../types';
+import type { FlowSurfaceApplyBlueprintReactionItem } from '../reaction/types';
+export type FlowSurfaceApplyBlueprintMode = 'create' | 'replace';
+export type FlowSurfaceApplyBlueprintTarget = {
+    pageSchemaUid: string;
+};
+export type FlowSurfaceApplyBlueprintNavigationGroup = {
+    routeId?: string | number;
+    title?: string;
+    icon?: string;
+    tooltip?: string;
+    hideInMenu?: boolean;
+};
+export type FlowSurfaceApplyBlueprintNavigation = {
+    group?: FlowSurfaceApplyBlueprintNavigationGroup;
+    item?: {
+        title?: string;
+        icon?: string;
+        tooltip?: string;
+        hideInMenu?: boolean;
+    };
+};
+export type FlowSurfaceApplyBlueprintPage = {
+    title?: string;
+    icon?: string;
+    documentTitle?: string;
+    enableHeader?: boolean;
+    enableTabs?: boolean;
+    displayTitle?: boolean;
+};
+export type FlowSurfaceApplyBlueprintAssetMap = Record<string, Record<string, any>>;
+export type FlowSurfaceApplyBlueprintAssets = {
+    scripts?: FlowSurfaceApplyBlueprintAssetMap;
+    charts?: FlowSurfaceApplyBlueprintAssetMap;
+};
+export type FlowSurfaceApplyBlueprintIdentifier = string | number;
+export type FlowSurfaceApplyBlueprintLayoutCellObject = {
+    key: string;
+    span?: number;
+};
+export type FlowSurfaceApplyBlueprintLayoutCell = string | FlowSurfaceApplyBlueprintLayoutCellObject;
+export type FlowSurfaceApplyBlueprintLayout = {
+    rows: FlowSurfaceApplyBlueprintLayoutCell[][];
+};
+export type FlowSurfaceApplyBlueprintSemanticResource = {
+    binding: FlowSurfaceResourceBindingKey;
+    dataSourceKey?: string;
+    collectionName?: string;
+    associationField?: string;
+};
+export type FlowSurfaceApplyBlueprintRawResource = {
+    dataSourceKey?: string;
+    collectionName?: string;
+    associationName?: string;
+    associationPathName?: string;
+    sourceId?: FlowSurfaceApplyBlueprintIdentifier;
+    filterByTk?: FlowSurfaceApplyBlueprintIdentifier;
+};
+export type FlowSurfaceApplyBlueprintBlockResource = FlowSurfaceApplyBlueprintSemanticResource | FlowSurfaceApplyBlueprintRawResource;
+export type FlowSurfaceApplyBlueprintPopup = {
+    title?: string;
+    mode?: 'replace' | 'append';
+    template?: Record<string, any>;
+    tryTemplate?: boolean;
+    defaultType?: 'view' | 'edit';
+    saveAsTemplate?: {
+        name: string;
+        description: string;
+        local?: string;
+    };
+    blocks?: FlowSurfaceApplyBlueprintBlockSpec[];
+    layout?: FlowSurfaceApplyBlueprintLayout;
+};
+export type FlowSurfaceApplyBlueprintFieldObjectSpec = {
+    key?: string;
+    field?: string;
+    associationPathName?: string;
+    renderer?: string;
+    type?: string;
+    fieldType?: string;
+    fields?: string[];
+    titleField?: string;
+    openMode?: string;
+    popupSize?: string;
+    pageSize?: number;
+    showIndex?: boolean;
+    label?: string;
+    target?: string;
+    settings?: Record<string, any>;
+    popup?: FlowSurfaceApplyBlueprintPopup;
+    script?: string;
+    chart?: string;
+};
+export type FlowSurfaceApplyBlueprintFieldSpec = string | FlowSurfaceApplyBlueprintFieldObjectSpec;
+export type FlowSurfaceApplyBlueprintFieldGroupSpec = {
+    key?: string;
+    title: string;
+    fields: FlowSurfaceApplyBlueprintFieldSpec[];
+};
+export type FlowSurfaceApplyBlueprintDefaultFieldGroupSpec = {
+    key?: string;
+    title: string;
+    fields: string[];
+};
+export type FlowSurfaceApplyBlueprintDefaultPopupName = {
+    name: string;
+    description: string;
+};
+export type FlowSurfaceApplyBlueprintDefaultPopupActionMap = {
+    view?: FlowSurfaceApplyBlueprintDefaultPopupName;
+    addNew?: FlowSurfaceApplyBlueprintDefaultPopupName;
+    edit?: FlowSurfaceApplyBlueprintDefaultPopupName;
+};
+export type FlowSurfaceApplyBlueprintDefaultPopups = FlowSurfaceApplyBlueprintDefaultPopupActionMap & {
+    associations?: Record<string, FlowSurfaceApplyBlueprintDefaultPopupActionMap>;
+};
+export type FlowSurfaceApplyBlueprintDefaultCollection = {
+    fieldGroups?: FlowSurfaceApplyBlueprintDefaultFieldGroupSpec[];
+    popups?: FlowSurfaceApplyBlueprintDefaultPopups;
+};
+export type FlowSurfaceApplyBlueprintDefaults = {
+    collections?: Record<string, FlowSurfaceApplyBlueprintDefaultCollection>;
+};
+export type FlowSurfaceApplyBlueprintActionObjectSpec = {
+    key?: string;
+    type: string;
+    title?: string;
+    settings?: Record<string, any>;
+    popup?: FlowSurfaceApplyBlueprintPopup;
+    script?: string;
+    chart?: string;
+};
+export type FlowSurfaceApplyBlueprintActionSpec = string | FlowSurfaceApplyBlueprintActionObjectSpec;
+export type FlowSurfaceApplyBlueprintBlockType = 'table' | 'createForm' | 'editForm' | 'details' | 'filterForm' | 'calendar' | 'kanban' | 'list' | 'gridCard' | 'markdown' | 'iframe' | 'chart' | 'actionPanel' | 'jsBlock' | 'tree';
+export type FlowSurfaceApplyBlueprintBlockSpec = {
+    key?: string;
+    type?: FlowSurfaceApplyBlueprintBlockType;
+    title?: string;
+    collection?: string;
+    dataSourceKey?: string;
+    associationPathName?: string;
+    binding?: FlowSurfaceResourceBindingKey;
+    associationField?: string;
+    resource?: FlowSurfaceApplyBlueprintBlockResource;
+    template?: Record<string, any>;
+    settings?: Record<string, any>;
+    fields?: FlowSurfaceApplyBlueprintFieldSpec[];
+    fieldGroups?: FlowSurfaceApplyBlueprintFieldGroupSpec[];
+    fieldsLayout?: FlowSurfaceApplyBlueprintLayout;
+    defaultFilter?: Record<string, any>;
+    actions?: FlowSurfaceApplyBlueprintActionSpec[];
+    recordActions?: FlowSurfaceApplyBlueprintActionSpec[];
+    script?: string;
+    chart?: string;
+};
+export type FlowSurfaceApplyBlueprintTabDocument = {
+    key: string;
+    title?: string;
+    icon?: string;
+    documentTitle?: string;
+    blocks: FlowSurfaceApplyBlueprintBlockSpec[];
+    layout?: FlowSurfaceApplyBlueprintLayout;
+};
+export type FlowSurfaceApplyBlueprintReaction = {
+    items: FlowSurfaceApplyBlueprintReactionItem[];
+};
+export type FlowSurfaceApplyBlueprintDocument = {
+    version: '1';
+    mode: FlowSurfaceApplyBlueprintMode;
+    target?: FlowSurfaceApplyBlueprintTarget;
+    navigation?: FlowSurfaceApplyBlueprintNavigation;
+    page?: FlowSurfaceApplyBlueprintPage;
+    defaults?: FlowSurfaceApplyBlueprintDefaults;
+    tabs: FlowSurfaceApplyBlueprintTabDocument[];
+    assets: FlowSurfaceApplyBlueprintAssets;
+    reaction?: FlowSurfaceApplyBlueprintReaction;
+};
+export type FlowSurfaceApplyBlueprintCollectionResolver = (dataSourceKey: string | undefined, collectionName: string | undefined) => any;
+export type FlowSurfaceApplyBlueprintReplaceTargetInfo = {
+    locator: FlowSurfaceReadLocator;
+    pageUid: string;
+    pageEnableTabs?: boolean;
+    tabs: Array<{
+        uid: string;
+    }>;
+};
+export type FlowSurfaceApplyBlueprintProgram = {
+    document: FlowSurfaceApplyBlueprintDocument;
+    surface?: FlowSurfaceSurfaceSelector;
+    steps: FlowSurfacePlanStep[];
+    pageLocator: FlowSurfaceReadLocator;
+    pageUid?: string;
+};

package/dist/server/flow-surfaces/blueprint/public-types.js

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var public_types_exports = {};
+module.exports = __toCommonJS(public_types_exports);

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

@@ -0,0 +1,238 @@
+/**
+ * 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 _ from 'lodash';
+import type { FlowSurfaceNodeDefaults, FlowSurfaceNodeSpec } from './types';
+type BuildFieldParams = {
+    wrapperUse: string;
+    fieldUse: string;
+    fieldPath: string;
+    dataSourceKey: string;
+    collectionName: string;
+    associationPathName?: string;
+    filterFormInit?: Record<string, any>;
+    wrapperProps?: Record<string, any>;
+    fieldProps?: Record<string, any>;
+    uid?: string;
+    innerUid?: string;
+};
+export declare function buildPersistedRootPageModel(options: {
+    pageUid?: string;
+    pageTitle: string;
+    routeId: string | number;
+    enableTabs?: boolean;
+    displayTitle?: boolean;
+    pageDocumentTitle?: string;
+}): {
+    uid: string;
+    use: string;
+    props: {
+        routeId: string | number;
+        title: string;
+        enableTabs: boolean;
+        displayTitle: boolean;
+    };
+    stepParams: {
+        pageSettings: {
+            general: {
+                title: string;
+                displayTitle: boolean;
+                enableTabs: boolean;
+                documentTitle: string;
+            };
+        };
+    };
+};
+export declare function buildSyntheticRootPageTabModel(options: {
+    uid: string;
+    title: string;
+    route: Record<string, any>;
+    documentTitle?: string;
+    icon?: string;
+    use?: string;
+    props?: Record<string, any>;
+    decoratorProps?: Record<string, any>;
+    stepParams?: Record<string, any>;
+    flowRegistry?: Record<string, any>;
+    grid?: Record<string, any> | null;
+}): {
+    subModels?: {
+        grid: Record<string, any>;
+    };
+    uid: string;
+    use: string;
+    props: {
+        route: Record<string, any>;
+        title: string;
+        icon: string;
+    };
+    decoratorProps: Record<string, any>;
+    flowRegistry: Record<string, any>;
+    stepParams: {
+        pageTabSettings: any;
+    };
+};
+export declare function buildBlockTree(options: {
+    type?: string;
+    use?: string;
+    containerUse?: string;
+    resourceInit?: Record<string, any>;
+    enableDefaultSorting?: boolean;
+    props?: Record<string, any>;
+    decoratorProps?: Record<string, any>;
+    stepParams?: Record<string, any>;
+    flowRegistry?: Record<string, any>;
+}): FlowSurfaceNodeSpec;
+export declare function buildPopupPageTree(options: {
+    pageUid?: string;
+    tabUid?: string;
+    gridUid?: string;
+    pageTitle?: string;
+    tabTitle?: string;
+    displayTitle?: boolean;
+    enableTabs?: boolean;
+}): {
+    uid: string;
+    use: string;
+    props: {
+        displayTitle: boolean;
+        enableTabs: boolean;
+        title?: string;
+    };
+    stepParams: {
+        pageSettings: {
+            general: {
+                displayTitle: boolean;
+                enableTabs: boolean;
+                title?: string;
+            };
+        };
+    };
+    subModels: {
+        tabs: {
+            uid: string;
+            use: string;
+            props: {
+                title: string;
+            };
+            stepParams: {
+                pageTabSettings: {
+                    tab: {
+                        title: string;
+                    };
+                };
+            };
+            subModels: {
+                grid: {
+                    uid: string;
+                    use: string;
+                };
+            };
+        }[];
+    };
+};
+export declare function buildFieldTree(params: BuildFieldParams): {
+    wrapperUid: string;
+    innerUid: string;
+    model: {
+        uid: string;
+        use: string;
+        props: Record<string, any>;
+        stepParams: Record<string, any>;
+        subModels: {
+            field: {
+                uid: string;
+                use: string;
+                props: Record<string, any>;
+                stepParams: Record<string, any> & {
+                    fieldSettings: {
+                        init: _.Dictionary<string>;
+                    };
+                    fieldBinding: {
+                        use: string;
+                    };
+                };
+            };
+        };
+    };
+} | {
+    wrapperUid: string;
+    innerUid: string;
+    model: {
+        uid: string;
+        use: string;
+        props: Record<string, any>;
+        stepParams: Record<string, any>;
+        subModels: {
+            field: {
+                subModels?: Record<string, FlowSurfaceNodeSpec | FlowSurfaceNodeSpec[]>;
+                uid: string;
+                use: string;
+                props: Record<string, any>;
+                stepParams: Record<string, any> & {
+                    fieldSettings: {
+                        init: _.Dictionary<string>;
+                    };
+                };
+            };
+        };
+    };
+};
+export declare function buildStandaloneFieldNode(options: {
+    use: 'JSColumnModel' | 'JSItemModel' | 'DividerItemModel';
+    uid?: string;
+    props?: Record<string, any>;
+    decoratorProps?: Record<string, any>;
+    stepParams?: Record<string, any>;
+}): {
+    uid: string;
+    use: "JSColumnModel" | "JSItemModel" | "DividerItemModel";
+    props: Record<string, any>;
+    decoratorProps: Record<string, any>;
+    stepParams: Record<string, any>;
+};
+export declare function buildActionTree(options: {
+    type?: string;
+    use?: string;
+    containerUse?: string;
+    resourceInit?: Record<string, any>;
+    props?: Record<string, any>;
+    decoratorProps?: Record<string, any>;
+    stepParams?: Record<string, any>;
+    flowRegistry?: Record<string, any>;
+}): {
+    subModels?: Record<string, FlowSurfaceNodeSpec | FlowSurfaceNodeSpec[]>;
+    use: string;
+    props: Record<string, any>;
+    decoratorProps: Record<string, any>;
+    stepParams: Record<string, any>;
+    flowRegistry: Record<string, any>;
+};
+export declare function buildCanonicalTableActionsColumnNode(options?: {
+    uid?: string;
+    props?: Record<string, any>;
+    decoratorProps?: Record<string, any>;
+    stepParams?: Record<string, any>;
+    flowRegistry?: Record<string, any>;
+}): {
+    uid: string;
+    use: string;
+    props: Record<string, any>;
+    decoratorProps: Record<string, any>;
+    stepParams: {
+        tableColumnSettings: {
+            title: {
+                title: string;
+            };
+        };
+    } & Record<string, any>;
+    flowRegistry: Record<string, any>;
+};
+export declare function assignClientKeysToUids(spec: FlowSurfaceNodeSpec, clientKeyToUid: Record<string, string>): FlowSurfaceNodeSpec;
+export declare function getStandaloneFieldDefaults(use: string): FlowSurfaceNodeDefaults;
+export {};