@nocobase/plugin-flow-engine 2.1.0-beta.15 → 2.1.0-beta.16

package/dist/server/flow-surfaces/constants.d.ts

@@ -0,0 +1,351 @@
+/**
+ * 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.
+ */
+export { FLOW_SURFACE_PLAN_STEP_ACTIONS } from './planning/action-specs';
+type FlowSurfaceActionMethod = 'get' | 'post';
+type FlowSurfaceActionValueSource = 'default' | 'read';
+export type FlowSurfaceActionDefinition = {
+    method: FlowSurfaceActionMethod;
+    read: boolean;
+    transaction: boolean;
+    mutate: boolean;
+    valueSource: FlowSurfaceActionValueSource;
+};
+export declare const FLOW_SURFACE_ACTION_DEFINITIONS: {
+    readonly catalog: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly context: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly get: {
+        readonly method: "get";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "read";
+    };
+    readonly describeSurface: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly getReactionMeta: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly setFieldValueRules: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly setBlockLinkageRules: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly setFieldLinkageRules: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly setActionLinkageRules: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly applyBlueprint: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly applyApprovalBlueprint: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly listTemplates: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly getTemplate: {
+        readonly method: "post";
+        readonly read: true;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly saveTemplate: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly updateTemplate: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly destroyTemplate: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly convertTemplateToCopy: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly compose: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly configure: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly createMenu: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly updateMenu: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly createPage: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly destroyPage: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly updateTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly moveTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly removeTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addPopupTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly updatePopupTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly movePopupTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly removePopupTab: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addBlock: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addBlocks: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly addField: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addFields: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly addAction: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addActions: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly addRecordAction: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly addRecordActions: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: false;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly updateSettings: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly setEventFlows: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly setLayout: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly moveNode: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly removeNode: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: true;
+        readonly valueSource: "default";
+    };
+    readonly mutate: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+    readonly apply: {
+        readonly method: "post";
+        readonly read: false;
+        readonly transaction: true;
+        readonly mutate: false;
+        readonly valueSource: "default";
+    };
+};
+export type FlowSurfacesActionName = keyof typeof FLOW_SURFACE_ACTION_DEFINITIONS;
+type SelectFlowSurfaceActionNames<TFlag extends keyof FlowSurfaceActionDefinition> = {
+    [K in FlowSurfacesActionName]: (typeof FLOW_SURFACE_ACTION_DEFINITIONS)[K][TFlag] extends true ? K : never;
+}[FlowSurfacesActionName];
+type FlowSurfaceMutateActionName = SelectFlowSurfaceActionNames<'mutate'>;
+export declare const FLOW_SURFACES_ACTION_NAMES: ("createMenu" | "catalog" | "get" | "context" | "describeSurface" | "getReactionMeta" | "setFieldValueRules" | "setBlockLinkageRules" | "setFieldLinkageRules" | "setActionLinkageRules" | "applyBlueprint" | "applyApprovalBlueprint" | "listTemplates" | "getTemplate" | "saveTemplate" | "updateTemplate" | "destroyTemplate" | "convertTemplateToCopy" | "compose" | "configure" | "updateMenu" | "createPage" | "destroyPage" | "addTab" | "updateTab" | "moveTab" | "removeTab" | "addPopupTab" | "updatePopupTab" | "movePopupTab" | "removePopupTab" | "addBlock" | "addBlocks" | "addField" | "addFields" | "addAction" | "addActions" | "addRecordAction" | "addRecordActions" | "updateSettings" | "setEventFlows" | "setLayout" | "moveNode" | "removeNode" | "mutate" | "apply")[];
+export declare const FLOW_SURFACES_READ_ACTION_NAMES: SelectFlowSurfaceActionNames<"read">[];
+export declare const FLOW_SURFACE_MUTATE_OP_TYPES: FlowSurfaceMutateActionName[];
+export declare const FLOW_SURFACES_ACTION_METHODS: Record<"createMenu" | "catalog" | "get" | "context" | "describeSurface" | "getReactionMeta" | "setFieldValueRules" | "setBlockLinkageRules" | "setFieldLinkageRules" | "setActionLinkageRules" | "applyBlueprint" | "applyApprovalBlueprint" | "listTemplates" | "getTemplate" | "saveTemplate" | "updateTemplate" | "destroyTemplate" | "convertTemplateToCopy" | "compose" | "configure" | "updateMenu" | "createPage" | "destroyPage" | "addTab" | "updateTab" | "moveTab" | "removeTab" | "addPopupTab" | "updatePopupTab" | "movePopupTab" | "removePopupTab" | "addBlock" | "addBlocks" | "addField" | "addFields" | "addAction" | "addActions" | "addRecordAction" | "addRecordActions" | "updateSettings" | "setEventFlows" | "setLayout" | "moveNode" | "removeNode" | "mutate" | "apply", FlowSurfaceActionMethod>;

package/dist/server/flow-surfaces/constants.js

@@ -0,0 +1,104 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var constants_exports = {};
+__export(constants_exports, {
+  FLOW_SURFACES_ACTION_METHODS: () => FLOW_SURFACES_ACTION_METHODS,
+  FLOW_SURFACES_ACTION_NAMES: () => FLOW_SURFACES_ACTION_NAMES,
+  FLOW_SURFACES_READ_ACTION_NAMES: () => FLOW_SURFACES_READ_ACTION_NAMES,
+  FLOW_SURFACE_ACTION_DEFINITIONS: () => FLOW_SURFACE_ACTION_DEFINITIONS,
+  FLOW_SURFACE_MUTATE_OP_TYPES: () => FLOW_SURFACE_MUTATE_OP_TYPES,
+  FLOW_SURFACE_PLAN_STEP_ACTIONS: () => import_action_specs.FLOW_SURFACE_PLAN_STEP_ACTIONS
+});
+module.exports = __toCommonJS(constants_exports);
+var import_action_specs = require("./planning/action-specs");
+const FLOW_SURFACE_ACTION_DEFINITIONS = {
+  catalog: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  context: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  get: { method: "get", read: true, transaction: false, mutate: false, valueSource: "read" },
+  describeSurface: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  getReactionMeta: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  setFieldValueRules: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  setBlockLinkageRules: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  setFieldLinkageRules: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  setActionLinkageRules: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  applyBlueprint: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  applyApprovalBlueprint: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  listTemplates: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  getTemplate: { method: "post", read: true, transaction: false, mutate: false, valueSource: "default" },
+  saveTemplate: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  updateTemplate: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  destroyTemplate: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  convertTemplateToCopy: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  compose: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  configure: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  createMenu: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  updateMenu: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  createPage: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  destroyPage: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  updateTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  moveTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  removeTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addPopupTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  updatePopupTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  movePopupTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  removePopupTab: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addBlock: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addBlocks: { method: "post", read: false, transaction: false, mutate: false, valueSource: "default" },
+  addField: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addFields: { method: "post", read: false, transaction: false, mutate: false, valueSource: "default" },
+  addAction: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addActions: { method: "post", read: false, transaction: false, mutate: false, valueSource: "default" },
+  addRecordAction: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  addRecordActions: { method: "post", read: false, transaction: false, mutate: false, valueSource: "default" },
+  updateSettings: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  setEventFlows: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  setLayout: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  moveNode: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  removeNode: { method: "post", read: false, transaction: true, mutate: true, valueSource: "default" },
+  mutate: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" },
+  apply: { method: "post", read: false, transaction: true, mutate: false, valueSource: "default" }
+};
+const FLOW_SURFACES_ACTION_NAMES = Object.keys(FLOW_SURFACE_ACTION_DEFINITIONS);
+const FLOW_SURFACES_READ_ACTION_NAMES = FLOW_SURFACES_ACTION_NAMES.filter(
+  (actionName) => FLOW_SURFACE_ACTION_DEFINITIONS[actionName].read === true
+);
+const FLOW_SURFACE_MUTATE_OP_TYPES = FLOW_SURFACES_ACTION_NAMES.filter(
+  (actionName) => FLOW_SURFACE_ACTION_DEFINITIONS[actionName].mutate === true
+);
+const FLOW_SURFACES_ACTION_METHODS = Object.fromEntries(
+  FLOW_SURFACES_ACTION_NAMES.map((actionName) => [actionName, FLOW_SURFACE_ACTION_DEFINITIONS[actionName].method])
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FLOW_SURFACES_ACTION_METHODS,
+  FLOW_SURFACES_ACTION_NAMES,
+  FLOW_SURFACES_READ_ACTION_NAMES,
+  FLOW_SURFACE_ACTION_DEFINITIONS,
+  FLOW_SURFACE_MUTATE_OP_TYPES,
+  FLOW_SURFACE_PLAN_STEP_ACTIONS
+});

package/dist/server/flow-surfaces/context.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 { FlowSurfaceContextResponse } from './types';
+type CollectionLike = {
+    name?: string;
+    title?: string;
+    dataSourceKey?: string;
+    fields?: any[] | Map<string, any> | Record<string, any>;
+    getFields?: () => any[];
+};
+type FlowSurfacePopupContextLevel = {
+    uid?: string;
+    recordCollection?: CollectionLike | null;
+    sourceRecordCollection?: CollectionLike | null;
+};
+type FlowSurfaceChartQueryOutput = {
+    alias: string;
+    source?: 'builder' | 'sql';
+    type?: string;
+    kind?: 'dimension' | 'measure';
+    field?: string | string[];
+    aggregation?: string;
+    format?: string;
+};
+type FlowSurfaceChartCapabilityHint = {
+    key: string;
+    title: string;
+    description: string;
+};
+type FlowSurfaceChartMappingSupport = {
+    allowed: string[];
+    required?: string[];
+};
+type FlowSurfaceChartStyleSupport = {
+    type: 'boolean' | 'number' | 'string';
+    enumValues?: string[];
+    min?: number;
+    max?: number;
+    description?: string;
+};
+type FlowSurfaceChartContext = {
+    queryOutputs?: FlowSurfaceChartQueryOutput[];
+    aliases?: string[];
+    supportedMappings?: Record<string, FlowSurfaceChartMappingSupport>;
+    supportedStyles?: Record<string, Record<string, FlowSurfaceChartStyleSupport>>;
+    supportedVisualTypes?: string[];
+    safeDefaults?: FlowSurfaceChartCapabilityHint[];
+    riskyPatterns?: FlowSurfaceChartCapabilityHint[];
+    unsupportedPatterns?: FlowSurfaceChartCapabilityHint[];
+};
+export type FlowSurfaceContextSemantic = {
+    collection?: CollectionLike | null;
+    recordCollection?: CollectionLike | null;
+    formValuesCollection?: CollectionLike | null;
+    itemCollections?: Array<CollectionLike | null>;
+    itemRootCollection?: CollectionLike | null;
+    popupLevels?: FlowSurfacePopupContextLevel[];
+    chart?: FlowSurfaceChartContext | null;
+};
+export declare function isBareFlowContextPath(path: string): boolean;
+export declare function buildFlowSurfaceContextResponse(input: {
+    semantic: FlowSurfaceContextSemantic;
+    path?: string;
+    maxDepth?: number;
+}): FlowSurfaceContextResponse;
+export {};