@textrp/briij-js-sdk 41.0.0

package/lib/testing.js

@@ -0,0 +1,205 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+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 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.
+*/
+
+/**
+ * This file is a secondary entrypoint for the js-sdk library, exposing utilities which might be useful for writing tests.
+ *
+ * In general, it should not be included in runtime applications.
+ *
+ * @packageDocumentation
+ */
+
+import { BriijEvent } from "./models/event.js";
+import { EventType } from "./@types/event.js";
+import { DecryptionError } from "./common-crypto/CryptoBackend.js";
+import { OAuthGrantType } from "./oidc/index.js";
+
+/**
+ * Create a {@link BriijEvent}.
+ *
+ * @param opts - Values for the event.
+ */
+export function mkBriijEvent(opts) {
+  var _opts$eventId, _opts$ts;
+  var event = {
+    type: opts.type,
+    room_id: opts.roomId,
+    sender: opts.sender,
+    content: opts.content,
+    event_id: (_opts$eventId = opts.eventId) !== null && _opts$eventId !== void 0 ? _opts$eventId : "$" + Math.random() + "-" + Math.random(),
+    origin_server_ts: (_opts$ts = opts.ts) !== null && _opts$ts !== void 0 ? _opts$ts : 0,
+    unsigned: opts.unsigned
+  };
+  if (opts.stateKey !== undefined) {
+    event.state_key = opts.stateKey;
+  }
+  var mxEvent = new BriijEvent(event);
+  mxEvent.sender = {
+    userId: opts.sender,
+    membership: "join",
+    name: opts.sender,
+    rawDisplayName: opts.sender,
+    roomId: opts.sender,
+    getAvatarUrl: () => {},
+    getMxcAvatarUrl: () => {}
+  };
+  return mxEvent;
+}
+
+/**
+ * Create a `BriijEvent` representing a successfully-decrypted `m.room.encrypted` event.
+ *
+ * @param opts - Values for the event.
+ */
+export function mkEncryptedBriijEvent(_x) {
+  return _mkEncryptedBriijEvent.apply(this, arguments);
+}
+
+/**
+ * Create a `BriijEvent` representing a `m.room.encrypted` event which could not be decrypted.
+ *
+ * @param opts - Values for the event.
+ */
+function _mkEncryptedBriijEvent() {
+  _mkEncryptedBriijEvent = _asyncToGenerator(function* (opts) {
+    var mxEvent = mkBriijEvent({
+      type: EventType.RoomMessageEncrypted,
+      roomId: opts.roomId,
+      sender: opts.sender,
+      content: {
+        algorithm: "m.megolm.v1.aes-sha2"
+      },
+      eventId: opts.eventId
+    });
+    yield decryptExistingEvent(mxEvent, {
+      plainType: opts.plainType,
+      plainContent: opts.plainContent
+    });
+    return mxEvent;
+  });
+  return _mkEncryptedBriijEvent.apply(this, arguments);
+}
+export function mkDecryptionFailureBriijEvent(_x2) {
+  return _mkDecryptionFailureBriijEvent.apply(this, arguments);
+}
+
+/**
+ * Given an event previously returned by {@link mkDecryptionFailureBriijEvent}, simulate a successful re-decryption
+ * attempt.
+ *
+ * @param mxEvent - The event that will be decrypted.
+ * @param opts - New data for the successful decryption.
+ */
+function _mkDecryptionFailureBriijEvent() {
+  _mkDecryptionFailureBriijEvent = _asyncToGenerator(function* (opts) {
+    var mxEvent = mkBriijEvent({
+      type: EventType.RoomMessageEncrypted,
+      roomId: opts.roomId,
+      sender: opts.sender,
+      content: {
+        algorithm: "m.megolm.v1.aes-sha2"
+      },
+      eventId: opts.eventId
+    });
+    var mockCrypto = {
+      decryptEvent: function () {
+        var _decryptEvent = _asyncToGenerator(function* (_ev) {
+          throw new DecryptionError(opts.code, opts.msg);
+        });
+        function decryptEvent(_x5) {
+          return _decryptEvent.apply(this, arguments);
+        }
+        return decryptEvent;
+      }()
+    };
+    yield mxEvent.attemptDecryption(mockCrypto);
+    return mxEvent;
+  });
+  return _mkDecryptionFailureBriijEvent.apply(this, arguments);
+}
+export function decryptExistingEvent(_x3, _x4) {
+  return _decryptExistingEvent.apply(this, arguments);
+}
+
+/**
+ * Makes a valid OidcClientConfig with minimum valid values
+ * @param issuer used as the base for all other urls
+ * @param additionalGrantTypes to add to the default grant types
+ * @returns OidcClientConfig
+ * @experimental
+ */
+function _decryptExistingEvent() {
+  _decryptExistingEvent = _asyncToGenerator(function* (mxEvent, opts) {
+    var decryptionResult = {
+      claimedEd25519Key: "",
+      clearEvent: {
+        type: opts.plainType,
+        content: opts.plainContent
+      },
+      senderCurve25519Key: ""
+    };
+    var mockCrypto = {
+      decryptEvent: function () {
+        var _decryptEvent2 = _asyncToGenerator(function* (_ev) {
+          return decryptionResult;
+        });
+        function decryptEvent(_x6) {
+          return _decryptEvent2.apply(this, arguments);
+        }
+        return decryptEvent;
+      }()
+    };
+    yield mxEvent.attemptDecryption(mockCrypto);
+  });
+  return _decryptExistingEvent.apply(this, arguments);
+}
+export var makeDelegatedAuthConfig = function makeDelegatedAuthConfig() {
+  var issuer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "https://auth.org/";
+  var additionalGrantTypes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var metadata = mockOpenIdConfiguration(issuer, additionalGrantTypes);
+  return _objectSpread(_objectSpread({}, metadata), {}, {
+    signingKeys: null
+  });
+};
+
+/**
+ * Useful for mocking <issuer>/.well-known/openid-configuration
+ * @param issuer used as the base for all other urls
+ * @param additionalGrantTypes to add to the default grant types
+ * @returns ValidatedAuthMetadata
+ * @experimental
+ */
+export var mockOpenIdConfiguration = function mockOpenIdConfiguration() {
+  var issuer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "https://auth.org/";
+  var additionalGrantTypes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return {
+    issuer,
+    revocation_endpoint: issuer + "revoke",
+    token_endpoint: issuer + "token",
+    authorization_endpoint: issuer + "auth",
+    registration_endpoint: issuer + "registration",
+    device_authorization_endpoint: issuer + "device",
+    jwks_uri: issuer + "jwks",
+    response_types_supported: ["code"],
+    grant_types_supported: [OAuthGrantType.AuthorizationCode, OAuthGrantType.RefreshToken, ...additionalGrantTypes],
+    code_challenge_methods_supported: ["S256"]
+  };
+};
+//# sourceMappingURL=testing.js.map

package/lib/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","names":["BriijEvent","EventType","DecryptionError","OAuthGrantType","mkBriijEvent","opts","_opts$eventId","_opts$ts","event","type","room_id","roomId","sender","content","event_id","eventId","Math","random","origin_server_ts","ts","unsigned","stateKey","undefined","state_key","mxEvent","userId","membership","name","rawDisplayName","getAvatarUrl","getMxcAvatarUrl","mkEncryptedBriijEvent","_x","_mkEncryptedBriijEvent","apply","arguments","_asyncToGenerator","RoomMessageEncrypted","algorithm","decryptExistingEvent","plainType","plainContent","mkDecryptionFailureBriijEvent","_x2","_mkDecryptionFailureBriijEvent","mockCrypto","decryptEvent","_decryptEvent","_ev","code","msg","_x5","attemptDecryption","_x3","_x4","_decryptExistingEvent","decryptionResult","claimedEd25519Key","clearEvent","senderCurve25519Key","_decryptEvent2","_x6","makeDelegatedAuthConfig","issuer","length","additionalGrantTypes","metadata","mockOpenIdConfiguration","_objectSpread","signingKeys","revocation_endpoint","token_endpoint","authorization_endpoint","registration_endpoint","device_authorization_endpoint","jwks_uri","response_types_supported","grant_types_supported","AuthorizationCode","RefreshToken","code_challenge_methods_supported"],"sources":["../src/testing.ts"],"sourcesContent":["/*\nCopyright 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/**\n * This file is a secondary entrypoint for the js-sdk library, exposing utilities which might be useful for writing tests.\n *\n * In general, it should not be included in runtime applications.\n *\n * @packageDocumentation\n */\n\nimport { type IContent, type IEvent, type IUnsigned, BriijEvent } from \"./models/event.ts\";\nimport { type RoomMember } from \"./models/room-member.ts\";\nimport { EventType } from \"./@types/event.ts\";\nimport { type DecryptionFailureCode } from \"./crypto-api/index.ts\";\nimport { DecryptionError, type EventDecryptionResult } from \"./common-crypto/CryptoBackend.ts\";\nimport { OAuthGrantType, type OidcClientConfig, type ValidatedAuthMetadata } from \"./oidc/index.ts\";\n\n/**\n * Create a {@link BriijEvent}.\n *\n * @param opts - Values for the event.\n */\nexport function mkBriijEvent(opts: {\n    /** Room ID of the event. */\n    roomId: string;\n\n    /** The sender of the event. */\n    sender: string;\n\n    /** The type of the event. */\n    type: EventType | string;\n\n    /** Optional `state_key` for the event. If unspecified, a non-state event is created. */\n    stateKey?: string;\n\n    /** Optional `origin_server_ts` for the event. If unspecified, the timestamp will be set to 0. */\n    ts?: number;\n\n    /** Optional `event_id` for the event. If provided will be used as event ID; else an ID is generated. */\n    eventId?: string;\n\n    /** Content of the event. */\n    content: IContent;\n\n    /** Optional `unsigned` data for the event. */\n    unsigned?: IUnsigned;\n}): BriijEvent {\n    const event: Partial<IEvent> = {\n        type: opts.type,\n        room_id: opts.roomId,\n        sender: opts.sender,\n        content: opts.content,\n        event_id: opts.eventId ?? \"$\" + Math.random() + \"-\" + Math.random(),\n        origin_server_ts: opts.ts ?? 0,\n        unsigned: opts.unsigned,\n    };\n    if (opts.stateKey !== undefined) {\n        event.state_key = opts.stateKey;\n    }\n\n    const mxEvent = new BriijEvent(event);\n    mxEvent.sender = {\n        userId: opts.sender,\n        membership: \"join\",\n        name: opts.sender,\n        rawDisplayName: opts.sender,\n        roomId: opts.sender,\n        getAvatarUrl: () => {},\n        getMxcAvatarUrl: () => {},\n    } as unknown as RoomMember;\n    return mxEvent;\n}\n\n/**\n * Create a `BriijEvent` representing a successfully-decrypted `m.room.encrypted` event.\n *\n * @param opts - Values for the event.\n */\nexport async function mkEncryptedBriijEvent(opts: {\n    /** Room ID of the event. */\n    roomId: string;\n\n    /** The sender of the event. */\n    sender: string;\n\n    /** The type the event will have, once it has been decrypted. */\n    plainType: EventType | string;\n\n    /** The content the event will have, once it has been decrypted. */\n    plainContent: IContent;\n\n    /** Optional `event_id` for the event. If provided will be used as event ID; else an ID is generated. */\n    eventId?: string;\n}): Promise<BriijEvent> {\n    const mxEvent = mkBriijEvent({\n        type: EventType.RoomMessageEncrypted,\n        roomId: opts.roomId,\n        sender: opts.sender,\n        content: { algorithm: \"m.megolm.v1.aes-sha2\" },\n        eventId: opts.eventId,\n    });\n\n    await decryptExistingEvent(mxEvent, { plainType: opts.plainType, plainContent: opts.plainContent });\n    return mxEvent;\n}\n\n/**\n * Create a `BriijEvent` representing a `m.room.encrypted` event which could not be decrypted.\n *\n * @param opts - Values for the event.\n */\nexport async function mkDecryptionFailureBriijEvent(opts: {\n    /** Room ID of the event. */\n    roomId: string;\n\n    /** The sender of the event. */\n    sender: string;\n\n    /** The reason code for the failure */\n    code: DecryptionFailureCode;\n\n    /** A textual reason for the failure */\n    msg: string;\n\n    /** Optional `event_id` for the event. If provided will be used as event ID; else an ID is generated. */\n    eventId?: string;\n}): Promise<BriijEvent> {\n    const mxEvent = mkBriijEvent({\n        type: EventType.RoomMessageEncrypted,\n        roomId: opts.roomId,\n        sender: opts.sender,\n        content: { algorithm: \"m.megolm.v1.aes-sha2\" },\n        eventId: opts.eventId,\n    });\n\n    const mockCrypto = {\n        decryptEvent: async (_ev): Promise<EventDecryptionResult> => {\n            throw new DecryptionError(opts.code, opts.msg);\n        },\n    } as Parameters<BriijEvent[\"attemptDecryption\"]>[0];\n    await mxEvent.attemptDecryption(mockCrypto);\n    return mxEvent;\n}\n\n/**\n * Given an event previously returned by {@link mkDecryptionFailureBriijEvent}, simulate a successful re-decryption\n * attempt.\n *\n * @param mxEvent - The event that will be decrypted.\n * @param opts - New data for the successful decryption.\n */\nexport async function decryptExistingEvent(\n    mxEvent: BriijEvent,\n    opts: {\n        /** The type the event will have, once it has been decrypted. */\n        plainType: EventType | string;\n\n        /** The content the event will have, once it has been decrypted. */\n        plainContent: IContent;\n    },\n): Promise<void> {\n    const decryptionResult: EventDecryptionResult = {\n        claimedEd25519Key: \"\",\n        clearEvent: {\n            type: opts.plainType,\n            content: opts.plainContent,\n        },\n        senderCurve25519Key: \"\",\n    };\n\n    const mockCrypto = {\n        decryptEvent: async (_ev): Promise<EventDecryptionResult> => decryptionResult,\n    } as Parameters<BriijEvent[\"attemptDecryption\"]>[0];\n    await mxEvent.attemptDecryption(mockCrypto);\n}\n\n/**\n * Makes a valid OidcClientConfig with minimum valid values\n * @param issuer used as the base for all other urls\n * @param additionalGrantTypes to add to the default grant types\n * @returns OidcClientConfig\n * @experimental\n */\nexport const makeDelegatedAuthConfig = (\n    issuer = \"https://auth.org/\",\n    additionalGrantTypes: string[] = [],\n): OidcClientConfig => {\n    const metadata = mockOpenIdConfiguration(issuer, additionalGrantTypes);\n\n    return {\n        ...metadata,\n        signingKeys: null,\n    };\n};\n\n/**\n * Useful for mocking <issuer>/.well-known/openid-configuration\n * @param issuer used as the base for all other urls\n * @param additionalGrantTypes to add to the default grant types\n * @returns ValidatedAuthMetadata\n * @experimental\n */\nexport const mockOpenIdConfiguration = (\n    issuer = \"https://auth.org/\",\n    additionalGrantTypes: string[] = [],\n): ValidatedAuthMetadata => ({\n    issuer,\n    revocation_endpoint: issuer + \"revoke\",\n    token_endpoint: issuer + \"token\",\n    authorization_endpoint: issuer + \"auth\",\n    registration_endpoint: issuer + \"registration\",\n    device_authorization_endpoint: issuer + \"device\",\n    jwks_uri: issuer + \"jwks\",\n    response_types_supported: [\"code\"],\n    grant_types_supported: [OAuthGrantType.AuthorizationCode, OAuthGrantType.RefreshToken, ...additionalGrantTypes],\n    code_challenge_methods_supported: [\"S256\"],\n});\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAqDA,UAAU,QAAQ,mBAAmB;AAE1F,SAASC,SAAS,QAAQ,mBAAmB;AAE7C,SAASC,eAAe,QAAoC,kCAAkC;AAC9F,SAASC,cAAc,QAA2D,iBAAiB;;AAEnG;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,IAwB5B,EAAc;EAAA,IAAAC,aAAA,EAAAC,QAAA;EACX,IAAMC,KAAsB,GAAG;IAC3BC,IAAI,EAAEJ,IAAI,CAACI,IAAI;IACfC,OAAO,EAAEL,IAAI,CAACM,MAAM;IACpBC,MAAM,EAAEP,IAAI,CAACO,MAAM;IACnBC,OAAO,EAAER,IAAI,CAACQ,OAAO;IACrBC,QAAQ,GAAAR,aAAA,GAAED,IAAI,CAACU,OAAO,cAAAT,aAAA,cAAAA,aAAA,GAAI,GAAG,GAAGU,IAAI,CAACC,MAAM,CAAC,CAAC,GAAG,GAAG,GAAGD,IAAI,CAACC,MAAM,CAAC,CAAC;IACnEC,gBAAgB,GAAAX,QAAA,GAAEF,IAAI,CAACc,EAAE,cAAAZ,QAAA,cAAAA,QAAA,GAAI,CAAC;IAC9Ba,QAAQ,EAAEf,IAAI,CAACe;EACnB,CAAC;EACD,IAAIf,IAAI,CAACgB,QAAQ,KAAKC,SAAS,EAAE;IAC7Bd,KAAK,CAACe,SAAS,GAAGlB,IAAI,CAACgB,QAAQ;EACnC;EAEA,IAAMG,OAAO,GAAG,IAAIxB,UAAU,CAACQ,KAAK,CAAC;EACrCgB,OAAO,CAACZ,MAAM,GAAG;IACba,MAAM,EAAEpB,IAAI,CAACO,MAAM;IACnBc,UAAU,EAAE,MAAM;IAClBC,IAAI,EAAEtB,IAAI,CAACO,MAAM;IACjBgB,cAAc,EAAEvB,IAAI,CAACO,MAAM;IAC3BD,MAAM,EAAEN,IAAI,CAACO,MAAM;IACnBiB,YAAY,EAAEA,CAAA,KAAM,CAAC,CAAC;IACtBC,eAAe,EAAEA,CAAA,KAAM,CAAC;EAC5B,CAA0B;EAC1B,OAAON,OAAO;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,gBAAsBO,qBAAqBA,CAAAC,EAAA;EAAA,OAAAC,sBAAA,CAAAC,KAAA,OAAAC,SAAA;AAAA;;AA4B3C;AACA;AACA;AACA;AACA;AAJA,SAAAF,uBAAA;EAAAA,sBAAA,GAAAG,iBAAA,CA5BO,WAAqC/B,IAe3C,EAAuB;IACpB,IAAMmB,OAAO,GAAGpB,YAAY,CAAC;MACzBK,IAAI,EAAER,SAAS,CAACoC,oBAAoB;MACpC1B,MAAM,EAAEN,IAAI,CAACM,MAAM;MACnBC,MAAM,EAAEP,IAAI,CAACO,MAAM;MACnBC,OAAO,EAAE;QAAEyB,SAAS,EAAE;MAAuB,CAAC;MAC9CvB,OAAO,EAAEV,IAAI,CAACU;IAClB,CAAC,CAAC;IAEF,MAAMwB,oBAAoB,CAACf,OAAO,EAAE;MAAEgB,SAAS,EAAEnC,IAAI,CAACmC,SAAS;MAAEC,YAAY,EAAEpC,IAAI,CAACoC;IAAa,CAAC,CAAC;IACnG,OAAOjB,OAAO;EAClB,CAAC;EAAA,OAAAS,sBAAA,CAAAC,KAAA,OAAAC,SAAA;AAAA;AAOD,gBAAsBO,6BAA6BA,CAAAC,GAAA;EAAA,OAAAC,8BAAA,CAAAV,KAAA,OAAAC,SAAA;AAAA;;AAiCnD;AACA;AACA;AACA;AACA;AACA;AACA;AANA,SAAAS,+BAAA;EAAAA,8BAAA,GAAAR,iBAAA,CAjCO,WAA6C/B,IAenD,EAAuB;IACpB,IAAMmB,OAAO,GAAGpB,YAAY,CAAC;MACzBK,IAAI,EAAER,SAAS,CAACoC,oBAAoB;MACpC1B,MAAM,EAAEN,IAAI,CAACM,MAAM;MACnBC,MAAM,EAAEP,IAAI,CAACO,MAAM;MACnBC,OAAO,EAAE;QAAEyB,SAAS,EAAE;MAAuB,CAAC;MAC9CvB,OAAO,EAAEV,IAAI,CAACU;IAClB,CAAC,CAAC;IAEF,IAAM8B,UAAU,GAAG;MACfC,YAAY;QAAA,IAAAC,aAAA,GAAAX,iBAAA,CAAE,WAAOY,GAAG,EAAqC;UACzD,MAAM,IAAI9C,eAAe,CAACG,IAAI,CAAC4C,IAAI,EAAE5C,IAAI,CAAC6C,GAAG,CAAC;QAClD,CAAC;QAAA,SAFDJ,YAAYA,CAAAK,GAAA;UAAA,OAAAJ,aAAA,CAAAb,KAAA,OAAAC,SAAA;QAAA;QAAA,OAAZW,YAAY;MAAA;IAGhB,CAAmD;IACnD,MAAMtB,OAAO,CAAC4B,iBAAiB,CAACP,UAAU,CAAC;IAC3C,OAAOrB,OAAO;EAClB,CAAC;EAAA,OAAAoB,8BAAA,CAAAV,KAAA,OAAAC,SAAA;AAAA;AASD,gBAAsBI,oBAAoBA,CAAAc,GAAA,EAAAC,GAAA;EAAA,OAAAC,qBAAA,CAAArB,KAAA,OAAAC,SAAA;AAAA;;AAyB1C;AACA;AACA;AACA;AACA;AACA;AACA;AANA,SAAAoB,sBAAA;EAAAA,qBAAA,GAAAnB,iBAAA,CAzBO,WACHZ,OAAmB,EACnBnB,IAMC,EACY;IACb,IAAMmD,gBAAuC,GAAG;MAC5CC,iBAAiB,EAAE,EAAE;MACrBC,UAAU,EAAE;QACRjD,IAAI,EAAEJ,IAAI,CAACmC,SAAS;QACpB3B,OAAO,EAAER,IAAI,CAACoC;MAClB,CAAC;MACDkB,mBAAmB,EAAE;IACzB,CAAC;IAED,IAAMd,UAAU,GAAG;MACfC,YAAY;QAAA,IAAAc,cAAA,GAAAxB,iBAAA,CAAE,WAAOY,GAAG;UAAA,OAAqCQ,gBAAgB;QAAA;QAAA,SAA7EV,YAAYA,CAAAe,GAAA;UAAA,OAAAD,cAAA,CAAA1B,KAAA,OAAAC,SAAA;QAAA;QAAA,OAAZW,YAAY;MAAA;IAChB,CAAmD;IACnD,MAAMtB,OAAO,CAAC4B,iBAAiB,CAACP,UAAU,CAAC;EAC/C,CAAC;EAAA,OAAAU,qBAAA,CAAArB,KAAA,OAAAC,SAAA;AAAA;AASD,OAAO,IAAM2B,uBAAuB,GAAG,SAA1BA,uBAAuBA,CAAA,EAGb;EAAA,IAFnBC,MAAM,GAAA5B,SAAA,CAAA6B,MAAA,QAAA7B,SAAA,QAAAb,SAAA,GAAAa,SAAA,MAAG,mBAAmB;EAAA,IAC5B8B,oBAA8B,GAAA9B,SAAA,CAAA6B,MAAA,QAAA7B,SAAA,QAAAb,SAAA,GAAAa,SAAA,MAAG,EAAE;EAEnC,IAAM+B,QAAQ,GAAGC,uBAAuB,CAACJ,MAAM,EAAEE,oBAAoB,CAAC;EAEtE,OAAAG,aAAA,CAAAA,aAAA,KACOF,QAAQ;IACXG,WAAW,EAAE;EAAI;AAEzB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMF,uBAAuB,GAAG,SAA1BA,uBAAuBA,CAAA;EAAA,IAChCJ,MAAM,GAAA5B,SAAA,CAAA6B,MAAA,QAAA7B,SAAA,QAAAb,SAAA,GAAAa,SAAA,MAAG,mBAAmB;EAAA,IAC5B8B,oBAA8B,GAAA9B,SAAA,CAAA6B,MAAA,QAAA7B,SAAA,QAAAb,SAAA,GAAAa,SAAA,MAAG,EAAE;EAAA,OACV;IACzB4B,MAAM;IACNO,mBAAmB,EAAEP,MAAM,GAAG,QAAQ;IACtCQ,cAAc,EAAER,MAAM,GAAG,OAAO;IAChCS,sBAAsB,EAAET,MAAM,GAAG,MAAM;IACvCU,qBAAqB,EAAEV,MAAM,GAAG,cAAc;IAC9CW,6BAA6B,EAAEX,MAAM,GAAG,QAAQ;IAChDY,QAAQ,EAAEZ,MAAM,GAAG,MAAM;IACzBa,wBAAwB,EAAE,CAAC,MAAM,CAAC;IAClCC,qBAAqB,EAAE,CAAC1E,cAAc,CAAC2E,iBAAiB,EAAE3E,cAAc,CAAC4E,YAAY,EAAE,GAAGd,oBAAoB,CAAC;IAC/Ge,gCAAgC,EAAE,CAAC,MAAM;EAC7C,CAAC;AAAA,CAAC","ignoreList":[]}

package/lib/thread-utils.d.ts

@@ -0,0 +1,10 @@
+import { type IEvent } from "./models/event.ts";
+/**
+ * Returns a filter function for the /relations endpoint to filter out relations directly
+ * to the thread root event that should not live in the thread timeline
+ *
+ * @param threadId - the thread ID (ie. the event ID of the root event of the thread)
+ * @returns the filtered list of events
+ */
+export declare function getRelationsThreadFilter(threadId: string): (e: Partial<IEvent>) => boolean;
+//# sourceMappingURL=thread-utils.d.ts.map

package/lib/thread-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"thread-utils.d.ts","sourceRoot":"","sources":["../src/thread-utils.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,OAAO,CAI1F"}

package/lib/thread-utils.js

@@ -0,0 +1,31 @@
+/*
+Copyright 2023 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 { THREAD_RELATION_TYPE } from "./models/thread.js";
+/**
+ * Returns a filter function for the /relations endpoint to filter out relations directly
+ * to the thread root event that should not live in the thread timeline
+ *
+ * @param threadId - the thread ID (ie. the event ID of the root event of the thread)
+ * @returns the filtered list of events
+ */
+export function getRelationsThreadFilter(threadId) {
+  return e => {
+    var _e$content, _e$content2;
+    return ((_e$content = e.content) === null || _e$content === void 0 || (_e$content = _e$content["m.relates_to"]) === null || _e$content === void 0 ? void 0 : _e$content.event_id) !== threadId || ((_e$content2 = e.content) === null || _e$content2 === void 0 || (_e$content2 = _e$content2["m.relates_to"]) === null || _e$content2 === void 0 ? void 0 : _e$content2.rel_type) === THREAD_RELATION_TYPE.name;
+  };
+}
+//# sourceMappingURL=thread-utils.js.map

package/lib/thread-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"thread-utils.js","names":["THREAD_RELATION_TYPE","getRelationsThreadFilter","threadId","e","_e$content","_e$content2","content","event_id","rel_type","name"],"sources":["../src/thread-utils.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { THREAD_RELATION_TYPE } from \"./models/thread.ts\";\r\nimport { type IEvent } from \"./models/event.ts\";\r\n\r\n/**\r\n * Returns a filter function for the /relations endpoint to filter out relations directly\r\n * to the thread root event that should not live in the thread timeline\r\n *\r\n * @param threadId - the thread ID (ie. the event ID of the root event of the thread)\r\n * @returns the filtered list of events\r\n */\r\nexport function getRelationsThreadFilter(threadId: string): (e: Partial<IEvent>) => boolean {\r\n    return (e: Partial<IEvent>) =>\r\n        e.content?.[\"m.relates_to\"]?.event_id !== threadId ||\r\n        e.content?.[\"m.relates_to\"]?.rel_type === THREAD_RELATION_TYPE.name;\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,oBAAoB,QAAQ,oBAAoB;AAGzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CAACC,QAAgB,EAAmC;EACxF,OAAQC,CAAkB;IAAA,IAAAC,UAAA,EAAAC,WAAA;IAAA,OACtB,EAAAD,UAAA,GAAAD,CAAC,CAACG,OAAO,cAAAF,UAAA,gBAAAA,UAAA,GAATA,UAAA,CAAY,cAAc,CAAC,cAAAA,UAAA,uBAA3BA,UAAA,CAA6BG,QAAQ,MAAKL,QAAQ,IAClD,EAAAG,WAAA,GAAAF,CAAC,CAACG,OAAO,cAAAD,WAAA,gBAAAA,WAAA,GAATA,WAAA,CAAY,cAAc,CAAC,cAAAA,WAAA,uBAA3BA,WAAA,CAA6BG,QAAQ,MAAKR,oBAAoB,CAACS,IAAI;EAAA;AAC3E","ignoreList":[]}

package/lib/timeline-window.d.ts

@@ -0,0 +1,168 @@
+import { type Direction, EventTimeline } from "./models/event-timeline.ts";
+import { type BriijClient } from "./client.ts";
+import { type EventTimelineSet } from "./models/event-timeline-set.ts";
+import { type BriijEvent } from "./models/event.ts";
+interface IOpts {
+    /**
+     * Maximum number of events to keep in the window. If more events are retrieved via pagination requests,
+     * excess events will be dropped from the other end of the window.
+     */
+    windowLimit?: number;
+}
+export declare class TimelineWindow {
+    private readonly client;
+    private readonly timelineSet;
+    private readonly windowLimit;
+    private start?;
+    private end?;
+    private eventCount;
+    /**
+     * Construct a TimelineWindow.
+     *
+     * <p>This abstracts the separate timelines in a Matrix {@link Room} into a single iterable thing.
+     * It keeps track of the start and endpoints of the window, which can be advanced with the help
+     * of pagination requests.
+     *
+     * <p>Before the window is useful, it must be initialised by calling {@link TimelineWindow#load}.
+     *
+     * <p>Note that the window will not automatically extend itself when new events
+     * are received from /sync; you should arrange to call {@link TimelineWindow#paginate}
+     * on {@link RoomEvent.Timeline} events.
+     *
+     * <p>Note that constructing an instance of this class for a room adds a
+     * listener for RoomEvent.Timeline events which is never removed. In theory
+     * this should not cause a leak since the EventEmitter uses weak mappings.
+     *
+     * @param client -   BriijClient to be used for context/pagination
+     *   requests.
+     *
+     * @param timelineSet -  The timelineSet to track
+     *
+     * @param opts - Configuration options for this window
+     */
+    constructor(client: BriijClient, timelineSet: EventTimelineSet, opts?: IOpts);
+    /**
+     * Initialise the window to point at a given event, or the live timeline
+     *
+     * @param initialEventId -   If given, the window will contain the
+     *    given event
+     * @param initialWindowSize -   Size of the initial window
+     */
+    load(initialEventId?: string, initialWindowSize?: number): Promise<void>;
+    /**
+     * Get the TimelineIndex of the window in the given direction.
+     *
+     * @param direction -   EventTimeline.BACKWARDS to get the TimelineIndex
+     * at the start of the window; EventTimeline.FORWARDS to get the TimelineIndex at
+     * the end.
+     *
+     * @returns The requested timeline index if one exists, null
+     * otherwise.
+     */
+    getTimelineIndex(direction: Direction): TimelineIndex | null;
+    /**
+     * Try to extend the window using events that are already in the underlying
+     * TimelineIndex.
+     *
+     * @param direction -   EventTimeline.BACKWARDS to try extending it
+     *   backwards; EventTimeline.FORWARDS to try extending it forwards.
+     * @param size -   number of events to try to extend by.
+     *
+     * @returns true if the window was extended, false otherwise.
+     */
+    extend(direction: Direction, size: number): boolean;
+    private onTimelineEvent;
+    /**
+     * If an event was removed, meaning this window is longer than the timeline,
+     * shorten the window.
+     */
+    private onEventRemoved;
+    /**
+     * Check if this window can be extended
+     *
+     * <p>This returns true if we either have more events, or if we have a
+     * pagination token which means we can paginate in that direction. It does not
+     * necessarily mean that there are more events available in that direction at
+     * this time.
+     *
+     * @param direction -   EventTimeline.BACKWARDS to check if we can
+     *   paginate backwards; EventTimeline.FORWARDS to check if we can go forwards
+     *
+     * @returns true if we can paginate in the given direction
+     */
+    canPaginate(direction: Direction): boolean;
+    /**
+     * Attempt to extend the window
+     *
+     * @param direction -   EventTimeline.BACKWARDS to extend the window
+     *    backwards (towards older events); EventTimeline.FORWARDS to go forwards.
+     *
+     * @param size -   number of events to try to extend by. If fewer than this
+     *    number are immediately available, then we return immediately rather than
+     *    making an API call.
+     *
+     * @param makeRequest - whether we should make API calls to
+     *    fetch further events if we don't have any at all. (This has no effect if
+     *    the room already knows about additional events in the relevant direction,
+     *    even if there are fewer than 'size' of them, as we will just return those
+     *    we already know about.)
+     *
+     * @param requestLimit - limit for the number of API requests we
+     *    should make.
+     *
+     * @returns Promise which resolves to a boolean which is true if more events
+     *    were successfully retrieved.
+     */
+    paginate(direction: Direction, size: number, makeRequest?: boolean, requestLimit?: number): Promise<boolean>;
+    /**
+     * Remove `delta` events from the start or end of the timeline.
+     *
+     * @param delta - number of events to remove from the timeline
+     * @param startOfTimeline - if events should be removed from the start
+     *     of the timeline.
+     */
+    unpaginate(delta: number, startOfTimeline: boolean): void;
+    /**
+     * Get a list of the events currently in the window
+     *
+     * @returns the events in the window
+     */
+    getEvents(): BriijEvent[];
+}
+/**
+ * A thing which contains a timeline reference, and an index into it.
+ * @internal
+ */
+export declare class TimelineIndex {
+    timeline: EventTimeline;
+    index: number;
+    pendingPaginate?: Promise<boolean>;
+    constructor(timeline: EventTimeline, index: number);
+    /**
+     * @returns the minimum possible value for the index in the current
+     *    timeline
+     */
+    minIndex(): number;
+    /**
+     * @returns the maximum possible value for the index in the current
+     *    timeline (exclusive - ie, it actually returns one more than the index
+     *    of the last element).
+     */
+    maxIndex(): number;
+    /**
+     * Try move the index forward, or into the neighbouring timeline
+     *
+     * @param delta -  number of events to advance by
+     * @returns number of events successfully advanced by
+     */
+    advance(delta: number): number;
+    /**
+     * Try move the index backwards, or into the neighbouring timeline
+     *
+     * @param delta -  number of events to retreat by
+     * @returns number of events successfully retreated by
+     */
+    retreat(delta: number): number;
+}
+export {};
+//# sourceMappingURL=timeline-window.d.ts.map

package/lib/timeline-window.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeline-window.d.ts","sourceRoot":"","sources":["../src/timeline-window.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,SAAS,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAwBpD,UAAU,KAAK;IACX;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,qBAAa,cAAc;IAmCnB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAnChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IAKrC,OAAO,CAAC,KAAK,CAAC,CAAgB;IAC9B,OAAO,CAAC,GAAG,CAAC,CAAgB;IAC5B,OAAO,CAAC,UAAU,CAAK;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;gBAEkB,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,gBAAgB,EAC9C,IAAI,GAAE,KAAU;IAMpB;;;;;;OAMG;IACI,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,iBAAiB,SAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IA2C3E;;;;;;;;;OASG;IACI,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,IAAI;IAUnE;;;;;;;;;OASG;IACI,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAwB1D,OAAO,CAAC,eAAe;IAMvB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAOtB;;;;;;;;;;;;OAYG;IACI,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAuBjD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,QAAQ,CACjB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,WAAW,UAAO,EAClB,YAAY,SAA8B,GAC3C,OAAO,CAAC,OAAO,CAAC;IAkEnB;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IA4BhE;;;;OAIG;IACI,SAAS,IAAI,UAAU,EAAE;CA8CnC;AAED;;;GAGG;AACH,qBAAa,aAAa;IAKX,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,MAAM;IALjB,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;gBAI/B,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM;IAGxB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;OAIG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAuDrC;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAGxC"}