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

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/api-field-decorator.js

@@ -1,4 +1,3 @@
-import { omitUndefined } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import { DATATYPE_METADATA } from '../constants.js';
 export function ApiFieldDecorator(options) {
@@ -17,6 +16,6 @@ export function ApiFieldDecorator(options) {
         }
         else
             elemMeta.type = elemMeta.type || designType;
-        Reflect.defineMetadata(DATATYPE_METADATA, omitUndefined(metadata), target.constructor);
+        Reflect.defineMetadata(DATATYPE_METADATA, metadata, target.constructor);
     };
 }

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

@@ -1,5 +1,4 @@
 import { FilterRules } from '../../filter/filter-rules.js';
-import { omitUndefined } from '../../helpers/index.js';
 import { HttpStatusCode, MimeTypes } from '../../http/index.js';
 import { DATATYPE_METADATA } from '../constants.js';
 import { FieldPathType, FilterType } from '../data-type/extended-types/index.js';
@@ -20,16 +19,16 @@ HttpOperation.Entity.Create = function (arg0, arg1) {
         args = { ...arg1, type: arg0 };
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'POST',
+        ...args,
         composition: 'Entity.Create',
         requestBody: {
             immediateFetch: true,
             ...args.requestBody,
             required: true,
         },
-    }));
+    });
     decorator
         .QueryParam('projection', {
         description: 'Determines fields projection',
@@ -51,8 +50,6 @@ HttpOperation.Entity.Create = function (arg0, arg1) {
         description: 'The request was well-formed but was unable to process operation due to one or many errors.',
         contentType: MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     decoratorChain.push((operationMeta) => {
         const compositionOptions = (operationMeta.compositionOptions = operationMeta.compositionOptions || {});
         compositionOptions.type = getDataTypeName(args.type);
@@ -71,11 +68,11 @@ HttpOperation.Entity.Delete = function (arg0, arg1) {
         args = { ...arg1, type: arg0 };
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'DELETE',
+        ...args,
         composition: 'Entity.Delete',
-    }));
+    });
     decorator
         .Response(HttpStatusCode.OK, {
         description: 'Operation is successful. Returns OperationResult with "affected" field.',
@@ -85,17 +82,28 @@ HttpOperation.Entity.Delete = function (arg0, arg1) {
         description: 'The request was well-formed but was unable to process operation due to one or many errors.',
         contentType: MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
     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;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -120,11 +128,11 @@ HttpOperation.Entity.DeleteMany = function (arg0, arg1) {
     const filterRules = new FilterRules();
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'DELETE',
+        ...args,
         composition: 'Entity.DeleteMany',
-    }));
+    });
     decorator
         .Response(HttpStatusCode.OK, {
         description: 'Operation is successful. Returns OperationResult with "affected" field.',
@@ -138,8 +146,6 @@ HttpOperation.Entity.DeleteMany = function (arg0, arg1) {
         type: filterType,
         description: 'Determines filter fields',
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     decoratorChain.push((operationMeta) => {
         const compositionOptions = (operationMeta.compositionOptions = operationMeta.compositionOptions || {});
         compositionOptions.type = getDataTypeName(args.type);
@@ -168,11 +174,11 @@ HttpOperation.Entity.FindMany = function (arg0, arg1) {
     const filterRules = new FilterRules();
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'GET',
+        ...args,
         composition: 'Entity.FindMany',
-    }));
+    });
     decorator
         .Response(HttpStatusCode.OK, {
         description: 'Operation is successful. Returns OperationResult with "payload" field that contains list of resources.',
@@ -187,7 +193,7 @@ HttpOperation.Entity.FindMany = function (arg0, arg1) {
     })
         .QueryParam('limit', {
         description: 'Determines number of returning instances',
-        type: new IntegerType({ minValue: 1 }),
+        type: new IntegerType({ minValue: 1, maxValue: args.maxLimit }),
     })
         .QueryParam('skip', {
         description: 'Determines number of returning instances',
@@ -219,11 +225,15 @@ HttpOperation.Entity.FindMany = function (arg0, arg1) {
         isArray: true,
         arraySeparator: ',',
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     decoratorChain.push((operationMeta) => {
         const compositionOptions = (operationMeta.compositionOptions = operationMeta.compositionOptions || {});
         compositionOptions.type = getDataTypeName(args.type);
+        if (args.defaultLimit)
+            compositionOptions.defaultLimit = args.defaultLimit;
+        if (args.defaultProjection)
+            compositionOptions.defaultProjection = args.defaultProjection;
+        if (args.maxLimit)
+            compositionOptions.maxLimit = args.maxLimit;
     });
     decorator.DefaultSort = (...fields) => {
         decoratorChain.push((operationMeta) => {
@@ -260,11 +270,11 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
         args = { ...arg1, type: arg0 };
     /** Initialize the decorator and the chain */
     const decoratorChain = [];
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'GET',
+        ...args,
         composition: 'Entity.Get',
-    }));
+    });
     decorator
         .QueryParam('projection', {
         description: 'Determines fields projection',
@@ -288,17 +298,28 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
         description: 'The request was well-formed but was unable to process operation due to one or many errors.',
         contentType: MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
     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;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -323,9 +344,9 @@ HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
     const filterRules = new FilterRules();
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'PATCH',
+        ...args,
         composition: 'Entity.UpdateMany',
         requestBody: {
             immediateFetch: true,
@@ -333,11 +354,9 @@ HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
             ...args.requestBody,
             required: true,
         },
-    }));
-    decorator.RequestContent(args.requestBody?.type || args.type);
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
+    });
     decorator
+        .RequestContent(args.requestBody?.type || args.type)
         .Response(HttpStatusCode.OK, {
         description: 'Operation is successful. Returns OperationResult with "affected" field.',
         contentType: MimeTypes.opra_response_json,
@@ -378,9 +397,9 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
     const filterRules = new FilterRules();
     const filterType = new FilterType({ dataType: args.type });
     filterType.rules = {};
-    const decorator = HttpOperationDecoratorFactory(decoratorChain, omitUndefined({
-        description: args.description,
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
         method: 'PATCH',
+        ...args,
         composition: 'Entity.Update',
         requestBody: {
             partial: 'deep',
@@ -388,7 +407,7 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
             ...args.requestBody,
             required: true,
         },
-    }));
+    });
     decorator
         .QueryParam('projection', {
         description: 'Determines fields projection',
@@ -417,17 +436,28 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
         description: 'The request was well-formed but was unable to process operation due to one or many errors.',
         contentType: MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
     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;
+            meta.mergePath = true;
         });
         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);
@@ -110,6 +114,9 @@ export function HttpOperationDecoratorFactory(decoratorChain, options) {
             responseMeta.contentType = responseMeta.contentType || MimeTypes.opra_response_json;
             responseMeta.contentEncoding = responseMeta.contentEncoding || 'utf-8';
         }
+        if (responseMeta.contentType === MimeTypes.opra_response_json) {
+            responseMeta.contentEncoding = responseMeta.contentEncoding || 'utf-8';
+        }
         decoratorChain.push((meta) => {
             meta.responses = meta.responses || [];
             meta.responses.push(responseMeta);

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

@@ -1,5 +1,3 @@
-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';
@@ -42,9 +40,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('');
                 }
             }
@@ -66,9 +62,14 @@ export class ApiDocumentFactory {
         else
             init = schemaOrUrl;
         // Add builtin data types if this document is the root
+        let builtinDocument;
         if (!document[BUILTIN]) {
-            const builtinDocument = await this.createBuiltinDocument(context);
-            document.references.set('opra', builtinDocument);
+            const t = document.node.findDataType('string');
+            builtinDocument = t?.node.getDocument();
+            if (!builtinDocument) {
+                builtinDocument = await this.createBuiltinDocument(context);
+                document.references.set('opra', builtinDocument);
+            }
         }
         init.spec = init.spec || OpraSchema.SpecVersion;
         document.url = init.url;
@@ -89,8 +90,12 @@ export class ApiDocumentFactory {
                             return;
                         }
                         const refDoc = new ApiDocument();
+                        if (builtinDocument)
+                            refDoc.references.set('opra', builtinDocument);
                         await this.initDocument(refDoc, context, r);
-                        document.references.set(ns, refDoc);
+                        /** If same document already exists in document tree, we use it except the new one */
+                        const preDoc = document.findDocument(refDoc.id);
+                        document.references.set(ns, preDoc || refDoc);
                     });
                 }
             });
@@ -111,8 +116,7 @@ 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');
+        document.invalidate();
     }
     /**
      *