@scalar/openapi-parser 0.7.1 → 0.8.1

package/dist/src/utils/makeFilesystem.js

@@ -1,22 +0,0 @@
-import { getListOfReferences } from './getListOfReferences.js';
-import { isFilesystem } from './isFilesystem.js';
-import { normalize } from './normalize.js';
-
-function makeFilesystem(value, overwrites = {}) {
-  if (isFilesystem(value)) {
-    return value;
-  }
-  const specification = normalize(value);
-  return [
-    {
-      isEntrypoint: true,
-      specification,
-      filename: null,
-      dir: "./",
-      references: getListOfReferences(specification),
-      ...overwrites
-    }
-  ];
-}
-
-export { makeFilesystem };

package/dist/src/utils/normalize.js

@@ -1,20 +0,0 @@
-import { parse } from 'yaml';
-import { isFilesystem } from './isFilesystem.js';
-
-function normalize(specification) {
-  if (isFilesystem(specification)) {
-    return specification;
-  }
-  if (typeof specification === "string") {
-    try {
-      return JSON.parse(specification);
-    } catch (error) {
-      return parse(specification, {
-        maxAliasCount: 1e4
-      });
-    }
-  }
-  return specification;
-}
-
-export { normalize };

package/dist/src/utils/resolveReferences.js

@@ -1,106 +0,0 @@
-import { ERRORS } from '../configuration.js';
-import { getEntrypoint } from './getEntrypoint.js';
-import { getSegmentsFromPath } from './getSegmentsFromPath.js';
-import { makeFilesystem } from './makeFilesystem.js';
-
-function resolveReferences(input, file, errors) {
-  if (errors === void 0) {
-    errors = [];
-  }
-  const clonedInput = structuredClone(input);
-  const filesystem = makeFilesystem(clonedInput);
-  const entrypoint = getEntrypoint(filesystem);
-  resolve(
-    file?.specification ?? entrypoint.specification,
-    filesystem,
-    file ?? entrypoint
-  );
-  resolve(
-    file?.specification ?? entrypoint.specification,
-    filesystem,
-    file ?? entrypoint
-  );
-  errors = errors.filter(
-    (error, index, self) => index === self.findIndex(
-      (t) => t.message === error.message && t.code === error.code
-    )
-  );
-  return {
-    valid: errors.length === 0,
-    errors,
-    schema: (file ?? getEntrypoint(filesystem)).specification
-  };
-  function resolve(schema, filesystem2, file2) {
-    let result;
-    Object.entries(schema ?? {}).forEach(([_, value]) => {
-      if (schema.$ref !== void 0) {
-        const target = resolveUri(schema.$ref, file2, filesystem2, errors);
-        if (target === void 0) {
-          return void 0;
-        }
-        delete schema.$ref;
-        if (typeof target === "object") {
-          Object.keys(target).forEach((key) => {
-            if (schema[key] === void 0) {
-              schema[key] = target[key];
-            }
-          });
-        }
-      }
-      if (typeof value === "object" && !isCircular(value)) {
-        result = resolve(value, filesystem2, file2);
-      }
-    });
-    return {
-      errors: result?.errors ?? []
-    };
-  }
-}
-function isCircular(schema) {
-  try {
-    JSON.stringify(schema);
-    return false;
-  } catch (error) {
-    return true;
-  }
-}
-function resolveUri(uri, file, filesystem, errors) {
-  if (typeof uri !== "string") {
-    errors.push({
-      code: "INVALID_REFERENCE",
-      message: ERRORS.INVALID_REFERENCE.replace("%s", uri)
-    });
-    return;
-  }
-  const [prefix, path] = uri.split("#", 2);
-  if (prefix) {
-    const externalReference = filesystem.find((entry) => {
-      return entry.filename === prefix;
-    });
-    if (!externalReference) {
-      errors.push({
-        code: "EXTERNAL_REFERENCE_NOT_FOUND",
-        message: ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace("%s", prefix)
-      });
-      return;
-    }
-    const result = resolveReferences(filesystem, externalReference, errors);
-    if (path === void 0) {
-      return result.schema;
-    }
-    return resolveUri(`#${path}`, externalReference, filesystem, errors);
-  }
-  const segments = getSegmentsFromPath(path);
-  try {
-    return segments.reduce((acc, key) => {
-      return acc[key];
-    }, file.specification);
-  } catch (error) {
-    errors.push({
-      code: "INVALID_REFERENCE",
-      message: ERRORS.INVALID_REFERENCE.replace("%s", uri)
-    });
-  }
-}
-
-export { resolveReferences };

package/dist/src/utils/toJson.js

@@ -1,3 +0,0 @@
-const toJson = (value) => JSON.stringify(value, null, 2);
-
-export { toJson };

package/dist/src/utils/toYaml.js

@@ -1,5 +0,0 @@
-import { stringify } from 'yaml';
-
-const toYaml = (value) => stringify(value);
-
-export { toYaml };

package/dist/src/utils/transformErrors.js

@@ -1,19 +0,0 @@
-import { betterAjvErrors } from './betterAjvErrors/index.js';
-
-function transformErrors(specification, errors) {
-  if (typeof errors === "string") {
-    return [
-      {
-        message: errors
-      }
-    ];
-  }
-  return betterAjvErrors(specification, null, errors, {
-    indent: 2
-  }).map((error) => {
-    error.message = error.message.trim();
-    return error;
-  });
-}
-
-export { transformErrors };

package/dist/src/utils/traverse.js

@@ -1,20 +0,0 @@
-function traverse(specification, transform) {
-  const result = {};
-  for (const [key, value] of Object.entries(specification)) {
-    if (Array.isArray(value)) {
-      result[key] = value.map((item) => {
-        if (typeof item === "object" && item !== null) {
-          return traverse(item, transform);
-        }
-        return item;
-      });
-    } else if (typeof value === "object" && value !== null) {
-      result[key] = traverse(value, transform);
-    } else {
-      result[key] = value;
-    }
-  }
-  return transform(result);
-}
-
-export { traverse };

package/dist/src/utils/unescapeJsonPointer.js

@@ -1,5 +0,0 @@
-function unescapeJsonPointer(uri) {
-  return decodeURI(uri.replace(/~1/g, "/").replace(/~0/g, "~"));
-}
-
-export { unescapeJsonPointer };

package/dist/src/utils/upgrade.js

@@ -1,19 +0,0 @@
-import { getEntrypoint } from './getEntrypoint.js';
-import { makeFilesystem } from './makeFilesystem.js';
-import { upgradeFromThreeToThreeOne } from './upgradeFromThreeToThreeOne.js';
-import { upgradeFromTwoToThree } from './upgradeFromTwoToThree.js';
-
-function upgrade(specification, _options) {
-  const upgraders = [upgradeFromTwoToThree, upgradeFromThreeToThreeOne];
-  const result = upgraders.reduce(
-    (specification2, upgrader) => upgrader(specification2),
-    getEntrypoint(makeFilesystem(specification)).specification
-  );
-  return {
-    specification: result,
-    // TODO: Make dynamic
-    version: "3.1"
-  };
-}
-
-export { upgrade };

package/dist/src/utils/upgradeFromThreeToThreeOne.js

@@ -1,70 +0,0 @@
-import { traverse } from './traverse.js';
-
-function upgradeFromThreeToThreeOne(specification) {
-  if (specification.openapi?.startsWith("3.0")) {
-    specification.openapi = "3.1.0";
-  } else {
-    return specification;
-  }
-  specification = traverse(specification, (schema) => {
-    if (schema.type !== "undefined" && schema.nullable === true) {
-      schema.type = ["null", schema.type];
-      delete schema.nullable;
-    }
-    return schema;
-  });
-  specification = traverse(specification, (schema) => {
-    if (schema.exclusiveMinimum === true) {
-      schema.exclusiveMinimum = schema.minimum;
-      delete schema.minimum;
-    } else if (schema.exclusiveMinimum === false) {
-      delete schema.exclusiveMinimum;
-    }
-    if (schema.exclusiveMaximum === true) {
-      schema.exclusiveMaximum = schema.maximum;
-      delete schema.maximum;
-    } else if (schema.exclusiveMaximum === false) {
-      delete schema.exclusiveMaximum;
-    }
-    return schema;
-  });
-  specification = traverse(specification, (schema) => {
-    if (schema.example !== void 0) {
-      schema.examples = {
-        default: schema.example
-      };
-      delete schema.example;
-    }
-    return schema;
-  });
-  specification = traverse(specification, (schema) => {
-    if (schema.type === "object" && schema.properties !== void 0) {
-      const entries = Object.entries(schema.properties);
-      for (const [_, value] of entries) {
-        if (typeof value === "object" && value.type === "string" && value.format === "binary") {
-          value.contentEncoding = "application/octet-stream";
-          delete value.format;
-        }
-      }
-    }
-    return schema;
-  });
-  specification = traverse(specification, (schema) => {
-    if (schema.type === "string" && schema.format === "binary") {
-      return void 0;
-    }
-    return schema;
-  });
-  specification = traverse(specification, (schema) => {
-    if (schema.type === "string" && schema.format === "base64") {
-      return {
-        type: "string",
-        contentEncoding: "base64"
-      };
-    }
-    return schema;
-  });
-  return specification;
-}
-
-export { upgradeFromThreeToThreeOne };

package/dist/src/utils/upgradeFromTwoToThree.js

@@ -1,5 +0,0 @@
-function upgradeFromTwoToThree(specification) {
-  return specification;
-}
-
-export { upgradeFromTwoToThree };

package/dist/src/utils/validate.js

@@ -1,15 +0,0 @@
-import { makeFilesystem } from './makeFilesystem.js';
-import { Validator } from '../lib/Validator/Validator.js';
-
-async function validate(value) {
-  const filesystem = makeFilesystem(value);
-  const validator = new Validator();
-  const result = await validator.validate(filesystem);
-  return {
-    ...result,
-    specification: validator.specification,
-    version: validator.version
-  };
-}
-
-export { validate };

package/dist/src/utils/workThroughQueue.js

@@ -1,24 +0,0 @@
-async function workThroughQueue(queue) {
-  let specification = queue.specification;
-  let result;
-  for (const { action, options } of queue.tasks) {
-    if (typeof action !== "function") {
-      console.warn("[queue] The given action is not a function:", action);
-      continue;
-    }
-    if (action.constructor.name === "AsyncFunction") {
-      result = {
-        ...result,
-        ...await action(result?.filesystem ?? specification, options)
-      };
-    } else {
-      result = {
-        ...result,
-        ...action(result?.filesystem ?? specification, options)
-      };
-    }
-  }
-  return result;
-}
-
-export { workThroughQueue };