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

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

@@ -0,0 +1,64 @@
+/**
+ * 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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var flow_schema_contributions_exports = {};
+__export(flow_schema_contributions_exports, {
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(flow_schema_contributions_exports);
+var import_field_models = require("./field-models");
+var import_actions = require("./actions");
+var import_models = require("./models");
+var import_shared = require("./shared");
+__reExport(flow_schema_contributions_exports, require("./actions"), module.exports);
+__reExport(flow_schema_contributions_exports, require("./field-models"), module.exports);
+__reExport(flow_schema_contributions_exports, require("./models"), module.exports);
+const flowSchemaContribution = {
+  actions: import_actions.flowSchemaActionContributions,
+  models: [...import_models.flowSchemaModelContributions, ...import_field_models.coreFieldModelContributions],
+  fieldBindingContexts: import_field_models.coreFieldBindingContextContributions,
+  fieldBindings: import_field_models.coreFieldBindingContributions,
+  inventory: {
+    slotUseExpansions: [
+      {
+        parentUse: "BlockGridModel",
+        slotKey: "items",
+        uses: Array.from(new Set(import_shared.publicBlockRootUses)).sort()
+      }
+    ]
+  },
+  defaults: {
+    source: "official"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flowSchemaContribution,
+  ...require("./actions"),
+  ...require("./field-models"),
+  ...require("./models")
+});

package/dist/server/flow-schema-contributions/models/ActionModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const actionModelSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,202 @@
+/**
+ * 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 ActionModel_exports = {};
+__export(ActionModel_exports, {
+  actionModelSchemaContribution: () => actionModelSchemaContribution
+});
+module.exports = __toCommonJS(ActionModel_exports);
+var import_shared = require("../shared");
+const actionModelSchemaContribution = {
+  use: "ActionModel",
+  title: "Action",
+  source: "official",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      buttonSettings: {
+        type: "object",
+        properties: {
+          general: {
+            type: "object",
+            properties: {
+              title: { type: "string" },
+              tooltip: { type: "string" },
+              type: {
+                type: "string",
+                enum: ["default", "primary", "dashed", "link", "text"]
+              },
+              danger: { type: "boolean" },
+              icon: { type: ["string", "null"] },
+              color: { type: "string" }
+            },
+            additionalProperties: false
+          },
+          linkageRules: import_shared.linkageRuleValueSchema
+        },
+        additionalProperties: true
+      },
+      buttonAclSettings: {
+        type: "object",
+        properties: {
+          aclCheck: import_shared.emptyObjectSchema
+        },
+        additionalProperties: true
+      },
+      paginationChange: {
+        type: "object",
+        properties: {
+          aclCheckRefresh: import_shared.aclCheckRefreshParamsSchema,
+          linkageRulesRefresh: import_shared.linkageRulesRefreshParamsSchema
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  flowRegistrySchema: {
+    type: "object",
+    properties: {
+      buttonSettings: {
+        type: "object",
+        properties: {
+          key: { const: "buttonSettings" },
+          steps: {
+            type: "object",
+            properties: {
+              general: {
+                type: "object",
+                properties: {
+                  title: { type: "string" }
+                },
+                additionalProperties: true
+              },
+              linkageRules: {
+                type: "object",
+                properties: {
+                  use: { const: "actionLinkageRules" }
+                },
+                additionalProperties: true
+              }
+            },
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  skeleton: {
+    uid: "todo-uid",
+    use: "ActionModel",
+    stepParams: {
+      buttonSettings: {
+        general: {
+          title: "Action",
+          type: "default",
+          danger: false
+        },
+        linkageRules: {
+          value: []
+        }
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "action-primary-save",
+      use: "ActionModel",
+      stepParams: {
+        buttonSettings: {
+          general: {
+            title: "Save",
+            type: "primary",
+            danger: false
+          },
+          linkageRules: {
+            value: []
+          }
+        }
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Primary submit action",
+        snippet: {
+          stepParams: {
+            buttonSettings: {
+              general: {
+                title: "Save",
+                type: "primary"
+              }
+            }
+          }
+        }
+      },
+      {
+        title: "Danger action",
+        snippet: {
+          stepParams: {
+            buttonSettings: {
+              general: {
+                title: "Delete",
+                danger: true
+              }
+            }
+          }
+        }
+      }
+    ],
+    antiPatterns: [
+      {
+        title: "Do not depend on hidden dynamic fields",
+        description: "buttonSettings.general fields are gated by model flags such as enableEditIcon / enableEditColor."
+      }
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-ui-schema",
+        path: "ActionModel.stepParams.buttonSettings.general",
+        message: "Editable fields depend on ActionModel runtime flags such as enableEditTitle and enableEditIcon.",
+        "x-flow": {
+          contextRequirements: ["enableEditTitle", "enableEditTooltip", "enableEditIcon", "enableEditColor"],
+          unresolvedReason: "runtime-action-editability-flags",
+          recommendedFallback: {
+            title: "Action",
+            type: "default",
+            danger: false
+          }
+        }
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  actionModelSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/AddChildActionModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const addChildActionModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,47 @@
+/**
+ * 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 AddChildActionModel_exports = {};
+__export(AddChildActionModel_exports, {
+  addChildActionModelInternalSchemaContribution: () => addChildActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(AddChildActionModel_exports);
+var import_shared = require("../shared");
+const addChildActionModelInternalSchemaContribution = {
+  use: "AddChildActionModel",
+  title: "Add child action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableActionsColumnModel", "DetailsBlockModel"],
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    popupSettings: import_shared.popupActionSettingsStepParamsSchema
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  addChildActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/AddNewActionModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const addNewActionModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,93 @@
+/**
+ * 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 AddNewActionModel_exports = {};
+__export(AddNewActionModel_exports, {
+  addNewActionModelInternalSchemaContribution: () => addNewActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(AddNewActionModel_exports);
+var import_shared = require("../shared");
+const addNewFormBlock = (0, import_shared.createFormBlockMinimalExample)("CreateFormModel");
+const addNewActionModelInternalSchemaContribution = {
+  use: "AddNewActionModel",
+  title: "Add new action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel"],
+  subModelSlots: {
+    page: (0, import_shared.createPopupPageSlotSchema)()
+  },
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    popupSettings: import_shared.popupActionSettingsStepParamsSchema
+  }),
+  skeleton: (0, import_shared.createPopupActionExample)({
+    uid: "todo-add-new-action-uid",
+    use: "AddNewActionModel",
+    title: "Add new",
+    prefix: "todo-add-new-action",
+    tabTitle: "Create form",
+    items: [addNewFormBlock],
+    openView: {
+      dataSourceKey: "main",
+      collectionName: "users"
+    }
+  }),
+  docs: {
+    minimalExample: (0, import_shared.createPopupActionExample)({
+      uid: "add-new-users",
+      use: "AddNewActionModel",
+      title: "Add new",
+      prefix: "add-new-users",
+      tabTitle: "Create form",
+      items: [addNewFormBlock],
+      openView: {
+        dataSourceKey: "main",
+        collectionName: "users"
+      }
+    }),
+    commonPatterns: [
+      (0, import_shared.createPopupActionPattern)({
+        title: "AddNewActionModel + CreateForm popup",
+        description: "Build a complete popup action with a ChildPageModel tree that hosts a CreateFormModel block.",
+        use: "AddNewActionModel",
+        buttonTitle: "Add new",
+        prefix: "add-new-pattern",
+        tabTitle: "Create form",
+        items: [addNewFormBlock],
+        openView: {
+          dataSourceKey: "main",
+          collectionName: "users"
+        }
+      })
+    ],
+    antiPatterns: import_shared.popupActionAntiPatterns
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  addNewActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/AssignFormGridModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const assignFormGridModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,82 @@
+/**
+ * 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 AssignFormGridModel_exports = {};
+__export(AssignFormGridModel_exports, {
+  assignFormGridModelInternalSchemaContribution: () => assignFormGridModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(AssignFormGridModel_exports);
+var import_shared = require("../shared");
+const assignFormGridModelInternalSchemaContribution = {
+  use: "AssignFormGridModel",
+  title: "Assign form grid",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["UpdateRecordActionModel"],
+  stepParamsSchema: (0, import_shared.createGridLayoutStepParamsSchema)(),
+  subModelSlots: {
+    items: {
+      type: "array",
+      uses: ["AssignFormItemModel"],
+      dynamic: true,
+      schema: import_shared.genericModelNodeSchema,
+      description: "Assign form items are resolved from runtime collection field factories."
+    }
+  },
+  skeleton: {
+    uid: "todo-assign-form-grid-uid",
+    use: "AssignFormGridModel",
+    subModels: {
+      items: []
+    }
+  },
+  docs: (0, import_shared.createGridLayoutDocs)({
+    use: "AssignFormGridModel",
+    itemUses: ["AssignFormItemModel"],
+    prefix: "assign-form-grid",
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "AssignFormGridModel.subModels.items",
+        message: "Assign form items depend on runtime collection fields and editable field bindings.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "items",
+            type: "array",
+            allowedUses: ["AssignFormItemModel"]
+          },
+          contextRequirements: ["collection fields", "editable field bindings"],
+          unresolvedReason: "runtime-assign-form-items"
+        }
+      }
+    ]
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assignFormGridModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/AssignFormItemModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const assignFormItemModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,80 @@
+/**
+ * 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 AssignFormItemModel_exports = {};
+__export(AssignFormItemModel_exports, {
+  assignFormItemModelInternalSchemaContribution: () => assignFormItemModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(AssignFormItemModel_exports);
+var import_shared = require("../shared");
+const assignFormItemModelInternalSchemaContribution = {
+  use: "AssignFormItemModel",
+  title: "Assign form item",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["UpdateRecordActionModel"],
+  stepParamsSchema: import_shared.assignFormItemStepParamsSchema,
+  subModelSlots: {
+    field: (0, import_shared.createRuntimeFieldModelSlotSchema)("assign-form-item-field")
+  },
+  skeleton: {
+    uid: "todo-assign-item-uid",
+    use: "AssignFormItemModel",
+    stepParams: {
+      fieldSettings: {
+        init: {
+          dataSourceKey: "main",
+          collectionName: "users",
+          fieldPath: "nickname"
+        },
+        assignValue: {
+          value: "Alice"
+        }
+      },
+      editItemSettings: {
+        showLabel: {
+          showLabel: true
+        }
+      }
+    },
+    subModels: {}
+  },
+  docs: {
+    dynamicHints: [
+      (0, import_shared.createRuntimeFieldDynamicHint)(
+        "AssignFormItemModel",
+        "AssignFormItemModel.subModels.field",
+        ["editable field bindings", "assignment value editor"],
+        "runtime-assign-form-item-field"
+      )
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assignFormItemModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/AssignFormModel.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 { FlowModelSchemaContribution } from '@nocobase/flow-engine';
+export declare const assignFormModelInternalSchemaContribution: FlowModelSchemaContribution;