@vex-chat/types 0.10.18 → 0.11.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 our repository](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/.husky/pre-commit

@@ -0,0 +1 @@
+yarn prettier && git add --all && npx lint-staged

package/RELEASING.md

@@ -0,0 +1,85 @@
+# Releasing @vex-chat/types
+
+This repo uses [Changesets](https://github.com/changesets/changesets) for versioning and publishing.
+
+## Dependency Chain
+
+```
+@vex-chat/types       ← you are here
+  └─ @vex-chat/crypto ← depends on types
+      └─ @vex-chat/libvex ← depends on crypto + types
+          └─ vex-desktop   ← depends on libvex + crypto
+```
+
+**types must be published first** when making cross-repo changes.
+
+## 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/types`)
+- 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
+
+## Release Candidates
+
+```bash
+npx changeset pre enter rc    # enter RC mode
+npx changeset version          # produces e.g. 0.12.0-rc.0
+npx changeset publish          # publishes with --tag rc
+
+# ... more changes + changesets ...
+npx changeset version          # produces 0.12.0-rc.1
+npx changeset publish
+
+# ready for stable:
+npx changeset pre exit
+npx changeset version          # produces 0.12.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/index.d.ts

@@ -1,229 +1,211 @@
-/// <reference types="node" />
 import nacl from "tweetnacl";
-export declare namespace XTypes {
-    namespace CRYPTO {
-        interface IXKeyRing {
-            identityKeys: nacl.BoxKeyPair;
-            ephemeralKeys: nacl.BoxKeyPair;
-            preKeys: IPreKeys;
-        }
-        interface IPreKeys {
-            keyPair: nacl.BoxKeyPair;
-            signature: Uint8Array;
-            index?: number;
-        }
-        interface ISession {
-            sessionID: string;
-            userID: string;
-            mode: "initiator" | "receiver";
-            SK: Uint8Array;
-            publicKey: Uint8Array;
-            fingerprint: Uint8Array;
-            lastUsed: Date;
-        }
-    }
-    namespace HTTP {
-        interface IFilePayload {
-            owner: string;
-            signed: string;
-            nonce: string;
-            file?: string;
-        }
-        interface IFileResponse {
-            details: XTypes.SQL.IFile;
-            data: Buffer;
-        }
-        enum TokenScopes {
-            Register = 0,
-            File = 1,
-            Avatar = 2,
-            Device = 3,
-            Invite = 4,
-            Emoji = 5,
-            Connect = 6
-        }
-        interface IActionToken {
-            key: string;
-            time: Date;
-            scope: TokenScopes;
-        }
-        interface IDevicePayload {
-            username: string;
-            signKey: string;
-            preKey: string;
-            preKeySignature: string;
-            preKeyIndex: number;
-            signed: string;
-            deviceName: string;
-        }
-        interface IRegistrationPayload extends IDevicePayload {
-            username: string;
-            signKey: string;
-            preKey: string;
-            preKeySignature: string;
-            preKeyIndex: number;
-            signed: string;
-            deviceName: string;
-            password: string;
-        }
-    }
-    namespace WS {
-        interface IBaseMsg {
-            transmissionID: string;
-            type: string;
-        }
-        interface ISucessMsg extends IBaseMsg {
-            data: any;
-            timestamp?: string;
-        }
-        interface IErrMsg extends IBaseMsg {
-            error: string;
-            data?: any;
-        }
-        interface IChallMsg extends IBaseMsg {
-            type: "challenge";
-            challenge: Uint8Array;
-        }
-        interface IRespMsg extends IBaseMsg {
-            type: "response";
-            signed: Uint8Array;
-        }
-        interface IReceiptMsg extends IBaseMsg {
-            nonce: Uint8Array;
-        }
-        interface IResourceMsg extends IBaseMsg {
-            resourceType: string;
-            action: string;
-            data?: any;
-        }
-        interface INotifyMsg extends IBaseMsg {
-            event: string;
-            data?: any;
-        }
-        interface IKeyBundle {
-            signKey: Uint8Array;
-            preKey: IPreKeys;
-            otk?: IPreKeys;
-        }
-        interface IPreKeys {
-            deviceID: string;
-            publicKey: Uint8Array;
-            signature: Uint8Array;
-            index: number;
-        }
-        interface IMail {
-            mailID: string;
-            mailType: MailType;
-            sender: string;
-            recipient: string;
-            cipher: Uint8Array;
-            nonce: Uint8Array;
-            extra: Uint8Array;
-            group: Uint8Array | null;
-            forward: boolean;
-            authorID: string;
-            readerID: string;
-        }
-        enum MailType {
-            initial = 0,
-            subsequent = 1
-        }
-        enum SocketAuthErrors {
-            BadSignature = 0,
-            InvalidToken = 1,
-            UserNotRegistered = 2
-        }
-    }
-    namespace SQL {
-        interface IUser {
-            userID: string;
-            username: string;
-            lastSeen: Date;
-            passwordHash: string;
-            passwordSalt: string;
-        }
-        interface IDevice {
-            deviceID: string;
-            owner: string;
-            signKey: string;
-            name: string;
-            lastLogin: string;
-            deleted: boolean;
-        }
-        interface IInvite {
-            inviteID: string;
-            serverID: string;
-            owner: string;
-            expiration: string;
-        }
-        interface IMail {
-            mailID: string;
-            mailType: WS.MailType;
-            header: string;
-            recipient: string;
-            sender: string;
-            cipher: string;
-            nonce: string;
-            extra: string;
-            time: Date;
-            group: string | null;
-            forward: boolean;
-            authorID: string;
-            readerID: string;
-        }
-        interface IEmoji {
-            emojiID: string;
-            owner: string;
-            name: string;
-        }
-        interface IFile {
-            fileID: string;
-            owner: string;
-            nonce: string;
-        }
-        interface IServer {
-            serverID: string;
-            name: string;
-            icon?: string;
-        }
-        interface IChannel {
-            channelID: string;
-            serverID: string;
-            name: string;
-        }
-        interface IPermission {
-            permissionID: string;
-            userID: string;
-            resourceID: string;
-            resourceType: string;
-            powerLevel: number;
-        }
-        interface IIdentityKeys {
-            keyID: string;
-            userID: string;
-            deviceID: string;
-            privateKey?: string;
-            publicKey: string;
-        }
-        interface IPreKeys {
-            keyID: string;
-            userID: string;
-            deviceID: string;
-            index: number;
-            privateKey?: string;
-            publicKey: string;
-            signature: string;
-        }
-        interface ISession {
-            sessionID: string;
-            userID: string;
-            deviceID: string;
-            mode: "initiator" | "receiver";
-            SK: string;
-            publicKey: string;
-            fingerprint: string;
-            lastUsed: Date;
-            verified: boolean;
-        }
-    }
+export interface IXKeyRing {
+    identityKeys: nacl.BoxKeyPair;
+    ephemeralKeys: nacl.BoxKeyPair;
+    preKeys: IPreKeysCrypto;
+}
+export interface IPreKeysCrypto {
+    keyPair: nacl.BoxKeyPair;
+    signature: Uint8Array;
+    index?: number;
+}
+export interface ISessionCrypto {
+    sessionID: string;
+    userID: string;
+    mode: "initiator" | "receiver";
+    SK: Uint8Array;
+    publicKey: Uint8Array;
+    fingerprint: Uint8Array;
+    lastUsed: Date;
+}
+export declare enum TokenScopes {
+    Register = 0,
+    File = 1,
+    Avatar = 2,
+    Device = 3,
+    Invite = 4,
+    Emoji = 5,
+    Connect = 6
+}
+export interface IActionToken {
+    key: string;
+    time: Date;
+    scope: TokenScopes;
+}
+export interface IFilePayload {
+    owner: string;
+    signed: string;
+    nonce: string;
+    file?: string;
+}
+export interface IFileResponse {
+    details: IFileSQL;
+    data: Buffer;
+}
+export interface IDevicePayload {
+    username: string;
+    signKey: string;
+    preKey: string;
+    preKeySignature: string;
+    preKeyIndex: number;
+    signed: string;
+    deviceName: string;
+}
+export interface IRegistrationPayload extends IDevicePayload {
+    password: string;
+}
+export declare enum SocketAuthErrors {
+    BadSignature = 0,
+    InvalidToken = 1,
+    UserNotRegistered = 2
+}
+export declare enum MailType {
+    initial = 0,
+    subsequent = 1
+}
+export interface IBaseMsg {
+    transmissionID: string;
+    type: string;
+}
+export interface ISucessMsg extends IBaseMsg {
+    data: any;
+    timestamp?: string;
+}
+export interface IErrMsg extends IBaseMsg {
+    error: string;
+    data?: any;
+}
+export interface IChallMsg extends IBaseMsg {
+    type: "challenge";
+    challenge: Uint8Array;
+}
+export interface IRespMsg extends IBaseMsg {
+    type: "response";
+    signed: Uint8Array;
+}
+export interface IReceiptMsg extends IBaseMsg {
+    nonce: Uint8Array;
+}
+export interface IResourceMsg extends IBaseMsg {
+    resourceType: string;
+    action: string;
+    data?: any;
+}
+export interface INotifyMsg extends IBaseMsg {
+    event: string;
+    data?: any;
+}
+export interface IKeyBundle {
+    signKey: Uint8Array;
+    preKey: IPreKeysWS;
+    otk?: IPreKeysWS;
+}
+export interface IPreKeysWS {
+    deviceID: string;
+    publicKey: Uint8Array;
+    signature: Uint8Array;
+    index: number;
+}
+export interface IMailWS {
+    mailID: string;
+    mailType: MailType;
+    sender: string;
+    recipient: string;
+    cipher: Uint8Array;
+    nonce: Uint8Array;
+    extra: Uint8Array;
+    group: Uint8Array | null;
+    forward: boolean;
+    authorID: string;
+    readerID: string;
+}
+export interface IUser {
+    userID: string;
+    username: string;
+    lastSeen: Date;
+    passwordHash: string;
+    passwordSalt: string;
+}
+export interface IDevice {
+    deviceID: string;
+    owner: string;
+    signKey: string;
+    name: string;
+    lastLogin: string;
+    deleted: boolean;
+}
+export interface IInvite {
+    inviteID: string;
+    serverID: string;
+    owner: string;
+    expiration: string;
+}
+export interface IMailSQL {
+    mailID: string;
+    mailType: MailType;
+    header: string;
+    recipient: string;
+    sender: string;
+    cipher: string;
+    nonce: string;
+    extra: string;
+    time: Date;
+    group: string | null;
+    forward: boolean;
+    authorID: string;
+    readerID: string;
+}
+export interface IEmoji {
+    emojiID: string;
+    owner: string;
+    name: string;
+}
+export interface IFileSQL {
+    fileID: string;
+    owner: string;
+    nonce: string;
+}
+export interface IServer {
+    serverID: string;
+    name: string;
+    icon?: string;
+}
+export interface IChannel {
+    channelID: string;
+    serverID: string;
+    name: string;
+}
+export interface IPermission {
+    permissionID: string;
+    userID: string;
+    resourceID: string;
+    resourceType: string;
+    powerLevel: number;
+}
+export interface IIdentityKeys {
+    keyID: string;
+    userID: string;
+    deviceID: string;
+    privateKey?: string;
+    publicKey: string;
+}
+export interface IPreKeysSQL {
+    keyID: string;
+    userID: string;
+    deviceID: string;
+    index: number;
+    privateKey?: string;
+    publicKey: string;
+    signature: string;
+}
+export interface ISessionSQL {
+    sessionID: string;
+    userID: string;
+    deviceID: string;
+    mode: "initiator" | "receiver";
+    SK: string;
+    publicKey: string;
+    fingerprint: string;
+    lastUsed: Date;
+    verified: boolean;
 }

package/dist/index.js

@@ -1,37 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XTypes = void 0;
-// HTTP api
-// tslint:disable-next-line: no-namespace
-var XTypes;
-(function (XTypes) {
-    // types for the HTTP API
-    let HTTP;
-    (function (HTTP) {
-        let TokenScopes;
-        (function (TokenScopes) {
-            TokenScopes[TokenScopes["Register"] = 0] = "Register";
-            TokenScopes[TokenScopes["File"] = 1] = "File";
-            TokenScopes[TokenScopes["Avatar"] = 2] = "Avatar";
-            TokenScopes[TokenScopes["Device"] = 3] = "Device";
-            TokenScopes[TokenScopes["Invite"] = 4] = "Invite";
-            TokenScopes[TokenScopes["Emoji"] = 5] = "Emoji";
-            TokenScopes[TokenScopes["Connect"] = 6] = "Connect";
-        })(TokenScopes = HTTP.TokenScopes || (HTTP.TokenScopes = {}));
-    })(HTTP = XTypes.HTTP || (XTypes.HTTP = {}));
-    // WS messages
-    let WS;
-    (function (WS) {
-        let MailType;
-        (function (MailType) {
-            MailType[MailType["initial"] = 0] = "initial";
-            MailType[MailType["subsequent"] = 1] = "subsequent";
-        })(MailType = WS.MailType || (WS.MailType = {}));
-        let SocketAuthErrors;
-        (function (SocketAuthErrors) {
-            SocketAuthErrors[SocketAuthErrors["BadSignature"] = 0] = "BadSignature";
-            SocketAuthErrors[SocketAuthErrors["InvalidToken"] = 1] = "InvalidToken";
-            SocketAuthErrors[SocketAuthErrors["UserNotRegistered"] = 2] = "UserNotRegistered";
-        })(SocketAuthErrors = WS.SocketAuthErrors || (WS.SocketAuthErrors = {}));
-    })(WS = XTypes.WS || (XTypes.WS = {}));
-})(XTypes = exports.XTypes || (exports.XTypes = {}));
+exports.MailType = exports.SocketAuthErrors = exports.TokenScopes = void 0;
+// ==========================================
+// HTTP API TYPES
+// ==========================================
+var TokenScopes;
+(function (TokenScopes) {
+    TokenScopes[TokenScopes["Register"] = 0] = "Register";
+    TokenScopes[TokenScopes["File"] = 1] = "File";
+    TokenScopes[TokenScopes["Avatar"] = 2] = "Avatar";
+    TokenScopes[TokenScopes["Device"] = 3] = "Device";
+    TokenScopes[TokenScopes["Invite"] = 4] = "Invite";
+    TokenScopes[TokenScopes["Emoji"] = 5] = "Emoji";
+    TokenScopes[TokenScopes["Connect"] = 6] = "Connect";
+})(TokenScopes || (exports.TokenScopes = TokenScopes = {}));
+// ==========================================
+// WEBSOCKET TYPES (Network Layer)
+// ==========================================
+var SocketAuthErrors;
+(function (SocketAuthErrors) {
+    SocketAuthErrors[SocketAuthErrors["BadSignature"] = 0] = "BadSignature";
+    SocketAuthErrors[SocketAuthErrors["InvalidToken"] = 1] = "InvalidToken";
+    SocketAuthErrors[SocketAuthErrors["UserNotRegistered"] = 2] = "UserNotRegistered";
+})(SocketAuthErrors || (exports.SocketAuthErrors = SocketAuthErrors = {}));
+var MailType;
+(function (MailType) {
+    MailType[MailType["initial"] = 0] = "initial";
+    MailType[MailType["subsequent"] = 1] = "subsequent";
+})(MailType || (exports.MailType = MailType = {}));

package/eslint.config.js

@@ -0,0 +1,14 @@
+const ts = require("@typescript-eslint/eslint-plugin");
+const parser = require("@typescript-eslint/parser");
+
+module.exports = [
+    {
+        files: ["**/*.ts"],
+        languageOptions: { parser },
+        plugins: { "@typescript-eslint": ts },
+        rules: {
+            "@typescript-eslint/interface-name-prefix": "off", 
+            "@typescript-eslint/no-explicit-any": "off"
+        }
+    }
+];

package/mise.toml

@@ -0,0 +1,3 @@
+[tools]
+node = "20"
+"npm:yarn" = "latest"

package/package.json

@@ -1,47 +1,48 @@
 {
-    "name": "@vex-chat/types",
-    "version": "0.10.18",
-    "description": "Types for vex",
-    "main": "./dist/index.js",
-    "author": "Extra <extrahash@protonmail.com>",
-    "license": "AGPL-3.0-or-later",
-    "scripts": {
-        "start": "node ./dist/index.js",
-        "build": "rm -rf ./dist/*; node ./node_modules/typescript/bin/tsc",
-        "prepack": "yarn build",
-        "prettier": "node ./node_modules/prettier/bin-prettier.js '**/*.{ts,tsx,json,md}' --tab-width 4 --trailing-comma es5 --ignore-path .gitignore  --arrow-parens always --write",
-        "lint": "./node_modules/tslint/bin/tslint src/**/*.ts{,x}",
-        "lint-fix": "./node_modules/tslint/bin/tslint src/**/*.ts{,x} --fix",
-        "prepublish": "yarn build"
-    },
-    "devDependencies": {
-        "husky": "^3.1.0",
-        "lint-staged": "^9.5.0",
-        "prettier": "^1.19.1",
-        "tslint": "^5.20.1",
-        "tslint-config-prettier": "^1.18.0",
-        "typescript": "^3.7.2"
-    },
-    "lint-staged": {
-        "src/**/*.{ts}": [
-            "./node_modules/tslint/bin/tslint -c tslint.json --fix",
-            "git add"
-        ]
-    },
-    "husky": {
-        "hooks": {
-            "pre-commit": "yarn prettier; git add --all; lint-staged"
-        }
-    },
-    "dependencies": {
-        "tweetnacl": "^1.0.3"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/vex-chat/types-js.git"
-    },
-    "bugs": {
-        "url": "https://github.com/vex-chat/types-js/issues"
-    },
-    "homepage": "https://github.com/vex-chat/types-js#readme"
+  "name": "@vex-chat/types",
+  "version": "0.11.0",
+  "description": "Types for vex",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Extra <extrahash@protonmail.com>",
+  "license": "AGPL-3.0-or-later",
+  "scripts": {
+    "start": "node ./dist/index.js",
+    "build": "rimraf dist && tsc",
+    "prepack": "yarn build",
+    "prettier": "prettier '**/*.{ts,tsx,json,md}' --ignore-path .gitignore --write",
+    "lint": "eslint src/**/*.ts",
+    "lint-fix": "eslint src/**/*.ts --fix",
+    "push": "yarn build && yalc push",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "tweetnacl": "^1.0.3"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.8",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "husky": "^9.0.0",
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.2.0",
+    "rimraf": "^5.0.0",
+    "typescript": "^5.7.0"
+  },
+  "lint-staged": {
+    "src/**/*.{ts}": [
+      "eslint --fix"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vex-chat/types-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vex-chat/types-js/issues"
+  },
+  "homepage": "https://github.com/vex-chat/types-js#readme"
 }