rettiwt-api 1.4.0 → 2.0.0

package/dist/services/FetcherService.js

@@ -0,0 +1,207 @@
+"use strict";
+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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetcherService = void 0;
+// PACKAGES
+var rettiwt_core_1 = require("rettiwt-core");
+var axios_1 = __importDefault(require("axios"));
+// ENUMS
+var HTTP_1 = require("../enums/HTTP");
+var ApiErrors_1 = require("../enums/ApiErrors");
+// MODELS
+var CursoredData_1 = require("../models/CursoredData");
+// HELPERS
+var JsonUtils_1 = require("../helper/JsonUtils");
+/**
+ * The base service that handles all HTTP requests.
+ *
+ * @internal
+ */
+var FetcherService = /** @class */ (function () {
+    /**
+     * @param cred - The credentials to use for authenticating against Twitter API.
+     */
+    function FetcherService(cred) {
+        this.cred = cred;
+    }
+    /**
+     * The middleware for handling any http error.
+     *
+     * @param res - The response object received.
+     * @returns The received response, if no HTTP errors are found.
+     */
+    FetcherService.prototype.handleHttpError = function (res) {
+        /**
+         * If the status code is not 200 =\> the HTTP request was not successful. hence throwing error
+         */
+        if (res.status != 200 && res.status in HTTP_1.EHttpStatus) {
+            throw new Error(HTTP_1.EHttpStatus[res.status]);
+        }
+        return res;
+    };
+    /**
+     * The middleware for handling any Twitter API-level errors.
+     *
+     * @param res - The response object received.
+     * @returns The received response, if no API errors are found.
+     */
+    FetcherService.prototype.handleApiError = function (res) {
+        // If error exists
+        if (res.data.errors && res.data.errors.length) {
+            // Getting the error code
+            var code = res.data.errors[0].code;
+            // Getting the error message
+            var message = ApiErrors_1.EApiErrors[(0, JsonUtils_1.findKeyByValue)(rettiwt_core_1.EErrorCodes, "".concat(code))];
+            // Throw the error
+            throw new Error(message);
+        }
+        return res;
+    };
+    /**
+     * Makes an HTTP request according to the given parameters.
+     *
+     * @param config - The request configuration.
+     * @returns The response received.
+     */
+    FetcherService.prototype.request = function (config) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axiosRequest;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        axiosRequest = {
+                            url: config.url,
+                            method: config.type,
+                            data: config.payload,
+                            headers: JSON.parse(JSON.stringify(this.cred.toHeader())),
+                        };
+                        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.
+                     */
+                    return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Extracts the required data based on the type of resource passed as argument.
+     *
+     * @param data - The data from which extraction is to be done.
+     * @param type - The type of data to extract.
+     * @typeParam BaseType - The base type of the raw data present in the input.
+     * @typeParam DeserializedType - The type of data produced after deserialization of BaseType.
+     * @returns The extracted data.
+     */
+    FetcherService.prototype.extractData = function (data, type) {
+        var _a;
+        /**
+         * The required extracted data.
+         */
+        var required = [];
+        // For 'Tweet' resources
+        if (type == rettiwt_core_1.EResourceType.TWEET_DETAILS ||
+            type == rettiwt_core_1.EResourceType.TWEET_SEARCH ||
+            type == rettiwt_core_1.EResourceType.USER_LIKES) {
+            required = (0, JsonUtils_1.findByFilter)(data, '__typename', 'Tweet');
+        }
+        // For 'User' resources
+        else {
+            required = (0, JsonUtils_1.findByFilter)(data, '__typename', 'User');
+        }
+        return new CursoredData_1.CursoredData(required, (_a = (0, JsonUtils_1.findByFilter)(data, 'cursorType', 'Bottom')[0]) === null || _a === void 0 ? void 0 : _a.value);
+    };
+    /**
+     * Fetches the requested resource from Twitter and returns it after processing.
+     *
+     * @param resourceType - The type of resource to fetch.
+     * @param args - Resource specific arguments.
+     * @typeParam OutType - The type of deserialized data returned.
+     * @returns The processed data requested from Twitter.
+     */
+    FetcherService.prototype.fetch = function (resourceType, args) {
+        return __awaiter(this, void 0, void 0, function () {
+            var request, res, data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        request = new rettiwt_core_1.Request(resourceType, args);
+                        return [4 /*yield*/, this.request(request).then(function (res) { return res.data; })];
+                    case 1:
+                        res = _a.sent();
+                        data = this.extractData(res, resourceType);
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * Posts the requested resource to Twitter and returns the response.
+     *
+     * @param resourceType - The type of resource to post.
+     * @param args - Resource specific arguments.
+     * @returns Whether posting was successful or not.
+     */
+    FetcherService.prototype.post = function (resourceType, args) {
+        return __awaiter(this, void 0, void 0, function () {
+            var request;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        request = new rettiwt_core_1.Request(resourceType, args);
+                        // Posting the data
+                        return [4 /*yield*/, this.request(request)];
+                    case 1:
+                        // Posting the data
+                        _a.sent();
+                        return [2 /*return*/, true];
+                }
+            });
+        });
+    };
+    return FetcherService;
+}());
+exports.FetcherService = FetcherService;
+//# sourceMappingURL=FetcherService.js.map

package/dist/services/FetcherService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetcherService.js","sourceRoot":"","sources":["../../src/services/FetcherService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CASsB;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,GAAe,EAAE,CAAC;QAE9B,wBAAwB;QACxB,IACC,IAAI,IAAI,4BAAa,CAAC,aAAa;YACnC,IAAI,IAAI,4BAAa,CAAC,YAAY;YAClC,IAAI,IAAI,4BAAa,CAAC,UAAU,EAC/B;YACD,QAAQ,GAAG,IAAA,wBAAY,EAAW,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;SAC/D;QACD,uBAAuB;aAClB;YACJ,QAAQ,GAAG,IAAA,wBAAY,EAAW,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;SAC9D;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,CAAgC,GAAG,EAAE,YAAY,CAAC,CAAC;wBAEhF,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,AAvJD,IAuJC;AAvJY,wCAAc"}

package/dist/services/TweetService.d.ts

@@ -0,0 +1,88 @@
+import { TweetFilter } from 'rettiwt-core';
+import { AuthCredential } from 'rettiwt-auth';
+import { FetcherService } from './FetcherService';
+import { Tweet } from '../models/Tweet';
+import { User } from '../models/User';
+import { CursoredData } from '../models/CursoredData';
+/**
+ * Handles fetching of data related to tweets.
+ *
+ * @public
+ */
+export declare class TweetService extends FetcherService {
+    /**
+     * @param cred - The credentials to use for authenticating against Twitter API.
+     *
+     * @internal
+     */
+    constructor(cred: AuthCredential);
+    /**
+     * Search for tweets using a query.
+     *
+     * @param query - The query be used for searching the tweets.
+     * @param count - The number of tweets to fetch, must be \<= 20.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The list of tweets that match the given filter.
+     *
+     * @public
+     */
+    search(query: TweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    /**
+     * 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>;
+    /**
+     * Get the list of users who liked a tweet.
+     *
+     * @param tweetId - The rest id of the target tweet.
+     * @param count - The number of favoriters to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of favoriters to fetch.
+     * @returns The list of users who liked the given tweet.
+     *
+     * @public
+     */
+    favoriters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the list of users who retweeted a tweet.
+     *
+     * @param tweetId - The rest id of the target tweet.
+     * @param count - The number of retweeters to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of retweeters to fetch.
+     * @returns The list of users who retweeted the given tweet.
+     *
+     * @public
+     */
+    retweeters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Post a tweet.
+     *
+     * @param tweetText - The text to be posted, length must be \<= 280 characters.
+     * @returns Whether posting was successful or not.
+     *
+     * @public
+     */
+    tweet(tweetText: string): Promise<boolean>;
+    /**
+     * Favorite the tweet with the given id.
+     *
+     * @param tweetId - The id of the tweet to be favorited.
+     * @returns Whether favoriting was successful or not.
+     *
+     * @public
+     */
+    favorite(tweetId: string): Promise<boolean>;
+    /**
+     * Retweet the tweet with the given id.
+     *
+     * @param tweetId - The id of the tweet with the given id.
+     * @returns Whether retweeting was successful or not.
+     *
+     * @public
+     */
+    retweet(tweetId: string): Promise<boolean>;
+}

package/dist/services/TweetService.js

@@ -0,0 +1,244 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TweetService = void 0;
+// PACKAGES
+var rettiwt_core_1 = require("rettiwt-core");
+// SERVICES
+var FetcherService_1 = require("./FetcherService");
+/**
+ * Handles fetching of data related to tweets.
+ *
+ * @public
+ */
+var TweetService = /** @class */ (function (_super) {
+    __extends(TweetService, _super);
+    /**
+     * @param cred - The credentials to use for authenticating against Twitter API.
+     *
+     * @internal
+     */
+    function TweetService(cred) {
+        return _super.call(this, cred) || this;
+    }
+    /**
+     * Search for tweets using a query.
+     *
+     * @param query - The query be used for searching the tweets.
+     * @param count - The number of tweets to fetch, must be \<= 20.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The list of tweets that match the given filter.
+     *
+     * @public
+     */
+    TweetService.prototype.search = function (query, 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_SEARCH, {
+                            filter: query,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        // 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];
+                }
+            });
+        });
+    };
+    /**
+     * 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]];
+                }
+            });
+        });
+    };
+    /**
+     * Get the list of users who liked a tweet.
+     *
+     * @param tweetId - The rest id of the target tweet.
+     * @param count - The number of favoriters to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of favoriters to fetch.
+     * @returns The list of users who liked the given tweet.
+     *
+     * @public
+     */
+    TweetService.prototype.favoriters = function (tweetId, 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_FAVORITERS, {
+                            id: tweetId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * Get the list of users who retweeted a tweet.
+     *
+     * @param tweetId - The rest id of the target tweet.
+     * @param count - The number of retweeters to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of retweeters to fetch.
+     * @returns The list of users who retweeted the given tweet.
+     *
+     * @public
+     */
+    TweetService.prototype.retweeters = function (tweetId, 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_RETWEETERS, {
+                            id: tweetId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * Post a tweet.
+     *
+     * @param tweetText - The text to be posted, length must be \<= 280 characters.
+     * @returns Whether posting was successful or not.
+     *
+     * @public
+     */
+    TweetService.prototype.tweet = function (tweetText) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.post(rettiwt_core_1.EResourceType.CREATE_TWEET, { tweetText: tweetText })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * Favorite the tweet with the given id.
+     *
+     * @param tweetId - The id of the tweet to be favorited.
+     * @returns Whether favoriting was successful or not.
+     *
+     * @public
+     */
+    TweetService.prototype.favorite = function (tweetId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.post(rettiwt_core_1.EResourceType.FAVORITE_TWEET, { id: tweetId })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * Retweet the tweet with the given id.
+     *
+     * @param tweetId - The id of the tweet with the given id.
+     * @returns Whether retweeting was successful or not.
+     *
+     * @public
+     */
+    TweetService.prototype.retweet = function (tweetId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.post(rettiwt_core_1.EResourceType.CREATE_RETWEET, { id: tweetId })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    return TweetService;
+}(FetcherService_1.FetcherService));
+exports.TweetService = TweetService;
+//# sourceMappingURL=TweetService.js.map

package/dist/services/TweetService.js.map

@@ -0,0 +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"}

package/dist/services/UserService.d.ts

@@ -0,0 +1,60 @@
+import { AuthCredential } from 'rettiwt-auth';
+import { FetcherService } from './FetcherService';
+import { User } from '../models/User';
+import { Tweet } from '../models/Tweet';
+import { CursoredData } from '../models/CursoredData';
+/**
+ * Handles fetching of data related to user account
+ *
+ * @public
+ */
+export declare class UserService extends FetcherService {
+    /**
+     * @param cred - The credentials to use for authenticating against Twitter API.
+     *
+     * @internal
+     */
+    constructor(cred: AuthCredential);
+    /**
+     * Get the details of a user.
+     *
+     * @param id - The username/id of the target user.
+     * @returns The details of the given user.
+     *
+     * @public
+     */
+    details(id: string): Promise<User>;
+    /**
+     * Get the list of users who are followed by the given user.
+     *
+     * @param userId - The rest id of the target user.
+     * @param count - The number of following to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of following to fetch.
+     * @returns The list of users followed by the target user.
+     *
+     * @public
+     */
+    following(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the list followers of a given user.
+     *
+     * @param userId - The rest id of the target user.
+     * @param count - The number of followers to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of followers to fetch.
+     * @returns The list of users following the target user.
+     *
+     * @public
+     */
+    followers(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the list of tweets liked by the given user.
+     *
+     * @param userId - The rest id of the target user.
+     * @param count - The number of likes to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of likes to fetch.
+     * @returns The list of tweets liked by the target user.
+     *
+     * @public
+     */
+    likes(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+}