rettiwt-api 2.1.0 → 2.2.1

package/dist/services/TweetService.js

@@ -64,12 +64,13 @@ 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.

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;;;;;;;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,AA/JD,CAAkC,+BAAc,GA+J/C;AA/JY,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.
@@ -85,7 +86,7 @@ var UserService = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!isNaN(parseFloat(id))) return [3 /*break*/, 2];
+                        if (!isNaN(Number(id))) return [3 /*break*/, 2];
                         return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.USER_DETAILS, { id: id })];
                     case 1:
                         // Fetching the requested data
@@ -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,MAAM,CAAC,EAAE,CAAC,CAAC,EAAjB,wBAAiB;wBAEb,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/Tweet.d.ts

@@ -1,19 +1,5 @@
+import { EMediaType } from 'rettiwt-core';
 import { IUser } from './User';
-/**
- * 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[];
-}
 /**
  * The details of a single Tweet.
  *
@@ -28,6 +14,8 @@ export interface ITweet {
     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. */
@@ -49,3 +37,27 @@ export interface ITweet {
     /** 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.1.0",
+	"version": "2.2.1",
 	"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.2"
+		"rettiwt-core": "3.2.0"
 	},
 	"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/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;
+	}
+}

package/src/models/Tweet.ts

@@ -1,6 +1,13 @@
+// PACKAGES
+import {
+	ITweet as IRawTweet,
+	IEntities as IRawTweetEntities,
+	IExtendedMedia as IRawExtendedMedia,
+	EMediaType,
+} from 'rettiwt-core';
+
 // TYPES
 import { ITweet, ITweetEntities } from '../types/Tweet';
-import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from 'rettiwt-core';
 
 // MODELS
 import { User } from './User';
@@ -8,55 +15,6 @@ import { User } from './User';
 // PARSERS
 import { normalizeText } from '../helper/JsonUtils';
 
-/**
- * The different types parsed entities like urls, media, mentions, hashtags, etc.
- *
- * @public
- */
-export 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) {
-		// Extracting user mentions
-		if (entities.user_mentions) {
-			for (const user of entities.user_mentions) {
-				this.mentionedUsers.push(user.screen_name);
-			}
-		}
-
-		// Extracting urls
-		if (entities.urls) {
-			for (const url of entities.urls) {
-				this.urls.push(url.expanded_url);
-			}
-		}
-
-		// Extracting hashtags
-		if (entities.hashtags) {
-			for (const hashtag of entities.hashtags) {
-				this.hashtags.push(hashtag.text);
-			}
-		}
-
-		// Extracting media urls (if any)
-		if (entities.media) {
-			for (const media of entities.media) {
-				this.media.push(media.media_url_https);
-			}
-		}
-	}
-}
-
 /**
  * The details of a single Tweet.
  *
@@ -75,6 +33,9 @@ export class Tweet implements ITweet {
 	/** 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;
 
@@ -115,6 +76,7 @@ export class Tweet implements ITweet {
 		this.createdAt = tweet.legacy.created_at;
 		this.tweetBy = new User(tweet.core.user_results.result);
 		this.entities = new TweetEntities(tweet.legacy.entities);
+		this.media = tweet.legacy.extended_entities?.media?.map((media) => new TweetMedia(media));
 		this.quoted = tweet.legacy.quoted_status_id_str;
 		this.fullText = normalizeText(tweet.legacy.full_text);
 		this.replyTo = tweet.legacy.in_reply_to_status_id_str;
@@ -127,3 +89,93 @@ export class Tweet implements ITweet {
 		this.bookmarkCount = tweet.legacy.bookmark_count;
 	}
 }
+
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export 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) {
+		// Extracting user mentions
+		if (entities.user_mentions) {
+			for (const user of entities.user_mentions) {
+				this.mentionedUsers.push(user.screen_name);
+			}
+		}
+
+		// Extracting urls
+		if (entities.urls) {
+			for (const url of entities.urls) {
+				this.urls.push(url.expanded_url);
+			}
+		}
+
+		// Extracting hashtags
+		if (entities.hashtags) {
+			for (const hashtag of entities.hashtags) {
+				this.hashtags.push(hashtag.text);
+			}
+		}
+	}
+}
+
+/**
+ * A single media content.
+ *
+ * @public
+ */
+export 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) {
+		this.type = media.type;
+
+		// If the media is a photo
+		if (media.type == EMediaType.PHOTO) {
+			this.url = media.media_url_https;
+		}
+		// If the media is a gif
+		else if (media.type == EMediaType.GIF) {
+			this.url = media.video_info?.variants[0].url as string;
+		}
+		// If the media is a video
+		else {
+			/** The highest bitrate of all variants. */
+			let highestRate: number = 0;
+
+			/**
+			 * Selecting the URL of the video variant with the highest bitrate.
+			 */
+			media.video_info?.variants.forEach((variant) => {
+				if (variant.bitrate > highestRate) {
+					highestRate = variant.bitrate;
+					this.url = variant.url;
+				}
+			});
+		}
+	}
+}

package/src/models/User.ts

@@ -1,6 +1,8 @@
+// PACKAGES
+import { IUser as IRawUser } from 'rettiwt-core';
+
 // TYPES
 import { IUser } from '../types/User';
-import { IUser as IRawUser } from 'rettiwt-core';
 
 /**
  * The details of a single user.

package/src/services/FetcherService.ts

@@ -12,7 +12,9 @@ import {
 	EErrorCodes,
 } from 'rettiwt-core';
 import axios, { AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import https, { Agent } from 'https';
 import { AuthCredential } from 'rettiwt-auth';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // ENUMS
 import { EHttpStatus } from '../enums/HTTP';
@@ -35,11 +37,40 @@ export class FetcherService {
 	/** The credential to use for authenticating against Twitter API. */
 	private cred: AuthCredential;
 
+	/** The HTTPS Agent to use for requests to Twitter API. */
+	private readonly httpsAgent: Agent;
+
 	/**
-	 * @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) {
-		this.cred = cred;
+	constructor(apiKey: string, proxyUrl?: URL) {
+		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.
+	 */
+	private getAuthCredential(apiKey: string): AuthCredential {
+		return new 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.
+	 */
+	private getHttpsAgent(proxyUrl?: URL): Agent {
+		if (proxyUrl) {
+			return new HttpsProxyAgent(proxyUrl);
+		}
+
+		return new https.Agent();
 	}
 
 	/**
@@ -98,10 +129,11 @@ export class FetcherService {
 			method: config.type,
 			data: config.payload,
 			headers: JSON.parse(JSON.stringify(this.cred.toHeader())) as AxiosRequestHeaders,
+			httpsAgent: this.httpsAgent,
 		};
 
 		/**
-		 * 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 await axios<IResponse<unknown>>(axiosRequest)
 			.then((res) => this.handleHttpError(res))
@@ -133,7 +165,8 @@ export class FetcherService {
 		} else if (
 			type == EResourceType.TWEET_SEARCH ||
 			type == EResourceType.USER_LIKES ||
-			type == EResourceType.LIST_TWEETS
+			type == EResourceType.LIST_TWEETS ||
+			type == EResourceType.USER_TWEETS
 		) {
 			required = findByFilter<ITimelineTweet>(data, '__typename', 'TimelineTweet').map(
 				(item) => item.tweet_results.result,

package/src/services/TweetService.ts

@@ -1,6 +1,5 @@
 // PACKAGES
 import { EResourceType, TweetFilter } from 'rettiwt-core';
-import { AuthCredential } from 'rettiwt-auth';
 
 // SERVICES
 import { FetcherService } from './FetcherService';
@@ -17,12 +16,13 @@ import { CursoredData } from '../models/CursoredData';
  */
 export 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) {
-		super(cred);
+	constructor(apiKey: string, proxyUrl?: URL) {
+		super(apiKey, proxyUrl);
 	}
 
 	/**

package/src/services/UserService.ts

@@ -1,6 +1,5 @@
 // PACKAGES
 import { EResourceType } from 'rettiwt-core';
-import { AuthCredential } from 'rettiwt-auth';
 
 // SERVICES
 import { FetcherService } from './FetcherService';
@@ -19,12 +18,13 @@ import { CursoredData } from '../models/CursoredData';
  */
 export 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) {
-		super(cred);
+	constructor(apiKey: string, proxyUrl?: URL) {
+		super(apiKey, proxyUrl);
 	}
 
 	/**
@@ -39,7 +39,7 @@ export class UserService extends FetcherService {
 		let data: CursoredData<User>;
 
 		// If username is given
-		if (isNaN(parseFloat(id))) {
+		if (isNaN(Number(id))) {
 			// Fetching the requested data
 			data = await this.fetch<User>(EResourceType.USER_DETAILS, { id: id });
 		}
@@ -114,4 +114,27 @@ export class UserService extends FetcherService {
 
 		return data;
 	}
+
+	/**
+	 * 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
+	 */
+	async timeline(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		// Fetching the requested data
+		const data = await this.fetch<Tweet>(EResourceType.USER_TWEETS, {
+			id: userId,
+			count: count,
+			cursor: cursor,
+		});
+
+		return data;
+	}
 }