rettiwt-api 1.1.2 → 1.1.7

package/dist/services/helper/payloads/LoginFlows.d.ts

@@ -0,0 +1,77 @@
+declare const LoginFlows: {
+    InitiateLogin: {
+        url: string;
+    };
+    JsInstrumentationSubtask: {
+        url: string;
+        body: (flowToken: string) => {
+            flow_token: string;
+            subtask_inputs: {
+                subtask_id: string;
+                js_instrumentation: {
+                    response: string;
+                    link: string;
+                };
+            }[];
+        };
+    };
+    EnterUserIdentifier: {
+        url: string;
+        body: (flowToken: string, email: string) => {
+            flow_token: string;
+            subtask_inputs: {
+                subtask_id: string;
+                settings_list: {
+                    setting_responses: {
+                        key: string;
+                        response_data: {
+                            text_data: {
+                                result: string;
+                            };
+                        };
+                    }[];
+                    link: string;
+                };
+            }[];
+        };
+    };
+    EnterAlternateUserIdentifier: {
+        url: string;
+        body: (flowToken: string, userName: string) => {
+            flow_token: string;
+            subtask_inputs: {
+                subtask_id: string;
+                enter_text: {
+                    text: string;
+                    link: string;
+                };
+            }[];
+        };
+    };
+    EnterPassword: {
+        url: string;
+        body: (flowToken: string, password: string) => {
+            flow_token: string;
+            subtask_inputs: {
+                subtask_id: string;
+                enter_password: {
+                    password: string;
+                    link: string;
+                };
+            }[];
+        };
+    };
+    AccountDuplicationCheck: {
+        url: string;
+        body: (flowToken: string) => {
+            flow_token: string;
+            subtask_inputs: {
+                subtask_id: string;
+                check_logged_in_account: {
+                    link: string;
+                };
+            }[];
+        };
+    };
+};
+export default LoginFlows;

package/dist/services/helper/payloads/LoginFlows.js

@@ -0,0 +1,92 @@
+"use strict";
+exports.__esModule = true;
+var LoginFlows = {
+    "InitiateLogin": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json?flow_name=login'
+    },
+    "JsInstrumentationSubtask": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json',
+        body: function (flowToken) { return ({
+            "flow_token": flowToken,
+            "subtask_inputs": [
+                {
+                    "subtask_id": "LoginJsInstrumentationSubtask",
+                    "js_instrumentation": {
+                        "response": "{\"rf\":{\"a09453c7341fb1cbb7d51561f92d478fa0752bc77e7ca6b5703258680b2c51d7\":-4,\"bd26c6694e256b10766447d992deaf92bb220bc05e3b8205ba5c9a4f83302230\":0,\"abfa440376b8dc33ca518e1e2a998b3ac4200a8122ef09781eea2c1408717111\":-1,\"a4e87b66027f638a4634561275fab00f9f7446b81a180b5f03eda69fa32eb8f4\":-224},\"s\":\"yET9nlXrlGRAylCyyBKEsxOpUweMpjRz5RfKzTzQyVADnKE64gmpyILfKBK0-HIHWY8FbJPHGWr6QrCb5A-Z3q2SLRm4DReprZGXykJ111_ynet8kSjFkRjODKKDN2FzT1V6rx9FILnUuRCaMu9ewfPgPBi4wO1g7EUeEsSSHIiCwNc9URJr4c2xVTA3ibIfTbu8p2WhX7RZAk8LWRPpPPB21st8Z1j0LcLlR0bkZoF6LsN-7w75lGB0s4z1JKqus2MVuRcPMay0wWZbn8Qx9In_-tSTvEBLcxjUpDgwu29G0g0iCWoISFzLY4-LLvV7UBGklkByIcPtwYbDbREqRQAAAYYmXAsG\"}",
+                        "link": "next_link"
+                    }
+                }
+            ]
+        }); }
+    },
+    "EnterUserIdentifier": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json',
+        body: function (flowToken, email) { return ({
+            "flow_token": flowToken,
+            "subtask_inputs": [
+                {
+                    "subtask_id": "LoginEnterUserIdentifierSSO",
+                    "settings_list": {
+                        "setting_responses": [
+                            {
+                                "key": "user_identifier",
+                                "response_data": {
+                                    "text_data": {
+                                        "result": email
+                                    }
+                                }
+                            }
+                        ],
+                        "link": "next_link"
+                    }
+                }
+            ]
+        }); }
+    },
+    "EnterAlternateUserIdentifier": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json',
+        body: function (flowToken, userName) { return ({
+            "flow_token": flowToken,
+            "subtask_inputs": [
+                {
+                    "subtask_id": "LoginEnterAlternateIdentifierSubtask",
+                    "enter_text": {
+                        "text": userName,
+                        "link": "next_link"
+                    }
+                }
+            ]
+        }); }
+    },
+    "EnterPassword": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json',
+        body: function (flowToken, password) { return ({
+            "flow_token": flowToken,
+            "subtask_inputs": [
+                {
+                    "subtask_id": "LoginEnterPassword",
+                    "enter_password": {
+                        "password": password,
+                        "link": "next_link"
+                    }
+                }
+            ]
+        }); }
+    },
+    "AccountDuplicationCheck": {
+        url: 'https://api.twitter.com/1.1/onboarding/task.json',
+        body: function (flowToken) { return ({
+            "flow_token": flowToken,
+            "subtask_inputs": [
+                {
+                    "subtask_id": "AccountDuplicationCheck",
+                    "check_logged_in_account": {
+                        "link": "AccountDuplicationCheck_false"
+                    }
+                }
+            ]
+        }); }
+    }
+};
+exports["default"] = LoginFlows;
+//# sourceMappingURL=LoginFlows.js.map

package/dist/services/helper/payloads/LoginFlows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoginFlows.js","sourceRoot":"","sources":["../../../../src/services/helper/payloads/LoginFlows.ts"],"names":[],"mappings":";;AAAA,IAAM,UAAU,GAAG;IACf,eAAe,EAAE;QACb,GAAG,EAAE,kEAAkE;KAC1E;IACD,0BAA0B,EAAE;QACxB,GAAG,EAAE,kDAAkD;QACvD,IAAI,EAAE,UAAC,SAAiB,IAAK,OAAA,CAAC;YAC1B,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE;gBACd;oBACI,YAAY,EAAE,+BAA+B;oBAC7C,oBAAoB,EAAE;wBAClB,UAAU,EAAE,wpBAAwpB;wBACpqB,MAAM,EAAE,WAAW;qBACtB;iBACJ;aACJ;SACJ,CAAC,EAX2B,CAW3B;KACL;IACD,qBAAqB,EAAE;QACnB,GAAG,EAAE,kDAAkD;QACvD,IAAI,EAAE,UAAC,SAAiB,EAAE,KAAa,IAAK,OAAA,CAAC;YACzC,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE;gBACd;oBACI,YAAY,EAAE,6BAA6B;oBAC3C,eAAe,EAAE;wBACb,mBAAmB,EAAE;4BACjB;gCACI,KAAK,EAAE,iBAAiB;gCACxB,eAAe,EAAE;oCACb,WAAW,EAAE;wCACT,QAAQ,EAAE,KAAK;qCAClB;iCACJ;6BACJ;yBACJ;wBACD,MAAM,EAAE,WAAW;qBACtB;iBACJ;aACJ;SACJ,CAAC,EApB0C,CAoB1C;KACL;IACD,8BAA8B,EAAE;QAC5B,GAAG,EAAE,kDAAkD;QACvD,IAAI,EAAE,UAAC,SAAiB,EAAE,QAAgB,IAAK,OAAA,CAAC;YAC5C,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE;gBACd;oBACI,YAAY,EAAE,sCAAsC;oBACpD,YAAY,EAAE;wBACV,MAAM,EAAE,QAAQ;wBAChB,MAAM,EAAE,WAAW;qBACtB;iBACJ;aACJ;SACJ,CAAC,EAX6C,CAW7C;KACL;IACD,eAAe,EAAE;QACb,GAAG,EAAE,kDAAkD;QACvD,IAAI,EAAE,UAAC,SAAiB,EAAE,QAAgB,IAAK,OAAA,CAAC;YAC5C,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE;gBACd;oBACI,YAAY,EAAE,oBAAoB;oBAClC,gBAAgB,EAAE;wBACd,UAAU,EAAE,QAAQ;wBACpB,MAAM,EAAE,WAAW;qBACtB;iBACJ;aACJ;SACJ,CAAC,EAX6C,CAW7C;KACL;IACD,yBAAyB,EAAE;QACvB,GAAG,EAAE,kDAAkD;QACvD,IAAI,EAAE,UAAC,SAAiB,IAAK,OAAA,CAAC;YAC1B,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE;gBACd;oBACI,YAAY,EAAE,yBAAyB;oBACvC,yBAAyB,EAAE;wBACvB,MAAM,EAAE,+BAA+B;qBAC1C;iBACJ;aACJ;SACJ,CAAC,EAV2B,CAU3B;KACL;CACJ,CAAA;AAED,qBAAe,UAAU,CAAC"}

package/dist/services/helper/urls/Users.d.ts

@@ -9,7 +9,14 @@ export declare function userDetailsUrl(screenName: string): string;
  */
 export declare function userDetailsByIdUrl(restId: string): string;
 /**
- * @returns The url for fetching the list of users followed bu target user.
+ * @returns The url for fetching the list of tweet made by target user.
+ * @param userId The rest id of the target user
+ * @param count The batch size of the list of tweets, should be >= 40 and <=100
+ * @param cursor The cursor to next batch
+ */
+export declare function userTweetsUrl(userId: string, count: number, cursor: string): string;
+/**
+ * @returns The url for fetching the list of users followed by target user.
  * @param userId The rest id of the target user
  * @param count The batch size of the list of following, should be >= 40 and <=100
  * @param cursor The cursor to next batch

package/dist/services/helper/urls/Users.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.userLikesUrl = exports.userFollowersUrl = exports.userFollowingUrl = exports.userDetailsByIdUrl = exports.userDetailsUrl = void 0;
+exports.userLikesUrl = exports.userFollowersUrl = exports.userFollowingUrl = exports.userTweetsUrl = exports.userDetailsByIdUrl = exports.userDetailsUrl = void 0;
 /**
  * @returns The url for fetching user account details.
  * @param screenName The screen name of the target user
@@ -18,7 +18,17 @@ function userDetailsByIdUrl(restId) {
 }
 exports.userDetailsByIdUrl = userDetailsByIdUrl;
 /**
- * @returns The url for fetching the list of users followed bu target user.
+ * @returns The url for fetching the list of tweet made by target user.
+ * @param userId The rest id of the target user
+ * @param count The batch size of the list of tweets, should be >= 40 and <=100
+ * @param cursor The cursor to next batch
+ */
+function userTweetsUrl(userId, count, cursor) {
+    return "https://api.twitter.com/graphql/xxLjoOBBPpYBHbBTI-hevQ/UserTweetsAndReplies?variables=%7B%22userId%22%3A%22".concat(userId, "%22%2C%22count%22%3A").concat(count, "%2C%22cursor%22%3A%22").concat(cursor, "%22%2C%22includePromotedContent%22%3Atrue%2C%22withCommunity%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%2C%22withVoice%22%3Atrue%2C%22withV2Timeline%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D");
+}
+exports.userTweetsUrl = userTweetsUrl;
+/**
+ * @returns The url for fetching the list of users followed by target user.
  * @param userId The rest id of the target user
  * @param count The batch size of the list of following, should be >= 40 and <=100
  * @param cursor The cursor to next batch

package/dist/services/helper/urls/Users.js.map

@@ -1 +1 @@
-{"version":3,"file":"Users.js","sourceRoot":"","sources":["../../../../src/services/helper/urls/Users.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAC7C,OAAO,sHAA+G,UAAU,6RAA0R,CAAA;AAC9Z,CAAC;AAFD,wCAEC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC7C,OAAO,6GAAsG,MAAM,6RAA0R,CAAC;AAClZ,CAAC;AAFD,gDAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IAC1E;;;;;OAKG;IACH,OAAO,0GAAmG,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CAAC,MAAM,CAAC,2nCAAwnC,CAAC;AAC3zC,CAAC;AARD,4CAQC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IAC1E;;;;;OAKG;IACH,2BAA2B;IAC3B,IAAI,CAAC,MAAM,EAAE;QACT,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC;KACtB;IAED,OAAO,0GAAmG,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CAAC,MAAM,CAAC,2nCAAwnC,CAAC;AAC3zC,CAAC;AAbD,4CAaC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IACtE,OAAO,sGAA+F,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CAAC,MAAM,CAAC,0vCAAuvC,CAAC;AACt7C,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"Users.js","sourceRoot":"","sources":["../../../../src/services/helper/urls/Users.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAChD,OAAO,sHAA+G,UAAU,6RAA0R,CAAC;AAC5Z,CAAC;AAFD,wCAEC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAChD,OAAO,6GAAsG,MAAM,6RAA0R,CAAC;AAC/Y,CAAC;AAFD,gDAEC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IAC1E,OAAO,qHAA8G,MAAM,iCAAuB,KAAK,kCAAwB,MAAM,iqCAA8pC,CAAC;AACr1C,CAAC;AAFD,sCAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IAC7E;;;;;OAKG;IACH,OAAO,0GAAmG,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CACrL,MAAM,CACN,2nCAAwnC,CAAC;AAC3nC,CAAC;AAVD,4CAUC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IAC7E;;;;;OAKG;IACH,2BAA2B;IAC3B,IAAI,CAAC,MAAM,EAAE;QACZ,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC;KACnB;IAED,OAAO,0GAAmG,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CACrL,MAAM,CACN,2nCAAwnC,CAAC;AAC3nC,CAAC;AAfD,4CAeC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,MAAc,EAAE,KAAa,EAAE,MAAc;IACzE,OAAO,sGAA+F,MAAM,iCAAuB,KAAK,kCAAwB,kBAAkB,CACjL,MAAM,CACN,0vCAAuvC,CAAC;AAC1vC,CAAC;AAJD,oCAIC"}

package/dist/services/util/CacheService.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Handles reading and writing of data from and to cache.
+ *
+ * This services uses a local node-cache instance to cache data, since the data to be cached has no real purpose outside of the server session.
+ * This serivce follows a singleton pattern, where at any point, only a single instance of this class exists.
+ * This is done so that all the data is cached in a single instance, which makes sharing of cached data between different endpoints possible.
+ * @internal
+ */
+export declare class CacheService {
+    private static instance;
+    private client;
+    private constructor();
+    /**
+     * @returns The current working instance of CacheService
+     */
+    static getInstance(): CacheService;
+    /**
+     * Stores the input data in the cache.
+     *
+     * @param data The input data to store.
+     *
+     * @returns Whether writing to cache was successful or not.
+     *
+     * @remarks In order to cache data, the data to be cached must have a unique 'id' field.
+     */
+    write(data: any): void;
+    /**
+     * @param id The id id of the data to be fetched from cache.
+     *
+     * @returns The data with the given id.
+     */
+    read(id: string): any;
+}

package/dist/services/util/CacheService.js

@@ -0,0 +1,96 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.CacheService = void 0;
+// PACKAGES
+var node_cache_1 = __importDefault(require("node-cache"));
+// PARSERS
+var Parsers = __importStar(require("../helper/Parser"));
+/**
+ * Handles reading and writing of data from and to cache.
+ *
+ * This services uses a local node-cache instance to cache data, since the data to be cached has no real purpose outside of the server session.
+ * This serivce follows a singleton pattern, where at any point, only a single instance of this class exists.
+ * This is done so that all the data is cached in a single instance, which makes sharing of cached data between different endpoints possible.
+ * @internal
+ */
+var CacheService = /** @class */ (function () {
+    // MEMBER METHODS
+    function CacheService() {
+        // Initializing new cache
+        this.client = new node_cache_1["default"]();
+    }
+    /**
+     * @returns The current working instance of CacheService
+     */
+    CacheService.getInstance = function () {
+        // If an instance doesnt exists already
+        if (!this.instance) {
+            this.instance = new CacheService();
+        }
+        // Returning the current instance
+        return this.instance;
+    };
+    /**
+     * Stores the input data in the cache.
+     *
+     * @param data The input data to store.
+     *
+     * @returns Whether writing to cache was successful or not.
+     *
+     * @remarks In order to cache data, the data to be cached must have a unique 'id' field.
+     */
+    CacheService.prototype.write = function (data) {
+        // Converting the data to a list of data
+        data = Parsers.dataToList(data);
+        // Iterating over the list of data
+        for (var _i = 0, data_1 = data; _i < data_1.length; _i++) {
+            var item = data_1[_i];
+            // Storing whether data is already cached or not
+            var cached = this.client.has(Parsers.findJSONKey(item, 'id'));
+            // If data does not already exist in cache
+            if (!cached) {
+                // Adding data to cache
+                this.client.set(Parsers.findJSONKey(item, 'id'), item);
+            }
+        }
+    };
+    /**
+     * @param id The id id of the data to be fetched from cache.
+     *
+     * @returns The data with the given id.
+     */
+    CacheService.prototype.read = function (id) {
+        // Getting data from cache
+        var res = this.client.get(id);
+        return res;
+    };
+    return CacheService;
+}());
+exports.CacheService = CacheService;
+//# sourceMappingURL=CacheService.js.map

package/dist/services/util/CacheService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheService.js","sourceRoot":"","sources":["../../../src/services/util/CacheService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,0DAAmC;AAEnC,UAAU;AACV,wDAA4C;AAE5C;;;;;;;GAOG;AACH;IAKI,iBAAiB;IACjB;QACI,yBAAyB;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAS,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,wBAAW,GAAlB;QACI,uCAAuC;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;SACtC;QAED,iCAAiC;QACjC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACI,4BAAK,GAAZ,UAAa,IAAS;QAClB,wCAAwC;QACxC,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEhC,kCAAkC;QAClC,KAAiB,UAAI,EAAJ,aAAI,EAAJ,kBAAI,EAAJ,IAAI,EAAE;YAAlB,IAAI,IAAI,aAAA;YACT,gDAAgD;YAChD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAE9D,0CAA0C;YAC1C,IAAG,CAAC,MAAM,EAAE;gBACR,uBAAuB;gBACvB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;aAC1D;SACJ;IACL,CAAC;IAED;;;;OAIG;IACI,2BAAI,GAAX,UAAY,EAAU;QAClB,0BAA0B;QAC1B,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE9B,OAAO,GAAG,CAAC;IACf,CAAC;IACL,mBAAC;AAAD,CAAC,AA7DD,IA6DC;AA7DY,oCAAY"}

package/dist/services/util/FetcherService.d.ts

@@ -0,0 +1,65 @@
+import { CurlyResult } from 'node-libcurl';
+import { AuthService } from '../auth/AuthService';
+/**
+ * The different types of http requests.
+ */
+export declare enum HttpMethods {
+    POST = "POST",
+    GET = "GET"
+}
+/**
+ * Handles all HTTP requests.
+ * @internal
+ *
+ * This serves as the base service from which all other data services derive their behaviour.
+ */
+export declare class FetcherService {
+    /** The authentication service instance. */
+    private auth;
+    /** The caching service instance. */
+    private cache;
+    /** Whether instance has been authenticated or not. */
+    protected isAuthenticated: boolean;
+    /**
+     * @param auth The AuthService instance to use for authentication.
+     */
+    constructor(auth: AuthService);
+    /**
+    * The middleware for handling any HTTP error.
+    *
+    * @param res The response object received.
+    *
+    * @returns The received response, if no HTTP errors are found.
+    *
+    * @throws {@link HttpStatus} error, if any HTTP error is found.
+    */
+    private handleHTTPError;
+    /**
+     * Creates an HTTP request according to the given parameters.
+     *
+     * This method internally uses node-libcurl library to make curl requests to the URL, instead of node-fetch.
+     * This has been done since that way it better mimics the HTTP requests made from browser.
+     *
+     * @param url The url to fetch data from.
+     * @param authenticate Whether to authenticate requests or not.
+     * @param method The HTTP method (from {@link HttpMethods}) to use.
+     * @param data The data to be sent along with the request (for POST request).
+     *
+     * @returns The {@link CurlyResult} received.
+     */
+    protected request<DataType>(url: string, authenticate?: boolean, method?: HttpMethods, data?: any): Promise<CurlyResult<DataType>>;
+    /**
+     * Caches the extracted data into the {@link CacheService} instance.
+     *
+     * @param data The extracted data to be cached.
+     */
+    protected cacheData(data: any): void;
+    /**
+     * Fetches the data with the given id from the cache.
+     *
+     * @param id The id of the data to be read from cache.
+     *
+     * @returns The data with the given id. If does not exists, returns undefined.
+     */
+    protected readData(id: string): any;
+}

package/dist/services/util/FetcherService.js

@@ -0,0 +1,214 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.FetcherService = exports.HttpMethods = void 0;
+// PACKAGES
+var node_libcurl_1 = require("node-libcurl");
+var CacheService_1 = require("./CacheService");
+// MODELS
+var Tweet_1 = require("../../models/data/Tweet");
+var User_1 = require("../../models/data/User");
+// ENUMS
+var HTTP_1 = require("../../enums/HTTP");
+// HELPERS
+var Headers = __importStar(require("../helper/Headers"));
+/**
+ * The different types of http requests.
+ */
+var HttpMethods;
+(function (HttpMethods) {
+    HttpMethods["POST"] = "POST";
+    HttpMethods["GET"] = "GET";
+})(HttpMethods = exports.HttpMethods || (exports.HttpMethods = {}));
+;
+/**
+ * Handles all HTTP requests.
+ * @internal
+ *
+ * This serves as the base service from which all other data services derive their behaviour.
+ */
+var FetcherService = /** @class */ (function () {
+    // MEMBER METHODS
+    /**
+     * @param auth The AuthService instance to use for authentication.
+     */
+    function FetcherService(auth) {
+        this.auth = auth;
+        this.cache = CacheService_1.CacheService.getInstance();
+        this.isAuthenticated = this.auth.isAuthenticated;
+    }
+    /**
+    * The middleware for handling any HTTP error.
+    *
+    * @param res The response object received.
+    *
+    * @returns The received response, if no HTTP errors are found.
+    *
+    * @throws {@link HttpStatus} error, if any HTTP error is found.
+    */
+    FetcherService.prototype.handleHTTPError = function (res) {
+        /**
+         * If the status code is not 200 => the HTTP request was not successful. hence throwing error
+         */
+        if (res.statusCode != 200 && res.statusCode in HTTP_1.HttpStatus) {
+            throw new Error(HTTP_1.HttpStatus[res.statusCode]);
+        }
+        return res;
+    };
+    /**
+     * Creates an HTTP request according to the given parameters.
+     *
+     * This method internally uses node-libcurl library to make curl requests to the URL, instead of node-fetch.
+     * This has been done since that way it better mimics the HTTP requests made from browser.
+     *
+     * @param url The url to fetch data from.
+     * @param authenticate Whether to authenticate requests or not.
+     * @param method The HTTP method (from {@link HttpMethods}) to use.
+     * @param data The data to be sent along with the request (for POST request).
+     *
+     * @returns The {@link CurlyResult} received.
+     */
+    FetcherService.prototype.request = function (url, authenticate, method, data) {
+        if (authenticate === void 0) { authenticate = true; }
+        if (method === void 0) { method = HttpMethods.GET; }
+        return __awaiter(this, void 0, void 0, function () {
+            var config, _a, _b, _c, _d, _e;
+            var _f;
+            var _this = this;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        _f = {};
+                        if (!authenticate) return [3 /*break*/, 2];
+                        _c = (_b = Headers).authorizedHeader;
+                        return [4 /*yield*/, this.auth.getAuthCredentials()];
+                    case 1:
+                        _a = _c.apply(_b, [_g.sent()]);
+                        return [3 /*break*/, 4];
+                    case 2:
+                        _e = (_d = Headers).guestHeader;
+                        return [4 /*yield*/, this.auth.getGuestCredentials()];
+                    case 3:
+                        _a = _e.apply(_d, [_g.sent()]);
+                        _g.label = 4;
+                    case 4:
+                        config = (
+                        /**
+                         * If authorization is required, using the authenticated header, using the authentication credentiials.
+                         * Else, using the guest header, using the guest credentials.
+                         */
+                        _f.httpHeader = _a,
+                            /**
+                             * Disabling SSL peer verification because verification causes Error 404 (only while fetching tweets), likely because peer verification fails.
+                             */
+                            _f.sslVerifyPeer = false,
+                            _f);
+                        if (!(method == HttpMethods.POST)) return [3 /*break*/, 6];
+                        return [4 /*yield*/, node_libcurl_1.curly.post(url, __assign(__assign({}, config), { postFields: JSON.stringify(data) })).then(function (res) { return _this.handleHTTPError(res); })];
+                    case 5: return [2 /*return*/, _g.sent()];
+                    case 6: return [4 /*yield*/, node_libcurl_1.curly.get(url, config).then(function (res) { return _this.handleHTTPError(res); })];
+                    case 7: return [2 /*return*/, _g.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Caches the extracted data into the {@link CacheService} instance.
+     *
+     * @param data The extracted data to be cached.
+     */
+    FetcherService.prototype.cacheData = function (data) {
+        /**
+         * The extracted data is in raw form.
+         * This raw data is deserialized into the respective known types.
+         */
+        var users = data.users.map(function (user) { return new User_1.User(user); });
+        var tweets = data.tweets.map(function (tweet) { return new Tweet_1.Tweet(tweet); });
+        // Caching the data
+        this.cache.write(users);
+        this.cache.write(tweets);
+    };
+    /**
+     * Fetches the data with the given id from the cache.
+     *
+     * @param id The id of the data to be read from cache.
+     *
+     * @returns The data with the given id. If does not exists, returns undefined.
+     */
+    FetcherService.prototype.readData = function (id) {
+        // Reading data from cache
+        return this.cache.read(id);
+    };
+    return FetcherService;
+}());
+exports.FetcherService = FetcherService;
+//# sourceMappingURL=FetcherService.js.map

package/dist/services/util/FetcherService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetcherService.js","sourceRoot":"","sources":["../../../src/services/util/FetcherService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAAkD;AAIlD,+CAA8C;AAE9C,SAAS;AACT,iDAAgD;AAChD,+CAA8C;AAM9C,QAAQ;AACR,yCAA8C;AAE9C,UAAU;AACV,yDAA4C;AAG5C;;GAEG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACnB,4BAAa,CAAA;IACb,0BAAW,CAAA;AACf,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAAA,CAAC;AAEF;;;;;GAKG;AACH;IAWI,iBAAiB;IACjB;;OAEG;IACH,wBAAY,IAAiB;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,2BAAY,CAAC,WAAW,EAAE,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;IACrD,CAAC;IAED;;;;;;;;MAQE;IACM,wCAAe,GAAvB,UAAwB,GAAgB;QACpC;;WAEG;QACH,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,IAAI,iBAAU,EAAE;YACvD,MAAM,IAAI,KAAK,CAAC,iBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;SAC9C;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;OAYG;IACa,gCAAO,GAAvB,UAAkC,GAAW,EAAE,YAA4B,EAAE,MAAqC,EAAE,IAAU;QAA/E,6BAAA,EAAA,mBAA4B;QAAE,uBAAA,EAAA,SAAsB,WAAW,CAAC,GAAG;;;;;;;;;6BAS9F,YAAY,EAAZ,wBAAY;wBAAG,KAAA,CAAA,KAAA,OAAO,CAAA,CAAC,gBAAgB,CAAA;wBAAC,qBAAM,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAA;;wBAA7D,KAAA,cAAyB,SAAoC,EAAC,CAAA;;;wBAAG,KAAA,CAAA,KAAA,OAAO,CAAA,CAAC,WAAW,CAAA;wBAAC,qBAAM,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAA;;wBAAzD,KAAA,cAAoB,SAAqC,EAAC,CAAA;;;wBALtJ,MAAM;wBACN;;;2BAGG;wBACH,aAAU,KAA4I;4BACtJ;;+BAEG;4BACH,gBAAa,GAAE,KAAK;+BACvB;6BAOG,CAAA,MAAM,IAAI,WAAW,CAAC,IAAI,CAAA,EAA1B,wBAA0B;wBACnB,qBAAM,oBAAK,CAAC,IAAI,CAAC,GAAG,wBAAO,MAAM,KAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAG,CAAC,IAAI,CAAC,UAAA,GAAG,IAAI,OAAA,KAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAzB,CAAyB,CAAC,EAAA;4BAApH,sBAAO,SAA6G,EAAC;4BAI9G,qBAAM,oBAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,UAAA,GAAG,IAAI,OAAA,KAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAzB,CAAyB,CAAC,EAAA;4BAA1E,sBAAO,SAAmE,EAAC;;;;KAElF;IAED;;;;OAIG;IACO,kCAAS,GAAnB,UAAoB,IAAS;QACzB;;;WAGG;QACH,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAC,IAAa,IAAK,OAAA,IAAI,WAAI,CAAC,IAAI,CAAC,EAAd,CAAc,CAAC,CAAC;QAC9D,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAC,KAAe,IAAK,OAAA,IAAI,aAAK,CAAC,KAAK,CAAC,EAAhB,CAAgB,CAAC,CAAC;QAEpE,mBAAmB;QACnB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACO,iCAAQ,GAAlB,UAAmB,EAAU;QACzB,0BAA0B;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IACL,qBAAC;AAAD,CAAC,AAjHD,IAiHC;AAjHY,wCAAc"}