@cloudpss/expression 0.6.0-alpha.9 → 0.6.0

package/tests/migrate.ts

@@ -0,0 +1,317 @@
+import { migrateMathJs } from '@cloudpss/expression/migrate';
+import type { ExpressionSource } from '../dist/expression.js';
+import { Scope } from '../dist/scope.js';
+import { Evaluator, Expression, VmError } from '../dist/index.js';
+import dedent from 'dedent';
+
+const s = new Scope({
+    a: [1, 2, 3],
+    m: [
+        [1, 2],
+        [3, 4],
+    ],
+    f: 1,
+    s: 'abc',
+    b: false,
+    o: {
+        x: 1,
+        y: 2,
+    },
+    type: 'keyword',
+});
+const e = new Evaluator();
+
+describe('migrate', () => {
+    it('should migrate constant expressions', () => {
+        const m = (e: string) => migrateMathJs(e as ExpressionSource, false, undefined);
+        expect(m('')).toBe('');
+        expect(m('   ')).toBe('');
+        expect(m('undefined')).toBe('');
+        expect(m('null')).toBe('nil');
+        expect(m('true')).toBe('true');
+        expect(m('false')).toBe('false');
+        expect(m('123')).toBe('123');
+        expect(m('-123.45e+6')).toBe('-123.45e+6');
+        expect(m('+123.45e-6')).toBe('+123.45e-6');
+        expect(m('.45e-6')).toBe('4.5e-7');
+    });
+
+    it.each([
+        ['sin(0)', 'sin(0)', 0],
+        ['sin(f)', 'sin(f)', Math.sin(1)],
+        ['f', 'f', 1],
+        ['o == null', 'o == nil', false],
+        ['o == undefined', 'o == nil', false],
+        ['o == undefined', 'o == nil', false],
+        ['b == false', 'b =~ 0', true],
+        ['true != b', '1 !~ b', true],
+        ['f == true', 'f =~ 1', true],
+        ['false == f', '0 =~ f', false],
+        ['0 <= f + 1 <= 2', 'f + 1 is 0..2', true],
+        ['$a', '$a', VmError],
+        ['$a + 1', 'matrix.add($a, 1)', VmError],
+        ['size(a)[1]', 'len(a)', 3],
+        ['size(s)[1]', 'len(chars(s))', 3],
+        ['(a).length', 'len((a))', 3],
+        ['(s).length', 'len(chars((s)))', 3],
+        ['count(s)', 'len(chars(s))', 3],
+        ['b ? true : false', 'b', false],
+        ['b ? false : true', '!b', true],
+        ['is(f, "string") ? count(f) != 0 : false', "type(f) == 'string' && f != ''", false],
+        ['is(f, "string") ? equalText(f, "xyz") : false', "f == 'xyz'", false],
+        ['b ? 1 : 2', 'if b { 1 } else { 2 }', 2],
+        ['f >0', 'f > 0', true],
+        ['f >=0', 'f >= 0', true],
+        ['f <0', 'f < 0', false],
+        ['f == 1', 'f =~ 1', true],
+        ['f != 1', 'f !~ 1', false],
+        ['1<f<2', '1 < f && f < 2', false],
+        ['1 + 2 + f', '1 + 2 + f', 4],
+        ['PI', 'PI', Math.PI],
+        ['pi', 'PI', Math.PI],
+        ['E', 'E', Math.E],
+        ['e', 'E', Math.E],
+        ['[1,2,3]', '[1, 2, 3]', [1, 2, 3]],
+        ['[1;2;3]', '[[1], [2], [3]]', [[1], [2], [3]]],
+        ['{ x: 1, y: 2 }', '(x: 1, y: 2)', { x: 1, y: 2 }],
+        ['{ x: f, y: b }', '(x: f, y: b)', { x: 1, y: false }],
+        ['equalText("a", "b")', "'a' == 'b'", false],
+        ['equalText("a", s)', "'a' == s", false],
+        ['equalText(s, "b")', "s == 'b'", false],
+        ['equalText(s, f)', 's == to_string(f)', false],
+        ['b | b', 'to_number(b || b)', 0],
+        ['b & b', 'to_number(b && b)', 0],
+        ['not b', '!b', true],
+        ['12!', 'factorial(12)', 479_001_600],
+        ['- b', '-b', -0],
+        ['+ b', '+b', +0],
+        ['- f', '-f', -1],
+        ['b ^| f', 'b_xor(b, f)', 1],
+        ['b ^| (not b)', 'to_number(b != (!b))', 1],
+        [
+            'not b xor f + 1',
+            dedent`
+                return (!b) != @@to_boolean(f + 1);
+                // # 帮助函数
+                fn @@to_boolean { if it is nil { nil } else { it != '' && it != '0' && it != 0 && it is not nan && it != false } }
+                // # 原始 math.js 表达式
+                // not b xor f + 1`,
+            false,
+        ],
+        ['size(f)', 'matrix.size(f)', []],
+        ['size(m)', 'matrix.size(m)', [2, 2]],
+        [`[1,2,3] == f`, `[1, 2, 3]::map(fn { it =~ f })`, [true, false, false]],
+        [`$V != [1,2,3]`, `[1, 2, 3]::map(fn { $V !~ it })`, VmError],
+        [
+            'u.length',
+            dedent`
+                return @@length(u);
+                // # 帮助函数
+                fn @@length(x) { if type(x) == 'string' { len(chars(x)) } else if type(x) == 'array' { len(x) } else { x.length } }
+                // # 转换日志
+                // - W: 符号 'u' 未定义
+                // # 原始 math.js 表达式
+                // u.length`,
+            VmError,
+        ],
+        ['o["x"]', 'o.x', 1],
+        ['o.x', 'o.x', 1],
+        [
+            'o[s]',
+            dedent`
+                return o[@@index(s)];
+                // # 帮助函数
+                fn @@index(index) { if type(index) == 'number' { index - 1 } else { index } }
+                // # 原始 math.js 表达式
+                // o[s]`,
+            null,
+        ],
+        [
+            'o[f]',
+            dedent`
+                return o[@@index(f)];
+                // # 帮助函数
+                fn @@index(index) { if type(index) == 'number' { index - 1 } else { index } }
+                // # 原始 math.js 表达式
+                // o[f]`,
+            null,
+        ],
+        [`{x:1,y:2}['x']`, `(x: 1, y: 2).x`, 1],
+        [`{x:1,y:2}[s]`, `(x: 1, y: 2)[s]`, null],
+        [`[1,2,3][f]`, `[1, 2, 3][f - 1]`, 1],
+        ['"abc"[1]', "chars('abc')[0]", 'a'],
+        ['s[1]', 'chars(s)[0]', 'a'],
+        ['[1,2,3][2]', '[1, 2, 3][1]', 2],
+        ['a[2]', 'a[1]', 2],
+        [
+            'a[u]',
+            dedent`
+                return a[@@index(u)];
+                // # 帮助函数
+                fn @@index(index) { if type(index) == 'number' { index - 1 } else { index } }
+                // # 转换日志
+                // - W: 符号 'u' 未定义
+                // # 原始 math.js 表达式
+                // a[u]`,
+            VmError,
+        ],
+        [
+            'u[1]',
+            dedent`
+                return @@maybe_chars(u)[0];
+                // # 帮助函数
+                fn @@maybe_chars(x) { if type(x) == 'string' { chars(x) } else { x } }
+                // # 转换日志
+                // - W: 符号 'u' 未定义
+                // # 原始 math.js 表达式
+                // u[1]`,
+            VmError,
+        ],
+        [
+            'm[1,2]',
+            dedent`
+                m[0][1]
+                // # 转换日志
+                // - W: 多维索引已拆分为多次单维索引
+                // # 原始 math.js 表达式
+                // m[1,2]`,
+            2,
+        ],
+        [
+            'm[f,2]',
+            dedent`
+                m[f - 1][1]
+                // # 转换日志
+                // - W: 多维索引已拆分为多次单维索引
+                // # 原始 math.js 表达式
+                // m[f,2]`,
+            2,
+        ],
+        [
+            'filter(x) = x > 1; a.filter(filter)',
+            dedent`
+                fn filter(x) { matrix.entrywise(x, 1, fn (a, b) { a > b }) }
+                a::global.filter(filter)
+                // # 转换日志
+                // - W: 使用了非精确转换的语法或函数，结果可能不准确
+                // # 原始 math.js 表达式
+                // filter(x) = x > 1; a.filter(filter)`,
+            [2, 3],
+        ],
+        [`print('hello world, $s!', {s:s})`, '`hello world, $(s)!`', `hello world, abc!`],
+        [`print('hello world, $1!', [s])`, '`hello world, $(s)!`', `hello world, abc!`],
+        [`concat('Value: ', f, string(1 >= 0))`, '`Value: $(f)$(1 >= 0)`', 'Value: 1true'],
+        [`concat(s, f, string(1 >= 0))`, '`$(s)$(f)$(1 >= 0)`', 'abc1true'],
+        [
+            String.raw`'Value: '.concat('\\x', '$', 1, f, string(1 >= 0))`,
+            '`Value: \\\\x\\$1$(f)$(1 >= 0)`',
+            String.raw`Value: \x$11true`,
+        ],
+        [
+            `concat([1], a)`,
+            dedent`
+                flatten([[1], a])
+                // # 转换日志
+                // - W: 矩阵连接时结果可能不一致
+                // # 原始 math.js 表达式
+                // concat([1], a)
+                `,
+            [1, 1, 2, 3],
+        ],
+        [`equalText(type, "keyword")`, `global.type == 'keyword'`, true],
+        [
+            `type = { "a": [1,2,3] }; type.a[1]`,
+            dedent`
+                let __type__ = (a: [1, 2, 3]);
+                return @@maybe_chars(__type__.a)[0];
+                // # 帮助函数
+                fn @@maybe_chars(x) { if type(x) == 'string' { chars(x) } else { x } }
+                // # 转换日志
+                // - W: 变量名 'type' 是 MiraScript 关键字，已转换为 '__type__'
+                // # 原始 math.js 表达式
+                // type = { "a": [1,2,3] }; type.a[1]
+                `,
+            1,
+        ],
+        [
+            '[1,2,3].map(f(x,y,z) = x^2)',
+            dedent`
+                return [1, 2, 3]::map(f);
+                // # 帮助函数
+                fn f(x, y, z) { x^2 }
+                // # 转换日志
+                // - W: 使用了非精确转换的语法或函数，结果可能不准确
+                // - W: '^' 不支持矩阵，计算结果可能不一致
+                // # 原始 math.js 表达式
+                // [1,2,3].map(f(x,y,z) = x^2)
+                `,
+            [1, 4, 9],
+        ],
+        ['', '', null],
+        ['#', '//', null],
+        ['#xx', '//xx', null],
+        ['(random() - 1) < 0', '(random() - 1) < 0', true],
+        [
+            're(12) + im(i)',
+            dedent`
+                /* re */(12) + /* im */(i)
+                // # 转换日志
+                // - E: 不支持复数
+                // # 原始 math.js 表达式
+                // re(12) + im(i)
+                `,
+            VmError,
+        ],
+        ['is(a, "number")', "type(a) == 'number'", false],
+        ['is(a, "string")', "type(a) == 'string'", false],
+        ['is(a, "boolean")', "type(a) == 'boolean'", false],
+        ['is(a, "null")', "type(a) == 'nil'", false],
+        ['is(a, "undefined")', "type(a) == 'nil'", false],
+        [`sum([a > 1])`, `sum([matrix.entrywise(a, 1, fn (a, b) { a > b })]::flatten())`, 2],
+        [`prod(1,2,3)`, `product(1, 2, 3)`, 6],
+        [`sum(true)`, `sum(true)`, 1],
+        [`sum(m)`, `sum(m::flatten())`, 10],
+        [`prod([1,2,3])`, `product([1, 2, 3])`, 6],
+        [`prod(f)`, `product(f)`, 1],
+        [`abs(f) + round(f) + f`, `abs(f) + round(f) + f`, 3],
+        [
+            `abs([1,2,3;-4,-5,-6])`,
+            `matrix.entrywise([[1, 2, 3], [-4, -5, -6]], nil, abs)`,
+            [
+                [1, 2, 3],
+                [4, 5, 6],
+            ],
+        ],
+        [`max(1, 2, f) + f`, `max(1, 2, f) + f`, 3],
+        [`min(1, 2, f) + f`, `min(1, 2, f) + f`, 2],
+        [
+            `max([1,2;3,4], 1)`,
+            dedent`
+                max([[1, 2], [3, 4]], 1)
+                // # 转换日志
+                // - W: 函数行为可能不一致: max
+                // # 原始 math.js 表达式
+                // max([1,2;3,4], 1)`,
+            VmError,
+        ],
+        [`0:(f + 1)`, `[0..(f + 1)]`, [0, 1, 2]],
+        [`3:1`, `[3..1]`, []],
+        [`1:+1:2`, `[1..2]`, [1, 2]],
+        [`3:-1:1`, `[1..3]`, [1, 2, 3]],
+        [`1:4 + 1`, `[1..4 + 1]`, [1, 2, 3, 4, 5]],
+        [`1.2:2*3`, `[1.2..2 * 3]`, [1.2, 2.2, 3.2, 4.2, 5.2]],
+        [`a[1:2]`, 'a[0..1]', [1, 2]],
+        [`a[2:-1:1]`, 'a[0..1]::reverse()', [2, 1]],
+        [`not b and f > 0`, `!b && f > 0`, true],
+    ])('should migrate expression: %s', (f, t, r) => {
+        const migrated = migrateMathJs(f as ExpressionSource, false, s);
+        expect(migrated).toBe(t);
+        if (typeof r === 'function' && r.prototype instanceof Error) {
+            expect(() => {
+                e.evaluate(Expression(migrated), s);
+            }).toThrow(r);
+        } else {
+            expect(e.evaluate(Expression(migrated), s)).toEqual(r);
+        }
+    });
+});

package/tests/scope.ts

@@ -10,7 +10,7 @@ describe('Scope should work correctly', () => {
     it('can create from function', () => {
         const s = new Scope((k) => (k === 'a' ? 12 : undefined), false);
         expect(e.evaluate(Expression('a'), s)).toBe(12);
-        expect(e.evaluate(Expression('b'), s)).toBe(undefined);
+        expect(e.evaluate(Expression('`b` in global'), s)).toBe(false);
     });
     it('can create from object', () => {
         const s = new Scope({ a: 12, b: Expression('a + 1') }, false);
@@ -22,8 +22,8 @@ describe('Scope should work correctly', () => {
 describe('Scope should not leak dangerous objects', () => {
     it('should not access prototype fields', () => {
         const s = new Scope({}, false);
-        expect(e.evaluate(Expression('__proto__'), s)).toBe(undefined);
-        expect(e.evaluate(Expression('toString'), s)).toBe(undefined);
+        expect(e.evaluate(Expression('`__proto__` in global'), s)).toBe(false);
+        expect(e.evaluate(Expression('`toString` in global'), s)).toBe(false);
     });
     it('should access same name props', () => {
         const s = new Scope({ ['__proto__']: 12, toString: 'x' }, false);

package/tests/template.ts

@@ -0,0 +1,36 @@
+import { Evaluator, Expression, Scope } from '../dist/index.js';
+
+const e = new Evaluator();
+const s = new Scope({}, false);
+
+describe('Evaluator.template should work correctly', () => {
+    it('should eval null', () => {
+        const result = e.template(null, s);
+        expect(result).toBe('');
+    });
+    it('should eval undefined', () => {
+        const result = e.template(undefined, s);
+        expect(result).toBe('');
+    });
+    it('should eval empty', () => {
+        const result = e.template('', s);
+        expect(result).toBe('');
+    });
+    it('should eval const', () => {
+        const result = e.template('12', s);
+        expect(result).toBe('12');
+    });
+
+    it('should eval exp', () => {
+        const result = e.template('$(1 + 1)', s);
+        expect(result).toBe('2');
+    });
+    it('should eval error', () => {
+        const result = e.template('$(exp+++)', s);
+        expect(result).toBe('$(exp+++)');
+    });
+    it('should eval bad type', () => {
+        // @ts-expect-error 测试错误输入
+        expect(() => e.template(new Date(0), s)).toThrow(TypeError);
+    });
+});

package/dist/context.d.ts

@@ -1,41 +0,0 @@
-import { LRUCache } from 'lru-cache';
-import type { ExpressionCache } from './parser.js';
-import type { VmValue } from '@mirascript/mirascript';
-/** 日志 */
-export interface Logger {
-    /**
-     * error
-     */
-    error(...args: unknown[]): void;
-    /**
-     * warning
-     */
-    warn(...args: unknown[]): void;
-    /**
-     * info
-     */
-    info(...args: unknown[]): void;
-    /**
-     * debug
-     */
-    debug(...args: unknown[]): void;
-}
-/** 选项 */
-export interface Options {
-    /** 日志 */
-    logger: Logger;
-    /** 表达式缓存 */
-    expressionCacheSize: number;
-}
-/** 执行上下文 */
-export declare class Context {
-    constructor(options?: Partial<Options>);
-    readonly imported: Map<string, VmValue>;
-    /** Logger */
-    get logger(): Logger;
-    /** 选项 */
-    readonly options: Options;
-    /** 表达式缓存 */
-    readonly expressionCache: LRUCache<string, ExpressionCache, unknown>;
-}
-//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEtD,SAAS;AACT,MAAM,WAAW,MAAM;IACnB;;OAEG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChC;;OAEG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CACnC;AAED,SAAS;AACT,MAAM,WAAW,OAAO;IACpB,SAAS;IACT,MAAM,EAAE,MAAM,CAAC;IACf,YAAY;IACZ,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAOD,YAAY;AACZ,qBAAa,OAAO;gBACJ,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAItC,QAAQ,CAAC,QAAQ,uBAA8B;IAC/C,aAAa;IACb,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,SAAS;IACT,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,YAAY;IACZ,QAAQ,CAAC,eAAe,6CAAC;CAC5B"}

package/dist/context.js

@@ -1,18 +0,0 @@
-import { LRUCache } from 'lru-cache';
-const defaultOptions = {
-    logger: console,
-    expressionCacheSize: 50,
-};
-/** 执行上下文 */
-export class Context {
-    constructor(options) {
-        this.imported = new Map();
-        this.options = { ...options, ...defaultOptions };
-        this.expressionCache = new LRUCache({ max: this.options.expressionCacheSize });
-    }
-    /** Logger */
-    get logger() {
-        return this.options.logger ?? console;
-    }
-}
-//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAgCrC,MAAM,cAAc,GAAY;IAC5B,MAAM,EAAE,OAAO;IACf,mBAAmB,EAAE,EAAE;CAC1B,CAAC;AAEF,YAAY;AACZ,MAAM,OAAO,OAAO;IAChB,YAAY,OAA0B;QAI7B,aAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;QAH3C,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAA0B,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,aAAa;IACb,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;IAC1C,CAAC;CAMJ"}

package/src/context.ts

@@ -1,54 +0,0 @@
-import { LRUCache } from 'lru-cache';
-import type { ExpressionCache } from './parser.js';
-import type { VmValue } from '@mirascript/mirascript';
-
-/** 日志 */
-export interface Logger {
-    /**
-     * error
-     */
-    error(...args: unknown[]): void;
-    /**
-     * warning
-     */
-    warn(...args: unknown[]): void;
-    /**
-     * info
-     */
-    info(...args: unknown[]): void;
-    /**
-     * debug
-     */
-    debug(...args: unknown[]): void;
-}
-
-/** 选项 */
-export interface Options {
-    /** 日志 */
-    logger: Logger;
-    /** 表达式缓存 */
-    expressionCacheSize: number;
-}
-
-const defaultOptions: Options = {
-    logger: console,
-    expressionCacheSize: 50,
-};
-
-/** 执行上下文 */
-export class Context {
-    constructor(options?: Partial<Options>) {
-        this.options = { ...options, ...defaultOptions };
-        this.expressionCache = new LRUCache<string, ExpressionCache>({ max: this.options.expressionCacheSize });
-    }
-    readonly imported = new Map<string, VmValue>();
-    /** Logger */
-    get logger(): Logger {
-        return this.options.logger ?? console;
-    }
-    /** 选项 */
-    readonly options: Options;
-
-    /** 表达式缓存 */
-    readonly expressionCache;
-}