/* eslint-disable no-param-reassign */ const binaryParser = require('./parsers/binary'); const jsonParser = require('./parsers/json'); const textParser = require('./parsers/text'); const yamlParser = require('./parsers/yaml'); const fileResolver = require('./resolvers/file'); const httpResolver = require('./resolvers/http'); module.exports = $RefParserOptions; /** * Options that determine how JSON schemas are parsed, resolved, and dereferenced. * * @param {object|$RefParserOptions} [options] - Overridden options * @constructor */ function $RefParserOptions(options) { merge(this, $RefParserOptions.defaults); merge(this, options); } $RefParserOptions.defaults = { /** * Determines how different types of files will be parsed. * * You can add additional parsers of your own, replace an existing one with * your own implementation, or disable any parser by setting it to false. */ parse: { json: jsonParser, yaml: yamlParser, text: textParser, binary: binaryParser, }, /** * Determines how JSON References will be resolved. * * You can add additional resolvers of your own, replace an existing one with * your own implementation, or disable any resolver by setting it to false. */ resolve: { file: fileResolver, http: httpResolver, /** * Determines whether external $ref pointers will be resolved. * If this option is disabled, then none of above resolvers will be called. * Instead, external $ref pointers will simply be ignored. * * @type {boolean} */ external: true, }, /** * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true` * causes it to keep processing as much as possible and then throw a single error that contains all errors * that were encountered. */ continueOnError: false, /** * Determines the types of JSON references that are allowed. */ dereference: { /** * Dereference circular (recursive) JSON references? * If false, then a {@link ReferenceError} will be thrown if a circular reference is found. * If "ignore", then circular references will not be dereferenced. * * @type {boolean|string} */ circular: true, }, }; /** * Merges the properties of the source object into the target object. * * @param {object} target - The object that we're populating * @param {?object} source - The options that are being merged * @returns {object} */ function merge(target, source) { if (isMergeable(source)) { const keys = Object.keys(source); for (let i = 0; i < keys.length; i++) { const key = keys[i]; const sourceSetting = source[key]; const targetSetting = target[key]; if (isMergeable(sourceSetting)) { // It's a nested object, so merge it recursively target[key] = merge(targetSetting || {}, sourceSetting); } else if (sourceSetting !== undefined) { // It's a scalar value, function, or array. No merging necessary. Just overwrite the target value. target[key] = sourceSetting; } } } return target; } /** * Determines whether the given value can be merged, * or if it is a scalar value that should just override the target value. * * @param {*} val * @returns {Boolean} */ function isMergeable(val) { return val && typeof val === 'object' && !Array.isArray(val) && !(val instanceof RegExp) && !(val instanceof Date); }