sidechat.js 2.5.6 → 2.6.0

package/dist/classes/SidechatAPIClient.d.ts

@@ -163,6 +163,14 @@ declare class SidechatAPIClient {
      * @returns {SidechatGroup[]}
      */
     getAvailableGroups: (onePage?: boolean) => SidechatGroup[];
+    /**
+     * Searches for new groups based on a query keyword
+     * @method
+     * @since 2.6.0
+     * @param {String} query - the string to search for.  This will be encoded, so strings with spaces and special characters are okay.
+     * @returns {SidechatGroup[]}
+     */
+    searchAvailableGroups: (query: string) => 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
@@ -287,6 +295,22 @@ declare class SidechatAPIClient {
      * @param {String} username - new username to set
      */
     setUsername: (userID: string, username: string) => Promise<any>;
+    /**
+     * Fetches a public user profile
+     * @method
+     * @since 2.6.0
+     * @param {String} username - username of the user to fetch
+     * @returns {SidechatProfile}
+     */
+    getUserProfile: (username: string) => SidechatProfile;
+    /**
+     * Fetches a public user's posts
+     * @method
+     * @since 2.6.0
+     * @param {String} username - username of the user to fetch
+     * @returns {SidechatPostOrComment[]}
+     */
+    getUserPosts: (username: string) => SidechatPostOrComment[];
     /**
      * Marks an activity item as read
      * @method
@@ -301,11 +325,16 @@ declare class SidechatAPIClient {
      */
     getGroupChats: () => Promise<any>;
     /**
-     * Joins a group chat
+     * Joins a group chat.  To mimic the official client, use the user's display name and icon by default.
      * @method
+     * @param {String} groupChatID - alphanumeric ID of group chat to join
+     * @param {String} displayName - display name to use in chat
+     * @param {String} emoji - emoji to use as icon
+     * @param {String} primaryColor - hex string of primary color
+     * @param {String} secondaryColor - hex string of secondary color
      * @since 2.3.5
      */
-    joinGroupChat: (groupChatID: any, displayName: any, emoji: any, primaryColor: any, secondaryColor: any) => Promise<any>;
+    joinGroupChat: (groupChatID: string, displayName: string, emoji: string, primaryColor: string, secondaryColor: string) => Promise<any>;
     /**
      * Gets a list of the user's direct messages
      * @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;IA2BE;;;;OAIG;IACH,oBAHW,iBAAiB,oBAU3B;IAtCD;;;SAGK;IACL,WAFU,iBAAiB,CAEjB;IAEV;;;;;OAKG;IACH,oBAKE;IAEF;;;;OAIG;IACH,gBAAqC;IAgBrC;;;;OAIG;IACH,kBAFW,iBAAiB,UAI1B;IAEF;;;;;OAKG;IACH,kCAEE;IAEF;;;;;;;;;OASG;IACH,yCANW,KAAK,GAAC,MAAM,GAAC,KAAK,GAAC,QAAQ,GAAC,OAAO,GAAC,SAAS,0EAuBtD;IAEF;;;;;OAKG;IACH,mDAgBE;IAEF;;;;;;OAMG;IACH,mEAmBE;IAEF;;;;;;OAMG;IACH,8DAsBE;IAEF;;;;;;OAMG;IACH,+CAwBE;IAEF;;;;OAIG;IACH,2CAsBE;IAEF;;;;;OAKG;IACH,6CAuBE;IAEF;;;;;;OAMG;IACH,oDAGE;IAEF;;;;;OAKG;IACH,+CAqBE;IAEF;;;;;;;;OAQG;IACH,4CAJW,KAAK,GAAC,QAAQ,GAAC,KAAK,WACpB,oBAAoB,KAClB,sBAAsB,CAwBjC;IAEF;;;;;;OAMG;IACH,kCAFW,kBAAkB,kBAwB3B;IAEF;;;;;;;OAOG;IACH,uDAFa,qBAAqB,CAuBhC;IAEF;;;;;;OAMG;IACH,8BAHW,OAAO,GAAC,UAAU,KAChB,qBAAqB,EAAE,CAyBlC;IAEF;;;;;;OAMG;IACH,qCAFa,qBAAqB,EAAE,CAqElC;IAEF;;;;;;OAMG;IACH,2CAFa,aAAa,EAAE,CAqB1B;IAEF;;;;;OAKG;IACH,uBAFa,oBAAoB,EAAE,CAoBjC;IAEF;;;;;OAKG;IACH,sBAFa,mBAAmB,CAoB9B;IAEF;;;;;;OAMG;IACH,wCAFa,aAAa,CAoBxB;IAEF;;;;;;OAMG;IACH,yEAwBE;IAEF;;;;;;;;;;;;;OAaG;IACH,oIALW,mBAAmB,EAAE,gDAGnB,qBAAqB,CAwChC;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,mBAAmB,EAAE,2EAInB,qBAAqB,CAqChC;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;OAMG;IACH,kEAsBE;IAEF;;;;;OAKG;IACH,kDAqBE;IAEF;;;;;;;;OAQG;IACH,sEAsCE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;IAEF;;;;;;OAMG;IACH,0DAsBE;IAEF;;;;;;OAMG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,gEAqBE;IAEF;;;;;OAKG;IACH,mDAqBE;IAEF;;;;OAIG;IACH,kCAkBE;IAEF;;;;OAIG;IACH,wHAiCE;IAEF;;;;;OAKG;IACH,cAHa,oBAAoB,EAAE,CA0BjC;IAEF;;;;;;OAMG;IACH,6BAHa,oBAAoB,CAwB/B;IAEF;;;;;;;;;OASG;IACH,kEAJW,aAAa,EAAE,uCA6BxB;IAEF;;;;;;;;;OASG;IACH,6FAHW,MAAM,kBAkCf;CACH"}
+{"version":3,"file":"SidechatAPIClient.d.ts","sourceRoot":"","sources":["../../src/classes/SidechatAPIClient.js"],"names":[],"mappings":";AAGA;;;;GAIG;AACH;IA2BE;;;;OAIG;IACH,oBAHW,iBAAiB,oBAU3B;IAtCD;;;SAGK;IACL,WAFU,iBAAiB,CAEjB;IAEV;;;;;OAKG;IACH,oBAKE;IAEF;;;;OAIG;IACH,gBAAqC;IAgBrC;;;;OAIG;IACH,kBAFW,iBAAiB,UAI1B;IAEF;;;;;OAKG;IACH,kCAEE;IAEF;;;;;;;;;OASG;IACH,yCANW,KAAK,GAAC,MAAM,GAAC,KAAK,GAAC,QAAQ,GAAC,OAAO,GAAC,SAAS,0EAuBtD;IAEF;;;;;OAKG;IACH,mDAgBE;IAEF;;;;;;OAMG;IACH,mEAmBE;IAEF;;;;;;OAMG;IACH,8DAsBE;IAEF;;;;;;OAMG;IACH,+CAwBE;IAEF;;;;OAIG;IACH,2CAsBE;IAEF;;;;;OAKG;IACH,6CAuBE;IAEF;;;;;;OAMG;IACH,oDAGE;IAEF;;;;;OAKG;IACH,+CAqBE;IAEF;;;;;;;;OAQG;IACH,4CAJW,KAAK,GAAC,QAAQ,GAAC,KAAK,WACpB,oBAAoB,KAClB,sBAAsB,CAwBjC;IAEF;;;;;;OAMG;IACH,kCAFW,kBAAkB,kBAwB3B;IAEF;;;;;;;OAOG;IACH,uDAFa,qBAAqB,CAuBhC;IAEF;;;;;;OAMG;IACH,8BAHW,OAAO,GAAC,UAAU,KAChB,qBAAqB,EAAE,CAyBlC;IAEF;;;;;;OAMG;IACH,qCAFa,qBAAqB,EAAE,CAqElC;IAEF;;;;;;OAMG;IACH,2CAFa,aAAa,EAAE,CAqB1B;IAEF;;;;;;OAMG;IACH,0CAFa,aAAa,EAAE,CAoB1B;IAEF;;;;;OAKG;IACH,uBAFa,oBAAoB,EAAE,CAoBjC;IAEF;;;;;OAKG;IACH,sBAFa,mBAAmB,CAoB9B;IAEF;;;;;;OAMG;IACH,wCAFa,aAAa,CAoBxB;IAEF;;;;;;OAMG;IACH,yEAwBE;IAEF;;;;;;;;;;;;;OAaG;IACH,oIALW,mBAAmB,EAAE,gDAGnB,qBAAqB,CAwChC;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,mBAAmB,EAAE,2EAInB,qBAAqB,CAqChC;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;OAMG;IACH,kEAsBE;IAEF;;;;;OAKG;IACH,kDAqBE;IAEF;;;;;;;;OAQG;IACH,sEAsCE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;IAEF;;;;;;OAMG;IACH,0DAsBE;IAEF;;;;;;OAMG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,gEAqBE;IAEF;;;;;;OAMG;IACH,sCAFa,eAAe,CAoB1B;IAEF;;;;;;OAMG;IACH,oCAFa,qBAAqB,EAAE,CAoBlC;IAEF;;;;;OAKG;IACH,mDAqBE;IAEF;;;;OAIG;IACH,kCAkBE;IAEF;;;;;;;;;OASG;IACH,uIAiCE;IAEF;;;;;OAKG;IACH,cAHa,oBAAoB,EAAE,CA0BjC;IAEF;;;;;;OAMG;IACH,6BAHa,oBAAoB,CAwB/B;IAEF;;;;;;;;;OASG;IACH,kEAJW,aAAa,EAAE,uCA6BxB;IAEF;;;;;;;;;OASG;IACH,6FAHW,MAAM,kBAkCf;CACH"}

package/dist/index.cjs

@@ -7,7 +7,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @typedef {Object} SidechatPostOrComment
  * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
  * @prop {String} id - alphanumeric ID of post or comment
- * @prop {Boolean} authored_by_user - undocumented
+ * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
  * @prop {String} alias - post creator's name in-app
  * @prop {String} group_id - alphanumeric ID of group
  * @prop {SidechatGroup} group - group in which post or comment was created
@@ -21,8 +21,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @prop {String[]} tags - undocumented
  * @prop {SidechatIdentity} identity - creator's identity information
  * @prop {Boolean} pinned - undocumented
- * @prop {Boolean} is_saved - undocumented
- * @prop {"following"|"not_following"} follow_status - undocumented
+ * @prop {Boolean} is_saved - whether or not the current user has saved the post
+ * @prop {"following"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
  * @prop {"group"} [destination] - undocumented
  * @prop {Number} [comment_count] - number of comments on post (only if type=post)
  * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
@@ -86,6 +86,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @prop {Boolean} posted_with_username - undocumented
  */
 
+/**
+ * A conversation icon associated with a user
+ * @typedef {Object} SidechatIcon
+ * @prop {String} emoji - unicode emoji character
+ * @prop {String} color - primary hex color code
+ * @prop {String} secondary_color - secondary hex color code
+ */
+
 /**
  * The current user's information
  * @typedef {Object} SidechatCurrentUser
@@ -99,6 +107,22 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
  */
 
+/**
+ * A user's public profile
+ * @typedef {Object} SidechatProfile
+ * @prop {String} id - alphanumeric ID of user
+ * @prop {String} name - public-facing username
+ * @prop {SidechatIcon} conversation_icon - icon associated with user
+ * @prop {Boolean} description - the user bio
+ * @prop {String} index_name - undocumented
+ * @prop {String} analytics_name - undocumented
+ * @prop {String} color - undocumented
+ * @prop {String} share_color_start - undocumented
+ * @prop {String} share_color_end - undocumented
+ * @prop {"account"} group_join_type - undocumented
+ * @prop {"public_to_all"} group_visibility - the profile visibility status
+ */
+
 /**
  * Representation of a group membership
  * @typedef {Object} SidechatMembership
@@ -133,7 +157,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @prop {SidechatCursorString} cursor
  */
 
-var SidechatTypes = {};
 
 /**
  * A direct message thread
@@ -170,7 +193,7 @@ var SidechatTypes = {};
  * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
  * @prop {Number} view_results_count - number of users who have viewed poll results
  * @prop {Boolean} participated - whether or not current user has voted in poll
- */
+*/
 
 /**
  * Represents a poll choice
@@ -178,7 +201,9 @@ var SidechatTypes = {};
  * @prop {Number} count - number of votes for choice
  * @prop {String} text - user-visible text of choice
  * @prop {Boolean} selected - whether or not current user has voted for choice
- */
+*/
+
+var SidechatTypes = {};
 
 /**
  * Throwable error caused by the Sidechat API
@@ -734,6 +759,33 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Searches for new groups based on a query keyword
+   * @method
+   * @since 2.6.0
+   * @param {String} query - the string to search for.  This will be encoded, so strings with spaces and special characters are okay.
+   * @returns {SidechatGroup[]}
+   */
+  searchAvailableGroups = async (query) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/groups/explore/search?term=${encodeURIComponent(query)}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
+      const json = await res.json();
+      return await json.results;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to search groups.`);
+    }
+  };
+
   /**
    * 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
@@ -1219,6 +1271,60 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Fetches a public user profile
+   * @method
+   * @since 2.6.0
+   * @param {String} username - username of the user to fetch
+   * @returns {SidechatProfile}
+   */
+  getUserProfile = async (username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/groups/username?username=${username}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        }
+      });
+      const json = await res.json();
+      return await json.group;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set icon.`);
+    }
+  };
+
+  /**
+   * Fetches a public user's posts
+   * @method
+   * @since 2.6.0
+   * @param {String} username - username of the user to fetch
+   * @returns {SidechatPostOrComment[]}
+   */
+  getUserPosts = async (username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/users/posts?username=${username}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        }
+      });
+      const json = await res.json();
+      return await json.posts;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set icon.`);
+    }
+  };
+
   /**
    * Marks an activity item as read
    * @method
@@ -1274,8 +1380,13 @@ class SidechatAPIClient {
   };
 
   /**
-   * Joins a group chat
+   * Joins a group chat.  To mimic the official client, use the user's display name and icon by default.
    * @method
+   * @param {String} groupChatID - alphanumeric ID of group chat to join
+   * @param {String} displayName - display name to use in chat
+   * @param {String} emoji - emoji to use as icon
+   * @param {String} primaryColor - hex string of primary color
+   * @param {String} secondaryColor - hex string of secondary color
    * @since 2.3.5
    */
   joinGroupChat = async (

package/dist/index.mjs

@@ -3,7 +3,7 @@
  * @typedef {Object} SidechatPostOrComment
  * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
  * @prop {String} id - alphanumeric ID of post or comment
- * @prop {Boolean} authored_by_user - undocumented
+ * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
  * @prop {String} alias - post creator's name in-app
  * @prop {String} group_id - alphanumeric ID of group
  * @prop {SidechatGroup} group - group in which post or comment was created
@@ -17,8 +17,8 @@
  * @prop {String[]} tags - undocumented
  * @prop {SidechatIdentity} identity - creator's identity information
  * @prop {Boolean} pinned - undocumented
- * @prop {Boolean} is_saved - undocumented
- * @prop {"following"|"not_following"} follow_status - undocumented
+ * @prop {Boolean} is_saved - whether or not the current user has saved the post
+ * @prop {"following"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
  * @prop {"group"} [destination] - undocumented
  * @prop {Number} [comment_count] - number of comments on post (only if type=post)
  * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
@@ -82,6 +82,14 @@
  * @prop {Boolean} posted_with_username - undocumented
  */
 
+/**
+ * A conversation icon associated with a user
+ * @typedef {Object} SidechatIcon
+ * @prop {String} emoji - unicode emoji character
+ * @prop {String} color - primary hex color code
+ * @prop {String} secondary_color - secondary hex color code
+ */
+
 /**
  * The current user's information
  * @typedef {Object} SidechatCurrentUser
@@ -95,6 +103,22 @@
  * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
  */
 
+/**
+ * A user's public profile
+ * @typedef {Object} SidechatProfile
+ * @prop {String} id - alphanumeric ID of user
+ * @prop {String} name - public-facing username
+ * @prop {SidechatIcon} conversation_icon - icon associated with user
+ * @prop {Boolean} description - the user bio
+ * @prop {String} index_name - undocumented
+ * @prop {String} analytics_name - undocumented
+ * @prop {String} color - undocumented
+ * @prop {String} share_color_start - undocumented
+ * @prop {String} share_color_end - undocumented
+ * @prop {"account"} group_join_type - undocumented
+ * @prop {"public_to_all"} group_visibility - the profile visibility status
+ */
+
 /**
  * Representation of a group membership
  * @typedef {Object} SidechatMembership
@@ -129,7 +153,6 @@
  * @prop {SidechatCursorString} cursor
  */
 
-var SidechatTypes = {};
 
 /**
  * A direct message thread
@@ -166,7 +189,7 @@ var SidechatTypes = {};
  * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
  * @prop {Number} view_results_count - number of users who have viewed poll results
  * @prop {Boolean} participated - whether or not current user has voted in poll
- */
+*/
 
 /**
  * Represents a poll choice
@@ -174,7 +197,9 @@ var SidechatTypes = {};
  * @prop {Number} count - number of votes for choice
  * @prop {String} text - user-visible text of choice
  * @prop {Boolean} selected - whether or not current user has voted for choice
- */
+*/
+
+var SidechatTypes = {};
 
 /**
  * Throwable error caused by the Sidechat API
@@ -730,6 +755,33 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Searches for new groups based on a query keyword
+   * @method
+   * @since 2.6.0
+   * @param {String} query - the string to search for.  This will be encoded, so strings with spaces and special characters are okay.
+   * @returns {SidechatGroup[]}
+   */
+  searchAvailableGroups = async (query) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/groups/explore/search?term=${encodeURIComponent(query)}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
+      const json = await res.json();
+      return await json.results;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to search groups.`);
+    }
+  };
+
   /**
    * 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
@@ -1215,6 +1267,60 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Fetches a public user profile
+   * @method
+   * @since 2.6.0
+   * @param {String} username - username of the user to fetch
+   * @returns {SidechatProfile}
+   */
+  getUserProfile = async (username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/groups/username?username=${username}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        }
+      });
+      const json = await res.json();
+      return await json.group;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set icon.`);
+    }
+  };
+
+  /**
+   * Fetches a public user's posts
+   * @method
+   * @since 2.6.0
+   * @param {String} username - username of the user to fetch
+   * @returns {SidechatPostOrComment[]}
+   */
+  getUserPosts = async (username) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/users/posts?username=${username}`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        }
+      });
+      const json = await res.json();
+      return await json.posts;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set icon.`);
+    }
+  };
+
   /**
    * Marks an activity item as read
    * @method
@@ -1270,8 +1376,13 @@ class SidechatAPIClient {
   };
 
   /**
-   * Joins a group chat
+   * Joins a group chat.  To mimic the official client, use the user's display name and icon by default.
    * @method
+   * @param {String} groupChatID - alphanumeric ID of group chat to join
+   * @param {String} displayName - display name to use in chat
+   * @param {String} emoji - emoji to use as icon
+   * @param {String} primaryColor - hex string of primary color
+   * @param {String} secondaryColor - hex string of secondary color
    * @since 2.3.5
    */
   joinGroupChat = async (

package/dist/types/SidechatTypes.d.ts

@@ -13,7 +13,7 @@ export type SidechatPostOrComment = {
      */
     id: string;
     /**
-     * - undocumented
+     * - whether or not the post or comment was created by the current user
      */
     authored_by_user: boolean;
     /**
@@ -69,11 +69,11 @@ export type SidechatPostOrComment = {
      */
     pinned: boolean;
     /**
-     * - undocumented
+     * - whether or not the current user has saved the post
      */
     is_saved: boolean;
     /**
-     * - undocumented
+     * - whether or not the current user should recieve activity notifications for the post
      */
     follow_status: "following" | "not_following";
     /**
@@ -246,6 +246,23 @@ export type SidechatIdentity = {
      */
     posted_with_username: boolean;
 };
+/**
+ * A conversation icon associated with a user
+ */
+export type SidechatIcon = {
+    /**
+     * - unicode emoji character
+     */
+    emoji: string;
+    /**
+     * - primary hex color code
+     */
+    color: string;
+    /**
+     * - secondary hex color code
+     */
+    secondary_color: string;
+};
 /**
  * The current user's information
  */
@@ -280,6 +297,55 @@ export type SidechatCurrentUser = {
      */
     wildcardEmailDomain: string;
 };
+/**
+ * A user's public profile
+ */
+export type SidechatProfile = {
+    /**
+     * - alphanumeric ID of user
+     */
+    id: string;
+    /**
+     * - public-facing username
+     */
+    name: string;
+    /**
+     * - icon associated with user
+     */
+    conversation_icon: SidechatIcon;
+    /**
+     * - the user bio
+     */
+    description: boolean;
+    /**
+     * - undocumented
+     */
+    index_name: string;
+    /**
+     * - undocumented
+     */
+    analytics_name: string;
+    /**
+     * - undocumented
+     */
+    color: string;
+    /**
+     * - undocumented
+     */
+    share_color_start: string;
+    /**
+     * - undocumented
+     */
+    share_color_end: string;
+    /**
+     * - undocumented
+     */
+    group_join_type: "account";
+    /**
+     * - the profile visibility status
+     */
+    group_visibility: "public_to_all";
+};
 /**
  * Representation of a group membership
  */

package/dist/types/SidechatTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SidechatTypes.d.ts","sourceRoot":"","sources":["../../src/types/SidechatTypes.js"],"names":[],"mappings":";;;;;;;;;UAGU,MAAM,GAAC,SAAS;;;;;;;;;;;;;;;;;;;;WAKhB,aAAa;;;;;;;;;;;;;;;;iBAIb,kBAAkB;;;;YAClB,mBAAmB,EAAE;;;;;;;;;;;;UAGrB,QAAQ;;;;cACR,gBAAgB;;;;;;;;;;;;mBAGhB,WAAW,GAAC,eAAe;;;;kBAC3B,OAAO;;;;;;;;;;;;WAGP,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAYZ,YAAY,GAAC,QAAQ;;;;;;;;qBAErB,MAAM,GAAC,QAAQ,GAAC,cAAc;;;;sBAC9B,SAAS,GAAC,eAAe,GAAC,mBAAmB;;;;8BAC7C,MAAM,GAAC,MAAM;;;;;;;;;;;;eAGb,uBAAuB;;;;;;;;;;;;;;;;;;;;;UASvB,OAAO;;;;kBACP,MAAM,GAAC,KAAK,GAAC,KAAK;;;;;;;;;;;;UAGlB,uBAAuB;;;;;;;;;;;;;;;;;cAQvB,qBAAqB;;;;SACrB,uBAAuB;;;;;;;;;;;;;;;;;UAQvB,OAAO;;;;kBACP,MAAM,GAAC,KAAK,GAAC,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBlB,kBAAkB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAyBjB,QAAQ,GAAC,UAAU,GAAC,MAAM;;;;;;;;;WAW7B,qBAAqB,EAAE;YACvB,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAapB,UAAU;;;;UACV,MAAM,GAAC,SAAS;;;;cAChB,qBAAqB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAavB,SAAS;;;;;;;;;;;;;;;;;aAQT,kBAAkB,EAAE"}
+{"version":3,"file":"SidechatTypes.d.ts","sourceRoot":"","sources":["../../src/types/SidechatTypes.js"],"names":[],"mappings":";;;;;;;;;UAGU,MAAM,GAAC,SAAS;;;;;;;;;;;;;;;;;;;;WAKhB,aAAa;;;;;;;;;;;;;;;;iBAIb,kBAAkB;;;;YAClB,mBAAmB,EAAE;;;;;;;;;;;;UAGrB,QAAQ;;;;cACR,gBAAgB;;;;;;;;;;;;mBAGhB,WAAW,GAAC,eAAe;;;;kBAC3B,OAAO;;;;;;;;;;;;WAGP,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAYZ,YAAY,GAAC,QAAQ;;;;;;;;qBAErB,MAAM,GAAC,QAAQ,GAAC,cAAc;;;;sBAC9B,SAAS,GAAC,eAAe,GAAC,mBAAmB;;;;8BAC7C,MAAM,GAAC,MAAM;;;;;;;;;;;;eAGb,uBAAuB;;;;;;;;;;;;;;;;;;;;;UASvB,OAAO;;;;kBACP,MAAM,GAAC,KAAK,GAAC,KAAK;;;;;;;;;;;;UAGlB,uBAAuB;;;;;;;;;;;;;;;;;cAQvB,qBAAqB;;;;SACrB,uBAAuB;;;;;;;;;;;;;;;;;UAQvB,OAAO;;;;kBACP,MAAM,GAAC,KAAK,GAAC,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyBlB,kBAAkB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAWpB,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAOZ,SAAS;;;;sBACT,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;iCAsBZ,QAAQ,GAAC,UAAU,GAAC,MAAM;;;;;;;;;WAW7B,qBAAqB,EAAE;YACvB,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAYpB,UAAU;;;;UACV,MAAM,GAAC,SAAS;;;;cAChB,qBAAqB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAavB,SAAS;;;;;;;;;;;;;;;;;aAQT,kBAAkB,EAAE"}