sidechat.js 2.5.2 → 2.5.4

package/dist/classes/SidechatAPIClient.d.ts

@@ -227,6 +227,21 @@ declare class SidechatAPIClient {
      * @param {String} postOrCommentID - alphanumeric ID of post to delete
      */
     deletePostOrComment: (postOrCommentID: string) => Promise<any>;
+    /**
+     * Votes on a poll attached to a post
+     * @method
+     * @param {String} pollId - alphanumeric ID of poll to vote on
+     * @param {Number} choiceIndex - index of the choice to vote on
+     * @since 2.5.4
+     */
+    voteOnPoll: (pollId: string, choiceIndex: number) => Promise<any>;
+    /**
+     * Marks that the user has viewed results on a poll.  Note that this does not actually return the results of the poll.
+     * @method
+     * @param {String} pollId - alphanumeric ID of poll to vote on
+     * @since 2.5.4
+     */
+    viewPollResults: (pollId: string) => Promise<any>;
     /**
      * Uploads an asset to AWS S3 for use in posts and comments.  Currently photos only
      * @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,yDAOC;IAtCD;;;SAGK;IACL,6BAAU;IAEV;;;;;OAKG;IACH,oBAKE;IAEF;;;;OAIG;IACH,gBAAqC;IAgBrC;;;;OAIG;IACH,6CAEE;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,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;;;;;;;;;;;;OAYG;IACH,0GALW,qBAAqB,sEAyC9B;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,qBAAqB,iGAyC9B;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;;;OAQG;IACH,sEAiDE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;IAEF;;;;;;OAMG;IACH,6CAwBE;IAEF;;;;;;OAMG;IACH,gEAqBE;IAEF;;;;;OAKG;IACH,mDAqBE;IAEF;;;;OAIG;IACH,kCAkBE;IAEF;;;;OAIG;IACH,wHAiCE;IAEF;;;;;OAKG;IACH,cAHa,sBAAsB,CA0BjC;IAEF;;;;;;OAMG;IACH,kDAqBE;IAEF;;;;;;;;;OASG;IACH,kEAJW,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,CAyBjC;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;;;;;;;;;;;;OAYG;IACH,0GALW,mBAAmB,EAAE,gDAGnB,qBAAqB,CAsChC;IAEF;;;;;;;;;;;OAWG;IACH,wDANW,mBAAmB,EAAE,2EAInB,qBAAqB,CAqChC;IAEF;;;;;OAKG;IACH,+DAqBE;IAEF;;;;;;OAMG;IACH,kEAsBE;IAEF;;;;;OAKG;IACH,kDAqBE;IAEF;;;;;;;;OAQG;IACH,sEAyCE;IAEF;;;;;;;;OAQG;IACH,2GA2BE;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"}

package/dist/index.cjs

@@ -18,7 +18,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @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 {String[]} tags - undocumented
  * @prop {SidechatIdentity} identity - creator's identity information
  * @prop {Boolean} pinned - undocumented
  * @prop {Boolean} is_saved - undocumented
@@ -26,6 +26,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @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 {SidechatPoll} [poll] - poll attached to post (only if the post has a poll)
  * @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)
@@ -158,6 +159,25 @@ var SidechatTypes = {};
  * @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
+ */
+
+/**
+ * Represents a poll with choices
+ * @typedef {Object} SidechatPoll
+ * @prop {String} id - alphanumeric ID of poll
+ * @prop {String} post_id - alphanumeric ID of post to which poll is attached
+ * @prop {SidechatPollChoice[]} choices - array of poll choices
+ * @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
+ * @typedef {Object} SidechatPollChoice
+ * @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
  */
 
 /**
@@ -956,6 +976,66 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Votes on a poll attached to a post
+   * @method
+   * @param {String} pollId - alphanumeric ID of poll to vote on
+   * @param {Number} choiceIndex - index of the choice to vote on
+   * @since 2.5.4
+   */
+  voteOnPoll = async (pollId, choiceIndex) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/polls/vote`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          poll_id: pollId,
+          choice: choiceIndex,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to vote on poll`);
+    }
+  };
+
+  /**
+   * Marks that the user has viewed results on a poll.  Note that this does not actually return the results of the poll.
+   * @method
+   * @param {String} pollId - alphanumeric ID of poll to vote on
+   * @since 2.5.4
+   */
+  viewPollResults = async (pollId) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/polls/view_results`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          poll_id: pollId,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to mark poll results as viewed.`);
+    }
+  };
+
   /**
    * Uploads an asset to AWS S3 for use in posts and comments.  Currently photos only
    * @method
@@ -970,20 +1050,12 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
 
-    let imageType;
-    switch (mimeType) {
-      case "image/png":
-        imageType = "png";
-        break;
-      case "image/jpeg":
-        imageType = "jpeg";
-        break;
-      default:
-        throw new SidechatAPIError("Unsupported image format.");
+    let imageType = mimeType.split("/")[1];
+    if (!["png", "jpeg", "gif"].includes(imageType)) {
+      throw new SidechatAPIError("Unsupported image format.");
     }
 
     const data = new FormData();
-
     data.append("image", {
       name: name,
       type: mimeType,

package/dist/index.mjs

@@ -14,7 +14,7 @@
  * @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 {String[]} tags - undocumented
  * @prop {SidechatIdentity} identity - creator's identity information
  * @prop {Boolean} pinned - undocumented
  * @prop {Boolean} is_saved - undocumented
@@ -22,6 +22,7 @@
  * @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 {SidechatPoll} [poll] - poll attached to post (only if the post has a poll)
  * @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)
@@ -154,6 +155,25 @@ var SidechatTypes = {};
  * @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
+ */
+
+/**
+ * Represents a poll with choices
+ * @typedef {Object} SidechatPoll
+ * @prop {String} id - alphanumeric ID of poll
+ * @prop {String} post_id - alphanumeric ID of post to which poll is attached
+ * @prop {SidechatPollChoice[]} choices - array of poll choices
+ * @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
+ * @typedef {Object} SidechatPollChoice
+ * @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
  */
 
 /**
@@ -952,6 +972,66 @@ class SidechatAPIClient {
     }
   };
 
+  /**
+   * Votes on a poll attached to a post
+   * @method
+   * @param {String} pollId - alphanumeric ID of poll to vote on
+   * @param {Number} choiceIndex - index of the choice to vote on
+   * @since 2.5.4
+   */
+  voteOnPoll = async (pollId, choiceIndex) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/polls/vote`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          poll_id: pollId,
+          choice: choiceIndex,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to vote on poll`);
+    }
+  };
+
+  /**
+   * Marks that the user has viewed results on a poll.  Note that this does not actually return the results of the poll.
+   * @method
+   * @param {String} pollId - alphanumeric ID of poll to vote on
+   * @since 2.5.4
+   */
+  viewPollResults = async (pollId) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await fetch(`${this.apiRoot}/v1/polls/view_results`, {
+        method: "POST",
+        headers: {
+          ...this.defaultHeaders,
+          Authorization: `Bearer ${this.userToken}`,
+        },
+        body: JSON.stringify({
+          poll_id: pollId,
+        }),
+      });
+      const json = await res.json();
+      return await json;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to mark poll results as viewed.`);
+    }
+  };
+
   /**
    * Uploads an asset to AWS S3 for use in posts and comments.  Currently photos only
    * @method
@@ -966,20 +1046,12 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
 
-    let imageType;
-    switch (mimeType) {
-      case "image/png":
-        imageType = "png";
-        break;
-      case "image/jpeg":
-        imageType = "jpeg";
-        break;
-      default:
-        throw new SidechatAPIError("Unsupported image format.");
+    let imageType = mimeType.split("/")[1];
+    if (!["png", "jpeg", "gif"].includes(imageType)) {
+      throw new SidechatAPIError("Unsupported image format.");
     }
 
     const data = new FormData();
-
     data.append("image", {
       name: name,
       type: mimeType,

package/dist/types/SidechatTypes.d.ts

@@ -59,7 +59,7 @@ export type SidechatPostOrComment = {
     /**
      * - undocumented
      */
-    tags: any[];
+    tags: string[];
     /**
      * - creator's identity information
      */
@@ -88,6 +88,10 @@ export type SidechatPostOrComment = {
      * - whether or not you can comment on post (only if type=post)
      */
     comments_disabled?: boolean;
+    /**
+     * - poll attached to post (only if the post has a poll)
+     */
+    poll?: SidechatPoll;
     /**
      * - alphanumeric ID of parent post (only if type=comment)
      */
@@ -386,4 +390,50 @@ export type SidechatDirectMessage = {
      */
     type: "message";
 };
+/**
+ * Represents a poll with choices
+ */
+export type SidechatPoll = {
+    /**
+     * - alphanumeric ID of poll
+     */
+    id: string;
+    /**
+     * - alphanumeric ID of post to which poll is attached
+     */
+    post_id: string;
+    /**
+     * - array of poll choices
+     */
+    choices: SidechatPollChoice[];
+    /**
+     * - whether or not poll results are publicly visible
+     */
+    allows_view_results: boolean;
+    /**
+     * - number of users who have viewed poll results
+     */
+    view_results_count: number;
+    /**
+     * - whether or not current user has voted in poll
+     */
+    participated: boolean;
+};
+/**
+ * Represents a poll choice
+ */
+export type SidechatPollChoice = {
+    /**
+     * - number of votes for choice
+     */
+    count: number;
+    /**
+     * - user-visible text of choice
+     */
+    text: string;
+    /**
+     * - whether or not current user has voted for choice
+     */
+    selected: boolean;
+};
 //# 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAapB,UAAU;;;;UACV,MAAM,GAAC,SAAS;;;;cAChB,qBAAqB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAavB,SAAS"}
+{"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"}