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

package/dist/swagger/flow-surfaces.examples.d.ts

@@ -0,0 +1,1215 @@
+/**
+ * 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.
+ */
+export declare const flowSurfaceExamples: {
+    catalog: {
+        target: {
+            uid: string;
+        };
+    };
+    context: {
+        target: {
+            uid: string;
+        };
+        path: string;
+        maxDepth: number;
+    };
+    getReactionMeta: {
+        target: {
+            uid: string;
+        };
+    };
+    describeSurface: {
+        locator: {
+            pageSchemaUid: string;
+        };
+        bindKeys: {
+            key: string;
+            locator: {
+                uid: string;
+            };
+            expectedKind: string;
+        }[];
+    };
+    applyBlueprint: {
+        version: string;
+        mode: string;
+        navigation: {
+            group: {
+                title: string;
+            };
+            item: {
+                title: string;
+            };
+        };
+        page: {
+            title: string;
+            documentTitle: string;
+            enableHeader: boolean;
+            displayTitle: boolean;
+        };
+        tabs: {
+            key: string;
+            title: string;
+            blocks: ({
+                key: string;
+                type: string;
+                collection: string;
+                fields: string[];
+                actions: string[];
+            } | {
+                key: string;
+                type: string;
+                collection: string;
+                fields: string[];
+                actions: {
+                    key: string;
+                    type: string;
+                }[];
+            })[];
+            layout: {
+                rows: string[][];
+            };
+        }[];
+        reaction: {
+            items: ({
+                type: string;
+                target: string;
+                rules: {
+                    key: string;
+                    targetPath: string;
+                    mode: string;
+                    value: {
+                        source: string;
+                        value: string;
+                    };
+                }[];
+            } | {
+                type: string;
+                target: string;
+                rules: {
+                    key: string;
+                    when: {
+                        logic: string;
+                        items: {
+                            path: string;
+                            operator: string;
+                        }[];
+                    };
+                    then: {
+                        type: string;
+                        state: string;
+                    }[];
+                }[];
+            } | {
+                type: string;
+                target: string;
+                rules: {
+                    key: string;
+                    when: {
+                        logic: string;
+                        items: {
+                            path: string;
+                            operator: string;
+                        }[];
+                    };
+                    then: {
+                        type: string;
+                        items: {
+                            targetPath: string;
+                            value: {
+                                source: string;
+                                version: string;
+                                code: string;
+                            };
+                        }[];
+                    }[];
+                }[];
+            })[];
+        };
+    };
+    applyBlueprintReplace: {
+        version: string;
+        mode: string;
+        target: {
+            pageSchemaUid: string;
+        };
+        page: {
+            title: string;
+            documentTitle: string;
+            displayTitle: boolean;
+            enableTabs: boolean;
+        };
+        tabs: {
+            title: string;
+            blocks: {
+                key: string;
+                type: string;
+                collection: string;
+                fields: string[];
+            }[];
+        }[];
+    };
+    setFieldValueRules: {
+        target: {
+            uid: string;
+        };
+        rules: {
+            key: string;
+            targetPath: string;
+            mode: string;
+            value: {
+                source: string;
+                value: string;
+            };
+        }[];
+        expectedFingerprint: string;
+    };
+    setBlockLinkageRules: {
+        target: {
+            uid: string;
+        };
+        rules: {
+            key: string;
+            when: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                }[];
+            };
+            then: {
+                type: string;
+                state: string;
+            }[];
+        }[];
+        expectedFingerprint: string;
+    };
+    setFieldLinkageRules: {
+        target: {
+            uid: string;
+        };
+        rules: {
+            key: string;
+            when: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                }[];
+            };
+            then: {
+                type: string;
+                items: {
+                    targetPath: string;
+                    value: {
+                        source: string;
+                        version: string;
+                        code: string;
+                    };
+                }[];
+            }[];
+        }[];
+        expectedFingerprint: string;
+    };
+    setActionLinkageRules: {
+        target: {
+            uid: string;
+        };
+        expectedFingerprint: string;
+        rules: {
+            key: string;
+            when: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                }[];
+            };
+            then: {
+                type: string;
+                state: string;
+            }[];
+        }[];
+    };
+    compose: {
+        target: {
+            uid: string;
+        };
+        mode: string;
+        blocks: ({
+            key: string;
+            type: string;
+            resource: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+            fields: {
+                fieldPath: string;
+                target: string;
+            }[];
+            actions: string[];
+            recordActions?: undefined;
+        } | {
+            key: string;
+            type: string;
+            resource: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+            fields: (string | {
+                fieldPath: string;
+            })[];
+            actions: string[];
+            recordActions: (string | {
+                type: string;
+                popup: {
+                    mode: string;
+                    blocks: {
+                        key: string;
+                        type: string;
+                        resource: {
+                            dataSourceKey: string;
+                            collectionName: string;
+                        };
+                        fields: string[];
+                    }[];
+                };
+            })[];
+        })[];
+        layout: {
+            rows: {
+                key: string;
+                span: number;
+            }[][];
+        };
+    };
+    composeStatic: {
+        target: {
+            uid: string;
+        };
+        blocks: ({
+            key: string;
+            type: string;
+            settings: {
+                content: string;
+                mode?: undefined;
+                url?: undefined;
+                height?: undefined;
+                layout?: undefined;
+                ellipsis?: undefined;
+            };
+        } | {
+            key: string;
+            type: string;
+            settings: {
+                mode: string;
+                url: string;
+                height: number;
+                content?: undefined;
+                layout?: undefined;
+                ellipsis?: undefined;
+            };
+        } | {
+            key: string;
+            type: string;
+            settings: {
+                layout: string;
+                ellipsis: boolean;
+                content?: undefined;
+                mode?: undefined;
+                url?: undefined;
+                height?: undefined;
+            };
+        })[];
+        layout: {
+            rows: string[][];
+        };
+    };
+    composeListRich: {
+        target: {
+            uid: string;
+        };
+        blocks: {
+            key: string;
+            type: string;
+            resource: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+            fields: (string | {
+                fieldPath: string;
+            })[];
+            actions: string[];
+            recordActions: (string | {
+                type: string;
+                popup: {
+                    mode: string;
+                    blocks: {
+                        key: string;
+                        type: string;
+                        resource: {
+                            dataSourceKey: string;
+                            collectionName: string;
+                        };
+                        fields: string[];
+                    }[];
+                };
+            })[];
+            settings: {
+                pageSize: number;
+                layout: string;
+            };
+        }[];
+    };
+    composeGridCardRich: {
+        target: {
+            uid: string;
+        };
+        blocks: {
+            key: string;
+            type: string;
+            resource: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+            fields: (string | {
+                fieldPath: string;
+            })[];
+            actions: string[];
+            recordActions: string[];
+            settings: {
+                columns: number;
+                rowCount: number;
+                layout: string;
+            };
+        }[];
+    };
+    composeJsBlock: {
+        target: {
+            uid: string;
+        };
+        blocks: {
+            key: string;
+            type: string;
+            settings: {
+                title: string;
+                description: string;
+                className: string;
+                version: string;
+                code: string;
+            };
+        }[];
+    };
+    configure: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            clickToOpen: boolean;
+            openView: {
+                dataSourceKey: string;
+                collectionName: string;
+                associationName: string;
+                mode: string;
+            };
+        };
+    };
+    configureAssociationPopup: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            clickToOpen: boolean;
+            openView: {
+                dataSourceKey: string;
+                collectionName: string;
+                associationName: string;
+                mode: string;
+            };
+        };
+    };
+    configureBlock: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            pageSize: number;
+            dataScope: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
+            sorting: {
+                field: string;
+                direction: string;
+            }[];
+            layout: string;
+        };
+    };
+    createMenu: {
+        title: string;
+        type: string;
+        parentMenuRouteId: number;
+    };
+    updateMenu: {
+        menuRouteId: number;
+        title: string;
+        parentMenuRouteId: any;
+    };
+    configureAction: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            title: string;
+            type: string;
+            color: string;
+            htmlType: string;
+            position: string;
+            confirm: {
+                enable: boolean;
+                title: string;
+                content: string;
+            };
+            assignValues: {
+                status: string;
+            };
+        };
+    };
+    configureJsBlock: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            title: string;
+            description: string;
+            className: string;
+            version: string;
+            code: string;
+        };
+    };
+    configureJsAction: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            title: string;
+            type: string;
+            version: string;
+            code: string;
+        };
+    };
+    configureJsItemAction: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            title: string;
+            type: string;
+            version: string;
+            code: string;
+        };
+    };
+    configureJsField: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            label: string;
+            version: string;
+            code: string;
+        };
+    };
+    configureJsColumn: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            title: string;
+            width: number;
+            fixed: string;
+            version: string;
+            code: string;
+        };
+    };
+    configureJsItem: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            label: string;
+            showLabel: boolean;
+            labelWidth: number;
+            version: string;
+            code: string;
+        };
+    };
+    configurePage: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            icon: string;
+            enableHeader: boolean;
+        };
+    };
+    configureTableAdvanced: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            quickEdit: boolean;
+            treeTable: boolean;
+            defaultExpandAllRows: boolean;
+            dragSort: boolean;
+            dragSortBy: string;
+        };
+    };
+    configureEditForm: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            colon: boolean;
+            dataScope: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
+        };
+    };
+    configureDetailsCompatibility: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            colon: boolean;
+            linkageRules: {
+                when: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                };
+                set: {
+                    hidden: boolean;
+                };
+            }[];
+        };
+    };
+    composePopupCurrentRecord: {
+        target: {
+            uid: string;
+        };
+        mode: string;
+        blocks: {
+            key: string;
+            type: string;
+            resource: {
+                binding: string;
+            };
+            fields: string[];
+        }[];
+    };
+    composePopupAssociatedRecords: {
+        target: {
+            uid: string;
+        };
+        mode: string;
+        blocks: {
+            key: string;
+            type: string;
+            resource: {
+                binding: string;
+                associationField: string;
+            };
+            fields: string[];
+            actions: string[];
+            recordActions: string[];
+        }[];
+    };
+    configureActionModesCompatibility: {
+        target: {
+            uid: string;
+        };
+        changes: {
+            linkageRules: {
+                when: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                };
+                set: {
+                    disabled: boolean;
+                };
+            }[];
+            editMode: string;
+            updateMode: string;
+            duplicateMode: string;
+            collapsedRows: number;
+            defaultCollapsed: boolean;
+            emailFieldNames: string[];
+            defaultSelectAllRecords: boolean;
+        };
+    };
+    createPage: {
+        menuRouteId: number;
+        title: string;
+        tabTitle: string;
+        enableTabs: boolean;
+        displayTitle: boolean;
+        documentTitle: string;
+        tabDocumentTitle: string;
+    };
+    addTab: {
+        target: {
+            uid: string;
+        };
+        title: string;
+        icon: string;
+        documentTitle: string;
+    };
+    updateTab: {
+        target: {
+            uid: string;
+        };
+        title: string;
+        icon: string;
+        documentTitle: string;
+        flowRegistry: {
+            beforeRenderApply: {
+                key: string;
+                on: string;
+                steps: {};
+            };
+        };
+    };
+    addPopupTab: {
+        target: {
+            uid: string;
+        };
+        title: string;
+        icon: string;
+        documentTitle: string;
+    };
+    updatePopupTab: {
+        target: {
+            uid: string;
+        };
+        title: string;
+        icon: string;
+        documentTitle: string;
+        flowRegistry: {
+            beforeRenderApply: {
+                key: string;
+                on: string;
+                steps: {};
+            };
+        };
+    };
+    movePopupTab: {
+        sourceUid: string;
+        targetUid: string;
+        position: string;
+    };
+    removePopupTab: {
+        target: {
+            uid: string;
+        };
+    };
+    addBlock: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        resource: {
+            binding: string;
+        };
+    };
+    addPopupAssociatedBlock: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        resource: {
+            binding: string;
+            associationField: string;
+        };
+    };
+    addPopupOtherRecordsBlock: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        resource: {
+            binding: string;
+            dataSourceKey: string;
+            collectionName: string;
+        };
+    };
+    addJsBlock: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            description: string;
+            version: string;
+            code: string;
+        };
+    };
+    addField: {
+        target: {
+            uid: string;
+        };
+        fieldPath: string;
+        renderer: string;
+        settings: {
+            label: string;
+            code: string;
+            version: string;
+        };
+    };
+    addAssociationField: {
+        target: {
+            uid: string;
+        };
+        fieldPath: string;
+        associationPathName: string;
+        settings: {
+            title: string;
+            width: number;
+        };
+        popup: {
+            mode: string;
+            blocks: {
+                key: string;
+                type: string;
+                resource: {
+                    binding: string;
+                };
+                fields: string[];
+            }[];
+        };
+    };
+    addJsColumn: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            width: number;
+            version: string;
+            code: string;
+        };
+    };
+    addJsItem: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            label: string;
+            showLabel: boolean;
+            version: string;
+            code: string;
+        };
+    };
+    addFieldPopupTemplate: {
+        target: {
+            uid: string;
+        };
+        fieldPath: string;
+        popup: {
+            template: {
+                uid: string;
+                mode: string;
+            };
+        };
+    };
+    addAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            confirm: boolean;
+        };
+    };
+    addLinkAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+        };
+    };
+    addJsAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            type: string;
+            version: string;
+            code: string;
+        };
+    };
+    addJsItemAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            type: string;
+            version: string;
+            code: string;
+        };
+    };
+    addRecordAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            openView: {
+                dataSourceKey: string;
+                collectionName: string;
+                mode: string;
+            };
+        };
+        popup: {
+            mode: string;
+            blocks: {
+                key: string;
+                type: string;
+                resource: {
+                    dataSourceKey: string;
+                    collectionName: string;
+                };
+                fields: string[];
+            }[];
+        };
+    };
+    addRecordJsAction: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        settings: {
+            title: string;
+            type: string;
+            version: string;
+            code: string;
+        };
+    };
+    addBlocks: {
+        target: {
+            uid: string;
+        };
+        blocks: ({
+            key: string;
+            type: string;
+            resourceInit: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+            settings: {
+                title: string;
+                pageSize: number;
+                content?: undefined;
+            };
+        } | {
+            key: string;
+            type: string;
+            settings: {
+                content: string;
+                title?: undefined;
+                pageSize?: undefined;
+            };
+            resourceInit?: undefined;
+        })[];
+    };
+    addFields: {
+        target: {
+            uid: string;
+        };
+        fields: ({
+            key: string;
+            fieldPath: string;
+            settings: {
+                title: string;
+                width: number;
+                label?: undefined;
+                code?: undefined;
+                version?: undefined;
+            };
+            popup: {
+                mode: string;
+                blocks: {
+                    key: string;
+                    type: string;
+                    resource: {
+                        binding: string;
+                    };
+                    fields: string[];
+                }[];
+            };
+            renderer?: undefined;
+        } | {
+            key: string;
+            fieldPath: string;
+            renderer: string;
+            settings: {
+                label: string;
+                code: string;
+                version: string;
+                title?: undefined;
+                width?: undefined;
+            };
+            popup?: undefined;
+        })[];
+    };
+    addActions: {
+        target: {
+            uid: string;
+        };
+        actions: ({
+            key: string;
+            type: string;
+            settings: {
+                title: string;
+                confirm: boolean;
+            };
+        } | {
+            key: string;
+            type: string;
+            settings: {
+                title: string;
+                confirm?: undefined;
+            };
+        })[];
+    };
+    addRecordActions: {
+        target: {
+            uid: string;
+        };
+        recordActions: ({
+            key: string;
+            type: string;
+            settings: {
+                title: string;
+                openView: {
+                    dataSourceKey: string;
+                    collectionName: string;
+                    mode: string;
+                };
+            };
+            popup: {
+                mode: string;
+                blocks: {
+                    key: string;
+                    type: string;
+                    resource: {
+                        dataSourceKey: string;
+                        collectionName: string;
+                    };
+                    fields: string[];
+                }[];
+            };
+        } | {
+            key: string;
+            type: string;
+            settings: {
+                title: string;
+                openView?: undefined;
+            };
+            popup?: undefined;
+        })[];
+    };
+    updateSettings: {
+        target: {
+            uid: string;
+        };
+        stepParams: {
+            tableSettings: {
+                pageSize: {
+                    pageSize: number;
+                };
+                tableDensity: {
+                    size: string;
+                };
+            };
+        };
+        flowRegistry: {
+            beforeRenderApply: {
+                key: string;
+                on: string;
+                steps: {};
+            };
+        };
+    };
+    setEventFlows: {
+        target: {
+            uid: string;
+        };
+        flowRegistry: {
+            popupSettings: {
+                key: string;
+                on: string;
+                steps: {
+                    openView: {
+                        params: {
+                            title: string;
+                            size: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+    setLayout: {
+        target: {
+            uid: string;
+        };
+        rows: {
+            row1: string[][];
+        };
+        sizes: {
+            row1: number[];
+        };
+        rowOrder: string[];
+    };
+    moveNode: {
+        sourceUid: string;
+        targetUid: string;
+        position: string;
+    };
+    removeNode: {
+        target: {
+            uid: string;
+        };
+    };
+    mutate: {
+        atomic: boolean;
+        ops: ({
+            opId: string;
+            type: string;
+            values: {
+                title: string;
+                type: string;
+                menuRouteId?: undefined;
+                tabTitle?: undefined;
+                target?: undefined;
+                resourceInit?: undefined;
+                fieldPath?: undefined;
+            };
+        } | {
+            opId: string;
+            type: string;
+            values: {
+                menuRouteId: {
+                    step: string;
+                    path: string;
+                };
+                tabTitle: string;
+                title?: undefined;
+                type?: undefined;
+                target?: undefined;
+                resourceInit?: undefined;
+                fieldPath?: undefined;
+            };
+        } | {
+            opId: string;
+            type: string;
+            values: {
+                target: {
+                    uid: {
+                        step: string;
+                        path: string;
+                    };
+                };
+                type: string;
+                resourceInit: {
+                    dataSourceKey: string;
+                    collectionName: string;
+                };
+                title?: undefined;
+                menuRouteId?: undefined;
+                tabTitle?: undefined;
+                fieldPath?: undefined;
+            };
+        } | {
+            type: string;
+            values: {
+                target: {
+                    uid: {
+                        step: string;
+                        path: string;
+                    };
+                };
+                fieldPath: string;
+                title?: undefined;
+                type?: undefined;
+                menuRouteId?: undefined;
+                tabTitle?: undefined;
+                resourceInit?: undefined;
+            };
+            opId?: undefined;
+        })[];
+    };
+    apply: {
+        target: {
+            uid: string;
+        };
+        mode: string;
+        spec: {
+            subModels: {
+                items: ({
+                    clientKey: string;
+                    use: string;
+                    stepParams: {
+                        resourceSettings: {
+                            init: {
+                                dataSourceKey: string;
+                                collectionName: string;
+                            };
+                        };
+                    };
+                    props?: undefined;
+                } | {
+                    clientKey: string;
+                    use: string;
+                    props: {
+                        content: string;
+                    };
+                    stepParams?: undefined;
+                })[];
+            };
+        };
+    };
+    getPopupQuery: {
+        uid: string;
+    };
+    getPageQuery: {
+        pageSchemaUid: string;
+    };
+};