@apidevtools/json-schema-ref-parser 11.4.0 → 11.4.1

package/dist/lib/index.d.ts

@@ -1,15 +1,8 @@
 import $Refs from "./refs.js";
-import { JSONParserError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError } from "./util/errors.js";
+import { JSONParserError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError, isHandledError, JSONParserErrorGroup } 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;
+export 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.
@@ -204,3 +197,4 @@ 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;
+export { UnmatchedResolverError, JSONParserError, JSONSchema, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, ParserOptions, $RefsCallback, isHandledError, JSONParserErrorGroup, SchemaCallback, };

package/dist/lib/index.js

@@ -26,7 +26,7 @@ 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;
+exports.JSONParserErrorGroup = exports.isHandledError = exports.UnmatchedParserError = exports.ParserError = exports.ResolverError = exports.MissingPointerError = exports.InvalidPointerError = exports.JSONParserError = exports.UnmatchedResolverError = exports.dereference = exports.bundle = exports.resolve = exports.parse = exports.$RefParser = 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"));
@@ -42,6 +42,8 @@ Object.defineProperty(exports, "ResolverError", { enumerable: true, get: functio
 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; } });
+Object.defineProperty(exports, "isHandledError", { enumerable: true, get: function () { return errors_js_1.isHandledError; } });
+Object.defineProperty(exports, "JSONParserErrorGroup", { enumerable: true, get: function () { return errors_js_1.JSONParserErrorGroup; } });
 const ono_1 = require("@jsdevtools/ono");
 const maybe_js_1 = __importDefault(require("./util/maybe.js"));
 /**

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

@@ -1,10 +1,13 @@
+import type { JSONSchema, SchemaCallback } from "./types";
+import type $RefParserOptions from "./options";
 export default normalizeArgs;
+export interface NormalizedArguments {
+    path: string;
+    schema: JSONSchema;
+    options: $RefParserOptions;
+    callback: SchemaCallback;
+}
 /**
  * Normalizes the given arguments, accounting for optional args.
  */
-declare function normalizeArgs(_args: Partial<IArguments>): {
-    path: string;
-    schema: any;
-    options: any;
-    callback: any;
-};
+declare function normalizeArgs(_args: Partial<IArguments>): NormalizedArguments;

package/dist/lib/normalize-args.js

@@ -36,9 +36,9 @@ function normalizeArgs(_args) {
         options = (0, options_js_1.getNewOptions)(options);
     }
     catch (e) {
-        console.log(e);
+        console.error(`JSON Schema Ref Parser: Error normalizing options: ${e}`);
     }
-    if (!options.mutateInputSchema) {
+    if (!options.mutateInputSchema && typeof schema === "object") {
         // Make a deep clone of the schema, so that we don't alter the original object
         schema = JSON.parse(JSON.stringify(schema));
     }

package/dist/lib/options.d.ts

@@ -1,5 +1,5 @@
 import type { HTTPResolverOptions, JSONSchemaObject, Plugin, ResolverOptions } from "./types/index.js";
-type DeepPartial<T> = T extends object ? {
+export type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 /**
@@ -8,7 +8,7 @@ type DeepPartial<T> = T extends object ? {
  * @param [options] - Overridden options
  * @class
  */
-interface $RefParserOptions {
+export interface $RefParserOptions {
     /**
      * The `parse` options determine how different types of files will be parsed.
      *
@@ -85,7 +85,8 @@ interface $RefParserOptions {
         mutateInputSchema?: boolean;
     };
 }
-export declare const getNewOptions: (options: DeepPartial<$RefParserOptions>) => $RefParserOptions;
+export declare const getJsonSchemaRefParserDefaultOptions: () => $RefParserOptions;
+export declare const getNewOptions: (options: DeepPartial<$RefParserOptions> | undefined) => $RefParserOptions;
 export type Options = $RefParserOptions;
 export type ParserOptions = DeepPartial<$RefParserOptions>;
 export default $RefParserOptions;

package/dist/lib/options.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNewOptions = void 0;
+exports.getNewOptions = exports.getJsonSchemaRefParserDefaultOptions = 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 getDefaults = () => {
+const getJsonSchemaRefParserDefaultOptions = () => {
     const defaults = {
         /**
          * Determines how different types of files will be parsed.
@@ -74,8 +74,9 @@ const getDefaults = () => {
     };
     return defaults;
 };
+exports.getJsonSchemaRefParserDefaultOptions = getJsonSchemaRefParserDefaultOptions;
 const getNewOptions = (options) => {
-    const newOptions = getDefaults();
+    const newOptions = (0, exports.getJsonSchemaRefParserDefaultOptions)();
     if (options) {
         merge(newOptions, options);
     }

package/dist/lib/types/index.d.ts

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

package/lib/index.ts

@@ -21,15 +21,7 @@ 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;
+export type RefParserSchema = string | JSONSchema;
 
 /**
  * This class parses a JSON schema, builds a map of its JSON references and their resolved values,
@@ -76,7 +68,6 @@ export class $RefParser {
     options: ParserOptions,
     callback: SchemaCallback,
   ): Promise<void>;
-
   async parse() {
     const args = normalizeArgs(arguments as any);
     let promise;
@@ -418,3 +409,19 @@ export const parse = $RefParser.parse;
 export const resolve = $RefParser.resolve;
 export const bundle = $RefParser.bundle;
 export const dereference = $RefParser.dereference;
+
+export {
+  UnmatchedResolverError,
+  JSONParserError,
+  JSONSchema,
+  InvalidPointerError,
+  MissingPointerError,
+  ResolverError,
+  ParserError,
+  UnmatchedParserError,
+  ParserOptions,
+  $RefsCallback,
+  isHandledError,
+  JSONParserErrorGroup,
+  SchemaCallback,
+};

package/lib/normalize-args.ts

@@ -1,11 +1,21 @@
 import { getNewOptions } from "./options.js";
+import type { JSONSchema, SchemaCallback } from "./types";
+import type $RefParserOptions from "./options";
 
 export default normalizeArgs;
 
+// 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 {
+  path: string;
+  schema: JSONSchema;
+  options: $RefParserOptions;
+  callback: SchemaCallback;
+}
 /**
  * Normalizes the given arguments, accounting for optional args.
  */
-function normalizeArgs(_args: Partial<IArguments>) {
+function normalizeArgs(_args: Partial<IArguments>): NormalizedArguments {
   let path, schema, options, callback;
   const args = Array.prototype.slice.call(_args) as any[];
 
@@ -36,10 +46,10 @@ function normalizeArgs(_args: Partial<IArguments>) {
   try {
     options = getNewOptions(options);
   } catch (e) {
-    console.log(e);
+    console.error(`JSON Schema Ref Parser: Error normalizing options: ${e}`);
   }
 
-  if (!options.mutateInputSchema) {
+  if (!options.mutateInputSchema && typeof schema === "object") {
     // Make a deep clone of the schema, so that we don't alter the original object
     schema = JSON.parse(JSON.stringify(schema));
   }

package/lib/options.ts

@@ -7,7 +7,7 @@ import httpResolver from "./resolvers/http.js";
 
 import type { HTTPResolverOptions, JSONSchemaObject, Plugin, ResolverOptions } from "./types/index.js";
 
-type DeepPartial<T> = T extends object
+export type DeepPartial<T> = T extends object
   ? {
       [P in keyof T]?: DeepPartial<T[P]>;
     }
@@ -18,7 +18,7 @@ type DeepPartial<T> = T extends object
  * @param [options] - Overridden options
  * @class
  */
-interface $RefParserOptions {
+export interface $RefParserOptions {
   /**
    * The `parse` options determine how different types of files will be parsed.
    *
@@ -101,7 +101,7 @@ interface $RefParserOptions {
   };
 }
 
-const getDefaults = () => {
+export const getJsonSchemaRefParserDefaultOptions = () => {
   const defaults = {
     /**
      * Determines how different types of files will be parsed.
@@ -172,8 +172,8 @@ const getDefaults = () => {
   return defaults;
 };
 
-export const getNewOptions = (options: DeepPartial<$RefParserOptions>): $RefParserOptions => {
-  const newOptions = getDefaults();
+export const getNewOptions = (options: DeepPartial<$RefParserOptions> | undefined): $RefParserOptions => {
+  const newOptions = getJsonSchemaRefParserDefaultOptions();
   if (options) {
     merge(newOptions, options);
   }

package/lib/types/index.ts

@@ -10,7 +10,7 @@ import type $Refs from "../refs.js";
 
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
 export type JSONSchemaObject = JSONSchema4Object | JSONSchema6Object | JSONSchema7Object;
-export type SchemaCallback = (err: Error | null, schema?: JSONSchema | object) => any;
+export type SchemaCallback = (err: Error | null, schema?: JSONSchema | object | null) => any;
 export type $RefsCallback = (err: Error | null, $refs?: $Refs) => any;
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "11.4.0",
+  "version": "11.4.1",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",