@pairlobby/local-server 0.0.0-stage → 0.20.0

package/LICENSE

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @pairlobby/local-server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Part of [PairLobby](https://github.com/PairLobby/app), built from `packages/local-server` at version 0.20.0. See that repository for documentation.
+
+Licensed under the [Elastic License 2.0](LICENSE): you may use, copy, modify and distribute it, but may not offer it to others as a hosted or managed service.

package/dist/backup.d.ts

@@ -0,0 +1,79 @@
+import type { BackupLocation } from './settings.js';
+import type { S3Client, S3Environment } from './s3.js';
+/** Where copies go. Names are `rooms-<UTC time>.sqlite`, so sorting them sorts them by age. */
+export type BackupTarget = {
+    description: string;
+    put(name: string, file: string): Promise<void>;
+    list(): Promise<string[]>;
+    /** Writes the copy to `file`. */
+    get(name: string, file: string): Promise<void>;
+    remove(name: string): Promise<void>;
+};
+export type BackupInfo = {
+    name: string;
+    takenAt: string;
+};
+export type RestoreResult = {
+    outcome: 'restored';
+    backup: BackupInfo;
+} | {
+    outcome: 'kept-local-data';
+} | {
+    outcome: 'no-backups';
+};
+export type BackupLogLine = {
+    ts: string;
+    level: 'info' | 'error';
+    event: 'backup' | 'restore';
+    name?: string;
+    bytes?: number;
+    ms?: number;
+    error?: string;
+};
+export type BackupScheduleOptions = {
+    target: BackupTarget;
+    /** How often to look for changes; a copy is only taken when something changed. Default one minute. */
+    intervalMs?: number;
+    /** Copies to keep; older ones are deleted after each new one. Default 48. */
+    keep?: number;
+    log?: (line: string) => void;
+};
+/** The store a backup schedule copies, as `SqliteRoomStore` provides it. */
+export type BackupSource = {
+    changeCount(): number;
+    snapshot(destination: string): Promise<void>;
+};
+type BackupScheduleInput = BackupScheduleOptions & {
+    source: BackupSource;
+    dataFile: string;
+    now?: () => Date;
+};
+type RestoreInput = {
+    target: BackupTarget;
+    dataFile: string;
+    log?: (line: string) => void;
+};
+export type BackupSchedule = {
+    /** Takes a copy now if anything changed since the last one; null when nothing did. */
+    run(): Promise<BackupInfo | null>;
+    /** Stops the schedule after one last copy, so a relay that is shut down loses nothing. */
+    stop(): Promise<void>;
+};
+export declare const DEFAULT_BACKUP_INTERVAL_MS = 60000;
+export declare const DEFAULT_BACKUP_KEEP = 48;
+export declare function backupName(at: Date): string;
+export declare function folderTarget(directory: string): BackupTarget;
+/** Copies are read into memory whole to upload and download them, which suits a team relay's database. */
+export declare function s3Target(bucket: string, prefix: string, client: S3Client): BackupTarget;
+/** The target for a parsed location. S3 reads its region, credentials and optional endpoint from the environment. */
+export declare function backupTarget(location: BackupLocation, environment?: S3Environment): BackupTarget;
+/**
+ * Restores the newest sound copy when the relay has no database yet. A database already on
+ * disk always wins, since it is at least as new as any copy. A copy that fails its check is
+ * skipped for the one before it; failing to reach the target at all throws, so a relay never
+ * starts empty while its rooms sit unreachable in a backup.
+ */
+export declare function restoreLatest({ target, dataFile, log }: RestoreInput): Promise<RestoreResult>;
+export declare function startBackups({ source, dataFile, target, intervalMs, keep, log, now }: BackupScheduleInput): BackupSchedule;
+export {};
+//# sourceMappingURL=backup.d.ts.map

package/dist/backup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../src/backup.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAC,QAAQ,EAAE,aAAa,EAAC,MAAM,SAAS,CAAC;AAErD,+FAA+F;AAC/F,MAAM,MAAM,YAAY,GAAG;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1B,iCAAiC;IACjC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG;IAAC,OAAO,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAC,GAAG;IAAC,OAAO,EAAE,iBAAiB,CAAA;CAAC,GAAG;IAAC,OAAO,EAAE,YAAY,CAAA;CAAC,CAAC;AAE/H,MAAM,MAAM,aAAa,GAAG;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE3J,MAAM,MAAM,qBAAqB,GAAG;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,sGAAsG;IACtG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6EAA6E;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,MAAM,YAAY,GAAG;IAAC,WAAW,IAAI,MAAM,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAAC,CAAC;AAEjG,KAAK,mBAAmB,GAAG,qBAAqB,GAAG;IAAC,MAAM,EAAE,YAAY,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;CAAC,CAAC;AAE9G,KAAK,YAAY,GAAG;IAAC,MAAM,EAAE,YAAY,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAAC,CAAC;AAE3F,MAAM,MAAM,cAAc,GAAG;IACzB,sFAAsF;IACtF,GAAG,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAClC,0FAA0F;IAC1F,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,0BAA0B,QAAS,CAAC;AAEjD,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAItC,wBAAgB,UAAU,CAAC,EAAE,EAAE,IAAI,GAAG,MAAM,CAE3C;AAOD,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,CAkB5D;AAED,0GAA0G;AAC1G,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,YAAY,CAoBvF;AAED,qHAAqH;AACrH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,cAAc,EAAE,WAAW,GAAE,aAA2B,GAAG,YAAY,CAO7G;AAoBD;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAC,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CA8BjG;AAED,wBAAgB,YAAY,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAuC,EAAE,IAA0B,EAAE,GAAG,EAAE,GAAsB,EAAC,EAAE,mBAAmB,GAAG,cAAc,CA4D9L"}

package/dist/backup.js

@@ -0,0 +1,184 @@
+//! Copies of the relay's database in a folder or an S3 bucket, taken while it runs and
+//! restored when it starts on an empty disk, so a replaced container keeps its rooms.
+import { copyFileSync, existsSync, mkdirSync, readdirSync, readFileSync, renameSync, rmSync, statSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { DatabaseSync } from 'node:sqlite';
+import { s3Client } from './s3.js';
+export const DEFAULT_BACKUP_INTERVAL_MS = 60_000;
+export const DEFAULT_BACKUP_KEEP = 48;
+const NAME = /^rooms-(\d{8})T(\d{6})(\d{3})Z\.sqlite$/;
+export function backupName(at) {
+    return `rooms-${at.toISOString().replace(/[-:.]/g, '')}.sqlite`;
+}
+function takenAt(name) {
+    const [, day = '', time = '', millis = ''] = NAME.exec(name) ?? [];
+    return `${day.slice(0, 4)}-${day.slice(4, 6)}-${day.slice(6)}T${time.slice(0, 2)}:${time.slice(2, 4)}:${time.slice(4)}.${millis}Z`;
+}
+export function folderTarget(directory) {
+    return {
+        description: directory,
+        async put(name, file) {
+            mkdirSync(directory, { recursive: true });
+            copyFileSync(file, join(directory, `${name}.partial`));
+            renameSync(join(directory, `${name}.partial`), join(directory, name));
+        },
+        async list() {
+            return existsSync(directory) ? readdirSync(directory).filter((name) => NAME.test(name)) : [];
+        },
+        async get(name, file) {
+            copyFileSync(join(directory, name), file);
+        },
+        async remove(name) {
+            rmSync(join(directory, name), { force: true });
+        }
+    };
+}
+/** Copies are read into memory whole to upload and download them, which suits a team relay's database. */
+export function s3Target(bucket, prefix, client) {
+    return {
+        description: `s3://${bucket}/${prefix}`,
+        async put(name, file) {
+            await client.putObject(`${prefix}${name}`, readFileSync(file));
+        },
+        async list() {
+            return (await client.listKeys(prefix)).map((key) => key.slice(prefix.length)).filter((name) => NAME.test(name));
+        },
+        async get(name, file) {
+            const bytes = await client.getObject(`${prefix}${name}`);
+            if (!bytes) {
+                throw new Error(`${prefix}${name} disappeared from s3://${bucket}`);
+            }
+            writeFileSync(file, bytes);
+        },
+        async remove(name) {
+            await client.deleteObject(`${prefix}${name}`);
+        }
+    };
+}
+/** The target for a parsed location. S3 reads its region, credentials and optional endpoint from the environment. */
+export function backupTarget(location, environment = process.env) {
+    if (location.kind === 'folder') {
+        return folderTarget(location.path);
+    }
+    const region = environment['AWS_REGION'] || environment['AWS_DEFAULT_REGION'] || 'us-east-1';
+    const endpoint = environment['PAIRLOBBY_BACKUP_S3_ENDPOINT'] || undefined;
+    return s3Target(location.bucket, location.prefix, s3Client({ bucket: location.bucket, region, ...(endpoint ? { endpoint } : {}) }));
+}
+function logLine(log, line) {
+    log?.(JSON.stringify({ ts: new Date().toISOString(), ...line }));
+}
+function isRelayDatabase(file) {
+    try {
+        const db = new DatabaseSync(file, { readOnly: true });
+        try {
+            const check = db.prepare('PRAGMA quick_check').get();
+            return check?.quick_check === 'ok' && db.prepare("SELECT value FROM meta WHERE key='schema_version'").get() !== undefined;
+        }
+        finally {
+            db.close();
+        }
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Restores the newest sound copy when the relay has no database yet. A database already on
+ * disk always wins, since it is at least as new as any copy. A copy that fails its check is
+ * skipped for the one before it; failing to reach the target at all throws, so a relay never
+ * starts empty while its rooms sit unreachable in a backup.
+ */
+export async function restoreLatest({ target, dataFile, log }) {
+    if (existsSync(dataFile)) {
+        return { outcome: 'kept-local-data' };
+    }
+    const names = (await target.list()).sort().reverse();
+    if (names.length === 0) {
+        return { outcome: 'no-backups' };
+    }
+    mkdirSync(dirname(dataFile), { recursive: true });
+    const partial = `${dataFile}.restore`;
+    for (const name of names) {
+        const started = Date.now();
+        await target.get(name, partial);
+        const sound = isRelayDatabase(partial);
+        // Opening the copy to check it leaves empty journal files beside it.
+        rmSync(`${partial}-wal`, { force: true });
+        rmSync(`${partial}-shm`, { force: true });
+        if (!sound) {
+            rmSync(partial, { force: true });
+            logLine(log, { level: 'error', event: 'restore', name, error: 'not a sound relay database; trying the copy before it' });
+            continue;
+        }
+        // A journal left by some other database would be replayed into this one.
+        rmSync(`${dataFile}-wal`, { force: true });
+        rmSync(`${dataFile}-shm`, { force: true });
+        renameSync(partial, dataFile);
+        logLine(log, { level: 'info', event: 'restore', name, bytes: statSync(dataFile).size, ms: Date.now() - started });
+        return { outcome: 'restored', backup: { name, takenAt: takenAt(name) } };
+    }
+    throw new Error(`none of the ${names.length} copies in ${target.description} is a sound relay database`);
+}
+export function startBackups({ source, dataFile, target, intervalMs = DEFAULT_BACKUP_INTERVAL_MS, keep = DEFAULT_BACKUP_KEEP, log, now = () => new Date() }) {
+    // What is on disk now is either new or what was just restored; only later changes need a copy.
+    let copiedAt = source.changeCount();
+    let inFlight = null;
+    let timer;
+    let stopped = false;
+    const partial = `${dataFile}.backup`;
+    const once = async () => {
+        const changes = source.changeCount();
+        if (changes === copiedAt) {
+            return null;
+        }
+        const at = now();
+        const name = backupName(at);
+        const started = Date.now();
+        try {
+            rmSync(partial, { force: true });
+            await source.snapshot(partial);
+            const bytes = statSync(partial).size;
+            await target.put(name, partial);
+            copiedAt = changes;
+            logLine(log, { level: 'info', event: 'backup', name, bytes, ms: Date.now() - started });
+            for (const old of (await target.list()).sort().reverse().slice(keep)) {
+                await target.remove(old);
+            }
+            return { name, takenAt: at.toISOString() };
+        }
+        catch (error) {
+            // The next round tries again: the change count only moves once a copy is stored.
+            logLine(log, { level: 'error', event: 'backup', name, error: error instanceof Error ? error.message : String(error) });
+            return null;
+        }
+        finally {
+            rmSync(partial, { force: true });
+        }
+    };
+    const run = () => {
+        inFlight ??= once().finally(() => {
+            inFlight = null;
+        });
+        return inFlight;
+    };
+    const schedule = () => {
+        if (stopped) {
+            return;
+        }
+        timer = setTimeout(() => {
+            void run().finally(schedule);
+        }, intervalMs);
+        timer.unref();
+    };
+    schedule();
+    return {
+        run,
+        async stop() {
+            stopped = true;
+            clearTimeout(timer);
+            await inFlight;
+            await run();
+        }
+    };
+}
+//# sourceMappingURL=backup.js.map

package/dist/backup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup.js","sourceRoot":"","sources":["../src/backup.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,sFAAsF;AAEtF,OAAO,EAAC,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAC,MAAM,SAAS,CAAC;AACpI,OAAO,EAAC,OAAO,EAAE,IAAI,EAAC,MAAM,WAAW,CAAC;AACxC,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AA2CjC,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAEjD,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAEtC,MAAM,IAAI,GAAG,yCAAyC,CAAC;AAEvD,MAAM,UAAU,UAAU,CAAC,EAAQ;IAC/B,OAAO,SAAS,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC;AACpE,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IACzB,MAAM,CAAC,EAAE,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACnE,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC;AACvI,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC1C,OAAO;QACH,WAAW,EAAE,SAAS;QACtB,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI;YAChB,SAAS,CAAC,SAAS,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;YACxC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;YACvD,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1E,CAAC;QACD,KAAK,CAAC,IAAI;YACN,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjG,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI;YAChB,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAAI;YACb,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACjD,CAAC;KACJ,CAAC;AACN,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,QAAQ,CAAC,MAAc,EAAE,MAAc,EAAE,MAAgB;IACrE,OAAO;QACH,WAAW,EAAE,QAAQ,MAAM,IAAI,MAAM,EAAE;QACvC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI;YAChB,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,CAAC;QACD,KAAK,CAAC,IAAI;YACN,OAAO,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpH,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI;YAChB,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC;YACzD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,GAAG,IAAI,0BAA0B,MAAM,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAAI;YACb,MAAM,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC;KACJ,CAAC;AACN,CAAC;AAED,qHAAqH;AACrH,MAAM,UAAU,YAAY,CAAC,QAAwB,EAAE,cAA6B,OAAO,CAAC,GAAG;IAC3F,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,WAAW,CAAC,oBAAoB,CAAC,IAAI,WAAW,CAAC;IAC7F,MAAM,QAAQ,GAAG,WAAW,CAAC,8BAA8B,CAAC,IAAI,SAAS,CAAC;IAC1E,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;AACpI,CAAC;AAED,SAAS,OAAO,CAAC,GAAyC,EAAE,IAA+B;IACvF,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,EAAC,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,eAAe,CAAC,IAAY;IACjC,IAAI,CAAC;QACD,MAAM,EAAE,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QACpD,IAAI,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,GAAG,EAAuC,CAAC;YAC1F,OAAO,KAAK,EAAE,WAAW,KAAK,IAAI,IAAI,EAAE,CAAC,OAAO,CAAC,mDAAmD,CAAC,CAAC,GAAG,EAAE,KAAK,SAAS,CAAC;QAC9H,CAAC;gBAAS,CAAC;YACP,EAAE,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAe;IACrE,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvB,OAAO,EAAC,OAAO,EAAE,iBAAiB,EAAC,CAAC;IACxC,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IACrD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAC,OAAO,EAAE,YAAY,EAAC,CAAC;IACnC,CAAC;IACD,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,GAAG,QAAQ,UAAU,CAAC;IACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QACvC,qEAAqE;QACrE,MAAM,CAAC,GAAG,OAAO,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACxC,MAAM,CAAC,GAAG,OAAO,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YAC/B,OAAO,CAAC,GAAG,EAAE,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,uDAAuD,EAAC,CAAC,CAAC;YACvH,SAAS;QACb,CAAC;QACD,yEAAyE;QACzE,MAAM,CAAC,GAAG,QAAQ,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,QAAQ,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACzC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,GAAG,EAAE,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,EAAC,CAAC,CAAC;QAChH,OAAO,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAC,EAAC,CAAC;IACzE,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,eAAe,KAAK,CAAC,MAAM,cAAc,MAAM,CAAC,WAAW,4BAA4B,CAAC,CAAC;AAC7G,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,0BAA0B,EAAE,IAAI,GAAG,mBAAmB,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,EAAsB;IAC1K,+FAA+F;IAC/F,IAAI,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACpC,IAAI,QAAQ,GAAsC,IAAI,CAAC;IACvD,IAAI,KAAiC,CAAC;IACtC,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,OAAO,GAAG,GAAG,QAAQ,SAAS,CAAC;IAErC,MAAM,IAAI,GAAG,KAAK,IAAgC,EAAE;QAChD,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACrC,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YAC/B,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YACrC,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,CAAC,GAAG,EAAE,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,EAAC,CAAC,CAAC;YACtF,KAAK,MAAM,GAAG,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnE,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,WAAW,EAAE,EAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,iFAAiF;YACjF,OAAO,CAAC,GAAG,EAAE,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,CAAC,CAAC;YACrH,OAAO,IAAI,CAAC;QAChB,CAAC;gBAAS,CAAC;YACP,MAAM,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACnC,CAAC;IACL,CAAC,CAAC;IACF,MAAM,GAAG,GAAG,GAAG,EAAE;QACb,QAAQ,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAC7B,QAAQ,GAAG,IAAI,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,GAAG,EAAE;QAClB,IAAI,OAAO,EAAE,CAAC;YACV,OAAO;QACX,CAAC;QACD,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACpB,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,EAAE,UAAU,CAAC,CAAC;QACf,KAAK,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC,CAAC;IACF,QAAQ,EAAE,CAAC;IACX,OAAO;QACH,GAAG;QACH,KAAK,CAAC,IAAI;YACN,OAAO,GAAG,IAAI,CAAC;YACf,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,QAAQ,CAAC;YACf,MAAM,GAAG,EAAE,CAAC;QAChB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/dist/check.d.ts

@@ -0,0 +1,12 @@
+export type CheckStep = {
+    name: string;
+    ok: boolean;
+    detail: string;
+};
+export type CheckOptions = {
+    /** Sent when creating the room; needed when the relay requires a create token. */
+    createToken?: string;
+    fetch?: typeof fetch;
+};
+export declare function checkRelay(url: string, { createToken, fetch: fetcher }?: CheckOptions): Promise<CheckStep[]>;
+//# sourceMappingURL=check.d.ts.map

package/dist/check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../src/check.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,SAAS,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC;AAEpE,MAAM,MAAM,YAAY,GAAG;IACvB,kFAAkF;IAClF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB,CAAC;AAcF,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,EAAC,WAAW,EAAE,KAAK,EAAE,OAAe,EAAC,GAAE,YAAiB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CA+F5H"}

package/dist/check.js

@@ -0,0 +1,102 @@
+//! Checks a deployed relay from the outside, the way a client will use it: health, the
+//! address invites show, whether creating rooms needs the token, then one throwaway room
+//! through create, join, send, read and delete. Nothing is left behind on success.
+import { newCredential, newId } from '@pairlobby/protocol';
+import { CREATE_TOKEN_HEADER } from '@pairlobby/server-core';
+export async function checkRelay(url, { createToken, fetch: fetcher = fetch } = {}) {
+    const origin = new URL(url).origin;
+    const steps = [];
+    let sequence = 0;
+    // Each request carries an id the relay writes in its request log, so a failure can be found there.
+    const call = (path, init = {}) => {
+        const headers = new Headers(init.headers);
+        headers.set('x-request-id', `pairlobby-check-${++sequence}`);
+        if (init.body) {
+            headers.set('content-type', 'application/json');
+        }
+        return fetcher(`${origin}${path}`, { ...init, headers, signal: AbortSignal.timeout(10_000) });
+    };
+    const step = (name, ok, detail) => {
+        steps.push({ name, ok, detail });
+        return ok;
+    };
+    const attempt = async (name, work) => {
+        try {
+            return await work();
+        }
+        catch (error) {
+            return step(name, false, error instanceof Error ? error.message : String(error));
+        }
+    };
+    const healthy = await attempt('health', async () => {
+        const response = await call('/health');
+        const body = (await response.json().catch(() => ({})));
+        return step('health', response.ok && body.service === 'pairlobby-relay' && body.ready === true, response.ok ? `PairLobby relay ${body.version ?? 'of an unknown version'}` : `GET /health answered ${response.status}; is this the relay, or something in front of it?`);
+    });
+    if (!healthy) {
+        return steps;
+    }
+    await attempt('invite address', async () => {
+        const body = (await (await call('/v1/server')).json());
+        const shown = body.shareUrls ?? [];
+        return step('invite address', shown.includes(origin), shown.includes(origin) ? `invites show ${origin}` : `invites show ${shown.join(', ') || 'no address'}; start the relay with PAIRLOBBY_PUBLIC_URL=${origin}`);
+    });
+    const credentials = { controllerCredential: newCredential('controller'), participantCredential: newCredential('participant') };
+    const createBody = JSON.stringify({ name: `relay-check-${new Date().toISOString().slice(0, 19)}`, displayName: 'relay-check', kind: 'human', ...credentials });
+    let created = null;
+    const opened = await attempt('create token', async () => {
+        const anonymous = await call('/v1/rooms', { method: 'POST', body: createBody });
+        if (anonymous.status === 201) {
+            created = (await anonymous.json());
+            return step('create token', true, 'not required: anyone who reaches this address can create rooms');
+        }
+        if (anonymous.status !== 401) {
+            return step('create token', false, `creating a room answered ${anonymous.status}`);
+        }
+        if (!createToken) {
+            step('create token', true, 'required, and the relay refused a room without it');
+            return step('create room', false, 'set PAIRLOBBY_CREATE_TOKEN to the relay\'s token to check the rest');
+        }
+        const withToken = await call('/v1/rooms', { method: 'POST', body: createBody, headers: { [CREATE_TOKEN_HEADER]: createToken } });
+        if (withToken.status !== 201) {
+            return step('create token', false, `required, and the relay answered ${withToken.status} to the token given; is it the same one?`);
+        }
+        created = (await withToken.json());
+        return step('create token', true, 'required, refused without it and accepted with it');
+    });
+    const room = created;
+    if (!opened || !room) {
+        return steps;
+    }
+    const roomPath = `/v1/rooms/${room.room.roomId}`;
+    try {
+        const joinerCredential = newCredential('participant');
+        const joined = await attempt('join', async () => {
+            const response = await call('/v1/invites/redeem', { method: 'POST', body: JSON.stringify({ code: room.invite.code, displayName: 'relay-check-joiner', kind: 'agent', participantCredential: joinerCredential, attemptId: newId('attempt'), attemptSecret: newCredential('attempt') }) });
+            return step('join', response.ok, response.ok ? 'joined with the invite code' : `redeeming the invite answered ${response.status}`);
+        });
+        if (!joined) {
+            return steps;
+        }
+        const text = `relay check ${newId('event')}`;
+        const sent = await attempt('send', async () => {
+            const response = await call(`${roomPath}/events`, { method: 'POST', body: JSON.stringify({ type: 'message', payload: { text }, idempotencyKey: newId('event') }), headers: { authorization: `Bearer ${credentials.participantCredential}` } });
+            return step('send', response.status === 201, response.status === 201 ? 'sent a message' : `sending answered ${response.status}`);
+        });
+        if (sent) {
+            await attempt('read', async () => {
+                const response = await call(`${roomPath}/events?after=0`, { headers: { authorization: `Bearer ${joinerCredential}` } });
+                const found = response.ok && (await response.json()).events.some((event) => event.type === 'message' && event.payload?.text === text);
+                return step('read', found, found ? 'the other member read it back' : `reading answered ${response.status} without the message`);
+            });
+        }
+    }
+    finally {
+        await attempt('delete', async () => {
+            const response = await call(roomPath, { method: 'DELETE', headers: { authorization: `Bearer ${credentials.controllerCredential}` } });
+            return step('delete', response.status === 204, response.status === 204 ? 'deleted the test room' : `deleting the test room answered ${response.status}; it stays on the relay`);
+        });
+    }
+    return steps;
+}
+//# sourceMappingURL=check.js.map

package/dist/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../src/check.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,yFAAyF;AACzF,mFAAmF;AAEnF,OAAO,EAAC,aAAa,EAAE,KAAK,EAAC,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAC,mBAAmB,EAAC,MAAM,wBAAwB,CAAC;AAsB3D,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW,EAAE,EAAC,WAAW,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,KAAkB,EAAE;IAClG,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,mGAAmG;IACnG,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,OAAoB,EAAE,EAAE,EAAE;QAClD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7D,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,EAAE,EAAC,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAC,CAAC,CAAC;IAChG,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAW,EAAE,MAAc,EAAE,EAAE;QACvD,KAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,CAAC;IACd,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,KAAK,EAAE,IAAY,EAAE,IAA4B,EAAE,EAAE;QACjE,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACrF,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAe,CAAC;QACrE,OAAO,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,KAAK,iBAAiB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,IAAI,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC,CAAC,CAAC,wBAAwB,QAAQ,CAAC,MAAM,mDAAmD,CAAC,CAAC;IAC7Q,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,OAAO,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,CAAe,CAAC;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,+CAA+C,MAAM,EAAE,CAAC,CAAC;IACvN,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GAAoB,EAAC,oBAAoB,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,qBAAqB,EAAE,aAAa,CAAC,aAAa,CAAC,EAAC,CAAC;IAC9I,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,eAAe,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAC7J,IAAI,OAAO,GAAuB,IAAI,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAC,CAAC,CAAC;QAC9E,IAAI,SAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,CAAgB,CAAC;YAClD,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,gEAAgE,CAAC,CAAC;QACxG,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,4BAA4B,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,mDAAmD,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,oEAAoE,CAAC,CAAC;QAC5G,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,EAAC,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAC,EAAC,CAAC,CAAC;QAC7H,IAAI,SAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,oCAAoC,SAAS,CAAC,MAAM,0CAA0C,CAAC,CAAC;QACvI,CAAC;QACD,OAAO,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,CAAgB,CAAC;QAClD,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,mDAAmD,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,OAA6B,CAAC;IAC3C,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,aAAa,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IACjD,IAAI,CAAC;QACD,MAAM,gBAAgB,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,oBAAoB,EAAE,IAAI,EAAE,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,aAAa,EAAE,aAAa,CAAC,SAAS,CAAC,EAAC,CAAC,EAAC,CAAC,CAAC;YACrR,OAAO,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,iCAAiC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACvI,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,MAAM,IAAI,GAAG,eAAe,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,QAAQ,SAAS,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,EAAC,IAAI,EAAC,EAAE,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,EAAC,CAAC,EAAE,OAAO,EAAE,EAAC,aAAa,EAAE,UAAU,WAAW,CAAC,qBAAqB,EAAE,EAAC,EAAC,CAAC,CAAC;YACvO,OAAO,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,oBAAoB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACrI,CAAC,CAAC,CAAC;QACH,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;gBAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,QAAQ,iBAAiB,EAAE,EAAC,OAAO,EAAE,EAAC,aAAa,EAAE,UAAU,gBAAgB,EAAE,EAAC,EAAC,CAAC,CAAC;gBACpH,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,IAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC;gBACtJ,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,oBAAoB,QAAQ,CAAC,MAAM,sBAAsB,CAAC,CAAC;YACpI,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;YAAS,CAAC;QACP,MAAM,OAAO,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;YAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAC,aAAa,EAAE,UAAU,WAAW,CAAC,oBAAoB,EAAE,EAAC,EAAC,CAAC,CAAC;YAClI,OAAO,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,mCAAmC,QAAQ,CAAC,MAAM,yBAAyB,CAAC,CAAC;QACpL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './network.js';
+export * from './schema.js';
+export * from './server.js';
+export * from './sqlite-store.js';
+export * from './request-log.js';
+export * from './backup.js';
+export * from './s3.js';
+export * from './settings.js';
+export * from './check.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+export * from './network.js';
+export * from './schema.js';
+export * from './server.js';
+export * from './sqlite-store.js';
+export * from './request-log.js';
+export * from './backup.js';
+export * from './s3.js';
+export * from './settings.js';
+export * from './check.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/dist/network.d.ts

@@ -0,0 +1,23 @@
+/** Where this device's relay accepts connections from. */
+export type RelayNetwork = 'off' | 'tailscale' | 'lan';
+export declare const RELAY_SERVICE = "_pairlobby._tcp.local";
+/** Tailscale assigns addresses from 100.64.0.0/10 and fd7a:115c:a1e0::/48. */
+export declare function isTailscaleAddress(address: string): boolean;
+export declare function isLoopbackAddress(address: string): boolean;
+/**
+ * This device, a private or link-local network address, or a Tailscale address:
+ * what may join a room by name when the room allows it. A request through a proxy
+ * arrives from the proxy, so a public URL in front of the relay is judged by the
+ * proxy's address; keep such rooms closed to the local network.
+ */
+export declare function isLocalNetworkAddress(address: string): boolean;
+/** This machine's non-internal IPv4 addresses, optionally only its Tailscale ones. */
+export declare function ownAddresses(tailscaleOnly?: boolean): string[];
+/**
+ * Answers mDNS queries for PairLobby relays with this relay's port and current
+ * LAN addresses. Returns a function that stops answering.
+ */
+export declare function advertiseRelay(port: number): () => void;
+/** Relay addresses announced on the local network within `timeoutMs`, as `http://ip:port` URLs. */
+export declare function browseRelays(timeoutMs?: number, signal?: AbortSignal): Promise<string[]>;
+//# sourceMappingURL=network.d.ts.map

package/dist/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AASA,0DAA0D;AAC1D,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,WAAW,GAAG,KAAK,CAAC;AAEvD,eAAO,MAAM,aAAa,0BAA0B,CAAC;AAMrD,8EAA8E;AAC9E,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAO3D;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAG1D;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAW9D;AAED,sFAAsF;AACtF,wBAAgB,YAAY,CAAC,aAAa,UAAQ,GAAG,MAAM,EAAE,CAE5D;AAOD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,IAAI,CA4BvD;AAED,mGAAmG;AACnG,wBAAgB,YAAY,CAAC,SAAS,SAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAwDtF"}