@element-hq/element-web-playwright-common 1.4.6 → 2.0.0

package/lib/fixtures/user.d.ts

@@ -1,5 +1,7 @@
 import { type Page } from "@playwright/test";
 import { Credentials } from "../utils/api.js";
+/** Adds an initScript to the given page which will populate localStorage appropriately so that Element will use the given credentials. */
+export declare function populateLocalStorageWithCredentials(page: Page, credentials: Credentials): Promise<void>;
 export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("./services.js").TestFixtures & {
     /**
      * The displayname to use for the user registered in {@link #credentials}.
@@ -23,7 +25,7 @@ export declare const test: import("playwright/test").TestType<import("playwright
     pageWithCredentials: Page;
     /**
      * A (rather poorly-named) test fixture which registers a user per {@link #credentials}, stores
-     * the credentials into localStorage per {@link #homeserver}, and then loads the front page of the
+     * the credentials into localStorage per {@link #pageWithCredentials}, and then loads the front page of the
      * app.
      */
     user: Credentials;

package/lib/fixtures/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/fixtures/user.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,IAAI;IACb;;;;;OAKG;kBACW,MAAM;IAEpB;;;OAGG;iBACU,WAAW;IAExB;;;;;;OAMG;yBACkB,IAAI;IAEzB;;;;OAIG;UACG,WAAW;iLAiDnB,CAAC"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/fixtures/user.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,0IAA0I;AAC1I,wBAAsB,mCAAmC,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,iBAuB7F;AAED,eAAO,MAAM,IAAI;IACb;;;;;OAKG;kBACW,MAAM;IAEpB;;;OAGG;iBACU,WAAW;IAExB;;;;;;OAMG;yBACkB,IAAI;IAEzB;;;;OAIG;UACG,WAAW;iLA2BnB,CAAC"}

package/lib/fixtures/user.js

@@ -7,6 +7,24 @@ Please see LICENSE files in the repository root for full details.
 */
 import { sample, uniqueId } from "lodash-es";
 import { test as base } from "./services.js";
+/** Adds an initScript to the given page which will populate localStorage appropriately so that Element will use the given credentials. */
+export async function populateLocalStorageWithCredentials(page, credentials) {
+    await page.addInitScript(({ credentials }) => {
+        window.localStorage.setItem("mx_hs_url", credentials.homeserverBaseUrl);
+        window.localStorage.setItem("mx_user_id", credentials.userId);
+        window.localStorage.setItem("mx_access_token", credentials.accessToken);
+        window.localStorage.setItem("mx_device_id", credentials.deviceId);
+        window.localStorage.setItem("mx_is_guest", "false");
+        window.localStorage.setItem("mx_has_pickle_key", "false");
+        window.localStorage.setItem("mx_has_access_token", "true");
+        window.localStorage.setItem("mx_local_settings", JSON.stringify({
+            // Retain any other settings which may have already been set
+            ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
+            // Ensure the language is set to a consistent value
+            language: "en",
+        }));
+    }, { credentials });
+}
 export const test = base.extend({
     displayName: undefined,
     credentials: async ({ homeserver, displayName: testDisplayName }, use, testInfo) => {
@@ -20,23 +38,8 @@ export const test = base.extend({
             displayName,
         });
     },
-    pageWithCredentials: async ({ page, homeserver, credentials }, use) => {
-        await page.addInitScript(({ baseUrl, credentials }) => {
-            // Seed the localStorage with the required credentials
-            window.localStorage.setItem("mx_hs_url", baseUrl);
-            window.localStorage.setItem("mx_user_id", credentials.userId);
-            window.localStorage.setItem("mx_access_token", credentials.accessToken);
-            window.localStorage.setItem("mx_device_id", credentials.deviceId);
-            window.localStorage.setItem("mx_is_guest", "false");
-            window.localStorage.setItem("mx_has_pickle_key", "false");
-            window.localStorage.setItem("mx_has_access_token", "true");
-            window.localStorage.setItem("mx_local_settings", JSON.stringify({
-                // Retain any other settings which may have already been set
-                ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
-                // Ensure the language is set to a consistent value
-                language: "en",
-            }));
-        }, { baseUrl: homeserver.baseUrl, credentials });
+    pageWithCredentials: async ({ page, credentials }, use) => {
+        await populateLocalStorageWithCredentials(page, credentials);
         await use(page);
     },
     user: async ({ pageWithCredentials: page, credentials }, use) => {

package/lib/index.d.ts

@@ -1,4 +1,7 @@
 import { type Config as BaseConfig } from "@element-hq/element-web-module-api";
+export * from "./utils/config_json.js";
+export * from "./utils/context.js";
+export { populateLocalStorageWithCredentials } from "./fixtures/user.js";
 export interface Config extends BaseConfig {
     default_server_config: {
         "m.homeserver"?: {

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,MAAM,IAAI,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAU/E,MAAM,WAAW,MAAO,SAAQ,UAAU;IACtC,qBAAqB,EAAE;QACnB,cAAc,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QACF,mBAAmB,CAAC,EAAE;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;KACL,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,MAAM,CAevC,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,IAAI;;;;;;;kNAkCf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,MAAM,IAAI,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAK/E,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,mCAAmC,EAAE,MAAM,oBAAoB,CAAC;AAQzE,MAAM,WAAW,MAAO,SAAQ,UAAU;IACtC,qBAAqB,EAAE;QACnB,cAAc,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QACF,mBAAmB,CAAC,EAAE;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;KACL,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,MAAM,CAevC,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,IAAI;;;;;;;kNASf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/index.js

@@ -6,6 +6,10 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
 Please see LICENSE files in the repository root for full details.
 */
 import { test as base } from "./fixtures/index.js";
+import { routeConfigJson } from "./utils/config_json.js";
+export * from "./utils/config_json.js";
+export * from "./utils/context.js";
+export { populateLocalStorageWithCredentials } from "./fixtures/user.js";
 // Enable experimental service worker support
 // See https://playwright.dev/docs/service-workers-experimental#how-to-enable
 process.env["PW_EXPERIMENTAL_SERVICE_WORKER_NETWORK_EVENTS"] = "1";
@@ -29,32 +33,7 @@ export const test = base.extend({
     labsFlags: async ({}, use) => use([]),
     disablePresence: async ({}, use) => use(false),
     page: async ({ homeserver, context, page, config, labsFlags, disablePresence }, use) => {
-        await context.route(`http://localhost:8080/config.json*`, async (route) => {
-            const json = {
-                ...CONFIG_JSON,
-                ...config,
-                default_server_config: {
-                    "m.homeserver": {
-                        base_url: homeserver.baseUrl,
-                    },
-                    ...config.default_server_config,
-                },
-            };
-            json["features"] = {
-                ...json["features"],
-                // Enable the lab features
-                ...labsFlags.reduce((obj, flag) => {
-                    obj[flag] = true;
-                    return obj;
-                }, {}),
-            };
-            if (disablePresence) {
-                json["enable_presence_by_hs_url"] = {
-                    [homeserver.baseUrl]: false,
-                };
-            }
-            await route.fulfill({ json });
-        });
+        await routeConfigJson(context, homeserver.baseUrl, config, labsFlags, disablePresence);
         await use(page);
     },
 });

package/lib/testcontainers/mas.d.ts

@@ -41,11 +41,12 @@ export declare class StartedMatrixAuthenticationServiceContainer extends Abstrac
     private registerUserInternal;
     /**
      * Registers a user
+     *
      * @param username - the username of the user to register
      * @param password - the password of the user to register
      * @param displayName - optional display name to set on the newly registered user
      */
-    registerUser(username: string, password: string, displayName?: string): Promise<Credentials>;
+    registerUser(username: string, password: string, displayName?: string): Promise<Omit<Credentials, "homeserverBaseUrl">>;
     /**
      * Binds a 3pid
      * @param username - the username of the user to bind the 3pid to

package/lib/testcontainers/mas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mas.d.ts","sourceRoot":"","sources":["../../src/testcontainers/mas.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wBAAwB,EACxB,gBAAgB,EAChB,KAAK,oBAAoB,EAEzB,KAAK,UAAU,EAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAK7E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKnD,OAAO,KAAK,EAAE,UAAU,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC;AAmH1B;;;;;GAKG;AACH,qBAAa,oCAAqC,SAAQ,gBAAgB;IACtE,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiC;gBAGlD,EAAE,EAAE,0BAA0B,EAC9B,KAAK,GAAE,MAAkE;IAe7E;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAQnD;;OAEG;IACmB,KAAK,IAAI,OAAO,CAAC,2CAA2C,CAAC;CA0BtF;AAED;;GAEG;AACH,qBAAa,2CAA4C,SAAQ,wBAAwB;aAKjE,OAAO,EAAE,MAAM;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI;IALzB,OAAO,CAAC,iBAAiB,CAAC,CAAkB;gBAGxC,SAAS,EAAE,oBAAoB,EACf,OAAO,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EAAE;IAKnC;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAYhC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;YAQ1D,kBAAkB;YAgClB,6BAA6B;YAmB7B,oBAAoB;IAoBlC;;;;;OAKG;IACU,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzG;;;;;OAKG;IACU,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO7F"}
+{"version":3,"file":"mas.d.ts","sourceRoot":"","sources":["../../src/testcontainers/mas.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wBAAwB,EACxB,gBAAgB,EAChB,KAAK,oBAAoB,EAEzB,KAAK,UAAU,EAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAK7E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKnD,OAAO,KAAK,EAAE,UAAU,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC;AAmH1B;;;;;GAKG;AACH,qBAAa,oCAAqC,SAAQ,gBAAgB;IACtE,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiC;gBAGlD,EAAE,EAAE,0BAA0B,EAC9B,KAAK,GAAE,MAAkE;IAe7E;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAQnD;;OAEG;IACmB,KAAK,IAAI,OAAO,CAAC,2CAA2C,CAAC;CA0BtF;AAED;;GAEG;AACH,qBAAa,2CAA4C,SAAQ,wBAAwB;aAKjE,OAAO,EAAE,MAAM;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI;IALzB,OAAO,CAAC,iBAAiB,CAAC,CAAkB;gBAGxC,SAAS,EAAE,oBAAoB,EACf,OAAO,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EAAE;IAKnC;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAYhC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;YAQ1D,kBAAkB;YAgClB,6BAA6B;YAmB7B,oBAAoB;IAoBlC;;;;;;OAMG;IACU,YAAY,CACrB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAIlD;;;;;OAKG;IACU,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO7F"}

package/lib/testcontainers/mas.js

@@ -244,6 +244,7 @@ export class StartedMatrixAuthenticationServiceContainer extends AbstractStarted
     }
     /**
      * Registers a user
+     *
      * @param username - the username of the user to register
      * @param password - the password of the user to register
      * @param displayName - optional display name to set on the newly registered user

package/lib/testcontainers/synapse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"synapse.d.ts","sourceRoot":"","sources":["../../src/testcontainers/synapse.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wBAAwB,EACxB,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAE5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAQzE,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACrG,OAAO,EAAE,KAAK,2CAA2C,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,GAAG,EAAE,eAAe,EAAa,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+GV,SAAS,GACT;QACI,aAAa,EAAE,OAAO,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,0BAA0B,EAAE,KAAK,CAAC;QAClC,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,OAAO,CAAC;QAC7B,eAAe,EAAE,MAAM,CAAC;KAC3B;kBAED,SAAS,GACT;QACI,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/C,4BAA4B,EAAE,OAAO,CAAC;QACtC,kBAAkB,EAAE,MAAM,CAAC;QAC3B,uBAAuB,EAAE,OAAO,CAAC;KACpC;oBAED,SAAS,GACT;QACI,qBAAqB,EAAE,MAAM,CAAC;QAC9B,wBAAwB,EAAE,MAAM,CAAC;QACjC,sBAAsB,EAAE,MAAM,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;KACrB;;;;;;;;;;;;aAUQ,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;CAC7E,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,cAAc,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,mBAAmB,CAAC,aAAa,CAAC;IAChG,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,GAAG,CAAC,EAAE,2CAA2C,CAAC;gBAEzC,KAAK,SAAuC;IA6CxD,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAKlD,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAQhD,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI;IAkBtD,+BAA+B,CAAC,GAAG,CAAC,EAAE,2CAA2C,GAAG,IAAI;IAKzE,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC;CA+BlE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,wBAAyB,YAAW,0BAA0B;aAOnF,OAAO,EAAE,MAAM;IAC/B,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IAP7C,SAAS,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;IACjC,SAAgB,KAAK,EAAE,eAAe,CAAC;gBAGnC,SAAS,EAAE,oBAAoB,EACf,OAAO,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM;IAOrD;;;;OAIG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAKtC,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAK9C,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;YAapC,oBAAoB;cAqClB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;YAYlC,YAAY;IAO1B;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInG;;;;OAIG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9E;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAU3F;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,uBAAuB;IAKnE,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAHpB,SAAS,EAAE,oBAAoB,EAC/B,OAAO,EAAE,MAAM,EACf,wBAAwB,EAAE,MAAM,EACf,GAAG,EAAE,2CAA2C;cAKrD,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAOhD;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInG;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG3F"}
+{"version":3,"file":"synapse.d.ts","sourceRoot":"","sources":["../../src/testcontainers/synapse.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wBAAwB,EACxB,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAE5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAQzE,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACrG,OAAO,EAAE,KAAK,2CAA2C,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,GAAG,EAAE,eAAe,EAAa,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+GV,SAAS,GACT;QACI,aAAa,EAAE,OAAO,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,0BAA0B,EAAE,KAAK,CAAC;QAClC,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,OAAO,CAAC;QAC7B,eAAe,EAAE,MAAM,CAAC;KAC3B;kBAED,SAAS,GACT;QACI,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/C,4BAA4B,EAAE,OAAO,CAAC;QACtC,kBAAkB,EAAE,MAAM,CAAC;QAC3B,uBAAuB,EAAE,OAAO,CAAC;KACpC;oBAED,SAAS,GACT;QACI,qBAAqB,EAAE,MAAM,CAAC;QAC9B,wBAAwB,EAAE,MAAM,CAAC;QACjC,sBAAsB,EAAE,MAAM,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;KACrB;;;;;;;;;;;;aAUQ,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;CAC7E,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,cAAc,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,mBAAmB,CAAC,aAAa,CAAC;IAChG,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,GAAG,CAAC,EAAE,2CAA2C,CAAC;gBAEzC,KAAK,SAAuC;IA6CxD,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAKlD,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAQhD,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI;IAkBtD,+BAA+B,CAAC,GAAG,CAAC,EAAE,2CAA2C,GAAG,IAAI;IAKzE,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC;CA+BlE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,wBAAyB,YAAW,0BAA0B;aAOnF,OAAO,EAAE,MAAM;IAC/B,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IAP7C,SAAS,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;IACjC,SAAgB,KAAK,EAAE,eAAe,CAAC;gBAGnC,SAAS,EAAE,oBAAoB,EACf,OAAO,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM;IAOrD;;;;OAIG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAKtC,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAK9C,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;YAapC,oBAAoB;cAsClB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;YAYlC,YAAY;IAO1B;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInG;;;;OAIG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAO9E;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAU3F;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,uBAAuB;IAKnE,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAHpB,SAAS,EAAE,oBAAoB,EAC/B,OAAO,EAAE,MAAM,EACf,wBAAwB,EAAE,MAAM,EACf,GAAG,EAAE,2CAA2C;cAKrD,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAOhD;;;;;OAKG;IACU,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKzG;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG3F"}

package/lib/testcontainers/synapse.js

@@ -299,6 +299,7 @@ export class StartedSynapseContainer extends AbstractStartedContainer {
         });
         return {
             homeServer: data.home_server || data.user_id.split(":").slice(1).join(":"),
+            homeserverBaseUrl: this.baseUrl,
             accessToken: data.access_token,
             userId: data.user_id,
             deviceId: data.device_id,
@@ -332,7 +333,10 @@ export class StartedSynapseContainer extends AbstractStartedContainer {
      * @param password - login password
      */
     async loginUser(userId, password) {
-        return this.csApi.loginUser(userId, password);
+        return {
+            ...(await this.csApi.loginUser(userId, password)),
+            homeserverBaseUrl: this.baseUrl,
+        };
     }
     /**
      * Binds a 3pid
@@ -372,8 +376,9 @@ export class StartedSynapseWithMasContainer extends StartedSynapseContainer {
      * @param password - the password of the user to register
      * @param displayName - optional display name to set on the newly registered user
      */
-    registerUser(username, password, displayName) {
-        return this.mas.registerUser(username, password, displayName);
+    async registerUser(username, password, displayName) {
+        const registered = await this.mas.registerUser(username, password, displayName);
+        return { ...registered, homeserverBaseUrl: this.baseUrl };
     }
     /**
      * Binds a 3pid

package/lib/utils/api.d.ts

@@ -26,9 +26,12 @@ export declare class Api {
  * Credentials for a user.
  */
 export interface Credentials {
+    /** The base URL of the homeserver's CS API. */
+    homeserverBaseUrl: string;
     accessToken: string;
     userId: string;
     deviceId: string;
+    /** The domain part of the user's matrix ID. */
     homeServer: string;
     password: string | null;
     displayName?: string;
@@ -44,6 +47,6 @@ export declare class ClientServerApi extends Api {
      * @param userId - The user ID to register.
      * @param password - The password to use for the user.
      */
-    loginUser(userId: string, password: string): Promise<Credentials>;
+    loginUser(userId: string, password: string): Promise<Omit<Credentials, "homeserverBaseUrl">>;
 }
 //# sourceMappingURL=api.d.ts.map

package/lib/utils/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/utils/api.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAErD;;GAEG;AACH,qBAAa,GAAG;IAGO,OAAO,CAAC,QAAQ,CAAC,OAAO;IAF3C,OAAO,CAAC,QAAQ,CAAC,CAAoB;gBAED,OAAO,EAAE,MAAM;IAEnD;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAInD;;;;;;OAMG;IACU,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC;IAC9F,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;CAyB9G;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,GAAG;gBACjB,OAAO,EAAE,MAAM;IAIlC;;;;OAIG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAwBjF"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/utils/api.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAErD;;GAEG;AACH,qBAAa,GAAG;IAGO,OAAO,CAAC,QAAQ,CAAC,OAAO;IAF3C,OAAO,CAAC,QAAQ,CAAC,CAAoB;gBAED,OAAO,EAAE,MAAM;IAEnD;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAInD;;;;;;OAMG;IACU,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC;IAC9F,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;CAyB9G;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,+CAA+C;IAC/C,iBAAiB,EAAE,MAAM,CAAC;IAE1B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IAEjB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,GAAG;gBACjB,OAAO,EAAE,MAAM;IAIlC;;;;OAIG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;CAwB5G"}

package/lib/utils/config_json.d.ts

@@ -0,0 +1,21 @@
+import { BrowserContext, Page } from "@playwright/test";
+import { Config } from "../index.js";
+/** Construct a suitable config.json for the given homeserver
+ *
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export declare function buildConfigJson(homeserverBaseUrl: string, additionalConfig?: Partial<Config>, labsFlags?: string[], disablePresence?: boolean): Partial<Config>;
+/**
+ * Add a route to the browser context/page which will serve a suitable config.json for the given homeserver.
+ *
+ * @param context - The browser context or page to route the config.json to.
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export declare function routeConfigJson(context: BrowserContext | Page, homeserverBaseUrl: string, additionalConfig?: Partial<Config>, labsFlags?: string[], disablePresence?: boolean): Promise<void>;
+//# sourceMappingURL=config_json.d.ts.map

package/lib/utils/config_json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config_json.d.ts","sourceRoot":"","sources":["../../src/utils/config_json.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,MAAM,EAAe,MAAM,aAAa,CAAC;AAElD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC3B,iBAAiB,EAAE,MAAM,EACzB,gBAAgB,GAAE,OAAO,CAAC,MAAM,CAAM,EACtC,SAAS,GAAE,MAAM,EAAO,EACxB,eAAe,GAAE,OAAe,GACjC,OAAO,CAAC,MAAM,CAAC,CAyBjB;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACjC,OAAO,EAAE,cAAc,GAAG,IAAI,EAC9B,iBAAiB,EAAE,MAAM,EACzB,gBAAgB,GAAE,OAAO,CAAC,MAAM,CAAM,EACtC,SAAS,GAAE,MAAM,EAAO,EACxB,eAAe,GAAE,OAAe,GACjC,OAAO,CAAC,IAAI,CAAC,CAKf"}

package/lib/utils/config_json.js

@@ -0,0 +1,55 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { CONFIG_JSON } from "../index.js";
+/** Construct a suitable config.json for the given homeserver
+ *
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export function buildConfigJson(homeserverBaseUrl, additionalConfig = {}, labsFlags = [], disablePresence = false) {
+    const json = {
+        ...CONFIG_JSON,
+        ...additionalConfig,
+        default_server_config: {
+            "m.homeserver": {
+                base_url: homeserverBaseUrl,
+            },
+            ...additionalConfig.default_server_config,
+        },
+    };
+    json["features"] = {
+        ...json["features"],
+        // Enable the lab features
+        ...labsFlags.reduce((obj, flag) => {
+            obj[flag] = true;
+            return obj;
+        }, {}),
+    };
+    if (disablePresence) {
+        json["enable_presence_by_hs_url"] = {
+            [homeserverBaseUrl]: false,
+        };
+    }
+    return json;
+}
+/**
+ * Add a route to the browser context/page which will serve a suitable config.json for the given homeserver.
+ *
+ * @param context - The browser context or page to route the config.json to.
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export async function routeConfigJson(context, homeserverBaseUrl, additionalConfig = {}, labsFlags = [], disablePresence = false) {
+    await context.route(`http://localhost:8080/config.json*`, async (route) => {
+        const json = buildConfigJson(homeserverBaseUrl, additionalConfig, labsFlags, disablePresence);
+        await route.fulfill({ json });
+    });
+}

package/lib/utils/context.d.ts

@@ -0,0 +1,14 @@
+import { Browser } from "playwright-core";
+import { Page } from "@playwright/test";
+import { Credentials } from "./api.js";
+import { Config } from "../index.js";
+/** Create a new instance of the application, in a separate browser context, using the given credentials.
+ *
+ * @param browser - the browser to use
+ * @param credentials - the credentials to use for the new instance
+ * @param additionalConfig - additional config for the `config.json` for the new instance
+ * @param labsFlags - additional labs flags for the `config.json` for the new instance
+ * @param disablePresence - whether to disable presence for the new instance
+ */
+export declare function createNewInstance(browser: Browser, credentials: Credentials, additionalConfig?: Partial<Config>, labsFlags?: string[], disablePresence?: boolean): Promise<Page>;
+//# sourceMappingURL=context.d.ts.map

package/lib/utils/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/utils/context.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACnC,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,WAAW,EACxB,gBAAgB,GAAE,OAAO,CAAC,MAAM,CAAM,EACtC,SAAS,GAAE,MAAM,EAAO,EACxB,eAAe,GAAE,OAAe,GACjC,OAAO,CAAC,IAAI,CAAC,CAQf"}

package/lib/utils/context.js

@@ -0,0 +1,25 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { routeConfigJson } from "./config_json.js";
+import { populateLocalStorageWithCredentials } from "../fixtures/user.js";
+/** Create a new instance of the application, in a separate browser context, using the given credentials.
+ *
+ * @param browser - the browser to use
+ * @param credentials - the credentials to use for the new instance
+ * @param additionalConfig - additional config for the `config.json` for the new instance
+ * @param labsFlags - additional labs flags for the `config.json` for the new instance
+ * @param disablePresence - whether to disable presence for the new instance
+ */
+export async function createNewInstance(browser, credentials, additionalConfig = {}, labsFlags = [], disablePresence = false) {
+    const context = await browser.newContext();
+    await routeConfigJson(context, credentials.homeserverBaseUrl, additionalConfig, labsFlags, disablePresence);
+    const page = await context.newPage();
+    await populateLocalStorageWithCredentials(page, credentials);
+    await page.goto("/");
+    await page.waitForSelector(".mx_MatrixChat", { timeout: 30000 });
+    return page;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@element-hq/element-web-playwright-common",
     "type": "module",
-    "version": "1.4.6",
+    "version": "2.0.0",
     "license": "SEE LICENSE IN README.md",
     "repository": {
         "type": "git",

package/src/fixtures/user.ts

@@ -12,6 +12,32 @@ import { sample, uniqueId } from "lodash-es";
 import { test as base } from "./services.js";
 import { Credentials } from "../utils/api.js";
 
+/** Adds an initScript to the given page which will populate localStorage appropriately so that Element will use the given credentials. */
+export async function populateLocalStorageWithCredentials(page: Page, credentials: Credentials) {
+    await page.addInitScript(
+        ({ credentials }) => {
+            window.localStorage.setItem("mx_hs_url", credentials.homeserverBaseUrl);
+            window.localStorage.setItem("mx_user_id", credentials.userId);
+            window.localStorage.setItem("mx_access_token", credentials.accessToken);
+            window.localStorage.setItem("mx_device_id", credentials.deviceId);
+            window.localStorage.setItem("mx_is_guest", "false");
+            window.localStorage.setItem("mx_has_pickle_key", "false");
+            window.localStorage.setItem("mx_has_access_token", "true");
+
+            window.localStorage.setItem(
+                "mx_local_settings",
+                JSON.stringify({
+                    // Retain any other settings which may have already been set
+                    ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
+                    // Ensure the language is set to a consistent value
+                    language: "en",
+                }),
+            );
+        },
+        { credentials },
+    );
+}
+
 export const test = base.extend<{
     /**
      * The displayname to use for the user registered in {@link #credentials}.
@@ -38,7 +64,7 @@ export const test = base.extend<{
 
     /**
      * A (rather poorly-named) test fixture which registers a user per {@link #credentials}, stores
-     * the credentials into localStorage per {@link #homeserver}, and then loads the front page of the
+     * the credentials into localStorage per {@link #pageWithCredentials}, and then loads the front page of the
      * app.
      */
     user: Credentials;
@@ -58,30 +84,8 @@ export const test = base.extend<{
         });
     },
 
-    pageWithCredentials: async ({ page, homeserver, credentials }, use) => {
-        await page.addInitScript(
-            ({ baseUrl, credentials }) => {
-                // Seed the localStorage with the required credentials
-                window.localStorage.setItem("mx_hs_url", baseUrl);
-                window.localStorage.setItem("mx_user_id", credentials.userId);
-                window.localStorage.setItem("mx_access_token", credentials.accessToken);
-                window.localStorage.setItem("mx_device_id", credentials.deviceId);
-                window.localStorage.setItem("mx_is_guest", "false");
-                window.localStorage.setItem("mx_has_pickle_key", "false");
-                window.localStorage.setItem("mx_has_access_token", "true");
-
-                window.localStorage.setItem(
-                    "mx_local_settings",
-                    JSON.stringify({
-                        // Retain any other settings which may have already been set
-                        ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
-                        // Ensure the language is set to a consistent value
-                        language: "en",
-                    }),
-                );
-            },
-            { baseUrl: homeserver.baseUrl, credentials },
-        );
+    pageWithCredentials: async ({ page, credentials }, use) => {
+        await populateLocalStorageWithCredentials(page, credentials);
         await use(page);
     },
 

package/src/index.ts

@@ -9,6 +9,12 @@ Please see LICENSE files in the repository root for full details.
 import { type Config as BaseConfig } from "@element-hq/element-web-module-api";
 
 import { test as base } from "./fixtures/index.js";
+import { routeConfigJson } from "./utils/config_json.js";
+
+export * from "./utils/config_json.js";
+export * from "./utils/context.js";
+
+export { populateLocalStorageWithCredentials } from "./fixtures/user.js";
 
 // Enable experimental service worker support
 // See https://playwright.dev/docs/service-workers-experimental#how-to-enable
@@ -68,32 +74,7 @@ export const test = base.extend<TestFixtures>({
     labsFlags: async ({}, use) => use([]),
     disablePresence: async ({}, use) => use(false),
     page: async ({ homeserver, context, page, config, labsFlags, disablePresence }, use) => {
-        await context.route(`http://localhost:8080/config.json*`, async (route) => {
-            const json = {
-                ...CONFIG_JSON,
-                ...config,
-                default_server_config: {
-                    "m.homeserver": {
-                        base_url: homeserver.baseUrl,
-                    },
-                    ...config.default_server_config,
-                },
-            };
-            json["features"] = {
-                ...json["features"],
-                // Enable the lab features
-                ...labsFlags.reduce<NonNullable<(typeof CONFIG_JSON)["features"]>>((obj, flag) => {
-                    obj[flag] = true;
-                    return obj;
-                }, {}),
-            };
-            if (disablePresence) {
-                json["enable_presence_by_hs_url"] = {
-                    [homeserver.baseUrl]: false,
-                };
-            }
-            await route.fulfill({ json });
-        });
+        await routeConfigJson(context, homeserver.baseUrl, config, labsFlags, disablePresence);
         await use(page);
     },
 });

package/src/testcontainers/mas.ts

@@ -302,7 +302,7 @@ export class StartedMatrixAuthenticationServiceContainer extends AbstractStarted
         password: string,
         displayName?: string,
         admin = false,
-    ): Promise<Credentials> {
+    ): Promise<Omit<Credentials, "homeserverBaseUrl">> {
         const userId = await this.manageRegisterUser(username, password, displayName, admin);
         const { deviceId, accessToken } = await this.manageIssueCompatibilityToken(username, admin);
 
@@ -319,11 +319,16 @@ export class StartedMatrixAuthenticationServiceContainer extends AbstractStarted
 
     /**
      * Registers a user
+     *
      * @param username - the username of the user to register
      * @param password - the password of the user to register
      * @param displayName - optional display name to set on the newly registered user
      */
-    public async registerUser(username: string, password: string, displayName?: string): Promise<Credentials> {
+    public async registerUser(
+        username: string,
+        password: string,
+        displayName?: string,
+    ): Promise<Omit<Credentials, "homeserverBaseUrl">> {
         return this.registerUserInternal(username, password, displayName, false);
     }
 

package/src/testcontainers/synapse.ts

@@ -389,6 +389,7 @@ export class StartedSynapseContainer extends AbstractStartedContainer implements
 
         return {
             homeServer: data.home_server || data.user_id.split(":").slice(1).join(":"),
+            homeserverBaseUrl: this.baseUrl,
             accessToken: data.access_token,
             userId: data.user_id,
             deviceId: data.device_id,
@@ -433,7 +434,10 @@ export class StartedSynapseContainer extends AbstractStartedContainer implements
      * @param password - login password
      */
     public async loginUser(userId: string, password: string): Promise<Credentials> {
-        return this.csApi.loginUser(userId, password);
+        return {
+            ...(await this.csApi.loginUser(userId, password)),
+            homeserverBaseUrl: this.baseUrl,
+        };
     }
 
     /**
@@ -480,8 +484,9 @@ export class StartedSynapseWithMasContainer extends StartedSynapseContainer {
      * @param password - the password of the user to register
      * @param displayName - optional display name to set on the newly registered user
      */
-    public registerUser(username: string, password: string, displayName?: string): Promise<Credentials> {
-        return this.mas.registerUser(username, password, displayName);
+    public async registerUser(username: string, password: string, displayName?: string): Promise<Credentials> {
+        const registered = await this.mas.registerUser(username, password, displayName);
+        return { ...registered, homeserverBaseUrl: this.baseUrl };
     }
 
     /**

package/src/utils/api.ts

@@ -64,10 +64,16 @@ export class Api {
  * Credentials for a user.
  */
 export interface Credentials {
+    /** The base URL of the homeserver's CS API. */
+    homeserverBaseUrl: string;
+
     accessToken: string;
     userId: string;
     deviceId: string;
+
+    /** The domain part of the user's matrix ID. */
     homeServer: string;
+
     password: string | null; // null for password-less users
     displayName?: string;
     username: string; // the localpart of the userId
@@ -86,7 +92,7 @@ export class ClientServerApi extends Api {
      * @param userId - The user ID to register.
      * @param password - The password to use for the user.
      */
-    public async loginUser(userId: string, password: string): Promise<Credentials> {
+    public async loginUser(userId: string, password: string): Promise<Omit<Credentials, "homeserverBaseUrl">> {
         const json = await this.request<{
             access_token: string;
             user_id: string;

package/src/utils/config_json.ts

@@ -0,0 +1,71 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { BrowserContext, Page } from "@playwright/test";
+
+import { Config, CONFIG_JSON } from "../index.js";
+
+/** Construct a suitable config.json for the given homeserver
+ *
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export function buildConfigJson(
+    homeserverBaseUrl: string,
+    additionalConfig: Partial<Config> = {},
+    labsFlags: string[] = [],
+    disablePresence: boolean = false,
+): Partial<Config> {
+    const json = {
+        ...CONFIG_JSON,
+        ...additionalConfig,
+        default_server_config: {
+            "m.homeserver": {
+                base_url: homeserverBaseUrl,
+            },
+            ...additionalConfig.default_server_config,
+        },
+    };
+    json["features"] = {
+        ...json["features"],
+        // Enable the lab features
+        ...labsFlags.reduce<NonNullable<(typeof CONFIG_JSON)["features"]>>((obj, flag) => {
+            obj[flag] = true;
+            return obj;
+        }, {}),
+    };
+    if (disablePresence) {
+        json["enable_presence_by_hs_url"] = {
+            [homeserverBaseUrl]: false,
+        };
+    }
+    return json;
+}
+
+/**
+ * Add a route to the browser context/page which will serve a suitable config.json for the given homeserver.
+ *
+ * @param context - The browser context or page to route the config.json to.
+ * @param homeserverBaseUrl - The `baseUrl` of the homeserver that the client should be configured to connect to.
+ * @param additionalConfig - Additional config to add to the default config.json.
+ * @param labsFlags - Lab flags to enable in the client.
+ * @param disablePresence - Whether to disable presence for the given homeserver.
+ */
+export async function routeConfigJson(
+    context: BrowserContext | Page,
+    homeserverBaseUrl: string,
+    additionalConfig: Partial<Config> = {},
+    labsFlags: string[] = [],
+    disablePresence: boolean = false,
+): Promise<void> {
+    await context.route(`http://localhost:8080/config.json*`, async (route) => {
+        const json = buildConfigJson(homeserverBaseUrl, additionalConfig, labsFlags, disablePresence);
+        await route.fulfill({ json });
+    });
+}

package/src/utils/context.ts

@@ -0,0 +1,38 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { Browser } from "playwright-core";
+import { Page } from "@playwright/test";
+
+import { Credentials } from "./api.js";
+import { Config } from "../index.js";
+import { routeConfigJson } from "./config_json.js";
+import { populateLocalStorageWithCredentials } from "../fixtures/user.js";
+
+/** Create a new instance of the application, in a separate browser context, using the given credentials.
+ *
+ * @param browser - the browser to use
+ * @param credentials - the credentials to use for the new instance
+ * @param additionalConfig - additional config for the `config.json` for the new instance
+ * @param labsFlags - additional labs flags for the `config.json` for the new instance
+ * @param disablePresence - whether to disable presence for the new instance
+ */
+export async function createNewInstance(
+    browser: Browser,
+    credentials: Credentials,
+    additionalConfig: Partial<Config> = {},
+    labsFlags: string[] = [],
+    disablePresence: boolean = false,
+): Promise<Page> {
+    const context = await browser.newContext();
+    await routeConfigJson(context, credentials.homeserverBaseUrl, additionalConfig, labsFlags, disablePresence);
+    const page = await context.newPage();
+    await populateLocalStorageWithCredentials(page, credentials);
+    await page.goto("/");
+    await page.waitForSelector(".mx_MatrixChat", { timeout: 30000 });
+    return page;
+}