rettiwt-api 2.3.0 → 2.4.0

package/dist/services/public/UserService.js

@@ -77,6 +77,40 @@ var UserService = /** @class */ (function (_super) {
      * @param id - The username/id of the target user.
      * @returns The details of the given user.
      *
+     * @example Fetching the details of the Twitter user with username 'user1'
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with username 'user1'
+     * rettiwt.user.details('user1')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @example Fetching the details of the Twitter user with id '12345678'
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with id '12345678'
+     * rettiwt.user.details('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     UserService.prototype.details = function (id) {
@@ -109,6 +143,23 @@ var UserService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of following to fetch.
      * @returns The list of users followed by the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 following of the User with id '12345678'
+     * rettiwt.user.following('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     UserService.prototype.following = function (userId, count, cursor) {
@@ -136,6 +187,23 @@ var UserService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of followers to fetch.
      * @returns The list of users following the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 followers of the User with id '12345678'
+     * rettiwt.user.followers('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     UserService.prototype.followers = function (userId, count, cursor) {
@@ -163,6 +231,23 @@ var UserService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of likes to fetch.
      * @returns The list of tweets liked by the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 liked Tweets of the User with id '12345678'
+     * rettiwt.user.likes('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @public
      */
     UserService.prototype.likes = function (userId, count, cursor) {
@@ -190,7 +275,26 @@ var UserService = /** @class */ (function (_super) {
      * @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.
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 20 timeline tweets of the User with id '12345678'
+     * rettiwt.user.timeline('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @remarks
+     * - If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
+     * - If timeline is fetched without authenticating, then the most popular tweets of the target user are returned instead.
      *
      * @public
      */
@@ -219,6 +323,23 @@ var UserService = /** @class */ (function (_super) {
      * @param cursor - The cursor to the batch of replies to fetch.
      * @returns The reply timeline of the target user.
      *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 timeline replies of the User with id '12345678'
+     * rettiwt.user.replies('12345678')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
      * @remarks If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
      *
      * @public

package/dist/services/public/UserService.js.map

@@ -1 +1 @@
-{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../src/services/public/UserService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA6C;AAE7C,WAAW;AACX,6DAA4D;AAU5D;;;;GAIG;AACH;IAAiC,+BAAc;IAC9C;;;;OAIG;IACH,qBAAmB,MAAsB;eACxC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACU,6BAAO,GAApB,UAAqB,EAAU;;;;;;6BAI1B,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;IACU,+BAAS,GAAtB,UAAuB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAExD,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;IACU,+BAAS,GAAtB,UAAuB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAExD,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;IACU,2BAAK,GAAlB,UAAmB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEpD,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;IACU,8BAAQ,GAArB,UAAsB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEvD,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;IAED;;;;;;;;;;;OAWG;IACU,6BAAO,GAApB,UAAqB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEtD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,uBAAuB,EAAE;4BAC3E,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,qEAAqE;wBACrE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,MAAM,EAA1B,CAA0B,CAAC,CAAC;wBAEpE,sBAAO,IAAI,EAAC;;;;KACZ;IACF,kBAAC;AAAD,CAAC,AAlJD,CAAiC,+BAAc,GAkJ9C;AAlJY,kCAAW"}
+{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../src/services/public/UserService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,6CAA6C;AAE7C,WAAW;AACX,6DAA4D;AAU5D;;;;GAIG;AACH;IAAiC,+BAAc;IAC9C;;;;OAIG;IACH,qBAAmB,MAAsB;eACxC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACU,6BAAO,GAApB,UAAqB,EAAU;;;;;;6BAI1B,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,+BAAS,GAAtB,UAAuB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAExD,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,+BAAS,GAAtB,UAAuB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAExD,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,2BAAK,GAAlB,UAAmB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEpD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,8BAAQ,GAArB,UAAsB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEvD,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,6BAAO,GAApB,UAAqB,MAAc,EAAE,KAAc,EAAE,MAAe;;;;;4BAEtD,qBAAM,IAAI,CAAC,KAAK,CAAQ,4BAAa,CAAC,uBAAuB,EAAE;4BAC3E,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,KAAK;4BACZ,MAAM,EAAE,MAAM;yBACd,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,qEAAqE;wBACrE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,MAAM,EAA1B,CAA0B,CAAC,CAAC;wBAEpE,sBAAO,IAAI,EAAC;;;;KACZ;IACF,kBAAC;AAAD,CAAC,AA3QD,CAAiC,+BAAc,GA2Q9C;AA3QY,kCAAW"}

package/dist/types/internal/RettiwtConfig.d.ts

@@ -6,6 +6,8 @@
 export interface IRettiwtConfig {
     /** The apiKey (cookie) to use for authenticating Rettiwt against Twitter API. */
     apiKey?: string;
+    /** The guestKey (guest token) to use for guest access to Twitter API. */
+    guestKey?: string;
     /** Optional URL with proxy configuration to use for requests to Twitter API. */
     proxyUrl?: URL;
     /** Whether to write logs to console or not. */

package/package.json

@@ -1,9 +1,12 @@
 {
 	"name": "rettiwt-api",
-	"version": "2.3.0",
+	"version": "2.4.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",
+	"bin": {
+		"rettiwt": "dist/cli.js"
+	},
 	"scripts": {
 		"build": "tsc",
 		"prepare": "tsc",
@@ -27,8 +30,9 @@
 	"homepage": "https://rishikant181.github.io/Rettiwt-API/",
 	"dependencies": {
 		"axios": "1.3.2",
+		"commander": "11.1.0",
 		"https-proxy-agent": "7.0.2",
-		"rettiwt-auth": "1.2.0",
+		"rettiwt-auth": "2.0.0",
 		"rettiwt-core": "3.2.1"
 	},
 	"devDependencies": {

package/src/Rettiwt.ts

@@ -6,7 +6,43 @@ import { UserService } from './services/public/UserService';
 import { RettiwtConfig } from './models/internal/RettiwtConfig';
 
 /**
- * The class for fetching data from Twitter.
+ * The class for accessing Twitter API.
+ *
+ * The created Rettiwt instance can be configured by passing in a configuration object to the constructor.
+ *
+ * For details regarding the available configuration options, refer to {@link RettiwtConfig}
+ *
+ * @example Creating a Rettiwt instance with 'guest' authentication:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt();
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'guest' authentication, using a pre-generated guest key:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ guestKey: 'GUEST_KEY' });
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'user' authentication:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ apiKey: 'API_KEY' });
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'user'authentication, along with enabling debug logs and using a proxy:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ apiKey: 'API_KEY', loggin: true, proxyUrl: 'URL_TO_PROXY_SERVER' });
+ * ```
  *
  * @public
  */

package/src/cli.ts

@@ -0,0 +1,40 @@
+#! /usr/bin/env node
+
+// PACKAGES
+import { createCommand } from 'commander';
+import { Rettiwt } from './Rettiwt';
+
+// SUB-COMMANDS
+import tweet from './commands/Tweet';
+import user from './commands/User';
+import auth from './commands/Auth';
+
+// Creating a new commandline program
+const program = createCommand('rettiwt')
+	.description('A CLI tool for accessing the Twitter API for free!')
+	.passThroughOptions()
+	.enablePositionalOptions();
+
+// Adding options
+program
+	.option('-k, --key <string>', 'The API key to use for authentication')
+	.option('-l, --log', 'Enable logging to console')
+	.option('-p, --proxy <string>', 'The URL to the proxy to use');
+
+// Parsing the program to get supplied options
+program.parse();
+
+// Initializing Rettiwt instance using the given options
+const rettiwt: Rettiwt = new Rettiwt({
+	apiKey: process.env.API_KEY ?? (program.opts().key as string),
+	logging: program.opts().log ? true : false,
+	proxyUrl: program.opts().proxy as URL,
+});
+
+// Adding sub-commands
+program.addCommand(tweet(rettiwt));
+program.addCommand(user(rettiwt));
+program.addCommand(auth());
+
+// Finalizing the CLI
+program.parse();

package/src/commands/Auth.ts

@@ -0,0 +1,45 @@
+// PACKAGES
+import { Command, createCommand } from 'commander';
+import { Auth } from 'rettiwt-auth';
+
+// UTILITY
+import { output } from '../helper/CliUtils';
+
+function createAuthCommand(): Command {
+	// Creating the 'auth' command
+	const auth = createCommand('auth').description('Manage authentication');
+
+	// Login
+	auth.command('login')
+		.description('Generate a new API key using Twitter account login credentials')
+		.argument('<email>', 'The email id of the Twitter account')
+		.argument('<username>', 'The username associated with the Twitter account')
+		.argument('<password>', 'The password to the Twitter account')
+		.action(async (email: string, username: string, password: string) => {
+			// Logging in and getting the credentials
+			let apiKey: string =
+				(
+					await new Auth().getUserCredential({ email: email, userName: username, password: password })
+				).toHeader().cookie ?? '';
+
+			// Converting the credentials to base64 string
+			apiKey = Buffer.from(apiKey).toString('base64');
+			output(apiKey);
+		});
+
+	// Guest
+	auth.command('guest')
+		.description('Generate a new guest API key')
+		.action(async () => {
+			// Getting a new guest API key
+			let guestKey: string = (await new Auth().getGuestCredential()).guestToken ?? '';
+
+			// Converting the credentials to base64 string
+			guestKey = Buffer.from(guestKey).toString('base64');
+			output(guestKey);
+		});
+
+	return auth;
+}
+
+export default createAuthCommand;

package/src/commands/Tweet.ts

@@ -0,0 +1,163 @@
+// PACKAGES
+import { Command, createCommand } from 'commander';
+import { Rettiwt } from '../Rettiwt';
+import { TweetFilter } from 'rettiwt-core';
+
+// UTILITY
+import { output } from '../helper/CliUtils';
+
+/**
+ * Creates a new 'tweet' command which uses the given Rettiwt instance.
+ *
+ * @param rettiwt - The Rettiwt instance to use.
+ * @returns The created 'tweet' command.
+ */
+function createTweetCommand(rettiwt: Rettiwt): Command {
+	// Creating the 'tweet' command
+	const tweet = createCommand('tweet').description('Access resources releated to tweets');
+
+	// Details
+	tweet
+		.command('details')
+		.description('Fetch the details of tweet with the given id')
+		.argument('<id>', 'The id of the tweet whose details are to be fetched')
+		.action(async (id: string) => {
+			const details = await rettiwt.tweet.details(id);
+			output(details);
+		});
+
+	// Search
+	tweet
+		.command('search')
+		.description('Fetch the list of tweets that match the given filter options')
+		.argument('[count]', 'The number of tweets to fetch')
+		.argument('[cursor]', 'The cursor to the batch of tweets to fetch')
+		.option('-f, --from <string>', "Matches the tweets made by list of given users, separated by ';'")
+		.option('-t, --to <string>', "Matches the tweets made to the list of given users, separated by ';'")
+		.option('-w, --words <string>', "Matches the tweets containing the given list of words, separated by ';'")
+		.option('-h, --hashtags <string>', "Matches the tweets containing the given list of hashtags, separated by ';'")
+		.option('-s, --start <string>', 'Matches the tweets made since the given date (valid date string)')
+		.option('-e, --end <string>', 'Matches the tweets made upto the given date (valid date string)')
+		.action(async (count?: string, cursor?: string, options?: TweetSearchOptions) => {
+			const tweets = await rettiwt.tweet.search(
+				new TweetSearchOptions(options).toTweetFilter(),
+				count ? parseInt(count) : undefined,
+				cursor,
+			);
+			output(tweets);
+		});
+
+	// List
+	tweet
+		.command('list')
+		.description('Fetch the list of tweets in the tweet list with the given id')
+		.argument('<id>', 'The id of the tweet list')
+		.argument('[count]', 'The number of tweets to fetch')
+		.argument('[cursor]', 'The cursor to the batch of tweets to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const tweets = await rettiwt.tweet.list(id, count ? parseInt(count) : undefined, cursor);
+			output(tweets);
+		});
+
+	// Likes
+	tweet
+		.command('likes')
+		.description('Fetch the list of users who liked the given tweets')
+		.argument('<id>', 'The id of the tweet')
+		.argument('[count]', 'The number of likers to fetch')
+		.argument('[cursor]', 'The cursor to the batch of likers to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const tweets = await rettiwt.tweet.favoriters(id, count ? parseInt(count) : undefined, cursor);
+			output(tweets);
+		});
+
+	// Retweets
+	tweet
+		.command('retweets')
+		.description('Fetch the list of users who retweeted the given tweets')
+		.argument('<id>', 'The id of the tweet')
+		.argument('[count]', 'The number of retweeters to fetch')
+		.argument('[cursor]', 'The cursor to the batch of retweeters to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const tweets = await rettiwt.tweet.retweeters(id, count ? parseInt(count) : undefined, cursor);
+			output(tweets);
+		});
+
+	// Post
+	tweet
+		.command('post')
+		.description('Post a tweet (text only)')
+		.argument('<text>', 'The text to post as a tweet')
+		.action(async (text: string) => {
+			const result = await rettiwt.tweet.tweet(text);
+			output(result);
+		});
+
+	// Like
+	tweet
+		.command('like')
+		.description('Like a tweet')
+		.argument('<id>', 'The tweet to like')
+		.action(async (id: string) => {
+			const result = await rettiwt.tweet.favorite(id);
+			output(result);
+		});
+
+	// Retweet
+	tweet
+		.command('retweet')
+		.description('Retweet a tweet')
+		.argument('<id>', 'The tweet to retweet')
+		.action(async (id: string) => {
+			const result = await rettiwt.tweet.retweet(id);
+			output(result);
+		});
+
+	return tweet;
+}
+
+/**
+ * The search options supplied while searching for tweets.
+ *
+ * @remarks The search options are implementations of the ones offered by {@link TweetFilter}
+ */
+class TweetSearchOptions {
+	public from?: string;
+	public to?: string;
+	public words?: string;
+	public hashtags?: string;
+	public start?: string;
+	public end?: string;
+
+	/**
+	 * Initializes a new object from the given options.
+	 *
+	 * @param options - The search options.
+	 */
+	public constructor(options?: TweetSearchOptions) {
+		this.from = options?.from;
+		this.to = options?.to;
+		this.words = options?.words;
+		this.hashtags = options?.hashtags;
+		this.start = options?.start;
+		this.end = options?.end;
+	}
+
+	/**
+	 * Converts the filter options to a format recognizable by rettiwt-api.
+	 *
+	 * @returns The '{@link TweetFilter}' representation of filter options.
+	 */
+	public toTweetFilter(): TweetFilter {
+		return new TweetFilter({
+			fromUsers: this.from ? this.from.split(';') : undefined,
+			toUsers: this.to ? this.to.split(';') : undefined,
+			words: this.words ? this.words.split(';') : undefined,
+			hashtags: this.hashtags ? this.hashtags.split(';') : undefined,
+			startDate: this.start ? new Date(this.start) : undefined,
+			endDate: this.end ? new Date(this.end) : undefined,
+		});
+	}
+}
+
+export default createTweetCommand;

package/src/commands/User.ts

@@ -0,0 +1,85 @@
+// PACKAGES
+import { Command, createCommand } from 'commander';
+import { Rettiwt } from '../Rettiwt';
+
+// UTILITY
+import { output } from '../helper/CliUtils';
+
+/**
+ * Creates a new 'user' command which uses the given Rettiwt instance.
+ *
+ * @param rettiwt - The Rettiwt instance to use.
+ * @returns The created 'user' command.
+ */
+function createUserCommand(rettiwt: Rettiwt): Command {
+	// Creating the 'user' command
+	const user = createCommand('user').description('Access resources releated to users');
+
+	// Details
+	user.command('details')
+		.description('Fetch the details of the user with the given id/username')
+		.argument('<id>', 'The username/id of the user whose details are to be fetched')
+		.action(async (id: string) => {
+			const details = await rettiwt.user.details(id);
+			output(details);
+		});
+
+	// Following
+	user.command('following')
+		.description('Fetch the list of users who are followed by the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of following to fetch')
+		.argument('[cursor]', 'The cursor to the batch of following to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const users = await rettiwt.user.following(id, count ? parseInt(count) : undefined, cursor);
+			output(users);
+		});
+
+	// Followers
+	user.command('followers')
+		.description('Fetch the list of users who follow the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of followers to fetch')
+		.argument('[cursor]', 'The cursor to the batch of followers to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const users = await rettiwt.user.followers(id, count ? parseInt(count) : undefined, cursor);
+			output(users);
+		});
+
+	// Likes
+	user.command('likes')
+		.description('Fetch the list of tweets liked by the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of liked tweets to fetch')
+		.argument('[cursor]', 'The cursor to the batch of liked tweets to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const users = await rettiwt.user.likes(id, count ? parseInt(count) : undefined, cursor);
+			output(users);
+		});
+
+	// Timeline
+	user.command('timeline')
+		.description('Fetch the tweets timeline the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of tweets to fetch')
+		.argument('[cursor]', 'The cursor to the batch of tweets to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const users = await rettiwt.user.timeline(id, count ? parseInt(count) : undefined, cursor);
+			output(users);
+		});
+
+	// Replies
+	user.command('replies')
+		.description('Fetch the replies timeline the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of replies to fetch')
+		.argument('[cursor]', 'The cursor to the batch of replies to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			const users = await rettiwt.user.replies(id, count ? parseInt(count) : undefined, cursor);
+			output(users);
+		});
+
+	return user;
+}
+
+export default createUserCommand;

package/src/helper/CliUtils.ts

@@ -0,0 +1,15 @@
+/**
+ * Outputs the given JSON data.
+ *
+ * @param data - The data to be output.
+ */
+export function output(data: NonNullable<unknown>): void {
+	// If data is string, output as is
+	if (typeof data == 'string') {
+		console.log(data);
+	}
+	// Else, format the output
+	else {
+		console.log(JSON.stringify(data, null, 4));
+	}
+}

package/src/index.ts

@@ -12,6 +12,7 @@ export * from './models/public/CursoredData';
 export * from './models/public/List';
 export * from './models/public/Tweet';
 export * from './models/public/User';
+export { TweetFilter } from 'rettiwt-core';
 
 // Exporting services
 export * from './services/internal/FetcherService';
@@ -25,3 +26,4 @@ export * from './types/public/CursoredData';
 export * from './types/public/List';
 export * from './types/public/Tweet';
 export * from './types/public/User';
+export { ITweetFilter } from 'rettiwt-core';

package/src/models/internal/RettiwtConfig.ts

@@ -7,13 +7,9 @@ import { IRettiwtConfig } from '../../types/internal/RettiwtConfig';
  * @internal
  */
 export class RettiwtConfig implements IRettiwtConfig {
-	/** The apiKey (cookie) to use for authenticating Rettiwt against Twitter API. */
 	public apiKey?: string;
-
-	/** Optional URL with proxy configuration to use for requests to Twitter API. */
+	public guestKey?: string;
 	public proxyUrl?: URL;
-
-	/** Whether to write logs to console or not. */
 	public logging?: boolean;
 
 	/**
@@ -23,6 +19,7 @@ export class RettiwtConfig implements IRettiwtConfig {
 	 */
 	public constructor(config: RettiwtConfig) {
 		this.apiKey = config.apiKey;
+		this.guestKey = config.guestKey;
 		this.proxyUrl = config.proxyUrl;
 		this.logging = config.logging;
 	}

package/src/models/public/CursoredData.ts

@@ -13,10 +13,7 @@ import { ICursor, ICursoredData } from '../../types/public/CursoredData';
  * @public
  */
 export class CursoredData<T extends Tweet | User> implements ICursoredData<T> {
-	/** The list of data of the given type. */
 	public list: T[] = [];
-
-	/** The cursor to the next batch of data. */
 	public next: Cursor;
 
 	/**
@@ -35,7 +32,6 @@ export class CursoredData<T extends Tweet | User> implements ICursoredData<T> {
  * @public
  */
 export class Cursor implements ICursor {
-	/** The cursor string. */
 	public value: string;
 
 	/**