@apidevtools/json-schema-ref-parser 10.0.1 → 11.0.0

package/dist/lib/index.d.ts

@@ -0,0 +1,206 @@
+import $Refs from "./refs.js";
+import { JSONParserError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError } from "./util/errors.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 declare class $RefParser {
+    /**
+     * The parsed (and possibly dereferenced) JSON schema object
+     *
+     * @type {object}
+     * @readonly
+     */
+    schema: JSONSchema | null;
+    /**
+     * The resolved JSON references
+     *
+     * @type {$Refs}
+     * @readonly
+     */
+    $refs: $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.
+     */
+    parse(schema: RefParserSchema): Promise<JSONSchema>;
+    parse(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    parse(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    parse(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    static parse(schema: RefParserSchema): Promise<JSONSchema>;
+    static parse(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    static parse(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static parse(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    static parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static parse(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    /**
+     * *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
+     */
+    resolve(schema: RefParserSchema): Promise<$Refs>;
+    resolve(schema: RefParserSchema, callback: $RefsCallback): Promise<void>;
+    resolve(schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+    resolve(schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+    resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+    resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+    /**
+     * *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
+     */
+    static resolve(schema: RefParserSchema): Promise<$Refs>;
+    static resolve(schema: RefParserSchema, callback: $RefsCallback): Promise<void>;
+    static resolve(schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+    static resolve(schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+    static resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<$Refs>;
+    static resolve(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: $RefsCallback): Promise<void>;
+    /**
+     * 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
+     */
+    static bundle(schema: RefParserSchema): Promise<JSONSchema>;
+    static bundle(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    static bundle(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static bundle(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    static bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<JSONSchema>;
+    /**
+     * 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
+     */
+    bundle(schema: RefParserSchema): Promise<JSONSchema>;
+    bundle(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    bundle(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    bundle(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    bundle(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    /**
+     * 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
+     */
+    static dereference(schema: RefParserSchema): Promise<JSONSchema>;
+    static dereference(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    static dereference(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static dereference(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    static dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    static dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    /**
+     * 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
+     */
+    dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    dereference(schema: RefParserSchema, options: ParserOptions, callback: SchemaCallback): Promise<void>;
+    dereference(schema: RefParserSchema, callback: SchemaCallback): Promise<void>;
+    dereference(baseUrl: string, schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    dereference(schema: RefParserSchema, options: ParserOptions): Promise<JSONSchema>;
+    dereference(schema: RefParserSchema): Promise<JSONSchema>;
+}
+export default $RefParser;
+export declare const parse: typeof $RefParser.parse;
+export declare const resolve: typeof $RefParser.resolve;
+export declare const bundle: typeof $RefParser.bundle;
+export declare const dereference: typeof $RefParser.dereference;

package/dist/lib/index.js

@@ -0,0 +1,206 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dereference = exports.bundle = exports.resolve = exports.parse = exports.$RefParser = exports.UnmatchedResolverError = exports.UnmatchedParserError = exports.ParserError = exports.ResolverError = exports.MissingPointerError = exports.InvalidPointerError = exports.JSONParserError = void 0;
+const refs_js_1 = __importDefault(require("./refs.js"));
+const parse_js_1 = __importDefault(require("./parse.js"));
+const normalize_args_js_1 = __importDefault(require("./normalize-args.js"));
+const resolve_external_js_1 = __importDefault(require("./resolve-external.js"));
+const bundle_js_1 = __importDefault(require("./bundle.js"));
+const dereference_js_1 = __importDefault(require("./dereference.js"));
+const url = __importStar(require("./util/url.js"));
+const errors_js_1 = require("./util/errors.js");
+Object.defineProperty(exports, "JSONParserError", { enumerable: true, get: function () { return errors_js_1.JSONParserError; } });
+Object.defineProperty(exports, "InvalidPointerError", { enumerable: true, get: function () { return errors_js_1.InvalidPointerError; } });
+Object.defineProperty(exports, "MissingPointerError", { enumerable: true, get: function () { return errors_js_1.MissingPointerError; } });
+Object.defineProperty(exports, "ResolverError", { enumerable: true, get: function () { return errors_js_1.ResolverError; } });
+Object.defineProperty(exports, "ParserError", { enumerable: true, get: function () { return errors_js_1.ParserError; } });
+Object.defineProperty(exports, "UnmatchedParserError", { enumerable: true, get: function () { return errors_js_1.UnmatchedParserError; } });
+Object.defineProperty(exports, "UnmatchedResolverError", { enumerable: true, get: function () { return errors_js_1.UnmatchedResolverError; } });
+const ono_1 = require("@jsdevtools/ono");
+const maybe_js_1 = __importDefault(require("./util/maybe.js"));
+/**
+ * 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
+ */
+class $RefParser {
+    constructor() {
+        /**
+         * The parsed (and possibly dereferenced) JSON schema object
+         *
+         * @type {object}
+         * @readonly
+         */
+        this.schema = null;
+        /**
+         * The resolved JSON references
+         *
+         * @type {$Refs}
+         * @readonly
+         */
+        this.$refs = new refs_js_1.default();
+    }
+    async parse() {
+        const args = (0, normalize_args_js_1.default)(arguments);
+        let promise;
+        if (!args.path && !args.schema) {
+            const err = (0, ono_1.ono)(`Expected a file path, URL, or object. Got ${args.path || args.schema}`);
+            return (0, maybe_js_1.default)(args.callback, Promise.reject(err));
+        }
+        // Reset everything
+        this.schema = null;
+        this.$refs = new refs_js_1.default();
+        // 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 = (0, parse_js_1.default)(args.path, this.$refs, args.options);
+        }
+        try {
+            const result = await promise;
+            if (result !== null && typeof result === "object" && !Buffer.isBuffer(result)) {
+                this.schema = result;
+                return (0, maybe_js_1.default)(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 (0, maybe_js_1.default)(args.callback, Promise.resolve(this.schema));
+            }
+            else {
+                throw ono_1.ono.syntax(`"${this.$refs._root$Ref.path || result}" is not a valid JSON Schema`);
+            }
+        }
+        catch (err) {
+            if (!args.options.continueOnError || !(0, errors_js_1.isHandledError)(err)) {
+                return (0, maybe_js_1.default)(args.callback, Promise.reject(err));
+            }
+            if (this.$refs._$refs[url.stripHash(args.path)]) {
+                this.$refs._$refs[url.stripHash(args.path)].addError(err);
+            }
+            return (0, maybe_js_1.default)(args.callback, Promise.resolve(null));
+        }
+    }
+    static parse() {
+        const parser = new $RefParser();
+        return parser.parse.apply(parser, arguments);
+    }
+    /**
+     * 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 = (0, normalize_args_js_1.default)(arguments);
+        try {
+            await this.parse(args.path, args.schema, args.options);
+            await (0, resolve_external_js_1.default)(this, args.options);
+            finalize(this);
+            return (0, maybe_js_1.default)(args.callback, Promise.resolve(this.$refs));
+        }
+        catch (err) {
+            return (0, maybe_js_1.default)(args.callback, Promise.reject(err));
+        }
+    }
+    static resolve() {
+        const instance = new $RefParser();
+        return instance.resolve.apply(instance, arguments);
+    }
+    static bundle() {
+        const instance = new $RefParser();
+        return instance.bundle.apply(instance, arguments);
+    }
+    async bundle() {
+        const args = (0, normalize_args_js_1.default)(arguments);
+        try {
+            await this.resolve(args.path, args.schema, args.options);
+            (0, bundle_js_1.default)(this, args.options);
+            finalize(this);
+            return (0, maybe_js_1.default)(args.callback, Promise.resolve(this.schema));
+        }
+        catch (err) {
+            return (0, maybe_js_1.default)(args.callback, Promise.reject(err));
+        }
+    }
+    static dereference() {
+        const instance = new $RefParser();
+        return instance.dereference.apply(instance, arguments);
+    }
+    async dereference() {
+        const args = (0, normalize_args_js_1.default)(arguments);
+        try {
+            await this.resolve(args.path, args.schema, args.options);
+            (0, dereference_js_1.default)(this, args.options);
+            finalize(this);
+            return (0, maybe_js_1.default)(args.callback, Promise.resolve(this.schema));
+        }
+        catch (err) {
+            return (0, maybe_js_1.default)(args.callback, Promise.reject(err));
+        }
+    }
+}
+exports.$RefParser = $RefParser;
+exports.default = $RefParser;
+function finalize(parser) {
+    const errors = errors_js_1.JSONParserErrorGroup.getParserErrors(parser);
+    if (errors.length > 0) {
+        throw new errors_js_1.JSONParserErrorGroup(parser);
+    }
+}
+exports.parse = $RefParser.parse;
+exports.resolve = $RefParser.resolve;
+exports.bundle = $RefParser.bundle;
+exports.dereference = $RefParser.dereference;

package/dist/lib/normalize-args.d.ts

@@ -0,0 +1,10 @@
+export default normalizeArgs;
+/**
+ * Normalizes the given arguments, accounting for optional args.
+ */
+declare function normalizeArgs(_args: Partial<IArguments>): {
+    path: string;
+    schema: any;
+    options: import("./options.js").default;
+    callback: any;
+};

package/dist/lib/normalize-args.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_js_1 = require("./options.js");
+exports.default = normalizeArgs;
+/**
+ * Normalizes the given arguments, accounting for optional args.
+ */
+function normalizeArgs(_args) {
+    let path, schema, options, callback;
+    const args = Array.prototype.slice.call(_args);
+    if (typeof args[args.length - 1] === "function") {
+        // The last parameter is a callback function
+        callback = args.pop();
+    }
+    if (typeof args[0] === "string") {
+        // The first parameter is the path
+        path = args[0];
+        if (typeof args[2] === "object") {
+            // The second parameter is the schema, and the third parameter is the options
+            schema = args[1];
+            options = args[2];
+        }
+        else {
+            // The second parameter is the options
+            schema = undefined;
+            options = args[1];
+        }
+    }
+    else {
+        // The first parameter is the schema
+        path = "";
+        schema = args[0];
+        options = args[1];
+    }
+    options = (0, options_js_1.getNewOptions)(options);
+    return {
+        path,
+        schema,
+        options,
+        callback,
+    };
+}

package/dist/lib/options.d.ts

@@ -0,0 +1,77 @@
+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;
+    };
+}
+export declare const getNewOptions: (options: DeepPartial<$RefParserOptions>) => $RefParserOptions;
+export type Options = $RefParserOptions;
+export type ParserOptions = DeepPartial<$RefParserOptions>;
+export default $RefParserOptions;

package/dist/lib/options.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNewOptions = void 0;
+const json_js_1 = __importDefault(require("./parsers/json.js"));
+const yaml_js_1 = __importDefault(require("./parsers/yaml.js"));
+const text_js_1 = __importDefault(require("./parsers/text.js"));
+const binary_js_1 = __importDefault(require("./parsers/binary.js"));
+const file_js_1 = __importDefault(require("./resolvers/file.js"));
+const http_js_1 = __importDefault(require("./resolvers/http.js"));
+const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
+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: json_js_1.default,
+            yaml: yaml_js_1.default,
+            text: text_js_1.default,
+            binary: binary_js_1.default,
+        },
+        /**
+         * 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: file_js_1.default,
+            http: http_js_1.default,
+            /**
+             * 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 (0, lodash_clonedeep_1.default)(defaults);
+};
+const getNewOptions = (options) => {
+    const newOptions = getDefaults();
+    if (options) {
+        merge(newOptions, options);
+    }
+    return newOptions;
+};
+exports.getNewOptions = getNewOptions;
+/**
+ * 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, source) {
+    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) {
+    return val && typeof val === "object" && !Array.isArray(val) && !(val instanceof RegExp) && !(val instanceof Date);
+}