rettiwt-api 2.7.1 → 3.0.1

package/dist/services/internal/ErrorService.d.ts

@@ -1,7 +1,7 @@
 import { AxiosError, AxiosResponse } from 'axios';
-import { IErrorHandler } from '../../types/ErrorHandler';
 import { ApiError } from '../../models/errors/ApiError';
 import { HttpError } from '../../models/errors/HttpError';
+import { IErrorHandler } from '../../types/ErrorHandler';
 /**
  * The base service that handles any errors.
  *
@@ -13,73 +13,83 @@ export declare class ErrorService implements IErrorHandler {
      */
     protected static readonly DEFAULT_ERROR_MESSAGE = "Unknown error";
     /**
-     * The method called when an error response is received from Twitter API.
+     * Creates an API error instance based on the provided error code.
      *
-     * @param error - The error caught while making HTTP request to Twitter API.
+     * @param errorCode - The error code.
+     *
+     * @returns An API error instance.
      */
-    handle(error: unknown): void;
+    protected createApiError(errorCode: number): ApiError;
     /**
-     * Handles exceeded timeout, configured in RettiwtConfig.
+     * Creates an HTTP error instance based on the provided HTTP status.
      *
-     * @param error - The error object.
-     * @throws An error if the configured request timeout has been exceeded.
+     * @param httpStatus - The HTTP status code.
+     *
+     * @returns An HTTP error instance.
      */
-    protected handleTimeoutError(error: AxiosError): void;
+    protected createHttpError(httpStatus: number): HttpError;
+    /**
+     * Retrieves the API error message based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     *
+     * @returns The API error message.
+     */
+    protected getApiErrorMessage(errorCode: number): string;
     /**
      * Retrieves the response data from the given error.
      *
      * @param error - The error object.
+     *
      * @returns The response data.
+     *
      * @throws The original error if it is not an HTTP error with a response.
      */
     protected getAxiosResponse(error: AxiosError): AxiosResponse;
     /**
-     * Handles HTTP error in a response.
-     *
-     * @param response - The response object received.
-     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
-     */
-    protected handleHttpError(response: AxiosResponse): void;
-    /**
-     * Handles API error in a response.
+     * Retrieves the API error code from the Axios response data.
      *
      * @param response - The response object received.
-     * @throws An error with the corresponding API error message if any API-related error has occurred.
-     */
-    protected handleApiError(response: AxiosResponse): void;
-    /**
-     * Creates an HTTP error instance based on the provided HTTP status.
      *
-     * @param httpStatus - The HTTP status code.
-     * @returns An HTTP error instance.
+     * @returns The error code, or undefined if not found.
      */
-    protected createHttpError(httpStatus: number): HttpError;
+    protected getErrorCode(response: AxiosResponse): number | undefined;
     /**
      * Retrieves the HTTP error message based on the provided HTTP status.
      *
      * @param httpStatus - The HTTP status code.
+     *
      * @returns The HTTP error message.
      */
     protected getHttpErrorMessage(httpStatus: number): string;
     /**
-     * Retrieves the API error code from the Axios response data.
+     * Handles API error in a response.
      *
      * @param response - The response object received.
-     * @returns The error code, or undefined if not found.
+     *
+     * @throws An error with the corresponding API error message if any API-related error has occurred.
      */
-    protected getErrorCode(response: AxiosResponse): number | undefined;
+    protected handleApiError(response: AxiosResponse): void;
     /**
-     * Creates an API error instance based on the provided error code.
+     * Handles HTTP error in a response.
      *
-     * @param errorCode - The error code.
-     * @returns An API error instance.
+     * @param response - The response object received.
+     *
+     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
      */
-    protected createApiError(errorCode: number): ApiError;
+    protected handleHttpError(response: AxiosResponse): void;
     /**
-     * Retrieves the API error message based on the provided error code.
+     * Handles exceeded timeout, configured in RettiwtConfig.
      *
-     * @param errorCode - The error code.
-     * @returns The API error message.
+     * @param error - The error object.
+     *
+     * @throws An error if the configured request timeout has been exceeded.
      */
-    protected getApiErrorMessage(errorCode: number): string;
+    protected handleTimeoutError(error: AxiosError): void;
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making HTTP request to Twitter API.
+     */
+    handle(error: unknown): void;
 }

package/dist/services/internal/ErrorService.js

@@ -1,21 +1,13 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorService = void 0;
-// PACKAGES
-var axios_1 = __importDefault(require("axios"));
-var JsonUtils_1 = require("../../helper/JsonUtils");
-// ENUMS
+var axios_1 = require("axios");
 var Api_1 = require("../../enums/Api");
 var Http_1 = require("../../enums/Http");
-var rettiwt_core_1 = require("rettiwt-core");
-// ERRORS
+var JsonUtils_1 = require("../../helper/JsonUtils");
 var ApiError_1 = require("../../models/errors/ApiError");
 var HttpError_1 = require("../../models/errors/HttpError");
 var TimeoutError_1 = require("../../models/errors/TimeoutError");
-// TODO Refactor and document this module
 /**
  * The base service that handles any errors.
  *
@@ -25,35 +17,45 @@ var ErrorService = exports.ErrorService = /** @class */ (function () {
     function ErrorService() {
     }
     /**
-     * The method called when an error response is received from Twitter API.
+     * Creates an API error instance based on the provided error code.
      *
-     * @param error - The error caught while making HTTP request to Twitter API.
+     * @param errorCode - The error code.
+     *
+     * @returns An API error instance.
      */
-    ErrorService.prototype.handle = function (error) {
-        if (!axios_1.default.isAxiosError(error)) {
-            throw error;
-        }
-        this.handleTimeoutError(error);
-        var axiosResponse = this.getAxiosResponse(error);
-        this.handleApiError(axiosResponse);
-        this.handleHttpError(axiosResponse);
+    ErrorService.prototype.createApiError = function (errorCode) {
+        return new ApiError_1.ApiError(errorCode, this.getApiErrorMessage(errorCode));
     };
     /**
-     * Handles exceeded timeout, configured in RettiwtConfig.
+     * Creates an HTTP error instance based on the provided HTTP status.
      *
-     * @param error - The error object.
-     * @throws An error if the configured request timeout has been exceeded.
+     * @param httpStatus - The HTTP status code.
+     *
+     * @returns An HTTP error instance.
      */
-    ErrorService.prototype.handleTimeoutError = function (error) {
-        if (error.code === 'ECONNABORTED') {
-            throw new TimeoutError_1.TimeoutError(error.message);
-        }
+    ErrorService.prototype.createHttpError = function (httpStatus) {
+        return new HttpError_1.HttpError(httpStatus, this.getHttpErrorMessage(httpStatus));
+    };
+    /**
+     * Retrieves the API error message based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     *
+     * @returns The API error message.
+     */
+    ErrorService.prototype.getApiErrorMessage = function (errorCode) {
+        var errorCodeKey = (0, JsonUtils_1.findKeyByValue)(Api_1.EErrorCodes, errorCode.toString());
+        return !!errorCodeKey && errorCodeKey in Api_1.EApiErrors
+            ? Api_1.EApiErrors[errorCodeKey]
+            : ErrorService.DEFAULT_ERROR_MESSAGE;
     };
     /**
      * Retrieves the response data from the given error.
      *
      * @param error - The error object.
+     *
      * @returns The response data.
+     *
      * @throws The original error if it is not an HTTP error with a response.
      */
     ErrorService.prototype.getAxiosResponse = function (error) {
@@ -63,18 +65,33 @@ var ErrorService = exports.ErrorService = /** @class */ (function () {
         throw error;
     };
     /**
-     * Handles HTTP error in a response.
+     * Retrieves the API error code from the Axios response data.
      *
      * @param response - The response object received.
-     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
+     *
+     * @returns The error code, or undefined if not found.
      */
-    ErrorService.prototype.handleHttpError = function (response) {
-        throw this.createHttpError(response.status);
+    ErrorService.prototype.getErrorCode = function (response) {
+        var errors = response.data.errors;
+        return !!errors && errors.length ? errors[0].code : undefined;
+    };
+    /**
+     * Retrieves the HTTP error message based on the provided HTTP status.
+     *
+     * @param httpStatus - The HTTP status code.
+     *
+     * @returns The HTTP error message.
+     */
+    ErrorService.prototype.getHttpErrorMessage = function (httpStatus) {
+        return Object.values(Http_1.EHttpStatus).includes(httpStatus)
+            ? Http_1.EHttpStatus[httpStatus]
+            : ErrorService.DEFAULT_ERROR_MESSAGE;
     };
     /**
      * Handles API error in a response.
      *
      * @param response - The response object received.
+     *
      * @throws An error with the corresponding API error message if any API-related error has occurred.
      */
     ErrorService.prototype.handleApiError = function (response) {
@@ -85,55 +102,40 @@ var ErrorService = exports.ErrorService = /** @class */ (function () {
         throw this.createApiError(errorCode);
     };
     /**
-     * Creates an HTTP error instance based on the provided HTTP status.
+     * Handles HTTP error in a response.
      *
-     * @param httpStatus - The HTTP status code.
-     * @returns An HTTP error instance.
-     */
-    ErrorService.prototype.createHttpError = function (httpStatus) {
-        return new HttpError_1.HttpError(httpStatus, this.getHttpErrorMessage(httpStatus));
-    };
-    /**
-     * Retrieves the HTTP error message based on the provided HTTP status.
+     * @param response - The response object received.
      *
-     * @param httpStatus - The HTTP status code.
-     * @returns The HTTP error message.
+     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
      */
-    ErrorService.prototype.getHttpErrorMessage = function (httpStatus) {
-        return Object.values(Http_1.EHttpStatus).includes(httpStatus)
-            ? Http_1.EHttpStatus[httpStatus]
-            : ErrorService.DEFAULT_ERROR_MESSAGE;
+    ErrorService.prototype.handleHttpError = function (response) {
+        throw this.createHttpError(response.status);
     };
     /**
-     * Retrieves the API error code from the Axios response data.
+     * Handles exceeded timeout, configured in RettiwtConfig.
      *
-     * @param response - The response object received.
-     * @returns The error code, or undefined if not found.
-     */
-    ErrorService.prototype.getErrorCode = function (response) {
-        var errors = response.data.errors;
-        return !!errors && errors.length ? errors[0].code : undefined;
-    };
-    /**
-     * Creates an API error instance based on the provided error code.
+     * @param error - The error object.
      *
-     * @param errorCode - The error code.
-     * @returns An API error instance.
+     * @throws An error if the configured request timeout has been exceeded.
      */
-    ErrorService.prototype.createApiError = function (errorCode) {
-        return new ApiError_1.ApiError(errorCode, this.getApiErrorMessage(errorCode));
+    ErrorService.prototype.handleTimeoutError = function (error) {
+        if (error.code === 'ECONNABORTED') {
+            throw new TimeoutError_1.TimeoutError(error.message);
+        }
     };
     /**
-     * Retrieves the API error message based on the provided error code.
+     * The method called when an error response is received from Twitter API.
      *
-     * @param errorCode - The error code.
-     * @returns The API error message.
+     * @param error - The error caught while making HTTP request to Twitter API.
      */
-    ErrorService.prototype.getApiErrorMessage = function (errorCode) {
-        var errorCodeKey = (0, JsonUtils_1.findKeyByValue)(rettiwt_core_1.EErrorCodes, errorCode.toString());
-        return !!errorCodeKey && errorCodeKey in Api_1.EApiErrors
-            ? Api_1.EApiErrors[errorCodeKey]
-            : ErrorService.DEFAULT_ERROR_MESSAGE;
+    ErrorService.prototype.handle = function (error) {
+        if (!(0, axios_1.isAxiosError)(error)) {
+            throw error;
+        }
+        this.handleTimeoutError(error);
+        var axiosResponse = this.getAxiosResponse(error);
+        this.handleApiError(axiosResponse);
+        this.handleHttpError(axiosResponse);
     };
     /**
      * Error message used when the specific error type is not defined in the required enums.

package/dist/services/internal/ErrorService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ErrorService.js","sourceRoot":"","sources":["../../../src/services/internal/ErrorService.ts"],"names":[],"mappings":";;;;;;AAAA,WAAW;AACX,gDAAyD;AACzD,oDAAwD;AAKxD,QAAQ;AACR,uCAA6C;AAC7C,yCAA+C;AAC/C,6CAA2C;AAE3C,SAAS;AACT,yDAAwD;AACxD,2DAA0D;AAC1D,iEAAgE;AAEhE,yCAAyC;AAEzC;;;;GAIG;AACH;IAAA;IAqIA,CAAC;IA/HA;;;;OAIG;IACI,6BAAM,GAAb,UAAc,KAAc;QAC3B,IAAI,CAAC,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YAC/B,MAAM,KAAK,CAAC;SACZ;QAED,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/B,IAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACO,yCAAkB,GAA5B,UAA6B,KAAiB;QAC7C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClC,MAAM,IAAI,2BAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACtC;IACF,CAAC;IAED;;;;;;OAMG;IACO,uCAAgB,GAA1B,UAA2B,KAAiB;QAC3C,IAAI,KAAK,CAAC,QAAQ,EAAE;YACnB,OAAO,KAAK,CAAC,QAAQ,CAAC;SACtB;QAED,MAAM,KAAK,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACO,sCAAe,GAAzB,UAA0B,QAAuB;QAChD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACO,qCAAc,GAAxB,UAAyB,QAAuB;QAC/C,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO;SACP;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACO,sCAAe,GAAzB,UAA0B,UAAkB;QAC3C,OAAO,IAAI,qBAAS,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACO,0CAAmB,GAA7B,UAA8B,UAAkB;QAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;YACrD,CAAC,CAAC,kBAAW,CAAC,UAAU,CAAC;YACzB,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACO,mCAAY,GAAtB,UAAuB,QAAuB;QAC7C,IAAM,MAAM,GAAI,QAAQ,CAAC,IAAuC,CAAC,MAAM,CAAC;QAExE,OAAO,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACO,qCAAc,GAAxB,UAAyB,SAAiB;QACzC,OAAO,IAAI,mBAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACO,yCAAkB,GAA5B,UAA6B,SAAiB;QAC7C,IAAM,YAAY,GAAG,IAAA,0BAAc,EAAC,0BAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC,YAAY,IAAI,YAAY,IAAI,gBAAU;YAClD,CAAC,CAAC,gBAAU,CAAC,YAAuC,CAAC;YACrD,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAnID;;OAEG;IACuB,kCAAqB,GAAG,eAAe,CAAC;IAiInE,mBAAC;CAAA,AArID,IAqIC"}
+{"version":3,"file":"ErrorService.js","sourceRoot":"","sources":["../../../src/services/internal/ErrorService.ts"],"names":[],"mappings":";;;AAAA,+BAAgE;AAEhE,uCAA0D;AAC1D,yCAA+C;AAC/C,oDAAwD;AACxD,yDAAwD;AACxD,2DAA0D;AAC1D,iEAAgE;AAGhE;;;;GAIG;AACH;IAAA;IA+IA,CAAC;IAzIA;;;;;;OAMG;IACO,qCAAc,GAAxB,UAAyB,SAAiB;QACzC,OAAO,IAAI,mBAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACO,sCAAe,GAAzB,UAA0B,UAAkB;QAC3C,OAAO,IAAI,qBAAS,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACO,yCAAkB,GAA5B,UAA6B,SAAiB;QAC7C,IAAM,YAAY,GAAG,IAAA,0BAAc,EAAC,iBAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC,YAAY,IAAI,YAAY,IAAI,gBAAU;YAClD,CAAC,CAAC,gBAAU,CAAC,YAAuC,CAAC;YACrD,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACO,uCAAgB,GAA1B,UAA2B,KAAiB;QAC3C,IAAI,KAAK,CAAC,QAAQ,EAAE;YACnB,OAAO,KAAK,CAAC,QAAQ,CAAC;SACtB;QAED,MAAM,KAAK,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACO,mCAAY,GAAtB,UAAuB,QAAuB;QAC7C,IAAM,MAAM,GAAI,QAAQ,CAAC,IAAuC,CAAC,MAAM,CAAC;QAExE,OAAO,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACO,0CAAmB,GAA7B,UAA8B,UAAkB;QAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;YACrD,CAAC,CAAC,kBAAW,CAAC,UAAU,CAAC;YACzB,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACO,qCAAc,GAAxB,UAAyB,QAAuB;QAC/C,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO;SACP;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACO,sCAAe,GAAzB,UAA0B,QAAuB;QAChD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACO,yCAAkB,GAA5B,UAA6B,KAAiB;QAC7C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClC,MAAM,IAAI,2BAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACtC;IACF,CAAC;IAED;;;;OAIG;IACI,6BAAM,GAAb,UAAc,KAAc;QAC3B,IAAI,CAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,EAAE;YACzB,MAAM,KAAK,CAAC;SACZ;QAED,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/B,IAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACrC,CAAC;IA7ID;;OAEG;IACuB,kCAAqB,GAAG,eAAe,CAAC;IA2InE,mBAAC;CAAA,AA/ID,IA+IC"}

package/dist/services/internal/LogService.d.ts

@@ -6,17 +6,19 @@ import { ELogActions } from '../../enums/Logging';
  */
 export declare class LogService {
     /** Whether logging is enabled or not. */
-    private readonly enabled;
+    static enabled: boolean;
     /**
-     * Initializes a new LogService instance.
+     * @param action - The action to be logged.
      *
-     * @param enable - Whether to enable logging or not.
+     * @returns - The colored text representing the action.
      */
-    constructor(enable?: boolean);
+    private static getColoredAction;
     /**
      * Logs the given data.
      *
+     * @param action - The action to be logged.
+     *
      * @param data - The data to be logged.
      */
-    log(action: ELogActions, data: NonNullable<unknown>): void;
+    static log(action: ELogActions, data: NonNullable<unknown>): void;
 }

package/dist/services/internal/LogService.js

@@ -1,35 +1,54 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogService = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var Logging_1 = require("../../enums/Logging");
 /**
  * Handles logging of data for debug purpose.
  *
  * @internal
  */
-var LogService = /** @class */ (function () {
+var LogService = exports.LogService = /** @class */ (function () {
+    function LogService() {
+    }
     /**
-     * Initializes a new LogService instance.
+     * @param action - The action to be logged.
      *
-     * @param enable - Whether to enable logging or not.
+     * @returns - The colored text representing the action.
      */
-    function LogService(enable) {
-        this.enabled = enable !== null && enable !== void 0 ? enable : false;
-    }
+    LogService.getColoredAction = function (action) {
+        if (action == Logging_1.ELogActions.WARNING) {
+            return chalk_1.default.yellow(action);
+        }
+        else {
+            return chalk_1.default.green(action);
+        }
+    };
     /**
      * Logs the given data.
      *
+     * @param action - The action to be logged.
+     *
      * @param data - The data to be logged.
      */
-    LogService.prototype.log = function (action, data) {
+    LogService.log = function (action, data) {
         // Proceed to log only if logging is enabled
         if (this.enabled) {
             // Preparing the log message
-            var logMessage = "[Rettiwt-API] [".concat(action, "] [").concat(new Date().toISOString(), "] ").concat(JSON.stringify(data));
+            var logPrefix = chalk_1.default.blue('Rettiwt-API');
+            var logTime = new Date().toISOString();
+            var logAction = LogService.getColoredAction(action);
+            var logData = JSON.stringify(data);
+            var logMessage = "[".concat(logPrefix, "] [").concat(logTime, "] [").concat(logAction, "] ").concat(logData);
             // Logging
             console.log(logMessage);
         }
     };
+    /** Whether logging is enabled or not. */
+    LogService.enabled = false;
     return LogService;
 }());
-exports.LogService = LogService;
 //# sourceMappingURL=LogService.js.map

package/dist/services/internal/LogService.js.map

@@ -1 +1 @@
-{"version":3,"file":"LogService.js","sourceRoot":"","sources":["../../../src/services/internal/LogService.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAIC;;;;OAIG;IACH,oBAAmB,MAAgB;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,wBAAG,GAAV,UAAW,MAAmB,EAAE,IAA0B;QACzD,4CAA4C;QAC5C,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,4BAA4B;YAC5B,IAAM,UAAU,GAAW,yBAAkB,MAAM,gBAAM,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,eAAK,IAAI,CAAC,SAAS,CACnG,IAAI,CACJ,CAAE,CAAC;YAEJ,UAAU;YACV,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SACxB;IACF,CAAC;IACF,iBAAC;AAAD,CAAC,AA9BD,IA8BC;AA9BY,gCAAU"}
+{"version":3,"file":"LogService.js","sourceRoot":"","sources":["../../../src/services/internal/LogService.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA0B;AAE1B,+CAAkD;AAElD;;;;GAIG;AACH;IAAA;IAuCA,CAAC;IAnCA;;;;OAIG;IACY,2BAAgB,GAA/B,UAAgC,MAAmB;QAClD,IAAI,MAAM,IAAI,qBAAW,CAAC,OAAO,EAAE;YAClC,OAAO,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC5B;aAAM;YACN,OAAO,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SAC3B;IACF,CAAC;IAED;;;;;;OAMG;IACW,cAAG,GAAjB,UAAkB,MAAmB,EAAE,IAA0B;QAChE,4CAA4C;QAC5C,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,4BAA4B;YAC5B,IAAM,SAAS,GAAW,eAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACpD,IAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACjD,IAAM,SAAS,GAAW,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAM,OAAO,GAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE7C,IAAM,UAAU,GAAW,WAAI,SAAS,gBAAM,OAAO,gBAAM,SAAS,eAAK,OAAO,CAAE,CAAC;YAEnF,UAAU;YACV,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SACxB;IACF,CAAC;IArCD,yCAAyC;IAC3B,kBAAO,GAAY,KAAK,CAAC;IAqCxC,iBAAC;CAAA,AAvCD,IAuCC"}

package/dist/services/public/AuthService.d.ts

@@ -1,24 +1,21 @@
-import { FetcherService } from '../internal/FetcherService';
 import { IRettiwtConfig } from '../../types/RettiwtConfig';
+import { FetcherService } from './FetcherService';
 /**
- * Handles authentication.
+ * The services that handles authentication.
  *
  * @public
  */
 export declare class AuthService extends FetcherService {
     /**
-     * @param config - The config object for configuring the Rettiwt instance.
+     * @param config - The config object for configuring the `Rettiwt` instance.
      *
      * @internal
      */
     constructor(config?: IRettiwtConfig);
     /**
-     * Login to twitter using account credentials.
+     * Login to twitter as guest.
      *
-     * @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.
+     * @returns A new guest key.
      *
      * @example
      * ```
@@ -27,10 +24,10 @@ export declare class AuthService extends FetcherService {
      * // 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
+     * // Logging in an getting a new guest key
+     * rettiwt.auth.guest()
+     * .then(guestKey => {
+     * 	// Use the guest key
      * 	...
      * })
      * .catch(err => {
@@ -38,11 +35,15 @@ export declare class AuthService extends FetcherService {
      * });
      * ```
      */
-    login(email: string, userName: string, password: string): Promise<string>;
+    guest(): Promise<string>;
     /**
-     * Login to twitter as guest.
+     * Login to twitter using account credentials.
      *
-     * @returns A new guest key.
+     * @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
      * ```
@@ -51,16 +52,19 @@ export declare class AuthService extends FetcherService {
      * // 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
+     * // 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.
      */
-    guest(): Promise<string>;
+    login(email: string, userName: string, password: string): Promise<string>;
 }