rettiwt-api 4.2.0 → 5.0.0-alpha.1

package/src/types/args/PostArgs.ts

@@ -0,0 +1,62 @@
+import { INewTweet } from 'rettiwt-core';
+
+/**
+ * Options specifying the media file to be uploaded.
+ *
+ * @public
+ */
+export interface IUploadArgs {
+	/** The id allocated to the media file to be uploaded. */
+	id?: string;
+
+	/** The media file to be uploaded. */
+	media?: string | ArrayBuffer;
+
+	/**
+	 * The size (in bytes) of the media file to be uploaded.
+	 *
+	 * @remarks The size must be \<= 5242880 bytes.
+	 */
+	size?: number;
+}
+
+/**
+ * Options specifying the data that is to be posted.
+ *
+ * @public
+ */
+export interface IPostArgs {
+	/**
+	 * The id of the target resource.
+	 *
+	 * @remarks
+	 * Required only when posting using the following resources:
+	 * - {@link EResourceType.TWEET_LIKE}
+	 * - {@link EResourceType.TWEET_RETWEET}
+	 * - {@link EResourceType.TWEET_UNLIKE}
+	 * - {@link EResourceType.TWEET_UNPOST}
+	 * - {@link EResourceType.TWEET_UNRETWEET}
+	 * - {@link EResourceType.USER_FOLLOW}
+	 * - {@link EResourceType.USER_UNFOLLOW}
+	 */
+	id?: string;
+
+	/**
+	 * The tweet that is to be posted.
+	 *
+	 * @remarks
+	 * Required only when posting a tweet using {@link EResourceType.TWEET_POST}
+	 */
+	tweet?: INewTweet;
+
+	/**
+	 * The media file to be uploaded.
+	 *
+	 * @remarks
+	 * Required only when uploading a media using the following resources:
+	 * - {@link EResourceType.MEDIA_UPLOAD_APPEND}
+	 * - {@link EResourceType.MEDIA_UPLOAD_FINALIZE}
+	 * - {@link EResourceType.MEDIA_UPLOAD_INITIALIZE}
+	 */
+	upload?: IUploadArgs;
+}

package/src/types/auth/AccountCredential.ts

@@ -0,0 +1,13 @@
+/**
+ * The credentials of the Twitter account to be logged into.
+ */
+export interface IAccountCredential {
+	/** The email id associated with the Twitter account. */
+	email: string;
+
+	/** The password to the Twitter account. */
+	password: string;
+
+	/** The username associated with the Twitter account. */
+	userName: string;
+}

package/src/types/auth/AuthCookie.ts

@@ -0,0 +1,20 @@
+/**
+ * The cookie containing the tokens that are used to authenticate against Twitter.
+ */
+export interface IAuthCookie {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	/** The bearer token from twitter.com. */
+	auth_token: string;
+
+	/** The CSRF token for the session. */
+	ct0: string;
+
+	/** Token used to authenticate a device. */
+	kdt: string;
+
+	/** Token used to authenticate a user using a Twitter ID. */
+	twid: string;
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+}

package/src/types/auth/AuthCredential.ts

@@ -0,0 +1,26 @@
+import { EAuthenticationType } from '../../enums/Authentication';
+
+/**
+ * The credentials for authenticating against Twitter.
+ *
+ * Depending on which tokens are present, the authentication type is determined as follows:
+ * - authToken, guestToken =\> Guest authentication.
+ * - authToken, csrfToken, cookie =\> User authentication.
+ * - authToken, guestToken, cookie =\> Guest authentication while logging in.
+ */
+export interface IAuthCredential {
+	/** The bearer token from twitter.com. */
+	authToken?: string;
+
+	/** The type of authentication. */
+	authenticationType?: EAuthenticationType;
+
+	/** The cookie of the twitter account, which is used to authenticate against twitter. */
+	cookies?: string;
+
+	/** The CSRF token for the session. */
+	csrfToken?: string;
+
+	/** The guest token provided by Twitter API. */
+	guestToken?: string;
+}

package/src/types/data/CursoredData.ts

@@ -0,0 +1,28 @@
+import { INotification } from './Notification';
+import { ITweet } from './Tweet';
+import { IUser } from './User';
+
+/**
+ * The data that is fetched batch-wise using a cursor.
+ *
+ * @typeParam T - Type of data to be stored.
+ *
+ * @public
+ */
+export interface ICursoredData<T extends INotification | ITweet | IUser> {
+	/** The batch of data of the given type. */
+	list: T[];
+
+	/** The cursor to the next batch of data. */
+	next: ICursor;
+}
+
+/**
+ * The cursor to the batch of data to fetch.
+ *
+ * @public
+ */
+export interface ICursor {
+	/** The cursor string. */
+	value: string;
+}

package/src/types/data/List.ts

@@ -0,0 +1,27 @@
+/**
+ * The details of a single Twitter List.
+ *
+ * @public
+ */
+export interface IList {
+	/** The date and time of creation of the list, int UTC string format. */
+	createdAt: string;
+
+	/** The rest id of the user who created the list. */
+	createdBy: string;
+
+	/** The list description. */
+	description?: string;
+
+	/** The rest id of the list. */
+	id: string;
+
+	/** The number of memeber of the list. */
+	memberCount: number;
+
+	/** The name of the list. */
+	name: string;
+
+	/** The number of subscribers of the list. */
+	subscriberCount: number;
+}

package/src/types/data/Notification.ts

@@ -0,0 +1,26 @@
+import { ENotificationType } from '../../enums/Data';
+
+/**
+ * The details of a single notification.
+ *
+ * @public
+ */
+export interface INotification {
+	/** The list of id of the users from whom the notification was received. */
+	from: string[];
+
+	/** The id of the notification. */
+	id: string;
+
+	/** The text contents of the notification. */
+	message: string;
+
+	/** The date/time at which the notification was received. */
+	receivedAt: Date;
+
+	/** The list of id of the target tweet(s) of the notification. */
+	target: string[];
+
+	/** The type of notification. */
+	type?: ENotificationType;
+}

package/src/types/data/Tweet.ts

@@ -0,0 +1,96 @@
+import { EMediaType } from 'rettiwt-core';
+
+import { IUser } from './User';
+
+/**
+ * The details of a single tweet.
+ *
+ * @public
+ */
+export interface ITweet {
+	/** The number of bookmarks of a tweet. */
+	bookmarkCount: number;
+
+	/** The ID of tweet which started the current conversation. */
+	conversationId: string;
+
+	/** The date and time of creation of the tweet, in UTC string format. */
+	createdAt: string;
+
+	/** Additional tweet entities like urls, mentions, etc. */
+	entities: ITweetEntities;
+
+	/** The full text content of the tweet. */
+	fullText: string;
+
+	/** The rest id of the tweet. */
+	id: string;
+
+	/** The language in which the tweet is written. */
+	lang: string;
+
+	/** The number of likes of the tweet. */
+	likeCount: number;
+
+	/** The urls of the media contents of the tweet (if any). */
+	media?: ITweetMedia[];
+
+	/** The number of quotes of the tweet. */
+	quoteCount: number;
+
+	/** The tweet which is quoted in the tweet. */
+	quoted?: ITweet;
+
+	/** The number of replies to the tweet. */
+	replyCount: number;
+
+	/** The rest id of the tweet to which the tweet is a reply. */
+	replyTo?: string;
+
+	/** The number of retweets of the tweet. */
+	retweetCount: number;
+
+	/** The tweet which is retweeted in this tweet (if any). */
+	retweetedTweet?: ITweet;
+
+	/** The details of the user who made the tweet. */
+	tweetBy: IUser;
+
+	/** The URL to the tweet. */
+	url: string;
+
+	/** The number of views of a tweet. */
+	viewCount: number;
+}
+
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export interface ITweetEntities {
+	/** The list of hashtags mentioned in the tweet. */
+	hashtags: string[];
+
+	/** The list of IDs of users mentioned in the tweet. */
+	mentionedUsers: string[];
+
+	/** The list of urls mentioned in the tweet. */
+	urls: string[];
+}
+
+/**
+ * The details of a single media content included in a tweet.
+ *
+ * @public
+ */
+export interface ITweetMedia {
+	/** The thumbnail URL for the video content of the tweet. */
+	thumbnailUrl?: string;
+
+	/** The type of media. */
+	type: EMediaType;
+
+	/** The direct URL to the media. */
+	url: string;
+}

package/src/types/data/User.ts

@@ -0,0 +1,48 @@
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+export interface IUser {
+	/** The creation date of user's account. */
+	createdAt: string;
+
+	/** The user's description. */
+	description?: string;
+
+	/** The number of followers of the user. */
+	followersCount: number;
+
+	/** The number of following of the user. */
+	followingsCount: number;
+
+	/** The full name of the user. */
+	fullName: string;
+
+	/** The rest id of the user. */
+	id: string;
+
+	/** Whether the account is verified or not. */
+	isVerified: boolean;
+
+	/** The number of tweets liked by the user. */
+	likeCount: number;
+
+	/** The location of user as provided by user. */
+	location?: string;
+
+	/** The rest id of the tweet pinned in the user's profile. */
+	pinnedTweet?: string;
+
+	/** The url of the profile banner image. */
+	profileBanner?: string;
+
+	/** The url of the profile image. */
+	profileImage: string;
+
+	/** The number of tweets made by the user. */
+	statusesCount: number;
+
+	/** The username/screenname of the user. */
+	userName: string;
+}

package/tsconfig.json

@@ -9,7 +9,7 @@
 		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
 		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 		/* Language and Environment */
-		// "target": "es2016",                               /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
 		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
 		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
 		"experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
@@ -22,9 +22,9 @@
 		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 		// "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 		/* Modules */
-		// "module": "commonjs",                             /* Specify what module code is generated. */
-		"rootDir": "./src" /* Specify the root folder within your source files. */,
-		// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+		"module": "NodeNext" /* Specify what module code is generated. */,
+		"rootDir": "./src/" /* Specify the root folder within your source files. */,
+		"moduleResolution": "nodenext" /* Specify how TypeScript looks up a file from a given module specifier. */,
 		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
 		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
 		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -91,5 +91,7 @@
 		/* Completeness */
 		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
 		// "skipLibCheck": true                              /* Skip type checking all .d.ts files. */
-	}
+	},
+	"include": ["src/**/*"],
+	"exclude": ["node_modules", "**/*.spec.ts"]
 }

package/.eslintignore

@@ -1,3 +0,0 @@
-node_modules/
-dist/
-docs/

package/dist/commands/Auth.d.ts

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

package/dist/commands/Auth.js

@@ -1,101 +0,0 @@
-"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 });
-var commander_1 = require("commander");
-var CliUtils_1 = require("../helper/CliUtils");
-/**
- * Creates a new 'auth' command which uses the given Rettiwt instance.
- *
- * @param rettiwt - The Rettiwt instance to use.
- * @returns The created 'auth' command.
- */
-function createAuthCommand(rettiwt) {
-    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, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, rettiwt.auth.login(email, username, password)];
-                case 1:
-                    apiKey = _a.sent();
-                    (0, CliUtils_1.output)(apiKey);
-                    return [3 /*break*/, 3];
-                case 2:
-                    error_1 = _a.sent();
-                    (0, CliUtils_1.output)(error_1);
-                    return [3 /*break*/, 3];
-                case 3: return [2 /*return*/];
-            }
-        });
-    }); });
-    // Guest
-    auth.command('guest')
-        .description('Generate a new guest key')
-        .action(function () { return __awaiter(_this, void 0, void 0, function () {
-        var guestKey, error_2;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, rettiwt.auth.guest()];
-                case 1:
-                    guestKey = _a.sent();
-                    (0, CliUtils_1.output)(guestKey);
-                    return [3 /*break*/, 3];
-                case 2:
-                    error_2 = _a.sent();
-                    (0, CliUtils_1.output)(error_2);
-                    return [3 /*break*/, 3];
-                case 3: return [2 /*return*/];
-            }
-        });
-    }); });
-    return auth;
-}
-exports.default = createAuthCommand;
-//# sourceMappingURL=Auth.js.map

package/dist/commands/Auth.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../src/commands/Auth.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAmD;AAEnD,+CAA4C;AAG5C;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,OAAgB;IAA3C,iBAgCC;IA/BA,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;;;;;;oBAEvC,qBAAM,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAA;;oBAApE,MAAM,GAAW,SAAmD;oBAC1E,IAAA,iBAAM,EAAC,MAAM,CAAC,CAAC;;;;oBAEf,IAAA,iBAAM,EAAC,OAAK,CAAC,CAAC;;;;;SAEf,CAAC,CAAC;IAEJ,QAAQ;IACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACnB,WAAW,CAAC,0BAA0B,CAAC;SACvC,MAAM,CAAC;;;;;;oBAEmB,qBAAM,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,EAAA;;oBAA7C,QAAQ,GAAW,SAA0B;oBACnD,IAAA,iBAAM,EAAC,QAAQ,CAAC,CAAC;;;;oBAEjB,IAAA,iBAAM,EAAC,OAAK,CAAC,CAAC;;;;;SAEf,CAAC,CAAC;IAEJ,OAAO,IAAI,CAAC;AACb,CAAC;AAED,kBAAe,iBAAiB,CAAC"}

package/dist/models/errors/DataValidationError.d.ts

@@ -1,30 +0,0 @@
-import { ValidationError } from 'class-validator';
-/**
- * Represents and error when any fields of a validation-enabled class fails to validate.
- *
- * @public
- */
-export declare class DataValidationError {
-    /** The detaied error message(s). */
-    details: ValidationErrorDetails[];
-    /** The user-friendly error message. */
-    message: string;
-    /** The name of the error. */
-    name: string;
-    /**
-     * @param data - The error details, as a list of type {@link ValidationError}
-     */
-    constructor(errorDetails: ValidationError[]);
-}
-/**
- * Represents the validation error details of a single field.
- *
- * @public
- */
-export declare class ValidationErrorDetails {
-    /** The constraints which failed to be validated for the given field. */
-    constraints: string[];
-    /** The name of the field which failed validation. */
-    field: string;
-    constructor(details: ValidationError);
-}

package/dist/models/errors/DataValidationError.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationErrorDetails = exports.DataValidationError = void 0;
-/**
- * Represents and error when any fields of a validation-enabled class fails to validate.
- *
- * @public
- */
-var DataValidationError = /** @class */ (function () {
-    /**
-     * @param data - The error details, as a list of type {@link ValidationError}
-     */
-    function DataValidationError(errorDetails) {
-        this.name = 'VALIDATION_ERROR';
-        this.message = 'One or more validation error(s) occured, check details field.';
-        this.details = errorDetails.map(function (error) { return new ValidationErrorDetails(error); });
-    }
-    return DataValidationError;
-}());
-exports.DataValidationError = DataValidationError;
-/**
- * Represents the validation error details of a single field.
- *
- * @public
- */
-var ValidationErrorDetails = /** @class */ (function () {
-    function ValidationErrorDetails(details) {
-        this.field = details.property;
-        this.constraints = Object.values(details.constraints);
-    }
-    return ValidationErrorDetails;
-}());
-exports.ValidationErrorDetails = ValidationErrorDetails;
-//# sourceMappingURL=DataValidationError.js.map

package/dist/models/errors/DataValidationError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataValidationError.js","sourceRoot":"","sources":["../../../src/models/errors/DataValidationError.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH;IAUC;;OAEG;IACH,6BAAmB,YAA+B;QACjD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,+DAA+D,CAAC;QAC/E,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,IAAI,sBAAsB,CAAC,KAAK,CAAC,EAAjC,CAAiC,CAAC,CAAC;IAC/E,CAAC;IACF,0BAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,kDAAmB;AAoBhC;;;;GAIG;AACH;IAOC,gCAAmB,OAAwB;QAC1C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC;IACxD,CAAC;IACF,6BAAC;AAAD,CAAC,AAXD,IAWC;AAXY,wDAAsB"}