sidechat.js 2.4.1 → 2.4.2

package/dist/index.cjs

@@ -2,6 +2,138 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+/**
+ * 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 = {};
+
 /**
  * Throwable error caused by the Sidechat API
  * @class
@@ -1044,3 +1176,4 @@ class SidechatColorList {
 exports.SidechatAPIClient = SidechatAPIClient;
 exports.SidechatAPIError = SidechatAPIError;
 exports.SidechatColorList = SidechatColorList;
+exports.SidechatTypes = SidechatTypes;

package/dist/index.d.mts

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

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import SidechatAPIClient from "./classes/SidechatAPIClient.js";
 import SidechatAPIError from "./classes/SidechatAPIError.js";
 import SidechatColorList from "./classes/SidechatColorList.js";
-export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
+import SidechatTypes from "./types/SidechatTypes.js";
+export { SidechatAPIClient, SidechatAPIError, SidechatColorList, SidechatTypes };
 //# 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;8BAC9B,gCAAgC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"8BAC8B,gCAAgC;6BACjC,+BAA+B;8BAC9B,gCAAgC;0BAHpC,0BAA0B"}

package/dist/index.mjs

@@ -1,3 +1,135 @@
+/**
+ * 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 = {};
+
 /**
  * Throwable error caused by the Sidechat API
  * @class
@@ -1037,4 +1169,4 @@ class SidechatColorList {
   ];
 }
 
-export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
+export { SidechatAPIClient, SidechatAPIError, SidechatColorList, SidechatTypes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sidechat.js",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "A reverse-engineered API wrapper for Sidechat",
   "type": "module",
   "source": "./src/index.js",

package/src/index.js

@@ -1,6 +1,11 @@
-import "./types/SidechatTypes.js";
+import SidechatTypes from "./types/SidechatTypes.js";
 import SidechatAPIClient from "./classes/SidechatAPIClient.js";
 import SidechatAPIError from "./classes/SidechatAPIError.js";
 import SidechatColorList from "./classes/SidechatColorList.js";
 
-export { SidechatAPIClient, SidechatAPIError, SidechatColorList };
+export {
+  SidechatAPIClient,
+  SidechatAPIError,
+  SidechatColorList,
+  SidechatTypes,
+};