amis-formula 1.2.6 → 1.3.0

package/README.md

@@ -1,5 +1,5 @@
 # amis-tpl
 
-负责 amis 里面的表达式实现，内置公式，编辑器等
+负责 amis 里面的表达式、公式及模板的实现
 
 属于 [amis](https://github.com/baidu/amis) 子项目

package/dist/doc.js

@@ -320,6 +320,79 @@ export default [
     },
     namespace: "数学函数"
   },
+  {
+    name: "DEVSQ",
+    description: "返回数据点与数据均值点之差（数据偏差）的平方和",
+    example: "DEVSQ(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "AVEDEV",
+    description: "数据点到其算术平均值的绝对偏差的平均值",
+    example: "AVEDEV(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "HARMEAN",
+    description: "数据点的调和平均值",
+    example: "HARMEAN(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "LARGE",
+    description: "数据集中第 k 个最大值",
+    example: "LARGE(array, k)",
+    params: [
+      {
+        type: "array",
+        name: "nums",
+        description: "要处理的数字"
+      },
+      {
+        type: "number",
+        name: "k",
+        description: "第几大"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
   {
     name: "UPPERMONEY",
     description: "将数值转为中文大写金额",
@@ -511,6 +584,128 @@ export default [
     },
     namespace: "文本函数"
   },
+  {
+    name: "UPPERFIRST",
+    description: "将传入文本首字母转成大写",
+    example: "UPPERFIRST(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "PADSTART",
+    description: "向前补齐文本长度\n\n示例 `PADSTART(\"6\", 2, \"0\")`\n\n返回 `06`",
+    example: "PADSTART(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "number",
+        name: "num",
+        description: "目标长度"
+      },
+      {
+        type: "string",
+        name: "pad",
+        description: "用于补齐的文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "CAPITALIZE",
+    description: "将文本转成标题\n\n示例 `CAPITALIZE(\"star\")`\n\n返回 `Star`",
+    example: "CAPITALIZE(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "ESCAPE",
+    description: "对文本进行 HTML 转义\n\n示例 `ESCAPE(\"star\")`\n\n返回 `Star`",
+    example: "ESCAPE(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "TRUNCATE",
+    description: "对文本长度进行截断\n\n示例 `TRUNCATE(\"amis.baidu.com\", 6)`\n\n返回 `amis...`",
+    example: "TRUNCATE(text, 6)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "number",
+        name: "text",
+        description: "最长长度"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "BEFORELAST",
+    description: "取在某个分隔符之前的所有字符串",
+    example: "BEFORELAST(text, '.')",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "string",
+        name: "delimiter",
+        description: "结束文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "判断结果"
+    },
+    namespace: "文本函数"
+  },
   {
     name: "SPLIT",
     description: "将文本根据指定片段分割成数组\n\n示例：`SPLIT(\"a,b,c\", \",\")`\n\n返回 `[\"a\", \"b\", \"c\"]`",
@@ -550,6 +745,40 @@ export default [
     },
     namespace: "文本函数"
   },
+  {
+    name: "STRIPTAG",
+    description: "去除文本中的 HTML 标签\n\n示例：`STRIPTAG(\"<b>amis</b>\")`\n\n返回：`amis`",
+    example: "STRIPTAG(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "处理后的文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "LINEBREAK",
+    description: "将字符串中的换行转成 HTML `<br>`，用于简单换行的场景\n\n示例：`LINEBREAK(\"\\n\")`\n\n返回：`<br/>`",
+    example: "LINEBREAK(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "处理后的文本"
+    },
+    namespace: "文本函数"
+  },
   {
     name: "STARTSWITH",
     description: "判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False",
@@ -572,6 +801,28 @@ export default [
     },
     namespace: "文本函数"
   },
+  {
+    name: "ENDSWITH",
+    description: "判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False",
+    example: "ENDSWITH(text, '片段')",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "string",
+        name: "endString",
+        description: "结束文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "判断结果"
+    },
+    namespace: "文本函数"
+  },
   {
     name: "CONTAINS",
     description: "判断参数 1 中的文本是否包含参数 2 中的文本。",

package/dist/doc.md

@@ -195,6 +195,47 @@
 
 返回所有参数的平均值
 
+### DEVSQ
+
+用法：`DEVSQ(num1, num2, ...numN)`
+
+ * `num:...number` 要处理的数字
+
+返回：`number` 所有数值的平均值
+
+返回数据点与数据均值点之差（数据偏差）的平方和
+
+### AVEDEV
+
+用法：`AVEDEV(num1, num2, ...numN)`
+
+ * `num:...number` 要处理的数字
+
+返回：`number` 所有数值的平均值
+
+数据点到其算术平均值的绝对偏差的平均值
+
+### HARMEAN
+
+用法：`HARMEAN(num1, num2, ...numN)`
+
+ * `num:...number` 要处理的数字
+
+返回：`number` 所有数值的平均值
+
+数据点的调和平均值
+
+### LARGE
+
+用法：`LARGE(array, k)`
+
+ * `nums:array` 要处理的数字
+ * `k:number` 第几大
+
+返回：`number` 所有数值的平均值
+
+数据集中第 k 个最大值
+
 ### UPPERMONEY
 
 用法：`UPPERMONEY(num)`
@@ -311,6 +352,86 @@
 
 将传入文本转成大写
 
+### UPPERFIRST
+
+用法：`UPPERFIRST(text)`
+
+ * `text:string` 文本
+
+返回：`string` 结果文本
+
+将传入文本首字母转成大写
+
+### PADSTART
+
+用法：`PADSTART(text)`
+
+ * `text:string` 文本
+ * `num:number` 目标长度
+ * `pad:string` 用于补齐的文本
+
+返回：`string` 结果文本
+
+向前补齐文本长度
+
+示例 `PADSTART("6", 2, "0")`
+
+返回 `06`
+
+### CAPITALIZE
+
+用法：`CAPITALIZE(text)`
+
+ * `text:string` 文本
+
+返回：`string` 结果文本
+
+将文本转成标题
+
+示例 `CAPITALIZE("star")`
+
+返回 `Star`
+
+### ESCAPE
+
+用法：`ESCAPE(text)`
+
+ * `text:string` 文本
+
+返回：`string` 结果文本
+
+对文本进行 HTML 转义
+
+示例 `ESCAPE("star")`
+
+返回 `Star`
+
+### TRUNCATE
+
+用法：`TRUNCATE(text, 6)`
+
+ * `text:string` 文本
+ * `text:number` 最长长度
+
+返回：`string` 结果文本
+
+对文本长度进行截断
+
+示例 `TRUNCATE("amis.baidu.com", 6)`
+
+返回 `amis...`
+
+### BEFORELAST
+
+用法：`BEFORELAST(text, '.')`
+
+ * `text:string` 文本
+ * `delimiter:string` 结束文本
+
+返回：`string` 判断结果
+
+取在某个分隔符之前的所有字符串
+
 ### SPLIT
 
 用法：`SPLIT(text, ',')`
@@ -336,6 +457,34 @@
 
 将文本去除前后空格
 
+### STRIPTAG
+
+用法：`STRIPTAG(text)`
+
+ * `text:string` 文本
+
+返回：`string` 处理后的文本
+
+去除文本中的 HTML 标签
+
+示例：`STRIPTAG("<b>amis</b>")`
+
+返回：`amis`
+
+### LINEBREAK
+
+用法：`LINEBREAK(text)`
+
+ * `text:string` 文本
+
+返回：`string` 处理后的文本
+
+将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+
+示例：`LINEBREAK("\n")`
+
+返回：`<br/>`
+
 ### STARTSWITH
 
 用法：`STARTSWITH(text, '片段')`
@@ -347,6 +496,17 @@
 
 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
 
+### ENDSWITH
+
+用法：`ENDSWITH(text, '片段')`
+
+ * `text:string` 文本
+ * `endString:string` 结束文本
+
+返回：`string` 判断结果
+
+判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
+
 ### CONTAINS
 
 用法：`CONTAINS(text, searchText)`

package/dist/evalutor.d.ts

@@ -9,6 +9,10 @@ export interface FunctionMap {
 }
 export interface FilterContext {
     data: Object;
+    filter?: {
+        name: string;
+        args: Array<any>;
+    };
     restFilters: Array<{
         name: string;
         args: Array<any>;
@@ -391,6 +395,47 @@ export declare class Evaluator {
      * @returns {number} 所有数值的平均值
      */
     fnAVG(...args: Array<any>): number;
+    /**
+     * 返回数据点与数据均值点之差（数据偏差）的平方和
+     *
+     * @example DEVSQ(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnDEVSQ(...args: Array<any>): number | null;
+    /**
+     * 数据点到其算术平均值的绝对偏差的平均值
+     *
+     * @example AVEDEV(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnAVEDEV(...args: Array<any>): number | null;
+    /**
+     * 数据点的调和平均值
+     *
+     * @example HARMEAN(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnHARMEAN(...args: Array<any>): number | null;
+    /**
+     * 数据集中第 k 个最大值
+     *
+     * @example LARGE(array, k)
+     * @param {array} nums - 要处理的数字
+     * @param {number}  k - 第几大
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnLARGE(nums: Array<any>, k: number): any;
     /**
      * 将数值转为中文大写金额
      *
@@ -509,6 +554,86 @@ export declare class Evaluator {
      * @returns {string} 结果文本
      */
     fnUPPER(text: string): string;
+    /**
+     * 将传入文本首字母转成大写
+     *
+     * @example UPPERFIRST(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnUPPERFIRST(text: string): string;
+    /**
+     * 向前补齐文本长度
+     *
+     * 示例 `PADSTART("6", 2, "0")`
+     *
+     * 返回 `06`
+     *
+     * @example PADSTART(text)
+     * @param {string} text - 文本
+     * @param {number} num - 目标长度
+     * @param {string} pad - 用于补齐的文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnPADSTART(text: string, num: number, pad: string): string;
+    /**
+     * 将文本转成标题
+     *
+     * 示例 `CAPITALIZE("star")`
+     *
+     * 返回 `Star`
+     *
+     * @example CAPITALIZE(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnCAPITALIZE(text: string): string;
+    /**
+     * 对文本进行 HTML 转义
+     *
+     * 示例 `ESCAPE("star")`
+     *
+     * 返回 `Star`
+     *
+     * @example ESCAPE(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnESCAPE(text: string): string;
+    /**
+     * 对文本长度进行截断
+     *
+     * 示例 `TRUNCATE("amis.baidu.com", 6)`
+     *
+     * 返回 `amis...`
+     *
+     * @example TRUNCATE(text, 6)
+     * @param {string} text - 文本
+     * @param {number} text - 最长长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnTRUNCATE(text: string, length: number): string;
+    /**
+     *  取在某个分隔符之前的所有字符串
+     *
+     * @example  BEFORELAST(text, '.')
+     * @param {string} text - 文本
+     * @param {string} delimiter - 结束文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
+    fnBEFORELAST(text: string, delimiter?: string): string;
     /**
      * 将文本根据指定片段分割成数组
      *
@@ -534,6 +659,34 @@ export declare class Evaluator {
      * @returns {string} 处理后的文本
      */
     fnTRIM(text: string): string;
+    /**
+     * 去除文本中的 HTML 标签
+     *
+     * 示例：`STRIPTAG("<b>amis</b>")`
+     *
+     * 返回：`amis`
+     *
+     * @example STRIPTAG(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
+    fnSTRIPTAG(text: string): string;
+    /**
+     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+     *
+     * 示例：`LINEBREAK("\n")`
+     *
+     * 返回：`<br/>`
+     *
+     * @example LINEBREAK(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
+    fnLINEBREAK(text: string): string;
     /**
      * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
      *
@@ -545,6 +698,17 @@ export declare class Evaluator {
      * @returns {string} 判断结果
      */
     fnSTARTSWITH(text: string, search: string): boolean;
+    /**
+     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
+     *
+     * @example ENDSWITH(text, '片段')
+     * @param {string} text - 文本
+     * @param {string} endString - 结束文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
+    fnENDSWITH(text: string, search: string): boolean;
     /**
      * 判断参数 1 中的文本是否包含参数 2 中的文本。
      *