rettiwt-api 1.1.0 → 1.1.2

package/src/types/Authentication.ts

@@ -1,16 +1,41 @@
 /**
- * @summary Stores the guest credentials for guest users
+ * The guest credentials for guest authentication.
+ * 
+ * @internal
  */
 export interface GuestCredentials {
+    /** The bearer token from twitter.com.
+     * 
+     * @remarks This is a static bearer token from twitter.com.
+     */
     authToken: string,
+    /** The guest token.
+     * 
+     * @remarks This is generated from twitter.com by calling GETTING https://api.twitter.com/1.1/guest/activate.json endpoint.
+     */
     guestToken: string
 };
 
 /**
- * @summary Stores the credentials for authenticated/logged in users
+ * The credentials for authenticated/logged in users.
+ * 
+ * @internal
  */
 export interface AuthCredentials {
+    /** The bearer token from twitter.com.
+     * 
+     * @remarks This is a static bearer token from twitter.com.
+     */
     authToken: string,
+    /** The guest token.
+     * 
+     * @remarks This is generated from twitter.com by calling GETTING https://api.twitter.com/1.1/guest/activate.json endpoint.
+     */
     csrfToken: string,
+    /** The cookie of the twitter account, which is used to authenticate against twitter.
+     * 
+     * @remarks The cookie can be obtained/scraped from any one of the outgoing HTTP request headers to twitter.com.
+     * It can also be obtained after logging in to twitter, from the 'set-cookie' field of response.
+     */
     cookie: string
 };

package/src/types/HTTP.ts

@@ -1,5 +1,7 @@
 /**
- * @summary Stores the different types of http status codes
+ * The different types of http status codes
+ *
+ * @internal
  */
 export enum HttpStatus {
     BadRequest = 400,
@@ -12,4 +14,4 @@ export enum HttpStatus {
     InternalServerError = 500,
     BadGateway = 502,
     ServiceUnavailable = 503
-};
+};

package/src/types/Resolvers.ts

@@ -1,9 +1,17 @@
 /**
- * @summary Stores the data returned from extractors
+ * The data returned from extractor methods.
+ * @internal
  */
 export interface DataExtract {
-    required: any;                                              // To store the required data extracted
-    cursor: string;                                             // To store the cursor extracted
-    users: any;                                                 // To store all user details extracted
-    tweets: any;                                                // To store all tweets exracted
-}
+    /** The required data. */
+    required: any;
+
+    /** The cursor string to the next batch of data. */
+    cursor: string;
+
+    /** Additional extracted user details. */
+    users: any;
+
+    /** Additional extracted tweet details */
+    tweets: any;
+}

package/src/types/data/Errors.ts

@@ -1,12 +1,19 @@
 /**
- * @summary Stores different types of error messages related to authentication
+ * Different types of error messages related to authentication.
+ *
+ * @public
  */
 export enum AuthenticationErrors {
     NotAuthenticated = "Cannot fetch this data without authentication",
+    InvalidEmail = "No Twitter account found for the given email address",
+    InvalidUsername = "Incorrect username given for the given Twitter account",
+    InvalidPassword = "Incorrect password given for the given Twitter account"
 };
 
 /**
- * @summary Stores different types error messages for validation errors
+ * Different types error messages for validation errors.
+ *
+ * @public
  */
 export enum ValidationErrors {
     InvalidTweetFilter = "Atleast one of fromUsers/toUsers/mentions/hashtags/words argument is required",
@@ -15,7 +22,9 @@ export enum ValidationErrors {
 };
 
 /**
- * @summary Stores all the different type of error messages that are returned by services
+ * Different type of error messages that are returned by services.
+ *
+ * @public
  */
 export enum DataErrors {
     UserNotFound = "An account with given username/id was not found",
@@ -25,4 +34,4 @@ export enum DataErrors {
     NoRetweetersFound = "No retweeters found for the tweet with the given id",
     NoFollowsFound = "No follow details were found for the user with the given id",
     NoLikedTweetsFound = "No liked tweets were found for the user with the given id"
-};
+};

package/src/types/data/Service.ts

@@ -4,16 +4,20 @@ import { TweetService } from "../../services/data/TweetService";
 import { UserService } from "../../services/data/UserService";
 
 /**
- * @summary Stores the cursor to the batch of data
+ * The cursor to the batch of data to be fetched.
+ * 
+ * @public
  */
 export class Cursor {
     // MEMBER DATA
-    value: string;                                                      // To store the cursor to next batch of data
+    /** The cursor string. */
+    value: string;
 
     // MEMBER DATA
     /**
-     * @summary Initializes a new cursor from the given cursor string
-     * @param cursorStr The string representation of the cursor
+     * Initializes a new cursor from the given cursor string.
+     * 
+     * @param cursorStr The string representation of the cursor.
      */
     constructor(cursorStr: string) {
         this.value = cursorStr;
@@ -21,18 +25,31 @@ export class Cursor {
 }
 
 /**
- * @summary Stores cursored data that is returned by services
+ * The data that us fetched batch-wise along with a cursor.
+ * 
+ * @typeParam Type - The type of data present in the list.
+ * @public
  */
 export interface CursoredData<Type> {
-    list: Type[];                                                       // To store the list data
-    next: Cursor;                                                       // To store the information about cursor to the next batch
+    /** The list of data of the given type. */
+    list: Type[];
+
+    /** The cursor to the next batch of data. */
+    next: Cursor;
 }
 
 /**
- * @summary Stores the data context from where data is to be fetched
+ * The data context from where data is to be fetched.
+ * 
+ * @public
  */
 export interface DataContext {
-    users: UserService,                                                 // To store the source for fetching user data
-    tweets: TweetService,                                               // To store the source for fetching tweet data
-    account: AccountService                                             // To store the source for account related operations
+    /** Handles data related to users. */
+    users: UserService,
+
+    /** Handles data related to tweets. */
+    tweets: TweetService,
+
+    /** Handles account related operations. */
+    account: AccountService
 }

package/src/types/data/Tweet.ts

@@ -1,45 +1,123 @@
-// This file contains various objects related to handling of Tweets made by a user
-
 /**
- * @summary Stores the filter to be used for fetching tweets from TwitterAPI
+ * The filter to be used for fetching tweets from Twitter.
+ * 
+ * @public
  */
 export interface TweetFilter {
-    words?: string[];                                                   // To store the list of words to search
-    hashtags?: string[];                                                // To store the list of hashtags to seach
-    fromUsers?: string[];                                               // To store the list of users who made the tweet
-    toUsers?: string[];                                                 // To store the list of users to whom the tweet was meant for
-    mentions?: string[];                                                // To store the list of mentioned users
-    startDate?: string;                                                 // To store the beginning date to search tweets
-    endDate?: string;                                                   // To store the ending date to search tweets
-    sinceId?: string;                                                   // To store the first id (exclusive) from which to search tweets
-    quoted?: string;                                                    // To store the id of the tweet which is quoted
-    links?: boolean;                                                    // To store whether to fetch link tweets or not
+    /** The list of words to search. */
+    words?: string[];
+
+    /** The list of hashtags to search.
+     * 
+     * @remarks
+     * '#' must be excluded from the hashtag!
+     */
+    hashtags?: string[];
+
+    /** The list of usernames whose tweets are to be searched.
+     * 
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    fromUsers?: string[];
+    
+    /** The list of username to whom the tweets to be searched, are adressed.
+     * 
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    toUsers?: string[];
+
+    /** The list of username mentioned in the tweets to search.
+     * 
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    mentions?: string[];
+
+    /** The date starting from which tweets are to be searched.
+     * 
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    startDate?: string;
+
+    /** The date upto which tweets are to be searched.
+     * 
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    endDate?: string;
+
+    /** The id of the tweet, after which the tweets are to be searched. */
+    sinceId?: string;
+
+    /** The id of the tweet which is quoted in the tweets to search. */
+    quoted?: string;
+
+    /** Whether to fetch tweets that are links or not.
+     * 
+     * @defaultValue false
+     */
+    links?: boolean;
 };
 
 /**
- * @summary Stores the different types of tweet elements like urls, media, mentions, hashtags, etc
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ * 
+ * @public
  */
 export interface TweetEntities {
-    hashtags: string[];                                                 // To store a list of hashtags used
-    urls: string[];                                                     // To store a list of urls mentioned
-    mentionedUsers: string[];                                           // To store a list of users mentioned
-    media: string[];                                                    // To store urls to various media files
+    /** The list of hashtags mentioned in the tweet. */
+    hashtags: string[];
+
+    /** The list of urls mentioned in the tweet. */
+    urls: string[];
+
+    /** The list of IDs of users mentioned in the tweet. */
+    mentionedUsers: string[];
+
+    /** The list of urls to various media mentioned in the tweet. */
+    media: string[];
 }
 
 /**
- * @summary Stores a single tweet
+ * The details of a single Tweet.
  */
 export interface Tweet {
-    id: string;                                                         // To store the conversation id
-    tweetBy: string;                                                    // To store the rest id of the user who made the tweet
-    createdAt: string;                                                  // To store the time when the tweet was created
-    entities: TweetEntities;                                            // To store additional tweet entities
-    quoted: string;                                                     // To store the id of the tweet quote (if any)
-    fullText: string;                                                   // To store the full text in the tweet
-    replyTo: string;                                                    // To store the id of the tweet to which this was a reply
-    lang: string;                                                       // To store the language used in the tweet
-    quoteCount: number;                                                 // To store the number of quotes of the tweet
-    replyCount: number;                                                 // To store the number of replies to the tweet
-    retweetCount: number;                                               // To store the number of retweets
-    likeCount: number;                                                  // To store the number of likes
+    /** The rest id of the tweet. */
+    id: string;
+
+    /** The rest id of the user who made the tweet. */
+    tweetBy: string;
+
+    /** The date and time of creation of the tweet, in UTC string format. */
+    createdAt: string;
+
+    /** Additional tweet entities like urls, mentions, etc. */
+    entities: TweetEntities;
+
+    /** The rest id of the tweet which is quoted in the tweet. */
+    quoted: string;
+
+    /** The full text content of the tweet. */
+    fullText: string;
+
+    /** The rest id of the user to which the tweet is a reply. */
+    replyTo: string;
+
+    /** The language in which the tweet is written. */
+    lang: string;
+
+    /** The number of quotes of the tweet. */
+    quoteCount: number;
+
+    /** The number of replies to the tweet. */
+    replyCount: number;
+
+    /** The number of retweets of the tweet. */
+    retweetCount: number;
+
+    /** The number of likes of the tweet. */
+    likeCount: number;
 }

package/src/types/data/User.ts

@@ -1,21 +1,51 @@
-// This file contains various objects for handling data related to User Account
-
 /**
- * @summary Stores the complete details of the given user's account
+ * The details of a single user.
+ * 
+ * @public
  */
 export interface User {
-    id: string;                                                             // To store the internal rest id of user account
-    userName: string;                                                       // To store the screen name of the user
-    fullName: string;                                                       // To store the actual name of the user
-    createdAt: string;                                                      // To store the time when the account was created
-    description: string;                                                    // To store the account description
-    isVerified: boolean ;                                                   // To store whether this is a verified account or not
-    favouritesCount: number;                                                // To store the number of favourites
-    followersCount: number;                                                 // To store the number of followers
-    followingsCount: number;                                                // To store the number of people followed by this user
-    statusesCount: number;                                                  // To store the number of status posted by user
-    location: string;                                                       // To store the user's location
-    pinnedTweet: string;                                                    // To store the id of tweet that is pinned in the account
-    profileBanner: string;                                                  // To store the url to the profile's banner
-    profileImage: string;                                                   // To store the url to the profile's image
+    /** The rest id of the user. */
+    id: string;
+
+    /** The username/screenname of the user. */
+    userName: string;
+
+    /** The full name of the user. */
+    fullName: string;
+
+    /** The creation date of user's account. */
+    createdAt: string;
+
+    /** The user's description. */
+    description: string;
+
+    /** Whether the account is verified or not. */
+    isVerified: boolean;
+
+    /** The number of tweets liked by the user. */
+    favouritesCount: number;
+
+    /** The number of followers of the user. */
+    followersCount: number;
+
+    /** The number of following of the user. */
+    followingsCount: number;
+
+    /** The number of tweets made by the user.
+     * 
+     * @remarks This includes original tweets along with retweets.
+     */
+    statusesCount: number;
+
+    /** The location of user as provided by user. */
+    location: string;
+
+    /** The rest id of the tweet pinned in the user's profile. */
+    pinnedTweet: string;
+
+    /** The url of the profile banner image. */
+    profileBanner: string;
+
+    /** The url of the profile image. */
+    profileImage: string;
 }