@opra/common 0.33.13 → 1.0.0-alpha.2

package/cjs/document/data-type/extended-types/date-time.type.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateTimeType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let DateTimeType = class DateTimeType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties) {
+        const fn = valgen_1.vg.isDate({ precision: 'time', coerce: true });
+        const x = [];
+        if (properties.minValue) {
+            (0, valgen_1.isDateString)(properties.minValue);
+            x.push(valgen_1.toString, valgen_1.vg.isGte(properties.minValue));
+        }
+        if (properties.maxValue) {
+            (0, valgen_1.isDateString)(properties.maxValue);
+            x.push(valgen_1.toString, valgen_1.vg.isLte(properties.maxValue));
+        }
+        return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
+    }
+    [constants_js_1.ENCODER](properties) {
+        const fn = valgen_1.vg.isDateString({ precision: 'time', trim: 'time', coerce: true });
+        const x = [];
+        if (properties.minValue) {
+            (0, valgen_1.isDateString)(properties.minValue);
+            x.push(valgen_1.vg.isGte(properties.minValue));
+        }
+        if (properties.maxValue) {
+            (0, valgen_1.isDateString)(properties.maxValue);
+            x.push(valgen_1.vg.isLte(properties.maxValue));
+        }
+        return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
+    }
+};
+exports.DateTimeType = DateTimeType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Minimum value',
+    })
+], DateTimeType.prototype, "minValue", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Maximum value',
+    })
+], DateTimeType.prototype, "maxValue", void 0);
+exports.DateTimeType = DateTimeType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'A full datetime value',
+    })
+        .Example('2021-04-18T22:30:15')
+        .Example('2021-04-18 22:30:15')
+        .Example('2021-04-18 22:30')
+], DateTimeType);

package/cjs/document/data-type/extended-types/date.type.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let DateType = class DateType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties) {
+        const fn = valgen_1.vg.isDate({ precision: 'date', coerce: true });
+        const x = [];
+        if (properties.minValue) {
+            (0, valgen_1.isDateString)(properties.minValue);
+            x.push(valgen_1.toString, valgen_1.vg.isGte(properties.minValue));
+        }
+        if (properties.maxValue) {
+            (0, valgen_1.isDateString)(properties.maxValue);
+            x.push(valgen_1.toString, valgen_1.vg.isLte(properties.maxValue));
+        }
+        return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
+    }
+    [constants_js_1.ENCODER](properties) {
+        const fn = valgen_1.vg.isDateString({ precision: 'date', trim: 'date', coerce: true });
+        const x = [];
+        if (properties.minValue) {
+            (0, valgen_1.isDateString)(properties.minValue);
+            x.push(valgen_1.vg.isGte(properties.minValue));
+        }
+        if (properties.maxValue) {
+            (0, valgen_1.isDateString)(properties.maxValue);
+            x.push(valgen_1.vg.isLte(properties.maxValue));
+        }
+        return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
+    }
+};
+exports.DateType = DateType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Minimum value',
+    })
+], DateType.prototype, "minValue", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Maximum value',
+    })
+], DateType.prototype, "maxValue", void 0);
+exports.DateType = DateType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'A date without time',
+    }).Example('2021-04-18', 'Full date value')
+], DateType);

package/cjs/document/data-type/extended-types/email.type.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let EmailType = class EmailType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties) {
+        return valgen_1.vg.isEmail({ ...properties, coerce: true });
+    }
+    [constants_js_1.ENCODER](properties) {
+        return valgen_1.vg.isEmail({ ...properties, coerce: true });
+    }
+};
+exports.EmailType = EmailType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to `true`, the validator will also match `Display Name <email-address>',
+        default: false,
+    })
+], EmailType.prototype, "allowDisplayName", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to `true`, the validator will reject strings without the format `Display Name <email-address>',
+        default: false,
+    })
+], EmailType.prototype, "requireDisplayName", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: "If set to `false`, the validator will not allow any non-English UTF8 character in email address's local part",
+        default: true,
+    })
+], EmailType.prototype, "utf8LocalPart", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to `true`, the validator will not check for the standard max length of an email',
+        default: false,
+    })
+], EmailType.prototype, "ignoreMaxLength", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to `true`, the validator will allow IP addresses in the host part',
+        default: false,
+    })
+], EmailType.prototype, "allowIpDomain", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to `true`, some additional validation will be enabled, ' +
+            'e.g. disallowing certain syntactically valid email addresses that are rejected by GMail.',
+        default: false,
+    })
+], EmailType.prototype, "domainSpecificValidation", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to an array of strings and the part of the email after the @ symbol ' +
+            ' one of the strings defined in it, the validation fails.',
+    })
+], EmailType.prototype, "hostBlacklist", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to an array of strings and the part of the email after the @ symbol ' +
+            ' matches none of the strings defined in it, the validation fails.',
+    })
+], EmailType.prototype, "hostWhitelist", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'If set to a string, then the validator will reject emails that include ' +
+            ' any of the characters in the string, in the name part.',
+    })
+], EmailType.prototype, "blacklistedChars", void 0);
+exports.EmailType = EmailType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'An email value',
+    }).Example('some.body@example.com')
+], EmailType);

package/cjs/document/data-type/extended-types/field-path.type.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldPathType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let FieldPathType = class FieldPathType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties, element) {
+        const dataType = properties.dataType
+            ? element.node.getComplexType(properties.dataType)
+            : element.node.getComplexType('object');
+        const allowSigns = properties.allowSigns;
+        const decodeFieldPath = (0, valgen_1.validator)('decodeFieldPath', function (input) {
+            return dataType.normalizeFieldPath(input, { allowSigns });
+        });
+        return valgen_1.vg.pipe([valgen_1.toString, decodeFieldPath]);
+    }
+    [constants_js_1.ENCODER](properties, element) {
+        return this[constants_js_1.DECODER](properties, element);
+    }
+    toJSON(properties, element) {
+        const dataType = properties.dataType
+            ? element.node.getComplexType(properties.dataType)
+            : element.node.getComplexType('object');
+        return {
+            dataType: dataType.name ? dataType.name : dataType.toJSON(),
+            allowSigns: properties.allowSigns,
+        };
+    }
+};
+exports.FieldPathType = FieldPathType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Data type which field belong to',
+    })
+], FieldPathType.prototype, "dataType", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Determines if signs (+,-) are allowed. ' +
+            'If set "first" signs are allowed only beginning of the field path' +
+            'If set "each" signs are allowed at each field in the path',
+    })
+], FieldPathType.prototype, "allowSigns", void 0);
+exports.FieldPathType = FieldPathType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'Field path',
+    })
+], FieldPathType);

package/cjs/document/data-type/extended-types/filter.type.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const filter_rules_js_1 = require("../../../filter/filter-rules.js");
+const index_js_1 = require("../../../filter/index.js");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let FilterType = class FilterType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties, element) {
+        const dataType = properties.dataType
+            ? element.node.getComplexType(properties.dataType)
+            : element.node.getComplexType('object');
+        const rules = properties.rules ? new filter_rules_js_1.FilterRules(properties.rules) : undefined;
+        return decodeFilter(dataType, rules);
+    }
+    [constants_js_1.ENCODER]() {
+        return encodeFilter;
+    }
+    toJSON(properties, element) {
+        const dataType = properties.dataType
+            ? element.node.getComplexType(properties.dataType)
+            : element.node.getComplexType('object');
+        return {
+            dataType: dataType.name ? dataType.name : dataType.toJSON(),
+            rules: properties.rules,
+        };
+    }
+};
+exports.FilterType = FilterType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Data type which filtering fields belong to',
+    })
+], FilterType.prototype, "dataType", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Stringified JSON object defines filtering rules',
+        format: 'string',
+    })
+], FilterType.prototype, "rules", void 0);
+exports.FilterType = FilterType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'A query filter',
+    })
+], FilterType);
+const decodeFilter = (dataType, rules) => {
+    return (0, valgen_1.validator)('decodeFilter', function (input, context, _this) {
+        if (typeof input === 'string') {
+            try {
+                const filter = index_js_1.OpraFilter.parse(input);
+                if (rules)
+                    return rules.normalizeFilter(filter, dataType);
+                return filter;
+            }
+            catch (e) {
+                context.fail(_this, `Not a valid filter expression. ${e.message}`, input, e.errors);
+                return;
+            }
+        }
+        context.fail(_this, `Nt a valid filter expression string`, input);
+    });
+};
+const encodeFilter = (0, valgen_1.validator)('encodeFilter', function (input, context, _this) {
+    if (input instanceof index_js_1.OpraFilter.Ast) {
+        return input.toString();
+    }
+    context.fail(_this, `Not a valid filter expression`, input);
+});

package/cjs/document/data-type/extended-types/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./base64.type.js"), exports);
+tslib_1.__exportStar(require("./date.type.js"), exports);
+tslib_1.__exportStar(require("./date-string.type.js"), exports);
+tslib_1.__exportStar(require("./date-time.type.js"), exports);
+tslib_1.__exportStar(require("./date-time-string.type.js"), exports);
+tslib_1.__exportStar(require("./email.type.js"), exports);
+tslib_1.__exportStar(require("./field-path.type.js"), exports);
+tslib_1.__exportStar(require("./filter.type.js"), exports);
+tslib_1.__exportStar(require("./object-id.type.js"), exports);
+tslib_1.__exportStar(require("./operation-result.type.js"), exports);
+tslib_1.__exportStar(require("./time.type.js"), exports);
+tslib_1.__exportStar(require("./url.type.js"), exports);
+tslib_1.__exportStar(require("./uuid.type.js"), exports);

package/cjs/document/data-type/{builtin → extended-types}/object-id.type.js

@@ -3,14 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectIdType = void 0;
 const tslib_1 = require("tslib");
 const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
 const simple_type_js_1 = require("../simple-type.js");
 let ObjectIdType = class ObjectIdType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER]() {
+        return valgen_1.vg.isObjectId({ coerce: true });
+    }
+    [constants_js_1.ENCODER]() {
+        return valgen_1.vg.isObjectId({ coerce: true });
+    }
 };
 exports.ObjectIdType = ObjectIdType;
 exports.ObjectIdType = ObjectIdType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A MongoDB ObjectID value',
-        decoder: valgen_1.isObjectId,
-        encoder: valgen_1.vg.pipe(valgen_1.isObjectId, valgen_1.isString)
     })
 ], ObjectIdType);

package/cjs/document/data-type/extended-types/operation-result.type.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationResult = void 0;
+const tslib_1 = require("tslib");
+const api_field_js_1 = require("../api-field.js");
+const complex_type_js_1 = require("../complex-type.js");
+let OperationResult = class OperationResult {
+    constructor(init) {
+        if (init)
+            Object.assign(this, init);
+    }
+};
+exports.OperationResult = OperationResult;
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)()
+], OperationResult.prototype, "affected", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)()
+], OperationResult.prototype, "totalMatches", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)()
+], OperationResult.prototype, "context", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)()
+], OperationResult.prototype, "type", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)()
+], OperationResult.prototype, "message", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)({ type: 'any' })
+], OperationResult.prototype, "payload", void 0);
+tslib_1.__decorate([
+    (0, api_field_js_1.ApiField)({ type: 'object' })
+], OperationResult.prototype, "errors", void 0);
+exports.OperationResult = OperationResult = tslib_1.__decorate([
+    (0, complex_type_js_1.ComplexType)({
+        description: 'Operation result',
+    })
+], OperationResult);
+(function (OperationResult) {
+    function forPayload(type) {
+        let OperationResult_ = class OperationResult_ extends OperationResult {
+            constructor(...args) {
+                super(...args);
+            }
+        };
+        tslib_1.__decorate([
+            (0, api_field_js_1.ApiField)({ type, required: true })
+        ], OperationResult_.prototype, "payload", void 0);
+        OperationResult_ = tslib_1.__decorate([
+            (0, complex_type_js_1.ComplexType)({ embedded: true })
+        ], OperationResult_);
+        return OperationResult_;
+    }
+    OperationResult.forPayload = forPayload;
+})(OperationResult || (exports.OperationResult = OperationResult = {}));

package/cjs/document/data-type/extended-types/time.type.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+const TIME_PATTERN = /^([0-1][0-9]|2[0-4]):([0-5][0-9])(?::([0-5][0-9]))?$/;
+let TimeType = class TimeType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties) {
+        const fn = valgen_1.vg.matches(TIME_PATTERN, {
+            formatName: 'time',
+            coerce: true,
+        });
+        const x = [];
+        if (properties.minValue)
+            x.push(valgen_1.vg.isGte(properties.minValue));
+        if (properties.maxValue)
+            x.push(valgen_1.vg.isLte(properties.maxValue));
+        return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
+    }
+    [constants_js_1.ENCODER](properties) {
+        return this[constants_js_1.DECODER](properties);
+    }
+};
+exports.TimeType = TimeType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Minimum value',
+    })
+], TimeType.prototype, "minValue", void 0);
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Maximum value',
+    })
+], TimeType.prototype, "maxValue", void 0);
+exports.TimeType = TimeType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'Time string in 24h format',
+    })
+        .Example('18:23:00', 'Full time value')
+        .Example('18:23:00', 'Time value without seconds')
+], TimeType);

package/cjs/document/data-type/{builtin → extended-types}/url.type.js

@@ -3,14 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlType = void 0;
 const tslib_1 = require("tslib");
 const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
 const simple_type_js_1 = require("../simple-type.js");
 let UrlType = class UrlType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER]() {
+        return valgen_1.vg.isURL({ coerce: true });
+    }
+    [constants_js_1.ENCODER]() {
+        return valgen_1.vg.isURL({ coerce: true });
+    }
 };
 exports.UrlType = UrlType;
 exports.UrlType = UrlType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A Uniform Resource Identifier Reference (RFC 3986 icon) value',
-        decoder: valgen_1.isURL,
-        encoder: valgen_1.isURL
-    })
+    }).Example('http://tempuri.org')
 ], UrlType);

package/cjs/document/data-type/extended-types/uuid.type.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UuidType = void 0;
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const constants_js_1 = require("../../constants.js");
+const simple_type_js_1 = require("../simple-type.js");
+let UuidType = class UuidType {
+    constructor(attributes) {
+        if (attributes)
+            Object.assign(this, attributes);
+    }
+    [constants_js_1.DECODER](properties) {
+        return valgen_1.vg.isUUID(properties?.version, { coerce: true });
+    }
+    [constants_js_1.ENCODER](properties) {
+        return valgen_1.vg.isUUID(properties?.version, { coerce: true });
+    }
+};
+exports.UuidType = UuidType;
+tslib_1.__decorate([
+    simple_type_js_1.SimpleType.Attribute({
+        description: 'Version of the UUID',
+    })
+], UuidType.prototype, "version", void 0);
+exports.UuidType = UuidType = tslib_1.__decorate([
+    (0, simple_type_js_1.SimpleType)({
+        description: 'A Universal Unique Identifier (UUID) value',
+    })
+], UuidType);