element-web/src/SdkConfig.ts

/*
Copyright 2016 OpenMarket Ltd
Copyright 2019 - 2021 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

export interface ISsoRedirectOptions {
    immediate?: boolean;
    on_welcome_page?: boolean; // eslint-disable-line camelcase
}

/* eslint-disable camelcase */
export interface ConfigOptions {
    [key: string]: any;

    logout_redirect_url?: string;

    // sso_immediate_redirect is deprecated in favour of sso_redirect_options.immediate
    sso_immediate_redirect?: boolean;
    sso_redirect_options?: ISsoRedirectOptions;

    custom_translations_url?: string;
}
/* eslint-enable camelcase*/

export const DEFAULTS: ConfigOptions = {
    // Brand name of the app
    brand: "Element",
    // URL to a page we show in an iframe to configure integrations
    integrations_ui_url: "https://scalar.vector.im/",
    // Base URL to the REST interface of the integrations server
    integrations_rest_url: "https://scalar.vector.im/api",
    // Where to send bug reports. If not specified, bugs cannot be sent.
    bug_report_endpoint_url: null,
    // Jitsi conference options
    jitsi: {
        // Default conference domain
        preferredDomain: "meet.element.io",
    },
    desktopBuilds: {
        available: true,
        logo: require("../res/img/element-desktop-logo.svg"),
        url: "https://element.io/get-started",
    },
};

export default class SdkConfig {
    private static instance: ConfigOptions;

    private static setInstance(i: ConfigOptions) {
        SdkConfig.instance = i;

        // For debugging purposes
        window.mxReactSdkConfig = i;
    }

    public static get() {
        return SdkConfig.instance || {};
    }

    public static put(cfg: ConfigOptions) {
        const defaultKeys = Object.keys(DEFAULTS);
        for (let i = 0; i < defaultKeys.length; ++i) {
            if (cfg[defaultKeys[i]] === undefined) {
                cfg[defaultKeys[i]] = DEFAULTS[defaultKeys[i]];
            }
        }
        SdkConfig.setInstance(cfg);
    }

    public static unset() {
        SdkConfig.setInstance({});
    }

    public static add(cfg: ConfigOptions) {
        const liveConfig = SdkConfig.get();
        const newConfig = Object.assign({}, liveConfig, cfg);
        SdkConfig.put(newConfig);
    }
}

export function parseSsoRedirectOptions(config: ConfigOptions): ISsoRedirectOptions {
    // Ignore deprecated options if the config is using new ones
    if (config.sso_redirect_options) return config.sso_redirect_options;

    // We can cheat here because the default is false anyways
    if (config.sso_immediate_redirect) return { immediate: true };

    // Default: do nothing
    return {};
}