@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/content-helpers.js

@@ -0,0 +1,250 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2018 - 2022 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 { MsgType } from "./@types/event.js";
+import { M_TEXT, REFERENCE_RELATION } from "./@types/extensible_events.js";
+import { isProvided } from "./extensible_events_v1/utilities.js";
+import { M_ASSET, LocationAssetType, M_LOCATION, M_TIMESTAMP } from "./@types/location.js";
+import { M_TOPIC } from "./@types/topic.js";
+/**
+ * Generates the content for a HTML Message event
+ * @param body - the plaintext body of the message
+ * @param htmlBody - the HTML representation of the message
+ * @returns
+ */
+export function makeHtmlMessage(body, htmlBody) {
+  return {
+    msgtype: MsgType.Text,
+    format: "org.matrix.custom.html",
+    body: body,
+    formatted_body: htmlBody
+  };
+}
+
+/**
+ * Generates the content for a HTML Notice event
+ * @param body - the plaintext body of the notice
+ * @param htmlBody - the HTML representation of the notice
+ * @returns
+ */
+export function makeHtmlNotice(body, htmlBody) {
+  return {
+    msgtype: MsgType.Notice,
+    format: "org.matrix.custom.html",
+    body: body,
+    formatted_body: htmlBody
+  };
+}
+
+/**
+ * Generates the content for a HTML Emote event
+ * @param body - the plaintext body of the emote
+ * @param htmlBody - the HTML representation of the emote
+ * @returns
+ */
+export function makeHtmlEmote(body, htmlBody) {
+  return {
+    msgtype: MsgType.Emote,
+    format: "org.matrix.custom.html",
+    body: body,
+    formatted_body: htmlBody
+  };
+}
+
+/**
+ * Generates the content for a Plaintext Message event
+ * @param body - the plaintext body of the emote
+ * @returns
+ */
+export function makeTextMessage(body) {
+  return {
+    msgtype: MsgType.Text,
+    body: body
+  };
+}
+
+/**
+ * Generates the content for a Plaintext Notice event
+ * @param body - the plaintext body of the notice
+ * @returns
+ */
+export function makeNotice(body) {
+  return {
+    msgtype: MsgType.Notice,
+    body: body
+  };
+}
+
+/**
+ * Generates the content for a Plaintext Emote event
+ * @param body - the plaintext body of the emote
+ * @returns
+ */
+export function makeEmoteMessage(body) {
+  return {
+    msgtype: MsgType.Emote,
+    body: body
+  };
+}
+
+/** Location content helpers */
+
+export var getTextForLocationEvent = (uri, assetType, timestamp, description) => {
+  var date = "at ".concat(new Date(timestamp).toISOString());
+  var assetName = assetType === LocationAssetType.Self ? "User" : undefined;
+  var quotedDescription = description ? "\"".concat(description, "\"") : undefined;
+  return [assetName, "Location", quotedDescription, uri, date].filter(Boolean).join(" ");
+};
+
+/**
+ * Generates the content for a Location event
+ * @param uri - a geo:// uri for the location
+ * @param timestamp - the timestamp when the location was correct (milliseconds since the UNIX epoch)
+ * @param description - the (optional) label for this location on the map
+ * @param assetType - the (optional) asset type of this location e.g. "m.self"
+ * @param text - optional. A text for the location
+ */
+export var makeLocationContent = (text, uri, timestamp, description, assetType) => {
+  var defaultedText = text !== null && text !== void 0 ? text : getTextForLocationEvent(uri, assetType || LocationAssetType.Self, timestamp, description);
+  var timestampEvent = timestamp ? {
+    [M_TIMESTAMP.name]: timestamp
+  } : {};
+  return _objectSpread({
+    msgtype: MsgType.Location,
+    body: defaultedText,
+    geo_uri: uri,
+    [M_LOCATION.name]: {
+      description,
+      uri
+    },
+    [M_ASSET.name]: {
+      type: assetType || LocationAssetType.Self
+    },
+    [M_TEXT.name]: defaultedText
+  }, timestampEvent);
+};
+
+/**
+ * Parse location event content and transform to
+ * a backwards compatible modern m.location event format
+ */
+export var parseLocationEvent = wireEventContent => {
+  var _location$uri, _asset$type;
+  var location = M_LOCATION.findIn(wireEventContent);
+  var asset = M_ASSET.findIn(wireEventContent);
+  var timestamp = M_TIMESTAMP.findIn(wireEventContent);
+  var text = M_TEXT.findIn(wireEventContent);
+  var geoUri = (_location$uri = location === null || location === void 0 ? void 0 : location.uri) !== null && _location$uri !== void 0 ? _location$uri : wireEventContent === null || wireEventContent === void 0 ? void 0 : wireEventContent.geo_uri;
+  var description = location === null || location === void 0 ? void 0 : location.description;
+  var assetType = (_asset$type = asset === null || asset === void 0 ? void 0 : asset.type) !== null && _asset$type !== void 0 ? _asset$type : LocationAssetType.Self;
+  var fallbackText = text !== null && text !== void 0 ? text : wireEventContent.body;
+  return makeLocationContent(fallbackText, geoUri, timestamp !== null && timestamp !== void 0 ? timestamp : undefined, description, assetType);
+};
+
+/**
+ * Topic event helpers
+ */
+
+export var makeTopicContent = (topic, htmlTopic) => {
+  var renderings = [{
+    body: topic,
+    mimetype: "text/plain"
+  }];
+  if (isProvided(htmlTopic)) {
+    renderings.push({
+      body: htmlTopic,
+      mimetype: "text/html"
+    });
+  }
+  return {
+    topic,
+    [M_TOPIC.name]: renderings
+  };
+};
+export var parseTopicContent = content => {
+  var _mtopic$find$body, _mtopic$find, _mtopic$find2;
+  var mtopic = M_TOPIC.findIn(content);
+  if (!Array.isArray(mtopic)) {
+    return {
+      text: content.topic
+    };
+  }
+  var text = (_mtopic$find$body = mtopic === null || mtopic === void 0 || (_mtopic$find = mtopic.find(r => !isProvided(r.mimetype) || r.mimetype === "text/plain")) === null || _mtopic$find === void 0 ? void 0 : _mtopic$find.body) !== null && _mtopic$find$body !== void 0 ? _mtopic$find$body : content.topic;
+  var html = mtopic === null || mtopic === void 0 || (_mtopic$find2 = mtopic.find(r => r.mimetype === "text/html")) === null || _mtopic$find2 === void 0 ? void 0 : _mtopic$find2.body;
+  return {
+    text,
+    html
+  };
+};
+
+/**
+ * Beacon event helpers
+ */
+
+export var makeBeaconInfoContent = (timeout, isLive, description, assetType, timestamp) => ({
+  description,
+  timeout,
+  live: isLive,
+  [M_TIMESTAMP.name]: timestamp || Date.now(),
+  [M_ASSET.name]: {
+    type: assetType !== null && assetType !== void 0 ? assetType : LocationAssetType.Self
+  }
+});
+/**
+ * Flatten beacon info event content
+ */
+export var parseBeaconInfoContent = content => {
+  var _M_TIMESTAMP$findIn;
+  var {
+    description,
+    timeout,
+    live
+  } = content;
+  var timestamp = (_M_TIMESTAMP$findIn = M_TIMESTAMP.findIn(content)) !== null && _M_TIMESTAMP$findIn !== void 0 ? _M_TIMESTAMP$findIn : undefined;
+  var asset = M_ASSET.findIn(content);
+  return {
+    description,
+    timeout,
+    live,
+    assetType: asset === null || asset === void 0 ? void 0 : asset.type,
+    timestamp
+  };
+};
+export var makeBeaconContent = (uri, timestamp, beaconInfoEventId, description) => ({
+  [M_LOCATION.name]: {
+    description,
+    uri
+  },
+  [M_TIMESTAMP.name]: timestamp,
+  "m.relates_to": {
+    rel_type: REFERENCE_RELATION.name,
+    event_id: beaconInfoEventId
+  }
+});
+export var parseBeaconContent = content => {
+  var _M_TIMESTAMP$findIn2;
+  var location = M_LOCATION.findIn(content);
+  var timestamp = (_M_TIMESTAMP$findIn2 = M_TIMESTAMP.findIn(content)) !== null && _M_TIMESTAMP$findIn2 !== void 0 ? _M_TIMESTAMP$findIn2 : undefined;
+  return {
+    description: location === null || location === void 0 ? void 0 : location.description,
+    uri: location === null || location === void 0 ? void 0 : location.uri,
+    timestamp
+  };
+};
+//# sourceMappingURL=content-helpers.js.map

package/lib/content-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-helpers.js","names":["MsgType","M_TEXT","REFERENCE_RELATION","isProvided","M_ASSET","LocationAssetType","M_LOCATION","M_TIMESTAMP","M_TOPIC","makeHtmlMessage","body","htmlBody","msgtype","Text","format","formatted_body","makeHtmlNotice","Notice","makeHtmlEmote","Emote","makeTextMessage","makeNotice","makeEmoteMessage","getTextForLocationEvent","uri","assetType","timestamp","description","date","concat","Date","toISOString","assetName","Self","undefined","quotedDescription","filter","Boolean","join","makeLocationContent","text","defaultedText","timestampEvent","name","_objectSpread","Location","geo_uri","type","parseLocationEvent","wireEventContent","_location$uri","_asset$type","location","findIn","asset","geoUri","fallbackText","makeTopicContent","topic","htmlTopic","renderings","mimetype","push","parseTopicContent","content","_mtopic$find$body","_mtopic$find","_mtopic$find2","mtopic","Array","isArray","find","r","html","makeBeaconInfoContent","timeout","isLive","live","now","parseBeaconInfoContent","_M_TIMESTAMP$findIn","makeBeaconContent","beaconInfoEventId","rel_type","event_id","parseBeaconContent","_M_TIMESTAMP$findIn2"],"sources":["../src/content-helpers.ts"],"sourcesContent":["/*\nCopyright 2018 - 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { MBeaconEventContent, MBeaconInfoContent, MBeaconInfoEventContent } from \"./@types/beacon.ts\";\nimport { MsgType } from \"./@types/event.ts\";\nimport { M_TEXT, REFERENCE_RELATION } from \"./@types/extensible_events.ts\";\nimport { isProvided } from \"./extensible_events_v1/utilities.ts\";\nimport {\n    M_ASSET,\n    LocationAssetType,\n    M_LOCATION,\n    M_TIMESTAMP,\n    LocationEventWireContent,\n    MLocationEventContent,\n    MLocationContent,\n    MAssetContent,\n    LegacyLocationEventContent,\n} from \"./@types/location.ts\";\nimport { MRoomTopicEventContent, MTopicContent, M_TOPIC } from \"./@types/topic.ts\";\nimport { RoomMessageEventContent } from \"./@types/events.ts\";\n\n/**\n * Generates the content for a HTML Message event\n * @param body - the plaintext body of the message\n * @param htmlBody - the HTML representation of the message\n * @returns\n */\nexport function makeHtmlMessage(body: string, htmlBody: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Text,\n        format: \"org.matrix.custom.html\",\n        body: body,\n        formatted_body: htmlBody,\n    };\n}\n\n/**\n * Generates the content for a HTML Notice event\n * @param body - the plaintext body of the notice\n * @param htmlBody - the HTML representation of the notice\n * @returns\n */\nexport function makeHtmlNotice(body: string, htmlBody: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Notice,\n        format: \"org.matrix.custom.html\",\n        body: body,\n        formatted_body: htmlBody,\n    };\n}\n\n/**\n * Generates the content for a HTML Emote event\n * @param body - the plaintext body of the emote\n * @param htmlBody - the HTML representation of the emote\n * @returns\n */\nexport function makeHtmlEmote(body: string, htmlBody: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Emote,\n        format: \"org.matrix.custom.html\",\n        body: body,\n        formatted_body: htmlBody,\n    };\n}\n\n/**\n * Generates the content for a Plaintext Message event\n * @param body - the plaintext body of the emote\n * @returns\n */\nexport function makeTextMessage(body: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Text,\n        body: body,\n    };\n}\n\n/**\n * Generates the content for a Plaintext Notice event\n * @param body - the plaintext body of the notice\n * @returns\n */\nexport function makeNotice(body: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Notice,\n        body: body,\n    };\n}\n\n/**\n * Generates the content for a Plaintext Emote event\n * @param body - the plaintext body of the emote\n * @returns\n */\nexport function makeEmoteMessage(body: string): RoomMessageEventContent {\n    return {\n        msgtype: MsgType.Emote,\n        body: body,\n    };\n}\n\n/** Location content helpers */\n\nexport const getTextForLocationEvent = (\n    uri: string | undefined,\n    assetType: LocationAssetType,\n    timestamp?: number,\n    description?: string | null,\n): string => {\n    const date = `at ${new Date(timestamp!).toISOString()}`;\n    const assetName = assetType === LocationAssetType.Self ? \"User\" : undefined;\n    const quotedDescription = description ? `\"${description}\"` : undefined;\n\n    return [assetName, \"Location\", quotedDescription, uri, date].filter(Boolean).join(\" \");\n};\n\n/**\n * Generates the content for a Location event\n * @param uri - a geo:// uri for the location\n * @param timestamp - the timestamp when the location was correct (milliseconds since the UNIX epoch)\n * @param description - the (optional) label for this location on the map\n * @param assetType - the (optional) asset type of this location e.g. \"m.self\"\n * @param text - optional. A text for the location\n */\nexport const makeLocationContent = (\n    // this is first but optional\n    // to avoid a breaking change\n    text?: string,\n    uri?: string,\n    timestamp?: number,\n    description?: string | null,\n    assetType?: LocationAssetType,\n): LegacyLocationEventContent & MLocationEventContent => {\n    const defaultedText =\n        text ?? getTextForLocationEvent(uri, assetType || LocationAssetType.Self, timestamp, description);\n    const timestampEvent = timestamp ? { [M_TIMESTAMP.name]: timestamp } : {};\n    return {\n        msgtype: MsgType.Location,\n        body: defaultedText,\n        geo_uri: uri,\n        [M_LOCATION.name]: {\n            description,\n            uri,\n        },\n        [M_ASSET.name]: {\n            type: assetType || LocationAssetType.Self,\n        },\n        [M_TEXT.name]: defaultedText,\n        ...timestampEvent,\n    } as LegacyLocationEventContent & MLocationEventContent;\n};\n\n/**\n * Parse location event content and transform to\n * a backwards compatible modern m.location event format\n */\nexport const parseLocationEvent = (wireEventContent: LocationEventWireContent): MLocationEventContent => {\n    const location = M_LOCATION.findIn<MLocationContent>(wireEventContent);\n    const asset = M_ASSET.findIn<MAssetContent>(wireEventContent);\n    const timestamp = M_TIMESTAMP.findIn<number>(wireEventContent);\n    const text = M_TEXT.findIn<string>(wireEventContent);\n\n    const geoUri = location?.uri ?? wireEventContent?.geo_uri;\n    const description = location?.description;\n    const assetType = asset?.type ?? LocationAssetType.Self;\n    const fallbackText = text ?? wireEventContent.body;\n\n    return makeLocationContent(fallbackText, geoUri, timestamp ?? undefined, description, assetType);\n};\n\n/**\n * Topic event helpers\n */\nexport type MakeTopicContent = (topic: string, htmlTopic?: string) => MRoomTopicEventContent;\n\nexport const makeTopicContent: MakeTopicContent = (topic, htmlTopic) => {\n    const renderings = [{ body: topic, mimetype: \"text/plain\" }];\n    if (isProvided(htmlTopic)) {\n        renderings.push({ body: htmlTopic!, mimetype: \"text/html\" });\n    }\n    return { topic, [M_TOPIC.name]: renderings };\n};\n\nexport type TopicState = {\n    text: string;\n    html?: string;\n};\n\nexport const parseTopicContent = (content: MRoomTopicEventContent): TopicState => {\n    const mtopic = M_TOPIC.findIn<MTopicContent>(content);\n    if (!Array.isArray(mtopic)) {\n        return { text: content.topic };\n    }\n    const text = mtopic?.find((r) => !isProvided(r.mimetype) || r.mimetype === \"text/plain\")?.body ?? content.topic;\n    const html = mtopic?.find((r) => r.mimetype === \"text/html\")?.body;\n    return { text, html };\n};\n\n/**\n * Beacon event helpers\n */\nexport type MakeBeaconInfoContent = (\n    timeout: number,\n    isLive?: boolean,\n    description?: string,\n    assetType?: LocationAssetType,\n    timestamp?: number,\n) => MBeaconInfoEventContent;\n\nexport const makeBeaconInfoContent: MakeBeaconInfoContent = (timeout, isLive, description, assetType, timestamp) => ({\n    description,\n    timeout,\n    live: isLive,\n    [M_TIMESTAMP.name]: timestamp || Date.now(),\n    [M_ASSET.name]: {\n        type: assetType ?? LocationAssetType.Self,\n    },\n});\n\nexport type BeaconInfoState = MBeaconInfoContent & {\n    assetType?: LocationAssetType;\n    timestamp?: number;\n};\n/**\n * Flatten beacon info event content\n */\nexport const parseBeaconInfoContent = (content: MBeaconInfoEventContent): BeaconInfoState => {\n    const { description, timeout, live } = content;\n    const timestamp = M_TIMESTAMP.findIn<number>(content) ?? undefined;\n    const asset = M_ASSET.findIn<MAssetContent>(content);\n\n    return {\n        description,\n        timeout,\n        live,\n        assetType: asset?.type,\n        timestamp,\n    };\n};\n\nexport type MakeBeaconContent = (\n    uri: string,\n    timestamp: number,\n    beaconInfoEventId: string,\n    description?: string,\n) => MBeaconEventContent;\n\nexport const makeBeaconContent: MakeBeaconContent = (uri, timestamp, beaconInfoEventId, description) => ({\n    [M_LOCATION.name]: {\n        description,\n        uri,\n    },\n    [M_TIMESTAMP.name]: timestamp,\n    \"m.relates_to\": {\n        rel_type: REFERENCE_RELATION.name,\n        event_id: beaconInfoEventId,\n    },\n});\n\nexport type BeaconLocationState = Omit<MLocationContent, \"uri\"> & {\n    uri?: string; // override from MLocationContent to allow optionals\n    timestamp?: number;\n};\n\nexport const parseBeaconContent = (content: MBeaconEventContent): BeaconLocationState => {\n    const location = M_LOCATION.findIn<MLocationContent>(content);\n    const timestamp = M_TIMESTAMP.findIn<number>(content) ?? undefined;\n\n    return {\n        description: location?.description,\n        uri: location?.uri,\n        timestamp,\n    };\n};\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,OAAO,QAAQ,mBAAmB;AAC3C,SAASC,MAAM,EAAEC,kBAAkB,QAAQ,+BAA+B;AAC1E,SAASC,UAAU,QAAQ,qCAAqC;AAChE,SACIC,OAAO,EACPC,iBAAiB,EACjBC,UAAU,EACVC,WAAW,QAMR,sBAAsB;AAC7B,SAAgDC,OAAO,QAAQ,mBAAmB;AAGlF;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,IAAY,EAAEC,QAAgB,EAA2B;EACrF,OAAO;IACHC,OAAO,EAAEZ,OAAO,CAACa,IAAI;IACrBC,MAAM,EAAE,wBAAwB;IAChCJ,IAAI,EAAEA,IAAI;IACVK,cAAc,EAAEJ;EACpB,CAAC;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,cAAcA,CAACN,IAAY,EAAEC,QAAgB,EAA2B;EACpF,OAAO;IACHC,OAAO,EAAEZ,OAAO,CAACiB,MAAM;IACvBH,MAAM,EAAE,wBAAwB;IAChCJ,IAAI,EAAEA,IAAI;IACVK,cAAc,EAAEJ;EACpB,CAAC;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,aAAaA,CAACR,IAAY,EAAEC,QAAgB,EAA2B;EACnF,OAAO;IACHC,OAAO,EAAEZ,OAAO,CAACmB,KAAK;IACtBL,MAAM,EAAE,wBAAwB;IAChCJ,IAAI,EAAEA,IAAI;IACVK,cAAc,EAAEJ;EACpB,CAAC;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,eAAeA,CAACV,IAAY,EAA2B;EACnE,OAAO;IACHE,OAAO,EAAEZ,OAAO,CAACa,IAAI;IACrBH,IAAI,EAAEA;EACV,CAAC;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASW,UAAUA,CAACX,IAAY,EAA2B;EAC9D,OAAO;IACHE,OAAO,EAAEZ,OAAO,CAACiB,MAAM;IACvBP,IAAI,EAAEA;EACV,CAAC;AACL;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASY,gBAAgBA,CAACZ,IAAY,EAA2B;EACpE,OAAO;IACHE,OAAO,EAAEZ,OAAO,CAACmB,KAAK;IACtBT,IAAI,EAAEA;EACV,CAAC;AACL;;AAEA;;AAEA,OAAO,IAAMa,uBAAuB,GAAGA,CACnCC,GAAuB,EACvBC,SAA4B,EAC5BC,SAAkB,EAClBC,WAA2B,KAClB;EACT,IAAMC,IAAI,SAAAC,MAAA,CAAS,IAAIC,IAAI,CAACJ,SAAU,CAAC,CAACK,WAAW,CAAC,CAAC,CAAE;EACvD,IAAMC,SAAS,GAAGP,SAAS,KAAKpB,iBAAiB,CAAC4B,IAAI,GAAG,MAAM,GAAGC,SAAS;EAC3E,IAAMC,iBAAiB,GAAGR,WAAW,QAAAE,MAAA,CAAOF,WAAW,UAAMO,SAAS;EAEtE,OAAO,CAACF,SAAS,EAAE,UAAU,EAAEG,iBAAiB,EAAEX,GAAG,EAAEI,IAAI,CAAC,CAACQ,MAAM,CAACC,OAAO,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;AAC1F,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,mBAAmB,GAAGA,CAG/BC,IAAa,EACbhB,GAAY,EACZE,SAAkB,EAClBC,WAA2B,EAC3BF,SAA6B,KACwB;EACrD,IAAMgB,aAAa,GACfD,IAAI,aAAJA,IAAI,cAAJA,IAAI,GAAIjB,uBAAuB,CAACC,GAAG,EAAEC,SAAS,IAAIpB,iBAAiB,CAAC4B,IAAI,EAAEP,SAAS,EAAEC,WAAW,CAAC;EACrG,IAAMe,cAAc,GAAGhB,SAAS,GAAG;IAAE,CAACnB,WAAW,CAACoC,IAAI,GAAGjB;EAAU,CAAC,GAAG,CAAC,CAAC;EACzE,OAAAkB,aAAA;IACIhC,OAAO,EAAEZ,OAAO,CAAC6C,QAAQ;IACzBnC,IAAI,EAAE+B,aAAa;IACnBK,OAAO,EAAEtB,GAAG;IACZ,CAAClB,UAAU,CAACqC,IAAI,GAAG;MACfhB,WAAW;MACXH;IACJ,CAAC;IACD,CAACpB,OAAO,CAACuC,IAAI,GAAG;MACZI,IAAI,EAAEtB,SAAS,IAAIpB,iBAAiB,CAAC4B;IACzC,CAAC;IACD,CAAChC,MAAM,CAAC0C,IAAI,GAAGF;EAAa,GACzBC,cAAc;AAEzB,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,IAAMM,kBAAkB,GAAIC,gBAA0C,IAA4B;EAAA,IAAAC,aAAA,EAAAC,WAAA;EACrG,IAAMC,QAAQ,GAAG9C,UAAU,CAAC+C,MAAM,CAAmBJ,gBAAgB,CAAC;EACtE,IAAMK,KAAK,GAAGlD,OAAO,CAACiD,MAAM,CAAgBJ,gBAAgB,CAAC;EAC7D,IAAMvB,SAAS,GAAGnB,WAAW,CAAC8C,MAAM,CAASJ,gBAAgB,CAAC;EAC9D,IAAMT,IAAI,GAAGvC,MAAM,CAACoD,MAAM,CAASJ,gBAAgB,CAAC;EAEpD,IAAMM,MAAM,IAAAL,aAAA,GAAGE,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAE5B,GAAG,cAAA0B,aAAA,cAAAA,aAAA,GAAID,gBAAgB,aAAhBA,gBAAgB,uBAAhBA,gBAAgB,CAAEH,OAAO;EACzD,IAAMnB,WAAW,GAAGyB,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEzB,WAAW;EACzC,IAAMF,SAAS,IAAA0B,WAAA,GAAGG,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEP,IAAI,cAAAI,WAAA,cAAAA,WAAA,GAAI9C,iBAAiB,CAAC4B,IAAI;EACvD,IAAMuB,YAAY,GAAGhB,IAAI,aAAJA,IAAI,cAAJA,IAAI,GAAIS,gBAAgB,CAACvC,IAAI;EAElD,OAAO6B,mBAAmB,CAACiB,YAAY,EAAED,MAAM,EAAE7B,SAAS,aAATA,SAAS,cAATA,SAAS,GAAIQ,SAAS,EAAEP,WAAW,EAAEF,SAAS,CAAC;AACpG,CAAC;;AAED;AACA;AACA;;AAGA,OAAO,IAAMgC,gBAAkC,GAAGA,CAACC,KAAK,EAAEC,SAAS,KAAK;EACpE,IAAMC,UAAU,GAAG,CAAC;IAAElD,IAAI,EAAEgD,KAAK;IAAEG,QAAQ,EAAE;EAAa,CAAC,CAAC;EAC5D,IAAI1D,UAAU,CAACwD,SAAS,CAAC,EAAE;IACvBC,UAAU,CAACE,IAAI,CAAC;MAAEpD,IAAI,EAAEiD,SAAU;MAAEE,QAAQ,EAAE;IAAY,CAAC,CAAC;EAChE;EACA,OAAO;IAAEH,KAAK;IAAE,CAAClD,OAAO,CAACmC,IAAI,GAAGiB;EAAW,CAAC;AAChD,CAAC;AAOD,OAAO,IAAMG,iBAAiB,GAAIC,OAA+B,IAAiB;EAAA,IAAAC,iBAAA,EAAAC,YAAA,EAAAC,aAAA;EAC9E,IAAMC,MAAM,GAAG5D,OAAO,CAAC6C,MAAM,CAAgBW,OAAO,CAAC;EACrD,IAAI,CAACK,KAAK,CAACC,OAAO,CAACF,MAAM,CAAC,EAAE;IACxB,OAAO;MAAE5B,IAAI,EAAEwB,OAAO,CAACN;IAAM,CAAC;EAClC;EACA,IAAMlB,IAAI,IAAAyB,iBAAA,GAAGG,MAAM,aAANA,MAAM,gBAAAF,YAAA,GAANE,MAAM,CAAEG,IAAI,CAAEC,CAAC,IAAK,CAACrE,UAAU,CAACqE,CAAC,CAACX,QAAQ,CAAC,IAAIW,CAAC,CAACX,QAAQ,KAAK,YAAY,CAAC,cAAAK,YAAA,uBAA3EA,YAAA,CAA6ExD,IAAI,cAAAuD,iBAAA,cAAAA,iBAAA,GAAID,OAAO,CAACN,KAAK;EAC/G,IAAMe,IAAI,GAAGL,MAAM,aAANA,MAAM,gBAAAD,aAAA,GAANC,MAAM,CAAEG,IAAI,CAAEC,CAAC,IAAKA,CAAC,CAACX,QAAQ,KAAK,WAAW,CAAC,cAAAM,aAAA,uBAA/CA,aAAA,CAAiDzD,IAAI;EAClE,OAAO;IAAE8B,IAAI;IAAEiC;EAAK,CAAC;AACzB,CAAC;;AAED;AACA;AACA;;AASA,OAAO,IAAMC,qBAA4C,GAAGA,CAACC,OAAO,EAAEC,MAAM,EAAEjD,WAAW,EAAEF,SAAS,EAAEC,SAAS,MAAM;EACjHC,WAAW;EACXgD,OAAO;EACPE,IAAI,EAAED,MAAM;EACZ,CAACrE,WAAW,CAACoC,IAAI,GAAGjB,SAAS,IAAII,IAAI,CAACgD,GAAG,CAAC,CAAC;EAC3C,CAAC1E,OAAO,CAACuC,IAAI,GAAG;IACZI,IAAI,EAAEtB,SAAS,aAATA,SAAS,cAATA,SAAS,GAAIpB,iBAAiB,CAAC4B;EACzC;AACJ,CAAC,CAAC;AAMF;AACA;AACA;AACA,OAAO,IAAM8C,sBAAsB,GAAIf,OAAgC,IAAsB;EAAA,IAAAgB,mBAAA;EACzF,IAAM;IAAErD,WAAW;IAAEgD,OAAO;IAAEE;EAAK,CAAC,GAAGb,OAAO;EAC9C,IAAMtC,SAAS,IAAAsD,mBAAA,GAAGzE,WAAW,CAAC8C,MAAM,CAASW,OAAO,CAAC,cAAAgB,mBAAA,cAAAA,mBAAA,GAAI9C,SAAS;EAClE,IAAMoB,KAAK,GAAGlD,OAAO,CAACiD,MAAM,CAAgBW,OAAO,CAAC;EAEpD,OAAO;IACHrC,WAAW;IACXgD,OAAO;IACPE,IAAI;IACJpD,SAAS,EAAE6B,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEP,IAAI;IACtBrB;EACJ,CAAC;AACL,CAAC;AASD,OAAO,IAAMuD,iBAAoC,GAAGA,CAACzD,GAAG,EAAEE,SAAS,EAAEwD,iBAAiB,EAAEvD,WAAW,MAAM;EACrG,CAACrB,UAAU,CAACqC,IAAI,GAAG;IACfhB,WAAW;IACXH;EACJ,CAAC;EACD,CAACjB,WAAW,CAACoC,IAAI,GAAGjB,SAAS;EAC7B,cAAc,EAAE;IACZyD,QAAQ,EAAEjF,kBAAkB,CAACyC,IAAI;IACjCyC,QAAQ,EAAEF;EACd;AACJ,CAAC,CAAC;AAOF,OAAO,IAAMG,kBAAkB,GAAIrB,OAA4B,IAA0B;EAAA,IAAAsB,oBAAA;EACrF,IAAMlC,QAAQ,GAAG9C,UAAU,CAAC+C,MAAM,CAAmBW,OAAO,CAAC;EAC7D,IAAMtC,SAAS,IAAA4D,oBAAA,GAAG/E,WAAW,CAAC8C,MAAM,CAASW,OAAO,CAAC,cAAAsB,oBAAA,cAAAA,oBAAA,GAAIpD,SAAS;EAElE,OAAO;IACHP,WAAW,EAAEyB,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEzB,WAAW;IAClCH,GAAG,EAAE4B,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAE5B,GAAG;IAClBE;EACJ,CAAC;AACL,CAAC","ignoreList":[]}

package/lib/content-repo.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Get the HTTP URL for an MXC URI.
+ * @param baseUrl - The base homeserver url which has a content repo.
+ * @param mxc - The mxc:// URI.
+ * @param width - The desired width of the thumbnail.
+ * @param height - The desired height of the thumbnail.
+ * @param resizeMethod - The thumbnail resize method to use, either
+ * "crop" or "scale".
+ * @param allowDirectLinks - If true, return any non-mxc URLs
+ * directly. Fetching such URLs will leak information about the user to
+ * anyone they share a room with. If false, will return the emptry string
+ * for such URLs.
+ * @param allowRedirects - If true, the caller supports the URL being 307 or
+ * 308 redirected to another resource upon request. If false, redirects
+ * are not expected. Implied `true` when `useAuthentication` is `true`.
+ * @param useAuthentication - If true, the caller supports authenticated
+ * media and wants an authentication-required URL. Note that server support
+ * for authenticated media will *not* be checked - it is the caller's responsibility
+ * to do so before calling this function. Note also that `useAuthentication`
+ * implies `allowRedirects`. Defaults to false (unauthenticated endpoints).
+ * @returns The complete URL to the content, may be an empty string if the provided mxc is not valid.
+ */
+export declare function getHttpUriForMxc(baseUrl: string, mxc?: string, width?: number, height?: number, resizeMethod?: string, allowDirectLinks?: boolean, allowRedirects?: boolean, useAuthentication?: boolean): string;
+//# sourceMappingURL=content-repo.d.ts.map

package/lib/content-repo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-repo.d.ts","sourceRoot":"","sources":["../src/content-repo.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,MAAM,EACrB,gBAAgB,UAAQ,EACxB,cAAc,CAAC,EAAE,OAAO,EACxB,iBAAiB,CAAC,EAAE,OAAO,GAC5B,MAAM,CAoDR"}

package/lib/content-repo.js

@@ -0,0 +1,104 @@
+/*
+Copyright 2015 - 2024 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.
+*/
+
+// Validation based on https://spec.matrix.org/v1.12/appendices/#server-name
+// We do not use the validation described in https://spec.matrix.org/v1.12/client-server-api/#security-considerations-5
+// as it'd wrongly make all MXCs invalid due to not allowing `[].:` in server names.
+var serverNameRegex = /^(?:(?:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:\[[\dA-Fa-f:.]{2,45}])|(?:[A-Za-z\d\-.]{1,255}))(?::\d{1,5})?$/;
+function validateServerName(serverName) {
+  var matches = serverNameRegex.exec(serverName);
+  return (matches === null || matches === void 0 ? void 0 : matches[0]) === serverName;
+}
+
+// Validation based on https://spec.matrix.org/v1.12/client-server-api/#security-considerations-5
+var mediaIdRegex = /^[\w-]+$/;
+function validateMediaId(mediaId) {
+  var matches = mediaIdRegex.exec(mediaId);
+  return (matches === null || matches === void 0 ? void 0 : matches[0]) === mediaId;
+}
+
+/**
+ * Get the HTTP URL for an MXC URI.
+ * @param baseUrl - The base homeserver url which has a content repo.
+ * @param mxc - The mxc:// URI.
+ * @param width - The desired width of the thumbnail.
+ * @param height - The desired height of the thumbnail.
+ * @param resizeMethod - The thumbnail resize method to use, either
+ * "crop" or "scale".
+ * @param allowDirectLinks - If true, return any non-mxc URLs
+ * directly. Fetching such URLs will leak information about the user to
+ * anyone they share a room with. If false, will return the emptry string
+ * for such URLs.
+ * @param allowRedirects - If true, the caller supports the URL being 307 or
+ * 308 redirected to another resource upon request. If false, redirects
+ * are not expected. Implied `true` when `useAuthentication` is `true`.
+ * @param useAuthentication - If true, the caller supports authenticated
+ * media and wants an authentication-required URL. Note that server support
+ * for authenticated media will *not* be checked - it is the caller's responsibility
+ * to do so before calling this function. Note also that `useAuthentication`
+ * implies `allowRedirects`. Defaults to false (unauthenticated endpoints).
+ * @returns The complete URL to the content, may be an empty string if the provided mxc is not valid.
+ */
+export function getHttpUriForMxc(baseUrl, mxc, width, height, resizeMethod) {
+  var allowDirectLinks = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+  var allowRedirects = arguments.length > 6 ? arguments[6] : undefined;
+  var useAuthentication = arguments.length > 7 ? arguments[7] : undefined;
+  if (typeof mxc !== "string" || !mxc) {
+    return "";
+  }
+  if (!mxc.startsWith("mxc://")) {
+    if (allowDirectLinks) {
+      return mxc;
+    } else {
+      return "";
+    }
+  }
+  var [serverName, mediaId, ...rest] = mxc.slice(6).split("/");
+  if (rest.length > 0 || !validateServerName(serverName) || !validateMediaId(mediaId)) {
+    return "";
+  }
+  if (useAuthentication) {
+    allowRedirects = true; // per docs (MSC3916 always expects redirects)
+
+    // Dev note: MSC3916 removes `allow_redirect` entirely, but
+    // for explicitness we set it here. This makes it slightly more obvious to
+    // callers, hopefully.
+  }
+  var prefix;
+  var isThumbnailRequest = !!width || !!height || !!resizeMethod;
+  var verb = isThumbnailRequest ? "thumbnail" : "download";
+  if (useAuthentication) {
+    prefix = "/_matrix/client/v1/media/".concat(verb);
+  } else {
+    prefix = "/_matrix/media/v3/".concat(verb);
+  }
+  var url = new URL("".concat(prefix, "/").concat(serverName, "/").concat(mediaId), baseUrl);
+  if (width) {
+    url.searchParams.set("width", Math.round(width).toString());
+  }
+  if (height) {
+    url.searchParams.set("height", Math.round(height).toString());
+  }
+  if (resizeMethod) {
+    url.searchParams.set("method", resizeMethod);
+  }
+  if (typeof allowRedirects === "boolean") {
+    // We add this after, so we don't convert everything to a thumbnail request.
+    url.searchParams.set("allow_redirect", JSON.stringify(allowRedirects));
+  }
+  return url.href;
+}
+//# sourceMappingURL=content-repo.js.map

package/lib/content-repo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-repo.js","names":["serverNameRegex","validateServerName","serverName","matches","exec","mediaIdRegex","validateMediaId","mediaId","getHttpUriForMxc","baseUrl","mxc","width","height","resizeMethod","allowDirectLinks","arguments","length","undefined","allowRedirects","useAuthentication","startsWith","rest","slice","split","prefix","isThumbnailRequest","verb","concat","url","URL","searchParams","set","Math","round","toString","JSON","stringify","href"],"sources":["../src/content-repo.ts"],"sourcesContent":["/*\nCopyright 2015 - 2024 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n// Validation based on https://spec.matrix.org/v1.12/appendices/#server-name\n// We do not use the validation described in https://spec.matrix.org/v1.12/client-server-api/#security-considerations-5\n// as it'd wrongly make all MXCs invalid due to not allowing `[].:` in server names.\nconst serverNameRegex =\n    /^(?:(?:\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})|(?:\\[[\\dA-Fa-f:.]{2,45}])|(?:[A-Za-z\\d\\-.]{1,255}))(?::\\d{1,5})?$/;\nfunction validateServerName(serverName: string): boolean {\n    const matches = serverNameRegex.exec(serverName);\n    return matches?.[0] === serverName;\n}\n\n// Validation based on https://spec.matrix.org/v1.12/client-server-api/#security-considerations-5\nconst mediaIdRegex = /^[\\w-]+$/;\nfunction validateMediaId(mediaId: string): boolean {\n    const matches = mediaIdRegex.exec(mediaId);\n    return matches?.[0] === mediaId;\n}\n\n/**\n * Get the HTTP URL for an MXC URI.\n * @param baseUrl - The base homeserver url which has a content repo.\n * @param mxc - The mxc:// URI.\n * @param width - The desired width of the thumbnail.\n * @param height - The desired height of the thumbnail.\n * @param resizeMethod - The thumbnail resize method to use, either\n * \"crop\" or \"scale\".\n * @param allowDirectLinks - If true, return any non-mxc URLs\n * directly. Fetching such URLs will leak information about the user to\n * anyone they share a room with. If false, will return the emptry string\n * for such URLs.\n * @param allowRedirects - If true, the caller supports the URL being 307 or\n * 308 redirected to another resource upon request. If false, redirects\n * are not expected. Implied `true` when `useAuthentication` is `true`.\n * @param useAuthentication - If true, the caller supports authenticated\n * media and wants an authentication-required URL. Note that server support\n * for authenticated media will *not* be checked - it is the caller's responsibility\n * to do so before calling this function. Note also that `useAuthentication`\n * implies `allowRedirects`. Defaults to false (unauthenticated endpoints).\n * @returns The complete URL to the content, may be an empty string if the provided mxc is not valid.\n */\nexport function getHttpUriForMxc(\n    baseUrl: string,\n    mxc?: string,\n    width?: number,\n    height?: number,\n    resizeMethod?: string,\n    allowDirectLinks = false,\n    allowRedirects?: boolean,\n    useAuthentication?: boolean,\n): string {\n    if (typeof mxc !== \"string\" || !mxc) {\n        return \"\";\n    }\n    if (!mxc.startsWith(\"mxc://\")) {\n        if (allowDirectLinks) {\n            return mxc;\n        } else {\n            return \"\";\n        }\n    }\n\n    const [serverName, mediaId, ...rest] = mxc.slice(6).split(\"/\");\n    if (rest.length > 0 || !validateServerName(serverName) || !validateMediaId(mediaId)) {\n        return \"\";\n    }\n\n    if (useAuthentication) {\n        allowRedirects = true; // per docs (MSC3916 always expects redirects)\n\n        // Dev note: MSC3916 removes `allow_redirect` entirely, but\n        // for explicitness we set it here. This makes it slightly more obvious to\n        // callers, hopefully.\n    }\n\n    let prefix: string;\n    const isThumbnailRequest = !!width || !!height || !!resizeMethod;\n    const verb = isThumbnailRequest ? \"thumbnail\" : \"download\";\n    if (useAuthentication) {\n        prefix = `/_matrix/client/v1/media/${verb}`;\n    } else {\n        prefix = `/_matrix/media/v3/${verb}`;\n    }\n\n    const url = new URL(`${prefix}/${serverName}/${mediaId}`, baseUrl);\n\n    if (width) {\n        url.searchParams.set(\"width\", Math.round(width).toString());\n    }\n    if (height) {\n        url.searchParams.set(\"height\", Math.round(height).toString());\n    }\n    if (resizeMethod) {\n        url.searchParams.set(\"method\", resizeMethod);\n    }\n\n    if (typeof allowRedirects === \"boolean\") {\n        // We add this after, so we don't convert everything to a thumbnail request.\n        url.searchParams.set(\"allow_redirect\", JSON.stringify(allowRedirects));\n    }\n\n    return url.href;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,IAAMA,eAAe,GACjB,8GAA8G;AAClH,SAASC,kBAAkBA,CAACC,UAAkB,EAAW;EACrD,IAAMC,OAAO,GAAGH,eAAe,CAACI,IAAI,CAACF,UAAU,CAAC;EAChD,OAAO,CAAAC,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAG,CAAC,CAAC,MAAKD,UAAU;AACtC;;AAEA;AACA,IAAMG,YAAY,GAAG,UAAU;AAC/B,SAASC,eAAeA,CAACC,OAAe,EAAW;EAC/C,IAAMJ,OAAO,GAAGE,YAAY,CAACD,IAAI,CAACG,OAAO,CAAC;EAC1C,OAAO,CAAAJ,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAG,CAAC,CAAC,MAAKI,OAAO;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC5BC,OAAe,EACfC,GAAY,EACZC,KAAc,EACdC,MAAe,EACfC,YAAqB,EAIf;EAAA,IAHNC,gBAAgB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;EAAA,IACxBG,cAAwB,GAAAH,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;EAAA,IACxBE,iBAA2B,GAAAJ,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;EAE3B,IAAI,OAAOP,GAAG,KAAK,QAAQ,IAAI,CAACA,GAAG,EAAE;IACjC,OAAO,EAAE;EACb;EACA,IAAI,CAACA,GAAG,CAACU,UAAU,CAAC,QAAQ,CAAC,EAAE;IAC3B,IAAIN,gBAAgB,EAAE;MAClB,OAAOJ,GAAG;IACd,CAAC,MAAM;MACH,OAAO,EAAE;IACb;EACJ;EAEA,IAAM,CAACR,UAAU,EAAEK,OAAO,EAAE,GAAGc,IAAI,CAAC,GAAGX,GAAG,CAACY,KAAK,CAAC,CAAC,CAAC,CAACC,KAAK,CAAC,GAAG,CAAC;EAC9D,IAAIF,IAAI,CAACL,MAAM,GAAG,CAAC,IAAI,CAACf,kBAAkB,CAACC,UAAU,CAAC,IAAI,CAACI,eAAe,CAACC,OAAO,CAAC,EAAE;IACjF,OAAO,EAAE;EACb;EAEA,IAAIY,iBAAiB,EAAE;IACnBD,cAAc,GAAG,IAAI,CAAC,CAAC;;IAEvB;IACA;IACA;EACJ;EAEA,IAAIM,MAAc;EAClB,IAAMC,kBAAkB,GAAG,CAAC,CAACd,KAAK,IAAI,CAAC,CAACC,MAAM,IAAI,CAAC,CAACC,YAAY;EAChE,IAAMa,IAAI,GAAGD,kBAAkB,GAAG,WAAW,GAAG,UAAU;EAC1D,IAAIN,iBAAiB,EAAE;IACnBK,MAAM,+BAAAG,MAAA,CAA+BD,IAAI,CAAE;EAC/C,CAAC,MAAM;IACHF,MAAM,wBAAAG,MAAA,CAAwBD,IAAI,CAAE;EACxC;EAEA,IAAME,GAAG,GAAG,IAAIC,GAAG,IAAAF,MAAA,CAAIH,MAAM,OAAAG,MAAA,CAAIzB,UAAU,OAAAyB,MAAA,CAAIpB,OAAO,GAAIE,OAAO,CAAC;EAElE,IAAIE,KAAK,EAAE;IACPiB,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC,OAAO,EAAEC,IAAI,CAACC,KAAK,CAACtB,KAAK,CAAC,CAACuB,QAAQ,CAAC,CAAC,CAAC;EAC/D;EACA,IAAItB,MAAM,EAAE;IACRgB,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC,QAAQ,EAAEC,IAAI,CAACC,KAAK,CAACrB,MAAM,CAAC,CAACsB,QAAQ,CAAC,CAAC,CAAC;EACjE;EACA,IAAIrB,YAAY,EAAE;IACde,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC,QAAQ,EAAElB,YAAY,CAAC;EAChD;EAEA,IAAI,OAAOK,cAAc,KAAK,SAAS,EAAE;IACrC;IACAU,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC,gBAAgB,EAAEI,IAAI,CAACC,SAAS,CAAClB,cAAc,CAAC,CAAC;EAC1E;EAEA,OAAOU,GAAG,CAACS,IAAI;AACnB","ignoreList":[]}

package/lib/crypto/CrossSigning.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Cross signing methods
+ */
+import type { PkSigning } from "@matrix-org/olm";
+import { DeviceInfo } from "./deviceinfo.ts";
+import { ISignedKey, MatrixClient } from "../client.ts";
+import { OlmDevice } from "./OlmDevice.ts";
+import { ICryptoCallbacks } from "./index.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { CryptoStore } from "./store/base.ts";
+import { ServerSideSecretStorage } from "../secret-storage.ts";
+import { CrossSigningKeyInfo, DeviceVerificationStatus, UserVerificationStatus as UserTrustLevel } from "../crypto-api/index.ts";
+export { UserTrustLevel };
+export interface ICacheCallbacks {
+    getCrossSigningKeyCache?(type: string, expectedPublicKey?: string): Promise<Uint8Array | null>;
+    storeCrossSigningKeyCache?(type: string, key?: Uint8Array): Promise<void>;
+}
+export interface ICrossSigningInfo {
+    keys: Record<string, CrossSigningKeyInfo>;
+    firstUse: boolean;
+    crossSigningVerifiedBefore: boolean;
+}
+export declare class CrossSigningInfo {
+    readonly userId: string;
+    private callbacks;
+    private cacheCallbacks;
+    keys: Record<string, CrossSigningKeyInfo>;
+    firstUse: boolean;
+    private crossSigningVerifiedBefore;
+    /**
+     * Information about a user's cross-signing keys
+     *
+     * @param userId - the user that the information is about
+     * @param callbacks - Callbacks used to interact with the app
+     *     Requires getCrossSigningKey and saveCrossSigningKeys
+     * @param cacheCallbacks - Callbacks used to interact with the cache
+     */
+    constructor(userId: string, callbacks?: ICryptoCallbacks, cacheCallbacks?: ICacheCallbacks);
+    static fromStorage(obj: ICrossSigningInfo, userId: string): CrossSigningInfo;
+    toStorage(): ICrossSigningInfo;
+    /**
+     * Calls the app callback to ask for a private key
+     *
+     * @param type - The key type ("master", "self_signing", or "user_signing")
+     * @param expectedPubkey - The matching public key or undefined to use
+     *     the stored public key for the given key type.
+     * @returns An array with [ public key, Olm.PkSigning ]
+     */
+    getCrossSigningKey(type: string, expectedPubkey?: string): Promise<[string, PkSigning]>;
+    /**
+     * Check whether the private keys exist in secret storage.
+     * XXX: This could be static, be we often seem to have an instance when we
+     * want to know this anyway...
+     *
+     * @param secretStorage - The secret store using account data
+     * @returns map of key name to key info the secret is encrypted
+     *     with, or null if it is not present or not encrypted with a trusted
+     *     key
+     */
+    isStoredInSecretStorage(secretStorage: ServerSideSecretStorage): Promise<Record<string, object> | null>;
+    /**
+     * Store private keys in secret storage for use by other devices. This is
+     * typically called in conjunction with the creation of new cross-signing
+     * keys.
+     *
+     * @param keys - The keys to store
+     * @param secretStorage - The secret store using account data
+     */
+    static storeInSecretStorage(keys: Map<string, Uint8Array>, secretStorage: ServerSideSecretStorage): Promise<void>;
+    /**
+     * Get private keys from secret storage created by some other device. This
+     * also passes the private keys to the app-specific callback.
+     *
+     * @param type - The type of key to get.  One of "master",
+     * "self_signing", or "user_signing".
+     * @param secretStorage - The secret store using account data
+     * @returns The private key
+     */
+    static getFromSecretStorage(type: string, secretStorage: ServerSideSecretStorage): Promise<Uint8Array | null>;
+    /**
+     * Check whether the private keys exist in the local key cache.
+     *
+     * @param type - The type of key to get. One of "master",
+     * "self_signing", or "user_signing". Optional, will check all by default.
+     * @returns True if all keys are stored in the local cache.
+     */
+    isStoredInKeyCache(type?: string): Promise<boolean>;
+    /**
+     * Get cross-signing private keys from the local cache.
+     *
+     * @returns A map from key type (string) to private key (Uint8Array)
+     */
+    getCrossSigningKeysFromCache(): Promise<Map<string, Uint8Array>>;
+    /**
+     * Get the ID used to identify the user. This can also be used to test for
+     * the existence of a given key type.
+     *
+     * @param type - The type of key to get the ID of.  One of "master",
+     * "self_signing", or "user_signing".  Defaults to "master".
+     *
+     * @returns the ID
+     */
+    getId(type?: string): string | null;
+    /**
+     * Create new cross-signing keys for the given key types. The public keys
+     * will be held in this class, while the private keys are passed off to the
+     * `saveCrossSigningKeys` application callback.
+     *
+     * @param level - The key types to reset
+     */
+    resetKeys(level?: CrossSigningLevel): Promise<void>;
+    /**
+     * unsets the keys, used when another session has reset the keys, to disable cross-signing
+     */
+    clearKeys(): void;
+    setKeys(keys: Record<string, CrossSigningKeyInfo>): void;
+    updateCrossSigningVerifiedBefore(isCrossSigningVerified: boolean): void;
+    signObject<T extends object>(data: T, type: string): Promise<T & {
+        signatures: ISignatures;
+    }>;
+    signUser(key: CrossSigningInfo): Promise<CrossSigningKeyInfo | undefined>;
+    signDevice(userId: string, device: DeviceInfo): Promise<ISignedKey | undefined>;
+    /**
+     * Check whether a given user is trusted.
+     *
+     * @param userCrossSigning - Cross signing info for user
+     *
+     * @returns
+     */
+    checkUserTrust(userCrossSigning: CrossSigningInfo): UserTrustLevel;
+    /**
+     * Check whether a given device is trusted.
+     *
+     * @param userCrossSigning - Cross signing info for user
+     * @param device - The device to check
+     * @param localTrust - Whether the device is trusted locally
+     * @param trustCrossSignedDevices - Whether we trust cross signed devices
+     *
+     * @returns
+     */
+    checkDeviceTrust(userCrossSigning: CrossSigningInfo, device: DeviceInfo, localTrust: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel;
+    /**
+     * @returns Cache callbacks
+     */
+    getCacheCallbacks(): ICacheCallbacks;
+}
+export declare enum CrossSigningLevel {
+    MASTER = 4,
+    USER_SIGNING = 2,
+    SELF_SIGNING = 1
+}
+/**
+ * Represents the ways in which we trust a device.
+ *
+ * @deprecated Use {@link DeviceVerificationStatus}.
+ */
+export declare class DeviceTrustLevel extends DeviceVerificationStatus {
+    constructor(crossSigningVerified: boolean, tofu: boolean, localVerified: boolean, trustCrossSignedDevices: boolean, signedByOwner?: boolean);
+    static fromUserTrustLevel(userTrustLevel: UserTrustLevel, localVerified: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel;
+    /**
+     * @returns true if this device is verified via cross signing
+     */
+    isCrossSigningVerified(): boolean;
+    /**
+     * @returns true if this device is verified locally
+     */
+    isLocallyVerified(): boolean;
+    /**
+     * @returns true if this device is trusted from a user's key
+     * that is trusted on first use
+     */
+    isTofu(): boolean;
+}
+export declare function createCryptoStoreCacheCallbacks(store: CryptoStore, olmDevice: OlmDevice): ICacheCallbacks;
+export type KeysDuringVerification = [[string, PkSigning], [string, PkSigning], [string, PkSigning], void];
+/**
+ * Request cross-signing keys from another device during verification.
+ *
+ * @param baseApis - base Matrix API interface
+ * @param userId - The user ID being verified
+ * @param deviceId - The device ID being verified
+ */
+export declare function requestKeysDuringVerification(baseApis: MatrixClient, userId: string, deviceId: string): Promise<KeysDuringVerification | void>;
+//# sourceMappingURL=CrossSigning.d.ts.map

package/lib/crypto/CrossSigning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrossSigning.d.ts","sourceRoot":"","sources":["../../src/crypto/CrossSigning.ts"],"names":[],"mappings":"AAgBA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAA0B,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAA+B,MAAM,sBAAsB,CAAC;AAC5F,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,IAAI,cAAc,EAC3C,MAAM,wBAAwB,CAAC;AAMhC,OAAO,EAAE,cAAc,EAAE,CAAC;AAW1B,MAAM,WAAW,eAAe;IAC5B,uBAAuB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC/F,yBAAyB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,0BAA0B,EAAE,OAAO,CAAC;CACvC;AAED,qBAAa,gBAAgB;aAmBL,MAAM,EAAE,MAAM;IAC9B,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,cAAc;IApBnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAM;IAC/C,QAAQ,UAAQ;IAMvB,OAAO,CAAC,0BAA0B,CAAS;IAE3C;;;;;;;OAOG;gBAEiB,MAAM,EAAE,MAAM,EACtB,SAAS,GAAE,gBAAqB,EAChC,cAAc,GAAE,eAAoB;WAGlC,WAAW,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,gBAAgB;IAW5E,SAAS,IAAI,iBAAiB;IAQrC;;;;;;;OAOG;IACU,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAiDpG;;;;;;;;;OASG;IACU,uBAAuB,CAChC,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAiBzC;;;;;;;OAOG;WACiB,oBAAoB,CACpC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAC7B,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;WACiB,oBAAoB,CACpC,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAQ7B;;;;;;OAMG;IACU,kBAAkB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYhE;;;;OAIG;IACU,4BAA4B,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAc7E;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,SAAW,GAAG,MAAM,GAAG,IAAI;IAM5C;;;;;;OAMG;IACU,SAAS,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8EhE;;OAEG;IACI,SAAS,IAAI,IAAI;IAIjB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,IAAI;IAoExD,gCAAgC,CAAC,sBAAsB,EAAE,OAAO,GAAG,IAAI;IAQjE,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG;QAAE,UAAU,EAAE,WAAW,CAAA;KAAE,CAAC;IAa7F,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQzE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAmB5F;;;;;;OAMG;IACI,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,cAAc;IA+BzE;;;;;;;;;OASG;IACI,gBAAgB,CACnB,gBAAgB,EAAE,gBAAgB,EAClC,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,OAAO,EACnB,uBAAuB,EAAE,OAAO,GACjC,gBAAgB;IAuBnB;;OAEG;IACI,iBAAiB,IAAI,eAAe;CAG9C;AAmBD,oBAAY,iBAAiB;IACzB,MAAM,IAAI;IACV,YAAY,IAAI;IAChB,YAAY,IAAI;CACnB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,wBAAwB;gBAEtD,oBAAoB,EAAE,OAAO,EAC7B,IAAI,EAAE,OAAO,EACb,aAAa,EAAE,OAAO,EACtB,uBAAuB,EAAE,OAAO,EAChC,aAAa,UAAQ;WAKX,kBAAkB,CAC5B,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,OAAO,EACtB,uBAAuB,EAAE,OAAO,GACjC,gBAAgB;IAUnB;;OAEG;IACI,sBAAsB,IAAI,OAAO;IAIxC;;OAEG;IACI,iBAAiB,IAAI,OAAO;IAInC;;;OAGG;IACI,MAAM,IAAI,OAAO;CAG3B;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,GAAG,eAAe,CAkCzG;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;AAE3G;;;;;;GAMG;AACH,wBAAsB,6BAA6B,CAC/C,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAwExC"}