sidechat.js 2.0.3 → 2.0.4

package/src/classes/SidechatAPIClient.d.ts

@@ -1,104 +0,0 @@
-export default SidechatAPIClient;
-/**
- * API client class for making requests to Sidechat's private API.  You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.
- * @class
- * @since 2.0.0-alpha.0
- */
-declare class SidechatAPIClient {
-    /**
-     * Create a new instance of the API client
-     * @param {SidechatAuthToken} [token] - user bearer token
-     */
-    constructor(token?: SidechatAuthToken);
-    /**
-     * User bearer token
-     * @type {SidechatAuthToken}
-     * */
-    userToken: SidechatAuthToken;
-    /**
-     * Default headers for every API request
-     * @type {Object}
-     * @static
-     */
-    defaultHeaders: any;
-    /**
-     * Manually set the currently signed in user's token.  Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions
-     * @method
-     * @param {SidechatAuthToken} token - user bearer token
-     */
-    setToken: (token: SidechatAuthToken) => void;
-    /**
-     * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().
-     * @method
-     * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
-     */
-    loginViaSMS: (phoneNumber: number) => Promise<any>;
-    /**
-     * Verify the code sent via SMS with loginViaSMS().
-     * @method
-     * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
-     * @param {String} code  - the verification code
-     */
-    verifySMSCode: (phoneNumber: number, code: string) => Promise<any>;
-    /**
-     * Set the user's age
-     * @method
-     * @param {Number} age - user's age in years
-     * @param {String} registrationID  - the registration ID generated by verifySMSCode()
-     */
-    setAge: (age: number, registrationID: string) => Promise<any>;
-    /**
-     * Initiate the email setup process.  Should be followed up with checkEmailVerification().
-     * @method
-     * @param {String} email - school email address to send verification code to
-     * @tutorial Email Registration
-     */
-    registerEmail: (email: string) => Promise<any>;
-    /**
-     * Check is the user's email is verified.
-     * @method
-     */
-    checkEmailVerification: () => Promise<any>;
-    /**
-     * Set the device ID of the current user
-     * @method
-     * @param {String} deviceId - the device ID to set
-     */
-    setDeviceID: (deviceID: any) => Promise<any>;
-    /**
-     * Get updated status for user and group
-     * @method
-     * @param {String} [groupID] - ID of a specific group to retrieve info from
-     */
-    getUserAndGroup: (groupID?: string) => Promise<any>;
-    /**
-     * Fetches posts from the specified category in a group
-     * @method
-     * @param {String} groupID - group ID
-     * @param {"hot"|"recent"|"top"} category - category to filter posts
-     * @param {SidechatCursorString} [cursor] - cursor string
-     * @returns {SidechatPostsAndCursor} List of posts and cursor
-     */
-    getGroupPosts: (groupID: string, category?: "hot" | "recent" | "top", cursor?: SidechatCursorString) => SidechatPostsAndCursor;
-    /**
-     * Upvote or downvote, or unvote a post
-     * @method
-     * @param {String} postID - post ID to vote on
-     * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
-     */
-    setVote: (postID: string, action: SidechatVoteString) => Promise<any>;
-    /**
-     * Get all the commments on a post
-     * @method
-     * @param {String} postID - post ID to get comments for
-     * @returns {SidechatPostOrComment[]} list of comments
-     */
-    getPostComments: (postID: string) => SidechatPostOrComment[];
-    /**
-     * Gets groups to be displayed on the "Explore Groups" page
-     * @method
-     * @returns {SidechatGroup[]}
-     */
-    getAvailableGroups: () => SidechatGroup[];
-}
-//# sourceMappingURL=SidechatAPIClient.d.ts.map

package/src/classes/SidechatAPIClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidechatAPIClient.d.ts","sourceRoot":"","sources":["SidechatAPIClient.js"],"names":[],"mappings":";AAGA;;;;GAIG;AACH;IAgBE;;;OAGG;IACH,oBAFW,iBAAiB,EAM3B;IAvBD;;;SAGK;IACL,WAFU,iBAAiB,CAEjB;IACV;;;;OAIG;IACH,oBAGE;IAYF;;;;OAIG;IACH,kBAFW,iBAAiB,UAI1B;IAEF;;;;OAIG;IACH,mDAgBE;IAEF;;;;;OAKG;IACH,mEAsBE;IAEF;;;;;OAKG;IACH,8DAyBE;IAEF;;;;;OAKG;IACH,+CA2BE;IAEF;;;OAGG;IACH,2CAyBE;IAEF;;;;OAIG;IACH,6CA2BE;IAEF;;;;OAIG;IACH,oDAqBE;IAEF;;;;;;;OAOG;IACH,4CAJW,KAAK,GAAC,QAAQ,GAAC,KAAK,WACpB,oBAAoB,KAClB,sBAAsB,CAyBjC;IAEF;;;;;OAKG;IACH,kCAFW,kBAAkB,kBAwB3B;IAEF;;;;;OAKG;IACH,qCAFa,qBAAqB,EAAE,CAqElC;IAEF;;;;OAIG;IACH,0BAFa,aAAa,EAAE,CAoB1B;CACH"}

package/src/classes/SidechatAPIError.d.ts

@@ -1,10 +0,0 @@
-export default SidechatAPIError;
-/**
- * Throwable error caused by the Sidechat API
- * @class
- * @extends Error
- */
-declare class SidechatAPIError extends Error {
-    constructor(message: any);
-}
-//# sourceMappingURL=SidechatAPIError.d.ts.map

package/src/classes/SidechatAPIError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidechatAPIError.d.ts","sourceRoot":"","sources":["SidechatAPIError.js"],"names":[],"mappings":";AAAA;;;;GAIG;AACH;IACE,0BAGC;CACF"}

package/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"8BAC8B,gCAAgC;6BACjC,+BAA+B"}

package/src/types/SidechatTypes.d.ts

@@ -1,224 +0,0 @@
-/**
- * A user-created post or comment, depending on the "type" prop
- */
-type SidechatPostOrComment = {
-    /**
-     * - whether this object represents a post or a comment on a post
-     */
-    type: "post" | "comment";
-    /**
-     * - alphanumeric ID of post or comment
-     */
-    id: string;
-    /**
-     * - undocumented
-     */
-    authored_by_user: boolean;
-    /**
-     * - post creator's name in-app
-     */
-    alias: string;
-    /**
-     * - alphanumeric ID of group
-     */
-    group_id: string;
-    /**
-     * - group in which post or comment was created
-     */
-    group: SidechatGroup;
-    /**
-     * - text content of post or comment
-     */
-    text: string;
-    /**
-     * - date string of post or comment creation time
-     */
-    created_at: string;
-    /**
-     * - sum of upvotes and downvotes
-     */
-    vote_total: number;
-    /**
-     * - current user's vote on post or comment
-     */
-    vote_status: SidechatVoteString;
-    /**
-     * - array of assets attached to post or comment
-     */
-    assets: SidechatAsset[];
-    /**
-     * - undocumented
-     */
-    attachments: any[];
-    /**
-     * - whether or not you can send a DM to creator of post
-     */
-    dms_disabled: boolean;
-    /**
-     * - undocumented
-     */
-    tags: any[];
-    /**
-     * - creator's identity information
-     */
-    identity: SidechatIdentity;
-    /**
-     * - undocumented
-     */
-    pinned: boolean;
-    /**
-     * - undocumented
-     */
-    is_saved: boolean;
-    /**
-     * - undocumented
-     */
-    follow_status: "following" | "not_following";
-    /**
-     * - undocumented
-     */
-    destination?: "group";
-    /**
-     * - number of comments on post (only if type=post)
-     */
-    comment_count?: number;
-    /**
-     * - whether or not you can comment on post (only if type=post)
-     */
-    comments_disabled?: boolean;
-    /**
-     * - alphanumeric ID of parent post (only if type=comment)
-     */
-    parent_post_id?: string;
-    /**
-     * - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
-     */
-    reply_post_id?: string;
-    /**
-     * - text content of comment being replied to, falls back to text (only if type=comment)
-     */
-    context?: string;
-};
-/**
- * A group object, containing metadata about a group as well as its join conditions and states
- */
-type SidechatGroup = {
-    /**
-     * - alphanumeric ID of group
-     */
-    id: string;
-    /**
-     * - human-readable name of group
-     */
-    name: string;
-    /**
-     * - name to file group under
-     */
-    analytics_name: string;
-    /**
-     * - whether or not current user is a member of group
-     */
-    membership_type: "non_member" | "member";
-    /**
-     * -  group's theme color as hex code (e.g., #FFFFFF)
-     */
-    color: string;
-    /**
-     * - basis on which group accepts new members
-     */
-    group_join_type: "open" | "closed" | "email_domain";
-    /**
-     * - group's visibility setting
-     */
-    group_visibility: "private" | "public_to_all" | "public_to_schools";
-    /**
-     * - whether or not group's asset library is visible
-     */
-    asset_library_visibility: "show" | "hide";
-    /**
-     * - undocumented
-     */
-    roles?: any[];
-    /**
-     * - description of group
-     */
-    description?: string;
-    /**
-     * - image URL for group icon
-     */
-    icon_url?: SidechatPrivateAssetURL;
-    /**
-     * - number of users in group
-     */
-    member_count?: number;
-    /**
-     * - undocumented
-     */
-    should_show_leaderboard?: boolean;
-};
-/**
- * An asset object, containing information about an image within a post or comment
- */
-type SidechatAsset = {
-    /**
-     * - alphanumeric ID of asset
-     */
-    id: string;
-    /**
-     * - undocumented
-     */
-    type: "image";
-    /**
-     * - file type of asset
-     */
-    content_type: "jpeg" | "png" | "gif";
-    /**
-     * - the width of asset
-     */
-    width: number;
-    /**
-     * - the height of asset
-     */
-    height: number;
-    /**
-     * - URL string of asset's location
-     */
-    url: SidechatPrivateAssetURL;
-};
-/**
- * A user's identity information
- */
-type SidechatIdentity = {
-    /**
-     * - representation of user's name (varies across app)
-     */
-    name: string;
-    /**
-     * - undocumented
-     */
-    posted_with_username: boolean;
-};
-/**
- * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
- */
-type SidechatPrivateAssetURL = string;
-/**
- * A cursor for paginating through post lists
- */
-type SidechatCursorString = string;
-/**
- * A vote on a comment or post
- */
-type SidechatVoteString = "upvote" | "downvote" | "none";
-/**
- * A user's bearer authentication token needed for most requests
- */
-type SidechatAuthToken = string;
-/**
- * A list of posts and the associated cursor
- */
-type SidechatPostsAndCursor = {
-    posts: SidechatPostOrComment[];
-    cursor: SidechatCursorString;
-};
-//# sourceMappingURL=SidechatTypes.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"SidechatTypes.d.ts","sourceRoot":"","sources":["SidechatTypes.js"],"names":[],"mappings":";;;;;;;UAGU,MAAM,GAAC,SAAS;;;;;;;;;;;;;;;;;;;;WAKhB,aAAa;;;;;;;;;;;;;;;;iBAIb,kBAAkB;;;;YAClB,aAAa,EAAE;;;;;;;;;;;;;;;;cAIf,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;;;;;;;;;;;;SAGlB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;0BAsBpB,QAAQ,GAAC,UAAU,GAAC,MAAM;;;;;;;;;WAW7B,qBAAqB,EAAE;YACvB,oBAAoB"}