sidechat.js 2.3.2 → 2.3.6

package/dist/classes/SidechatAPIClient.d.ts

@@ -114,6 +114,14 @@ declare class SidechatAPIClient {
      * @returns {SidechatPostOrComment} post object
      */
     getPost: (postID: string, includeDeleted?: boolean) => SidechatPostOrComment;
+    /**
+     * Fetches the posts or comments that the user has created
+     * @method
+     * @since 2.3.5
+     * @param {"posts"|"comments"} contentType - type of user content to fetch
+     * @returns {SidechatPostOrComment[]} post object
+     */
+    getUserContent: (contentType: "posts" | "comments") => SidechatPostOrComment[];
     /**
      * Get all the commments on a post
      * @method
@@ -126,9 +134,10 @@ declare class SidechatAPIClient {
      * Gets groups to be displayed on the "Explore Groups" page
      * @method
      * @since 2.0.0-alpha.0
+     * @param {Boolean} onePage - whether or not results should be returned as a single page
      * @returns {SidechatGroup[]}
      */
-    getAvailableGroups: () => SidechatGroup[];
+    getAvailableGroups: (onePage?: boolean) => SidechatGroup[];
     /**
      * Retrieves the entire accessible asset library.  Be warned that as of the time of this documentation, it's a 1.5MB JSON download and this request is very expensive.
      * @method
@@ -173,9 +182,10 @@ declare class SidechatAPIClient {
      * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach.
      * @param {Boolean} [disableDMs] - prevent direct messages from being sent to post's author
      * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
+     * @param {Boolean} [anonymous] - whether or not to hide user's name and icon on post
      * @returns {SidechatPostOrComment} the created post
      */
-    createPost: (text: string, groupID: string, assetList?: SidechatSimpleAsset[], disableDMs?: boolean, disableComments?: boolean) => SidechatPostOrComment;
+    createPost: (text: string, groupID: string, assetList?: SidechatSimpleAsset[], disableDMs?: boolean, disableComments?: boolean, anonymous?: boolean) => SidechatPostOrComment;
     /**
      * Deletes a post or comment that the user created
      * @method
@@ -187,12 +197,28 @@ declare class SidechatAPIClient {
      * Sets the conversation icon of the current user
      * @method
      * @since 2.2.1
-     * @param {String} userID - alphanumeric ID of the post to delete
+     * @param {String} userID - alphanumeric ID of user
      * @param {String} emoji - emoji to set as icon
      * @param {String} primaryColor - hex string (including #) of primary color
      * @param {String} secondaryColor - hex string (including #) of secondary color
      */
     setUserIcon: (userID: string, emoji: string, primaryColor: string, secondaryColor: string) => Promise<any>;
+    /**
+     * Checks if user can set their username to a string
+     * @method
+     * @since 2.3.6
+     * @param {String} username - string to check
+     * @returns {Boolean} whether or not username is valid and unused
+     */
+    checkUsername: (username: string) => boolean;
+    /**
+     * Changes the username of the current user
+     * @method
+     * @since 2.3.6
+     * @param {String} userID - alphanumeric ID of user
+     * @param {String} username - new username to set
+     */
+    setUsername: (userID: string, username: string) => Promise<any>;
     /**
      * Marks an activity item as read
      * @method
@@ -200,5 +226,17 @@ declare class SidechatAPIClient {
      * @param {String} activityID - alphanumeric ID of activity object
      */
     readActivity: (activityID: string) => Promise<any>;
+    /**
+     * Retrieves joinable group chats
+     * @method
+     * @since 2.3.5
+     */
+    getGroupChats: () => Promise<any>;
+    /**
+     * Joins a group chat
+     * @method
+     * @since 2.3.5
+     */
+    joinGroupChat: (groupChatID: any, displayName: any, emoji: any, primaryColor: any, secondaryColor: any) => Promise<any>;
 }
 //# sourceMappingURL=SidechatAPIClient.d.ts.map

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,qCAFa,uBAAuB,CAqElC;IAEF;;;;;OAKG;IACH,0BAFa,eAAe,CAoB1B;IAEF;;;;;OAKG;IACH,uBAFa,sBAAsB,CAoBjC;IAEF;;;;;OAKG;IACH,0CAkBE;IAEF;;;;;;OAMG;IACH,sDAkBE;IAEF;;;;;;;;;;;OAWG;IACH,0GAJW,qBAAqB,iDAsC9B;IAEF;;;;;;;;;;OAUG;IACH,wDALW,qBAAqB,4EAsC9B;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;;;OAQG;IACH,2GA0BE;IAEF;;;;;OAKG;IACH,mDAqBE;CACH"}
+{"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"}

package/dist/classes/SidechatColorList.d.ts

@@ -0,0 +1,25 @@
+export default SidechatColorList;
+export type SidechatColor = {
+    /**
+     * - hex code of primary color
+     */
+    primary: string;
+    /**
+     * - hex code of secondary color
+     */
+    secondary: string;
+};
+/**
+ * @typedef SidechatColor
+ * @prop {String} primary - hex code of primary color
+ * @prop {String} secondary - hex code of secondary color
+ */
+/**
+ * List of colors compatible with user conversation icons
+ * @constant
+ * @type {{ colors: SidechatColor[] }}
+ */
+declare const SidechatColorList: {
+    colors: SidechatColor[];
+};
+//# sourceMappingURL=SidechatColorList.d.ts.map

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

@@ -0,0 +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"}

package/dist/index.cjs

@@ -34,7 +34,7 @@ class SidechatAPIClient {
   defaultHeaders = {
     Accept: "application/json",
     "Content-Type": "application/json",
-    "App-Version": "10.0.0",
+    "App-Version": "4.2.0",
     Dnt: 1,
   };
 
@@ -386,6 +386,41 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Fetches the posts or comments that the user has created
+   * @method
+   * @since 2.3.5
+   * @param {"posts"|"comments"} contentType - type of user content to fetch
+   * @returns {SidechatPostOrComment[]} post object
+   */
+  getUserContent = async (contentType) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    if (contentType == "posts") {
+      contentType = "my_posts";
+    } else if (contentType == "comments") {
+      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 json = await res.json();
+      return json.posts;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get content from user.`);
+    }
+  };
+
   /**
    * Get all the commments on a post
    * @method
@@ -466,9 +501,10 @@ class SidechatAPIClient {
    * Gets groups to be displayed on the "Explore Groups" page
    * @method
    * @since 2.0.0-alpha.0
+   * @param {Boolean} onePage - whether or not results should be returned as a single page
    * @returns {SidechatGroup[]}
    */
-  getAvailableGroups = async () => {
+  getAvailableGroups = async (onePage = true) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
     }
@@ -477,6 +513,7 @@ class SidechatAPIClient {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
+          "App-Version": onePage ? "0" : this.defaultHeaders["App-Version"],
           Authorization: `Bearer ${this.userToken}`,
         },
       });
@@ -624,6 +661,7 @@ class SidechatAPIClient {
    * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach.
    * @param {Boolean} [disableDMs] - prevent direct messages from being sent to post's author
    * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
+   * @param {Boolean} [anonymous] - whether or not to hide user's name and icon on post
    * @returns {SidechatPostOrComment} the created post
    */
   createPost = async (
@@ -631,7 +669,8 @@ class SidechatAPIClient {
     groupID,
     assetList = [],
     disableDMs = false,
-    disableComments = false
+    disableComments = false,
+    anonymous = false
   ) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
@@ -651,6 +690,7 @@ class SidechatAPIClient {
           attachments: [],
           dms_disabled: disableDMs,
           comments_disabled: disableComments,
+          using_identity: !anonymous,
         }),
       });
       const json = await res.json();
@@ -694,7 +734,7 @@ class SidechatAPIClient {
    * Sets the conversation icon of the current user
    * @method
    * @since 2.2.1
-   * @param {String} userID - alphanumeric ID of the post to delete
+   * @param {String} userID - alphanumeric ID of user
    * @param {String} emoji - emoji to set as icon
    * @param {String} primaryColor - hex string (including #) of primary color
    * @param {String} secondaryColor - hex string (including #) of secondary color
@@ -708,6 +748,7 @@ class SidechatAPIClient {
         method: "PATCH",
         headers: {
           ...this.defaultHeaders,
+          "App-Version": "0",
           Authorization: `Bearer ${this.userToken}`,
         },
         body: JSON.stringify({
@@ -727,6 +768,69 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Checks if user can set their username to a string
+   * @method
+   * @since 2.3.6
+   * @param {String} username - string to check
+   * @returns {Boolean} whether or not username is valid and unused
+   */
+  checkUsername = async (username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(
+        `https://api.sidechat.lol/v1/users/username?username=${username}`,
+        {
+          method: "GET",
+          headers: {
+            ...this.defaultHeaders,
+            Authorization: `Bearer ${this.userToken}`,
+          },
+        }
+      );
+      if (res?.status == 200 || res?.status == 204) {
+        return true;
+      } else {
+        return false;
+      }
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to check username.`);
+    }
+  };
+
+  /**
+   * Changes the username of the current user
+   * @method
+   * @since 2.3.6
+   * @param {String} userID - alphanumeric ID of user
+   * @param {String} username - new username to set
+   */
+  setUsername = async (userID, username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`https://api.sidechat.lol/v1/users/${userID}`, {
+        method: "PATCH",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          username: username,
+        }),
+      });
+      const json = await res.json();
+      return await json.user;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set icon.`);
+    }
+  };
+
   /**
    * Marks an activity item as read
    * @method
@@ -755,7 +859,149 @@ class SidechatAPIClient {
       throw new SidechatAPIError(`Failed to mark activity as read.`);
     }
   };
+
+  /**
+   * Retrieves joinable group chats
+   * @method
+   * @since 2.3.5
+   */
+  getGroupChats = async () => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`https://api.sidechat.lol/v1/chats/explore`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
+      const json = await res.json();
+      return await json.chats;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get groupchats.`);
+    }
+  };
+
+  /**
+   * Joins a group chat
+   * @method
+   * @since 2.3.5
+   */
+  joinGroupChat = async (
+    groupChatID,
+    displayName,
+    emoji,
+    primaryColor,
+    secondaryColor
+  ) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`https://api.sidechat.lol/v1/chats/groups/join`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          chat_id: groupChatID,
+          identity: {
+            display_name: displayName,
+            emoji: emoji,
+            secondary_color: secondaryColor,
+            color: primaryColor,
+          },
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to join groupchat.`);
+    }
+  };
 }
 
+/**
+ * @typedef SidechatColor
+ * @prop {String} primary - hex code of primary color
+ * @prop {String} secondary - hex code of secondary color
+ */
+
+/**
+ * List of colors compatible with user conversation icons
+ * @constant
+ * @type {{ colors: SidechatColor[] }}
+ */
+const SidechatColorList = {
+  colors: [
+    {
+      primary: "#74DEEE",
+      secondary: "#239EAB",
+    },
+    {
+      primary: "#15FF46",
+      secondary: "#3FC0FF",
+    },
+    {
+      primary: "#D9FB8A",
+      secondary: "#B1FD00",
+    },
+    {
+      primary: "#FC40FF",
+      secondary: "#0DD5B2",
+    },
+    {
+      primary: "#3E973C",
+      secondary: "#0F430E",
+    },
+    {
+      primary: "#FFD305",
+      secondary: "#F4B320",
+    },
+    {
+      primary: "#8483FF",
+      secondary: "#5857FF",
+    },
+    {
+      primary: "#FA81FF",
+      secondary: "#722DFF",
+    },
+    {
+      primary: "#00CBFE",
+      secondary: "#0D13D5",
+    },
+    {
+      primary: "#FF7B51",
+      secondary: "#B2431F",
+    },
+    {
+      primary: "#FF47CC",
+      secondary: "#69004C",
+    },
+    {
+      primary: "#00EE6E",
+      secondary: "#0C75E6",
+    },
+    {
+      primary: "#FF1885",
+      secondary: "#FA81FF",
+    },
+    {
+      primary: "#D8DC44",
+      secondary: "#228B3F",
+    },
+    {
+      primary: "#0968E5",
+      secondary: "#091970",
+    },
+  ],
+};
+
 exports.SidechatAPIClient = SidechatAPIClient;
 exports.SidechatAPIError = SidechatAPIError;
+exports.SidechatColorList = SidechatColorList;

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import SidechatAPIClient from "./classes/SidechatAPIClient.js";
 import SidechatAPIError from "./classes/SidechatAPIError.js";
-export { SidechatAPIClient, SidechatAPIError };
+import SidechatColorList from "./classes/SidechatColorList.js";
+export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import SidechatAPIClient from "./classes/SidechatAPIClient.js";
 import SidechatAPIError from "./classes/SidechatAPIError.js";
-export { SidechatAPIClient, SidechatAPIError };
+import SidechatColorList from "./classes/SidechatColorList.js";
+export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"8BAC8B,gCAAgC;6BACjC,+BAA+B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"8BAC8B,gCAAgC;6BACjC,+BAA+B;8BAC9B,gCAAgC"}