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

package/lib/types/index.ts

@@ -7,17 +7,21 @@ 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 SchemaCallback<S extends object = JSONSchema> = (err: Error | null, schema?: S | object | null) => any;
+export type $RefsCallback<S extends object = 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
  */
 
-export interface HTTPResolverOptions<S extends JSONSchema = JSONSchema> extends Partial<ResolverOptions<S>> {
+export interface HTTPResolverOptions<S extends object = JSONSchema> extends Partial<ResolverOptions<S>> {
   /**
    * You can specify any HTTP headers that should be sent when downloading files. For example, some servers may require you to set the `Accept` or `Referrer` header.
    */
@@ -44,7 +48,7 @@ export interface HTTPResolverOptions<S extends JSONSchema = JSONSchema> extends
  *
  * See https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html
  */
-export interface ResolverOptions<S extends JSONSchema = JSONSchema> {
+export interface ResolverOptions<S extends object = JSONSchema> {
   name?: string;
   /**
    * All resolvers have an order property, even the built-in resolvers. If you don't specify an order property, then your resolver will run last. Specifying `order: 1`, like we did in this example, will make your resolver run first. Or you can squeeze your resolver in-between some of the built-in resolvers. For example, `order: 101` would make it run after the file resolver, but before the HTTP resolver. You can see the order of all the built-in resolvers by looking at their source code.

package/lib/util/errors.ts

@@ -38,8 +38,8 @@ export class JSONParserError extends Error {
 }
 
 export class JSONParserErrorGroup<
-  S extends JSONSchema = JSONSchema,
-  O extends ParserOptions = ParserOptions,
+  S extends object = JSONSchema,
+  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 object = 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);
   }
 }
 

package/lib/util/plugins.ts

@@ -1,5 +1,5 @@
 import type { FileInfo, JSONSchema } from "../types/index.js";
-import type $RefParserOptions from "../options.js";
+import type { ParserOptions } from "../options.js";
 import type { ResolverOptions } from "../types/index.js";
 import type $Refs from "../refs.js";
 import type { Plugin } from "../types/index.js";
@@ -10,14 +10,16 @@ import type { Plugin } from "../types/index.js";
  *
  * @returns
  */
-export function all<S extends JSONSchema = JSONSchema>(plugins: $RefParserOptions<S>["resolve"]): Plugin[] {
-  return Object.keys(plugins)
+export function all<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  plugins: O["resolve"],
+): Plugin[] {
+  return (Object.keys(plugins || {}) as (keyof ResolverOptions<S>)[])
     .filter((key) => {
-      return typeof plugins[key] === "object";
+      return typeof plugins![key] === "object";
     })
     .map((key) => {
-      (plugins[key] as ResolverOptions<S>)!.name = key;
-      return plugins[key] as Plugin;
+      (plugins![key] as ResolverOptions<S>)!.name = key;
+      return plugins![key] as Plugin;
     });
 }
 
@@ -43,7 +45,7 @@ export function sort(plugins: Plugin[]) {
   });
 }
 
-export interface PluginResult<S extends JSONSchema = JSONSchema> {
+export interface PluginResult<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   plugin: Plugin;
   result?: string | Buffer | S;
   error?: any;
@@ -57,17 +59,17 @@ export interface PluginResult<S extends JSONSchema = JSONSchema> {
  * If the promise rejects, or the callback is called with an error, then the next plugin is called.
  * If ALL plugins fail, then the last error is thrown.
  */
-export async function run<S extends JSONSchema = JSONSchema>(
+export async function run<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   plugins: Plugin[],
   method: keyof Plugin | keyof ResolverOptions<S>,
   file: FileInfo,
-  $refs: $Refs<S>,
+  $refs: $Refs<S, O>,
 ) {
   let plugin: Plugin;
-  let lastError: PluginResult<S>;
+  let lastError: PluginResult<S, O>;
   let index = 0;
 
-  return new Promise<PluginResult<S>>((resolve, reject) => {
+  return new Promise<PluginResult<S, O>>((resolve, reject) => {
     runNextPlugin();
 
     function runNextPlugin() {
@@ -94,7 +96,7 @@ export async function run<S extends JSONSchema = JSONSchema>(
       }
     }
 
-    function callback(err: PluginResult<S>["error"], result: PluginResult<S>["result"]) {
+    function callback(err: PluginResult<S, O>["error"], result: PluginResult<S, O>["result"]) {
       if (err) {
         onError(err);
       } else {
@@ -102,7 +104,7 @@ export async function run<S extends JSONSchema = JSONSchema>(
       }
     }
 
-    function onSuccess(result: PluginResult<S>["result"]) {
+    function onSuccess(result: PluginResult<S, O>["result"]) {
       // console.log('    success');
       resolve({
         plugin,
@@ -110,7 +112,7 @@ export async function run<S extends JSONSchema = JSONSchema>(
       });
     }
 
-    function onError(error: PluginResult<S>["error"]) {
+    function onError(error: PluginResult<S, O>["error"]) {
       // console.log('    %s', err.message || err);
       lastError = {
         plugin,
@@ -127,12 +129,12 @@ export async function run<S extends JSONSchema = JSONSchema>(
  * If the value is a RegExp, then it will be tested against the file URL.
  * If the value is an array, then it will be compared against the file extension.
  */
-function getResult<S extends JSONSchema = JSONSchema>(
+function getResult<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
   obj: Plugin,
   prop: keyof Plugin | keyof ResolverOptions<S>,
   file: FileInfo,
   callback?: (err?: Error, result?: any) => void,
-  $refs?: any,
+  $refs?: $Refs<S, O>,
 ) {
   const value = obj[prop as keyof typeof obj] as unknown;
 

package/package.json

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