@opra/common 1.20.0 → 1.22.0

package/cjs/filter/filter-rules.js

@@ -1,150 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterRules = void 0;
-require("../polifils/array-find-last.js");
-const objects_1 = require("@jsopen/objects");
-const valgen_1 = require("valgen");
-const index_js_1 = require("../exception/index.js");
-const index_js_2 = require("../helpers/index.js");
-const index_js_3 = require("./ast/index.js");
-const parse_js_1 = require("./parse.js");
-class FilterRules {
-    constructor(rules, options) {
-        this._rules = new index_js_2.ResponsiveMap();
-        this._decoderCache = new WeakMap();
-        Object.defineProperty(this, '_rules', {
-            value: new index_js_2.ResponsiveMap(null, { caseSensitive: options?.caseSensitive }),
-            enumerable: false,
-        });
-        if (rules) {
-            for (const [k, v] of Object.entries(rules)) {
-                this.set(k, v);
-            }
-        }
-    }
-    set(fieldName, options) {
-        const operators = typeof options?.operators === 'string'
-            ? options.operators.split(/\s*[,| ]\s*/)
-            : options?.operators;
-        this._rules.set(fieldName, (0, objects_1.omitUndefined)({
-            ...options,
-            operators,
-        }));
-    }
-    normalizeFilter(filter, currentType, scope) {
-        const ast = typeof filter === 'string' ? (0, parse_js_1.parse)(filter) : filter;
-        return this.normalizeFilterAst(ast, [], currentType, scope);
-    }
-    normalizeFilterAst(ast, stack, currentType, scope) {
-        if (ast instanceof index_js_3.ComparisonExpression) {
-            stack.push(ast);
-            this.normalizeFilterAst(ast.left, stack, currentType);
-            if (!(ast.left instanceof index_js_3.QualifiedIdentifier && ast.left.field)) {
-                throw new TypeError(`Invalid filter query. Left side should be a data field.`);
-            }
-            // Check if filtering accepted for given field
-            const rule = this._rules.get(ast.left.value);
-            if (!rule) {
-                throw new index_js_1.OpraException({
-                    message: `Field '${ast.left.value}' is not available for filter operation`,
-                    code: 'UNACCEPTED_FILTER_FIELD',
-                    details: {
-                        field: ast.left.value,
-                    },
-                });
-            }
-            // Check if filtering endpoint accepted for given field
-            if (rule.operators && !rule.operators.includes(ast.op)) {
-                throw new index_js_1.OpraException({
-                    message: `'${ast.left.value}' field do not accept '${ast.op}' filter operator`,
-                    code: 'UNACCEPTED_FILTER_OPERATION',
-                    details: {
-                        field: ast.left.value,
-                        operator: ast.op,
-                    },
-                });
-            }
-            if (rule.mappedField)
-                ast.left.value = rule.mappedField;
-            if (rule.prepare)
-                ast.prepare = rule.prepare;
-            this.normalizeFilterAst(ast.right, stack, currentType);
-            stack.pop();
-            return ast;
-        }
-        if (ast instanceof index_js_3.LogicalExpression) {
-            stack.push(ast);
-            ast.items.forEach(item => this.normalizeFilterAst(item, stack, currentType));
-            stack.pop();
-            return ast;
-        }
-        if (ast instanceof index_js_3.ArithmeticExpression) {
-            stack.push(ast);
-            ast.items.forEach(item => this.normalizeFilterAst(item.expression, stack, currentType));
-            stack.pop();
-            return ast;
-        }
-        if (ast instanceof index_js_3.ArrayExpression) {
-            stack.push(ast);
-            ast.items.forEach(item => this.normalizeFilterAst(item, stack, currentType));
-            stack.pop();
-            return ast;
-        }
-        if (ast instanceof index_js_3.ParenthesizedExpression) {
-            stack.push(ast);
-            this.normalizeFilterAst(ast.expression, stack, currentType);
-            stack.pop();
-            return ast;
-        }
-        if (ast instanceof index_js_3.QualifiedIdentifier && currentType) {
-            ast.value = currentType.normalizeFieldPath(ast.value, { scope });
-            ast.field = currentType.getField(ast.value, scope);
-            ast.dataType = ast.field.type;
-            return ast;
-        }
-        if (ast instanceof index_js_3.Literal) {
-            /** Check if comparison expression has in stack */
-            const compIdx = stack.findLastIndex(x => x instanceof index_js_3.ComparisonExpression);
-            if (compIdx >= 0) {
-                const comp = stack[compIdx];
-                /** If calling for right side of comparison */
-                if (ast === comp.right || stack[compIdx + 1] === comp.right) {
-                    /** Check if comparison expression left side is a field */
-                    if (comp &&
-                        comp.left instanceof index_js_3.QualifiedIdentifier &&
-                        comp.left.field) {
-                        if (ast.value == null && !comp.left.field.required)
-                            return ast.value;
-                        let decoder;
-                        if (comp.op === 'like' ||
-                            comp.op === '!like' ||
-                            comp.op === 'ilike' ||
-                            comp.op === '!ilike') {
-                            decoder = valgen_1.isString;
-                        }
-                        else
-                            decoder = this._decoderCache.get(comp.left.field);
-                        if (!decoder) {
-                            decoder = comp.left.field.generateCodec('decode', {
-                                scope,
-                                projection: '*',
-                                ignoreReadonlyFields: true,
-                                coerce: true,
-                            });
-                            this._decoderCache.set(comp.left.field, decoder);
-                        }
-                        ast.value = decoder(ast.value, { coerce: true });
-                    }
-                }
-            }
-        }
-        return ast;
-    }
-    toJSON() {
-        return this._rules.toObject();
-    }
-    [Symbol.iterator]() {
-        return this._rules.entries();
-    }
-}
-exports.FilterRules = FilterRules;

package/cjs/filter/filter-tree-visitor.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterTreeVisitor = void 0;
-const antlr4_1 = require("@browsery/antlr4");
-const OpraFilterParser_js_1 = require("./antlr/OpraFilterParser.js");
-const index_js_1 = require("./ast/index.js");
-const external_constant_js_1 = require("./ast/terms/external-constant.js");
-const utils_js_1 = require("./utils.js");
-class FilterTreeVisitor extends antlr4_1.ParseTreeVisitor {
-    constructor(options) {
-        super();
-        this._timeZone = options?.timeZone;
-    }
-    visitChildren(node) {
-        const result = super.visitChildren(node);
-        if (Array.isArray(result) && result.length < 2)
-            return result[0];
-        return result ?? node.getText();
-    }
-    defaultResult() {
-        return undefined;
-    }
-    visitRoot(ctx) {
-        return this.visit(ctx.expression());
-    }
-    visitParenthesizedExpression(ctx) {
-        const expression = this.visit(ctx.parenthesizedItem());
-        return new index_js_1.ParenthesizedExpression(expression);
-    }
-    visitParenthesizedItem(ctx) {
-        return this.visit(ctx.expression());
-    }
-    visitNegativeExpression(ctx) {
-        const expression = this.visit(ctx.expression());
-        return new index_js_1.NegativeExpression(expression);
-    }
-    visitComparisonExpression(ctx) {
-        return new index_js_1.ComparisonExpression({
-            op: ctx.comparisonOperator().getText(),
-            left: this.visit(ctx.comparisonLeft()),
-            right: this.visit(ctx.comparisonRight()),
-        });
-    }
-    visitLogicalExpression(ctx) {
-        const items = [];
-        const wrapChildren = (arr, op) => {
-            for (const c of arr) {
-                if (c instanceof OpraFilterParser_js_1.LogicalExpressionContext &&
-                    c.logicalOperator().getText() === op) {
-                    wrapChildren(c.expression_list(), c.logicalOperator().getText());
-                    continue;
-                }
-                const o = this.visit(c);
-                items.push(o);
-            }
-        };
-        wrapChildren(ctx.expression_list(), ctx.logicalOperator().getText());
-        return new index_js_1.LogicalExpression({
-            op: ctx.logicalOperator().getText(),
-            items,
-        });
-    }
-    visitQualifiedIdentifier(ctx) {
-        return new index_js_1.QualifiedIdentifier(ctx.getText());
-    }
-    visitExternalConstant(ctx) {
-        return new external_constant_js_1.ExternalConstant(ctx.identifier().getText());
-    }
-    visitNullLiteral() {
-        return new index_js_1.NullLiteral();
-    }
-    visitBooleanLiteral(ctx) {
-        return new index_js_1.BooleanLiteral(ctx.getText() === 'true');
-    }
-    visitNumberLiteral(ctx) {
-        return new index_js_1.NumberLiteral(ctx.getText());
-    }
-    visitStringLiteral(ctx) {
-        return new index_js_1.StringLiteral((0, utils_js_1.unquoteFilterString)(ctx.getText()));
-    }
-    visitInfinityLiteral() {
-        return new index_js_1.NumberLiteral(Infinity);
-    }
-    visitDateLiteral(ctx) {
-        return new index_js_1.DateLiteral((0, utils_js_1.unquoteFilterString)(ctx.getText()));
-    }
-    visitDateTimeLiteral(ctx) {
-        return new index_js_1.DateTimeLiteral((0, utils_js_1.unquoteFilterString)(ctx.getText()));
-    }
-    visitTimeLiteral(ctx) {
-        return new index_js_1.TimeLiteral((0, utils_js_1.unquoteFilterString)(ctx.getText()));
-    }
-    visitArrayValue(ctx) {
-        return new index_js_1.ArrayExpression(ctx.value_list().map(child => this.visit(child)));
-    }
-}
-exports.FilterTreeVisitor = FilterTreeVisitor;

package/cjs/filter/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpraFilter = void 0;
-const tslib_1 = require("tslib");
-exports.OpraFilter = tslib_1.__importStar(require("./opra-filter.ns.js"));

package/cjs/filter/opra-error-listener.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpraErrorListener = void 0;
-const antlr4_1 = require("@browsery/antlr4");
-const errors_js_1 = require("./errors.js");
-class OpraErrorListener extends antlr4_1.ErrorListener {
-    constructor(errors) {
-        super();
-        this.errors = errors;
-    }
-    syntaxError(recognizer, offendingSymbol, line, column, msg, e) {
-        this.errors.push(new errors_js_1.FilterParseError(msg, {
-            recognizer,
-            offendingSymbol,
-            line,
-            column,
-            e,
-        }));
-    }
-}
-exports.OpraErrorListener = OpraErrorListener;

package/cjs/filter/opra-filter.ns.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./ast/index.js"), exports);
-tslib_1.__exportStar(require("./build.js"), exports);
-tslib_1.__exportStar(require("./filter-tree-visitor.js"), exports);
-tslib_1.__exportStar(require("./opra-error-listener.js"), exports);
-tslib_1.__exportStar(require("./parse.js"), exports);

package/cjs/filter/parse.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parse = parse;
-const tslib_1 = require("tslib");
-const antlr4_1 = require("@browsery/antlr4");
-const OpraFilterLexer_js_1 = tslib_1.__importDefault(require("./antlr/OpraFilterLexer.js"));
-const OpraFilterParser_js_1 = tslib_1.__importDefault(require("./antlr/OpraFilterParser.js"));
-const errors_js_1 = require("./errors.js");
-const filter_tree_visitor_js_1 = require("./filter-tree-visitor.js");
-const opra_error_listener_js_1 = require("./opra-error-listener.js");
-function parse(text, visitor) {
-    const chars = new antlr4_1.CharStream(text);
-    const lexer = new OpraFilterLexer_js_1.default(chars);
-    const tokenStream = new antlr4_1.CommonTokenStream(lexer);
-    const parser = new OpraFilterParser_js_1.default(tokenStream);
-    parser.buildParseTrees = true;
-    const errors = [];
-    const errorListener = new opra_error_listener_js_1.OpraErrorListener(errors);
-    lexer.removeErrorListeners();
-    lexer.addErrorListener(errorListener);
-    parser.removeErrorListeners();
-    parser.addErrorListener(errorListener);
-    const tree = parser.root();
-    if (errors.length) {
-        const errMsgs = [];
-        for (const err of errors) {
-            errMsgs.push(err.message +
-                (text.includes('\n')
-                    ? ' at line: ' + err.line + ' column: ' + err.column
-                    : ' at column: ' + err.column));
-        }
-        const e = new errors_js_1.SyntaxError(errMsgs.join('\n'));
-        e.errors = errors;
-        throw e;
-    }
-    visitor = visitor || new filter_tree_visitor_js_1.FilterTreeVisitor();
-    return visitor.visit(tree);
-}

package/cjs/filter/utils.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.quoteFilterString = quoteFilterString;
-exports.unquoteFilterString = unquoteFilterString;
-const quotesRegEx = /'/g;
-const escapeRegEx = /(\\)/g;
-const unescapeRegEx = /\\(.)/g;
-function escapeString(s) {
-    return s.replace(escapeRegEx, '\\\\');
-}
-function unescapeString(s) {
-    return s.replace(unescapeRegEx, '$1');
-}
-function quoteFilterString(s) {
-    return "'" + escapeString(s).replace(quotesRegEx, "\\'") + "'";
-}
-function unquoteFilterString(s) {
-    if (s &&
-        (s.startsWith("'") || s.startsWith('"')) &&
-        s.endsWith(s.charAt(0))) {
-        return unescapeString(s.substring(1, s.length - 1));
-    }
-    /* istanbul ignore next */
-    return s;
-}

package/cjs/helpers/function-utils.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveThunk = resolveThunk;
-const tslib_1 = require("tslib");
-const objects_1 = require("@jsopen/objects");
-const putil_promisify_1 = tslib_1.__importDefault(require("putil-promisify"));
-async function resolveThunk(thunk) {
-    thunk = putil_promisify_1.default.isPromise(thunk) ? await thunk : thunk;
-    if (typeof thunk === 'function') {
-        if ((0, objects_1.isConstructor)(thunk))
-            return thunk;
-        return await thunk();
-    }
-    return thunk;
-}

package/cjs/helpers/get-stack-filename.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStackFileName = getStackFileName;
-exports.getErrorStack = getErrorStack;
-const PATH_PATTERN = /^(?:file:\/\/)?(.+)$/;
-function getStackFileName(position = 1) {
-    if (position >= Error.stackTraceLimit) {
-        throw new TypeError('getCallerFile(position) requires position be less then Error.stackTraceLimit but position was: `' +
-            position +
-            '` and Error.stackTraceLimit was: `' +
-            Error.stackTraceLimit +
-            '`');
-    }
-    const oldPrepareStackTrace = Error.prepareStackTrace;
-    Error.prepareStackTrace = (_, stack) => stack;
-    const stack = new Error().stack;
-    Error.prepareStackTrace = oldPrepareStackTrace;
-    if (stack !== null && typeof stack === 'object') {
-        // stack[0] holds this file
-        // stack[1] holds where this function was called
-        const s = stack[position]
-            ? stack[position].getFileName()
-            : undefined;
-        const m = s ? PATH_PATTERN.exec(s) : undefined;
-        return m ? m[1] : '';
-    }
-    return '';
-}
-function getErrorStack(position = 1) {
-    if (position >= Error.stackTraceLimit) {
-        throw new TypeError('getCallerFile(position) requires position be less then Error.stackTraceLimit but position was: `' +
-            position +
-            '` and Error.stackTraceLimit was: `' +
-            Error.stackTraceLimit +
-            '`');
-    }
-    const oldPrepareStackTrace = Error.prepareStackTrace;
-    Error.prepareStackTrace = (_, stack) => stack;
-    const stack = new Error().stack;
-    Error.prepareStackTrace = oldPrepareStackTrace;
-    if (stack !== null && typeof stack === 'object') {
-        // stack[0] holds this file
-        // stack[1] holds where this function was called
-        const s = stack[position]
-            ? stack[position].getFileName()
-            : undefined;
-        const m = s ? PATH_PATTERN.exec(s) : undefined;
-        return m ? m[1] : '';
-    }
-    return '';
-}

package/cjs/helpers/index.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-require("./monkey-patches.js");
-tslib_1.__exportStar(require("./function-utils.js"), exports);
-tslib_1.__exportStar(require("./get-stack-filename.js"), exports);
-tslib_1.__exportStar(require("./mixin-utils.js"), exports);
-tslib_1.__exportStar(require("./object-utils.js"), exports);
-tslib_1.__exportStar(require("./parse-fields-projection.js"), exports);
-tslib_1.__exportStar(require("./responsive-map.js"), exports);
-tslib_1.__exportStar(require("./safe-json-stringify.js"), exports);
-tslib_1.__exportStar(require("./type-guards.js"), exports);

package/cjs/helpers/mixin-utils.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergePrototype = mergePrototype;
-exports.inheritPropertyInitializers = inheritPropertyInitializers;
-function mergePrototype(targetProto, baseProto, filter) {
-    for (const k of Object.getOwnPropertyNames(baseProto)) {
-        if (k === 'constructor' ||
-            k === '__proto__' ||
-            k === 'toJSON' ||
-            k === 'toString' ||
-            (filter && !filter(k))) {
-            continue;
-        }
-        Object.defineProperty(targetProto, k, Object.getOwnPropertyDescriptor(baseProto, k) || Object.create(null));
-    }
-}
-// noinspection JSUnusedLocalSymbols
-function inheritPropertyInitializers(target, clazz, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-isPropertyInherited = (key) => true) {
-    try {
-        const tempInstance = new clazz();
-        const propertyNames = Object.getOwnPropertyNames(tempInstance);
-        propertyNames
-            .filter(propertyName => typeof tempInstance[propertyName] !== 'undefined' &&
-            typeof target[propertyName] === 'undefined')
-            .filter(propertyName => isPropertyInherited(propertyName))
-            .forEach(propertyName => {
-            target[propertyName] = tempInstance[propertyName];
-        });
-    }
-    catch {
-        //
-    }
-}

package/cjs/helpers/object-utils.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneObject = cloneObject;
-const objects_1 = require("@jsopen/objects");
-const constants_js_1 = require("../document/constants.js");
-function cloneObject(obj, jsonOnly) {
-    return (0, objects_1.merge)({}, obj, {
-        deep: v => (0, objects_1.isPlainObject)(v) && !v[constants_js_1.DATATYPE_METADATA],
-        symbolKeys: true,
-        copyDescriptors: true,
-        ignoreUndefined: true,
-        filter(key, source) {
-            const v = source[key];
-            return (!jsonOnly ||
-                (typeof v !== 'function' &&
-                    (typeof v !== 'object' || (0, objects_1.isPlainObject)(v) || Array.isArray(v))));
-        },
-    });
-}

package/cjs/helpers/parse-fields-projection.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldsProjection = void 0;
-exports.parseFieldsProjection = parseFieldsProjection;
-exports.parse = parse;
-const fast_tokenizer_1 = require("fast-tokenizer");
-const FIELD_PATTERN = /^([+-])?([a-z_$]\w*)$/i;
-const NO_DOT_BRACKET_PATTERN = /[^.]\(/g;
-class FieldsProjection {
-}
-exports.FieldsProjection = FieldsProjection;
-(function (FieldsProjection) {
-    class Item {
-    }
-    FieldsProjection.Item = Item;
-})(FieldsProjection || (exports.FieldsProjection = FieldsProjection = {}));
-function parseFieldsProjection(projection, keepCase) {
-    const arr = Array.isArray(projection) ? projection : [projection];
-    if (!(arr && arr.length))
-        return;
-    const out = new FieldsProjection();
-    for (let s of arr) {
-        if (!keepCase)
-            s = s.toLowerCase();
-        parse(s, out);
-    }
-    return out;
-}
-function parse(input, target) {
-    /** Add dot before brackets which is required to split fields */
-    input = input.replace(NO_DOT_BRACKET_PATTERN, s => s.charAt(0) + '.' + s.substring(1));
-    const fields = (0, fast_tokenizer_1.splitString)(input, {
-        delimiters: '.',
-        brackets: true,
-        keepBrackets: false,
-    });
-    for (let i = 0; i < fields.length; i++) {
-        const f = fields[i];
-        if (f.includes(',')) {
-            const subFields = (0, fast_tokenizer_1.splitString)(f, {
-                delimiters: ',',
-                brackets: true,
-                keepBrackets: true,
-            });
-            for (const n of subFields) {
-                parse(n, target);
-            }
-            continue;
-        }
-        const m = FIELD_PATTERN.exec(f);
-        /* istanbul ignore next */
-        if (!m)
-            throw new TypeError(`Invalid field path (${input})`);
-        const fieldName = m[2];
-        const treeItem = (target[fieldName] =
-            target[fieldName] || new FieldsProjection.Item());
-        if (m[1])
-            treeItem.sign = m[1];
-        if (i === fields.length - 1) {
-            delete treeItem.projection;
-        }
-        else {
-            target = treeItem.projection =
-                treeItem.projection || new FieldsProjection();
-        }
-    }
-}