@scalar/helpers 0.4.0 → 0.4.2

package/dist/http/is-http-method.js

@@ -1,6 +1,3 @@
-import { httpMethods } from "./http-methods.js";
-const isHttpMethod = (method) => method && typeof method === "string" ? httpMethods.has(method.toLowerCase()) : false;
-export {
-  isHttpMethod
-};
-//# sourceMappingURL=is-http-method.js.map
+import { httpMethods } from './http-methods.js';
+/** Type guard which takes in a string and returns true if it is in fact an HTTPMethod */
+export const isHttpMethod = (method) => method && typeof method === 'string' ? httpMethods.has(method.toLowerCase()) : false;

package/dist/http/normalize-http-method.js

@@ -1,20 +1,20 @@
-import { isHttpMethod } from "./is-http-method.js";
-const DEFAULT_REQUEST_METHOD = "get";
-const normalizeHttpMethod = (method) => {
-  if (typeof method !== "string") {
-    console.warn(`Request method is not a string. Using ${DEFAULT_REQUEST_METHOD} as the default.`);
-    return DEFAULT_REQUEST_METHOD;
-  }
-  const normalizedMethod = method.trim().toLowerCase();
-  if (!isHttpMethod(normalizedMethod)) {
-    console.warn(
-      `${method || "Request method"} is not a valid request method. Using ${DEFAULT_REQUEST_METHOD} as the default.`
-    );
-    return DEFAULT_REQUEST_METHOD;
-  }
-  return normalizedMethod;
+import { isHttpMethod } from './is-http-method.js';
+const DEFAULT_REQUEST_METHOD = 'get';
+/**
+ * Get a normalized request method (e.g. get, post, etc.)
+ * Lowercases the method and returns the default if it is not a valid method so you will always have a valid method
+ */
+export const normalizeHttpMethod = (method) => {
+    // Make sure it's a string
+    if (typeof method !== 'string') {
+        console.warn(`Request method is not a string. Using ${DEFAULT_REQUEST_METHOD} as the default.`);
+        return DEFAULT_REQUEST_METHOD;
+    }
+    // Normalize the string
+    const normalizedMethod = method.trim().toLowerCase();
+    if (!isHttpMethod(normalizedMethod)) {
+        console.warn(`${method || 'Request method'} is not a valid request method. Using ${DEFAULT_REQUEST_METHOD} as the default.`);
+        return DEFAULT_REQUEST_METHOD;
+    }
+    return normalizedMethod;
 };
-export {
-  normalizeHttpMethod
-};
-//# sourceMappingURL=normalize-http-method.js.map

package/dist/json/escape-json-pointer.js

@@ -1,5 +1,6 @@
-const escapeJsonPointer = (str) => str.replace(/~/g, "~0").replace(/\//g, "~1");
-export {
-  escapeJsonPointer
-};
-//# sourceMappingURL=escape-json-pointer.js.map
+/**
+ * Escapes a JSON pointer string.
+ *
+ * Example: `/foo/bar~baz` -> `~1foo~1bar~0baz`
+ */
+export const escapeJsonPointer = (str) => str.replace(/~/g, '~0').replace(/\//g, '~1');

package/dist/json/parse-json-pointer-segments.js

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

package/dist/json/pretty-print-json.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Takes JSON and formats it.
+ */
+export declare const prettyPrintJson: (value: string | number | any[] | Record<any, any>) => string;
+/**
+ * JSON.stringify, but with circular dependencies replaced with '[Circular]'
+ */
+export declare function replaceCircularDependencies(content: any): string;
+//# sourceMappingURL=pretty-print-json.d.ts.map

package/dist/json/pretty-print-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty-print-json.d.ts","sourceRoot":"","sources":["../../src/json/pretty-print-json.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,MAAM,GAAG,MAAM,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,KAAG,MAyBnF,CAAA;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,GAAG,UAiBvD"}

package/dist/json/pretty-print-json.js

@@ -0,0 +1,42 @@
+/**
+ * Takes JSON and formats it.
+ */
+export const prettyPrintJson = (value) => {
+    // When the values is already a string it should be parsable
+    if (typeof value === 'string') {
+        try {
+            const parsed = JSON.parse(value);
+            if (typeof parsed === 'object' && parsed !== null) {
+                return JSON.stringify(parsed, null, 2);
+            }
+            return value;
+        }
+        catch {
+            return value;
+        }
+    }
+    if (typeof value === 'object') {
+        try {
+            return JSON.stringify(value, null, 2);
+        }
+        catch {
+            return replaceCircularDependencies(value);
+        }
+    }
+    return value?.toString() ?? '';
+};
+/**
+ * JSON.stringify, but with circular dependencies replaced with '[Circular]'
+ */
+export function replaceCircularDependencies(content) {
+    const cache = new Set();
+    return JSON.stringify(content, (_key, value) => {
+        if (typeof value === 'object' && value !== null) {
+            if (cache.has(value)) {
+                return '[Circular]';
+            }
+            cache.add(value);
+        }
+        return value;
+    }, 2);
+}

package/dist/json/unescape-json-pointer.js

@@ -1,5 +1,7 @@
-const unescapeJsonPointer = (uri) => decodeURI(uri.replace(/~1/g, "/").replace(/~0/g, "~"));
-export {
-  unescapeJsonPointer
-};
-//# sourceMappingURL=unescape-json-pointer.js.map
+/**
+ * Unescape JSON pointer
+ *
+ * Examples:
+ * /foo~1bar~0baz -> /foo/bar~baz
+ */
+export const unescapeJsonPointer = (uri) => decodeURI(uri.replace(/~1/g, '/').replace(/~0/g, '~'));

package/dist/node/path.js

@@ -1,157 +1,187 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+// resolves . and .. elements in a path array with directory names there
+// must be no slashes, empty elements, or device names (c:\) in the array
+// (so also no leading and trailing slashes - it does not distinguish
+// relative and absolute paths)
+// !! WARNING !!
+// The original implementation included ponyfills for `filters` and `substr`.
+// These have been removed in favor of native implementations supported by the current platforms.
+// See: https://github.com/scalar/scalar/pull/7235#discussion_r2484230212
 function normalizeArray(parts, allowAboveRoot) {
-  let up = 0;
-  for (let i = parts.length - 1; i >= 0; i--) {
-    const 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 the path tries to go above the root, `up` ends up > 0
+    let up = 0;
+    for (let i = parts.length - 1; i >= 0; i--) {
+        const 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("..");
+    // if the path is allowed to go above the root, restore leading ..s
+    if (allowAboveRoot) {
+        for (; up--; up) {
+            parts.unshift('..');
+        }
     }
-  }
-  return parts;
+    return parts;
 }
+// Split a filename into [root, dir, basename, ext], unix version
+// 'root' is just a slash, or nothing.
 const splitPathRe = /^(\/?|)([\s\S]*?)((?:\.{1,2}|[^/]+?|)(\.[^./]*|))(?:[/]*)$/;
 const splitPath = (filename) => splitPathRe.exec(filename).slice(1);
-function resolve(...parameters) {
-  let resolvedPath = "", resolvedAbsolute = false;
-  for (let i = parameters.length - 1; i >= -1 && !resolvedAbsolute; i--) {
-    const path2 = i >= 0 ? parameters[i] : "/";
-    if (typeof path2 !== "string") {
-      throw new TypeError("Arguments to path.resolve must be strings");
+// path.resolve([from ...], to)
+// posix version
+export function resolve(...parameters) {
+    let resolvedPath = '', resolvedAbsolute = false;
+    for (let i = parameters.length - 1; i >= -1 && !resolvedAbsolute; i--) {
+        const path = i >= 0 ? parameters[i] : '/';
+        // Skip empty and invalid entries
+        if (typeof path !== 'string') {
+            throw new TypeError('Arguments to path.resolve must be strings');
+        }
+        if (!path) {
+            continue;
+        }
+        resolvedPath = path + '/' + resolvedPath;
+        resolvedAbsolute = path.charAt(0) === '/';
     }
-    if (!path2) {
-      continue;
-    }
-    resolvedPath = path2 + "/" + resolvedPath;
-    resolvedAbsolute = path2.charAt(0) === "/";
-  }
-  resolvedPath = normalizeArray(
-    resolvedPath.split("/").filter((p) => !!p),
-    !resolvedAbsolute
-  ).join("/");
-  return (resolvedAbsolute ? "/" : "") + resolvedPath || ".";
+    // At this point the path should be resolved to a full absolute path, but
+    // handle relative paths to be safe (might happen when process.cwd() fails)
+    // Normalize the path
+    resolvedPath = normalizeArray(resolvedPath.split('/').filter((p) => !!p), !resolvedAbsolute).join('/');
+    return (resolvedAbsolute ? '/' : '') + resolvedPath || '.';
 }
-function normalize(inputPath) {
-  const isPathAbsolute = isAbsolute(inputPath), trailingSlash = inputPath.slice(-1) === "/";
-  let path2 = normalizeArray(
-    inputPath.split("/").filter((p) => !!p),
-    !isPathAbsolute
-  ).join("/");
-  if (!path2 && !isPathAbsolute) {
-    path2 = ".";
-  }
-  if (path2 && trailingSlash) {
-    path2 += "/";
-  }
-  return (isPathAbsolute ? "/" : "") + path2;
+// path.normalize(path)
+// posix version
+export function normalize(inputPath) {
+    const isPathAbsolute = isAbsolute(inputPath), trailingSlash = inputPath.slice(-1) === '/';
+    // Normalize the path
+    let path = normalizeArray(inputPath.split('/').filter((p) => !!p), !isPathAbsolute).join('/');
+    if (!path && !isPathAbsolute) {
+        path = '.';
+    }
+    if (path && trailingSlash) {
+        path += '/';
+    }
+    return (isPathAbsolute ? '/' : '') + path;
 }
-function isAbsolute(path2) {
-  return path2.charAt(0) === "/";
+// posix version
+export function isAbsolute(path) {
+    return path.charAt(0) === '/';
 }
-function join(...paths) {
-  return normalize(
-    paths.filter((p) => {
-      if (typeof p !== "string") {
-        throw new TypeError("Arguments to path.join must be strings");
-      }
-      return p;
-    }).join("/")
-  );
+// posix version
+export function join(...paths) {
+    return normalize(paths
+        .filter((p) => {
+        if (typeof p !== 'string') {
+            throw new TypeError('Arguments to path.join must be strings');
+        }
+        return p;
+    })
+        .join('/'));
 }
-function relative(from, to) {
-  const fromResolved = resolve(from).substring(1);
-  const toResolved = resolve(to).substring(1);
-  function trim(arr) {
-    let start = 0;
-    for (; start < arr.length; start++) {
-      if (arr[start] !== "") {
-        break;
-      }
-    }
-    let end = arr.length - 1;
-    for (; end >= 0; end--) {
-      if (arr[end] !== "") {
-        break;
-      }
+// path.relative(from, to)
+// posix version
+export function relative(from, to) {
+    const fromResolved = resolve(from).substring(1);
+    const toResolved = resolve(to).substring(1);
+    function trim(arr) {
+        let start = 0;
+        for (; start < arr.length; start++) {
+            if (arr[start] !== '') {
+                break;
+            }
+        }
+        let end = arr.length - 1;
+        for (; end >= 0; end--) {
+            if (arr[end] !== '') {
+                break;
+            }
+        }
+        if (start > end) {
+            return [];
+        }
+        return arr.slice(start, end - start + 1);
     }
-    if (start > end) {
-      return [];
+    const fromParts = trim(fromResolved.split('/'));
+    const toParts = trim(toResolved.split('/'));
+    const length = Math.min(fromParts.length, toParts.length);
+    let samePartsLength = length;
+    for (let i = 0; i < length; i++) {
+        if (fromParts[i] !== toParts[i]) {
+            samePartsLength = i;
+            break;
+        }
     }
-    return arr.slice(start, end - start + 1);
-  }
-  const fromParts = trim(fromResolved.split("/"));
-  const toParts = trim(toResolved.split("/"));
-  const length = Math.min(fromParts.length, toParts.length);
-  let samePartsLength = length;
-  for (let i = 0; i < length; i++) {
-    if (fromParts[i] !== toParts[i]) {
-      samePartsLength = i;
-      break;
+    let outputParts = [];
+    for (let i = samePartsLength; i < fromParts.length; i++) {
+        outputParts.push('..');
     }
-  }
-  let outputParts = [];
-  for (let i = samePartsLength; i < fromParts.length; i++) {
-    outputParts.push("..");
-  }
-  outputParts = outputParts.concat(toParts.slice(samePartsLength));
-  return outputParts.join("/");
+    outputParts = outputParts.concat(toParts.slice(samePartsLength));
+    return outputParts.join('/');
 }
-const sep = "/";
-const delimiter = ":";
-function dirname(path2) {
-  const result = splitPath(path2);
-  const root = result[0];
-  let dir = result[1];
-  if (!root && !dir) {
-    return ".";
-  }
-  if (dir) {
-    dir = dir.slice(0, -1);
-  }
-  return root + dir;
+export const sep = '/';
+export const delimiter = ':';
+export function dirname(path) {
+    const result = splitPath(path);
+    const root = result[0];
+    let dir = result[1];
+    if (!root && !dir) {
+        // No dirname whatsoever
+        return '.';
+    }
+    if (dir) {
+        // It has a dirname, strip trailing slash
+        dir = dir.slice(0, -1);
+    }
+    return root + dir;
 }
-function basename(path2, ext) {
-  let f = splitPath(path2)[2];
-  if (ext && f.slice(-ext.length) === ext) {
-    f = f.slice(0, -ext.length);
-  }
-  return f;
+export function basename(path, ext) {
+    let f = splitPath(path)[2];
+    // TODO: make this comparison case-insensitive on windows?
+    if (ext && f.slice(-ext.length) === ext) {
+        f = f.slice(0, -ext.length);
+    }
+    return f;
 }
-function extname(path2) {
-  return splitPath(path2)[3];
+export function extname(path) {
+    return splitPath(path)[3];
 }
-const path = {
-  extname,
-  basename,
-  dirname,
-  sep,
-  delimiter,
-  relative,
-  join,
-  isAbsolute,
-  normalize,
-  resolve
-};
-export {
-  basename,
-  delimiter,
-  dirname,
-  extname,
-  isAbsolute,
-  join,
-  normalize,
-  path,
-  relative,
-  resolve,
-  sep
+export const path = {
+    extname,
+    basename,
+    dirname,
+    sep,
+    delimiter,
+    relative,
+    join,
+    isAbsolute,
+    normalize,
+    resolve,
 };
-//# sourceMappingURL=path.js.map

package/dist/object/get-value-at-path.js

@@ -1,12 +1,18 @@
-function getValueAtPath(obj, pointer) {
-  return pointer.reduce((acc, part) => {
-    if (acc === void 0 || acc === null) {
-      return void 0;
-    }
-    return acc[part];
-  }, obj);
+/**
+ * Retrieves a nested value from the source document using a path array
+ *
+ * @example
+ * ```ts
+ * getValueByPath(document, ['components', 'schemas', 'User'])
+ *
+ * { id: '123', name: 'John Doe' }
+ * ```
+ */
+export function getValueAtPath(obj, pointer) {
+    return pointer.reduce((acc, part) => {
+        if (acc === undefined || acc === null) {
+            return undefined;
+        }
+        return acc[part];
+    }, obj);
 }
-export {
-  getValueAtPath
-};
-//# sourceMappingURL=get-value-at-path.js.map

package/dist/object/is-object.js

@@ -1,11 +1,25 @@
-const isObject = (value) => {
-  if (value === null || typeof value !== "object") {
-    return false;
-  }
-  const proto = Object.getPrototypeOf(value);
-  return proto === Object.prototype || proto === null;
+/**
+ * Returns true if the provided value is a record object
+ * (i.e. not null, not an array, and has an actual object as the prototype).
+ *
+ * Differs from the previous isObject in that it returns false for Date,
+ * RegExp, Error, Map, Set, WeakMap, WeakSet, Promise, and other non-plain objects.
+ *
+ * Examples:
+ *   isObject({})                  // true
+ *   isObject({ a: 1 })            // true
+ *   isObject([])                  // false (Array)
+ *   isObject(null)                // false
+ *   isObject(123)                 // false
+ *   isObject('string')            // false
+ *   isObject(new Error('test'))   // false
+ *   isObject(new Date())          // false
+ *   isObject(Object.create(null)) // true
+ */
+export const isObject = (value) => {
+    if (value === null || typeof value !== 'object') {
+        return false;
+    }
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
 };
-export {
-  isObject
-};
-//# sourceMappingURL=is-object.js.map

package/dist/object/local-storage.js

@@ -1,45 +1,53 @@
-const LS_KEYS = {
-  COLLECTION: "collection",
-  COOKIE: "cookie",
-  ENVIRONMENT: "environment",
-  REQUEST: "request",
-  REQUEST_EXAMPLE: "requestExample",
-  SECURITY_SCHEME: "securityScheme",
-  SERVER: "server",
-  TAG: "tag",
-  WORKSPACE: "workspace"
+/**
+ * localStorage keys for resources
+ * DO NOT CHANGE THESE AS IT WILL BREAK THE MIGRATION
+ */
+export const LS_KEYS = {
+    COLLECTION: 'collection',
+    COOKIE: 'cookie',
+    ENVIRONMENT: 'environment',
+    REQUEST: 'request',
+    REQUEST_EXAMPLE: 'requestExample',
+    SECURITY_SCHEME: 'securityScheme',
+    SERVER: 'server',
+    TAG: 'tag',
+    WORKSPACE: 'workspace',
 };
-const REFERENCE_LS_KEYS = {
-  /**
-   * Store the selected client as a string in localStorage
-   */
-  SELECTED_CLIENT: "scalar-reference-selected-client-v2",
-  /**
-   * Store the auth as a string in localStorage
-   */
-  AUTH: "scalar-reference-auth"
+/**
+ * localStorage keys for all reference resources
+ * to ensure we do not have any conflicts
+ */
+export const REFERENCE_LS_KEYS = {
+    /**
+     * Store the selected client as a string in localStorage
+     */
+    SELECTED_CLIENT: 'scalar-reference-selected-client-v2',
+    /**
+     * Store the auth as a string in localStorage
+     */
+    AUTH: 'scalar-reference-auth',
 };
-const CLIENT_LS_KEYS = {
-  /**
-   * @deprecated This key is deprecated and will be removed in a future release.
-   * We are now storing the entire document for the api-client instead.
-   */
-  AUTH: "scalar-client-auth",
-  /**
-   * @deprecated This key is deprecated and will be removed in a future release.
-   * We are now storing the entire document for the api-client instead.
-   */
-  SELECTED_SECURITY_SCHEMES: "scalar-client-selected-security-schemes"
+/**
+ * localStorage keys for all client resources
+ * to ensure we do not have any conflicts
+ */
+export const CLIENT_LS_KEYS = {
+    /**
+     * @deprecated This key is deprecated and will be removed in a future release.
+     * We are now storing the entire document for the api-client instead.
+     */
+    AUTH: 'scalar-client-auth',
+    /**
+     * @deprecated This key is deprecated and will be removed in a future release.
+     * We are now storing the entire document for the api-client instead.
+     */
+    SELECTED_SECURITY_SCHEMES: 'scalar-client-selected-security-schemes',
 };
-const safeLocalStorage = () => typeof window === "undefined" ? {
-  getItem: () => null,
-  setItem: () => null,
-  removeItem: () => null
-} : localStorage;
-export {
-  CLIENT_LS_KEYS,
-  LS_KEYS,
-  REFERENCE_LS_KEYS,
-  safeLocalStorage
-};
-//# sourceMappingURL=local-storage.js.map
+/** SSR safe alias for localStorage */
+export const safeLocalStorage = () => typeof window === 'undefined'
+    ? {
+        getItem: () => null,
+        setItem: () => null,
+        removeItem: () => null,
+    }
+    : localStorage;