@apidevtools/json-schema-ref-parser 15.0.1 → 15.1.0

package/dist/lib/parse.js

@@ -1,5 +1,5 @@
 import * as url from "./util/url.js";
-import * as plugins from "./util/plugins.js";
+import { filter, all, sort, run } from "./util/plugins.js";
 import { ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError, isHandledError, } from "./util/errors.js";
 /**
  * Reads and parses the specified file path or URL.
@@ -52,12 +52,12 @@ async function parse(path, $refs, options) {
 async function readFile(file, options, $refs) {
     // console.log('Reading %s', file.url);
     // Find the resolvers that can read this file
-    let resolvers = plugins.all(options.resolve);
-    resolvers = plugins.filter(resolvers, "canRead", file);
+    let resolvers = all(options.resolve);
+    resolvers = filter(resolvers, "canRead", file, undefined, $refs);
     // Run the resolvers, in order, until one of them succeeds
-    plugins.sort(resolvers);
+    sort(resolvers);
     try {
-        const data = await plugins.run(resolvers, "read", file, $refs);
+        const data = await run(resolvers, "read", file, $refs);
         return data;
     }
     catch (err) {
@@ -95,13 +95,13 @@ async function parseFile(file, options, $refs) {
     // 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.
     // This handles situations where the file IS a supported type, just with an unknown extension.
-    const allParsers = plugins.all(options.parse);
-    const filteredParsers = plugins.filter(allParsers, "canParse", file);
+    const allParsers = all(options.parse);
+    const filteredParsers = filter(allParsers, "canParse", file);
     const parsers = filteredParsers.length > 0 ? filteredParsers : allParsers;
     // Run the parsers, in order, until one of them succeeds
-    plugins.sort(parsers);
+    sort(parsers);
     try {
-        const parser = await plugins.run(parsers, "parse", file, $refs);
+        const parser = await run(parsers, "parse", file, $refs);
         if (!parser.plugin.allowEmpty && isEmpty(parser.result)) {
             throw new SyntaxError(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`);
         }

package/dist/lib/util/plugins.d.ts

@@ -13,7 +13,7 @@ export declare function all<S extends object = JSONSchema, O extends ParserOptio
 /**
  * Filters the given plugins, returning only the ones return `true` for the given method.
  */
-export declare function filter(plugins: Plugin[], method: any, file: any): Plugin[];
+export declare function filter<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(plugins: Plugin[], method: keyof Plugin | keyof ResolverOptions<S>, file: FileInfo, callback?: (err?: Error, result?: any) => void, $refs?: $Refs<S, O>): Plugin[];
 /**
  * Sorts the given plugins, in place, by their `order` property.
  */

package/dist/lib/util/plugins.js

@@ -17,9 +17,9 @@ export function all(plugins) {
 /**
  * Filters the given plugins, returning only the ones return `true` for the given method.
  */
-export function filter(plugins, method, file) {
+export function filter(plugins, method, file, callback, $refs) {
     return plugins.filter((plugin) => {
-        return !!getResult(plugin, method, file);
+        return !!getResult(plugin, method, file, callback, $refs);
     });
 }
 /**

package/lib/parse.ts

@@ -1,5 +1,5 @@
 import * as url from "./util/url.js";
-import * as plugins from "./util/plugins.js";
+import { filter, all, sort, run } from "./util/plugins.js";
 import {
   ResolverError,
   ParserError,
@@ -77,13 +77,13 @@ async function readFile<S extends object = JSONSchema, O extends ParserOptions<S
   // console.log('Reading %s', file.url);
 
   // Find the resolvers that can read this file
-  let resolvers = plugins.all(options.resolve);
-  resolvers = plugins.filter(resolvers, "canRead", file);
+  let resolvers = all(options.resolve);
+  resolvers = filter(resolvers, "canRead", file, undefined, $refs);
 
   // Run the resolvers, in order, until one of them succeeds
-  plugins.sort(resolvers);
+  sort(resolvers);
   try {
-    const data = await plugins.run(resolvers, "read", file, $refs);
+    const data = await run(resolvers, "read", file, $refs);
     return data;
   } catch (err: any) {
     if (!err && options.continueOnError) {
@@ -123,14 +123,14 @@ async function parseFile<S extends object = JSONSchema, O extends ParserOptions<
   // 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.
   // This handles situations where the file IS a supported type, just with an unknown extension.
-  const allParsers = plugins.all(options.parse);
-  const filteredParsers = plugins.filter(allParsers, "canParse", file);
+  const allParsers = all(options.parse);
+  const filteredParsers = filter(allParsers, "canParse", file);
   const parsers = filteredParsers.length > 0 ? filteredParsers : allParsers;
 
   // Run the parsers, in order, until one of them succeeds
-  plugins.sort(parsers);
+  sort(parsers);
   try {
-    const parser = await plugins.run<S, O>(parsers, "parse", file, $refs);
+    const parser = await run<S, O>(parsers, "parse", file, $refs);
     if (!parser.plugin.allowEmpty && isEmpty(parser.result)) {
       throw new SyntaxError(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`);
     } else {

package/lib/util/plugins.ts

@@ -26,9 +26,15 @@ export function all<S extends object = JSONSchema, O extends ParserOptions<S> =
 /**
  * Filters the given plugins, returning only the ones return `true` for the given method.
  */
-export function filter(plugins: Plugin[], method: any, file: any) {
+export function filter<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  plugins: Plugin[],
+  method: keyof Plugin | keyof ResolverOptions<S>,
+  file: FileInfo,
+  callback?: (err?: Error, result?: any) => void,
+  $refs?: $Refs<S, O>,
+) {
   return plugins.filter((plugin: Plugin) => {
-    return !!getResult(plugin, method, file);
+    return !!getResult(plugin, method, file, callback, $refs);
   });
 }
 
@@ -40,8 +46,8 @@ export function sort(plugins: Plugin[]) {
     plugin.order = plugin.order || Number.MAX_SAFE_INTEGER;
   }
 
-  return plugins.sort((a: any, b: any) => {
-    return a.order - b.order;
+  return plugins.sort((a: Plugin, b: Plugin) => {
+    return a.order! - b.order!;
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "15.0.1",
+  "version": "15.1.0",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "type": "module",
   "types": "dist/lib/index.d.ts",