@vex-chat/libvex 0.21.0-rc.0 → 0.27.1

package/README.md

@@ -8,46 +8,43 @@ nodejs for interfacing with xchat server. Use it for a client, a bot, whatever y
 
 ## Quickstart
 
-The client now uses an asynchronous factory pattern. You must use `Client.create()` instead of `new Client()`.
-
-```typescript
+```ts
 import { Client } from "@vex-chat/libvex";
 
 async function main() {
-    // Generate a secret key (save this securely, it is your identity)
+    // generate a secret key to use, save this somewhere permanent
     const privateKey = Client.generateSecretKey();
 
-    // Client.create handles the database connection and crypto initialization for you.
-    const client = await Client.create(privateKey, {
-        host: "api.vex.wtf",
-        logLevel: "info",
-    });
-
-    // Register (only needed once per new key)
-    // await client.register("Username", "Password123");
+    const client = new Client(privateKey);
 
-    // Login
-    await client.login("Username", "Password123");
-
-    // Connect to the WebSocket
-    // This establishes the real-time connection.
-    await client.connect();
+    /* the ready event is emitted when init() is finished.
+    you must wait until this event fires to perform 
+    registration or login. */
+    client.on("ready", async () => {
+        // you must register once before you can log in
+        await client.register(Client.randomUsername());
+        await client.login();
+    });
 
-    // Listen for events
-    client.on("connected", async () => {
-        console.log("Connected as", client.toString());
-        const me = client.me.user();
+    /* The authed event fires when login() successfully completes
+    and the server indicates you are authorized. You must wait to
+    perform any operations besides register() and login() until
+    this occurs. */
+    client.on("authed", async () => {
+        const me = await client.users.me();
 
-        // Send a message
+        // send a message
         await client.messages.send(me.userID, "Hello world!");
     });
 
+    /* Outgoing and incoming messages are emitted here. */
     client.on("message", (message) => {
-        console.log(
-            `Received message from ${message.sender}:`,
-            message.message
-        );
+        console.log("message:", message);
     });
+
+    /* you must call init() to initialize the keyring and 
+    start the client. */
+    client.init();
 }
 
 main();

package/dist/Client.d.ts

@@ -1,8 +1,10 @@
-import * as XTypes from "@vex-chat/types";
+/// <reference types="node" />
+import { XTypes } from "@vex-chat/types";
+import { AxiosError } from "axios";
 import { EventEmitter } from "events";
 import { IStorage } from "./IStorage";
 interface ICensoredUser {
-    lastSeen: Date;
+    lastSeen: number;
     userID: string;
     username: string;
 }
@@ -26,7 +28,7 @@ export interface IMessage {
 /**
  * IPermission is a permission to a resource.
  */
-export interface IPermission extends XTypes.IPermission {
+export interface IPermission extends XTypes.SQL.IPermission {
 }
 /**
  * IKeys are a pair of ed25519 public and private keys,
@@ -36,7 +38,7 @@ export interface IKeys {
     public: string;
     private: string;
 }
-export interface IDevice extends XTypes.IDevice {
+export interface IDevice extends XTypes.SQL.IDevice {
 }
 /**
  * IUser is a single user on the vex platform.
@@ -46,41 +48,41 @@ export interface IUser extends ICensoredUser {
 /**
  * ISession is an end to end encryption session with another peer.
  */
-export interface ISession extends XTypes.ISessionSQL {
+export interface ISession extends XTypes.SQL.ISession {
 }
 /**
  * IChannel is a chat channel on a server.
  */
-export interface IChannel extends XTypes.IChannel {
+export interface IChannel extends XTypes.SQL.IChannel {
 }
 /**
  * IServer is a single chat server.
  */
-export interface IServer extends XTypes.IServer {
+export interface IServer extends XTypes.SQL.IServer {
 }
 /**
  * Ifile is an uploaded encrypted file.
  */
-export interface IFile extends XTypes.IFileSQL {
+export interface IFile extends XTypes.SQL.IFile {
 }
 /**
  * IFileRes is a server response to a file retrieval request.
  */
-export interface IFileRes extends XTypes.IFileResponse {
+export interface IFileRes extends XTypes.HTTP.IFileResponse {
 }
 /**
  * @ignore
  */
 interface IMe {
     user: () => ICensoredUser;
-    device: () => XTypes.IDevice;
+    device: () => XTypes.SQL.IDevice;
     setAvatar: (avatar: Buffer) => Promise<void>;
 }
 /**
  * @ignore
  */
 interface IUsers {
-    retrieve: (userID: string) => Promise<[IUser | null, Error | null]>;
+    retrieve: (userID: string) => Promise<[IUser | null, AxiosError | null]>;
     familiars: () => Promise<IUser[]>;
 }
 /**
@@ -98,9 +100,9 @@ interface IMessages {
  * @ignore
  */
 interface IServers {
-    retrieve: () => Promise<XTypes.IServer[]>;
-    retrieveByID: (serverID: string) => Promise<XTypes.IServer | null>;
-    create: (name: string) => Promise<XTypes.IServer>;
+    retrieve: () => Promise<XTypes.SQL.IServer[]>;
+    retrieveByID: (serverID: string) => Promise<XTypes.SQL.IServer | null>;
+    create: (name: string) => Promise<XTypes.SQL.IServer>;
     delete: (serverID: string) => Promise<void>;
     leave: (serverID: string) => Promise<void>;
 }
@@ -109,30 +111,30 @@ interface IServers {
  */
 interface IModeration {
     kick: (userID: string, serverID: string) => Promise<void>;
-    fetchPermissionList: (serverID: string) => Promise<XTypes.IPermission[]>;
+    fetchPermissionList: (serverID: string) => Promise<XTypes.SQL.IPermission[]>;
 }
 /**
  * @ignore
  */
 interface IPermissions {
-    retrieve: () => Promise<XTypes.IPermission[]>;
+    retrieve: () => Promise<XTypes.SQL.IPermission[]>;
     delete: (permissionID: string) => Promise<void>;
 }
 /**
  * @ignore
  */
 interface IInvites {
-    redeem: (inviteID: string) => Promise<XTypes.IPermission>;
-    create: (serverID: string, duration: string) => Promise<XTypes.IInvite>;
-    retrieve: (serverID: string) => Promise<XTypes.IInvite[]>;
+    redeem: (inviteID: string) => Promise<XTypes.SQL.IPermission>;
+    create: (serverID: string, duration: string) => Promise<XTypes.SQL.IInvite>;
+    retrieve: (serverID: string) => Promise<XTypes.SQL.IInvite[]>;
 }
 /**
  * @ignore
  */
 interface IChannels {
-    retrieve: (serverID: string) => Promise<XTypes.IChannel[]>;
-    retrieveByID: (channelID: string) => Promise<XTypes.IChannel | null>;
-    create: (name: string, serverID: string) => Promise<XTypes.IChannel>;
+    retrieve: (serverID: string) => Promise<XTypes.SQL.IChannel[]>;
+    retrieveByID: (channelID: string) => Promise<XTypes.SQL.IChannel | null>;
+    create: (name: string, serverID: string) => Promise<XTypes.SQL.IChannel>;
     delete: (channelID: string) => Promise<void>;
     userList: (channelID: string) => Promise<IUser[]>;
 }
@@ -140,32 +142,32 @@ interface IChannels {
  * @ignore
  */
 interface ISessions {
-    retrieve: () => Promise<XTypes.ISessionSQL[]>;
-    verify: (session: XTypes.ISessionSQL) => string;
+    retrieve: () => Promise<XTypes.SQL.ISession[]>;
+    verify: (session: XTypes.SQL.ISession) => string;
     markVerified: (fingerprint: string) => Promise<void>;
 }
 /**
  * @ignore
  */
 interface IDevices {
-    retrieve: (deviceIdentifier: string) => Promise<XTypes.IDevice | null>;
-    register: () => Promise<XTypes.IDevice | null>;
+    retrieve: (deviceIdentifier: string) => Promise<XTypes.SQL.IDevice | null>;
+    register: () => Promise<XTypes.SQL.IDevice | null>;
     delete: (deviceID: string) => Promise<void>;
 }
 /**
  * @ignore
  */
 interface IFiles {
-    create: (file: Buffer) => Promise<[XTypes.IFileSQL, string]>;
-    retrieve: (fileID: string, key: string) => Promise<XTypes.IFileResponse | null>;
+    create: (file: Buffer) => Promise<[XTypes.SQL.IFile, string]>;
+    retrieve: (fileID: string, key: string) => Promise<XTypes.HTTP.IFileResponse | null>;
 }
 /**
  * @ignore
  */
 interface IEmoji {
-    create: (emoji: Buffer, name: string, serverID: string) => Promise<XTypes.IEmoji | null>;
-    retrieveList: (serverID: string) => Promise<XTypes.IEmoji[]>;
-    retrieve: (emojiID: string) => Promise<XTypes.IEmoji | null>;
+    create: (emoji: Buffer, name: string, serverID: string) => Promise<XTypes.SQL.IEmoji | null>;
+    retrieveList: (serverID: string) => Promise<XTypes.SQL.IEmoji[]>;
+    retrieve: (emojiID: string) => Promise<XTypes.SQL.IEmoji | null>;
 }
 export interface IFileProgress {
     token: string;
@@ -185,7 +187,6 @@ export interface IClientOptions {
     dbLogLevel?: "error" | "warn" | "info" | "http" | "verbose" | "debug" | "silly";
     unsafeHttp?: boolean;
     saveHistory?: boolean;
-    token?: string;
 }
 export declare interface Client {
     /**
@@ -358,8 +359,8 @@ export declare interface Client {
  */
 export declare class Client extends EventEmitter {
     static loadKeyFile: (path: string, password: string) => string;
-    static saveKeyFile: (path: string, password: string, keyToSave: string, iterationOverride?: number) => void;
-    static create: (privateKey?: string, options?: IClientOptions, storage?: IStorage) => Promise<Client>;
+    static saveKeyFile: (path: string, password: string, keyToSave: string, iterationOverride?: number | undefined) => void;
+    static create: (privateKey?: string | undefined, options?: IClientOptions | undefined, storage?: IStorage | undefined) => Promise<Client>;
     /**
      * Generates an ed25519 secret key as a hex string.
      *
@@ -439,19 +440,10 @@ export declare class Client extends EventEmitter {
     private mailInterval?;
     private manuallyClosing;
     private token;
-    private deviceToken;
     private forwarded;
     private prefixes;
-    private ax;
     private constructor();
-    private getTokenPath;
-    private saveToken;
-    private loadToken;
-    clearToken(): void;
     getHost(): string;
-    private getDeviceTokenPath;
-    private saveDeviceToken;
-    private loadDeviceToken;
     /**
      * Manually closes the client. Emits the closed event on successful shutdown.
      */
@@ -493,6 +485,8 @@ export declare class Client extends EventEmitter {
     private retrieveEmojiByID;
     private leaveServer;
     private kickUser;
+    private addCookie;
+    private getCookies;
     private uploadEmoji;
     private retrieveOrCreateDevice;
     private registerDevice;