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

package/cjs/document/api-document.js

@@ -2,6 +2,8 @@
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiDocument = void 0;
+const tslib_1 = require("tslib");
+const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
 const index_js_1 = require("../helpers/index.js");
 const index_js_2 = require("../schema/index.js");
 const data_type_map_js_1 = require("./common/data-type-map.js");
@@ -80,6 +82,14 @@ class ApiDocument extends document_element_js_1.DocumentElement {
             out.api = this.api.toJSON();
         return out;
     }
+    invalidate() {
+        /** Generate id */
+        const x = this.export();
+        delete x.id;
+        this.id = node_crypto_1.default.createHash('md5').update(JSON.stringify(x)).digest('base64url');
+        /** Clear [kTypeNSMap] */
+        this[constants_js_1.kTypeNSMap] = new WeakMap();
+    }
     _findDataType(nameOrCtor, visitedRefs) {
         let result = this.types.get(nameOrCtor);
         if (result || !this.references.size)

package/cjs/document/common/document-element.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentElement = void 0;
+const tslib_1 = require("tslib");
+const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
 const ts_gems_1 = require("ts-gems");
 const document_node_js_1 = require("./document-node.js");
 /**
@@ -11,6 +13,7 @@ exports.DocumentElement = function (owner) {
     if (!this)
         throw new TypeError('"this" should be passed to call class constructor');
     const _this = (0, ts_gems_1.asMutable)(this);
+    _this.id = node_crypto_1.default.randomBytes(16).toString('base64url');
     Object.defineProperty(_this, 'node', {
         value: new document_node_js_1.DocumentNode(this, owner?.node),
         enumerable: false,

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

@@ -53,8 +53,6 @@ http_operation_js_1.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: index_js_2.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);
@@ -87,8 +85,6 @@ http_operation_js_1.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: index_js_2.MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
@@ -110,6 +106,7 @@ http_operation_js_1.HttpOperation.Entity.Delete = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -152,8 +149,6 @@ http_operation_js_1.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);
@@ -233,8 +228,6 @@ http_operation_js_1.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);
@@ -302,8 +295,6 @@ http_operation_js_1.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: index_js_2.MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
@@ -325,6 +316,7 @@ http_operation_js_1.HttpOperation.Entity.Get = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -360,10 +352,8 @@ http_operation_js_1.HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
             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(index_js_2.HttpStatusCode.OK, {
         description: 'Operation is successful. Returns OperationResult with "affected" field.',
         contentType: index_js_2.MimeTypes.opra_response_json,
@@ -443,8 +433,6 @@ http_operation_js_1.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: index_js_2.MimeTypes.opra_response_json,
     });
-    if (typeof args.type === 'function')
-        decorator.UseType(args.type);
     /**
      *
      */
@@ -466,6 +454,7 @@ http_operation_js_1.HttpOperation.Entity.Update = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };

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

@@ -118,6 +118,9 @@ function HttpOperationDecoratorFactory(decoratorChain, options) {
             responseMeta.contentType = responseMeta.contentType || index_js_1.MimeTypes.opra_response_json;
             responseMeta.contentEncoding = responseMeta.contentEncoding || 'utf-8';
         }
+        if (responseMeta.contentType === index_js_1.MimeTypes.opra_response_json) {
+            responseMeta.contentEncoding = responseMeta.contentEncoding || 'utf-8';
+        }
         decoratorChain.push((meta) => {
             meta.responses = meta.responses || [];
             meta.responses.push(responseMeta);

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

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiDocumentFactory = void 0;
-const tslib_1 = require("tslib");
-const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
-const ts_gems_1 = require("ts-gems");
 const index_js_1 = require("../../helpers/index.js");
 const index_js_2 = require("../../schema/index.js");
 const api_document_js_1 = require("../api-document.js");
@@ -68,9 +65,14 @@ class ApiDocumentFactory {
         else
             init = schemaOrUrl;
         // Add builtin data types if this document is the root
+        let builtinDocument;
         if (!document[constants_js_1.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 || index_js_2.OpraSchema.SpecVersion;
         document.url = init.url;
@@ -91,8 +93,12 @@ class ApiDocumentFactory {
                             return;
                         }
                         const refDoc = new api_document_js_1.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);
                     });
                 }
             });
@@ -113,8 +119,7 @@ class ApiDocumentFactory {
                     context.addError(`Unknown service protocol (${init.api.protocol})`);
             });
         }
-        const x = document.export();
-        (0, ts_gems_1.asMutable)(document).id = node_crypto_1.default.createHash('md5').update(JSON.stringify(x)).digest('base64url');
+        document.invalidate();
     }
     /**
      *

package/cjs/document/http/http-operation.js

@@ -31,6 +31,7 @@ exports.HttpOperation = function (...args) {
     _this.types = _this.node[constants_js_1.kDataTypeMap] = new data_type_map_js_1.DataTypeMap();
     _this.name = initArgs.name;
     _this.path = initArgs.path;
+    _this.mergePath = initArgs.mergePath;
     _this.method = initArgs.method || 'GET';
     _this.description = initArgs.description;
     _this.composition = initArgs.composition;
@@ -57,7 +58,15 @@ class HttpOperationClass extends document_element_js_1.DocumentElement {
     }
     getFullUrl() {
         const out = this.owner.getFullUrl();
-        return out ? (this.path ? node_path_1.default.posix.join(out, this.path) : out) : this.path || '/';
+        if (out) {
+            if (this.path) {
+                if (this.mergePath)
+                    return out + this.path;
+                return node_path_1.default.posix.join(out, this.path);
+            }
+            return out;
+        }
+        return this.path || '/';
     }
     toJSON() {
         const out = (0, index_js_1.omitUndefined)({
@@ -65,6 +74,7 @@ class HttpOperationClass extends document_element_js_1.DocumentElement {
             description: this.description,
             method: this.method,
             path: this.path,
+            mergePath: this.mergePath,
             composition: this.composition,
             requestBody: this.requestBody?.toJSON(),
         });

package/cjs/document/http/http-status-range.js

@@ -25,8 +25,11 @@ class HttpStatusRange {
             this.end = m[2] ? parseInt(m[2], 10) : this.start;
         }
     }
-    get distance() {
-        return this.end - this.start;
+    includes(statusCode) {
+        return statusCode >= this.start && statusCode <= this.end;
+    }
+    intersects(start, end) {
+        return end >= this.start && start <= this.end;
     }
     toString() {
         if (this.start === this.end)

package/esm/document/api-document.js

@@ -1,4 +1,5 @@
 var _a;
+import crypto from 'node:crypto';
 import { cloneObject, omitUndefined, ResponsiveMap } from '../helpers/index.js';
 import { OpraSchema } from '../schema/index.js';
 import { DataTypeMap } from './common/data-type-map.js';
@@ -77,6 +78,14 @@ export class ApiDocument extends DocumentElement {
             out.api = this.api.toJSON();
         return out;
     }
+    invalidate() {
+        /** Generate id */
+        const x = this.export();
+        delete x.id;
+        this.id = crypto.createHash('md5').update(JSON.stringify(x)).digest('base64url');
+        /** Clear [kTypeNSMap] */
+        this[kTypeNSMap] = new WeakMap();
+    }
     _findDataType(nameOrCtor, visitedRefs) {
         let result = this.types.get(nameOrCtor);
         if (result || !this.references.size)

package/esm/document/common/document-element.js

@@ -1,3 +1,4 @@
+import crypto from 'node:crypto';
 import { asMutable } from 'ts-gems';
 import { DocumentNode } from './document-node.js';
 /**
@@ -8,6 +9,7 @@ export const DocumentElement = function (owner) {
     if (!this)
         throw new TypeError('"this" should be passed to call class constructor');
     const _this = asMutable(this);
+    _this.id = crypto.randomBytes(16).toString('base64url');
     Object.defineProperty(_this, 'node', {
         value: new DocumentNode(this, owner?.node),
         enumerable: false,

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

@@ -51,8 +51,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);
@@ -85,8 +83,6 @@ 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);
     /**
      *
      */
@@ -108,6 +104,7 @@ HttpOperation.Entity.Delete = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -150,8 +147,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);
@@ -231,8 +226,6 @@ 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);
@@ -300,8 +293,6 @@ 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);
     /**
      *
      */
@@ -323,6 +314,7 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };
@@ -358,10 +350,8 @@ HttpOperation.Entity.UpdateMany = function (arg0, arg1) {
             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,
@@ -441,8 +431,6 @@ 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);
     /**
      *
      */
@@ -464,6 +452,7 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
         decoratorChain.push((meta) => {
             if (!meta.path?.includes(':' + name))
                 meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
         });
         return decorator;
     };

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

@@ -114,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';
@@ -64,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;
@@ -87,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);
                     });
                 }
             });
@@ -109,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();
     }
     /**
      *

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

@@ -27,6 +27,7 @@ export const HttpOperation = function (...args) {
     _this.types = _this.node[kDataTypeMap] = new DataTypeMap();
     _this.name = initArgs.name;
     _this.path = initArgs.path;
+    _this.mergePath = initArgs.mergePath;
     _this.method = initArgs.method || 'GET';
     _this.description = initArgs.description;
     _this.composition = initArgs.composition;
@@ -53,7 +54,15 @@ class HttpOperationClass extends DocumentElement {
     }
     getFullUrl() {
         const out = this.owner.getFullUrl();
-        return out ? (this.path ? nodePath.posix.join(out, this.path) : out) : this.path || '/';
+        if (out) {
+            if (this.path) {
+                if (this.mergePath)
+                    return out + this.path;
+                return nodePath.posix.join(out, this.path);
+            }
+            return out;
+        }
+        return this.path || '/';
     }
     toJSON() {
         const out = omitUndefined({
@@ -61,6 +70,7 @@ class HttpOperationClass extends DocumentElement {
             description: this.description,
             method: this.method,
             path: this.path,
+            mergePath: this.mergePath,
             composition: this.composition,
             requestBody: this.requestBody?.toJSON(),
         });

package/esm/document/http/http-status-range.js

@@ -22,8 +22,11 @@ export class HttpStatusRange {
             this.end = m[2] ? parseInt(m[2], 10) : this.start;
         }
     }
-    get distance() {
-        return this.end - this.start;
+    includes(statusCode) {
+        return statusCode >= this.start && statusCode <= this.end;
+    }
+    intersects(start, end) {
+        return end >= this.start && start <= this.end;
     }
     toString() {
         if (this.start === this.end)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.0.0-alpha.11",
+  "version": "1.0.0-alpha.13",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/api-document.d.ts

@@ -31,5 +31,6 @@ export declare class ApiDocument extends DocumentElement {
      * Export as Opra schema definition object
      */
     export(): OpraSchema.ApiDocument;
+    invalidate(): void;
     protected _findDataType(nameOrCtor: string | Type | Function | EnumType.EnumArray | EnumType.EnumObject, visitedRefs?: WeakMap<ApiDocument, boolean>): DataType | undefined;
 }

package/types/document/common/document-element.d.ts

@@ -17,6 +17,7 @@ export declare const DocumentElement: DocumentElementConstructor;
  * @class DocumentElement
  */
 declare abstract class DocumentElementClass {
+    readonly id: string;
     readonly owner?: DocumentElement;
     readonly node: DocumentNode;
 }

package/types/document/http/http-operation.d.ts

@@ -13,7 +13,7 @@ import type { HttpRequestBody } from './http-request-body.js';
  * @namespace HttpOperation
  */
 export declare namespace HttpOperation {
-    interface Metadata extends Pick<OpraSchema.HttpOperation, 'description' | 'path' | 'method' | 'composition' | 'compositionOptions'> {
+    interface Metadata extends Pick<OpraSchema.HttpOperation, 'description' | 'method' | 'path' | 'mergePath' | 'composition' | 'compositionOptions'> {
         types?: ThunkAsync<Type | EnumType.EnumObject | EnumType.EnumArray>[];
         parameters?: HttpParameter.Metadata[];
         responses?: HttpOperationResponse.Metadata[];
@@ -26,7 +26,7 @@ export declare namespace HttpOperation {
     interface InitArguments extends Combine<{
         name: string;
         types?: DataType[];
-    }, Pick<Metadata, 'description' | 'path' | 'method' | 'composition' | 'compositionOptions' | 'immediateFetch'>> {
+    }, Pick<Metadata, 'description' | 'method' | 'path' | 'mergePath' | 'composition' | 'compositionOptions' | 'immediateFetch'>> {
     }
 }
 /**
@@ -72,6 +72,7 @@ declare class HttpOperationClass extends DocumentElement {
     method: OpraSchema.HttpMethod;
     description?: string;
     path?: string;
+    mergePath?: boolean;
     types: DataTypeMap;
     parameters: HttpParameter[];
     responses: HttpOperationResponse[];

package/types/document/http/http-status-range.d.ts

@@ -8,7 +8,8 @@ export declare class HttpStatusRange {
     constructor(value: string);
     constructor(start: number, end?: number);
     constructor(init: Pick<HttpStatusRange, 'start' | 'end'>);
-    get distance(): number;
+    includes(statusCode: number): boolean;
+    intersects(start: number, end: number): boolean;
     toString(): string;
     toJSON(): OpraSchema.HttpStatusRange | number;
 }

package/types/schema/http/http-operation.interface.d.ts

@@ -11,6 +11,10 @@ export interface HttpOperation extends DataTypeContainer {
     method: HttpMethod;
     description?: string;
     path?: string;
+    /**
+     * Determines if the `path` will be joined or merged to parent path.
+     */
+    mergePath?: boolean;
     parameters?: HttpParameter[];
     responses?: HttpOperationResponse[];
     requestBody?: HttpRequestBody;