@opra/common 1.20.0 → 1.22.0

package/cjs/document/api-document.js

@@ -1,182 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiDocument = void 0;
-const objects_1 = require("@jsopen/objects");
-const super_fast_md5_1 = require("super-fast-md5");
-const index_js_1 = require("../helpers/index.js");
-const index_js_2 = require("../schema/index.js");
-const data_type_map_js_1 = require("./common/data-type-map.js");
-const document_element_js_1 = require("./common/document-element.js");
-const constants_js_1 = require("./constants.js");
-const data_type_js_1 = require("./data-type/data-type.js");
-const http_api_js_1 = require("./http/http-api.js");
-const mq_api_js_1 = require("./mq/mq-api.js");
-const ws_api_js_1 = require("./ws/ws-api.js");
-/**
- *
- * @class ApiDocument
- */
-class ApiDocument extends document_element_js_1.DocumentElement {
-    constructor() {
-        super(null);
-        this[_a] = new WeakMap();
-        this.id = '';
-        this.info = {};
-        this.references = new index_js_1.ResponsiveMap();
-        this.types = new data_type_map_js_1.DataTypeMap();
-        this.node[constants_js_1.kDataTypeMap] = this.types;
-        this.node.findDataType = this._findDataType.bind(this);
-    }
-    /**
-     * Returns NS of datatype. Returns undefined if not found
-     * @param nameOrCtor
-     */
-    getDataTypeNs(nameOrCtor) {
-        const dt = nameOrCtor instanceof data_type_js_1.DataType
-            ? this._findDataType(nameOrCtor.name || '')
-            : this._findDataType(nameOrCtor);
-        if (dt)
-            return this[constants_js_1.kTypeNSMap].get(dt);
-    }
-    findDocument(id) {
-        if (this.id === id)
-            return this;
-        for (const doc of this.references.values()) {
-            if (doc.id === id)
-                return doc;
-            const d = doc.findDocument(id);
-            if (d)
-                return d;
-        }
-    }
-    get httpApi() {
-        if (this.api && this.api instanceof http_api_js_1.HttpApi)
-            return this.api;
-    }
-    get mqApi() {
-        if (this.api && this.api instanceof mq_api_js_1.MQApi)
-            return this.api;
-    }
-    get wsApi() {
-        if (this.api && this.api instanceof ws_api_js_1.WSApi)
-            return this.api;
-    }
-    getHttpApi() {
-        if (!(this.api && this.api instanceof http_api_js_1.HttpApi)) {
-            throw new TypeError('The document do not contains HttpApi instance');
-        }
-        return this.api;
-    }
-    getMqApi() {
-        if (!(this.api && this.api instanceof mq_api_js_1.MQApi)) {
-            throw new TypeError('The document do not contains MQApi instance');
-        }
-        return this.api;
-    }
-    getWsApi() {
-        if (!(this.api && this.api instanceof ws_api_js_1.WSApi)) {
-            throw new TypeError('The document do not contains WSApi instance');
-        }
-        return this.api;
-    }
-    toJSON() {
-        return this.export();
-    }
-    /**
-     * Export as Opra schema definition object
-     */
-    export(options) {
-        const out = (0, objects_1.omitUndefined)({
-            spec: index_js_2.OpraSchema.SpecVersion,
-            id: this.id,
-            url: this.url,
-            info: (0, index_js_1.cloneObject)(this.info, true),
-        });
-        if (this.references.size) {
-            let i = 0;
-            const references = {};
-            for (const [ns, doc] of this.references.entries()) {
-                if (doc[constants_js_1.BUILTIN])
-                    continue;
-                references[ns] = {
-                    id: doc.id,
-                    url: doc.url,
-                    info: (0, index_js_1.cloneObject)(doc.info, true),
-                };
-                i++;
-            }
-            if (i)
-                out.references = references;
-        }
-        if (this.types.size) {
-            out.types = {};
-            for (const v of this.types.values()) {
-                if (!v.inScope(options?.scope))
-                    continue;
-                out.types[v.name] = v.toJSON(options);
-            }
-        }
-        if (this.api)
-            out.api = this.api.toJSON(options);
-        return out;
-    }
-    invalidate() {
-        /** Generate id */
-        const x = this.export({});
-        delete x.id;
-        this.id = (0, super_fast_md5_1.md5)(JSON.stringify(x));
-        /** Clear [kTypeNSMap] */
-        this[constants_js_1.kTypeNSMap] = new WeakMap();
-    }
-    _findDataType(nameOrCtor, scope, visitedRefs) {
-        let result = this.types.get(nameOrCtor);
-        if (result && result.inScope(scope))
-            return result;
-        if (!this.references.size)
-            return;
-        // Lookup for references
-        if (typeof nameOrCtor === 'string') {
-            // If given string has namespace pattern (ns:type_name)
-            const m = constants_js_1.NAMESPACE_PATTERN.exec(nameOrCtor);
-            if (m) {
-                const ns = m[1];
-                if (ns) {
-                    const ref = this.references.get(ns);
-                    if (!ref)
-                        return;
-                    visitedRefs = visitedRefs || new WeakMap();
-                    visitedRefs.set(this, true);
-                    visitedRefs.set(ref, true);
-                    return ref._findDataType(m[2], scope, visitedRefs);
-                }
-                nameOrCtor = m[2];
-            }
-        }
-        // if not found, search in references (from last to first)
-        visitedRefs = visitedRefs || new WeakMap();
-        visitedRefs.set(this, true);
-        const references = Array.from(this.references.keys()).reverse();
-        /** First step, lookup for own types */
-        for (const refNs of references) {
-            const ref = this.references.get(refNs);
-            result = ref?.types.get(nameOrCtor);
-            if (result) {
-                this[constants_js_1.kTypeNSMap].set(result, ref?.[constants_js_1.BUILTIN] ? '' : refNs);
-                return result;
-            }
-        }
-        /** If not found lookup for child references */
-        for (const refNs of references) {
-            const ref = this.references.get(refNs);
-            visitedRefs.set(ref, true);
-            result = ref._findDataType(nameOrCtor, scope, visitedRefs);
-            if (result) {
-                this[constants_js_1.kTypeNSMap].set(result, ref?.[constants_js_1.BUILTIN] ? '' : refNs);
-                return result;
-            }
-        }
-    }
-}
-exports.ApiDocument = ApiDocument;
-_a = constants_js_1.kTypeNSMap;

package/cjs/document/common/api-base.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBase = void 0;
-const objects_1 = require("@jsopen/objects");
-const constants_js_1 = require("../constants.js");
-const document_element_js_1 = require("./document-element.js");
-class ApiBase extends document_element_js_1.DocumentElement {
-    constructor(init) {
-        super(init.owner);
-        this.name = 'OpraApi';
-        this.name = init.name;
-        this.description = init.description;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    toJSON(options) {
-        return (0, objects_1.omitUndefined)({
-            transport: this.transport,
-            name: this.name,
-            description: this.description,
-        });
-    }
-    async _initialize(init, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    context) {
-        if (!constants_js_1.CLASS_NAME_PATTERN.test(init.name))
-            throw new TypeError(`Invalid api name (${init.name})`);
-        this.name = init.name;
-        this.description = init?.description;
-    }
-}
-exports.ApiBase = ApiBase;

package/cjs/document/common/data-type-map.js

@@ -1,77 +0,0 @@
-"use strict";
-var _a, _b;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataTypeMap = void 0;
-const index_js_1 = require("../../helpers/index.js");
-const constants_js_1 = require("../constants.js");
-const data_type_js_1 = require("../data-type/data-type.js");
-const kMap = Symbol.for('kMap');
-const kCtorMap = Symbol.for('kCtorMap');
-/**
- * @class DataTypeMap
- */
-class DataTypeMap {
-    constructor() {
-        this[_a] = new index_js_1.ResponsiveMap();
-        this[_b] = new WeakMap();
-    }
-    get size() {
-        return this[kMap].size;
-    }
-    forEach(callbackFn, thisArg) {
-        this[kMap].forEach(callbackFn, thisArg);
-    }
-    get(nameOrCtor) {
-        let name = typeof nameOrCtor === 'string'
-            ? nameOrCtor
-            : this[kCtorMap].get(nameOrCtor);
-        if (!name && typeof nameOrCtor === 'function') {
-            const metadata = Reflect.getMetadata(constants_js_1.DATATYPE_METADATA, nameOrCtor);
-            name = metadata?.name;
-        }
-        if (!name && typeof nameOrCtor === 'object') {
-            const metadata = nameOrCtor[constants_js_1.DATATYPE_METADATA];
-            name = metadata?.name;
-        }
-        if (!name)
-            return;
-        const out = this[kMap].get(name);
-        if (!out)
-            return;
-        if (typeof nameOrCtor === 'function' && out.kind === 'ComplexType')
-            return out.ctor === nameOrCtor ? out : undefined;
-        return out;
-    }
-    set(name, dataType) {
-        this[kMap].set(name, dataType);
-        if (dataType.ctor)
-            this[kCtorMap].set(dataType.ctor, name);
-        else if (dataType.instance)
-            this[kCtorMap].set(dataType.instance, name);
-    }
-    has(nameOrCtor) {
-        if (nameOrCtor instanceof data_type_js_1.DataType)
-            return !!nameOrCtor.name && this[kMap].has(nameOrCtor.name);
-        const name = typeof nameOrCtor === 'string'
-            ? nameOrCtor
-            : this[kCtorMap].get(nameOrCtor);
-        return name ? this[kMap].has(name) : false;
-    }
-    keys() {
-        return this[kMap].keys();
-    }
-    values() {
-        return this[kMap].values();
-    }
-    entries() {
-        return this[kMap].entries();
-    }
-    sort(compareFn) {
-        this[kMap].sort(compareFn);
-        return this;
-    }
-    [(_a = kMap, _b = kCtorMap, Symbol.iterator)]() {
-        return this[kMap][Symbol.iterator]();
-    }
-}
-exports.DataTypeMap = DataTypeMap;

package/cjs/document/common/document-element.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentElement = void 0;
-const ts_gems_1 = require("ts-gems");
-const uid_1 = require("uid");
-const document_node_js_1 = require("./document-node.js");
-/**
- *
- * @constructor DocumentElement
- */
-exports.DocumentElement = function (owner) {
-    if (!this)
-        throw new TypeError('"this" should be passed to call class constructor');
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this.id = (0, uid_1.uid)(16);
-    Object.defineProperty(_this, 'node', {
-        value: new document_node_js_1.DocumentNode(this, owner?.node),
-        enumerable: false,
-        writable: true,
-    });
-    if (owner) {
-        Object.defineProperty(_this, 'owner', {
-            value: owner,
-            enumerable: false,
-            writable: true,
-        });
-    }
-};
-/**
- * @class DocumentElement
- */
-class DocumentElementClass {
-}
-exports.DocumentElement.prototype = DocumentElementClass.prototype;

package/cjs/document/common/document-init-context.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentInitContext = void 0;
-const opra_document_error_js_1 = require("./opra-document-error.js");
-class DocumentInitContext {
-    constructor(options) {
-        this.path = '';
-        this.error = new opra_document_error_js_1.OpraDocumentError();
-        this.showErrorDetails = true;
-        this.maxErrors = options?.maxErrors || 0;
-        this.error.message = '';
-    }
-    addError(error) {
-        if (!this.error.details.length) {
-            if (error instanceof Error)
-                this.error.stack = error.stack;
-            else {
-                const e = new Error();
-                Error.captureStackTrace(e, this.addError);
-                this.error.stack = e.stack;
-            }
-        }
-        // @ts-ignore
-        this.error.add({
-            message: typeof error === 'string' ? error : error.message,
-            path: this.path,
-            ...(typeof error === 'object' ? error : undefined),
-        });
-        if (this.error.details.length >= this.maxErrors)
-            throw this.error;
-    }
-    enter(path, fn) {
-        const oldPath = this.path;
-        this.path = this.path + path;
-        try {
-            return fn();
-        }
-        catch (e) {
-            if (e !== this.error) {
-                this.addError(e);
-            }
-        }
-        finally {
-            this.path = oldPath;
-        }
-    }
-    async enterAsync(path, fn) {
-        const oldPath = this.path;
-        this.path = this.path + path;
-        try {
-            return await fn();
-        }
-        catch (e) {
-            if (e !== this.error)
-                this.addError(e);
-        }
-        finally {
-            this.path = oldPath;
-        }
-    }
-    extend(args) {
-        const out = {
-            ...args,
-        };
-        Object.setPrototypeOf(out, this);
-        return out;
-    }
-}
-exports.DocumentInitContext = DocumentInitContext;

package/cjs/document/common/document-node.js

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentNode = void 0;
-const index_js_1 = require("../../schema/index.js");
-const constants_js_1 = require("../constants.js");
-/**
- * @class DocumentNode
- */
-class DocumentNode {
-    constructor(element, parent) {
-        this.element = element;
-        this.parent = parent;
-    }
-    getDocument() {
-        if (this._document)
-            return this._document;
-        if (this.element[constants_js_1.kTypeNSMap])
-            return this.element;
-        if (this.parent)
-            return (this._document = this.parent.getDocument());
-        // istanbul ignore next
-        throw new Error('ApiDocument not found in document tree');
-    }
-    hasDataType(nameOrCtor, scope) {
-        return !!this.findDataType(nameOrCtor, scope);
-    }
-    findDataType(nameOrCtor, scope) {
-        const dt = this[constants_js_1.kDataTypeMap]?.get(nameOrCtor);
-        if (dt && dt.inScope(scope))
-            return dt;
-        return this.parent
-            ? this.parent.findDataType(nameOrCtor, scope)
-            : undefined;
-    }
-    /**
-     * Returns DataType instance by name or Constructor. Returns undefined if not found
-     */
-    getDataType(nameOrCtor, scope) {
-        const dt = this.findDataType(nameOrCtor, scope);
-        if (dt)
-            return dt;
-        let name = '';
-        if (typeof nameOrCtor === 'function') {
-            const metadata = Reflect.getMetadata(constants_js_1.DATATYPE_METADATA, nameOrCtor);
-            name = metadata.name;
-        }
-        else if (typeof nameOrCtor === 'object') {
-            const metadata = nameOrCtor[constants_js_1.DATATYPE_METADATA];
-            name = metadata?.name;
-        }
-        if (!name) {
-            if (nameOrCtor && typeof nameOrCtor === 'string')
-                name = nameOrCtor;
-            else if (typeof nameOrCtor === 'function')
-                name = nameOrCtor.name;
-        }
-        if (dt)
-            throw new TypeError(`Data type${name ? ' (' + name + ')' : ''} is not in requested scope (${scope})`);
-        throw new TypeError(`Unknown data type${name ? ' (' + name + ')' : ''}`);
-    }
-    getDataTypeNameWithNs(dataType) {
-        if (!dataType.name)
-            return;
-        const ns = this.getDocument().getDataTypeNs(dataType);
-        return ns ? ns + ':' + dataType.name : dataType.name;
-    }
-    /**
-     * Returns EnumType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a UnionType
-     */
-    getArrayType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.ArrayType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a MixinType`);
-    }
-    /**
-     * Returns ComplexType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a ComplexType
-     */
-    getComplexType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.ComplexType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name}" is not a ComplexType`);
-    }
-    /**
-     * Returns SimpleType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a SimpleType
-     */
-    getSimpleType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.SimpleType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a SimpleType`);
-    }
-    /**
-     * Returns EnumType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a EnumType
-     */
-    getEnumType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.EnumType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a EnumType`);
-    }
-    /**
-     * Returns EnumType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a MappedType
-     */
-    getMappedType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.MappedType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a MappedType`);
-    }
-    /**
-     * Returns EnumType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a MixinType
-     */
-    getMixinType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.MixinType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a MixinType`);
-    }
-    /**
-     * Returns EnumType instance by name or Constructor.
-     * Returns undefined if not found
-     * Throws error if data type is not a UnionType
-     */
-    getUnionType(nameOrCtor, scope) {
-        const t = this.getDataType(nameOrCtor, scope);
-        if (t.kind === index_js_1.OpraSchema.UnionType.Kind)
-            return t;
-        throw new TypeError(`Data type "${t.name || t}" is not a UnionType`);
-    }
-}
-exports.DocumentNode = DocumentNode;

package/cjs/document/common/opra-document-error.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpraDocumentError = void 0;
-const opra_exception_js_1 = require("../../exception/opra-exception.js");
-class OpraDocumentError extends opra_exception_js_1.OpraException {
-    constructor() {
-        super('');
-        this.details = [];
-    }
-    add(detail) {
-        this.details.push(detail);
-        return this;
-    }
-}
-exports.OpraDocumentError = OpraDocumentError;

package/cjs/document/common/value.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Value = void 0;
-const objects_1 = require("@jsopen/objects");
-const ts_gems_1 = require("ts-gems");
-const document_element_js_1 = require("./document-element.js");
-exports.Value = function (owner, initArgs) {
-    if (!this)
-        throw new TypeError('"this" should be passed to call class constructor');
-    document_element_js_1.DocumentElement.call(this, owner);
-    // if (args.name && !PARAMETER_NAME_PATTERN.test(args.name))
-    //   throw new TypeError(`"${args.name}" is not a valid parameter name`);
-    const _this = (0, ts_gems_1.asMutable)(this);
-    _this.description = initArgs.description;
-    _this.type = initArgs.type;
-    _this.examples = initArgs.examples;
-    _this.isArray = initArgs.isArray;
-};
-/**
- * @class Value
- */
-class ValueClass extends document_element_js_1.DocumentElement {
-    toJSON(options) {
-        const typeName = this.type
-            ? this.node.getDataTypeNameWithNs(this.type)
-            : undefined;
-        return (0, objects_1.omitUndefined)({
-            type: this.type
-                ? typeName
-                    ? typeName
-                    : this.type.toJSON(options)
-                : 'any',
-            description: this.description,
-            isArray: this.isArray,
-            examples: this.examples,
-        });
-    }
-}
-exports.Value.prototype = ValueClass.prototype;

package/cjs/document/constants.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.kTypeNSMap = exports.kCtorMap = exports.kDataTypeMap = exports.CLASS_NAME_PATTERN = exports.NAMESPACE_PATTERN = exports.BUILTIN = exports.DECORATOR = exports.ENCODER = exports.DECODER = exports.RPC_CONTROLLER_METADATA = exports.WS_PARAM_METADATA = exports.WS_CONTROLLER_METADATA = exports.MQ_CONTROLLER_METADATA = exports.HTTP_CONTROLLER_METADATA = exports.DATATYPE_METADATA = void 0;
-exports.DATATYPE_METADATA = Symbol.for('opra.type.metadata');
-exports.HTTP_CONTROLLER_METADATA = Symbol('opra.http-controller.metadata');
-exports.MQ_CONTROLLER_METADATA = Symbol('opra.mq-controller.metadata');
-exports.WS_CONTROLLER_METADATA = Symbol('opra.ws-controller.metadata');
-exports.WS_PARAM_METADATA = Symbol('opra.ws-param.metadata');
-exports.RPC_CONTROLLER_METADATA = Symbol('opra.rpc-controller.metadata');
-exports.DECODER = Symbol.for('opra.type.decoder');
-exports.ENCODER = Symbol('opra.type.encoder');
-exports.DECORATOR = Symbol.for('DECORATOR');
-exports.BUILTIN = Symbol.for('BUILTIN');
-exports.NAMESPACE_PATTERN = /([a-z$_]\w+):(.+)/i;
-exports.CLASS_NAME_PATTERN = /^[a-z][\w_]*$/i;
-exports.kDataTypeMap = Symbol.for('kDataTypeMap');
-exports.kCtorMap = Symbol.for('kCtorMap');
-exports.kTypeNSMap = Symbol.for('kTypeNSMap');