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

package/dist/server/flow-schema-contributions/shared.d.ts

@@ -1,501 +0,0 @@
-/**
- * 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 { FlowDynamicHint, FlowJsonSchema, FlowModelSchemaContribution, FlowSubModelSlotSchema } from '@nocobase/flow-engine';
-export declare const genericFilterSchema: FlowJsonSchema;
-export declare const genericModelNodeSchema: FlowJsonSchema;
-export declare const emptyObjectSchema: FlowJsonSchema;
-export declare const linkageRuleValueSchema: FlowJsonSchema;
-export declare const layoutParamsSchema: FlowJsonSchema;
-export declare const dataScopeParamsSchema: FlowJsonSchema;
-export declare const sortingRuleParamsSchema: FlowJsonSchema;
-export declare const aclCheckRefreshParamsSchema: FlowJsonSchema;
-export declare const linkageRulesRefreshParamsSchema: FlowJsonSchema;
-export declare const openViewParamsSchema: FlowJsonSchema;
-export declare const gridRowsSchema: FlowJsonSchema;
-export declare const gridSizesSchema: FlowJsonSchema;
-export declare const gridRowOrderSchema: FlowJsonSchema;
-export declare function createGridLayoutStepParamsSchema(): FlowJsonSchema;
-export declare function createGridLayoutDocs(options: {
-    use: string;
-    itemUses: string[];
-    prefix: string;
-    dynamicHints?: FlowDynamicHint[];
-}): FlowModelSchemaContribution['docs'];
-export declare const publicBlockRootUses: string[];
-export declare const pageTabUses: string[];
-export declare const tableColumnUses: string[];
-export declare const coreBlockGridItemUses: string[];
-export declare const collectionActionUses: string[];
-export declare const recordActionUses: string[];
-export declare const formBlockActionUses: string[];
-export declare const filterFormActionUses: string[];
-export declare const formGridItemUses: string[];
-export declare const detailsGridItemUses: string[];
-export declare const filterFormGridItemUses: string[];
-export declare const fieldBindingInitSchema: FlowJsonSchema;
-export declare const filterFieldMetadataSchema: FlowJsonSchema;
-export declare function createRuntimeFieldModelSlotSchema(fieldBindingContext: string, description?: string): FlowSubModelSlotSchema;
-export declare const showLabelStepParamsSchema: FlowJsonSchema;
-export declare const labelStepParamsSchema: FlowJsonSchema;
-export declare const tooltipStepParamsSchema: FlowJsonSchema;
-export declare const descriptionStepParamsSchema: FlowJsonSchema;
-export declare const defaultValueStepParamsSchema: FlowJsonSchema;
-export declare const tableColumnWidthStepParamsSchema: FlowJsonSchema;
-export declare const tableColumnEditableStepParamsSchema: FlowJsonSchema;
-export declare const tableColumnSorterStepParamsSchema: FlowJsonSchema;
-export declare const filterFormItemInitStepParamsSchema: FlowJsonSchema;
-export declare const actionButtonGeneralStepParamsSchema: FlowJsonSchema;
-export declare const actionButtonSettingsStepParamsSchema: FlowJsonSchema;
-export declare function createActionStepParamsSchema(extraProperties?: Record<string, FlowJsonSchema>): FlowJsonSchema;
-export declare const confirmStepParamsSchema: FlowJsonSchema;
-export declare const popupActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const runJsActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const deleteActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const refreshActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const expandCollapseActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const filterActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const linkActionSettingsStepParamsSchema: FlowJsonSchema;
-export declare const formSubmitSettingsStepParamsSchema: FlowJsonSchema;
-export declare const filterFormCollapseSettingsStepParamsSchema: FlowJsonSchema;
-export declare const pageTabSettingsStepParamsSchema: FlowJsonSchema;
-export declare const childPageSettingsStepParamsSchema: FlowJsonSchema;
-export declare function createPopupActionOpenViewParams(overrides?: Partial<{
-    uid: string;
-    mode: 'drawer' | 'dialog' | 'embed';
-    size: 'small' | 'medium' | 'large';
-    pageModelClass: 'ChildPageModel' | 'RootPageModel';
-    filterByTk: string | number;
-    sourceId: string | number;
-    dataSourceKey: string;
-    collectionName: string;
-    associationName: string;
-    preventClose: boolean;
-    navigation: boolean;
-    tabUid: string;
-}>): {
-    uid?: string;
-    mode: string;
-    size: string;
-    pageModelClass: 'ChildPageModel' | 'RootPageModel';
-    filterByTk?: string | number;
-    sourceId?: string | number;
-    dataSourceKey?: string;
-    collectionName?: string;
-    associationName?: string;
-    preventClose?: boolean;
-    navigation?: boolean;
-    tabUid?: string;
-};
-export declare function createPopupBlockGrid(options: {
-    prefix: string;
-    items?: any[];
-}): {
-    uid: string;
-    use: string;
-    subModels: {
-        items: any[];
-    };
-};
-export declare function createPopupChildPageTree(options: {
-    prefix: string;
-    tabTitle?: string;
-    items?: any[];
-}): {
-    uid: string;
-    use: string;
-    stepParams: {
-        pageSettings: {
-            general: {
-                displayTitle: boolean;
-                enableTabs: boolean;
-            };
-        };
-    };
-    subModels: {
-        tabs: {
-            uid: string;
-            use: string;
-            stepParams: {
-                pageTabSettings: {
-                    tab: {
-                        title: string;
-                    };
-                };
-            };
-            subModels: {
-                grid: {
-                    uid: string;
-                    use: string;
-                    subModels: {
-                        items: any[];
-                    };
-                };
-            };
-        }[];
-    };
-};
-export declare function createPopupPageSlotSchema(): FlowSubModelSlotSchema;
-export declare const popupActionAntiPatterns: {
-    title: string;
-    description: string;
-}[];
-export declare function createPopupActionStepParams(title: string, overrides?: Record<string, any>): {
-    buttonSettings: {
-        general: {
-            title: string;
-            type: string;
-        };
-    };
-    popupSettings: {
-        openView: {
-            uid?: string;
-            mode: string;
-            size: string;
-            pageModelClass: "ChildPageModel" | "RootPageModel";
-            filterByTk?: string | number;
-            sourceId?: string | number;
-            dataSourceKey?: string;
-            collectionName?: string;
-            associationName?: string;
-            preventClose?: boolean;
-            navigation?: boolean;
-            tabUid?: string;
-        };
-    };
-};
-export declare function createPopupActionExample(options: {
-    uid: string;
-    use: string;
-    title: string;
-    prefix: string;
-    tabTitle?: string;
-    items?: any[];
-    openView?: Record<string, any>;
-}): {
-    uid: string;
-    use: string;
-    stepParams: {
-        buttonSettings: {
-            general: {
-                title: string;
-                type: string;
-            };
-        };
-        popupSettings: {
-            openView: {
-                uid?: string;
-                mode: string;
-                size: string;
-                pageModelClass: "ChildPageModel" | "RootPageModel";
-                filterByTk?: string | number;
-                sourceId?: string | number;
-                dataSourceKey?: string;
-                collectionName?: string;
-                associationName?: string;
-                preventClose?: boolean;
-                navigation?: boolean;
-                tabUid?: string;
-            };
-        };
-    };
-    subModels: {
-        page: {
-            uid: string;
-            use: string;
-            stepParams: {
-                pageSettings: {
-                    general: {
-                        displayTitle: boolean;
-                        enableTabs: boolean;
-                    };
-                };
-            };
-            subModels: {
-                tabs: {
-                    uid: string;
-                    use: string;
-                    stepParams: {
-                        pageTabSettings: {
-                            tab: {
-                                title: string;
-                            };
-                        };
-                    };
-                    subModels: {
-                        grid: {
-                            uid: string;
-                            use: string;
-                            subModels: {
-                                items: any[];
-                            };
-                        };
-                    };
-                }[];
-            };
-        };
-    };
-};
-export declare function createPopupActionPattern(options: {
-    title: string;
-    description?: string;
-    use: string;
-    buttonTitle: string;
-    prefix: string;
-    tabTitle?: string;
-    items?: any[];
-    openView?: Record<string, any>;
-}): {
-    title: string;
-    description: string;
-    snippet: {
-        use: string;
-        stepParams: {
-            buttonSettings: {
-                general: {
-                    title: string;
-                    type: string;
-                };
-            };
-            popupSettings: {
-                openView: {
-                    uid?: string;
-                    mode: string;
-                    size: string;
-                    pageModelClass: "ChildPageModel" | "RootPageModel";
-                    filterByTk?: string | number;
-                    sourceId?: string | number;
-                    dataSourceKey?: string;
-                    collectionName?: string;
-                    associationName?: string;
-                    preventClose?: boolean;
-                    navigation?: boolean;
-                    tabUid?: string;
-                };
-            };
-        };
-        subModels: {
-            page: {
-                uid: string;
-                use: string;
-                stepParams: {
-                    pageSettings: {
-                        general: {
-                            displayTitle: boolean;
-                            enableTabs: boolean;
-                        };
-                    };
-                };
-                subModels: {
-                    tabs: {
-                        uid: string;
-                        use: string;
-                        stepParams: {
-                            pageTabSettings: {
-                                tab: {
-                                    title: string;
-                                };
-                            };
-                        };
-                        subModels: {
-                            grid: {
-                                uid: string;
-                                use: string;
-                                subModels: {
-                                    items: any[];
-                                };
-                            };
-                        };
-                    }[];
-                };
-            };
-        };
-    };
-};
-export declare const detailItemStepParamsSchema: FlowJsonSchema;
-export declare const formItemStepParamsSchema: FlowJsonSchema;
-export declare const assignFormItemStepParamsSchema: FlowJsonSchema;
-export declare const filterFormItemStepParamsSchema: FlowJsonSchema;
-export declare const tableColumnStepParamsSchema: FlowJsonSchema;
-export declare function createFieldBoundStepParamsSchema(bindingFlowKey: string, bindingFlowSchema: FlowJsonSchema, extraProperties?: Record<string, FlowJsonSchema>): FlowJsonSchema;
-export declare function createRuntimeFieldDynamicHint(modelUse: string, path: string, contextRequirements: string[], unresolvedReason: string): FlowDynamicHint;
-export declare function createFieldModelStepParamsSchema(extraFieldSettingsProperties?: Record<string, FlowJsonSchema>): FlowJsonSchema;
-export declare function createFieldModelSkeleton(use: string, init?: Partial<{
-    dataSourceKey: string;
-    collectionName: string;
-    fieldPath: string;
-    associationPathName: string;
-}>): {
-    stepParams?: {
-        fieldSettings: {
-            init: {
-                dataSourceKey?: string;
-                collectionName?: string;
-                fieldPath?: string;
-                associationPathName?: string;
-            };
-        };
-    };
-    uid: string;
-    use: string;
-};
-export declare function createFieldModelSchemaContribution(options: {
-    use: string;
-    title?: string;
-    source?: 'official' | 'plugin' | 'third-party';
-    strict?: boolean;
-    exposure?: 'public' | 'internal';
-    abstract?: boolean;
-    allowDirectUse?: boolean;
-    suggestedUses?: string[];
-    stepParamsSchema?: FlowJsonSchema;
-    skeleton?: any;
-}): FlowModelSchemaContribution;
-export declare const collectionResourceInitSchema: FlowJsonSchema;
-export declare const collectionResourceSettingsStepParamsSchema: FlowJsonSchema;
-export declare function createCollectionResourceInit(init?: Partial<{
-    dataSourceKey: string;
-    collectionName: string;
-    associationName: string;
-    sourceId: string | number;
-    filterByTk: string | number;
-}>): {
-    dataSourceKey: string;
-    collectionName: string;
-    associationName?: string;
-    sourceId?: string | number;
-    filterByTk?: string | number;
-};
-export declare function createCollectionResourceStepParams(init?: Partial<{
-    dataSourceKey: string;
-    collectionName: string;
-    associationName: string;
-    sourceId: string | number;
-    filterByTk: string | number;
-}>, extraStepParams?: Record<string, any>): {
-    resourceSettings: {
-        init: {
-            dataSourceKey: string;
-            collectionName: string;
-            associationName?: string;
-            sourceId?: string | number;
-            filterByTk?: string | number;
-        };
-    };
-};
-export declare function createCurrentRecordCollectionPattern(use: string, extraStepParams?: Record<string, any>): {
-    title: string;
-    description: string;
-    snippet: {
-        use: string;
-        stepParams: {
-            resourceSettings: {
-                init: {
-                    dataSourceKey: string;
-                    collectionName: string;
-                    associationName?: string;
-                    sourceId?: string | number;
-                    filterByTk?: string | number;
-                };
-            };
-        };
-    };
-};
-export declare function createAssociatedCollectionPattern(use: string, extraStepParams?: Record<string, any>): {
-    title: string;
-    description: string;
-    snippet: {
-        use: string;
-        stepParams: {
-            resourceSettings: {
-                init: {
-                    dataSourceKey: string;
-                    collectionName: string;
-                    associationName?: string;
-                    sourceId?: string | number;
-                    filterByTk?: string | number;
-                };
-            };
-        };
-    };
-};
-export declare const formBlockBaseStepParamsSchema: FlowJsonSchema;
-export declare function createFormGridDynamicHints(): FlowDynamicHint[];
-export declare function createFormBlockSubModelSlots(): Record<string, FlowSubModelSlotSchema>;
-export declare function createFormBlockSkeleton(use: string): {
-    uid: string;
-    use: string;
-    stepParams: {
-        resourceSettings: {
-            init: {
-                dataSourceKey: string;
-                collectionName: string;
-                associationName?: string;
-                sourceId?: string | number;
-                filterByTk?: string | number;
-            };
-        };
-    };
-    subModels: {
-        grid: {
-            uid: string;
-            use: string;
-        };
-        actions: any[];
-    };
-};
-export declare function createFormBlockMinimalExample(use: string): {
-    uid: string;
-    use: string;
-    stepParams: {
-        resourceSettings: {
-            init: {
-                dataSourceKey: string;
-                collectionName: string;
-                associationName?: string;
-                sourceId?: string | number;
-                filterByTk?: string | number;
-            };
-        };
-    };
-    subModels: {
-        grid: {
-            uid: string;
-            use: string;
-        };
-        actions: any[];
-    };
-};
-export declare function createFormBlockCommonPatterns(use: string): {
-    title: string;
-    snippet: {
-        use: string;
-        stepParams: {
-            resourceSettings: {
-                init: {
-                    dataSourceKey: string;
-                    collectionName: string;
-                    associationName?: string;
-                    sourceId?: string | number;
-                    filterByTk?: string | number;
-                };
-            };
-        };
-        subModels: {
-            grid: {
-                uid: string;
-                use: string;
-            };
-        };
-    };
-}[];
-export declare const formBlockAntiPatterns: {
-    title: string;
-    description: string;
-}[];
-export declare function createFormBlockDynamicHints(use: string): FlowDynamicHint[];