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

package/lib/testcontainers/synapse.js

@@ -0,0 +1,383 @@
+/*
+Copyright 2024 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 crypto from "node:crypto";
+import * as YAML from "yaml";
+import { set } from "lodash-es";
+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
+    pid_file: "/homeserver.pid",
+    web_client: false,
+    soft_file_limit: 0,
+    // Needs to be configured to log to the console like a good docker process
+    log_config: "/data/log.config",
+    listeners: [
+        {
+            // Listener is always port 8008 (configured in the container)
+            port: 8008,
+            tls: false,
+            bind_addresses: ["::"],
+            type: "http",
+            x_forwarded: true,
+            resources: [
+                {
+                    names: ["client"],
+                    compress: false,
+                },
+            ],
+        },
+    ],
+    database: {
+        // An sqlite in-memory database is fast & automatically wipes each time
+        name: "sqlite3",
+        args: {
+            database: ":memory:",
+        },
+    },
+    rc_messages_per_second: 10000,
+    rc_message_burst_count: 10000,
+    rc_registration: {
+        per_second: 10000,
+        burst_count: 10000,
+    },
+    rc_joins: {
+        local: {
+            per_second: 9999,
+            burst_count: 9999,
+        },
+        remote: {
+            per_second: 9999,
+            burst_count: 9999,
+        },
+    },
+    rc_joins_per_room: {
+        per_second: 9999,
+        burst_count: 9999,
+    },
+    rc_3pid_validation: {
+        per_second: 1000,
+        burst_count: 1000,
+    },
+    rc_invites: {
+        per_room: {
+            per_second: 1000,
+            burst_count: 1000,
+        },
+        per_user: {
+            per_second: 1000,
+            burst_count: 1000,
+        },
+    },
+    rc_login: {
+        address: {
+            per_second: 10000,
+            burst_count: 10000,
+        },
+        account: {
+            per_second: 10000,
+            burst_count: 10000,
+        },
+        failed_attempts: {
+            per_second: 10000,
+            burst_count: 10000,
+        },
+    },
+    media_store_path: "/tmp/media_store",
+    max_upload_size: "50M",
+    max_image_pixels: "32M",
+    dynamic_thumbnails: false,
+    enable_registration: true,
+    enable_registration_without_verification: true,
+    disable_msisdn_registration: false,
+    registrations_require_3pid: [],
+    enable_metrics: false,
+    report_stats: false,
+    // These placeholders will be replaced with values generated at start
+    registration_shared_secret: "secret",
+    macaroon_secret_key: "secret",
+    form_secret: "secret",
+    // Signing key must be here: it will be generated to this file
+    signing_key_path: "/data/localhost.signing.key",
+    trusted_key_servers: [],
+    password_config: {
+        enabled: true,
+    },
+    ui_auth: {},
+    background_updates: {
+        // Inhibit background updates as this Synapse isn't long-lived
+        min_batch_size: 100000,
+        sleep_duration_ms: 100000,
+    },
+    enable_authenticated_media: true,
+    email: undefined,
+    user_consent: undefined,
+    server_notices: undefined,
+    allow_guest_access: false,
+    experimental_features: {},
+    oidc_providers: [],
+    serve_server_wellknown: true,
+    presence: {
+        enabled: true,
+        include_offline_users_on_sync: true,
+    },
+    room_list_publication_rules: [{ action: "allow" }],
+};
+/**
+ * A Synapse testcontainer
+ *
+ * Exposes port 8008.
+ * Waits for HTTP /health 8008 to 200.
+ */
+export class SynapseContainer extends GenericContainer {
+    config;
+    mas;
+    constructor() {
+        super(`ghcr.io/element-hq/synapse:${TAG}`);
+        this.config = deepCopy(DEFAULT_CONFIG);
+        this.config.registration_shared_secret = randB64Bytes(16);
+        this.config.macaroon_secret_key = randB64Bytes(16);
+        this.config.form_secret = randB64Bytes(16);
+        const signingKey = randB64Bytes(32);
+        this.withWaitStrategy(Wait.forHttp("/health", 8008)).withCopyContentToContainer([
+            { target: this.config.signing_key_path, content: `ed25519 x ${signingKey}` },
+            {
+                target: this.config.log_config,
+                content: YAML.stringify({
+                    version: 1,
+                    formatters: {
+                        precise: {
+                            format: "%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s",
+                        },
+                    },
+                    handlers: {
+                        console: {
+                            class: "logging.StreamHandler",
+                            formatter: "precise",
+                        },
+                    },
+                    loggers: {
+                        "synapse.storage.SQL": {
+                            level: "DEBUG",
+                        },
+                        "twisted": {
+                            handlers: ["console"],
+                            propagate: false,
+                        },
+                    },
+                    root: {
+                        level: "DEBUG",
+                        handlers: ["console"],
+                    },
+                    disable_existing_loggers: false,
+                }),
+            },
+        ]);
+    }
+    withConfigField(key, value) {
+        set(this.config, key, value);
+        return this;
+    }
+    withConfig(config) {
+        this.config = {
+            ...this.config,
+            ...config,
+        };
+        return this;
+    }
+    withSmtpServer(mailpit) {
+        this.config.email = {
+            enable_notifs: false,
+            smtp_host: mailpit.internalHost,
+            smtp_port: mailpit.internalSmtpPort,
+            smtp_user: "username",
+            smtp_pass: "password",
+            require_transport_security: false,
+            notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
+            app_name: "Matrix",
+            notif_template_html: "notif_mail.html",
+            notif_template_text: "notif_mail.txt",
+            notif_for_new_users: true,
+            client_base_url: "http://localhost/element",
+        };
+        return this;
+    }
+    withMatrixAuthenticationService(mas) {
+        this.mas = mas;
+        return this;
+    }
+    async start() {
+        // Synapse config public_baseurl needs to know what URL it'll be accessed from, so we have to map the port manually
+        const port = await getFreePort();
+        this.withExposedPorts({
+            container: 8008,
+            host: port,
+        })
+            .withConfig({
+            public_baseurl: `http://localhost:${port}`,
+        })
+            .withCopyContentToContainer([
+            {
+                target: "/data/homeserver.yaml",
+                content: YAML.stringify(this.config),
+            },
+        ]);
+        const container = await super.start();
+        const baseUrl = `http://localhost:${port}`;
+        if (this.mas) {
+            return new StartedSynapseWithMasContainer(container, baseUrl, this.config.registration_shared_secret, this.mas);
+        }
+        return new StartedSynapseContainer(container, baseUrl, this.config.registration_shared_secret);
+    }
+}
+/**
+ * A started Synapse testcontainer
+ */
+export class StartedSynapseContainer extends AbstractStartedContainer {
+    baseUrl;
+    registrationSharedSecret;
+    adminTokenPromise;
+    adminApi;
+    csApi;
+    constructor(container, baseUrl, registrationSharedSecret) {
+        super(container);
+        this.baseUrl = baseUrl;
+        this.registrationSharedSecret = registrationSharedSecret;
+        this.adminApi = new Api(`${this.baseUrl}/_synapse/admin`);
+        this.csApi = new ClientServerApi(this.baseUrl);
+    }
+    /**
+     * Restart the container
+     * Useful to reset the state of the homeserver between tests
+     * @param options - options to pass to the restart
+     */
+    restart(options) {
+        this.adminTokenPromise = undefined;
+        return super.restart(options);
+    }
+    setRequest(request) {
+        this.csApi.setRequest(request);
+        this.adminApi.setRequest(request);
+    }
+    async onTestFinished(testInfo) {
+        // Clean up the server to prevent rooms leaking between tests
+        await this.deletePublicRooms();
+    }
+    async deletePublicRooms() {
+        const token = await this.getAdminToken();
+        // We hide the rooms from the room directory to save time between tests and for portability between homeservers
+        const { chunk: rooms } = await this.csApi.request("GET", "/v3/publicRooms", token, {});
+        await Promise.all(rooms.map((room) => this.csApi.request("PUT", `/v3/directory/list/room/${room.room_id}`, token, { visibility: "private" })));
+    }
+    async registerUserInternal(username, password, displayName, admin = false) {
+        const path = "/v1/register";
+        const { nonce } = await this.adminApi.request("GET", path, undefined, {});
+        const mac = crypto
+            .createHmac("sha1", this.registrationSharedSecret)
+            .update(`${nonce}\0${username}\0${password}\0${admin ? "" : "not"}admin`)
+            .digest("hex");
+        const data = await this.adminApi.request("POST", path, undefined, {
+            nonce,
+            username,
+            password,
+            mac,
+            admin,
+            displayname: displayName,
+        });
+        return {
+            homeServer: data.home_server || data.user_id.split(":").slice(1).join(":"),
+            accessToken: data.access_token,
+            userId: data.user_id,
+            deviceId: data.device_id,
+            password,
+            displayName,
+            username,
+        };
+    }
+    async getAdminToken() {
+        if (this.adminTokenPromise === undefined) {
+            this.adminTokenPromise = this.registerUserInternal("admin", "totalyinsecureadminpassword", undefined, true).then((res) => res.accessToken);
+        }
+        return this.adminTokenPromise;
+    }
+    async adminRequest(verb, path, data) {
+        const adminToken = await this.getAdminToken();
+        return this.adminApi.request(verb, path, adminToken, data);
+    }
+    /**
+     * 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, password, displayName) {
+        return this.registerUserInternal(username, password, displayName, false);
+    }
+    /**
+     * Logs into synapse with the given username/password
+     * @param userId - login username
+     * @param password - login password
+     */
+    async loginUser(userId, password) {
+        return this.csApi.loginUser(userId, password);
+    }
+    /**
+     * Binds a 3pid
+     * @param userId - 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
+     */
+    async setThreepid(userId, medium, address) {
+        await this.adminRequest("PUT", `/v2/users/${userId}`, {
+            threepids: [
+                {
+                    medium,
+                    address,
+                },
+            ],
+        });
+    }
+}
+/**
+ * A started Synapse container when delegating auth to MAS
+ */
+export class StartedSynapseWithMasContainer extends StartedSynapseContainer {
+    mas;
+    constructor(container, baseUrl, registrationSharedSecret, mas) {
+        super(container, baseUrl, registrationSharedSecret);
+        this.mas = mas;
+    }
+    async getAdminToken() {
+        if (this.adminTokenPromise === undefined) {
+            this.adminTokenPromise = this.mas.getAdminToken();
+        }
+        return this.adminTokenPromise;
+    }
+    /**
+     * 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, password, displayName) {
+        return this.mas.registerUser(username, password, displayName);
+    }
+    /**
+     * Binds a 3pid
+     * @param userId - 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
+     */
+    async setThreepid(userId, medium, address) {
+        return this.mas.setThreepid(userId, medium, address);
+    }
+}

package/lib/utils/api.d.ts

@@ -0,0 +1,49 @@
+import { type APIRequestContext } from "@playwright/test";
+export type Verb = "GET" | "POST" | "PUT" | "DELETE";
+/**
+ * A generic API client.
+ */
+export declare class Api {
+    private readonly baseUrl;
+    private _request?;
+    constructor(baseUrl: string);
+    /**
+     * Set the request context to use for making requests.
+     * @param request - The request context to use.
+     */
+    setRequest(request: APIRequestContext): void;
+    /**
+     * Make a request to the API.
+     * @param verb - The HTTP verb to use.
+     * @param path - The path to request.
+     * @param token - The access token to use for the request.
+     * @param data - The data to send with the request.
+     */
+    request<R extends object>(verb: "GET", path: string, token?: string, data?: never): Promise<R>;
+    request<R extends object>(verb: Verb, path: string, token?: string, data?: object): Promise<R>;
+}
+/**
+ * Credentials for a user.
+ */
+export interface Credentials {
+    accessToken: string;
+    userId: string;
+    deviceId: string;
+    homeServer: string;
+    password: string | null;
+    displayName?: string;
+    username: string;
+}
+/**
+ * A client-server API for interacting with a Matrix homeserver.
+ */
+export declare class ClientServerApi extends Api {
+    constructor(baseUrl: string);
+    /**
+     * Register a user on the homeserver.
+     * @param userId - The user ID to register.
+     * @param password - The password to use for the user.
+     */
+    loginUser(userId: string, password: string): Promise<Credentials>;
+}
+//# sourceMappingURL=api.d.ts.map

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

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

package/lib/utils/api.js

@@ -0,0 +1,73 @@
+/*
+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.
+*/
+/**
+ * A generic API client.
+ */
+export class Api {
+    baseUrl;
+    _request;
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl;
+    }
+    /**
+     * Set the request context to use for making requests.
+     * @param request - The request context to use.
+     */
+    setRequest(request) {
+        this._request = request;
+    }
+    async request(verb, path, token, data) {
+        if (!this._request) {
+            throw new Error("No request context set");
+        }
+        const url = `${this.baseUrl}${path}`;
+        const res = await this._request.fetch(url, {
+            data,
+            method: verb,
+            headers: token
+                ? {
+                    Authorization: `Bearer ${token}`,
+                }
+                : undefined,
+        });
+        if (!res.ok()) {
+            throw new Error(`Request to ${url} failed with status ${res.status()}: ${JSON.stringify(await res.json())}`);
+        }
+        return res.json();
+    }
+}
+/**
+ * A client-server API for interacting with a Matrix homeserver.
+ */
+export class ClientServerApi extends Api {
+    constructor(baseUrl) {
+        super(`${baseUrl}/_matrix/client`);
+    }
+    /**
+     * Register a user on the homeserver.
+     * @param userId - The user ID to register.
+     * @param password - The password to use for the user.
+     */
+    async loginUser(userId, password) {
+        const json = await this.request("POST", "/v3/login", undefined, {
+            type: "m.login.password",
+            identifier: {
+                type: "m.id.user",
+                user: userId,
+            },
+            password: password,
+        });
+        return {
+            password,
+            accessToken: json.access_token,
+            userId: json.user_id,
+            deviceId: json.device_id,
+            homeServer: json.home_server || json.user_id.split(":").slice(1).join(":"),
+            username: userId.slice(1).split(":")[0],
+        };
+    }
+}

package/lib/utils/logger.d.ts

@@ -0,0 +1,25 @@
+import { type BrowserContext, type TestInfo } from "@playwright/test";
+import { type Readable } from "node:stream";
+/**
+ * A logger that captures console logs from pages and testcontainers.
+ */
+export declare class Logger {
+    private pages;
+    private logs;
+    /**
+     * Get a consumer function that captures logs for a given container.
+     * @param container - the human-readable name of the container.
+     */
+    getConsumer(container: string): (stream: Readable) => void;
+    /**
+     * Hook to call when a test starts.
+     * @param context - the browser context of the test.
+     */
+    onTestStarted(context: BrowserContext): Promise<void>;
+    /**
+     * Hook to call when a test finishes.
+     * @param testInfo - the info about the test that just finished.
+     */
+    onTestFinished(testInfo: TestInfo): Promise<void>;
+}
+//# sourceMappingURL=logger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAa,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C;;GAEG;AACH,qBAAa,MAAM;IACf,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,IAAI,CAA8B;IAE1C;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,IAExB,QAAQ,QAAQ;IAU5B;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,cAAc;IAyBlD;;;OAGG;IACU,cAAc,CAAC,QAAQ,EAAE,QAAQ;CAWjD"}

package/lib/utils/logger.js

@@ -0,0 +1,74 @@
+/*
+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 stripAnsi from "strip-ansi";
+/**
+ * A logger that captures console logs from pages and testcontainers.
+ */
+export class Logger {
+    pages = [];
+    logs = {};
+    /**
+     * Get a consumer function that captures logs for a given container.
+     * @param container - the human-readable name of the container.
+     */
+    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();
+            });
+        };
+    }
+    /**
+     * Hook to call when a test starts.
+     * @param context - the browser context of the test.
+     */
+    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`;
+        });
+    }
+    /**
+     * Hook to call when a test finishes.
+     * @param testInfo - the info about the test that just finished.
+     */
+    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/utils/object.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Deep copy the given object. The object MUST NOT have circular references and
+ * MUST NOT have functions.
+ * @param obj - The object to deep copy.
+ * @returns A copy of the object without any references to the original.
+ */
+export declare function deepCopy<T>(obj: T): T;
+//# sourceMappingURL=object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAErC"}

package/lib/utils/object.js

@@ -0,0 +1,15 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+/**
+ * Deep copy the given object. The object MUST NOT have circular references and
+ * MUST NOT have functions.
+ * @param obj - The object to deep copy.
+ * @returns A copy of the object without any references to the original.
+ */
+export function deepCopy(obj) {
+    return JSON.parse(JSON.stringify(obj));
+}

package/lib/utils/port.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get a free networking port on the system.
+ */
+export declare function getFreePort(): Promise<number>;
+//# sourceMappingURL=port.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"port.d.ts","sourceRoot":"","sources":["../../src/utils/port.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAQnD"}

package/lib/utils/port.js

@@ -0,0 +1,20 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2022 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 * as net from "node:net";
+/**
+ * Get a free networking port on the system.
+ */
+export async function getFreePort() {
+    return new Promise((resolve) => {
+        const srv = net.createServer();
+        srv.listen(0, () => {
+            const port = srv.address().port;
+            srv.close(() => resolve(port));
+        });
+    });
+}

package/lib/utils/rand.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generate a random base64 string of the given number of bytes.
+ * @param numBytes - The number of bytes to generate.
+ */
+export declare function randB64Bytes(numBytes: number): string;
+//# sourceMappingURL=rand.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rand.d.ts","sourceRoot":"","sources":["../../src/utils/rand.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAErD"}