@speclynx/apidom-reference 4.11.1 → 4.12.0

package/src/options/index.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 /**
@@ -15,6 +17,24 @@ var _ramda = require("ramda");
  * @public
  */
 
+/**
+ * Context passed to a custom component-name resolver.
+ *
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
 /**
  * @public
  */
@@ -170,6 +190,13 @@ const defaultOptions = {
      * your own implementation, or remove any bundle strategy by removing it from the list.
      */
     strategies: [],
+    /**
+     * Determines strategy specific options. The key is the name of the strategy
+     * (e.g. `openapi-3-0`) and the value is an object of options specific to
+     * that strategy. Strategy specific options take precedence over the
+     * top-level bundle options.
+     */
+    strategyOpts: {},
     /**
      * This option accepts an instance of pre-computed ReferenceSet.
      * If provided it will speed up the bundling significantly as the external
@@ -188,7 +215,49 @@ const defaultOptions = {
      * The bundling should throw MaximumBundleDepthError if bundling depth
      * is exceeded by this option.
      */
-    maxDepth: +Infinity
+    maxDepth: +Infinity,
+    /**
+     * Determines whether the bundling process will be immutable.
+     * By default, the bundling process is immutable, which means that the original
+     * ApiDOM (and any pre-computed refSet) is not mutated and a deep clone is bundled.
+     *
+     * true - the bundling process is immutable (deep cloning of ApiDOM is involved)
+     * false - the bundling process is mutable (no deep cloning, faster, mutates input)
+     */
+    immutable: true,
+    /**
+     * Determines how hoisted components are named.
+     *
+     * `basename` (default) - derive the name from the referenced JSON Pointer
+     *   (its last token), falling back to the referenced file's basename.
+     * `title` - derive Schema Object names from their `title` field, falling
+     *   back to `basename` when no usable title is present.
+     * A custom resolver function - receives the referenced element and reference
+     *   context and returns the base name; collision suffixing is still applied.
+     */
+    componentNamesStrategy: 'basename',
+    /**
+     * Determines how a component rename forced by a name collision with
+     * different content is reported.
+     *
+     * `warn` (default) - append a warning annotation to the parse result.
+     * `off` - rename silently.
+     * `error` - throw a BundleError instead of renaming.
+     */
+    onComponentNameCollision: 'warn',
+    /**
+     * Determines how the bundling process behaves when a reference cannot be
+     * resolved.
+     *
+     * Unlike dereferencing, a swallowed reference is left in place — so the
+     * bundled document may still contain unresolved external references.
+     *
+     * false - fail fast, throw on first error (default)
+     * true - skip unresolvable references silently, continue bundling
+     * (error) => void - callback invoked for each error; if the callback
+     *   itself throws, bundling stops with that error
+     */
+    continueOnError: false
   }
 };
 var _default = exports.default = defaultOptions;

package/src/options/index.mjs

@@ -1,5 +1,23 @@
 import { identity } from 'ramda';
 
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * Context passed to a custom component-name resolver.
+ *
+ * @public
+ */
+
 /**
  * @public
  */
@@ -167,6 +185,13 @@ const defaultOptions = {
      * your own implementation, or remove any bundle strategy by removing it from the list.
      */
     strategies: [],
+    /**
+     * Determines strategy specific options. The key is the name of the strategy
+     * (e.g. `openapi-3-0`) and the value is an object of options specific to
+     * that strategy. Strategy specific options take precedence over the
+     * top-level bundle options.
+     */
+    strategyOpts: {},
     /**
      * This option accepts an instance of pre-computed ReferenceSet.
      * If provided it will speed up the bundling significantly as the external
@@ -185,7 +210,49 @@ const defaultOptions = {
      * The bundling should throw MaximumBundleDepthError if bundling depth
      * is exceeded by this option.
      */
-    maxDepth: +Infinity
+    maxDepth: +Infinity,
+    /**
+     * Determines whether the bundling process will be immutable.
+     * By default, the bundling process is immutable, which means that the original
+     * ApiDOM (and any pre-computed refSet) is not mutated and a deep clone is bundled.
+     *
+     * true - the bundling process is immutable (deep cloning of ApiDOM is involved)
+     * false - the bundling process is mutable (no deep cloning, faster, mutates input)
+     */
+    immutable: true,
+    /**
+     * Determines how hoisted components are named.
+     *
+     * `basename` (default) - derive the name from the referenced JSON Pointer
+     *   (its last token), falling back to the referenced file's basename.
+     * `title` - derive Schema Object names from their `title` field, falling
+     *   back to `basename` when no usable title is present.
+     * A custom resolver function - receives the referenced element and reference
+     *   context and returns the base name; collision suffixing is still applied.
+     */
+    componentNamesStrategy: 'basename',
+    /**
+     * Determines how a component rename forced by a name collision with
+     * different content is reported.
+     *
+     * `warn` (default) - append a warning annotation to the parse result.
+     * `off` - rename silently.
+     * `error` - throw a BundleError instead of renaming.
+     */
+    onComponentNameCollision: 'warn',
+    /**
+     * Determines how the bundling process behaves when a reference cannot be
+     * resolved.
+     *
+     * Unlike dereferencing, a swallowed reference is left in place — so the
+     * bundled document may still contain unresolved external references.
+     *
+     * false - fail fast, throw on first error (default)
+     * true - skip unresolvable references silently, continue bundling
+     * (error) => void - callback invoked for each error; if the callback
+     *   itself throws, bundling stops with that error
+     */
+    continueOnError: false
   }
 };
 export default defaultOptions;

package/src/options/util.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.merge = void 0;
 var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");

package/src/parse/index.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var url = _interopRequireWildcard(require("../util/url.cjs"));

package/src/parse/parsers/Parser.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 /**
  * @public

package/src/parse/parsers/apidom-json/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));

package/src/parse/parsers/arazzo-json-1/index.cjs

@@ -1,14 +1,21 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
+Object.defineProperty(exports, "parseSourceDescriptions", {
+  enumerable: true,
+  get: function () {
+    return _sourceDescriptions.parseSourceDescriptions;
+  }
+});
 var _ramda = require("ramda");
 var _apidomParserAdapterArazzoJson = require("@speclynx/apidom-parser-adapter-arazzo-json-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
 var _sourceDescriptions = require("./source-descriptions.cjs");
-exports.parseSourceDescriptions = _sourceDescriptions.parseSourceDescriptions;
 /**
  * @public
  */

package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.parseSourceDescriptions = parseSourceDescriptions;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");

package/src/parse/parsers/arazzo-yaml-1/index.cjs

@@ -1,14 +1,21 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
+Object.defineProperty(exports, "parseSourceDescriptions", {
+  enumerable: true,
+  get: function () {
+    return _sourceDescriptions.parseSourceDescriptions;
+  }
+});
 var _ramda = require("ramda");
 var _apidomParserAdapterArazzoYaml = require("@speclynx/apidom-parser-adapter-arazzo-yaml-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
 var _sourceDescriptions = require("./source-descriptions.cjs");
-exports.parseSourceDescriptions = _sourceDescriptions.parseSourceDescriptions;
 /**
  * @public
  */

package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.parseSourceDescriptions = void 0;
 var _sourceDescriptions = require("../arazzo-json-1/source-descriptions.cjs");
 /**

package/src/parse/parsers/asyncapi-json-2/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterAsyncapiJson = require("@speclynx/apidom-parser-adapter-asyncapi-json-2");

package/src/parse/parsers/asyncapi-yaml-2/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterAsyncapiYaml = require("@speclynx/apidom-parser-adapter-asyncapi-yaml-2");

package/src/parse/parsers/binary/index-browser.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));

package/src/parse/parsers/binary/index-node.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _nodeBuffer = require("node:buffer");
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");

package/src/parse/parsers/json/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterJson = require("@speclynx/apidom-parser-adapter-json");

package/src/parse/parsers/openapi-json-2/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiJson = require("@speclynx/apidom-parser-adapter-openapi-json-2");

package/src/parse/parsers/openapi-json-3-0/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiJson = require("@speclynx/apidom-parser-adapter-openapi-json-3-0");

package/src/parse/parsers/openapi-json-3-1/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiJson = require("@speclynx/apidom-parser-adapter-openapi-json-3-1");

package/src/parse/parsers/openapi-yaml-2/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiYaml = require("@speclynx/apidom-parser-adapter-openapi-yaml-2");

package/src/parse/parsers/openapi-yaml-3-0/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiYaml = require("@speclynx/apidom-parser-adapter-openapi-yaml-3-0");

package/src/parse/parsers/openapi-yaml-3-1/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomParserAdapterOpenapiYaml = require("@speclynx/apidom-parser-adapter-openapi-yaml-3-1");

package/src/parse/parsers/overlay-json-1/extends.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.parseExtends = parseExtends;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomNsOverlay = require("@speclynx/apidom-ns-overlay-1");

package/src/parse/parsers/overlay-json-1/index.cjs

@@ -1,14 +1,21 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
+Object.defineProperty(exports, "parseExtends", {
+  enumerable: true,
+  get: function () {
+    return _extends.parseExtends;
+  }
+});
 var _ramda = require("ramda");
 var _apidomParserAdapterOverlayJson = require("@speclynx/apidom-parser-adapter-overlay-json-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
 var _extends = require("./extends.cjs");
-exports.parseExtends = _extends.parseExtends;
 /**
  * @public
  */

package/src/parse/parsers/overlay-yaml-1/extends.cjs

@@ -1,6 +1,12 @@
 "use strict";
 
-exports.__esModule = true;
-exports.parseExtends = void 0;
-var _extends = require("../overlay-json-1/extends.cjs");
-exports.parseExtends = _extends.parseExtends;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "parseExtends", {
+  enumerable: true,
+  get: function () {
+    return _extends.parseExtends;
+  }
+});
+var _extends = require("../overlay-json-1/extends.cjs");

package/src/parse/parsers/overlay-yaml-1/index.cjs

@@ -1,14 +1,21 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
+Object.defineProperty(exports, "parseExtends", {
+  enumerable: true,
+  get: function () {
+    return _extends.parseExtends;
+  }
+});
 var _ramda = require("ramda");
 var _apidomParserAdapterOverlayYaml = require("@speclynx/apidom-parser-adapter-overlay-yaml-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
 var _extends = require("./extends.cjs");
-exports.parseExtends = _extends.parseExtends;
 /**
  * @public
  */

package/src/parse/parsers/yaml-1-2/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _apidomParserAdapterYaml = require("@speclynx/apidom-parser-adapter-yaml-1-2");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));

package/src/resolve/index.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.resolveApiDOM = exports.default = void 0;
 var _ramda = require("ramda");
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");

package/src/resolve/resolvers/HTTPResolver.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _Resolver = _interopRequireDefault(require("./Resolver.cjs"));
 var url = _interopRequireWildcard(require("../../util/url.cjs"));

package/src/resolve/resolvers/Resolver.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 /**
  * @public

package/src/resolve/resolvers/file/index-browser.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _Resolver = _interopRequireDefault(require("../Resolver.cjs"));
 var _ResolverError = _interopRequireDefault(require("../../../errors/ResolverError.cjs"));

package/src/resolve/resolvers/file/index-node.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _nodeFs = require("node:fs");
 var _nodeUtil = require("node:util");

package/src/resolve/resolvers/http-axios/cache/MemoryCache.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 class MemoryCache {
   maxEntries;

package/src/resolve/resolvers/http-axios/index.cjs

@@ -2,7 +2,9 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");

package/src/resolve/strategies/ResolveStrategy.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 /**
  * @public

package/src/resolve/strategies/apidom/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ResolveStrategy = _interopRequireDefault(require("../ResolveStrategy.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));

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

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ResolveStrategy = _interopRequireDefault(require("../ResolveStrategy.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));