@speclynx/apidom-reference 4.10.1 → 4.12.0

package/types/errors/UnresolvableReferenceError.d.ts

@@ -1,7 +1,10 @@
-import DereferenceError from './DereferenceError.ts';
+import ResolveError from './ResolveError.ts';
 /**
+ * Thrown when a reference cannot be resolved. Resolution is shared by the
+ * dereference and bundle components, so this error lives under `ResolveError`.
+ *
  * @public
  */
-declare class UnresolvableReferenceError extends DereferenceError {
+declare class UnresolvableReferenceError extends ResolveError {
 }
 export default UnresolvableReferenceError;

package/types/index.d.ts

@@ -16,6 +16,7 @@ export type { DereferenceStrategyOptions } from './dereference/strategies/Derefe
 export { AncestorLineage as DereferenceAncestorLineage } from './dereference/util.ts';
 export { default as BundleStrategy } from './bundle/strategies/BundleStrategy.ts';
 export type { BundleStrategyOptions } from './bundle/strategies/BundleStrategy.ts';
+export type { ComponentNamesStrategy, ComponentNameResolver, ComponentNameResolverArgs, ComponentNameCollisionSeverity, } from './options/index.ts';
 export { default as options } from './options/index.ts';
 export { merge as mergeOptions } from './options/util.ts';
 export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from './options/index.ts';

package/types/options/index.d.ts

@@ -1,4 +1,4 @@
-import type { RefElement } from '@speclynx/apidom-datamodel';
+import type { RefElement, Element } from '@speclynx/apidom-datamodel';
 import type Parser from '../parse/parsers/Parser.ts';
 import type Resolver from '../resolve/resolvers/Resolver.ts';
 import type ResolveStrategy from '../resolve/strategies/ResolveStrategy.ts';
@@ -40,13 +40,45 @@ export interface ReferenceDereferenceOptions {
     immutable: boolean;
     continueOnError: boolean | ((error: UnresolvableReferenceError) => void);
 }
+/**
+ * Context passed to a custom component-name resolver.
+ *
+ * @public
+ */
+export interface ComponentNameResolverArgs {
+    /** The refracted element being hoisted. */
+    readonly element: Element;
+    /** The Components Object field the element is hoisted into (e.g. `schemas`). */
+    readonly field: string;
+    /** The JSON Pointer of the referenced fragment within its document. */
+    readonly jsonPointer: string;
+    /** The base URI (without hash) of the referenced document. */
+    readonly baseURI: string;
+}
+/**
+ * @public
+ */
+export type ComponentNameResolver = (args: ComponentNameResolverArgs) => string;
+/**
+ * @public
+ */
+export type ComponentNamesStrategy = 'basename' | 'title' | ComponentNameResolver;
+/**
+ * @public
+ */
+export type ComponentNameCollisionSeverity = 'off' | 'warn' | 'error';
 /**
  * @public
  */
 export interface ReferenceBundleOptions {
     strategies: Array<BundleStrategy>;
+    strategyOpts: Record<string, any>;
     refSet: null | ReferenceSet;
     maxDepth: number;
+    immutable: boolean;
+    componentNamesStrategy: ComponentNamesStrategy;
+    onComponentNameCollision: ComponentNameCollisionSeverity;
+    continueOnError: boolean | ((error: UnresolvableReferenceError) => void);
 }
 /**
  * @public