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

package/dist/server/flow-schema-contributions/models/index.d.ts

@@ -6,7 +6,7 @@
  * 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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+import type { FlowModelSchemaContribution, FlowSchemaContribution } from '../../flow-schema-registry';
 import { actionModelSchemaContribution } from './ActionModel';
 import { addChildActionModelInternalSchemaContribution } from './AddChildActionModel';
 import { addNewActionModelInternalSchemaContribution } from './AddNewActionModel';
@@ -64,3 +64,8 @@ import { updateRecordActionModelSchemaContribution } from './UpdateRecordActionM
 import { viewActionModelInternalSchemaContribution } from './ViewActionModel';
 export { actionModelSchemaContribution, addChildActionModelInternalSchemaContribution, addNewActionModelInternalSchemaContribution, assignFormItemModelInternalSchemaContribution, assignFormGridModelInternalSchemaContribution, assignFormModelInternalSchemaContribution, basePageTabModelInternalSchemaContribution, blockGridModelInternalSchemaContribution, bulkDeleteActionModelInternalSchemaContribution, childPageModelInternalSchemaContribution, childPageTabModelInternalSchemaContribution, createFormModelSchemaContribution, deleteActionModelInternalSchemaContribution, detailsBlockModelSchemaContribution, detailsGridModelInternalSchemaContribution, detailsItemModelInternalSchemaContribution, editActionModelInternalSchemaContribution, expandCollapseActionModelInternalSchemaContribution, editFormModelSchemaContribution, filterActionModelInternalSchemaContribution, filterFormBlockModelSchemaContribution, filterFormCollapseActionModelInternalSchemaContribution, filterFormCustomFieldModelInternalSchemaContribution, filterFormGridModelInternalSchemaContribution, filterFormItemModelInternalSchemaContribution, filterFormJsActionModelInternalSchemaContribution, filterFormResetActionModelInternalSchemaContribution, filterFormSubmitActionModelInternalSchemaContribution, formBlockModelInternalSchemaContribution, formAssociationItemModelInternalSchemaContribution, formGridModelInternalSchemaContribution, jsActionModelInternalSchemaContribution, jsBlockModelSchemaContribution, jsCollectionActionModelInternalSchemaContribution, jsFormActionModelInternalSchemaContribution, jsItemModelInternalSchemaContribution, formItemModelInternalSchemaContribution, jsRecordActionModelInternalSchemaContribution, formSubmitActionModelInternalSchemaContribution, jsColumnModelInternalSchemaContribution, linkActionModelInternalSchemaContribution, pageModelSchemaContribution, pageTabModelInternalSchemaContribution, popupActionModelInternalSchemaContribution, popupCollectionActionModelInternalSchemaContribution, refreshActionModelInternalSchemaContribution, rootPageModelSchemaContribution, rootPageTabModelInternalSchemaContribution, routeModelSchemaContribution, tableActionsColumnModelInternalSchemaContribution, tableBlockModelSchemaContribution, tableColumnModelInternalSchemaContribution, tableCustomColumnModelInternalSchemaContribution, updateRecordActionModelSchemaContribution, viewActionModelInternalSchemaContribution, };
 export declare const flowSchemaModelContributions: FlowModelSchemaContribution[];
+export type OfficialFlowSchemaContributionEntry = {
+    packageName: string;
+    contribution: FlowSchemaContribution;
+};
+export declare const officialFlowSchemaContributions: OfficialFlowSchemaContributionEntry[];

package/dist/server/flow-schema-contributions/models/index.js

@@ -68,6 +68,7 @@ __export(models_exports, {
   jsItemModelInternalSchemaContribution: () => import_JSItemModel.jsItemModelInternalSchemaContribution,
   jsRecordActionModelInternalSchemaContribution: () => import_JSRecordActionModel.jsRecordActionModelInternalSchemaContribution,
   linkActionModelInternalSchemaContribution: () => import_LinkActionModel.linkActionModelInternalSchemaContribution,
+  officialFlowSchemaContributions: () => officialFlowSchemaContributions,
   pageModelSchemaContribution: () => import_PageModel.pageModelSchemaContribution,
   pageTabModelInternalSchemaContribution: () => import_PageTabModel.pageTabModelInternalSchemaContribution,
   popupActionModelInternalSchemaContribution: () => import_PopupActionModel.popupActionModelInternalSchemaContribution,
@@ -84,18 +85,31 @@ __export(models_exports, {
   viewActionModelInternalSchemaContribution: () => import_ViewActionModel.viewActionModelInternalSchemaContribution
 });
 module.exports = __toCommonJS(models_exports);
+var import_ActionBulkEditModel = require("./ActionBulkEditModel");
+var import_ActionBulkUpdateModel = require("./ActionBulkUpdateModel");
+var import_ActionCustomRequestModel = require("./ActionCustomRequestModel");
 var import_ActionModel = require("./ActionModel");
+var import_ActionDuplicateModel = require("./ActionDuplicateModel");
+var import_ActionExportModel = require("./ActionExportModel");
+var import_ActionImportModel = require("./ActionImportModel");
 var import_AddChildActionModel = require("./AddChildActionModel");
 var import_AddNewActionModel = require("./AddNewActionModel");
 var import_AssignFormItemModel = require("./AssignFormItemModel");
 var import_AssignFormGridModel = require("./AssignFormGridModel");
 var import_AssignFormModel = require("./AssignFormModel");
 var import_BasePageTabModel = require("./BasePageTabModel");
+var import_BlockGridCardModel = require("./BlockGridCardModel");
 var import_BlockGridModel = require("./BlockGridModel");
+var import_BlockIframeModel = require("./BlockIframeModel");
+var import_BlockListModel = require("./BlockListModel");
+var import_BlockMarkdownModel = require("./BlockMarkdownModel");
+var import_BlockWorkbenchModel = require("./BlockWorkbenchModel");
 var import_BulkDeleteActionModel = require("./BulkDeleteActionModel");
 var import_ChildPageModel = require("./ChildPageModel");
 var import_ChildPageTabModel = require("./ChildPageTabModel");
+var import_CommentsModel = require("./CommentsModel");
 var import_CreateFormModel = require("./CreateFormModel");
+var import_DataVisualizationModel = require("./DataVisualizationModel");
 var import_DeleteActionModel = require("./DeleteActionModel");
 var import_DetailsBlockModel = require("./DetailsBlockModel");
 var import_DetailsGridModel = require("./DetailsGridModel");
@@ -103,6 +117,9 @@ var import_DetailsItemModel = require("./DetailsItemModel");
 var import_EditActionModel = require("./EditActionModel");
 var import_ExpandCollapseActionModel = require("./ExpandCollapseActionModel");
 var import_EditFormModel = require("./EditFormModel");
+var import_FieldAttachmentUrlModel = require("./FieldAttachmentUrlModel");
+var import_FieldCodeModel = require("./FieldCodeModel");
+var import_FieldFormulaModel = require("./FieldFormulaModel");
 var import_FilterActionModel = require("./FilterActionModel");
 var import_FilterFormBlockModel = require("./FilterFormBlockModel");
 var import_FilterFormCollapseActionModel = require("./FilterFormCollapseActionModel");
@@ -112,6 +129,10 @@ var import_FilterFormItemModel = require("./FilterFormItemModel");
 var import_FilterFormJSActionModel = require("./FilterFormJSActionModel");
 var import_FilterFormResetActionModel = require("./FilterFormResetActionModel");
 var import_FilterFormSubmitActionModel = require("./FilterFormSubmitActionModel");
+var import_FieldMarkdownVditorModel = require("./FieldMarkdownVditorModel");
+var import_FieldSequenceModel = require("./FieldSequenceModel");
+var import_FieldSortModel = require("./FieldSortModel");
+var import_FileManagerModel = require("./FileManagerModel");
 var import_FormBlockModel = require("./FormBlockModel");
 var import_FormAssociationItemModel = require("./FormAssociationItemModel");
 var import_FormGridModel = require("./FormGridModel");
@@ -137,6 +158,8 @@ var import_TableActionsColumnModel = require("./TableActionsColumnModel");
 var import_TableBlockModel = require("./TableBlockModel");
 var import_TableColumnModel = require("./TableColumnModel");
 var import_TableCustomColumnModel = require("./TableCustomColumnModel");
+var import_MapModel = require("./MapModel");
+var import_UiTemplatesModel = require("./UiTemplatesModel");
 var import_UpdateRecordActionModel = require("./UpdateRecordActionModel");
 var import_ViewActionModel = require("./ViewActionModel");
 const flowSchemaModelContributions = [
@@ -196,6 +219,96 @@ const flowSchemaModelContributions = [
   import_TableBlockModel.tableBlockModelSchemaContribution,
   import_PageModel.pageModelSchemaContribution
 ];
+const officialFlowSchemaContributions = [
+  {
+    packageName: "@nocobase/plugin-action-bulk-edit",
+    contribution: import_ActionBulkEditModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-action-bulk-update",
+    contribution: import_ActionBulkUpdateModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-action-custom-request",
+    contribution: import_ActionCustomRequestModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-action-duplicate",
+    contribution: import_ActionDuplicateModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-action-export",
+    contribution: import_ActionExportModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-action-import",
+    contribution: import_ActionImportModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-block-grid-card",
+    contribution: import_BlockGridCardModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-block-iframe",
+    contribution: import_BlockIframeModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-block-list",
+    contribution: import_BlockListModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-block-markdown",
+    contribution: import_BlockMarkdownModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-block-workbench",
+    contribution: import_BlockWorkbenchModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-comments",
+    contribution: import_CommentsModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-data-visualization",
+    contribution: import_DataVisualizationModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-attachment-url",
+    contribution: import_FieldAttachmentUrlModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-code",
+    contribution: import_FieldCodeModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-formula",
+    contribution: import_FieldFormulaModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-markdown-vditor",
+    contribution: import_FieldMarkdownVditorModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-sequence",
+    contribution: import_FieldSequenceModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-field-sort",
+    contribution: import_FieldSortModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-file-manager",
+    contribution: import_FileManagerModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-map",
+    contribution: import_MapModel.flowSchemaContribution
+  },
+  {
+    packageName: "@nocobase/plugin-ui-templates",
+    contribution: import_UiTemplatesModel.flowSchemaContribution
+  }
+];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   actionModelSchemaContribution,
@@ -240,6 +353,7 @@ const flowSchemaModelContributions = [
   jsItemModelInternalSchemaContribution,
   jsRecordActionModelInternalSchemaContribution,
   linkActionModelInternalSchemaContribution,
+  officialFlowSchemaContributions,
   pageModelSchemaContribution,
   pageTabModelInternalSchemaContribution,
   popupActionModelInternalSchemaContribution,

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

@@ -6,7 +6,7 @@
  * 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';
+import type { FlowDynamicHint, FlowJsonSchema, FlowModelSchemaContribution, FlowSubModelSlotSchema } from '../flow-schema-registry';
 export declare const genericFilterSchema: FlowJsonSchema;
 export declare const genericModelNodeSchema: FlowJsonSchema;
 export declare const emptyObjectSchema: FlowJsonSchema;

package/dist/server/flow-schema-registry/FlowSchemaRegistry.d.ts

@@ -0,0 +1,154 @@
+/**
+ * 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 { ActionDefinition, FlowActionSchemaContribution, FlowFieldBindingContextContribution, FlowFieldBindingContribution, FlowFieldModelCompatibility, FlowSchemaBundleDocument, FlowSchemaContextEdge, FlowSchemaDocs, FlowDynamicHint, FlowSchemaInventoryContribution, FlowJsonSchema, FlowModelSchemaContribution, FlowSchemaCoverage, FlowSchemaDetail, FlowSchemaDocument, FlowModelSchemaExposure, FlowSchemaPublicDocument, FlowSubModelSlotSchema, ModelConstructor, StepDefinition } from './types';
+import { type StepSchemaResolution } from './flow-schema-registry/schemaInference';
+export type RegisteredActionSchema = {
+    name: string;
+    title?: string;
+    definition?: ActionDefinition;
+    schema?: FlowJsonSchema;
+    docs: FlowSchemaDocs;
+    coverage: FlowSchemaCoverage;
+    dynamicHints: FlowDynamicHint[];
+};
+export type RegisteredModelSchema = {
+    use: string;
+    modelClass?: ModelConstructor;
+    stepParamsSchema?: FlowJsonSchema;
+    flowRegistrySchema?: FlowJsonSchema;
+    subModelSlots?: Record<string, FlowSubModelSlotSchema>;
+    flowRegistrySchemaPatch?: FlowJsonSchema;
+    title?: string;
+    examples: any[];
+    docs: FlowSchemaDocs;
+    skeleton?: any;
+    dynamicHints: FlowDynamicHint[];
+    coverage: FlowSchemaCoverage;
+    exposure: FlowModelSchemaExposure;
+    abstract: boolean;
+    allowDirectUse: boolean;
+    suggestedUses: string[];
+};
+export declare class FlowSchemaRegistry {
+    private readonly modelSchemas;
+    private readonly actionSchemas;
+    private readonly fieldBindingContexts;
+    private readonly fieldBindings;
+    private readonly resolvedModelCache;
+    private readonly modelSnapshotSchemaCache;
+    private readonly compactModelSnapshotSchemaCache;
+    private readonly modelSchemaHashCache;
+    private readonly compactModelSchemaHashCache;
+    private readonly modelDocumentCache;
+    private readonly modelLocalDynamicHintsCache;
+    private readonly publicModelDocumentCache;
+    private readonly publicTreeRoots;
+    private readonly slotUseExpansions;
+    private invalidateDerivedCaches;
+    registerAction(action: ActionDefinition | ({
+        name: string;
+    } & Partial<ActionDefinition>)): void;
+    registerActions(actions: Record<string, ActionDefinition>): void;
+    registerActionContribution(contribution: FlowActionSchemaContribution): void;
+    registerActionContributions(contributions: FlowActionSchemaContribution[] | Record<string, FlowActionSchemaContribution>): void;
+    registerFieldBindingContext(contribution: FlowFieldBindingContextContribution, fallbackName?: string): void;
+    registerFieldBindingContexts(contributions: FlowFieldBindingContextContribution[] | Record<string, FlowFieldBindingContextContribution> | undefined): void;
+    registerFieldBinding(contribution: FlowFieldBindingContribution, source?: FlowSchemaCoverage['source']): void;
+    registerFieldBindings(contributions: FlowFieldBindingContribution[] | Record<string, FlowFieldBindingContribution | FlowFieldBindingContribution[]> | undefined, source?: FlowSchemaCoverage['source']): void;
+    registerModel(use: string, options: Partial<RegisteredModelSchema>): void;
+    registerModelContribution(contribution: FlowModelSchemaContribution): void;
+    registerModelContributions(contributions: FlowModelSchemaContribution[] | Record<string, FlowModelSchemaContribution>): void;
+    registerModelClass(use: string, modelClass: ModelConstructor): void;
+    registerModels(models: Record<string, ModelConstructor | undefined>): void;
+    registerInventory(inventory: FlowSchemaInventoryContribution | undefined, _source: FlowSchemaCoverage['source']): void;
+    resolveFieldBindingCandidates(context: string, options?: {
+        interface?: string;
+        fieldType?: string;
+        association?: boolean;
+        targetCollectionTemplate?: string;
+    }): {
+        use: string;
+        defaultProps: any;
+        compatibility: FlowFieldModelCompatibility;
+    }[];
+    getAction(name: string): RegisteredActionSchema | undefined;
+    listActionNames(): string[];
+    getModel(use: string): RegisteredModelSchema | undefined;
+    private resolveFieldBindingContextChain;
+    private resolveModelSchemaRef;
+    resolveModelSchema(use: string, contextChain?: FlowSchemaContextEdge[]): RegisteredModelSchema;
+    private isPublicModel;
+    private isQueryableModel;
+    getSuggestedUses(use: string): string[];
+    hasQueryableModel(use: string): boolean;
+    isDirectUseAllowed(use: string): boolean;
+    listPublicTreeRoots(): string[];
+    listModelUses(options?: {
+        publicOnly?: boolean;
+        directUseOnly?: boolean;
+        queryableOnly?: boolean;
+    }): string[];
+    getSchemaBundle(uses?: string[]): FlowSchemaBundleDocument;
+    getModelDocument(use: string, contextChain?: FlowSchemaContextEdge[]): FlowSchemaDocument;
+    getModelDocumentRef(use: string, contextChain?: FlowSchemaContextEdge[]): Readonly<FlowSchemaDocument>;
+    getPublicModelDocument(use: string, options?: {
+        detail?: FlowSchemaDetail;
+        contextChain?: FlowSchemaContextEdge[];
+    }): FlowSchemaPublicDocument;
+    getPublicModelDocumentRef(use: string, options?: {
+        detail?: FlowSchemaDetail;
+        contextChain?: FlowSchemaContextEdge[];
+    }): Readonly<FlowSchemaPublicDocument>;
+    private buildFullPublicModelDocument;
+    private buildCompactPublicModelDocument;
+    private getModelLocalDynamicHintsRef;
+    private buildModelLocalDynamicHints;
+    getModelSchemaHash(use: string, contextChain?: FlowSchemaContextEdge[]): string;
+    getCompactModelSchemaHash(use: string, contextChain?: FlowSchemaContextEdge[]): string;
+    private createSlotUseExpansionKey;
+    private getSlotUseExpansionUses;
+    resolveSlotAllowedUses(parentUse: string, slotKey: string, slot?: FlowSubModelSlotSchema): string[];
+    private buildModelDocument;
+    private buildBundleNode;
+    private buildBundleSubModelCatalog;
+    private createContextVisitKey;
+    private isContextCycle;
+    buildModelSnapshotSchema(use: string, contextChain?: FlowSchemaContextEdge[]): FlowJsonSchema;
+    buildCompactModelSnapshotSchema(use: string, contextChain?: FlowSchemaContextEdge[]): FlowJsonSchema;
+    private buildModelSnapshotSchemaRef;
+    private buildCompactModelSnapshotSchemaRef;
+    private buildCompactModelSnapshotSchemaInternal;
+    private buildModelSnapshotSchemaInternal;
+    private buildSnapshotSchemaFromResolved;
+    private buildSnapshotShellSchema;
+    private buildTruncatedSnapshotSchema;
+    buildStaticFlowRegistrySchema(use: string, contextChain?: FlowSchemaContextEdge[]): FlowJsonSchema;
+    buildStaticStepParamsSchema(use: string, contextChain?: FlowSchemaContextEdge[]): FlowJsonSchema;
+    buildSubModelsSchema(use: string, contextChain?: FlowSchemaContextEdge[]): FlowJsonSchema;
+    private buildCompactSubModelsSchemaFromSlots;
+    private buildSubModelsSchemaFromSlots;
+    private buildInferredFlowRegistrySchema;
+    private buildInferredStepParamsSchema;
+    buildFlowOnSchema(): FlowJsonSchema;
+    buildStepDefinitionSchema(step: StepDefinition): FlowJsonSchema;
+    resolveStepParamsSchema(step: StepDefinition, path: string): StepSchemaResolution;
+    private buildSlotTargetSchema;
+    private buildCompactSlotTargetSchema;
+    private buildCompactSlotCandidateSchema;
+    private buildCompactAnonymousSlotSnapshotSchema;
+    private buildAnonymousSlotSnapshotSchema;
+    private createAnonymousResolvedSchema;
+    private collectNestedDocumentHints;
+    private prefixNestedHint;
+    private collectContextPatches;
+    private collectModelDynamicHints;
+    private collectFlowSchemaDiagnostics;
+    private buildDocumentCoverage;
+    private inferSubModelSlotsFromModelClass;
+}