@usearazzo/resolver 1.0.1-alpha.2

package/src/dereference/arazzo.cjs

@@ -0,0 +1,246 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: 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 _arazzo = _interopRequireDefault(require("@speclynx/apidom-reference/dereference/strategies/arazzo-1"));
+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 _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
+var _parser = require("@usearazzo/parser");
+var _DereferenceError = _interopRequireDefault(require("../errors/DereferenceError.cjs"));
+/**
+ * Options for dereferencing Arazzo Documents.
+ * @public
+ */
+
+/**
+ * Default reference options for dereferencing Arazzo Documents.
+ * @public
+ */
+const defaultOptions = exports.defaultOptions = {
+  resolve: {
+    resolvers: [..._parser.defaultParseArazzoOptions.resolve.resolvers]
+  },
+  parse: {
+    parsers: [..._parser.defaultParseArazzoOptions.parse.parsers, new _json.default({
+      allowEmpty: false
+    }), new _yaml.default({
+      allowEmpty: false
+    }), new _binary.default({
+      allowEmpty: false
+    })],
+    parserOpts: {
+      ..._parser.defaultParseArazzoOptions.parse.parserOpts
+    }
+  },
+  dereference: {
+    strategies: [new _arazzo.default(), new _openapi.default(), new _openapi2.default(), new _openapi3.default()],
+    strategyOpts: {
+      sourceDescriptions: false
+    }
+  }
+};
+
+/**
+ * Dereferences an Arazzo Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document.
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the Arazzo Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced Arazzo Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an Arazzo specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceArazzo('/path/to/arazzo.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceArazzo('https://example.com/arazzo.yaml');
+ *
+ * @example
+ * Dereference with source descriptions
+ * ```typescript
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ * ```
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', customReferenceOptions);
+ * @public
+ */
+async function dereference(uri, options = {}) {
+  const mergedOptions = (0, _empty.mergeOptions)(defaultOptions, options);
+
+  // a relative file system path resolves against the current working directory; the string
+  // doubles as the base URI for relative references, where a relative base resolves against
+  // the filesystem root instead of the document. A leading slash or backslash (UNC,
+  // drive-rooted) is already rooted and passes through untouched. `uri` itself is left as
+  // is so error messages below quote what the caller passed in.
+  const retrievalURI = !_empty.url.isHttpUrl(uri) && _empty.url.getProtocol(uri) !== 'file' && !/^[\\/]/.test(uri) ? _empty.url.resolve(_empty.url.fromFileSystemPath(_empty.url.cwd()), uri) : uri;
+  try {
+    const parseResult = await (0, _empty.dereference)(retrievalURI, mergedOptions);
+
+    // validate that the dereferenced document is an Arazzo specification
+    if (!(0, _apidomNsArazzo.isArazzoSpecification1Element)(parseResult.api)) {
+      throw new _empty.UnmatchedDereferenceStrategyError(`Could not find a dereference strategy that can dereference "${uri}" as an Arazzo specification`);
+    }
+    parseResult.meta.set('retrievalURI', retrievalURI);
+    return parseResult;
+  } catch (error) {
+    throw new _DereferenceError.default(`Failed to dereference Arazzo Document at "${uri}"`, {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Dereferences an ApiDOM element representing an Arazzo Document.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., WorkflowElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like WorkflowElement)
+ * @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 { parseArazzo } from '@usearazzo/parser';
+ *
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseArazzo({ arazzo: '1.0.1', ... });
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/arazzo.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., WorkflowElement)
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const workflow = parseResult.api.workflows.get(0);
+ * const dereferenced = await dereferenceArazzoElement(workflow, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference with source descriptions
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ * ```
+ * @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 ((0, _apidomNsArazzo.isArazzoSpecification1Element)(element.api)) {
+        mediaType = _apidomNsArazzo.mediaTypes.latest();
+      }
+      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 ((0, _apidomNsArazzo.isArazzoSpecification1Element)(parseResult.api)) {
+        mediaType = _apidomNsArazzo.mediaTypes.latest();
+      }
+      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');
+      }
+
+      // the fragment wrapper must expose the element as its result, the same way
+      // dereferenceApiDOM wraps a bare element: dereference strategies read the
+      // traversed root's `result` to index the `$id`s of the fragment
+      const elementClone = (0, _apidomDatamodel.cloneShallow)(element);
+      elementClone.classes.push('result');
+      const elementReference = new _empty.Reference({
+        uri: `${rootURI}#fragment`,
+        value: new _apidomDatamodel.ParseResultElement([elementClone])
+      });
+      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 Arazzo Document', {
+      cause: error
+    });
+  }
+}

package/src/dereference/arazzo.mjs

@@ -0,0 +1,236 @@
+import { isParseResultElement, ParseResultElement, cloneShallow } from '@speclynx/apidom-datamodel';
+import { url, dereference as dereferenceURI, dereferenceApiDOM as dereferenceApiDOMElement, mergeOptions, ReferenceSet, Reference, UnmatchedDereferenceStrategyError } from '@speclynx/apidom-reference/configuration/empty';
+import Arazzo1DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/arazzo-1';
+import OpenAPI2DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/openapi-2';
+import OpenAPI30DereferenceStrategy from '@speclynx/apidom-reference/dereference/strategies/openapi-3-0';
+import OpenAPI31DereferenceStrategy 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 { isArazzoSpecification1Element, mediaTypes } from '@speclynx/apidom-ns-arazzo-1';
+import { defaultParseArazzoOptions as parserDefaultOptions } from '@usearazzo/parser';
+import DereferenceError from "../errors/DereferenceError.mjs";
+/**
+ * Options for dereferencing Arazzo Documents.
+ * @public
+ */
+/**
+ * Default reference options for dereferencing Arazzo 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 Arazzo1DereferenceStrategy(), new OpenAPI2DereferenceStrategy(), new OpenAPI30DereferenceStrategy(), new OpenAPI31DereferenceStrategy()],
+    strategyOpts: {
+      sourceDescriptions: false
+    }
+  }
+};
+
+/**
+ * Dereferences an Arazzo Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document.
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the Arazzo Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced Arazzo Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an Arazzo specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceArazzo('/path/to/arazzo.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceArazzo('https://example.com/arazzo.yaml');
+ *
+ * @example
+ * Dereference with source descriptions
+ * ```typescript
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ * ```
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', customReferenceOptions);
+ * @public
+ */
+export async function dereference(uri, options = {}) {
+  const mergedOptions = mergeOptions(defaultOptions, options);
+
+  // a relative file system path resolves against the current working directory; the string
+  // doubles as the base URI for relative references, where a relative base resolves against
+  // the filesystem root instead of the document. A leading slash or backslash (UNC,
+  // drive-rooted) is already rooted and passes through untouched. `uri` itself is left as
+  // is so error messages below quote what the caller passed in.
+  const retrievalURI = !url.isHttpUrl(uri) && url.getProtocol(uri) !== 'file' && !/^[\\/]/.test(uri) ? url.resolve(url.fromFileSystemPath(url.cwd()), uri) : uri;
+  try {
+    const parseResult = await dereferenceURI(retrievalURI, mergedOptions);
+
+    // validate that the dereferenced document is an Arazzo specification
+    if (!isArazzoSpecification1Element(parseResult.api)) {
+      throw new UnmatchedDereferenceStrategyError(`Could not find a dereference strategy that can dereference "${uri}" as an Arazzo specification`);
+    }
+    parseResult.meta.set('retrievalURI', retrievalURI);
+    return parseResult;
+  } catch (error) {
+    throw new DereferenceError(`Failed to dereference Arazzo Document at "${uri}"`, {
+      cause: error
+    });
+  }
+}
+
+/**
+ * Dereferences an ApiDOM element representing an Arazzo Document.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., WorkflowElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like WorkflowElement)
+ * @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 { parseArazzo } from '@usearazzo/parser';
+ *
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseArazzo({ arazzo: '1.0.1', ... });
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/arazzo.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., WorkflowElement)
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const workflow = parseResult.api.workflows.get(0);
+ * const dereferenced = await dereferenceArazzoElement(workflow, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference with source descriptions
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ * ```
+ * @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 (isArazzoSpecification1Element(element.api)) {
+        mediaType = mediaTypes.latest();
+      }
+      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 (isArazzoSpecification1Element(parseResult.api)) {
+        mediaType = mediaTypes.latest();
+      }
+      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');
+      }
+
+      // the fragment wrapper must expose the element as its result, the same way
+      // dereferenceApiDOM wraps a bare element: dereference strategies read the
+      // traversed root's `result` to index the `$id`s of the fragment
+      const elementClone = cloneShallow(element);
+      elementClone.classes.push('result');
+      const elementReference = new Reference({
+        uri: `${rootURI}#fragment`,
+        value: new ParseResultElement([elementClone])
+      });
+      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 Arazzo Document', {
+      cause: error
+    });
+  }
+}