@scalar/openapi-parser 0.25.4 → 0.25.5

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

@@ -1,19 +1,15 @@
-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
-    };
-  }
+import BaseValidationError from './base.js';
+export default 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
-};
-//# sourceMappingURL=unevaluated-prop.js.map

package/dist/utils/dereference.js

@@ -1,19 +1,23 @@
-import { details } from "./details.js";
-import { getEntrypoint } from "./get-entrypoint.js";
-import { makeFilesystem } from "./make-filesystem.js";
-import { resolveReferences } from "./resolve-references.js";
-function dereference(value, options) {
-  const filesystem = makeFilesystem(value);
-  const entrypoint = getEntrypoint(filesystem);
-  const result = resolveReferences(filesystem, options);
-  return {
-    specification: entrypoint.specification,
-    errors: result.errors,
-    schema: result.schema,
-    ...details(entrypoint.specification)
-  };
+import { details } from './details.js';
+import { getEntrypoint } from './get-entrypoint.js';
+import { makeFilesystem } from './make-filesystem.js';
+import { resolveReferences } from './resolve-references.js';
+/**
+ * Dereferences an API definition or filesystem by resolving all references within the specification.
+ *
+ * @param value - The API definition or filesystem to dereference.\
+ *                Can be any supported API definition format or a filesystem object.
+ *
+ * @param options - Optional options for the dereferencing process.
+ */
+export function dereference(value, options) {
+    const filesystem = makeFilesystem(value);
+    const entrypoint = getEntrypoint(filesystem);
+    const result = resolveReferences(filesystem, options);
+    return {
+        specification: entrypoint.specification,
+        errors: result.errors,
+        schema: result.schema,
+        ...details(entrypoint.specification),
+    };
 }
-export {
-  dereference
-};
-//# sourceMappingURL=dereference.js.map

package/dist/utils/details.js

@@ -1,33 +1,32 @@
-import { isObject } from "@scalar/helpers/object/is-object";
-import { OpenApiVersions } from "../configuration/index.js";
-function details(specification) {
-  if (specification === null) {
-    return {
-      version: void 0,
-      specificationType: void 0,
-      specificationVersion: void 0
-    };
-  }
-  if (isObject(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)) {
+import { isObject } from '@scalar/helpers/object/is-object';
+import { OpenApiVersions } from '../configuration/index.js';
+/**
+ * Get versions of the OpenAPI document.
+ */
+export function details(specification) {
+    if (specification === null) {
         return {
-          version,
-          specificationType,
-          specificationVersion: value
+            version: undefined,
+            specificationType: undefined,
+            specificationVersion: undefined,
         };
-      }
     }
-  }
-  return {
-    version: void 0,
-    specificationType: void 0,
-    specificationVersion: void 0
-  };
+    if (isObject(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: version,
+                    specificationType,
+                    specificationVersion: value,
+                };
+            }
+        }
+    }
+    return {
+        version: undefined,
+        specificationType: undefined,
+        specificationVersion: undefined,
+    };
 }
-export {
-  details
-};
-//# sourceMappingURL=details.js.map

package/dist/utils/filter.js

@@ -1,15 +1,14 @@
-import { getEntrypoint } from "./get-entrypoint.js";
-import { makeFilesystem } from "./make-filesystem.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;
-    })
-  };
+import { getEntrypoint } from './get-entrypoint.js';
+import { makeFilesystem } from './make-filesystem.js';
+import { traverse } from './traverse.js';
+/**
+ * Filter the specification based on the callback
+ */
+export function filter(specification, callback) {
+    const filesystem = makeFilesystem(specification);
+    return {
+        specification: traverse(getEntrypoint(filesystem).specification, (schema) => {
+            return callback(schema) ? schema : undefined;
+        }),
+    };
 }
-export {
-  filter
-};
-//# sourceMappingURL=filter.js.map

package/dist/utils/get-entrypoint.js

@@ -1,7 +1,6 @@
-function getEntrypoint(filesystem) {
-  return filesystem?.find((file) => file.isEntrypoint);
+/**
+ * Return just the entrypoint of the filesystem.
+ */
+export function getEntrypoint(filesystem) {
+    return filesystem?.find((file) => file.isEntrypoint);
 }
-export {
-  getEntrypoint
-};
-//# sourceMappingURL=get-entrypoint.js.map

package/dist/utils/get-list-of-references.js

@@ -1,18 +1,22 @@
-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]);
+import { traverse } from './traverse.js';
+/**
+ * Walks through the specification and returns all references as an array.
+ *
+ * Warning: Doesn't return internal references.
+ */
+export function getListOfReferences(specification) {
+    const references = [];
+    // Make sure we're dealing with an object
+    if (!specification || typeof specification !== 'object') {
+        return references;
     }
-    return value;
-  });
-  return [...new Set(references)];
+    // Traverse the specification and collect all references
+    traverse(specification, (value) => {
+        if (value.$ref && typeof value.$ref === 'string' && !value.$ref.startsWith('#')) {
+            references.push(value.$ref.split('#')[0]);
+        }
+        return value;
+    });
+    // Remove duplicates
+    return [...new Set(references)];
 }
-export {
-  getListOfReferences
-};
-//# sourceMappingURL=get-list-of-references.js.map

package/dist/utils/get-segments-from-path.js

@@ -1,11 +1,15 @@
-import { unescapeJsonPointer } from "./unescape-json-pointer.js";
-function getSegmentsFromPath(path) {
-  return (
+import { unescapeJsonPointer } from './unescape-json-pointer.js';
+/**
+ * Translate `/paths/~1test` to `['paths', '/test']`
+ */
+export function getSegmentsFromPath(path) {
+    return (
     // /paths/~1test
-    path.split("/").slice(1).map(unescapeJsonPointer)
-  );
+    path
+        // ['', 'paths', '~1test']
+        .split('/')
+        // ['paths', '~test']
+        .slice(1)
+        // ['paths', '/test']
+        .map(unescapeJsonPointer));
 }
-export {
-  getSegmentsFromPath
-};
-//# sourceMappingURL=get-segments-from-path.js.map

package/dist/utils/is-filesystem.js

@@ -1,7 +1,9 @@
-function isFilesystem(value) {
-  return typeof value !== "undefined" && Array.isArray(value) && value.length > 0 && value.some((file) => file.isEntrypoint === true);
+/**
+ * Check if the value is a filesystem
+ */
+export function isFilesystem(value) {
+    return (typeof value !== 'undefined' &&
+        Array.isArray(value) &&
+        value.length > 0 &&
+        value.some((file) => file.isEntrypoint === true));
 }
-export {
-  isFilesystem
-};
-//# sourceMappingURL=is-filesystem.js.map

package/dist/utils/is-json.js

@@ -1,12 +1,9 @@
-function isJson(value) {
-  try {
-    JSON.parse(value);
-    return true;
-  } catch {
-    return false;
-  }
+export function isJson(value) {
+    try {
+        JSON.parse(value);
+        return true;
+    }
+    catch {
+        return false;
+    }
 }
-export {
-  isJson
-};
-//# sourceMappingURL=is-json.js.map

package/dist/utils/is-yaml.js

@@ -1,18 +1,16 @@
-import { parse } from "yaml";
-function isYaml(value) {
-  if (!value.includes("\n")) {
-    return false;
-  }
-  try {
-    parse(value, {
-      maxAliasCount: 1e4
-    });
-    return true;
-  } catch (_error) {
-    return false;
-  }
+import { parse } from 'yaml';
+export function isYaml(value) {
+    // Line breaks
+    if (!value.includes('\n')) {
+        return false;
+    }
+    try {
+        parse(value, {
+            maxAliasCount: 10000,
+        });
+        return true;
+    }
+    catch (_error) {
+        return false;
+    }
 }
-export {
-  isYaml
-};
-//# sourceMappingURL=is-yaml.js.map

package/dist/utils/join/index.js

@@ -1,5 +1 @@
-import { join } from "./join.js";
-export {
-  join
-};
-//# sourceMappingURL=index.js.map
+export { join } from './join.js';