mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-18 14:44:58 +08:00
d8a939df5d
* Document and support the established naming convention for config opts This change: * Rename `ConfigOptions` to `IConfigOptions` to match code convention/style, plus move it to a dedicated file * Update comments and surrounding documentation * Define every single documented option (from element-web's config.md) * Enable a linter to enforce the convention * Invent a translation layer for a different change to use * No attempt to fix build errors from doing this (at this stage) * Add demo of lint rule in action * Fix all obvious instances of SdkConfig case conflicts * Fix tests to use SdkConfig directly * Add docs to make unset() calling safer * Appease the linter * Update documentation to match snake_case_config * Fix more instances of square brackets off SdkConfig
51 lines
1.8 KiB
TypeScript
51 lines
1.8 KiB
TypeScript
/*
|
|
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.
|
|
*/
|
|
|
|
import { logger } from "matrix-js-sdk/src/logger";
|
|
|
|
import { IConfigOptions } from "../IConfigOptions";
|
|
import { SnakedObject } from "./SnakedObject";
|
|
|
|
export function getHomePageUrl(appConfig: IConfigOptions): string | null {
|
|
const config = new SnakedObject(appConfig);
|
|
|
|
const pagesConfig = config.get("embedded_pages");
|
|
let pageUrl = pagesConfig ? (new SnakedObject(pagesConfig).get("home_url")) : null;
|
|
|
|
if (!pageUrl) {
|
|
// This is a deprecated config option for the home page
|
|
// (despite the name, given we also now have a welcome
|
|
// page, which is not the same).
|
|
pageUrl = (<any>appConfig).welcomePageUrl;
|
|
if (pageUrl) {
|
|
logger.warn(
|
|
"You are using a deprecated config option: `welcomePageUrl`. Please use " +
|
|
"`embedded_pages.home_url` instead, per https://github.com/vector-im/element-web/issues/21428",
|
|
);
|
|
}
|
|
}
|
|
|
|
return pageUrl;
|
|
}
|
|
|
|
export function shouldUseLoginForWelcome(appConfig: IConfigOptions): boolean {
|
|
const config = new SnakedObject(appConfig);
|
|
const pagesConfig = config.get("embedded_pages");
|
|
return pagesConfig
|
|
? ((new SnakedObject(pagesConfig).get("login_for_welcome")) === true)
|
|
: false;
|
|
}
|