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

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

@@ -0,0 +1,87 @@
+/**
+ * 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 { FlowSchemaRegistry, type ActionDefinition, type FlowActionSchemaContribution, type FlowFieldBindingContextContribution, type FlowFieldBindingContribution, type FlowSchemaInventoryContribution, type FlowModelSchemaContribution, type FlowSchemaBundleDocument, type FlowSchemaContextEdge, type FlowSchemaDocument, type FlowSchemaDetail, type FlowSchemaPublicDocument, type ModelConstructor } from '@nocobase/flow-engine/server';
+export interface FlowSchemaValidationIssue {
+    level: 'error' | 'warning';
+    jsonPointer: string;
+    modelUid?: string;
+    modelUse?: string;
+    section: 'model' | 'stepParams' | 'subModels' | 'flowRegistry';
+    keyword: string;
+    message: string;
+    expectedType?: string | string[];
+    allowedValues?: any[];
+    suggestedUses?: string[];
+    fieldInterface?: string;
+    fieldType?: string;
+    targetCollectionTemplate?: string;
+    schemaHash?: string;
+}
+type NormalizeModelTreeOptions = {
+    allowRootObjectLocator?: boolean;
+    assignImplicitUids?: boolean;
+};
+type FlowSchemaValidationOptions = {
+    allowRootObjectLocator?: boolean;
+    existingNodeUids?: ReadonlySet<string>;
+};
+export declare class FlowSchemaService {
+    readonly registry: FlowSchemaRegistry;
+    private readonly ajv;
+    private readonly validatorCache;
+    private app;
+    constructor();
+    registerModels(models: Record<string, ModelConstructor>): void;
+    registerActions(actions: Record<string, ActionDefinition>): void;
+    registerActionContributions(contributions: FlowActionSchemaContribution[] | Record<string, FlowActionSchemaContribution>): void;
+    registerModelContributions(contributions: FlowModelSchemaContribution[] | Record<string, FlowModelSchemaContribution>): void;
+    registerInventory(inventory: FlowSchemaInventoryContribution | undefined, source: 'official' | 'plugin' | 'third-party'): void;
+    registerFieldBindingContexts(contributions: FlowFieldBindingContextContribution[] | Record<string, FlowFieldBindingContextContribution> | undefined): void;
+    registerFieldBindings(contributions: FlowFieldBindingContribution[] | Record<string, FlowFieldBindingContribution | FlowFieldBindingContribution[]> | undefined, source: 'official' | 'plugin' | 'third-party'): void;
+    setApp(app: any): void;
+    private readDocumentFromRegistry;
+    getDocument(use: string, options?: {
+        clone?: boolean;
+    }): FlowSchemaDocument | undefined;
+    getDocuments(uses?: string[], options?: {
+        clone?: boolean;
+    }): FlowSchemaDocument[];
+    private projectDocument;
+    getPublicDocument(use: string, options?: {
+        clone?: boolean;
+        detail?: FlowSchemaDetail;
+    }): FlowSchemaPublicDocument | undefined;
+    getPublicDocuments(uses?: string[], options?: {
+        clone?: boolean;
+        detail?: FlowSchemaDetail;
+    }): FlowSchemaPublicDocument[];
+    getBundle(uses?: string[]): FlowSchemaBundleDocument;
+    private collectRuntimeFieldBindingUses;
+    private resolveFieldBindingMetadata;
+    validateModelTree(input: any, options?: FlowSchemaValidationOptions): FlowSchemaValidationIssue[];
+    validateNormalizedModelTree(input: any, options?: FlowSchemaValidationOptions): FlowSchemaValidationIssue[];
+    normalizeModelTree(input: any, contextChain?: FlowSchemaContextEdge[], options?: NormalizeModelTreeOptions, isRoot?: boolean): any;
+    assignImplicitUids(input: any, options?: {
+        allowRootObjectLocator?: boolean;
+    }, isRoot?: boolean): any;
+    private normalizeModelNodeInput;
+    private normalizeChildModelInput;
+    private validateModelNode;
+    private validateFlowRegistry;
+    private validateStepParams;
+    private validateSubModels;
+    private validateRequiredSubModelSlots;
+    private validateSubModelChildUse;
+    private validateFlowOn;
+    private validateSchemaSection;
+    private validateSchema;
+    private pushAjvIssues;
+    private escapeJsonPointer;
+}
+export {};