rettiwt-api 2.3.1 → 2.4.1

package/README.md

@@ -4,9 +4,40 @@ An API for fetching data from Twitter for free!
 
 ## Prerequisites
 
--   NodeJS 18.14.2
+-   NodeJS 20.10.0
 -   A working Twitter account
 
+## Types of Authentication
+
+Rettiwt can be used with or without logging in to Twitter. As such, the two authentication strategies are:
+
+-   'guest' authentication (without logging in) grants access to the following resources:
+
+    -   Tweet Details
+    -   User Details
+    -   User Timeline (tweets timeline)
+    -   User Replies (replies timeline)
+
+-   'user' authentication (logging in) grants access to the following resources:
+
+    -   Tweet Details
+    -   Tweet Favoriters (likes)
+    -   Tweet Retweeters (retweets)
+    -   Tweet Search
+    -   Tweet List
+    -   User Details
+    -   User Followers
+    -   User Following
+    -   User Likes
+    -   User Timeline (tweets timeline)
+    -   User Replies (replies timeline)
+
+## Notes for non-programmers
+
+-   If you have no idea of programming, it's recommended to use the CLI.
+-   The CLI provides an easy to use interface which does not require any knowledge of JavaScript or programming
+-   Please skip to 'CLI-Usage' section for details.
+
 ## Installation
 
 1. Initialize a new Node.JS project using the command `npm init`.
@@ -18,7 +49,7 @@ Although the above process initializes a new project, that is, in fact, not nece
 
 ## Getting started
 
-1. Generate credentials using [rettiwt-auth](https://www.npmjs.com/package/rettiwt-auth) package, by following these [steps](https://rishikant181.github.io/Rettiwt-Auth/#md:1-generating-credentials-as-an-api-key-for-use-with-rettiwt-api).
+1. Generate credentials using the command `npx rettiwt auth login <email> <username> <password>` in a terminal in the root of your project.
 2. The generated string is the API_KEY.
 3. Create a new instance of Rettiwt, passing in the API key as a config object:  
    `const rettiwt = Rettiwt({ apiKey: API_KEY });`  
@@ -29,10 +60,31 @@ Although the above process initializes a new project, that is, in fact, not nece
 
 -   The API_KEY that we generated, is a very sensitive information and provides all access to the Twitter account. Therefore, it is generally recommended to store it as an environment variable and use it from there.
 
--   It's also possible to use this package without using a Twitter account, by omitting the 'apiKey' parameter in the config object. However, in this case, functionality is limited to accessing only the following resources:
-    -   Getting the details of a user (by username)
-    -   Getting the details of a tweet
-    -   Getting the tweet timeline of a user (only most recent 100 entries)
+-   The given example above uses 'user' authentication by using an API_KEY generated from the Twitter account.
+
+-   It's also possible to use this package without using a Twitter account, by omitting the 'apiKey' parameter in the config object. However, in this case, 'guest' authentication is used.
+
+## The API_KEY
+
+The API_KEY generated by logging in is what allows Rettiwt-API to authenticate as a logged in user while interacting with the Twitter API ('user' authentication). As such it is a very sensitive information and therefore, must be stored securely. The following points must be kept in mind while using the API_KEY for 'user' authentication:
+
+-   The API_KEY is generated by logging into Twitter using the email, username and password and encoding the returned cookies as a base64 string. This encoded string is the API_KEY.
+-   The API_KEY provides the same level of authorization as any standard Twitter account, nothing more, nothing less.
+-   Since generation of API_KEY is equivalent to logging in to Twitter, repeated generation attempts might trigger Twitter's anti-bot measures, the same way repeated login attempts do.
+-   The API_KEY expires after one year from the day it was generated.
+-   Therefore, it is recommended to generate the API_KEY only once, then use it every time it is needed.
+-   Do not generate an API_KEY if it has not expired yet!
+
+## The Rettiwt class
+
+The Rettiwt class is entry point for accessing the Twitter API.
+
+The Rettiwt class has two members:
+
+-   'tweet' member, for accessing resources related to tweets
+-   'user' member, for accessing resources related to users
+
+For details regarding usage of these members for accessing the Twitter API, refer to the 'Features' section.
 
 ## Usage
 
@@ -40,7 +92,7 @@ The following examples may help you to get started using the library:
 
 ### 1. Getting the details of a target Twitter user
 
-```
+```js
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
@@ -58,7 +110,7 @@ rettiwt.user.details('<username>')
 
 ### 2. Getting the list of tweets that match a given filter
 
-```
+```js
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
@@ -85,7 +137,7 @@ rettiwt.tweet.search({
 
 The previous example fetches the the list of tweets matching the given filter. Since no count is specified, in this case, a default of 20 such Tweets are fetched initially. The following example demonstrates how to use the [cursor string](https://rishikant181.github.io/Rettiwt-API/classes/Cursor.html#value) obtained from the [response](https://rishikant181.github.io/Rettiwt-API/classes/CursoredData.html) object's [next](https://rishikant181.github.io/Rettiwt-API/classes/CursoredData.html#next) field, from the previous example, to fetch the next batch of tweets:
 
-```
+```js
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
@@ -116,7 +168,7 @@ For more information regarding the different available filter options, please re
 
 For masking of IP address using a proxy server, use the following code snippet for instantiation of Rettiwt:
 
-```
+```js
 /**
  * PROXY_URL is the URL or configuration for the proxy server you want to use.`
  */
@@ -129,7 +181,7 @@ This creates a Rettiwt instance which uses the given proxy server for making req
 
 Sometimes, when the library shows unexpected behaviour, for troubleshooting purposes, debug logs can be enabled which will help in tracking down the issue and working on a potential fix. Currently, debug logs are printed to the console and are enabled by setting the 'logging' property of the config to true, while creating an instance of Rettiwt:
 
-```
+```js
 /**
  * By default, is no value for 'logging' is supplied, logging is disabled.
  */
@@ -160,6 +212,33 @@ So far, the following operations are supported:
 -   [Getting the tweet timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#timeline)
 -   [Getting the reply timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#replies)
 
+## CLI Usage
+
+Rettiwt-API also provides an easy to use command-line interface which does not require any programming knowledge.
+
+### Installation
+
+1. Install the recommended version of NodeJS specified in the 'Prerequisites' section.
+2. Open a terminal.
+3. Install the package globally using the command `npm install -g rettiwt-api`.
+4. Use the command `rettiwt help` to ensure that the package has been installed correctly.
+
+### Authentication
+
+By default, the CLI operates in 'guest' authentication. If you want to use 'user' authentication:
+
+1. Generate an API_KEY using the command `rettiwt auth login <email> <username> <password>`.
+2. Store the output API_KEY as an environment variable with the name 'API_KEY'.
+    - Additionaly, store the API_KEY in a file for later use.
+    - Make sure to generate an API_KEY only once, and use it every time you need it.
+3. The CLI automatically reads this environment variable to authenticate against Twitter.
+    - Additionaly, the API_KEY can also be passed in manually using the '-k' option as follows: `rettiwt -k <API_KEY> <command>`
+
+### Help
+
+-   For help regarding the available commands, use the command `rettiwt help`
+-   For help regarding a specific command, use the command `rettiwt help <command_name>`
+
 ## API Reference
 
 The complete API reference can be found at [this](https://rishikant181.github.io/Rettiwt-API/) page.

package/dist/Rettiwt.d.ts

@@ -2,7 +2,43 @@ import { TweetService } from './services/public/TweetService';
 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/dist/Rettiwt.js

@@ -5,7 +5,43 @@ exports.Rettiwt = void 0;
 var TweetService_1 = require("./services/public/TweetService");
 var UserService_1 = require("./services/public/UserService");
 /**
- * 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/dist/Rettiwt.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,+DAA8D;AAC9D,6DAA4D;AAK5D;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,iBAAmB,MAAsB;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACF,cAAC;AAAD,CAAC,AAhBD,IAgBC;AAhBY,0BAAO"}
+{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,+DAA8D;AAC9D,6DAA4D;AAK5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH;IAOC;;;;OAIG;IACH,iBAAmB,MAAsB;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACF,cAAC;AAAD,CAAC,AAhBD,IAgBC;AAhBY,0BAAO"}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,39 @@
+#! /usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+// PACKAGES
+var commander_1 = require("commander");
+var Rettiwt_1 = require("./Rettiwt");
+// SUB-COMMANDS
+var Tweet_1 = __importDefault(require("./commands/Tweet"));
+var User_1 = __importDefault(require("./commands/User"));
+var Auth_1 = __importDefault(require("./commands/Auth"));
+// Creating a new commandline program
+var program = (0, commander_1.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
+var rettiwt = new Rettiwt_1.Rettiwt({
+    apiKey: (_a = process.env.API_KEY) !== null && _a !== void 0 ? _a : program.opts().key,
+    logging: program.opts().log ? true : false,
+    proxyUrl: program.opts().proxy,
+});
+// Adding sub-commands
+program.addCommand((0, Tweet_1.default)(rettiwt));
+program.addCommand((0, User_1.default)(rettiwt));
+program.addCommand((0, Auth_1.default)());
+// Finalizing the CLI
+program.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;AAEA,WAAW;AACX,uCAA0C;AAC1C,qCAAoC;AAEpC,eAAe;AACf,2DAAqC;AACrC,yDAAmC;AACnC,yDAAmC;AAEnC,qCAAqC;AACrC,IAAM,OAAO,GAAG,IAAA,yBAAa,EAAC,SAAS,CAAC;KACtC,WAAW,CAAC,oDAAoD,CAAC;KACjE,kBAAkB,EAAE;KACpB,uBAAuB,EAAE,CAAC;AAE5B,iBAAiB;AACjB,OAAO;KACL,MAAM,CAAC,oBAAoB,EAAE,uCAAuC,CAAC;KACrE,MAAM,CAAC,WAAW,EAAE,2BAA2B,CAAC;KAChD,MAAM,CAAC,sBAAsB,EAAE,6BAA6B,CAAC,CAAC;AAEhE,8CAA8C;AAC9C,OAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,wDAAwD;AACxD,IAAM,OAAO,GAAY,IAAI,iBAAO,CAAC;IACpC,MAAM,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,OAAO,mCAAK,OAAO,CAAC,IAAI,EAAE,CAAC,GAAc;IAC7D,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;IAC1C,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,KAAY;CACrC,CAAC,CAAC;AAEH,sBAAsB;AACtB,OAAO,CAAC,UAAU,CAAC,IAAA,eAAK,EAAC,OAAO,CAAC,CAAC,CAAC;AACnC,OAAO,CAAC,UAAU,CAAC,IAAA,cAAI,EAAC,OAAO,CAAC,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,IAAA,cAAI,GAAE,CAAC,CAAC;AAE3B,qBAAqB;AACrB,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/commands/Auth.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare function createAuthCommand(): Command;
+export default createAuthCommand;

package/dist/commands/Auth.js

@@ -0,0 +1,90 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// PACKAGES
+var commander_1 = require("commander");
+var rettiwt_auth_1 = require("rettiwt-auth");
+// UTILITY
+var CliUtils_1 = require("../helper/CliUtils");
+function createAuthCommand() {
+    var _this = this;
+    // Creating the 'auth' command
+    var auth = (0, commander_1.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(function (email, username, password) { return __awaiter(_this, void 0, void 0, function () {
+        var apiKey;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, new rettiwt_auth_1.Auth().getUserCredential({ email: email, userName: username, password: password })];
+                case 1:
+                    apiKey = (_a = (_b.sent()).toHeader().cookie) !== null && _a !== void 0 ? _a : '';
+                    // Converting the credentials to base64 string
+                    apiKey = Buffer.from(apiKey).toString('base64');
+                    (0, CliUtils_1.output)(apiKey);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // Guest
+    auth.command('guest')
+        .description('Generate a new guest API key')
+        .action(function () { return __awaiter(_this, void 0, void 0, function () {
+        var guestKey;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, new rettiwt_auth_1.Auth().getGuestCredential()];
+                case 1:
+                    guestKey = (_a = (_b.sent()).guestToken) !== null && _a !== void 0 ? _a : '';
+                    // Converting the credentials to base64 string
+                    guestKey = Buffer.from(guestKey).toString('base64');
+                    (0, CliUtils_1.output)(guestKey);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    return auth;
+}
+exports.default = createAuthCommand;
+//# sourceMappingURL=Auth.js.map

package/dist/commands/Auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../src/commands/Auth.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,WAAW;AACX,uCAAmD;AACnD,6CAAoC;AAEpC,UAAU;AACV,+CAA4C;AAE5C,SAAS,iBAAiB;IAA1B,iBAmCC;IAlCA,8BAA8B;IAC9B,IAAM,IAAI,GAAG,IAAA,yBAAa,EAAC,MAAM,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;IAExE,QAAQ;IACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACnB,WAAW,CAAC,gEAAgE,CAAC;SAC7E,QAAQ,CAAC,SAAS,EAAE,qCAAqC,CAAC;SAC1D,QAAQ,CAAC,YAAY,EAAE,kDAAkD,CAAC;SAC1E,QAAQ,CAAC,YAAY,EAAE,qCAAqC,CAAC;SAC7D,MAAM,CAAC,UAAO,KAAa,EAAE,QAAgB,EAAE,QAAgB;;;;;wBAI7D,qBAAM,IAAI,mBAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAA;;oBAF1F,MAAM,GACT,MAAA,CACC,SAA4F,CAC5F,CAAC,QAAQ,EAAE,CAAC,MAAM,mCAAI,EAAE;oBAE1B,8CAA8C;oBAC9C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAChD,IAAA,iBAAM,EAAC,MAAM,CAAC,CAAC;;;;SACf,CAAC,CAAC;IAEJ,QAAQ;IACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACnB,WAAW,CAAC,8BAA8B,CAAC;SAC3C,MAAM,CAAC;;;;;wBAEiB,qBAAM,IAAI,mBAAI,EAAE,CAAC,kBAAkB,EAAE,EAAA;;oBAAzD,QAAQ,GAAW,MAAA,CAAC,SAAqC,CAAC,CAAC,UAAU,mCAAI,EAAE;oBAE/E,8CAA8C;oBAC9C,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACpD,IAAA,iBAAM,EAAC,QAAQ,CAAC,CAAC;;;;SACjB,CAAC,CAAC;IAEJ,OAAO,IAAI,CAAC;AACb,CAAC;AAED,kBAAe,iBAAiB,CAAC"}

package/dist/commands/Tweet.d.ts

@@ -0,0 +1,10 @@
+import { Command } from 'commander';
+import { Rettiwt } from '../Rettiwt';
+/**
+ * Creates a new 'tweet' command which uses the given Rettiwt instance.
+ *
+ * @param rettiwt - The Rettiwt instance to use.
+ * @returns The created 'tweet' command.
+ */
+declare function createTweetCommand(rettiwt: Rettiwt): Command;
+export default createTweetCommand;

package/dist/commands/Tweet.js

@@ -0,0 +1,242 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// PACKAGES
+var commander_1 = require("commander");
+var rettiwt_core_1 = require("rettiwt-core");
+// UTILITY
+var CliUtils_1 = require("../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) {
+    var _this = this;
+    // Creating the 'tweet' command
+    var tweet = (0, commander_1.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(function (id) { return __awaiter(_this, void 0, void 0, function () {
+        var details;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.details(id)];
+                case 1:
+                    details = _a.sent();
+                    (0, CliUtils_1.output)(details);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // 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(function (count, cursor, options) { return __awaiter(_this, void 0, void 0, function () {
+        var tweets;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.search(new TweetSearchOptions(options).toTweetFilter(), count ? parseInt(count) : undefined, cursor)];
+                case 1:
+                    tweets = _a.sent();
+                    (0, CliUtils_1.output)(tweets);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // 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(function (id, count, cursor) { return __awaiter(_this, void 0, void 0, function () {
+        var tweets;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.list(id, count ? parseInt(count) : undefined, cursor)];
+                case 1:
+                    tweets = _a.sent();
+                    (0, CliUtils_1.output)(tweets);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // 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(function (id, count, cursor) { return __awaiter(_this, void 0, void 0, function () {
+        var tweets;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.favoriters(id, count ? parseInt(count) : undefined, cursor)];
+                case 1:
+                    tweets = _a.sent();
+                    (0, CliUtils_1.output)(tweets);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // 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(function (id, count, cursor) { return __awaiter(_this, void 0, void 0, function () {
+        var tweets;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.retweeters(id, count ? parseInt(count) : undefined, cursor)];
+                case 1:
+                    tweets = _a.sent();
+                    (0, CliUtils_1.output)(tweets);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // Post
+    tweet
+        .command('post')
+        .description('Post a tweet (text only)')
+        .argument('<text>', 'The text to post as a tweet')
+        .action(function (text) { return __awaiter(_this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.tweet(text)];
+                case 1:
+                    result = _a.sent();
+                    (0, CliUtils_1.output)(result);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // Like
+    tweet
+        .command('like')
+        .description('Like a tweet')
+        .argument('<id>', 'The tweet to like')
+        .action(function (id) { return __awaiter(_this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.favorite(id)];
+                case 1:
+                    result = _a.sent();
+                    (0, CliUtils_1.output)(result);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // Retweet
+    tweet
+        .command('retweet')
+        .description('Retweet a tweet')
+        .argument('<id>', 'The tweet to retweet')
+        .action(function (id) { return __awaiter(_this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, rettiwt.tweet.retweet(id)];
+                case 1:
+                    result = _a.sent();
+                    (0, CliUtils_1.output)(result);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    return tweet;
+}
+/**
+ * The search options supplied while searching for tweets.
+ *
+ * @remarks The search options are implementations of the ones offered by {@link TweetFilter}
+ */
+var TweetSearchOptions = /** @class */ (function () {
+    /**
+     * Initializes a new object from the given options.
+     *
+     * @param options - The search options.
+     */
+    function TweetSearchOptions(options) {
+        this.from = options === null || options === void 0 ? void 0 : options.from;
+        this.to = options === null || options === void 0 ? void 0 : options.to;
+        this.words = options === null || options === void 0 ? void 0 : options.words;
+        this.hashtags = options === null || options === void 0 ? void 0 : options.hashtags;
+        this.start = options === null || options === void 0 ? void 0 : options.start;
+        this.end = options === null || options === void 0 ? void 0 : options.end;
+    }
+    /**
+     * Converts the filter options to a format recognizable by rettiwt-api.
+     *
+     * @returns The '{@link TweetFilter}' representation of filter options.
+     */
+    TweetSearchOptions.prototype.toTweetFilter = function () {
+        return new rettiwt_core_1.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,
+        });
+    };
+    return TweetSearchOptions;
+}());
+exports.default = createTweetCommand;
+//# sourceMappingURL=Tweet.js.map