@nocobase/evaluators 0.9.1-alpha.1

package/client.d.ts

@@ -0,0 +1,3 @@
+// @ts-nocheck
+export * from './lib/client';
+export { default } from './lib/client';

package/client.js

@@ -0,0 +1,12 @@
+var _useExportClient = require("./lib/client");
+
+Object.keys(_useExportClient).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _useExportClient[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useExportClient[key];
+    }
+  });
+});

package/lib/client/engines/formulajs.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    label: string;
+    tooltip: string;
+    link: string;
+    evaluate: any;
+};
+export default _default;

package/lib/client/engines/formulajs.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("../../utils");
+
+var _formulajs = _interopRequireDefault(require("../../utils/formulajs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = {
+  label: 'Formula.js',
+  tooltip: '{{t("Formula.js supports most Microsoft Excel formula functions.")}}',
+  link: 'https://formulajs.info/functions/',
+  evaluate: _utils.evaluate.bind(_formulajs.default)
+};
+exports.default = _default;

package/lib/client/engines/mathjs.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    label: string;
+    tooltip: string;
+    link: string;
+    evaluate: any;
+};
+export default _default;

package/lib/client/engines/mathjs.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("../../utils");
+
+var _mathjs = _interopRequireDefault(require("../../utils/mathjs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = {
+  label: 'Math.js',
+  tooltip: `{{t('Math.js comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types')}}`,
+  link: "https://mathjs.org/",
+  evaluate: _utils.evaluate.bind(_mathjs.default)
+};
+exports.default = _default;

package/lib/client/index.d.ts

@@ -0,0 +1,12 @@
+import { Registry } from '@nocobase/utils/client';
+export interface Evaluator {
+    label: string;
+    tooltip?: string;
+    link?: string;
+    evaluate(exp: string, scope?: {
+        [key: string]: any;
+    }): any;
+}
+export declare const evaluators: Registry<Evaluator>;
+export declare const renderReference: (key: string) => JSX.Element;
+export default evaluators;

package/lib/client/index.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.renderReference = exports.evaluators = exports.default = void 0;
+
+function _react() {
+  const data = _interopRequireDefault(require("react"));
+
+  _react = function _react() {
+    return data;
+  };
+
+  return data;
+}
+
+function _css() {
+  const data = require("@emotion/css");
+
+  _css = function _css() {
+    return data;
+  };
+
+  return data;
+}
+
+function _client() {
+  const data = require("@nocobase/client");
+
+  _client = function _client() {
+    return data;
+  };
+
+  return data;
+}
+
+function _client2() {
+  const data = require("@nocobase/utils/client");
+
+  _client2 = function _client2() {
+    return data;
+  };
+
+  return data;
+}
+
+var _mathjs = _interopRequireDefault(require("./engines/mathjs"));
+
+var _formulajs = _interopRequireDefault(require("./engines/formulajs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const evaluators = new (_client2().Registry)();
+exports.evaluators = evaluators;
+evaluators.register('math.js', _mathjs.default);
+evaluators.register('formula.js', _formulajs.default);
+
+const renderReference = key => {
+  const engine = evaluators.get(key);
+
+  if (!engine) {
+    return null;
+  }
+
+  return engine.link ? _react().default.createElement(_react().default.Fragment, null, _react().default.createElement("span", {
+    className: (0, _css().css)`
+          &:after {
+            content: ':';
+          }
+          & + a {
+            margin-left: .25em;
+          }
+        `
+  }, _client().i18n.t('Syntax references')), _react().default.createElement("a", {
+    href: engine.link,
+    target: "_blank"
+  }, engine.label)) : null;
+};
+
+exports.renderReference = renderReference;
+var _default = evaluators;
+exports.default = _default;

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {};
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _server.default;
+  }
+});
+
+var _server = _interopRequireWildcard(require("./server"));
+
+Object.keys(_server).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _server[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _server[key];
+    }
+  });
+});
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib/server/index.d.ts

@@ -0,0 +1,5 @@
+import { Registry } from "@nocobase/utils";
+import { Evaluator } from '../utils';
+export { Evaluator } from '../utils';
+export declare const evaluators: Registry<Evaluator>;
+export default evaluators;

package/lib/server/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.evaluators = exports.default = void 0;
+
+function _utils() {
+  const data = require("@nocobase/utils");
+
+  _utils = function _utils() {
+    return data;
+  };
+
+  return data;
+}
+
+var _utils2 = require("../utils");
+
+var _mathjs = _interopRequireDefault(require("../utils/mathjs"));
+
+var _formulajs = _interopRequireDefault(require("../utils/formulajs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const evaluators = new (_utils().Registry)();
+exports.evaluators = evaluators;
+evaluators.register('math.js', _utils2.evaluate.bind(_mathjs.default));
+evaluators.register('formula.js', _utils2.evaluate.bind(_formulajs.default));
+var _default = evaluators;
+exports.default = _default;

package/lib/utils/formulajs.d.ts

@@ -0,0 +1 @@
+export default function (expression: string, scope?: {}): any;

package/lib/utils/formulajs.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+
+function functions() {
+  const data = _interopRequireWildcard(require("@formulajs/formulajs"));
+
+  functions = function functions() {
+    return data;
+  };
+
+  return data;
+}
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const fnNames = Object.keys(functions()).filter(key => key !== 'default');
+const fns = fnNames.map(key => functions()[key]);
+
+function _default(expression, scope = {}) {
+  const fn = new Function(...fnNames, ...Object.keys(scope), `return ${expression}`);
+  const result = fn(...fns, ...Object.values(scope));
+
+  if (typeof result === 'number') {
+    if (Number.isNaN(result) || !Number.isFinite(result)) {
+      return null;
+    }
+
+    return functions().ROUND(result, 9);
+  }
+
+  return result;
+}

package/lib/utils/index.d.ts

@@ -0,0 +1,5 @@
+export declare type Scope = {
+    [key: string]: any;
+};
+export declare type Evaluator = (expression: string, scope?: Scope) => any;
+export declare function evaluate(this: Evaluator, expression: string, scope?: Scope): any;

package/lib/utils/index.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.evaluate = evaluate;
+
+function _lodash() {
+  const data = require("lodash");
+
+  _lodash = function _lodash() {
+    return data;
+  };
+
+  return data;
+}
+
+function appendArrayColumn(scope, key) {
+  const paths = key.split('.');
+  let data = scope;
+
+  for (let p = 0; p < paths.length && data != null; p++) {
+    const path = paths[p];
+    const isIndex = path.match(/^\d+$/);
+
+    if (Array.isArray(data) && !isIndex && !data[path]) {
+      data[path] = data.map(item => item[path]);
+    }
+
+    data = data[path];
+  }
+}
+
+function replaceNumberIndex(path, scope) {
+  const segments = path.split('.');
+  const paths = [];
+
+  for (let i = 0; i < segments.length; i++) {
+    const p = segments[i];
+
+    if (p.match(/^\d+$/)) {
+      paths.push(Array.isArray((0, _lodash().get)(scope, segments.slice(0, i))) ? `[${p}]` : `["${p}"]`);
+    } else {
+      if (i) {
+        paths.push('.', p);
+      } else {
+        paths.push(p);
+      }
+    }
+  }
+
+  return paths.join('');
+}
+
+function evaluate(expression, scope = {}) {
+  const context = (0, _lodash().cloneDeep)(scope);
+  const exp = expression.trim().replace(/{{\s*([^{}]+)\s*}}/g, (_, v) => {
+    appendArrayColumn(context, v);
+    const item = (0, _lodash().get)(context, v);
+
+    if (item == null) {
+      return 'null';
+    }
+
+    if (typeof item === 'function') {
+      const result = item();
+      return typeof result === 'string' ? `'${result.replace(/'/g, "\\'")}'` : result;
+    }
+
+    return replaceNumberIndex(v, context);
+  });
+  return this(exp, context);
+}

package/lib/utils/mathjs.d.ts

@@ -0,0 +1 @@
+export default function (expression: string, scope?: {}): any;

package/lib/utils/mathjs.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+
+function math() {
+  const data = _interopRequireWildcard(require("mathjs"));
+
+  math = function math() {
+    return data;
+  };
+
+  return data;
+}
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _default(expression, scope = {}) {
+  const result = math().evaluate(expression, scope);
+
+  if (typeof result === 'number') {
+    if (Number.isNaN(result) || !Number.isFinite(result)) {
+      return null;
+    }
+
+    return math().round(result, 9);
+  }
+
+  return result;
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@nocobase/evaluators",
+  "version": "0.9.1-alpha.1",
+  "description": "",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@formulajs/formulajs": "4.2.0",
+    "@nocobase/utils": "0.9.1-alpha.1",
+    "mathjs": "^10.6.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nocobase/nocobase.git",
+    "directory": "packages/evaluators"
+  },
+  "gitHead": "56cb184b00dc383b853015d525bf6e79dea92169"
+}

package/server.d.ts

@@ -0,0 +1,3 @@
+// @ts-nocheck
+export * from './lib/server';
+export { default } from './lib/server';

package/server.js

@@ -0,0 +1,12 @@
+var _useExportServer = require("./lib/server");
+
+Object.keys(_useExportServer).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _useExportServer[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useExportServer[key];
+    }
+  });
+});

package/src/client/engines/formulajs.ts

@@ -0,0 +1,11 @@
+import { evaluate } from '../../utils';
+import formulajs from '../../utils/formulajs';
+
+
+
+export default {
+  label: 'Formula.js',
+  tooltip: '{{t("Formula.js supports most Microsoft Excel formula functions.")}}',
+  link: 'https://formulajs.info/functions/',
+  evaluate: evaluate.bind(formulajs)
+};

package/src/client/engines/mathjs.ts

@@ -0,0 +1,11 @@
+import { evaluate } from "../../utils";
+import mathjs from "../../utils/mathjs";
+
+
+
+export default {
+  label: 'Math.js',
+  tooltip: `{{t('Math.js comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types')}}`,
+  link: "https://mathjs.org/",
+  evaluate: evaluate.bind(mathjs)
+};

package/src/client/index.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import { css } from '@emotion/css';
+
+import { i18n } from '@nocobase/client';
+import { Registry } from '@nocobase/utils/client';
+
+import mathjs from './engines/mathjs';
+import formulajs from './engines/formulajs';
+
+export interface Evaluator {
+  label: string;
+  tooltip?: string;
+  link?: string;
+  evaluate(exp: string, scope?: { [key: string]: any }): any;
+}
+
+export const evaluators = new Registry<Evaluator>();
+
+evaluators.register('math.js', mathjs);
+evaluators.register('formula.js', formulajs);
+
+export const renderReference = (key: string) => {
+  const engine = evaluators.get(key);
+  if (!engine) {
+    return null;
+  }
+
+  return engine.link
+    ? (
+      <>
+        <span className={css`
+          &:after {
+            content: ':';
+          }
+          & + a {
+            margin-left: .25em;
+          }
+        `}>
+          {i18n.t('Syntax references')}
+        </span>
+        <a href={engine.link} target="_blank">{engine.label}</a>
+      </>
+    )
+    : null
+};
+
+export default evaluators;

package/src/index.ts

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

package/src/server/__tests__/index.test.ts

@@ -0,0 +1,42 @@
+import evaluators from '..';
+
+const mathEval = evaluators.get('math.js');
+const formulaEval = evaluators.get('formula.js');
+
+
+
+describe('evaluate', () => {
+  it('reference null or undefined', () => {
+    const result = formulaEval('{{a.b}}', { a: null });
+    expect(result).toBeNull();
+  });
+
+  it('function result string with quote', () => {
+    const result = formulaEval('{{a}}', { a() { return "I'm done." } });
+    expect(result).toBe("I'm done.");
+  });
+
+  it('function result number', () => {
+    const result = formulaEval('{{a}}', { a() { return 1 } });
+    expect(result).toBe(1);
+  });
+
+  it('number path to array item 0 (math.js)', () => {
+    expect(() => mathEval('{{a.0}}', { a: [1, 2, 3] })).toThrow();
+  });
+
+  it('number path to array item 1 (math.js)', () => {
+    const result = mathEval('{{a}}[1]', { a: [1, 2, 3] });
+    expect(result).toBe(1);
+  });
+
+  it('number path to array item 1 (math.js)', () => {
+    const result = mathEval('{{a.1}}', { a: [1, 2, 3] });
+    expect(result).toBe(1);
+  });
+
+  it('number path to object member 0 (math.js)', () => {
+    const result = mathEval('{{a.1}}', { a: { 1: 1 } });
+    expect(result).toBe(1);
+  });
+});

package/src/server/index.ts

@@ -0,0 +1,16 @@
+import { Registry } from "@nocobase/utils";
+
+import { evaluate, Evaluator } from '../utils';
+import mathjs from "../utils/mathjs";
+import formulajs from "../utils/formulajs";
+
+
+
+export { Evaluator } from '../utils';
+
+export const evaluators = new Registry<Evaluator>();
+
+evaluators.register('math.js', evaluate.bind(mathjs));
+evaluators.register('formula.js', evaluate.bind(formulajs));
+
+export default evaluators;

package/src/utils/formulajs.ts

@@ -0,0 +1,18 @@
+import * as functions from '@formulajs/formulajs';
+
+
+
+const fnNames = Object.keys(functions).filter(key => key !== 'default');
+const fns = fnNames.map(key => functions[key]);
+
+export default function(expression: string, scope = {}) {
+  const fn = new Function(...fnNames, ...Object.keys(scope), `return ${expression}`);
+  const result = fn(...fns, ...Object.values(scope));
+  if (typeof result === 'number') {
+    if (Number.isNaN(result) || !Number.isFinite(result)) {
+      return null;
+    }
+    return functions.ROUND(result, 9);
+  }
+  return result;
+}

package/src/utils/index.ts

@@ -0,0 +1,61 @@
+import { get, cloneDeep } from "lodash";
+
+
+
+export type Scope = { [key: string]: any };
+
+export type Evaluator = (expression: string, scope?: Scope) => any;
+
+function appendArrayColumn(scope, key) {
+  const paths = key.split('.');
+  let data = scope;
+  for (let p = 0; p < paths.length && data != null; p++) {
+    const path = paths[p];
+    const isIndex = path.match(/^\d+$/);
+    if (Array.isArray(data) && !isIndex && !data[path]) {
+      data[path] = data.map(item => item[path]);
+    }
+    data = data[path];
+  }
+}
+
+function replaceNumberIndex(path: string, scope: Scope): string {
+  const segments = path.split('.');
+  const paths = [];
+
+  for (let i = 0; i < segments.length; i++) {
+    const p = segments[i];
+    if (p.match(/^\d+$/)) {
+      paths.push(Array.isArray(get(scope, segments.slice(0, i))) ? `[${p}]` : `["${p}"]`);
+    } else {
+      if (i) {
+        paths.push('.', p);
+      } else {
+        paths.push(p);
+      }
+    }
+  }
+
+  return paths.join('');
+}
+
+export function evaluate(this: Evaluator, expression: string, scope: Scope = {}) {
+  const context = cloneDeep(scope);
+  const exp = expression.trim().replace(/{{\s*([^{}]+)\s*}}/g, (_, v) => {
+    appendArrayColumn(context, v);
+
+    const item = get(context, v);
+
+    if (item == null) {
+      return 'null';
+    }
+
+    if (typeof item === 'function') {
+      const result = item();
+      return typeof result === 'string' ? `'${result.replace(/'/g, "\\'")}'` : result;
+    }
+
+    return replaceNumberIndex(v, context);
+  });
+  return this(exp, context);
+}

package/src/utils/mathjs.ts

@@ -0,0 +1,12 @@
+import * as math from 'mathjs';
+
+export default function (expression: string, scope = {}) {
+  const result = math.evaluate(expression, scope);
+  if (typeof result === 'number') {
+    if (Number.isNaN(result) || !Number.isFinite(result)) {
+      return null;
+    }
+    return math.round(result, 9);
+  }
+  return result;
+}