import type { FileInfo, JSONSchema } from "../types/index.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"; /** * 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 function all = ParserOptions>( plugins: O["resolve"], ): Plugin[] { return (Object.keys(plugins || {}) as (keyof ResolverOptions)[]) .filter((key) => { return typeof plugins![key] === "object"; }) .map((key) => { (plugins![key] as ResolverOptions)!.name = key; return plugins![key] as Plugin; }); } /** * Filters the given plugins, returning only the ones return `true` for the given method. */ export function filter = ParserOptions>( plugins: Plugin[], method: keyof Plugin | keyof ResolverOptions, file: FileInfo, callback?: (err?: Error, result?: any) => void, $refs?: $Refs, ) { return plugins.filter((plugin: Plugin) => { return !!getResult(plugin, method, file, callback, $refs); }); } /** * Sorts the given plugins, in place, by their `order` property. */ export function sort(plugins: Plugin[]) { for (const plugin of plugins) { plugin.order = plugin.order || Number.MAX_SAFE_INTEGER; } return plugins.sort((a: Plugin, b: Plugin) => { return a.order! - b.order!; }); } export interface PluginResult { plugin: Plugin; result?: string | Buffer | S; 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 async function run = ParserOptions>( plugins: Plugin[], method: keyof Plugin | keyof ResolverOptions, file: FileInfo, $refs: $Refs, ) { let plugin: Plugin; let lastError: PluginResult; 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: PluginResult["error"], result: PluginResult["result"]) { if (err) { onError(err); } else { onSuccess(result); } } function onSuccess(result: PluginResult["result"]) { // console.log(' success'); resolve({ plugin, result: result!, }); } function onError(error: PluginResult["error"]) { // console.log(' %s', err.message || err); lastError = { plugin, error, }; runNextPlugin(); } }); } /** * 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 = ParserOptions>( obj: Plugin, prop: keyof Plugin | keyof ResolverOptions, file: FileInfo, callback?: (err?: Error, result?: any) => void, $refs?: $Refs, ) { const value = obj[prop as keyof typeof obj] as unknown; 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; }