rettiwt-api 2.0.3 → 2.2.0

package/dist/services/FetcherService.d.ts

@@ -1,5 +1,4 @@
 import { Args, EResourceType } from 'rettiwt-core';
-import { AuthCredential } from 'rettiwt-auth';
 import { CursoredData } from '../models/CursoredData';
 import { Tweet } from '../models/Tweet';
 import { User } from '../models/User';
@@ -11,10 +10,27 @@ import { User } from '../models/User';
 export declare class FetcherService {
     /** The credential to use for authenticating against Twitter API. */
     private cred;
+    /** The HTTPS Agent to use for requests to Twitter API. */
+    private readonly httpsAgent;
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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(cred: AuthCredential);
+    constructor(apiKey: string, proxyUrl?: URL);
+    /**
+     * Returns an AuthCredential generated using the given API key.
+     *
+     * @param apiKey - The API key to use for authenticating.
+     * @returns The generated AuthCredential.
+     */
+    private getAuthCredential;
+    /**
+     * Gets the HttpsAgent based on whether a proxy is used or not.
+     *
+     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
+     * @returns The HttpsAgent to use.
+     */
+    private getHttpsAgent;
     /**
      * The middleware for handling any http error.
      *

package/dist/services/FetcherService.js

@@ -43,6 +43,9 @@ exports.FetcherService = void 0;
 // PACKAGES
 var rettiwt_core_1 = require("rettiwt-core");
 var axios_1 = __importDefault(require("axios"));
+var https_1 = __importDefault(require("https"));
+var rettiwt_auth_1 = require("rettiwt-auth");
+var https_proxy_agent_1 = require("https-proxy-agent");
 // ENUMS
 var HTTP_1 = require("../enums/HTTP");
 var ApiErrors_1 = require("../enums/ApiErrors");
@@ -57,11 +60,34 @@ var JsonUtils_1 = require("../helper/JsonUtils");
  */
 var FetcherService = /** @class */ (function () {
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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 FetcherService(cred) {
-        this.cred = cred;
+    function FetcherService(apiKey, proxyUrl) {
+        this.cred = this.getAuthCredential(apiKey);
+        this.httpsAgent = this.getHttpsAgent(proxyUrl);
     }
+    /**
+     * Returns an AuthCredential generated using the given API key.
+     *
+     * @param apiKey - The API key to use for authenticating.
+     * @returns The generated AuthCredential.
+     */
+    FetcherService.prototype.getAuthCredential = function (apiKey) {
+        return new rettiwt_auth_1.AuthCredential(apiKey.split(';'));
+    };
+    /**
+     * Gets the HttpsAgent based on whether a proxy is used or not.
+     *
+     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
+     * @returns The HttpsAgent to use.
+     */
+    FetcherService.prototype.getHttpsAgent = function (proxyUrl) {
+        if (proxyUrl) {
+            return new https_proxy_agent_1.HttpsProxyAgent(proxyUrl);
+        }
+        return new https_1.default.Agent();
+    };
     /**
      * The middleware for handling any http error.
      *
@@ -113,13 +139,14 @@ var FetcherService = /** @class */ (function () {
                             method: config.type,
                             data: config.payload,
                             headers: JSON.parse(JSON.stringify(this.cred.toHeader())),
+                            httpsAgent: this.httpsAgent,
                         };
                         return [4 /*yield*/, (0, axios_1.default)(axiosRequest)
                                 .then(function (res) { return _this.handleHttpError(res); })
                                 .then(function (res) { return _this.handleApiError(res); })];
                     case 1: 
                     /**
-                     * After making the request, the response is then passed to HTTP error handling middlware for HTTP error handling.
+                     * After making the request, the response is then passed to HTTP error handling middleware for HTTP error handling.
                      */
                     return [2 /*return*/, _a.sent()];
                 }
@@ -147,10 +174,16 @@ var FetcherService = /** @class */ (function () {
         else if (type == rettiwt_core_1.EResourceType.USER_DETAILS || type == rettiwt_core_1.EResourceType.USER_DETAILS_BY_ID) {
             required = (0, JsonUtils_1.findByFilter)(data, '__typename', 'User');
         }
-        else if (type == rettiwt_core_1.EResourceType.TWEET_SEARCH || type == rettiwt_core_1.EResourceType.USER_LIKES) {
+        else if (type == rettiwt_core_1.EResourceType.TWEET_SEARCH ||
+            type == rettiwt_core_1.EResourceType.USER_LIKES ||
+            type == rettiwt_core_1.EResourceType.LIST_TWEETS ||
+            type == rettiwt_core_1.EResourceType.USER_TWEETS) {
             required = (0, JsonUtils_1.findByFilter)(data, '__typename', 'TimelineTweet').map(function (item) { return item.tweet_results.result; });
         }
-        else {
+        else if (type == rettiwt_core_1.EResourceType.TWEET_FAVORITERS ||
+            type == rettiwt_core_1.EResourceType.TWEET_RETWEETERS ||
+            type == rettiwt_core_1.EResourceType.USER_FOLLOWERS ||
+            type == rettiwt_core_1.EResourceType.USER_FOLLOWING) {
             required = (0, JsonUtils_1.findByFilter)(data, '__typename', 'TimelineUser').map(function (item) { return item.user_results.result; });
         }
         return new CursoredData_1.CursoredData(required, (_a = (0, JsonUtils_1.findByFilter)(data, 'cursorType', 'Bottom')[0]) === null || _a === void 0 ? void 0 : _a.value);

package/dist/services/FetcherService.js.map

@@ -1 +1 @@
-{"version":3,"file":"FetcherService.js","sourceRoot":"","sources":["../../src/services/FetcherService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAWsB;AACtB,gDAAsF;AAGtF,QAAQ;AACR,sCAA4C;AAC5C,gDAAgD;AAEhD,SAAS;AACT,uDAAsD;AAItD,UAAU;AACV,iDAAmE;AAEnE;;;;GAIG;AACH;IAIC;;OAEG;IACH,wBAAY,IAAoB;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACK,wCAAe,GAAvB,UAAwB,GAAsC;QAC7D;;WAEG;QACH,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,kBAAW,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,kBAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;SACzC;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACK,uCAAc,GAAtB,UAAuB,GAAsC;QAC5D,kBAAkB;QAClB,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC9C,yBAAyB;YACzB,IAAM,IAAI,GAAW,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAE7C,4BAA4B;YAC5B,IAAM,OAAO,GAAW,sBAAU,CACjC,IAAA,0BAAc,EAAC,0BAAW,EAAE,UAAG,IAAI,CAAE,CAA4B,CACvD,CAAC;YAEZ,kBAAkB;YAClB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACzB;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACW,gCAAO,GAArB,UAAsB,MAAe;;;;;;;wBAI9B,YAAY,GAAuB;4BACxC,GAAG,EAAE,MAAM,CAAC,GAAG;4BACf,MAAM,EAAE,MAAM,CAAC,IAAI;4BACnB,IAAI,EAAE,MAAM,CAAC,OAAO;4BACpB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAwB;yBAChF,CAAC;wBAKK,qBAAM,IAAA,eAAK,EAAqB,YAAY,CAAC;iCAClD,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,KAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAzB,CAAyB,CAAC;iCACxC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,KAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAxB,CAAwB,CAAC,EAAA;;oBALzC;;uBAEG;oBACH,sBAAO,SAEkC,EAAC;;;;KAC1C;IAED;;;;;;;;OAQG;IACK,oCAAW,GAAnB,UACC,IAA0B,EAC1B,IAAmB;;QAEnB;;WAEG;QACH,IAAI,QAAQ,GAAG,EAAE,CAAC;QAElB,IAAI,IAAI,IAAI,4BAAa,CAAC,aAAa,EAAE;YACxC,QAAQ,GAAG,IAAA,wBAAY,EAAY,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;SAChE;aAAM,IAAI,IAAI,IAAI,4BAAa,CAAC,YAAY,IAAI,IAAI,IAAI,4BAAa,CAAC,kBAAkB,EAAE;YAC1F,QAAQ,GAAG,IAAA,wBAAY,EAAW,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;SAC9D;aAAM,IAAI,IAAI,IAAI,4BAAa,CAAC,YAAY,IAAI,IAAI,IAAI,4BAAa,CAAC,UAAU,EAAE;YAClF,QAAQ,GAAG,IAAA,wBAAY,EAAiB,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC,GAAG,CAC/E,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,aAAa,CAAC,MAAM,EAAzB,CAAyB,CACnC,CAAC;SACF;aAAM;YACN,QAAQ,GAAG,IAAA,wBAAY,EAAgB,IAAI,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC,GAAG,CAC7E,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,YAAY,CAAC,MAAM,EAAxB,CAAwB,CAClC,CAAC;SACF;QAED,OAAO,IAAI,2BAAY,CAAC,QAAQ,EAAE,MAAA,IAAA,wBAAY,EAAa,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;OAOG;IACa,8BAAK,GAArB,UACC,YAA2B,EAC3B,IAAU;;;;;;wBAGJ,OAAO,GAAY,IAAI,sBAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;wBAG7C,qBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ,CAAC,EAAA;;wBAAzD,GAAG,GAAG,SAAmD;wBAGzD,IAAI,GAAG,IAAI,CAAC,WAAW,CAAU,GAAG,EAAE,YAAY,CAAC,CAAC;wBAE1D,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;OAMG;IACa,6BAAI,GAApB,UAAqB,YAA2B,EAAE,IAAU;;;;;;wBAErD,OAAO,GAAY,IAAI,sBAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;wBAEzD,mBAAmB;wBACnB,qBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAA;;wBAD3B,mBAAmB;wBACnB,SAA2B,CAAC;wBAE5B,sBAAO,IAAI,EAAC;;;;KACZ;IACF,qBAAC;AAAD,CAAC,AAxJD,IAwJC;AAxJY,wCAAc"}
+{"version":3,"file":"FetcherService.js","sourceRoot":"","sources":["../../src/services/FetcherService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAWsB;AACtB,gDAAsF;AACtF,gDAAqC;AACrC,6CAA8C;AAC9C,uDAAoD;AAEpD,QAAQ;AACR,sCAA4C;AAC5C,gDAAgD;AAEhD,SAAS;AACT,uDAAsD;AAItD,UAAU;AACV,iDAAmE;AAEnE;;;;GAIG;AACH;IAOC;;;OAGG;IACH,wBAAY,MAAc,EAAE,QAAc;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACK,0CAAiB,GAAzB,UAA0B,MAAc;QACvC,OAAO,IAAI,6BAAc,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACK,sCAAa,GAArB,UAAsB,QAAc;QACnC,IAAI,QAAQ,EAAE;YACb,OAAO,IAAI,mCAAe,CAAC,QAAQ,CAAC,CAAC;SACrC;QAED,OAAO,IAAI,eAAK,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACK,wCAAe,GAAvB,UAAwB,GAAsC;QAC7D;;WAEG;QACH,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,kBAAW,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,kBAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;SACzC;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACK,uCAAc,GAAtB,UAAuB,GAAsC;QAC5D,kBAAkB;QAClB,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC9C,yBAAyB;YACzB,IAAM,IAAI,GAAW,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAE7C,4BAA4B;YAC5B,IAAM,OAAO,GAAW,sBAAU,CACjC,IAAA,0BAAc,EAAC,0BAAW,EAAE,UAAG,IAAI,CAAE,CAA4B,CACvD,CAAC;YAEZ,kBAAkB;YAClB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACzB;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACW,gCAAO,GAArB,UAAsB,MAAe;;;;;;;wBAI9B,YAAY,GAAuB;4BACxC,GAAG,EAAE,MAAM,CAAC,GAAG;4BACf,MAAM,EAAE,MAAM,CAAC,IAAI;4BACnB,IAAI,EAAE,MAAM,CAAC,OAAO;4BACpB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAwB;4BAChF,UAAU,EAAE,IAAI,CAAC,UAAU;yBAC3B,CAAC;wBAKK,qBAAM,IAAA,eAAK,EAAqB,YAAY,CAAC;iCAClD,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,KAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAzB,CAAyB,CAAC;iCACxC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,KAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAxB,CAAwB,CAAC,EAAA;;oBALzC;;uBAEG;oBACH,sBAAO,SAEkC,EAAC;;;;KAC1C;IAED;;;;;;;;OAQG;IACK,oCAAW,GAAnB,UACC,IAA0B,EAC1B,IAAmB;;QAEnB;;WAEG;QACH,IAAI,QAAQ,GAA6B,EAAE,CAAC;QAE5C,IAAI,IAAI,IAAI,4BAAa,CAAC,aAAa,EAAE;YACxC,QAAQ,GAAG,IAAA,wBAAY,EAAY,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;SAChE;aAAM,IAAI,IAAI,IAAI,4BAAa,CAAC,YAAY,IAAI,IAAI,IAAI,4BAAa,CAAC,kBAAkB,EAAE;YAC1F,QAAQ,GAAG,IAAA,wBAAY,EAAW,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;SAC9D;aAAM,IACN,IAAI,IAAI,4BAAa,CAAC,YAAY;YAClC,IAAI,IAAI,4BAAa,CAAC,UAAU;YAChC,IAAI,IAAI,4BAAa,CAAC,WAAW;YACjC,IAAI,IAAI,4BAAa,CAAC,WAAW,EAChC;YACD,QAAQ,GAAG,IAAA,wBAAY,EAAiB,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC,GAAG,CAC/E,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,aAAa,CAAC,MAAM,EAAzB,CAAyB,CACnC,CAAC;SACF;aAAM,IACN,IAAI,IAAI,4BAAa,CAAC,gBAAgB;YACtC,IAAI,IAAI,4BAAa,CAAC,gBAAgB;YACtC,IAAI,IAAI,4BAAa,CAAC,cAAc;YACpC,IAAI,IAAI,4BAAa,CAAC,cAAc,EACnC;YACD,QAAQ,GAAG,IAAA,wBAAY,EAAgB,IAAI,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC,GAAG,CAC7E,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,YAAY,CAAC,MAAM,EAAxB,CAAwB,CAClC,CAAC;SACF;QAED,OAAO,IAAI,2BAAY,CAAC,QAAQ,EAAE,MAAA,IAAA,wBAAY,EAAa,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;OAOG;IACa,8BAAK,GAArB,UACC,YAA2B,EAC3B,IAAU;;;;;;wBAGJ,OAAO,GAAY,IAAI,sBAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;wBAG7C,qBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ,CAAC,EAAA;;wBAAzD,GAAG,GAAG,SAAmD;wBAGzD,IAAI,GAAG,IAAI,CAAC,WAAW,CAAU,GAAG,EAAE,YAAY,CAAC,CAAC;wBAE1D,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;OAMG;IACa,6BAAI,GAApB,UAAqB,YAA2B,EAAE,IAAU;;;;;;wBAErD,OAAO,GAAY,IAAI,sBAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;wBAEzD,mBAAmB;wBACnB,qBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAA;;wBAD3B,mBAAmB;wBACnB,SAA2B,CAAC;wBAE5B,sBAAO,IAAI,EAAC;;;;KACZ;IACF,qBAAC;AAAD,CAAC,AAhMD,IAgMC;AAhMY,wCAAc"}

package/dist/services/TweetService.d.ts

@@ -1,5 +1,4 @@
 import { TweetFilter } from 'rettiwt-core';
-import { AuthCredential } from 'rettiwt-auth';
 import { FetcherService } from './FetcherService';
 import { Tweet } from '../models/Tweet';
 import { User } from '../models/User';
@@ -11,11 +10,21 @@ import { CursoredData } from '../models/CursoredData';
  */
 export declare class TweetService extends FetcherService {
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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.
      *
      * @internal
      */
-    constructor(cred: AuthCredential);
+    constructor(apiKey: string, proxyUrl?: URL);
+    /**
+     * Get the details of a tweet.
+     *
+     * @param id - The id of the target tweet.
+     * @returns The details of a single tweet with the given tweet id.
+     *
+     * @public
+     */
+    details(id: string): Promise<Tweet>;
     /**
      * Search for tweets using a query.
      *
@@ -28,14 +37,16 @@ export declare class TweetService extends FetcherService {
      */
     search(query: TweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
-     * Get the details of a tweet.
+     * Get the tweets from the tweet list with the given id.
      *
-     * @param id - The id of the target tweet.
-     * @returns The details of a single tweet with the given tweet id.
+     * @param listId - The id of list from where the tweets are to be fetched.
+     * @param count - The number of tweets to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The list tweets present in the given list.
      *
-     * @public
+     * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
-    details(id: string): Promise<Tweet>;
+    list(listId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
      * Get the list of users who liked a tweet.
      *

package/dist/services/TweetService.js

@@ -64,13 +64,35 @@ var FetcherService_1 = require("./FetcherService");
 var TweetService = /** @class */ (function (_super) {
     __extends(TweetService, _super);
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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.
      *
      * @internal
      */
-    function TweetService(cred) {
-        return _super.call(this, cred) || this;
+    function TweetService(apiKey, proxyUrl) {
+        return _super.call(this, apiKey, proxyUrl) || this;
     }
+    /**
+     * Get the details of a tweet.
+     *
+     * @param id - The id of the target tweet.
+     * @returns The details of a single tweet with the given tweet id.
+     *
+     * @public
+     */
+    TweetService.prototype.details = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.TWEET_DETAILS, { id: id })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data.list[0]];
+                }
+            });
+        });
+    };
     /**
      * Search for tweets using a query.
      *
@@ -101,22 +123,30 @@ var TweetService = /** @class */ (function (_super) {
         });
     };
     /**
-     * Get the details of a tweet.
+     * Get the tweets from the tweet list with the given id.
      *
-     * @param id - The id of the target tweet.
-     * @returns The details of a single tweet with the given tweet id.
+     * @param listId - The id of list from where the tweets are to be fetched.
+     * @param count - The number of tweets to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The list tweets present in the given list.
      *
-     * @public
+     * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
-    TweetService.prototype.details = function (id) {
+    TweetService.prototype.list = function (listId, count, cursor) {
         return __awaiter(this, void 0, void 0, function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.TWEET_DETAILS, { id: id })];
+                    case 0: return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.LIST_TWEETS, {
+                            id: listId,
+                            count: count,
+                            cursor: cursor,
+                        })];
                     case 1:
                         data = _a.sent();
-                        return [2 /*return*/, data.list[0]];
+                        // Sorting the tweets by date, from recent to oldest
+                        data.list.sort(function (a, b) { return new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf(); });
+                        return [2 /*return*/, data];
                 }
             });
         });

package/dist/services/TweetService.js.map

@@ -1 +1 @@
-{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../src/services/TweetService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA0D;AAG1D,WAAW;AACX,mDAAkD;AAOlD;;;;GAIG;AACH;IAAkC,gCAAc;IAC/C;;;;OAIG;IACH,sBAAY,IAAoB;eAC/B,kBAAM,IAAI,CAAC;IACZ,CAAC;IAED;;;;;;;;;OASG;IACG,6BAAM,GAAZ,UAAa,KAAkB,EAAE,KAAc,EAAE,MAAe;;;;;4BAElD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,YAAY,EAAE;4BAChE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,8BAAO,GAAb,UAAc,EAAU;;;;;4BAEV,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,aAAa,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAAvE,IAAI,GAAG,SAAgE;wBAE7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;OASG;IACG,iCAAU,GAAhB,UAAiB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,iCAAU,GAAhB,UAAiB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,4BAAK,GAAX,UAAY,SAAiB;;;;;4BAEf,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAA;;wBAA5E,IAAI,GAAG,SAAqE;wBAElF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,+BAAQ,GAAd,UAAe,OAAe;;;;;4BAEhB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,8BAAO,GAAb,UAAc,OAAe;;;;;4BAEf,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IACF,mBAAC;AAAD,CAAC,AAvID,CAAkC,+BAAc,GAuI/C;AAvIY,oCAAY"}
+{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../src/services/TweetService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA0D;AAE1D,WAAW;AACX,mDAAkD;AAOlD;;;;GAIG;AACH;IAAkC,gCAAc;IAC/C;;;;;OAKG;IACH,sBAAY,MAAc,EAAE,QAAc;eACzC,kBAAM,MAAM,EAAE,QAAQ,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACG,8BAAO,GAAb,UAAc,EAAU;;;;;4BAEV,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,aAAa,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAAvE,IAAI,GAAG,SAAgE;wBAE7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;OASG;IACG,6BAAM,GAAZ,UAAa,KAAkB,EAAE,KAAc,EAAE,MAAe;;;;;4BAElD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,YAAY,EAAE;4BAChE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,2BAAI,GAAV,UAAW,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAE5C,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,WAAW,EAAE;4BAC/D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,iCAAU,GAAhB,UAAiB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,iCAAU,GAAhB,UAAiB,OAAe,EAAE,KAAc,EAAE,MAAe;;;;;4BAEnD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,gBAAgB,EAAE;4BACnE,EAAE,EAAE,OAAO;4BACX,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,4BAAK,GAAX,UAAY,SAAiB;;;;;4BAEf,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAA;;wBAA5E,IAAI,GAAG,SAAqE;wBAElF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,+BAAQ,GAAd,UAAe,OAAe;;;;;4BAEhB,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;OAOG;IACG,8BAAO,GAAb,UAAc,OAAe;;;;;4BAEf,qBAAM,IAAI,CAAC,IAAI,CAAC,4BAAa,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAE3E,sBAAO,IAAI,EAAC;;;;KACZ;IACF,mBAAC;AAAD,CAAC,AAhKD,CAAkC,+BAAc,GAgK/C;AAhKY,oCAAY"}

package/dist/services/UserService.d.ts

@@ -1,4 +1,3 @@
-import { AuthCredential } from 'rettiwt-auth';
 import { FetcherService } from './FetcherService';
 import { User } from '../models/User';
 import { Tweet } from '../models/Tweet';
@@ -10,11 +9,12 @@ import { CursoredData } from '../models/CursoredData';
  */
 export declare class UserService extends FetcherService {
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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.
      *
      * @internal
      */
-    constructor(cred: AuthCredential);
+    constructor(apiKey: string, proxyUrl?: URL);
     /**
      * Get the details of a user.
      *
@@ -57,4 +57,17 @@ export declare class UserService extends FetcherService {
      * @public
      */
     likes(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    /**
+     * Get the timeline of the given user.
+     *
+     * @param userId - The rest id of the target user.
+     * @param count - The number of timeline items to fetch, must be \<= 20.
+     * @param cursor - The cursor to the batch of timeline items to fetch.
+     * @returns The timeline of the target user.
+     *
+     * @remarks If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
+     *
+     * @public
+     */
+    timeline(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
 }

package/dist/services/UserService.js

@@ -64,12 +64,13 @@ var FetcherService_1 = require("./FetcherService");
 var UserService = /** @class */ (function (_super) {
     __extends(UserService, _super);
     /**
-     * @param cred - The credentials to use for authenticating against Twitter API.
+     * @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.
      *
      * @internal
      */
-    function UserService(cred) {
-        return _super.call(this, cred) || this;
+    function UserService(apiKey, proxyUrl) {
+        return _super.call(this, apiKey, proxyUrl) || this;
     }
     /**
      * Get the details of a user.
@@ -182,6 +183,35 @@ var UserService = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Get the timeline of the given user.
+     *
+     * @param userId - The rest id of the target user.
+     * @param count - The number of timeline items to fetch, must be \<= 20.
+     * @param cursor - The cursor to the batch of timeline items to fetch.
+     * @returns The timeline of the target user.
+     *
+     * @remarks If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
+     *
+     * @public
+     */
+    UserService.prototype.timeline = function (userId, count, cursor) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.USER_TWEETS, {
+                            id: userId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
     return UserService;
 }(FetcherService_1.FetcherService));
 exports.UserService = UserService;

package/dist/services/UserService.js.map

@@ -1 +1 @@
-{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../src/services/UserService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA6C;AAG7C,WAAW;AACX,mDAAkD;AASlD;;;;GAIG;AACH;IAAiC,+BAAc;IAC9C;;;;OAIG;IACH,qBAAY,IAAoB;eAC/B,kBAAM,IAAI,CAAC;IACZ,CAAC;IAED;;;;;;;OAOG;IACG,6BAAO,GAAb,UAAc,EAAU;;;;;;6BAInB,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,EAArB,wBAAqB;wBAEjB,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBADrE,8BAA8B;wBAC9B,IAAI,GAAG,SAA8D,CAAC;;4BAK/D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAD3E,8BAA8B;wBAC9B,IAAI,GAAG,SAAoE,CAAC;;4BAG7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;OASG;IACG,+BAAS,GAAf,UAAgB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEjD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,cAAc,EAAE;4BACjE,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,+BAAS,GAAf,UAAgB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEjD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,cAAc,EAAE;4BACjE,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,2BAAK,GAAX,UAAY,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAE7C,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,UAAU,EAAE;4BAC9D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IACF,kBAAC;AAAD,CAAC,AAjGD,CAAiC,+BAAc,GAiG9C;AAjGY,kCAAW"}
+{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../src/services/UserService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA6C;AAE7C,WAAW;AACX,mDAAkD;AASlD;;;;GAIG;AACH;IAAiC,+BAAc;IAC9C;;;;;OAKG;IACH,qBAAY,MAAc,EAAE,QAAc;eACzC,kBAAM,MAAM,EAAE,QAAQ,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACG,6BAAO,GAAb,UAAc,EAAU;;;;;;6BAInB,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,EAArB,wBAAqB;wBAEjB,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBADrE,8BAA8B;wBAC9B,IAAI,GAAG,SAA8D,CAAC;;4BAK/D,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAA;;wBAD3E,8BAA8B;wBAC9B,IAAI,GAAG,SAAoE,CAAC;;4BAG7E,sBAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC;;;;KACpB;IAED;;;;;;;;;OASG;IACG,+BAAS,GAAf,UAAgB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEjD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,cAAc,EAAE;4BACjE,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,+BAAS,GAAf,UAAgB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEjD,qBAAM,IAAI,CAAC,KAAK,CAAO,4BAAa,CAAC,cAAc,EAAE;4BACjE,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;OASG;IACG,2BAAK,GAAX,UAAY,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAE7C,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,UAAU,EAAE;4BAC9D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;OAWG;IACG,8BAAQ,GAAd,UAAe,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEhD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,WAAW,EAAE;4BAC/D,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,sBAAO,IAAI,EAAC;;;;KACZ;IACF,kBAAC;AAAD,CAAC,AAzHD,CAAiC,+BAAc,GAyH9C;AAzHY,kCAAW"}

package/dist/types/CursoredData.d.ts

@@ -1,12 +1,3 @@
-/**
- * The cursor to the batch of data to be fetched.
- *
- * @public
- */
-export interface ICursor {
-    /** The cursor string. */
-    value: string;
-}
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -20,3 +11,12 @@ export interface ICursoredData<T> {
     /** The cursor to the next batch of data. */
     next: ICursor;
 }
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+export interface ICursor {
+    /** The cursor string. */
+    value: string;
+}

package/dist/types/List.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+export interface 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;
+}

package/dist/types/List.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=List.js.map

package/dist/types/List.js.map

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

package/dist/types/Tweet.d.ts

@@ -1,18 +1,5 @@
-/**
- * The different types parsed entities like urls, media, mentions, hashtags, etc.
- *
- * @public
- */
-export interface 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[];
-}
+import { EMediaType } from 'rettiwt-core';
+import { IUser } from './User';
 /**
  * The details of a single Tweet.
  *
@@ -21,12 +8,14 @@ export interface ITweetEntities {
 export interface 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: IUser;
     /** The date and time of creation of the tweet, in UTC string format. */
     createdAt: string;
     /** Additional tweet entities like urls, mentions, etc. */
     entities: ITweetEntities;
+    /** The urls of the media contents of the tweet (if any). */
+    media: ITweetMedia[];
     /** The rest id of the tweet which is quoted in the tweet. */
     quoted: string;
     /** The full text content of the tweet. */
@@ -43,4 +32,32 @@ export interface 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;
+}
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export interface 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[];
+}
+/**
+ * A single media content.
+ *
+ * @public
+ */
+export interface ITweetMedia {
+    /** The type of media. */
+    type: EMediaType;
+    /** The direct URL to the media. */
+    url: string;
 }

package/package.json

@@ -1,11 +1,12 @@
 {
 	"name": "rettiwt-api",
-	"version": "2.0.3",
+	"version": "2.2.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",
 	"scripts": {
 		"build": "tsc",
+		"prepare": "tsc",
 		"format": "prettier --write .",
 		"lint": "eslint --max-warnings 0 .",
 		"docs": "typedoc src/index.ts",
@@ -26,8 +27,9 @@
 	"homepage": "https://rishikant181.github.io/Rettiwt-API/",
 	"dependencies": {
 		"axios": "1.3.2",
+		"https-proxy-agent": "^7.0.2",
 		"rettiwt-auth": "1.2.0",
-		"rettiwt-core": "3.1.0"
+		"rettiwt-core": "3.2.0-alpha.3"
 	},
 	"devDependencies": {
 		"@types/node": "20.4.1",

package/src/Rettiwt.ts

@@ -1,6 +1,3 @@
-// PACKAGE
-import { AuthCredential } from 'rettiwt-auth';
-
 // SERVICES
 import { TweetService } from './services/TweetService';
 import { UserService } from './services/UserService';
@@ -20,14 +17,11 @@ export 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) {
-		// Preparing auth credentials
-		const cred: AuthCredential = new AuthCredential(apiKey.split(';'));
-
-		// Initalizing service instances
-		this.tweet = new TweetService(cred);
-		this.user = new UserService(cred);
+	constructor(apiKey: string, proxyUrl?: URL) {
+		this.tweet = new TweetService(apiKey, proxyUrl);
+		this.user = new UserService(apiKey, proxyUrl);
 	}
 }

package/src/index.ts

@@ -7,6 +7,7 @@ export * from './enums/HTTP';
 
 // Exporting models
 export * from './models/CursoredData';
+export * from './models/List';
 export * from './models/Tweet';
 export * from './models/User';
 
@@ -17,5 +18,6 @@ export * from './services/UserService';
 
 // Exporting types
 export * from './types/CursoredData';
+export * from './types/List';
 export * from './types/Tweet';
 export * from './types/User';

package/src/models/CursoredData.ts

@@ -8,25 +8,6 @@ import { User } from './User';
 // TYPES
 import { ICursor, ICursoredData } from '../types/CursoredData';
 
-/**
- * The cursor to the batch of data to be fetched.
- *
- * @public
- */
-export 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) {
-		this.value = cursorStr;
-	}
-}
-
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -62,3 +43,22 @@ export class CursoredData<T extends Tweet | User> implements ICursoredData<T> {
 		this.next = new Cursor(next);
 	}
 }
+
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+export 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) {
+		this.value = cursorStr;
+	}
+}