rettiwt-api 2.0.3 → 2.2.0

package/.github/workflows/publish.yml

@@ -20,9 +20,6 @@ jobs:
             # Installing dependencies
             - run: yarn
 
-            # Building the package
-            - run: yarn run build
-
             # Publishing to NPM
             - run: npm publish
               env:

package/README.md

@@ -26,6 +26,19 @@ Although the above process initializes a new project, that is, in fact, not nece
 
 **Note:** The API_KEY (cookie) that we generated, is a very sensitive information and provides all access to the Twitter account. Therefore, it is generally recommended to store it as an environment variable and use it from there.
 
+## Using a proxy
+
+For masking of IP address using a proxy server, use the following code snippet for instantiation of Rettiwt:
+
+```
+/**
+ * proxyUrl is the URL or configuration for the proxy server you want to use.`
+ */
+const rettiwt = Rettiwt(API_KEY, proxyUrl);
+```
+
+This creates a Rettiwt instance which uses the given proxy server for making requests to Twitter.
+
 ## Usage
 
 The following examples may help you to get started using the library:
@@ -33,6 +46,8 @@ The following examples may help you to get started using the library:
 ### 1. Getting the details of a target Twitter user
 
 ```
+const { Rettiwt } = require('rettiwt-api');
+
 // Creating a new Rettiwt instance using the API_KEY
 const rettiwt = new Rettiwt(API_KEY);
 
@@ -49,6 +64,8 @@ rettiwt.user.details('<username>')
 ### 2. Getting the list of tweets that match a given filter
 
 ```
+const { Rettiwt } = require('rettiwt-api');
+
 // Creating a new Rettiwt instance using the API_KEY
 const rettiwt = new Rettiwt(API_KEY);
 
@@ -66,11 +83,63 @@ rettiwt.tweet.search({
 })
 .catch(err => {
 	...
+});
+```
+
+### 3. Getting the next batch of data using a cursor
+
+The previous example fetches the the list of tweets matching the given filter. Since no count is specified, in this case, a default of 20 such Tweets are fetched initially. The following example demonstrates how to use the [cursor string](https://rishikant181.github.io/Rettiwt-API/classes/Cursor.html#value) obtained from the [response](https://rishikant181.github.io/Rettiwt-API/classes/CursoredData.html) object's [next](https://rishikant181.github.io/Rettiwt-API/classes/CursoredData.html#next) field, from the previous example, to fetch the next batch of tweets:
+
+```
+const { Rettiwt } = require('rettiwt-api');
+
+// Creating a new Rettiwt instance using the API_KEY
+const rettiwt = new Rettiwt(API_KEY);
+
+/**
+ * Fetching the list of tweets that:
+ * 	- are made by a user with username <username>,
+ * 	- contain the words <word1> and <word2>
+ *
+ * 'data' is the response object received in the previous example.
+ */
+rettiwt.tweet.search({
+	fromUsers: ['<username>'],
+	words: ['<word1>', '<word2>']
+}, data.next.value)
+.then(data => {
+	...
 })
+.catch(err => {
+	...
+});
 ```
 
 For more information regarding the different available filter options, please refer to [TweetFilter](https://rishikant181.github.io/Rettiwt-API/classes/TweetFilter.html).
 
+## Features
+
+So far, the following operations are supported:
+
+### Tweets
+
+-   [Getting the details of a tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#details)
+-   [Favoriting/liking a tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#favorite)
+-   [Getting the list of users who favorited/liked a given tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#favoriters)
+-   [Getting the list of tweets from a given Twitter list](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#list)
+-   [Retweeting/reposting a tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#retweet)
+-   [Getting the list of users who retweeted/reposted a given tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#retweeters)
+-   [Searching for the list of tweets that match a given filter](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#search)
+-   [Posting a new tweet](https://rishikant181.github.io/Rettiwt-API/classes/TweetService.html#tweet)
+
+### Users
+
+-   [Getting the details of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#details)
+-   [Getting the list of users who follow the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#followers)
+-   [Getting the list of users who are followed by the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#following)
+-   [Getting the list of tweets favorited/liked by the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#likes)
+-   [Getting the timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#timeline)
+
 ## API Reference
 
 The complete API reference can be found at [this](https://rishikant181.github.io/Rettiwt-API/) page.

package/dist/Rettiwt.d.ts

@@ -13,7 +13,8 @@ export declare class Rettiwt {
     /**
      * Initializes a new Rettiwt instance using the given api key.
      *
-     * @param apiKey - The apiKey (cookie) to be used for authenticating Rettiwt against Twitter.
+     * @param apiKey - The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.
+     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
      */
-    constructor(apiKey: string);
+    constructor(apiKey: string, proxyUrl?: URL);
 }

package/dist/Rettiwt.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rettiwt = void 0;
-// PACKAGE
-var rettiwt_auth_1 = require("rettiwt-auth");
 // SERVICES
 var TweetService_1 = require("./services/TweetService");
 var UserService_1 = require("./services/UserService");
@@ -15,14 +13,12 @@ var Rettiwt = /** @class */ (function () {
     /**
      * Initializes a new Rettiwt instance using the given api key.
      *
-     * @param apiKey - The apiKey (cookie) to be used for authenticating Rettiwt against Twitter.
+     * @param apiKey - The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.
+     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
      */
-    function Rettiwt(apiKey) {
-        // Preparing auth credentials
-        var cred = new rettiwt_auth_1.AuthCredential(apiKey.split(';'));
-        // Initalizing service instances
-        this.tweet = new TweetService_1.TweetService(cred);
-        this.user = new UserService_1.UserService(cred);
+    function Rettiwt(apiKey, proxyUrl) {
+        this.tweet = new TweetService_1.TweetService(apiKey, proxyUrl);
+        this.user = new UserService_1.UserService(apiKey, proxyUrl);
     }
     return Rettiwt;
 }());

package/dist/Rettiwt.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,UAAU;AACV,6CAA8C;AAE9C,WAAW;AACX,wDAAuD;AACvD,sDAAqD;AAErD;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,iBAAY,MAAc;QACzB,6BAA6B;QAC7B,IAAM,IAAI,GAAmB,IAAI,6BAAc,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,gCAAgC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACF,cAAC;AAAD,CAAC,AApBD,IAoBC;AApBY,0BAAO"}
+{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,wDAAuD;AACvD,sDAAqD;AAErD;;;;GAIG;AACH;IAOC;;;;;OAKG;IACH,iBAAY,MAAc,EAAE,QAAc;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IACF,cAAC;AAAD,CAAC,AAjBD,IAiBC;AAjBY,0BAAO"}

package/dist/index.d.ts

@@ -2,11 +2,13 @@ export * from './Rettiwt';
 export * from './enums/ApiErrors';
 export * from './enums/HTTP';
 export * from './models/CursoredData';
+export * from './models/List';
 export * from './models/Tweet';
 export * from './models/User';
 export * from './services/FetcherService';
 export * from './services/TweetService';
 export * from './services/UserService';
 export * from './types/CursoredData';
+export * from './types/List';
 export * from './types/Tweet';
 export * from './types/User';

package/dist/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./enums/ApiErrors"), exports);
 __exportStar(require("./enums/HTTP"), exports);
 // Exporting models
 __exportStar(require("./models/CursoredData"), exports);
+__exportStar(require("./models/List"), exports);
 __exportStar(require("./models/Tweet"), exports);
 __exportStar(require("./models/User"), exports);
 // Exporting services
@@ -29,6 +30,7 @@ __exportStar(require("./services/TweetService"), exports);
 __exportStar(require("./services/UserService"), exports);
 // Exporting types
 __exportStar(require("./types/CursoredData"), exports);
+__exportStar(require("./types/List"), exports);
 __exportStar(require("./types/Tweet"), exports);
 __exportStar(require("./types/User"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,kBAAkB;AAClB,oDAAkC;AAClC,+CAA6B;AAE7B,mBAAmB;AACnB,wDAAsC;AACtC,iDAA+B;AAC/B,gDAA8B;AAE9B,qBAAqB;AACrB,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AAEvC,kBAAkB;AAClB,uDAAqC;AACrC,gDAA8B;AAC9B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,kBAAkB;AAClB,oDAAkC;AAClC,+CAA6B;AAE7B,mBAAmB;AACnB,wDAAsC;AACtC,gDAA8B;AAC9B,iDAA+B;AAC/B,gDAA8B;AAE9B,qBAAqB;AACrB,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AAEvC,kBAAkB;AAClB,uDAAqC;AACrC,+CAA6B;AAC7B,gDAA8B;AAC9B,+CAA6B"}

package/dist/models/CursoredData.d.ts

@@ -2,21 +2,6 @@ import { ITweet as IRawTweet, IUser as IRawUser } from 'rettiwt-core';
 import { Tweet } from './Tweet';
 import { User } from './User';
 import { ICursor, ICursoredData } from '../types/CursoredData';
-/**
- * The cursor to the batch of data to be fetched.
- *
- * @public
- */
-export declare class Cursor implements ICursor {
-    /** The cursor string. */
-    value: string;
-    /**
-     * Initializes a new cursor from the given cursor string.
-     *
-     * @param cursorStr - The string representation of the cursor.
-     */
-    constructor(cursorStr: string);
-}
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -35,3 +20,18 @@ export declare class CursoredData<T extends Tweet | User> implements ICursoredDa
      */
     constructor(list?: (IRawTweet | IRawUser)[], next?: string);
 }
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+export declare class Cursor implements ICursor {
+    /** The cursor string. */
+    value: string;
+    /**
+     * Initializes a new cursor from the given cursor string.
+     *
+     * @param cursorStr - The string representation of the cursor.
+     */
+    constructor(cursorStr: string);
+}

package/dist/models/CursoredData.js

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CursoredData = exports.Cursor = void 0;
+exports.Cursor = exports.CursoredData = void 0;
 // MODELS
 var Tweet_1 = require("./Tweet");
 var User_1 = require("./User");
-/**
- * The cursor to the batch of data to be fetched.
- *
- * @public
- */
-var Cursor = /** @class */ (function () {
-    /**
-     * Initializes a new cursor from the given cursor string.
-     *
-     * @param cursorStr - The string representation of the cursor.
-     */
-    function Cursor(cursorStr) {
-        this.value = cursorStr;
-    }
-    return Cursor;
-}());
-exports.Cursor = Cursor;
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -56,4 +39,21 @@ var CursoredData = /** @class */ (function () {
     return CursoredData;
 }());
 exports.CursoredData = CursoredData;
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+var Cursor = /** @class */ (function () {
+    /**
+     * Initializes a new cursor from the given cursor string.
+     *
+     * @param cursorStr - The string representation of the cursor.
+     */
+    function Cursor(cursorStr) {
+        this.value = cursorStr;
+    }
+    return Cursor;
+}());
+exports.Cursor = Cursor;
 //# sourceMappingURL=CursoredData.js.map

package/dist/models/CursoredData.js.map

@@ -1 +1 @@
-{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../src/models/CursoredData.ts"],"names":[],"mappings":";;;AAGA,SAAS;AACT,iCAAgC;AAChC,+BAA8B;AAK9B;;;;GAIG;AACH;IAIC;;;;OAIG;IACH,gBAAY,SAAiB;QAC5B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IACxB,CAAC;IACF,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM;AAcnB;;;;;;GAMG;AACH;IAOC;;;OAGG;IACH,sBAAY,IAAmC,EAAE,IAAiB;QAAtD,qBAAA,EAAA,SAAmC;QAAE,qBAAA,EAAA,SAAiB;QAVlE,0CAA0C;QAC1C,SAAI,GAAQ,EAAE,CAAC;QAUd,8DAA8D;QAC9D,KAAmB,UAAI,EAAJ,aAAI,EAAJ,kBAAI,EAAJ,IAAI,EAAE;YAApB,IAAM,IAAI,aAAA;YACd,mCAAmC;YACnC,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;gBAC/C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAK,CAAC,IAAiB,CAAM,CAAC,CAAC;aAClD;YACD,kCAAkC;iBAC7B,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAK,IAAiB,CAAC,EAAE,EAAE;gBAC5E,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,WAAI,CAAC,IAAgB,CAAM,CAAC,CAAC;aAChD;SACD;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACF,mBAAC;AAAD,CAAC,AA3BD,IA2BC;AA3BY,oCAAY"}
+{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../src/models/CursoredData.ts"],"names":[],"mappings":";;;AAGA,SAAS;AACT,iCAAgC;AAChC,+BAA8B;AAK9B;;;;;;GAMG;AACH;IAOC;;;OAGG;IACH,sBAAY,IAAmC,EAAE,IAAiB;QAAtD,qBAAA,EAAA,SAAmC;QAAE,qBAAA,EAAA,SAAiB;QAVlE,0CAA0C;QAC1C,SAAI,GAAQ,EAAE,CAAC;QAUd,8DAA8D;QAC9D,KAAmB,UAAI,EAAJ,aAAI,EAAJ,kBAAI,EAAJ,IAAI,EAAE;YAApB,IAAM,IAAI,aAAA;YACd,mCAAmC;YACnC,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;gBAC/C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAK,CAAC,IAAiB,CAAM,CAAC,CAAC;aAClD;YACD,kCAAkC;iBAC7B,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAK,IAAiB,CAAC,EAAE,EAAE;gBAC5E,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,WAAI,CAAC,IAAgB,CAAM,CAAC,CAAC;aAChD;SACD;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACF,mBAAC;AAAD,CAAC,AA3BD,IA2BC;AA3BY,oCAAY;AA6BzB;;;;GAIG;AACH;IAIC;;;;OAIG;IACH,gBAAY,SAAiB;QAC5B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IACxB,CAAC;IACF,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM"}

package/dist/models/List.d.ts

@@ -0,0 +1,29 @@
+import { IList as IRawList } from 'rettiwt-core';
+import { IList } from '../types/List';
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+export declare class List implements IList {
+    /** The rest id of the list. */
+    id: string;
+    /** The name of the list. */
+    name: string;
+    /** The date and time of creation of the list, int UTC string format. */
+    createdAt: string;
+    /** The list description. */
+    description: string;
+    /** The number of memeber of the list. */
+    memberCount: number;
+    /** The number of subscribers of the list. */
+    subscriberCount: number;
+    /** The rest id of the user who created the list. */
+    createdBy: string;
+    /**
+     * Initializes a new Tweet List from the given raw list data.
+     *
+     * @param list - list The raw tweet list data.
+     */
+    constructor(list: IRawList);
+}

package/dist/models/List.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.List = void 0;
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+var List = /** @class */ (function () {
+    /**
+     * Initializes a new Tweet List from the given raw list data.
+     *
+     * @param list - list The raw tweet list data.
+     */
+    function List(list) {
+        this.id = list.id_str;
+        this.name = list.name;
+        this.createdAt = new Date(list.created_at).toISOString();
+        this.description = list.description;
+        this.memberCount = list.member_count;
+        this.subscriberCount = list.subscriber_count;
+        this.createdBy = list.user_results.result.id;
+    }
+    return List;
+}());
+exports.List = List;
+//# sourceMappingURL=List.js.map

package/dist/models/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../src/models/List.ts"],"names":[],"mappings":";;;AAMA;;;;GAIG;AACH;IAsBC;;;;OAIG;IACH,cAAY,IAAc;QACzB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9C,CAAC;IACF,WAAC;AAAD,CAAC,AApCD,IAoCC;AApCY,oBAAI"}

package/dist/models/Tweet.d.ts

@@ -1,21 +1,6 @@
+import { ITweet as IRawTweet, IEntities as IRawTweetEntities, IExtendedMedia as IRawExtendedMedia, EMediaType } from 'rettiwt-core';
 import { ITweet, ITweetEntities } from '../types/Tweet';
-import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from 'rettiwt-core';
-/**
- * The different types parsed entities like urls, media, mentions, hashtags, etc.
- *
- * @public
- */
-export declare class TweetEntities implements ITweetEntities {
-    /** 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[];
-    constructor(entities: IRawTweetEntities);
-}
+import { User } from './User';
 /**
  * The details of a single Tweet.
  *
@@ -24,12 +9,14 @@ export declare class TweetEntities implements ITweetEntities {
 export declare class Tweet implements ITweet {
     /** The rest id of the tweet. */
     id: string;
-    /** The rest id of the user who made the tweet. */
-    tweetBy: string;
+    /** The details of the user who made the tweet. */
+    tweetBy: User;
     /** 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 urls of the media contents of the tweet (if any). */
+    media: TweetMedia[];
     /** The rest id of the tweet which is quoted in the tweet. */
     quoted: string;
     /** The full text content of the tweet. */
@@ -46,8 +33,50 @@ export declare class Tweet implements ITweet {
     retweetCount: number;
     /** The number of likes of the tweet. */
     likeCount: number;
+    /** The number of views of a tweet. */
+    viewCount: number;
+    /** The number of bookmarks of a tweet. */
+    bookmarkCount: number;
     /**
+     * Initializes a new Tweet from the given raw tweet data.
+     *
      * @param tweet - The raw tweet data.
      */
     constructor(tweet: IRawTweet);
 }
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export declare class TweetEntities implements ITweetEntities {
+    /** 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[];
+    /**
+     * Initializes the TweetEntities from the raw tweet entities.
+     *
+     * @param entities - The raw tweet entities.
+     */
+    constructor(entities: IRawTweetEntities);
+}
+/**
+ * A single media content.
+ *
+ * @public
+ */
+export declare class TweetMedia {
+    /** The type of media. */
+    type: EMediaType;
+    /** The direct URL to the media. */
+    url: string;
+    /**
+     * Initializes the TweetMedia from the raw tweet media.
+     *
+     * @param media - The raw tweet media.
+     */
+    constructor(media: IRawExtendedMedia);
+}

package/dist/models/Tweet.js

@@ -1,14 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tweet = exports.TweetEntities = void 0;
+exports.TweetMedia = exports.TweetEntities = exports.Tweet = void 0;
+// PACKAGES
+var rettiwt_core_1 = require("rettiwt-core");
+// MODELS
+var User_1 = require("./User");
 // PARSERS
 var JsonUtils_1 = require("../helper/JsonUtils");
+/**
+ * The details of a single Tweet.
+ *
+ * @public
+ */
+var Tweet = /** @class */ (function () {
+    /**
+     * Initializes a new Tweet from the given raw tweet data.
+     *
+     * @param tweet - The raw tweet data.
+     */
+    function Tweet(tweet) {
+        var _a, _b;
+        this.id = tweet.rest_id;
+        this.createdAt = tweet.legacy.created_at;
+        this.tweetBy = new User_1.User(tweet.core.user_results.result);
+        this.entities = new TweetEntities(tweet.legacy.entities);
+        this.media = (_b = (_a = tweet.legacy.extended_entities) === null || _a === void 0 ? void 0 : _a.media) === null || _b === void 0 ? void 0 : _b.map(function (media) { return new TweetMedia(media); });
+        this.quoted = tweet.legacy.quoted_status_id_str;
+        this.fullText = (0, JsonUtils_1.normalizeText)(tweet.legacy.full_text);
+        this.replyTo = tweet.legacy.in_reply_to_status_id_str;
+        this.lang = tweet.legacy.lang;
+        this.quoteCount = tweet.legacy.quote_count;
+        this.replyCount = tweet.legacy.reply_count;
+        this.retweetCount = tweet.legacy.retweet_count;
+        this.likeCount = tweet.legacy.favorite_count;
+        this.viewCount = parseInt(tweet.views.count);
+        this.bookmarkCount = tweet.legacy.bookmark_count;
+    }
+    return Tweet;
+}());
+exports.Tweet = Tweet;
 /**
  * The different types parsed entities like urls, media, mentions, hashtags, etc.
  *
  * @public
  */
 var TweetEntities = /** @class */ (function () {
+    /**
+     * Initializes the TweetEntities from the raw tweet entities.
+     *
+     * @param entities - The raw tweet entities.
+     */
     function TweetEntities(entities) {
         /** The list of hashtags mentioned in the tweet. */
         this.hashtags = [];
@@ -16,8 +57,6 @@ var TweetEntities = /** @class */ (function () {
         this.urls = [];
         /** The list of IDs of users mentioned in the tweet. */
         this.mentionedUsers = [];
-        /** The list of urls to various media mentioned in the tweet. */
-        this.media = [];
         // Extracting user mentions
         if (entities.user_mentions) {
             for (var _i = 0, _a = entities.user_mentions; _i < _a.length; _i++) {
@@ -39,41 +78,51 @@ var TweetEntities = /** @class */ (function () {
                 this.hashtags.push(hashtag.text);
             }
         }
-        // Extracting media urls (if any)
-        if (entities.media) {
-            for (var _f = 0, _g = entities.media; _f < _g.length; _f++) {
-                var media = _g[_f];
-                this.media.push(media.media_url_https);
-            }
-        }
     }
     return TweetEntities;
 }());
 exports.TweetEntities = TweetEntities;
 /**
- * The details of a single Tweet.
+ * A single media content.
  *
  * @public
  */
-var Tweet = /** @class */ (function () {
+var TweetMedia = /** @class */ (function () {
     /**
-     * @param tweet - The raw tweet data.
+     * Initializes the TweetMedia from the raw tweet media.
+     *
+     * @param media - The raw tweet media.
      */
-    function Tweet(tweet) {
-        this.id = tweet.rest_id;
-        this.createdAt = tweet.legacy.created_at;
-        this.tweetBy = tweet.legacy.user_id_str;
-        this.entities = new TweetEntities(tweet.legacy.entities);
-        this.quoted = tweet.legacy.quoted_status_id_str;
-        this.fullText = (0, JsonUtils_1.normalizeText)(tweet.legacy.full_text);
-        this.replyTo = tweet.legacy.in_reply_to_status_id_str;
-        this.lang = tweet.legacy.lang;
-        this.quoteCount = tweet.legacy.quote_count;
-        this.replyCount = tweet.legacy.reply_count;
-        this.retweetCount = tweet.legacy.retweet_count;
-        this.likeCount = tweet.legacy.favorite_count;
+    function TweetMedia(media) {
+        var _this = this;
+        var _a, _b;
+        /** The direct URL to the media. */
+        this.url = '';
+        this.type = media.type;
+        // If the media is a photo
+        if (media.type == rettiwt_core_1.EMediaType.PHOTO) {
+            this.url = media.media_url_https;
+        }
+        // If the media is a gif
+        else if (media.type == rettiwt_core_1.EMediaType.GIF) {
+            this.url = (_a = media.video_info) === null || _a === void 0 ? void 0 : _a.variants[0].url;
+        }
+        // If the media is a video
+        else {
+            /** The highest bitrate of all variants. */
+            var highestRate_1 = 0;
+            /**
+             * Selecting the URL of the video variant with the highest bitrate.
+             */
+            (_b = media.video_info) === null || _b === void 0 ? void 0 : _b.variants.forEach(function (variant) {
+                if (variant.bitrate > highestRate_1) {
+                    highestRate_1 = variant.bitrate;
+                    _this.url = variant.url;
+                }
+            });
+        }
     }
-    return Tweet;
+    return TweetMedia;
 }());
-exports.Tweet = Tweet;
+exports.TweetMedia = TweetMedia;
 //# sourceMappingURL=Tweet.js.map

package/dist/models/Tweet.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../src/models/Tweet.ts"],"names":[],"mappings":";;;AAIA,UAAU;AACV,iDAAoD;AAEpD;;;;GAIG;AACH;IAaC,uBAAY,QAA2B;QAZvC,mDAAmD;QACnD,aAAQ,GAAa,EAAE,CAAC;QAExB,+CAA+C;QAC/C,SAAI,GAAa,EAAE,CAAC;QAEpB,uDAAuD;QACvD,mBAAc,GAAa,EAAE,CAAC;QAE9B,gEAAgE;QAChE,UAAK,GAAa,EAAE,CAAC;QAGpB,2BAA2B;QAC3B,IAAI,QAAQ,CAAC,aAAa,EAAE;YAC3B,KAAmB,UAAsB,EAAtB,KAAA,QAAQ,CAAC,aAAa,EAAtB,cAAsB,EAAtB,IAAsB,EAAE;gBAAtC,IAAM,IAAI,SAAA;gBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC3C;SACD;QAED,kBAAkB;QAClB,IAAI,QAAQ,CAAC,IAAI,EAAE;YAClB,KAAkB,UAAa,EAAb,KAAA,QAAQ,CAAC,IAAI,EAAb,cAAa,EAAb,IAAa,EAAE;gBAA5B,IAAM,GAAG,SAAA;gBACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;aACjC;SACD;QAED,sBAAsB;QACtB,IAAI,QAAQ,CAAC,QAAQ,EAAE;YACtB,KAAsB,UAAiB,EAAjB,KAAA,QAAQ,CAAC,QAAQ,EAAjB,cAAiB,EAAjB,IAAiB,EAAE;gBAApC,IAAM,OAAO,SAAA;gBACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC;SACD;QAED,iCAAiC;QACjC,IAAI,QAAQ,CAAC,KAAK,EAAE;YACnB,KAAoB,UAAc,EAAd,KAAA,QAAQ,CAAC,KAAK,EAAd,cAAc,EAAd,IAAc,EAAE;gBAA/B,IAAM,KAAK,SAAA;gBACf,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;aACvC;SACD;IACF,CAAC;IACF,oBAAC;AAAD,CAAC,AA1CD,IA0CC;AA1CY,sCAAa;AA4C1B;;;;GAIG;AACH;IAqCC;;OAEG;IACH,eAAY,KAAgB;QAC3B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;IAC9C,CAAC;IACF,YAAC;AAAD,CAAC,AAtDD,IAsDC;AAtDY,sBAAK"}
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../src/models/Tweet.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,6CAKsB;AAKtB,SAAS;AACT,+BAA8B;AAE9B,UAAU;AACV,iDAAoD;AAEpD;;;;GAIG;AACH;IA8CC;;;;OAIG;IACH,eAAY,KAAgB;;QAC3B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,WAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,GAAG,MAAA,MAAA,KAAK,CAAC,MAAM,CAAC,iBAAiB,0CAAE,KAAK,0CAAE,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,IAAI,UAAU,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,CAAC;QAC1F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;IAClD,CAAC;IACF,YAAC;AAAD,CAAC,AApED,IAoEC;AApEY,sBAAK;AAsElB;;;;GAIG;AACH;IAUC;;;;OAIG;IACH,uBAAY,QAA2B;QAdvC,mDAAmD;QACnD,aAAQ,GAAa,EAAE,CAAC;QAExB,+CAA+C;QAC/C,SAAI,GAAa,EAAE,CAAC;QAEpB,uDAAuD;QACvD,mBAAc,GAAa,EAAE,CAAC;QAQ7B,2BAA2B;QAC3B,IAAI,QAAQ,CAAC,aAAa,EAAE;YAC3B,KAAmB,UAAsB,EAAtB,KAAA,QAAQ,CAAC,aAAa,EAAtB,cAAsB,EAAtB,IAAsB,EAAE;gBAAtC,IAAM,IAAI,SAAA;gBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC3C;SACD;QAED,kBAAkB;QAClB,IAAI,QAAQ,CAAC,IAAI,EAAE;YAClB,KAAkB,UAAa,EAAb,KAAA,QAAQ,CAAC,IAAI,EAAb,cAAa,EAAb,IAAa,EAAE;gBAA5B,IAAM,GAAG,SAAA;gBACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;aACjC;SACD;QAED,sBAAsB;QACtB,IAAI,QAAQ,CAAC,QAAQ,EAAE;YACtB,KAAsB,UAAiB,EAAjB,KAAA,QAAQ,CAAC,QAAQ,EAAjB,cAAiB,EAAjB,IAAiB,EAAE;gBAApC,IAAM,OAAO,SAAA;gBACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC;SACD;IACF,CAAC;IACF,oBAAC;AAAD,CAAC,AArCD,IAqCC;AArCY,sCAAa;AAuC1B;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,oBAAY,KAAwB;QAApC,iBA0BC;;QAlCD,mCAAmC;QACnC,QAAG,GAAW,EAAE,CAAC;QAQhB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEvB,0BAA0B;QAC1B,IAAI,KAAK,CAAC,IAAI,IAAI,yBAAU,CAAC,KAAK,EAAE;YACnC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC;SACjC;QACD,wBAAwB;aACnB,IAAI,KAAK,CAAC,IAAI,IAAI,yBAAU,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,UAAU,0CAAE,QAAQ,CAAC,CAAC,EAAE,GAAa,CAAC;SACvD;QACD,0BAA0B;aACrB;YACJ,2CAA2C;YAC3C,IAAI,aAAW,GAAW,CAAC,CAAC;YAE5B;;eAEG;YACH,MAAA,KAAK,CAAC,UAAU,0CAAE,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO;gBAC1C,IAAI,OAAO,CAAC,OAAO,GAAG,aAAW,EAAE;oBAClC,aAAW,GAAG,OAAO,CAAC,OAAO,CAAC;oBAC9B,KAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;iBACvB;YACF,CAAC,CAAC,CAAC;SACH;IACF,CAAC;IACF,iBAAC;AAAD,CAAC,AAvCD,IAuCC;AAvCY,gCAAU"}

package/dist/models/User.d.ts

@@ -1,5 +1,5 @@
-import { IUser } from '../types/User';
 import { IUser as IRawUser } from 'rettiwt-core';
+import { IUser } from '../types/User';
 /**
  * The details of a single user.
  *
@@ -35,6 +35,8 @@ export declare class User implements IUser {
     /** The url of the profile image. */
     profileImage: string;
     /**
+     * Initializes a new User from the given raw user data.
+     *
      * @param user - The raw user data.
      */
     constructor(user: IRawUser);

package/dist/models/User.js

@@ -8,6 +8,8 @@ exports.User = void 0;
  */
 var User = /** @class */ (function () {
     /**
+     * Initializes a new User from the given raw user data.
+     *
      * @param user - The raw user data.
      */
     function User(user) {

package/dist/models/User.js.map

@@ -1 +1 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../src/models/User.ts"],"names":[],"mappings":";;;AAIA;;;;GAIG;AACH;IA2CC;;OAEG;IACH,cAAY,IAAc;QACzB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACzD,CAAC;IACF,WAAC;AAAD,CAAC,AA9DD,IA8DC;AA9DY,oBAAI"}
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../src/models/User.ts"],"names":[],"mappings":";;;AAMA;;;;GAIG;AACH;IA2CC;;;;OAIG;IACH,cAAY,IAAc;QACzB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACzD,CAAC;IACF,WAAC;AAAD,CAAC,AAhED,IAgEC;AAhEY,oBAAI"}