@vex-chat/libvex 1.0.1 → 1.1.0

package/dist/Client.d.ts

@@ -1,6 +1,7 @@
 import type { IChannel, IDevice, IEmoji, IFileResponse, IFileSQL, IInvite, IPermission, IServer, ISessionSQL } from "@vex-chat/types";
 import { AxiosError } from "axios";
-import { EventEmitter } from "events";
+import { EventEmitter } from "eventemitter3";
+import type { IClientAdapters } from "./transport/types.js";
 import type { IStorage } from "./IStorage.js";
 /**
  * IMessage is a chat message.
@@ -176,7 +177,7 @@ export interface IMe {
     /** Returns metadata for the currently authenticated device. */
     device: () => IDevice;
     /** Uploads and sets a new avatar image for the current user. */
-    setAvatar: (avatar: Buffer) => Promise<void>;
+    setAvatar: (avatar: Uint8Array) => Promise<void>;
 }
 /**
  * @ignore
@@ -292,7 +293,7 @@ export interface IDevices {
  */
 export interface IFiles {
     /** Uploads and encrypts a file. */
-    create: (file: Buffer) => Promise<[IFileSQL, string]>;
+    create: (file: Uint8Array) => Promise<[IFileSQL, string]>;
     /** Downloads and decrypts a file using a file ID and key. */
     retrieve: (fileID: string, key: string) => Promise<IFileResponse | null>;
 }
@@ -301,7 +302,7 @@ export interface IFiles {
  */
 export interface IEmojis {
     /** Uploads a custom emoji to a server. */
-    create: (emoji: Buffer, name: string, serverID: string) => Promise<IEmoji | null>;
+    create: (emoji: Uint8Array, name: string, serverID: string) => Promise<IEmoji | null>;
     /** Lists emojis available on a server. */
     retrieveList: (serverID: string) => Promise<IEmoji[]>;
     /** Fetches one emoji's metadata by ID. */
@@ -340,6 +341,10 @@ export interface IClientOptions {
     unsafeHttp?: boolean;
     /** Whether local message history should be persisted by default storage. */
     saveHistory?: boolean;
+    /** Platform-specific adapters (WebSocket + Logger). When omitted, defaults to Node.js ws. */
+    adapters?: IClientAdapters;
+    /** Platform label for device registration (e.g. "ios", "macos", "linux"). */
+    deviceName?: string;
 }
 export declare interface Client {
     /**
@@ -518,17 +523,17 @@ export declare interface Client {
  */
 export declare class Client extends EventEmitter {
     /**
-     * Loads a key file from disk.
+     * Encrypts a secret key with a password.
      *
      * Pass-through utility from `@vex-chat/crypto`.
      */
-    static loadKeyFile: (path: string, password: string) => string;
+    static encryptKeyData: (password: string, keyToSave: string, iterationOverride?: number) => Uint8Array;
     /**
-     * Saves a key file to disk.
+     * Decrypts a secret key from encrypted data produced by encryptKeyData().
      *
      * Pass-through utility from `@vex-chat/crypto`.
      */
-    static saveKeyFile: (path: string, password: string, keyToSave: string, iterationOverride?: number) => void;
+    static decryptKeyData: (keyData: Uint8Array, password: string) => string;
     /**
      * Creates and initializes a client in one step.
      *
@@ -641,6 +646,7 @@ export declare class Client extends EventEmitter {
     private dbPath;
     private conn;
     private host;
+    private adapters;
     private firstMailFetch;
     private signKeys;
     private idKeys;
@@ -653,7 +659,7 @@ export declare class Client extends EventEmitter {
     private isAlive;
     private reading;
     private fetchingMail;
-    private cookies;
+    private ax;
     private log;
     private pingInterval;
     private mailInterval?;
@@ -661,6 +667,7 @@ export declare class Client extends EventEmitter {
     private token;
     private forwarded;
     private prefixes;
+    private options?;
     private constructor();
     /**
      * Returns the current HTTP API origin with protocol.
@@ -680,7 +687,7 @@ export declare class Client extends EventEmitter {
      */
     getKeys(): IKeys;
     /**
-     * Authenticates with username/password and stores the auth token/cookie.
+     * Authenticates with username/password and stores the Bearer auth token.
      *
      * @param username Account username.
      * @param password Account password.
@@ -694,9 +701,14 @@ export declare class Client extends EventEmitter {
      */
     login(username: string, password: string): Promise<Error | null>;
     /**
-     * Returns the authorization cookie details. Throws if you don't have a
-     * valid authorization cookie.
+     * Authenticates using the device's Ed25519 signing key.
+     * No password needed — proves possession of the private key via
+     * challenge-response. Issues a short-lived (1-hour) JWT.
+     *
+     * Used by auto-login when stored credentials have a deviceKey
+     * but no valid session.
      */
+    loginWithDeviceKey(deviceID?: string): Promise<Error | null>;
     /**
      * Returns details about the currently authenticated session.
      *
@@ -718,7 +730,7 @@ export declare class Client extends EventEmitter {
      */
     logout(): Promise<void>;
     /**
-     * Connects your device to the chat. You must have an valid authorization cookie.
+     * Connects your device to the chat. You must have a valid Bearer token.
      * You can check whoami() to see before calling connect().
      */
     connect(): Promise<void>;
@@ -742,8 +754,6 @@ export declare class Client extends EventEmitter {
     private retrieveEmojiByID;
     private leaveServer;
     private kickUser;
-    private addCookie;
-    private getCookies;
     private uploadEmoji;
     private retrieveOrCreateDevice;
     private registerDevice;