matrix-react-sdk
Version:
SDK for matrix.org using React
100 lines (92 loc) • 12.9 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.removeClientInformation = exports.recordClientInformation = exports.pruneClientInformation = exports.getDeviceClientInformation = exports.getClientInformationEventType = void 0;
/*
Copyright 2024 New Vector Ltd.
Copyright 2022 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 formatUrl = () => {
// don't record url for electron clients
if (window.electron) {
return undefined;
}
// strip query-string and fragment from uri
const url = new URL(window.location.href);
return [url.host, url.pathname.replace(/\/$/, "") // Remove trailing slash if present
].join("");
};
const clientInformationEventPrefix = "io.element.matrix_client_information.";
const getClientInformationEventType = deviceId => `${clientInformationEventPrefix}${deviceId}`;
/**
* Record extra client information for the current device
* https://github.com/vector-im/element-meta/blob/develop/spec/matrix_client_information.md
*/
exports.getClientInformationEventType = getClientInformationEventType;
const recordClientInformation = async (matrixClient, sdkConfig, platform) => {
const deviceId = matrixClient.getDeviceId();
const {
brand
} = sdkConfig;
const version = await platform?.getAppVersion();
const type = getClientInformationEventType(deviceId);
const url = formatUrl();
await matrixClient.setAccountData(type, {
name: brand,
version,
url
});
};
/**
* Remove client information events for devices that no longer exist
* @param validDeviceIds - ids of current devices,
* client information for devices NOT in this list will be removed
*/
exports.recordClientInformation = recordClientInformation;
const pruneClientInformation = (validDeviceIds, matrixClient) => {
Array.from(matrixClient.store.accountData.values()).forEach(event => {
if (!event.getType().startsWith(clientInformationEventPrefix)) {
return;
}
const [, deviceId] = event.getType().split(clientInformationEventPrefix);
if (deviceId && !validDeviceIds.includes(deviceId)) {
matrixClient.deleteAccountData(event.getType());
}
});
};
/**
* Remove extra client information for current device
*/
exports.pruneClientInformation = pruneClientInformation;
const removeClientInformation = async matrixClient => {
const deviceId = matrixClient.getDeviceId();
const type = getClientInformationEventType(deviceId);
const clientInformation = getDeviceClientInformation(matrixClient, deviceId);
// if a non-empty client info event exists, remove it
if (clientInformation.name || clientInformation.version || clientInformation.url) {
await matrixClient.deleteAccountData(type);
}
};
exports.removeClientInformation = removeClientInformation;
const sanitizeContentString = value => value && typeof value === "string" ? value : undefined;
const getDeviceClientInformation = (matrixClient, deviceId) => {
const event = matrixClient.getAccountData(getClientInformationEventType(deviceId));
if (!event) {
return {};
}
const {
name,
version,
url
} = event.getContent();
return {
name: sanitizeContentString(name),
version: sanitizeContentString(version),
url: sanitizeContentString(url)
};
};
exports.getDeviceClientInformation = getDeviceClientInformation;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["formatUrl","window","electron","undefined","url","URL","location","href","host","pathname","replace","join","clientInformationEventPrefix","getClientInformationEventType","deviceId","exports","recordClientInformation","matrixClient","sdkConfig","platform","getDeviceId","brand","version","getAppVersion","type","setAccountData","name","pruneClientInformation","validDeviceIds","Array","from","store","accountData","values","forEach","event","getType","startsWith","split","includes","deleteAccountData","removeClientInformation","clientInformation","getDeviceClientInformation","sanitizeContentString","value","getAccountData","getContent"],"sources":["../../../src/utils/device/clientInformation.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2022 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 { MatrixClient } from \"matrix-js-sdk/src/matrix\";\n\nimport BasePlatform from \"../../BasePlatform\";\nimport { IConfigOptions } from \"../../IConfigOptions\";\nimport { DeepReadonly } from \"../../@types/common\";\n\nexport type DeviceClientInformation = {\n    name?: string;\n    version?: string;\n    url?: string;\n};\n\nconst formatUrl = (): string | undefined => {\n    // don't record url for electron clients\n    if (window.electron) {\n        return undefined;\n    }\n\n    // strip query-string and fragment from uri\n    const url = new URL(window.location.href);\n\n    return [\n        url.host,\n        url.pathname.replace(/\\/$/, \"\"), // Remove trailing slash if present\n    ].join(\"\");\n};\n\nconst clientInformationEventPrefix = \"io.element.matrix_client_information.\";\nexport const getClientInformationEventType = (deviceId: string): string => `${clientInformationEventPrefix}${deviceId}`;\n\n/**\n * Record extra client information for the current device\n * https://github.com/vector-im/element-meta/blob/develop/spec/matrix_client_information.md\n */\nexport const recordClientInformation = async (\n    matrixClient: MatrixClient,\n    sdkConfig: DeepReadonly<IConfigOptions>,\n    platform?: BasePlatform,\n): Promise<void> => {\n    const deviceId = matrixClient.getDeviceId()!;\n    const { brand } = sdkConfig;\n    const version = await platform?.getAppVersion();\n    const type = getClientInformationEventType(deviceId);\n    const url = formatUrl();\n\n    await matrixClient.setAccountData(type, {\n        name: brand,\n        version,\n        url,\n    });\n};\n\n/**\n * Remove client information events for devices that no longer exist\n * @param validDeviceIds - ids of current devices,\n *                      client information for devices NOT in this list will be removed\n */\nexport const pruneClientInformation = (validDeviceIds: string[], matrixClient: MatrixClient): void => {\n    Array.from(matrixClient.store.accountData.values()).forEach((event) => {\n        if (!event.getType().startsWith(clientInformationEventPrefix)) {\n            return;\n        }\n        const [, deviceId] = event.getType().split(clientInformationEventPrefix);\n        if (deviceId && !validDeviceIds.includes(deviceId)) {\n            matrixClient.deleteAccountData(event.getType());\n        }\n    });\n};\n\n/**\n * Remove extra client information for current device\n */\nexport const removeClientInformation = async (matrixClient: MatrixClient): Promise<void> => {\n    const deviceId = matrixClient.getDeviceId()!;\n    const type = getClientInformationEventType(deviceId);\n    const clientInformation = getDeviceClientInformation(matrixClient, deviceId);\n\n    // if a non-empty client info event exists, remove it\n    if (clientInformation.name || clientInformation.version || clientInformation.url) {\n        await matrixClient.deleteAccountData(type);\n    }\n};\n\nconst sanitizeContentString = (value: unknown): string | undefined =>\n    value && typeof value === \"string\" ? value : undefined;\n\nexport const getDeviceClientInformation = (matrixClient: MatrixClient, deviceId: string): DeviceClientInformation => {\n    const event = matrixClient.getAccountData(getClientInformationEventType(deviceId));\n\n    if (!event) {\n        return {};\n    }\n\n    const { name, version, url } = event.getContent();\n\n    return {\n        name: sanitizeContentString(name),\n        version: sanitizeContentString(version),\n        url: sanitizeContentString(url),\n    };\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA,MAAMA,SAAS,GAAGA,CAAA,KAA0B;EACxC;EACA,IAAIC,MAAM,CAACC,QAAQ,EAAE;IACjB,OAAOC,SAAS;EACpB;;EAEA;EACA,MAAMC,GAAG,GAAG,IAAIC,GAAG,CAACJ,MAAM,CAACK,QAAQ,CAACC,IAAI,CAAC;EAEzC,OAAO,CACHH,GAAG,CAACI,IAAI,EACRJ,GAAG,CAACK,QAAQ,CAACC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAE;EAAA,CACpC,CAACC,IAAI,CAAC,EAAE,CAAC;AACd,CAAC;AAED,MAAMC,4BAA4B,GAAG,uCAAuC;AACrE,MAAMC,6BAA6B,GAAIC,QAAgB,IAAa,GAAGF,4BAA4B,GAAGE,QAAQ,EAAE;;AAEvH;AACA;AACA;AACA;AAHAC,OAAA,CAAAF,6BAAA,GAAAA,6BAAA;AAIO,MAAMG,uBAAuB,GAAG,MAAAA,CACnCC,YAA0B,EAC1BC,SAAuC,EACvCC,QAAuB,KACP;EAChB,MAAML,QAAQ,GAAGG,YAAY,CAACG,WAAW,CAAC,CAAE;EAC5C,MAAM;IAAEC;EAAM,CAAC,GAAGH,SAAS;EAC3B,MAAMI,OAAO,GAAG,MAAMH,QAAQ,EAAEI,aAAa,CAAC,CAAC;EAC/C,MAAMC,IAAI,GAAGX,6BAA6B,CAACC,QAAQ,CAAC;EACpD,MAAMV,GAAG,GAAGJ,SAAS,CAAC,CAAC;EAEvB,MAAMiB,YAAY,CAACQ,cAAc,CAACD,IAAI,EAAE;IACpCE,IAAI,EAAEL,KAAK;IACXC,OAAO;IACPlB;EACJ,CAAC,CAAC;AACN,CAAC;;AAED;AACA;AACA;AACA;AACA;AAJAW,OAAA,CAAAC,uBAAA,GAAAA,uBAAA;AAKO,MAAMW,sBAAsB,GAAGA,CAACC,cAAwB,EAAEX,YAA0B,KAAW;EAClGY,KAAK,CAACC,IAAI,CAACb,YAAY,CAACc,KAAK,CAACC,WAAW,CAACC,MAAM,CAAC,CAAC,CAAC,CAACC,OAAO,CAAEC,KAAK,IAAK;IACnE,IAAI,CAACA,KAAK,CAACC,OAAO,CAAC,CAAC,CAACC,UAAU,CAACzB,4BAA4B,CAAC,EAAE;MAC3D;IACJ;IACA,MAAM,GAAGE,QAAQ,CAAC,GAAGqB,KAAK,CAACC,OAAO,CAAC,CAAC,CAACE,KAAK,CAAC1B,4BAA4B,CAAC;IACxE,IAAIE,QAAQ,IAAI,CAACc,cAAc,CAACW,QAAQ,CAACzB,QAAQ,CAAC,EAAE;MAChDG,YAAY,CAACuB,iBAAiB,CAACL,KAAK,CAACC,OAAO,CAAC,CAAC,CAAC;IACnD;EACJ,CAAC,CAAC;AACN,CAAC;;AAED;AACA;AACA;AAFArB,OAAA,CAAAY,sBAAA,GAAAA,sBAAA;AAGO,MAAMc,uBAAuB,GAAG,MAAOxB,YAA0B,IAAoB;EACxF,MAAMH,QAAQ,GAAGG,YAAY,CAACG,WAAW,CAAC,CAAE;EAC5C,MAAMI,IAAI,GAAGX,6BAA6B,CAACC,QAAQ,CAAC;EACpD,MAAM4B,iBAAiB,GAAGC,0BAA0B,CAAC1B,YAAY,EAAEH,QAAQ,CAAC;;EAE5E;EACA,IAAI4B,iBAAiB,CAAChB,IAAI,IAAIgB,iBAAiB,CAACpB,OAAO,IAAIoB,iBAAiB,CAACtC,GAAG,EAAE;IAC9E,MAAMa,YAAY,CAACuB,iBAAiB,CAAChB,IAAI,CAAC;EAC9C;AACJ,CAAC;AAACT,OAAA,CAAA0B,uBAAA,GAAAA,uBAAA;AAEF,MAAMG,qBAAqB,GAAIC,KAAc,IACzCA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,GAAGA,KAAK,GAAG1C,SAAS;AAEnD,MAAMwC,0BAA0B,GAAGA,CAAC1B,YAA0B,EAAEH,QAAgB,KAA8B;EACjH,MAAMqB,KAAK,GAAGlB,YAAY,CAAC6B,cAAc,CAACjC,6BAA6B,CAACC,QAAQ,CAAC,CAAC;EAElF,IAAI,CAACqB,KAAK,EAAE;IACR,OAAO,CAAC,CAAC;EACb;EAEA,MAAM;IAAET,IAAI;IAAEJ,OAAO;IAAElB;EAAI,CAAC,GAAG+B,KAAK,CAACY,UAAU,CAAC,CAAC;EAEjD,OAAO;IACHrB,IAAI,EAAEkB,qBAAqB,CAAClB,IAAI,CAAC;IACjCJ,OAAO,EAAEsB,qBAAqB,CAACtB,OAAO,CAAC;IACvClB,GAAG,EAAEwC,qBAAqB,CAACxC,GAAG;EAClC,CAAC;AACL,CAAC;AAACW,OAAA,CAAA4B,0BAAA,GAAAA,0BAAA","ignoreList":[]}