@opra/common 1.20.0 → 1.22.0

package/cjs/document/data-type/api-field.js

@@ -1,124 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiField = void 0;
-const objects_1 = require("@jsopen/objects");
-const ts_gems_1 = require("ts-gems");
-const document_element_js_1 = require("../common/document-element.js");
-const constants_js_1 = require("../constants.js");
-const api_field_decorator_js_1 = require("../decorators/api-field-decorator.js");
-const test_scope_match_js_1 = require("../utils/test-scope-match.js");
-const complex_type_base_js_1 = require("./complex-type-base.js");
-/**
- * @decorator ApiField
- */
-exports.ApiField = function (...args) {
-    // Decorator
-    if (!this) {
-        const [options] = args;
-        return exports.ApiField[constants_js_1.DECORATOR](options);
-    }
-    // Constructor
-    const [owner, initArgs] = args;
-    document_element_js_1.DocumentElement.call(this, owner);
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this.name = initArgs.name;
-    const origin = initArgs.origin || owner;
-    /* istanbul ignore next */
-    if (!(origin instanceof complex_type_base_js_1.ComplexTypeBase)) {
-        throw new Error('Field origin should be one of ComplexType, MappedType or MixinType');
-    }
-    _this.origin = origin;
-    _this.type = initArgs.type || owner.node.getDataType('any');
-    _this.description = initArgs.description;
-    _this.isArray = initArgs.isArray;
-    _this.isNestedEntity = initArgs.isNestedEntity;
-    _this.default = initArgs.default;
-    _this.fixed = initArgs.fixed;
-    _this.required = initArgs.required;
-    _this.exclusive = initArgs.exclusive;
-    _this.localization = initArgs.localization;
-    _this.keyField = initArgs.keyField;
-    _this.deprecated = initArgs.deprecated;
-    _this.readonly = initArgs.readonly;
-    _this.writeonly = initArgs.writeonly;
-    _this.examples = initArgs.examples;
-    _this.override = initArgs.override;
-    _this.scopePattern = initArgs.scopePattern
-        ? Array.isArray(initArgs.scopePattern)
-            ? initArgs.scopePattern
-            : [initArgs.scopePattern]
-        : undefined;
-    _this.designType = initArgs.designType;
-    _this.override = initArgs.override;
-};
-/**
- * The ApiFieldClass represents a descriptive metadata structure for API fields,
- * supporting features like data type definition, scoping, localization, and constraints.
- * This class extends DocumentElement, inheriting base document structure capabilities.
- */
-class ApiFieldClass extends document_element_js_1.DocumentElement {
-    inScope(scope) {
-        return (0, test_scope_match_js_1.testScopeMatch)(scope, this.scopePattern);
-    }
-    forScope(scope) {
-        if (!(scope && this.override))
-            return this;
-        this._overrideCache = this._overrideCache || {};
-        let field = this._overrideCache[scope];
-        if (field)
-            return field;
-        if (scope !== '*') {
-            for (const o of this.override) {
-                if ((0, test_scope_match_js_1.testScopeMatch)(scope, o.scopePattern)) {
-                    field = (0, objects_1.omitUndefined)({
-                        ...o,
-                        id: undefined,
-                        owner: undefined,
-                        node: undefined,
-                        origin: undefined,
-                        name: undefined,
-                        type: undefined,
-                        override: undefined,
-                        _overrideCache: undefined,
-                        scopePattern: o.scopePattern,
-                    });
-                    Object.setPrototypeOf(field, this);
-                    break;
-                }
-            }
-        }
-        field = field || this;
-        this._overrideCache[scope] = field;
-        return field;
-    }
-    toJSON(options) {
-        const typeName = this.type
-            ? this.node.getDataTypeNameWithNs(this.type)
-            : undefined;
-        return (0, objects_1.omitUndefined)({
-            type: typeName ? typeName : this.type?.toJSON(options),
-            description: this.description,
-            isArray: this.isArray || undefined,
-            isNestedEntity: this.isNestedEntity || undefined,
-            default: this.default,
-            fixed: this.fixed,
-            required: this.required || undefined,
-            exclusive: this.exclusive || undefined,
-            localization: this.localization || undefined,
-            keyField: this.keyField || undefined,
-            deprecated: this.deprecated || undefined,
-            readonly: this.readonly || undefined,
-            writeonly: this.writeonly || undefined,
-            examples: this.examples,
-        });
-    }
-    generateCodec(codec, options, properties) {
-        return this.type.generateCodec(codec, options, {
-            ...properties,
-            designType: this.designType,
-        });
-    }
-}
-exports.ApiField.prototype = ApiFieldClass.prototype;
-Object.assign(exports.ApiField, api_field_decorator_js_1.ApiFieldDecoratorFactory);
-exports.ApiField[constants_js_1.DECORATOR] = api_field_decorator_js_1.ApiFieldDecoratorFactory;

package/cjs/document/data-type/array-type.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayType = void 0;
-require("reflect-metadata");
-const objects_1 = require("@jsopen/objects");
-const ts_gems_1 = require("ts-gems");
-const valgen_1 = require("valgen");
-const index_js_1 = require("../../schema/index.js");
-const constants_js_1 = require("../constants.js");
-const data_type_js_1 = require("./data-type.js");
-/**
- * @class ArrayType
- */
-exports.ArrayType = function (...args) {
-    // ArrayType factory
-    if (!this) {
-        return exports.ArrayType[constants_js_1.DECORATOR].apply(undefined, args);
-    }
-    // Constructor
-    const [owner, initArgs, context] = args;
-    data_type_js_1.DataType.call(this, owner, initArgs, context);
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this.kind = index_js_1.OpraSchema.ArrayType.Kind;
-    _this.type = initArgs.type;
-    _this.minOccurs = initArgs.minOccurs;
-    _this.maxOccurs = initArgs.maxOccurs;
-};
-/**
- *
- * @class ArrayType
- */
-class ArrayTypeClass extends data_type_js_1.DataType {
-    toJSON(options) {
-        const superJson = super.toJSON(options);
-        const typeName = this.node.getDataTypeNameWithNs(this.type);
-        return (0, objects_1.omitUndefined)({
-            ...superJson,
-            kind: this.kind,
-            type: typeName ? typeName : this.type.toJSON(options),
-            minOccurs: this.minOccurs,
-            maxOccurs: this.maxOccurs,
-        });
-    }
-    generateCodec(codec, options, properties) {
-        let fn = this.type.generateCodec(codec, options, properties);
-        fn = valgen_1.vg.isArray(fn);
-        const fns = [];
-        if (this.minOccurs)
-            fns.push(valgen_1.vg.lengthMin(this.minOccurs));
-        if (this.maxOccurs)
-            fns.push(valgen_1.vg.lengthMax(this.maxOccurs));
-        if (fns.length > 0)
-            return valgen_1.vg.pipe([fn, ...fns], { returnIndex: 0 });
-        return fn;
-    }
-    extendsFrom() {
-        return false;
-    }
-    _locateBase() {
-        return;
-    }
-}
-exports.ArrayType.prototype = ArrayTypeClass.prototype;
-exports.ArrayType[constants_js_1.DECORATOR] = ArrayTypeFactory;
-/**
- *
- */
-function ArrayTypeFactory(clasRefs, options) {
-    class ArrayClass {
-    }
-    const metadata = {
-        ...options,
-        kind: index_js_1.OpraSchema.ArrayType.Kind,
-        type: clasRefs,
-    };
-    Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, ArrayClass);
-    return ArrayClass;
-}

package/cjs/document/data-type/complex-type-base.js

@@ -1,346 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComplexTypeBase = exports.FIELD_PATH_PATTERN = void 0;
-const tslib_1 = require("tslib");
-const object_hash_1 = tslib_1.__importDefault(require("object-hash"));
-const ts_gems_1 = require("ts-gems");
-const valgen_1 = require("valgen");
-const index_js_1 = require("../../helpers/index.js");
-const array_type_js_1 = require("./array-type.js");
-const data_type_js_1 = require("./data-type.js");
-exports.FIELD_PATH_PATTERN = /^([+-])?([a-z$_][\w.]*)$/i;
-/**
- *
- * @constructor
- */
-exports.ComplexTypeBase = function (...args) {
-    if (!this)
-        throw new TypeError('"this" should be passed to call class constructor');
-    // Constructor
-    const [owner, initArgs, context] = args;
-    data_type_js_1.DataType.call(this, owner, initArgs, context);
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this._fields = new index_js_1.ResponsiveMap();
-};
-/**
- *
- */
-class ComplexTypeBaseClass extends data_type_js_1.DataType {
-    fieldCount(scope) {
-        if (scope === '*')
-            return this._fields.size;
-        let count = 0;
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        for (const i of this.fields(scope))
-            count++;
-        return count;
-    }
-    fieldEntries(scope) {
-        let iterator = this._fields.entries();
-        if (scope === '*')
-            return iterator;
-        let r;
-        return {
-            next() {
-                while (iterator) {
-                    r = iterator.next();
-                    if (r.done)
-                        break;
-                    if (r.value && r.value[1].inScope(scope))
-                        break;
-                }
-                if (r.done)
-                    return { done: r.done, value: undefined };
-                return {
-                    done: r.done,
-                    value: [r.value[0], r.value[1].forScope(scope)],
-                };
-            },
-            return(value) {
-                iterator = undefined;
-                return { done: true, value };
-            },
-            [Symbol.iterator]() {
-                return this;
-            },
-        };
-    }
-    fields(scope) {
-        let iterator = this.fieldEntries(scope);
-        let r;
-        return {
-            next() {
-                if (!iterator)
-                    return { done: true, value: undefined };
-                r = iterator.next();
-                return { done: r.done, value: r.value?.[1] };
-            },
-            return(value) {
-                iterator = undefined;
-                return { done: true, value };
-            },
-            [Symbol.iterator]() {
-                return this;
-            },
-        };
-    }
-    fieldNames(scope) {
-        if (scope === '*')
-            return this._fields.keys();
-        let iterator = this.fieldEntries(scope);
-        let r;
-        return {
-            next() {
-                if (!iterator)
-                    return { done: true, value: undefined };
-                r = iterator.next();
-                return { done: r.done, value: r.value?.[0] };
-            },
-            return(value) {
-                iterator = undefined;
-                return { done: true, value };
-            },
-            [Symbol.iterator]() {
-                return this;
-            },
-        };
-    }
-    /**
-     *
-     */
-    findField(nameOrPath, scope) {
-        if (nameOrPath.includes('.')) {
-            const fieldPath = this.parseFieldPath(nameOrPath, { scope });
-            if (fieldPath.length === 0)
-                throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope}"`);
-            const lastItem = fieldPath.pop();
-            return lastItem?.field;
-        }
-        const field = this._fields.get(nameOrPath);
-        if (field && field.inScope(scope))
-            return field.forScope(scope);
-    }
-    /**
-     *
-     */
-    getField(nameOrPath, scope) {
-        const field = this.findField(nameOrPath, '*');
-        if (field && !field.inScope(scope))
-            throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope || 'null'}"`);
-        if (!field) {
-            throw new Error(`Field (${nameOrPath}) does not exist`);
-        }
-        return field.forScope(scope);
-    }
-    /**
-     *
-     */
-    parseFieldPath(fieldPath, options) {
-        let dataType = this;
-        let field;
-        const arr = fieldPath.split('.');
-        const len = arr.length;
-        const out = [];
-        const objectType = this.owner.node.getDataType('object');
-        const allowSigns = options?.allowSigns;
-        const getStrPath = () => out.map(x => x.fieldName).join('.');
-        for (let i = 0; i < len; i++) {
-            const item = {
-                fieldName: arr[i],
-                dataType: objectType,
-            };
-            out.push(item);
-            const m = exports.FIELD_PATH_PATTERN.exec(arr[i]);
-            if (!m)
-                throw new TypeError(`Invalid field name (${getStrPath()})`);
-            if (m[1]) {
-                if ((i === 0 && allowSigns === 'first') || allowSigns === 'each')
-                    item.sign = m[1];
-                item.fieldName = m[2];
-            }
-            if (dataType) {
-                if (dataType instanceof exports.ComplexTypeBase) {
-                    field = dataType.findField(item.fieldName, options?.scope);
-                    if (field) {
-                        item.fieldName = field.name;
-                        item.field = field;
-                        item.dataType = field.type;
-                        dataType = field.type;
-                        continue;
-                    }
-                    if (dataType.additionalFields?.[0] === true) {
-                        item.additionalField = true;
-                        item.dataType = objectType;
-                        dataType = undefined;
-                        continue;
-                    }
-                    if (dataType.additionalFields?.[0] === 'type' &&
-                        dataType.additionalFields?.[1] instanceof data_type_js_1.DataType) {
-                        item.additionalField = true;
-                        item.dataType = dataType.additionalFields[1];
-                        dataType = dataType.additionalFields[1];
-                        continue;
-                    }
-                    throw new Error(`Unknown field (${out.map(x => x.fieldName).join('.')})`);
-                }
-                throw new TypeError(`"${out.map(x => x.fieldName).join('.')}" field is not a complex type and has no child fields`);
-            }
-            item.additionalField = true;
-            item.dataType = objectType;
-        }
-        return out;
-    }
-    /**
-     *
-     */
-    normalizeFieldPath(fieldPath, options) {
-        return this.parseFieldPath(fieldPath, options)
-            .map(x => (x.sign || '') + x.fieldName)
-            .join('.');
-    }
-    /**
-     *
-     */
-    generateCodec(codec, options) {
-        const context = options?.cache
-            ? options
-            : {
-                ...options,
-                projection: Array.isArray(options?.projection)
-                    ? (0, index_js_1.parseFieldsProjection)(options.projection)
-                    : options?.projection,
-                currentPath: '',
-            };
-        const schema = this._generateSchema(codec, context);
-        let additionalFields;
-        if (this.additionalFields instanceof data_type_js_1.DataType) {
-            additionalFields = this.additionalFields.generateCodec(codec, options);
-        }
-        else if (typeof this.additionalFields === 'boolean')
-            additionalFields = this.additionalFields;
-        else if (Array.isArray(this.additionalFields)) {
-            if (this.additionalFields.length < 2)
-                additionalFields = 'error';
-            else {
-                const message = additionalFields[1];
-                additionalFields = (0, valgen_1.validator)((input, ctx, _this) => ctx.fail(_this, message, input));
-            }
-        }
-        const fn = valgen_1.vg.isObject(schema, {
-            ctor: this.name === 'object' ? Object : this.ctor,
-            additionalFields,
-            name: this.name,
-            coerce: true,
-            caseInSensitive: options?.caseInSensitive,
-            onFail: options?.onFail,
-        });
-        if (context.level === 0 && context.forwardCallbacks?.size) {
-            for (const cb of context.forwardCallbacks) {
-                cb();
-            }
-        }
-        return fn;
-    }
-    _generateSchema(codec, context) {
-        context.fieldCache = context.fieldCache || new Map();
-        context.level = context.level || 0;
-        context.forwardCallbacks = context.forwardCallbacks || new Set();
-        const schema = {};
-        const { currentPath, projection } = context;
-        const pickList = !!(projection && Object.values(projection).find(p => !p.sign));
-        // Process fields
-        let fieldName;
-        for (const field of this.fields('*')) {
-            if (
-            /** Ignore field if required scope(s) do not match field scopes */
-            !field.inScope(context.scope) ||
-                (!(context.keepKeyFields && this.keyField) &&
-                    /** Ignore field if readonly and ignoreReadonlyFields option true */
-                    ((context.ignoreReadonlyFields && field.readonly) ||
-                        /** Ignore field if writeonly and ignoreWriteonlyFields option true */
-                        (context.ignoreWriteonlyFields && field.writeonly)))) {
-                schema[field.name] = valgen_1.vg.isUndefined({ coerce: true });
-                continue;
-            }
-            fieldName = field.name;
-            let p;
-            if (projection !== '*') {
-                p = projection?.[fieldName.toLowerCase()];
-                if (
-                /** Ignore if field is omitted */
-                p?.sign === '-' ||
-                    /** Ignore if default fields ignored and field is not in projection */
-                    (pickList && !p) ||
-                    /** Ignore if default fields enabled and fields is exclusive */
-                    (!pickList && field.exclusive && !p)) {
-                    schema[field.name] = valgen_1.vg.isUndefined({ coerce: true });
-                    continue;
-                }
-            }
-            const subProjection = typeof projection === 'object'
-                ? projection[fieldName]?.projection || '*'
-                : projection;
-            let cacheItem = context.fieldCache.get(field);
-            const cacheKey = typeof subProjection === 'string'
-                ? subProjection
-                : (0, object_hash_1.default)(subProjection || {});
-            if (!cacheItem) {
-                cacheItem = {};
-                context.fieldCache.set(field, cacheItem);
-            }
-            let fn = cacheItem[cacheKey];
-            /** If in progress (circular) */
-            if (fn === null) {
-                // Temporary set any
-                fn = valgen_1.vg.isAny();
-                context.forwardCallbacks.add(() => {
-                    fn = cacheItem[cacheKey];
-                    schema[fieldName] =
-                        context.partial || !field.required
-                            ? valgen_1.vg.optional(fn)
-                            : valgen_1.vg.required(fn);
-                });
-            }
-            else if (!fn) {
-                const defaultGenerator = () => {
-                    cacheItem[cacheKey] = null;
-                    const xfn = this._generateFieldCodec(codec, field, {
-                        ...context,
-                        partial: context.partial === 'deep' ? context.partial : undefined,
-                        projection: subProjection,
-                        currentPath: currentPath + (currentPath ? '.' : '') + fieldName,
-                    });
-                    cacheItem[cacheKey] = xfn;
-                    return xfn;
-                };
-                if (context.fieldHook)
-                    fn = context.fieldHook(field, context.currentPath, defaultGenerator);
-                else
-                    fn = defaultGenerator();
-            }
-            schema[fieldName] =
-                context.partial || !(field.required || fn.id === 'required')
-                    ? valgen_1.vg.optional(fn)
-                    : fn.id === 'required'
-                        ? fn
-                        : valgen_1.vg.required(fn);
-        }
-        if (context.allowPatchOperators) {
-            schema._$pull = valgen_1.vg.optional(valgen_1.vg.isAny());
-            schema._$push = valgen_1.vg.optional(valgen_1.vg.isAny());
-        }
-        return schema;
-    }
-    _generateFieldCodec(codec, field, context) {
-        let fn = field.generateCodec(codec, {
-            ...context,
-            level: context.level + 1,
-        });
-        if (field.fixed)
-            fn = valgen_1.vg.isEqual(field.fixed);
-        if (field.isArray && !(field.type instanceof array_type_js_1.ArrayType))
-            fn = valgen_1.vg.isArray(fn);
-        return fn;
-    }
-}
-exports.ComplexTypeBase.prototype = ComplexTypeBaseClass.prototype;

package/cjs/document/data-type/complex-type.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComplexType = void 0;
-require("reflect-metadata");
-const objects_1 = require("@jsopen/objects");
-const ts_gems_1 = require("ts-gems");
-const index_js_1 = require("../../schema/index.js");
-const document_init_context_js_1 = require("../common/document-init-context.js");
-const constants_js_1 = require("../constants.js");
-const complex_type_decorator_js_1 = require("../decorators/complex-type.decorator.js");
-const api_field_js_1 = require("./api-field.js");
-const complex_type_base_js_1 = require("./complex-type-base.js");
-const data_type_js_1 = require("./data-type.js");
-/**
- * ComplexType constructor
- */
-exports.ComplexType = function (...args) {
-    // Decorator
-    if (!this)
-        return exports.ComplexType[constants_js_1.DECORATOR].apply(undefined, args);
-    // Constructor
-    const [owner, initArgs] = args;
-    const context = args[2] || new document_init_context_js_1.DocumentInitContext({ maxErrors: 0 });
-    complex_type_base_js_1.ComplexTypeBase.call(this, owner, initArgs, context);
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this.kind = index_js_1.OpraSchema.ComplexType.Kind;
-    _this.discriminatorField = initArgs.discriminatorField;
-    _this.discriminatorValue = initArgs.discriminatorValue;
-    if (initArgs.base) {
-        context.enter('.base', () => {
-            // noinspection SuspiciousTypeOfGuard
-            if (!(initArgs.base instanceof complex_type_base_js_1.ComplexTypeBase)) {
-                throw new TypeError(`"${initArgs.base.kind}" can't be set as base for a "${this.kind}"`);
-            }
-            _this.base = initArgs.base;
-            _this.additionalFields = _this.base.additionalFields;
-            _this.keyField = _this.base.keyField;
-            /** Copy fields from base */
-            for (const v of _this.base.fields('*')) {
-                _this._fields.set(v.name, new api_field_js_1.ApiField(this, v));
-            }
-        });
-    }
-    if (initArgs.additionalFields !== undefined)
-        _this.additionalFields = initArgs.additionalFields;
-    if (initArgs.keyField !== undefined)
-        _this.keyField = initArgs.keyField;
-    _this.ctor = initArgs.ctor || _this.base?.ctor;
-    /** Add own fields */
-    if (initArgs.fields) {
-        context.enter('.fields', () => {
-            for (const [k, v] of Object.entries(initArgs.fields)) {
-                const field = new api_field_js_1.ApiField(this, {
-                    ...v,
-                    name: k,
-                });
-                this._fields.set(field.name, field);
-            }
-        });
-    }
-};
-/**
- *
- * @class ComplexType
- */
-class ComplexTypeClass extends complex_type_base_js_1.ComplexTypeBase {
-    extendsFrom(baseType) {
-        if (!(baseType instanceof data_type_js_1.DataType))
-            baseType = this.node.getDataType(baseType);
-        if (!(baseType instanceof complex_type_base_js_1.ComplexTypeBase))
-            return false;
-        if (baseType === this)
-            return true;
-        return !!this.base?.extendsFrom(baseType);
-    }
-    toJSON(options) {
-        const superJson = super.toJSON(options);
-        const baseName = this.base
-            ? this.node.getDataTypeNameWithNs(this.base)
-            : undefined;
-        const out = {
-            ...superJson,
-            kind: this.kind,
-            base: this.base
-                ? baseName
-                    ? baseName
-                    : this.base.toJSON(options)
-                : undefined,
-            discriminatorField: this.discriminatorField,
-            discriminatorValue: this.discriminatorValue,
-        };
-        if (this.additionalFields) {
-            if (this.additionalFields instanceof data_type_js_1.DataType) {
-                const typeName = this.node.getDataTypeNameWithNs(this.additionalFields);
-                out.additionalFields = typeName
-                    ? typeName
-                    : this.additionalFields.toJSON(options);
-            }
-            else
-                out.additionalFields = this.additionalFields;
-        }
-        if (this._fields.size) {
-            const fields = {};
-            let i = 0;
-            for (const field of this._fields.values()) {
-                if (field.origin === this && field.inScope(options?.scope)) {
-                    fields[field.name] = field.toJSON(options);
-                    i++;
-                }
-            }
-            if (i)
-                out.fields = fields;
-        }
-        return (0, objects_1.omitUndefined)(out);
-    }
-    _locateBase(callback) {
-        if (!this.base)
-            return;
-        if (callback(this.base))
-            return this.base;
-        if (this.base._locateBase)
-            return this.base._locateBase(callback);
-    }
-}
-exports.ComplexType.prototype = ComplexTypeClass.prototype;
-Object.assign(exports.ComplexType, complex_type_decorator_js_1.ComplexTypeDecorator);
-exports.ComplexType[constants_js_1.DECORATOR] = complex_type_decorator_js_1.ComplexTypeDecorator;