@nocobase/plugin-field-sort 1.5.0-alpha.1

package/dist/server/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 __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,
+  move: () => import_action.move
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));
+var import_action = require("./action");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  move
+});

package/dist/server/plugin.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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';
+export declare class PluginFieldSortServer extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    install(): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginFieldSortServer;

package/dist/server/plugin.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 plugin_exports = {};
+__export(plugin_exports, {
+  PluginFieldSortServer: () => PluginFieldSortServer,
+  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_sort_field = require("./sort-field");
+var import_action = require("./action");
+class PluginFieldSortServer extends import_server.Plugin {
+  async afterAdd() {
+  }
+  async beforeLoad() {
+    const { lockManager } = this.app;
+    class SortFieldClass extends import_sort_field.SortField {
+    }
+    SortFieldClass.lockManager = lockManager;
+    this.app.db.registerFieldTypes({
+      sort: SortFieldClass
+    });
+    this.app.dataSourceManager.beforeAddDataSource((dataSource) => {
+      if (dataSource.collectionManager instanceof import_data_source_manager.SequelizeCollectionManager) {
+        dataSource.resourceManager.registerActionHandlers({ move: import_action.move });
+      }
+    });
+  }
+  async load() {
+  }
+  async install() {
+  }
+  async afterEnable() {
+  }
+  async afterDisable() {
+  }
+  async remove() {
+  }
+}
+var plugin_default = PluginFieldSortServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginFieldSortServer
+});

package/dist/server/sort-field.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { DataTypes } from 'sequelize';
+import { BaseColumnFieldOptions, Field } from '@nocobase/database';
+import { LockManager } from '@nocobase/lock-manager';
+export declare class SortField extends Field {
+    static lockManager: LockManager;
+    get dataType(): DataTypes.BigIntDataTypeConstructor;
+    setSortValue: (instance: any, options: any) => Promise<void>;
+    onScopeChange: (instance: any, options: any) => Promise<void>;
+    initRecordsSortValue: (options: any) => Promise<void>;
+    bind(): void;
+    unbind(): void;
+}
+export interface SortFieldOptions extends BaseColumnFieldOptions {
+    type: 'sort';
+    scopeKey?: string;
+}

package/dist/server/sort-field.js

@@ -0,0 +1,197 @@
+/**
+ * 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 sort_field_exports = {};
+__export(sort_field_exports, {
+  SortField: () => SortField
+});
+module.exports = __toCommonJS(sort_field_exports);
+var import_lodash = require("lodash");
+var import_sequelize = require("sequelize");
+var import_database = require("@nocobase/database");
+class SortField extends import_database.Field {
+  static lockManager;
+  get dataType() {
+    return import_sequelize.DataTypes.BIGINT;
+  }
+  setSortValue = async (instance, options) => {
+    const { name, scopeKey } = this.options;
+    const { model } = this.context.collection;
+    if ((0, import_lodash.isNumber)(instance.get(name)) && instance._previousDataValues[scopeKey] == instance[scopeKey]) {
+      return;
+    }
+    const where = {};
+    if (scopeKey) {
+      const value = instance.get(scopeKey);
+      if (value !== void 0 && value !== null) {
+        where[scopeKey] = value;
+      }
+    }
+    await this.constructor.lockManager.runExclusive(
+      this.context.collection.name,
+      async () => {
+        const max = await model.max(name, { ...options, where });
+        const newValue = (max || 0) + 1;
+        instance.set(name, newValue);
+      },
+      2e3
+    );
+  };
+  onScopeChange = async (instance, options) => {
+    const { scopeKey } = this.options;
+    if (scopeKey && !instance.isNewRecord && instance._previousDataValues[scopeKey] != instance[scopeKey]) {
+      await this.setSortValue(instance, options);
+    }
+  };
+  initRecordsSortValue = async (options) => {
+    const { transaction } = options;
+    const orderField = (() => {
+      const model = this.collection.model;
+      if (model.primaryKeyAttribute) {
+        return model.primaryKeyAttribute;
+      }
+      if (model.rawAttributes["createdAt"]) {
+        return model.rawAttributes["createdAt"].field;
+      }
+      throw new Error(`can not find order key for collection ${this.collection.name}`);
+    })();
+    const needInit = async (scopeKey2 = null, scopeValue = null) => {
+      const filter = {};
+      if (scopeKey2 && scopeValue) {
+        filter[scopeKey2] = scopeValue;
+      }
+      const totalCount = await this.collection.repository.count({
+        filter,
+        transaction
+      });
+      const emptyCount = await this.collection.repository.count({
+        filter: {
+          [this.name]: null,
+          ...filter
+        },
+        transaction
+      });
+      return emptyCount === totalCount && emptyCount > 0;
+    };
+    const doInit = async (scopeKey2 = null, scopeValue = null) => {
+      const queryInterface = this.collection.db.sequelize.getQueryInterface();
+      if (scopeKey2) {
+        const scopeAttribute = this.collection.model.rawAttributes[scopeKey2];
+        if (!scopeAttribute) {
+          throw new Error(`can not find scope field ${scopeKey2} for collection ${this.collection.name}`);
+        }
+        scopeKey2 = scopeAttribute.field;
+      }
+      const quotedOrderField = queryInterface.quoteIdentifier(orderField);
+      const sortColumnName = queryInterface.quoteIdentifier(this.collection.model.rawAttributes[this.name].field);
+      let sql;
+      const whereClause = scopeKey2 && scopeValue ? (() => {
+        const filteredScopeValue = scopeValue.filter((v) => v !== null);
+        if (filteredScopeValue.length === 0) {
+          return "";
+        }
+        const initialClause = `
+  WHERE ${queryInterface.quoteIdentifier(scopeKey2)} IN (${filteredScopeValue.map((v) => `'${v}'`).join(", ")})`;
+        const nullCheck = scopeValue.includes(null) ? ` OR ${queryInterface.quoteIdentifier(scopeKey2)} IS NULL` : "";
+        return initialClause + nullCheck;
+      })() : "";
+      if (this.collection.db.inDialect("postgres")) {
+        sql = `
+    UPDATE ${this.collection.quotedTableName()}
+    SET ${sortColumnName} = ordered_table.new_sequence_number
+    FROM (
+      SELECT *, ROW_NUMBER() OVER (${scopeKey2 ? `PARTITION BY ${queryInterface.quoteIdentifier(scopeKey2)}` : ""} ORDER BY ${quotedOrderField}) AS new_sequence_number
+      FROM ${this.collection.quotedTableName()}
+      ${whereClause}
+    ) AS ordered_table
+    WHERE ${this.collection.quotedTableName()}.${quotedOrderField} = ordered_table.${quotedOrderField};
+  `;
+      } else if (this.collection.db.inDialect("sqlite")) {
+        sql = `
+    UPDATE ${this.collection.quotedTableName()}
+    SET ${sortColumnName} = (
+      SELECT new_sequence_number
+      FROM (
+        SELECT *, ROW_NUMBER() OVER (${scopeKey2 ? `PARTITION BY ${queryInterface.quoteIdentifier(scopeKey2)}` : ""} ORDER BY ${quotedOrderField}) AS new_sequence_number
+        FROM ${this.collection.quotedTableName()}
+        ${whereClause}
+      ) AS ordered_table
+      WHERE ${this.collection.quotedTableName()}.${quotedOrderField} = ordered_table.${quotedOrderField}
+    );
+  `;
+      } else if (this.collection.db.inDialect("mysql") || this.collection.db.inDialect("mariadb")) {
+        sql = `
+    UPDATE ${this.collection.quotedTableName()}
+    JOIN (
+      SELECT *, ROW_NUMBER() OVER (${scopeKey2 ? `PARTITION BY ${queryInterface.quoteIdentifier(scopeKey2)}` : ""} ORDER BY ${quotedOrderField}) AS new_sequence_number
+      FROM ${this.collection.quotedTableName()}
+      ${whereClause}
+    ) AS ordered_table ON ${this.collection.quotedTableName()}.${quotedOrderField} = ordered_table.${quotedOrderField}
+    SET ${this.collection.quotedTableName()}.${sortColumnName} = ordered_table.new_sequence_number;
+  `;
+      }
+      await this.collection.db.sequelize.query(sql, {
+        transaction
+      });
+    };
+    const scopeKey = this.options.scopeKey;
+    if (scopeKey) {
+      const scopeKeyColumn = this.collection.model.rawAttributes[scopeKey].field;
+      const groups = await this.collection.model.findAll({
+        attributes: [[import_sequelize.Sequelize.fn("DISTINCT", import_sequelize.Sequelize.col(scopeKeyColumn)), scopeKey]],
+        raw: true,
+        transaction
+      });
+      const needInitGroups = [];
+      for (const group of groups) {
+        if (await needInit(scopeKey, group[scopeKey])) {
+          needInitGroups.push(group[scopeKey]);
+        }
+      }
+      if (needInitGroups.length > 0) {
+        await doInit(scopeKey, needInitGroups);
+      }
+    } else if (await needInit()) {
+      await doInit();
+    }
+  };
+  bind() {
+    super.bind();
+    this.on("afterSync", this.initRecordsSortValue);
+    this.on("beforeUpdate", this.onScopeChange);
+    this.on("beforeCreate", this.setSortValue);
+  }
+  unbind() {
+    super.unbind();
+    this.off("beforeUpdate", this.onScopeChange);
+    this.off("beforeCreate", this.setSortValue);
+    this.off("afterSync", this.initRecordsSortValue);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SortField
+});

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@nocobase/plugin-field-sort",
+  "version": "1.5.0-alpha.1",
+  "main": "dist/server/index.js",
+  "peerDependencies": {
+    "@nocobase/actions": "1.x",
+    "@nocobase/client": "1.x",
+    "@nocobase/database": "1.x",
+    "@nocobase/lock-manager": "1.x",
+    "@nocobase/server": "1.x",
+    "@nocobase/test": "1.x",
+    "lodash": "4.17.21",
+    "sequelize": "^6.26.0"
+  },
+  "gitHead": "abe58fad69534a13c2502a47da86425a597c3ba3"
+}

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');