@peers-app/peers-sdk 0.23.14 → 0.24.0

package/dist/user-connect/connection-code.test.js

@@ -1,213 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const connection_code_1 = require("./connection-code");
-describe("connection-code", () => {
-    describe("generateConnectionCode", () => {
-        it("should generate a code with 12 characters", () => {
-            const result = (0, connection_code_1.generateConnectionCode)();
-            expect(result.code).toHaveLength(12);
-        });
-        it("should have alias of 4 characters", () => {
-            const result = (0, connection_code_1.generateConnectionCode)();
-            expect(result.alias).toHaveLength(4);
-        });
-        it("should have secret of 8 characters", () => {
-            const result = (0, connection_code_1.generateConnectionCode)();
-            expect(result.secret).toHaveLength(8);
-        });
-        it("should have code = alias + secret", () => {
-            const result = (0, connection_code_1.generateConnectionCode)();
-            expect(result.code).toBe(result.alias + result.secret);
-        });
-        it("should only contain valid Crockford Base32 characters", () => {
-            const validChars = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
-            for (let i = 0; i < 10; i++) {
-                const result = (0, connection_code_1.generateConnectionCode)();
-                for (const char of result.code) {
-                    expect(validChars).toContain(char);
-                }
-            }
-        });
-        it("should generate different codes each time", () => {
-            const codes = new Set();
-            for (let i = 0; i < 100; i++) {
-                codes.add((0, connection_code_1.generateConnectionCode)().code);
-            }
-            expect(codes.size).toBe(100);
-        });
-    });
-    describe("formatConnectionCode", () => {
-        it("should format a 12-character code as XXXX-YYYY-ZZZZ", () => {
-            expect((0, connection_code_1.formatConnectionCode)("ABCD1234EFGH")).toBe("ABCD-1234-EFGH");
-        });
-        it("should handle lowercase input", () => {
-            expect((0, connection_code_1.formatConnectionCode)("abcd1234efgh")).toBe("ABCD-1234-EFGH");
-        });
-        it("should handle input with existing dashes", () => {
-            expect((0, connection_code_1.formatConnectionCode)("ABCD-1234-EFGH")).toBe("ABCD-1234-EFGH");
-        });
-        it("should handle input with spaces", () => {
-            expect((0, connection_code_1.formatConnectionCode)("ABCD 1234 EFGH")).toBe("ABCD-1234-EFGH");
-        });
-        it("should throw for codes that are too short", () => {
-            expect(() => (0, connection_code_1.formatConnectionCode)("ABCD1234")).toThrow("must be 12 characters");
-        });
-        it("should throw for codes that are too long", () => {
-            expect(() => (0, connection_code_1.formatConnectionCode)("ABCD1234EFGH5678")).toThrow("must be 12 characters");
-        });
-    });
-    describe("parseConnectionCode", () => {
-        it("should parse a plain 12-character code", () => {
-            const result = (0, connection_code_1.parseConnectionCode)("ABCD12345678");
-            expect(result.alias).toBe("ABCD");
-            expect(result.secret).toBe("12345678");
-        });
-        it("should parse a formatted code with dashes", () => {
-            const result = (0, connection_code_1.parseConnectionCode)("ABCD-1234-5678");
-            expect(result.alias).toBe("ABCD");
-            expect(result.secret).toBe("12345678");
-        });
-        it("should handle lowercase input", () => {
-            const result = (0, connection_code_1.parseConnectionCode)("abcd-1234-5678");
-            expect(result.alias).toBe("ABCD");
-            expect(result.secret).toBe("12345678");
-        });
-        it("should handle mixed case and spaces", () => {
-            const result = (0, connection_code_1.parseConnectionCode)("AbCd 1234 5678");
-            expect(result.alias).toBe("ABCD");
-            expect(result.secret).toBe("12345678");
-        });
-        it("should throw for invalid length", () => {
-            expect(() => (0, connection_code_1.parseConnectionCode)("ABCD1234")).toThrow("must be 12 characters");
-        });
-        it("should be the inverse of formatConnectionCode", () => {
-            const original = (0, connection_code_1.generateConnectionCode)();
-            const formatted = (0, connection_code_1.formatConnectionCode)(original.code);
-            const parsed = (0, connection_code_1.parseConnectionCode)(formatted);
-            expect(parsed.alias).toBe(original.alias);
-            expect(parsed.secret).toBe(original.secret);
-        });
-    });
-    describe("encryptWithSecret and decryptWithSecret", () => {
-        it("should round-trip a simple string", () => {
-            const secret = "ABCD1234";
-            const data = "Hello, World!";
-            const encrypted = (0, connection_code_1.encryptWithSecret)(data, secret);
-            const decrypted = (0, connection_code_1.decryptWithSecret)(encrypted, secret);
-            expect(decrypted).toBe(data);
-        });
-        it("should round-trip an object", () => {
-            const secret = "ZYXW9876";
-            const data = { userId: "user123", name: "Test User", count: 42 };
-            const encrypted = (0, connection_code_1.encryptWithSecret)(data, secret);
-            const decrypted = (0, connection_code_1.decryptWithSecret)(encrypted, secret);
-            expect(decrypted).toEqual(data);
-        });
-        it("should round-trip user connect info", () => {
-            const secret = "TESTCODE";
-            const userInfo = {
-                userId: "user123",
-                publicKey: "pk_abc123",
-                publicBoxKey: "pbk_xyz789",
-                deviceId: "device456",
-            };
-            const encrypted = (0, connection_code_1.encryptWithSecret)(userInfo, secret);
-            const decrypted = (0, connection_code_1.decryptWithSecret)(encrypted, secret);
-            expect(decrypted).toEqual(userInfo);
-        });
-        it("should produce different ciphertext for same data (due to random nonce)", () => {
-            const secret = "ABCD1234";
-            const data = "Same data";
-            const encrypted1 = (0, connection_code_1.encryptWithSecret)(data, secret);
-            const encrypted2 = (0, connection_code_1.encryptWithSecret)(data, secret);
-            expect(encrypted1).not.toBe(encrypted2);
-        });
-        it("should fail decryption with wrong secret", () => {
-            const data = "Secret message";
-            const encrypted = (0, connection_code_1.encryptWithSecret)(data, "CORRECT1");
-            expect(() => (0, connection_code_1.decryptWithSecret)(encrypted, "WRONGKEY")).toThrow("Decryption failed");
-        });
-        it("should fail decryption with corrupted data", () => {
-            const secret = "ABCD1234";
-            const data = "Hello";
-            const encrypted = (0, connection_code_1.encryptWithSecret)(data, secret);
-            const corrupted = `${encrypted.slice(0, -5)}XXXXX`;
-            expect(() => (0, connection_code_1.decryptWithSecret)(corrupted, secret)).toThrow();
-        });
-    });
-    describe("generateConfirmationHash", () => {
-        const userA = {
-            userId: "userA123",
-            publicKey: "pkA",
-            publicBoxKey: "pbkA",
-            deviceId: "deviceA",
-        };
-        const userB = {
-            userId: "userB456",
-            publicKey: "pkB",
-            publicBoxKey: "pbkB",
-            deviceId: "deviceB",
-        };
-        it("should return a 4-character hash", () => {
-            const hash = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            expect(hash).toHaveLength(4);
-        });
-        it("should only contain valid Crockford Base32 characters", () => {
-            const validChars = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
-            const hash = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            for (const char of hash) {
-                expect(validChars).toContain(char);
-            }
-        });
-        it("should produce same hash regardless of argument order", () => {
-            const hashAB = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            const hashBA = (0, connection_code_1.generateConfirmationHash)(userB, userA);
-            expect(hashAB).toBe(hashBA);
-        });
-        it("should produce different hash for different users", () => {
-            const userC = {
-                userId: "userC789",
-                publicKey: "pkC",
-                publicBoxKey: "pbkC",
-                deviceId: "deviceC",
-            };
-            const hashAB = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            const hashAC = (0, connection_code_1.generateConfirmationHash)(userA, userC);
-            expect(hashAB).not.toBe(hashAC);
-        });
-        it("should be deterministic", () => {
-            const hash1 = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            const hash2 = (0, connection_code_1.generateConfirmationHash)(userA, userB);
-            expect(hash1).toBe(hash2);
-        });
-    });
-    describe("isValidConnectionCode", () => {
-        it("should return true for valid 12-character codes", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("ABCD1234EFGH")).toBe(true);
-        });
-        it("should return true for codes with dashes", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("ABCD-1234-EFGH")).toBe(true);
-        });
-        it("should return true for lowercase codes", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("abcd1234efgh")).toBe(true);
-        });
-        it("should return true for generated codes", () => {
-            const code = (0, connection_code_1.generateConnectionCode)();
-            expect((0, connection_code_1.isValidConnectionCode)(code.code)).toBe(true);
-            expect((0, connection_code_1.isValidConnectionCode)((0, connection_code_1.formatConnectionCode)(code.code))).toBe(true);
-        });
-        it("should return false for codes that are too short", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("ABCD1234")).toBe(false);
-        });
-        it("should return false for codes that are too long", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("ABCD1234EFGH5678")).toBe(false);
-        });
-        it("should return false for codes with invalid characters", () => {
-            // I, L, O, U are not in Crockford Base32
-            expect((0, connection_code_1.isValidConnectionCode)("ABCDILOU1234")).toBe(false);
-        });
-        it("should return false for empty string", () => {
-            expect((0, connection_code_1.isValidConnectionCode)("")).toBe(false);
-        });
-    });
-});

package/dist/user-connect/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./connection-code";
-export * from "./user-connect.pvars";
-export * from "./user-connect.types";

package/dist/user-connect/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./connection-code"), exports);
-__exportStar(require("./user-connect.pvars"), exports);
-__exportStar(require("./user-connect.types"), exports);

package/dist/user-connect/user-connect.pvars.d.ts

@@ -1,20 +0,0 @@
-import { type UserConnectStatus } from "./user-connect.types";
-/**
- * Shared lifetime for connection codes, aliases, invite intents, and UI countdowns.
- * Ten minutes from creation or capture.
- */
-export declare const USER_CONNECT_TTL_MS = 600000;
-/**
- * Current structured status of the local user-connect ceremony.
- * Prefer reading through {@link normalizeUserConnectStatus} when consuming
- * values that may have been persisted before the structured type existed.
- */
-export declare const userConnectStatus: import("../data/persistent-vars").PersistentVar<UserConnectStatus>;
-/**
- * Active offer connection code (12 Crockford chars). Cleared after {@link USER_CONNECT_TTL_MS}.
- */
-export declare const userConnectCodeOffer: import("../data/persistent-vars").PersistentVar<string>;
-/**
- * Active answer connection code (12 Crockford chars). Cleared after {@link USER_CONNECT_TTL_MS}.
- */
-export declare const userConnectCodeAnswer: import("../data/persistent-vars").PersistentVar<string>;

package/dist/user-connect/user-connect.pvars.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.userConnectCodeAnswer = exports.userConnectCodeOffer = exports.userConnectStatus = exports.USER_CONNECT_TTL_MS = void 0;
-const persistent_vars_1 = require("../data/persistent-vars");
-const user_connect_types_1 = require("./user-connect.types");
-/**
- * Shared lifetime for connection codes, aliases, invite intents, and UI countdowns.
- * Ten minutes from creation or capture.
- */
-exports.USER_CONNECT_TTL_MS = 600_000;
-/**
- * Current structured status of the local user-connect ceremony.
- * Prefer reading through {@link normalizeUserConnectStatus} when consuming
- * values that may have been persisted before the structured type existed.
- */
-exports.userConnectStatus = (0, persistent_vars_1.deviceVar)("userConnectStatus", {
-    defaultValue: user_connect_types_1.USER_CONNECT_IDLE_STATUS,
-});
-/**
- * Active offer connection code (12 Crockford chars). Cleared after {@link USER_CONNECT_TTL_MS}.
- */
-exports.userConnectCodeOffer = (0, persistent_vars_1.deviceVar)("userConnectCodeOffer", { defaultValue: "" });
-exports.userConnectCodeOffer.loadingPromise.then(() => {
-    let codeTimeout;
-    if ((0, exports.userConnectCodeOffer)()) {
-        (0, exports.userConnectCodeOffer)("");
-    }
-    (0, exports.userConnectStatus)(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-    exports.userConnectCodeOffer.subscribe(() => {
-        (0, exports.userConnectStatus)(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        clearTimeout(codeTimeout);
-        if ((0, exports.userConnectCodeOffer)()) {
-            codeTimeout = setTimeout(() => {
-                (0, exports.userConnectCodeOffer)("");
-            }, exports.USER_CONNECT_TTL_MS);
-        }
-    });
-});
-/**
- * Active answer connection code (12 Crockford chars). Cleared after {@link USER_CONNECT_TTL_MS}.
- */
-exports.userConnectCodeAnswer = (0, persistent_vars_1.deviceVar)("userConnectCodeAnswer", {
-    defaultValue: "",
-});
-exports.userConnectCodeAnswer.loadingPromise.then(() => {
-    let codeTimeout;
-    if ((0, exports.userConnectCodeAnswer)()) {
-        (0, exports.userConnectCodeAnswer)("");
-    }
-    (0, exports.userConnectStatus)(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-    exports.userConnectCodeAnswer.subscribe(() => {
-        (0, exports.userConnectStatus)(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        clearTimeout(codeTimeout);
-        if ((0, exports.userConnectCodeAnswer)()) {
-            codeTimeout = setTimeout(() => {
-                (0, exports.userConnectCodeAnswer)("");
-            }, exports.USER_CONNECT_TTL_MS);
-        }
-    });
-});
-exports.userConnectStatus.loadingPromise.then(() => {
-    (0, exports.userConnectStatus)(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-});

package/dist/user-connect/user-connect.pvars.test.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const user_connect_types_1 = require("./user-connect.types");
-describe("normalizeUserConnectStatus", () => {
-    it("clears legacy string and malformed persisted statuses", () => {
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)("")).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)("Error: old error")).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)("old-remote-user-id")).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)(null)).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({ kind: "connected" })).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({ kind: "error", code: "unknown" })).toEqual(user_connect_types_1.USER_CONNECT_IDLE_STATUS);
-    });
-    it("preserves valid structured statuses", () => {
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({ kind: "offer-ready" })).toEqual({
-            kind: "offer-ready",
-        });
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({ kind: "connecting", attempt: 3 })).toEqual({
-            kind: "connecting",
-            attempt: 3,
-        });
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({
-            kind: "connected",
-            remoteUserId: "remote-user",
-            remoteDeviceId: "remote-device",
-        })).toEqual({
-            kind: "connected",
-            remoteUserId: "remote-user",
-            remoteDeviceId: "remote-device",
-        });
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({
-            kind: "error",
-            code: "remote-not-waiting",
-            detail: "diagnostic",
-        })).toEqual({
-            kind: "error",
-            code: "remote-not-waiting",
-            detail: "diagnostic",
-        });
-    });
-    it("normalizes invalid connection attempt numbers to the first attempt", () => {
-        expect((0, user_connect_types_1.normalizeUserConnectStatus)({ kind: "connecting", attempt: 0 })).toEqual({
-            kind: "connecting",
-            attempt: 1,
-        });
-    });
-});

package/dist/user-connect/user-connect.types.d.ts

@@ -1,94 +0,0 @@
-/**
- * Types for the user connection flow.
- *
- * This flow allows two users to securely exchange user information
- * using a 12-character code (4-char rendezvous alias + 8-char shared secret).
- */
-/**
- * Stable protocol error codes for the user-connect exchange.
- * The UI owns presentation text; the device layer reports these codes.
- */
-export type UserConnectErrorCode = "invalid-code" | "no-route" | "not-found-or-expired" | "remote-not-waiting" | "canceled" | "protocol-error";
-/**
- * Discriminated status published by the device layer during a user-connect ceremony.
- */
-export type UserConnectStatus = {
-    kind: "idle";
-} | {
-    kind: "offer-registering";
-} | {
-    kind: "offer-ready";
-} | {
-    kind: "connecting";
-    attempt: number;
-} | {
-    kind: "connected";
-    remoteUserId: string;
-    remoteDeviceId: string;
-} | {
-    kind: "error";
-    code: UserConnectErrorCode;
-    detail?: string;
-};
-/** Default idle status for a quiet connection ceremony. */
-export declare const USER_CONNECT_IDLE_STATUS: UserConnectStatus;
-/**
- * Normalize a persisted or in-memory status value to the structured shape.
- * Clears legacy string statuses (`""`, `"Error: …"`, bare user IDs) to idle so
- * callers never treat stale strings as protocol facts.
- * @param value Raw pvar value
- * @returns A valid {@link UserConnectStatus}
- */
-export declare function normalizeUserConnectStatus(value: unknown): UserConnectStatus;
-/**
- * User information exchanged during the connection flow.
- */
-export interface IUserConnectInfo {
-    userId: string;
-    name?: string;
-    publicKey: string;
-    publicBoxKey: string;
-    deviceId: string;
-}
-/**
- * Message sent by the responder to initiate the connection.
- * The payload is encrypted with the shared secret from the connection code.
- */
-export interface IUserConnectRequest {
-    type: "user-connect-request";
-    /** User info encrypted with the shared secret */
-    encryptedUserInfo: string;
-    /** The responder's deviceId so the initiator can respond directly */
-    responseDeviceId: string;
-}
-/**
- * Message sent by the initiator in response to a connection request.
- * The payload is encrypted with the shared secret.
- */
-export interface IUserConnectResponse {
-    type: "user-connect-response";
-    /** User info encrypted with the shared secret */
-    encryptedUserInfo: string;
-}
-/**
- * Message broadcast to register a short-lived device alias.
- * Other devices store this mapping for routing purposes.
- */
-export interface IDeviceAliasMessage {
-    type: "device-alias";
-    /** The short alias (4 chars Crockford Base32) */
-    alias: string;
-    /** The actual deviceId this alias maps to */
-    deviceId: string;
-    /** TTL in milliseconds (typically 10 minutes) */
-    ttlMs: number;
-}
-/**
- * Result of a successful user connection.
- */
-export interface IUserConnectResult {
-    /** The remote user's information */
-    remoteUser: IUserConnectInfo;
-    /** Confirmation hash (first 4 chars) for visual verification */
-    confirmationHash: string;
-}

package/dist/user-connect/user-connect.types.js

@@ -1,68 +0,0 @@
-"use strict";
-/**
- * Types for the user connection flow.
- *
- * This flow allows two users to securely exchange user information
- * using a 12-character code (4-char rendezvous alias + 8-char shared secret).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_CONNECT_IDLE_STATUS = void 0;
-exports.normalizeUserConnectStatus = normalizeUserConnectStatus;
-/** Default idle status for a quiet connection ceremony. */
-exports.USER_CONNECT_IDLE_STATUS = { kind: "idle" };
-/**
- * Normalize a persisted or in-memory status value to the structured shape.
- * Clears legacy string statuses (`""`, `"Error: …"`, bare user IDs) to idle so
- * callers never treat stale strings as protocol facts.
- * @param value Raw pvar value
- * @returns A valid {@link UserConnectStatus}
- */
-function normalizeUserConnectStatus(value) {
-    if (!value || typeof value !== "object" || Array.isArray(value)) {
-        return exports.USER_CONNECT_IDLE_STATUS;
-    }
-    const candidate = value;
-    switch (candidate.kind) {
-        case "idle":
-        case "offer-registering":
-        case "offer-ready":
-            return { kind: candidate.kind };
-        case "connecting": {
-            const attempt = value.attempt;
-            return {
-                kind: "connecting",
-                attempt: typeof attempt === "number" && attempt > 0 ? attempt : 1,
-            };
-        }
-        case "connected": {
-            const remoteUserId = value.remoteUserId;
-            const remoteDeviceId = value.remoteDeviceId;
-            if (typeof remoteUserId === "string" &&
-                remoteUserId.length > 0 &&
-                typeof remoteDeviceId === "string" &&
-                remoteDeviceId.length > 0) {
-                return { kind: "connected", remoteUserId, remoteDeviceId };
-            }
-            return exports.USER_CONNECT_IDLE_STATUS;
-        }
-        case "error": {
-            const code = value.code;
-            const detail = value.detail;
-            if (code === "invalid-code" ||
-                code === "no-route" ||
-                code === "not-found-or-expired" ||
-                code === "remote-not-waiting" ||
-                code === "canceled" ||
-                code === "protocol-error") {
-                return {
-                    kind: "error",
-                    code,
-                    detail: typeof detail === "string" ? detail : undefined,
-                };
-            }
-            return exports.USER_CONNECT_IDLE_STATUS;
-        }
-        default:
-            return exports.USER_CONNECT_IDLE_STATUS;
-    }
-}