sidechat.js 2.4.1 → 2.4.4

package/dist/index.mjs

@@ -1,3 +1,161 @@
+/**
+ * A user-created post or comment, depending on the "type" prop
+ * @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 {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
+ * @prop {String} text - text content of post or comment
+ * @prop {String} created_at - date string of post or comment creation time
+ * @prop {Number} vote_total - sum of upvotes and downvotes
+ * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
+ * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
+ * @prop {Array} attachments - undocumented
+ * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
+ * @prop {Array} 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 {"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)
+ * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
+ * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
+ * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
+ */
+
+/**
+ * A group object, containing metadata about a group as well as its join conditions and states.  Some properties vary based on the endpoint the object came from.
+ * @typedef {Object} SidechatGroup
+ * @prop {String} id - alphanumeric ID of group
+ * @prop {String} name - human-readable name of group
+ * @prop {String} analytics_name - name to file group under
+ * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
+ * @prop {String} color -  group's theme color as hex code (e.g., #FFFFFF)
+ * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
+ * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
+ * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
+ * @prop {Array} [roles] - undocumented
+ * @prop {String} [description] - description of group
+ * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
+ * @prop {Number} [member_count] - number of users in group
+ * @prop {Boolean} [should_show_leaderboard] - undocumented
+ */
+
+/**
+ * An asset object, containing information about an image within a post or comment
+ * @typedef {Object} SidechatSimpleAsset
+ * @prop {String} id - alphanumeric ID of asset
+ * @prop {"image"} type - undocumented
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
+ * @prop {Number} width - width of asset
+ * @prop {Number} height - height of asset
+ * @prop {SidechatPrivateAssetURL} [url] - URL string of asset's location
+ */
+
+/**
+ * An asset object, containing information about an image from the asset library
+ * @typedef {Object} SidechatLibraryAsset
+ * @prop {String} id - alphanumeric ID of asset
+ * @prop {String} created_at - date string of asset creation time
+ * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
+ */
+
+/**
+ * An asset object, containing information about an image from the asset library
+ * @typedef {Object} SidechatAssetMetadata
+ * @prop {Number} width - width of asset
+ * @prop {Number} height - height of asset
+ * @prop {"image"} type - undocumented
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
+ */
+
+/**
+ * A user's anonymous identity information
+ * @typedef {Object} SidechatIdentity
+ * @prop {String} name - representation of user's name (varies across app)
+ * @prop {Boolean} posted_with_username - undocumented
+ */
+
+/**
+ * The current user's information
+ * @typedef {Object} SidechatCurrentUser
+ * @prop {String} id - alphanumeric ID of current user
+ * @prop {String} hashedVerifiedEmail - verified email of current user in an unreadable hashed form
+ * @prop {Boolean} isGlobalModerator - whether or not user is a moderator
+ * @prop {Boolean} isGlobalAdmin - whether or not user is an admin
+ * @prop {SidechatMembership[]} memberships
+ * @prop {Array} roles - undocumented
+ * @prop {String} emailDomain - domain of verified email address on account
+ * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
+ */
+
+/**
+ * Representation of a group membership
+ * @typedef {Object} SidechatMembership
+ * @prop {String} groupId - alphanumeric ID of group
+ * @prop {String} type - role of current user in group
+ */
+
+/**
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
+ * @typedef {String} SidechatPrivateAssetURL
+ */
+
+/**
+ * A cursor for paginating through post lists
+ * @typedef {String} SidechatCursorString
+ */
+
+/**
+ * A vote on a comment or post
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
+ */
+
+/**
+ * A user's bearer authentication token needed for most requests
+ * @typedef {String} SidechatAuthToken
+ */
+
+/**
+ * A list of posts and the associated cursor
+ * @typedef {Object} SidechatPostsAndCursor
+ * @prop {SidechatPostOrComment[]} posts
+ * @prop {SidechatCursorString} cursor
+ */
+
+var SidechatTypes = {};
+
+/**
+ * A direct message thread
+ * @typedef {Object} SidechatDirectThread
+ * @prop {String} id - alphanumeric ID of thread
+ * @prop {String} group_id - alphanumeric ID of group in which the thread exists
+ * @prop {String} updated_at - date string of when the last message in the chat was sent
+ * @prop {String} post_id - post or comment from which the thread was originally sent
+ * @prop {String} post_context - the context of the DM thread (only "feed" is known at the moment)
+ * @prop {"accepted"} accept_status - whether or not the other user has accepted this DM
+ * @prop {"post"|"comment"} type - the type of the content from which the DM was originally sent
+ * @prop {SidechatDirectMessage[]} messages - array of direct message objects
+ */
+
+/**
+ * A single direct message
+ * @typedef {Object} SidechatDirectMessage
+ * @prop {String} created_at - time at which the message was sent
+ * @prop {String} client_id - alphanumeric ID of the device the message was sent on
+ * @prop {String} obfuscatedUserId - obfuscated version of the sender's alphanumeric ID
+ * @prop {String} text - body text of the message
+ * @prop {String} id - alphanumeric ID of the message
+ * @prop {String} chat_id - alphanumeric ID of the thread in which the message resides
+ * @prop {Boolean} authored_by_user - whether or not the current user sent the message
+ * @prop {"message"} type - undocumented
+ */
+
 /**
  * Throwable error caused by the Sidechat API
  * @class
@@ -938,7 +1096,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(`${this.apiRoot}/v1/chats/groups/join`, {
-        method: "GET",
+        method: "POST",
         headers: {
           ...this.defaultHeaders,
           Authorization: `Bearer ${this.userToken}`,
@@ -960,6 +1118,147 @@ class SidechatAPIClient {
       throw new SidechatAPIError(`Failed to join groupchat.`);
     }
   };
+
+  /**
+   * Gets a list of the user's direct messages
+   * @method
+   * @returns {SidechatDirectThread[]}
+   * @since 2.4.4
+   */
+  getDMs = async () => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/chats`, {
+        method: "GET",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+      });
+      const json = await res.json();
+      const list = await json.chats;
+      let r = [];
+      list.forEach((o) => {
+        r.push(o.chat);
+      });
+      return await r;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to fetch DMs.`);
+    }
+  };
+
+  /**
+   * Gets a single direct message thread
+   * @method
+   * @param {String} id - alphanumeric ID of the chat to fetch
+   * @returns {SidechatDirectThread}
+   * @since 2.4.4
+   */
+  getDMThread = async (id) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(
+        `${this.apiRoot}/v1/chats/messages?chat_id=${id}`,
+        {
+          method: "GET",
+          headers: {
+            ...this.defaultHeaders,
+            Authorization: `Bearer ${this.userToken}`,
+          },
+        }
+      );
+      const json = await res.json();
+      return await json.chat;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to fetch DM thread.`);
+    }
+  };
+
+  /**
+   * Sends a message to an existing direct message thread - note that you must first use startDM() to start a thread.
+   * @method
+   * @param {String} chatID - alphanumeric ID of the chat to send to
+   * @param {String} text - text content of message
+   * @param {String} clientID - alphanumeric device ID
+   * @param {SidechatAsset[]} - array of assets to send
+   * @param {Boolean} anonymous - whether the DM should be sent anonymously
+   * @since 2.4.4
+   */
+  sendDM = async (chatID, text, clientID, assets = [], anonymous = false) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/chats/send`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          chat_id: chatID,
+          text: text,
+          client_id: clientID,
+          anonymous: anonymous,
+          assets: assets,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to fetch DMs.`);
+    }
+  };
+
+  /**
+   * Creates a new direct message thread
+   * @method
+   * @param {String} text - text content of message
+   * @param {String} clientID - alphanumeric ID of devide
+   * @param {String} postID - alphanumeric ID of post or comment
+   * @param {Boolean} anonymous - whether the DM should be sent anonymously
+   * @param {"feed"} postContext - context of post (mostly undocumented, defaults to "feed")
+   * @since 2.4.4
+   */
+  startDM = async (
+    text,
+    clientID,
+    postID,
+    anonymous = false,
+    postContext = "feed"
+  ) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/chats/send`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          text: text,
+          client_id: clientID,
+          post_id: postID,
+          anonymous: anonymous,
+          post_context: postContext,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to fetch DMs.`);
+    }
+  };
 }
 
 /**
@@ -1037,4 +1336,4 @@ class SidechatColorList {
   ];
 }
 
-export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
+export { SidechatAPIClient, SidechatAPIError, SidechatColorList, SidechatTypes };

package/dist/types/SidechatTypes.d.ts

@@ -312,4 +312,78 @@ export type SidechatPostsAndCursor = {
     posts: SidechatPostOrComment[];
     cursor: SidechatCursorString;
 };
+/**
+ * A direct message thread
+ */
+export type SidechatDirectThread = {
+    /**
+     * - alphanumeric ID of thread
+     */
+    id: string;
+    /**
+     * - alphanumeric ID of group in which the thread exists
+     */
+    group_id: string;
+    /**
+     * - date string of when the last message in the chat was sent
+     */
+    updated_at: string;
+    /**
+     * - post or comment from which the thread was originally sent
+     */
+    post_id: string;
+    /**
+     * - the context of the DM thread (only "feed" is known at the moment)
+     */
+    post_context: string;
+    /**
+     * - whether or not the other user has accepted this DM
+     */
+    accept_status: "accepted";
+    /**
+     * - the type of the content from which the DM was originally sent
+     */
+    type: "post" | "comment";
+    /**
+     * - array of direct message objects
+     */
+    messages: SidechatDirectMessage[];
+};
+/**
+ * A single direct message
+ */
+export type SidechatDirectMessage = {
+    /**
+     * - time at which the message was sent
+     */
+    created_at: string;
+    /**
+     * - alphanumeric ID of the device the message was sent on
+     */
+    client_id: string;
+    /**
+     * - obfuscated version of the sender's alphanumeric ID
+     */
+    obfuscatedUserId: string;
+    /**
+     * - body text of the message
+     */
+    text: string;
+    /**
+     * - alphanumeric ID of the message
+     */
+    id: string;
+    /**
+     * - alphanumeric ID of the thread in which the message resides
+     */
+    chat_id: string;
+    /**
+     * - whether or not the current user sent the message
+     */
+    authored_by_user: boolean;
+    /**
+     * - undocumented
+     */
+    type: "message";
+};
 //# sourceMappingURL=SidechatTypes.d.ts.map

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;;;;;;;;;;;;;;;;cAIrB,gBAAgB;;;;;;;;;;;;mBAGhB,WAAW,GAAC,eAAe;;;;kBAC3B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAcP,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"}
+{"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;;;;;;;;;;;;;;;;cAIrB,gBAAgB;;;;;;;;;;;;mBAGhB,WAAW,GAAC,eAAe;;;;kBAC3B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAcP,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"}