@nocobase/flow-engine 2.1.0-alpha.1 → 2.1.0-alpha.11

package/README.md

@@ -1,17 +1,24 @@
 # NocoBase
 
 <video width="100%" controls>
-      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
+  <source src="https://github.com/user-attachments/assets/4d11a87b-00e2-48f3-9bf7-389d21072d13" type="video/mp4">
 </video>
 
+<p align="center">
+<a href="https://trendshift.io/repositories/4112" target="_blank"><img src="https://trendshift.io/api/badge/repositories/4112" alt="nocobase%2Fnocobase | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+<a href="https://www.producthunt.com/posts/nocobase?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-nocobase" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=456520&theme=light&period=weekly&topic_id=267" alt="NocoBase - Scalability&#0045;first&#0044;&#0032;open&#0045;source&#0032;no&#0045;code&#0032;platform | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+</p>
 
 ## What is NocoBase
 
-NocoBase is a scalability-first, open-source no-code development platform.  
-Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
+NocoBase is the most extensible AI-powered no-code platform.   
+Total control. Infinite extensibility. AI collaboration.  
+Enable your team to adapt quickly and cut costs dramatically.  
+No years of development. No millions wasted.  
+Deploy NocoBase in minutes — and take control of everything.
 
 Homepage:  
-https://www.nocobase.com/
+https://www.nocobase.com/  
 
 Online Demo:  
 https://demo.nocobase.com/new
@@ -19,12 +26,74 @@ https://demo.nocobase.com/new
 Documents:  
 https://docs.nocobase.com/
 
-Commericial license & plugins:  
-https://www.nocobase.com/en/commercial
+Forum:  
+https://forum.nocobase.com/
 
-License agreement:   
-https://www.nocobase.com/en/agreement
+Use Cases:  
+https://www.nocobase.com/en/blog/tags/customer-stories
 
+## Release Notes
 
-## Contact Us:  
-hello@nocobase.com
+Our [blog](https://www.nocobase.com/en/blog/timeline) is regularly updated with release notes and provides a weekly summary.
+
+## Distinctive features
+
+### 1. Data model-driven, not form/table–driven
+
+Instead of being constrained by forms or tables, NocoBase adopts a data model–driven approach, separating data structure from user interface to unlock unlimited possibilities.
+
+- UI and data structure are fully decoupled
+- Multiple blocks and actions can be created for the same table or record in any quantity or form
+- Supports the main database, external databases, and third-party APIs as data sources
+
+![model](https://static-docs.nocobase.com/model.png)
+
+### 2. AI employees, integrated into your business systems
+Unlike standalone AI demos, NocoBase allows you to embed AI capabilities seamlessly into your interfaces, workflows, and data context, making AI truly useful in real business scenarios.
+
+- Define AI employees for roles such as translator, analyst, researcher, or assistant
+- Seamless AI–human collaboration in interfaces and workflows
+- Ensure AI usage is secure, transparent, and customizable for your business needs
+
+![AI-employee](https://static-docs.nocobase.com/ai-employee-home.png)
+
+### 3. What you see is what you get, incredibly easy to use
+
+While enabling the development of complex business systems, NocoBase keeps the experience simple and intuitive.
+
+- One-click switch between usage mode and configuration mode
+- Pages serve as a canvas to arrange blocks and actions, similar to Notion
+- Configuration mode is designed for ordinary users, not just programmers
+
+![wysiwyg](https://static-docs.nocobase.com/wysiwyg.gif)
+
+### 4. Everything is a plugin, designed for extension
+Adding more no-code features will never cover every business case. NocoBase is built for extension through its plugin-based microkernel architecture.
+
+- All functionalities are plugins, similar to WordPress
+- Plugins are ready to use upon installation
+- Pages, blocks, actions, APIs, and data sources can all be extended through custom plugins
+
+![plugins](https://static-docs.nocobase.com/plugins.png)
+
+## Installation
+
+NocoBase supports three installation methods:
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/docker-compose">Installing With Docker (👍Recommended)</a>
+
+  Suitable for no-code scenarios, no code to write. When upgrading, just download the latest image and reboot.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/create-nocobase-app">Installing from create-nocobase-app CLI</a>
+
+  The business code of the project is completely independent and supports low-code development.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/git-clone">Installing from Git source code</a>
+
+  If you want to experience the latest unreleased version, or want to participate in the contribution, you need to make changes and debug on the source code, it is recommended to choose this installation method, which requires a high level of development skills, and if the code has been updated, you can git pull the latest code.
+
+## How NocoBase works
+
+<video width="100%" controls>
+  <source src="https://github.com/user-attachments/assets/8d183b44-9bb5-4792-b08f-bc08fe8dfaaf" type="video/mp4">
+</video>

package/lib/BlockScopedFlowEngine.js

@@ -37,7 +37,6 @@ function createBlockScopedEngine(parent) {
     local.setModelRepository(parent.modelRepository);
   }
   local.context.addDelegate(parent.context);
-  const originalUnlink = local.unlinkFromStack.bind(local);
   local.unlinkFromStack = function() {
     const prev = local._previousEngine;
     const next = local._nextEngine;

package/lib/FlowDefinition.d.ts

@@ -240,6 +240,8 @@ export declare class FlowStep {
         use?: string;
         sort?: number;
         preset?: boolean;
+        paramsSchemaOverride?: import("./types").FlowJsonSchema;
+        schemaDocs?: import("./types").FlowSchemaDocs;
         uiMode?: import("./types").StepUIMode | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => import("./types").StepUIMode | Promise<import("./types").StepUIMode>);
         title?: string;
         uiSchema?: Record<string, import("@formily/json-schema").Stringify<{
@@ -413,12 +415,16 @@ export declare class FlowStep {
         }>>>);
         defaultParams?: Record<string, any> | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => Record<string, any> | Promise<Record<string, any>>);
         handler?: (ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>, params: any) => any;
+        paramsSchema?: import("./types").FlowJsonSchema;
+        paramsSchemaPatch?: import("./types").FlowJsonSchema;
         beforeParamsSave?: (ctx: import("./flowContext").FlowSettingsContext<import(".").FlowModel<import("./types").DefaultStructure>>, params: any, previousParams: any) => void | Promise<void>;
         afterParamsSave?: (ctx: import("./flowContext").FlowSettingsContext<import(".").FlowModel<import("./types").DefaultStructure>>, params: any, previousParams: any) => void | Promise<void>;
         useRawParams?: boolean | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => boolean | Promise<boolean>);
         scene?: import("./types").ActionScene | import("./types").ActionScene[];
         paramsRequired?: boolean;
         hideInSettings?: boolean | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => boolean | Promise<boolean>);
+        disabledInSettings?: boolean | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => boolean | Promise<boolean>);
+        disabledReasonInSettings?: string | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => string | Promise<string>);
         defineProperties?: Record<string, import("./flowContext").PropertyOptions> | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => Record<string, import("./flowContext").PropertyOptions> | Promise<Record<string, import("./flowContext").PropertyOptions>>);
         defineMethods?: Record<string, (this: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>, ...args: any[]) => any> | ((ctx: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>) => Record<string, (this: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>, ...args: any[]) => any> | Promise<Record<string, (this: import("./flowContext").FlowRuntimeContext<import(".").FlowModel<import("./types").DefaultStructure>, any>, ...args: any[]) => any>>);
     };

package/lib/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;
+}