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

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

@@ -0,0 +1,254 @@
+/**
+ * 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 TableBlockModel_exports = {};
+__export(TableBlockModel_exports, {
+  tableBlockModelSchemaContribution: () => tableBlockModelSchemaContribution
+});
+module.exports = __toCommonJS(TableBlockModel_exports);
+var import_shared = require("../shared");
+const tableBlockModelSchemaContribution = {
+  use: "TableBlockModel",
+  title: "Table block",
+  source: "official",
+  strict: false,
+  subModelSlots: {
+    columns: {
+      type: "array",
+      uses: import_shared.tableColumnUses,
+      dynamic: true,
+      schema: import_shared.genericModelNodeSchema,
+      description: "Table columns or action columns."
+    },
+    actions: {
+      type: "array",
+      uses: import_shared.collectionActionUses,
+      dynamic: true,
+      schema: import_shared.genericModelNodeSchema,
+      description: "Collection actions depend on runtime action registries and table capabilities."
+    }
+  },
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      ...import_shared.collectionResourceSettingsStepParamsSchema.properties || {},
+      resourceSettings2: {
+        type: "object",
+        additionalProperties: true
+      },
+      tableSettings: {
+        type: "object",
+        properties: {
+          quickEdit: {
+            type: "object",
+            properties: {
+              editable: { type: "boolean" }
+            },
+            additionalProperties: false
+          },
+          showRowNumbers: {
+            type: "object",
+            properties: {
+              showIndex: { type: "boolean" }
+            },
+            additionalProperties: false
+          },
+          pageSize: {
+            type: "object",
+            properties: {
+              pageSize: {
+                type: "number",
+                enum: [5, 10, 20, 50, 100, 200]
+              }
+            },
+            additionalProperties: false
+          },
+          dataScope: import_shared.dataScopeParamsSchema,
+          defaultSorting: import_shared.sortingRuleParamsSchema,
+          treeTable: {
+            type: "object",
+            properties: {
+              treeTable: { type: "boolean" }
+            },
+            additionalProperties: false
+          },
+          defaultExpandAllRows: {
+            type: "object",
+            properties: {
+              defaultExpandAllRows: { type: "boolean" }
+            },
+            additionalProperties: false
+          },
+          tableDensity: {
+            type: "object",
+            properties: {
+              size: {
+                type: "string",
+                enum: ["large", "middle", "small"]
+              }
+            },
+            additionalProperties: false
+          },
+          dragSort: {
+            type: "object",
+            additionalProperties: true
+          },
+          dragSortBy: {
+            type: "object",
+            additionalProperties: true
+          },
+          refreshData: {
+            type: "object",
+            additionalProperties: true
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  skeleton: {
+    uid: "todo-uid",
+    use: "TableBlockModel",
+    stepParams: (0, import_shared.createCollectionResourceStepParams)(
+      {},
+      {
+        tableSettings: {
+          pageSize: {
+            pageSize: 20
+          },
+          showRowNumbers: {
+            showIndex: true
+          },
+          dataScope: {
+            filter: {
+              logic: "$and",
+              items: []
+            }
+          }
+        }
+      }
+    ),
+    subModels: {
+      columns: [],
+      actions: []
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "table-block-users",
+      use: "TableBlockModel",
+      stepParams: (0, import_shared.createCollectionResourceStepParams)(
+        {},
+        {
+          tableSettings: {
+            pageSize: {
+              pageSize: 20
+            },
+            showRowNumbers: {
+              showIndex: true
+            },
+            dataScope: {
+              filter: {
+                logic: "$and",
+                items: []
+              }
+            }
+          }
+        }
+      ),
+      subModels: {
+        columns: [],
+        actions: []
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Basic table with page size and sorting",
+        snippet: {
+          stepParams: (0, import_shared.createCollectionResourceStepParams)(
+            {},
+            {
+              tableSettings: {
+                pageSize: { pageSize: 20 },
+                defaultSorting: {
+                  sort: [{ field: "createdAt", direction: "desc" }]
+                }
+              }
+            }
+          )
+        }
+      },
+      (0, import_shared.createAssociatedCollectionPattern)("TableBlockModel", {
+        tableSettings: {
+          pageSize: {
+            pageSize: 20
+          }
+        }
+      })
+    ],
+    antiPatterns: [
+      {
+        title: "Do not assume every column use is TableActionsColumnModel",
+        description: "The columns slot accepts multiple concrete column models."
+      }
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "TableBlockModel.subModels.columns",
+        message: "Column use values depend on collection field interfaces and runtime table column factories.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "columns",
+            type: "array",
+            allowedUses: import_shared.tableColumnUses
+          },
+          contextRequirements: ["collection fields", "column factories"],
+          unresolvedReason: "runtime-table-columns"
+        }
+      },
+      {
+        kind: "dynamic-children",
+        path: "TableBlockModel.subModels.actions",
+        message: "Collection actions depend on runtime action registries and collection capabilities.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "actions",
+            type: "array",
+            allowedUses: import_shared.collectionActionUses
+          },
+          contextRequirements: ["collection action registry", "collection capabilities"],
+          unresolvedReason: "runtime-table-collection-actions"
+        }
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  tableBlockModelSchemaContribution
+});

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

package/dist/server/flow-schema-contributions/models/TableColumnModel.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 TableColumnModel_exports = {};
+__export(TableColumnModel_exports, {
+  tableColumnModelInternalSchemaContribution: () => tableColumnModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(TableColumnModel_exports);
+var import_shared = require("../shared");
+const tableColumnModelInternalSchemaContribution = {
+  use: "TableColumnModel",
+  title: "Table column",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel"],
+  stepParamsSchema: import_shared.tableColumnStepParamsSchema,
+  subModelSlots: {
+    field: (0, import_shared.createRuntimeFieldModelSlotSchema)("table-column-field")
+  },
+  skeleton: {
+    uid: "todo-table-column-uid",
+    use: "TableColumnModel",
+    stepParams: {
+      fieldSettings: {
+        init: {
+          dataSourceKey: "main",
+          collectionName: "users",
+          fieldPath: "nickname"
+        }
+      },
+      tableColumnSettings: {
+        width: {
+          width: 150
+        }
+      }
+    },
+    subModels: {}
+  },
+  docs: {
+    dynamicHints: [
+      (0, import_shared.createRuntimeFieldDynamicHint)(
+        "TableColumnModel",
+        "TableColumnModel.subModels.field",
+        ["table column bindings", "collection field metadata"],
+        "runtime-table-column-field"
+      )
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  tableColumnModelInternalSchemaContribution
+});

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

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

@@ -0,0 +1,66 @@
+/**
+ * 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 TableCustomColumnModel_exports = {};
+__export(TableCustomColumnModel_exports, {
+  tableCustomColumnModelInternalSchemaContribution: () => tableCustomColumnModelInternalSchemaContribution
+});
+module.exports = __toCommonJS(TableCustomColumnModel_exports);
+var import_shared = require("../shared");
+var _a;
+const tableCustomColumnModelInternalSchemaContribution = {
+  use: "TableCustomColumnModel",
+  title: "Table custom column",
+  source: "official",
+  strict: false,
+  exposure: "internal",
+  suggestedUses: ["TableBlockModel"],
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      tableColumnSettings: (_a = import_shared.tableColumnStepParamsSchema.properties) == null ? void 0 : _a.tableColumnSettings
+    },
+    additionalProperties: true
+  },
+  skeleton: {
+    uid: "todo-custom-column-uid",
+    use: "TableCustomColumnModel",
+    stepParams: {
+      tableColumnSettings: {
+        title: {
+          title: "Custom column"
+        },
+        width: {
+          width: 150
+        }
+      }
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  tableCustomColumnModelInternalSchemaContribution
+});

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

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

@@ -0,0 +1,173 @@
+/**
+ * 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 UpdateRecordActionModel_exports = {};
+__export(UpdateRecordActionModel_exports, {
+  updateRecordActionModelSchemaContribution: () => updateRecordActionModelSchemaContribution
+});
+module.exports = __toCommonJS(UpdateRecordActionModel_exports);
+const confirmStepParamsSchema = {
+  type: "object",
+  properties: {
+    enable: { type: "boolean" },
+    title: { type: "string" },
+    content: { type: "string" }
+  },
+  additionalProperties: false
+};
+const updateRecordActionModelSchemaContribution = {
+  use: "UpdateRecordActionModel",
+  title: "Update record action",
+  source: "official",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      assignSettings: {
+        type: "object",
+        properties: {
+          confirm: confirmStepParamsSchema,
+          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
+              },
+              requestConfig: {
+                type: "object",
+                additionalProperties: true
+              }
+            },
+            additionalProperties: true
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  subModelSlots: {
+    assignForm: {
+      type: "object",
+      use: "AssignFormModel",
+      description: "Internal assignment form used to configure field/value pairs."
+    }
+  },
+  skeleton: {
+    uid: "todo-update-record-action-uid",
+    use: "UpdateRecordActionModel",
+    stepParams: {
+      assignSettings: {
+        confirm: {
+          enable: false,
+          title: "Perform the Update record",
+          content: "Are you sure you want to perform the Update record action?"
+        },
+        assignFieldValues: {
+          assignedValues: {}
+        }
+      }
+    },
+    subModels: {
+      assignForm: {
+        uid: "todo-update-record-assign-form-uid",
+        use: "AssignFormModel"
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "update-record-users",
+      use: "UpdateRecordActionModel",
+      stepParams: {
+        assignSettings: {
+          confirm: {
+            enable: false,
+            title: "Perform the Update record",
+            content: "Are you sure you want to perform the Update record action?"
+          },
+          assignFieldValues: {
+            assignedValues: {}
+          }
+        }
+      },
+      subModels: {
+        assignForm: {
+          uid: "update-record-users-assign-form",
+          use: "AssignFormModel"
+        }
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Record update with explicit confirmation",
+        snippet: {
+          stepParams: {
+            assignSettings: {
+              confirm: {
+                enable: true,
+                title: "Confirm update"
+              }
+            }
+          }
+        }
+      }
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-ui-schema",
+        path: "UpdateRecordActionModel.stepParams.assignSettings.assignFieldValues.assignedValues",
+        message: "Assigned field/value pairs depend on the runtime collection field tree and RunJS-enabled field editors.",
+        "x-flow": {
+          contextRequirements: ["collection fields", "assign form child tree"],
+          unresolvedReason: "runtime-update-record-assigned-values",
+          recommendedFallback: {}
+        }
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  updateRecordActionModelSchemaContribution
+});

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