rettiwt-api 5.0.0-alpha.0 → 5.0.0-alpha.2

package/dist/services/public/AuthService.js

@@ -1,205 +0,0 @@
-"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.AuthService = void 0;
-var rettiwt_auth_1 = require("rettiwt-auth");
-var Api_1 = require("../../enums/Api");
-var FetcherService_1 = require("./FetcherService");
-/**
- * The services that handles authentication.
- *
- * @public
- */
-var AuthService = /** @class */ (function (_super) {
-    __extends(AuthService, _super);
-    /**
-     * @param config - The config object for configuring the `Rettiwt` instance.
-     *
-     * @internal
-     */
-    function AuthService(config) {
-        return _super.call(this, config) || this;
-    }
-    /**
-     * Decodes the encoded cookie string.
-     *
-     * @param encodedCookies - The encoded cookie string to decode.
-     * @returns The decoded cookie string.
-     */
-    AuthService.decodeCookie = function (encodedCookies) {
-        // Decoding the encoded cookie string
-        var decodedCookies = Buffer.from(encodedCookies, 'base64').toString('ascii');
-        return decodedCookies;
-    };
-    /**
-     * Encodes the given cookie string.
-     *
-     * @param cookieString - The cookie string to encode.
-     * @returns The encoded cookie string.
-     */
-    AuthService.encodeCookie = function (cookieString) {
-        // Encoding the cookie string to base64
-        var encodedCookies = Buffer.from(cookieString).toString('base64');
-        return encodedCookies;
-    };
-    /**
-     * Gets the user's id from the given API key.
-     *
-     * @param apiKey - The API key.
-     * @returns The user id associated with the API key.
-     */
-    AuthService.getUserId = function (apiKey) {
-        // Getting the cookie string from the API key
-        var cookieString = AuthService.decodeCookie(apiKey);
-        // Searching for the user id in the cookie string
-        var searchResults = cookieString.match(/((?<=twid="u=)(\d+)(?="))|((?<=twid=u%3D)(\d+)(?=;))/);
-        // If user id was found
-        if (searchResults) {
-            return searchResults[0];
-        }
-        // If user id was not found
-        else {
-            throw new Error(Api_1.EApiErrors.BAD_AUTHENTICATION);
-        }
-    };
-    /**
-     * Login to twitter as guest.
-     *
-     * @returns A new guest key.
-     *
-     * @example
-     * ```
-     * import { Rettiwt } from 'rettiwt-api';
-     *
-     * // Creating a new Rettiwt instance
-     * const rettiwt = new Rettiwt();
-     *
-     * // Logging in an getting a new guest key
-     * rettiwt.auth.guest()
-     * .then(guestKey => {
-     * 	// Use the guest key
-     * 	...
-     * })
-     * .catch(err => {
-     * 	console.log(err);
-     * });
-     * ```
-     */
-    AuthService.prototype.guest = function () {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var guestKey;
-            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 : '';
-                        return [2 /*return*/, guestKey];
-                }
-            });
-        });
-    };
-    /**
-     * Login to twitter using account credentials.
-     *
-     * @param email - The email id associated with the Twitter account.
-     * @param userName - The username associated with the Twitter account.
-     * @param password - The password to the Twitter account.
-     *
-     * @returns The `API_KEY` for the Twitter account.
-     *
-     * @example
-     * ```
-     * import { Rettiwt } from 'rettiwt-api';
-     *
-     * // Creating a new Rettiwt instance
-     * const rettiwt = new Rettiwt();
-     *
-     * // Logging in an getting the API_KEY
-     * rettiwt.auth.login("email@domain.com", "username", "password")
-     * .then(apiKey => {
-     * 	// Use the API_KEY
-     * 	...
-     * })
-     * .catch(err => {
-     * 	console.log(err);
-     * });
-     * ```
-     *
-     * @remarks
-     * Interchanging `email` and `userName` works too.
-     */
-    AuthService.prototype.login = function (email, userName, password) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var apiKey;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0: return [4 /*yield*/, new rettiwt_auth_1.Auth({ proxyUrl: this.authProxyUrl }).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 = AuthService.encodeCookie(apiKey);
-                        return [2 /*return*/, apiKey];
-                }
-            });
-        });
-    };
-    return AuthService;
-}(FetcherService_1.FetcherService));
-exports.AuthService = AuthService;
-//# sourceMappingURL=AuthService.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"AuthService.js","sourceRoot":"","sources":["../../../src/services/public/AuthService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAoC;AAEpC,uCAA6C;AAG7C,mDAAkD;AAElD;;;;GAIG;AACH;IAAiC,+BAAc;IAC9C;;;;OAIG;IACH,qBAAmB,MAAuB;eACzC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACW,wBAAY,GAA1B,UAA2B,cAAsB;QAChD,qCAAqC;QACrC,IAAM,cAAc,GAAW,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEvF,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACW,wBAAY,GAA1B,UAA2B,YAAoB;QAC9C,uCAAuC;QACvC,IAAM,cAAc,GAAW,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE5E,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACW,qBAAS,GAAvB,UAAwB,MAAc;QACrC,6CAA6C;QAC7C,IAAM,YAAY,GAAW,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE9D,iDAAiD;QACjD,IAAM,aAAa,GAAoB,YAAY,CAAC,KAAK,CACxD,sDAAsD,CACtD,CAAC;QAEF,uBAAuB;QACvB,IAAI,aAAa,EAAE;YAClB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;SACxB;QACD,2BAA2B;aACtB;YACJ,MAAM,IAAI,KAAK,CAAC,gBAAU,CAAC,kBAAkB,CAAC,CAAC;SAC/C;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,2BAAK,GAAlB;;;;;;4BAE2B,qBAAM,IAAI,mBAAI,EAAE,CAAC,kBAAkB,EAAE,EAAA;;wBAAzD,QAAQ,GAAW,MAAA,CAAC,SAAqC,CAAC,CAAC,UAAU,mCAAI,EAAE;wBAEjF,sBAAO,QAAQ,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,2BAAK,GAAlB,UAAmB,KAAa,EAAE,QAAgB,EAAE,QAAgB;;;;;;4BAIjE,qBAAM,IAAI,mBAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,iBAAiB,CAAC;4BACjE,KAAK,EAAE,KAAK;4BACZ,QAAQ,EAAE,QAAQ;4BAClB,QAAQ,EAAE,QAAQ;yBAClB,CAAC,EAAA;;wBANA,MAAM,GACT,MAAC,CACA,SAIE,CACF,CAAC,QAAQ,EAAE,CAAC,MAAiB,mCAAI,EAAE;wBAErC,8CAA8C;wBAC9C,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;wBAE1C,sBAAO,MAAM,EAAC;;;;KACd;IACF,kBAAC;AAAD,CAAC,AAzID,CAAiC,+BAAc,GAyI9C;AAzIY,kCAAW"}

package/dist/types/ReturnTypes.d.ts

@@ -1,21 +0,0 @@
-import { CursoredData } from '../models/data/CursoredData';
-import { Tweet } from '../models/data/Tweet';
-import { User } from '../models/data/User';
-/**
- * Collection of all return types.
- *
- * @internal
- */
-export type AllReturnTypes = boolean | CursoredData<Tweet> | CursoredData<User> | string | Tweet | User;
-/**
- * Return type of fetch requests.
- *
- * @internal
- */
-export type FetchReturnType = boolean | CursoredData<Tweet> | CursoredData<User> | Tweet | User;
-/**
- * Return type of post requests.
- *
- * @internal
- */
-export type PostReturnType = boolean;

package/dist/types/ReturnTypes.js.map

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

package/src/commands/Auth.ts

@@ -1,46 +0,0 @@
-import { Command, createCommand } from 'commander';
-
-import { output } from '../helper/CliUtils';
-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.
- */
-function createAuthCommand(rettiwt: Rettiwt): 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) => {
-			try {
-				const apiKey: string = await rettiwt.auth.login(email, username, password);
-				output(apiKey);
-			} catch (error) {
-				output(error);
-			}
-		});
-
-	// Guest
-	auth.command('guest')
-		.description('Generate a new guest key')
-		.action(async () => {
-			try {
-				const guestKey: string = await rettiwt.auth.guest();
-				output(guestKey);
-			} catch (error) {
-				output(error);
-			}
-		});
-
-	return auth;
-}
-
-export default createAuthCommand;

package/src/models/errors/DataValidationError.ts

@@ -1,44 +0,0 @@
-import { ValidationError } from 'class-validator';
-
-/**
- * Represents and error when any fields of a validation-enabled class fails to validate.
- *
- * @public
- */
-export class DataValidationError {
-	/** The detaied error message(s). */
-	public details: ValidationErrorDetails[];
-
-	/** The user-friendly error message. */
-	public message: string;
-
-	/** The name of the error. */
-	public name: string;
-
-	/**
-	 * @param data - The error details, as a list of type {@link ValidationError}
-	 */
-	public constructor(errorDetails: ValidationError[]) {
-		this.name = 'VALIDATION_ERROR';
-		this.message = 'One or more validation error(s) occured, check details field.';
-		this.details = errorDetails.map((error) => new ValidationErrorDetails(error));
-	}
-}
-
-/**
- * Represents the validation error details of a single field.
- *
- * @public
- */
-export class ValidationErrorDetails {
-	/** The constraints which failed to be validated for the given field. */
-	public constraints: string[];
-
-	/** The name of the field which failed validation. */
-	public field: string;
-
-	public constructor(details: ValidationError) {
-		this.field = details.property;
-		this.constraints = Object.values(details.constraints!);
-	}
-}

package/src/types/ReturnTypes.ts

@@ -1,24 +0,0 @@
-import { CursoredData } from '../models/data/CursoredData';
-import { Tweet } from '../models/data/Tweet';
-import { User } from '../models/data/User';
-
-/**
- * Collection of all return types.
- *
- * @internal
- */
-export type AllReturnTypes = boolean | CursoredData<Tweet> | CursoredData<User> | string | Tweet | User;
-
-/**
- * Return type of fetch requests.
- *
- * @internal
- */
-export type FetchReturnType = boolean | CursoredData<Tweet> | CursoredData<User> | Tweet | User;
-
-/**
- * Return type of post requests.
- *
- * @internal
- */
-export type PostReturnType = boolean;