@jentic/arazzo-resolver 1.0.0-alpha.3 → 1.0.0-alpha.31

package/src/dereference/openapi.cjs

@@ -0,0 +1,224 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.defaultOptions = void 0;
+exports.dereference = dereference;
+exports.dereferenceElement = dereferenceElement;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _empty = require("@speclynx/apidom-reference/configuration/empty");
+var _openapi = _interopRequireDefault(require("@speclynx/apidom-reference/dereference/strategies/openapi-2"));
+var _openapi2 = _interopRequireDefault(require("@speclynx/apidom-reference/dereference/strategies/openapi-3-0"));
+var _openapi3 = _interopRequireDefault(require("@speclynx/apidom-reference/dereference/strategies/openapi-3-1"));
+var _json = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/json"));
+var _yaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/yaml-1-2"));
+var _binary = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/binary"));
+var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
+var _apidomNsOpenapi2 = require("@speclynx/apidom-ns-openapi-3-0");
+var _apidomNsOpenapi3 = require("@speclynx/apidom-ns-openapi-3-1");
+var _arazzoParser = require("@jentic/arazzo-parser");
+var _DereferenceError = _interopRequireDefault(require("../errors/DereferenceError.cjs"));
+/**
+ * Options for dereferencing OpenAPI Documents.
+ * @public
+ */
+
+/**
+ * Default reference options for dereferencing OpenAPI Documents.
+ * @public
+ */
+const defaultOptions = exports.defaultOptions = {
+  resolve: {
+    resolvers: [..._arazzoParser.defaultParseOpenAPIOptions.resolve.resolvers]
+  },
+  parse: {
+    parsers: [..._arazzoParser.defaultParseOpenAPIOptions.parse.parsers, new _json.default({
+      allowEmpty: false
+    }), new _yaml.default({
+      allowEmpty: false
+    }), new _binary.default({
+      allowEmpty: false
+    })],
+    parserOpts: {
+      ..._arazzoParser.defaultParseOpenAPIOptions.parse.parserOpts
+    }
+  },
+  dereference: {
+    strategies: [new _openapi.default(), new _openapi2.default(), new _openapi3.default()],
+    strategyOpts: {}
+  }
+};
+
+/**
+ * Dereferences an OpenAPI Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document.
+ *
+ * Supports OpenAPI 2.0 (Swagger), OpenAPI 3.0.x, and OpenAPI 3.1.x.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the OpenAPI Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced OpenAPI Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an OpenAPI specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceOpenAPI('https://example.com/openapi.yaml');
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json', customReferenceOptions);
+ * @public
+ */
+async function dereference(uri, options = {}) {
+  const mergedOptions = (0, _empty.mergeOptions)(defaultOptions, options);
+  try {
+    const parseResult = await (0, _empty.dereference)(uri, mergedOptions);
+
+    // validate that the dereferenced document is an OpenAPI specification
+    if (!isOpenApiElement(parseResult.api)) {
+      throw new _empty.UnmatchedDereferenceStrategyError(`Could not find a dereference strategy that can dereference "${uri}" as an OpenAPI specification`);
+    }
+    parseResult.meta.set('retrievalURI', uri);
+    return parseResult;
+  } catch (error) {
+    throw new _DereferenceError.default(`Failed to dereference OpenAPI Document at "${uri}"`, {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Dereferences an ApiDOM element representing an OpenAPI Document.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., PathItemElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like PathItemElement)
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced element
+ * @throws DereferenceError - When baseURI is required but not provided, or when dereferencing fails
+ *
+ * @example
+ * Dereference ParseResultElement with retrievalURI (from file parsing)
+ * ```typescript
+ * import { parseOpenAPI } from '@jentic/arazzo-parser';
+ *
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseOpenAPI({ openapi: '3.1.0', ... });
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/openapi.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., PathItemElement)
+ * ```typescript
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const pathItem = parseResult.api.paths.get('/users');
+ * const dereferenced = await dereferenceOpenAPIElement(pathItem, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ * @public
+ */
+async function dereferenceElement(element, options = {}) {
+  const mergedOptions = (0, _empty.mergeOptions)(defaultOptions, options);
+  const refSet = mergedOptions.dereference?.refSet ?? new _empty.ReferenceSet();
+  let baseURI = mergedOptions.resolve?.baseURI;
+  let mediaType = 'text/plain';
+  if (refSet.size === 0) {
+    if ((0, _apidomDatamodel.isParseResultElement)(element)) {
+      if (isOpenApiElement(element.api)) {
+        mediaType = inferOpenApiMediaType(element.api);
+      }
+      if (element.hasMetaProperty('retrievalURI')) {
+        baseURI = element.meta.get('retrievalURI');
+      } else if (!baseURI) {
+        throw new _DereferenceError.default('baseURI option is required when dereferencing a ParseResultElement without retrievalURI metadata');
+      }
+    } else if ((0, _apidomDatamodel.isParseResultElement)(mergedOptions.dereference?.strategyOpts?.parseResult)) {
+      // dereferencing child element requires refSet for component resolution
+      const {
+        parseResult
+      } = mergedOptions.dereference.strategyOpts;
+      let rootURI;
+      if (isOpenApiElement(parseResult.api)) {
+        mediaType = inferOpenApiMediaType(parseResult.api);
+      }
+      if (parseResult.hasMetaProperty('retrievalURI')) {
+        rootURI = parseResult.meta.get('retrievalURI');
+      } else if (baseURI) {
+        rootURI = baseURI;
+      } else {
+        throw new _DereferenceError.default('baseURI option is required when dereferencing a child element without retrievalURI metadata');
+      }
+      const elementReference = new _empty.Reference({
+        uri: `${rootURI}#fragment`,
+        value: new _apidomDatamodel.ParseResultElement([element])
+      });
+      const rootReference = new _empty.Reference({
+        uri: rootURI,
+        value: parseResult
+      });
+      refSet.add(elementReference).add(rootReference);
+      baseURI = rootURI;
+    }
+  }
+  try {
+    return await (0, _empty.dereferenceApiDOM)(element, (0, _empty.mergeOptions)(mergedOptions, {
+      resolve: {
+        baseURI
+      },
+      parse: {
+        mediaType
+      },
+      dereference: {
+        refSet
+      }
+    }));
+  } catch (error) {
+    throw new _DereferenceError.default('Failed to dereference OpenAPI Document', {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Checks if the element is a valid OpenAPI specification element.
+ */
+function isOpenApiElement(element) {
+  return (0, _apidomNsOpenapi.isSwaggerElement)(element) || (0, _apidomNsOpenapi2.isOpenApi3_0Element)(element) || (0, _apidomNsOpenapi3.isOpenApi3_1Element)(element);
+}
+
+/**
+ * Gets the appropriate mediaType for an OpenAPI element.
+ */
+function inferOpenApiMediaType(element) {
+  if ((0, _apidomNsOpenapi.isSwaggerElement)(element)) {
+    return _apidomNsOpenapi.mediaTypes.latest();
+  }
+  if ((0, _apidomNsOpenapi2.isOpenApi3_0Element)(element)) {
+    return _apidomNsOpenapi2.mediaTypes.latest();
+  }
+  if ((0, _apidomNsOpenapi3.isOpenApi3_1Element)(element)) {
+    return _apidomNsOpenapi3.mediaTypes.latest();
+  }
+  return 'text/plain';
+}

package/src/dereference/openapi.mjs

@@ -0,0 +1,216 @@
+import { isParseResultElement, ParseResultElement } from '@speclynx/apidom-datamodel';
+import { dereference as dereferenceURI, dereferenceApiDOM as dereferenceApiDOMElement, mergeOptions, ReferenceSet, Reference, UnmatchedDereferenceStrategyError } from '@speclynx/apidom-reference/configuration/empty';
+import OpenAPI2DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/openapi-2';
+import OpenAPI3_0DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/openapi-3-0';
+import OpenAPI3_1DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/openapi-3-1';
+import JSONParser from '@speclynx/apidom-reference/parse/parsers/json';
+import YAMLParser from '@speclynx/apidom-reference/parse/parsers/yaml-1-2';
+import BinaryParser from '@speclynx/apidom-reference/parse/parsers/binary';
+import { isSwaggerElement, mediaTypes as openApi2MediaTypes } from '@speclynx/apidom-ns-openapi-2';
+import { isOpenApi3_0Element, mediaTypes as openApi3_0MediaTypes } from '@speclynx/apidom-ns-openapi-3-0';
+import { isOpenApi3_1Element, mediaTypes as openApi3_1MediaTypes } from '@speclynx/apidom-ns-openapi-3-1';
+import { defaultParseOpenAPIOptions as parserDefaultOptions } from '@jentic/arazzo-parser';
+import DereferenceError from "../errors/DereferenceError.mjs";
+/**
+ * Options for dereferencing OpenAPI Documents.
+ * @public
+ */
+/**
+ * Default reference options for dereferencing OpenAPI Documents.
+ * @public
+ */
+export const defaultOptions = {
+  resolve: {
+    resolvers: [...parserDefaultOptions.resolve.resolvers]
+  },
+  parse: {
+    parsers: [...parserDefaultOptions.parse.parsers, new JSONParser({
+      allowEmpty: false
+    }), new YAMLParser({
+      allowEmpty: false
+    }), new BinaryParser({
+      allowEmpty: false
+    })],
+    parserOpts: {
+      ...parserDefaultOptions.parse.parserOpts
+    }
+  },
+  dereference: {
+    strategies: [new OpenAPI2DereferenceStrategy(), new OpenAPI3_0DereferenceStrategy(), new OpenAPI3_1DereferenceStrategy()],
+    strategyOpts: {}
+  }
+};
+
+/**
+ * Dereferences an OpenAPI Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document.
+ *
+ * Supports OpenAPI 2.0 (Swagger), OpenAPI 3.0.x, and OpenAPI 3.1.x.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the OpenAPI Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced OpenAPI Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an OpenAPI specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceOpenAPI('https://example.com/openapi.yaml');
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json', customReferenceOptions);
+ * @public
+ */
+export async function dereference(uri, options = {}) {
+  const mergedOptions = mergeOptions(defaultOptions, options);
+  try {
+    const parseResult = await dereferenceURI(uri, mergedOptions);
+
+    // validate that the dereferenced document is an OpenAPI specification
+    if (!isOpenApiElement(parseResult.api)) {
+      throw new UnmatchedDereferenceStrategyError(`Could not find a dereference strategy that can dereference "${uri}" as an OpenAPI specification`);
+    }
+    parseResult.meta.set('retrievalURI', uri);
+    return parseResult;
+  } catch (error) {
+    throw new DereferenceError(`Failed to dereference OpenAPI Document at "${uri}"`, {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Dereferences an ApiDOM element representing an OpenAPI Document.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., PathItemElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like PathItemElement)
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced element
+ * @throws DereferenceError - When baseURI is required but not provided, or when dereferencing fails
+ *
+ * @example
+ * Dereference ParseResultElement with retrievalURI (from file parsing)
+ * ```typescript
+ * import { parseOpenAPI } from '@jentic/arazzo-parser';
+ *
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseOpenAPI({ openapi: '3.1.0', ... });
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/openapi.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., PathItemElement)
+ * ```typescript
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const pathItem = parseResult.api.paths.get('/users');
+ * const dereferenced = await dereferenceOpenAPIElement(pathItem, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ * @public
+ */
+export async function dereferenceElement(element, options = {}) {
+  const mergedOptions = mergeOptions(defaultOptions, options);
+  const refSet = mergedOptions.dereference?.refSet ?? new ReferenceSet();
+  let baseURI = mergedOptions.resolve?.baseURI;
+  let mediaType = 'text/plain';
+  if (refSet.size === 0) {
+    if (isParseResultElement(element)) {
+      if (isOpenApiElement(element.api)) {
+        mediaType = inferOpenApiMediaType(element.api);
+      }
+      if (element.hasMetaProperty('retrievalURI')) {
+        baseURI = element.meta.get('retrievalURI');
+      } else if (!baseURI) {
+        throw new DereferenceError('baseURI option is required when dereferencing a ParseResultElement without retrievalURI metadata');
+      }
+    } else if (isParseResultElement(mergedOptions.dereference?.strategyOpts?.parseResult)) {
+      // dereferencing child element requires refSet for component resolution
+      const {
+        parseResult
+      } = mergedOptions.dereference.strategyOpts;
+      let rootURI;
+      if (isOpenApiElement(parseResult.api)) {
+        mediaType = inferOpenApiMediaType(parseResult.api);
+      }
+      if (parseResult.hasMetaProperty('retrievalURI')) {
+        rootURI = parseResult.meta.get('retrievalURI');
+      } else if (baseURI) {
+        rootURI = baseURI;
+      } else {
+        throw new DereferenceError('baseURI option is required when dereferencing a child element without retrievalURI metadata');
+      }
+      const elementReference = new Reference({
+        uri: `${rootURI}#fragment`,
+        value: new ParseResultElement([element])
+      });
+      const rootReference = new Reference({
+        uri: rootURI,
+        value: parseResult
+      });
+      refSet.add(elementReference).add(rootReference);
+      baseURI = rootURI;
+    }
+  }
+  try {
+    return await dereferenceApiDOMElement(element, mergeOptions(mergedOptions, {
+      resolve: {
+        baseURI
+      },
+      parse: {
+        mediaType
+      },
+      dereference: {
+        refSet
+      }
+    }));
+  } catch (error) {
+    throw new DereferenceError('Failed to dereference OpenAPI Document', {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Checks if the element is a valid OpenAPI specification element.
+ */
+function isOpenApiElement(element) {
+  return isSwaggerElement(element) || isOpenApi3_0Element(element) || isOpenApi3_1Element(element);
+}
+
+/**
+ * Gets the appropriate mediaType for an OpenAPI element.
+ */
+function inferOpenApiMediaType(element) {
+  if (isSwaggerElement(element)) {
+    return openApi2MediaTypes.latest();
+  }
+  if (isOpenApi3_0Element(element)) {
+    return openApi3_0MediaTypes.latest();
+  }
+  if (isOpenApi3_1Element(element)) {
+    return openApi3_1MediaTypes.latest();
+  }
+  return 'text/plain';
+}

package/src/index.cjs

@@ -2,13 +2,14 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.dereferenceElement = exports.dereferenceArazzoElement = exports.dereferenceArazzo = exports.dereference = exports.defaultDereferenceOptions = exports.defaultDereferenceArazzoOptions = exports.DereferenceError = void 0;
-var _dereference = require("./dereference.cjs");
-exports.defaultDereferenceOptions = _dereference.defaultOptions;
-exports.defaultDereferenceArazzoOptions = _dereference.defaultOptions;
-exports.dereference = _dereference.dereference;
-exports.dereferenceElement = _dereference.dereferenceElement;
-exports.dereferenceArazzo = _dereference.dereference;
-exports.dereferenceArazzoElement = _dereference.dereferenceElement;
+exports.dereferenceOpenAPIElement = exports.dereferenceOpenAPI = exports.dereferenceArazzoElement = exports.dereferenceArazzo = exports.defaultDereferenceOpenAPIOptions = exports.defaultDereferenceArazzoOptions = exports.DereferenceError = void 0;
+var _arazzo = require("./dereference/arazzo.cjs");
+exports.defaultDereferenceArazzoOptions = _arazzo.defaultOptions;
+exports.dereferenceArazzo = _arazzo.dereference;
+exports.dereferenceArazzoElement = _arazzo.dereferenceElement;
+var _openapi = require("./dereference/openapi.cjs");
+exports.defaultDereferenceOpenAPIOptions = _openapi.defaultOptions;
+exports.dereferenceOpenAPI = _openapi.dereference;
+exports.dereferenceOpenAPIElement = _openapi.dereferenceElement;
 var _DereferenceError = _interopRequireDefault(require("./errors/DereferenceError.cjs"));
 exports.DereferenceError = _DereferenceError.default;

package/src/index.mjs

@@ -1,2 +1,3 @@
-export { defaultOptions as defaultDereferenceOptions, defaultOptions as defaultDereferenceArazzoOptions, dereference, dereferenceElement, dereference as dereferenceArazzo, dereferenceElement as dereferenceArazzoElement } from "./dereference.mjs";
+export { defaultOptions as defaultDereferenceArazzoOptions, dereference as dereferenceArazzo, dereferenceElement as dereferenceArazzoElement } from "./dereference/arazzo.mjs";
+export { defaultOptions as defaultDereferenceOpenAPIOptions, dereference as dereferenceOpenAPI, dereferenceElement as dereferenceOpenAPIElement } from "./dereference/openapi.mjs";
 export { default as DereferenceError } from "./errors/DereferenceError.mjs";