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

package/dist/lib/resolvers/http.js

@@ -0,0 +1,159 @@
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ono_1 = require("@jsdevtools/ono");
+const url = __importStar(require("../util/url.js"));
+const errors_js_1 = require("../util/errors.js");
+exports.default = {
+    /**
+     * The order that this resolver will run, in relation to other resolvers.
+     */
+    order: 200,
+    /**
+     * HTTP headers to send when downloading files.
+     *
+     * @example:
+     * {
+     *   "User-Agent": "JSON Schema $Ref Parser",
+     *   Accept: "application/json"
+     * }
+     */
+    headers: null,
+    /**
+     * HTTP request timeout (in milliseconds).
+     */
+    timeout: 5000,
+    /**
+     * The maximum number of HTTP redirects to follow.
+     * To disable automatic following of redirects, set this to zero.
+     */
+    redirects: 5,
+    /**
+     * The `withCredentials` option of XMLHttpRequest.
+     * Set this to `true` if you're downloading files from a CORS-enabled server that requires authentication
+     */
+    withCredentials: false,
+    /**
+     * Determines whether this resolver can read a given file reference.
+     * Resolvers that return true will be tried in order, until one successfully resolves the file.
+     * Resolvers that return false will not be given a chance to resolve the file.
+     */
+    canRead(file) {
+        return url.isHttp(file.url);
+    },
+    /**
+     * Reads the given URL and returns its raw contents as a Buffer.
+     */
+    read(file) {
+        const u = url.parse(file.url);
+        if (typeof window !== "undefined" && !u.protocol) {
+            // Use the protocol of the current page
+            u.protocol = url.parse(location.href).protocol;
+        }
+        return download(u, this);
+    },
+};
+/**
+ * Downloads the given file.
+ * @returns
+ * The promise resolves with the raw downloaded data, or rejects if there is an HTTP error.
+ */
+function download(u, httpOptions, _redirects) {
+    return __awaiter(this, void 0, void 0, function* () {
+        u = url.parse(u);
+        const redirects = _redirects || [];
+        redirects.push(u.href);
+        try {
+            const res = yield get(u, httpOptions);
+            if (res.status >= 400) {
+                throw (0, ono_1.ono)({ status: res.status }, `HTTP ERROR ${res.status}`);
+            }
+            else if (res.status >= 300) {
+                if (!Number.isNaN(httpOptions.redirects) && redirects.length > httpOptions.redirects) {
+                    throw new errors_js_1.ResolverError((0, ono_1.ono)({ status: res.status }, `Error downloading ${redirects[0]}. \nToo many redirects: \n  ${redirects.join(" \n  ")}`));
+                }
+                else if (!("location" in res.headers) || !res.headers.location) {
+                    throw (0, ono_1.ono)({ status: res.status }, `HTTP ${res.status} redirect with no location header`);
+                }
+                else {
+                    const redirectTo = url.resolve(u, res.headers.location);
+                    return download(redirectTo, httpOptions, redirects);
+                }
+            }
+            else {
+                if (res.body) {
+                    const buf = yield res.arrayBuffer();
+                    return Buffer.from(buf);
+                }
+                return Buffer.alloc(0);
+            }
+        }
+        catch (err) {
+            throw new errors_js_1.ResolverError((0, ono_1.ono)(err, `Error downloading ${u.href}`), u.href);
+        }
+    });
+}
+/**
+ * Sends an HTTP GET request.
+ * The promise resolves with the HTTP Response object.
+ */
+function get(u, httpOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let controller;
+        let timeoutId;
+        if (httpOptions.timeout) {
+            controller = new AbortController();
+            timeoutId = setTimeout(() => controller.abort(), httpOptions.timeout);
+        }
+        if (!global.fetch) {
+            const { default: fetch, Request, Headers } = yield Promise.resolve().then(() => __importStar(require("node-fetch")));
+            // @ts-ignore
+            global.fetch = fetch;
+            // @ts-ignore
+            global.Request = Request;
+            // @ts-ignore
+            global.Headers = Headers;
+        }
+        const response = yield fetch(u, {
+            method: "GET",
+            headers: httpOptions.headers || {},
+            credentials: httpOptions.withCredentials ? "include" : "same-origin",
+            signal: controller ? controller.signal : null,
+        });
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        return response;
+    });
+}

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

@@ -0,0 +1,104 @@
+/// <reference types="node" />
+import type { JSONSchema4, JSONSchema4Object, JSONSchema6, JSONSchema6Object, JSONSchema7, JSONSchema7Object } from "json-schema";
+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 $RefsCallback = (err: Error | null, $refs?: $Refs) => any;
+/**
+ * See https://apitools.dev/json-schema-ref-parser/docs/options.html
+ */
+export interface HTTPResolverOptions extends Partial<ResolverOptions> {
+    /**
+     * 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.
+     */
+    headers?: HeadersInit | null;
+    /**
+     * The amount of time (in milliseconds) to wait for a response from the server when downloading files. The default is 5 seconds.
+     */
+    timeout?: number;
+    /**
+     * The maximum number of HTTP redirects to follow per file. The default is 5. To disable automatic following of redirects, set this to zero.
+     */
+    redirects?: number;
+    /**
+     * Set this to `true` if you're downloading files from a CORS-enabled server that requires authentication
+     */
+    withCredentials?: boolean;
+}
+/**
+ * JSON Schema `$Ref` Parser comes with built-in resolvers for HTTP and HTTPS URLs, as well as local filesystem paths (when running in Node.js). You can add your own custom resolvers to support additional protocols, or even replace any of the built-in resolvers with your own custom implementation.
+ *
+ * See https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html
+ */
+export interface ResolverOptions {
+    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.
+     *
+     * The order property and canRead property are related to each other. For each file that JSON Schema $Ref Parser needs to resolve, it first determines which resolvers can read that file by checking their canRead property. If only one resolver matches a file, then only that one resolver is called, regardless of its order. If multiple resolvers match a file, then those resolvers are tried in order until one of them successfully reads the file. Once a resolver successfully reads the file, the rest of the resolvers are skipped.
+     */
+    order?: number;
+    /**
+     * The `canRead` property tells JSON Schema `$Ref` Parser what kind of files your resolver can read. In this example, we've simply specified a regular expression that matches "mogodb://" URLs, but we could have used a simple boolean, or even a function with custom logic to determine which files to resolve. Here are examples of each approach:
+     */
+    canRead: boolean | RegExp | string | string[] | ((file: FileInfo) => boolean);
+    /**
+     * This is where the real work of a resolver happens. The `read` method accepts the same file info object as the `canRead` function, but rather than returning a boolean value, the `read` method should return the contents of the file. The file contents should be returned in as raw a form as possible, such as a string or a byte array. Any further parsing or processing should be done by parsers.
+     *
+     * Unlike the `canRead` function, the `read` method can also be asynchronous. This might be important if your resolver needs to read data from a database or some other external source. You can return your asynchronous value using either an ES6 Promise or a Node.js-style error-first callback. Of course, if your resolver has the ability to return its data synchronously, then that's fine too. Here are examples of all three approaches:
+     */
+    read: string | object | ((file: FileInfo, callback?: (error: Error | null, data: string | null) => any) => string | Buffer | JSONSchema | Promise<string | Buffer | JSONSchema>);
+}
+export interface Plugin {
+    name?: string;
+    /**
+     * Parsers run in a specific order, relative to other parsers. For example, a parser with `order: 5` will run before a parser with `order: 10`. If a parser is unable to successfully parse a file, then the next parser is tried, until one succeeds or they all fail.
+     *
+     * You can change the order in which parsers run, which is useful if you know that most of your referenced files will be a certain type, or if you add your own custom parser that you want to run first.
+     */
+    order?: number;
+    /**
+     * All of the built-in parsers allow empty files by default. The JSON and YAML parsers will parse empty files as `undefined`. The text parser will parse empty files as an empty string. The binary parser will parse empty files as an empty byte array.
+     *
+     * You can set `allowEmpty: false` on any parser, which will cause an error to be thrown if a file empty.
+     */
+    allowEmpty?: boolean;
+    /**
+     * The encoding that the text is expected to be in.
+     */
+    encoding?: BufferEncoding;
+    /**
+     * Determines which parsers will be used for which files.
+     *
+     * A regular expression can be used to match files by their full path. A string (or array of strings) can be used to match files by their file extension. Or a function can be used to perform more complex matching logic. See the custom parser docs for details.
+     */
+    canParse?: boolean | RegExp | string | string[] | ((file: FileInfo) => boolean);
+    /**
+     * This is where the real work of a parser happens. The `parse` method accepts the same file info object as the `canParse` function, but rather than returning a boolean value, the `parse` method should return a JavaScript representation of the file contents.  For our CSV parser, that is a two-dimensional array of lines and values.  For your parser, it might be an object, a string, a custom class, or anything else.
+     *
+     * Unlike the `canParse` function, the `parse` method can also be asynchronous. This might be important if your parser needs to retrieve data from a database or if it relies on an external HTTP service to return the parsed value.  You can return your asynchronous value via a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) or a Node.js-style error-first callback.  Here are examples of both approaches:
+     */
+    parse: ((file: FileInfo, callback?: (error: Error | null, data: string | null) => any) => unknown | Promise<unknown>) | number | string;
+}
+/**
+ * JSON Schema `$Ref` Parser supports plug-ins, such as resolvers and parsers. These plug-ins can have methods such as `canRead()`, `read()`, `canParse()`, and `parse()`. All of these methods accept the same object as their parameter: an object containing information about the file being read or parsed.
+ *
+ * The file info object currently only consists of a few properties, but it may grow in the future if plug-ins end up needing more information.
+ *
+ * See https://apitools.dev/json-schema-ref-parser/docs/plugins/file-info-object.html
+ */
+export interface FileInfo {
+    /**
+     * The full URL of the file. This could be any type of URL, including "http://", "https://", "file://", "ftp://", "mongodb://", or even a local filesystem path (when running in Node.js).
+     */
+    url: string;
+    /**
+     * The lowercase file extension, such as ".json", ".yaml", ".txt", etc.
+     */
+    extension: string;
+    /**
+     * The raw file contents, in whatever form they were returned by the resolver that read the file.
+     */
+    data: string | Buffer;
+}

package/dist/lib/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,50 @@
+import type $RefParser from "../index.js";
+export type JSONParserErrorType = "EUNKNOWN" | "EPARSER" | "EUNMATCHEDPARSER" | "ERESOLVER" | "EUNMATCHEDRESOLVER" | "EMISSINGPOINTER" | "EINVALIDPOINTER";
+export declare class JSONParserError extends Error {
+    readonly name: string;
+    readonly message: string;
+    source: string | undefined;
+    path: Array<string | number> | null;
+    readonly code: JSONParserErrorType;
+    constructor(message: string, source?: string);
+    get footprint(): string;
+}
+export declare class JSONParserErrorGroup extends Error {
+    files: $RefParser;
+    constructor(parser: $RefParser);
+    static getParserErrors(parser: any): any[];
+    get errors(): Array<JSONParserError | InvalidPointerError | ResolverError | ParserError | MissingPointerError | UnmatchedParserError | UnmatchedResolverError>;
+}
+export declare class ParserError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    constructor(message: any, source: any);
+}
+export declare class UnmatchedParserError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    constructor(source: string);
+}
+export declare class ResolverError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    ioErrorCode?: string;
+    constructor(ex: Error | any, source?: string);
+}
+export declare class UnmatchedResolverError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    constructor(source: any);
+}
+export declare class MissingPointerError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    constructor(token: any, path: any);
+}
+export declare class InvalidPointerError extends JSONParserError {
+    code: JSONParserErrorType;
+    name: string;
+    constructor(pointer: any, path: any);
+}
+export declare function isHandledError(err: any): err is JSONParserError;
+export declare function normalizeError(err: any): any;

package/dist/lib/util/errors.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeError = exports.isHandledError = exports.InvalidPointerError = exports.MissingPointerError = exports.UnmatchedResolverError = exports.ResolverError = exports.UnmatchedParserError = exports.ParserError = exports.JSONParserErrorGroup = exports.JSONParserError = void 0;
+const ono_1 = require("@jsdevtools/ono");
+const url_js_1 = require("./url.js");
+class JSONParserError extends Error {
+    constructor(message, source) {
+        super();
+        this.code = "EUNKNOWN";
+        this.name = "JSONParserError";
+        this.message = message;
+        this.source = source;
+        this.path = null;
+        ono_1.Ono.extend(this);
+    }
+    get footprint() {
+        return `${this.path}+${this.source}+${this.code}+${this.message}`;
+    }
+}
+exports.JSONParserError = JSONParserError;
+class JSONParserErrorGroup extends Error {
+    constructor(parser) {
+        super();
+        this.files = parser;
+        this.name = "JSONParserErrorGroup";
+        this.message = `${this.errors.length} error${this.errors.length > 1 ? "s" : ""} occurred while reading '${(0, url_js_1.toFileSystemPath)(parser.$refs._root$Ref.path)}'`;
+        ono_1.Ono.extend(this);
+    }
+    static getParserErrors(parser) {
+        const errors = [];
+        for (const $ref of Object.values(parser.$refs._$refs)) {
+            // @ts-expect-error TS(2571): Object is of type 'unknown'.
+            if ($ref.errors) {
+                // @ts-expect-error TS(2571): Object is of type 'unknown'.
+                errors.push(...$ref.errors);
+            }
+        }
+        return errors;
+    }
+    get errors() {
+        return JSONParserErrorGroup.getParserErrors(this.files);
+    }
+}
+exports.JSONParserErrorGroup = JSONParserErrorGroup;
+class ParserError extends JSONParserError {
+    constructor(message, source) {
+        super(`Error parsing ${source}: ${message}`, source);
+        this.code = "EPARSER";
+        this.name = "ParserError";
+    }
+}
+exports.ParserError = ParserError;
+class UnmatchedParserError extends JSONParserError {
+    constructor(source) {
+        super(`Could not find parser for "${source}"`, source);
+        this.code = "EUNMATCHEDPARSER";
+        this.name = "UnmatchedParserError";
+    }
+}
+exports.UnmatchedParserError = UnmatchedParserError;
+class ResolverError extends JSONParserError {
+    constructor(ex, source) {
+        super(ex.message || `Error reading file "${source}"`, source);
+        this.code = "ERESOLVER";
+        this.name = "ResolverError";
+        if ("code" in ex) {
+            this.ioErrorCode = String(ex.code);
+        }
+    }
+}
+exports.ResolverError = ResolverError;
+class UnmatchedResolverError extends JSONParserError {
+    constructor(source) {
+        super(`Could not find resolver for "${source}"`, source);
+        this.code = "EUNMATCHEDRESOLVER";
+        this.name = "UnmatchedResolverError";
+    }
+}
+exports.UnmatchedResolverError = UnmatchedResolverError;
+class MissingPointerError extends JSONParserError {
+    constructor(token, path) {
+        super(`Token "${token}" does not exist.`, (0, url_js_1.stripHash)(path));
+        this.code = "EUNMATCHEDRESOLVER";
+        this.name = "MissingPointerError";
+    }
+}
+exports.MissingPointerError = MissingPointerError;
+class InvalidPointerError extends JSONParserError {
+    constructor(pointer, path) {
+        super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, (0, url_js_1.stripHash)(path));
+        this.code = "EUNMATCHEDRESOLVER";
+        this.name = "InvalidPointerError";
+    }
+}
+exports.InvalidPointerError = InvalidPointerError;
+function isHandledError(err) {
+    return err instanceof JSONParserError || err instanceof JSONParserErrorGroup;
+}
+exports.isHandledError = isHandledError;
+function normalizeError(err) {
+    if (err.path === null) {
+        err.path = [];
+    }
+    return err;
+}
+exports.normalizeError = normalizeError;

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

@@ -0,0 +1,3 @@
+type MaybeParams<T> = (err: Error | any | null, result?: T) => void;
+export default function maybe<T>(cb: MaybeParams<T> | undefined, promise: Promise<T>): Promise<T> | void;
+export {};

package/dist/lib/util/maybe.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const next_js_1 = __importDefault(require("./next.js"));
+function maybe(cb, promise) {
+    if (cb) {
+        promise.then(function (result) {
+            (0, next_js_1.default)(function () {
+                cb(null, result);
+            });
+        }, function (err) {
+            (0, next_js_1.default)(function () {
+                cb(err);
+            });
+        });
+        return undefined;
+    }
+    else {
+        return promise;
+    }
+}
+exports.default = maybe;

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

@@ -0,0 +1,2 @@
+declare const _default: (callback: Function, ...args: any[]) => void;
+export default _default;

package/dist/lib/util/next.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function makeNext() {
+    if (typeof process === "object" && typeof process.nextTick === "function") {
+        return process.nextTick;
+    }
+    else if (typeof setImmediate === "function") {
+        return setImmediate;
+    }
+    else {
+        return function next(f) {
+            setTimeout(f, 0);
+        };
+    }
+}
+exports.default = makeNext();

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

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import type { FileInfo } from "../types/index.js";
+import type $RefParserOptions from "../options.js";
+import type { ResolverOptions } from "../types/index.js";
+import type $Refs from "../refs.js";
+import type { Plugin } from "../types/index.js";
+import type { JSONSchema } from "../types/index.js";
+/**
+ * Returns the given plugins as an array, rather than an object map.
+ * All other methods in this module expect an array of plugins rather than an object map.
+ *
+ * @returns
+ */
+export declare function all(plugins: $RefParserOptions["resolve"]): Plugin[];
+/**
+ * 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[];
+/**
+ * Sorts the given plugins, in place, by their `order` property.
+ */
+export declare function sort(plugins: Plugin[]): Plugin[];
+export interface PluginResult {
+    plugin: Plugin;
+    result?: string | Buffer | JSONSchema;
+    error?: any;
+}
+/**
+ * Runs the specified method of the given plugins, in order, until one of them returns a successful result.
+ * Each method can return a synchronous value, a Promise, or call an error-first callback.
+ * If the promise resolves successfully, or the callback is called without an error, then the result
+ * is immediately returned and no further plugins are called.
+ * 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 declare function run(plugins: Plugin[], method: keyof Plugin | keyof ResolverOptions, file: FileInfo, $refs: $Refs): Promise<PluginResult>;

package/dist/lib/util/plugins.js

@@ -0,0 +1,144 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = exports.sort = exports.filter = exports.all = void 0;
+/**
+ * Returns the given plugins as an array, rather than an object map.
+ * All other methods in this module expect an array of plugins rather than an object map.
+ *
+ * @returns
+ */
+function all(plugins) {
+    return Object.keys(plugins)
+        .filter((key) => {
+        return typeof plugins[key] === "object";
+    })
+        .map((key) => {
+        plugins[key].name = key;
+        return plugins[key];
+    });
+}
+exports.all = all;
+/**
+ * Filters the given plugins, returning only the ones return `true` for the given method.
+ */
+function filter(plugins, method, file) {
+    return plugins.filter((plugin) => {
+        return !!getResult(plugin, method, file);
+    });
+}
+exports.filter = filter;
+/**
+ * Sorts the given plugins, in place, by their `order` property.
+ */
+function sort(plugins) {
+    for (const plugin of plugins) {
+        plugin.order = plugin.order || Number.MAX_SAFE_INTEGER;
+    }
+    return plugins.sort((a, b) => {
+        return a.order - b.order;
+    });
+}
+exports.sort = sort;
+/**
+ * Runs the specified method of the given plugins, in order, until one of them returns a successful result.
+ * Each method can return a synchronous value, a Promise, or call an error-first callback.
+ * If the promise resolves successfully, or the callback is called without an error, then the result
+ * is immediately returned and no further plugins are called.
+ * 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.
+ */
+function run(plugins, method, file, $refs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let plugin;
+        let lastError;
+        let index = 0;
+        return new Promise((resolve, reject) => {
+            runNextPlugin();
+            function runNextPlugin() {
+                plugin = plugins[index++];
+                if (!plugin) {
+                    // There are no more functions, so re-throw the last error
+                    return reject(lastError);
+                }
+                try {
+                    // console.log('  %s', plugin.name);
+                    const result = getResult(plugin, method, file, callback, $refs);
+                    if (result && typeof result.then === "function") {
+                        // A promise was returned
+                        result.then(onSuccess, onError);
+                    }
+                    else if (result !== undefined) {
+                        // A synchronous result was returned
+                        onSuccess(result);
+                    }
+                    else if (index === plugins.length) {
+                        throw new Error("No promise has been returned or callback has been called.");
+                    }
+                }
+                catch (e) {
+                    onError(e);
+                }
+            }
+            function callback(err, result) {
+                if (err) {
+                    onError(err);
+                }
+                else {
+                    onSuccess(result);
+                }
+            }
+            function onSuccess(result) {
+                // console.log('    success');
+                resolve({
+                    plugin,
+                    result,
+                });
+            }
+            function onError(error) {
+                // console.log('    %s', err.message || err);
+                lastError = {
+                    plugin,
+                    error,
+                };
+                runNextPlugin();
+            }
+        });
+    });
+}
+exports.run = run;
+/**
+ * Returns the value of the given property.
+ * If the property is a function, then the result of the function is returned.
+ * 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(obj, prop, file, callback, $refs) {
+    const value = obj[prop];
+    if (typeof value === "function") {
+        return value.apply(obj, [file, callback, $refs]);
+    }
+    if (!callback) {
+        // The synchronous plugin functions (canParse and canRead)
+        // allow a "shorthand" syntax, where the user can match
+        // files by RegExp or by file extension.
+        if (value instanceof RegExp) {
+            return value.test(file.url);
+        }
+        else if (typeof value === "string") {
+            return value === file.extension;
+        }
+        else if (Array.isArray(value)) {
+            return value.indexOf(file.extension) !== -1;
+        }
+    }
+    return value;
+}