@nocobase/plugin-flow-engine 2.1.0-alpha.10 → 2.1.0-alpha.11

package/dist/swagger/index.d.ts

@@ -0,0 +1,1164 @@
+/**
+ * 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.
+ */
+declare const _default: {
+    openapi: string;
+    info: {
+        title: string;
+    };
+    paths: {
+        '/flowModels:findOne': {
+            get: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        default?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        default: boolean;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:schema': {
+            get: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum?: undefined;
+                        default?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                        default: string;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    404: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:schemas': {
+            post: {
+                tags: string[];
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:schemaBundle': {
+            post: {
+                tags: string[];
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:save': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                        default: string;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        default: boolean;
+                        enum?: undefined;
+                    };
+                })[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:duplicate': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    anyOf: ({
+                                        $ref: string;
+                                        type?: undefined;
+                                    } | {
+                                        type: string;
+                                        $ref?: undefined;
+                                    })[];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:attach': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum?: undefined;
+                        description?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                        description?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        description: string;
+                        enum?: undefined;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:move': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                    };
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    example: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:destroy': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    example: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:ensure': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        default: boolean;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                            examples: {
+                                ensureByUid: {
+                                    summary: string;
+                                    value: {
+                                        uid: string;
+                                        use: string;
+                                        async: boolean;
+                                    };
+                                };
+                                ensureExistingByUid: {
+                                    summary: string;
+                                    value: {
+                                        uid: string;
+                                    };
+                                };
+                                ensureObjectChild: {
+                                    summary: string;
+                                    value: {
+                                        parentId: string;
+                                        subKey: string;
+                                        subType: string;
+                                        use: string;
+                                        async: boolean;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    404: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    409: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/flowModels:mutate': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        default: boolean;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                            examples: {
+                                duplicateAttachMoveUpsert: {
+                                    summary: string;
+                                    value: {
+                                        atomic: boolean;
+                                        ops: ({
+                                            opId: string;
+                                            type: string;
+                                            params: {
+                                                uid: string;
+                                                targetUid: string;
+                                                parentId?: undefined;
+                                                subKey?: undefined;
+                                                subType?: undefined;
+                                                position?: undefined;
+                                                sourceId?: undefined;
+                                                targetId?: undefined;
+                                                values?: undefined;
+                                            };
+                                        } | {
+                                            opId: string;
+                                            type: string;
+                                            params: {
+                                                uid: string;
+                                                parentId: string;
+                                                subKey: string;
+                                                subType: string;
+                                                position: string;
+                                                targetUid?: undefined;
+                                                sourceId?: undefined;
+                                                targetId?: undefined;
+                                                values?: undefined;
+                                            };
+                                        } | {
+                                            opId: string;
+                                            type: string;
+                                            params: {
+                                                sourceId: string;
+                                                targetId: string;
+                                                position: string;
+                                                uid?: undefined;
+                                                targetUid?: undefined;
+                                                parentId?: undefined;
+                                                subKey?: undefined;
+                                                subType?: undefined;
+                                                values?: undefined;
+                                            };
+                                        } | {
+                                            opId: string;
+                                            type: string;
+                                            params: {
+                                                values: {
+                                                    uid: string;
+                                                    use: string;
+                                                };
+                                                uid?: undefined;
+                                                targetUid?: undefined;
+                                                parentId?: undefined;
+                                                subKey?: undefined;
+                                                subType?: undefined;
+                                                position?: undefined;
+                                                sourceId?: undefined;
+                                                targetId?: undefined;
+                                            };
+                                        })[];
+                                        returnModels: string[];
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    404: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    409: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    500: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        schemas: {
+            ErrorItem: {
+                type: string;
+                required: string[];
+                properties: {
+                    code: {
+                        type: string;
+                    };
+                    message: {
+                        type: string;
+                    };
+                    details: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    opId: {
+                        type: string;
+                    };
+                    opIndex: {
+                        type: string;
+                    };
+                    jsonPointer: {
+                        type: string;
+                    };
+                    modelUid: {
+                        type: string;
+                    };
+                    modelUse: {
+                        type: string;
+                    };
+                    section: {
+                        type: string;
+                    };
+                    keyword: {
+                        type: string;
+                    };
+                    expectedType: {
+                        oneOf: ({
+                            type: string;
+                            items?: undefined;
+                        } | {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        })[];
+                    };
+                    allowedValues: {
+                        type: string;
+                        items: {};
+                    };
+                    suggestedUses: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    schemaHash: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            ErrorResponse: {
+                type: string;
+                required: string[];
+                properties: {
+                    errors: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedNullableFlowModelSnapshotResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        anyOf: ({
+                            $ref: string;
+                            type?: undefined;
+                        } | {
+                            type: string;
+                            $ref?: undefined;
+                        })[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelSchemaDocumentResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelSchemaDocumentListResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelSchemaBundleDocumentResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelSnapshotOrUidResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        oneOf: ({
+                            $ref: string;
+                            type?: undefined;
+                        } | {
+                            type: string;
+                            $ref?: undefined;
+                        })[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelSnapshotResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedFlowModelsMutateResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelEnsureRequest: {
+                oneOf: ({
+                    type: string;
+                    required: string[];
+                    properties: {
+                        uid: {
+                            type: string;
+                        };
+                        use: {
+                            type: string;
+                        };
+                        async: {
+                            type: string;
+                        };
+                        stepParams: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        flowRegistry: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        subModels: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        parentId?: undefined;
+                        subKey?: undefined;
+                        subType?: undefined;
+                    };
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        parentId: {
+                            type: string;
+                        };
+                        subKey: {
+                            type: string;
+                        };
+                        subType: {
+                            type: string;
+                            enum: string[];
+                        };
+                        use: {
+                            type: string;
+                        };
+                        async: {
+                            type: string;
+                        };
+                        stepParams: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        flowRegistry: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        subModels: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                        uid?: undefined;
+                    };
+                    additionalProperties: boolean;
+                })[];
+            };
+            FlowDynamicHint: {
+                type: string;
+                required: string[];
+                properties: {
+                    kind: {
+                        type: string;
+                    };
+                    path: {
+                        type: string;
+                    };
+                    message: {
+                        type: string;
+                    };
+                    'x-flow': {
+                        type: string;
+                        properties: {
+                            slotRules: {
+                                type: string;
+                                properties: {
+                                    slotKey: {
+                                        type: string;
+                                    };
+                                    type: {
+                                        type: string;
+                                        enum: string[];
+                                    };
+                                    allowedUses: {
+                                        type: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                                additionalProperties: boolean;
+                            };
+                            contextRequirements: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                };
+                            };
+                            unresolvedReason: {
+                                type: string;
+                            };
+                            recommendedFallback: {};
+                        };
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowSchemaPattern: {
+                type: string;
+                required: string[];
+                properties: {
+                    title: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                    snippet: {};
+                };
+                additionalProperties: boolean;
+            };
+            FlowSchemaCoverage: {
+                type: string;
+                required: string[];
+                properties: {
+                    status: {
+                        type: string;
+                        enum: string[];
+                    };
+                    source: {
+                        type: string;
+                        enum: string[];
+                    };
+                    strict: {
+                        type: string;
+                    };
+                    issues: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSchemasRequest: {
+                type: string;
+                properties: {
+                    uses: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    detail: {
+                        type: string;
+                        enum: string[];
+                        default: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSchemaDocument: {
+                type: string;
+                required: string[];
+                properties: {
+                    use: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    jsonSchema: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    dynamicHints: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    minimalExample: {};
+                    commonPatterns: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    antiPatterns: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    hash: {
+                        type: string;
+                    };
+                    source: {
+                        type: string;
+                        enum: string[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSchemaBundleItem: {
+                type: string;
+                required: string[];
+                properties: {
+                    use: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    subModelCatalog: {
+                        type: string;
+                        additionalProperties: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSchemaBundleSlotCatalog: {
+                type: string;
+                required: string[];
+                properties: {
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    required: {
+                        type: string;
+                    };
+                    open: {
+                        type: string;
+                    };
+                    candidates: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSchemaBundleDocument: {
+                type: string;
+                required: string[];
+                properties: {
+                    items: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelsMutateOp: {
+                type: string;
+                required: string[];
+                properties: {
+                    opId: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    params: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelsMutateRequest: {
+                type: string;
+                required: string[];
+                properties: {
+                    atomic: {
+                        type: string;
+                        enum: boolean[];
+                    };
+                    ops: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    returnModels: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelsMutateOpResult: {
+                type: string;
+                required: string[];
+                properties: {
+                    opId: {
+                        type: string;
+                    };
+                    ok: {
+                        type: string;
+                    };
+                    output: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelsMutateResponse: {
+                type: string;
+                required: string[];
+                properties: {
+                    results: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    models: {
+                        type: string;
+                        additionalProperties: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            FlowModelSnapshot: {
+                type: string;
+                required: string[];
+                properties: {
+                    uid: {
+                        type: string;
+                        description: string;
+                    };
+                    use: {
+                        type: string;
+                        description: string;
+                    };
+                    async: {
+                        type: string;
+                        description: string;
+                    };
+                    parentId: {
+                        type: string;
+                        description: string;
+                    };
+                    subKey: {
+                        type: string;
+                        description: string;
+                    };
+                    subType: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    stepParams: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    flowRegistry: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    subModels: {
+                        type: string;
+                        additionalProperties: {
+                            oneOf: ({
+                                $ref: string;
+                                type?: undefined;
+                                items?: undefined;
+                            } | {
+                                type: string;
+                                items: {
+                                    $ref: string;
+                                };
+                                $ref?: undefined;
+                            })[];
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+        };
+    };
+};
+export default _default;