@scalar/openapi-parser 0.7.1 → 0.7.2

package/dist/src/polyfills/path.js

@@ -1,80 +0,0 @@
-function normalizeArray(parts, allowAboveRoot) {
-  var up = 0;
-  for (var i = parts.length - 1; i >= 0; i--) {
-    var last = parts[i];
-    if (last === ".") {
-      parts.splice(i, 1);
-    } else if (last === "..") {
-      parts.splice(i, 1);
-      up++;
-    } else if (up) {
-      parts.splice(i, 1);
-      up--;
-    }
-  }
-  if (allowAboveRoot) {
-    for (; up--; up) {
-      parts.unshift("..");
-    }
-  }
-  return parts;
-}
-var splitPathRe = /^(\/?|)([\s\S]*?)((?:\.{1,2}|[^\/]+?|)(\.[^.\/]*|))(?:[\/]*)$/;
-var splitPath = function(filename) {
-  return splitPathRe.exec(filename).slice(1);
-};
-function normalize(path) {
-  var isPathAbsolute = isAbsolute(path), trailingSlash = substr(path, -1) === "/";
-  path = normalizeArray(
-    filter(path.split("/"), function(p) {
-      return !!p;
-    }),
-    !isPathAbsolute
-  ).join("/");
-  if (!path && !isPathAbsolute) {
-    path = ".";
-  }
-  if (path && trailingSlash) {
-    path += "/";
-  }
-  return (isPathAbsolute ? "/" : "") + path;
-}
-function isAbsolute(path) {
-  return path.charAt(0) === "/";
-}
-function join(...paths) {
-  return normalize(
-    filter(paths, function(p, index) {
-      if (typeof p !== "string") {
-        throw new TypeError("Arguments to path.join must be strings");
-      }
-      return p;
-    }).join("/")
-  );
-}
-function dirname(path) {
-  var result = splitPath(path), root = result[0], dir = result[1];
-  if (!root && !dir) {
-    return ".";
-  }
-  if (dir) {
-    dir = dir.substr(0, dir.length - 1);
-  }
-  return root + dir;
-}
-function filter(xs, f) {
-  if (xs.filter) return xs.filter(f);
-  var res = [];
-  for (var i = 0; i < xs.length; i++) {
-    if (f(xs[i], i, xs)) res.push(xs[i]);
-  }
-  return res;
-}
-var substr = "ab".substr(-1) === "b" ? function(str, start, len) {
-  return str.substr(start, len);
-} : function(str, start, len) {
-  if (start < 0) start = str.length + start;
-  return str.substr(start, len);
-};
-
-export { dirname, isAbsolute, join, normalize };

package/dist/src/utils/betterAjvErrors/helpers.js

@@ -1,89 +0,0 @@
-import { getErrors, isRequiredError, isAnyOfError, isEnumError, getSiblings, notUndefined, concatAll, getChildren } from './utils.js';
-import EnumValidationError from './validation-errors/enum.js';
-import DefaultValidationError from './validation-errors/default.js';
-import UnevaluatedPropValidationError from './validation-errors/unevaluated-prop.js';
-import RequiredValidationError from './validation-errors/required.js';
-import PatternValidationError from './validation-errors/pattern.js';
-import AdditionalPropValidationError from './validation-errors/additional-prop.js';
-
-const JSON_POINTERS_REGEX = /\/[\w_-]+(\/\d+)?/g;
-function makeTree(ajvErrors = []) {
-  const root = { children: {} };
-  ajvErrors.forEach((ajvError) => {
-    const instancePath = typeof ajvError.instancePath !== "undefined" ? ajvError.instancePath : ajvError.dataPath;
-    const paths = instancePath === "" ? [""] : instancePath.match(JSON_POINTERS_REGEX);
-    if (paths) {
-      paths.reduce((obj, path, i) => {
-        obj.children[path] = obj.children[path] || { children: {}, errors: [] };
-        if (i === paths.length - 1) {
-          obj.children[path].errors.push(ajvError);
-        }
-        return obj.children[path];
-      }, root);
-    }
-  });
-  return root;
-}
-function filterRedundantErrors(root, parent, key) {
-  getErrors(root).forEach((error) => {
-    if (isRequiredError(error)) {
-      root.errors = [error];
-      root.children = {};
-    }
-  });
-  if (getErrors(root).some(isAnyOfError)) {
-    if (Object.keys(root.children).length > 0) {
-      delete root.errors;
-    }
-  }
-  if (root.errors && root.errors.length && getErrors(root).every(isEnumError)) {
-    if (getSiblings(parent)(root).filter(notUndefined).some(getErrors)) {
-      delete parent.children[key];
-    }
-  }
-  Object.entries(root.children).forEach(
-    ([k, child]) => filterRedundantErrors(child, root, k)
-  );
-}
-function createErrorInstances(root, options) {
-  const errors = getErrors(root);
-  if (errors.length && errors.every(isEnumError)) {
-    const uniqueValues = new Set(
-      concatAll([])(errors.map((e) => e.params.allowedValues))
-    );
-    const allowedValues = [...uniqueValues];
-    const error = errors[0];
-    return [
-      new EnumValidationError(
-        {
-          ...error,
-          params: { allowedValues }
-        },
-        options
-      )
-    ];
-  }
-  return concatAll(
-    errors.reduce((ret, error) => {
-      switch (error.keyword) {
-        case "additionalProperties":
-          return ret.concat(new AdditionalPropValidationError(error, options));
-        case "pattern":
-          return ret.concat(new PatternValidationError(error, options));
-        case "required":
-          return ret.concat(new RequiredValidationError(error, options));
-        case "unevaluatedProperties":
-          return ret.concat(new UnevaluatedPropValidationError(error, options));
-        default:
-          return ret.concat(new DefaultValidationError(error, options));
-      }
-    }, [])
-  )(getChildren(root).map((child) => createErrorInstances(child, options)));
-}
-function prettify(ajvErrors, options) {
-  const tree = makeTree(ajvErrors || []);
-  filterRedundantErrors(tree);
-  return createErrorInstances(tree, options);
-}
-
-export { createErrorInstances, prettify as default, filterRedundantErrors, makeTree };

package/dist/src/utils/betterAjvErrors/index.js

@@ -1,15 +0,0 @@
-import prettify from './helpers.js';
-
-function betterAjvErrors(schema, data, errors, options = {}) {
-  const { indent = null, json = null } = options;
-  const jsonRaw = json || JSON.stringify(data, null, indent);
-  const customErrorToStructure = (error) => error.getError();
-  const customErrors = prettify(errors, {
-    data,
-    schema,
-    jsonRaw
-  });
-  return customErrors.map(customErrorToStructure);
-}
-
-export { betterAjvErrors };

package/dist/src/utils/betterAjvErrors/utils.js

@@ -1,17 +0,0 @@
-const eq = (x) => (y) => x === y;
-const not = (fn) => (x) => !fn(x);
-const getValues = (o) => Object.values(o);
-const notUndefined = (x) => x !== void 0;
-const isXError = (x) => (error) => error.keyword === x;
-const isRequiredError = isXError("required");
-const isAnyOfError = isXError("anyOf");
-const isEnumError = isXError("enum");
-const getErrors = (node) => node && node.errors || [];
-const getChildren = (node) => node && getValues(node.children) || [];
-const getSiblings = (parent) => (node) => getChildren(parent).filter(not(eq(node)));
-const concatAll = (
-  /* ::<T> */
-  (xs) => (ys) => ys.reduce((zs, z) => zs.concat(z), xs)
-);
-
-export { concatAll, getChildren, getErrors, getSiblings, isAnyOfError, isEnumError, isRequiredError, notUndefined };

package/dist/src/utils/betterAjvErrors/validation-errors/additional-prop.js

@@ -1,18 +0,0 @@
-import BaseValidationError from './base.js';
-
-class AdditionalPropValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "AdditionalPropValidationError";
-    this.options.isIdentifierLocation = true;
-  }
-  getError() {
-    const { params } = this.options;
-    return {
-      message: `Property ${params.additionalProperty} is not expected to be here`,
-      path: this.instancePath
-    };
-  }
-}
-
-export { AdditionalPropValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/base.js

@@ -1,23 +0,0 @@
-class BaseValidationError {
-  // eslint-disable-next-line default-param-last
-  constructor(options = { isIdentifierLocation: false }, { data, schema, jsonAst, jsonRaw }) {
-    this.options = options;
-    this.data = data;
-    this.schema = schema;
-    this.jsonAst = jsonAst;
-    this.jsonRaw = jsonRaw;
-  }
-  /**
-   * @return {string}
-   */
-  get instancePath() {
-    return typeof this.options.instancePath !== "undefined" ? this.options.instancePath : this.options.dataPath;
-  }
-  getError() {
-    throw new Error(
-      `Implement the 'getError' method inside ${this.constructor.name}!`
-    );
-  }
-}
-
-export { BaseValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/default.js

@@ -1,18 +0,0 @@
-import BaseValidationError from './base.js';
-
-class DefaultValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "DefaultValidationError";
-    this.options.isSkipEndLocation = true;
-  }
-  getError() {
-    const { keyword, message } = this.options;
-    return {
-      message: `${keyword} ${message}`,
-      path: this.instancePath
-    };
-  }
-}
-
-export { DefaultValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/enum.js

@@ -1,41 +0,0 @@
-import pointer from 'jsonpointer';
-import leven from 'leven';
-import BaseValidationError from './base.js';
-
-class EnumValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "EnumValidationError";
-  }
-  getError() {
-    const { message, params } = this.options;
-    const bestMatch = this.findBestMatch();
-    const allowedValues = params.allowedValues.join(", ");
-    const output = {
-      message: `${message}: ${allowedValues}`,
-      path: this.instancePath
-    };
-    if (bestMatch !== null) {
-      output.suggestion = `Did you mean ${bestMatch}?`;
-    }
-    return output;
-  }
-  findBestMatch() {
-    const {
-      params: { allowedValues }
-    } = this.options;
-    const currentValue = this.instancePath === "" ? this.data : pointer.get(this.data, this.instancePath);
-    if (!currentValue) {
-      return null;
-    }
-    const bestMatch = allowedValues.map((value) => ({
-      value,
-      weight: leven(value, currentValue.toString())
-    })).sort(
-      (x, y) => x.weight > y.weight ? 1 : x.weight < y.weight ? -1 : 0
-    )[0];
-    return allowedValues.length === 1 || bestMatch.weight < bestMatch.value.length ? bestMatch.value : null;
-  }
-}
-
-export { EnumValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/pattern.js

@@ -1,18 +0,0 @@
-import BaseValidationError from './base.js';
-
-class PatternValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "PatternValidationError";
-    this.options.isIdentifierLocation = true;
-  }
-  getError() {
-    const { params, propertyName } = this.options;
-    return {
-      message: `Property "${propertyName}" must match pattern ${params.pattern}`,
-      path: this.instancePath
-    };
-  }
-}
-
-export { PatternValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/required.js

@@ -1,17 +0,0 @@
-import BaseValidationError from './base.js';
-
-class RequiredValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "RequiredValidationError";
-  }
-  getError() {
-    const { message } = this.options;
-    return {
-      message: `${message}`,
-      path: this.instancePath
-    };
-  }
-}
-
-export { RequiredValidationError as default };

package/dist/src/utils/betterAjvErrors/validation-errors/unevaluated-prop.js

@@ -1,18 +0,0 @@
-import BaseValidationError from './base.js';
-
-class UnevaluatedPropValidationError extends BaseValidationError {
-  constructor(...args) {
-    super(...args);
-    this.name = "UnevaluatedPropValidationError";
-    this.options.isIdentifierLocation = true;
-  }
-  getError() {
-    const { params } = this.options;
-    return {
-      message: `Property ${params.unevaluatedProperty} is not expected to be here`,
-      path: this.instancePath
-    };
-  }
-}
-
-export { UnevaluatedPropValidationError as default };

package/dist/src/utils/dereference.js

@@ -1,18 +0,0 @@
-import { details } from './details.js';
-import { getEntrypoint } from './getEntrypoint.js';
-import { makeFilesystem } from './makeFilesystem.js';
-import { resolveReferences } from './resolveReferences.js';
-
-async function dereference(value) {
-  const filesystem = makeFilesystem(value);
-  const entrypoint = getEntrypoint(filesystem);
-  const result = resolveReferences(filesystem);
-  return {
-    specification: entrypoint.specification,
-    errors: result.errors,
-    schema: result.schema,
-    ...details(entrypoint.specification)
-  };
-}
-
-export { dereference };

package/dist/src/utils/details.js

@@ -1,22 +0,0 @@
-import { OpenApiVersions } from '../configuration.js';
-
-function details(specification) {
-  for (const version of new Set(OpenApiVersions)) {
-    const specificationType = version === "2.0" ? "swagger" : "openapi";
-    const value = specification[specificationType];
-    if (typeof value === "string" && value.startsWith(version)) {
-      return {
-        version,
-        specificationType,
-        specificationVersion: value
-      };
-    }
-  }
-  return {
-    version: void 0,
-    specificationType: void 0,
-    specificationVersion: void 0
-  };
-}
-
-export { details };

package/dist/src/utils/escapeJsonPointer.js

@@ -1,5 +0,0 @@
-function escapeJsonPointer(str) {
-  return str.replace(/~/g, "~0").replace(/\//g, "~1");
-}
-
-export { escapeJsonPointer };

package/dist/src/utils/filter.js

@@ -1,17 +0,0 @@
-import { getEntrypoint } from './getEntrypoint.js';
-import { makeFilesystem } from './makeFilesystem.js';
-import { traverse } from './traverse.js';
-
-function filter(specification, callback) {
-  const filesystem = makeFilesystem(specification);
-  return {
-    specification: traverse(
-      getEntrypoint(filesystem).specification,
-      (schema) => {
-        return callback(schema) ? schema : void 0;
-      }
-    )
-  };
-}
-
-export { filter };

package/dist/src/utils/getEntrypoint.js

@@ -1,5 +0,0 @@
-function getEntrypoint(filesystem) {
-  return filesystem.find((file) => file.isEntrypoint);
-}
-
-export { getEntrypoint };

package/dist/src/utils/getListOfReferences.js

@@ -1,17 +0,0 @@
-import { traverse } from './traverse.js';
-
-function getListOfReferences(specification) {
-  const references = [];
-  if (!specification || typeof specification !== "object") {
-    return references;
-  }
-  traverse(specification, (value) => {
-    if (value.$ref && typeof value.$ref === "string" && !value.$ref.startsWith("#")) {
-      references.push(value.$ref.split("#")[0]);
-    }
-    return value;
-  });
-  return [...new Set(references)];
-}
-
-export { getListOfReferences };

package/dist/src/utils/getSegmentsFromPath.js

@@ -1,10 +0,0 @@
-import { unescapeJsonPointer } from './unescapeJsonPointer.js';
-
-function getSegmentsFromPath(path) {
-  return (
-    // /paths/~1test
-    path.split("/").slice(1).map(unescapeJsonPointer)
-  );
-}
-
-export { getSegmentsFromPath };

package/dist/src/utils/isFilesystem.js

@@ -1,5 +0,0 @@
-function isFilesystem(value) {
-  return typeof value !== void 0 && Array.isArray(value) && value.length > 0 && value.some((file) => file.isEntrypoint === true);
-}
-
-export { isFilesystem };

package/dist/src/utils/isJson.js

@@ -1,10 +0,0 @@
-function isJson(value) {
-  try {
-    JSON.parse(value);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-export { isJson };

package/dist/src/utils/isObject.js

@@ -1,3 +0,0 @@
-const isObject = (obj) => typeof obj === "object" && !Array.isArray(obj) && obj !== null;
-
-export { isObject };

package/dist/src/utils/isYaml.js

@@ -1,17 +0,0 @@
-import { parse } from 'yaml';
-
-function isYaml(value) {
-  if (!value.includes("\n")) {
-    return false;
-  }
-  try {
-    parse(value, {
-      maxAliasCount: 1e4
-    });
-    return true;
-  } catch (error) {
-    return false;
-  }
-}
-
-export { isYaml };

package/dist/src/utils/load/load.js

@@ -1,59 +0,0 @@
-import { getEntrypoint } from '../getEntrypoint.js';
-import { getListOfReferences } from '../getListOfReferences.js';
-import { makeFilesystem } from '../makeFilesystem.js';
-import { normalize } from '../normalize.js';
-
-async function load(value, options) {
-  if (options?.filesystem && options?.filesystem.find((entry) => entry.filename === value)) {
-    return {
-      filesystem: options.filesystem
-    };
-  }
-  const plugin = options?.plugins?.find((plugin2) => plugin2.check(value));
-  const content = normalize(plugin ? await plugin.get(value) : value);
-  if (content === void 0) {
-    return {
-      filesystem: []
-    };
-  }
-  let filesystem = makeFilesystem(content, {
-    filename: options?.filename ?? null
-  });
-  const newEntry = options?.filename ? filesystem.find((entry) => entry.filename === options?.filename) : getEntrypoint(filesystem);
-  const listOfReferences = newEntry.references ?? getListOfReferences(content);
-  if (listOfReferences.length === 0) {
-    return {
-      filesystem
-    };
-  }
-  for (const reference of listOfReferences) {
-    const plugin2 = options?.plugins?.find((plugin3) => plugin3.check(reference));
-    if (!plugin2) {
-      continue;
-    }
-    const target = plugin2.check(reference) && plugin2.resolvePath ? plugin2.resolvePath(value, reference) : reference;
-    if (filesystem.find((entry) => entry.filename === reference)) {
-      continue;
-    }
-    const { filesystem: referencedFiles } = await load(target, {
-      ...options,
-      // Make the filename the exact same value as the $ref
-      // TODO: This leads to problems, if there are multiple references with the same file name but in different folders
-      filename: reference
-    });
-    filesystem = [
-      ...filesystem,
-      ...referencedFiles.map((file) => {
-        return {
-          ...file,
-          isEntrypoint: false
-        };
-      })
-    ];
-  }
-  return {
-    filesystem
-  };
-}
-
-export { load };

package/dist/src/utils/load/plugins/fetchUrls.js

@@ -1,38 +0,0 @@
-const fetchUrlsDefaultConfiguration = {
-  limit: 20
-};
-const fetchUrls = (customConfiguration) => {
-  let numberOfRequests = 0;
-  const configuration = {
-    ...fetchUrlsDefaultConfiguration,
-    ...customConfiguration
-  };
-  return {
-    check(value) {
-      if (typeof value !== "string") {
-        return false;
-      }
-      if (!value.startsWith("http://") && !value.startsWith("https://")) {
-        return false;
-      }
-      return true;
-    },
-    async get(value) {
-      if (configuration?.limit !== false && numberOfRequests >= configuration?.limit) {
-        console.warn(
-          `[fetchUrls] Maximum number of requests reeached (${configuration?.limit}), skipping request`
-        );
-        return void 0;
-      }
-      try {
-        numberOfRequests++;
-        const response = await (configuration?.fetch ? configuration.fetch(value) : fetch(value));
-        return await response.text();
-      } catch (error) {
-        console.error("[fetchUrls]", error.message, `(${value})`);
-      }
-    }
-  };
-};
-
-export { fetchUrls, fetchUrlsDefaultConfiguration };

package/dist/src/utils/load/plugins/readFiles.d.ts

@@ -1,5 +0,0 @@
-import { LoadPlugin } from '../../../../utils/load/load.js';
-
-declare const readFiles: () => LoadPlugin;
-
-export { readFiles };

package/dist/src/utils/load/plugins/readFiles.js

@@ -1,50 +0,0 @@
-import fs from 'node:fs';
-import { ERRORS } from '../../../configuration.js';
-import { dirname, join } from '../../../polyfills/path.js';
-import { isJson } from '../../isJson.js';
-import { isYaml } from '../../isYaml.js';
-
-const readFiles = () => {
-  return {
-    check(value) {
-      if (typeof value !== "string") {
-        return false;
-      }
-      if (value.startsWith("http://") || value.startsWith("https://")) {
-        return false;
-      }
-      if (value.includes("\n")) {
-        return false;
-      }
-      if (isJson(value)) {
-        return false;
-      }
-      if (isYaml(value)) {
-        return false;
-      }
-      return true;
-    },
-    async get(value) {
-      if (!fs.existsSync(value)) {
-        throw new Error(ERRORS.FILE_DOES_NOT_EXIST.replace("%s", value));
-      }
-      try {
-        return fs.readFileSync(value, "utf-8");
-      } catch (error) {
-        console.error("[readFiles]", error);
-      }
-    },
-    resolvePath(value, reference) {
-      const dir = dirname(value);
-      return join(dir, reference);
-    },
-    getDir(value) {
-      return dirname(value);
-    },
-    getFilename(value) {
-      return value.split("/").pop();
-    }
-  };
-};
-
-export { readFiles };