@apidevtools/json-schema-ref-parser 10.0.0 → 10.1.0

package/lib/index.ts

@@ -0,0 +1,413 @@
+import $Refs from "./refs.js";
+import _parse from "./parse.js";
+import normalizeArgs from "./normalize-args.js";
+import resolveExternal from "./resolve-external.js";
+import _bundle from "./bundle.js";
+import _dereference from "./dereference.js";
+import * as url from "./util/url.js";
+import {
+  JSONParserError,
+  InvalidPointerError,
+  MissingPointerError,
+  ResolverError,
+  ParserError,
+  UnmatchedParserError,
+  UnmatchedResolverError,
+  isHandledError,
+  JSONParserErrorGroup,
+} from "./util/errors.js";
+import { ono } from "@jsdevtools/ono";
+import maybe from "./util/maybe.js";
+import type { ParserOptions } from "./options.js";
+import type { $RefsCallback, JSONSchema, SchemaCallback } from "./types/index.js";
+
+export { JSONParserError };
+export { InvalidPointerError };
+export { MissingPointerError };
+export { ResolverError };
+export { ParserError };
+export { UnmatchedParserError };
+export { UnmatchedResolverError };
+
+type RefParserSchema = string | JSONSchema;
+
+/**
+ * This class parses a JSON schema, builds a map of its JSON references and their resolved values,
+ * and provides methods for traversing, manipulating, and dereferencing those references.
+ *
+ * @class
+ */
+export class $RefParser {
+  /**
+   * The parsed (and possibly dereferenced) JSON schema object
+   *
+   * @type {object}
+   * @readonly
+   */
+  public schema: JSONSchema | null = null;
+
+  /**
+   * The resolved JSON references
+   *
+   * @type {$Refs}
+   * @readonly
+   */
+  $refs = new $Refs();
+
+  /**
+   * Parses the given JSON schema.
+   * This method does not resolve any JSON references.
+   * It just reads a single file in JSON or YAML format, and parse it as a JavaScript object.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed
+   * @param [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
+   * @returns - The returned promise resolves with the parsed JSON schema object.
+   */
+  public parse(schema: RefParserSchema): Promise<JSONSchema>;
+  public parse(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public parse(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public parse(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public parse(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<void>;
+
+  async parse() {
+    const args = normalizeArgs(arguments as any);
+    let promise;
+
+    if (!args.path && !args.schema) {
+      const err = ono(`Expected a file path, URL, or object. Got ${args.path || args.schema}`);
+      return maybe(args.callback, Promise.reject(err));
+    }
+
+    // Reset everything
+    this.schema = null;
+    this.$refs = new $Refs();
+
+    // If the path is a filesystem path, then convert it to a URL.
+    // NOTE: According to the JSON Reference spec, these should already be URLs,
+    // but, in practice, many people use local filesystem paths instead.
+    // So we're being generous here and doing the conversion automatically.
+    // This is not intended to be a 100% bulletproof solution.
+    // If it doesn't work for your use-case, then use a URL instead.
+    let pathType = "http";
+    if (url.isFileSystemPath(args.path)) {
+      args.path = url.fromFileSystemPath(args.path);
+      pathType = "file";
+    }
+
+    // Resolve the absolute path of the schema
+    args.path = url.resolve(url.cwd(), args.path);
+
+    if (args.schema && typeof args.schema === "object") {
+      // A schema object was passed-in.
+      // So immediately add a new $Ref with the schema object as its value
+      const $ref = this.$refs._add(args.path);
+      $ref.value = args.schema;
+      $ref.pathType = pathType;
+      promise = Promise.resolve(args.schema);
+    } else {
+      // Parse the schema file/url
+      promise = _parse(args.path, this.$refs, args.options);
+    }
+
+    try {
+      const result = await promise;
+
+      if (result !== null && typeof result === "object" && !Buffer.isBuffer(result)) {
+        this.schema = result;
+        return maybe(args.callback, Promise.resolve(this.schema!));
+      } else if (args.options.continueOnError) {
+        this.schema = null; // it's already set to null at line 79, but let's set it again for the sake of readability
+        return maybe(args.callback, Promise.resolve(this.schema!));
+      } else {
+        throw ono.syntax(`"${this.$refs._root$Ref.path || result}" is not a valid JSON Schema`);
+      }
+    } catch (err) {
+      if (!args.options.continueOnError || !isHandledError(err)) {
+        return maybe(args.callback, Promise.reject(err));
+      }
+
+      if (this.$refs._$refs[url.stripHash(args.path)]) {
+        this.$refs._$refs[url.stripHash(args.path)].addError(err);
+      }
+
+      return maybe(args.callback, Promise.resolve(null));
+    }
+  }
+
+  public static parse(schema: RefParserSchema): Promise<JSONSchema>;
+  public static parse(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public static parse(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static parse(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public static parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static parse(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<void>;
+  public static parse(): Promise<JSONSchema> | Promise<void> {
+    const parser = new $RefParser();
+    return parser.parse.apply(parser, arguments as any);
+  }
+
+  /**
+   * *This method is used internally by other methods, such as `bundle` and `dereference`. You probably won't need to call this method yourself.*
+   *
+   * Resolves all JSON references (`$ref` pointers) in the given JSON Schema file. If it references any other files/URLs, then they will be downloaded and resolved as well. This method **does not** dereference anything. It simply gives you a `$Refs` object, which is a map of all the resolved references and their values.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#resolveschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive a `$Refs` object
+   */
+  public resolve(schema: RefParserSchema): Promise<$Refs>;
+  public resolve(schema: RefParserSchema, callback: $RefsCallback): Promise<void>;
+  public resolve(schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+  public resolve(schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+  public resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+  public resolve(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: $RefsCallback,
+  ): Promise<void>;
+  /**
+   * Parses the given JSON schema and resolves any JSON references, including references in
+   * externally-referenced files.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed and resolved
+   * @param [callback]
+   * - An error-first callback. The second parameter is a {@link $Refs} object containing the resolved JSON references
+   *
+   * @returns
+   * The returned promise resolves with a {@link $Refs} object containing the resolved JSON references
+   */
+  async resolve() {
+    const args = normalizeArgs(arguments);
+
+    try {
+      await this.parse(args.path, args.schema, args.options);
+      await resolveExternal(this, args.options);
+      finalize(this);
+      return maybe(args.callback, Promise.resolve(this.$refs));
+    } catch (err) {
+      return maybe(args.callback, Promise.reject(err));
+    }
+  }
+
+  /**
+   * *This method is used internally by other methods, such as `bundle` and `dereference`. You probably won't need to call this method yourself.*
+   *
+   * Resolves all JSON references (`$ref` pointers) in the given JSON Schema file. If it references any other files/URLs, then they will be downloaded and resolved as well. This method **does not** dereference anything. It simply gives you a `$Refs` object, which is a map of all the resolved references and their values.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#resolveschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive a `$Refs` object
+   */
+  public static resolve(schema: RefParserSchema): Promise<$Refs>;
+  public static resolve(schema: RefParserSchema, callback: $RefsCallback): Promise<void>;
+  public static resolve(schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+  public static resolve(schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+  public static resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+  public static resolve(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: $RefsCallback,
+  ): Promise<void>;
+  static resolve(): Promise<JSONSchema> | Promise<void> {
+    const instance = new $RefParser();
+    return instance.resolve.apply(instance, arguments as any);
+  }
+
+  /**
+   * Parses the given JSON schema, resolves any JSON references, and bundles all external references
+   * into the main JSON schema. This produces a JSON schema that only has *internal* references,
+   * not any *external* references.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+   * @param [callback] - An error-first callback. The second parameter is the bundled JSON schema object
+   * @returns - The returned promise resolves with the bundled JSON schema object.
+   */
+  /**
+   * Bundles all referenced files/URLs into a single schema that only has internal `$ref` pointers. This lets you split-up your schema however you want while you're building it, but easily combine all those files together when it's time to package or distribute the schema to other people. The resulting schema size will be small, since it will still contain internal JSON references rather than being fully-dereferenced.
+   *
+   * This also eliminates the risk of circular references, so the schema can be safely serialized using `JSON.stringify()`.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundleschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive the bundled schema object
+   */
+  public static bundle(schema: RefParserSchema): Promise<JSONSchema>;
+  public static bundle(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public static bundle(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static bundle(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public static bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static bundle(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<JSONSchema>;
+  static bundle(): Promise<JSONSchema> | Promise<void> {
+    const instance = new $RefParser();
+    return instance.bundle.apply(instance, arguments as any);
+  }
+
+  /**
+   * Parses the given JSON schema, resolves any JSON references, and bundles all external references
+   * into the main JSON schema. This produces a JSON schema that only has *internal* references,
+   * not any *external* references.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+   * @param [callback] - An error-first callback. The second parameter is the bundled JSON schema object
+   * @returns - The returned promise resolves with the bundled JSON schema object.
+   */
+  /**
+   * Bundles all referenced files/URLs into a single schema that only has internal `$ref` pointers. This lets you split-up your schema however you want while you're building it, but easily combine all those files together when it's time to package or distribute the schema to other people. The resulting schema size will be small, since it will still contain internal JSON references rather than being fully-dereferenced.
+   *
+   * This also eliminates the risk of circular references, so the schema can be safely serialized using `JSON.stringify()`.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundleschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive the bundled schema object
+   */
+  public bundle(schema: RefParserSchema): Promise<JSONSchema>;
+  public bundle(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public bundle(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public bundle(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public bundle(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<void>;
+  async bundle() {
+    const args = normalizeArgs(arguments);
+    try {
+      await this.resolve(args.path, args.schema, args.options);
+      _bundle(this, args.options);
+      finalize(this);
+      return maybe(args.callback, Promise.resolve(this.schema!));
+    } catch (err) {
+      return maybe(args.callback, Promise.reject(err));
+    }
+  }
+
+  /**
+   * Parses the given JSON schema, resolves any JSON references, and dereferences the JSON schema.
+   * That is, all JSON references are replaced with their resolved values.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+   * @param [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
+   * @returns - The returned promise resolves with the dereferenced JSON schema object.
+   */
+  /**
+   * Dereferences all `$ref` pointers in the JSON Schema, replacing each reference with its resolved value. This results in a schema object that does not contain any `$ref` pointers. Instead, it's a normal JavaScript object tree that can easily be crawled and used just like any other JavaScript object. This is great for programmatic usage, especially when using tools that don't understand JSON references.
+   *
+   * The dereference method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object. Again, this is great for programmatic usage, but it does introduce the risk of circular references, so be careful if you intend to serialize the schema using `JSON.stringify()`. Consider using the bundle method instead, which does not create circular references.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferenceschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive the dereferenced schema object
+   */
+  public static dereference(schema: RefParserSchema): Promise<JSONSchema>;
+  public static dereference(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public static dereference(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static dereference(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public static dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public static dereference(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<void>;
+  static dereference(): Promise<JSONSchema> | Promise<void> {
+    const instance = new $RefParser();
+    return instance.dereference.apply(instance, arguments as any);
+  }
+
+  /**
+   * Parses the given JSON schema, resolves any JSON references, and dereferences the JSON schema.
+   * That is, all JSON references are replaced with their resolved values.
+   *
+   * @param [path] - The file path or URL of the JSON schema
+   * @param [schema] - A JSON schema object. This object will be used instead of reading from `path`.
+   * @param [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+   * @param [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
+   * @returns - The returned promise resolves with the dereferenced JSON schema object.
+   */
+  /**
+   * Dereferences all `$ref` pointers in the JSON Schema, replacing each reference with its resolved value. This results in a schema object that does not contain any `$ref` pointers. Instead, it's a normal JavaScript object tree that can easily be crawled and used just like any other JavaScript object. This is great for programmatic usage, especially when using tools that don't understand JSON references.
+   *
+   * The dereference method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object. Again, this is great for programmatic usage, but it does introduce the risk of circular references, so be careful if you intend to serialize the schema using `JSON.stringify()`. Consider using the bundle method instead, which does not create circular references.
+   *
+   * See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferenceschema-options-callback
+   *
+   * @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
+   * @param options (optional)
+   * @param callback (optional) A callback that will receive the dereferenced schema object
+   */
+  public dereference(
+    baseUrl: string,
+    schema: RefParserSchema,
+    options: ParserOptions,
+    callback: SchemaCallback,
+  ): Promise<void>;
+  public dereference(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+  public dereference(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+  public dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public dereference(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+  public dereference(schema: RefParserSchema): Promise<JSONSchema>;
+  async dereference() {
+    const args = normalizeArgs(arguments);
+
+    try {
+      await this.resolve(args.path, args.schema, args.options);
+      _dereference(this, args.options);
+      finalize(this);
+      return maybe(args.callback, Promise.resolve(this.schema));
+    } catch (err) {
+      return maybe(args.callback, Promise.reject(err));
+    }
+  }
+}
+export default $RefParser;
+
+function finalize(parser: any) {
+  const errors = JSONParserErrorGroup.getParserErrors(parser);
+  if (errors.length > 0) {
+    throw new JSONParserErrorGroup(parser);
+  }
+}
+
+export const parse = $RefParser.parse;
+export const resolve = $RefParser.resolve;
+export const bundle = $RefParser.bundle;
+export const dereference = $RefParser.dereference;

package/lib/{normalize-args.js → normalize-args.ts}

@@ -1,16 +1,13 @@
-import Options from "./options.js";
+import { getNewOptions } from "./options.js";
 
 export default normalizeArgs;
 
 /**
  * Normalizes the given arguments, accounting for optional args.
- *
- * @param {Arguments} args
- * @returns {object}
  */
-function normalizeArgs (args) {
+function normalizeArgs(_args: Partial<IArguments>) {
   let path, schema, options, callback;
-  args = Array.prototype.slice.call(args);
+  const args = Array.prototype.slice.call(_args) as any[];
 
   if (typeof args[args.length - 1] === "function") {
     // The last parameter is a callback function
@@ -24,28 +21,24 @@ function normalizeArgs (args) {
       // The second parameter is the schema, and the third parameter is the options
       schema = args[1];
       options = args[2];
-    }
-    else {
+    } else {
       // The second parameter is the options
       schema = undefined;
       options = args[1];
     }
-  }
-  else {
+  } else {
     // The first parameter is the schema
     path = "";
     schema = args[0];
     options = args[1];
   }
 
-  if (!(options instanceof Options)) {
-    options = new Options(options);
-  }
+  options = getNewOptions(options);
 
   return {
     path,
     schema,
     options,
-    callback
+    callback,
   };
 }

package/lib/options.ts

@@ -0,0 +1,202 @@
+import jsonParser from "./parsers/json.js";
+import yamlParser from "./parsers/yaml.js";
+import textParser from "./parsers/text.js";
+import binaryParser from "./parsers/binary.js";
+import fileResolver from "./resolvers/file.js";
+import httpResolver from "./resolvers/http.js";
+import cloneDeep from "lodash.clonedeep";
+
+import type { HTTPResolverOptions, JSONSchemaObject, Plugin, ResolverOptions } from "./types/index.js";
+
+type DeepPartial<T> = T extends object
+  ? {
+      [P in keyof T]?: DeepPartial<T[P]>;
+    }
+  : T;
+/**
+ * Options that determine how JSON schemas are parsed, resolved, and dereferenced.
+ *
+ * @param [options] - Overridden options
+ * @class
+ */
+interface $RefParserOptions {
+  /**
+   * The `parse` options determine how different types of files will be parsed.
+   *
+   * JSON Schema `$Ref` Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add your own custom parsers if you want.
+   */
+  parse: {
+    json?: Plugin | boolean;
+    yaml?: Plugin | boolean;
+    binary?: Plugin | boolean;
+    text?: (Plugin & { encoding?: string }) | boolean;
+    [key: string]: Plugin | boolean | undefined;
+  };
+
+  /**
+   * The `resolve` options control how JSON Schema $Ref Parser will resolve file paths and URLs, and how those files will be read/downloaded.
+   *
+   * JSON Schema `$Ref` Parser comes with built-in support for HTTP and HTTPS, as well as support for local files (when running in Node.js). You can configure or disable either of these built-in resolvers. You can also add your own custom resolvers if you want.
+   */
+  resolve: {
+    /**
+     * Determines whether external $ref pointers will be resolved. If this option is disabled, then external `$ref` pointers will simply be ignored.
+     */
+    external?: boolean;
+    file?: Partial<ResolverOptions> | boolean;
+    http?: HTTPResolverOptions | boolean;
+  } & {
+    [key: string]: Partial<ResolverOptions> | HTTPResolverOptions | boolean | undefined;
+  };
+
+  /**
+   * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+   * causes it to keep processing as much as possible and then throw a single error that contains all errors
+   * that were encountered.
+   */
+  continueOnError: boolean;
+
+  /**
+   * The `dereference` options control how JSON Schema `$Ref` Parser will dereference `$ref` pointers within the JSON schema.
+   */
+  dereference: {
+    /**
+     * Determines whether circular `$ref` pointers are handled.
+     *
+     * If set to `false`, then a `ReferenceError` will be thrown if the schema contains any circular references.
+     *
+     * If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the `$Refs.circular` property will still be set to `true`.
+     */
+    circular?: boolean | "ignore";
+
+    /**
+     * A function, called for each path, which can return true to stop this path and all
+     * subpaths from being dereferenced further. This is useful in schemas where some
+     * subpaths contain literal $ref keys that should not be dereferenced.
+     */
+    excludedPathMatcher?(path: string): boolean;
+
+    /**
+     * Callback invoked during dereferencing.
+     *
+     * @argument {string} path The path being dereferenced (ie. the `$ref` string).
+     * @argument {JSONSchemaObject} object The JSON-Schema that the `$ref` resolved to.
+     */
+    onDereference?(path: string, value: JSONSchemaObject): void;
+  };
+}
+
+const getDefaults = () => {
+  const defaults = {
+    /**
+     * Determines how different types of files will be parsed.
+     *
+     * You can add additional parsers of your own, replace an existing one with
+     * your own implementation, or disable any parser by setting it to false.
+     */
+    parse: {
+      json: jsonParser,
+      yaml: yamlParser,
+      text: textParser,
+      binary: binaryParser,
+    },
+
+    /**
+     * Determines how JSON References will be resolved.
+     *
+     * You can add additional resolvers of your own, replace an existing one with
+     * your own implementation, or disable any resolver by setting it to false.
+     */
+    resolve: {
+      file: fileResolver,
+      http: httpResolver,
+
+      /**
+       * Determines whether external $ref pointers will be resolved.
+       * If this option is disabled, then none of above resolvers will be called.
+       * Instead, external $ref pointers will simply be ignored.
+       *
+       * @type {boolean}
+       */
+      external: true,
+    },
+
+    /**
+     * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+     * causes it to keep processing as much as possible and then throw a single error that contains all errors
+     * that were encountered.
+     */
+    continueOnError: false,
+
+    /**
+     * Determines the types of JSON references that are allowed.
+     */
+    dereference: {
+      /**
+       * Dereference circular (recursive) JSON references?
+       * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
+       * If "ignore", then circular references will not be dereferenced.
+       *
+       * @type {boolean|string}
+       */
+      circular: true,
+
+      /**
+       * A function, called for each path, which can return true to stop this path and all
+       * subpaths from being dereferenced further. This is useful in schemas where some
+       * subpaths contain literal $ref keys that should not be dereferenced.
+       *
+       * @type {function}
+       */
+      excludedPathMatcher: () => false,
+    },
+  };
+  return cloneDeep(defaults);
+};
+
+export const getNewOptions = (options: DeepPartial<$RefParserOptions>): $RefParserOptions => {
+  const newOptions = getDefaults();
+  if (options) {
+    merge(newOptions, options);
+  }
+  return newOptions;
+};
+export type Options = $RefParserOptions;
+export type ParserOptions = DeepPartial<$RefParserOptions>;
+/**
+ * Merges the properties of the source object into the target object.
+ *
+ * @param target - The object that we're populating
+ * @param source - The options that are being merged
+ * @returns
+ */
+function merge(target: any, source: any) {
+  if (isMergeable(source)) {
+    const keys = Object.keys(source);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const sourceSetting = source[key];
+      const targetSetting = target[key];
+
+      if (isMergeable(sourceSetting)) {
+        // It's a nested object, so merge it recursively
+        target[key] = merge(targetSetting || {}, sourceSetting);
+      } else if (sourceSetting !== undefined) {
+        // It's a scalar value, function, or array. No merging necessary. Just overwrite the target value.
+        target[key] = sourceSetting;
+      }
+    }
+  }
+  return target;
+}
+/**
+ * Determines whether the given value can be merged,
+ * or if it is a scalar value that should just override the target value.
+ *
+ * @param val
+ * @returns
+ */
+function isMergeable(val: any) {
+  return val && typeof val === "object" && !Array.isArray(val) && !(val instanceof RegExp) && !(val instanceof Date);
+}
+export default $RefParserOptions;