rettiwt-api 1.4.0 → 2.0.0

package/dist/services/UserService.js

@@ -0,0 +1,188 @@
+"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.UserService = void 0;
+// PACKAGES
+var rettiwt_core_1 = require("rettiwt-core");
+// SERVICES
+var FetcherService_1 = require("./FetcherService");
+/**
+ * Handles fetching of data related to user account
+ *
+ * @public
+ */
+var UserService = /** @class */ (function (_super) {
+    __extends(UserService, _super);
+    /**
+     * @param cred - The credentials to use for authenticating against Twitter API.
+     *
+     * @internal
+     */
+    function UserService(cred) {
+        return _super.call(this, cred) || this;
+    }
+    /**
+     * Get the details of a user.
+     *
+     * @param id - The username/id of the target user.
+     * @returns The details of the given user.
+     *
+     * @public
+     */
+    UserService.prototype.details = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!isNaN(parseFloat(id))) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.USER_DETAILS, { id: id })];
+                    case 1:
+                        // Fetching the requested data
+                        data = _a.sent();
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, this.fetch(rettiwt_core_1.EResourceType.USER_DETAILS_BY_ID, { id: id })];
+                    case 3:
+                        // Fetching the requested data
+                        data = _a.sent();
+                        _a.label = 4;
+                    case 4: return [2 /*return*/, data.list[0]];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    UserService.prototype.following = 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_FOLLOWING, {
+                            id: userId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    UserService.prototype.followers = 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_FOLLOWERS, {
+                            id: userId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    UserService.prototype.likes = 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_LIKES, {
+                            id: userId,
+                            count: count,
+                            cursor: cursor,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    return UserService;
+}(FetcherService_1.FetcherService));
+exports.UserService = UserService;
+//# sourceMappingURL=UserService.js.map

package/dist/services/UserService.js.map

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

package/dist/types/{Service.d.ts → CursoredData.d.ts}

@@ -10,13 +10,13 @@ export interface ICursor {
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
- * @typeParam Type - The type of data present in the list.
+ * @typeParam T - Type of data present in the list.
  *
  * @public
  */
-export interface ICursoredData<Type> {
+export interface ICursoredData<T> {
     /** The list of data of the given type. */
-    list: Type[];
+    list: T[];
     /** The cursor to the next batch of data. */
     next: ICursor;
 }

package/dist/types/CursoredData.js

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

package/dist/types/CursoredData.js.map

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

package/dist/types/Tweet.js

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

package/dist/types/User.js

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

package/package.json

@@ -1,13 +1,15 @@
 {
 	"name": "rettiwt-api",
-	"version": "1.4.0",
+	"version": "2.0.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",
 	"scripts": {
 		"build": "tsc",
-		"start": "node ./dist/server.js",
-		"debug": "nodemon ./dist/server.js --inspect=0.0.0.0:9229"
+		"format": "prettier --write .",
+		"lint": "eslint --max-warnings 0 .",
+		"docs": "typedoc src/index.ts",
+		"debug": "nodemon ./dist/index.js --inspect=0.0.0.0:9229"
 	},
 	"repository": {
 		"type": "git",
@@ -24,24 +26,18 @@
 	"homepage": "https://rishikant181.github.io/Rettiwt-API/",
 	"dependencies": {
 		"axios": "1.3.2",
-		"class-transformer": "0.5.1",
-		"class-validator": "0.14.0",
-		"cookiejar": "2.1.4",
-		"express": "4.18.2",
-		"express-graphql": "0.12.0",
-		"graphql": "14.7.0",
-		"node-cache": "5.1.2",
-		"node-libcurl": "3.0.0",
-		"reflect-metadata": "0.1.13",
-		"rettiwt-core": "2.4.0"
+		"rettiwt-auth": "1.2.0",
+		"rettiwt-core": "3.0.0"
 	},
 	"devDependencies": {
-		"@types/cookiejar": "2.1.2",
-		"@types/express": "4.17.13",
-		"@types/graphql": "14.5.0",
-		"@types/node": "17.0.24",
+		"@types/node": "20.4.1",
+		"@typescript-eslint/eslint-plugin": "6.0.0",
+		"@typescript-eslint/parser": "6.0.0",
+		"eslint": "8.44.0",
+		"eslint-plugin-tsdoc": "0.2.17",
 		"nodemon": "2.0.20",
-		"typedoc": "0.23.26",
-		"typescript": "4.6.4"
+		"prettier": "3.0.0",
+		"typedoc": "0.24.8",
+		"typescript": "5.1.6"
 	}
 }

package/src/Rettiwt.ts

@@ -0,0 +1,33 @@
+// PACKAGE
+import { AuthCredential } from 'rettiwt-auth';
+
+// SERVICES
+import { TweetService } from './services/TweetService';
+import { UserService } from './services/UserService';
+
+/**
+ * The class for fetching data from Twitter.
+ *
+ * @public
+ */
+export class Rettiwt {
+	/** The instance used to fetch data related to tweets. */
+	tweet: TweetService;
+
+	/** The instance used to fetch data related to users. */
+	user: UserService;
+
+	/**
+	 * Initializes a new Rettiwt instance using the given api key.
+	 *
+	 * @param apiKey - The apiKey (cookie) to be used for authenticating Rettiwt against Twitter.
+	 */
+	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);
+	}
+}

package/src/enums/ApiErrors.ts

@@ -0,0 +1,30 @@
+/**
+ * The different types of api error messages.
+ *
+ * @public
+ */
+export enum EApiErrors {
+	COULD_NOT_AUTHENTICATE = 'Failed to authenticate',
+	RESOURCE_NOT_FOUND = 'Requested resource not found',
+	MISSING_PARAMETER = 'Missing named parameter',
+	USER_NOT_FOUND = 'Requested user not found',
+	USER_SUSPENDED = 'Requested user has been suspended',
+	ACCOUNT_SUSPENDED = 'Account has been suspended',
+	RATE_LIMIT_EXCEEDED = 'Rate limit exceeded',
+	INTERNAL_ERROR = 'Internal server error',
+	TIME_ERROR = 'Mismatched data/time with server',
+	ALREADY_FAVORITED = 'Tweet already favorited',
+	STATUS_NOT_FOUND = 'Requested tweeet not found',
+	NOT_AUTHORIZED = 'Not authorized to view tweet',
+	DAILY_STATUS_LIMIT_EXCEEDED = 'Exceeded daily tweet update limit',
+	TWEET_LENGTH_EXCEEDED = 'Exceeded tweet text maximum length',
+	DUPLICATE_STATUS = 'Tweet already posted',
+	BAD_AUTHENTICATION = 'Invalid authentication data',
+	RESOURCE_NOT_ALLOWED = 'Not authorized to access requested resource',
+	AUTOMATED_REQUEST_ERROR = 'Automated request detected',
+	ACCOUNT_LOCKED = 'Account has been locked',
+	ALREADY_RETWEETED = 'Tweet already retweeted',
+	TWEET_NOT_FOUND = 'Requested tweet not found',
+	TWEET_VIOLATED_RULES = 'Requestd tweet has been removed for rules violation',
+	DISABLED_TWEET_ACTIONS = 'Reqeusted action disabled on the tweet',
+}

package/src/enums/HTTP.ts

@@ -3,15 +3,15 @@
  *
  * @internal
  */
-export enum HttpStatus {
-    BadRequest = 400,
-    Unauthorized = 401,
-    Forbidden = 403,
-    NotFound = 404,
-    MethodNotAllowed = 405,
-    RequestTimeout = 408,
-    TooManyRequests = 429,
-    InternalServerError = 500,
-    BadGateway = 502,
-    ServiceUnavailable = 503
-};
+export enum EHttpStatus {
+	BAD_REQUEST = 400,
+	UNAUTHORIZED = 401,
+	FORBIDDEN = 403,
+	NOT_FOUND = 404,
+	METHOD_NOT_ALLOWED = 405,
+	REQUEST_TIMEOUT = 408,
+	TOO_MANY_REQUESTS = 429,
+	INTERNAL_SERVER_ERROR = 500,
+	BAD_GATEWAY = 502,
+	SERVICE_UNAVAILABLE = 503,
+}

package/src/helper/JsonUtils.ts

@@ -0,0 +1,86 @@
+/**
+ * Search for all the sub-objects (even deep-nested ones) that have the given key-value pair(filter).
+ *
+ * @param data - The data on which search is to be performed.
+ * @param key - The key of the key-value pair to search.
+ * @param value - The value of the key-value pait to search.
+ * @returns The list of sub-objects from the given object, having the given key-value pair.
+ *
+ * @internal
+ */
+export function findByFilter<T>(data: NonNullable<unknown>, key: string, value: string): T[] {
+	/**
+	 * The list containing all the objects matching given filter.
+	 */
+	let res: T[] = [];
+
+	/**
+	 * If the data is an array, recursively run the function of each element of the array and merge the results.
+	 */
+	if (Array.isArray(data)) {
+		/**
+		 * findByFilter returns an array.
+		 * map() also returns an array.
+		 * Therefore, map(item =\> findByFilter(.......)) returns an array of arrays.
+		 * Therefore, using ... operator to spread the 2-D array in 1-D array.
+		 */
+		res = res.concat(...data.map((item) => findByFilter<T>(item as NonNullable<unknown>, key, value)));
+	}
+	// If the data is an object
+	else if (typeof data == 'object') {
+		/**
+		 * If the object includes the key and the value specified by the key matches the filter, add it to the result.
+		 */
+		if (Object.keys(data).includes(key) && data[key as keyof typeof data] == value) {
+			res.push(data as T);
+		}
+
+		/**
+		 * Recursively run the function on each value specified by each key in the object, for subsequent matches.
+		 */
+		for (const [, v] of Object.entries(data)) {
+			res = res.concat(findByFilter<T>(v as NonNullable<unknown>, key, value));
+		}
+	}
+
+	return res;
+}
+
+/**
+ * @param text - The text to be normalized.
+ * @returns The text after being formatted to remove unnecessary characters.
+ *
+ * @internal
+ */
+export function normalizeText(text: string): string {
+	let normalizedText: string = ''; // To store the normalized text
+
+	// Removing unnecessary full stops, and other characters
+	normalizedText = text.replace(/\n/g, '.').replace(/[.]+[\s+.\s+]+/g, '. ');
+
+	// Adding full-stop to the end if does not exist already
+	normalizedText = normalizedText.endsWith('.') ? normalizedText : normalizedText + '.';
+
+	return normalizedText;
+}
+
+/**
+ * Searches for the key which has the given value in the given object.
+ *
+ * @param data - The data on which search is to be performed.
+ * @param value - The value to search.
+ * @returns The key with the given value.
+ */
+export function findKeyByValue(data: NonNullable<unknown>, value: string): string | undefined {
+	// Finding the key-value pairs that have the given value
+	const kvPair = Object.entries(data).filter(([, v]) => v == value)[0];
+
+	// If a match is found
+	if (kvPair) {
+		return kvPair[0];
+	}
+	// If no match is found
+	else {
+		return undefined;
+	}
+}

package/src/index.ts

@@ -1,64 +1,21 @@
-// PACKAGES
-import 'reflect-metadata';
+// MAIN
+export * from './Rettiwt';
 
-// SERVICES
-import { AuthService } from "./services/auth/AuthService";
-import { UserService } from "./services/data/UserService";
-import { TweetService } from "./services/data/TweetService";
-import { AccountService } from "./services/auth/AccountService";
+// Exporting enums
+export * from './enums/ApiErrors';
+export * from './enums/HTTP';
 
-// TYPES
-import { IAuthCookie } from './types/Authentication';
-
-/**
- * The instance for fetching data from Twitter.
- * 
- * @public
- * 
- * @param cookie The cookie to use to fetch data.
- * 
- * @returns The API for fetching user and tweet data.
- * 
- * @remarks The cookie can be obtained by using {@link AccountService.login} method.
- * To use the {@link AccountService.login} method, create a {@link Rettiwt} instance without passing any cookie .
- * Then use the {@link AccountService.login} method of {@link AccountService} to get the cookie.
- */
-export const Rettiwt = (cookie?: IAuthCookie) => {
-    // Creating new auth service instance using the given cookie
-    const auth: AuthService = new AuthService(cookie);
-
-    // Using the auth service instance to create data services instances
-    return {
-        users: new UserService(auth),
-        tweets: new TweetService(auth),
-        account: new AccountService()
-    };
-}
+// Exporting models
+export * from './models/CursoredData';
+export * from './models/Tweet';
+export * from './models/User';
 
-// Exporting classes
-export * from './services/auth/AuthService';
-export * from './services/auth/AccountService';
-export * from './services/data/TweetService';
-export * from './services/data/UserService';
-export * from './services/util/CacheService';
-export * from './services/util/FetcherService';
+// Exporting services
+export * from './services/FetcherService';
+export * from './services/TweetService';
+export * from './services/UserService';
 
 // Exporting types
-export { ITweetFilter } from 'rettiwt-core';
-export * from './types/Args';
-export { IAuthCookie } from './types/Authentication';
-export * from './types/Rettiwt';
-export * from './types/Service';
+export * from './types/CursoredData';
 export * from './types/Tweet';
 export * from './types/User';
-export { IDataValidationError } from 'rettiwt-core';
-
-// Exporting models
-export { TweetFilter } from 'rettiwt-core';
-export * from './models/args/TweetListArgs';
-export * from './models/args/UserListArgs';
-export { AuthCookie } from './models/auth/AuthCookie';
-export * from './models/data/CursoredData';
-export * from './models/data/Tweet';
-export * from './models/data/User';
-export { DataValidationError } from 'rettiwt-core';

package/src/models/CursoredData.ts

@@ -0,0 +1,64 @@
+// PACKAGES
+import { ITweet as IRawTweet, IUser as IRawUser } from 'rettiwt-core';
+
+// MODELS
+import { Tweet } from './Tweet';
+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.
+ *
+ * @typeParam T - Type of data to be stored in the list.
+ * 
+ * @public
+ */
+export class CursoredData<T extends Tweet | User> implements ICursoredData<T> {
+	/** The list of data of the given type. */
+	list: T[] = [];
+
+	/** The cursor to the next batch of data. */
+	next: Cursor;
+
+	/**
+	 * @param list - The list of data item to store.
+	 * @param next - The cursor to the next batch of data.
+	 */
+	constructor(list: (IRawTweet | IRawUser)[] = [], next: string = '') {
+		// Deserializing the input raw data and storing it in the list
+		for (const item of list) {
+			// If the item is a valid raw tweet
+			if (item.__typename == 'Tweet' && item.rest_id) {
+				this.list.push(new Tweet(item as IRawTweet) as T);
+			}
+			// If the item is a valid raw user
+			else if (item.__typename == 'User' && item.rest_id) {
+				this.list.push(new User(item as IRawUser) as T);
+			}
+		}
+
+		// Initializing cursors
+		this.next = new Cursor(next);
+	}
+}