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

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in the changesets repo](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
+    "changelog": "@changesets/cli/changelog",
+    "commit": false,
+    "fixed": [],
+    "linked": [],
+    "access": "public",
+    "baseBranch": "master",
+    "updateInternalDependencies": "patch",
+    "ignore": []
+}

package/.changeset/pre.json

@@ -0,0 +1,8 @@
+{
+    "mode": "pre",
+    "tag": "rc",
+    "initialVersions": {
+        "@vex-chat/libvex": "0.20.8"
+    },
+    "changesets": ["prerelease-rc"]
+}

package/.changeset/prerelease-rc.md

@@ -0,0 +1,5 @@
+---
+"@vex-chat/libvex": minor
+---
+
+Add instance-specific axios config, move API URL to utils/constants.ts, and replace yalc refs with npm refs. Upgrade to @vex-chat/crypto@1.0.0-rc.0 and @vex-chat/types@1.0.0-rc.0.

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @vex-chat/libvex
+
+## 0.21.0-rc.0
+
+### Minor Changes
+
+-   Add instance-specific axios config, move API URL to utils/constants.ts, and replace yalc refs with npm refs. Upgrade to @vex-chat/crypto@1.0.0-rc.0 and @vex-chat/types@1.0.0-rc.0.

package/README.md

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

package/RELEASING.md

@@ -0,0 +1,95 @@
+# Releasing @vex-chat/libvex
+
+This repo uses [Changesets](https://github.com/changesets/changesets) for versioning and publishing.
+
+## Dependency Chain
+
+```
+@vex-chat/types
+  └─ @vex-chat/crypto
+      └─ @vex-chat/libvex ← you are here
+          └─ vex-desktop
+```
+
+**Publish types and crypto first** if they have changes, then publish libvex.
+
+## Day-to-Day Workflow
+
+### 1. Work on a feature branch
+
+```bash
+git checkout -b my-feature
+# ... make changes ...
+```
+
+### 2. Add a changeset before pushing
+
+```bash
+npx changeset
+```
+
+This prompts you to:
+
+-   Select the package (`@vex-chat/libvex`)
+-   Choose bump type (patch / minor / major)
+-   Write a short summary of the change
+
+It creates a file in `.changeset/` — commit it with your code.
+
+### 3. Push and open a PR
+
+```bash
+git add .
+git commit -m "my feature"
+git push -u origin my-feature
+```
+
+### 4. Merge to master
+
+After merge, the **Release** GitHub Action will:
+
+1. Detect pending changesets
+2. Open a **"chore: version packages"** PR with bumped version + updated CHANGELOG.md
+3. When you merge that PR, it publishes to npm automatically
+
+## Making a Release Right Now (Locally)
+
+```bash
+npx changeset          # add a changeset if you haven't
+npx changeset version  # bumps package.json, writes CHANGELOG.md
+git add . && git commit -m "chore: version packages"
+git push
+npx changeset publish  # publishes to npm
+```
+
+## Release Candidates
+
+```bash
+npx changeset pre enter rc    # enter RC mode
+npx changeset version          # produces e.g. 0.21.0-rc.0
+npx changeset publish          # publishes with --tag rc
+
+# ... more changes + changesets ...
+npx changeset version          # produces 0.21.0-rc.1
+npx changeset publish
+
+# ready for stable:
+npx changeset pre exit
+npx changeset version          # produces 0.21.0
+npx changeset publish          # publishes as @latest
+```
+
+## GitHub Secrets Required
+
+-   `NPM_TOKEN` — npm access token with publish permission for `@vex-chat` scope
+-   `GITHUB_TOKEN` — provided automatically by GitHub Actions
+
+## Local Development
+
+You can still use `yalc` for local cross-repo development:
+
+```bash
+yarn push   # builds and pushes to yalc for local consumers
+```
+
+When publishing for real, changesets handles versioning — yalc is just for local dev loops.

package/dist/Client.d.ts

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