@jentic/arazzo-resolver 1.0.0-alpha.10

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@jentic/arazzo-resolver",
+  "version": "1.0.0-alpha.10",
+  "description": "Resolver for Arazzo Documents.",
+  "keywords": [
+    "arazzo",
+    "arazzo-specification",
+    "resolver",
+    "resolve",
+    "dereference",
+    "workflow",
+    "workflows"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org",
+    "provenance": true,
+    "tag": "latest"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "unpkg": "./dist/jentic-arazzo-resolver.browser.min.js",
+  "main": "./src/index.cjs",
+  "exports": {
+    "types": "./types/arazzo-resolver.d.ts",
+    "import": "./src/index.mjs",
+    "require": "./src/index.cjs"
+  },
+  "types": "./types/arazzo-resolver.d.ts",
+  "scripts": {
+    "build": "npm run clean && run-p --max-parallel ${CPU_CORES:-2} typescript:declaration build:es build:cjs build:umd:browser",
+    "build:es": "cross-env BABEL_ENV=es babel src --out-dir src --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward'",
+    "build:cjs": "cross-env BABEL_ENV=cjs babel src --out-dir src --extensions '.ts' --out-file-extension '.cjs' --root-mode 'upward'",
+    "build:umd:browser": "cross-env BABEL_ENV=browser webpack --config config/webpack/browser.config.js --progress",
+    "lint": "eslint ./",
+    "lint:fix": "eslint ./ --fix",
+    "clean": "rimraf --glob 'src/**/*.mjs' 'src/**/*.cjs' 'test/**/*.mjs' ./dist ./types",
+    "typescript:check-types": "tsc --noEmit",
+    "typescript:declaration": "tsc -p tsconfig.declaration.json && api-extractor run -l -c ./config/api-extractor/api-extractor.json",
+    "test": "npm run build:es && cross-env BABEL_ENV=es babel test --out-dir test --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward' && cross-env NODE_ENV=test mocha",
+    "prepack": "copyfiles -u 2 ../../LICENSE . && copyfiles -u 2 ../../NOTICE .",
+    "postpack": "rimraf NOTICE LICENSE"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jentic/jentic-arazzo-tools.git"
+  },
+  "author": "Jentic <hello@jentic.com>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@babel/runtime-corejs3": "^7.28.4",
+    "@speclynx/apidom-core": "2.10.0",
+    "@speclynx/apidom-datamodel": "2.10.0",
+    "@speclynx/apidom-error": "2.10.0",
+    "@speclynx/apidom-ns-arazzo-1": "2.10.0",
+    "@speclynx/apidom-ns-openapi-2": "2.10.0",
+    "@speclynx/apidom-ns-openapi-3-0": "2.10.0",
+    "@speclynx/apidom-ns-openapi-3-1": "2.10.0",
+    "@speclynx/apidom-reference": "2.10.0",
+    "type-fest": "^5.4.3"
+  },
+  "files": [
+    "src/**/*.mjs",
+    "src/**/*.cjs",
+    "dist/",
+    "types/arazzo-resolver.d.ts",
+    "LICENSE",
+    "NOTICE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "gitHead": "13363a00a365e8f5d30ddedfdde8e93216e60df8"
+}

package/src/dereference/arazzo.cjs

@@ -0,0 +1,272 @@
+"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 _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 _arazzoJson = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-json-1"));
+var _arazzoYaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-yaml-1"));
+var _openapiJson = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-2"));
+var _openapiYaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-2"));
+var _openapiJson2 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-3-0"));
+var _openapiYaml2 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-0"));
+var _openapiJson3 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-3-1"));
+var _openapiYaml3 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-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 _file = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/file"));
+var _httpAxios = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/http-axios"));
+var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
+var _apidomCore = require("@speclynx/apidom-core");
+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: [new _file.default({
+      fileAllowList: ['*.json', '*.yaml', '*.yml']
+    }), new _httpAxios.default({
+      timeout: 5000,
+      redirects: 5,
+      withCredentials: false
+    })]
+  },
+  parse: {
+    parsers: [new _arazzoJson.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _arazzoYaml.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _openapiJson.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _openapiJson2.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml2.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _openapiJson3.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml3.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _json.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _yaml.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _binary.default({
+      allowEmpty: false
+    })],
+    parserOpts: {
+      sourceMap: false,
+      strict: true
+    }
+  },
+  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
+ * 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);
+  try {
+    const parseResult = await (0, _empty.dereference)(uri, 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', uri);
+    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 '@jentic/arazzo-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 = (0, _apidomCore.toValue)(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 = (0, _apidomCore.toValue)(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 Arazzo Document', {
+      cause: error
+    });
+  }
+}

package/src/dereference/arazzo.mjs

@@ -0,0 +1,264 @@
+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 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 ArazzoJSON1Parser from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
+import ArazzoYAML1Parser from '@speclynx/apidom-reference/parse/parsers/arazzo-yaml-1';
+import OpenAPIJSON20Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-2';
+import OpenAPIYAML20Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-2';
+import OpenAPIJSON30Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-3-0';
+import OpenAPIYAML30Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-0';
+import OpenAPIJSON31Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-3-1';
+import OpenAPIYAML31Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-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 FileResolver from '@speclynx/apidom-reference/resolve/resolvers/file';
+import HTTPResolverAxios from '@speclynx/apidom-reference/resolve/resolvers/http-axios';
+import { isArazzoSpecification1Element, mediaTypes } from '@speclynx/apidom-ns-arazzo-1';
+import { toValue } from '@speclynx/apidom-core';
+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: [new FileResolver({
+      fileAllowList: ['*.json', '*.yaml', '*.yml']
+    }), new HTTPResolverAxios({
+      timeout: 5000,
+      redirects: 5,
+      withCredentials: false
+    })]
+  },
+  parse: {
+    parsers: [new ArazzoJSON1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new ArazzoYAML1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new OpenAPIJSON20Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenAPIYAML20Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new OpenAPIJSON30Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenAPIYAML30Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new OpenAPIJSON31Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenAPIYAML31Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new JSONParser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new YAMLParser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new BinaryParser({
+      allowEmpty: false
+    })],
+    parserOpts: {
+      sourceMap: false,
+      strict: true
+    }
+  },
+  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
+ * 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);
+  try {
+    const parseResult = await dereferenceURI(uri, 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', uri);
+    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 '@jentic/arazzo-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 = toValue(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 = toValue(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 Arazzo Document', {
+      cause: error
+    });
+  }
+}