@nocobase/plugin-collection-tree 1.3.0-beta

package/LICENSE.txt

@@ -0,0 +1,121 @@
+Updated Date: August 15, 2024
+
+NocoBase License Agreement
+
+NOCOBASE PTE. LTD.，a Singaporean Exempt Private Company Limited by Shares with its principal place of business located at #03-01 ROBINSON 112 ("The Company") https://www.nocobase.com/ issues this License Agreement ("Agreement") to you. You, as an individual or a company ("User"), will be deemed to voluntarily accept all terms of this Agreement by using NocoBase (including but not limited to obtaining NocoBase source code or installation package in any form, installing and using NocoBase, purchasing NocoBase commercial license and services, purchasing NocoBase commercial plugins). If the User does not agree to any term of this Agreement, or cannot accurately understand our interpretation of the relevant terms, please stop using it immediately.
+
+This Agreement applies to any use, quotation, contract, invoice, and all software delivered by the Company. The User and the Company or NocoBase's agents can no longer sign a separate license agreement for the sale and delivery of the software.
+
+The Company reserves the right to formulate and modify this Agreement from time to time as needed. If there are changes, the Company will announce them in the form of website announcements, without further individual notification. The changed Agreement will automatically take effect once it is announced, becoming part of this Agreement.
+
+==============
+1. Definitions
+==============
+
+1.1 "Software" refers to the NocoBase kernel and plugins placed in the same code repository as the kernel, including their source code, installation packages, images, and all their modifications, updates, and upgrades.
+
+1.2 "Marketplace" refers to the marketplace provided by the Company for selling Software plugins and solutions.
+
+1.3 "Commercial Plugin" refers to the paid plugins sold in the Marketplace.
+
+1.4 "Upper Layer Application" refers to a specific business use case application serving internal or external customers of the User, developed based on Software and Commercial Plugins, such as ERP/CRM.
+
+1.5 "Customer" refers to the clients who purchase the User's Upper Layer Application.
+
+1.6 "Third-Party Open Source Software" refers to open source software provided with Software and Commercial Plugins. They are licensed through various published open source software licenses or copyright notices accompanying such software.
+
+===================================
+2. Intellectual Property Protection
+===================================
+
+Except for Third-Party Open Source Software, the Company owns all copyrights, trademark rights, patent rights, trade secrets, and other intellectual property rights of the Software, and has registered and protected them in relevant countries and regions according to the "Paris Convention" or "TRIPS Agreement", ensuring that the intellectual property rights of the Software and Commercial Plugins are internationally recognized and protected.
+
+=============
+3. Disclaimer
+=============
+
+3.1 Users shall not use the Software and Commercial Plugins to engage in activities that violate local laws and regulations, religious beliefs. All legal responsibilities and legal consequences arising from the use of Software and Commercial Plugins shall be borne by the User.
+
+3.2 The Company shall not be liable for any direct, indirect, special, incidental, or consequential damages (including but not limited to loss of profits, business interruption, data loss, or business information disclosure) caused by the User's use of the Software and Commercial Plugins, even if it has been previously informed of the possibility of such damages.
+
+===============
+4. License Type
+===============
+
+4.1 The Software uses a dual license type of AGPL-3.0 Open Source License https://www.gnu.org/licenses/agpl-3..en.htm and Commercial License.
+
+4.2 Commercial Plugins use Commercial License.
+
+================================================
+5. Rights and Obligations of Open Source License
+================================================
+
+5.1 The Software can be used for commercial purposes.
+
+5.2 User can sell plugins developed for the Software in the Marketplace.
+
+5.3 Outside the Marketplace, changes and plugins to the Software developed by User or third parties, and third-party applications developed based on the Software must all be open-sourced under the AGPL-3.0 license.
+
+5.4 It is not allowed to remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface, except for the main LOGO in the upper left corner of the page.
+
+5.5 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+5.6 It is not allowed to provide any form of no-code, zero-code, low-code platform SaaS products to the public using the original or modified Software.
+
+5.7 Comply with all requirements of the AGPL-3.0 agreement.
+
+===============================
+6. Rights of Commercial License
+===============================
+
+6.1 Obtain a permanent commercial license of the Software or Commercial Plugin.
+
+6.2 Get 12 months of upgrade and exclusive technical support.
+
+6.3 The licensed Software and Commercial Plugins can be used for commercial purposes with no restrictions on the number of applications and users.
+
+6.4 Changes and plugins to the Software, and applications integrated with the Software do not need to be open sourced.
+
+6.5 Can remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface.
+
+6.6 Can sell plugins developed for Software in the Marketplace.
+
+6.7 Users with a Professional or Enterprise Edition license can sell Upper Layer Application to their clients.
+
+6.8 Not restricted by the AGPL-3.0 agreement.
+
+6.9 If there are other agreements in the contract for the above rights, the contract agreement shall prevail.
+
+====================================
+7. Obligations of Commercial License
+====================================
+
+7.1 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+7.2 It is not allowed to sell, transfer, lease, share, or give away the Commercial License.
+
+7.3 It is not allowed to provide any form of no-code, zero-code, low-code platform SaaS products to the public using the original or modified Software.
+
+7.4 It is not allowed for Users with a standard license to sell Upper Layer Application to clients without a commercial license.
+
+7.5 It is not allowed to use reverse engineering, decompilation, and other means to try to discover the source code of Commercial Plugins that have not obtained source code license.
+
+7.6 It is not allowed to disclose the source code of Commercial Plugins to any third party.
+
+7.7 It is not allowed to publicly sell plugins developed for Software outside of the Marketplace.
+
+7.8 If there is a violation of the above obligations or the terms of this Agreement, the rights owned by the User will be immediately terminated, the paid fees will not be refunded, and the Company reserves the right to pursue the User's legal responsibility.
+
+7.9 If there are other agreements in the contract for the above obligations, the contract agreement shall prevail.
+
+=============================================================
+8. Legal Jurisdiction, Interpretation, and Dispute Resolution
+=============================================================
+
+8.1 Except for Mainland China, the interpretation, application, and all matters related to this agreement are subject to the jurisdiction of Singapore law.
+
+8.2 Any dispute related to this Agreement should first be resolved through friendly negotiation. If the negotiation fails to resolve the dispute, the dispute should be submitted to the International Chamber of Commerce (ICC) for arbitration. The arbitration venue should be Singapore, conducted in English.
+
+8.3 All terms and conditions of this Agreement shall be deemed enforceable to the maximum extent permitted by applicable law. If any term of this Agreement is deemed invalid by any applicable law, the invalidity of that term does not affect the validity of any other term of this Agreement, and it should be deemed that the invalid term has been modified as much as possible to make it valid and enforceable, or if the term cannot be modified, it should be deemed to have been deleted from this Agreement.
+
+8.4 The arbitration award is final, binding on both parties, and can be enforced in any court with jurisdiction.

package/README.md

@@ -0,0 +1 @@
+# @nocobase/plugin-collection-tree

package/client.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/client';
+export { default } from './dist/client';

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./dist/client/index.js');

package/dist/client/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { Plugin } from '@nocobase/client';
+export declare class PluginCollectionTreeClient extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}
+export default PluginCollectionTreeClient;

package/dist/client/index.js

@@ -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.
+ */
+
+(function(e,n){typeof exports=="object"&&typeof module!="undefined"?n(exports,require("@nocobase/client")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client"],n):(e=typeof globalThis!="undefined"?globalThis:e||self,n(e["@nocobase/plugin-collection-tree"]={},e["@nocobase/client"]))})(this,function(e,n){"use strict";var t=(e,n,o)=>new Promise((c,d)=>{var u=i=>{try{l(o.next(i))}catch(s){d(s)}},f=i=>{try{l(o.throw(i))}catch(s){d(s)}},l=i=>i.done?c(i.value):Promise.resolve(i.value).then(u,f);l((o=o.apply(e,n)).next())});class o extends n.Plugin{afterAdd(){return t(this,null,function*(){})}beforeLoad(){return t(this,null,function*(){})}load(){return t(this,null,function*(){console.log(this.app)})}}e.PluginCollectionTreeClient=o,e.default=o,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/externalVersion.js

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  "@nocobase/client": "1.3.0-beta",
+  "lodash": "4.17.21",
+  "@nocobase/database": "1.3.0-beta",
+  "@nocobase/utils": "1.3.0-beta",
+  "@nocobase/server": "1.3.0-beta",
+  "@nocobase/data-source-manager": "1.3.0-beta",
+  "sequelize": "6.35.2"
+};

package/dist/index.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.
+ */
+export * from './server';
+export { default } from './server';

package/dist/index.js

@@ -0,0 +1,48 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  default: () => import_server.default
+});
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./server"), module.exports);
+var import_server = __toESM(require("./server"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./server")
+});

package/dist/server/adjacency-list-repository.d.ts

@@ -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.
+ */
+import { CountOptions, FindOptions, Repository, FindAndCountOptions, Model } from '@nocobase/database';
+import { TreeCollection } from './tree-collection';
+export declare class AdjacencyListRepository extends Repository {
+    collection: TreeCollection;
+    update(options: any): Promise<any>;
+    buildRootNodeDataMap(nodeData: Model[]): {
+        [key: string]: Set<string>;
+    };
+    buildTree(paths: Model[], options?: FindOptions & {
+        addIndex?: boolean;
+    }, rootNodes?: Model[]): Promise<Model<any, any>[]>;
+    findWithoutFilter(options?: FindOptions & {
+        addIndex?: boolean;
+    }): Promise<any>;
+    countWithoutFilter(options: CountOptions & {
+        raw?: boolean;
+        tree?: boolean;
+    }): Promise<number>;
+    filterAndGetPaths(options?: FindOptions & {
+        addIndex?: boolean;
+    }): Promise<{
+        filterNodes: Model[];
+        paths: Model[];
+    }>;
+    find(options?: FindOptions & {
+        addIndex?: boolean;
+    }): Promise<any>;
+    countByPaths(paths: Model[]): number;
+    count(countOptions?: CountOptions & {
+        raw?: boolean;
+        tree?: boolean;
+    }): Promise<number>;
+    findAndCount(options?: FindAndCountOptions & {
+        filterByTk?: number | string;
+    }): Promise<[Model[], number]>;
+    private addIndex;
+    private queryPathByNode;
+    private queryPathByRoot;
+}

package/dist/server/adjacency-list-repository.js

@@ -0,0 +1,310 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var adjacency_list_repository_exports = {};
+__export(adjacency_list_repository_exports, {
+  AdjacencyListRepository: () => AdjacencyListRepository
+});
+module.exports = __toCommonJS(adjacency_list_repository_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_database = require("@nocobase/database");
+var import_utils = require("@nocobase/utils");
+class AdjacencyListRepository extends import_database.Repository {
+  async update(options) {
+    return super.update({
+      ...options || {},
+      addIndex: false
+    });
+  }
+  buildRootNodeDataMap(nodeData) {
+    const rootPathDataMap = {};
+    for (const node of nodeData) {
+      const rootPk = node.get("rootPk");
+      const pathSet = new Set(
+        node.get("path").split("/").filter((item) => item !== "")
+      );
+      if (rootPathDataMap[rootPk]) {
+        const set = rootPathDataMap[rootPk];
+        for (const path of pathSet) {
+          set.add(path);
+        }
+        rootPathDataMap[rootPk] = set;
+      } else {
+        rootPathDataMap[rootPk] = pathSet;
+      }
+    }
+    return rootPathDataMap;
+  }
+  async buildTree(paths, options = {}, rootNodes) {
+    var _a;
+    const collection = this.collection;
+    const primaryKey = collection.model.primaryKeyAttribute;
+    const foreignKey = collection.treeForeignKey;
+    const childrenKey = ((_a = collection.treeChildrenField) == null ? void 0 : _a.name) ?? "children";
+    const treePathMap = this.buildRootNodeDataMap(paths);
+    if (!rootNodes) {
+      const rootIds = Object.keys(treePathMap);
+      if (!rootIds.length) {
+        this.database.logger.warn("adjacency-list-repository: rootIds is empty");
+        return [];
+      }
+      rootNodes = await super.find({
+        filter: {
+          [primaryKey]: {
+            $in: rootIds
+          }
+        },
+        ...import_lodash.default.omit(options, ["filter", "filterByTk"]),
+        transaction: options.transaction
+      });
+    }
+    const childIds = [];
+    for (const nodeIdSet of Object.values(treePathMap)) {
+      for (const nodeId of nodeIdSet) {
+        childIds.push(nodeId);
+      }
+    }
+    const findChildrenOptions = {
+      ...import_lodash.default.omit(options, ["limit", "offset", "filterByTk"]),
+      filter: {
+        [primaryKey]: childIds
+      }
+    };
+    if (findChildrenOptions.fields) {
+      [primaryKey, foreignKey].forEach((field) => {
+        if (!findChildrenOptions.fields.includes(field)) {
+          findChildrenOptions.fields.push(field);
+        }
+      });
+    }
+    const childInstances = await super.find(findChildrenOptions);
+    const nodeMap = {};
+    childInstances.forEach((node) => {
+      if (!nodeMap[`${node[foreignKey]}`]) {
+        nodeMap[`${node[foreignKey]}`] = [];
+      }
+      nodeMap[`${node[foreignKey]}`].push(node);
+    });
+    function buildTree(rootId) {
+      const children = nodeMap[rootId];
+      if (!children) {
+        return [];
+      }
+      return children.map((child) => {
+        const childrenValues = buildTree(child.id);
+        if (childrenValues.length > 0) {
+          child.setDataValue(childrenKey, childrenValues);
+        }
+        return child;
+      });
+    }
+    for (const root of rootNodes) {
+      const rootId = root[primaryKey];
+      const children = buildTree(rootId);
+      if (children.length > 0) {
+        root.setDataValue(childrenKey, children);
+      }
+    }
+    this.addIndex(rootNodes, childrenKey, options);
+    return rootNodes;
+  }
+  async findWithoutFilter(options = {}) {
+    var _a, _b;
+    const foreignKey = this.collection.treeForeignKey;
+    const rootNodes = await super.find({ ...options, filter: { [foreignKey]: null } });
+    if (!rootNodes.length) {
+      return [];
+    }
+    const collection = this.collection;
+    const primaryKey = collection.model.primaryKeyAttribute;
+    const rootPks = rootNodes.map((node) => node[primaryKey]);
+    const paths = await this.queryPathByRoot({
+      rootPks,
+      dataSourceName: ((_b = (_a = options.context) == null ? void 0 : _a.dataSource) == null ? void 0 : _b.name) ?? "main",
+      transaction: options.transaction
+    });
+    return await this.buildTree(paths, options, rootNodes);
+  }
+  async countWithoutFilter(options) {
+    const foreignKey = this.collection.treeForeignKey;
+    return await super.count({ ...options, filter: { [foreignKey]: null } });
+  }
+  async filterAndGetPaths(options = {}) {
+    var _a, _b;
+    const primaryKey = this.collection.model.primaryKeyAttribute;
+    const filterNodes = await super.find({
+      fields: [primaryKey],
+      ...import_lodash.default.omit(options, ["limit", "offset", "fields"])
+    });
+    if (!filterNodes.length) {
+      return { filterNodes: [], paths: [] };
+    }
+    const filterPks = filterNodes.map((node) => node[primaryKey]);
+    if (!filterPks.length) {
+      this.database.logger.debug("adjacency-list-repository: filterIds is empty");
+      return { filterNodes, paths: [] };
+    }
+    const paths = await this.queryPathByNode({
+      nodePks: filterPks,
+      dataSourceName: ((_b = (_a = options.context) == null ? void 0 : _a.dataSource) == null ? void 0 : _b.name) ?? "main",
+      transaction: options.transaction
+    });
+    return { filterNodes, paths };
+  }
+  async find(options = {}) {
+    if (options.raw || !options.tree) {
+      return await super.find(options);
+    }
+    const primaryKey = this.collection.model.primaryKeyAttribute;
+    if (options.fields && !options.fields.includes(primaryKey)) {
+      options.fields.push(primaryKey);
+    }
+    if (!(0, import_utils.isValidFilter)(options.filter) && !options.filterByTk) {
+      return await this.findWithoutFilter(options);
+    }
+    const { filterNodes, paths } = await this.filterAndGetPaths(options);
+    if (!paths.length) {
+      return filterNodes;
+    }
+    return await this.buildTree(paths, options);
+  }
+  countByPaths(paths) {
+    const rootIds = /* @__PURE__ */ new Set();
+    for (const path of paths) {
+      rootIds.add(path.get("rootPk"));
+    }
+    return rootIds.size;
+  }
+  async count(countOptions) {
+    if (countOptions.raw || !countOptions.tree) {
+      return await super.count(countOptions);
+    }
+    if (!(0, import_utils.isValidFilter)(countOptions.filter) && !countOptions.filterByTk) {
+      return await this.countWithoutFilter(countOptions);
+    }
+    const { paths } = await this.filterAndGetPaths(countOptions);
+    return this.countByPaths(paths);
+  }
+  async findAndCount(options) {
+    options = {
+      ...options,
+      transaction: await this.getTransaction(options.transaction)
+    };
+    if (options.raw || !options.tree) {
+      return await super.findAndCount(options);
+    }
+    if (!(0, import_utils.isValidFilter)(options.filter) && !options.filterByTk) {
+      const count2 = await this.countWithoutFilter(options);
+      const results2 = count2 ? await this.findWithoutFilter(options) : [];
+      return [results2, count2];
+    }
+    const { filterNodes, paths } = await this.filterAndGetPaths(options);
+    if (!paths.length) {
+      return [filterNodes, 0];
+    }
+    const results = await this.buildTree(paths, options);
+    const count = this.countByPaths(paths);
+    return [results, count];
+  }
+  addIndex(treeArray, childrenKey, options) {
+    function traverse(node, index) {
+      if (node._options.includeNames && !node._options.includeNames.includes(childrenKey)) {
+        node._options.includeNames.push(childrenKey);
+      }
+      if (options.addIndex !== false) {
+        node.setDataValue("__index", `${index}`);
+      }
+      const children = node.getDataValue(childrenKey);
+      if (children && children.length === 0) {
+        node.setDataValue(childrenKey, void 0);
+      }
+      if (children && children.length > 0) {
+        children.forEach((child, i) => {
+          traverse(child, `${index}.${childrenKey}.${i}`);
+        });
+      }
+    }
+    treeArray.forEach((tree, i) => {
+      traverse(tree, i);
+    });
+  }
+  async queryPathByNode({
+    nodePks,
+    dataSourceName,
+    transaction
+  }) {
+    const collection = this.collection;
+    const pathTableName = `${dataSourceName}_${collection.name}_path`;
+    const repo = this.database.getRepository(pathTableName);
+    if (repo) {
+      return await repo.find({
+        filter: {
+          nodePk: {
+            $in: nodePks
+          }
+        },
+        transaction
+      });
+    }
+    this.database.logger.warn(`Collection tree path table: ${pathTableName} not found`);
+    return [];
+  }
+  async queryPathByRoot({
+    rootPks,
+    dataSourceName,
+    transaction
+  }) {
+    const collection = this.collection;
+    const pathTableName = `${dataSourceName}_${collection.name}_path`;
+    const repo = this.database.getRepository(pathTableName);
+    if (repo) {
+      return await repo.find({
+        filter: {
+          rootPk: {
+            $in: rootPks
+          }
+        },
+        transaction
+      });
+    }
+    this.database.logger.warn(`Collection tree path table: ${pathTableName} not found`);
+    return [];
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AdjacencyListRepository
+});

package/dist/server/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,42 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

package/dist/server/migrations/20240802141435-collection-tree.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { Migration } from '@nocobase/server';
+import { Model } from '@nocobase/database';
+import { Transaction } from 'sequelize';
+export default class extends Migration {
+    on: string;
+    appVersion: string;
+    up(): Promise<void>;
+    getTreePath(model: Model, path: string, collection: Model, pathCollectionName: string, transaction: Transaction): Promise<string>;
+}

package/dist/server/migrations/20240802141435-collection-tree.js

@@ -0,0 +1,136 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var collection_tree_exports = {};
+__export(collection_tree_exports, {
+  default: () => collection_tree_default
+});
+module.exports = __toCommonJS(collection_tree_exports);
+var import_server = require("@nocobase/server");
+var import_lodash = __toESM(require("lodash"));
+class collection_tree_default extends import_server.Migration {
+  on = "afterLoad";
+  // 'beforeLoad' or 'afterLoad'
+  appVersion = "<=1.3.0-beta";
+  async up() {
+    await this.db.sequelize.transaction(async (transaction) => {
+      const treeCollections = await this.app.db.getRepository("collections").find({
+        appends: ["fields"],
+        filter: {
+          "options.tree": "adjacencyList"
+        },
+        transaction
+      });
+      for (const treeCollection of treeCollections) {
+        const name = `main_${treeCollection.name}_path`;
+        this.app.db.collection({
+          name,
+          autoGenId: false,
+          timestamps: false,
+          fields: [
+            { type: "integer", name: "nodePk" },
+            { type: "string", name: "path", length: 1024 },
+            { type: "integer", name: "rootPk" }
+          ],
+          indexes: [
+            {
+              fields: [{ name: "path", length: 191 }]
+            }
+          ]
+        });
+        const treeExistsInDb = await this.app.db.getCollection(name).existsInDb({ transaction });
+        if (!treeExistsInDb) {
+          await this.app.db.getCollection(name).sync({ transaction });
+          this.app.db.collection({
+            name: treeCollection.name,
+            autoGenId: false,
+            timestamps: false,
+            fields: [
+              { type: "integer", name: "id" },
+              { type: "integer", name: "parentId" }
+            ]
+          });
+          const chunkSize = 1e3;
+          await this.app.db.getRepository(treeCollection.name).chunk({
+            chunkSize,
+            callback: async (rows, options) => {
+              const pathData = [];
+              for (const data of rows) {
+                let path = `/${data.get("id")}`;
+                path = await this.getTreePath(data, path, treeCollection, name, transaction);
+                pathData.push({
+                  nodePk: data.get("id"),
+                  path,
+                  rootPk: path.split("/")[1]
+                });
+              }
+              await this.app.db.getModel(name).bulkCreate(pathData, { transaction });
+            },
+            transaction
+          });
+        }
+      }
+    });
+  }
+  async getTreePath(model, path, collection, pathCollectionName, transaction) {
+    if (model.get("parentId") !== null) {
+      const parent = await this.app.db.getRepository(collection.name).findOne({
+        filter: {
+          id: model.get("parentId")
+        },
+        transaction
+      });
+      if (parent && parent.get("parentId") !== model.get("id")) {
+        path = `/${parent.get("id")}${path}`;
+        const collectionTreePath = this.app.db.getCollection(pathCollectionName);
+        const nodePkColumnName = collectionTreePath.getField("nodePk").columnName();
+        const parentPathData = await this.app.db.getRepository(pathCollectionName).findOne({
+          filter: {
+            [nodePkColumnName]: parent.get("id")
+          },
+          transaction
+        });
+        const parentPath = import_lodash.default.get(parentPathData, "path", null);
+        if (parentPath == null) {
+          path = await this.getTreePath(parent, path, collection, pathCollectionName, transaction);
+        } else {
+          path = `${parentPath}/${model.get("id")}`;
+        }
+      }
+    }
+    return path;
+  }
+}

package/dist/server/plugin.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { Plugin } from '@nocobase/server';
+declare class PluginCollectionTreeServer extends Plugin {
+    beforeLoad(): Promise<void>;
+    private defineTreePathCollection;
+    private getTreePath;
+}
+export default PluginCollectionTreeServer;

package/dist/server/plugin.js

@@ -0,0 +1,198 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  default: () => plugin_default
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_server = require("@nocobase/server");
+var import_data_source_manager = require("@nocobase/data-source-manager");
+var import_lodash = __toESM(require("lodash"));
+var import_tree_collection = require("./tree-collection");
+const getFilterTargetKey = (model) => {
+  return model.constructor.collection.filterTargetKey;
+};
+class PluginCollectionTreeServer extends import_server.Plugin {
+  async beforeLoad() {
+    const condition = (options) => {
+      return options.tree;
+    };
+    this.app.db.collectionFactory.registerCollectionType(import_tree_collection.TreeCollection, {
+      condition
+    });
+    this.app.dataSourceManager.afterAddDataSource((dataSource) => {
+      const collectionManager = dataSource.collectionManager;
+      if (collectionManager instanceof import_data_source_manager.SequelizeCollectionManager) {
+        collectionManager.db.on("afterDefineCollection", (collection) => {
+          var _a;
+          if (!condition(collection.options)) {
+            return;
+          }
+          const name = `${dataSource.name}_${collection.name}_path`;
+          const parentForeignKey = ((_a = collection.treeParentField) == null ? void 0 : _a.foreignKey) || "parentId";
+          this.defineTreePathCollection(name);
+          collectionManager.db.on(`${collection.name}.afterSync`, async ({ transaction }) => {
+            await this.db.getCollection(name).sync({ transaction });
+          });
+          this.db.on(`${collection.name}.afterCreate`, async (model, options) => {
+            const { transaction } = options;
+            const tk = getFilterTargetKey(model);
+            let path = `/${model.get(tk)}`;
+            path = await this.getTreePath(model, path, collection, name, transaction);
+            const rootPk = path.split("/")[1];
+            await this.app.db.getRepository(name).create({
+              values: {
+                nodePk: model.get(tk),
+                path,
+                rootPk: rootPk ? Number(rootPk) : null
+              },
+              transaction
+            });
+          });
+          this.db.on(`${collection.name}.afterUpdate`, async (model, options) => {
+            const tk = getFilterTargetKey(model);
+            if (!(model._changed.has(tk) || model._changed.has(parentForeignKey))) {
+              return;
+            }
+            const { transaction } = options;
+            let path = `/${model.get(tk)}`;
+            path = await this.getTreePath(model, path, collection, name, transaction);
+            const collectionTreePath = this.db.getCollection(name);
+            const nodePkColumnName = collectionTreePath.getField("nodePk").columnName();
+            const pathData = await this.app.db.getRepository(name).findOne({
+              filter: {
+                [nodePkColumnName]: model.get(tk)
+              },
+              transaction
+            });
+            const relatedNodes = await this.app.db.getRepository(name).find({
+              filter: {
+                path: {
+                  $startsWith: `${pathData.get("path")}`
+                }
+              },
+              transaction
+            });
+            const rootPk = path.split("/")[1];
+            for (const node of relatedNodes) {
+              await this.app.db.getRepository(name).update({
+                values: {
+                  path: node.get("path").replace(`${pathData.get("path")}`, path),
+                  rootPk: rootPk ? Number(rootPk) : null
+                },
+                filter: {
+                  [nodePkColumnName]: node.get("nodePk")
+                },
+                transaction
+              });
+            }
+          });
+          this.db.on(`${collection.name}.afterDestroy`, async (model, options) => {
+            const tk = getFilterTargetKey(model);
+            await this.app.db.getRepository(name).destroy({
+              filter: {
+                nodePk: model.get(tk)
+              },
+              transaction: options.transaction
+            });
+          });
+        });
+      }
+    });
+    this.db.on("collections.afterDestroy", async (collection, { transaction }) => {
+      const name = `main_${collection.get("name")}_path`;
+      if (!condition(collection.options)) {
+        return;
+      }
+      const collectionTree = this.db.getCollection(name);
+      if (collectionTree) {
+        await this.db.getCollection(name).removeFromDb({ transaction });
+      }
+    });
+  }
+  async defineTreePathCollection(name) {
+    this.db.collection({
+      name,
+      autoGenId: false,
+      timestamps: false,
+      fields: [
+        { type: "integer", name: "nodePk" },
+        { type: "string", name: "path", length: 1024 },
+        { type: "integer", name: "rootPk" }
+      ],
+      indexes: [
+        {
+          fields: [{ name: "path", length: 191 }]
+        }
+      ]
+    });
+  }
+  async getTreePath(model, path, collection, pathCollectionName, transaction) {
+    var _a;
+    const tk = getFilterTargetKey(model);
+    const parentForeignKey = ((_a = collection.treeParentField) == null ? void 0 : _a.foreignKey) || "parentId";
+    if (model.get(parentForeignKey) && model.get(parentForeignKey) !== null) {
+      const parent = await this.app.db.getRepository(collection.name).findOne({
+        filter: {
+          [tk]: model.get(parentForeignKey)
+        },
+        transaction
+      });
+      if (parent && parent.get(parentForeignKey) !== model.get(tk)) {
+        path = `/${parent.get(tk)}${path}`;
+        if (parent.get(parentForeignKey) !== null) {
+          const collectionTreePath = this.app.db.getCollection(pathCollectionName);
+          const nodePkColumnName = collectionTreePath.getField("nodePk").columnName();
+          const parentPathData = await this.app.db.getRepository(pathCollectionName).findOne({
+            filter: {
+              [nodePkColumnName]: parent.get(tk)
+            },
+            transaction
+          });
+          const parentPath = import_lodash.default.get(parentPathData, "path", null);
+          if (parentPath == null) {
+            path = await this.getTreePath(parent, path, collection, pathCollectionName, transaction);
+          } else {
+            path = `${parentPath}/${model.get(tk)}`;
+          }
+        }
+      }
+    }
+    return path;
+  }
+}
+var plugin_default = PluginCollectionTreeServer;

package/dist/server/tree-collection.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 { Collection } from '@nocobase/database';
+export declare class TreeCollection extends Collection {
+    setRepository(): void;
+    get treeForeignKey(): any;
+}

package/dist/server/tree-collection.js

@@ -0,0 +1,46 @@
+/**
+ * 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 tree_collection_exports = {};
+__export(tree_collection_exports, {
+  TreeCollection: () => TreeCollection
+});
+module.exports = __toCommonJS(tree_collection_exports);
+var import_database = require("@nocobase/database");
+var import_adjacency_list_repository = require("./adjacency-list-repository");
+class TreeCollection extends import_database.Collection {
+  setRepository() {
+    this.repository = new import_adjacency_list_repository.AdjacencyListRepository(this);
+  }
+  get treeForeignKey() {
+    var _a;
+    return ((_a = this.treeParentField) == null ? void 0 : _a.options.foreignKey) || "parent";
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TreeCollection
+});

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@nocobase/plugin-collection-tree",
+  "version": "1.3.0-beta",
+  "displayName": "Collection: Tree",
+  "displayName.zh-CN": "数据表：树",
+  "description": "Provides tree collection template",
+  "description.zh-CN": "提供树数据表模板",
+  "keywords": [
+    "Collections"
+  ],
+  "main": "dist/server/index.js",
+  "peerDependencies": {
+    "@nocobase/client": "1.x",
+    "@nocobase/server": "1.x",
+    "@nocobase/test": "1.x"
+  },
+  "gitHead": "175a86dcc41577bff4f94ae614ebe778fd532f3f"
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');