@imaentity/selfjs 4.1.0 → 4.2.0

package/docs.md

@@ -57,10 +57,8 @@ Promise<Object | null>
 ```javascript
 const user = await self.validateToken(token);
 
-if(user)
-    console.log(`Logged in as ${user.username}`);
-else
-    console.log("Invalid token");
+if(user) console.log(`Logged in as ${user.username}`);
+else console.log("Invalid token");
 ```
 
 ## `createToken(options)`
@@ -112,12 +110,9 @@ const login = await self.createToken({
     password: "password"
 });
 
-if(!login)
-    throw new Error("Login failed");
-
-if(!login.mfaRequired) {
-    console.log(login.token);
-} else {
+if(!login) throw new Error("Login failed");
+if(!login.mfaRequired) console.log(login.token);
+else {
     console.log("MFA methods:", login.mfaMethods);
 
     const result = await login.confirmMFA("totp", {
@@ -152,7 +147,6 @@ Number
 
 ```javascript
 const timestamp = self.snowflakeToUTC("1329029486758592595");
-
 console.log(new Date(timestamp));
 ```
 
@@ -177,7 +171,6 @@ String
 
 ```javascript
 const snowflake = self.UTCToSnowflake(Date.now());
-
 console.log(snowflake);
 ```
 
@@ -202,7 +195,6 @@ const client = new self.Client({
     },
 
     debugLogs: true,
-
     intents: 0
 });
 ```
@@ -441,7 +433,7 @@ Gets recent messages from a channel.
 ### Returns
 
 ```javascript
-Promise<Array>
+Promise<Array<Object>>
 ```
 
 Messages are returned from newest to oldest.
@@ -537,7 +529,7 @@ This can contain both direct messages and group DMs.
 ### Returns
 
 ```javascript
-Promise<Object>
+Promise<Array<Object>>
 ```
 
 ### Example
@@ -858,7 +850,6 @@ The current channel object.
 
 ```javascript
 const channel = await client.getChannelObject("123456789");
-
 console.log(channel);
 ```
 
@@ -885,7 +876,6 @@ The DM channel object.
 
 ```javascript
 const channel = await client.getDMChannel("123456789");
-
 console.log(channel);
 ```
 
@@ -911,7 +901,6 @@ The DM channel object.
 
 ```javascript
 const channel = await client.getDMChannel("123456789");
-
 console.log(channel);
 ```
 
@@ -977,6 +966,128 @@ const profile = await client.getUserProfile({
 });
 ```
 
+# User Settings
+
+## `client.getUserSettings()`
+
+Gets the `PreloadedUserSettings` protobuf containing general account settings.  
+The protobuf is decoded into a JavaScript object.
+
+### Returns
+
+```javascript
+Promise<Object>
+```
+
+### Example
+
+```javascript
+const settings = await client.getUserSettings();
+console.log(settings);
+```
+
+## `client.getFrecencySettings()`
+
+Gets the `FrecencyUserSettings` protobuf.  
+This contains frecency and favorite data for GIFs, emojis, stickers, and similar items.  
+The protobuf is decoded into a JavaScript object.
+
+### Returns
+
+```javascript
+Promise<Object>
+```
+
+### Example
+
+```javascript
+const settings = await client.getFrecencySettings();
+console.log(settings);
+```
+
+---
+
+## `client.updateUserSettings(buf)`
+
+Updates the `PreloadedUserSettings` protobuf.  
+The provided object is encoded into a protobuf and sent to Discord.
+
+### Parameters
+
+| Name  | Type     | Description        |
+| ----- | -------- | ------------------ |
+| `buf` | `Object` | New settings data. |
+
+### Returns
+
+```javascript
+Promise<Object>
+```
+
+The updated settings.
+
+### Example
+
+```javascript
+const settings = await client.updateUserSettings({
+    // settings data
+});
+
+console.log(settings);
+```
+
+## `client.updateFrecencySettings(buf)`
+
+Updates the `FrecencyUserSettings` protobuf.  
+The provided object is encoded into a protobuf and sent to Discord.  
+This controls frecency and favorite data for GIFs, emojis, stickers, and similar items.
+
+### Parameters
+
+| Name  | Type     | Description                 |
+| ----- | -------- | --------------------------- |
+| `buf` | `Object` | New frecency settings data. |
+
+### Returns
+
+```javascript
+Promise<Object>
+```
+
+The updated settings.
+
+### Example
+
+```javascript
+const settings = await client.updateFrecencySettings({
+    // frecency settings data
+});
+
+console.log(settings);
+```
+
+# Servers
+
+## `client.getServerList()`
+
+Gets the full list of servers the account is currently in.
+
+### Returns
+
+```javascript
+Promise<Array<Object>>
+```
+
+An array containing the server objects.
+
+### Example
+
+```javascript
+const servers = await client.getServerList();
+
+console.log(servers);
+```
+
 # Status
 
 ## `client.setStatus(options)`
@@ -1004,7 +1115,6 @@ Activity objects contain:
 ```javascript
 client.setStatus({
     status: "dnd",
-
     activities: [{
         name: "with the Discord API",
         type: Status.PLAYING
@@ -1017,7 +1127,6 @@ client.setStatus({
 ```javascript
 client.setStatus({
     status: "online",
-
     activities: [{
         name: "my custom status",
         type: Status.CUSTOM_STATUS
@@ -1032,7 +1141,6 @@ Streaming activities automatically receive the activity's name as `details`.
 ```javascript
 client.setStatus({
     status: "online",
-
     activities: [{
         name: "Minecraft",
         type: Status.STREAMING
@@ -1088,7 +1196,6 @@ client.disconnect(1000);
 
 ```javascript
 const self = require("@imaentity/selfjs");
-
 const client = new self.Client({
     debugLogs: true
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@imaentity/selfjs",
-    "version": "4.1.0",
+    "version": "4.2.0",
     "description": "Breaking Discord's TOS to bot user accounts.",
     "main": "self.js",
     "repository": {
@@ -10,7 +10,8 @@
     "keywords": [
         "bot",
         "discord",
-        "library"
+        "library",
+        "selfbot"
     ],
     "author": "ImaEntity",
     "license": "ISC",
@@ -19,6 +20,7 @@
     },
     "homepage": "https://github.com/ImaEntity/SelfJS#readme",
     "dependencies": {
-        "ws": "^7.5.4"
+        "ws": "^7.5.4",
+        "discord-protos": "^1.2.305"
     }
 }

package/self.js

@@ -2,19 +2,20 @@
  * @name SelfJS
  * @description Breaking Discord's TOS to bot user accounts.
  * @author Entity
- * @version 4.1
+ * @version 4.2
  */
 
+const proto = require("discord-protos");
 const EventEmitter = require("events");
 const https = require("https");
 const ws = require("ws");
 
 const DISCORD_EPOCH = 1420070400000n;
-const SELF_VERSION = "v4.0";
+const SELF_VERSION = "v4.2";
 const WS_ENDPOINT  = "wss://gateway.discord.gg?v=10&encoding=json";
 const LOGIN_PROPS  = {
     os: process.platform,
-	browser: "SelfJS",
+	browser: `SelfJS ${SELF_VERSION}`,
     device: "NodeJS"
 };
 
@@ -190,25 +191,35 @@ async function validateToken(token) {
  * @param {Object} options Options for getting a token
  * @param {String} options.email The email to use for finding a token
  * @param {String} options.password The password to use for getting a token
- * @returns {Promise<Object|null>} An object containing a token, mfa methods and a callback, or null
+ * @returns {Promise<Object>} An object containing a token, mfa methods and a callback, or an error message
  */
 async function createToken(options) {
     const {email, password} = options;
-    if(!email || !password) return null;
+    if(!email || !password) return {
+        success: false,
+        error: "Missing email or password"
+    };
 
     const loginData = await POST({
         path: "/auth/login",
         body: {login: email, password}
     });
 
-    if(!loginData.user_id) return null;
+    if(loginData.captcha_service) return {
+        success: false,
+        error: "Captcha required, but not yet supported",
+        ...loginData
+    };
+
     if(!loginData.mfa) return {
+        success: true,
         token: loginData.token,
         user_id: loginData.user_id,
         mfaRequired: false
     };
 
     return {
+        success: true,
         user_id: loginData.user_id,
         mfaRequired: true,
         mfaMethods: Object.entries(loginData)
@@ -574,12 +585,20 @@ class Client extends EventEmitter {
 
     /**
      * Gets the channels active in the DM list of the user, channels can be both DMs and group chats
-     * @returns {Promise<Object>} The list of channels open in the user's DM list
+     * @returns {Promise<Array<Object>>} The list of channels open in the user's DM list
      */
     getOpenChannels() {
         return this.#GET({path: "/users/@me/channels"});
     }
 
+    /**
+     * Gets the full list of servers the user is in
+     * @returns {Promise<Array<Object>>} The list of servers
+     */
+    getServerList() {
+        return this.#GET({ path: "/users/@me/guilds" });
+    }
+
     /**
      * Closes the current session and disconnects from discord
      * Once this is done a client will no longer see events
@@ -609,7 +628,8 @@ class Client extends EventEmitter {
      * }>} options.activities Used to provide a list of activities
      * 
      * @returns {void}
-     */
+    */
+    // TODO: Send protobuf chunk to endpoint 1
     setStatus(options) {
         for(const activity of options.activities) {
             if(activity.type == Status.CUSTOM_STATUS) {
@@ -714,7 +734,7 @@ class Client extends EventEmitter {
      * @param {String} options.channel_id The channel id to get messages from
      * @param {Number} [options.limit] The max amount of messages to return
      * @param {String} [options.before] Only return messages before this message id
-     * @returns {Promise<Array>} The list of messages in order from newest to oldest
+     * @returns {Promise<Object<Array>>} The list of messages in order from newest to oldest
      */
     getMessages(options) {
         return this.#GET({
@@ -868,6 +888,52 @@ class Client extends EventEmitter {
             }
         });
     }
+
+    /**
+     * Gets the "PreloadedUserSettings" protobuf, containing general user settings
+     * @returns {Promise<Object>} The protobuf content converted to JSON
+     */
+    async getUserSettings() {
+        const buf = await this.#GET({path: "/users/@me/settings-proto/1"});
+        if(buf?.settings) return proto.PreloadedUserSettings.fromBase64(buf.settings);
+        return buf;
+    }
+
+    /**
+     * Gets the "FrecencyUserSettings" protobuf converted to JSON
+     * Containing frecency and favorite data for gifs, emojis, stickers, and other similar things
+     * @returns {Promise<Object>} The protobuf content converted to JSON
+     */
+    async getFrecencySettings() {
+        const buf = await this.#GET({path: "/users/@me/settings-proto/2"});
+        if(buf?.settings) return proto.FrecencyUserSettings.fromBase64(buf.settings);
+        return buf;
+    }
+
+    /**
+     * Updates the "PreloadedUserSettings" protobuf, containing general user settings
+     * @param {Object} buf The new data to set the protobuf to
+     * @returns {Promise<Object>} The updated protobuf stored on the server
+     */
+    async updateUserSettings(buf) {
+        const b64 = proto.PreloadedUserSettings.toBase64(buf);
+        const res = await this.#PATCH({path: "/users/@me/settings-proto/1", body: {settings: b64}});
+        if(res?.settings) return proto.PreloadedUserSettings.fromBase64(res.settings);
+        return res;
+    }
+
+    /**
+     * Updates the "FrecencyUserSettings" protobuf
+     * Contains frecency and favorite data for gifs, emojis, stickers, and other similar things
+     * @param {Object} buf The new data to set the protobuf to
+     * @returns {Promise<Object>} The updated protobuf stored on the server
+     */
+    async updateFrecencySettings(buf) {
+        const b64 = proto.FrecencyUserSettings.toBase64(buf);
+        const res = await this.#PATCH({path: "/users/@me/settings-proto/2", body: {settings: b64}});
+        if(res?.settings) return proto.FrecencyUserSettings.fromBase64(res.settings);
+        return res;
+    }
 }
 
 module.exports = {