@nocobase/flow-engine 2.1.0-alpha.12 → 2.1.0-alpha.13

package/src/runjs-context/snippets/scene/table/set-cell-style.snippet.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { SnippetModule } from '../../types';
+const snippet: SnippetModule = {
+  contexts: ['*'],
+  scenes: ['tableFieldEvent'],
+  prefix: 'sn-table-cell-style',
+  label: 'Set table cell style',
+  description: 'Customize table field cell styles with onCell',
+  locales: {
+    'zh-CN': {
+      label: '表格字段样式设置',
+      description: '通过 onCell 自定义表格字段单元格样式',
+    },
+  },
+  content: `
+ctx.model.props.onCell = (record, rowIndex) => {
+  return {
+    style: {
+      fontWeight: 900,
+    },
+  };
+};
+`,
+};
+
+export default snippet;

package/src/types.ts

@@ -41,261 +41,6 @@ export type DeepPartial<T> = {
         : T[P];
 };
 
-export type FlowJsonSchema = Record<string, any> & {
-  $schema?: string;
-  $id?: string;
-};
-
-export interface FlowDynamicHintMetadata {
-  slotRules?: {
-    slotKey?: string;
-    type?: 'object' | 'array';
-    allowedUses?: string[];
-  };
-  contextRequirements?: string[];
-  unresolvedReason?: string;
-  recommendedFallback?: any;
-}
-
-export interface FlowDynamicHint {
-  kind:
-    | 'dynamic-ui-schema'
-    | 'dynamic-children'
-    | 'custom-component'
-    | 'x-reactions'
-    | 'unresolved-action'
-    | 'manual-schema-required'
-    | 'unresolved-model';
-  path?: string;
-  message: string;
-  'x-flow'?: FlowDynamicHintMetadata;
-}
-
-export interface FlowSchemaCoverage {
-  status: 'auto' | 'manual' | 'mixed' | 'unresolved';
-  source: 'official' | 'plugin' | 'third-party';
-  strict?: boolean;
-  issues?: string[];
-}
-
-export type FlowModelSchemaExposure = 'public' | 'internal';
-
-export interface FlowSchemaPattern {
-  title: string;
-  description?: string;
-  snippet?: any;
-}
-
-export interface FlowSchemaDocument {
-  use: string;
-  title?: string;
-  jsonSchema: FlowJsonSchema;
-  coverage: FlowSchemaCoverage;
-  dynamicHints: FlowDynamicHint[];
-  examples: any[];
-  minimalExample?: any;
-  commonPatterns: FlowSchemaPattern[];
-  antiPatterns: FlowSchemaPattern[];
-  skeleton: any;
-  hash: string;
-  source: FlowSchemaCoverage['source'];
-}
-
-export type FlowSchemaDetail = 'compact' | 'full';
-
-export interface FlowSchemaPublicDocument {
-  use: string;
-  title?: string;
-  jsonSchema: FlowJsonSchema;
-  dynamicHints: FlowDynamicHint[];
-  minimalExample?: any;
-  commonPatterns: FlowSchemaPattern[];
-  antiPatterns: FlowSchemaPattern[];
-  hash: string;
-  source: FlowSchemaCoverage['source'];
-}
-
-export interface FlowSchemaDocs {
-  description?: string;
-  examples?: any[];
-  minimalExample?: any;
-  commonPatterns?: FlowSchemaPattern[];
-  antiPatterns?: FlowSchemaPattern[];
-  dynamicHints?: FlowDynamicHint[];
-}
-
-export interface FlowSchemaBundleSlotCatalog {
-  type: 'object' | 'array';
-  required?: boolean;
-  minItems?: number;
-  open?: boolean;
-  candidates: FlowSchemaBundleNode[];
-}
-
-export interface FlowSchemaBundleNode {
-  use: string;
-  title?: string;
-  compatibility?: FlowFieldModelCompatibility;
-  subModelCatalog?: Record<string, FlowSchemaBundleSlotCatalog>;
-}
-
-export type FlowSchemaBundleItem = FlowSchemaBundleNode;
-
-export interface FlowSchemaBundleDocument {
-  items: FlowSchemaBundleNode[];
-}
-
-export interface FlowSchemaContextEdge {
-  parentUse: string;
-  slotKey: string;
-  childUse: string;
-}
-
-export interface FlowSubModelContextPathStep {
-  slotKey: string;
-  use?: string | string[];
-}
-
-export interface FlowModelSchemaPatch {
-  stepParamsSchema?: FlowJsonSchema;
-  flowRegistrySchema?: FlowJsonSchema;
-  subModelSlots?: Record<string, FlowSubModelSlotSchema>;
-  flowRegistrySchemaPatch?: FlowJsonSchema;
-  docs?: FlowSchemaDocs;
-  examples?: any[];
-  skeleton?: any;
-  dynamicHints?: FlowDynamicHint[];
-}
-
-export interface FlowDescendantSchemaPatch {
-  path: FlowSubModelContextPathStep[];
-  patch: FlowModelSchemaPatch;
-}
-
-export interface FlowSubModelSlotSchema {
-  type: 'object' | 'array';
-  use?: string;
-  uses?: string[];
-  required?: boolean;
-  minItems?: number;
-  dynamic?: boolean;
-  schema?: FlowJsonSchema;
-  fieldBindingContext?: string;
-  childSchemaPatch?: FlowModelSchemaPatch | Record<string, FlowModelSchemaPatch>;
-  descendantSchemaPatches?: FlowDescendantSchemaPatch[];
-  description?: string;
-}
-
-export interface FlowModelSchemaMeta {
-  stepParamsSchema?: FlowJsonSchema;
-  flowRegistrySchema?: FlowJsonSchema;
-  subModelSlots?: Record<string, FlowSubModelSlotSchema>;
-  flowRegistrySchemaPatch?: FlowJsonSchema;
-  docs?: FlowSchemaDocs;
-  examples?: any[];
-  skeleton?: any;
-  dynamicHints?: FlowDynamicHint[];
-  source?: FlowSchemaCoverage['source'];
-  strict?: boolean;
-  exposure?: FlowModelSchemaExposure;
-  abstract?: boolean;
-  allowDirectUse?: boolean;
-  suggestedUses?: string[];
-}
-
-export interface FlowActionSchemaContribution {
-  name: string;
-  title?: string;
-  paramsSchema?: FlowJsonSchema;
-  docs?: FlowSchemaDocs;
-  source?: FlowSchemaCoverage['source'];
-  strict?: boolean;
-}
-
-export interface FlowModelSchemaContribution {
-  use: string;
-  title?: string;
-  stepParamsSchema?: FlowJsonSchema;
-  flowRegistrySchema?: FlowJsonSchema;
-  subModelSlots?: Record<string, FlowSubModelSlotSchema>;
-  flowRegistrySchemaPatch?: FlowJsonSchema;
-  docs?: FlowSchemaDocs;
-  examples?: any[];
-  skeleton?: any;
-  dynamicHints?: FlowDynamicHint[];
-  source?: FlowSchemaCoverage['source'];
-  strict?: boolean;
-  exposure?: FlowModelSchemaExposure;
-  abstract?: boolean;
-  allowDirectUse?: boolean;
-  suggestedUses?: string[];
-}
-
-export interface FlowSchemaContributionDefaults {
-  source?: FlowSchemaCoverage['source'];
-  strict?: boolean;
-}
-
-export interface FlowSchemaSlotUseExpansion {
-  parentUse: string;
-  slotKey: string;
-  uses: string[];
-}
-
-export interface FlowSchemaInventoryContribution {
-  publicTreeRoots?: string[];
-  slotUseExpansions?: FlowSchemaSlotUseExpansion[];
-}
-
-export interface FlowFieldBindingConditions {
-  association?: boolean;
-  fieldTypes?: string[];
-  targetCollectionTemplateIn?: string[];
-  targetCollectionTemplateNotIn?: string[];
-}
-
-export interface FlowFieldBindingContextContribution {
-  name: string;
-  inherits?: string[];
-}
-
-export interface FlowFieldBindingContribution {
-  context: string;
-  use: string;
-  interfaces: string[];
-  isDefault?: boolean;
-  order?: number;
-  conditions?: FlowFieldBindingConditions;
-  defaultProps?: any;
-}
-
-export interface FlowFieldModelCompatibility {
-  context: string;
-  interfaces: string[];
-  isDefault?: boolean;
-  order?: number;
-  association?: boolean;
-  fieldTypes?: string[];
-  targetCollectionTemplateIn?: string[];
-  targetCollectionTemplateNotIn?: string[];
-  inheritParentFieldBinding?: boolean;
-}
-
-export interface FlowSchemaContribution {
-  models?: FlowModelSchemaContribution[] | Record<string, FlowModelSchemaContribution>;
-  actions?: FlowActionSchemaContribution[] | Record<string, FlowActionSchemaContribution>;
-  fieldBindingContexts?: FlowFieldBindingContextContribution[] | Record<string, FlowFieldBindingContextContribution>;
-  fieldBindings?:
-    | FlowFieldBindingContribution[]
-    | Record<string, FlowFieldBindingContribution | FlowFieldBindingContribution[]>;
-  inventory?: FlowSchemaInventoryContribution;
-  defaults?: FlowSchemaContributionDefaults;
-}
-
-export interface FlowSchemaContributionProvider {
-  getFlowSchemaContributions(): FlowSchemaContribution | undefined | Promise<FlowSchemaContribution | undefined>;
-}
-
 /**
  * Defines a flow with generic model type support.
  */
@@ -410,9 +155,6 @@ export interface ActionDefinition<TModel extends FlowModel = FlowModel, TCtx ext
   title?: string;
   handler: (ctx: TCtx, params: any) => Promise<any> | any;
   uiSchema?: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>);
-  paramsSchema?: FlowJsonSchema;
-  paramsSchemaPatch?: FlowJsonSchema;
-  schemaDocs?: FlowSchemaDocs;
   defaultParams?: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>);
   beforeParamsSave?: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>;
   afterParamsSave?: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>;
@@ -559,9 +301,6 @@ export interface StepDefinition<TModel extends FlowModel = FlowModel>
   // Step configuration
   // `preset: true` 的 step params 需要在创建时填写，没有标记的可以创建模型后再填写。
   preset?: boolean;
-  // JSON Schema object used to fully override the resolved step params schema for this step.
-  paramsSchemaOverride?: FlowJsonSchema;
-  schemaDocs?: FlowSchemaDocs;
   uiMode?: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>);
 }
 
@@ -834,7 +573,6 @@ export type FlowModelMeta =
      */
     hide?: boolean | ((context: FlowModelContext) => boolean);
     eventList?: { label: string; value: string }[]; // 支持的事件列表
-    schema?: FlowModelSchemaMeta;
   };
 
 /**

package/lib/FlowSchemaRegistry.d.ts

@@ -1,154 +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 { 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;
-}