From 139ca9a635c1d6911f9886fb77b906447cfa2b05 Mon Sep 17 00:00:00 2001 From: Junyi Date: Tue, 21 Feb 2023 20:12:21 +0800 Subject: [PATCH] refactor(plugin-formula): combine 2 formula field type into 1 (#1457) * fix: observer * refactor(plugin-formula): merge 2 formula field type * fix(plugin-formula): fix types * fix(plugin-formula): fix type * fix(plugin-formula): fix formulajs version * fix(plugin-formula): change to VariableInput to avoid range error * test(plugin-formula): add test * fix(plugin-formula): fix test case * fix(plugin-formula): fix test case * fix(plugin-formula): fix test case * refactor(plugin-formula): move components into plugin * fix(plugin-formula): fix migration * fix(plugin-formula): revert legacy component to fix build * fix(plugin-formula): fix test case * fix(plugin-formula): fix test case * fix(plugin-formula): fix read-pretty component * fix(plugin-formula): fix formula result component * feat(plugin-formula): add checkbox display X --------- Co-authored-by: chenos --- .../client/src/plugins/excel-formula-field.ts | 1 - .../app/client/src/plugins/formula-field.ts | 1 + .../client/src/plugins/math-formula-field.ts | 1 - .../collection-manager/interfaces/checkbox.ts | 9 +- .../interfaces/properties/index.ts | 1 - packages/core/client/src/index.tsx | 1 - packages/core/client/src/locale/zh_CN.ts | 8 +- .../antd/checkbox/Checkbox.tsx | 7 +- packages/core/evaluators/client.d.ts | 2 + packages/core/evaluators/client.js | 12 + packages/core/evaluators/package.json | 19 + packages/core/evaluators/server.d.ts | 2 + packages/core/evaluators/server.js | 12 + .../src/client/engines/formulajs.ts | 10 + .../evaluators/src/client/engines/mathjs.ts | 10 + packages/core/evaluators/src/client/index.tsx | 18 + packages/core/evaluators/src/index.ts | 1 + packages/core/evaluators/src/server/index.ts | 24 + .../core/evaluators/src/utils/formulajs.ts | 19 + packages/core/evaluators/src/utils/mathjs.ts | 13 + packages/core/utils/src/registry.ts | 10 +- packages/plugins/formula-field/LICENSE | 661 +++++++++ packages/plugins/formula-field/README.md | 9 + .../plugins/formula-field/README.zh-CN.md | 9 + packages/plugins/formula-field/client.d.ts | 4 + packages/plugins/formula-field/client.js | 30 + packages/plugins/formula-field/package.json | 16 + packages/plugins/formula-field/server.d.ts | 4 + packages/plugins/formula-field/server.js | 30 + .../formula-field/src/client/field.tsx | 198 +++ .../src/client/formula/Expression.tsx | 243 ++++ .../src/client/formula/Result.tsx | 60 + .../src/client/formula/demos/demo2.tsx | 72 + .../formula-field/src/client/formula/index.md | 10 + .../src/client/formula/index.tsx | 9 + .../formula-field/src/client/index.tsx | 55 + .../formula-field/src/client/locale/index.ts | 13 + .../formula-field/src/client/locale/zh-CN.ts | 7 + packages/plugins/formula-field/src/index.ts | 1 + .../formula-field/src/server/Plugin.ts | 33 + .../server/__tests__/formula-field.test.ts | 1182 +++++++++++++++++ .../formula-field/src/server/formula-field.ts | 294 ++++ .../plugins/formula-field/src/server/index.ts | 1 + .../migrations/20230213161902-alter-field.ts | 61 + .../plugins/map/src/client/fields/schema.ts | 4 +- packages/presets/nocobase/package.json | 3 +- packages/presets/nocobase/src/index.ts | 3 +- 47 files changed, 3171 insertions(+), 22 deletions(-) delete mode 100644 packages/app/client/src/plugins/excel-formula-field.ts create mode 100644 packages/app/client/src/plugins/formula-field.ts delete mode 100644 packages/app/client/src/plugins/math-formula-field.ts create mode 100644 packages/core/evaluators/client.d.ts create mode 100644 packages/core/evaluators/client.js create mode 100644 packages/core/evaluators/package.json create mode 100644 packages/core/evaluators/server.d.ts create mode 100644 packages/core/evaluators/server.js create mode 100644 packages/core/evaluators/src/client/engines/formulajs.ts create mode 100644 packages/core/evaluators/src/client/engines/mathjs.ts create mode 100644 packages/core/evaluators/src/client/index.tsx create mode 100644 packages/core/evaluators/src/index.ts create mode 100644 packages/core/evaluators/src/server/index.ts create mode 100644 packages/core/evaluators/src/utils/formulajs.ts create mode 100644 packages/core/evaluators/src/utils/mathjs.ts create mode 100644 packages/plugins/formula-field/LICENSE create mode 100644 packages/plugins/formula-field/README.md create mode 100644 packages/plugins/formula-field/README.zh-CN.md create mode 100755 packages/plugins/formula-field/client.d.ts create mode 100755 packages/plugins/formula-field/client.js create mode 100644 packages/plugins/formula-field/package.json create mode 100755 packages/plugins/formula-field/server.d.ts create mode 100755 packages/plugins/formula-field/server.js create mode 100644 packages/plugins/formula-field/src/client/field.tsx create mode 100644 packages/plugins/formula-field/src/client/formula/Expression.tsx create mode 100644 packages/plugins/formula-field/src/client/formula/Result.tsx create mode 100644 packages/plugins/formula-field/src/client/formula/demos/demo2.tsx create mode 100644 packages/plugins/formula-field/src/client/formula/index.md create mode 100644 packages/plugins/formula-field/src/client/formula/index.tsx create mode 100644 packages/plugins/formula-field/src/client/index.tsx create mode 100644 packages/plugins/formula-field/src/client/locale/index.ts create mode 100644 packages/plugins/formula-field/src/client/locale/zh-CN.ts create mode 100644 packages/plugins/formula-field/src/index.ts create mode 100644 packages/plugins/formula-field/src/server/Plugin.ts create mode 100644 packages/plugins/formula-field/src/server/__tests__/formula-field.test.ts create mode 100644 packages/plugins/formula-field/src/server/formula-field.ts create mode 100644 packages/plugins/formula-field/src/server/index.ts create mode 100644 packages/plugins/formula-field/src/server/migrations/20230213161902-alter-field.ts diff --git a/packages/app/client/src/plugins/excel-formula-field.ts b/packages/app/client/src/plugins/excel-formula-field.ts deleted file mode 100644 index e7bcc5fe0..000000000 --- a/packages/app/client/src/plugins/excel-formula-field.ts +++ /dev/null @@ -1 +0,0 @@ -export { default } from '@nocobase/plugin-excel-formula-field/client'; \ No newline at end of file diff --git a/packages/app/client/src/plugins/formula-field.ts b/packages/app/client/src/plugins/formula-field.ts new file mode 100644 index 000000000..73ed8f5f1 --- /dev/null +++ b/packages/app/client/src/plugins/formula-field.ts @@ -0,0 +1 @@ +export { default } from '@nocobase/plugin-formula-field/client'; diff --git a/packages/app/client/src/plugins/math-formula-field.ts b/packages/app/client/src/plugins/math-formula-field.ts deleted file mode 100644 index 9869c7c28..000000000 --- a/packages/app/client/src/plugins/math-formula-field.ts +++ /dev/null @@ -1 +0,0 @@ -export { default } from '@nocobase/plugin-math-formula-field/client'; \ No newline at end of file diff --git a/packages/core/client/src/collection-manager/interfaces/checkbox.ts b/packages/core/client/src/collection-manager/interfaces/checkbox.ts index f254fd813..2b127fab7 100644 --- a/packages/core/client/src/collection-manager/interfaces/checkbox.ts +++ b/packages/core/client/src/collection-manager/interfaces/checkbox.ts @@ -17,7 +17,14 @@ export const checkbox: IField = { }, hasDefaultValue: true, properties: { - ...defaultProps + ...defaultProps, + showUnchecked: { + type: 'boolean', + title: '{{t("Display X when unchecked")}}', + default: false, + 'x-decorator': 'FormItem', + 'x-component': 'Checkbox', + } }, filterable: { operators: operators.boolean, diff --git a/packages/core/client/src/collection-manager/interfaces/properties/index.ts b/packages/core/client/src/collection-manager/interfaces/properties/index.ts index 338836592..bc835e508 100644 --- a/packages/core/client/src/collection-manager/interfaces/properties/index.ts +++ b/packages/core/client/src/collection-manager/interfaces/properties/index.ts @@ -333,7 +333,6 @@ export const defaultProps = { description: "{{t('Randomly generated and can be modified. Support letters, numbers and underscores, must start with an letter.')}}", }, - type, }; export const recordPickerSelector: ISchema = { diff --git a/packages/core/client/src/index.tsx b/packages/core/client/src/index.tsx index facc1a0d5..0eec7fb64 100644 --- a/packages/core/client/src/index.tsx +++ b/packages/core/client/src/index.tsx @@ -27,4 +27,3 @@ export * from './schema-templates'; export * from './settings-form'; export * from './system-settings'; export * from './user'; - diff --git a/packages/core/client/src/locale/zh_CN.ts b/packages/core/client/src/locale/zh_CN.ts index 468c97499..c92ac2bfd 100644 --- a/packages/core/client/src/locale/zh_CN.ts +++ b/packages/core/client/src/locale/zh_CN.ts @@ -138,6 +138,7 @@ export default { "General collection": "普通数据表", "Randomly generated and can be modified. Support letters, numbers and underscores, must start with an letter.": "随机生成，可修改。支持英文、数字和下划线，必须以英文字母开头。", "Storage type": "存储类型", + "Types will be used in database": "数据库使用的类型", "Edit": "编辑", "Edit collection": "编辑数据表", "Configure fields": "配置字段", @@ -157,9 +158,11 @@ export default { "Long text": "多行文本", "Phone": "手机号码", "Email": "电子邮箱", + "Boolean": "逻辑值", "Number": "数字", "Integer": "整数", "Percent": "百分比", + "String": "字符串", "Password": "密码", "Advanced type": "高级类型", "Formula": "公式", @@ -169,6 +172,7 @@ export default { "Formula.js supports most Microsoft Excel formula functions.": "Formula.js 支持大部分 Mircrosoft Excel 公式。", "Choices": "选择类型", "Checkbox": "勾选", + "Display X when unchecked": "未勾选时显示 X", "Single select": "下拉菜单（单选）", "Multiple select": "下拉菜单（多选）", "Radio group": "单选框", @@ -468,10 +472,6 @@ export default { 'Role UID': '角色标识', 'Precision': '精确度', - 'Formula mode': '计算方式', - 'Expression': '表达式', - 'Input +, -, *, /, ( ) to calculate, input @ to open field variables.': '英文输入+、-、*、/、( ) 进行运算，输入@打开可用字段变量。', - 'Formula error.': '公式验证错误。', 'Accept': '文件格式', 'Rich Text': '富文本', 'Junction collection': '中间表', diff --git a/packages/core/client/src/schema-component/antd/checkbox/Checkbox.tsx b/packages/core/client/src/schema-component/antd/checkbox/Checkbox.tsx index 14bb1cc0c..fe7f1305f 100644 --- a/packages/core/client/src/schema-component/antd/checkbox/Checkbox.tsx +++ b/packages/core/client/src/schema-component/antd/checkbox/Checkbox.tsx @@ -1,4 +1,4 @@ -import { CheckOutlined } from '@ant-design/icons'; +import { CheckOutlined, CloseOutlined } from '@ant-design/icons'; import { connect, mapProps, mapReadPretty, useField } from '@formily/react'; import { isValid } from '@formily/shared'; import { Checkbox as AntdCheckbox, Tag } from 'antd'; @@ -34,7 +34,10 @@ export const Checkbox: ComposedCheckbox = connect( if (!isValid(props.value)) { return null; } - return props.value ? : null; + if (props.value) { + return ; + } + return props.showUnchecked ? : null; }), ); diff --git a/packages/core/evaluators/client.d.ts b/packages/core/evaluators/client.d.ts new file mode 100644 index 000000000..d472744e5 --- /dev/null +++ b/packages/core/evaluators/client.d.ts @@ -0,0 +1,2 @@ +// @ts-nocheck +export * from './lib/client'; diff --git a/packages/core/evaluators/client.js b/packages/core/evaluators/client.js new file mode 100644 index 000000000..5effcafee --- /dev/null +++ b/packages/core/evaluators/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]; + } + }); +}); diff --git a/packages/core/evaluators/package.json b/packages/core/evaluators/package.json new file mode 100644 index 000000000..4380a3199 --- /dev/null +++ b/packages/core/evaluators/package.json @@ -0,0 +1,19 @@ +{ + "name": "@nocobase/evaluators", + "version": "0.9.0-alpha.2", + "description": "", + "main": "./lib/index.js", + "types": "./lib/index.d.ts", + "license": "Apache-2.0", + "dependencies": { + "@formulajs/formulajs": "4.2.0", + "@nocobase/utils": "0.9.0-alpha.2", + "mathjs": "^10.6.0" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/nocobase/nocobase.git", + "directory": "packages/evaluators" + }, + "gitHead": "ce588eefb0bfc50f7d5bbee575e0b5e843bf6644" +} diff --git a/packages/core/evaluators/server.d.ts b/packages/core/evaluators/server.d.ts new file mode 100644 index 000000000..d8ed31d87 --- /dev/null +++ b/packages/core/evaluators/server.d.ts @@ -0,0 +1,2 @@ +// @ts-nocheck +export * from './lib/server'; diff --git a/packages/core/evaluators/server.js b/packages/core/evaluators/server.js new file mode 100644 index 000000000..c93247d51 --- /dev/null +++ b/packages/core/evaluators/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]; + } + }); +}); diff --git a/packages/core/evaluators/src/client/engines/formulajs.ts b/packages/core/evaluators/src/client/engines/formulajs.ts new file mode 100644 index 000000000..85ab9c453 --- /dev/null +++ b/packages/core/evaluators/src/client/engines/formulajs.ts @@ -0,0 +1,10 @@ +import evaluate from '../../utils/formulajs'; + + + +export default { + label: 'Formula.js', + tooltip: '{{t("Formula.js supports most Microsoft Excel formula functions.")}}', + link: 'https://formulajs.info/functions/', + evaluate +}; diff --git a/packages/core/evaluators/src/client/engines/mathjs.ts b/packages/core/evaluators/src/client/engines/mathjs.ts new file mode 100644 index 000000000..ffa002f8c --- /dev/null +++ b/packages/core/evaluators/src/client/engines/mathjs.ts @@ -0,0 +1,10 @@ +import evaluate 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 +}; diff --git a/packages/core/evaluators/src/client/index.tsx b/packages/core/evaluators/src/client/index.tsx new file mode 100644 index 000000000..9a881d129 --- /dev/null +++ b/packages/core/evaluators/src/client/index.tsx @@ -0,0 +1,18 @@ +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; +} + +const evaluators = new Registry(); + +evaluators.register('math.js', mathjs); +evaluators.register('formula.js', formulajs); + +export default evaluators; diff --git a/packages/core/evaluators/src/index.ts b/packages/core/evaluators/src/index.ts new file mode 100644 index 000000000..7ddad5814 --- /dev/null +++ b/packages/core/evaluators/src/index.ts @@ -0,0 +1 @@ +export { default } from './server'; diff --git a/packages/core/evaluators/src/server/index.ts b/packages/core/evaluators/src/server/index.ts new file mode 100644 index 000000000..2223447d9 --- /dev/null +++ b/packages/core/evaluators/src/server/index.ts @@ -0,0 +1,24 @@ +import { get } from "lodash"; + +import { Registry, RegistryOptions } from "@nocobase/utils"; + +import mathjs from "../utils/mathjs"; +import formulajs from "../utils/formulajs"; + + + +export interface Evaluator { + (expression: string, scope?: { [key: string]: any }): any; +} + +export interface EvaluatorsOptions extends RegistryOptions { + empty?: boolean; + evaluators?: { [key: string]: Evaluator }; +} + +const evaluators = new Registry(); + +evaluators.register('math.js', mathjs); +evaluators.register('formula.js', formulajs); + +export default evaluators; diff --git a/packages/core/evaluators/src/utils/formulajs.ts b/packages/core/evaluators/src/utils/formulajs.ts new file mode 100644 index 000000000..aa2b81f82 --- /dev/null +++ b/packages/core/evaluators/src/utils/formulajs.ts @@ -0,0 +1,19 @@ +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(exp: string, scope = {}) { + const expression = exp.replace(/{{\s*([^{}]+)\s*}}/g, (_, v) => v); + 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; +} diff --git a/packages/core/evaluators/src/utils/mathjs.ts b/packages/core/evaluators/src/utils/mathjs.ts new file mode 100644 index 000000000..7dccbd9f8 --- /dev/null +++ b/packages/core/evaluators/src/utils/mathjs.ts @@ -0,0 +1,13 @@ +import * as math from 'mathjs'; + +export default function (expression: string, scope = {}) { + const exp = expression.trim().replace(/{{\s*([^{}]+)\s*}}/g, (_, v) => v); + const result = math.evaluate(exp, scope); + if (typeof result === 'number') { + if (Number.isNaN(result) || !Number.isFinite(result)) { + return null; + } + return math.round(result, 9); + } + return result; +} diff --git a/packages/core/utils/src/registry.ts b/packages/core/utils/src/registry.ts index 3dd4a07f0..493f591ee 100644 --- a/packages/core/utils/src/registry.ts +++ b/packages/core/utils/src/registry.ts @@ -11,7 +11,7 @@ export class Registry { this.options = options; } - register(key: string, value: T): void { + public register(key: string, value: T): void { if (!this.options.override && this.map.has(key)) { throw new Error(`this registry does not allow to override existing keys: "${key}"`); } @@ -24,19 +24,19 @@ export class Registry { // return files.filter(file => extensions.includes(path.extname(file))) // } - get(key: string): T { + public get(key: string): T { return this.map.get(key); } - getKeys(): Iterable { + public getKeys(): Iterable { return this.map.keys(); } - getValues(): Iterable { + public getValues(): Iterable { return this.map.values(); } - getEntities(): Iterable<[string, T]> { + public getEntities(): Iterable<[string, T]> { return this.map.entries(); } } diff --git a/packages/plugins/formula-field/LICENSE b/packages/plugins/formula-field/LICENSE new file mode 100644 index 000000000..0ad25db4b --- /dev/null +++ b/packages/plugins/formula-field/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/packages/plugins/formula-field/README.md b/packages/plugins/formula-field/README.md new file mode 100644 index 000000000..09eeec113 --- /dev/null +++ b/packages/plugins/formula-field/README.md @@ -0,0 +1,9 @@ +# math-formula-field + +English | [中文](./README.zh-CN.md) + +## 安装激活 + +内置插件无需手动安装激活。 + +## 使用方法 diff --git a/packages/plugins/formula-field/README.zh-CN.md b/packages/plugins/formula-field/README.zh-CN.md new file mode 100644 index 000000000..d408567ed --- /dev/null +++ b/packages/plugins/formula-field/README.zh-CN.md @@ -0,0 +1,9 @@ +# math-formula-field + +[English](./README.md) | 中文 + +## 安装激活 + +内置插件无需手动安装激活。 + +## 使用方法 diff --git a/packages/plugins/formula-field/client.d.ts b/packages/plugins/formula-field/client.d.ts new file mode 100755 index 000000000..765db9222 --- /dev/null +++ b/packages/plugins/formula-field/client.d.ts @@ -0,0 +1,4 @@ +// @ts-nocheck +export * from './lib/client'; +export { default } from './lib/client'; + diff --git a/packages/plugins/formula-field/client.js b/packages/plugins/formula-field/client.js new file mode 100755 index 000000000..238820257 --- /dev/null +++ b/packages/plugins/formula-field/client.js @@ -0,0 +1,30 @@ +"use strict"; + +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; } + +var _index = _interopRequireWildcard(require("./lib/client")); + +Object.defineProperty(exports, "__esModule", { + value: true +}); +var _exportNames = {}; +Object.defineProperty(exports, "default", { + enumerable: true, + get: function get() { + return _index.default; + } +}); + +Object.keys(_index).forEach(function (key) { + if (key === "default" || key === "__esModule") return; + if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return; + if (key in exports && exports[key] === _index[key]) return; + Object.defineProperty(exports, key, { + enumerable: true, + get: function get() { + return _index[key]; + } + }); +}); diff --git a/packages/plugins/formula-field/package.json b/packages/plugins/formula-field/package.json new file mode 100644 index 000000000..5a61c42b0 --- /dev/null +++ b/packages/plugins/formula-field/package.json @@ -0,0 +1,16 @@ +{ + "name": "@nocobase/plugin-formula-field", + "version": "0.9.0-alpha.2", + "description": "", + "license": "AGPL-3.0", + "main": "./lib/index.js", + "types": "./lib/index.d.ts", + "dependencies": { + "@nocobase/evaluators": "0.9.0-alpha.2", + "@nocobase/utils": "0.9.0-alpha.2" + }, + "devDependencies": { + "@nocobase/server": "0.9.0-alpha.2", + "@nocobase/test": "0.9.0-alpha.2" + } +} diff --git a/packages/plugins/formula-field/server.d.ts b/packages/plugins/formula-field/server.d.ts new file mode 100755 index 000000000..e70edb928 --- /dev/null +++ b/packages/plugins/formula-field/server.d.ts @@ -0,0 +1,4 @@ +// @ts-nocheck +export * from './lib/server'; +export { default } from './lib/server'; + diff --git a/packages/plugins/formula-field/server.js b/packages/plugins/formula-field/server.js new file mode 100755 index 000000000..d06a7eb92 --- /dev/null +++ b/packages/plugins/formula-field/server.js @@ -0,0 +1,30 @@ +"use strict"; + +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; } + +var _index = _interopRequireWildcard(require("./lib/server")); + +Object.defineProperty(exports, "__esModule", { + value: true +}); +var _exportNames = {}; +Object.defineProperty(exports, "default", { + enumerable: true, + get: function get() { + return _index.default; + } +}); + +Object.keys(_index).forEach(function (key) { + if (key === "default" || key === "__esModule") return; + if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return; + if (key in exports && exports[key] === _index[key]) return; + Object.defineProperty(exports, key, { + enumerable: true, + get: function get() { + return _index[key]; + } + }); +}); diff --git a/packages/plugins/formula-field/src/client/field.tsx b/packages/plugins/formula-field/src/client/field.tsx new file mode 100644 index 000000000..8c38ace30 --- /dev/null +++ b/packages/plugins/formula-field/src/client/field.tsx @@ -0,0 +1,198 @@ +import { cloneDeep } from 'lodash'; +import { i18n, IField, interfacesProperties } from '@nocobase/client'; +import evaluators, { Evaluator } from '@nocobase/evaluators/client'; +import { Registry } from '@nocobase/utils/client'; + +import { NAMESPACE } from './locale'; + + + +const booleanReactions = [ + { + dependencies: ['dataType'], + fulfill: { + state: { + display: '{{$deps[0] === "boolean" ? "visible" : "none"}}', + }, + }, + } +]; + +const numberReactions = [ + { + dependencies: ['dataType'], + fulfill: { + state: { + display: '{{["double", "decimal"].includes($deps[0]) ? "visible" : "none"}}', + }, + }, + } +]; + +const datetimeReactions = [ + { + dependencies: ['dataType'], + fulfill: { + state: { + display: '{{$deps[0] === "date" ? "visible" : "none"}}', + }, + }, + } +]; + +const { defaultProps, dateTimeProps, operators } = interfacesProperties; +const datetimeProperties = { + 'uiSchema.x-component-props.dateFormat': { + ...cloneDeep(dateTimeProps['uiSchema.x-component-props.dateFormat']), + 'x-reactions': datetimeReactions + }, + 'uiSchema.x-component-props.showTime': { + ...cloneDeep(dateTimeProps['uiSchema.x-component-props.showTime']), + 'x-reactions': [...(dateTimeProps['uiSchema.x-component-props.showTime']['x-reactions'] as string[]), ...datetimeReactions] + }, + 'uiSchema.x-component-props.timeFormat': { + ...cloneDeep(dateTimeProps['uiSchema.x-component-props.timeFormat']), + } +}; + +export default { + name: 'formula', + type: 'object', + group: 'advanced', + order: 1, + title: `{{t("Formula", { ns: "${NAMESPACE}" })}}`, + description: '{{t("Compute a value based on the other fields using mathjs")}}', + sortable: true, + default: { + type: 'formula', + // name, + uiSchema: { + type: 'number', + // title, + 'x-disabled': true, + 'x-component': 'Formula.Result', + 'x-component-props': { + stringMode: true, + step: '1', + }, + }, + }, + properties: { + ...defaultProps, + dataType: { + type: 'string', + title: '{{t("Storage type")}}', + 'x-decorator': 'FormItem', + 'x-component': 'Select', + 'x-disabled': '{{ !createOnly }}', + enum: [ + { value: 'boolean', label: 'Boolean' }, + { value: 'integer', label: 'Integer' }, + { value: 'bigInt', label: 'Big integer' }, // not fully supported as JS native bigint type + { value: 'double', label: 'Double' }, + // { value: 'decimal', label: 'Decimal' }, // not supported + { value: 'string', label: 'String' }, + { value: 'date', label: 'Datetime' }, + ], + required: true, + default: 'double', + }, + 'uiSchema.x-component-props.showUnchecked': { + type: 'boolean', + title: '{{t("Display X when unchecked")}}', + default: false, + 'x-decorator': 'FormItem', + 'x-component': 'Checkbox', + 'x-reactions': booleanReactions + }, + 'uiSchema.x-component-props.step': { + type: 'string', + title: '{{t("Precision")}}', + 'x-component': 'Select', + 'x-decorator': 'FormItem', + required: true, + default: '0', + enum: [ + { value: '0', label: '1' }, + { value: '0.1', label: '1.0' }, + { value: '0.01', label: '1.00' }, + { value: '0.001', label: '1.000' }, + { value: '0.0001', label: '1.0000' }, + { value: '0.00001', label: '1.00000' }, + ], + 'x-reactions': numberReactions, + }, + ...datetimeProperties, + engine: { + type: 'string', + title: `{{t("Formula engine", { ns: "${NAMESPACE}" })}}`, + 'x-decorator': 'FormItem', + 'x-component': 'Radio.Group', + enum: Array.from((evaluators as Registry).getEntities()).reduce((result: any[], [value, options]) => result.concat({ value, ...options }), []), + required: true, + default: 'math.js', + }, + expression: { + type: 'string', + title: `{{t("Expression", { ns: "${NAMESPACE}" })}}`, + required: true, + 'x-component': 'Formula.Expression', + 'x-decorator': 'FormItem', + 'x-component-props': { + supports: [ + 'checkbox', + + 'number', + 'percent', + 'integer', + 'number', + 'percent', + + 'input', + 'textarea', + 'email', + 'phone', + + 'datetime', + 'createdAt', + 'updatedAt', + + 'radioGroup', + 'checkboxGroup', + 'select', + 'multipleSelect', + + // 'json' + ], + useCurrentFields: '{{ useCurrentFields }}', + // evaluate(exp: string) { + // const { values } = useForm(); + // const { evaluate } = evaluators.get(values.engine); + // return evaluate(exp); + // } + }, + 'x-reactions': { + dependencies: ['engine'], + fulfill: { + schema: { + description: '{{renderExpressionDescription($deps[0])}}', + } + } + }, + ['x-validator'](value, rules, { form }) { + const { values } = form; + const { evaluate } = (evaluators as Registry).get(values.engine); + const exp = value.trim().replace(/{{\s*([^{}]+)\s*}}/g, '1'); + try { + evaluate(exp); + return ''; + } catch (e) { + return i18n.t('Expression syntax error', { ns: NAMESPACE }); + } + } + }, + }, + filterable: { + operators: operators.number, + }, +} as IField; diff --git a/packages/plugins/formula-field/src/client/formula/Expression.tsx b/packages/plugins/formula-field/src/client/formula/Expression.tsx new file mode 100644 index 000000000..0e48e8b3a --- /dev/null +++ b/packages/plugins/formula-field/src/client/formula/Expression.tsx @@ -0,0 +1,243 @@ +import React, { useEffect, useRef, useState, useMemo } from 'react'; +import { css, cx } from '@emotion/css'; +import { useForm } from '@formily/react'; +import { Button, Cascader, Input, Tooltip } from 'antd'; +import { useTranslation } from 'react-i18next'; +import { useCompile } from '@nocobase/client'; + + + +const VARIABLE_RE = /\{\{\s*([^{}]+)\s*\}\}/g; + +function pasteHtml(container, html, { selectPastedContent = false, range: indexes }) { + // IE9 and non-IE + const sel = window.getSelection?.(); + if (!sel?.getRangeAt || !sel.rangeCount) { + return; + } + const range = sel.getRangeAt(0); + if (!range) { + return; + } + const children = Array.from(container.childNodes) as HTMLElement[]; + if (indexes[0] === -1) { + if (indexes[1]) { + range.setStartAfter(children[indexes[1] - 1]); + } + } else { + range.setStart(children[indexes[0]], indexes[1]); + } + + if (indexes[2] === -1) { + if (indexes[3]) { + range.setEndAfter(children[indexes[3] - 1]); + } + } else { + range.setEnd(children[indexes[2]], indexes[3]); + } + range.deleteContents(); + + // Range.createContextualFragment() would be useful here but is + // only relatively recently standardized and is not supported in + // some browsers (IE9, for one) + const el = document.createElement('div'); + el.innerHTML = html; + + const frag = document.createDocumentFragment(); + let lastNode; + while (el.firstChild) { + lastNode = frag.appendChild(el.firstChild); + } + const { firstChild } = frag; + range.insertNode(frag); + + // Preserve the selection + if (lastNode) { + const next = range.cloneRange(); + next.setStartAfter(lastNode); + if (selectPastedContent) { + if (firstChild) { + next.setStartBefore(firstChild); + } + } else { + next.collapse(true); + } + sel.removeAllRanges(); + sel.addRange(next); + } +} + +function getValue(el) { + const values: any[] = []; + for (const node of el.childNodes) { + if (node.nodeName === 'SPAN') { + values.push(`{{${node['dataset']['key']}}}`); + } else { + values.push(node.textContent?.trim?.()); + } + } + return values.join(' ').replace(/\s+/g, ' ').trim(); +} + +function renderHTML(exp: string, keyLabelMap) { + return exp.replace(VARIABLE_RE, (_, i) => { + const key = i.trim(); + return createVariableTagHTML(key, keyLabelMap) ?? ''; + }); +} + +function createOptionsKeyLabelMap(options: any[]) { + const map = new Map(); + for (const option of options) { + map.set(option.value, [option.label]); + if (option.children) { + for (const [value, labels] of createOptionsKeyLabelMap(option.children)) { + map.set(`${option.value}.${value}`, [option.label, ...labels]); + } + } + } + return map; +} + +function createVariableTagHTML(variable, keyLabelMap) { + const labels = keyLabelMap.get(variable); + return `${labels?.join(' / ')}`; +} + +export const Expression = (props) => { + const { value = '', supports, useCurrentFields, onChange } = props; + const { t } = useTranslation(); + const compile = useCompile(); + const fields = useCurrentFields().filter(field => supports.includes(field.interface)); + + const inputRef = useRef(null); + const options = fields.map(field => ({ + label: compile(field.uiSchema.title), + value: field.name + })); + const form = useForm(); + const keyLabelMap = useMemo(() => createOptionsKeyLabelMap(options), []); + const [changed, setChanged] = useState(false); + const [html, setHtml] = useState(() => renderHTML(value ?? '', keyLabelMap)); + // [startElementIndex, startOffset, endElementIndex, endOffset] + const [range, setRange] = useState<[number, number, number, number]>([-1, 0, -1, 0]); + + useEffect(() => { + if (changed) { + return; + } + setHtml(renderHTML(value ?? '', keyLabelMap)); + }, [value]); + + useEffect(() => { + const { current } = inputRef; + if (!current || changed) { + return; + } + const nextRange = new Range(); + const { lastChild } = current; + if (lastChild) { + nextRange.setStartAfter(lastChild); + nextRange.setEndAfter(lastChild); + const nodes = Array.from(current.childNodes); + const startElementIndex = nextRange.startContainer === current ? -1 : nodes.indexOf(lastChild); + const endElementIndex = nextRange.startContainer === current ? -1 : nodes.indexOf(lastChild); + setRange([startElementIndex, nextRange.startOffset, endElementIndex, nextRange.endOffset]); + } + }, [html]); + + function onInsert(keyPath) { + const variable: string[] = keyPath.filter(key => Boolean(key.trim())); + const { current } = inputRef; + if (!current || !variable) { + return; + } + + current.focus(); + + pasteHtml(current, createVariableTagHTML(variable.join('.'), keyLabelMap), { + range, + }); + + setChanged(true); + onChange(getValue(current)); + } + + function onInput({ currentTarget }) { + setChanged(true); + onChange(getValue(currentTarget)); + } + + function onBlur({ currentTarget }) { + const sel = window.getSelection?.(); + if (!sel?.getRangeAt || !sel.rangeCount) { + return; + } + const r = sel.getRangeAt(0); + const nodes = Array.from(currentTarget.childNodes); + const startElementIndex = nodes.indexOf(r.startContainer); + const endElementIndex = nodes.indexOf(r.endContainer); + setRange([startElementIndex, r.startOffset, endElementIndex, r.endOffset]); + } + + const disabled = props.disabled || form.disabled; + + return ( + +
{ + if (e.key === 'Enter') { + e.preventDefault(); + } + }} + onBlur={onBlur} + onInput={onInput} + className={cx('ant-input', { 'ant-input-disabled': disabled }, css` + overflow: auto; + white-space: nowrap; + .ant-tag{ + display: inline; + line-height: 19px; + margin: 0 .5em; + padding: 2px 7px; + border-radius: 10px; + } + `)} + ref={inputRef as any} + contentEditable={!disabled} + dangerouslySetInnerHTML={{ __html: html }} + /> + + + + + + + ); +}; + +export default Expression; diff --git a/packages/plugins/formula-field/src/client/formula/Result.tsx b/packages/plugins/formula-field/src/client/formula/Result.tsx new file mode 100644 index 000000000..9ba5a84da --- /dev/null +++ b/packages/plugins/formula-field/src/client/formula/Result.tsx @@ -0,0 +1,60 @@ +import { onFormValuesChange } from '@formily/core'; +import { useField, useFieldSchema, useForm, useFormEffects } from '@formily/react'; +import evaluators, { Evaluator } from '@nocobase/evaluators/client'; +import { Registry, toFixedByStep } from '@nocobase/utils/client'; +import cloneDeep from 'lodash/cloneDeep'; +import React, { useState } from 'react'; +import { Checkbox, DatePicker, Input as InputString, InputNumber, useCollection } from '@nocobase/client'; + +const TypedComponents = { + boolean: Checkbox, + integer: InputNumber, + bigInt: InputNumber, + double: InputNumber, + decimal: InputNumber, + date: DatePicker, + string: InputString, +}; + +const ReadPretty = (props) => { + const { dataType } = props?.options?? {}; + const Component = TypedComponents[dataType] ?? InputString; + return ; +}; + +const Input = (props) => { + const { options } = props; + const { dataType, expression, engine = 'math.js' } = options; + const { evaluate } = (evaluators as Registry).get(engine); + const form = useForm(); + const val = () => { + const scope = cloneDeep(form.values); + try { + return evaluate(expression, scope); + } catch (error) { + return null; + } + }; + const [value, setVal] = useState(() => { + return val(); + }); + useFormEffects(() => { + onFormValuesChange(() => { + setVal(val()); + }); + }); + if (dataType === 'double') { + return
{toFixedByStep(value, props.step)}
; + } + return
{value}
; +}; + +export const Result = (props: any) => { + const field = useField(); + const { getField } = useCollection(); + const fieldSchema = useFieldSchema(); + const options = getField(fieldSchema.name as string); + return field.readPretty ? : ; +}; + +export default Result; diff --git a/packages/plugins/formula-field/src/client/formula/demos/demo2.tsx b/packages/plugins/formula-field/src/client/formula/demos/demo2.tsx new file mode 100644 index 000000000..d809f9afa --- /dev/null +++ b/packages/plugins/formula-field/src/client/formula/demos/demo2.tsx @@ -0,0 +1,72 @@ +/** + * title: Formula + */ +import { connect } from '@formily/react'; +import { Formula, SchemaComponent, SchemaComponentProvider } from '@nocobase/client'; +import React from 'react'; + +const Expression = connect(Formula.Expression); + +const schema = { + type: 'object', + properties: { + input: { + type: 'string', + default: '{{f1 }} + {{ f2}}', + 'x-component': 'Expression', + 'x-component-props': { + supports: [ + 'checkbox', + + 'number', + 'percent', + 'integer', + 'number', + 'percent', + + 'input', + 'textarea', + 'email', + 'phone', + + 'datetime', + 'createdAt', + 'updatedAt', + + 'radioGroup', + 'checkboxGroup', + 'select', + 'multipleSelect', + + // 'json' + ], + useCurrentFields: () => { + return [ + { + name: 'f1', + interface: 'number', + uiSchema: { + title: 'F1', + }, + }, + { + name: 'f2', + interface: 'number', + uiSchema: { + title: 'F2', + }, + }, + ]; + }, + }, + }, + }, +}; + +export default () => { + return ( + + + + ); +}; diff --git a/packages/plugins/formula-field/src/client/formula/index.md b/packages/plugins/formula-field/src/client/formula/index.md new file mode 100644 index 000000000..5efb7dfdf --- /dev/null +++ b/packages/plugins/formula-field/src/client/formula/index.md @@ -0,0 +1,10 @@ +--- +nav: + path: /client +group: + path: /client +--- + +# Formula + + diff --git a/packages/plugins/formula-field/src/client/formula/index.tsx b/packages/plugins/formula-field/src/client/formula/index.tsx new file mode 100644 index 000000000..9a59d66df --- /dev/null +++ b/packages/plugins/formula-field/src/client/formula/index.tsx @@ -0,0 +1,9 @@ +import Expression from './Expression'; +import Result from './Result'; + +export const Formula = () => null; + +Formula.Result = Result; +Formula.Expression = Expression; + +export default Formula; diff --git a/packages/plugins/formula-field/src/client/index.tsx b/packages/plugins/formula-field/src/client/index.tsx new file mode 100644 index 000000000..2164cc9be --- /dev/null +++ b/packages/plugins/formula-field/src/client/index.tsx @@ -0,0 +1,55 @@ +import React, { useContext } from 'react'; +import { i18n } from '@nocobase/client'; +import { css } from '@emotion/css'; + +import { CollectionManagerContext, registerField, SchemaComponentOptions } from '@nocobase/client'; +import evaluators, { Evaluator } from '@nocobase/evaluators/client'; + +import Formula from './formula'; +import field from './field'; +import { NAMESPACE } from './locale'; +import { Registry } from '@nocobase/utils/client'; + + + +registerField(field.group, 'formula', field); + +function renderExpressionDescription(key: string) { + const engine = (evaluators as Registry).get(key); + + return engine?.link + ? ( + <> + + {i18n.t('Syntax references', { ns: NAMESPACE })} + + {engine.label} + + ) + : null +} + +export default React.memo((props) => { + const ctx = useContext(CollectionManagerContext); + return ( + + + {props.children} + + + ); +}); diff --git a/packages/plugins/formula-field/src/client/locale/index.ts b/packages/plugins/formula-field/src/client/locale/index.ts new file mode 100644 index 000000000..93530ed0a --- /dev/null +++ b/packages/plugins/formula-field/src/client/locale/index.ts @@ -0,0 +1,13 @@ +import { i18n } from '@nocobase/client'; +import { useTranslation } from 'react-i18next'; + + +export const NAMESPACE = 'formula-field'; + +export function lang(key: string, options = {}) { + return i18n.t(key, { ...options, ns: NAMESPACE }); +} + +export function usePluginTranslation() { + return useTranslation(NAMESPACE); +} diff --git a/packages/plugins/formula-field/src/client/locale/zh-CN.ts b/packages/plugins/formula-field/src/client/locale/zh-CN.ts new file mode 100644 index 000000000..ac8fc1b31 --- /dev/null +++ b/packages/plugins/formula-field/src/client/locale/zh-CN.ts @@ -0,0 +1,7 @@ +export default { + 'Formula': '公式', + 'Formula engine': '公式引擎', + 'Expression': '表达式', + 'Expression syntax error': '表达式语法错误', + 'Syntax references': '语法参考' +} diff --git a/packages/plugins/formula-field/src/index.ts b/packages/plugins/formula-field/src/index.ts new file mode 100644 index 000000000..7ddad5814 --- /dev/null +++ b/packages/plugins/formula-field/src/index.ts @@ -0,0 +1 @@ +export { default } from './server'; diff --git a/packages/plugins/formula-field/src/server/Plugin.ts b/packages/plugins/formula-field/src/server/Plugin.ts new file mode 100644 index 000000000..4d46c30f0 --- /dev/null +++ b/packages/plugins/formula-field/src/server/Plugin.ts @@ -0,0 +1,33 @@ +import { InstallOptions, Plugin } from '@nocobase/server'; +import { resolve } from 'path'; +import { FormulaField } from './formula-field'; + +export class FormulaFieldPlugin extends Plugin { + afterAdd() {} + + beforeLoad() { + this.db.registerFieldTypes({ + formula: FormulaField, + }); + + this.db.addMigrations({ + namespace: this.name, + directory: resolve(__dirname, './migrations'), + context: { + plugin: this, + }, + }); + } + + async load() {} + + async install(options?: InstallOptions) {} + + async afterEnable() {} + + async afterDisable() {} + + async remove() {} +} + +export default FormulaFieldPlugin; diff --git a/packages/plugins/formula-field/src/server/__tests__/formula-field.test.ts b/packages/plugins/formula-field/src/server/__tests__/formula-field.test.ts new file mode 100644 index 000000000..6005713a0 --- /dev/null +++ b/packages/plugins/formula-field/src/server/__tests__/formula-field.test.ts @@ -0,0 +1,1182 @@ +import { Database, mockDatabase } from '@nocobase/database'; +import { FormulaField } from '../formula-field'; + +describe('formula field', () => { + let db: Database; + + beforeEach(async () => { + db = mockDatabase(); + db.registerFieldTypes({ + formula: FormulaField, + }); + }); + + afterEach(async () => { + await db.close(); + }); + + describe('engines', () => { + describe('math.js', () => { + it('auto set formula field with create or update data', async () => { + const expression = '{{price}}*{{count}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'price' }, + { type: 'float', name: 'count' }, + { name: 'sum', type: 'formula', expression, engine: 'math.js' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + price: '1.2', + count: '2', + }); + + const sumField = Test.getField('sum'); + expect(test.get('sum')).toEqual(2.4); + + test.set('count', '6'); + await test.save(); + expect(test.get('sum')).toEqual(7.2); + }); + + it('auto set formula field with create or update data', async () => { + const expression = '{{price}}*{{count}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'price' }, + { type: 'float', name: 'count' }, + { name: 'sum', type: 'formula', expression, engine: 'math.js' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + price: '1.2', + count: '2', + }); + + const sumField = Test.getField('sum'); + expect(test.get('sum')).toEqual(2.4); + + test.set('count', '6'); + await test.save(); + expect(test.get('sum')).toEqual(7.2); + }); + + it('1.22+2=3.22', async () => { + const expression = '{{a}}+{{b}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { type: 'float', name: 'b' }, + { name: 'sum', type: 'formula', expression, engine: 'math.js' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '2', + b: '1.22', + }); + + expect(test.get('sum')).toEqual(3.22); + }); + }); + + describe('formula.js', () => { + it('SUM(a, b)', async () => { + const expression = 'SUM({{a}}, {{b}})'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { type: 'float', name: 'b' }, + { name: 'sum', type: 'formula', expression, engine: 'formula.js' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 2, + b: 1.22, + }); + + expect(test.get('sum')).toEqual(3.22); + }); + }); + }); + + describe('data types', () => { + describe('boolean', () => { + it('from null', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: null, + }); + + expect(test.get('formula')).toBe(null); + }); + + it('from boolean', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + + expect(test.get('formula')).toBe(true); + }); + + it('from number', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'double', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 123.45, + }); + + expect(test.get('formula')).toBe(true); + }); + + it('from bigint', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: BigInt(123), + }); + + expect(test.get('formula')).toBe(true); + }); + + it('from empty string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '', + }); + + expect(test.get('formula')).toBe(false); + }); + + it('from string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: ' ', + }); + + expect(test.get('formula')).toBe(true); + }); + + it('from date', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'boolean' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: new Date(), + }); + + expect(test.get('formula')).toBe(true); + }); + }); + + describe('to integer', () => { + describe('from boolean', () => { + it('null', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: null, + }); + + expect(test.get('formula')).toBe(null); + }); + + it('true', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + + expect(test.get('formula')).toBe(1); + }); + + it('false', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: false, + }); + + expect(test.get('formula')).toBe(0); + }); + }); + + describe('from number', () => { + it('positive', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 34.56, + }); + + expect(test.get('formula')).toBe(34); + }); + + it('negative', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: -34.56, + }); + + expect(test.get('formula')).toBe(-34); + }); + }); + + describe('from bigint', () => { + it('in int range', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: BigInt(123), + }); + + expect(test.get('formula')).toBe(123); + }); + + it('out of int range', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + Test.model.create({ a: BigInt(Number.MAX_SAFE_INTEGER) }) + .then(() => { + throw Error('should not be called'); + }) + .catch((e) => { + expect(e).toBeDefined(); + }); + }); + }); + + describe('from string', () => { + it('non-number content string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'formula', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'abc', + }); + + expect(test.get('formula')).toBeNull(); + }); + + it('number content in string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'integer', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '123.6', + }); + + expect(test.get('integer')).toBe(123); + }); + + it('number started mixed content in string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'integer', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '123abc', + }); + + expect(test.get('integer')).toBe(123); + }); + }); + + describe('from date', () => { + it('now', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'integer', type: 'formula', expression, engine: 'formula.js', dataType: 'integer' }, + ], + }); + + await db.sync(); + + Test.model.create({ a: now }) + .then(() => { + throw Error('should not be called'); + }) + .catch((e) => { + expect(e).toBeDefined(); + }); + }); + }); + }); + + describe('bigInt', () => { + describe('from boolean', () => { + it('true', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + expect(test.get('result')).toBe(1); + }); + + it('false', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: false, + }); + expect(test.get('result')).toBe(0); + }); + }); + + describe('from number', () => { + it('float', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 1.6, + }); + expect(test.get('result')).toEqual(1); + }); + + it('negative', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: -1.6, + }); + expect(test.get('result')).toEqual(-1); + }); + }); + + describe('from string', () => { + it('number string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '-123.56', + }); + expect(test.get('result')).toEqual(-123); + }); + + it('mixed string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '9007199254740991abc', + }); + expect(test.get('result')).toEqual(9007199254740991); + }); + + it('invalid number string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'abc', + }); + expect(test.get('result')).toEqual(null); + }); + + it('infinity string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'Infinity', + }); + expect(test.get('result')).toEqual(null); + }); + }); + + describe('from date', () => { + it('now', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'bigInt' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: now, + }); + expect(test.get('result')).toEqual(now.valueOf()); + }); + }); + }); + + describe('double', () => { + describe('from boolean', () => { + it('true', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + expect(test.get('result')).toEqual(1); + }); + + it('false', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: false, + }); + expect(test.get('result')).toEqual(0); + }); + }); + + describe('from number', () => { + it('integer', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'integer', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 1, + }); + expect(test.get('result')).toEqual(1); + }); + + it('float', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: -1.5, + }); + expect(test.get('result')).toEqual(-1.5); + }); + }); + + describe('from string', () => { + it('empty string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '', + }); + expect(test.get('result')).toEqual(null); + }); + + it('number content string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '123.456', + }); + expect(test.get('result')).toEqual(123.456); + }); + + it('number started string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '123.abc', + }); + expect(test.get('result')).toEqual(123); + }); + + it('just string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'abc', + }); + expect(test.get('result')).toEqual(null); + }); + + it('Infinity', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'Infinity', + }); + expect(test.get('result')).toEqual(null); + }); + }); + + describe('from date', () => { + it('now', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'double' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: now, + }); + expect(test.get('result')).toEqual(now.valueOf()); + }); + }); + }); + + describe.skip('decimal', () => { + + }); + + describe('string', () => { + describe('from boolean', () => { + it('true', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + expect(test.get('result')).toBe('true'); + }); + + it('false', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: false, + }); + expect(test.get('result')).toBe('false'); + }); + }); + + describe('from number', () => { + it('zero', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'integer', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 0, + }); + expect(test.get('result')).toBe('0'); + }); + + it('positive', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 1.5, + }); + expect(test.get('result')).toBe('1.5'); + }); + + it('negative', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: -1.5, + }); + expect(test.get('result')).toBe('-1.5'); + }); + }); + + describe('from bigint', () => { + it('bigint', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: BigInt(Number.MAX_SAFE_INTEGER), + }); + expect(test.get('result')).toBe(`${Number.MAX_SAFE_INTEGER}`); + }); + }); + + describe('from string', () => { + it('empty string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: '', + }); + expect(test.get('result')).toBe(''); + }); + }); + + describe('from date', () => { + it('now', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'string' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: now, + }); + expect(test.get('result')).toBe(now.toISOString()); + }); + }); + }); + + describe('date', () => { + describe('from boolean', () => { + it('true', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'boolean', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: true, + }); + expect(test.get('result')).toBe(null); + }); + }); + + describe('from number', () => { + it('zero', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'integer', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 0, + }); + expect(test.get('result')).toEqual(new Date(0)); + }); + + it('positive float', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 123.456, + }); + expect(test.get('result')).toEqual(new Date(123.456)); + }); + + it('negative float', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'float', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: -123.456, + }); + expect(test.get('result')).toEqual(new Date(-123.456)); + }); + }); + + describe('from bigint', () => { + it('in range', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: BigInt(now.valueOf()), + }); + expect(test.get('result')).toEqual(new Date(now)); + }); + + it('out of range', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'bigInt', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: BigInt(Number.MAX_SAFE_INTEGER), + }); + expect(test.get('result')).toBe(null); + }); + }); + + describe('from string', () => { + it('valid date string', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: now.toISOString(), + }); + expect(test.get('result')).toEqual(now); + }); + + it('invalid date string', async () => { + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'string', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: 'xxx', + }); + expect(test.get('result')).toBe(null); + }); + }); + + describe('from date', () => { + it('now', async () => { + const now = new Date(); + const expression = '{{a}}'; + const Test = db.collection({ + name: 'tests', + fields: [ + { type: 'date', name: 'a' }, + { name: 'result', type: 'formula', expression, engine: 'formula.js', dataType: 'date' }, + ], + }); + + await db.sync(); + + const test = await Test.model.create({ + a: now, + }); + expect(test.get('result')).toEqual(now); + }); + }); + }); + }); +}); diff --git a/packages/plugins/formula-field/src/server/formula-field.ts b/packages/plugins/formula-field/src/server/formula-field.ts new file mode 100644 index 000000000..62c982316 --- /dev/null +++ b/packages/plugins/formula-field/src/server/formula-field.ts @@ -0,0 +1,294 @@ +import { DataTypes } from 'sequelize'; + +import { BaseFieldOptions, Field } from '@nocobase/database'; +import evaluators from '@nocobase/evaluators'; + +export interface FormulaFieldOptions extends BaseFieldOptions { + type: 'formula', + engine: string; + expression: string; +} + +const DataTypeMap = { + boolean: { + type: DataTypes.BOOLEAN, + transformers: Boolean + }, + integer: { + type: DataTypes.INTEGER, + transformers: { + boolean(value: boolean) { + return Number(value); + }, + number(value: number) { + return value >= 0 ? Math.floor(value) : Math.ceil(value); + }, + bigint(value: bigint) { + return Number(value); + }, + string(value: string) { + const result = Number.parseInt(value, 10); + if (Number.isNaN(result) || !Number.isFinite(result)) { + return null; + } + return result; + }, + date(value: Date) { + const result = value.valueOf(); + if (Number.isNaN(result)) { + return null; + } + return result; + } + } + }, + bigInt: { + type: DataTypes.BIGINT, + transformers: { + boolean(value: boolean) { + return Number(value); + }, + number(value: number) { + return Math.floor(value >= 0 ? Math.floor(value) : Math.ceil(value)); + }, + bigint(value: bigint) { + return Number(value); + }, + string(value: string) { + const result = Number.parseInt(value, 10); + if (Number.isNaN(result) || !Number.isFinite(result)) { + return null; + } + return result; + }, + date(value: Date) { + const result = value.valueOf(); + if (Number.isNaN(result)) { + return null; + } + return result; + } + } + }, + double: { + type: DataTypes.DOUBLE, + transformers: { + boolean(value: boolean) { + return Number(value); + }, + number(value: number) { + return value; + }, + bigint(value: bigint) { + return Number(value); + }, + string(value: string) { + const result = Number.parseFloat(value); + if (Number.isNaN(result) || !Number.isFinite(result)) { + return null; + } + return result; + }, + date(value: Date) { + const result = value.valueOf(); + if (Number.isNaN(result)) { + return null; + } + return result; + } + } + }, + decimal: { + type: DataTypes.DECIMAL, + transformers: { + boolean(value: boolean) { + return Number(value); + }, + number(value: number) { + return value; + }, + bigint(value: bigint) { + return value; + }, + date(value: Date) { + const result = value.valueOf(); + if (Number.isNaN(result)) { + return null; + } + return result; + } + } + }, + string: { + type: DataTypes.STRING, + transformers: { + boolean(value: boolean) { + return value.toString(); + }, + number(value: number) { + return value.toString(); + }, + bigint(value: bigint) { + return value.toString(); + }, + string(value: string) { + return value; + }, + date(value: Date) { + return value.toISOString(); + } + } + }, + date: { + type: DataTypes.DATE(3), + transformers: { + boolean(value: boolean) { + return null; + }, + number(value: number) { + const result = new Date(value); + if (Number.isNaN(result.valueOf())) { + return null; + } + return result; + }, + bigint(value: bigint) { + const result = new Date(Number(value)); + if (Number.isNaN(result.valueOf())) { + return null; + } + return result; + }, + string(value: string) { + const ts = Date.parse(value); + if (Number.isNaN(ts)) { + return null; + } + return new Date(ts); + }, + date(value: Date) { + return new Date(value); + } + } + }, +} + + + +function toDbType(value, type) { + if (value == null) { + return null; + } + + let jsType: string = typeof value; + if (jsType == 'object' && value instanceof Date) { + jsType = 'date'; + } + + if (!DataTypeMap[type]) { + return null; + } + + const { transformers } = DataTypeMap[type]; + + if (typeof transformers === 'function') { + return transformers(value); + } + + const transformer = transformers[jsType]; + return transformer ? transformer(value) : null; +} + +export class FormulaField extends Field { + get dataType() { + const { dataType } = this.options; + return DataTypeMap[dataType]?.type ?? DataTypes.DOUBLE; + } + + calculate(scope) { + const { expression, engine = 'math.js', dataType = 'double' } = this.options; + const evaluate = evaluators.get(engine); + try { + const result = evaluate(expression, scope); + return toDbType(result, dataType); + } catch (e){ + console.error(e); + } + return null; + } + + initFieldData = async ({ transaction }) => { + const { name } = this.options; + + const records = await this.collection.repository.find({ + order: [this.collection.model.primaryKeyAttribute], + transaction, + }); + + for (const record of records) { + const scope = record.toJSON(); + const result = this.calculate(scope); + if (result != null) { + await record.update( + { + [name]: result, + }, + { + transaction, + silent: true, + hooks: false, + }, + ); + } + } + }; + + calculateField = async (instance) => { + const { name } = this.options; + const result = this.calculate(instance.toJSON()); + instance.set(name, result); + }; + + updateFieldData = async (instance, { transaction }) => { + if (this.collection.name === instance.collectionName && instance.name === this.options.name) { + this.options = Object.assign(this.options, instance.options); + const { name } = this.options; + + const records = await this.collection.repository.find({ + order: [this.collection.model.primaryKeyAttribute], + transaction, + }); + + for (const record of records) { + const scope = record.toJSON(); + const result = this.calculate(scope); + await record.update( + { + [name]: result, + }, + { + transaction, + silent: true, + hooks: false, + }, + ); + } + } + }; + + bind() { + super.bind(); + this.on('afterSync', this.initFieldData); + // TODO: should not depends on fields table (which is defined by other plugin) + this.database.on('fields.afterUpdate', this.updateFieldData); + this.on('beforeSave', this.calculateField); + } + + unbind() { + super.unbind(); + this.off('beforeSave', this.calculateField); + // TODO: should not depends on fields table + this.database.off('fields.afterUpdate', this.updateFieldData); + this.off('afterSync', this.initFieldData); + } +} diff --git a/packages/plugins/formula-field/src/server/index.ts b/packages/plugins/formula-field/src/server/index.ts new file mode 100644 index 000000000..b68aea57f --- /dev/null +++ b/packages/plugins/formula-field/src/server/index.ts @@ -0,0 +1 @@ +export { default } from './plugin'; diff --git a/packages/plugins/formula-field/src/server/migrations/20230213161902-alter-field.ts b/packages/plugins/formula-field/src/server/migrations/20230213161902-alter-field.ts new file mode 100644 index 000000000..b20237ff9 --- /dev/null +++ b/packages/plugins/formula-field/src/server/migrations/20230213161902-alter-field.ts @@ -0,0 +1,61 @@ +import { Migration } from '@nocobase/server'; + +export default class extends Migration { + async up() { + const result = await this.app.version.satisfies('<=0.9.0-alpha.2'); + if (!result) { + return; + } + const { db } = this.context; + await db.sequelize.transaction(async (transaction) => { + const Field = db.getRepository('fields'); + const fields = await Field.find({ transaction }); + for (const field of fields) { + if (['mathFormula', 'excelFormula'].includes(field.get('type'))) { + const { options } = field; + field.set({ + type: 'formula', + interface: 'formula', + options: { + ...options, + engine: field.get('type') === 'mathFormula' ? 'math.js' : 'formula.js', + dataType: options.dataType === 'number' ? 'double' : 'string' + }, + }); + await field.save({ transaction }); + const schema = await field.getUiSchema({ transaction }); + schema.set('x-component', 'Formula.Result'); + await schema.save({ transaction }); + } + } + + const AppPlugin = db.getRepository('applicationPlugins'); + const formulaPlugin = await AppPlugin.findOne({ + filter: { + name: 'formula-field', + }, + transaction + }); + + if (!formulaPlugin) { + await AppPlugin.create({ + values: { + name: 'formula-field', + version: '0.9.0-alpha.2', + enabled: true, + installed: true, + builtin: true + }, + transaction + }); + } + + await AppPlugin.destroy({ + filter: { + name: ['math-formula-field', 'excel-formula-field'] + }, + transaction + }); + }); + } +} diff --git a/packages/plugins/map/src/client/fields/schema.ts b/packages/plugins/map/src/client/fields/schema.ts index bd2f73a78..7e3630ce1 100644 --- a/packages/plugins/map/src/client/fields/schema.ts +++ b/packages/plugins/map/src/client/fields/schema.ts @@ -5,8 +5,8 @@ import { generateNTemplate } from '../locale'; const { defaultProps } = interfacesProperties; -if (Array.isArray(defaultProps.type.enum)) { - defaultProps.type.enum.push( +if (Array.isArray(interfacesProperties.type.enum)) { + interfacesProperties.type.enum.push( { label: 'Point', value: 'point', diff --git a/packages/presets/nocobase/package.json b/packages/presets/nocobase/package.json index 325c3de14..3c39add91 100644 --- a/packages/presets/nocobase/package.json +++ b/packages/presets/nocobase/package.json @@ -12,15 +12,14 @@ "@nocobase/plugin-collection-manager": "0.9.0-alpha.2", "@nocobase/plugin-duplicator": "0.9.0-alpha.2", "@nocobase/plugin-error-handler": "0.9.0-alpha.2", - "@nocobase/plugin-excel-formula-field": "0.9.0-alpha.2", "@nocobase/plugin-export": "0.9.0-alpha.2", "@nocobase/plugin-file-manager": "0.9.0-alpha.2", + "@nocobase/plugin-formula-field": "0.9.0-alpha.2", "@nocobase/plugin-graph-collection-manager": "0.9.0-alpha.2", "@nocobase/plugin-multi-app-manager": "0.9.0-alpha.2", "@nocobase/plugin-iframe-block": "0.9.0-alpha.2", "@nocobase/plugin-import": "0.9.0-alpha.2", "@nocobase/plugin-map": "0.9.0-alpha.2", - "@nocobase/plugin-math-formula-field": "0.9.0-alpha.2", "@nocobase/plugin-oidc": "0.9.0-alpha.2", "@nocobase/plugin-saml": "0.9.0-alpha.2", "@nocobase/plugin-sample-hello": "0.9.0-alpha.2", diff --git a/packages/presets/nocobase/src/index.ts b/packages/presets/nocobase/src/index.ts index 92c0a78dd..e7a6fa372 100644 --- a/packages/presets/nocobase/src/index.ts +++ b/packages/presets/nocobase/src/index.ts @@ -25,8 +25,7 @@ export class PresetNocoBase extends Plugin { 'audit-logs', 'duplicator', 'iframe-block', - 'math-formula-field', - 'excel-formula-field', + 'formula-field', ].concat(plugins), ); }