amis-formula 6.9.0 → 6.10.0-beta.0

package/lib/evalutor.d.ts

@@ -281,7 +281,7 @@ export declare class Evaluator {
     /**
      * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MAX(num1, num2, ...numN)
+     * @example MAX(num1, num2, ...numN) or MAX([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -291,7 +291,7 @@ export declare class Evaluator {
     /**
      * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MIN(num1, num2, ...numN)
+     * @example MIN(num1, num2, ...numN) or MIN([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -301,7 +301,7 @@ export declare class Evaluator {
     /**
      * 求和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example SUM(num1, num2, ...numN)
+     * @example SUM(num1, num2, ...numN) or SUM([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -384,7 +384,7 @@ export declare class Evaluator {
     /**
      * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example AVG(num1, num2, ...numN)
+     * @example AVG(num1, num2, ...numN) or AVG([num1, num2, ...numN])
      * @param {...number} num - 要处理的数字
      * @namespace 数学函数
      *
@@ -580,7 +580,7 @@ export declare class Evaluator {
      *
      * @returns {string} 结果文本
      */
-    fnUPPERFIRST(text: string): string;
+    fnUPPERFIRST(text: string): Capitalize<string>;
     /**
      * 向前补齐文本长度。
      *
@@ -712,7 +712,7 @@ export declare class Evaluator {
      * @param {string} startString - 起始文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnSTARTSWITH(text: string, search: string): boolean;
     /**
@@ -723,7 +723,7 @@ export declare class Evaluator {
      * @param {string} endString - 结束文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnENDSWITH(text: string, search: string): boolean;
     /**
@@ -734,7 +734,7 @@ export declare class Evaluator {
      * @param {string} searchText - 搜索文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnCONTAINS(text: string, search: string): boolean;
     /**
@@ -764,13 +764,17 @@ export declare class Evaluator {
     /**
      * 返回文本字符串中从指定位置开始的特定数目的字符。
      *
+     * 示例：`MID("amis.baidu.com", 6, 3)`，
+     *
+     * 返回 `aid`。
+     *
      * @example MID(text, from, len)
      * @param {string} text - 要处理的文本
      * @param {number} from - 起始位置
      * @param {number} len - 处理长度
      * @namespace 文本函数
      *
-     * @returns {number} 命中的位置
+     * @returns {string} 命中的位置
      */
     fnMID(text: string, from: number, len: number): string;
     /**
@@ -778,7 +782,7 @@ export declare class Evaluator {
      *
      * 示例：`/home/amis/a.json`，
      *
-     * 返回：a.json`。
+     * 返回：`a.json`。
      *
      * @example BASENAME(text)
      * @param {string} text - 要处理的文本
@@ -919,7 +923,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     fnSTARTOF(date: Date, unit?: any, format?: string): string | Date;
     /**
@@ -930,7 +934,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     fnENDOF(date: Date, unit?: any, format?: string): string | Date;
     normalizeDate(raw: any): Date;
@@ -1122,28 +1126,38 @@ export declare class Evaluator {
      * @param {Array<any>} arr 数组
      * @namespace 数组
      * @example COUNT(arr)
-     * @returns {boolean} 结果
+     * @returns {number} 结果
      */
     fnCOUNT(value: any): number;
     /**
      * 数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      *
+     * 将数组中的每个元素转换成箭头函数返回的值。
+     *
+     * 示例：
+     *
+     * ARRAYMAP([1, 2, 3], item => item + 1) 得到 [2, 3, 4]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYMAP(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回转换后的数组
      */
     fnARRAYMAP(value: any, iterator: any): any[];
     /**
      * 数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      * 将第二个箭头函数返回为 false 的成员过滤掉。
      *
+     * 示例：
+     *
+     * ARRAYFILTER([1, 2, 3], item => item > 1) 得到 [2, 3]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYFILTER(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回过滤后的数组
      */
     fnARRAYFILTER(value: any, iterator: any): any[];
     /**
@@ -1244,7 +1258,7 @@ export declare class Evaluator {
      * @param { String} separator 分隔符
      * @namespace 数组
      * @example JOIN(arr, string)
-     * @returns {String} 结果
+     * @returns {string} 结果
      */
     fnJOIN(arr: any[], separator?: string): string;
     /**
@@ -1265,7 +1279,7 @@ export declare class Evaluator {
      *
      * 示例：
      *
-     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。
+     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]) 得到 [{a: '1'}, {b: '2'}]。
      *
      * @param {Array<any>} arr 数组
      * @param {string} field 字段

package/lib/evalutor.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 
@@ -598,7 +598,7 @@ var Evaluator = /** @class */ (function () {
     /**
      * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MAX(num1, num2, ...numN)
+     * @example MAX(num1, num2, ...numN) or MAX([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -616,7 +616,7 @@ var Evaluator = /** @class */ (function () {
     /**
      * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MIN(num1, num2, ...numN)
+     * @example MIN(num1, num2, ...numN) or MIN([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -634,7 +634,7 @@ var Evaluator = /** @class */ (function () {
     /**
      * 求和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example SUM(num1, num2, ...numN)
+     * @example SUM(num1, num2, ...numN) or SUM([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -763,7 +763,7 @@ var Evaluator = /** @class */ (function () {
     /**
      * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example AVG(num1, num2, ...numN)
+     * @example AVG(num1, num2, ...numN) or AVG([num1, num2, ...numN])
      * @param {...number} num - 要处理的数字
      * @namespace 数学函数
      *
@@ -1007,7 +1007,7 @@ var Evaluator = /** @class */ (function () {
         if (!this.isValidValue(base) || !this.isValidValue(exponent)) {
             return base;
         }
-        return Math.pow(base, exponent);
+        return Math.pow(this.formatNumber(base), this.formatNumber(exponent));
     };
     // 文本函数
     Evaluator.prototype.normalizeText = function (raw) {
@@ -1054,6 +1054,9 @@ var Evaluator = /** @class */ (function () {
      * @returns {number} 长度
      */
     Evaluator.prototype.fnLEN = function (text) {
+        if (text === undefined || text === null) {
+            return 0;
+        }
         text = this.normalizeText(text);
         return text === null || text === void 0 ? void 0 : text.length;
     };
@@ -1071,7 +1074,7 @@ var Evaluator = /** @class */ (function () {
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
-        return this.fnLEN.call(this, args);
+        return this.fnLEN.apply(this, args);
     };
     /**
      * 判断文本是否为空。
@@ -1099,7 +1102,7 @@ var Evaluator = /** @class */ (function () {
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
-        return args.join('');
+        return args.map(this.normalizeText).join('');
     };
     /**
      * 返回计算机字符集的数字代码所对应的字符。
@@ -1315,7 +1318,7 @@ var Evaluator = /** @class */ (function () {
      * @param {string} startString - 起始文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     Evaluator.prototype.fnSTARTSWITH = function (text, search) {
         search = this.normalizeText(search);
@@ -1333,7 +1336,7 @@ var Evaluator = /** @class */ (function () {
      * @param {string} endString - 结束文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     Evaluator.prototype.fnENDSWITH = function (text, search) {
         search = this.normalizeText(search);
@@ -1351,7 +1354,7 @@ var Evaluator = /** @class */ (function () {
      * @param {string} searchText - 搜索文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     Evaluator.prototype.fnCONTAINS = function (text, search) {
         search = this.normalizeText(search);
@@ -1421,13 +1424,17 @@ var Evaluator = /** @class */ (function () {
     /**
      * 返回文本字符串中从指定位置开始的特定数目的字符。
      *
+     * 示例：`MID("amis.baidu.com", 6, 3)`，
+     *
+     * 返回 `aid`。
+     *
      * @example MID(text, from, len)
      * @param {string} text - 要处理的文本
      * @param {number} from - 起始位置
      * @param {number} len - 处理长度
      * @namespace 文本函数
      *
-     * @returns {number} 命中的位置
+     * @returns {string} 命中的位置
      */
     Evaluator.prototype.fnMID = function (text, from, len) {
         text = this.normalizeText(text);
@@ -1440,7 +1447,7 @@ var Evaluator = /** @class */ (function () {
      *
      * 示例：`/home/amis/a.json`，
      *
-     * 返回：a.json`。
+     * 返回：`a.json`。
      *
      * @example BASENAME(text)
      * @param {string} text - 要处理的文本
@@ -1631,7 +1638,7 @@ var Evaluator = /** @class */ (function () {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     Evaluator.prototype.fnSTARTOF = function (date, unit, format) {
         var md = moment__default["default"](this.normalizeDate(date)).startOf(unit || 'day');
@@ -1645,7 +1652,7 @@ var Evaluator = /** @class */ (function () {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     Evaluator.prototype.fnENDOF = function (date, unit, format) {
         var md = moment__default["default"](this.normalizeDate(date)).endOf(unit || 'day');
@@ -1928,7 +1935,7 @@ var Evaluator = /** @class */ (function () {
      * @param {Array<any>} arr 数组
      * @namespace 数组
      * @example COUNT(arr)
-     * @returns {boolean} 结果
+     * @returns {number} 结果
      */
     Evaluator.prototype.fnCOUNT = function (value) {
         return Array.isArray(value) ? value.length : value ? 1 : 0;
@@ -1936,11 +1943,17 @@ var Evaluator = /** @class */ (function () {
     /**
      * 数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      *
+     * 将数组中的每个元素转换成箭头函数返回的值。
+     *
+     * 示例：
+     *
+     * ARRAYMAP([1, 2, 3], item => item + 1) 得到 [2, 3, 4]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYMAP(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回转换后的数组
      */
     Evaluator.prototype.fnARRAYMAP = function (value, iterator) {
         var _this = this;
@@ -1955,11 +1968,15 @@ var Evaluator = /** @class */ (function () {
      * 数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      * 将第二个箭头函数返回为 false 的成员过滤掉。
      *
+     * 示例：
+     *
+     * ARRAYFILTER([1, 2, 3], item => item > 1) 得到 [2, 3]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYFILTER(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回过滤后的数组
      */
     Evaluator.prototype.fnARRAYFILTER = function (value, iterator) {
         var _this = this;
@@ -2127,7 +2144,7 @@ var Evaluator = /** @class */ (function () {
      * @param { String} separator 分隔符
      * @namespace 数组
      * @example JOIN(arr, string)
-     * @returns {String} 结果
+     * @returns {string} 结果
      */
     Evaluator.prototype.fnJOIN = function (arr, separator) {
         if (separator === void 0) { separator = ''; }
@@ -2165,7 +2182,7 @@ var Evaluator = /** @class */ (function () {
      *
      * 示例：
      *
-     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。
+     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]) 得到 [{a: '1'}, {b: '2'}]。
      *
      * @param {Array<any>} arr 数组
      * @param {string} field 字段

package/lib/evalutorForAsync.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/lib/filter.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/lib/function.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/lib/index.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/lib/lexer.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/lib/parser.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amis-formula",
-  "version": "6.9.0",
+  "version": "6.10.0-beta.0",
   "description": "负责 amis 里面的表达式实现，内置公式，编辑器等",
   "main": "lib/index.js",
   "module": "esm/index.js",