@wireapp/commons/lib/util/UrlUtil.js

Collection of common components that are used across Wire web applications.

"use strict";
/*
 * Wire
 * Copyright (C) 2018 Wire Swiss GmbH
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://www.gnu.org/licenses/.
 *
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.pathWithParams = pathWithParams;
exports.paramsToRecord = paramsToRecord;
exports.getURLParameter = getURLParameter;
exports.getURLParameterFromHash = getURLParameterFromHash;
exports.getURLParameterFromAny = getURLParameterFromAny;
exports.hasURLParameter = hasURLParameter;
function pathWithParams(path, additionalParams, whitelistParams, search = window.location.search) {
    const params = paramsToRecord(search);
    if (additionalParams) {
        Object.assign(params, additionalParams);
    }
    if (whitelistParams) {
        Object.keys(params).forEach(key => {
            if (!whitelistParams.includes(key)) {
                delete params[key];
            }
        });
    }
    const queryString = new URLSearchParams(params).toString();
    return `${path}${queryString ? `?${queryString}` : ''}`;
}
function paramsToRecord(params) {
    const records = {};
    new URLSearchParams(params).forEach((value, key) => {
        records[key] = value;
    });
    return records;
}
/**
 * Looks for a given parameter by name in the query part of the URL of the current window's location.
 * @param parameterName the name of the parameter to search for
 * @param search the source to look at for the parameter, defaults to window.location.search
 * @returns the first found parameter or an empty string
 */
function getURLParameter(parameterName, search = window.location.search) {
    return new URLSearchParams(search).get(parameterName) || '';
}
/**
 * Looks for a given parameter by name in the hash part of the URL of the current window's location.
 * @param parameterName the name of the parameter to search for
 * @param hash the source to look for at the parameter, defaults to window.location.hash
 * @returns the first found parameter or an empty string
 */
function getURLParameterFromHash(parameterName, hash = window.location.hash) {
    // window.location.hash always starts with #
    if (hash.length <= 1 || hash[0] !== '#') {
        return '';
    }
    return new URLSearchParams(hash.substring(1)).get(parameterName) || '';
}
/**
 * Looks for a given parameter by name in the hash and query part of the URL of the current window's location.
 * Findings in the hash part are preferend ver the query part.
 * Empty values are considered a valid value.
 * @param parameterName the name of the parameter to search for
 * @param hash the "hash" source to look for at the parameter, defaults to window.location.hash
 * @param search the "search" source to look at for the parameter, defaults to window.location.search
 * @returns the first found parameter or an empty string
 */
function getURLParameterFromAny(parameterName, hash = window.location.hash, search = window.location.search) {
    // getURLParameterFromHash cannot be used here, as it will always return an empty string, even if the value is not set.
    // a decision whether the value was set or not is then no longer possible.
    // window.location.hash always starts with #
    if (hash.length > 1 && hash[0] === '#') {
        const result = new URLSearchParams(hash.substring(1)).get(parameterName);
        if (result !== null) {
            return result;
        }
    }
    return getURLParameter(parameterName, search);
}
function hasURLParameter(parameterName, search = window.location.search) {
    return !!new URLSearchParams(search).has(parameterName);
}