sidechat.js 1.0.0

package/index.js

@@ -0,0 +1,362 @@
+import "./types/SidechatTypes.js";
+import SidechatAPIError from "./classes/SidechatAPIError.js";
+const defaultHeaders = {
+  Accept: "application/json",
+  "Content-Type": "application/json",
+};
+
+/**
+ * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
+ */
+const loginViaSMS = async (phoneNumber) => {
+  try {
+    const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
+      method: "POST",
+      headers: defaultHeaders,
+      body: JSON.stringify({
+        phone_number: `+1${phoneNumber}`,
+        version: 3,
+      }),
+    });
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(error);
+    throw new SidechatAPIError("Failed to request SMS verification.");
+  }
+};
+
+/**
+ * Verify the code sent via SMS with loginViaSMS().
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
+ * @param {String} code  - the verification code
+ */
+const verifySMSCode = async (phoneNumber, code) => {
+  try {
+    const res = await fetch(`https://api.sidechat.lol/v1/verify_phone_number`, {
+      method: "POST",
+      headers: defaultHeaders,
+      body: JSON.stringify({
+        phone_number: `+1${phoneNumber}`,
+        code: code.toUpperCase(),
+      }),
+    });
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError("Failed verify this code.");
+  }
+};
+
+/**
+ * Set the user's age
+ * @param {Number} age - user's age in years
+ * @param {String} registrationID  - the registration ID generated by verifySMSCode()
+ */
+const setAge = async (age, registrationID) => {
+  if (age < 13) {
+    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: defaultHeaders,
+        body: JSON.stringify({
+          age: Number(age),
+          registration_id: registrationID,
+        }),
+      }
+    );
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError("Failed verify this code.");
+  }
+};
+
+/**
+ * Initiate the email setup process.  Should be followed up with checkEmailVerification().
+ * @param {String} email - school email address to send verification code to
+ * @param {String} token - user bearer token
+ */
+const registerEmail = async (email, token) => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v2/users/register_email`,
+      {
+        method: "POST",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+        body: JSON.stringify({
+          email: email,
+        }),
+      }
+    );
+    const json = await res.json();
+    if (json.message) {
+      throw new SidechatAPIError(json.message);
+    }
+    return json;
+  } catch (err) {
+    console.error(error);
+    throw new SidechatAPIError("Failed to request email verification.");
+  }
+};
+
+/**
+ * Check is the user's email is verified.
+ * @param {String} token - user bearer token
+ */
+const checkEmailVerification = async (token) => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v1/users/check_email_verified`,
+      {
+        method: "GET",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+      }
+    );
+    const json = await res.json();
+    if (json.verified_email_updates_response) {
+      return json.verified_email_updates_response;
+    } else {
+      throw new SidechatAPIError(json?.message || "Email is not verified.");
+    }
+  } catch (err) {
+    console.error(error);
+    throw new SidechatAPIError("Email is not verified.");
+  }
+};
+
+/**
+ * Set the device ID of the current user
+ * @param {String} deviceId - the device ID to set
+ * @param {String} token  - the user bearer token
+ */
+const setDeviceID = async (deviceID, token) => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v1/register_device_token`,
+      {
+        method: "POST",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+        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;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError("Failed verify this code.");
+  }
+};
+
+/**
+ * Get updated status for user and group
+ * @param {String} token - user bearer token
+ * @param {String} [groupID] - ID of a specific group to retrieve info from
+ * @returns
+ */
+const getUserAndGroup = async (token, groupID = "") => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
+      {
+        method: "GET",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+      }
+    );
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError(`Failed to get posts from group.`);
+  }
+};
+
+/**
+ * Fetches posts from the specified category in a group
+ * @param {String} groupID - group ID
+ * @param {String} token - user bearer token
+ * @param {"hot"|"recent"|"top"} category - category to filter posts
+ * @param {SidechatCursorString} [cursor] - cursor string
+ * @returns {{posts: SidechatPostOrComment[], cursor: SidechatCursorString}} List of posts and cursor
+ */
+const getGroupPosts = async (groupID, token, category = "hot", cursor) => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v1/posts?group_id=${groupID}&type=${category}${
+        cursor ? "&cursor=" + cursor : ""
+      }`,
+      {
+        method: "GET",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+      }
+    );
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError(`Failed to get posts from group.`);
+  }
+};
+
+/**
+ * Upvote or downvote, or unvote a post
+ * @param {String} postID - post ID to vote on
+ * @param {String} token - user bearer token
+ * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
+ * @returns
+ */
+const setVote = async (postID, token, action) => {
+  try {
+    const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
+      method: "POST",
+      headers: {
+        ...defaultHeaders,
+        Authorization: `Bearer ${token}`,
+      },
+      body: JSON.stringify({
+        post_id: postID,
+        vote_status: action,
+      }),
+    });
+    const json = await res.json();
+    return json;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError(`Failed to change the vote on post.`);
+  }
+};
+
+/**
+ * Get all the commments on a post
+ * @param {String} postID - post ID to get comments for
+ * @param {String} token - user bearer token
+ * @returns {SidechatPostOrComment[]} list of comments
+ */
+const getPostComments = async (postID, token) => {
+  try {
+    const res = await fetch(
+      `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
+      {
+        method: "GET",
+        headers: {
+          ...defaultHeaders,
+          Authorization: `Bearer ${token}`,
+        },
+      }
+    );
+    const json = await res.json();
+    // Function to preprocess the comments and organize them into a nested structure
+    function preprocessComments(apiComments) {
+      // Map to store comments by their IDs for efficient lookup
+      const commentMap = new Map();
+      // List to store top-level comments
+      const topLevelComments = [];
+
+      // Iterate through the API comments
+      apiComments.forEach((comment) => {
+        // Store the comment in the map with its ID as the key
+        commentMap.set(comment.id, comment);
+        // Get the parent comment using the reply_post_id
+        const parentComment = commentMap.get(comment.reply_post_id);
+        // Check if the comment is a top-level comment
+        if (
+          !parentComment ||
+          comment.reply_post_id === comment.parent_post_id
+        ) {
+          // If it's a top-level comment, push it to the topLevelComments array
+          topLevelComments.push(comment);
+        } else {
+          // If it's a reply, add it to the parent comment's replies array
+          if (!parentComment.replies) parentComment.replies = [];
+          parentComment.replies.push(comment);
+        }
+      });
+
+      // Flatten the nested structure and return a single list of comments
+      return flattenComments(topLevelComments);
+    }
+
+    // Function to flatten nested comments into a single list
+    function flattenComments(comments) {
+      // Use reduce to flatten the nested comments array into a single list
+      return comments.reduce((flatComments, comment) => {
+        // Push the current comment to the flatComments array
+        flatComments.push(comment);
+        // If the current comment has replies, recursively flatten them and push to the flatComments array
+        if (comment.replies)
+          flatComments.push(...flattenComments(comment.replies));
+        // Return the flatComments array
+        return flatComments;
+      }, []);
+    }
+
+    const sortedComments = preprocessComments(json.posts);
+    return sortedComments;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError(`Failed to get comments on post.`);
+  }
+};
+
+/**
+ * Gets groups to be displayed on the "Explore Groups" page
+ * @param {String} token - user bearer token
+ * @returns {SidechatGroup}
+ */
+const getAvailableGroups = async (token) => {
+  try {
+    const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
+      method: "GET",
+      headers: {
+        ...defaultHeaders,
+        Authorization: `Bearer ${token}`,
+      },
+    });
+    const json = await res.json();
+    return json.groups;
+  } catch (err) {
+    console.error(err);
+    throw new SidechatAPIError(`Failed to get groups from explore.`);
+  }
+};
+
+export {
+  loginViaSMS,
+  verifySMSCode,
+  setAge,
+  setDeviceID,
+  registerEmail,
+  checkEmailVerification,
+  getUserAndGroup,
+  getGroupPosts,
+  setVote,
+  getPostComments,
+  getAvailableGroups,
+};

package/jsdoc.json

@@ -0,0 +1,38 @@
+{
+  "source": {
+    "include": [
+      "index.js",
+      "package.json",
+      "README.md",
+      "types/SidechatTypes.js",
+      "classes/SidechatAPIError.js"
+    ],
+    "includePattern": ".js$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "encoding": "utf8",
+    "readme": "./README.md",
+    "destination": "docs/",
+    "package": "./package.json",
+    "recurse": true,
+    "verbose": true,
+    "template": "./node_modules/clean-jsdoc-theme",
+    "theme_opts": {
+      "default_theme": "dark",
+      "homepageTitle": "Sidechat.js Documentation",
+      "menu": [
+        {
+          "title": "Offsides (Sidechat for Android)",
+          "link": "https://github.com/micahlt/offsides#README.md",
+          "target": "_blank"
+        }
+      ]
+    }
+  },
+  "markdown": {
+    "hardwrap": false,
+    "idInHeadings": true
+  }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "sidechat.js",
+  "version": "1.0.0",
+  "description": "A reverse-engineered API wrapper for Sidechat",
+  "type": "module",
+  "source": "index.js",
+  "exports": {
+    "require": "./dist/sidechat.cjs",
+    "default": "./dist/sidechat.modern.js"
+  },
+  "main": "./dist/sidechat.cjs",
+  "module": "./dist/sidechat.module.js",
+  "unpkg": "./dist/sidechat.umd.js",
+  "scripts": {
+    "build": "microbundle",
+    "dev": "microbundle watch",
+    "docs": "npx jsdoc --configure jsdoc.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/micahlt/sidechat.js.git"
+  },
+  "author": "Micah Lindley",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/micahlt/sidechat.js/issues"
+  },
+  "homepage": "https://github.com/micahlt/sidechat.js#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.2.17",
+    "microbundle": "^0.15.1"
+  }
+}

package/tests/basicTest.js

@@ -0,0 +1,8 @@
+import * as API from "../index.js";
+
+async function main() {
+  const res = await API.setVote();
+  console.log(await res);
+}
+
+main();

package/types/SidechatTypes.js

@@ -0,0 +1,79 @@
+/**
+ * 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 {SidechatAsset[]} assets - array of 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
+ * @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} SidechatAsset
+ * @prop {String} id - alphanumeric ID of asset
+ * @prop {"image"} type - undocumented
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
+ * @prop {Number} width - the width of asset
+ * @prop {Number} height - the height of asset
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
+ */
+
+/**
+ * A user's identity information
+ * @typedef {Object} SidechatIdentity
+ * @prop {String} name - representation of user's name (varies across app)
+ * @prop {Boolean} posted_with_username - undocumented
+ */
+
+/**
+ * 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
+ */
+
+/**
+ * Represents a vote on a comment or post
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
+ */