@speclynx/apidom-reference 5.2.4 → 5.2.6

package/types/dereference/strategies/openapi-3-1/visitor.d.ts

@@ -1,5 +1,6 @@
 import { Element } from '@speclynx/apidom-datamodel';
 import { type Path } from '@speclynx/apidom-traverse';
+import { type Schema$idIndex } from './selectors/uri.ts';
 import Reference from '../../../Reference.ts';
 import { AncestorLineage } from '../../util.ts';
 import type { ReferenceOptions } from '../../../options/index.ts';
@@ -11,8 +12,10 @@ export interface OpenAPI3_1DereferenceVisitorOptions {
     readonly options: ReferenceOptions;
     readonly indirections?: Element[];
     readonly refractCache?: WeakMap<Element, Element>;
+    readonly schema$idIndex?: Schema$idIndex;
     readonly ancestors?: AncestorLineage<Element>;
     readonly visited?: WeakSet<Element>;
+    readonly ancestorSchema$ids?: string[];
 }
 /**
  * @public
@@ -22,14 +25,27 @@ declare class OpenAPI3_1DereferenceVisitor {
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
     protected readonly refractCache: WeakMap<Element, Element>;
+    /**
+     * Index of `$id`-bearing schemas per document, shared across nested visitors
+     * of a single dereference run so it never outlives mutations of the documents.
+     */
+    protected readonly schema$idIndex: Schema$idIndex;
     protected readonly visited: WeakSet<Element>;
+    /**
+     * `$id`s of the JSON Schema elements enclosing the traversal root within its
+     * document (outermost first). Empty when the root is the document itself; a
+     * nested visitor traversing a fragment is seeded with the `$id`s of the
+     * schemas the fragment sits under, so the `$ref`s and `$id`s within resolve
+     * against the same base as they would from the document root.
+     */
+    protected readonly ancestorSchema$ids: string[];
     /**
      * Tracks element ancestors across dive-deep traversal boundaries.
      * Used for cycle detection: if a referenced element is found in
      * the ancestor lineage, a circular reference is detected.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, refractCache, ancestors, visited, }: OpenAPI3_1DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, refractCache, schema$idIndex, ancestors, visited, ancestorSchema$ids, }: OpenAPI3_1DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;

package/types/util/url.d.ts

@@ -96,6 +96,16 @@ export declare const cwd: () => string;
  * @public
  */
 export declare const resolve: (from: string, to: string) => string;
+/**
+ * Computes the URI reference that resolves to `to` against `from` — the inverse
+ * of `resolve`: `resolve(from, relative(from, to)) === to`. The reference is
+ * relative to the directory of `from` (its last path segment is the document,
+ * not a directory). When the two URIs differ in scheme or authority, or either
+ * has no hierarchical path (e.g. a URN), no relative form exists and `to` is
+ * returned unchanged.
+ * @public
+ */
+export declare const relative: (from: string, to: string) => string;
 /**
  * Sanitizes/Encodes URI to it's url encoded form.
  *