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

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

@@ -0,0 +1,382 @@
+/**
+ * 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 ActionBulkEditModel_exports = {};
+__export(ActionBulkEditModel_exports, {
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(ActionBulkEditModel_exports);
+const genericModelNodeSchema = {
+  type: "object",
+  required: ["uid", "use"],
+  properties: {
+    uid: { type: "string" },
+    use: { type: "string" }
+  },
+  additionalProperties: true
+};
+const gridRowsSchema = {
+  type: "object",
+  description: "Map of row ids to column definitions. Each row value is a string[][] where every inner array lists the child model UIDs rendered inside one column.",
+  additionalProperties: {
+    type: "array",
+    items: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    }
+  }
+};
+const gridSizesSchema = {
+  type: "object",
+  description: "Map of row ids to column widths. Each width array uses the 24-column grid system, for example [12, 12] or [8, 8, 8].",
+  additionalProperties: {
+    type: "array",
+    items: {
+      type: "number"
+    }
+  }
+};
+const gridRowOrderSchema = {
+  type: "array",
+  description: "Optional explicit row order. When omitted, the persisted row key order is used.",
+  items: {
+    type: "string"
+  }
+};
+const createGridLayoutStepParamsSchema = () => ({
+  type: "object",
+  properties: {
+    gridSettings: {
+      type: "object",
+      properties: {
+        grid: {
+          type: "object",
+          description: "Persisted multi-row, multi-column grid layout.",
+          properties: {
+            rows: gridRowsSchema,
+            sizes: gridSizesSchema,
+            rowOrder: gridRowOrderSchema
+          },
+          additionalProperties: false
+        }
+      },
+      additionalProperties: true
+    }
+  },
+  additionalProperties: true
+});
+const createGridLayoutStepParamsValue = (rows, sizes, rowOrder) => ({
+  gridSettings: {
+    grid: {
+      rows,
+      sizes,
+      rowOrder
+    }
+  }
+});
+const createGridLayoutItems = (itemUses, prefix, count) => Array.from({ length: count }, (_, index) => ({
+  uid: `${prefix}-item-${index + 1}`,
+  use: itemUses[index % itemUses.length]
+}));
+const createGridLayoutDocs = (options) => {
+  const minimalItems = createGridLayoutItems(options.itemUses, `${options.prefix}-minimal`, 1);
+  const standardItems = createGridLayoutItems(options.itemUses, `${options.prefix}-standard`, 5);
+  const customSizeItems = createGridLayoutItems(options.itemUses, `${options.prefix}-sizes`, 5);
+  return {
+    minimalExample: {
+      uid: `${options.prefix}-grid`,
+      use: options.use,
+      stepParams: createGridLayoutStepParamsValue({ rowMain: [[minimalItems[0].uid]] }, { rowMain: [24] }, ["rowMain"]),
+      subModels: {
+        items: minimalItems
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Single row with one column",
+        description: "Use one row with a single 24-column slot when the grid only needs one child model.",
+        snippet: {
+          use: options.use,
+          stepParams: createGridLayoutStepParamsValue({ rowMain: [[minimalItems[0].uid]] }, { rowMain: [24] }, [
+            "rowMain"
+          ]),
+          subModels: {
+            items: minimalItems
+          }
+        }
+      },
+      {
+        title: "Two rows with 2 + 3 columns",
+        description: "The first row has 2 columns and the second row has 3 columns with equal widths.",
+        snippet: {
+          use: options.use,
+          stepParams: createGridLayoutStepParamsValue(
+            {
+              rowTop: [[standardItems[0].uid], [standardItems[1].uid]],
+              rowBottom: [[standardItems[2].uid], [standardItems[3].uid], [standardItems[4].uid]]
+            },
+            {
+              rowTop: [12, 12],
+              rowBottom: [8, 8, 8]
+            },
+            ["rowTop", "rowBottom"]
+          ),
+          subModels: {
+            items: standardItems
+          }
+        }
+      },
+      {
+        title: "Two rows with custom column sizes",
+        description: "Use sizes to express non-equal column widths while keeping the rows definition stable.",
+        snippet: {
+          use: options.use,
+          stepParams: createGridLayoutStepParamsValue(
+            {
+              rowTop: [[customSizeItems[0].uid], [customSizeItems[1].uid]],
+              rowBottom: [[customSizeItems[2].uid], [customSizeItems[3].uid], [customSizeItems[4].uid]]
+            },
+            {
+              rowTop: [8, 16],
+              rowBottom: [6, 10, 8]
+            },
+            ["rowTop", "rowBottom"]
+          ),
+          subModels: {
+            items: customSizeItems
+          }
+        }
+      }
+    ],
+    dynamicHints: options.dynamicHints || []
+  };
+};
+const bulkEditBlockGridModelInternalSchemaContribution = {
+  use: "BulkEditBlockGridModel",
+  title: "Bulk edit block grid",
+  source: "plugin",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["BulkEditActionModel"],
+  stepParamsSchema: createGridLayoutStepParamsSchema(),
+  subModelSlots: {
+    items: {
+      type: "array",
+      dynamic: true,
+      schema: genericModelNodeSchema,
+      description: "Bulk edit grid items depend on runtime block registries."
+    }
+  },
+  skeleton: {
+    uid: "todo-bulk-edit-grid-uid",
+    use: "BulkEditBlockGridModel",
+    subModels: {
+      items: []
+    }
+  },
+  docs: createGridLayoutDocs({
+    use: "BulkEditBlockGridModel",
+    itemUses: ["TableBlockModel", "JSBlockModel", "MarkdownBlockModel"],
+    prefix: "bulk-edit-grid",
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "BulkEditBlockGridModel.subModels.items",
+        message: "Bulk edit page blocks depend on runtime block registries and collection context.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "items",
+            type: "array"
+          },
+          contextRequirements: ["block registry", "collection context"],
+          unresolvedReason: "runtime-bulk-edit-grid-items"
+        }
+      }
+    ]
+  })
+};
+const bulkEditChildPageTabModelInternalSchemaContribution = {
+  use: "BulkEditChildPageTabModel",
+  title: "Bulk edit child page tab",
+  source: "plugin",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["BulkEditActionModel"],
+  subModelSlots: {
+    grid: {
+      type: "object",
+      use: "BulkEditBlockGridModel",
+      description: "Bulk edit tab content grid."
+    }
+  },
+  skeleton: {
+    uid: "todo-bulk-edit-tab-uid",
+    use: "BulkEditChildPageTabModel",
+    subModels: {
+      grid: {
+        uid: "todo-bulk-edit-tab-grid-uid",
+        use: "BulkEditBlockGridModel"
+      }
+    }
+  }
+};
+const bulkEditActionModelSchemaContribution = {
+  use: "BulkEditActionModel",
+  title: "Bulk edit action",
+  source: "plugin",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      bulkEditSettings: {
+        type: "object",
+        properties: {
+          editMode: {
+            type: "object",
+            properties: {
+              value: {
+                type: "string",
+                enum: ["selected", "all"]
+              }
+            },
+            required: ["value"],
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  subModelSlots: {
+    page: {
+      type: "object",
+      use: "ChildPageModel",
+      description: "Popup child page used to host bulk edit tabs.",
+      childSchemaPatch: {
+        subModelSlots: {
+          tabs: {
+            type: "array",
+            uses: ["BulkEditChildPageTabModel"],
+            description: "Bulk edit tabs."
+          }
+        }
+      }
+    }
+  },
+  skeleton: {
+    uid: "todo-bulk-edit-action-uid",
+    use: "BulkEditActionModel",
+    stepParams: {
+      bulkEditSettings: {
+        editMode: {
+          value: "selected"
+        }
+      }
+    },
+    subModels: {
+      page: {
+        uid: "todo-bulk-edit-page-uid",
+        use: "ChildPageModel",
+        stepParams: {
+          pageSettings: {
+            general: {
+              displayTitle: false,
+              enableTabs: true
+            }
+          }
+        },
+        subModels: {
+          tabs: [
+            {
+              uid: "todo-bulk-edit-tab-uid",
+              use: "BulkEditChildPageTabModel",
+              stepParams: {
+                pageTabSettings: {
+                  tab: {
+                    title: "Bulk edit"
+                  }
+                }
+              },
+              subModels: {
+                grid: {
+                  uid: "todo-bulk-edit-grid-uid",
+                  use: "BulkEditBlockGridModel"
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "bulk-edit-users",
+      use: "BulkEditActionModel",
+      stepParams: {
+        bulkEditSettings: {
+          editMode: {
+            value: "selected"
+          }
+        }
+      },
+      subModels: {
+        page: {
+          uid: "bulk-edit-users-page",
+          use: "ChildPageModel"
+        }
+      }
+    },
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "BulkEditActionModel.subModels.page.subModels.tabs[*].subModels.grid.subModels.items",
+        message: "Bulk edit blocks inside the popup grid depend on runtime block registries.",
+        "x-flow": {
+          contextRequirements: ["block registry", "collection context"],
+          unresolvedReason: "runtime-bulk-edit-grid-items"
+        }
+      }
+    ]
+  }
+};
+const flowSchemaContribution = {
+  models: [
+    bulkEditBlockGridModelInternalSchemaContribution,
+    bulkEditChildPageTabModelInternalSchemaContribution,
+    bulkEditActionModelSchemaContribution
+  ],
+  defaults: {
+    source: "plugin"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flowSchemaContribution
+});

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

@@ -0,0 +1,10 @@
+/**
+ * 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 { FlowSchemaContribution } from '../../flow-schema-registry';
+export declare const flowSchemaContribution: FlowSchemaContribution;

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

@@ -0,0 +1,169 @@
+/**
+ * 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 ActionBulkUpdateModel_exports = {};
+__export(ActionBulkUpdateModel_exports, {
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(ActionBulkUpdateModel_exports);
+const confirmStepParamsSchema = {
+  type: "object",
+  properties: {
+    enable: { type: "boolean" },
+    title: { type: "string" },
+    content: { type: "string" }
+  },
+  additionalProperties: false
+};
+const bulkUpdateActionModelSchemaContribution = {
+  use: "BulkUpdateActionModel",
+  title: "Bulk update action",
+  source: "plugin",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      assignSettings: {
+        type: "object",
+        properties: {
+          confirm: confirmStepParamsSchema,
+          updateMode: {
+            type: "object",
+            properties: {
+              value: {
+                type: "string",
+                enum: ["selected", "all"]
+              }
+            },
+            required: ["value"],
+            additionalProperties: false
+          },
+          assignFieldValues: {
+            type: "object",
+            properties: {
+              assignedValues: {
+                type: "object",
+                additionalProperties: true
+              }
+            },
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      },
+      apply: {
+        type: "object",
+        properties: {
+          apply: {
+            type: "object",
+            properties: {
+              assignedValues: {
+                type: "object",
+                additionalProperties: true
+              }
+            },
+            additionalProperties: true
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  subModelSlots: {
+    assignForm: {
+      type: "object",
+      use: "AssignFormModel",
+      description: "Internal assignment form used to configure bulk update field/value pairs."
+    }
+  },
+  skeleton: {
+    uid: "todo-bulk-update-action-uid",
+    use: "BulkUpdateActionModel",
+    stepParams: {
+      assignSettings: {
+        confirm: {
+          enable: false,
+          title: "Bulk update",
+          content: "Are you sure you want to perform the Update record action?"
+        },
+        updateMode: {
+          value: "selected"
+        },
+        assignFieldValues: {
+          assignedValues: {}
+        }
+      }
+    },
+    subModels: {
+      assignForm: {
+        uid: "todo-bulk-update-assign-form-uid",
+        use: "AssignFormModel"
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "bulk-update-users",
+      use: "BulkUpdateActionModel",
+      stepParams: {
+        assignSettings: {
+          updateMode: {
+            value: "selected"
+          }
+        }
+      },
+      subModels: {
+        assignForm: {
+          uid: "bulk-update-users-assign-form",
+          use: "AssignFormModel"
+        }
+      }
+    },
+    dynamicHints: [
+      {
+        kind: "dynamic-ui-schema",
+        path: "BulkUpdateActionModel.stepParams.assignSettings.assignFieldValues.assignedValues",
+        message: "Assigned field/value pairs depend on runtime collection fields and assign-form editors.",
+        "x-flow": {
+          contextRequirements: ["collection fields", "assign form child tree"],
+          unresolvedReason: "runtime-bulk-update-assigned-values",
+          recommendedFallback: {}
+        }
+      }
+    ]
+  }
+};
+const flowSchemaContribution = {
+  models: [bulkUpdateActionModelSchemaContribution],
+  defaults: {
+    source: "plugin"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flowSchemaContribution
+});

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { FlowActionSchemaContribution, FlowSchemaContribution } from '../../flow-schema-registry';
+export declare const customRequestActionSchemaContribution: FlowActionSchemaContribution;
+export declare const flowSchemaContribution: FlowSchemaContribution;

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

@@ -0,0 +1,115 @@
+/**
+ * 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 ActionCustomRequestModel_exports = {};
+__export(ActionCustomRequestModel_exports, {
+  customRequestActionSchemaContribution: () => customRequestActionSchemaContribution,
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(ActionCustomRequestModel_exports);
+const requestNameValueSchema = {
+  type: "object",
+  properties: {
+    name: { type: "string" },
+    value: { type: "string" }
+  },
+  additionalProperties: false
+};
+const customRequestActionSchemaContribution = {
+  name: "customRequest",
+  title: "Custom request",
+  source: "plugin",
+  strict: false,
+  paramsSchema: {
+    type: "object",
+    properties: {
+      key: { type: "string" },
+      method: {
+        type: "string",
+        enum: ["GET", "POST", "PUT", "PATCH", "DELETE"]
+      },
+      url: { type: "string" },
+      headers: {
+        type: "array",
+        items: requestNameValueSchema
+      },
+      params: {
+        type: "array",
+        items: requestNameValueSchema
+      },
+      data: {},
+      timeout: { type: "number" },
+      responseType: {
+        type: "string",
+        enum: ["json", "stream"]
+      },
+      variablePaths: {
+        type: "array",
+        items: { type: "string" }
+      },
+      roles: {
+        type: "array",
+        items: { type: "string" }
+      }
+    },
+    additionalProperties: false
+  },
+  docs: {
+    minimalExample: {
+      key: "req_demo",
+      method: "POST",
+      url: "https://api.example.com/orders",
+      headers: [
+        {
+          name: "Authorization",
+          value: "Bearer {{ctx.token}}"
+        }
+      ],
+      params: [
+        {
+          name: "id",
+          value: "{{ctx.record.id}}"
+        }
+      ],
+      data: {
+        status: "processed"
+      },
+      timeout: 5e3,
+      responseType: "json"
+    }
+  }
+};
+const flowSchemaContribution = {
+  actions: [customRequestActionSchemaContribution],
+  defaults: {
+    source: "plugin"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  customRequestActionSchemaContribution,
+  flowSchemaContribution
+});

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

@@ -0,0 +1,10 @@
+/**
+ * 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 { FlowSchemaContribution } from '../../flow-schema-registry';
+export declare const flowSchemaContribution: FlowSchemaContribution;