sidechat.js 2.3.7 → 2.4.0

package/dist/classes/SidechatAPIClient.d.ts

@@ -8,8 +8,9 @@ declare class SidechatAPIClient {
     /**
      * Create a new instance of the API client
      * @param {SidechatAuthToken} [token] - user bearer token
+     * @param {String} rootUrl - custom API root URL for mocking or using other server
      */
-    constructor(token?: SidechatAuthToken);
+    constructor(token?: SidechatAuthToken, rootUrl?: string);
     /**
      * User bearer token
      * @type {SidechatAuthToken}
@@ -22,12 +23,25 @@ declare class SidechatAPIClient {
      * @constant
      */
     defaultHeaders: any;
+    /**
+     * Root URL for every API request
+     * @type {String}
+     * @default "https://api.sidechat.lol"
+     */
+    apiRoot: string;
     /**
      * Manually set the currently signed in user's token.  Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions
      * @method
      * @param {SidechatAuthToken} token - user bearer token
      */
     setToken: (token: SidechatAuthToken) => void;
+    /**
+     * Manually set the root URL for all API requests.  This can be used for mocking requests or redirecting them to a different server
+     * @method
+     * @param {String} url - new root URL to set
+     * @since 2.3.9
+     */
+    setAPIRoot: (url: string) => void;
     /**
      * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().
      * @method
@@ -160,6 +174,14 @@ declare class SidechatAPIClient {
      * @returns {SidechatGroup}
      */
     getGroupMetadata: (groupID?: string) => SidechatGroup;
+    /**
+     * Joins or leaves a group
+     * @method
+     * @param {String} groupID - alphanumeric ID of group to join or leave
+     * @param {Boolean} isMember - whether or not the user should be a member of the group
+     * @since 2.3.8
+     */
+    setGroupMembership: (groupID: string, isMember: boolean) => Promise<any>;
     /**
      * Creates a comment on a post
      * @method

package/dist/classes/SidechatAPIClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SidechatAPIClient.d.ts","sourceRoot":"","sources":["../../src/classes/SidechatAPIClient.js"],"names":[],"mappings":";AAGA;;;;GAIG;AACH;IAmBE;;;OAGG;IACH,uCAIC;IA1BD;;;SAGK;IACL,6BAAU;IACV;;;;;OAKG;IACH,oBAKE;IAYF;;;;OAIG;IACH,6CAEE;IAEF;;;;;OAKG;IACH,mDAgBE;IAEF;;;;;;OAMG;IACH,mEAsBE;IAEF;;;;;;OAMG;IACH,8DAyBE;IAEF;;;;;;OAMG;IACH,+CA2BE;IAEF;;;;OAIG;IACH,2CAyBE;IAEF;;;;;OAKG;IACH,6CA2BE;IAEF;;;;;;OAMG;IACH,oDAGE;IAEF;;;;;OAKG;IACH,+CAqBE;IAEF;;;;;;;;OAQG;IACH,4CAJW,KAAK,GAAC,QAAQ,GAAC,KAAK,2DA2B7B;IAEF;;;;;;OAMG;IACH,sEAsBE;IAEF;;;;;;;OAOG;IACH,6EAqBE;IAEF;;;;;;OAMG;IACH,8BAHW,OAAO,GAAC,UAAU,KAChB,uBAAuB,CA4BlC;IAEF;;;;;;OAMG;IACH,qCAFa,uBAAuB,CAqElC;IAEF;;;;;;OAMG;IACH,2CAFa,eAAe,CAqB1B;IAEF;;;;;OAKG;IACH,uBAFa,sBAAsB,CAoBjC;IAEF;;;;;OAKG;IACH,0CAkBE;IAEF;;;;;;OAMG;IACH,sDAkBE;IAEF;;;;;;;;;;;OAWG;IACH,0GAJW,qBAAqB,iDAsC9B;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,qBAAqB,iGAyC9B;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;IAEF;;;;;;OAMG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,gEAqBE;IAEF;;;;;OAKG;IACH,mDAqBE;IAEF;;;;OAIG;IACH,kCAkBE;IAEF;;;;OAIG;IACH,wHAiCE;CACH"}
+{"version":3,"file":"SidechatAPIClient.d.ts","sourceRoot":"","sources":["../../src/classes/SidechatAPIClient.js"],"names":[],"mappings":";AAGA;;;;GAIG;AACH;IA2BE;;;;OAIG;IACH,yDAOC;IAtCD;;;SAGK;IACL,6BAAU;IAEV;;;;;OAKG;IACH,oBAKE;IAEF;;;;OAIG;IACH,gBAAqC;IAgBrC;;;;OAIG;IACH,6CAEE;IAEF;;;;;OAKG;IACH,kCAEE;IAEF;;;;;OAKG;IACH,mDAgBE;IAEF;;;;;;OAMG;IACH,mEAmBE;IAEF;;;;;;OAMG;IACH,8DAsBE;IAEF;;;;;;OAMG;IACH,+CAwBE;IAEF;;;;OAIG;IACH,2CAsBE;IAEF;;;;;OAKG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,oDAGE;IAEF;;;;;OAKG;IACH,+CAqBE;IAEF;;;;;;;;OAQG;IACH,4CAJW,KAAK,GAAC,QAAQ,GAAC,KAAK,2DA2B7B;IAEF;;;;;;OAMG;IACH,sEAsBE;IAEF;;;;;;;OAOG;IACH,6EAqBE;IAEF;;;;;;OAMG;IACH,8BAHW,OAAO,GAAC,UAAU,KAChB,uBAAuB,CAyBlC;IAEF;;;;;;OAMG;IACH,qCAFa,uBAAuB,CAqElC;IAEF;;;;;;OAMG;IACH,2CAFa,eAAe,CAqB1B;IAEF;;;;;OAKG;IACH,uBAFa,sBAAsB,CAoBjC;IAEF;;;;;OAKG;IACH,0CAkBE;IAEF;;;;;;OAMG;IACH,sDAkBE;IAEF;;;;;;OAMG;IACH,yEAwBE;IAEF;;;;;;;;;;;OAWG;IACH,0GAJW,qBAAqB,iDAsC9B;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,qBAAqB,iGAyC9B;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;IAEF;;;;;;OAMG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,gEAqBE;IAEF;;;;;OAKG;IACH,mDAqBE;IAEF;;;;OAIG;IACH,kCAkBE;IAEF;;;;OAIG;IACH,wHAiCE;CACH"}

package/dist/classes/SidechatColorList.d.ts

@@ -16,10 +16,12 @@ export type SidechatColor = {
  */
 /**
  * List of colors compatible with user conversation icons
- * @constant
- * @type {{ colors: SidechatColor[] }}
+ * @prop {SidechatColor[]} colors - list of color themes for user icons
  */
-declare const SidechatColorList: {
-    colors: SidechatColor[];
-};
+declare class SidechatColorList {
+    colors: {
+        primary: string;
+        secondary: string;
+    }[];
+}
 //# sourceMappingURL=SidechatColorList.d.ts.map

package/dist/classes/SidechatColorList.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SidechatColorList.d.ts","sourceRoot":"","sources":["../../src/classes/SidechatColorList.js"],"names":[],"mappings":";;;;;;;;;;;AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,iCAFU;IAAE,MAAM,EAAE,aAAa,EAAE,CAAA;CAAE,CAiEnC"}
+{"version":3,"file":"SidechatColorList.d.ts","sourceRoot":"","sources":["../../src/classes/SidechatColorList.js"],"names":[],"mappings":";;;;;;;;;;;AAAA;;;;GAIG;AAEH;;;GAGG;AACH;IACE;;;QA6DE;CACH"}

package/dist/index.cjs

@@ -25,6 +25,7 @@ class SidechatAPIClient {
    * @type {SidechatAuthToken}
    * */
   userToken;
+
   /**
    * Default headers for every API request
    * @type {Object}
@@ -38,14 +39,25 @@ class SidechatAPIClient {
     Dnt: 1,
   };
 
+  /**
+   * Root URL for every API request
+   * @type {String}
+   * @default "https://api.sidechat.lol"
+   */
+  apiRoot = "https://api.sidechat.lol";
+
   /**
    * Create a new instance of the API client
    * @param {SidechatAuthToken} [token] - user bearer token
+   * @param {String} rootUrl - custom API root URL for mocking or using other server
    */
-  constructor(token = "") {
+  constructor(token = "", rootUrl = "") {
     if (token) {
       this.userToken = token;
     }
+    if (rootUrl) {
+      this.apiRoot = rootUrl;
+    }
   }
 
   /**
@@ -57,6 +69,16 @@ class SidechatAPIClient {
     this.userToken = token;
   };
 
+  /**
+   * Manually set the root URL for all API requests.  This can be used for mocking requests or redirecting them to a different server
+   * @method
+   * @param {String} url - new root URL to set
+   * @since 2.3.9
+   */
+  setAPIRoot = (url) => {
+    this.apiRoot = url;
+  };
+
   /**
    * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().
    * @method
@@ -65,7 +87,7 @@ class SidechatAPIClient {
    */
   loginViaSMS = async (phoneNumber) => {
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
+      const res = await fetch(`${this.apiRoot}/v1/login_register`, {
         method: "POST",
         headers: this.defaultHeaders,
         body: JSON.stringify({
@@ -90,17 +112,14 @@ class SidechatAPIClient {
    */
   verifySMSCode = async (phoneNumber, code) => {
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v1/verify_phone_number`,
-        {
-          method: "POST",
-          headers: this.defaultHeaders,
-          body: JSON.stringify({
-            phone_number: `+1${phoneNumber}`,
-            code: code.toUpperCase(),
-          }),
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v1/verify_phone_number`, {
+        method: "POST",
+        headers: this.defaultHeaders,
+        body: JSON.stringify({
+          phone_number: `+1${phoneNumber}`,
+          code: code.toUpperCase(),
+        }),
+      });
       const json = await res.json();
       if (json?.logged_in_user?.token) {
         this.userToken = json.logged_in_user.token;
@@ -124,17 +143,14 @@ class SidechatAPIClient {
       throw new SidechatAPIError("You're too young to use Offsides.");
     }
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v1/complete_registration`,
-        {
-          method: "POST",
-          headers: this.defaultHeaders,
-          body: JSON.stringify({
-            age: Number(age),
-            registration_id: registrationID,
-          }),
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v1/complete_registration`, {
+        method: "POST",
+        headers: this.defaultHeaders,
+        body: JSON.stringify({
+          age: Number(age),
+          registration_id: registrationID,
+        }),
+      });
       const json = await res.json();
       if (json.token) {
         this.userToken = json.token;
@@ -158,19 +174,16 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v2/users/register_email`,
-        {
-          method: "POST",
-          headers: {
-            ...this.defaultHeaders,
-            Authorization: `Bearer ${this.userToken}`,
-          },
-          body: JSON.stringify({
-            email: email,
-          }),
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v2/users/register_email`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          email: email,
+        }),
+      });
       const json = await res.json();
       if (json.message) {
         throw new SidechatAPIError(json.message);
@@ -192,16 +205,13 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v1/users/check_email_verified`,
-        {
-          method: "GET",
-          headers: {
-            ...this.defaultHeaders,
-            Authorization: `Bearer ${this.userToken}`,
-          },
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v1/users/check_email_verified`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
       const json = await res.json();
       if (json.verified_email_updates_response) {
         return json.verified_email_updates_response;
@@ -225,21 +235,18 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v1/register_device_token`,
-        {
-          method: "POST",
-          headers: {
-            ...this.defaultHeaders,
-            Authorization: `Bearer ${this.userToken}`,
-          },
-          body: JSON.stringify({
-            build_type: "release",
-            bundle_id: "com.flowerave.sidechat",
-            device_token: deviceID,
-          }),
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v1/register_device_token`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          build_type: "release",
+          bundle_id: "com.flowerave.sidechat",
+          device_token: deviceID,
+        }),
+      });
       const json = await res.json();
       await AsyncStorage.setItem("deviceID", deviceID);
       return json;
@@ -273,7 +280,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
+        `${this.apiRoot}/v1/updates?group_id=${groupID}`,
         {
           method: "GET",
           headers: {
@@ -305,7 +312,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `https://api.sidechat.lol/v1/posts?group_id=${groupID}&type=${category}${
+        `${this.apiRoot}/v1/posts?group_id=${groupID}&type=${category}${
           cursor ? "&cursor=" + cursor : ""
         }`,
         {
@@ -336,7 +343,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
+      const res = await fetch(`${this.apiRoot}/v1/posts/set_vote`, {
         method: "POST",
         headers: {
           ...this.defaultHeaders,
@@ -369,7 +376,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `https://api.sidechat.lol/v1/posts/get?include_deleted=${includeDeleted}&post_id=${postID}`,
+        `${this.apiRoot}/v1/posts/get?include_deleted=${includeDeleted}&post_id=${postID}`,
         {
           method: "GET",
           headers: {
@@ -403,16 +410,13 @@ class SidechatAPIClient {
       contentType = "my_comments";
     }
     try {
-      const res = await fetch(
-        `https://api.sidechat.lol/v1/posts&type=${contentType}`,
-        {
-          method: "GET",
-          headers: {
-            ...this.defaultHeaders,
-            Authorization: `Bearer ${this.userToken}`,
-          },
-        }
-      );
+      const res = await fetch(`${this.apiRoot}/v1/posts&type=${contentType}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
       const json = await res.json();
       return json.posts;
     } catch (err) {
@@ -434,7 +438,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
+        `${this.apiRoot}/v1/posts/comments/?post_id=${postID}`,
         {
           method: "GET",
           headers: {
@@ -509,7 +513,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
+      const res = await fetch(`${this.apiRoot}/v1/groups/explore`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -536,7 +540,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/assets/library`, {
+      const res = await fetch(`${this.apiRoot}/v1/assets/library`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -562,7 +566,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/users/me`, {
+      const res = await fetch(`${this.apiRoot}/v1/users/me`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -589,7 +593,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/groups/${groupID}`, {
+      const res = await fetch(`${this.apiRoot}/v1/groups/${groupID}`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -604,6 +608,39 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Joins or leaves a group
+   * @method
+   * @param {String} groupID - alphanumeric ID of group to join or leave
+   * @param {Boolean} isMember - whether or not the user should be a member of the group
+   * @since 2.3.8
+   */
+  setGroupMembership = async (groupID, isMember) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(
+        `${this.apiRoot}/v1/groups/${isMember ? "join" : "leave"}`,
+        {
+          method: "POST",
+          headers: {
+            ...this.defaultHeaders,
+            Authorization: `Bearer ${this.userToken}`,
+          },
+          body: JSON.stringify({
+            group_id: groupID,
+          }),
+        }
+      );
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to modify group membership.`);
+    }
+  };
+
   /**
    * Creates a comment on a post
    * @method
@@ -628,7 +665,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
+      const res = await fetch(`${this.apiRoot}/v1/posts`, {
         method: "POST",
         headers: {
           ...this.defaultHeaders,
@@ -676,7 +713,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
+      const res = await fetch(`${this.apiRoot}/v1/posts`, {
         method: "POST",
         headers: {
           ...this.defaultHeaders,
@@ -712,7 +749,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/posts/delete`, {
+      const res = await fetch(`${this.apiRoot}/v1/posts/delete`, {
         method: "POST",
         headers: {
           ...this.defaultHeaders,
@@ -744,7 +781,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/users/${userID}`, {
+      const res = await fetch(`${this.apiRoot}/v1/users/${userID}`, {
         method: "PATCH",
         headers: {
           ...this.defaultHeaders,
@@ -781,7 +818,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `https://api.sidechat.lol/v1/users/username?username=${username}`,
+        `${this.apiRoot}/v1/users/username?username=${username}`,
         {
           method: "GET",
           headers: {
@@ -813,7 +850,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/users/${userID}`, {
+      const res = await fetch(`${this.apiRoot}/v1/users/${userID}`, {
         method: "PATCH",
         headers: {
           ...this.defaultHeaders,
@@ -842,7 +879,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/activity/seen`, {
+      const res = await fetch(`${this.apiRoot}/v1/activity/seen`, {
         method: "POST",
         headers: {
           ...this.defaultHeaders,
@@ -870,7 +907,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/chats/explore`, {
+      const res = await fetch(`${this.apiRoot}/v1/chats/explore`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -901,7 +938,7 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`https://api.sidechat.lol/v1/chats/groups/join`, {
+      const res = await fetch(`${this.apiRoot}/v1/chats/groups/join`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -934,11 +971,10 @@ class SidechatAPIClient {
 
 /**
  * List of colors compatible with user conversation icons
- * @constant
- * @type {{ colors: SidechatColor[] }}
+ * @prop {SidechatColor[]} colors - list of color themes for user icons
  */
-const SidechatColorList = {
-  colors: [
+class SidechatColorList {
+  colors = [
     {
       primary: "#74DEEE",
       secondary: "#239EAB",
@@ -999,8 +1035,8 @@ const SidechatColorList = {
       primary: "#0968E5",
       secondary: "#091970",
     },
-  ],
-};
+  ];
+}
 
 exports.SidechatAPIClient = SidechatAPIClient;
 exports.SidechatAPIError = SidechatAPIError;