@opra/common 1.0.0-alpha.3 → 1.0.0-alpha.5

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

@@ -36,6 +36,8 @@ exports.ApiField = function (...args) {
     _this.exclusive = initArgs.exclusive;
     _this.translatable = initArgs.translatable;
     _this.deprecated = initArgs.deprecated;
+    _this.readonly = initArgs.readonly;
+    _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
 };
 /**
@@ -55,6 +57,8 @@ class ApiFieldClass extends document_element_js_1.DocumentElement {
             exclusive: this.exclusive,
             translatable: this.translatable,
             deprecated: this.deprecated,
+            readonly: this.readonly,
+            writeonly: this.writeonly,
             examples: this.examples,
         });
     }

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

@@ -146,6 +146,10 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         // Process fields
         let fieldName;
         for (const field of this.fields.values()) {
+            if ((context.ignoreReadonlyFields && field.readonly) || (context.ignoreWriteonlyFields && field.writeonly)) {
+                schema[field.name] = valgen_1.vg.isUndefined({ coerce: true });
+                continue;
+            }
             fieldName = field.name;
             let p;
             if (projection !== '*') {

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

@@ -60,6 +60,8 @@ exports.ComplexType = function (...args) {
  */
 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)

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

@@ -38,6 +38,8 @@ exports.EnumType = function (...args) {
  */
 class EnumTypeClass extends data_type_js_1.DataType {
     extendsFrom(baseType) {
+        if (!(baseType instanceof data_type_js_1.DataType))
+            baseType = this.node.getDataType(baseType);
         if (!(baseType instanceof exports.EnumType))
             return false;
         if (baseType === this)

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

@@ -21,6 +21,10 @@ exports.Base64Type = Base64Type;
 exports.Base64Type = Base64Type = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A stream of bytes, base64 encoded',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], Base64Type);

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

@@ -39,6 +39,10 @@ tslib_1.__decorate([
 exports.DateStringType = DateStringType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Date string value',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     })
         .Example('2021-04-18', 'Full date value')
         .Example('2021-04', 'Date value without day')

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

@@ -39,6 +39,10 @@ tslib_1.__decorate([
 exports.DateTimeStringType = DateTimeStringType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'DateTime string value',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     })
         .Example('2021-04-18T22:30:15+01:00', 'Full date-time value with timezone')
         .Example('2021-04-18T22:30:15', 'Full date-time value without timezone')

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

@@ -53,6 +53,10 @@ tslib_1.__decorate([
 exports.DateTimeType = DateTimeType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A full datetime value',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     })
         .Example('2021-04-18T22:30:15')
         .Example('2021-04-18 22:30:15')

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

@@ -53,6 +53,10 @@ tslib_1.__decorate([
 exports.DateType = DateType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A date without time',
+        nameMappings: {
+            js: 'Date',
+            json: 'string',
+        },
     }).Example('2021-04-18', 'Full date value'),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], DateType);

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

@@ -85,6 +85,10 @@ tslib_1.__decorate([
 exports.EmailType = EmailType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'An email value',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }).Example('some.body@example.com'),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], EmailType);

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

@@ -52,6 +52,10 @@ tslib_1.__decorate([
 exports.FieldPathType = FieldPathType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Field path',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], FieldPathType);

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

@@ -49,6 +49,10 @@ tslib_1.__decorate([
 exports.FilterType = FilterType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A query filter',
+        nameMappings: {
+            js: 'object',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], FilterType);

package/cjs/document/data-type/extended-types/object-id.type.js

@@ -21,6 +21,10 @@ exports.ObjectIdType = ObjectIdType;
 exports.ObjectIdType = ObjectIdType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A MongoDB ObjectID value',
+        nameMappings: {
+            js: 'object',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], ObjectIdType);

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

@@ -43,6 +43,10 @@ tslib_1.__decorate([
 exports.TimeType = TimeType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Time string in 24h format',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     })
         .Example('18:23:00', 'Full time value')
         .Example('18:23:00', 'Time value without seconds'),

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

@@ -21,6 +21,10 @@ 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',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }).Example('http://tempuri.org'),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], UrlType);

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

@@ -27,6 +27,10 @@ tslib_1.__decorate([
 exports.UuidType = UuidType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A Universal Unique Identifier (UUID) value',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], UuidType);

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

@@ -7,6 +7,7 @@ const index_js_1 = require("../../helpers/index.js");
 const index_js_2 = require("../../schema/index.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");
 const get_is_inherited_predicate_fn_js_1 = require("./utils/get-is-inherited-predicate-fn.js");
 /**
  * MappedType constructor
@@ -68,6 +69,8 @@ exports.MappedType = function (...args) {
  */
 class MappedTypeClass 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)

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

@@ -8,6 +8,7 @@ const index_js_2 = require("../../schema/index.js");
 const constants_js_1 = require("../constants.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");
 /**
  * @class MixinType
  */
@@ -43,6 +44,8 @@ exports.MixinType = function (...args) {
  */
 class MixinTypeClass 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)

package/cjs/document/data-type/primitive-types/bigint.type.js

@@ -26,6 +26,10 @@ exports.BigintType = BigintType;
 exports.BigintType = BigintType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'BigInt number',
+        nameMappings: {
+            js: 'bigint',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], BigintType);

package/cjs/document/data-type/primitive-types/boolean.type.js

@@ -21,6 +21,10 @@ exports.BooleanType = BooleanType;
 exports.BooleanType = BooleanType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Simple true/false value',
+        nameMappings: {
+            js: 'boolean',
+            json: 'boolean',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], BooleanType);

package/cjs/document/data-type/primitive-types/integer.type.js

@@ -26,6 +26,10 @@ exports.IntegerType = IntegerType;
 exports.IntegerType = IntegerType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'An integer number',
+        nameMappings: {
+            js: 'number',
+            json: 'number',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], IntegerType);

package/cjs/document/data-type/primitive-types/null.type.js

@@ -21,6 +21,10 @@ exports.NullType = NullType;
 exports.NullType = NullType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A Null value',
+        nameMappings: {
+            js: 'null',
+            json: 'null',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], NullType);

package/cjs/document/data-type/primitive-types/number.type.js

@@ -38,6 +38,10 @@ tslib_1.__decorate([
 exports.NumberType = NumberType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'Both Integer as well as Floating-Point numbers',
+        nameMappings: {
+            js: 'number',
+            json: 'number',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], NumberType);

package/cjs/document/data-type/primitive-types/string.type.js

@@ -58,6 +58,10 @@ tslib_1.__decorate([
 exports.StringType = StringType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
         description: 'A sequence of characters',
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
     }),
     tslib_1.__metadata("design:paramtypes", [Object])
 ], StringType);

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

@@ -28,6 +28,8 @@ exports.SimpleType = function (...args) {
         _this.base = initArgs.base;
     }
     _this.properties = initArgs.properties;
+    _this.ownNameMappings = { ...initArgs.nameMappings };
+    _this.nameMappings = { ..._this.base?.nameMappings, ...initArgs.nameMappings };
     _this.ownAttributes = (0, index_js_1.cloneObject)(initArgs.attributes || {});
     _this.attributes = _this.base ? (0, index_js_1.cloneObject)(_this.base.attributes) : {};
     if (_this.ownAttributes) {
@@ -46,6 +48,8 @@ exports.SimpleType = function (...args) {
  */
 class SimpleTypeClass extends data_type_js_1.DataType {
     extendsFrom(baseType) {
+        if (!(baseType instanceof data_type_js_1.DataType))
+            baseType = this.node.getDataType(baseType);
         if (!(baseType instanceof exports.SimpleType))
             return false;
         if (baseType === this)
@@ -90,12 +94,15 @@ class SimpleTypeClass extends data_type_js_1.DataType {
             return o;
         }, {});
         const baseName = this.base ? this.node.getDataTypeNameWithNs(this.base) : undefined;
-        return (0, index_js_1.omitUndefined)({
+        const out = (0, index_js_1.omitUndefined)({
             ...data_type_js_1.DataType.prototype.toJSON.apply(this),
             base: this.base ? (baseName ? baseName : this.base.toJSON()) : undefined,
             attributes: attributes && Object.keys(attributes).length ? attributes : undefined,
             properties: Object.keys(properties).length ? properties : undefined,
         });
+        if (Object.keys(this.ownNameMappings).length)
+            out.nameMappings = { ...this.ownNameMappings };
+        return out;
     }
 }
 exports.SimpleType.prototype = SimpleTypeClass.prototype;

package/cjs/document/decorators/http-controller.decorator.js

@@ -102,6 +102,31 @@ function HttpControllerDecoratorFactory(options) {
         });
         return decorator;
     };
+    /**
+     *
+     */
+    decorator.KeyParam = (name, arg1) => {
+        decoratorChain.push((meta) => {
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
+            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
+                ? {
+                    name,
+                    location: 'path',
+                    type: arg1,
+                    keyParam: true,
+                }
+                : {
+                    ...arg1,
+                    name,
+                    location: 'path',
+                    keyParam: true,
+                };
+            meta.parameters = meta.parameters || [];
+            meta.parameters.push(paramMeta);
+        });
+        return decorator;
+    };
     /**
      *
      */

package/cjs/document/decorators/http-operation-entity.decorator.js

@@ -23,8 +23,8 @@ http_operation_js_1.HttpOperation.Entity.Create = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'POST',
+        ...args,
         composition: 'Entity.Create',
         requestBody: {
             immediateFetch: true,
@@ -74,8 +74,8 @@ http_operation_js_1.HttpOperation.Entity.Delete = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'DELETE',
+        ...args,
         composition: 'Entity.Delete',
     }));
     decorator
@@ -93,11 +93,23 @@ http_operation_js_1.HttpOperation.Entity.Delete = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -123,8 +135,8 @@ http_operation_js_1.HttpOperation.Entity.DeleteMany = function (arg0, arg1) {
     const filterType = new index_js_3.FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'DELETE',
+        ...args,
         composition: 'Entity.DeleteMany',
     }));
     decorator
@@ -171,8 +183,8 @@ http_operation_js_1.HttpOperation.Entity.FindMany = function (arg0, arg1) {
     const filterType = new index_js_3.FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'GET',
+        ...args,
         composition: 'Entity.FindMany',
     }));
     decorator
@@ -263,8 +275,8 @@ http_operation_js_1.HttpOperation.Entity.Get = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'GET',
+        ...args,
         composition: 'Entity.Get',
     }));
     decorator
@@ -296,11 +308,23 @@ http_operation_js_1.HttpOperation.Entity.Get = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -326,8 +350,8 @@ http_operation_js_1.HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
     filterType.rules = {};
     const filterRules = new filter_rules_js_1.FilterRules();
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'PATCH',
+        ...args,
         composition: 'Entity.UpdateMany',
         requestBody: {
             immediateFetch: true,
@@ -381,8 +405,8 @@ http_operation_js_1.HttpOperation.Entity.Update = function (arg0, arg1) {
     const filterType = new index_js_3.FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, (0, index_js_1.omitUndefined)({
-        description: args.description,
         method: 'PATCH',
+        ...args,
         composition: 'Entity.Update',
         requestBody: {
             partial: 'deep',
@@ -425,11 +449,23 @@ http_operation_js_1.HttpOperation.Entity.Update = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };