@opra/common 0.18.4 → 0.19.0

package/cjs/document/api-document.js

@@ -6,9 +6,9 @@ const index_js_2 = require("../helpers/index.js");
 const index_js_3 = require("../schema/index.js");
 const constants_js_1 = require("./constants.js");
 const complex_type_js_1 = require("./data-type/complex-type.js");
-const simple_type_js_1 = require("./data-type/simple-type.js");
 class ApiDocument {
     constructor() {
+        this._designCtorMap = new Map();
         this._typeCache = new index_js_2.ResponsiveMap();
         this._typesCacheByCtor = new Map();
         this.references = new index_js_2.ResponsiveMap();
@@ -18,59 +18,81 @@ class ApiDocument {
             version: '',
             title: ''
         };
+        const BigIntConstructor = Object.getPrototypeOf(BigInt(0)).constructor;
+        const BufferConstructor = Object.getPrototypeOf(Buffer.from([]));
+        this._designCtorMap.set(String, 'string');
+        this._designCtorMap.set(Number, 'number');
+        this._designCtorMap.set(Boolean, 'boolean');
+        this._designCtorMap.set(Object, 'any');
+        this._designCtorMap.set(Date, 'timestamp');
+        this._designCtorMap.set(BigIntConstructor, 'bigint');
+        this._designCtorMap.set(ArrayBuffer, 'base64');
+        this._designCtorMap.set(SharedArrayBuffer, 'base64');
+        this._designCtorMap.set(BufferConstructor, 'base64');
     }
-    getDataType(nameOrCtor, silent) {
+    /**
+     *
+     */
+    getDataType(arg0, silent) {
         let dataType;
-        if (nameOrCtor === Object)
-            nameOrCtor = 'any';
-        const nameOrCtorName = typeof nameOrCtor === 'function' ? nameOrCtor.name : nameOrCtor;
+        const name = typeof arg0 === 'function' ? arg0.name : arg0;
         // Try to get instance from cache
-        const t = typeof nameOrCtor === 'string'
-            ? this._typeCache.get(nameOrCtor)
-            : this._typesCacheByCtor.get(nameOrCtor);
+        const t = typeof arg0 === 'string'
+            ? this._typeCache.get(arg0)
+            : this._typesCacheByCtor.get(arg0);
         if (t)
             return t;
+        // If cached as null, it means "not found"
         if (t === null) {
             if (silent)
                 return;
-            throw new index_js_1.NotFoundError(`Data type "${nameOrCtorName}" does not exists`);
+            throw new Error(`Data type "${name}" does not exists`);
         }
-        if (typeof nameOrCtor === 'string') {
-            const m = constants_js_1.NAMESPACE_PATTERN.exec(nameOrCtor);
+        // Convert design ctor to type name (String -> 'string')
+        if (typeof arg0 === 'function') {
+            const x = this._designCtorMap.get(arg0);
+            if (x)
+                arg0 = x;
+        }
+        if (typeof arg0 === 'string') {
+            const m = constants_js_1.NAMESPACE_PATTERN.exec(arg0);
             if (!m)
-                throw new index_js_1.NotFoundError(`Invalid data type name "${nameOrCtorName}"`);
+                throw new TypeError(`Invalid data type name "${name}"`);
             // If given string has namespace pattern (ns:type_name)
             if (m[2]) {
                 const ref = this.references.get(m[1]);
                 if (!ref) {
                     if (silent)
                         return;
-                    throw new index_js_1.NotFoundError(`Reference "${m[1]}" not found`);
+                    throw new Error(`No referenced document found for given namespace "${m[1]}"`);
                 }
-                dataType = ref.getDataType(m[2]);
-                this._typeCache.set(nameOrCtor, dataType);
+                dataType = ref.getDataType(m[2], silent);
             }
             else {
-                const name = m[1];
                 // Get instance from own types
-                dataType = this.types.get(name);
+                dataType = this.types.get(arg0);
                 // if not found, search in references (from last to first)
                 if (!dataType) {
                     const references = Array.from(this.references.values()).reverse();
                     for (const ref of references) {
-                        dataType = ref.getDataType(name);
+                        dataType = ref.getDataType(name, true);
                         if (dataType)
                             break;
                     }
                 }
-                if (dataType)
-                    this._typeCache.set(dataType.name || name, dataType);
             }
+            if (dataType) {
+                this._typeCache.set(arg0, dataType);
+                return dataType;
+            }
+            if (!silent)
+                throw new index_js_1.NotFoundError(`Data type "${arg0}" does not exists`);
+            return;
         }
-        else if (typeof nameOrCtor === 'function') {
+        if (typeof arg0 === 'function') {
             const types = Array.from(this.types.values()).reverse();
             for (const dt of types) {
-                if ((dt instanceof complex_type_js_1.ComplexType || dt instanceof simple_type_js_1.SimpleType) && dt.own.ctor === nameOrCtor) {
+                if (dt instanceof complex_type_js_1.ComplexType && dt.isTypeOf(arg0)) {
                     dataType = dt;
                     break;
                 }
@@ -79,27 +101,22 @@ class ApiDocument {
             if (!dataType) {
                 const references = Array.from(this.references.values()).reverse();
                 for (const ref of references) {
-                    dataType = ref.getDataType(nameOrCtor, true);
+                    dataType = ref.getDataType(arg0, true);
                     if (dataType)
                         break;
                 }
             }
-        }
-        if (dataType) {
-            if ((dataType instanceof complex_type_js_1.ComplexType || dataType instanceof simple_type_js_1.SimpleType) &&
-                dataType.own?.ctor && dataType.own.ctor !== Object)
-                this._typesCacheByCtor.set(dataType.own.ctor, dataType);
-            return dataType;
-        }
-        else {
-            if (typeof nameOrCtor === 'string')
-                this._typeCache.set(nameOrCtor, null);
-            else
-                this._typesCacheByCtor.set(nameOrCtor, null);
-        }
-        if (silent)
+            if (dataType)
+                this._typesCacheByCtor.set(arg0, dataType);
+            if (dataType)
+                return dataType;
+            if (!silent)
+                throw new index_js_1.NotFoundError(`No data type mapping found for class "${name}"`);
             return;
-        throw new index_js_1.NotFoundError(`Data type "${nameOrCtorName}" does not exists`);
+        }
+        /* istanbul ignore next */
+        if (!silent)
+            throw new TypeError('Invalid argument');
     }
     getComplexType(nameOrCtor, silent) {
         if (nameOrCtor === Object)

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

@@ -19,14 +19,15 @@ exports.ApiField = function (...args) {
             metadata.kind = index_js_2.OpraSchema.ComplexType.Kind;
             metadata.fields = metadata.fields || {};
             const designType = Reflect.getMetadata('design:type', target, propertyKey);
-            const isArray = designType === Array;
             const elemMeta = metadata.fields[propertyKey] = {
                 ...options,
                 enum: undefined,
-                designType: isArray ? undefined : designType
+                designType
             };
-            if (designType === Array)
+            if (designType === Array) {
                 elemMeta.isArray = true;
+                delete elemMeta.designType;
+            }
             if (options?.enum) {
                 elemMeta.type = undefined;
                 if (Array.isArray(options.enum)) {
@@ -69,7 +70,7 @@ exports.ApiField = function (...args) {
 };
 const proto = {
     exportSchema() {
-        const out = {
+        return {
             type: this.type.name ? this.type.name : this.type.exportSchema(),
             description: this.description,
             isArray: this.isArray,
@@ -77,7 +78,6 @@ const proto = {
             fixed: this.fixed,
             required: this.required
         };
-        return out;
     }
 };
 Object.assign(exports.ApiField.prototype, proto);

package/cjs/document/data-type/builtin/any.type.js

@@ -3,12 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnyType = void 0;
 const tslib_1 = require("tslib");
 const simple_type_js_1 = require("../simple-type.js");
-let AnyType = class AnyType {
+let AnyType = exports.AnyType = class AnyType {
 };
-AnyType = tslib_1.__decorate([
+exports.AnyType = AnyType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
-        description: 'Any value',
-        ctor: Object
+        description: 'Represents any value'
     })
 ], AnyType);
-exports.AnyType = AnyType;

package/cjs/document/data-type/builtin/base64.type.js

@@ -2,37 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Base64Type = void 0;
 const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-const BASE64_PATTERN = /^(?:[A-Za-z0-9+/]{4})*(?:(?:[A-Za-z0-9+/][AQgw](:?==)?)|(?:[A-Za-z0-9+/]{2}[AEIMQUYcgkosw048]=?))?$/;
-let Base64Type = class Base64Type {
-    decode(v) {
-        if (v == null)
-            return v;
-        if (typeof v === 'string')
-            this.validate(v);
-        return Buffer.from(v, 'base64').buffer.slice(0);
-    }
-    encode(v) {
-        if (v == null)
-            return v;
-        if (Buffer.isBuffer(v))
-            return v.toString('base64');
-        return Buffer.from(v).toString('base64');
-    }
-    coerce(v) {
-        if (v instanceof ArrayBuffer)
-            return v;
-        return this.decode(v);
-    }
-    validate(v) {
-        if (!(typeof v === 'string' && BASE64_PATTERN.test(v)))
-            throw new TypeError(`Invalid base64 value "${String(v).substring(0, 10)}..."`);
-    }
+let Base64Type = exports.Base64Type = class Base64Type {
 };
-Base64Type = tslib_1.__decorate([
+exports.Base64Type = Base64Type = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A stream of bytes, base64 encoded',
-        ctor: ArrayBuffer
+        decoder: (0, valgen_1.isBase64)(),
+        encoder: (0, valgen_1.isBase64)(),
     })
 ], Base64Type);
-exports.Base64Type = Base64Type;

package/cjs/document/data-type/builtin/bigint.type.js

@@ -1,33 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BigIntType = void 0;
+exports.BigintType = void 0;
 const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-const BigIntConstructor = Object.getPrototypeOf(BigInt(0)).constructor;
-let BigIntType = class BigIntType {
-    decode(v) {
-        if (v == null)
-            return v;
-        return typeof v === 'bigint' ? v : BigInt(v);
-    }
-    encode(v) {
-        if (v == null)
-            return v;
-        return typeof v === 'bigint' ? String(v) : undefined;
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
-    validate(v) {
-        if (!((typeof v === 'number' && !isNaN(v)) || typeof v === 'bigint'))
-            throw new TypeError(`Invalid number value "${v}"`);
-    }
+let BigintType = exports.BigintType = class BigintType {
 };
-BigIntType = tslib_1.__decorate([
+exports.BigintType = BigintType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
-        name: 'bigint',
         description: 'BigInt number',
-        ctor: BigIntConstructor
+        decoder: (0, valgen_1.isBigint)(),
+        encoder: (0, valgen_1.pipe)((0, valgen_1.isBigint)(), (0, valgen_1.isString)())
     })
-], BigIntType);
-exports.BigIntType = BigIntType;
+], BigintType);

package/cjs/document/data-type/builtin/boolean.type.js

@@ -2,27 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BooleanType = void 0;
 const tslib_1 = require("tslib");
-const putil_varhelpers_1 = require("putil-varhelpers");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-let BooleanType = class BooleanType {
-    decode(v) {
-        if (v == null)
-            return v;
-        return (0, putil_varhelpers_1.toBoolean)(v);
-    }
-    encode(v) {
-        if (v == null)
-            return v;
-        return (0, putil_varhelpers_1.toBoolean)(v);
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
+let BooleanType = exports.BooleanType = class BooleanType {
 };
-BooleanType = tslib_1.__decorate([
+exports.BooleanType = BooleanType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Simple true/false value',
-        ctor: Boolean
+        decoder: (0, valgen_1.isBoolean)(),
+        encoder: (0, valgen_1.isBoolean)()
     })
 ], BooleanType);
-exports.BooleanType = BooleanType;

package/cjs/document/data-type/builtin/date.type.js

@@ -2,17 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DateType = void 0;
 const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-const timestamp_type_js_1 = require("./timestamp.type.js");
-let DateType = class DateType extends timestamp_type_js_1.TimestampType {
-    constructor() {
-        super(...arguments);
-        this.format = 'YYYY-MM-DD';
-    }
+let DateType = exports.DateType = class DateType {
 };
-DateType = tslib_1.__decorate([
+exports.DateType = DateType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
-        description: 'full-date notation as defined by RFC 3339, section 5.6, for example, 2021-04-18',
+        description: 'Date only string, for example, 2021-04-18',
+        decoder: (0, valgen_1.isDate)({
+            format: ['YYYY-MM-DD', 'YYYY',
+                'YYYY-MM-DDTHH:mm:ss',
+                'YYYY-MM-DDTHH:mm',
+                'YYYY-MM-DD HH:mm:ss',
+                'YYYY-MM-DD HH:mm'
+            ]
+        }),
+        encoder: (0, valgen_1.isDateString)({ format: 'YYYY-MM-DD' })
     })
 ], DateType);
-exports.DateType = DateType;

package/cjs/document/data-type/builtin/index.js

@@ -6,8 +6,10 @@ tslib_1.__exportStar(require("./base64.type.js"), exports);
 tslib_1.__exportStar(require("./bigint.type.js"), exports);
 tslib_1.__exportStar(require("./boolean.type.js"), exports);
 tslib_1.__exportStar(require("./date.type.js"), exports);
-tslib_1.__exportStar(require("./guid.type.js"), exports);
+tslib_1.__exportStar(require("./uuid.type.js"), exports);
 tslib_1.__exportStar(require("./integer.type.js"), exports);
 tslib_1.__exportStar(require("./number.type.js"), exports);
 tslib_1.__exportStar(require("./object.type.js"), exports);
 tslib_1.__exportStar(require("./string.type.js"), exports);
+tslib_1.__exportStar(require("./time.type.js"), exports);
+tslib_1.__exportStar(require("./timestamp.type.js"), exports);

package/cjs/document/data-type/builtin/integer.type.js

@@ -2,27 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntegerType = void 0;
 const tslib_1 = require("tslib");
-const putil_varhelpers_1 = require("putil-varhelpers");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-const number_type_js_1 = require("./number.type.js");
-let IntegerType = class IntegerType extends number_type_js_1.NumberType {
-    decode(v) {
-        if (v == null)
-            return v;
-        return (0, putil_varhelpers_1.toInt)(super.decode(v));
-    }
-    encode(v) {
-        if (v == null)
-            return v;
-        return (0, putil_varhelpers_1.toInt)(super.encode(v));
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
+let IntegerType = exports.IntegerType = class IntegerType {
 };
-IntegerType = tslib_1.__decorate([
+exports.IntegerType = IntegerType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'An integer number',
+        decoder: (0, valgen_1.isInteger)(),
+        encoder: (0, valgen_1.isInteger)()
     })
 ], IntegerType);
-exports.IntegerType = IntegerType;

package/cjs/document/data-type/builtin/number.type.js

@@ -2,32 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumberType = void 0;
 const tslib_1 = require("tslib");
-const putil_varhelpers_1 = require("putil-varhelpers");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-let NumberType = class NumberType {
-    decode(v) {
-        if (v == null)
-            return v;
-        const x = (0, putil_varhelpers_1.toNumber)(v);
-        if (x)
-            this.validate(x);
-        return x;
-    }
-    encode(v) {
-        return this.decode(v);
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
-    validate(v) {
-        if (typeof v !== 'number' || isNaN(v))
-            throw new TypeError(`Invalid number value "${v}"`);
-    }
+let NumberType = exports.NumberType = class NumberType {
 };
-NumberType = tslib_1.__decorate([
+exports.NumberType = NumberType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Both Integer as well as Floating-Point numbers',
-        ctor: Number
+        decoder: (0, valgen_1.isNumber)(),
+        encoder: (0, valgen_1.isNumber)()
     })
 ], NumberType);
-exports.NumberType = NumberType;

package/cjs/document/data-type/builtin/object.type.js

@@ -3,18 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectType = void 0;
 const tslib_1 = require("tslib");
 const complex_type_js_1 = require("../complex-type.js");
-let ObjectType = class ObjectType {
-    coerce(v) {
-        if (v == null)
-            return v;
-        return typeof v === 'object' ? v : {};
-    }
+let ObjectType = exports.ObjectType = class ObjectType {
 };
-ObjectType = tslib_1.__decorate([
+exports.ObjectType = ObjectType = tslib_1.__decorate([
     (0, complex_type_js_1.ComplexType)({
         name: 'object',
         description: 'A non modelled object',
-        additionalFields: true
+        additionalFields: true,
+        ctor: Object
     })
 ], ObjectType);
-exports.ObjectType = ObjectType;

package/cjs/document/data-type/builtin/string.type.js

@@ -2,23 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StringType = void 0;
 const tslib_1 = require("tslib");
-const putil_varhelpers_1 = require("putil-varhelpers");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-let StringType = class StringType {
-    decode(v) {
-        return (0, putil_varhelpers_1.toString)(v);
-    }
-    encode(v) {
-        return (0, putil_varhelpers_1.toString)(v);
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
+let StringType = exports.StringType = class StringType {
 };
-StringType = tslib_1.__decorate([
+exports.StringType = StringType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A sequence of characters',
-        ctor: String
+        decoder: (0, valgen_1.isString)(),
+        encoder: (0, valgen_1.isString)(),
     })
 ], StringType);
-exports.StringType = StringType;

package/cjs/document/data-type/builtin/time.type.js

@@ -2,31 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimeType = void 0;
 const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-const string_type_js_1 = require("./string.type.js");
-const TIME_PATTERN = /^([01][0-9]|2[0-3]):?([0-5][0-9]):?([0-5][0-9])?(?:\.(\d+))?$/;
-let TimeType = class TimeType extends string_type_js_1.StringType {
-    decode(v) {
-        if (v == null)
-            return v;
-        this.validate(v);
-        return v;
-    }
-    encode(v) {
-        return this.decode(v);
-    }
-    coerce(v) {
-        return this.decode(v);
-    }
-    validate(v) {
-        // noinspection SuspiciousTypeOfGuard
-        if (typeof v === 'string' && !TIME_PATTERN.test(v))
-            throw new TypeError(`Invalid Time value "${v}"`);
-    }
+let TimeType = exports.TimeType = class TimeType {
 };
-TimeType = tslib_1.__decorate([
+exports.TimeType = TimeType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
-        description: 'Time formatted string',
+        description: 'Time string in 24h format, for example, 18:23:00',
+        decoder: (0, valgen_1.isDateString)({
+            format: ['HH:mm:ss', 'HH:mm'],
+            onFail: () => '{{label}} is not a valid time'
+        }),
+        encoder: (0, valgen_1.isDateString)({ format: ['HH:mm:ss', 'HH:mm'],
+            onFail: () => '{{label}} is not a valid time'
+        })
     })
 ], TimeType);
-exports.TimeType = TimeType;

package/cjs/document/data-type/builtin/timestamp.type.js

@@ -2,28 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimestampType = void 0;
 const tslib_1 = require("tslib");
-const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const valgen_1 = require("valgen");
 const simple_type_js_1 = require("../simple-type.js");
-let TimestampType = class TimestampType {
-    constructor() {
-        this.format = 'YYYY-MM-DDTHH:mm:ss';
-    }
-    decode(v) {
-        return (0, dayjs_1.default)(v).toDate();
-    }
-    encode(v) {
-        if (!v)
-            return undefined;
-        const d = (0, dayjs_1.default)(v);
-        if (!d.isValid())
-            throw new TypeError(`Invalid date value ${v}`);
-        return (0, dayjs_1.default)(v).format(this.format);
-    }
+let TimestampType = exports.TimestampType = class TimestampType {
 };
-TimestampType = tslib_1.__decorate([
+exports.TimestampType = TimestampType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
-        description: 'date-time notation as defined by RFC 3339, section 5.6, for example, 2021-04-18T09:12:53',
-        ctor: Date
+        description: 'Timestamp, for example, 2021-04-18T09:12:53',
+        decoder: (0, valgen_1.isDate)({
+            format: ['YYYY-MM-DDTHH:mm:ss', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DD', 'YYYY']
+        }),
+        encoder: (0, valgen_1.isDateString)({ format: 'YYYY-MM-DDTHH:mm:ss' })
     })
 ], TimestampType);
-exports.TimestampType = TimestampType;

package/cjs/document/data-type/builtin/uuid.type.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UuidType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const simple_type_js_1 = require("../simple-type.js");
+let UuidType = exports.UuidType = class UuidType {
+};
+exports.UuidType = UuidType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'A Universal Unique Identifier (UUID) value',
+        decoder: (0, valgen_1.isUUID)(),
+        encoder: (0, valgen_1.isUUID)()
+    })
+], UuidType);