@speclynx/apidom-reference 6.1.2 → 7.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "6.1.2",
+  "version": "7.0.0",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "keywords": [
     "apidom",
@@ -299,35 +299,36 @@
   "author": "Vladimir Gorej",
   "license": "Apache-2.0",
   "dependencies": {
-    "@babel/runtime-corejs3": "^8.0.8",
-    "@speclynx/apidom-core": "6.1.2",
-    "@speclynx/apidom-datamodel": "6.1.2",
-    "@speclynx/apidom-error": "6.1.2",
-    "@speclynx/apidom-json-pointer": "6.1.2",
-    "@speclynx/apidom-ns-arazzo-1": "6.1.2",
-    "@speclynx/apidom-ns-asyncapi-2": "6.1.2",
-    "@speclynx/apidom-ns-json-schema-2020-12": "6.1.2",
-    "@speclynx/apidom-ns-openapi-2": "6.1.2",
-    "@speclynx/apidom-ns-openapi-3-0": "6.1.2",
-    "@speclynx/apidom-ns-openapi-3-1": "6.1.2",
-    "@speclynx/apidom-ns-overlay-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "6.1.2",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "6.1.2",
-    "@speclynx/apidom-parser-adapter-json": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "6.1.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-overlay-json-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "6.1.2",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "6.1.2",
-    "@speclynx/apidom-traverse": "6.1.2",
+    "@babel/runtime-corejs3": "^8.1.0",
+    "@speclynx/apidom-core": "7.0.0",
+    "@speclynx/apidom-datamodel": "7.0.0",
+    "@speclynx/apidom-error": "7.0.0",
+    "@speclynx/apidom-json-pointer": "7.0.0",
+    "@speclynx/apidom-ns-arazzo-1": "7.0.0",
+    "@speclynx/apidom-ns-asyncapi-2": "7.0.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "7.0.0",
+    "@speclynx/apidom-ns-openapi-2": "7.0.0",
+    "@speclynx/apidom-ns-openapi-3-0": "7.0.0",
+    "@speclynx/apidom-ns-openapi-3-1": "7.0.0",
+    "@speclynx/apidom-ns-overlay-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "7.0.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "7.0.0",
+    "@speclynx/apidom-parser-adapter-json": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "7.0.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-overlay-json-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "7.0.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "7.0.0",
+    "@speclynx/apidom-traverse": "7.0.0",
     "@swaggerexpert/arazzo-runtime-expression": "^3.2.0",
-    "axios": "^1.20.0",
+    "@swaggerexpert/media-types": "^1.0.3",
+    "axios": "^1.21.0",
     "picomatch": "^4.0.7",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.1.0"
@@ -346,5 +347,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "e3ba735e1c56369bb263dd8246c711d405ed9606"
+  "gitHead": "40c7c9837e4fb303453cec3d633bc06ee6be1e8b"
 }

package/src/File.cjs

@@ -23,12 +23,15 @@ class File {
   parseResult;
   constructor({
     uri,
-    mediaType = 'text/plain',
+    mediaType,
     data,
     parseResult
   }) {
     this.uri = uri;
-    this.mediaType = mediaType;
+    // media types are compared as Content-Type field values, which exclude surrounding whitespace;
+    // a missing or blank media type means none was given
+    const trimmedMediaType = (0, _ramdaAdjunct.isString)(mediaType) ? mediaType.trim() : '';
+    this.mediaType = trimmedMediaType === '' ? 'text/plain' : trimmedMediaType;
     this.data = data;
     this.parseResult = parseResult;
   }

package/src/File.mjs

@@ -15,12 +15,15 @@ class File {
   parseResult;
   constructor({
     uri,
-    mediaType = 'text/plain',
+    mediaType,
     data,
     parseResult
   }) {
     this.uri = uri;
-    this.mediaType = mediaType;
+    // media types are compared as Content-Type field values, which exclude surrounding whitespace;
+    // a missing or blank media type means none was given
+    const trimmedMediaType = isString(mediaType) ? mediaType.trim() : '';
+    this.mediaType = trimmedMediaType === '' ? 'text/plain' : trimmedMediaType;
     this.data = data;
     this.parseResult = parseResult;
   }

package/src/bundle/index.cjs

@@ -22,20 +22,22 @@ const bundle = async (uri, options) => {
   const {
     refSet
   } = options.bundle;
-  const sanitizedURI = url.sanitize(uri);
+  // strategies look up same-document references by a resolved, hence normalized, URI;
+  // the file is parsed as a whole document, so its URI has no fragment
+  const baseURI = url.normalize(url.stripHash(uri));
   const mergedOptions = (0, _util.merge)(options, {
     resolve: {
-      baseURI: sanitizedURI
+      baseURI
     }
   });
   let parseResult;
 
   // if refSet was provided, use it to avoid unnecessary parsing
-  if (refSet !== null && refSet.has(sanitizedURI)) {
+  if (refSet !== null && refSet.has(baseURI)) {
     // @ts-ignore
     ({
       value: parseResult
-    } = refSet.find((0, _ramda.propEq)(sanitizedURI, 'uri')));
+    } = refSet.find((0, _ramda.propEq)(baseURI, 'uri')));
   } else {
     parseResult = await (0, _index.default)(uri, mergedOptions);
   }

package/src/bundle/index.mjs

@@ -14,20 +14,22 @@ const bundle = async (uri, options) => {
   const {
     refSet
   } = options.bundle;
-  const sanitizedURI = url.sanitize(uri);
+  // strategies look up same-document references by a resolved, hence normalized, URI;
+  // the file is parsed as a whole document, so its URI has no fragment
+  const baseURI = url.normalize(url.stripHash(uri));
   const mergedOptions = mergeOptions(options, {
     resolve: {
-      baseURI: sanitizedURI
+      baseURI
     }
   });
   let parseResult;
 
   // if refSet was provided, use it to avoid unnecessary parsing
-  if (refSet !== null && refSet.has(sanitizedURI)) {
+  if (refSet !== null && refSet.has(baseURI)) {
     // @ts-ignore
     ({
       value: parseResult
-    } = refSet.find(propEq(sanitizedURI, 'uri')));
+    } = refSet.find(propEq(baseURI, 'uri')));
   } else {
     parseResult = await parse(uri, mergedOptions);
   }

package/src/bundle/strategies/arazzo-1/index.cjs

@@ -14,6 +14,7 @@ exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
+var _mediaTypes = require("@swaggerexpert/media-types");
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
@@ -34,8 +35,8 @@ class Arazzo1BundleStrategy extends _BundleStrategy.default {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsArazzo.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsArazzo.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

package/src/bundle/strategies/arazzo-1/index.mjs

@@ -1,6 +1,7 @@
 import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isArazzoSpecification1Element } from '@speclynx/apidom-ns-arazzo-1';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
@@ -20,8 +21,8 @@ class Arazzo1BundleStrategy extends BundleStrategy {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

package/src/bundle/strategies/asyncapi-2/index.cjs

@@ -14,6 +14,7 @@ exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsAsyncapi = require("@speclynx/apidom-ns-asyncapi-2");
+var _mediaTypes = require("@swaggerexpert/media-types");
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
@@ -34,8 +35,8 @@ class AsyncAPI2BundleStrategy extends _BundleStrategy.default {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsAsyncapi.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsAsyncapi.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

package/src/bundle/strategies/asyncapi-2/index.mjs

@@ -1,6 +1,7 @@
 import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isAsyncApi2Element } from '@speclynx/apidom-ns-asyncapi-2';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
@@ -20,8 +21,8 @@ class AsyncAPI2BundleStrategy extends BundleStrategy {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -14,6 +14,7 @@ exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
+var _mediaTypes = require("@swaggerexpert/media-types");
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
@@ -34,8 +35,8 @@ class OpenAPI2BundleStrategy extends _BundleStrategy.default {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsOpenapi.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -1,6 +1,7 @@
 import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isSwaggerElement } from '@speclynx/apidom-ns-openapi-2';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
@@ -20,8 +21,8 @@ class OpenAPI2BundleStrategy extends BundleStrategy {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -14,6 +14,7 @@ exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
+var _mediaTypes = require("@swaggerexpert/media-types");
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
@@ -34,8 +35,8 @@ class OpenAPI3_0BundleStrategy extends _BundleStrategy.default {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsOpenapi.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -1,6 +1,7 @@
 import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isOpenApi3_0Element } from '@speclynx/apidom-ns-openapi-3-0';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
@@ -20,8 +21,8 @@ class OpenAPI3_0BundleStrategy extends BundleStrategy {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -14,6 +14,7 @@ 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 _mediaTypes = require("@swaggerexpert/media-types");
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
@@ -34,8 +35,8 @@ class OpenAPI3_1BundleStrategy extends _BundleStrategy.default {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsOpenapi.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

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

@@ -1,6 +1,7 @@
 import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { traverseAsync } from '@speclynx/apidom-traverse';
 import { mediaTypes, isOpenApi3_1Element } from '@speclynx/apidom-ns-openapi-3-1';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import BundleStrategy from "../BundleStrategy.mjs";
@@ -20,8 +21,8 @@ class OpenAPI3_1BundleStrategy extends BundleStrategy {
   }
   canBundle(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM

package/src/dereference/index.cjs

@@ -31,8 +31,10 @@ const dereferenceApiDOM = async (element, options) => {
     parseResult = new _apidomDatamodel.ParseResultElement([elementClone]);
     surrogateWrapping = true;
   }
+
+  // strategies look up same-document references by a resolved, hence normalized, URI
   const file = new _File.default({
-    uri: options.resolve.baseURI,
+    uri: url.normalize(options.resolve.baseURI),
     parseResult,
     mediaType: options.parse.mediaType
   });
@@ -66,21 +68,22 @@ const dereference = async (uri, options) => {
   const {
     refSet
   } = options.dereference;
-  const sanitizedURI = url.sanitize(uri);
+  // the file is parsed as a whole document, so its URI has no fragment
+  const baseURI = url.normalize(url.stripHash(uri));
   let parseResult;
 
   // if refSet was provided, use it to avoid unnecessary parsing
-  if (refSet !== null && refSet.has(sanitizedURI)) {
+  if (refSet !== null && refSet.has(baseURI)) {
     // @ts-ignore
     ({
       value: parseResult
-    } = refSet.find((0, _ramda.propEq)(sanitizedURI, 'uri')));
+    } = refSet.find((0, _ramda.propEq)(baseURI, 'uri')));
   } else {
     parseResult = await (0, _index.default)(uri, options);
   }
   const mergedOptions = (0, _util.merge)(options, {
     resolve: {
-      baseURI: sanitizedURI
+      baseURI
     },
     dereference: {
       // if refSet was not provided, then we can work in mutable mode

package/src/dereference/index.mjs

@@ -23,8 +23,10 @@ export const dereferenceApiDOM = async (element, options) => {
     parseResult = new ParseResultElement([elementClone]);
     surrogateWrapping = true;
   }
+
+  // strategies look up same-document references by a resolved, hence normalized, URI
   const file = new File({
-    uri: options.resolve.baseURI,
+    uri: url.normalize(options.resolve.baseURI),
     parseResult,
     mediaType: options.parse.mediaType
   });
@@ -57,21 +59,22 @@ const dereference = async (uri, options) => {
   const {
     refSet
   } = options.dereference;
-  const sanitizedURI = url.sanitize(uri);
+  // the file is parsed as a whole document, so its URI has no fragment
+  const baseURI = url.normalize(url.stripHash(uri));
   let parseResult;
 
   // if refSet was provided, use it to avoid unnecessary parsing
-  if (refSet !== null && refSet.has(sanitizedURI)) {
+  if (refSet !== null && refSet.has(baseURI)) {
     // @ts-ignore
     ({
       value: parseResult
-    } = refSet.find(propEq(sanitizedURI, 'uri')));
+    } = refSet.find(propEq(baseURI, 'uri')));
   } else {
     parseResult = await parse(uri, options);
   }
   const mergedOptions = mergeOptions(options, {
     resolve: {
-      baseURI: sanitizedURI
+      baseURI
     },
     dereference: {
       // if refSet was not provided, then we can work in mutable mode