matrix-react-sdk/lib/utils/WellKnownUtils.js

SDK for matrix.org using React

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.TILE_SERVER_WK_KEY = exports.SecureBackupSetupMethod = void 0;
exports.embeddedPagesFromWellKnown = embeddedPagesFromWellKnown;
exports.getCallBehaviourWellKnown = getCallBehaviourWellKnown;
exports.getE2EEWellKnown = getE2EEWellKnown;
exports.getEmbeddedPagesWellKnown = getEmbeddedPagesWellKnown;
exports.getSecureBackupSetupMethods = getSecureBackupSetupMethods;
exports.getTileServerWellKnown = getTileServerWellKnown;
exports.isSecureBackupRequired = isSecureBackupRequired;
exports.tileServerFromWellKnown = tileServerFromWellKnown;
var _NamespacedValue = require("matrix-js-sdk/src/NamespacedValue");
/*
Copyright 2024 New Vector Ltd.
Copyright 2020 The Matrix.org Foundation C.I.C.

SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/

const CALL_BEHAVIOUR_WK_KEY = "io.element.call_behaviour";
const E2EE_WK_KEY = "io.element.e2ee";
const E2EE_WK_KEY_DEPRECATED = "im.vector.riot.e2ee";
const TILE_SERVER_WK_KEY = exports.TILE_SERVER_WK_KEY = new _NamespacedValue.UnstableValue("m.tile_server", "org.matrix.msc3488.tile_server");
const EMBEDDED_PAGES_WK_PROPERTY = "io.element.embedded_pages";

/* eslint-disable camelcase */

/* eslint-enable camelcase */

function getCallBehaviourWellKnown(matrixClient) {
  const clientWellKnown = matrixClient.getClientWellKnown();
  return clientWellKnown?.[CALL_BEHAVIOUR_WK_KEY];
}
function getE2EEWellKnown(matrixClient) {
  const clientWellKnown = matrixClient.getClientWellKnown();
  if (clientWellKnown?.[E2EE_WK_KEY]) {
    return clientWellKnown[E2EE_WK_KEY];
  }
  if (clientWellKnown?.[E2EE_WK_KEY_DEPRECATED]) {
    return clientWellKnown[E2EE_WK_KEY_DEPRECATED];
  }
  return null;
}
function getTileServerWellKnown(matrixClient) {
  return tileServerFromWellKnown(matrixClient.getClientWellKnown());
}
function tileServerFromWellKnown(clientWellKnown) {
  return clientWellKnown?.[TILE_SERVER_WK_KEY.name] ?? clientWellKnown?.[TILE_SERVER_WK_KEY.altName];
}
function getEmbeddedPagesWellKnown(matrixClient) {
  return embeddedPagesFromWellKnown(matrixClient?.getClientWellKnown());
}
function embeddedPagesFromWellKnown(clientWellKnown) {
  return clientWellKnown?.[EMBEDDED_PAGES_WK_PROPERTY];
}
function isSecureBackupRequired(matrixClient) {
  return getE2EEWellKnown(matrixClient)?.["secure_backup_required"] === true;
}
let SecureBackupSetupMethod = exports.SecureBackupSetupMethod = /*#__PURE__*/function (SecureBackupSetupMethod) {
  SecureBackupSetupMethod["Key"] = "key";
  SecureBackupSetupMethod["Passphrase"] = "passphrase";
  return SecureBackupSetupMethod;
}({});
function getSecureBackupSetupMethods(matrixClient) {
  const wellKnown = getE2EEWellKnown(matrixClient);
  if (!wellKnown || !wellKnown["secure_backup_setup_methods"] || !wellKnown["secure_backup_setup_methods"].length || !(wellKnown["secure_backup_setup_methods"].includes(SecureBackupSetupMethod.Key) || wellKnown["secure_backup_setup_methods"].includes(SecureBackupSetupMethod.Passphrase))) {
    return [SecureBackupSetupMethod.Key, SecureBackupSetupMethod.Passphrase];
  }
  return wellKnown["secure_backup_setup_methods"];
}
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_NamespacedValue","require","CALL_BEHAVIOUR_WK_KEY","E2EE_WK_KEY","E2EE_WK_KEY_DEPRECATED","TILE_SERVER_WK_KEY","exports","UnstableValue","EMBEDDED_PAGES_WK_PROPERTY","getCallBehaviourWellKnown","matrixClient","clientWellKnown","getClientWellKnown","getE2EEWellKnown","getTileServerWellKnown","tileServerFromWellKnown","name","altName","getEmbeddedPagesWellKnown","embeddedPagesFromWellKnown","isSecureBackupRequired","SecureBackupSetupMethod","getSecureBackupSetupMethods","wellKnown","length","includes","Key","Passphrase"],"sources":["../../src/utils/WellKnownUtils.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2020 The Matrix.org Foundation C.I.C.\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { IClientWellKnown, MatrixClient } from \"matrix-js-sdk/src/matrix\";\nimport { UnstableValue } from \"matrix-js-sdk/src/NamespacedValue\";\n\nconst CALL_BEHAVIOUR_WK_KEY = \"io.element.call_behaviour\";\nconst E2EE_WK_KEY = \"io.element.e2ee\";\nconst E2EE_WK_KEY_DEPRECATED = \"im.vector.riot.e2ee\";\nexport const TILE_SERVER_WK_KEY = new UnstableValue(\"m.tile_server\", \"org.matrix.msc3488.tile_server\");\nconst EMBEDDED_PAGES_WK_PROPERTY = \"io.element.embedded_pages\";\n\n/* eslint-disable camelcase */\nexport interface ICallBehaviourWellKnown {\n    widget_build_url?: string;\n    ignore_dm?: boolean;\n}\n\nexport interface IE2EEWellKnown {\n    default?: boolean;\n    /**\n     * Forces the encryption to disabled for all new rooms\n     * When true, overrides configured 'default' behaviour\n     * Hides the option to enable encryption on room creation\n     * Disables the option to enable encryption in room settings for all new and existing rooms\n     */\n    force_disable?: boolean;\n    secure_backup_required?: boolean;\n    secure_backup_setup_methods?: SecureBackupSetupMethod[];\n}\n\nexport interface ITileServerWellKnown {\n    map_style_url?: string;\n}\n\nexport interface IEmbeddedPagesWellKnown {\n    home_url?: string;\n}\n/* eslint-enable camelcase */\n\nexport function getCallBehaviourWellKnown(matrixClient: MatrixClient): ICallBehaviourWellKnown {\n    const clientWellKnown = matrixClient.getClientWellKnown();\n    return clientWellKnown?.[CALL_BEHAVIOUR_WK_KEY];\n}\n\nexport function getE2EEWellKnown(matrixClient: MatrixClient): IE2EEWellKnown | null {\n    const clientWellKnown = matrixClient.getClientWellKnown();\n    if (clientWellKnown?.[E2EE_WK_KEY]) {\n        return clientWellKnown[E2EE_WK_KEY];\n    }\n    if (clientWellKnown?.[E2EE_WK_KEY_DEPRECATED]) {\n        return clientWellKnown[E2EE_WK_KEY_DEPRECATED];\n    }\n    return null;\n}\n\nexport function getTileServerWellKnown(matrixClient: MatrixClient): ITileServerWellKnown | undefined {\n    return tileServerFromWellKnown(matrixClient.getClientWellKnown());\n}\n\nexport function tileServerFromWellKnown(clientWellKnown?: IClientWellKnown | undefined): ITileServerWellKnown {\n    return clientWellKnown?.[TILE_SERVER_WK_KEY.name] ?? clientWellKnown?.[TILE_SERVER_WK_KEY.altName];\n}\n\nexport function getEmbeddedPagesWellKnown(matrixClient: MatrixClient | undefined): IEmbeddedPagesWellKnown | undefined {\n    return embeddedPagesFromWellKnown(matrixClient?.getClientWellKnown());\n}\n\nexport function embeddedPagesFromWellKnown(clientWellKnown?: IClientWellKnown): IEmbeddedPagesWellKnown {\n    return clientWellKnown?.[EMBEDDED_PAGES_WK_PROPERTY];\n}\n\nexport function isSecureBackupRequired(matrixClient: MatrixClient): boolean {\n    return getE2EEWellKnown(matrixClient)?.[\"secure_backup_required\"] === true;\n}\n\nexport enum SecureBackupSetupMethod {\n    Key = \"key\",\n    Passphrase = \"passphrase\",\n}\n\nexport function getSecureBackupSetupMethods(matrixClient: MatrixClient): SecureBackupSetupMethod[] {\n    const wellKnown = getE2EEWellKnown(matrixClient);\n    if (\n        !wellKnown ||\n        !wellKnown[\"secure_backup_setup_methods\"] ||\n        !wellKnown[\"secure_backup_setup_methods\"].length ||\n        !(\n            wellKnown[\"secure_backup_setup_methods\"].includes(SecureBackupSetupMethod.Key) ||\n            wellKnown[\"secure_backup_setup_methods\"].includes(SecureBackupSetupMethod.Passphrase)\n        )\n    ) {\n        return [SecureBackupSetupMethod.Key, SecureBackupSetupMethod.Passphrase];\n    }\n    return wellKnown[\"secure_backup_setup_methods\"];\n}\n"],"mappings":";;;;;;;;;;;;;;AASA,IAAAA,gBAAA,GAAAC,OAAA;AATA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA,MAAMC,qBAAqB,GAAG,2BAA2B;AACzD,MAAMC,WAAW,GAAG,iBAAiB;AACrC,MAAMC,sBAAsB,GAAG,qBAAqB;AAC7C,MAAMC,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,GAAG,IAAIE,8BAAa,CAAC,eAAe,EAAE,gCAAgC,CAAC;AACtG,MAAMC,0BAA0B,GAAG,2BAA2B;;AAE9D;;AA0BA;;AAEO,SAASC,yBAAyBA,CAACC,YAA0B,EAA2B;EAC3F,MAAMC,eAAe,GAAGD,YAAY,CAACE,kBAAkB,CAAC,CAAC;EACzD,OAAOD,eAAe,GAAGT,qBAAqB,CAAC;AACnD;AAEO,SAASW,gBAAgBA,CAACH,YAA0B,EAAyB;EAChF,MAAMC,eAAe,GAAGD,YAAY,CAACE,kBAAkB,CAAC,CAAC;EACzD,IAAID,eAAe,GAAGR,WAAW,CAAC,EAAE;IAChC,OAAOQ,eAAe,CAACR,WAAW,CAAC;EACvC;EACA,IAAIQ,eAAe,GAAGP,sBAAsB,CAAC,EAAE;IAC3C,OAAOO,eAAe,CAACP,sBAAsB,CAAC;EAClD;EACA,OAAO,IAAI;AACf;AAEO,SAASU,sBAAsBA,CAACJ,YAA0B,EAAoC;EACjG,OAAOK,uBAAuB,CAACL,YAAY,CAACE,kBAAkB,CAAC,CAAC,CAAC;AACrE;AAEO,SAASG,uBAAuBA,CAACJ,eAA8C,EAAwB;EAC1G,OAAOA,eAAe,GAAGN,kBAAkB,CAACW,IAAI,CAAC,IAAIL,eAAe,GAAGN,kBAAkB,CAACY,OAAO,CAAC;AACtG;AAEO,SAASC,yBAAyBA,CAACR,YAAsC,EAAuC;EACnH,OAAOS,0BAA0B,CAACT,YAAY,EAAEE,kBAAkB,CAAC,CAAC,CAAC;AACzE;AAEO,SAASO,0BAA0BA,CAACR,eAAkC,EAA2B;EACpG,OAAOA,eAAe,GAAGH,0BAA0B,CAAC;AACxD;AAEO,SAASY,sBAAsBA,CAACV,YAA0B,EAAW;EACxE,OAAOG,gBAAgB,CAACH,YAAY,CAAC,GAAG,wBAAwB,CAAC,KAAK,IAAI;AAC9E;AAAC,IAEWW,uBAAuB,GAAAf,OAAA,CAAAe,uBAAA,0BAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAA,OAAvBA,uBAAuB;AAAA;AAK5B,SAASC,2BAA2BA,CAACZ,YAA0B,EAA6B;EAC/F,MAAMa,SAAS,GAAGV,gBAAgB,CAACH,YAAY,CAAC;EAChD,IACI,CAACa,SAAS,IACV,CAACA,SAAS,CAAC,6BAA6B,CAAC,IACzC,CAACA,SAAS,CAAC,6BAA6B,CAAC,CAACC,MAAM,IAChD,EACID,SAAS,CAAC,6BAA6B,CAAC,CAACE,QAAQ,CAACJ,uBAAuB,CAACK,GAAG,CAAC,IAC9EH,SAAS,CAAC,6BAA6B,CAAC,CAACE,QAAQ,CAACJ,uBAAuB,CAACM,UAAU,CAAC,CACxF,EACH;IACE,OAAO,CAACN,uBAAuB,CAACK,GAAG,EAAEL,uBAAuB,CAACM,UAAU,CAAC;EAC5E;EACA,OAAOJ,SAAS,CAAC,6BAA6B,CAAC;AACnD","ignoreList":[]}