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

package/dist/models/auth/AuthCredential.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthCredential = void 0;
+const axios_1 = require("axios");
+const Authentication_1 = require("../../enums/Authentication");
+const AuthCookie_1 = require("./AuthCookie");
+/**
+ * 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.
+ *
+ * @public
+ */
+class AuthCredential {
+    authToken;
+    authenticationType;
+    cookies;
+    csrfToken;
+    guestToken;
+    /**
+     * @param cookies - The list of cookies to be used for authenticating against Twitter.
+     * @param guestToken - The guest token to be used to authenticate a guest session.
+     */
+    constructor(cookies, guestToken) {
+        this.authToken =
+            'AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA';
+        // If guest credentials given
+        if (!cookies && guestToken) {
+            this.guestToken = guestToken;
+            this.authenticationType = Authentication_1.EAuthenticationType.GUEST;
+        }
+        // If login credentials given
+        else if (cookies && guestToken) {
+            // Parsing the cookies
+            const parsedCookie = new AuthCookie_1.AuthCookie(cookies);
+            this.cookies = parsedCookie.toString();
+            this.guestToken = guestToken;
+            this.authenticationType = Authentication_1.EAuthenticationType.LOGIN;
+        }
+        // If user credentials given
+        else if (cookies && !guestToken) {
+            // Parsing the cookies
+            const parsedCookie = new AuthCookie_1.AuthCookie(cookies);
+            this.cookies = parsedCookie.toString();
+            this.csrfToken = parsedCookie.ct0;
+            this.authenticationType = Authentication_1.EAuthenticationType.USER;
+        }
+    }
+    /**
+     * @returns The HTTP header representation of 'this' object.
+     */
+    toHeader() {
+        const headers = new axios_1.AxiosHeaders();
+        /**
+         * Conditionally initializing only those data which are supplied.
+         *
+         * This is done to ensure that the data that is not supplied, is not included in output, not even undefined.
+         */
+        if (this.authToken) {
+            headers.set('authorization', `Bearer ${this.authToken}`);
+        }
+        if (this.guestToken) {
+            headers.set('x-guest-token', this.guestToken);
+        }
+        if (this.csrfToken) {
+            headers.set('x-csrf-token', this.csrfToken);
+        }
+        if (this.cookies) {
+            headers.set('cookie', this.cookies);
+        }
+        return headers;
+    }
+}
+exports.AuthCredential = AuthCredential;
+//# sourceMappingURL=AuthCredential.js.map

package/dist/models/auth/AuthCredential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthCredential.js","sourceRoot":"","sources":["../../../src/models/auth/AuthCredential.ts"],"names":[],"mappings":";;;AAAA,iCAA0D;AAI1D,+DAAiE;AAGjE,6CAA0C;AAE1C;;;;;;;;;GASG;AACH,MAAa,cAAc;IACnB,SAAS,CAAU;IACnB,kBAAkB,CAAuB;IACzC,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,UAAU,CAAU;IAE3B;;;OAGG;IACH,YAAmB,OAAkB,EAAE,UAAmB;QACzD,IAAI,CAAC,SAAS;YACb,0GAA0G,CAAC;QAC5G,6BAA6B;QAC7B,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,oCAAmB,CAAC,KAAK,CAAC;QACrD,CAAC;QACD,6BAA6B;aACxB,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YAChC,sBAAsB;YACtB,MAAM,YAAY,GAAe,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,oCAAmB,CAAC,KAAK,CAAC;QACrD,CAAC;QACD,4BAA4B;aACvB,IAAI,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YACjC,sBAAsB;YACtB,MAAM,YAAY,GAAe,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;YAClC,IAAI,CAAC,kBAAkB,GAAG,oCAAmB,CAAC,IAAI,CAAC;QACpD,CAAC;IACF,CAAC;IAED;;OAEG;IACI,QAAQ;QACd,MAAM,OAAO,GAAG,IAAI,oBAAY,EAAE,CAAC;QAEnC;;;;WAIG;QACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AAjED,wCAiEC"}

package/dist/models/data/CursoredData.d.ts

@@ -1,4 +1,5 @@
 import { EBaseType } from '../../enums/Data';
+import { ICursoredData } from '../../types/data/CursoredData';
 import { Notification } from './Notification';
 import { Tweet } from './Tweet';
 import { User } from './User';
@@ -9,27 +10,16 @@ import { User } from './User';
  *
  * @public
  */
-export declare class CursoredData<T extends Notification | Tweet | User> {
-    /** The batch of data of the given type. */
+export declare class CursoredData<T extends Notification | Tweet | User> implements ICursoredData<T> {
     list: T[];
-    /** The cursor to the next batch of data. */
-    next: Cursor;
+    next: string;
     /**
      * @param response - The raw response.
      * @param type - The base type of the data included in the batch.
      */
     constructor(response: NonNullable<unknown>, type: EBaseType);
-}
-/**
- * The cursor to the batch of data to fetch.
- *
- * @public
- */
-export declare class Cursor {
-    /** The cursor string. */
-    value: string;
     /**
-     * @param cursor - The cursor string.
+     * @returns A serializable JSON representation of `this` object.
      */
-    constructor(cursor: string);
+    toJSON(): ICursoredData<T>;
 }

package/dist/models/data/CursoredData.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cursor = exports.CursoredData = void 0;
-var Data_1 = require("../../enums/Data");
-var JsonUtils_1 = require("../../helper/JsonUtils");
-var Notification_1 = require("./Notification");
-var Tweet_1 = require("./Tweet");
-var User_1 = require("./User");
+exports.CursoredData = void 0;
+const Data_1 = require("../../enums/Data");
+const JsonUtils_1 = require("../../helper/JsonUtils");
+const Notification_1 = require("./Notification");
+const Tweet_1 = require("./Tweet");
+const User_1 = require("./User");
 /**
  * The data that is fetched batch-wise using a cursor.
  *
@@ -13,46 +13,39 @@ var User_1 = require("./User");
  *
  * @public
  */
-var CursoredData = /** @class */ (function () {
+class CursoredData {
+    list;
+    next;
     /**
      * @param response - The raw response.
      * @param type - The base type of the data included in the batch.
      */
-    function CursoredData(response, type) {
-        var _a, _b, _c, _d, _e, _f;
-        /** The batch of data of the given type. */
+    constructor(response, type) {
+        // Initializing defaults
         this.list = [];
-        /** The cursor to the next batch of data. */
-        this.next = new Cursor('');
+        this.next = '';
         if (type == Data_1.EBaseType.TWEET) {
-            this.list = Tweet_1.Tweet.list(response);
-            this.next = new Cursor((_b = (_a = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Bottom')[0]) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : '');
+            this.list = Tweet_1.Tweet.timeline(response);
+            this.next = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Bottom')[0]?.value ?? '';
         }
         else if (type == Data_1.EBaseType.USER) {
-            this.list = User_1.User.list(response);
-            this.next = new Cursor((_d = (_c = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Bottom')[0]) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : '');
+            this.list = User_1.User.timeline(response);
+            this.next = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Bottom')[0]?.value ?? '';
         }
         else if (type == Data_1.EBaseType.NOTIFICATION) {
             this.list = Notification_1.Notification.list(response);
-            this.next = new Cursor((_f = (_e = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Top')[0]) === null || _e === void 0 ? void 0 : _e.value) !== null && _f !== void 0 ? _f : '');
+            this.next = (0, JsonUtils_1.findByFilter)(response, 'cursorType', 'Top')[0]?.value ?? '';
         }
     }
-    return CursoredData;
-}());
-exports.CursoredData = CursoredData;
-/**
- * The cursor to the batch of data to fetch.
- *
- * @public
- */
-var Cursor = /** @class */ (function () {
     /**
-     * @param cursor - The cursor string.
+     * @returns A serializable JSON representation of `this` object.
      */
-    function Cursor(cursor) {
-        this.value = cursor;
+    toJSON() {
+        return {
+            list: this.list.map((item) => item.toJSON()),
+            next: this.next,
+        };
     }
-    return Cursor;
-}());
-exports.Cursor = Cursor;
+}
+exports.CursoredData = CursoredData;
 //# sourceMappingURL=CursoredData.js.map

package/dist/models/data/CursoredData.js.map

@@ -1 +1 @@
-{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../../src/models/data/CursoredData.ts"],"names":[],"mappings":";;;AAEA,yCAA6C;AAE7C,oDAAsD;AAEtD,+CAA8C;AAC9C,iCAAgC;AAChC,+BAA8B;AAE9B;;;;;;GAMG;AACH;IAOC;;;OAGG;IACH,sBAAmB,QAA8B,EAAE,IAAe;;QAVlE,2CAA2C;QACpC,SAAI,GAAQ,EAAE,CAAC;QAEtB,4CAA4C;QACrC,SAAI,GAAW,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;QAOpC,IAAI,IAAI,IAAI,gBAAS,CAAC,KAAK,EAAE;YAC5B,IAAI,CAAC,IAAI,GAAG,aAAK,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAA,MAAA,IAAA,wBAAY,EAAU,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;SAChG;aAAM,IAAI,IAAI,IAAI,gBAAS,CAAC,IAAI,EAAE;YAClC,IAAI,CAAC,IAAI,GAAG,WAAI,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;YACvC,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAA,MAAA,IAAA,wBAAY,EAAU,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;SAChG;aAAM,IAAI,IAAI,IAAI,gBAAS,CAAC,YAAY,EAAE;YAC1C,IAAI,CAAC,IAAI,GAAG,2BAAY,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;YAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAA,MAAA,IAAA,wBAAY,EAAU,QAAQ,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;SAC7F;IACF,CAAC;IACF,mBAAC;AAAD,CAAC,AAvBD,IAuBC;AAvBY,oCAAY;AAyBzB;;;;GAIG;AACH;IAIC;;OAEG;IACH,gBAAmB,MAAc;QAChC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;IACrB,CAAC;IACF,aAAC;AAAD,CAAC,AAVD,IAUC;AAVY,wBAAM"}
+{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../../src/models/data/CursoredData.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,sDAAsD;AAKtD,iDAA8C;AAC9C,mCAAgC;AAChC,iCAA8B;AAE9B;;;;;;GAMG;AACH,MAAa,YAAY;IACjB,IAAI,CAAM;IACV,IAAI,CAAS;IAEpB;;;OAGG;IACH,YAAmB,QAA8B,EAAE,IAAe;QACjE,wBAAwB;QACxB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QAEf,IAAI,IAAI,IAAI,gBAAS,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,GAAG,aAAK,CAAC,QAAQ,CAAC,QAAQ,CAAQ,CAAC;YAC5C,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAY,EAAa,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACxF,CAAC;aAAM,IAAI,IAAI,IAAI,gBAAS,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,GAAG,WAAI,CAAC,QAAQ,CAAC,QAAQ,CAAQ,CAAC;YAC3C,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAY,EAAa,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACxF,CAAC;aAAM,IAAI,IAAI,IAAI,gBAAS,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,GAAG,2BAAY,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;YAC/C,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAY,EAAa,QAAQ,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACrF,CAAC;IACF,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC;YACjD,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AAlCD,oCAkCC"}

package/dist/models/data/List.d.ts

@@ -1,26 +1,24 @@
-import { IList as IRawList } from 'rettiwt-core';
+import { IList } from '../../types/data/List';
+import { IList as IRawList } from '../../types/raw/base/List';
 /**
  * The details of a single Twitter List.
  *
  * @public
  */
-export declare class List {
-    /** The date and time of creation of the list, int UTC string format. */
+export declare class List implements IList {
     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;
     /**
      * @param list - The raw list details.
      */
     constructor(list: IRawList);
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): IList;
 }

package/dist/models/data/List.js

@@ -6,11 +6,18 @@ exports.List = void 0;
  *
  * @public
  */
-var List = /** @class */ (function () {
+class List {
+    createdAt;
+    createdBy;
+    description;
+    id;
+    memberCount;
+    name;
+    subscriberCount;
     /**
      * @param list - The raw list details.
      */
-    function List(list) {
+    constructor(list) {
         this.id = list.id_str;
         this.name = list.name;
         this.createdAt = new Date(list.created_at).toISOString();
@@ -19,7 +26,20 @@ var List = /** @class */ (function () {
         this.subscriberCount = list.subscriber_count;
         this.createdBy = list.user_results.result.id;
     }
-    return List;
-}());
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            createdAt: this.createdAt,
+            createdBy: this.createdBy,
+            description: this.description,
+            id: this.id,
+            memberCount: this.memberCount,
+            name: this.name,
+            subscriberCount: this.subscriberCount,
+        };
+    }
+}
 exports.List = List;
 //# sourceMappingURL=List.js.map

package/dist/models/data/List.js.map

@@ -1 +1 @@
-{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/models/data/List.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH;IAsBC;;OAEG;IACH,cAAmB,IAAc;QAChC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9C,CAAC;IACF,WAAC;AAAD,CAAC,AAlCD,IAkCC;AAlCY,oBAAI"}
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/models/data/List.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH,MAAa,IAAI;IACT,SAAS,CAAS;IAClB,SAAS,CAAS;IAClB,WAAW,CAAU;IACrB,EAAE,CAAS;IACX,WAAW,CAAS;IACpB,IAAI,CAAS;IACb,eAAe,CAAS;IAE/B;;OAEG;IACH,YAAmB,IAAc;QAChC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,IAAI,CAAC,eAAe;SACrC,CAAC;IACH,CAAC;CACD;AApCD,oBAoCC"}

package/dist/models/data/Notification.d.ts

@@ -1,46 +1,32 @@
-import { INotification } from 'rettiwt-core';
-/**
- * The different types of notifications.
- *
- * @public
- */
-export declare enum ENotificationType {
-    RECOMMENDATION = "RECOMMENDATION",
-    INFORMATION = "INFORMATION",
-    LIVE = "LIVE",
-    ALERT = "ALERT",
-    UNDEFINED = "UNDEFINED"
-}
+import { ENotificationType } from '../../enums/Notification';
+import { INotification } from '../../types/data/Notification';
+import { INotification as IRawNotification } from '../../types/raw/base/Notification';
 /**
  * The details of a single notification.
  *
  * @public
  */
-export declare class Notification {
-    /** The list of id of the users from whom the notification was received. */
+export declare class Notification implements INotification {
     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. */
+    receivedAt: string;
     target: string[];
-    /** The type of notification. */
     type?: ENotificationType;
     /**
      * @param notification - The raw notification details.
      */
-    constructor(notification: INotification);
+    constructor(notification: IRawNotification);
     /**
      * Extracts and deserializes the list of notifications from the given raw response data.
      *
      * @param response - The raw response data.
      *
      * @returns The deserialized list of notifications.
-     *
-     * @internal
      */
     static list(response: NonNullable<unknown>): Notification[];
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): INotification;
 }

package/dist/models/data/Notification.js

@@ -1,46 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Notification = exports.ENotificationType = void 0;
-var rettiwt_core_1 = require("rettiwt-core");
-var JsonUtils_1 = require("../../helper/JsonUtils");
-/**
- * The different types of notifications.
- *
- * @public
- */
-var ENotificationType;
-(function (ENotificationType) {
-    ENotificationType["RECOMMENDATION"] = "RECOMMENDATION";
-    ENotificationType["INFORMATION"] = "INFORMATION";
-    ENotificationType["LIVE"] = "LIVE";
-    ENotificationType["ALERT"] = "ALERT";
-    ENotificationType["UNDEFINED"] = "UNDEFINED";
-})(ENotificationType || (exports.ENotificationType = ENotificationType = {}));
+exports.Notification = void 0;
+const Notification_1 = require("../../enums/Notification");
+const Notification_2 = require("../../enums/raw/Notification");
+const JsonUtils_1 = require("../../helper/JsonUtils");
 /**
  * The details of a single notification.
  *
  * @public
  */
-var Notification = /** @class */ (function () {
+class Notification {
+    from;
+    id;
+    message;
+    receivedAt;
+    target;
+    type;
     /**
      * @param notification - The raw notification details.
      */
-    function Notification(notification) {
-        var _a, _b, _c, _d;
+    constructor(notification) {
         // Getting the original notification type
-        var notificationType = (0, JsonUtils_1.findKeyByValue)(rettiwt_core_1.ENotificationType, notification.icon.id);
-        this.from = ((_b = (_a = notification.template) === null || _a === void 0 ? void 0 : _a.aggregateUserActionsV1) === null || _b === void 0 ? void 0 : _b.fromUsers)
-            ? notification.template.aggregateUserActionsV1.fromUsers.map(function (item) { return item.user.id; })
+        const notificationType = (0, JsonUtils_1.findKeyByValue)(Notification_2.ERawNotificationType, notification.icon.id);
+        this.from = notification.template?.aggregateUserActionsV1?.fromUsers
+            ? notification.template.aggregateUserActionsV1.fromUsers.map((item) => item.user.id)
             : [];
         this.id = notification.id;
         this.message = notification.message.text;
-        this.receivedAt = new Date(Number(notification.timestampMs));
-        this.target = ((_d = (_c = notification.template) === null || _c === void 0 ? void 0 : _c.aggregateUserActionsV1) === null || _d === void 0 ? void 0 : _d.targetObjects)
-            ? notification.template.aggregateUserActionsV1.targetObjects.map(function (item) { return item.tweet.id; })
+        this.receivedAt = new Date(Number(notification.timestampMs)).toISOString();
+        this.target = notification.template?.aggregateUserActionsV1?.targetObjects
+            ? notification.template.aggregateUserActionsV1.targetObjects.map((item) => item.tweet.id)
             : [];
         this.type = notificationType
-            ? ENotificationType[notificationType]
-            : ENotificationType.UNDEFINED;
+            ? Notification_1.ENotificationType[notificationType]
+            : Notification_1.ENotificationType.UNDEFINED;
     }
     /**
      * Extracts and deserializes the list of notifications from the given raw response data.
@@ -48,22 +41,31 @@ var Notification = /** @class */ (function () {
      * @param response - The raw response data.
      *
      * @returns The deserialized list of notifications.
-     *
-     * @internal
      */
-    Notification.list = function (response) {
-        var notifications = [];
+    static list(response) {
+        const notifications = [];
         // Extracting notifications
         if (response.globalObjects.notifications) {
             // Iterating over the raw list of notifications
-            for (var _i = 0, _a = Object.entries(response.globalObjects.notifications); _i < _a.length; _i++) {
-                var _b = _a[_i], value = _b[1];
+            for (const [, value] of Object.entries(response.globalObjects.notifications)) {
                 notifications.push(new Notification(value));
             }
         }
         return notifications;
-    };
-    return Notification;
-}());
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            from: this.from,
+            id: this.id,
+            message: this.message,
+            receivedAt: this.receivedAt,
+            target: this.target,
+            type: this.type,
+        };
+    }
+}
 exports.Notification = Notification;
 //# sourceMappingURL=Notification.js.map

package/dist/models/data/Notification.js.map

@@ -1 +1 @@
-{"version":3,"file":"Notification.js","sourceRoot":"","sources":["../../../src/models/data/Notification.ts"],"names":[],"mappings":";;;AAAA,6CAIsB;AAEtB,oDAAwD;AAExD;;;;GAIG;AACH,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC5B,sDAAiC,CAAA;IACjC,gDAA2B,CAAA;IAC3B,kCAAa,CAAA;IACb,oCAAe,CAAA;IACf,4CAAuB,CAAA;AACxB,CAAC,EANW,iBAAiB,iCAAjB,iBAAiB,QAM5B;AAED;;;;GAIG;AACH;IAmBC;;OAEG;IACH,sBAAmB,YAA2B;;QAC7C,yCAAyC;QACzC,IAAM,gBAAgB,GAAuB,IAAA,0BAAc,EAAC,gCAAyB,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE7G,IAAI,CAAC,IAAI,GAAG,CAAA,MAAA,MAAA,YAAY,CAAC,QAAQ,0CAAE,sBAAsB,0CAAE,SAAS;YACnE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,EAAE,EAAZ,CAAY,CAAC;YACpF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,CAAA,MAAA,MAAA,YAAY,CAAC,QAAQ,0CAAE,sBAAsB,0CAAE,aAAa;YACzE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,KAAK,CAAC,EAAE,EAAb,CAAa,CAAC;YACzF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,IAAI,GAAG,gBAAgB;YAC3B,CAAC,CAAC,iBAAiB,CAAC,gBAAkD,CAAC;YACvE,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACW,iBAAI,GAAlB,UAAmB,QAA8B;QAChD,IAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,2BAA2B;QAC3B,IAAK,QAAuC,CAAC,aAAa,CAAC,aAAa,EAAE;YACzE,+CAA+C;YAC/C,KAAwB,UAEvB,EAFuB,KAAA,MAAM,CAAC,OAAO,CACpC,QAAuC,CAAC,aAAa,CAAC,aAAa,CACpE,EAFuB,cAEvB,EAFuB,IAEvB,EAAE;gBAFQ,IAAA,WAAS,EAAN,KAAK,QAAA;gBAGlB,aAAa,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,KAAsB,CAAC,CAAC,CAAC;aAC7D;SACD;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;IACF,mBAAC;AAAD,CAAC,AAhED,IAgEC;AAhEY,oCAAY"}
+{"version":3,"file":"Notification.js","sourceRoot":"","sources":["../../../src/models/data/Notification.ts"],"names":[],"mappings":";;;AAAA,2DAA6D;AAC7D,+DAAoE;AACpE,sDAAwD;AAKxD;;;;GAIG;AACH,MAAa,YAAY;IACjB,IAAI,CAAW;IACf,EAAE,CAAS;IACX,OAAO,CAAS;IAChB,UAAU,CAAS;IACnB,MAAM,CAAW;IACjB,IAAI,CAAqB;IAEhC;;OAEG;IACH,YAAmB,YAA8B;QAChD,yCAAyC;QACzC,MAAM,gBAAgB,GAAuB,IAAA,0BAAc,EAAC,mCAAoB,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAExG,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,QAAQ,EAAE,sBAAsB,EAAE,SAAS;YACnE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3E,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,sBAAsB,EAAE,aAAa;YACzE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACzF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,IAAI,GAAG,gBAAgB;YAC3B,CAAC,CAAC,gCAAiB,CAAC,gBAAkD,CAAC;YACvE,CAAC,CAAC,gCAAiB,CAAC,SAAS,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,QAA8B;QAChD,MAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,2BAA2B;QAC3B,IAAK,QAAuC,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;YAC1E,+CAA+C;YAC/C,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CACpC,QAAuC,CAAC,aAAa,CAAC,aAAa,CACpE,EAAE,CAAC;gBACH,aAAa,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,KAAyB,CAAC,CAAC,CAAC;YACjE,CAAC;QACF,CAAC;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AAjED,oCAiEC"}

package/dist/models/data/Tweet.d.ts

@@ -1,54 +1,40 @@
-import { EMediaType, IExtendedMedia as IRawExtendedMedia, ITweet as IRawTweet, IEntities as IRawTweetEntities } from 'rettiwt-core';
+import { EMediaType } from '../../enums/Media';
+import { ITweet, ITweetEntities, ITweetMedia } from '../../types/data/Tweet';
+import { IExtendedMedia as IRawExtendedMedia } from '../../types/raw/base/Media';
+import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from '../../types/raw/base/Tweet';
 import { User } from './User';
 /**
  * The details of a single tweet.
  *
  * @public
  */
-export declare class Tweet {
-    /** The number of bookmarks of a tweet. */
+export declare class Tweet implements ITweet {
     bookmarkCount: number;
-    /** The date and time of creation of the tweet, in UTC string format. */
+    conversationId: string;
     createdAt: string;
-    /** Additional tweet entities like urls, mentions, etc. */
     entities: TweetEntities;
-    /** 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?: TweetMedia[];
-    /** The number of quotes of the tweet. */
     quoteCount: number;
-    /** The tweet which is quoted in the tweet. */
     quoted?: Tweet;
-    /** The number of replies to the tweet. */
     replyCount: number;
-    /** The rest id of the tweet to which the tweet is a reply. */
-    replyTo?: Tweet;
-    /** The number of retweets of the tweet. */
+    replyTo?: string;
     retweetCount: number;
-    /** The tweet which is retweeted in this tweet (if any). */
     retweetedTweet?: Tweet;
-    /** The details of the user who made the tweet. */
     tweetBy: User;
-    /** The number of views of a tweet. */
+    url: string;
     viewCount: number;
     /**
      * @param tweet - The raw tweet details.
-     * @param response - The raw response
      */
-    constructor(tweet: IRawTweet, response: NonNullable<unknown>);
-    private getParentTweet;
+    constructor(tweet: IRawTweet);
     /**
      * Extract and deserialize the original quoted tweet from the given raw tweet.
      *
      * @param tweet - The raw tweet.
-     * @param response - The raw response
      *
      * @returns - The deserialized original quoted tweet.
      */
@@ -57,21 +43,19 @@ export declare class Tweet {
      * Extract and deserialize the original retweeted tweet from the given raw tweet.
      *
      * @param tweet - The raw tweet.
-     * @param response - The raw response
      *
      * @returns - The deserialized original retweeted tweet.
      */
     private getRetweetedTweet;
     /**
-     * Extracts and deserializes the list of tweets from the given raw response data.
+     * Extracts and deserializes multiple target tweets from the given raw response data.
      *
      * @param response - The raw response data.
+     * @param ids - The ids of the target tweets.
      *
-     * @returns The deserialized list of tweets.
-     *
-     * @internal
+     * @returns The target deserialized tweets.
      */
-    static list(response: NonNullable<unknown>): Tweet[];
+    static multiple(response: NonNullable<unknown>, ids: string[]): Tweet[];
     /**
      * Extracts and deserializes a single target tweet from the given raw response data.
      *
@@ -79,10 +63,21 @@ export declare class Tweet {
      * @param id - The id of the target tweet.
      *
      * @returns The target deserialized tweet.
-     *
-     * @internal
      */
     static single(response: NonNullable<unknown>, id: string): Tweet | undefined;
+    /**
+     * Extracts and deserializes the timeline of tweets from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The IDs of specific tweets that need to be extracted.
+     *
+     * @returns The deserialized timeline of tweets.
+     */
+    static timeline(response: NonNullable<unknown>): Tweet[];
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweet;
 }
 /**
  * The different types parsed entities like urls, media, mentions, hashtags, etc.
@@ -100,6 +95,10 @@ export declare class TweetEntities {
      * @param entities - The raw tweet entities.
      */
     constructor(entities: IRawTweetEntities);
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweetEntities;
 }
 /**
  * The details of a single media content included in a tweet.
@@ -117,4 +116,8 @@ export declare class TweetMedia {
      * @param media - The raw media details.
      */
     constructor(media: IRawExtendedMedia);
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweetMedia;
 }