amis-formula 2.7.2 → 2.8.0

package/esm/evalutor.js

@@ -1,9 +1,9 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 
-import { __assign } from 'tslib';
+import { __assign, __values } from 'tslib';
 import moment from 'moment';
 import upperFirst from 'lodash/upperFirst';
 import padStart from 'lodash/padStart';
@@ -14,6 +14,7 @@ import uniqWith from 'lodash/uniqWith';
 import uniqBy from 'lodash/uniqBy';
 import isEqual from 'lodash/isEqual';
 import isPlainObject from 'lodash/isPlainObject';
+import get from 'lodash/get';
 
 /**
  * @file 公式内置函数
@@ -709,6 +710,7 @@ var Evaluator = /** @class */ (function () {
      * @returns {number} 所有数值的平均值
      */
     Evaluator.prototype.fnDEVSQ = function () {
+        var e_1, _a;
         var _this = this;
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -722,9 +724,18 @@ var Evaluator = /** @class */ (function () {
         var sum = nums.reduce(function (sum, a) { return sum + a || 0; }, 0);
         var mean = sum / nums.length;
         var result = 0;
-        for (var _a = 0, nums_1 = nums; _a < nums_1.length; _a++) {
-            var num = nums_1[_a];
-            result += Math.pow(num - mean, 2);
+        try {
+            for (var nums_1 = __values(nums), nums_1_1 = nums_1.next(); !nums_1_1.done; nums_1_1 = nums_1.next()) {
+                var num = nums_1_1.value;
+                result += Math.pow(num - mean, 2);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (nums_1_1 && !nums_1_1.done && (_a = nums_1.return)) _a.call(nums_1);
+            }
+            finally { if (e_1) throw e_1.error; }
         }
         return result;
     };
@@ -738,6 +749,7 @@ var Evaluator = /** @class */ (function () {
      * @returns {number} 所有数值的平均值
      */
     Evaluator.prototype.fnAVEDEV = function () {
+        var e_2, _a;
         var _this = this;
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -754,9 +766,18 @@ var Evaluator = /** @class */ (function () {
         var sum = nums.reduce(function (sum, a) { return sum + a || 0; }, 0);
         var mean = sum / nums.length;
         var result = 0;
-        for (var _a = 0, nums_2 = nums; _a < nums_2.length; _a++) {
-            var num = nums_2[_a];
-            result += Math.abs(num - mean);
+        try {
+            for (var nums_2 = __values(nums), nums_2_1 = nums_2.next(); !nums_2_1.done; nums_2_1 = nums_2.next()) {
+                var num = nums_2_1.value;
+                result += Math.abs(num - mean);
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (nums_2_1 && !nums_2_1.done && (_a = nums_2.return)) _a.call(nums_2);
+            }
+            finally { if (e_2) throw e_2.error; }
         }
         return result / nums.length;
     };
@@ -770,6 +791,7 @@ var Evaluator = /** @class */ (function () {
      * @returns {number} 所有数值的平均值
      */
     Evaluator.prototype.fnHARMEAN = function () {
+        var e_3, _a;
         var _this = this;
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -784,9 +806,18 @@ var Evaluator = /** @class */ (function () {
         }
         var nums = arr.map(function (item) { return _this.formatNumber(item); });
         var den = 0;
-        for (var _a = 0, nums_3 = nums; _a < nums_3.length; _a++) {
-            var num = nums_3[_a];
-            den += 1 / num;
+        try {
+            for (var nums_3 = __values(nums), nums_3_1 = nums_3.next(); !nums_3_1.done; nums_3_1 = nums_3.next()) {
+                var num = nums_3_1.value;
+                den += 1 / num;
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (nums_3_1 && !nums_3_1.done && (_a = nums_3.return)) _a.call(nums_3);
+            }
+            finally { if (e_3) throw e_3.error; }
         }
         return nums.length / den;
     };
@@ -1342,7 +1373,7 @@ var Evaluator = /** @class */ (function () {
      * @returns {number} 时间戳
      */
     Evaluator.prototype.fnTIMESTAMP = function (date, format) {
-        return parseInt(moment(date).format(format === 'x' ? 'x' : 'X'), 10);
+        return parseInt(moment(this.normalizeDate(date)).format(format === 'x' ? 'x' : 'X'), 10);
     };
     /**
      * 返回今天的日期
@@ -1367,20 +1398,106 @@ var Evaluator = /** @class */ (function () {
         return new Date();
     };
     /**
-     * 将日期转成日期字符串
+     * 获取日期的星期几，
+     *
+     * 示例：
+     *
+     * WEEKDAY('2023-02-27') 得到 1
+     *
+     * @example WEEKDAY(date)
+     * @namespace 日期函数
+     * @param {any} date 日期
+     * @param {number} type 星期定义类型，默认为1，1表示0至6代表星期一到星期日，2表示1至7代表星期一到星期日
+     *
+     * @returns {number} 星期几的数字标识
+     */
+    Evaluator.prototype.fnWEEKDAY = function (date, type) {
+        var md = moment(this.normalizeDate(date));
+        return type === 2 ? md.isoWeekday() : md.weekday();
+    };
+    /**
+     * 获取年份的星期，即第几周
+     *
+     * 示例：
+     *
+     * WEEK('2023-03-05') 得到 10
+     *
+     * @example WEEK(date)
+     * @namespace 日期函数
+     * @param {any} date 日期
+     * @param {boolean} isISO 是否ISO星期
+     *
+     * @returns {number} 星期几的数字标识
+     */
+    Evaluator.prototype.fnWEEK = function (date, isISO) {
+        if (isISO === void 0) { isISO = false; }
+        var md = moment(this.normalizeDate(date));
+        return isISO ? md.isoWeek() : md.week();
+    };
+    /**
+     * 对日期、日期字符串、时间戳进行格式化
+     *
+     * 示例：
+     *
+     * DATETOSTR('12/25/2022', 'YYYY-MM-DD') 得到 '2022.12.25'
+     * DATETOSTR(1676563200, 'YYYY.MM.DD') 得到 '2023.02.17'
+     * DATETOSTR(1676563200000, 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
+     * DATETOSTR(DATE('2021-12-21'), 'YYYY.MM.DD hh:mm:ss') 得到 '2021.12.21 08:00:00'
      *
-     * @example DATETOSTR(date[, format="YYYY-MM-DD HH:mm:ss"])
      * @example DATETOSTR(date, 'YYYY-MM-DD')
      * @namespace 日期函数
-     * @param {date} date 日期对象
+     * @param {any} date 日期对象、日期字符串、时间戳
      * @param {string} format 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
      *
-     * @returns {number} 日期字符串
+     * @returns {string} 日期字符串
      */
     Evaluator.prototype.fnDATETOSTR = function (date, format) {
         if (format === void 0) { format = 'YYYY-MM-DD HH:mm:ss'; }
+        date = this.normalizeDate(date);
         return moment(date).format(format);
     };
+    /**
+     * 获取日期范围字符串中的开始时间、结束时间
+     *
+     * 示例：
+     *
+     * DATERANGESPLIT('1676563200, 1676735999') 得到 [1676563200, 1676735999]
+     * DATERANGESPLIT('1676563200, 1676735999', undefined , 'YYYY.MM.DD hh:mm:ss') 得到 [2023.02.17 12:00:00, 2023.02.18 11:59:59]
+     * DATERANGESPLIT('1676563200, 1676735999', 0 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
+     * DATERANGESPLIT('1676563200, 1676735999', 'start' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
+     * DATERANGESPLIT('1676563200, 1676735999', 1 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'
+     * DATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'
+     *
+     * @example DATERANGESPLIT(date, 'YYYY-MM-DD')
+     * @namespace 日期函数
+     * @param {string} date 日期范围字符串
+     * @param {string} key 取值标识，0或'start'表示获取开始时间，1或'end'表示获取结束时间
+     * @param {string} format 日期格式，可选
+     * @param {string} delimiter 分隔符，可选，默认为','
+     *
+     * @returns {string} 日期字符串
+     */
+    Evaluator.prototype.fnDATERANGESPLIT = function (daterange, key, format, delimiter) {
+        var _this = this;
+        if (delimiter === void 0) { delimiter = ','; }
+        if (!daterange || typeof daterange !== 'string') {
+            return daterange;
+        }
+        var dateArr = daterange
+            .split(delimiter)
+            .map(function (item) {
+            return item && format
+                ? moment(_this.normalizeDate(item.trim())).format(format)
+                : item.trim();
+        });
+        if ([0, '0', 'start'].includes(key)) {
+            return dateArr[0];
+        }
+        if ([1, '1', 'end'].includes(key)) {
+            return dateArr[1];
+        }
+        return dateArr;
+    };
     /**
      * 返回日期的指定范围的开端
      *
@@ -1388,12 +1505,12 @@ var Evaluator = /** @class */ (function () {
      * @example STARTOF(date[unit = "day"])
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @param {string} format 日期格式，可选
      * @returns {date} 新的日期对象
      */
-    Evaluator.prototype.fnSTARTOF = function (date, unit) {
-        return moment(date)
-            .startOf(unit || 'day')
-            .toDate();
+    Evaluator.prototype.fnSTARTOF = function (date, unit, format) {
+        var md = moment(this.normalizeDate(date)).startOf(unit || 'day');
+        return format ? md.format(format) : md.toDate();
     };
     /**
      * 返回日期的指定范围的末尾
@@ -1401,19 +1518,22 @@ var Evaluator = /** @class */ (function () {
      * @example ENDOF(date[unit = "day"])
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @param {string} format 日期格式，可选
      * @returns {date} 新的日期对象
      */
-    Evaluator.prototype.fnENDOF = function (date, unit) {
-        return moment(date)
-            .endOf(unit || 'day')
-            .toDate();
+    Evaluator.prototype.fnENDOF = function (date, unit, format) {
+        var md = moment(this.normalizeDate(date)).endOf(unit || 'day');
+        return format ? md.format(format) : md.toDate();
     };
     Evaluator.prototype.normalizeDate = function (raw) {
-        if (typeof raw === 'number' || !isNaN(raw)) {
-            return new Date(Number(raw));
-        }
-        if (typeof raw === 'string') {
+        if (typeof raw === 'string' || typeof raw === 'number') {
             var formats = ['', 'YYYY-MM-DD HH:mm:ss', 'X'];
+            if (/^\d{10}((\.\d+)*)$/.test(raw.toString())) {
+                formats = ['X', 'x', 'YYYY-MM-DD HH:mm:ss', ''];
+            }
+            else if (/^\d{13}((\.\d+)*)$/.test(raw.toString())) {
+                formats = ['x', 'X', 'YYYY-MM-DD HH:mm:ss', ''];
+            }
             while (formats.length) {
                 var format = formats.shift();
                 var date = moment(raw, format);
@@ -1424,6 +1544,12 @@ var Evaluator = /** @class */ (function () {
         }
         return raw;
     };
+    Evaluator.prototype.normalizeDateRange = function (raw) {
+        var _this = this;
+        return (Array.isArray(raw) ? raw : raw.split(',')).map(function (item) {
+            return _this.normalizeDate(String(item).trim());
+        });
+    };
     /**
      * 返回日期的年份
      * @namespace 日期函数
@@ -1610,6 +1736,25 @@ var Evaluator = /** @class */ (function () {
         b = this.normalizeDate(b);
         return moment(a).isAfter(moment(b), unit);
     };
+    /**
+     * 判断日期是否在指定范围内
+     *
+     * 示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])
+     *
+     * @param {any} date 第一个日期
+     * @param {any[]} daterange 日期范围
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @param {string} inclusivity 包容性规则，默认为'[]'。[ 表示包含、( 表示排除，如果使用包容性参数，则必须传入两个指示符，如'()'表示左右范围都排除
+     * @namespace 日期函数
+     * @example BETWEENRANGE(date, [start, end])
+     * @returns {boolean} 判断结果
+     */
+    Evaluator.prototype.fnBETWEENRANGE = function (date, daterange, unit, inclusivity) {
+        if (unit === void 0) { unit = 'day'; }
+        if (inclusivity === void 0) { inclusivity = '[]'; }
+        var range = this.normalizeDateRange(daterange);
+        return moment(this.normalizeDate(date)).isBetween(range[0], range[1], unit, inclusivity);
+    };
     /**
      * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
      *
@@ -1690,6 +1835,114 @@ var Evaluator = /** @class */ (function () {
             return _this.callAnonymousFunction(iterator, [item, index, arr]);
         });
     };
+    /**
+     * 数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 找出第二个箭头函数返回为 true 的成员的索引。
+     *
+     * 示例：
+     *
+     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYFINDINDEX(arr, item => item === 2)
+     * @returns {number} 结果
+     */
+    Evaluator.prototype.fnARRAYFINDINDEX = function (arr, iterator) {
+        var _this = this;
+        if (!iterator || iterator.type !== 'anonymous_function') {
+            throw new Error('expected an anonymous function get ' + iterator);
+        }
+        return (Array.isArray(arr) ? arr : []).findIndex(function (item, index, arr) {
+            return _this.callAnonymousFunction(iterator, [item, index, arr]);
+        });
+    };
+    /**
+     * 数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 找出第二个箭头函数返回为 true 的成员。
+     *
+     * 示例：
+     *
+     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYFIND(arr, item => item === 2)
+     * @returns {any} 结果
+     */
+    Evaluator.prototype.fnARRAYFIND = function (arr, iterator) {
+        var _this = this;
+        if (!iterator || iterator.type !== 'anonymous_function') {
+            throw new Error('expected an anonymous function get ' + iterator);
+        }
+        return (Array.isArray(arr) ? arr : []).find(function (item, index, arr) {
+            return _this.callAnonymousFunction(iterator, [item, index, arr]);
+        });
+    };
+    /**
+     * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 判断第二个箭头函数是否存在返回为 true 的成员。
+     *
+     * 示例：
+     *
+     * ARRAYSOME([0, 2, false], item => item === 2) 得到 true
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYSOME(arr, item => item === 2)
+     * @returns {boolean} 结果
+     */
+    Evaluator.prototype.fnARRAYSOME = function (arr, iterator) {
+        var _this = this;
+        if (!iterator || iterator.type !== 'anonymous_function') {
+            throw new Error('expected an anonymous function get ' + iterator);
+        }
+        return (Array.isArray(arr) ? arr : []).some(function (item, index, arr) {
+            return _this.callAnonymousFunction(iterator, [item, index, arr]);
+        });
+    };
+    /**
+     * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 判断第二个箭头函数返回是否都为 true。
+     *
+     * 示例：
+     *
+     * ARRAYEVERY([0, 2, false], item => item === 2) 得到 false
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYEVERY(arr, item => item === 2)
+     * @returns {boolean} 结果
+     */
+    Evaluator.prototype.fnARRAYEVERY = function (arr, iterator) {
+        var _this = this;
+        if (!iterator || iterator.type !== 'anonymous_function') {
+            throw new Error('expected an anonymous function get ' + iterator);
+        }
+        return (Array.isArray(arr) ? arr : []).every(function (item, index, arr) {
+            return _this.callAnonymousFunction(iterator, [item, index, arr]);
+        });
+    };
+    /**
+     * 判断数据中是否存在指定元素
+     *
+     * 示例：
+     *
+     * ARRAYINCLUDES([0, 2, false], 2) 得到 true
+     *
+     * @param {Array<any>} arr 数组
+     * @param {any} item 元素
+     * @namespace 数组
+     * @example ARRAYINCLUDES(arr, 2)
+     * @returns {any} 结果
+     */
+    Evaluator.prototype.fnARRAYINCLUDES = function (arr, item) {
+        return (Array.isArray(arr) ? arr : []).includes(item);
+    };
     /**
      * 数组过滤掉 false、null、0 和 ""
      *
@@ -1703,14 +1956,24 @@ var Evaluator = /** @class */ (function () {
      * @returns {Array<any>} 结果
      */
     Evaluator.prototype.fnCOMPACT = function (arr) {
+        var e_4, _a;
         if (Array.isArray(arr)) {
             var resIndex = 0;
             var result = [];
-            for (var _i = 0, arr_1 = arr; _i < arr_1.length; _i++) {
-                var item = arr_1[_i];
-                if (item) {
-                    result[resIndex++] = item;
+            try {
+                for (var arr_1 = __values(arr), arr_1_1 = arr_1.next(); !arr_1_1.done; arr_1_1 = arr_1.next()) {
+                    var item = arr_1_1.value;
+                    if (item) {
+                        result[resIndex++] = item;
+                    }
+                }
+            }
+            catch (e_4_1) { e_4 = { error: e_4_1 }; }
+            finally {
+                try {
+                    if (arr_1_1 && !arr_1_1.done && (_a = arr_1.return)) _a.call(arr_1);
                 }
+                finally { if (e_4) throw e_4.error; }
             }
             return result;
         }
@@ -1779,13 +2042,64 @@ var Evaluator = /** @class */ (function () {
     Evaluator.prototype.fnUNIQ = function (arr, field) {
         return field ? uniqBy(arr, field) : uniqWith(arr, isEqual);
     };
+    /**
+     * 将JS对象转换成JSON字符串
+     *
+     * 示例：
+     *
+     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'
+     *
+     * @param {object} obj JS对象
+     * @namespace 编码
+     * @example ENCODEJSON({name: 'amis'})
+     * @returns {string} 结果
+     */
+    Evaluator.prototype.fnENCODEJSON = function (obj) {
+        return JSON.stringify(obj);
+    };
+    /**
+     * 解析JSON编码数据，返回JS对象
+     *
+     * 示例：
+     *
+     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}
+     *
+     * @param {string} str 字符串
+     * @namespace 编码
+     * @example DECODEJSON('{\"name\": "amis"}')
+     * @returns {object} 结果
+     */
+    Evaluator.prototype.fnDECODEJSON = function (str) {
+        return JSON.parse(str);
+    };
+    /**
+     * 根据对象或者数组的path路径获取值。 如果解析 value 是 undefined 会以 defaultValue 取代
+     *
+     * 示例：
+     *
+     * GET([0, 2, {name: 'amis', age: 18}], 1) 得到 2
+     * GET([0, 2, {name: 'amis', age: 18}], '2.name') 得到 'amis'
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr[0].name') 得到 'amis'
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.0.name') 得到 'amis'
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.1.name', 'not-found') 得到 'not-found'
+     *
+     * @param {any} obj 对象或数组
+     * @param {string} path 路径
+     * @param {any} defaultValue 如果解析不到则返回该值
+     * @namespace 其他
+     * @example GET(arr, 2)
+     * @returns {any} 结果
+     */
+    Evaluator.prototype.fnGET = function (obj, path, defaultValue) {
+        return get(obj, path, defaultValue);
+    };
     /**
      * 判断是否为类型支持：string, number, array, date, plain-object。
      *
      * @param {string} 判断对象
      * @namespace 其他
      * @example ISTYPE([{a: '1'}, {b: '2'}, {a: '1'}], 'array')
-     * @returns {boolean} 结果结果
+     * @returns {boolean} 结果
      */
     Evaluator.prototype.fnISTYPE = function (target, type) {
         switch (type) {

package/esm/filter.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 

package/esm/function.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 

package/esm/index.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 

package/esm/lexer.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 

package/esm/parser.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */