@scalar/oas-utils/dist/helpers/merge-urls.js

Open API spec and Yaml handling utilities

import { ensureProtocol } from './ensure-protocol.js';
import { isRelativePath } from './redirect-to-proxy.js';
import { REGEX } from './regex-helpers.js';

/**
 * Merges multiple URLSearchParams objects, preserving multiple values per param
 * within each source, but later sources overwrite earlier ones completely
 * This should de-dupe our query params while allowing multiple keys for "arrays"
 */
const mergeSearchParams = (...params) => {
    // We keep a merged record to ensure the next group will overwrite the previous
    const merged = {};
    // Loops over each group and grabs unique keys
    params.forEach((p) => {
        const keys = Array.from(p.keys());
        const uniqueKeys = new Set(keys);
        uniqueKeys.forEach((key) => {
            const values = p.getAll(key);
            const value = values.length > 1 ? values : (values[0] ?? '');
            merged[key] = value;
        });
    });
    const result = new URLSearchParams();
    // We maintain multiple values for each key if they existed
    Object.entries(merged).forEach(([key, value]) => {
        if (Array.isArray(value)) {
            value.forEach((v) => result.append(key, v));
        }
        else {
            result.append(key, value);
        }
    });
    return result;
};
/** Combines a base URL and a path ensuring there's only one slash between them */
const combineUrlAndPath = (url, path) => {
    if (!path || url === path) {
        return url.trim();
    }
    if (!url) {
        return path.trim();
    }
    return `${url.trim()}/${path.trim()}`.replace(REGEX.MULTIPLE_SLASHES, '/');
};
/**
 * Creates a URL from the path and server
 * also optionally merges query params if you include urlSearchParams
 * This was re-written without using URL to support variables in the scheme
 */
const mergeUrls = (url, path, urlParams = new URLSearchParams(), 
/** To disable prefixing the url with the origin or a scheme*/
disableOriginPrefix = false) => {
    // Extract and merge all query params
    if (url && (!isRelativePath(url) || typeof window !== 'undefined')) {
        /** Prefix the url with the origin if it is relative and we wish to */
        const base = disableOriginPrefix
            ? url
            : isRelativePath(url)
                ? combineUrlAndPath(window.location.origin, url)
                : ensureProtocol(url);
        // Extract search params from base URL if any
        const [baseUrl = '', baseQuery] = base.split('?');
        const baseParams = new URLSearchParams(baseQuery || '');
        // Extract search params from path if any
        const [pathWithoutQuery = '', pathQuery] = path.split('?');
        const pathParams = new URLSearchParams(pathQuery || '');
        // Merge the baseUrl and path
        const mergedUrl = url === path ? baseUrl : combineUrlAndPath(baseUrl, pathWithoutQuery);
        // Merge all search params
        const mergedSearchParams = mergeSearchParams(baseParams, pathParams, urlParams);
        // Build the final URL
        const search = mergedSearchParams.toString();
        return search ? `${mergedUrl}?${search}` : mergedUrl;
    }
    if (path) {
        return combineUrlAndPath(url, path);
    }
    return '';
};

export { combineUrlAndPath, mergeSearchParams, mergeUrls };