@opra/common 1.0.0-alpha.1 → 1.0.0-alpha.11

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

@@ -4,6 +4,7 @@ import { omitUndefined } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import { ApiField } from './api-field.js';
 import { ComplexTypeBase } from './complex-type-base.js';
+import { DataType } from './data-type.js';
 import { getIsInheritedPredicateFn } from './utils/get-is-inherited-predicate-fn.js';
 /**
  * MappedType constructor
@@ -18,22 +19,25 @@ export const MappedType = function (...args) {
     _this.kind = OpraSchema.MappedType.Kind;
     if (initArgs.base) {
         // noinspection SuspiciousTypeOfGuard
-        if (!(initArgs.base instanceof ComplexTypeBase))
+        if (!(initArgs.base instanceof ComplexTypeBase)) {
             throw new TypeError(`"${initArgs.base.kind}" can't be set as base for a "${this.kind}"`);
+        }
         _this.base = initArgs.base;
         _this.ctor = initArgs.ctor || _this.base.ctor;
         if (initArgs.pick)
             _this.pick = initArgs.pick.map(f => _this.base.normalizeFieldPath(f));
         else if (initArgs.omit)
             _this.omit = initArgs.omit.map(f => _this.base.normalizeFieldPath(f));
-        else if (initArgs.partial)
+        else if (initArgs.partial) {
             _this.partial = Array.isArray(initArgs.partial)
                 ? initArgs.partial.map(f => _this.base.normalizeFieldPath(f))
                 : initArgs.partial;
-        else if (initArgs.required)
+        }
+        else if (initArgs.required) {
             _this.required = Array.isArray(initArgs.required)
                 ? initArgs.required.map(f => _this.base.normalizeFieldPath(f))
                 : initArgs.required;
+        }
         /** Copy fields from base */
         const isInheritedPredicate = getIsInheritedPredicateFn(_this.pick, _this.omit);
         const partial = Array.isArray(_this.partial) ? _this.partial.map(x => x.toLowerCase()) : _this.partial;
@@ -53,8 +57,9 @@ export const MappedType = function (...args) {
         }
         if (!_this.pick ||
             _this.base.additionalFields === false ||
-            (Array.isArray(_this.base.additionalFields) && _this.base.additionalFields?.[0] === 'error'))
+            (Array.isArray(_this.base.additionalFields) && _this.base.additionalFields?.[0] === 'error')) {
             _this.additionalFields = _this.base.additionalFields;
+        }
         if (initArgs.base.keyField && isInheritedPredicate(initArgs.base.keyField))
             _this.keyField = initArgs.base.keyField;
     }
@@ -65,6 +70,8 @@ export const MappedType = function (...args) {
  */
 class MappedTypeClass extends ComplexTypeBase {
     extendsFrom(baseType) {
+        if (!(baseType instanceof DataType))
+            baseType = this.node.getDataType(baseType);
         if (!(baseType instanceof ComplexTypeBase))
             return false;
         if (baseType === this)
@@ -85,4 +92,4 @@ class MappedTypeClass extends ComplexTypeBase {
     }
 }
 MappedType.prototype = MappedTypeClass.prototype;
-MappedType._applyMixin = () => void 0;
+MappedType._applyMixin = () => undefined;

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

@@ -5,6 +5,7 @@ import { OpraSchema } from '../../schema/index.js';
 import { DATATYPE_METADATA, DECORATOR } from '../constants.js';
 import { ApiField } from './api-field.js';
 import { ComplexTypeBase } from './complex-type-base.js';
+import { DataType } from './data-type.js';
 /**
  * @class MixinType
  */
@@ -40,6 +41,8 @@ export const MixinType = function (...args) {
  */
 class MixinTypeClass extends ComplexTypeBase {
     extendsFrom(baseType) {
+        if (!(baseType instanceof DataType))
+            baseType = this.node.getDataType(baseType);
         if (!(baseType instanceof ComplexTypeBase))
             return false;
         if (baseType === this)
@@ -94,8 +97,9 @@ function MixinTypeFactory(...args) {
         if (!(itemMeta &&
             (itemMeta.kind === OpraSchema.ComplexType.Kind ||
                 itemMeta.kind === OpraSchema.MixinType.Kind ||
-                itemMeta.kind === OpraSchema.MappedType.Kind)))
+                itemMeta.kind === OpraSchema.MappedType.Kind))) {
             throw new TypeError(`Class "${c.name}" is not a ${OpraSchema.ComplexType.Kind}, ${OpraSchema.MixinType.Kind} or ${OpraSchema.MappedType.Kind}`);
+        }
         metadata.types.push(c);
         mergePrototype(MixinClass.prototype, c.prototype);
     }

package/esm/document/data-type/primitive-types/any.type.js

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { isAny } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -17,6 +17,7 @@ let AnyType = class AnyType {
 AnyType = __decorate([
     SimpleType({
         description: 'Represents any value',
-    })
+    }),
+    __metadata("design:paramtypes", [Object])
 ], AnyType);
 export { AnyType };

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { toBigint, vg } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -22,6 +22,11 @@ let BigintType = class BigintType extends NumberType {
 BigintType = __decorate([
     SimpleType({
         description: 'BigInt number',
-    })
+        nameMappings: {
+            js: 'bigint',
+            json: 'string',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], BigintType);
 export { BigintType };

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { toBoolean } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -17,6 +17,11 @@ let BooleanType = class BooleanType {
 BooleanType = __decorate([
     SimpleType({
         description: 'Simple true/false value',
-    })
+        nameMappings: {
+            js: 'boolean',
+            json: 'boolean',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], BooleanType);
 export { BooleanType };

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { toInteger, vg } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -22,6 +22,11 @@ let IntegerType = class IntegerType extends NumberType {
 IntegerType = __decorate([
     SimpleType({
         description: 'An integer number',
-    })
+        nameMappings: {
+            js: 'number',
+            json: 'number',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], IntegerType);
 export { IntegerType };

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { isNull } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -17,6 +17,11 @@ let NullType = class NullType {
 NullType = __decorate([
     SimpleType({
         description: 'A Null value',
-    })
+        nameMappings: {
+            js: 'null',
+            json: 'null',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], NullType);
 export { NullType };

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { toNumber, vg } from 'valgen';
 import { DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -22,16 +22,23 @@ let NumberType = class NumberType {
 __decorate([
     SimpleType.Attribute({
         description: 'Determines the minimum value',
-    })
+    }),
+    __metadata("design:type", Number)
 ], NumberType.prototype, "minValue", void 0);
 __decorate([
     SimpleType.Attribute({
         description: 'Determines the maximum value',
-    })
+    }),
+    __metadata("design:type", Number)
 ], NumberType.prototype, "maxValue", void 0);
 NumberType = __decorate([
     SimpleType({
         description: 'Both Integer as well as Floating-Point numbers',
-    })
+        nameMappings: {
+            js: 'number',
+            json: 'number',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], NumberType);
 export { NumberType };

package/esm/document/data-type/primitive-types/object.type.js

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { DATATYPE_METADATA } from '../../constants.js';
 import { ComplexType } from '../complex-type.js';
 let ObjectType = class ObjectType {
@@ -12,7 +12,8 @@ ObjectType = __decorate([
         name: 'object',
         description: 'A non modelled object',
         additionalFields: true,
-    })
+    }),
+    __metadata("design:paramtypes", [Object])
 ], ObjectType);
 export { ObjectType };
 const metadata = Reflect.getMetadata(DATATYPE_METADATA, ObjectType);

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

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { toString, vg } from 'valgen';
 import { DATATYPE_METADATA, DECODER, ENCODER } from '../../constants.js';
 import { SimpleType } from '../simple-type.js';
@@ -30,26 +30,35 @@ let StringType = class StringType {
 __decorate([
     SimpleType.Attribute({
         description: 'Regex pattern to be used for validation',
-    })
+    }),
+    __metadata("design:type", Object)
 ], StringType.prototype, "pattern", void 0);
 __decorate([
     SimpleType.Attribute({
         description: 'Name of the pattern',
-    })
+    }),
+    __metadata("design:type", String)
 ], StringType.prototype, "patternName", void 0);
 __decorate([
     SimpleType.Attribute({
         description: 'Minimum number of characters',
-    })
+    }),
+    __metadata("design:type", Number)
 ], StringType.prototype, "minLength", void 0);
 __decorate([
     SimpleType.Attribute({
         description: 'Minimum number of characters',
-    })
+    }),
+    __metadata("design:type", Number)
 ], StringType.prototype, "maxLength", void 0);
 StringType = __decorate([
     SimpleType({
         description: 'A sequence of characters',
-    })
+        nameMappings: {
+            js: 'string',
+            json: 'string',
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
 ], StringType);
 export { StringType };

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

@@ -20,11 +20,14 @@ export const SimpleType = function (...args) {
     _this.kind = OpraSchema.SimpleType.Kind;
     if (initArgs.base) {
         // noinspection SuspiciousTypeOfGuard
-        if (!(initArgs.base instanceof SimpleType))
+        if (!(initArgs.base instanceof SimpleType)) {
             throw new TypeError(`"${initArgs.base.kind}" can't be set as base for a "${this.kind}"`);
+        }
         _this.base = initArgs.base;
     }
     _this.properties = initArgs.properties;
+    _this.ownNameMappings = { ...initArgs.nameMappings };
+    _this.nameMappings = { ..._this.base?.nameMappings, ...initArgs.nameMappings };
     _this.ownAttributes = cloneObject(initArgs.attributes || {});
     _this.attributes = _this.base ? cloneObject(_this.base.attributes) : {};
     if (_this.ownAttributes) {
@@ -43,6 +46,8 @@ export const SimpleType = function (...args) {
  */
 class SimpleTypeClass extends DataType {
     extendsFrom(baseType) {
+        if (!(baseType instanceof DataType))
+            baseType = this.node.getDataType(baseType);
         if (!(baseType instanceof SimpleType))
             return false;
         if (baseType === this)
@@ -63,15 +68,13 @@ class SimpleTypeClass extends DataType {
             }
             return isAny;
         }
-        else {
-            let t = this;
-            while (t) {
-                if (t._generateEncoder)
-                    return t._generateEncoder(prop, options?.documentElement || this.owner);
-                t = this.base;
-            }
-            return isAny;
+        let t = this;
+        while (t) {
+            if (t._generateEncoder)
+                return t._generateEncoder(prop, options?.documentElement || this.owner);
+            t = this.base;
         }
+        return isAny;
     }
     toJSON() {
         const attributes = omitUndefined(this.ownAttributes);
@@ -87,12 +90,15 @@ class SimpleTypeClass extends DataType {
             return o;
         }, {});
         const baseName = this.base ? this.node.getDataTypeNameWithNs(this.base) : undefined;
-        return omitUndefined({
+        const out = omitUndefined({
             ...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;
     }
 }
 SimpleType.prototype = SimpleTypeClass.prototype;

package/esm/document/data-type/utils/create-mapped-class.js

@@ -23,8 +23,9 @@ export function createMappedClass(source, config, options) {
             throw new TypeError(`Class "${source}" doesn't have datatype metadata information`);
         if (!(m.kind === OpraSchema.ComplexType.Kind ||
             m.kind === OpraSchema.MappedType.Kind ||
-            m.kind === OpraSchema.MixinType.Kind))
+            m.kind === OpraSchema.MixinType.Kind)) {
             throw new TypeError(`Class "${source}" is not a ${OpraSchema.ComplexType.Kind}`);
+        }
     }
     const metadata = {
         ...options,

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

@@ -98,6 +98,31 @@ export 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/esm/document/decorators/http-operation-entity.decorator.js

@@ -21,8 +21,8 @@ HttpOperation.Entity.Create = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'POST',
+        ...args,
         composition: 'Entity.Create',
         requestBody: {
             immediateFetch: true,
@@ -72,8 +72,8 @@ HttpOperation.Entity.Delete = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'DELETE',
+        ...args,
         composition: 'Entity.Delete',
     }));
     decorator
@@ -91,11 +91,23 @@ 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;
     };
@@ -121,8 +133,8 @@ HttpOperation.Entity.DeleteMany = function (arg0, arg1) {
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'DELETE',
+        ...args,
         composition: 'Entity.DeleteMany',
     }));
     decorator
@@ -169,8 +181,8 @@ HttpOperation.Entity.FindMany = function (arg0, arg1) {
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'GET',
+        ...args,
         composition: 'Entity.FindMany',
     }));
     decorator
@@ -261,8 +273,8 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'GET',
+        ...args,
         composition: 'Entity.Get',
     }));
     decorator
@@ -294,11 +306,23 @@ 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;
     };
@@ -324,8 +348,8 @@ HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
     filterType.rules = {};
     const filterRules = new FilterRules();
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'PATCH',
+        ...args,
         composition: 'Entity.UpdateMany',
         requestBody: {
             immediateFetch: true,
@@ -379,8 +403,8 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
     const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
         method: 'PATCH',
+        ...args,
         composition: 'Entity.Update',
         requestBody: {
             partial: 'deep',
@@ -423,11 +447,23 @@ 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;
     };

package/esm/document/decorators/http-operation.decorator.js

@@ -33,8 +33,9 @@ export function HttpOperationDecoratorFactory(decoratorChain, options) {
                     type: arg1,
                 }
                 : { ...arg1, name, location: 'cookie' };
-            if (meta.parameters)
+            if (meta.parameters) {
                 meta.parameters = meta.parameters.filter(p => !(p.location === 'cookie' && String(p.name) === String(name)));
+            }
             else
                 meta.parameters = [];
             meta.parameters.push(paramMeta);
@@ -53,8 +54,9 @@ export function HttpOperationDecoratorFactory(decoratorChain, options) {
                     type: arg1,
                 }
                 : { ...arg1, name, location: 'header' };
-            if (meta.parameters)
+            if (meta.parameters) {
                 meta.parameters = meta.parameters.filter(p => !(p.location === 'header' && String(p.name) === String(name)));
+            }
             else
                 meta.parameters = [];
             meta.parameters.push(paramMeta);
@@ -73,8 +75,9 @@ export function HttpOperationDecoratorFactory(decoratorChain, options) {
                     type: arg1,
                 }
                 : { ...arg1, name, location: 'query' };
-            if (meta.parameters)
+            if (meta.parameters) {
                 meta.parameters = meta.parameters.filter(p => !(p.location === 'query' && String(p.name) === String(name)));
+            }
             else
                 meta.parameters = [];
             meta.parameters.push(paramMeta);
@@ -93,8 +96,9 @@ export function HttpOperationDecoratorFactory(decoratorChain, options) {
                     type: arg1,
                 }
                 : { ...arg1, name, location: 'path' };
-            if (meta.parameters)
+            if (meta.parameters) {
                 meta.parameters = meta.parameters.filter(p => !(p.location === 'path' && String(p.name) === String(name)));
+            }
             else
                 meta.parameters = [];
             meta.parameters.push(paramMeta);

package/esm/document/factory/api-document.factory.js

@@ -1,3 +1,5 @@
+import crypto from 'node:crypto';
+import { asMutable } from 'ts-gems';
 import { resolveThunk } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import { ApiDocument } from '../api-document.js';
@@ -40,9 +42,7 @@ export class ApiDocumentFactory {
                 context.error.message = `(${l}) error${l > 1 ? 's' : ''} found in document schema.`;
                 if (context.showErrorDetails) {
                     context.error.message += context.error.details
-                        .map(d => {
-                        return `\n\n  - ${d.message}` + (d.path ? `\n    @${d.path}` : '');
-                    })
+                        .map(d => `\n\n  - ${d.message}` + (d.path ? `\n    @${d.path}` : ''))
                         .join('');
                 }
             }
@@ -109,6 +109,8 @@ export class ApiDocumentFactory {
                     context.addError(`Unknown service protocol (${init.api.protocol})`);
             });
         }
+        const x = document.export();
+        asMutable(document).id = crypto.createHash('md5').update(JSON.stringify(x)).digest('base64url');
     }
     /**
      *