rettiwt-api 1.1.0 → 1.1.2

package/dist/types/data/Service.d.ts

@@ -2,28 +2,42 @@ import { AccountService } from "../../services/accounts/AccountService";
 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 declare class Cursor {
+    /** The cursor string. */
     value: string;
     /**
-     * @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);
 }
 /**
- * @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> {
+    /** 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 {
+    /** Handles data related to users. */
     users: UserService;
+    /** Handles data related to tweets. */
     tweets: TweetService;
+    /** Handles account related operations. */
     account: AccountService;
 }

package/dist/types/data/Service.js

@@ -2,13 +2,16 @@
 exports.__esModule = true;
 exports.Cursor = void 0;
 /**
- * @summary Stores the cursor to the batch of data
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
  */
 var Cursor = /** @class */ (function () {
     // 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.
      */
     function Cursor(cursorStr) {
         this.value = cursorStr;

package/dist/types/data/Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../../src/types/data/Service.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH;IAII,cAAc;IACd;;;OAGG;IACH,gBAAY,SAAiB;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IACL,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM"}
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../../src/types/data/Service.ts"],"names":[],"mappings":";;;AAKA;;;;GAIG;AACH;IAKI,cAAc;IACd;;;;OAIG;IACH,gBAAY,SAAiB;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IACL,aAAC;AAAD,CAAC,AAdD,IAcC;AAdY,wBAAM"}

package/dist/types/data/Tweet.d.ts

@@ -1,41 +1,98 @@
 /**
- * @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 {
+    /** 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 {
+    /** 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 {
+    /** 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/dist/types/data/Tweet.js

@@ -1,5 +1,4 @@
 "use strict";
-// This file contains various objects related to handling of Tweets made by a user
 exports.__esModule = true;
 ;
 //# sourceMappingURL=Tweet.js.map

package/dist/types/data/Tweet.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../src/types/data/Tweet.ts"],"names":[],"mappings":";AAAA,kFAAkF;;AAgBjF,CAAC"}
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../src/types/data/Tweet.ts"],"names":[],"mappings":";;AA8DC,CAAC"}

package/dist/types/data/User.d.ts

@@ -1,19 +1,38 @@
 /**
- * @summary Stores the complete details of the given user's account
+ * The details of a single user.
+ *
+ * @public
  */
 export interface User {
+    /** 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;
 }

package/dist/types/data/User.js

@@ -1,4 +1,3 @@
 "use strict";
-// This file contains various objects for handling data related to User Account
 exports.__esModule = true;
 //# sourceMappingURL=User.js.map

package/dist/types/data/User.js.map

@@ -1 +1 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/types/data/User.ts"],"names":[],"mappings":";AAAA,+EAA+E"}
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/types/data/User.ts"],"names":[],"mappings":""}

package/dist/types/graphql/Errors.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @summary Collection of different types of validation errors
+ */
+export declare enum ValidationErrors {
+    InvalidTweetFilter = "Atleast one of fromUsers/toUsers/mentions/hashtags/words argument is required",
+    NoUserIdentification = "Either userName or id must be given"
+}
+/**
+ * @summary Stores all the different type of error messages that are returned by services
+ */
+export declare enum DataErrors {
+    UserNotFound = "An account with given username/id was not found",
+    TweetNotFound = "A tweet with the given id was not found",
+    NoTweetsFound = "No tweets matching the given criteria found"
+}

package/dist/types/graphql/Errors.js

@@ -0,0 +1,23 @@
+"use strict";
+exports.__esModule = true;
+exports.DataErrors = exports.ValidationErrors = void 0;
+/**
+ * @summary Collection of different types of validation errors
+ */
+var ValidationErrors;
+(function (ValidationErrors) {
+    ValidationErrors["InvalidTweetFilter"] = "Atleast one of fromUsers/toUsers/mentions/hashtags/words argument is required";
+    ValidationErrors["NoUserIdentification"] = "Either userName or id must be given";
+})(ValidationErrors = exports.ValidationErrors || (exports.ValidationErrors = {}));
+;
+/**
+ * @summary Stores all the different type of error messages that are returned by services
+ */
+var DataErrors;
+(function (DataErrors) {
+    DataErrors["UserNotFound"] = "An account with given username/id was not found";
+    DataErrors["TweetNotFound"] = "A tweet with the given id was not found";
+    DataErrors["NoTweetsFound"] = "No tweets matching the given criteria found";
+})(DataErrors = exports.DataErrors || (exports.DataErrors = {}));
+;
+//# sourceMappingURL=Errors.js.map

package/dist/types/graphql/Errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../../../src/types/graphql/Errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IACxB,wHAAoG,CAAA;IACpG,gFAA4D,CAAA;AAChE,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAAA,CAAC;AAEF;;GAEG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IAClB,8EAAgE,CAAA;IAChE,uEAAyD,CAAA;IACzD,2EAA6D,CAAA;AACjE,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAAA,CAAC"}

package/dist/types/raw/general/Trends.d.ts

@@ -0,0 +1,324 @@
+export default interface Root {
+    globalObjects: GlobalObjects;
+    timeline: Timeline;
+    pageConfiguration: PageConfiguration;
+}
+export interface GlobalObjects {
+    tweets: Tweets;
+    users: Users;
+    moments: Moments;
+    cards: Cards;
+    places: Places;
+    media: Media;
+    broadcasts: Broadcasts;
+    topics: Topics;
+    lists: Lists;
+}
+export interface Tweets {
+}
+export interface Users {
+}
+export interface Moments {
+}
+export interface Cards {
+}
+export interface Places {
+}
+export interface Media {
+}
+export interface Broadcasts {
+}
+export interface Topics {
+}
+export interface Lists {
+}
+export interface Timeline {
+    id: string;
+    instructions: Instruction[];
+    responseObjects: ResponseObjects;
+}
+export interface Instruction {
+    clearCache?: ClearCache;
+    addEntries?: AddEntries;
+    terminateTimeline?: TerminateTimeline;
+}
+export interface ClearCache {
+}
+export interface AddEntries {
+    entries: Entry[];
+}
+export interface Entry {
+    entryId: string;
+    sortIndex: string;
+    content: Content;
+}
+export interface Content {
+    operation?: Operation;
+    timelineModule?: TimelineModule;
+}
+export interface Operation {
+    cursor: Cursor;
+}
+export interface Cursor {
+    value: string;
+    cursorType: string;
+}
+export interface TimelineModule {
+    items: Item[];
+    displayType: string;
+    header: Header;
+    clientEventInfo: ClientEventInfo3;
+}
+export interface Item {
+    entryId: string;
+    item: Item2;
+}
+export interface Item2 {
+    content: Content2;
+    clientEventInfo: ClientEventInfo;
+    feedbackInfo: FeedbackInfo;
+}
+export interface Content2 {
+    trend: Trend;
+}
+export interface Trend {
+    name: string;
+    url: Url;
+    associatedCardUrls: any[];
+    trendMetadata: TrendMetadata;
+    rank: string;
+}
+export interface Url {
+    urlType: string;
+    url: string;
+    urtEndpointOptions: UrtEndpointOptions;
+}
+export interface UrtEndpointOptions {
+    requestParams: RequestParams;
+}
+export interface RequestParams {
+    cd: string;
+}
+export interface TrendMetadata {
+    metaDescription?: string;
+    url: Url2;
+    domainContext: string;
+}
+export interface Url2 {
+    urlType: string;
+    url: string;
+    urtEndpointOptions: UrtEndpointOptions2;
+}
+export interface UrtEndpointOptions2 {
+    requestParams: RequestParams2;
+}
+export interface RequestParams2 {
+    cd: string;
+}
+export interface ClientEventInfo {
+    component: string;
+    element: string;
+    details: Details;
+}
+export interface Details {
+    guideDetails: GuideDetails;
+}
+export interface GuideDetails {
+    identifier: string;
+    token: string;
+    transparentGuideDetails: TransparentGuideDetails;
+}
+export interface TransparentGuideDetails {
+    trendMetadata: TrendMetadata2;
+}
+export interface TrendMetadata2 {
+    impressionId: string;
+    impressionToken: string;
+    position: number;
+    trendName: string;
+    relatedTerms?: string[];
+    clusterId?: string;
+    associatedCuratedTweetIds: any[];
+    containsCuratedTitle: boolean;
+    topicIds?: string[];
+    displayedTopicId?: string;
+}
+export interface FeedbackInfo {
+    feedbackKeys: string[];
+    feedbackMetadata: string;
+    clientEventInfo: ClientEventInfo2;
+}
+export interface ClientEventInfo2 {
+    component: string;
+    element: string;
+    action: string;
+}
+export interface Header {
+    text: string;
+    sticky: boolean;
+    displayType: string;
+}
+export interface ClientEventInfo3 {
+    component: string;
+    details: Details2;
+}
+export interface Details2 {
+    guideDetails: GuideDetails2;
+}
+export interface GuideDetails2 {
+    identifier: string;
+}
+export interface TerminateTimeline {
+    direction: string;
+}
+export interface ResponseObjects {
+    feedbackActions: FeedbackActions;
+}
+export interface FeedbackActions {
+    trend_irrelevant_content_feedback_key: TrendIrrelevantContentFeedbackKey;
+    spotlight_dismiss_feedback_key: SpotlightDismissFeedbackKey;
+    trend_abusive_feedback_key: TrendAbusiveFeedbackKey;
+    guide_not_interested_feedback_key: GuideNotInterestedFeedbackKey;
+    guide_see_more_feedback_key: GuideSeeMoreFeedbackKey;
+    trend_spam_feedback_key: TrendSpamFeedbackKey;
+    trend_low_quality_feedback_key: TrendLowQualityFeedbackKey;
+    guide_see_less_feedback_key: GuideSeeLessFeedbackKey;
+    trend_not_interested_in_this_feedback_key: TrendNotInterestedInThisFeedbackKey;
+    trend_abusive_or_harmful_feedback_key: TrendAbusiveOrHarmfulFeedbackKey;
+    guide_hide_topic_key: GuideHideTopicKey;
+    trend_duplicate_feedback_key: TrendDuplicateFeedbackKey;
+}
+export interface TrendIrrelevantContentFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface SpotlightDismissFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface TrendAbusiveFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface GuideNotInterestedFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+    icon: string;
+}
+export interface GuideSeeMoreFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface TrendSpamFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface TrendLowQualityFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface GuideSeeLessFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface TrendNotInterestedInThisFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface TrendAbusiveOrHarmfulFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface GuideHideTopicKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+    icon: string;
+}
+export interface TrendDuplicateFeedbackKey {
+    feedbackType: string;
+    prompt: string;
+    confirmation: string;
+    feedbackUrl: string;
+    hasUndoAction: boolean;
+    confirmationDisplayType: string;
+}
+export interface PageConfiguration {
+    id: string;
+    title: string;
+    tabs: Tabs;
+    scribeConfig: ScribeConfig2;
+}
+export interface Tabs {
+    tabs: Tab[];
+    initialTabId: string;
+}
+export interface Tab {
+    id: string;
+    labelText: string;
+    urtEndpoint: UrtEndpoint;
+    scribeConfig: ScribeConfig;
+}
+export interface UrtEndpoint {
+    urlType: string;
+    url: string;
+    urtEndpointOptions: UrtEndpointOptions3;
+}
+export interface UrtEndpointOptions3 {
+    requestParams: RequestParams3;
+    cacheId?: string;
+}
+export interface RequestParams3 {
+    tab_category: string;
+    sc_category_id?: string;
+}
+export interface ScribeConfig {
+    page: string;
+    section: string;
+}
+export interface ScribeConfig2 {
+    page: string;
+    section: string;
+}

package/dist/types/raw/general/Trends.js

@@ -0,0 +1,3 @@
+"use strict";
+exports.__esModule = true;
+//# sourceMappingURL=Trends.js.map

package/dist/types/raw/general/Trends.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Trends.js","sourceRoot":"","sources":["../../../../src/types/raw/general/Trends.ts"],"names":[],"mappings":""}