@nocobase/plugin-custom-variables 2.0.3

package/dist/server/collections/customVariables.js

@@ -0,0 +1,116 @@
+/**
+ * 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 customVariables_exports = {};
+__export(customVariables_exports, {
+  default: () => customVariables_default
+});
+module.exports = __toCommonJS(customVariables_exports);
+var import_database = require("@nocobase/database");
+var customVariables_default = (0, import_database.defineCollection)({
+  name: "customVariables",
+  dumpRules: "required",
+  migrationRules: ["overwrite", "schema-only"],
+  shared: true,
+  autoGenId: false,
+  timestamps: true,
+  createdBy: true,
+  updatedBy: true,
+  logging: true,
+  fields: [
+    {
+      name: "name",
+      type: "string",
+      interface: "input",
+      primaryKey: true,
+      allowNull: false,
+      unique: true,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Variable Name")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      name: "label",
+      type: "string",
+      interface: "input",
+      allowNull: false,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Label")}}',
+        "x-component": "Input",
+        required: true
+      },
+      translation: true
+    },
+    {
+      name: "declaredAt",
+      type: "uid",
+      interface: "input",
+      allowNull: false,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Declared At")}}',
+        "x-component": "Input",
+        "x-disabled": true
+      }
+    },
+    {
+      name: "type",
+      type: "string",
+      interface: "input",
+      allowNull: false,
+      defaultValue: "aggregation",
+      uiSchema: {
+        type: "string",
+        title: '{{t("Variable Type")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      name: "options",
+      type: "json",
+      interface: "json",
+      defaultValue: {},
+      uiSchema: {
+        type: "object",
+        title: '{{t("Options")}}',
+        "x-component": "Input.JSON",
+        description: '{{t("Variable configuration options")}}'
+      }
+      // 聚合选项需包含：
+      // - collection：数据集合
+      // - field：字段名
+      // - aggregator：聚合方法 (count, sum, avg, min, max)
+      // - filter：过滤条件 (可选)
+      // - distinct：是否去重 (可选，默认 false)
+      // - precision：精度 (可选，默认 2，适用于 avg)
+    }
+  ]
+});

package/dist/server/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This program is offered under a commercial license.
+ * For more information, see <https://www.nocobase.com/agreement>
+ */
+import { InstallOptions, Plugin } from '@nocobase/server';
+export declare class PluginCustomVariablesServer extends Plugin {
+    afterAdd(): void;
+    load(): Promise<void>;
+    install(options?: InstallOptions): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginCustomVariablesServer;

package/dist/server/index.js

@@ -0,0 +1,124 @@
+/**
+ * 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 server_exports = {};
+__export(server_exports, {
+  PluginCustomVariablesServer: () => PluginCustomVariablesServer,
+  default: () => server_default
+});
+module.exports = __toCommonJS(server_exports);
+var import_server = require("@nocobase/server");
+var import_mathjs = require("mathjs");
+var import_data_source_manager = require("@nocobase/data-source-manager");
+var import_database = require("@nocobase/database");
+var import_parseFilter = require("./parseFilter");
+const aggregators = {
+  count: "count",
+  sum: "sum",
+  avg: "avg",
+  min: "min",
+  max: "max"
+};
+class PluginCustomVariablesServer extends import_server.Plugin {
+  afterAdd() {
+  }
+  async load() {
+    this.app.resourceManager.registerActionHandler("customVariables:parse", async (ctx, next) => {
+      const { name } = ctx.query;
+      const { filterCtx } = ctx.request.body;
+      if (!name) {
+        return ctx.throw(400, "Variable name is required");
+      }
+      try {
+        const variableRepo = this.app.db.getRepository("customVariables");
+        const variable = await variableRepo.findOne({
+          filter: { name }
+        });
+        if (!variable) {
+          return ctx.throw(404, `Variable '${name}' not found`);
+        }
+        const { type, options } = variable.toJSON();
+        if (type !== "aggregate") {
+          return ctx.throw(400, `Variable '${name}' is not an aggregate variable`);
+        }
+        if (filterCtx && options.params.filter) {
+          options.params.filter = (0, import_parseFilter.parseFilter)(options.params.filter, filterCtx);
+        }
+        const {
+          collection,
+          params: {
+            field,
+            filter,
+            distinct
+          },
+          aggregator,
+          precision = 2
+        } = options;
+        if (!collection || !field || !aggregator || !aggregators[aggregator]) {
+          return ctx.throw(400, "Invalid variable configuration");
+        }
+        const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(collection);
+        const { collectionManager } = this.app.dataSourceManager.dataSources.get(dataSourceName);
+        if (!collectionManager.db) {
+          throw new Error("Aggregate variables can only work with data source of type database");
+        }
+        const repo = collectionManager.getRepository(collectionName);
+        const aggregateOptions = {
+          method: aggregators[aggregator],
+          field,
+          filter,
+          distinct
+        };
+        if (aggregator === "avg") {
+          aggregateOptions["dataType"] = import_database.DataTypes.DOUBLE;
+        }
+        const result = await repo.aggregate(aggregateOptions);
+        const processedResult = (0, import_mathjs.round)(
+          (aggregator === "avg" ? Number(result) : result) || 0,
+          Math.max(0, Math.min(precision, 14))
+        );
+        ctx.body = processedResult;
+      } catch (error) {
+        ctx.throw(500, `Error parsing variable: ${error.message}`);
+      }
+      await next();
+    });
+    this.app.acl.allow("customVariables", ["parse", "create", "update", "destroy", "list", "get"], "loggedIn");
+  }
+  async install(options) {
+  }
+  async afterEnable() {
+  }
+  async afterDisable() {
+  }
+  async remove() {
+  }
+}
+var server_default = PluginCustomVariablesServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginCustomVariablesServer
+});

package/dist/server/parseFilter.d.ts

@@ -0,0 +1 @@
+export declare const parseFilter: (filter: any, ctx: Record<string, any>) => any;

package/dist/server/parseFilter.js

@@ -0,0 +1,44 @@
+/**
+ * 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 parseFilter_exports = {};
+__export(parseFilter_exports, {
+  parseFilter: () => parseFilter
+});
+module.exports = __toCommonJS(parseFilter_exports);
+const parseFilter = (filter, ctx) => {
+  if (typeof filter !== "string") {
+    filter = JSON.stringify(filter);
+  }
+  Object.keys(ctx).forEach((key) => {
+    filter = filter.replaceAll(`"${key}"`, JSON.stringify(ctx[key]));
+  });
+  return JSON.parse(filter);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  parseFilter
+});

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@nocobase/plugin-custom-variables",
+  "displayName": "Custom variables",
+  "displayName.zh-CN": "自定义变量",
+  "description": "Support for adding and using custom variables",
+  "description.zh-CN": "支持新增和使用自定义变量",
+  "version": "2.0.3",
+  "main": "./dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/handbook/custom-variables",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/custom-variables",
+  "nocobase": {
+    "supportedVersions": [
+      "1.x"
+    ],
+    "editionLevel": 0
+  },
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/test": "2.x",
+    "antd-style": "3.x"
+  },
+  "gitHead": "5bcb42fc092f85adb9511c1a351b388bd7aaf66e",
+  "keywords": [
+    "Custom variables"
+  ],
+  "license": "Apache-2.0"
+}

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