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

package/lib/fixtures/user.d.ts

@@ -0,0 +1,31 @@
+import { type Page } from "@playwright/test";
+import { Credentials } from "../utils/api.js";
+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}.
+     *
+     * To set it, call `test.use({ displayName: "myDisplayName" })` in the test file or `describe` block.
+     * See {@link https://playwright.dev/docs/api/class-test#test-use}.
+     */
+    displayName?: string;
+    /**
+     * A test fixture which registers a test user on the {@link #homeserver} and supplies the details
+     * of the registered user.
+     */
+    credentials: Credentials;
+    /**
+     * The same as {@link https://playwright.dev/docs/api/class-fixtures#fixtures-page|`page`},
+     * but adds an initScript which will populate localStorage with the user's details from
+     * {@link #credentials} and {@link #homeserver}.
+     *
+     * Similar to {@link #user}, but doesn't load the app.
+     */
+    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
+     * app.
+     */
+    user: Credentials;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./services.js").WorkerOptions & import("./services.js").Services>;
+//# sourceMappingURL=user.d.ts.map

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

@@ -0,0 +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"}

package/lib/fixtures/user.js

@@ -0,0 +1,47 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { sample, uniqueId } from "lodash-es";
+import { test as base } from "./services.js";
+export const test = base.extend({
+    displayName: undefined,
+    credentials: async ({ homeserver, displayName: testDisplayName }, use, testInfo) => {
+        const names = ["Alice", "Bob", "Charlie", "Daniel", "Eve", "Frank", "Grace", "Hannah", "Isaac", "Judy"];
+        const password = uniqueId("password_");
+        const displayName = testDisplayName ?? sample(names);
+        const credentials = await homeserver.registerUser(`user_${testInfo.testId}`, password, displayName);
+        console.log(`Registered test user ${credentials.userId} with displayname ${displayName}`);
+        await use({
+            ...credentials,
+            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 });
+        await use(page);
+    },
+    user: async ({ pageWithCredentials: page, credentials }, use) => {
+        await page.goto("/");
+        await page.waitForSelector(".mx_MatrixChat", { timeout: 30000 });
+        await use(credentials);
+    },
+});

package/lib/index.d.ts

@@ -0,0 +1,35 @@
+import { type Config as BaseConfig } from "@element-hq/element-web-module-api";
+export interface Config extends BaseConfig {
+    default_server_config: {
+        "m.homeserver"?: {
+            base_url: string;
+            server_name?: string;
+        };
+        "m.identity_server"?: {
+            base_url: string;
+            server_name?: string;
+        };
+    };
+    setting_defaults: Record<string, unknown>;
+    map_style_url?: string;
+    features: Record<string, boolean>;
+    modules?: string[];
+}
+export declare const CONFIG_JSON: Partial<Config>;
+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;
+} & import("./fixtures/services.js").TestFixtures & {
+    displayName?: string;
+    credentials: import("./utils/api.js").Credentials;
+    pageWithCredentials: import("playwright-core").Page;
+    user: import("./utils/api.js").Credentials;
+} & TestFixtures, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./fixtures/services.js").WorkerOptions & import("./fixtures/services.js").Services>;
+export { expect, type ToMatchScreenshotOptions } from "./expect/index.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +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"}

package/lib/index.js

@@ -0,0 +1,54 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+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";
+// 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.
+export 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/index.js";

package/lib/logger.d.ts

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,59 @@
+/*
+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

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

package/lib/playwright.d.ts.map

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

package/lib/playwright.js

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

package/lib/testcontainers/HomeserverContainer.d.ts

@@ -0,0 +1,70 @@
+import { type AbstractStartedContainer, type GenericContainer } from "testcontainers";
+import { type APIRequestContext, type TestInfo } from "@playwright/test";
+import { type StartedMatrixAuthenticationServiceContainer } from "./mas";
+import { ClientServerApi, Credentials } from "../utils/api";
+import { StartedMailpitContainer } from "./mailpit";
+export interface HomeserverInstance {
+    readonly baseUrl: string;
+    readonly csApi: ClientServerApi;
+    /**
+     * Register a user on the given Homeserver using the shared registration secret.
+     * @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>;
+    /**
+     * Logs into synapse with the given username/password
+     * @param userId login username
+     * @param password login password
+     */
+    loginUser(userId: string, password: string): Promise<Credentials>;
+    /**
+     * Sets a third party identifier for the given user. This only supports setting a single 3pid and will
+     * replace any others.
+     * @param userId The full ID of the user to edit (as returned from registerUser)
+     * @param medium The medium of the 3pid to set
+     * @param address The address of the 3pid to set
+     */
+    setThreepid(userId: string, medium: string, address: string): Promise<void>;
+}
+export interface HomeserverContainer<Config> extends GenericContainer {
+    /**
+     * Set a configuration field in the config
+     * @param key - the key to set
+     * @param value - the value to set
+     */
+    withConfigField<Key extends keyof Config>(key: Key, value: Config[Key]): this;
+    /**
+     * Merge a partial configuration into the config
+     * @param config - the partial configuration to merge
+     */
+    withConfig(config: Partial<Config>): this;
+    /**
+     * Set the SMTP server to use for sending emails
+     * @param mailpit - the mailpit container to use
+     */
+    withSmtpServer(mailpit: StartedMailpitContainer): this;
+    /**
+     * Set the MAS server to use for delegated auth
+     * @param mas - the MAS container to use
+     */
+    withMatrixAuthenticationService(mas?: StartedMatrixAuthenticationServiceContainer): this;
+    /**
+     * Start the container
+     */
+    start(): Promise<StartedHomeserverContainer>;
+}
+export interface StartedHomeserverContainer extends AbstractStartedContainer, HomeserverInstance {
+    /**
+     * Set the request context for the APIs
+     * @param request - the request context to set
+     */
+    setRequest(request: APIRequestContext): void;
+    /**
+     * Clean up the server to prevent rooms leaking between tests
+     * @param testInfo - the test info for the test that just finished
+     */
+    onTestFinished(testInfo: TestInfo): Promise<void>;
+}
+//# sourceMappingURL=HomeserverContainer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HomeserverContainer.d.ts","sourceRoot":"","sources":["../../src/testcontainers/HomeserverContainer.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEzE,OAAO,EAAE,KAAK,2CAA2C,EAAE,MAAM,OAAO,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AAEpD,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;IAEhC;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7F;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAElE;;;;;;OAMG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/E;AAED,MAAM,WAAW,mBAAmB,CAAC,MAAM,CAAE,SAAQ,gBAAgB;IACjE;;;;OAIG;IACH,eAAe,CAAC,GAAG,SAAS,MAAM,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACvD;;;OAGG;IACH,+BAA+B,CAAC,GAAG,CAAC,EAAE,2CAA2C,GAAG,IAAI,CAAC;IAEzF;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,0BAA0B,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,0BAA2B,SAAQ,wBAAwB,EAAE,kBAAkB;IAC5F;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrD"}

package/lib/testcontainers/HomeserverContainer.js

@@ -0,0 +1,7 @@
+/*
+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.
+*/
+export {};

package/lib/testcontainers/index.d.ts

@@ -0,0 +1,5 @@
+export type { HomeserverInstance, HomeserverContainer, StartedHomeserverContainer } from "./HomeserverContainer.js";
+export { type SynapseConfig, SynapseContainer, StartedSynapseContainer } from "./synapse.js";
+export { type MasConfig, MatrixAuthenticationServiceContainer, StartedMatrixAuthenticationServiceContainer, } from "./mas.js";
+export { MailpitClient, MailpitContainer, StartedMailpitContainer } from "./mailpit.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testcontainers/index.ts"],"names":[],"mappings":"AAOA,YAAY,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC7F,OAAO,EACH,KAAK,SAAS,EACd,oCAAoC,EACpC,2CAA2C,GAC9C,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC"}

package/lib/testcontainers/index.js

@@ -0,0 +1,9 @@
+/*
+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.
+*/
+export { SynapseContainer, StartedSynapseContainer } from "./synapse.js";
+export { MatrixAuthenticationServiceContainer, StartedMatrixAuthenticationServiceContainer, } from "./mas.js";
+export { MailpitContainer, StartedMailpitContainer } from "./mailpit.js";

package/lib/testcontainers/mailpit.d.ts

@@ -0,0 +1,33 @@
+import { AbstractStartedContainer, GenericContainer, type StartedTestContainer } from "testcontainers";
+import { MailpitClient } from "mailpit-api";
+export type { MailpitClient };
+/**
+ * A testcontainer for Mailpit.
+ *
+ * Exposes port 8025.
+ * Waits for listening ports.
+ * Disables SMTP authentication.
+ */
+export declare class MailpitContainer extends GenericContainer {
+    constructor();
+    /**
+     * Start the Mailpit container.
+     */
+    start(): Promise<StartedMailpitContainer>;
+}
+/**
+ * A started Mailpit container.
+ */
+export declare class StartedMailpitContainer extends AbstractStartedContainer {
+    readonly client: MailpitClient;
+    constructor(container: StartedTestContainer);
+    /**
+     * Get the hostname to use to connect to the Mailpit container from inside the docker network.
+     */
+    get internalHost(): string;
+    /**
+     * Get the port to use to connect to the Mailpit container from inside the docker network.
+     */
+    get internalSmtpPort(): number;
+}
+//# sourceMappingURL=mailpit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mailpit.d.ts","sourceRoot":"","sources":["../../src/testcontainers/mailpit.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,KAAK,oBAAoB,EAAQ,MAAM,gBAAgB,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;;IAUlD;;OAEG;IACmB,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC;CAGlE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,wBAAwB;IACjE,SAAgB,MAAM,EAAE,aAAa,CAAC;gBAEnB,SAAS,EAAE,oBAAoB;IAKlD;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;CACJ"}

package/lib/testcontainers/mailpit.js

@@ -0,0 +1,52 @@
+/*
+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.
+*/
+import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers";
+import { MailpitClient } from "mailpit-api";
+/**
+ * A testcontainer for Mailpit.
+ *
+ * Exposes port 8025.
+ * Waits for listening ports.
+ * Disables SMTP authentication.
+ */
+export class MailpitContainer extends GenericContainer {
+    constructor() {
+        super("axllent/mailpit:latest");
+        this.withExposedPorts(8025).withWaitStrategy(Wait.forListeningPorts()).withEnvironment({
+            MP_SMTP_AUTH_ALLOW_INSECURE: "true",
+            MP_SMTP_AUTH_ACCEPT_ANY: "true",
+        });
+    }
+    /**
+     * Start the Mailpit container.
+     */
+    async start() {
+        return new StartedMailpitContainer(await super.start());
+    }
+}
+/**
+ * A started Mailpit container.
+ */
+export class StartedMailpitContainer extends AbstractStartedContainer {
+    client;
+    constructor(container) {
+        super(container);
+        this.client = new MailpitClient(`http://${container.getHost()}:${container.getMappedPort(8025)}`);
+    }
+    /**
+     * Get the hostname to use to connect to the Mailpit container from inside the docker network.
+     */
+    get internalHost() {
+        return "mailpit";
+    }
+    /**
+     * Get the port to use to connect to the Mailpit container from inside the docker network.
+     */
+    get internalSmtpPort() {
+        return 1025;
+    }
+}

package/lib/testcontainers/mas.d.ts

@@ -0,0 +1,182 @@
+import { AbstractStartedContainer, GenericContainer, type StartedTestContainer } from "testcontainers";
+import { type StartedPostgreSqlContainer } from "@testcontainers/postgresql";
+import { type Credentials } from "../utils/api.js";
+declare const DEFAULT_CONFIG: {
+    http: {
+        listeners: {
+            name: string;
+            resources: ({
+                name: string;
+                playground?: undefined;
+                path?: undefined;
+            } | {
+                name: string;
+                playground: boolean;
+                path?: undefined;
+            } | {
+                name: string;
+                path: string;
+                playground?: undefined;
+            })[];
+            binds: {
+                address: string;
+            }[];
+            proxy_protocol: boolean;
+        }[];
+        trusted_proxies: string[];
+        public_base: string;
+        issuer: string;
+    };
+    database: {
+        host: string;
+        port: number;
+        database: string;
+        username: string;
+        password: string;
+        max_connections: number;
+        min_connections: number;
+        connect_timeout: number;
+        idle_timeout: number;
+        max_lifetime: number;
+    };
+    telemetry: {
+        tracing: {
+            exporter: string;
+            propagators: never[];
+        };
+        metrics: {
+            exporter: string;
+        };
+        sentry: {
+            dsn: null;
+        };
+    };
+    templates: {
+        path: string;
+        assets_manifest: string;
+        translations_path: string;
+    };
+    email: {
+        from: string;
+        reply_to: string;
+        transport: string;
+        mode: string;
+        hostname: string;
+        port: number;
+        username: string;
+        password: string;
+    };
+    secrets: {
+        encryption: string;
+        keys: {
+            kid: string;
+            key: string;
+        }[];
+    };
+    passwords: {
+        enabled: boolean;
+        schemes: {
+            version: number;
+            algorithm: string;
+        }[];
+        minimum_complexity: number;
+    };
+    policy: {
+        wasm_module: string;
+        client_registration_entrypoint: string;
+        register_entrypoint: string;
+        authorization_grant_entrypoint: string;
+        password_entrypoint: string;
+        email_entrypoint: string;
+        data: {
+            client_registration: {
+                allow_insecure_uris: boolean;
+                allow_missing_contacts: boolean;
+            };
+        };
+    };
+    upstream_oauth2: {
+        providers: never[];
+    };
+    branding: {
+        service_name: null;
+        policy_uri: null;
+        tos_uri: null;
+        imprint: null;
+        logo_uri: null;
+    };
+    account: {
+        password_registration_enabled: boolean;
+    };
+    experimental: {
+        access_token_ttl: number;
+        compat_token_ttl: number;
+    };
+    rate_limiting: {
+        login: {
+            burst: number;
+            per_second: number;
+        };
+        registration: {
+            burst: number;
+            per_second: number;
+        };
+    };
+};
+/**
+ * Incomplete type for the MAS configuration.
+ */
+export type MasConfig = typeof DEFAULT_CONFIG;
+/**
+ * A container running the Matrix Authentication Service.
+ *
+ * Exposes the MAS API on port 8080 and the health check on port 8081.
+ * Waits for HTTP /health on port 8081 to be available.
+ */
+export declare class MatrixAuthenticationServiceContainer extends GenericContainer {
+    private config;
+    private readonly args;
+    constructor(db: StartedPostgreSqlContainer);
+    /**
+     * Adds additional configuration to the MAS config.
+     * @param config - additional config fields to add
+     */
+    withConfig(config: object): this;
+    /**
+     * Starts the MAS container
+     */
+    start(): Promise<StartedMatrixAuthenticationServiceContainer>;
+}
+/**
+ * A started Matrix Authentication Service container.
+ */
+export declare class StartedMatrixAuthenticationServiceContainer extends AbstractStartedContainer {
+    readonly baseUrl: string;
+    private readonly args;
+    private adminTokenPromise?;
+    constructor(container: StartedTestContainer, baseUrl: string, args: string[]);
+    /**
+     * Retrieves a valid HS admin token
+     */
+    getAdminToken(): Promise<string>;
+    private manage;
+    private manageRegisterUser;
+    private manageIssueCompatibilityToken;
+    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>;
+    /**
+     * Binds a 3pid
+     * @param username - the username of the user to bind the 3pid to
+     * @param medium - the medium of the 3pid to bind
+     * @param address - the address of the 3pid to bind
+     */
+    setThreepid(username: string, medium: string, address: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=mas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mas.d.ts","sourceRoot":"","sources":["../../src/testcontainers/mas.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,wBAAwB,EACxB,gBAAgB,EAChB,KAAK,oBAAoB,EAG5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAK7E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8JnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,cAAc,CAAC;AAE9C;;;;;GAKG;AACH,qBAAa,oCAAqC,SAAQ,gBAAgB;IACtE,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiC;gBAEnC,EAAE,EAAE,0BAA0B;IAcjD;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQvC;;OAEG;IACmB,KAAK,IAAI,OAAO,CAAC,2CAA2C,CAAC;CAuBtF;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;YAY/B,MAAM;YAQN,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"}