@speclynx/apidom-reference 4.13.0 → 4.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "keywords": [
     "apidom",
@@ -289,32 +289,32 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^8.0.0",
-    "@speclynx/apidom-core": "4.13.0",
-    "@speclynx/apidom-datamodel": "4.13.0",
-    "@speclynx/apidom-error": "4.13.0",
-    "@speclynx/apidom-json-pointer": "4.13.0",
-    "@speclynx/apidom-ns-arazzo-1": "4.13.0",
-    "@speclynx/apidom-ns-asyncapi-2": "4.13.0",
-    "@speclynx/apidom-ns-json-schema-2020-12": "4.13.0",
-    "@speclynx/apidom-ns-openapi-2": "4.13.0",
-    "@speclynx/apidom-ns-openapi-3-0": "4.13.0",
-    "@speclynx/apidom-ns-openapi-3-1": "4.13.0",
-    "@speclynx/apidom-ns-overlay-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.13.0",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.13.0",
-    "@speclynx/apidom-parser-adapter-json": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.13.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.13.0",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.13.0",
-    "@speclynx/apidom-traverse": "4.13.0",
+    "@speclynx/apidom-core": "4.14.0",
+    "@speclynx/apidom-datamodel": "4.14.0",
+    "@speclynx/apidom-error": "4.14.0",
+    "@speclynx/apidom-json-pointer": "4.14.0",
+    "@speclynx/apidom-ns-arazzo-1": "4.14.0",
+    "@speclynx/apidom-ns-asyncapi-2": "4.14.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "4.14.0",
+    "@speclynx/apidom-ns-openapi-2": "4.14.0",
+    "@speclynx/apidom-ns-openapi-3-0": "4.14.0",
+    "@speclynx/apidom-ns-openapi-3-1": "4.14.0",
+    "@speclynx/apidom-ns-overlay-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-json": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.14.0",
+    "@speclynx/apidom-traverse": "4.14.0",
     "@swaggerexpert/arazzo-runtime-expression": "^2.0.3",
     "axios": "^1.18.0",
     "picomatch": "^4.0.4",
@@ -336,5 +336,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "178b5324324332132479271fb9ac747a7ddbfccc"
+  "gitHead": "ae231056cc8865f2467fa97ca456975301bbe265"
 }

package/src/bundle/strategies/openapi-2/visitor.cjs

@@ -177,11 +177,11 @@ class OpenAPI2BundleVisitor {
   }
 
   /**
-   * Normalizes a self-file reference (e.g. `./root.json#/definitions/Pet`)
+   * Normalizes a self-reference (e.g. `./root.json#/definitions/Pet`)
    * to a bare fragment (`#/definitions/Pet`) so the bundled document stays
    * transferable. Bare fragments are returned unchanged.
    */
-  normalizeSelfFileRef(ref) {
+  normalizeSelfReference(ref) {
     return ref.startsWith('#') ? ref : url.getHash(ref);
   }
 
@@ -262,16 +262,8 @@ class OpenAPI2BundleVisitor {
    */
   basenameOf(jsonPointer, baseURI) {
     const tokens = (0, _apidomJsonPointer.parse)(jsonPointer).tree;
-    let candidate = tokens.length > 0 ? tokens[tokens.length - 1] : '';
-    if (candidate === '') {
-      const lastSlash = baseURI.lastIndexOf('/');
-      const lastDot = baseURI.lastIndexOf('.');
-      const fileName = baseURI.slice(lastSlash + 1);
-      // strip the extension only when the last dot belongs to the file name
-      candidate = lastDot > lastSlash ? baseURI.slice(lastSlash + 1, lastDot) : fileName;
-    }
-    if (candidate === '') candidate = 'Schema';
-    return candidate;
+    const lastToken = tokens.length > 0 ? tokens[tokens.length - 1] : '';
+    return lastToken || url.getBasename(baseURI) || 'Schema';
   }
 
   /**
@@ -326,9 +318,9 @@ class OpenAPI2BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      referencingElement.set('$ref', this.normalizeSelfFileRef($ref));
+      referencingElement.set('$ref', this.normalizeSelfReference($ref));
       path.skip();
       return;
     }
@@ -485,9 +477,9 @@ class OpenAPI2BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      pathItemElement.set('$ref', this.normalizeSelfFileRef($ref));
+      pathItemElement.set('$ref', this.normalizeSelfReference($ref));
       return;
     }
 

package/src/bundle/strategies/openapi-2/visitor.mjs

@@ -169,11 +169,11 @@ class OpenAPI2BundleVisitor {
   }
 
   /**
-   * Normalizes a self-file reference (e.g. `./root.json#/definitions/Pet`)
+   * Normalizes a self-reference (e.g. `./root.json#/definitions/Pet`)
    * to a bare fragment (`#/definitions/Pet`) so the bundled document stays
    * transferable. Bare fragments are returned unchanged.
    */
-  normalizeSelfFileRef(ref) {
+  normalizeSelfReference(ref) {
     return ref.startsWith('#') ? ref : url.getHash(ref);
   }
 
@@ -254,16 +254,8 @@ class OpenAPI2BundleVisitor {
    */
   basenameOf(jsonPointer, baseURI) {
     const tokens = parseJSONPointer(jsonPointer).tree;
-    let candidate = tokens.length > 0 ? tokens[tokens.length - 1] : '';
-    if (candidate === '') {
-      const lastSlash = baseURI.lastIndexOf('/');
-      const lastDot = baseURI.lastIndexOf('.');
-      const fileName = baseURI.slice(lastSlash + 1);
-      // strip the extension only when the last dot belongs to the file name
-      candidate = lastDot > lastSlash ? baseURI.slice(lastSlash + 1, lastDot) : fileName;
-    }
-    if (candidate === '') candidate = 'Schema';
-    return candidate;
+    const lastToken = tokens.length > 0 ? tokens[tokens.length - 1] : '';
+    return lastToken || url.getBasename(baseURI) || 'Schema';
   }
 
   /**
@@ -318,9 +310,9 @@ class OpenAPI2BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      referencingElement.set('$ref', this.normalizeSelfFileRef($ref));
+      referencingElement.set('$ref', this.normalizeSelfReference($ref));
       path.skip();
       return;
     }
@@ -477,9 +469,9 @@ class OpenAPI2BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      pathItemElement.set('$ref', this.normalizeSelfFileRef($ref));
+      pathItemElement.set('$ref', this.normalizeSelfReference($ref));
       return;
     }
 

package/src/bundle/strategies/openapi-3-0/visitor.cjs

@@ -188,11 +188,11 @@ class OpenAPI3_0BundleVisitor {
   }
 
   /**
-   * Normalizes a self-file reference (e.g. `./root.json#/components/schemas/Pet`)
+   * Normalizes a self-reference (e.g. `./root.json#/components/schemas/Pet`)
    * to a bare fragment (`#/components/schemas/Pet`) so the bundled document stays
    * transferable. Bare fragments are returned unchanged.
    */
-  normalizeSelfFileRef(ref) {
+  normalizeSelfReference(ref) {
     return ref.startsWith('#') ? ref : url.getHash(ref);
   }
 
@@ -278,16 +278,8 @@ class OpenAPI3_0BundleVisitor {
    */
   basenameOf(jsonPointer, baseURI) {
     const tokens = (0, _apidomJsonPointer.parse)(jsonPointer).tree;
-    let candidate = tokens.length > 0 ? tokens[tokens.length - 1] : '';
-    if (candidate === '') {
-      const lastSlash = baseURI.lastIndexOf('/');
-      const lastDot = baseURI.lastIndexOf('.');
-      const fileName = baseURI.slice(lastSlash + 1);
-      // strip the extension only when the last dot belongs to the file name
-      candidate = lastDot > lastSlash ? baseURI.slice(lastSlash + 1, lastDot) : fileName;
-    }
-    if (candidate === '') candidate = 'Schema';
-    return candidate;
+    const lastToken = tokens.length > 0 ? tokens[tokens.length - 1] : '';
+    return lastToken || url.getBasename(baseURI) || 'Schema';
   }
 
   /**
@@ -337,9 +329,9 @@ class OpenAPI3_0BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      referencingElement.set('$ref', this.normalizeSelfFileRef($ref));
+      referencingElement.set('$ref', this.normalizeSelfReference($ref));
       path.skip();
       return;
     }
@@ -481,9 +473,9 @@ class OpenAPI3_0BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      pathItemElement.set('$ref', this.normalizeSelfFileRef($ref));
+      pathItemElement.set('$ref', this.normalizeSelfReference($ref));
       return;
     }
 
@@ -628,9 +620,9 @@ class OpenAPI3_0BundleVisitor {
     const retrievalURI = this.toBaseURI(operationRef);
     const isInternalReference = this.entryURI === retrievalURI;
     if (isInternalReference) {
-      // normalize self-file operationRef to a bare fragment so the bundled
+      // normalize a self-reference operationRef to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      linkElement.set('operationRef', this.normalizeSelfFileRef(operationRef));
+      linkElement.set('operationRef', this.normalizeSelfReference(operationRef));
       return;
     }
 

package/src/bundle/strategies/openapi-3-0/visitor.mjs

@@ -180,11 +180,11 @@ class OpenAPI3_0BundleVisitor {
   }
 
   /**
-   * Normalizes a self-file reference (e.g. `./root.json#/components/schemas/Pet`)
+   * Normalizes a self-reference (e.g. `./root.json#/components/schemas/Pet`)
    * to a bare fragment (`#/components/schemas/Pet`) so the bundled document stays
    * transferable. Bare fragments are returned unchanged.
    */
-  normalizeSelfFileRef(ref) {
+  normalizeSelfReference(ref) {
     return ref.startsWith('#') ? ref : url.getHash(ref);
   }
 
@@ -270,16 +270,8 @@ class OpenAPI3_0BundleVisitor {
    */
   basenameOf(jsonPointer, baseURI) {
     const tokens = parseJSONPointer(jsonPointer).tree;
-    let candidate = tokens.length > 0 ? tokens[tokens.length - 1] : '';
-    if (candidate === '') {
-      const lastSlash = baseURI.lastIndexOf('/');
-      const lastDot = baseURI.lastIndexOf('.');
-      const fileName = baseURI.slice(lastSlash + 1);
-      // strip the extension only when the last dot belongs to the file name
-      candidate = lastDot > lastSlash ? baseURI.slice(lastSlash + 1, lastDot) : fileName;
-    }
-    if (candidate === '') candidate = 'Schema';
-    return candidate;
+    const lastToken = tokens.length > 0 ? tokens[tokens.length - 1] : '';
+    return lastToken || url.getBasename(baseURI) || 'Schema';
   }
 
   /**
@@ -329,9 +321,9 @@ class OpenAPI3_0BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      referencingElement.set('$ref', this.normalizeSelfFileRef($ref));
+      referencingElement.set('$ref', this.normalizeSelfReference($ref));
       path.skip();
       return;
     }
@@ -473,9 +465,9 @@ class OpenAPI3_0BundleVisitor {
     const isInternalReference = this.entryURI === retrievalURI;
     const isExternalReference = !isInternalReference;
     if (isInternalReference) {
-      // normalize self-file references to a bare fragment so the bundled
+      // normalize self-references to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      pathItemElement.set('$ref', this.normalizeSelfFileRef($ref));
+      pathItemElement.set('$ref', this.normalizeSelfReference($ref));
       return;
     }
 
@@ -620,9 +612,9 @@ class OpenAPI3_0BundleVisitor {
     const retrievalURI = this.toBaseURI(operationRef);
     const isInternalReference = this.entryURI === retrievalURI;
     if (isInternalReference) {
-      // normalize self-file operationRef to a bare fragment so the bundled
+      // normalize a self-reference operationRef to a bare fragment so the bundled
       // document stays transferable; bare fragments are left untouched
-      linkElement.set('operationRef', this.normalizeSelfFileRef(operationRef));
+      linkElement.set('operationRef', this.normalizeSelfReference(operationRef));
       return;
     }
 

package/src/bundle/strategies/openapi-3-1/index.cjs

@@ -4,9 +4,20 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "OpenAPI3_1BundleVisitor", {
+  enumerable: true,
+  get: function () {
+    return _visitor.default;
+  }
+});
 exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-1");
+var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
+var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
+var _visitor = _interopRequireDefault(require("./visitor.cjs"));
 /**
  * @public
  */
@@ -30,8 +41,54 @@ class OpenAPI3_1BundleStrategy extends _BundleStrategy.default {
     // assert by inspecting ApiDOM
     return (0, _apidomNsOpenapi.isOpenApi3_1Element)(file.parseResult?.result);
   }
-  async bundle(file) {
-    return file.parseResult;
+  async bundle(file, options) {
+    const immutableRefSet = options.bundle.refSet ?? new _ReferenceSet.default();
+    const mutableRefSet = new _ReferenceSet.default();
+    let refSet = immutableRefSet;
+    let reference;
+
+    // determine the initial reference
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new _Reference.default({
+        uri: file.uri,
+        value: file.parseResult
+      });
+      immutableRefSet.add(reference);
+    } else {
+      // pre-computed refSet was provided as configuration option
+      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+    }
+
+    /**
+     * Clone refSet due the bundling process being mutable.
+     * We don't want to mutate the original refSet and the references.
+     */
+    if (options.bundle.immutable) {
+      immutableRefSet.refs.map(ref => new _Reference.default({
+        ...ref,
+        value: (0, _apidomDatamodel.cloneDeep)(ref.value)
+      })).forEach(ref => mutableRefSet.add(ref));
+      reference = mutableRefSet.find(ref => ref.uri === file.uri);
+      refSet = mutableRefSet;
+    }
+    const visitor = new _visitor.default({
+      reference: reference,
+      options
+    });
+    await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
+      mutable: true
+    });
+    const parseResult = reference.value;
+
+    /**
+     * Release all memory if this refSet was not provided as a configuration option.
+     * If provided as configuration option, then provider is responsible for cleanup.
+     */
+    if (options.bundle.refSet === null) {
+      immutableRefSet.clean();
+    }
+    mutableRefSet.clean();
+    return parseResult;
   }
 }
 var _default = exports.default = OpenAPI3_1BundleStrategy;

package/src/bundle/strategies/openapi-3-1/index.mjs

@@ -1,5 +1,10 @@
+import { cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isOpenApi3_1Element } from '@speclynx/apidom-ns-openapi-3-1';
+import Reference from "../../../Reference.mjs";
+import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
+import OpenAPI3_1BundleVisitor from "./visitor.mjs";
 /**
  * @public
  */
@@ -22,8 +27,55 @@ class OpenAPI3_1BundleStrategy extends BundleStrategy {
     // assert by inspecting ApiDOM
     return isOpenApi3_1Element(file.parseResult?.result);
   }
-  async bundle(file) {
-    return file.parseResult;
+  async bundle(file, options) {
+    const immutableRefSet = options.bundle.refSet ?? new ReferenceSet();
+    const mutableRefSet = new ReferenceSet();
+    let refSet = immutableRefSet;
+    let reference;
+
+    // determine the initial reference
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new Reference({
+        uri: file.uri,
+        value: file.parseResult
+      });
+      immutableRefSet.add(reference);
+    } else {
+      // pre-computed refSet was provided as configuration option
+      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+    }
+
+    /**
+     * Clone refSet due the bundling process being mutable.
+     * We don't want to mutate the original refSet and the references.
+     */
+    if (options.bundle.immutable) {
+      immutableRefSet.refs.map(ref => new Reference({
+        ...ref,
+        value: cloneDeep(ref.value)
+      })).forEach(ref => mutableRefSet.add(ref));
+      reference = mutableRefSet.find(ref => ref.uri === file.uri);
+      refSet = mutableRefSet;
+    }
+    const visitor = new OpenAPI3_1BundleVisitor({
+      reference: reference,
+      options
+    });
+    await traverseAsync(refSet.rootRef.value, visitor, {
+      mutable: true
+    });
+    const parseResult = reference.value;
+
+    /**
+     * Release all memory if this refSet was not provided as a configuration option.
+     * If provided as configuration option, then provider is responsible for cleanup.
+     */
+    if (options.bundle.refSet === null) {
+      immutableRefSet.clean();
+    }
+    mutableRefSet.clean();
+    return parseResult;
   }
 }
+export { OpenAPI3_1BundleVisitor };
 export default OpenAPI3_1BundleStrategy;