@vex-chat/libvex 6.1.8 → 6.2.0

package/dist/index.d.ts

@@ -4,9 +4,9 @@
  * Commercial licenses available at vex.wtf
  */
 export { Client, DeviceApprovalRequiredError } from "./Client.js";
-export type { Channel, Channels, ClientEvents, ClientOptions, Device, DeviceRegistrationResult, Devices, Emojis, FileProgress, FileRes, Files, Invites, Keys, Me, Message, Messages, Moderation, PendingDeviceApprovalStatus, PendingDeviceRegistration, PendingDeviceRequest, Permission, Permissions, Server, Servers, Session, Sessions, User, Users, VexFile, } from "./Client.js";
+export type { Channel, Channels, ClientEvents, ClientOptions, Device, DeviceRegistrationResult, Devices, Emojis, FileProgress, FileRes, Files, Invites, Keys, Me, Message, Messages, Moderation, Passkeys, PendingDeviceApprovalStatus, PendingDeviceRegistration, PendingDeviceRequest, Permission, Permissions, Server, Servers, Session, Sessions, User, Users, VexFile, } from "./Client.js";
 export { createCodec, msgpack } from "./codec.js";
 export type { Storage } from "./Storage.js";
 export type { KeyPair, KeyStore, PreKeysCrypto, SessionCrypto, StoredCredentials, UnsavedPreKey, } from "./types/index.js";
-export type { Invite } from "@vex-chat/types";
+export type { Invite, Passkey } from "@vex-chat/types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAClE,YAAY,EACR,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,MAAM,EACN,wBAAwB,EACxB,OAAO,EACP,MAAM,EACN,YAAY,EACZ,OAAO,EACP,KAAK,EACL,OAAO,EACP,IAAI,EACJ,EAAE,EACF,OAAO,EACP,QAAQ,EACR,UAAU,EACV,2BAA2B,EAC3B,yBAAyB,EACzB,oBAAoB,EACpB,UAAU,EACV,WAAW,EACX,MAAM,EACN,OAAO,EACP,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,OAAO,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAClD,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EACR,OAAO,EACP,QAAQ,EACR,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAClE,YAAY,EACR,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,MAAM,EACN,wBAAwB,EACxB,OAAO,EACP,MAAM,EACN,YAAY,EACZ,OAAO,EACP,KAAK,EACL,OAAO,EACP,IAAI,EACJ,EAAE,EACF,OAAO,EACP,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,2BAA2B,EAC3B,yBAAyB,EACzB,oBAAoB,EACpB,UAAU,EACV,WAAW,EACX,MAAM,EACN,OAAO,EACP,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,OAAO,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAClD,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EACR,OAAO,EACP,QAAQ,EACR,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAgClE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAiClE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vex-chat/libvex",
-  "version": "6.1.8",
+  "version": "6.2.0",
   "description": "Library for communicating with xchat server.",
   "type": "module",
   "sideEffects": false,
@@ -93,8 +93,8 @@
     "msgpackr": "^1.11.9",
     "uuid": "^14.0.0",
     "zod": "^4.3.6",
-    "@vex-chat/crypto": "^4.0.1",
-    "@vex-chat/types": "^3.1.0"
+    "@vex-chat/crypto": "^5.0.0",
+    "@vex-chat/types": "^3.2.0"
   },
   "peerDependencies": {
     "better-sqlite3": ">=11.0.0"

package/src/Client.ts

@@ -26,6 +26,7 @@ import type {
     KeyBundle,
     MailWS,
     NotifyMsg,
+    Passkey,
     Permission,
     PreKeysSQL,
     PreKeysWS,
@@ -112,10 +113,18 @@ export class DeviceApprovalRequiredError extends Error {
     public readonly challenge: string;
     public readonly expiresAt: string;
     public readonly requestID: string;
+    /**
+     * Existing user's ID, when the server provides it. Lets the new
+     * (unauthenticated) device fetch the public avatar and show an
+     * "is this you?" confirmation before continuing the approval
+     * dance. Optional because older servers don't return it.
+     */
+    public readonly userID: null | string;
     constructor(args: {
         challenge: string;
         expiresAt: string;
         requestID: string;
+        userID?: null | string;
     }) {
         super(
             "Device registration requires approval from an existing device. requestID=" +
@@ -125,6 +134,7 @@ export class DeviceApprovalRequiredError extends Error {
         this.challenge = args.challenge;
         this.expiresAt = args.expiresAt;
         this.requestID = args.requestID;
+        this.userID = args.userID ?? null;
     }
 }
 
@@ -249,6 +259,10 @@ import {
     InviteCodec,
     KeyBundleCodec,
     OtkCountCodec,
+    PasskeyArrayCodec,
+    PasskeyAuthFinishResponseCodec,
+    PasskeyCodec,
+    PasskeyOptionsCodec,
     PendingDeviceRequestArrayCodec,
     PendingDeviceRequestCodec,
     PermissionArrayCodec,
@@ -307,6 +321,14 @@ export interface Channels {
  */
 export type { Device } from "@vex-chat/types";
 
+/**
+ * Public passkey record returned by `client.passkeys.list()` and
+ * `client.passkeys.finishRegistration()`. Server-private fields
+ * (credential ID, public key, COSE algorithm, signature counter) are
+ * never exposed.
+ */
+export type { Passkey } from "@vex-chat/types";
+
 /**
  * ClientOptions are the options you can pass into the client.
  */
@@ -349,6 +371,8 @@ export interface Devices {
     delete: (deviceID: string) => Promise<void>;
     /** Fetches one pending registration request by ID for the current user. */
     getRequest: (requestID: string) => Promise<null | PendingDeviceRequest>;
+    /** Lists every device belonging to the current account. */
+    list: () => Promise<Device[]>;
     /** Lists pending/processed registration requests for the current user. */
     listRequests: () => Promise<PendingDeviceRequest[]>;
     /**
@@ -429,6 +453,16 @@ export interface FileProgress {
  */
 export type FileRes = FileResponse;
 
+/**
+ * @ignore
+ */
+export interface Files {
+    /** Uploads and encrypts a file. */
+    create: (file: Uint8Array) => Promise<[FileSQL, string]>;
+    /** Downloads and decrypts a file using a file ID and key. */
+    retrieve: (fileID: string, key: string) => Promise<FileResponse | null>;
+}
+
 /**
  * Channel is a chat channel on a server.
  *
@@ -449,16 +483,6 @@ export type { Channel } from "@vex-chat/types";
  */
 export type { Server } from "@vex-chat/types";
 
-/**
- * @ignore
- */
-export interface Files {
-    /** Uploads and encrypts a file. */
-    create: (file: Uint8Array) => Promise<[FileSQL, string]>;
-    /** Downloads and decrypts a file using a file ID and key. */
-    retrieve: (fileID: string, key: string) => Promise<FileResponse | null>;
-}
-
 /**
  * @ignore
  */
@@ -524,6 +548,65 @@ export interface Message {
     timestamp: string;
 }
 
+/**
+ * Begin/finish handshakes for a passkey (WebAuthn) ceremony plus the
+ * passkey-only admin/recovery surface. The host application (a
+ * browser, Tauri webview, etc.) is responsible for invoking
+ * `navigator.credentials.create()` / `.get()` itself (e.g. via
+ * `@simplewebauthn/browser`) using the `options` returned from
+ * `begin*`, and then handing the resulting `RegistrationResponseJSON`
+ * / `AuthenticationResponseJSON` to `finish*`.
+ *
+ * @public
+ */
+export interface Passkeys {
+    /** Approves a pending device-enrollment request using the passkey session. */
+    approveDeviceRequest: (requestID: string) => Promise<Device>;
+    /** Begin a public passkey authentication ceremony for `username`. */
+    beginAuthentication: (username: string) => Promise<{
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- WebAuthn options shape varies per simplewebauthn version
+        options: any;
+        requestID: string;
+    }>;
+    /** Begin adding a new passkey to the currently authenticated account. */
+    beginRegistration: (name: string) => Promise<{
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- WebAuthn options shape varies per simplewebauthn version
+        options: any;
+        requestID: string;
+    }>;
+    /** Remove a passkey from the account. */
+    delete: (passkeyID: string) => Promise<void>;
+    /** Delete one of the account's devices using the passkey session. */
+    deleteDevice: (deviceID: string) => Promise<void>;
+    /**
+     * Finish the public passkey authentication ceremony with the
+     * assertion produced by the host. On success the client is
+     * placed in passkey-only mode: the bearer is the passkey JWT,
+     * device-only flows (mail, etc.) will not work, and the
+     * `client.passkeys.*` admin methods become available.
+     */
+    finishAuthentication: (args: {
+        requestID: string;
+        response: Record<string, unknown>;
+    }) => Promise<{
+        passkeyID: string;
+        token: string;
+        user: User;
+    }>;
+    /** Finish adding a passkey to the currently authenticated account. */
+    finishRegistration: (args: {
+        name: string;
+        requestID: string;
+        response: Record<string, unknown>;
+    }) => Promise<Passkey>;
+    /** List the account's passkeys (public shape only — no key material). */
+    list: () => Promise<Passkey[]>;
+    /** List all of the account's devices using the passkey session. */
+    listDevices: () => Promise<Device[]>;
+    /** Reject a pending device-enrollment request using the passkey session. */
+    rejectDeviceRequest: (requestID: string) => Promise<void>;
+}
+
 export type PendingDeviceApprovalStatus =
     | "approved"
     | "expired"
@@ -535,6 +618,13 @@ export interface PendingDeviceRegistration {
     expiresAt: string;
     requestID: string;
     status: "pending_approval";
+    /**
+     * Existing user's ID. Optional for backward compat with older
+     * servers that don't include it; when present, the new device can
+     * fetch the public avatar from `/avatar/:userID` (no auth required)
+     * to power an "is this you?" confirmation.
+     */
+    userID?: string | undefined;
 }
 
 export interface PendingDeviceRequest {
@@ -880,6 +970,7 @@ export class Client {
         approveRequest: this.approveDeviceRequest.bind(this),
         delete: this.deleteDevice.bind(this),
         getRequest: this.getDeviceRegistrationRequest.bind(this),
+        list: this.listDevices.bind(this),
         listRequests: this.listDeviceRegistrationRequests.bind(this),
         pollPendingRegistration: this.pollPendingDeviceRegistration.bind(this),
         register: this.registerDevice.bind(this),
@@ -953,6 +1044,7 @@ export class Client {
          */
         user: this.getUser.bind(this),
     };
+
     /**
      * Message operations (direct and group).
      *
@@ -993,7 +1085,6 @@ export class Client {
          */
         send: this.sendMessage.bind(this),
     };
-
     /**
      * Server moderation helper methods.
      */
@@ -1002,6 +1093,31 @@ export class Client {
         kick: this.kickUser.bind(this),
     };
 
+    /**
+     * Passkey ("recovery credential") methods.
+     *
+     * Passkeys are an account-bound second-class credential that can
+     * authenticate the owning user, list devices, delete devices, and
+     * approve/reject pending device-enrollment requests — i.e.
+     * provisioning + recovery. They cannot send/decrypt mail.
+     *
+     * The host app drives the WebAuthn ceremony (e.g. via
+     * `@simplewebauthn/browser`) and hands the JSON response to
+     * `finish*`.
+     */
+    public passkeys: Passkeys = {
+        approveDeviceRequest: this.passkeyApproveDeviceRequest.bind(this),
+        beginAuthentication: this.beginPasskeyAuthentication.bind(this),
+        beginRegistration: this.beginPasskeyRegistration.bind(this),
+        delete: this.deletePasskey.bind(this),
+        deleteDevice: this.passkeyDeleteDevice.bind(this),
+        finishAuthentication: this.finishPasskeyAuthentication.bind(this),
+        finishRegistration: this.finishPasskeyRegistration.bind(this),
+        list: this.listPasskeys.bind(this),
+        listDevices: this.passkeyListDevices.bind(this),
+        rejectDeviceRequest: this.passkeyRejectDeviceRequest.bind(this),
+    };
+
     /**
      * Permission-management methods for the current user.
      */
@@ -1848,6 +1964,7 @@ export class Client {
                                 challenge: pendingApproval.challenge,
                                 expiresAt: pendingApproval.expiresAt,
                                 requestID: pendingApproval.requestID,
+                                userID: pendingApproval.userID ?? null,
                             }),
                         ];
                     }
@@ -1964,6 +2081,33 @@ export class Client {
         return decodeAxios(DeviceCodec, response.data);
     }
 
+    private async beginPasskeyAuthentication(username: string): Promise<{
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- WebAuthn options shape varies per simplewebauthn version
+        options: any;
+        requestID: string;
+    }> {
+        const response = await this.http.post(
+            this.getHost() + "/auth/passkey/begin",
+            msgpack.encode({ username }),
+            { headers: { "Content-Type": "application/msgpack" } },
+        );
+        return decodeAxios(PasskeyOptionsCodec, response.data);
+    }
+
+    private async beginPasskeyRegistration(name: string): Promise<{
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- WebAuthn options shape varies per simplewebauthn version
+        options: any;
+        requestID: string;
+    }> {
+        const userID = this.getUser().userID;
+        const response = await this.http.post(
+            this.getHost() + "/user/" + userID + "/passkeys/register/begin",
+            msgpack.encode({ name }),
+            { headers: { "Content-Type": "application/msgpack" } },
+        );
+        return decodeAxios(PasskeyOptionsCodec, response.data);
+    }
+
     private censorPreKey(preKey: PreKeysSQL): PreKeysWS {
         if (!preKey.index) {
             throw new Error("Key index is required.");
@@ -2320,6 +2464,13 @@ export class Client {
         await this.database.deleteHistory(channelOrUserID);
     }
 
+    private async deletePasskey(passkeyID: string): Promise<void> {
+        const userID = this.getUser().userID;
+        await this.http.delete(
+            this.getHost() + "/user/" + userID + "/passkeys/" + passkeyID,
+        );
+    }
+
     private async deletePermission(permissionID: string): Promise<void> {
         await this.http.delete(this.getHost() + "/permission/" + permissionID);
     }
@@ -2357,7 +2508,6 @@ export class Client {
         );
         return decodeAxios(PermissionArrayCodec, res.data);
     }
-
     private async fetchUser(
         userIdentifier: string,
     ): Promise<[null | User, AxiosError | null]> {
@@ -2452,6 +2602,50 @@ export class Client {
         }
         throw new Error(`${base}${this.deviceListFailureDetail(lastErr)}`);
     }
+
+    /**
+     * Finish a passkey login and adopt the resulting JWT as the
+     * client's bearer token. After this call, `client.passkeys.*`
+     * admin methods are usable; messaging routes will continue to
+     * require a real device token.
+     */
+    private async finishPasskeyAuthentication(args: {
+        requestID: string;
+        response: Record<string, unknown>;
+    }): Promise<{
+        passkeyID: string;
+        token: string;
+        user: User;
+    }> {
+        const response = await this.http.post(
+            this.getHost() + "/auth/passkey/finish",
+            msgpack.encode(args),
+            { headers: { "Content-Type": "application/msgpack" } },
+        );
+        const decoded = decodeAxios(
+            PasskeyAuthFinishResponseCodec,
+            response.data,
+        );
+        this.setUser(decoded.user);
+        this.token = decoded.token;
+        this.http.defaults.headers.common.Authorization = `Bearer ${decoded.token}`;
+        return decoded;
+    }
+
+    private async finishPasskeyRegistration(args: {
+        name: string;
+        requestID: string;
+        response: Record<string, unknown>;
+    }): Promise<Passkey> {
+        const userID = this.getUser().userID;
+        const response = await this.http.post(
+            this.getHost() + "/user/" + userID + "/passkeys/register/finish",
+            msgpack.encode(args),
+            { headers: { "Content-Type": "application/msgpack" } },
+        );
+        return decodeAxios(PasskeyCodec, response.data);
+    }
+
     private async forward(message: Message) {
         if (this.isManualCloseInFlight()) {
             return;
@@ -2942,6 +3136,8 @@ export class Client {
         }
     }
 
+    // ── Passkeys ────────────────────────────────────────────────────────
+
     /**
      * Fresh read of the `manuallyClosing` flag for async loops — direct property checks
      * after `await` are flagged as always-false by control-flow analysis even though
@@ -2984,6 +3180,28 @@ export class Client {
         return decodeAxios(PendingDeviceRequestArrayCodec, response.data);
     }
 
+    /**
+     * Lists every device the current account owns.
+     *
+     * Uses the device-authenticated `/user/:id/devices` route. For
+     * the passkey-recovery equivalent see `client.passkeys.listDevices`.
+     */
+    private async listDevices(): Promise<Device[]> {
+        const userID = this.getUser().userID;
+        const res = await this.http.get(
+            this.getHost() + "/user/" + userID + "/devices",
+        );
+        return decodeAxios(DeviceArrayCodec, res.data);
+    }
+
+    private async listPasskeys(): Promise<Passkey[]> {
+        const userID = this.getUser().userID;
+        const response = await this.http.get(
+            this.getHost() + "/user/" + userID + "/passkeys",
+        );
+        return decodeAxios(PasskeyArrayCodec, response.data);
+    }
+
     private async markSessionVerified(sessionID: string) {
         return this.database.markSessionVerified(sessionID);
     }
@@ -3030,6 +3248,48 @@ export class Client {
         void this.database.saveMessage(message);
     };
 
+    private async passkeyApproveDeviceRequest(
+        requestID: string,
+    ): Promise<Device> {
+        const userID = this.getUser().userID;
+        const response = await this.http.post(
+            this.getHost() +
+                "/user/" +
+                userID +
+                "/passkey/devices/requests/" +
+                requestID +
+                "/approve",
+        );
+        return decodeAxios(DeviceCodec, response.data);
+    }
+
+    private async passkeyDeleteDevice(deviceID: string): Promise<void> {
+        const userID = this.getUser().userID;
+        await this.http.delete(
+            this.getHost() + "/user/" + userID + "/passkey/devices/" + deviceID,
+        );
+    }
+
+    private async passkeyListDevices(): Promise<Device[]> {
+        const userID = this.getUser().userID;
+        const response = await this.http.get(
+            this.getHost() + "/user/" + userID + "/passkey/devices",
+        );
+        return decodeAxios(DeviceArrayCodec, response.data);
+    }
+
+    private async passkeyRejectDeviceRequest(requestID: string): Promise<void> {
+        const userID = this.getUser().userID;
+        await this.http.post(
+            this.getHost() +
+                "/user/" +
+                userID +
+                "/passkey/devices/requests/" +
+                requestID +
+                "/reject",
+        );
+    }
+
     private ping() {
         if (!this.isAlive) {
             // Previous ping went unanswered — the WebSocket is half-open

package/src/codecs.ts

@@ -21,6 +21,7 @@ import {
     FileSQLSchema,
     InviteSchema,
     KeyBundleSchema,
+    PasskeySchema,
     PermissionSchema,
     ServerSchema,
     UserSchema,
@@ -80,6 +81,11 @@ export const RegisterPendingApprovalCodec = createCodec(
         expiresAt: z.string(),
         requestID: z.string(),
         status: z.literal("pending_approval"),
+        // Optional for backward compat with older servers that don't
+        // surface the existing user's ID in this response. When present,
+        // clients can use it to fetch the unauthenticated avatar and
+        // show an "is this you?" confirmation before proceeding.
+        userID: z.string().optional(),
     }),
 );
 
@@ -151,6 +157,35 @@ export const WhoamiCodec = createCodec(
 
 export const OtkCountCodec = createCodec(z.object({ count: z.number() }));
 
+// ── Passkey response codecs ────────────────────────────────────────────────
+
+export const PasskeyCodec = createCodec(PasskeySchema);
+export const PasskeyArrayCodec = createCodec(z.array(PasskeySchema));
+
+/**
+ * The shape of `/user/:id/passkeys/register/begin` and
+ * `/auth/passkey/begin` responses. `options` is the WebAuthn JSON
+ * the host hands straight to `navigator.credentials.create()` /
+ * `.get()` (via `@simplewebauthn/browser`); we don't validate its
+ * inner shape because both ends of the wire (`@simplewebauthn/server`
+ * on spire, `@simplewebauthn/browser` on the host) already do.
+ */
+export const PasskeyOptionsCodec = createCodec(
+    z.object({
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- WebAuthn options shape varies by simplewebauthn version
+        options: z.unknown() as z.ZodType<any>,
+        requestID: z.string(),
+    }),
+);
+
+export const PasskeyAuthFinishResponseCodec = createCodec(
+    z.object({
+        passkeyID: z.string(),
+        token: z.string(),
+        user: UserSchema,
+    }),
+);
+
 // ── Helper: decode axios response buffer ────────────────────────────────────
 
 /**

package/src/index.ts

@@ -23,6 +23,7 @@ export type {
     Message,
     Messages,
     Moderation,
+    Passkeys,
     PendingDeviceApprovalStatus,
     PendingDeviceRegistration,
     PendingDeviceRequest,
@@ -47,4 +48,4 @@ export type {
     UnsavedPreKey,
 } from "./types/index.js";
 // Re-export app-facing types
-export type { Invite } from "@vex-chat/types";
+export type { Invite, Passkey } from "@vex-chat/types";