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

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

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

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

@@ -0,0 +1,179 @@
+/**
+ * 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 DetailsBlockModel_exports = {};
+__export(DetailsBlockModel_exports, {
+  detailsBlockModelSchemaContribution: () => detailsBlockModelSchemaContribution
+});
+module.exports = __toCommonJS(DetailsBlockModel_exports);
+var import_shared = require("../shared");
+const detailsBlockModelSchemaContribution = {
+  use: "DetailsBlockModel",
+  title: "Details block",
+  source: "official",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      ...import_shared.collectionResourceSettingsStepParamsSchema.properties || {},
+      detailsSettings: {
+        type: "object",
+        properties: {
+          layout: import_shared.layoutParamsSchema,
+          dataScope: import_shared.dataScopeParamsSchema,
+          defaultSorting: import_shared.sortingRuleParamsSchema,
+          linkageRules: import_shared.linkageRuleValueSchema
+        },
+        additionalProperties: true
+      },
+      paginationChange: {
+        type: "object",
+        properties: {
+          blockLinkageRulesRefresh: import_shared.linkageRulesRefreshParamsSchema,
+          fieldslinkageRulesRefresh: import_shared.linkageRulesRefreshParamsSchema
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  subModelSlots: {
+    grid: {
+      type: "object",
+      use: "DetailsGridModel",
+      description: "Primary details field grid."
+    },
+    actions: {
+      type: "array",
+      uses: import_shared.recordActionUses,
+      dynamic: true,
+      schema: import_shared.genericModelNodeSchema,
+      description: "Details actions depend on runtime record-action registries."
+    }
+  },
+  skeleton: {
+    uid: "todo-uid",
+    use: "DetailsBlockModel",
+    stepParams: (0, import_shared.createCollectionResourceStepParams)(
+      {},
+      {
+        detailsSettings: {
+          layout: {
+            layout: "vertical",
+            colon: true
+          },
+          dataScope: {
+            filter: {
+              logic: "$and",
+              items: []
+            }
+          },
+          linkageRules: {
+            value: []
+          }
+        }
+      }
+    ),
+    subModels: {
+      grid: {
+        uid: "todo-details-grid-uid",
+        use: "DetailsGridModel"
+      },
+      actions: []
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "details-users",
+      use: "DetailsBlockModel",
+      stepParams: (0, import_shared.createCollectionResourceStepParams)(
+        {},
+        {
+          detailsSettings: {
+            layout: {
+              layout: "vertical",
+              colon: true
+            },
+            dataScope: {
+              filter: {
+                logic: "$and",
+                items: []
+              }
+            },
+            linkageRules: {
+              value: []
+            }
+          }
+        }
+      ),
+      subModels: {
+        grid: {
+          uid: "details-grid-users",
+          use: "DetailsGridModel"
+        },
+        actions: []
+      }
+    },
+    commonPatterns: [
+      (0, import_shared.createCurrentRecordCollectionPattern)("DetailsBlockModel", {
+        detailsSettings: {
+          layout: {
+            layout: "vertical",
+            colon: true
+          }
+        }
+      }),
+      {
+        title: "Details block with record actions",
+        snippet: {
+          subModels: {
+            actions: []
+          }
+        }
+      }
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "DetailsBlockModel.subModels.actions",
+        message: "Details actions depend on runtime record-action registries and collection context.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "actions",
+            type: "array",
+            allowedUses: import_shared.recordActionUses
+          },
+          contextRequirements: ["record action registry", "collection metadata"],
+          unresolvedReason: "runtime-details-actions"
+        }
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  detailsBlockModelSchemaContribution
+});

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

package/dist/server/flow-schema-contributions/models/DetailsGridModel.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 DetailsGridModel_exports = {};
+__export(DetailsGridModel_exports, {
+  detailsGridModelInternalSchemaContribution: () => detailsGridModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(DetailsGridModel_exports);
+var import_shared = require("../shared");
+const detailsGridModelInternalSchemaContribution = {
+  use: "DetailsGridModel",
+  title: "Details grid",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["DetailsBlockModel"],
+  stepParamsSchema: (0, import_shared.createGridLayoutStepParamsSchema)(),
+  subModelSlots: {
+    items: {
+      type: "array",
+      uses: import_shared.detailsGridItemUses,
+      dynamic: true,
+      schema: import_shared.genericModelNodeSchema,
+      description: "Details grid items depend on field metadata and runtime item factories."
+    }
+  },
+  skeleton: {
+    uid: "todo-details-grid-uid",
+    use: "DetailsGridModel",
+    subModels: {
+      items: []
+    }
+  },
+  docs: (0, import_shared.createGridLayoutDocs)({
+    use: "DetailsGridModel",
+    itemUses: import_shared.detailsGridItemUses,
+    prefix: "details-grid",
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "DetailsGridModel.subModels.items",
+        message: "Details grid items are resolved from runtime field model factories.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "items",
+            type: "array",
+            allowedUses: import_shared.detailsGridItemUses
+          },
+          contextRequirements: ["details field metadata", "details item factories"],
+          unresolvedReason: "runtime-details-grid-items"
+        }
+      }
+    ]
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  detailsGridModelInternalSchemaContribution
+});

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

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

@@ -0,0 +1,77 @@
+/**
+ * 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 DetailsItemModel_exports = {};
+__export(DetailsItemModel_exports, {
+  detailsItemModelInternalSchemaContribution: () => detailsItemModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(DetailsItemModel_exports);
+var import_shared = require("../shared");
+const detailsItemModelInternalSchemaContribution = {
+  use: "DetailsItemModel",
+  title: "Details item",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["DetailsBlockModel"],
+  stepParamsSchema: import_shared.detailItemStepParamsSchema,
+  subModelSlots: {
+    field: (0, import_shared.createRuntimeFieldModelSlotSchema)("details-item-field")
+  },
+  skeleton: {
+    uid: "todo-details-item-uid",
+    use: "DetailsItemModel",
+    stepParams: {
+      fieldSettings: {
+        init: {
+          dataSourceKey: "main",
+          collectionName: "users",
+          fieldPath: "nickname"
+        }
+      },
+      detailItemSettings: {
+        showLabel: {
+          showLabel: true
+        }
+      }
+    },
+    subModels: {}
+  },
+  docs: {
+    dynamicHints: [
+      (0, import_shared.createRuntimeFieldDynamicHint)(
+        "DetailsItemModel",
+        "DetailsItemModel.subModels.field",
+        ["details field bindings", "collection metadata"],
+        "runtime-details-item-field"
+      )
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  detailsItemModelInternalSchemaContribution
+});

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

package/dist/server/flow-schema-contributions/models/EditActionModel.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 EditActionModel_exports = {};
+__export(EditActionModel_exports, {
+  editActionModelInternalSchemaContribution: () => editActionModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(EditActionModel_exports);
+var import_shared = require("../shared");
+const editFormBlock = (0, import_shared.createFormBlockMinimalExample)("EditFormModel");
+const editActionModelInternalSchemaContribution = {
+  use: "EditActionModel",
+  title: "Edit action",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableActionsColumnModel", "DetailsBlockModel"],
+  subModelSlots: {
+    page: (0, import_shared.createPopupPageSlotSchema)()
+  },
+  stepParamsSchema: (0, import_shared.createActionStepParamsSchema)({
+    popupSettings: import_shared.popupActionSettingsStepParamsSchema
+  }),
+  skeleton: (0, import_shared.createPopupActionExample)({
+    uid: "todo-edit-action-uid",
+    use: "EditActionModel",
+    title: "Edit",
+    prefix: "todo-edit-action",
+    tabTitle: "Edit form",
+    items: [editFormBlock],
+    openView: {
+      dataSourceKey: "main",
+      collectionName: "users"
+    }
+  }),
+  docs: {
+    minimalExample: (0, import_shared.createPopupActionExample)({
+      uid: "edit-users",
+      use: "EditActionModel",
+      title: "Edit",
+      prefix: "edit-users",
+      tabTitle: "Edit form",
+      items: [editFormBlock],
+      openView: {
+        dataSourceKey: "main",
+        collectionName: "users"
+      }
+    }),
+    commonPatterns: [
+      (0, import_shared.createPopupActionPattern)({
+        title: "EditActionModel + EditForm popup",
+        description: "Use a ChildPageModel popup tree to host an EditFormModel block for record editing.",
+        use: "EditActionModel",
+        buttonTitle: "Edit",
+        prefix: "edit-pattern",
+        tabTitle: "Edit form",
+        items: [editFormBlock],
+        openView: {
+          dataSourceKey: "main",
+          collectionName: "users"
+        }
+      })
+    ],
+    antiPatterns: import_shared.popupActionAntiPatterns
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  editActionModelInternalSchemaContribution
+});

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

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

@@ -0,0 +1,103 @@
+/**
+ * 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 EditFormModel_exports = {};
+__export(EditFormModel_exports, {
+  editFormModelSchemaContribution: () => editFormModelSchemaContribution
+});
+module.exports = __toCommonJS(EditFormModel_exports);
+var import_shared = require("../shared");
+const editFormSkeleton = (0, import_shared.createFormBlockSkeleton)("EditFormModel");
+const editFormMinimalExample = (0, import_shared.createFormBlockMinimalExample)("EditFormModel");
+const editFormModelSchemaContribution = {
+  use: "EditFormModel",
+  title: "Form (Edit)",
+  source: "official",
+  strict: false,
+  stepParamsSchema: {
+    ...import_shared.formBlockBaseStepParamsSchema,
+    properties: {
+      ...import_shared.formBlockBaseStepParamsSchema.properties || {},
+      formSettings: {
+        type: "object",
+        properties: {
+          dataScope: import_shared.dataScopeParamsSchema
+        },
+        additionalProperties: true
+      }
+    }
+  },
+  subModelSlots: (0, import_shared.createFormBlockSubModelSlots)(),
+  skeleton: {
+    ...editFormSkeleton,
+    stepParams: {
+      ...editFormSkeleton.stepParams,
+      formSettings: {
+        dataScope: {
+          filter: {
+            logic: "$and",
+            items: []
+          }
+        }
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      ...editFormMinimalExample,
+      stepParams: {
+        ...editFormMinimalExample.stepParams,
+        formSettings: {
+          dataScope: {
+            filter: {
+              logic: "$and",
+              items: []
+            }
+          }
+        }
+      }
+    },
+    commonPatterns: [
+      ...(0, import_shared.createFormBlockCommonPatterns)("EditFormModel"),
+      (0, import_shared.createCurrentRecordCollectionPattern)("EditFormModel", {
+        formSettings: {
+          dataScope: {
+            filter: {
+              logic: "$and",
+              items: []
+            }
+          }
+        }
+      })
+    ],
+    antiPatterns: import_shared.formBlockAntiPatterns,
+    dynamicHints: (0, import_shared.createFormBlockDynamicHints)("EditFormModel")
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  editFormModelSchemaContribution
+});

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