@apidevtools/json-schema-ref-parser 11.5.2 → 11.5.3

package/lib/index.ts

@@ -37,7 +37,7 @@ export type RefParserSchema = string | JSONSchema;
  *
  * @class
  */
-export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions> {
+export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   /**
    * The parsed (and possibly dereferenced) JSON schema object
    *
@@ -52,7 +52,7 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
    * @type {$Refs}
    * @readonly
    */
-  $refs = new $Refs<S>();
+  $refs = new $Refs<S, O>();
 
   /**
    * Parses the given JSON schema.
@@ -143,32 +143,34 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
     }
   }
 
-  public static parse<S extends JSONSchema = JSONSchema>(schema: S | string): Promise<S>;
-  public static parse<S extends JSONSchema = JSONSchema>(
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+    schema: S | string,
+  ): Promise<S>;
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>():
+  public static parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>():
     | Promise<S>
     | Promise<void> {
     const parser = new $RefParser<S, O>();
@@ -186,12 +188,12 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
    * @param options (optional)
    * @param callback (optional) A callback that will receive a `$Refs` object
    */
-  public resolve(schema: S | string): Promise<$Refs<S>>;
-  public resolve(schema: S | string, callback: $RefsCallback<S>): Promise<void>;
-  public resolve(schema: S | string, options: O): Promise<$Refs<S>>;
-  public resolve(schema: S | string, options: O, callback: $RefsCallback<S>): Promise<void>;
-  public resolve(baseUrl: string, schema: S | string, options: O): Promise<$Refs<S>>;
-  public resolve(baseUrl: string, schema: S | string, options: O, callback: $RefsCallback<S>): Promise<void>;
+  public resolve(schema: S | string): Promise<$Refs<S, O>>;
+  public resolve(schema: S | string, callback: $RefsCallback<S, O>): Promise<void>;
+  public resolve(schema: S | string, options: O): Promise<$Refs<S, O>>;
+  public resolve(schema: S | string, options: O, callback: $RefsCallback<S, O>): Promise<void>;
+  public resolve(baseUrl: string, schema: S | string, options: O): Promise<$Refs<S, O>>;
+  public resolve(baseUrl: string, schema: S | string, options: O, callback: $RefsCallback<S, O>): Promise<void>;
   async resolve() {
     const args = normalizeArgs<S, O>(arguments);
 
@@ -216,32 +218,34 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
    * @param options (optional)
    * @param callback (optional) A callback that will receive a `$Refs` object
    */
-  public static resolve<S extends JSONSchema = JSONSchema>(schema: S | string): Promise<$Refs<S>>;
-  public static resolve<S extends JSONSchema = JSONSchema>(
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+    schema: S | string,
+  ): Promise<$Refs<S, O>>;
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
-    callback: $RefsCallback<S>,
+    callback: $RefsCallback<S, O>,
   ): Promise<void>;
-  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
-  ): Promise<$Refs<S>>;
-  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  ): Promise<$Refs<S, O>>;
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
-    callback: $RefsCallback<S>,
+    callback: $RefsCallback<S, O>,
   ): Promise<void>;
-  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
-  ): Promise<$Refs<S>>;
-  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  ): Promise<$Refs<S, O>>;
+  public static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
-    callback: $RefsCallback<S>,
+    callback: $RefsCallback<S, O>,
   ): Promise<void>;
-  static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>():
+  static resolve<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>():
     | Promise<S>
     | Promise<void> {
     const instance = new $RefParser<S, O>();
@@ -259,34 +263,34 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
    * @param options (optional)
    * @param callback (optional) A callback that will receive the bundled schema object
    */
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
   ): Promise<S>;
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<S>;
-  static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>():
+  static bundle<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>():
     | Promise<S>
     | Promise<void> {
     const instance = new $RefParser<S, O>();
@@ -333,34 +337,34 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
    * @param options (optional)
    * @param callback (optional) A callback that will receive the dereferenced schema object
    */
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
   ): Promise<S>;
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
   ): Promise<S>;
-  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  public static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     baseUrl: string,
     schema: S | string,
     options: O,
     callback: SchemaCallback<S>,
   ): Promise<void>;
-  static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>():
+  static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>():
     | Promise<S>
     | Promise<void> {
     const instance = new $RefParser<S, O>();
@@ -400,7 +404,7 @@ export class $RefParser<S extends JSONSchema = JSONSchema, O extends ParserOptio
 }
 export default $RefParser;
 
-function finalize<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+function finalize<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   parser: $RefParser<S, O>,
 ) {
   const errors = JSONParserErrorGroup.getParserErrors(parser);

package/lib/normalize-args.ts

@@ -4,21 +4,21 @@ import type { JSONSchema, SchemaCallback } from "./types";
 
 // I really dislike this function and the way it's written. It's not clear what it's doing, and it's way too flexible
 // In the future, I'd like to deprecate the api and accept only named parameters in index.ts
-export interface NormalizedArguments<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions> {
+export interface NormalizedArguments<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   path: string;
   schema: S;
-  options: O & Options;
+  options: O & Options<S>;
   callback: SchemaCallback<S>;
 }
 /**
  * Normalizes the given arguments, accounting for optional args.
  */
-export function normalizeArgs<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+export function normalizeArgs<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   _args: Partial<IArguments>,
 ): NormalizedArguments<S, O> {
   let path;
   let schema;
-  let options: Options & O;
+  let options: Options<S> & O;
   let callback;
   const args = Array.prototype.slice.call(_args) as any[];
 

package/lib/options.ts

@@ -174,7 +174,7 @@ export const getJsonSchemaRefParserDefaultOptions = () => {
   return defaults;
 };
 
-export const getNewOptions = <S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+export const getNewOptions = <S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   options: O | undefined,
 ): O & $RefParserOptions<S> => {
   const newOptions = getJsonSchemaRefParserDefaultOptions();
@@ -183,8 +183,9 @@ export const getNewOptions = <S extends JSONSchema = JSONSchema, O extends Parse
   }
   return newOptions as O & $RefParserOptions<S>;
 };
-export type Options = $RefParserOptions<JSONSchema>;
-export type ParserOptions = DeepPartial<$RefParserOptions<JSONSchema>>;
+
+export type Options<S extends JSONSchema = JSONSchema> = $RefParserOptions<S>;
+export type ParserOptions<S extends JSONSchema = JSONSchema> = DeepPartial<$RefParserOptions<S>>;
 /**
  * Merges the properties of the source object into the target object.
  *

package/lib/parse.ts

@@ -9,15 +9,15 @@ import {
   isHandledError,
 } from "./util/errors.js";
 import type $Refs from "./refs.js";
-import type { Options } from "./options.js";
+import type { ParserOptions } from "./options.js";
 import type { FileInfo, JSONSchema } from "./types/index.js";
 
 /**
  * Reads and parses the specified file path or URL.
  */
-async function parse<S extends JSONSchema = JSONSchema, O extends Options = Options>(
+async function parse<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   path: string,
-  $refs: $Refs<S>,
+  $refs: $Refs<S, O>,
   options: O,
 ) {
   // Remove the URL fragment, if any
@@ -70,10 +70,10 @@ async function parse<S extends JSONSchema = JSONSchema, O extends Options = Opti
  * @returns
  * The promise resolves with the raw file contents and the resolver that was used.
  */
-async function readFile<S extends JSONSchema = JSONSchema, O extends Options = Options>(
+async function readFile<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   file: FileInfo,
   options: O,
-  $refs: $Refs<S>,
+  $refs: $Refs<S, O>,
 ): Promise<any> {
   // console.log('Reading %s', file.url);
 
@@ -116,10 +116,10 @@ async function readFile<S extends JSONSchema = JSONSchema, O extends Options = O
  * @returns
  * The promise resolves with the parsed file contents and the parser that was used.
  */
-async function parseFile<S extends JSONSchema = JSONSchema, O extends Options = Options>(
+async function parseFile<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   file: FileInfo,
   options: O,
-  $refs: $Refs<S>,
+  $refs: $Refs<S, O>,
 ) {
   // Find the parsers that can read this file type.
   // If none of the parsers are an exact match for this file, then we'll try ALL of them.
@@ -131,7 +131,7 @@ async function parseFile<S extends JSONSchema = JSONSchema, O extends Options =
   // Run the parsers, in order, until one of them succeeds
   plugins.sort(parsers);
   try {
-    const parser = await plugins.run<S>(parsers, "parse", file, $refs);
+    const parser = await plugins.run<S, O>(parsers, "parse", file, $refs);
     if (!parser.plugin.allowEmpty && isEmpty(parser.result)) {
       throw ono.syntax(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`);
     } else {

package/lib/pointer.ts

@@ -1,4 +1,4 @@
-import type $RefParserOptions from "./options.js";
+import type { ParserOptions } from "./options.js";
 
 import $Ref from "./ref.js";
 import * as url from "./util/url.js";
@@ -26,11 +26,11 @@ const safeDecodeURIComponent = (encodedURIComponent: string): string => {
  * @param [friendlyPath] - The original user-specified path (used for error messages)
  * @class
  */
-class Pointer<S extends JSONSchema = JSONSchema> {
+class Pointer<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   /**
    * The {@link $Ref} object that contains this {@link Pointer} object.
    */
-  $ref: $Ref<S>;
+  $ref: $Ref<S, O>;
 
   /**
    * The file path or URL, containing the JSON pointer in the hash.
@@ -59,7 +59,7 @@ class Pointer<S extends JSONSchema = JSONSchema> {
    */
   indirections: number;
 
-  constructor($ref: $Ref<S>, path: string, friendlyPath?: string) {
+  constructor($ref: $Ref<S, O>, path: string, friendlyPath?: string) {
     this.$ref = $ref;
 
     this.path = path;
@@ -86,7 +86,7 @@ class Pointer<S extends JSONSchema = JSONSchema> {
    * the {@link Pointer#$ref} and {@link Pointer#path} will reflect the resolution path
    * of the resolved value.
    */
-  resolve(obj: any, options?: $RefParserOptions<S>, pathFromRoot?: string) {
+  resolve(obj: any, options?: O, pathFromRoot?: string) {
     const tokens = Pointer.parse(this.path, this.originalPath);
 
     // Crawl the object, one token at a time
@@ -144,7 +144,7 @@ class Pointer<S extends JSONSchema = JSONSchema> {
    * @returns
    * Returns the modified object, or an entirely new object if the entire object is overwritten.
    */
-  set(obj: any, value: any, options?: $RefParserOptions<S>) {
+  set(obj: any, value: any, options?: O) {
     const tokens = Pointer.parse(this.path);
     let token;
 

package/lib/ref.ts

@@ -3,7 +3,6 @@ import type { JSONParserError, MissingPointerError, ParserError, ResolverError }
 import { InvalidPointerError, isHandledError, normalizeError } from "./util/errors.js";
 import { safePointerToPath, stripHash, getHash } from "./util/url.js";
 import type $Refs from "./refs.js";
-import type $RefParserOptions from "./options.js";
 import type { ParserOptions } from "./options.js";
 import type { JSONSchema } from "./types";
 
@@ -14,7 +13,7 @@ export type $RefError = JSONParserError | ResolverError | ParserError | MissingP
  *
  * @class
  */
-class $Ref<S extends JSONSchema = JSONSchema> {
+class $Ref<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   /**
    * The file path or URL of the referenced file.
    * This path is relative to the path of the main JSON schema file.
@@ -40,7 +39,7 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    *
    * @type {$Refs}
    */
-  $refs: $Refs<S>;
+  $refs: $Refs<S, O>;
 
   /**
    * Indicates the type of {@link $Ref#path} (e.g. "file", "http", etc.)
@@ -52,7 +51,7 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    */
   errors: Array<$RefError> = [];
 
-  constructor($refs: $Refs<S>) {
+  constructor($refs: $Refs<S, O>) {
     this.$refs = $refs;
   }
 
@@ -88,7 +87,7 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    * @param options
    * @returns
    */
-  exists(path: string, options?: $RefParserOptions<S>) {
+  exists(path: string, options?: O) {
     try {
       this.resolve(path, options);
       return true;
@@ -104,7 +103,7 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    * @param options
    * @returns - Returns the resolved value
    */
-  get(path: string, options?: $RefParserOptions<S>) {
+  get(path: string, options?: O) {
     return this.resolve(path, options)?.value;
   }
 
@@ -117,8 +116,8 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    * @param pathFromRoot - The path of `obj` from the schema root
    * @returns
    */
-  resolve(path: string, options?: $RefParserOptions<S>, friendlyPath?: string, pathFromRoot?: string) {
-    const pointer = new Pointer<S>(this, path, friendlyPath);
+  resolve(path: string, options?: O, friendlyPath?: string, pathFromRoot?: string) {
+    const pointer = new Pointer<S, O>(this, path, friendlyPath);
     try {
       return pointer.resolve(this.value, options, pathFromRoot);
     } catch (err: any) {
@@ -186,7 +185,7 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    * @param options
    * @returns
    */
-  static isAllowed$Ref(value: unknown, options?: ParserOptions) {
+  static isAllowed$Ref<S extends JSONSchema = JSONSchema>(value: unknown, options?: ParserOptions<S>) {
     if (this.is$Ref(value)) {
       if (value.$ref.substring(0, 2) === "#/" || value.$ref === "#") {
         // It's a JSON Pointer reference, which is always allowed
@@ -267,7 +266,10 @@ class $Ref<S extends JSONSchema = JSONSchema> {
    * @param resolvedValue - The resolved value, which can be any type
    * @returns - Returns the dereferenced value
    */
-  static dereference<S extends JSONSchema = JSONSchema>($ref: $Ref<S>, resolvedValue: S): S {
+  static dereference<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+    $ref: $Ref<S, O>,
+    resolvedValue: S,
+  ): S {
     if (resolvedValue && typeof resolvedValue === "object" && $Ref.isExtended$Ref($ref)) {
       const merged = {};
       for (const key of Object.keys($ref)) {

package/lib/refs.ts

@@ -2,12 +2,12 @@ import { ono } from "@jsdevtools/ono";
 import $Ref from "./ref.js";
 import * as url from "./util/url.js";
 import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
-import type $RefParserOptions from "./options.js";
+import type { ParserOptions } from "./options.js";
 import convertPathToPosix from "./util/convert-path-to-posix";
 import type { JSONSchema } from "./types";
 
-interface $RefsMap<S extends JSONSchema = JSONSchema> {
-  [url: string]: $Ref<S>;
+interface $RefsMap<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
+  [url: string]: $Ref<S, O>;
 }
 /**
  * When you call the resolve method, the value that gets passed to the callback function (or Promise) is a $Refs object. This same object is accessible via the parser.$refs property of $RefParser objects.
@@ -16,7 +16,7 @@ interface $RefsMap<S extends JSONSchema = JSONSchema> {
  *
  * See https://apitools.dev/json-schema-ref-parser/docs/refs.html
  */
-export default class $Refs<S extends JSONSchema = JSONSchema> {
+export default class $Refs<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   /**
    * This property is true if the schema contains any circular references. You may want to check this property before serializing the dereferenced schema as JSON, since JSON.stringify() does not support circular references by default.
    *
@@ -84,7 +84,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
    * @param [options]
    * @returns - Returns the resolved value
    */
-  get(path: string, options?: $RefParserOptions<S>): JSONSchema4Type | JSONSchema6Type | JSONSchema7Type {
+  get(path: string, options?: O): JSONSchema4Type | JSONSchema6Type | JSONSchema7Type {
     return this._resolve(path, "", options)!.value;
   }
 
@@ -112,7 +112,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
    * @returns
    * @protected
    */
-  _get$Ref(path: any) {
+  _get$Ref(path: string) {
     path = url.resolve(this._root$Ref.path!, path);
     const withoutHash = url.stripHash(path);
     return this._$refs[withoutHash];
@@ -126,7 +126,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
   _add(path: string) {
     const withoutHash = url.stripHash(path);
 
-    const $ref = new $Ref<S>(this);
+    const $ref = new $Ref<S, O>(this);
     $ref.path = withoutHash;
 
     this._$refs[withoutHash] = $ref;
@@ -144,7 +144,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
    * @returns
    * @protected
    */
-  _resolve(path: string, pathFromRoot: string, options?: any) {
+  _resolve(path: string, pathFromRoot: string, options?: O) {
     const absPath = url.resolve(this._root$Ref.path!, path);
     const withoutHash = url.stripHash(absPath);
     const $ref = this._$refs[withoutHash];
@@ -162,7 +162,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
    * @type {object}
    * @protected
    */
-  _$refs: $RefsMap<S> = {};
+  _$refs: $RefsMap<S, O> = {};
 
   /**
    * The {@link $Ref} object that is the root of the JSON schema.
@@ -170,7 +170,7 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
    * @type {$Ref}
    * @protected
    */
-  _root$Ref: $Ref<S>;
+  _root$Ref: $Ref<S, O>;
 
   constructor() {
     /**
@@ -215,7 +215,10 @@ export default class $Refs<S extends JSONSchema = JSONSchema> {
  * @param [types] - Only return paths of the given types ("file", "http", etc.)
  * @returns
  */
-function getPaths<S extends JSONSchema = JSONSchema>($refs: $RefsMap<S>, types: string[]) {
+function getPaths<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  $refs: $RefsMap<S, O>,
+  types: string[],
+) {
   let paths = Object.keys($refs);
 
   // Filter the paths by type

package/lib/resolve-external.ts

@@ -4,7 +4,7 @@ import parse from "./parse.js";
 import * as url from "./util/url.js";
 import { isHandledError } from "./util/errors.js";
 import type $Refs from "./refs.js";
-import type { Options, ParserOptions } from "./options.js";
+import type { ParserOptions } from "./options.js";
 import type { JSONSchema } from "./types/index.js";
 import type $RefParser from "./index.js";
 
@@ -18,11 +18,11 @@ import type $RefParser from "./index.js";
  * The promise resolves once all JSON references in the schema have been resolved,
  * including nested references that are contained in externally-referenced files.
  */
-function resolveExternal<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+function resolveExternal<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   parser: $RefParser<S, O>,
-  options: Options,
+  options: O,
 ) {
-  if (!options.resolve.external) {
+  if (!options.resolve?.external) {
     // Nothing to resolve, so exit early
     return Promise.resolve();
   }
@@ -52,11 +52,11 @@ function resolveExternal<S extends JSONSchema = JSONSchema, O extends ParserOpti
  * If any of the JSON references point to files that contain additional JSON references,
  * then the corresponding promise will internally reference an array of promises.
  */
-function crawl<S extends JSONSchema = JSONSchema>(
+function crawl<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   obj: string | Buffer | S | undefined | null,
   path: string,
-  $refs: $Refs<S>,
-  options: Options,
+  $refs: $Refs<S, O>,
+  options: O,
   seen?: Set<any>,
   external?: boolean,
 ) {
@@ -66,7 +66,7 @@ function crawl<S extends JSONSchema = JSONSchema>(
   if (obj && typeof obj === "object" && !ArrayBuffer.isView(obj) && !seen.has(obj)) {
     seen.add(obj); // Track previously seen objects to avoid infinite recursion
     if ($Ref.isExternal$Ref(obj)) {
-      promises.push(resolve$Ref<S>(obj, path, $refs, options));
+      promises.push(resolve$Ref<S, O>(obj, path, $refs, options));
     }
 
     const keys = Object.keys(obj) as string[];
@@ -92,13 +92,13 @@ function crawl<S extends JSONSchema = JSONSchema>(
  * The promise resolves once all JSON references in the object have been resolved,
  * including nested references that are contained in externally-referenced files.
  */
-async function resolve$Ref<S extends JSONSchema = JSONSchema>(
+async function resolve$Ref<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   $ref: S,
   path: string,
-  $refs: $Refs<S>,
-  options: Options,
+  $refs: $Refs<S, O>,
+  options: O,
 ) {
-  const shouldResolveOnCwd = options.dereference.externalReferenceResolution === "root";
+  const shouldResolveOnCwd = options.dereference?.externalReferenceResolution === "root";
   const resolvedPath = url.resolve(shouldResolveOnCwd ? url.cwd() : path, $ref.$ref!);
   const withoutHash = url.stripHash(resolvedPath);
 

package/lib/types/index.ts

@@ -7,11 +7,15 @@ import type {
   JSONSchema7Object,
 } from "json-schema";
 import type $Refs from "../refs.js";
+import type { ParserOptions } from "../options";
 
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
 export type JSONSchemaObject = JSONSchema4Object | JSONSchema6Object | JSONSchema7Object;
 export type SchemaCallback<S extends JSONSchema = JSONSchema> = (err: Error | null, schema?: S | object | null) => any;
-export type $RefsCallback<S extends JSONSchema = JSONSchema> = (err: Error | null, $refs?: $Refs<S>) => any;
+export type $RefsCallback<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> = (
+  err: Error | null,
+  $refs?: $Refs<S, O>,
+) => any;
 
 /**
  * See https://apitools.dev/json-schema-ref-parser/docs/options.html

package/lib/util/errors.ts

@@ -39,7 +39,7 @@ export class JSONParserError extends Error {
 
 export class JSONParserErrorGroup<
   S extends JSONSchema = JSONSchema,
-  O extends ParserOptions = ParserOptions,
+  O extends ParserOptions<S> = ParserOptions<S>,
 > extends Error {
   files: $RefParser<S, O>;
 
@@ -55,12 +55,12 @@ export class JSONParserErrorGroup<
     Ono.extend(this);
   }
 
-  static getParserErrors<S extends JSONSchema = JSONSchema, O extends ParserOptions = ParserOptions>(
+  static getParserErrors<S extends JSONSchema = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
     parser: $RefParser<S, O>,
   ) {
     const errors = [];
 
-    for (const $ref of Object.values(parser.$refs._$refs) as $Ref<S>[]) {
+    for (const $ref of Object.values(parser.$refs._$refs) as $Ref<S, O>[]) {
       if ($ref.errors) {
         errors.push(...$ref.errors);
       }
@@ -78,7 +78,7 @@ export class JSONParserErrorGroup<
     | UnmatchedParserError
     | UnmatchedResolverError
   > {
-    return JSONParserErrorGroup.getParserErrors<S>(this.files);
+    return JSONParserErrorGroup.getParserErrors<S, O>(this.files);
   }
 }