sidechat.js 2.3.7 → 2.4.0

package/dist/index.mjs

@@ -21,6 +21,7 @@ class SidechatAPIClient {
    * @type {SidechatAuthToken}
    * */
   userToken;
+
   /**
    * Default headers for every API request
    * @type {Object}
@@ -34,14 +35,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;
+    }
   }
 
   /**
@@ -53,6 +65,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
@@ -61,7 +83,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({
@@ -86,17 +108,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;
@@ -120,17 +139,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;
@@ -154,19 +170,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);
@@ -188,16 +201,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;
@@ -221,21 +231,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;
@@ -269,7 +276,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: {
@@ -301,7 +308,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 : ""
         }`,
         {
@@ -332,7 +339,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,
@@ -365,7 +372,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: {
@@ -399,16 +406,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) {
@@ -430,7 +434,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: {
@@ -505,7 +509,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,
@@ -532,7 +536,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,
@@ -558,7 +562,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,
@@ -585,7 +589,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,
@@ -600,6 +604,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
@@ -624,7 +661,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,
@@ -672,7 +709,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,
@@ -708,7 +745,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,
@@ -740,7 +777,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,
@@ -777,7 +814,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: {
@@ -809,7 +846,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,
@@ -838,7 +875,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,
@@ -866,7 +903,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,
@@ -897,7 +934,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,
@@ -930,11 +967,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",
@@ -995,7 +1031,7 @@ const SidechatColorList = {
       primary: "#0968E5",
       secondary: "#091970",
     },
-  ],
-};
+  ];
+}
 
 export { SidechatAPIClient, SidechatAPIError, SidechatColorList };