@element-hq/element-web-playwright-common 1.0.0 → 1.1.5

package/lib/expect/screenshot.d.ts

@@ -1,5 +1,4 @@
-import { type ExpectMatcherState, type Locator, type Page, type PageAssertionsToHaveScreenshotOptions } from "@playwright/test";
-import { type MatcherReturnType } from "playwright/types/test";
+import { type ExpectMatcherState, type Locator, type Page, type PageAssertionsToHaveScreenshotOptions, type MatcherReturnType } from "@playwright/test";
 export interface ToMatchScreenshotOptions extends PageAssertionsToHaveScreenshotOptions {
     css?: string;
 }

package/lib/expect/screenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../src/expect/screenshot.ts"],"names":[],"mappings":"AAQA,OAAO,EAIH,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,qCAAqC,EAC7C,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAW/D,MAAM,WAAW,wBAAyB,SAAQ,qCAAqC;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,iBAAiB,EAAE,CACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,IAAI,GAAG,OAAO,EACxB,IAAI,EAAE,GAAG,MAAM,MAAM,EACrB,OAAO,CAAC,EAAE,wBAAwB,KACjC,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,gDAiCjB,CAAC"}
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../src/expect/screenshot.ts"],"names":[],"mappings":"AAQA,OAAO,EAIH,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,qCAAqC,EAC1C,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAW1B,MAAM,WAAW,wBAAyB,SAAQ,qCAAqC;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,iBAAiB,EAAE,CACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,IAAI,GAAG,OAAO,EACxB,IAAI,EAAE,GAAG,MAAM,MAAM,EACrB,OAAO,CAAC,EAAE,wBAAwB,KACjC,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,gDAiCjB,CAAC"}

package/lib/fixtures/user.js

@@ -32,7 +32,7 @@ export const test = base.extend({
             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") || "{}"),
+                ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
                 // Ensure the language is set to a consistent value
                 language: "en",
             }));

package/lib/index.d.ts

@@ -10,6 +10,7 @@ export interface Config extends BaseConfig {
             server_name?: string;
         };
     };
+    enable_presence_by_hs_url?: Record<string, boolean>;
     setting_defaults: Record<string, unknown>;
     map_style_url?: string;
     features: Record<string, boolean>;
@@ -22,6 +23,7 @@ export interface TestFixtures {
      */
     config: Partial<typeof CONFIG_JSON>;
     labsFlags: string[];
+    disablePresence: boolean;
 }
 export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
     axe: import("@axe-core/playwright").AxeBuilder;

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,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;CACvB;AAED,eAAO,MAAM,IAAI;;;;;;;kNA2Bf,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;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"}

package/lib/index.js

@@ -24,9 +24,11 @@ export const CONFIG_JSON = {
     },
 };
 export const test = base.extend({
-    config: {}, // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
-    labsFlags: [],
-    page: async ({ homeserver, context, page, config, labsFlags }, use) => {
+    // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
+    config: async ({}, use) => use({}),
+    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,
@@ -46,6 +48,11 @@ export const test = base.extend({
                     return obj;
                 }, {}),
             };
+            if (disablePresence) {
+                json["enable_presence_by_hs_url"] = {
+                    [homeserver.baseUrl]: false,
+                };
+            }
             await route.fulfill({ json });
         });
         await use(page);

package/lib/testcontainers/synapse.d.ts

@@ -153,7 +153,7 @@ export type SynapseConfig = typeof DEFAULT_CONFIG;
 export declare class SynapseContainer extends GenericContainer implements HomeserverContainer<SynapseConfig> {
     private config;
     private mas?;
-    constructor();
+    constructor(image?: string);
     withConfigField(key: string, value: unknown): this;
     withConfig(config: Partial<SynapseConfig>): this;
     withSmtpServer(mailpit: StartedMailpitContainer): this;

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;AAIvD,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2GV,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;;;;;;;;;;;;CAUV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,cAAc,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,mBAAmB,CAAC,aAAa,CAAC;IAChG,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,GAAG,CAAC,CAA8C;;IA+CnD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2GV,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;;;;;;;;;;;;CAUV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,cAAc,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,mBAAmB,CAAC,aAAa,CAAC;IAChG,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,GAAG,CAAC,CAA8C;gBAEvC,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"}

package/lib/testcontainers/synapse.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 New Vector Ltd.
+Copyright 2024-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.
@@ -12,7 +12,6 @@ import { getFreePort } from "../utils/port.js";
 import { randB64Bytes } from "../utils/rand.js";
 import { deepCopy } from "../utils/object.js";
 import { Api, ClientServerApi } from "../utils/api.js";
-const TAG = "develop@sha256:8d0049e8e0524ad6817cf7737453fe47de1ed3b8d04704f0c2fd6c136414c9d7";
 const DEFAULT_CONFIG = {
     server_name: "localhost",
     public_baseurl: "", // set by start method
@@ -141,8 +140,8 @@ const DEFAULT_CONFIG = {
 export class SynapseContainer extends GenericContainer {
     config;
     mas;
-    constructor() {
-        super(`ghcr.io/element-hq/synapse:${TAG}`);
+    constructor(image = "ghcr.io/element-hq/synapse:develop") {
+        super(image);
         this.config = deepCopy(DEFAULT_CONFIG);
         this.config.registration_shared_secret = randB64Bytes(16);
         this.config.macaroon_secret_key = randB64Bytes(16);

package/package.json

@@ -1,11 +1,24 @@
 {
     "name": "@element-hq/element-web-playwright-common",
     "type": "module",
-    "version": "1.0.0",
+    "version": "1.1.5",
     "license": "SEE LICENSE IN README.md",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/element-hq/element-modules.git",
+        "directory": "packages/element-web-playwright-common"
+    },
+    "author": "element-hq",
+    "engines": {
+        "node": ">=20.0.0"
+    },
     "main": "lib/index.js",
     "bin": {
-        "playwright-screenshots": "./playwright-screenshots.sh"
+        "playwright-screenshots": "playwright-screenshots.sh"
+    },
+    "scripts": {
+        "prepare": "tsc",
+        "test": "echo No tests for @element-hq/element-web-playwright-common"
     },
     "devDependencies": {
         "@types/lodash-es": "^4.17.12",
@@ -21,10 +34,8 @@
         "yaml": "^2.7.0"
     },
     "peerDependencies": {
+        "@element-hq/element-web-module-api": "*",
         "@playwright/test": "^1.51.0",
         "playwright-core": "^1.51.0"
-    },
-    "scripts": {
-        "prepare": "tsc"
     }
 }

package/src/expect/screenshot.ts

@@ -14,8 +14,8 @@ import {
     type Locator,
     type Page,
     type PageAssertionsToHaveScreenshotOptions,
+    type MatcherReturnType,
 } from "@playwright/test";
-import { type MatcherReturnType } from "playwright/types/test";
 import { sanitizeForFilePath } from "playwright-core/lib/utils";
 import { extname } from "node:path";
 

package/src/fixtures/user.ts

@@ -74,7 +74,7 @@ export const test = base.extend<{
                     "mx_local_settings",
                     JSON.stringify({
                         // Retain any other settings which may have already been set
-                        ...JSON.parse(window.localStorage.getItem("mx_local_settings") || "{}"),
+                        ...JSON.parse(window.localStorage.getItem("mx_local_settings") ?? "{}"),
                         // Ensure the language is set to a consistent value
                         language: "en",
                     }),

package/src/index.ts

@@ -27,6 +27,7 @@ export interface Config extends BaseConfig {
             server_name?: string;
         };
     };
+    enable_presence_by_hs_url?: Record<string, boolean>;
     setting_defaults: Record<string, unknown>;
     map_style_url?: string;
     features: Record<string, boolean>;
@@ -58,12 +59,15 @@ export interface TestFixtures {
     config: Partial<typeof CONFIG_JSON>;
 
     labsFlags: string[];
+    disablePresence: boolean;
 }
 
 export const test = base.extend<TestFixtures>({
-    config: {}, // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
-    labsFlags: [],
-    page: async ({ homeserver, context, page, config, labsFlags }, use) => {
+    // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
+    config: async ({}, use) => use({}),
+    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,
@@ -83,6 +87,11 @@ export const test = base.extend<TestFixtures>({
                     return obj;
                 }, {}),
             };
+            if (disablePresence) {
+                json["enable_presence_by_hs_url"] = {
+                    [homeserver.baseUrl]: false,
+                };
+            }
             await route.fulfill({ json });
         });
         await use(page);

package/src/testcontainers/synapse.ts

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 New Vector Ltd.
+Copyright 2024-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.
@@ -25,8 +25,6 @@ import { type StartedMatrixAuthenticationServiceContainer } from "./mas.js";
 import { Api, ClientServerApi, type Verb, type Credentials } from "../utils/api.js";
 import { StartedMailpitContainer } from "./mailpit.js";
 
-const TAG = "develop@sha256:8d0049e8e0524ad6817cf7737453fe47de1ed3b8d04704f0c2fd6c136414c9d7";
-
 const DEFAULT_CONFIG = {
     server_name: "localhost",
     public_baseurl: "", // set by start method
@@ -193,8 +191,8 @@ export class SynapseContainer extends GenericContainer implements HomeserverCont
     private config: SynapseConfig;
     private mas?: StartedMatrixAuthenticationServiceContainer;
 
-    public constructor() {
-        super(`ghcr.io/element-hq/synapse:${TAG}`);
+    public constructor(image = "ghcr.io/element-hq/synapse:develop") {
+        super(image);
 
         this.config = deepCopy(DEFAULT_CONFIG);
         this.config.registration_shared_secret = randB64Bytes(16);

package/lib/element-web-test.d.ts

@@ -1,26 +0,0 @@
-declare const CONFIG_JSON: {
-    default_server_config: {};
-    setting_defaults: {
-        language: string;
-    };
-    map_style_url: string;
-    features: Record<string, boolean>;
-};
-export interface TestFixtures {
-    /**
-     * The contents of the config.json to send when the client requests it.
-     */
-    config: Partial<typeof CONFIG_JSON>;
-    labsFlags: string[];
-}
-export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
-    axe: import("@axe-core/playwright").AxeBuilder;
-    checkA11y: () => Promise<void>;
-} & import("./fixtures/services").TestFixtures & {
-    displayName?: string;
-    credentials: import("./utils/api").Credentials;
-    pageWithCredentials: import("playwright-core").Page;
-    user: import("./utils/api").Credentials;
-} & TestFixtures, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./fixtures/services").Services>;
-export { expect } from "./expect";
-//# sourceMappingURL=element-web-test.d.ts.map

package/lib/element-web-test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"element-web-test.d.ts","sourceRoot":"","sources":["../src/element-web-test.ts"],"names":[],"mappings":"AAeA,QAAA,MAAM,WAAW;;;;;;cAcR,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,eAAO,MAAM,IAAI;;;;;;;;8JA2Bf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/lib/element-web-test.js

@@ -1,54 +0,0 @@
-/*
-Copyright 2024 New Vector Ltd.
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
-Please see LICENSE files in the repository root for full details.
-*/
-import { test as base } from "./fixtures";
-// 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";
-// This is deliberately quite a minimal config.json, so that we can test that the default settings actually work.
-const CONFIG_JSON = {
-    default_server_config: {},
-    // The default language is set here for test consistency
-    setting_defaults: {
-        language: "en-GB",
-    },
-    // the location tests want a map style url.
-    map_style_url: "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx",
-    features: {
-        // We don't want to go through the feature announcement during the e2e test
-        feature_release_announcement: false,
-    },
-};
-export const test = base.extend({
-    config: {}, // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
-    labsFlags: [],
-    page: async ({ homeserver, context, page, config, labsFlags }, 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;
-                }, {}),
-            };
-            await route.fulfill({ json });
-        });
-        await use(page);
-    },
-});
-export { expect } from "./expect";

package/lib/expect/toHaveNoViolations.d.ts

@@ -1,11 +0,0 @@
-import { type ExpectMatcherState, type MatcherReturnType } from "@playwright/test";
-import type AxeBuilder from "@axe-core/playwright";
-export type Expectations = {
-    /**
-     * Assert that the given AxeBuilder instance has no violations.
-     * @param receiver - The AxeBuilder instance to check.
-     */
-    toHaveNoViolations: (this: ExpectMatcherState, receiver: AxeBuilder) => Promise<MatcherReturnType>;
-};
-export declare const expect: import("playwright/test").Expect<Expectations>;
-//# sourceMappingURL=toHaveNoViolations.d.ts.map

package/lib/expect/toHaveNoViolations.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toHaveNoViolations.d.ts","sourceRoot":"","sources":["../../src/expect/toHaveNoViolations.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,KAAK,UAAU,MAAM,sBAAsB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACvB;;;OAGG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtG,CAAC;AAEF,eAAO,MAAM,MAAM,gDAgBjB,CAAC"}

package/lib/expect/toHaveNoViolations.js

@@ -1,22 +0,0 @@
-/*
-Copyright 2024 New Vector Ltd.
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
-Please see LICENSE files in the repository root for full details.
-*/
-import { test, expect as baseExpect } from "@playwright/test";
-export const expect = baseExpect.extend({
-    async toHaveNoViolations(receiver) {
-        const testInfo = test.info();
-        if (!testInfo)
-            throw new Error(`toHaveNoViolations() must be called during the test`);
-        const results = await receiver.analyze();
-        await testInfo.attach("accessibility-scan-results", {
-            body: JSON.stringify(results, null, 2),
-            contentType: "application/json",
-        });
-        baseExpect(results.violations).toEqual([]);
-        return { pass: true, message: () => "", name: "toHaveNoViolations" };
-    },
-});

package/lib/expect/toMatchScreenshot.d.ts

@@ -1,13 +0,0 @@
-import { type ExpectMatcherState, type Locator, type Page } from "@playwright/test";
-import { type MatcherReturnType } from "playwright/types/test";
-export type Expectations = {
-    toMatchScreenshot: (this: ExpectMatcherState, receiver: Page | Locator, name: `${string}.png`, options?: {
-        mask?: Array<Locator>;
-        includeDialogBackground?: boolean;
-        showTooltips?: boolean;
-        timeout?: number;
-        css?: string;
-    }) => Promise<MatcherReturnType>;
-};
-export declare const expect: import("playwright/test").Expect<Expectations>;
-//# sourceMappingURL=toMatchScreenshot.d.ts.map

package/lib/expect/toMatchScreenshot.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toMatchScreenshot.d.ts","sourceRoot":"","sources":["../../src/expect/toMatchScreenshot.ts"],"names":[],"mappings":"AAQA,OAAO,EAIH,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,IAAI,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAW/D,MAAM,MAAM,YAAY,GAAG;IACvB,iBAAiB,EAAE,CACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,IAAI,GAAG,OAAO,EACxB,IAAI,EAAE,GAAG,MAAM,MAAM,EACrB,OAAO,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACtB,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;KAChB,KACA,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,MAAM,gDAkCjB,CAAC"}

package/lib/expect/toMatchScreenshot.js

@@ -1,44 +0,0 @@
-/*
-Copyright 2024 New Vector Ltd.
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
-Please see LICENSE files in the repository root for full details.
-*/
-import { test, expect as baseExpect, } from "@playwright/test";
-import { sanitizeForFilePath } from "playwright-core/lib/utils";
-import { extname } from "node:path";
-// Based on https://github.com/microsoft/playwright/blob/2b77ed4d7aafa85a600caa0b0d101b72c8437eeb/packages/playwright/src/util.ts#L206C8-L210C2
-function sanitizeFilePathBeforeExtension(filePath) {
-    const ext = extname(filePath);
-    const base = filePath.substring(0, filePath.length - ext.length);
-    return sanitizeForFilePath(base) + ext;
-}
-export const expect = baseExpect.extend({
-    async toMatchScreenshot(receiver, name, options) {
-        const testInfo = test.info();
-        if (!testInfo)
-            throw new Error(`toMatchScreenshot() must be called during the test`);
-        if (!testInfo.tags.includes("@screenshot")) {
-            throw new Error("toMatchScreenshot() must be used in a test tagged with @screenshot");
-        }
-        const page = "page" in receiver ? receiver.page() : receiver;
-        let style;
-        if (options?.css) {
-            // We add a custom style tag before taking screenshots
-            style = (await page.addStyleTag({
-                content: options.css,
-            }));
-        }
-        const screenshotName = sanitizeFilePathBeforeExtension(name);
-        await baseExpect(receiver).toHaveScreenshot(screenshotName, options);
-        await style?.evaluate((tag) => tag.remove());
-        testInfo.annotations.push({
-            // `_` prefix hides it from the HTML reporter
-            type: "_screenshot",
-            // include a path relative to `playwright/snapshots/`
-            description: testInfo.snapshotPath(screenshotName).split("/playwright/snapshots/", 2)[1],
-        });
-        return { pass: true, message: () => "", name: "toMatchScreenshot" };
-    },
-});

package/lib/expect/toPassAxeCheck.d.ts

@@ -1,7 +0,0 @@
-import { type ExpectMatcherState, type MatcherReturnType } from "@playwright/test";
-import type AxeBuilder from "@axe-core/playwright";
-export type Expectations = {
-    toPassAxeCheck: (this: ExpectMatcherState, receiver: AxeBuilder) => Promise<MatcherReturnType>;
-};
-export declare const expect: import("playwright/test").Expect<Expectations>;
-//# sourceMappingURL=toPassAxeCheck.d.ts.map

package/lib/expect/toPassAxeCheck.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toPassAxeCheck.d.ts","sourceRoot":"","sources":["../../src/expect/toPassAxeCheck.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,KAAK,UAAU,MAAM,sBAAsB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACvB,cAAc,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAClG,CAAC;AAEF,eAAO,MAAM,MAAM,gDAgBjB,CAAC"}

package/lib/expect/toPassAxeCheck.js

@@ -1,22 +0,0 @@
-/*
-Copyright 2024 New Vector Ltd.
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
-Please see LICENSE files in the repository root for full details.
-*/
-import { test, expect as baseExpect } from "@playwright/test";
-export const expect = baseExpect.extend({
-    async toPassAxeCheck(receiver) {
-        const testInfo = test.info();
-        if (!testInfo)
-            throw new Error(`toPassAxeCheck() must be called during the test`);
-        const results = await receiver.analyze();
-        await testInfo.attach("accessibility-scan-results", {
-            body: JSON.stringify(results, null, 2),
-            contentType: "application/json",
-        });
-        baseExpect(results.violations).toEqual([]);
-        return { pass: true, message: () => "", name: "toPassAxeCheck" };
-    },
-});

package/lib/logger.d.ts

@@ -1,10 +0,0 @@
-import { type BrowserContext, type TestInfo } from "@playwright/test";
-import { type Readable } from "stream";
-export declare class Logger {
-    private pages;
-    private logs;
-    getConsumer(container: string): (stream: Readable) => void;
-    onTestStarted(context: BrowserContext): Promise<void>;
-    onTestFinished(testInfo: TestInfo): Promise<void>;
-}
-//# sourceMappingURL=logger.d.ts.map

package/lib/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAa,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGvC,qBAAa,MAAM;IACf,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,IAAI,CAA8B;IAEnC,WAAW,CAAC,SAAS,EAAE,MAAM,IAExB,QAAQ,QAAQ;IAUf,aAAa,CAAC,OAAO,EAAE,cAAc;IAyBrC,cAAc,CAAC,QAAQ,EAAE,QAAQ;CAWjD"}

package/lib/logger.js

@@ -1,59 +0,0 @@
-/*
-Copyright 2024 New Vector Ltd.
-
-SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
-Please see LICENSE files in the repository root for full details.
-*/
-import stripAnsi from "strip-ansi";
-export class Logger {
-    pages = [];
-    logs = {};
-    getConsumer(container) {
-        this.logs[container] = "";
-        return (stream) => {
-            stream.on("data", (chunk) => {
-                this.logs[container] += chunk.toString();
-            });
-            stream.on("err", (chunk) => {
-                this.logs[container] += "ERR " + chunk.toString();
-            });
-        };
-    }
-    async onTestStarted(context) {
-        this.pages = [];
-        for (const id in this.logs) {
-            if (id.startsWith("page-")) {
-                delete this.logs[id];
-            }
-            else {
-                this.logs[id] = "";
-            }
-        }
-        context.on("console", (msg) => {
-            const page = msg.page();
-            if (!page)
-                return;
-            let pageIdx = this.pages.indexOf(page);
-            if (pageIdx === -1) {
-                this.pages.push(page);
-                pageIdx = this.pages.length - 1;
-                this.logs[`page-${pageIdx}`] = `Console logs for page with URL: ${page.url()}\n\n`;
-            }
-            const type = msg.type();
-            const text = msg.text();
-            this.logs[`page-${pageIdx}`] += `${type}: ${text}\n`;
-        });
-    }
-    async onTestFinished(testInfo) {
-        if (testInfo.status !== "passed") {
-            for (const id in this.logs) {
-                if (!this.logs[id])
-                    continue;
-                await testInfo.attach(id, {
-                    body: stripAnsi(this.logs[id]),
-                    contentType: "text/plain",
-                });
-            }
-        }
-    }
-}

package/lib/playwright.d.ts

@@ -1,2 +0,0 @@
-export * from "@playwright/test";
-//# sourceMappingURL=playwright.d.ts.map

package/lib/playwright.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../src/playwright.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/lib/playwright.js

@@ -1 +0,0 @@
-export * from "@playwright/test";