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

package/dist/server/flow-schema-contributions/models/LinkActionModel.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 LinkActionModel_exports = {};
+__export(LinkActionModel_exports, {
+  linkActionModelInternalSchemaContribution: () => linkActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(LinkActionModel_exports);
+var import_shared = require("../shared");
+const linkActionModelInternalSchemaContribution = {
+  use: "LinkActionModel",
+  title: "Link action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel", "TableActionsColumnModel", "DetailsBlockModel"],
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    actionPanelLinkSettings: import_shared.linkActionSettingsStepParamsSchema
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  linkActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/PageModel.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 pageModelSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,159 @@
+/**
+ * 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 PageModel_exports = {};
+__export(PageModel_exports, {
+  pageModelSchemaContribution: () => pageModelSchemaContribution
+});
+module.exports = __toCommonJS(PageModel_exports);
+var import_shared = require("../shared");
+const pageModelSchemaContribution = {
+  use: "PageModel",
+  title: "Page",
+  source: "official",
+  strict: false,
+  subModelSlots: {
+    tabs: {
+      type: "array",
+      uses: import_shared.pageTabUses,
+      description: "Page tabs."
+    }
+  },
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      pageSettings: {
+        type: "object",
+        properties: {
+          general: {
+            type: "object",
+            properties: {
+              title: { type: "string" },
+              documentTitle: { type: "string" },
+              displayTitle: { type: "boolean" },
+              enableTabs: { type: "boolean" }
+            },
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  skeleton: {
+    uid: "todo-uid",
+    use: "PageModel",
+    stepParams: {
+      pageSettings: {
+        general: {
+          title: "Page title",
+          displayTitle: true,
+          enableTabs: false
+        }
+      }
+    },
+    subModels: {
+      tabs: []
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "page-users",
+      use: "PageModel",
+      stepParams: {
+        pageSettings: {
+          general: {
+            title: "Users",
+            displayTitle: true,
+            enableTabs: false
+          }
+        }
+      },
+      subModels: {
+        tabs: []
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Single page without tabs",
+        snippet: {
+          stepParams: {
+            pageSettings: {
+              general: {
+                title: "Users",
+                displayTitle: true,
+                enableTabs: false
+              }
+            }
+          }
+        }
+      },
+      {
+        title: "Page with tabs enabled",
+        snippet: {
+          stepParams: {
+            pageSettings: {
+              general: {
+                title: "Dashboard",
+                displayTitle: true,
+                enableTabs: true
+              }
+            }
+          },
+          subModels: {
+            tabs: [
+              {
+                uid: "page-tab-1",
+                use: "RootPageTabModel"
+              }
+            ]
+          }
+        }
+      }
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "PageModel.subModels.tabs",
+        message: "Tab models are usually created from runtime route context.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "tabs",
+            type: "array",
+            allowedUses: import_shared.pageTabUses
+          },
+          contextRequirements: ["route context", "page tab model class"],
+          unresolvedReason: "runtime-page-tabs"
+        }
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pageModelSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/PageTabModel.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 pageTabModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,69 @@
+/**
+ * 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 PageTabModel_exports = {};
+__export(PageTabModel_exports, {
+  pageTabModelInternalSchemaContribution: () => pageTabModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(PageTabModel_exports);
+var import_shared = require("../shared");
+const pageTabModelInternalSchemaContribution = {
+  use: "PageTabModel",
+  title: "Page tab",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["PageModel"],
+  stepParamsSchema: import_shared.pageTabSettingsStepParamsSchema,
+  subModelSlots: {
+    grid: {
+      type: "object",
+      use: "BlockGridModel",
+      description: "Tab content block grid."
+    }
+  },
+  skeleton: {
+    uid: "todo-page-tab-uid",
+    use: "PageTabModel",
+    stepParams: {
+      pageTabSettings: {
+        tab: {
+          title: "Tab"
+        }
+      }
+    },
+    subModels: {
+      grid: {
+        uid: "todo-grid-uid",
+        use: "BlockGridModel"
+      }
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pageTabModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/PopupActionModel.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 popupActionModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,92 @@
+/**
+ * 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 PopupActionModel_exports = {};
+__export(PopupActionModel_exports, {
+  popupActionModelInternalSchemaContribution: () => popupActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(PopupActionModel_exports);
+var import_shared = require("../shared");
+const popupJsBlock = {
+  uid: "popup-js-block",
+  use: "JSBlockModel",
+  stepParams: {
+    jsSettings: {
+      runJs: {
+        version: "v2",
+        code: "ctx.render('<div>Popup content</div>');"
+      }
+    }
+  }
+};
+const popupActionModelInternalSchemaContribution = {
+  use: "PopupActionModel",
+  title: "Popup action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["ActionPanelBlockModel"],
+  subModelSlots: {
+    page: (0, import_shared.createPopupPageSlotSchema)()
+  },
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    popupSettings: import_shared.popupActionSettingsStepParamsSchema
+  }),
+  skeleton: (0, import_shared.createPopupActionExample)({
+    uid: "todo-popup-action-uid",
+    use: "PopupActionModel",
+    title: "Popup",
+    prefix: "todo-popup-action",
+    tabTitle: "Popup",
+    items: [popupJsBlock]
+  }),
+  docs: {
+    minimalExample: (0, import_shared.createPopupActionExample)({
+      uid: "popup-action-example",
+      use: "PopupActionModel",
+      title: "Popup",
+      prefix: "popup-action-example",
+      tabTitle: "Popup",
+      items: [popupJsBlock]
+    }),
+    commonPatterns: [
+      (0, import_shared.createPopupActionPattern)({
+        title: "Generic popup with a JS block",
+        description: "Use a ChildPageModel popup tree when the action opens a self-contained popup UI.",
+        use: "PopupActionModel",
+        buttonTitle: "Popup",
+        prefix: "popup-generic-pattern",
+        tabTitle: "Popup",
+        items: [popupJsBlock]
+      })
+    ],
+    antiPatterns: import_shared.popupActionAntiPatterns
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  popupActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/PopupCollectionActionModel.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 popupCollectionActionModelInternalSchemaContribution: FlowModelSchemaContribution;

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

@@ -0,0 +1,119 @@
+/**
+ * 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 PopupCollectionActionModel_exports = {};
+__export(PopupCollectionActionModel_exports, {
+  popupCollectionActionModelInternalSchemaContribution: () => popupCollectionActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(PopupCollectionActionModel_exports);
+var import_shared = require("../shared");
+const popupCollectionTableBlock = {
+  uid: "popup-collection-table",
+  use: "TableBlockModel",
+  stepParams: (0, import_shared.createCollectionResourceStepParams)(
+    {},
+    {
+      tableSettings: {
+        pageSize: {
+          pageSize: 20
+        },
+        showRowNumbers: {
+          showIndex: true
+        },
+        dataScope: {
+          filter: {
+            logic: "$and",
+            items: []
+          }
+        }
+      }
+    }
+  ),
+  subModels: {
+    columns: [],
+    actions: []
+  }
+};
+const popupCollectionActionModelInternalSchemaContribution = {
+  use: "PopupCollectionActionModel",
+  title: "Popup collection action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel", "TableActionsColumnModel", "DetailsBlockModel"],
+  subModelSlots: {
+    page: (0, import_shared.createPopupPageSlotSchema)()
+  },
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    popupSettings: import_shared.popupActionSettingsStepParamsSchema
+  }),
+  skeleton: (0, import_shared.createPopupActionExample)({
+    uid: "todo-popup-collection-action-uid",
+    use: "PopupCollectionActionModel",
+    title: "Popup collection",
+    prefix: "todo-popup-collection-action",
+    tabTitle: "Collection popup",
+    items: [popupCollectionTableBlock],
+    openView: {
+      dataSourceKey: "main",
+      collectionName: "users"
+    }
+  }),
+  docs: {
+    minimalExample: (0, import_shared.createPopupActionExample)({
+      uid: "popup-collection-users",
+      use: "PopupCollectionActionModel",
+      title: "Popup collection",
+      prefix: "popup-collection-users",
+      tabTitle: "Collection popup",
+      items: [popupCollectionTableBlock],
+      openView: {
+        dataSourceKey: "main",
+        collectionName: "users"
+      }
+    }),
+    commonPatterns: [
+      (0, import_shared.createPopupActionPattern)({
+        title: "Collection popup with a table block",
+        description: "Open a popup ChildPageModel tree that hosts collection-backed blocks.",
+        use: "PopupCollectionActionModel",
+        buttonTitle: "Popup collection",
+        prefix: "popup-collection-pattern",
+        tabTitle: "Collection popup",
+        items: [popupCollectionTableBlock],
+        openView: {
+          dataSourceKey: "main",
+          collectionName: "users"
+        }
+      })
+    ],
+    antiPatterns: import_shared.popupActionAntiPatterns
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  popupCollectionActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/RefreshActionModel.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 refreshActionModelInternalSchemaContribution: FlowModelSchemaContribution;

package/dist/server/flow-schema-contributions/models/RefreshActionModel.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 RefreshActionModel_exports = {};
+__export(RefreshActionModel_exports, {
+  refreshActionModelInternalSchemaContribution: () => refreshActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(RefreshActionModel_exports);
+var import_shared = require("../shared");
+const refreshActionModelInternalSchemaContribution = {
+  use: "RefreshActionModel",
+  title: "Refresh action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel"],
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    refreshSettings: import_shared.refreshActionSettingsStepParamsSchema
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  refreshActionModelInternalSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/RootPageModel.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 rootPageModelSchemaContribution: FlowModelSchemaContribution;