amis-formula 6.8.0 → 6.9.0-rc.0

package/esm/doc.d.ts

@@ -1,18 +1,4 @@
 /**
  * 公式文档 请运行 `npm run genDoc` 自动生成
  */
-export declare const doc: {
-    name: string;
-    description: string;
-    example: string;
-    params: {
-        type: string;
-        name: string;
-        description: string | null;
-    }[];
-    returns: {
-        type: string;
-        description: string | null;
-    };
-    namespace: string;
-}[];
+export {};

package/esm/doc.js

@@ -1,12 +1,14 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
+import { bulkRegisterFunctionDoc } from './function.js';
+
 /**
  * 公式文档 请运行 `npm run genDoc` 自动生成
  */
-var doc = [
+bulkRegisterFunctionDoc([
     {
         name: "IF",
         description: "如果满足条件condition，则返回consequent，否则返回alternate，支持多层嵌套IF函数。\n\n等价于直接用JS表达式如：condition ? consequent : alternate。",
@@ -1917,6 +1919,4 @@ var doc = [
         },
         namespace: "其他"
     }
-];
-
-export { doc };
+]);

package/esm/error.js

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

package/esm/evalutor.d.ts

@@ -11,9 +11,9 @@ export declare class Evaluator {
     };
     contextStack: Array<(varname: string) => any>;
     static defaultFilters: FilterMap;
-    static setDefaultFilters(filters: FilterMap): void;
+    static extendDefaultFilters(filters: FilterMap): void;
     static defaultFunctions: FunctionMap;
-    static setDefaultFunctions(funtions: FunctionMap): void;
+    static extendDefaultFunctions(funtions: FunctionMap): void;
     constructor(context: {
         [propName: string]: any;
     }, options?: EvaluatorOptions);

package/esm/evalutor.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -36,10 +36,10 @@ var Evaluator = /** @class */ (function () {
         this.filters = __assign(__assign(__assign({}, Evaluator.defaultFilters), this.filters), options === null || options === void 0 ? void 0 : options.filters);
         this.functions = __assign(__assign(__assign({}, Evaluator.defaultFunctions), this.functions), options === null || options === void 0 ? void 0 : options.functions);
     }
-    Evaluator.setDefaultFilters = function (filters) {
+    Evaluator.extendDefaultFilters = function (filters) {
         Evaluator.defaultFilters = __assign(__assign({}, Evaluator.defaultFilters), filters);
     };
-    Evaluator.setDefaultFunctions = function (funtions) {
+    Evaluator.extendDefaultFunctions = function (funtions) {
         Evaluator.defaultFunctions = __assign(__assign({}, Evaluator.defaultFunctions), funtions);
     };
     // 主入口
@@ -2232,6 +2232,9 @@ var Evaluator = /** @class */ (function () {
     Evaluator.defaultFunctions = {};
     return Evaluator;
 }());
+// 兼容
+Evaluator.setDefaultFilters = Evaluator.extendDefaultFilters;
+Evaluator.setDefaultFunctions = Evaluator.extendDefaultFunctions;
 function getCookie(name) {
     var value = "; ".concat(document.cookie);
     var parts = value.split("; ".concat(name, "="));

package/esm/evalutorForAsync.js

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

package/esm/filter.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -33,11 +33,11 @@ var filters = {
 };
 function registerFilter(name, fn) {
     filters[name] = fn;
-    Evaluator.setDefaultFilters(filters);
+    Evaluator.extendDefaultFilters(filters);
 }
 function extendsFilters(value) {
     Object.assign(filters, value);
-    Evaluator.setDefaultFilters(filters);
+    Evaluator.extendDefaultFilters(filters);
 }
 function getFilters() {
     return filters;

package/esm/function.d.ts

@@ -1,5 +1,27 @@
-import { FunctionMap, FunctionDocMap, FunctionDocItem } from './types';
-export declare const functions: FunctionMap;
-export declare function registerFunction(name: string, fn: (input: any, ...args: any[]) => any): void;
-export declare let functionDocs: FunctionDocMap;
+import { Evaluator } from './evalutor';
+import { FunctionDocMap, FunctionDocItem } from './types';
+export declare function registerFunction(name: string, fn: (this: Evaluator, ...args: Array<any>) => any): void;
+export declare const functionDocs: FunctionDocMap;
 export declare function registerFunctionDoc(groupName: string, item: FunctionDocItem): void;
+export declare function bulkRegisterFunctionDoc(fnDocs: {
+    name: string;
+    description: string;
+    example: string;
+    params: {
+        type: string;
+        name: string;
+        description: string | null;
+    }[];
+    returns: {
+        type: string;
+        description: string | null;
+    };
+    namespace: string;
+}[]): void;
+/**
+ * 注册公式，并同时注册公式说明
+ * @param name
+ * @param fn
+ * @param fnInfo
+ */
+export declare function registerFormula(name: string, fn: (this: Evaluator, ...args: Array<any>) => any, fnInfo?: FunctionDocItem): void;

package/esm/function.js

@@ -1,14 +1,15 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
 import { Evaluator } from './evalutor.js';
 
-var functions = {};
 function registerFunction(name, fn) {
-    functions["fn".concat(name)] = fn;
-    Evaluator.setDefaultFunctions(functions);
+    var _a;
+    Evaluator.extendDefaultFunctions((_a = {},
+        _a["fn".concat(name)] = fn,
+        _a));
 }
 var functionDocs = {};
 function registerFunctionDoc(groupName, item) {
@@ -19,5 +20,18 @@ function registerFunctionDoc(groupName, item) {
         functionDocs[groupName] = [item];
     }
 }
+function bulkRegisterFunctionDoc(fnDocs) {
+    fnDocs.forEach(function (item) { return registerFunctionDoc(item.namespace || 'Others', item); });
+}
+/**
+ * 注册公式，并同时注册公式说明
+ * @param name
+ * @param fn
+ * @param fnInfo
+ */
+function registerFormula(name, fn, fnInfo) {
+    registerFunction(name, fn);
+    fnInfo && registerFunctionDoc(fnInfo.namespace || 'Others', fnInfo);
+}
 
-export { functionDocs, functions, registerFunction, registerFunctionDoc };
+export { bulkRegisterFunctionDoc, functionDocs, registerFormula, registerFunction, registerFunctionDoc };

package/esm/index.d.ts

@@ -3,9 +3,13 @@ import { AsyncEvaluator } from './evalutorForAsync';
 import { parse } from './parser';
 import { lexer } from './lexer';
 import { registerFilter, filters, getFilters, extendsFilters } from './filter';
-import { registerFunction, registerFunctionDoc, functionDocs } from './function';
+import { registerFunction, registerFunctionDoc, registerFormula } from './function';
 import type { FilterContext, ASTNode, ParserOptions, EvaluatorOptions } from './types';
-export { parse, lexer, Evaluator, AsyncEvaluator, FilterContext, filters, getFilters, registerFilter, registerFunction, registerFunctionDoc, functionDocs, extendsFilters };
+export { parse, lexer, Evaluator, AsyncEvaluator, FilterContext, filters, getFilters, registerFilter, registerFormula, registerFunction, registerFunctionDoc, extendsFilters };
 export * from './types';
 export declare function evaluate(astOrString: string | ASTNode, data: any, options?: ParserOptions & EvaluatorOptions): any;
 export declare function evaluateForAsync(astOrString: string | ASTNode, data: any, options?: ParserOptions & EvaluatorOptions): Promise<any>;
+export declare function getFunctionsDoc(): Promise<{
+    groupName: string;
+    items: import("./types").FunctionDocItem[];
+}[]>;

package/esm/index.js

@@ -1,9 +1,9 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
-import { __awaiter, __generator } from 'tslib';
+import { __awaiter, __generator, __read } from 'tslib';
 import { Evaluator } from './evalutor.js';
 export { Evaluator } from './evalutor.js';
 import { AsyncEvaluator } from './evalutorForAsync.js';
@@ -13,7 +13,8 @@ export { parse } from './parser.js';
 export { lexer } from './lexer.js';
 import { getFilters } from './filter.js';
 export { extendsFilters, filters, getFilters, registerFilter } from './filter.js';
-export { functionDocs, registerFunction, registerFunctionDoc } from './function.js';
+import { functionDocs } from './function.js';
+export { registerFormula, registerFunction, registerFunctionDoc } from './function.js';
 
 function evaluate(astOrString, data, options) {
     var ast = astOrString;
@@ -34,7 +35,25 @@ function evaluateForAsync(astOrString, data, options) {
         });
     });
 }
-Evaluator.setDefaultFilters(getFilters());
+Evaluator.extendDefaultFilters(getFilters());
 AsyncEvaluator.setDefaultFilters(getFilters());
+function getFunctionsDoc() {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, import('./doc.js')];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/, Object.entries(functionDocs).map(function (_a) {
+                            var _b = __read(_a, 2), k = _b[0], items = _b[1];
+                            return ({
+                                groupName: k,
+                                items: items
+                            });
+                        })];
+            }
+        });
+    });
+}
 
-export { evaluate, evaluateForAsync };
+export { evaluate, evaluateForAsync, getFunctionsDoc };

package/esm/lexer.js

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

package/esm/parser.js

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

package/esm/types.d.ts

@@ -3,12 +3,13 @@ export interface FilterMap {
     [propName: string]: (this: FilterContext, input: any, ...args: any[]) => any;
 }
 export interface FunctionMap {
-    [propName: string]: (this: Evaluator, ast: Object, data: any) => any;
+    [propName: string]: (this: Evaluator, ...args: Array<any>) => any;
 }
 export interface FunctionDocItem {
     name: string;
     example?: string;
     description?: string;
+    namespace?: string;
     [propName: string]: any;
 }
 export interface FunctionDocMap {

package/lib/doc.d.ts

@@ -1,18 +1,4 @@
 /**
  * 公式文档 请运行 `npm run genDoc` 自动生成
  */
-export declare const doc: {
-    name: string;
-    description: string;
-    example: string;
-    params: {
-        type: string;
-        name: string;
-        description: string | null;
-    }[];
-    returns: {
-        type: string;
-        description: string | null;
-    };
-    namespace: string;
-}[];
+export {};

package/lib/doc.js

@@ -1,16 +1,16 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
+var _function = require('./function.js');
 
 /**
  * 公式文档 请运行 `npm run genDoc` 自动生成
  */
-var doc = [
+_function.bulkRegisterFunctionDoc([
     {
         name: "IF",
         description: "如果满足条件condition，则返回consequent，否则返回alternate，支持多层嵌套IF函数。\n\n等价于直接用JS表达式如：condition ? consequent : alternate。",
@@ -1921,6 +1921,4 @@ var doc = [
         },
         namespace: "其他"
     }
-];
-
-exports.doc = doc;
+]);

package/lib/error.js

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

package/lib/evalutor.d.ts

@@ -11,9 +11,9 @@ export declare class Evaluator {
     };
     contextStack: Array<(varname: string) => any>;
     static defaultFilters: FilterMap;
-    static setDefaultFilters(filters: FilterMap): void;
+    static extendDefaultFilters(filters: FilterMap): void;
     static defaultFunctions: FunctionMap;
-    static setDefaultFunctions(funtions: FunctionMap): void;
+    static extendDefaultFunctions(funtions: FunctionMap): void;
     constructor(context: {
         [propName: string]: any;
     }, options?: EvaluatorOptions);

package/lib/evalutor.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -55,10 +55,10 @@ var Evaluator = /** @class */ (function () {
         this.filters = tslib.__assign(tslib.__assign(tslib.__assign({}, Evaluator.defaultFilters), this.filters), options === null || options === void 0 ? void 0 : options.filters);
         this.functions = tslib.__assign(tslib.__assign(tslib.__assign({}, Evaluator.defaultFunctions), this.functions), options === null || options === void 0 ? void 0 : options.functions);
     }
-    Evaluator.setDefaultFilters = function (filters) {
+    Evaluator.extendDefaultFilters = function (filters) {
         Evaluator.defaultFilters = tslib.__assign(tslib.__assign({}, Evaluator.defaultFilters), filters);
     };
-    Evaluator.setDefaultFunctions = function (funtions) {
+    Evaluator.extendDefaultFunctions = function (funtions) {
         Evaluator.defaultFunctions = tslib.__assign(tslib.__assign({}, Evaluator.defaultFunctions), funtions);
     };
     // 主入口
@@ -2251,6 +2251,9 @@ var Evaluator = /** @class */ (function () {
     Evaluator.defaultFunctions = {};
     return Evaluator;
 }());
+// 兼容
+Evaluator.setDefaultFilters = Evaluator.extendDefaultFilters;
+Evaluator.setDefaultFunctions = Evaluator.extendDefaultFunctions;
 function getCookie(name) {
     var value = "; ".concat(document.cookie);
     var parts = value.split("; ".concat(name, "="));

package/lib/evalutorForAsync.js

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

package/lib/filter.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -37,11 +37,11 @@ var filters = {
 };
 function registerFilter(name, fn) {
     filters[name] = fn;
-    evalutor.Evaluator.setDefaultFilters(filters);
+    evalutor.Evaluator.extendDefaultFilters(filters);
 }
 function extendsFilters(value) {
     Object.assign(filters, value);
-    evalutor.Evaluator.setDefaultFilters(filters);
+    evalutor.Evaluator.extendDefaultFilters(filters);
 }
 function getFilters() {
     return filters;

package/lib/function.d.ts

@@ -1,5 +1,27 @@
-import { FunctionMap, FunctionDocMap, FunctionDocItem } from './types';
-export declare const functions: FunctionMap;
-export declare function registerFunction(name: string, fn: (input: any, ...args: any[]) => any): void;
-export declare let functionDocs: FunctionDocMap;
+import { Evaluator } from './evalutor';
+import { FunctionDocMap, FunctionDocItem } from './types';
+export declare function registerFunction(name: string, fn: (this: Evaluator, ...args: Array<any>) => any): void;
+export declare const functionDocs: FunctionDocMap;
 export declare function registerFunctionDoc(groupName: string, item: FunctionDocItem): void;
+export declare function bulkRegisterFunctionDoc(fnDocs: {
+    name: string;
+    description: string;
+    example: string;
+    params: {
+        type: string;
+        name: string;
+        description: string | null;
+    }[];
+    returns: {
+        type: string;
+        description: string | null;
+    };
+    namespace: string;
+}[]): void;
+/**
+ * 注册公式，并同时注册公式说明
+ * @param name
+ * @param fn
+ * @param fnInfo
+ */
+export declare function registerFormula(name: string, fn: (this: Evaluator, ...args: Array<any>) => any, fnInfo?: FunctionDocItem): void;

package/lib/function.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -9,10 +9,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var evalutor = require('./evalutor.js');
 
-var functions = {};
 function registerFunction(name, fn) {
-    functions["fn".concat(name)] = fn;
-    evalutor.Evaluator.setDefaultFunctions(functions);
+    var _a;
+    evalutor.Evaluator.extendDefaultFunctions((_a = {},
+        _a["fn".concat(name)] = fn,
+        _a));
 }
 var functionDocs = {};
 function registerFunctionDoc(groupName, item) {
@@ -23,8 +24,22 @@ function registerFunctionDoc(groupName, item) {
         functionDocs[groupName] = [item];
     }
 }
+function bulkRegisterFunctionDoc(fnDocs) {
+    fnDocs.forEach(function (item) { return registerFunctionDoc(item.namespace || 'Others', item); });
+}
+/**
+ * 注册公式，并同时注册公式说明
+ * @param name
+ * @param fn
+ * @param fnInfo
+ */
+function registerFormula(name, fn, fnInfo) {
+    registerFunction(name, fn);
+    fnInfo && registerFunctionDoc(fnInfo.namespace || 'Others', fnInfo);
+}
 
+exports.bulkRegisterFunctionDoc = bulkRegisterFunctionDoc;
 exports.functionDocs = functionDocs;
-exports.functions = functions;
+exports.registerFormula = registerFormula;
 exports.registerFunction = registerFunction;
 exports.registerFunctionDoc = registerFunctionDoc;

package/lib/index.d.ts

@@ -3,9 +3,13 @@ import { AsyncEvaluator } from './evalutorForAsync';
 import { parse } from './parser';
 import { lexer } from './lexer';
 import { registerFilter, filters, getFilters, extendsFilters } from './filter';
-import { registerFunction, registerFunctionDoc, functionDocs } from './function';
+import { registerFunction, registerFunctionDoc, registerFormula } from './function';
 import type { FilterContext, ASTNode, ParserOptions, EvaluatorOptions } from './types';
-export { parse, lexer, Evaluator, AsyncEvaluator, FilterContext, filters, getFilters, registerFilter, registerFunction, registerFunctionDoc, functionDocs, extendsFilters };
+export { parse, lexer, Evaluator, AsyncEvaluator, FilterContext, filters, getFilters, registerFilter, registerFormula, registerFunction, registerFunctionDoc, extendsFilters };
 export * from './types';
 export declare function evaluate(astOrString: string | ASTNode, data: any, options?: ParserOptions & EvaluatorOptions): any;
 export declare function evaluateForAsync(astOrString: string | ASTNode, data: any, options?: ParserOptions & EvaluatorOptions): Promise<any>;
+export declare function getFunctionsDoc(): Promise<{
+    groupName: string;
+    items: import("./types").FunctionDocItem[];
+}[]>;

package/lib/index.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.8.0
+ * amis-formula v6.9.0-rc.0
  * Copyright 2021-2024 fex
  */
 
@@ -34,8 +34,26 @@ function evaluateForAsync(astOrString, data, options) {
         });
     });
 }
-evalutor.Evaluator.setDefaultFilters(filter.getFilters());
+evalutor.Evaluator.extendDefaultFilters(filter.getFilters());
 evalutorForAsync.AsyncEvaluator.setDefaultFilters(filter.getFilters());
+function getFunctionsDoc() {
+    return tslib.__awaiter(this, void 0, void 0, function () {
+        return tslib.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, Promise.resolve().then(function() {return new Promise(function(fullfill) {require(['./doc.js', "tslib"], function(mod, tslib) {fullfill(tslib.__importStar(mod))})})})];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/, Object.entries(_function.functionDocs).map(function (_a) {
+                            var _b = tslib.__read(_a, 2), k = _b[0], items = _b[1];
+                            return ({
+                                groupName: k,
+                                items: items
+                            });
+                        })];
+            }
+        });
+    });
+}
 
 exports.Evaluator = evalutor.Evaluator;
 exports.AsyncEvaluator = evalutorForAsync.AsyncEvaluator;
@@ -45,8 +63,9 @@ exports.extendsFilters = filter.extendsFilters;
 exports.filters = filter.filters;
 exports.getFilters = filter.getFilters;
 exports.registerFilter = filter.registerFilter;
-exports.functionDocs = _function.functionDocs;
+exports.registerFormula = _function.registerFormula;
 exports.registerFunction = _function.registerFunction;
 exports.registerFunctionDoc = _function.registerFunctionDoc;
 exports.evaluate = evaluate;
 exports.evaluateForAsync = evaluateForAsync;
+exports.getFunctionsDoc = getFunctionsDoc;

package/lib/lexer.js

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

package/lib/parser.js

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

package/lib/types.d.ts

@@ -3,12 +3,13 @@ export interface FilterMap {
     [propName: string]: (this: FilterContext, input: any, ...args: any[]) => any;
 }
 export interface FunctionMap {
-    [propName: string]: (this: Evaluator, ast: Object, data: any) => any;
+    [propName: string]: (this: Evaluator, ...args: Array<any>) => any;
 }
 export interface FunctionDocItem {
     name: string;
     example?: string;
     description?: string;
+    namespace?: string;
     [propName: string]: any;
 }
 export interface FunctionDocMap {

package/package.json

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