matrix-js-sdk 28.2.0 → 29.0.0-rc.1

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+Changes in [29.0.0-rc.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v29.0.0-rc.1) (2023-10-03)
+============================================================================================================
+
+## 🚨 BREAKING CHANGES
+ * Remove browserify builds ([\#3759](https://github.com/matrix-org/matrix-js-sdk/pull/3759)).
+
+## ✨ Features
+ * Export AutoDiscoveryError and fix type of ALL_ERRORS ([\#3768](https://github.com/matrix-org/matrix-js-sdk/pull/3768)).
+ * Support for stable MSC3882 get_login_token ([\#3416](https://github.com/matrix-org/matrix-js-sdk/pull/3416)). Contributed by @hughns.
+ * Remove IsUserMention and IsRoomMention from DEFAULT_OVERRIDE_RULES ([\#3752](https://github.com/matrix-org/matrix-js-sdk/pull/3752)). Contributed by @kerryarchibald.
+
+## 🐛 Bug Fixes
+ * Fix a case where joinRoom creates a duplicate Room object ([\#3747](https://github.com/matrix-org/matrix-js-sdk/pull/3747)).
+ * Add membershipID to call memberships ([\#3745](https://github.com/matrix-org/matrix-js-sdk/pull/3745)).
+ * Fix the warning for messages from unsigned devices ([\#3743](https://github.com/matrix-org/matrix-js-sdk/pull/3743)).
+ * Stop keep alive, when sync was stoped ([\#3720](https://github.com/matrix-org/matrix-js-sdk/pull/3720)). Contributed by @finsterwalder.
+
 Changes in [28.2.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v28.2.0) (2023-09-26)
 ==================================================================================================
 

package/README.md

@@ -23,19 +23,7 @@ endpoints from before Matrix 1.1, for example.
 
 ## In a browser
 
-### Note, the browserify build has been deprecated. Please use a bundler like webpack or vite instead.
-
-Download the browser version from
-https://github.com/matrix-org/matrix-js-sdk/releases/latest and add that as a
-`<script>` to your page. There will be a global variable `matrixcs`
-attached to `window` through which you can access the SDK. See below for how to
-include libolm to enable end-to-end-encryption.
-
-The browser bundle supports recent versions of browsers. Typically this is ES2015
-or `> 0.5%, last 2 versions, Firefox ESR, not dead` if using
-[browserlists](https://github.com/browserslist/browserslist).
-
-Please check [the working browser example](examples/browser) for more information.
+### Note, the browserify build has been removed. Please use a bundler like webpack or vite instead.
 
 ## In Node.js
 
@@ -375,9 +363,6 @@ To run tests (Jest):
  $ yarn test
 ```
 
-> **Note**
-> The `sync-browserify.spec.ts` requires a browser build (`yarn build`) in order to pass
-
 To run linting:
 
 ```

package/git-revision.txt

@@ -1 +1 @@
-a49150854336b703ba106c791ed0a0406b2f97de
+53a72df01ba684340f83a0d68ab5c29248a8e9d4

package/lib/@types/auth.d.ts

@@ -197,9 +197,7 @@ export interface LoginResponse {
     home_server?: string;
 }
 /**
- * The result of a successful [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882)
- * `m.login.token` issuance request.
- * Note that this is UNSTABLE and subject to breaking changes without notice.
+ * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token
  */
 export interface LoginTokenPostResponse {
     /**
@@ -209,7 +207,7 @@ export interface LoginTokenPostResponse {
     /**
      * Expiration in seconds.
      *
-     * @deprecated this is only provided for compatibility with original revision of the MSC.
+     * @deprecated this is only provided for compatibility with original revision of [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882).
      */
     expires_in: number;
     /**

package/lib/@types/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/@types/auth.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAK7C;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACzB;AAID;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED,eAAO,MAAM,4BAA4B,kGAGxC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,UAAU;IACxC,IAAI,EAAE,aAAa,GAAG,aAAa,CAAC;IAEpC,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACzC,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC;IAC9C,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,oBAAY,qBAAqB;IAC7B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAAC;CAC1C;AAED,oBAAY,SAAS;IACjB,uDAAuD;IACvD,KAAK,UAAU;IAEf,qDAAqD;IACrD,QAAQ,aAAa;CACxB;AAED;;;;GAIG;AACH,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,KAAK,yBAAyB,GAAG;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,KAAK,oBAAoB,GAAG;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,kBAAkB,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AAEjG;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,kBAAkB,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,IAAI,EAAE,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAAC;IACpD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/@types/auth.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAK7C;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACzB;AAID;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED,eAAO,MAAM,4BAA4B,kGAGxC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,UAAU;IACxC,IAAI,EAAE,aAAa,GAAG,aAAa,CAAC;IAEpC,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACzC,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC;IAC9C,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,oBAAY,qBAAqB;IAC7B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAAC;CAC1C;AAED,oBAAY,SAAS;IACjB,uDAAuD;IACvD,KAAK,UAAU;IAEf,qDAAqD;IACrD,QAAQ,aAAa;CACxB;AAED;;;;GAIG;AACH,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,KAAK,yBAAyB,GAAG;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,KAAK,oBAAoB,GAAG;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,kBAAkB,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AAEjG;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,kBAAkB,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,IAAI,EAAE,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAAC;IACpD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB"}

package/lib/@types/auth.js

@@ -92,9 +92,7 @@ let SSOAction = /*#__PURE__*/function (SSOAction) {
  * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login
  */
 /**
- * The result of a successful [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882)
- * `m.login.token` issuance request.
- * Note that this is UNSTABLE and subject to breaking changes without notice.
+ * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token
  */
 exports.SSOAction = SSOAction;
 //# sourceMappingURL=auth.js.map

package/lib/@types/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","names":["_NamespacedValue","require","DELEGATED_OIDC_COMPATIBILITY","UnstableValue","exports","IdentityProviderBrand","SSOAction"],"sources":["../../src/@types/auth.ts"],"sourcesContent":["/*\nCopyright 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 { UnstableValue } from \"../NamespacedValue\";\nimport { IClientWellKnown } from \"../client\";\n\n// disable lint because these are wire responses\n/* eslint-disable camelcase */\n\n/**\n * Represents a response to the CSAPI `/refresh` endpoint.\n */\nexport interface IRefreshTokenResponse {\n    access_token: string;\n    expires_in_ms: number;\n    refresh_token: string;\n}\n\n/* eslint-enable camelcase */\n\n/**\n * Response to GET login flows as per https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3login\n */\nexport interface ILoginFlowsResponse {\n    flows: LoginFlow[];\n}\n\nexport type LoginFlow = ISSOFlow | IPasswordFlow | ILoginFlow;\n\nexport interface ILoginFlow {\n    type: string;\n}\n\nexport interface IPasswordFlow extends ILoginFlow {\n    type: \"m.login.password\";\n}\n\nexport const DELEGATED_OIDC_COMPATIBILITY = new UnstableValue(\n    \"delegated_oidc_compatibility\",\n    \"org.matrix.msc3824.delegated_oidc_compatibility\",\n);\n\n/**\n * Representation of SSO flow as per https://spec.matrix.org/v1.3/client-server-api/#client-login-via-sso\n */\nexport interface ISSOFlow extends ILoginFlow {\n    type: \"m.login.sso\" | \"m.login.cas\";\n    // eslint-disable-next-line camelcase\n    identity_providers?: IIdentityProvider[];\n    [DELEGATED_OIDC_COMPATIBILITY.name]?: boolean;\n    [DELEGATED_OIDC_COMPATIBILITY.altName]?: boolean;\n}\n\nexport enum IdentityProviderBrand {\n    Gitlab = \"gitlab\",\n    Github = \"github\",\n    Apple = \"apple\",\n    Google = \"google\",\n    Facebook = \"facebook\",\n    Twitter = \"twitter\",\n}\n\nexport interface IIdentityProvider {\n    id: string;\n    name: string;\n    icon?: string;\n    brand?: IdentityProviderBrand | string;\n}\n\nexport enum SSOAction {\n    /** The user intends to login to an existing account */\n    LOGIN = \"login\",\n\n    /** The user intends to register for a new account */\n    REGISTER = \"register\",\n}\n\n/**\n * A client can identify a user using their Matrix ID.\n * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.\n * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id\n */\ntype UserLoginIdentifier = {\n    type: \"m.id.user\";\n    user: string;\n};\n\n/**\n * A client can identify a user using a 3PID associated with the user’s account on the homeserver,\n * where the 3PID was previously associated using the /account/3pid API.\n * See the 3PID Types Appendix for a list of Third-party ID media.\n * @see https://spec.matrix.org/v1.7/client-server-api/#third-party-id\n */\ntype ThirdPartyLoginIdentifier = {\n    type: \"m.id.thirdparty\";\n    medium: string;\n    address: string;\n};\n\n/**\n * A client can identify a user using a phone number associated with the user’s account,\n * where the phone number was previously associated using the /account/3pid API.\n * The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it.\n * If the client wishes to canonicalise the phone number,\n * then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.\n *\n * The country is the two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone should be parsed as if it were dialled from.\n *\n * @see https://spec.matrix.org/v1.7/client-server-api/#phone-number\n */\ntype PhoneLoginIdentifier = {\n    type: \"m.id.phone\";\n    country: string;\n    phone: string;\n};\n\ntype SpecUserIdentifier = UserLoginIdentifier | ThirdPartyLoginIdentifier | PhoneLoginIdentifier;\n\n/**\n * User Identifiers usable for login & user-interactive authentication.\n *\n * Extensibly allows more than Matrix specified identifiers.\n */\nexport type UserIdentifier =\n    | SpecUserIdentifier\n    | { type: Exclude<string, SpecUserIdentifier[\"type\"]>; [key: string]: any };\n\n/**\n * Request body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginRequest {\n    /**\n     * The login type being used.\n     */\n    type: \"m.login.password\" | \"m.login.token\" | string;\n    /**\n     * Third-party identifier for the user.\n     * @deprecated in favour of `identifier`.\n     */\n    address?: string;\n    /**\n     * ID of the client device.\n     * If this does not correspond to a known client device, a new device will be created.\n     * The given device ID must not be the same as a cross-signing key ID.\n     * The server will auto-generate a device_id if this is not specified.\n     */\n    device_id?: string;\n    /**\n     * Identification information for a user\n     */\n    identifier?: UserIdentifier;\n    /**\n     * A display name to assign to the newly-created device.\n     * Ignored if device_id corresponds to a known device.\n     */\n    initial_device_display_name?: string;\n    /**\n     * When logging in using a third-party identifier, the medium of the identifier.\n     * Must be `email`.\n     * @deprecated in favour of `identifier`.\n     */\n    medium?: \"email\";\n    /**\n     * Required when type is `m.login.password`. The user’s password.\n     */\n    password?: string;\n    /**\n     * If true, the client supports refresh tokens.\n     */\n    refresh_token?: boolean;\n    /**\n     * Required when type is `m.login.token`. Part of Token-based login.\n     */\n    token?: string;\n    /**\n     * The fully qualified user ID or just local part of the user ID, to log in.\n     * @deprecated in favour of identifier.\n     */\n    user?: string;\n    // Extensible\n    [key: string]: any;\n}\n\n// Export for backwards compatibility\nexport type ILoginParams = LoginRequest;\n\n/**\n * Response body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginResponse {\n    /**\n     * An access token for the account.\n     * This access token can then be used to authorize other requests.\n     */\n    access_token: string;\n    /**\n     * ID of the logged-in device.\n     * Will be the same as the corresponding parameter in the request, if one was specified.\n     */\n    device_id: string;\n    /**\n     * The fully-qualified Matrix ID for the account.\n     */\n    user_id: string;\n    /**\n     * The lifetime of the access token, in milliseconds.\n     * Once the access token has expired a new access token can be obtained by using the provided refresh token.\n     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.\n     * If not given, the client can assume that the access token will not expire.\n     */\n    expires_in_ms?: number;\n    /**\n     * A refresh token for the account.\n     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.\n     */\n    refresh_token?: string;\n    /**\n     * Optional client configuration provided by the server.\n     * If present, clients SHOULD use the provided object to reconfigure themselves, optionally validating the URLs within.\n     * This object takes the same form as the one returned from .well-known autodiscovery.\n     */\n    well_known?: IClientWellKnown;\n    /**\n     * The server_name of the homeserver on which the account has been registered.\n     * @deprecated Clients should extract the server_name from user_id (by splitting at the first colon) if they require it.\n     */\n    home_server?: string;\n}\n\n/**\n * The result of a successful [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882)\n * `m.login.token` issuance request.\n * Note that this is UNSTABLE and subject to breaking changes without notice.\n */\nexport interface LoginTokenPostResponse {\n    /**\n     * The token to use with `m.login.token` to authenticate.\n     */\n    login_token: string;\n    /**\n     * Expiration in seconds.\n     *\n     * @deprecated this is only provided for compatibility with original revision of the MSC.\n     */\n    expires_in: number;\n    /**\n     * Expiration in milliseconds.\n     */\n    expires_in_ms: number;\n}\n"],"mappings":";;;;;;AAgBA,IAAAA,gBAAA,GAAAC,OAAA;AAhBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;;AAEA;AACA;AACA;;AAOA;;AAEA;AACA;AACA;;AAeO,MAAMC,4BAA4B,GAAG,IAAIC,8BAAa,CACzD,8BAA8B,EAC9B,iDACJ,CAAC;;AAED;AACA;AACA;AAFAC,OAAA,CAAAF,4BAAA,GAAAA,4BAAA;AAAA,IAWYG,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAAAD,OAAA,CAAAC,qBAAA,GAAAA,qBAAA;AAAA,IAgBrBC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAQrB;AACA;AACA;AACA;AACA;AAMA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AASA;AACA;AACA;AACA;AACA;AAKA;AACA;AACA;AACA;AAsDA;AAGA;AACA;AACA;AACA;AAyCA;AACA;AACA;AACA;AACA;AAJAF,OAAA,CAAAE,SAAA,GAAAA,SAAA"}
+{"version":3,"file":"auth.js","names":["_NamespacedValue","require","DELEGATED_OIDC_COMPATIBILITY","UnstableValue","exports","IdentityProviderBrand","SSOAction"],"sources":["../../src/@types/auth.ts"],"sourcesContent":["/*\nCopyright 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 { UnstableValue } from \"../NamespacedValue\";\nimport { IClientWellKnown } from \"../client\";\n\n// disable lint because these are wire responses\n/* eslint-disable camelcase */\n\n/**\n * Represents a response to the CSAPI `/refresh` endpoint.\n */\nexport interface IRefreshTokenResponse {\n    access_token: string;\n    expires_in_ms: number;\n    refresh_token: string;\n}\n\n/* eslint-enable camelcase */\n\n/**\n * Response to GET login flows as per https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3login\n */\nexport interface ILoginFlowsResponse {\n    flows: LoginFlow[];\n}\n\nexport type LoginFlow = ISSOFlow | IPasswordFlow | ILoginFlow;\n\nexport interface ILoginFlow {\n    type: string;\n}\n\nexport interface IPasswordFlow extends ILoginFlow {\n    type: \"m.login.password\";\n}\n\nexport const DELEGATED_OIDC_COMPATIBILITY = new UnstableValue(\n    \"delegated_oidc_compatibility\",\n    \"org.matrix.msc3824.delegated_oidc_compatibility\",\n);\n\n/**\n * Representation of SSO flow as per https://spec.matrix.org/v1.3/client-server-api/#client-login-via-sso\n */\nexport interface ISSOFlow extends ILoginFlow {\n    type: \"m.login.sso\" | \"m.login.cas\";\n    // eslint-disable-next-line camelcase\n    identity_providers?: IIdentityProvider[];\n    [DELEGATED_OIDC_COMPATIBILITY.name]?: boolean;\n    [DELEGATED_OIDC_COMPATIBILITY.altName]?: boolean;\n}\n\nexport enum IdentityProviderBrand {\n    Gitlab = \"gitlab\",\n    Github = \"github\",\n    Apple = \"apple\",\n    Google = \"google\",\n    Facebook = \"facebook\",\n    Twitter = \"twitter\",\n}\n\nexport interface IIdentityProvider {\n    id: string;\n    name: string;\n    icon?: string;\n    brand?: IdentityProviderBrand | string;\n}\n\nexport enum SSOAction {\n    /** The user intends to login to an existing account */\n    LOGIN = \"login\",\n\n    /** The user intends to register for a new account */\n    REGISTER = \"register\",\n}\n\n/**\n * A client can identify a user using their Matrix ID.\n * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.\n * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id\n */\ntype UserLoginIdentifier = {\n    type: \"m.id.user\";\n    user: string;\n};\n\n/**\n * A client can identify a user using a 3PID associated with the user’s account on the homeserver,\n * where the 3PID was previously associated using the /account/3pid API.\n * See the 3PID Types Appendix for a list of Third-party ID media.\n * @see https://spec.matrix.org/v1.7/client-server-api/#third-party-id\n */\ntype ThirdPartyLoginIdentifier = {\n    type: \"m.id.thirdparty\";\n    medium: string;\n    address: string;\n};\n\n/**\n * A client can identify a user using a phone number associated with the user’s account,\n * where the phone number was previously associated using the /account/3pid API.\n * The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it.\n * If the client wishes to canonicalise the phone number,\n * then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.\n *\n * The country is the two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone should be parsed as if it were dialled from.\n *\n * @see https://spec.matrix.org/v1.7/client-server-api/#phone-number\n */\ntype PhoneLoginIdentifier = {\n    type: \"m.id.phone\";\n    country: string;\n    phone: string;\n};\n\ntype SpecUserIdentifier = UserLoginIdentifier | ThirdPartyLoginIdentifier | PhoneLoginIdentifier;\n\n/**\n * User Identifiers usable for login & user-interactive authentication.\n *\n * Extensibly allows more than Matrix specified identifiers.\n */\nexport type UserIdentifier =\n    | SpecUserIdentifier\n    | { type: Exclude<string, SpecUserIdentifier[\"type\"]>; [key: string]: any };\n\n/**\n * Request body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginRequest {\n    /**\n     * The login type being used.\n     */\n    type: \"m.login.password\" | \"m.login.token\" | string;\n    /**\n     * Third-party identifier for the user.\n     * @deprecated in favour of `identifier`.\n     */\n    address?: string;\n    /**\n     * ID of the client device.\n     * If this does not correspond to a known client device, a new device will be created.\n     * The given device ID must not be the same as a cross-signing key ID.\n     * The server will auto-generate a device_id if this is not specified.\n     */\n    device_id?: string;\n    /**\n     * Identification information for a user\n     */\n    identifier?: UserIdentifier;\n    /**\n     * A display name to assign to the newly-created device.\n     * Ignored if device_id corresponds to a known device.\n     */\n    initial_device_display_name?: string;\n    /**\n     * When logging in using a third-party identifier, the medium of the identifier.\n     * Must be `email`.\n     * @deprecated in favour of `identifier`.\n     */\n    medium?: \"email\";\n    /**\n     * Required when type is `m.login.password`. The user’s password.\n     */\n    password?: string;\n    /**\n     * If true, the client supports refresh tokens.\n     */\n    refresh_token?: boolean;\n    /**\n     * Required when type is `m.login.token`. Part of Token-based login.\n     */\n    token?: string;\n    /**\n     * The fully qualified user ID or just local part of the user ID, to log in.\n     * @deprecated in favour of identifier.\n     */\n    user?: string;\n    // Extensible\n    [key: string]: any;\n}\n\n// Export for backwards compatibility\nexport type ILoginParams = LoginRequest;\n\n/**\n * Response body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginResponse {\n    /**\n     * An access token for the account.\n     * This access token can then be used to authorize other requests.\n     */\n    access_token: string;\n    /**\n     * ID of the logged-in device.\n     * Will be the same as the corresponding parameter in the request, if one was specified.\n     */\n    device_id: string;\n    /**\n     * The fully-qualified Matrix ID for the account.\n     */\n    user_id: string;\n    /**\n     * The lifetime of the access token, in milliseconds.\n     * Once the access token has expired a new access token can be obtained by using the provided refresh token.\n     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.\n     * If not given, the client can assume that the access token will not expire.\n     */\n    expires_in_ms?: number;\n    /**\n     * A refresh token for the account.\n     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.\n     */\n    refresh_token?: string;\n    /**\n     * Optional client configuration provided by the server.\n     * If present, clients SHOULD use the provided object to reconfigure themselves, optionally validating the URLs within.\n     * This object takes the same form as the one returned from .well-known autodiscovery.\n     */\n    well_known?: IClientWellKnown;\n    /**\n     * The server_name of the homeserver on which the account has been registered.\n     * @deprecated Clients should extract the server_name from user_id (by splitting at the first colon) if they require it.\n     */\n    home_server?: string;\n}\n\n/**\n * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token\n */\nexport interface LoginTokenPostResponse {\n    /**\n     * The token to use with `m.login.token` to authenticate.\n     */\n    login_token: string;\n    /**\n     * Expiration in seconds.\n     *\n     * @deprecated this is only provided for compatibility with original revision of [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882).\n     */\n    expires_in: number;\n    /**\n     * Expiration in milliseconds.\n     */\n    expires_in_ms: number;\n}\n"],"mappings":";;;;;;AAgBA,IAAAA,gBAAA,GAAAC,OAAA;AAhBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;;AAEA;AACA;AACA;;AAOA;;AAEA;AACA;AACA;;AAeO,MAAMC,4BAA4B,GAAG,IAAIC,8BAAa,CACzD,8BAA8B,EAC9B,iDACJ,CAAC;;AAED;AACA;AACA;AAFAC,OAAA,CAAAF,4BAAA,GAAAA,4BAAA;AAAA,IAWYG,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAAAD,OAAA,CAAAC,qBAAA,GAAAA,qBAAA;AAAA,IAgBrBC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAQrB;AACA;AACA;AACA;AACA;AAMA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AASA;AACA;AACA;AACA;AACA;AAKA;AACA;AACA;AACA;AAsDA;AAGA;AACA;AACA;AACA;AAyCA;AACA;AACA;AAFAF,OAAA,CAAAE,SAAA,GAAAA,SAAA"}

package/lib/browser-index.d.ts

@@ -5,5 +5,4 @@ declare global {
     var matrixcs: BrowserMatrix;
 }
 export * from "./matrix";
-export default matrixcs;
 //# sourceMappingURL=browser-index.d.ts.map

package/lib/browser-index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-index.d.ts","sourceRoot":"","sources":["../src/browser-index.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,KAAK,aAAa,GAAG,OAAO,QAAQ,CAAC;AACrC,OAAO,CAAC,MAAM,CAAC;IAEX,IAAI,mBAAmB,EAAE,OAAO,CAAC;IACjC,IAAI,QAAQ,EAAE,aAAa,CAAC;CAE/B;AAoBD,cAAc,UAAU,CAAC;AACzB,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"browser-index.d.ts","sourceRoot":"","sources":["../src/browser-index.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,KAAK,aAAa,GAAG,OAAO,QAAQ,CAAC;AACrC,OAAO,CAAC,MAAM,CAAC;IAEX,IAAI,mBAAmB,EAAE,OAAO,CAAC;IACjC,IAAI,QAAQ,EAAE,aAAa,CAAC;CAE/B;AAkBD,cAAc,UAAU,CAAC"}

package/lib/browser-index.js

@@ -3,12 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _exportNames = {};
-exports.default = void 0;
 var matrixcs = _interopRequireWildcard(require("./matrix"));
 Object.keys(matrixcs).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
   if (key in exports && exports[key] === matrixcs[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
@@ -35,25 +32,20 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-if (global.__js_sdk_entrypoint) {
+if (globalThis.__js_sdk_entrypoint) {
   throw new Error("Multiple matrix-js-sdk entrypoints detected!");
 }
-global.__js_sdk_entrypoint = true;
+globalThis.__js_sdk_entrypoint = true;
 
 // just *accessing* indexedDB throws an exception in firefox with indexeddb disabled.
 let indexedDB;
 try {
-  indexedDB = global.indexedDB;
+  indexedDB = globalThis.indexedDB;
 } catch (e) {}
 
 // if our browser (appears to) support indexeddb, use an indexeddb crypto store.
 if (indexedDB) {
   matrixcs.setCryptoStoreFactory(() => new matrixcs.IndexedDBCryptoStore(indexedDB, "matrix-js-sdk:crypto"));
 }
-
-// We export 3 things to make browserify happy as well as downstream projects.
-// It's awkward, but required.
-var _default = matrixcs; // keep export for browserify package deps
-exports.default = _default;
-global.matrixcs = matrixcs;
+globalThis.matrixcs = matrixcs;
 //# sourceMappingURL=browser-index.js.map

package/lib/browser-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"browser-index.js","names":["matrixcs","_interopRequireWildcard","require","Object","keys","forEach","key","prototype","hasOwnProperty","call","_exportNames","exports","defineProperty","enumerable","get","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","newObj","hasPropertyDescriptor","getOwnPropertyDescriptor","desc","set","global","__js_sdk_entrypoint","Error","indexedDB","e","setCryptoStoreFactory","IndexedDBCryptoStore","_default"],"sources":["../src/browser-index.ts"],"sourcesContent":["/*\nCopyright 2019 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 * as matrixcs from \"./matrix\";\n\ntype BrowserMatrix = typeof matrixcs;\ndeclare global {\n    /* eslint-disable no-var, camelcase */\n    var __js_sdk_entrypoint: boolean;\n    var matrixcs: BrowserMatrix;\n    /* eslint-enable no-var */\n}\n\nif (global.__js_sdk_entrypoint) {\n    throw new Error(\"Multiple matrix-js-sdk entrypoints detected!\");\n}\nglobal.__js_sdk_entrypoint = true;\n\n// just *accessing* indexedDB throws an exception in firefox with indexeddb disabled.\nlet indexedDB: IDBFactory | undefined;\ntry {\n    indexedDB = global.indexedDB;\n} catch (e) {}\n\n// if our browser (appears to) support indexeddb, use an indexeddb crypto store.\nif (indexedDB) {\n    matrixcs.setCryptoStoreFactory(() => new matrixcs.IndexedDBCryptoStore(indexedDB!, \"matrix-js-sdk:crypto\"));\n}\n\n// We export 3 things to make browserify happy as well as downstream projects.\n// It's awkward, but required.\nexport * from \"./matrix\";\nexport default matrixcs; // keep export for browserify package deps\nglobal.matrixcs = matrixcs;\n"],"mappings":";;;;;;;AAgBA,IAAAA,QAAA,GAAAC,uBAAA,CAAAC,OAAA;AA4BAC,MAAA,CAAAC,IAAA,CAAAJ,QAAA,EAAAK,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAN,QAAA,CAAAM,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAd,QAAA,CAAAM,GAAA;IAAA;EAAA;AAAA;AAAyB,SAAAS,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAf,wBAAAmB,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAT,GAAA,CAAAM,GAAA,SAAAK,MAAA,WAAAC,qBAAA,GAAAvB,MAAA,CAAAS,cAAA,IAAAT,MAAA,CAAAwB,wBAAA,WAAArB,GAAA,IAAAc,GAAA,QAAAd,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAW,GAAA,EAAAd,GAAA,SAAAsB,IAAA,GAAAF,qBAAA,GAAAvB,MAAA,CAAAwB,wBAAA,CAAAP,GAAA,EAAAd,GAAA,cAAAsB,IAAA,KAAAA,IAAA,CAAAd,GAAA,IAAAc,IAAA,CAAAC,GAAA,KAAA1B,MAAA,CAAAS,cAAA,CAAAa,MAAA,EAAAnB,GAAA,EAAAsB,IAAA,YAAAH,MAAA,CAAAnB,GAAA,IAAAc,GAAA,CAAAd,GAAA,SAAAmB,MAAA,CAAAH,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAM,GAAA,CAAAT,GAAA,EAAAK,MAAA,YAAAA,MAAA;AA5CzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,IAAIK,MAAM,CAACC,mBAAmB,EAAE;EAC5B,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACnE;AACAF,MAAM,CAACC,mBAAmB,GAAG,IAAI;;AAEjC;AACA,IAAIE,SAAiC;AACrC,IAAI;EACAA,SAAS,GAAGH,MAAM,CAACG,SAAS;AAChC,CAAC,CAAC,OAAOC,CAAC,EAAE,CAAC;;AAEb;AACA,IAAID,SAAS,EAAE;EACXjC,QAAQ,CAACmC,qBAAqB,CAAC,MAAM,IAAInC,QAAQ,CAACoC,oBAAoB,CAACH,SAAS,EAAG,sBAAsB,CAAC,CAAC;AAC/G;;AAEA;AACA;AAAA,IAAAI,QAAA,GAEerC,QAAQ,EAAE;AAAAW,OAAA,CAAAW,OAAA,GAAAe,QAAA;AACzBP,MAAM,CAAC9B,QAAQ,GAAGA,QAAQ"}
+{"version":3,"file":"browser-index.js","names":["matrixcs","_interopRequireWildcard","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","newObj","hasPropertyDescriptor","getOwnPropertyDescriptor","prototype","hasOwnProperty","call","desc","set","globalThis","__js_sdk_entrypoint","Error","indexedDB","e","setCryptoStoreFactory","IndexedDBCryptoStore"],"sources":["../src/browser-index.ts"],"sourcesContent":["/*\nCopyright 2019 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 * as matrixcs from \"./matrix\";\n\ntype BrowserMatrix = typeof matrixcs;\ndeclare global {\n    /* eslint-disable no-var, camelcase */\n    var __js_sdk_entrypoint: boolean;\n    var matrixcs: BrowserMatrix;\n    /* eslint-enable no-var */\n}\n\nif (globalThis.__js_sdk_entrypoint) {\n    throw new Error(\"Multiple matrix-js-sdk entrypoints detected!\");\n}\nglobalThis.__js_sdk_entrypoint = true;\n\n// just *accessing* indexedDB throws an exception in firefox with indexeddb disabled.\nlet indexedDB: IDBFactory | undefined;\ntry {\n    indexedDB = globalThis.indexedDB;\n} catch (e) {}\n\n// if our browser (appears to) support indexeddb, use an indexeddb crypto store.\nif (indexedDB) {\n    matrixcs.setCryptoStoreFactory(() => new matrixcs.IndexedDBCryptoStore(indexedDB!, \"matrix-js-sdk:crypto\"));\n}\n\nexport * from \"./matrix\";\nglobalThis.matrixcs = matrixcs;\n"],"mappings":";;;;;AAgBA,IAAAA,QAAA,GAAAC,uBAAA,CAAAC,OAAA;AA0BAC,MAAA,CAAAC,IAAA,CAAAJ,QAAA,EAAAK,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAN,QAAA,CAAAM,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAV,QAAA,CAAAM,GAAA;IAAA;EAAA;AAAA;AAAyB,SAAAK,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAX,wBAAAe,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAT,GAAA,CAAAM,GAAA,SAAAK,MAAA,WAAAC,qBAAA,GAAAnB,MAAA,CAAAK,cAAA,IAAAL,MAAA,CAAAoB,wBAAA,WAAAjB,GAAA,IAAAU,GAAA,QAAAV,GAAA,kBAAAH,MAAA,CAAAqB,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAV,GAAA,EAAAV,GAAA,SAAAqB,IAAA,GAAAL,qBAAA,GAAAnB,MAAA,CAAAoB,wBAAA,CAAAP,GAAA,EAAAV,GAAA,cAAAqB,IAAA,KAAAA,IAAA,CAAAjB,GAAA,IAAAiB,IAAA,CAAAC,GAAA,KAAAzB,MAAA,CAAAK,cAAA,CAAAa,MAAA,EAAAf,GAAA,EAAAqB,IAAA,YAAAN,MAAA,CAAAf,GAAA,IAAAU,GAAA,CAAAV,GAAA,SAAAe,MAAA,CAAAH,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAS,GAAA,CAAAZ,GAAA,EAAAK,MAAA,YAAAA,MAAA;AA1CzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,IAAIQ,UAAU,CAACC,mBAAmB,EAAE;EAChC,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACnE;AACAF,UAAU,CAACC,mBAAmB,GAAG,IAAI;;AAErC;AACA,IAAIE,SAAiC;AACrC,IAAI;EACAA,SAAS,GAAGH,UAAU,CAACG,SAAS;AACpC,CAAC,CAAC,OAAOC,CAAC,EAAE,CAAC;;AAEb;AACA,IAAID,SAAS,EAAE;EACXhC,QAAQ,CAACkC,qBAAqB,CAAC,MAAM,IAAIlC,QAAQ,CAACmC,oBAAoB,CAACH,SAAS,EAAG,sBAAsB,CAAC,CAAC;AAC/G;AAGAH,UAAU,CAAC7B,QAAQ,GAAGA,QAAQ"}

package/lib/client.d.ts

@@ -18,8 +18,8 @@ import { IOlmDevice } from "./crypto/algorithms/megolm";
 import { TypedReEmitter } from "./ReEmitter";
 import { IRoomEncryption, RoomList } from "./crypto/RoomList";
 import { SERVICE_TYPES } from "./service-types";
-import { HttpApiEvent, HttpApiEventHandlerMap, Upload, UploadOpts, MatrixError, MatrixHttpApi, IHttpOpts, FileType, UploadResponse, IRequestOpts } from "./http-api";
-import { Crypto, CryptoEvent, CryptoEventHandlerMap, ICryptoCallbacks, ICheckOwnCrossSigningTrustOpts, VerificationMethod } from "./crypto";
+import { FileType, HttpApiEvent, HttpApiEventHandlerMap, IHttpOpts, IRequestOpts, MatrixError, MatrixHttpApi, Upload, UploadOpts, UploadResponse } from "./http-api";
+import { Crypto, CryptoEvent, CryptoEventHandlerMap, ICheckOwnCrossSigningTrustOpts, ICryptoCallbacks, VerificationMethod } from "./crypto";
 import { DeviceInfo } from "./crypto/deviceinfo";
 import { User, UserEvent, UserEventHandlerMap } from "./models/user";
 import { IDehydratedDevice, IDehydratedDeviceKeyInfo } from "./crypto/dehydration";
@@ -37,7 +37,7 @@ import { CrossSigningInfo, DeviceTrustLevel, ICacheCallbacks, UserTrustLevel } f
 import { Room, RoomEvent, RoomEventHandlerMap, RoomNameState } from "./models/room";
 import { RoomMemberEvent, RoomMemberEventHandlerMap } from "./models/room-member";
 import { RoomStateEvent, RoomStateEventHandlerMap } from "./models/room-state";
-import { IAddThreePidOnlyBody, IBindThreePidBody, ICreateRoomOpts, IEventSearchOpts, IGuestAccessOpts, IJoinRoomOpts, IPaginateOpts, IPresenceOpts, IRedactOpts, IRelationsRequestOpts, IRelationsResponse, IRoomDirectoryOptions, ISearchOpts, ISendEventResponse, ITagsResponse, IStatusResponse, KnockRoomOpts } from "./@types/requests";
+import { IAddThreePidOnlyBody, IBindThreePidBody, ICreateRoomOpts, IEventSearchOpts, IGuestAccessOpts, IJoinRoomOpts, IPaginateOpts, IPresenceOpts, IRedactOpts, IRelationsRequestOpts, IRelationsResponse, IRoomDirectoryOptions, ISearchOpts, ISendEventResponse, IStatusResponse, ITagsResponse, KnockRoomOpts } from "./@types/requests";
 import { EventType, RelationType, RoomType } from "./@types/event";
 import { IdServerUnbindResult, IImageInfo, JoinRule, Preset, Visibility } from "./@types/partials";
 import { EventMapper, MapperOpts } from "./event-mapper";
@@ -52,16 +52,16 @@ import { IHierarchyRoom } from "./@types/spaces";
 import { IPusher, IPusherRequest, IPushRule, IPushRules, PushRuleAction, PushRuleKind, RuleId } from "./@types/PushRules";
 import { IThreepid } from "./@types/threepids";
 import { CryptoStore, OutgoingRoomKeyRequest } from "./crypto/store/base";
-import { GroupCall, IGroupCallDataChannelOptions, GroupCallIntent, GroupCallType } from "./webrtc/groupCall";
+import { GroupCall, GroupCallIntent, GroupCallType, IGroupCallDataChannelOptions } from "./webrtc/groupCall";
 import { MediaHandler } from "./webrtc/mediaHandler";
-import { LoginTokenPostResponse, ILoginFlowsResponse, IRefreshTokenResponse, SSOAction, LoginResponse, LoginRequest } from "./@types/auth";
+import { ILoginFlowsResponse, IRefreshTokenResponse, LoginRequest, LoginResponse, LoginTokenPostResponse, SSOAction } from "./@types/auth";
 import { TypedEventEmitter } from "./models/typed-event-emitter";
 import { ReceiptType } from "./@types/read_receipts";
 import { MSC3575SlidingSyncRequest, MSC3575SlidingSyncResponse, SlidingSync } from "./sliding-sync";
 import { SlidingSyncSdk } from "./sliding-sync-sdk";
 import { FeatureSupport, ThreadFilterType } from "./models/thread";
 import { MBeaconInfoEventContent } from "./@types/beacon";
-import { UnstableValue } from "./NamespacedValue";
+import { NamespacedValue, UnstableValue } from "./NamespacedValue";
 import { ToDeviceBatch } from "./models/ToDeviceMessage";
 import { IgnoredInvites } from "./models/invites-ignorer";
 import { UIAResponse } from "./@types/uia";
@@ -166,7 +166,14 @@ export interface ICreateClientOpts {
      */
     deviceToImport?: IExportedDevice;
     /**
-     * Key used to pickle olm objects or other sensitive data.
+     * Encryption key used for encrypting sensitive data (such as e2ee keys) in storage.
+     *
+     * This must be set to the same value every time the client is initialised for the same device.
+     *
+     * If unset, either a hardcoded key or no encryption at all is used, depending on the Crypto implementation.
+     *
+     * No particular requirement is placed on the key data (it is fed into an HKDF to generate the actual encryption
+     * keys).
      */
     pickleKey?: string;
     /**
@@ -306,9 +313,17 @@ export interface IChangePasswordCapability extends ICapability {
 }
 export interface IThreadsCapability extends ICapability {
 }
-export interface IMSC3882GetLoginTokenCapability extends ICapability {
+export interface IGetLoginTokenCapability extends ICapability {
 }
-export declare const UNSTABLE_MSC3882_CAPABILITY: UnstableValue<"m.get_login_token", "org.matrix.msc3882.get_login_token">;
+/**
+ * @deprecated use {@link IGetLoginTokenCapability} instead
+ */
+export type IMSC3882GetLoginTokenCapability = IGetLoginTokenCapability;
+export declare const GET_LOGIN_TOKEN_CAPABILITY: NamespacedValue<"m.get_login_token", "org.matrix.msc3882.get_login_token">;
+/**
+ * @deprecated use {@link GET_LOGIN_TOKEN_CAPABILITY} instead
+ */
+export declare const UNSTABLE_MSC3882_CAPABILITY: NamespacedValue<"m.get_login_token", "org.matrix.msc3882.get_login_token">;
 export declare const UNSTABLE_MSC2666_SHARED_ROOMS = "uk.half-shot.msc2666";
 export declare const UNSTABLE_MSC2666_MUTUAL_ROOMS = "uk.half-shot.msc2666.mutual_rooms";
 export declare const UNSTABLE_MSC2666_QUERY_MUTUAL_ROOMS = "uk.half-shot.msc2666.query_mutual_rooms";
@@ -321,8 +336,8 @@ export interface Capabilities {
     "m.change_password"?: IChangePasswordCapability;
     "m.room_versions"?: IRoomVersionsCapability;
     "io.element.thread"?: IThreadsCapability;
-    [UNSTABLE_MSC3882_CAPABILITY.name]?: IMSC3882GetLoginTokenCapability;
-    [UNSTABLE_MSC3882_CAPABILITY.altName]?: IMSC3882GetLoginTokenCapability;
+    "m.get_login_token"?: IGetLoginTokenCapability;
+    "org.matrix.msc3882.get_login_token"?: IGetLoginTokenCapability;
 }
 /** @deprecated prefer {@link CrossSigningKeyInfo}. */
 export type ICrossSigningKey = CrossSigningKeyInfo;
@@ -831,6 +846,15 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
     credentials: {
         userId: string | null;
     };
+    /**
+     * Encryption key used for encrypting sensitive data (such as e2ee keys) in storage.
+     *
+     * As supplied in the constructor via {@link IMatrixClientCreateOpts#pickleKey}.
+     *
+     * If unset, either a hardcoded key or no encryption at all is used, depending on the Crypto implementation.
+     *
+     * @deprecated this should be a private property.
+     */
     pickleKey?: string;
     scheduler?: MatrixScheduler;
     clientRunning: boolean;
@@ -1796,10 +1820,14 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      */
     checkKeyBackup(): Promise<IKeyBackupCheck | null>;
     /**
-     * Get information about the current key backup.
-     * @returns Information object from API or null
+     * Get information about the current key backup from the server.
      *
-     * @deprecated Prefer {@link CryptoApi.checkKeyBackupAndEnable}.
+     * Performs some basic validity checks on the shape of the result, and raises an error if it is not as expected.
+     *
+     * **Note**: there is no (supported) way to distinguish between "failure to talk to the server" and "another client
+     * uploaded a key backup version using an algorithm I don't understand.
+     *
+     * @returns Information object from API, or null if no backup is present on the server.
      */
     getKeyBackupVersion(): Promise<IKeyBackupInfo | null>;
     /**
@@ -3107,7 +3135,9 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * Make a request for an `m.login.token` to be issued as per
      * [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882).
      * The server may require User-Interactive auth.
-     * Note that this is UNSTABLE and subject to breaking changes without notice.
+     *
+     * Compatibility with unstable implementations of MSC3882 is deprecated and will be removed in a future release.
+     *
      * @param auth - Optional. Auth data to supply for User-Interactive auth.
      * @returns Promise which resolves: On success, the token response
      * or UIA auth data.