rettiwt-api 2.2.2 → 2.3.1

package/.eslintrc.js

@@ -41,6 +41,7 @@ module.exports = {
 		],
 		'@typescript-eslint/explicit-function-return-type': 'error',
 		'@typescript-eslint/explicit-module-boundary-types': 'error',
+		'@typescript-eslint/explicit-member-accessibility': 'error',
 		'@typescript-eslint/no-explicit-any': 'warn',
 		'@typescript-eslint/no-extraneous-class': [
 			'warn',

package/README.md

@@ -18,26 +18,21 @@ Although the above process initializes a new project, that is, in fact, not nece
 
 ## Getting started
 
-1. Generate credentials using [rettiwt-auth](https://www.npmjs.com/package/rettiwt-auth) package, by following these [steps](https://rishikant181.github.io/Rettiwt-Auth/#md:cli-usage).
-2. Copy the value of the 'cookies' field from the generated credentials and store it somewhere safe. Let's call this our API_KEY.
-3. Create a new instance of Rettiwt, passing in the API key:  
-   `const rettiwt = Rettiwt(API_KEY);`
+1. Generate credentials using [rettiwt-auth](https://www.npmjs.com/package/rettiwt-auth) package, by following these [steps](https://rishikant181.github.io/Rettiwt-Auth/#md:1-generating-credentials-as-an-api-key-for-use-with-rettiwt-api).
+2. The generated string is the API_KEY.
+3. Create a new instance of Rettiwt, passing in the API key as a config object:  
+   `const rettiwt = Rettiwt({ apiKey: API_KEY });`  
+   The available options in the config object can be found [here](https://rishikant181.github.io/Rettiwt-API/classes/RettiwtConfig.html).
 4. Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/classes/Rettiwt.html) instance to fetch data from Twitter.
 
-**Note:** The API_KEY (cookie) that we generated, is a very sensitive information and provides all access to the Twitter account. Therefore, it is generally recommended to store it as an environment variable and use it from there.
+**Notes:**
 
-## Using a proxy
-
-For masking of IP address using a proxy server, use the following code snippet for instantiation of Rettiwt:
-
-```
-/**
- * proxyUrl is the URL or configuration for the proxy server you want to use.`
- */
-const rettiwt = Rettiwt(API_KEY, proxyUrl);
-```
+-   The API_KEY that we generated, is a very sensitive information and provides all access to the Twitter account. Therefore, it is generally recommended to store it as an environment variable and use it from there.
 
-This creates a Rettiwt instance which uses the given proxy server for making requests to Twitter.
+-   It's also possible to use this package without using a Twitter account, by omitting the 'apiKey' parameter in the config object. However, in this case, functionality is limited to accessing only the following resources:
+    -   Getting the details of a user (by username)
+    -   Getting the details of a tweet
+    -   Getting the tweet timeline of a user (only most recent 100 entries)
 
 ## Usage
 
@@ -49,7 +44,7 @@ The following examples may help you to get started using the library:
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
-const rettiwt = new Rettiwt(API_KEY);
+const rettiwt = new Rettiwt({ apiKey: API_KEY });
 
 // Fetching the details of the user whose username is <username>
 rettiwt.user.details('<username>')
@@ -67,7 +62,7 @@ rettiwt.user.details('<username>')
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
-const rettiwt = new Rettiwt(API_KEY);
+const rettiwt = new Rettiwt({ apiKey: API_KEY });
 
 /**
  * Fetching the list of tweets that:
@@ -94,7 +89,7 @@ The previous example fetches the the list of tweets matching the given filter. S
 const { Rettiwt } = require('rettiwt-api');
 
 // Creating a new Rettiwt instance using the API_KEY
-const rettiwt = new Rettiwt(API_KEY);
+const rettiwt = new Rettiwt({ apiKey: API_KEY });
 
 /**
  * Fetching the list of tweets that:
@@ -115,7 +110,31 @@ rettiwt.tweet.search({
 });
 ```
 
-For more information regarding the different available filter options, please refer to [TweetFilter](https://rishikant181.github.io/Rettiwt-API/classes/TweetFilter.html).
+For more information regarding the different available filter options, please refer to [TweetFilter](https://rishikant181.github.io/Rettiwt-Core/classes/TweetFilter.html).
+
+## Using a proxy
+
+For masking of IP address using a proxy server, use the following code snippet for instantiation of Rettiwt:
+
+```
+/**
+ * PROXY_URL is the URL or configuration for the proxy server you want to use.`
+ */
+const rettiwt = Rettiwt({ apiKey: API_KEY, proxyUrl: PROXY_URL });
+```
+
+This creates a Rettiwt instance which uses the given proxy server for making requests to Twitter.
+
+## Debug logs
+
+Sometimes, when the library shows unexpected behaviour, for troubleshooting purposes, debug logs can be enabled which will help in tracking down the issue and working on a potential fix. Currently, debug logs are printed to the console and are enabled by setting the 'logging' property of the config to true, while creating an instance of Rettiwt:
+
+```
+/**
+ * By default, is no value for 'logging' is supplied, logging is disabled.
+ */
+const rettiwt = Rettiwt({ apiKey: API_KEY, logging: true });
+```
 
 ## Features
 
@@ -138,7 +157,8 @@ So far, the following operations are supported:
 -   [Getting the list of users who follow the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#followers)
 -   [Getting the list of users who are followed by the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#following)
 -   [Getting the list of tweets favorited/liked by the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#likes)
--   [Getting the timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#timeline)
+-   [Getting the tweet timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#timeline)
+-   [Getting the reply timeline of a user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#replies)
 
 ## API Reference
 
@@ -147,5 +167,4 @@ The complete API reference can be found at [this](https://rishikant181.github.io
 ## Additional information
 
 -   This API uses the cookies of a Twitter account to fetch data from Twitter and as such, there is always a chance (altough a measly one) of getting the account banned by Twitter algorithm.
--   From personal experience, not a single one of my accounts has ever been banned by using this library, and this is coming from someone who has been using his primary Twitter account to fetch large amounts of data from Twitter for over 1.5 years now, since the conception of this project.
 -   There have been no reports of accounts getting banned, but you have been warned, even though the chances of getting banned is negligible, it is not zero!

package/dist/Rettiwt.d.ts

@@ -1,5 +1,6 @@
-import { TweetService } from './services/TweetService';
-import { UserService } from './services/UserService';
+import { TweetService } from './services/public/TweetService';
+import { UserService } from './services/public/UserService';
+import { RettiwtConfig } from './models/internal/RettiwtConfig';
 /**
  * The class for fetching data from Twitter.
  *
@@ -13,8 +14,7 @@ export declare class Rettiwt {
     /**
      * Initializes a new Rettiwt instance using the given api key.
      *
-     * @param apiKey - The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.
-     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
+     * @param config - The config object for configuring the Rettiwt instance.
      */
-    constructor(apiKey: string, proxyUrl?: URL);
+    constructor(config?: RettiwtConfig);
 }

package/dist/Rettiwt.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rettiwt = void 0;
 // SERVICES
-var TweetService_1 = require("./services/TweetService");
-var UserService_1 = require("./services/UserService");
+var TweetService_1 = require("./services/public/TweetService");
+var UserService_1 = require("./services/public/UserService");
 /**
  * The class for fetching data from Twitter.
  *
@@ -13,12 +13,11 @@ var Rettiwt = /** @class */ (function () {
     /**
      * Initializes a new Rettiwt instance using the given api key.
      *
-     * @param apiKey - The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.
-     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
+     * @param config - The config object for configuring the Rettiwt instance.
      */
-    function Rettiwt(apiKey, proxyUrl) {
-        this.tweet = new TweetService_1.TweetService(apiKey, proxyUrl);
-        this.user = new UserService_1.UserService(apiKey, proxyUrl);
+    function Rettiwt(config) {
+        this.tweet = new TweetService_1.TweetService(config);
+        this.user = new UserService_1.UserService(config);
     }
     return Rettiwt;
 }());

package/dist/Rettiwt.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,wDAAuD;AACvD,sDAAqD;AAErD;;;;GAIG;AACH;IAOC;;;;;OAKG;IACH,iBAAY,MAAc,EAAE,QAAc;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IACF,cAAC;AAAD,CAAC,AAjBD,IAiBC;AAjBY,0BAAO"}
+{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,+DAA8D;AAC9D,6DAA4D;AAK5D;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,iBAAmB,MAAsB;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACF,cAAC;AAAD,CAAC,AAhBD,IAgBC;AAhBY,0BAAO"}

package/dist/enums/Logging.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The different types of actions that are logged.
+ *
+ * @internal
+ */
+export declare enum ELogActions {
+    FETCH = "FETCH",
+    POST = "POST",
+    EXTRACT = "EXTRACT",
+    DESERIALIZE = "DESERIALIZE",
+    AUTHORIZATION = "AUTHORIZATION"
+}

package/dist/enums/Logging.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ELogActions = void 0;
+/**
+ * The different types of actions that are logged.
+ *
+ * @internal
+ */
+var ELogActions;
+(function (ELogActions) {
+    ELogActions["FETCH"] = "FETCH";
+    ELogActions["POST"] = "POST";
+    ELogActions["EXTRACT"] = "EXTRACT";
+    ELogActions["DESERIALIZE"] = "DESERIALIZE";
+    ELogActions["AUTHORIZATION"] = "AUTHORIZATION";
+})(ELogActions || (exports.ELogActions = ELogActions = {}));
+//# sourceMappingURL=Logging.js.map

package/dist/enums/Logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../src/enums/Logging.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,WAMX;AAND,WAAY,WAAW;IACtB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,0CAA2B,CAAA;IAC3B,8CAA+B,CAAA;AAChC,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB"}

package/dist/index.d.ts

@@ -1,14 +1,18 @@
 export * from './Rettiwt';
 export * from './enums/ApiErrors';
 export * from './enums/HTTP';
-export * from './models/CursoredData';
-export * from './models/List';
-export * from './models/Tweet';
-export * from './models/User';
-export * from './services/FetcherService';
-export * from './services/TweetService';
-export * from './services/UserService';
-export * from './types/CursoredData';
-export * from './types/List';
-export * from './types/Tweet';
-export * from './types/User';
+export * from './enums/Logging';
+export * from './models/internal/RettiwtConfig';
+export * from './models/public/CursoredData';
+export * from './models/public/List';
+export * from './models/public/Tweet';
+export * from './models/public/User';
+export * from './services/internal/FetcherService';
+export * from './services/internal/LogService';
+export * from './services/public/TweetService';
+export * from './services/public/UserService';
+export * from './types/internal/RettiwtConfig';
+export * from './types/public/CursoredData';
+export * from './types/public/List';
+export * from './types/public/Tweet';
+export * from './types/public/User';

package/dist/index.js

@@ -19,18 +19,22 @@ __exportStar(require("./Rettiwt"), exports);
 // Exporting enums
 __exportStar(require("./enums/ApiErrors"), exports);
 __exportStar(require("./enums/HTTP"), exports);
+__exportStar(require("./enums/Logging"), exports);
 // Exporting models
-__exportStar(require("./models/CursoredData"), exports);
-__exportStar(require("./models/List"), exports);
-__exportStar(require("./models/Tweet"), exports);
-__exportStar(require("./models/User"), exports);
+__exportStar(require("./models/internal/RettiwtConfig"), exports);
+__exportStar(require("./models/public/CursoredData"), exports);
+__exportStar(require("./models/public/List"), exports);
+__exportStar(require("./models/public/Tweet"), exports);
+__exportStar(require("./models/public/User"), exports);
 // Exporting services
-__exportStar(require("./services/FetcherService"), exports);
-__exportStar(require("./services/TweetService"), exports);
-__exportStar(require("./services/UserService"), exports);
+__exportStar(require("./services/internal/FetcherService"), exports);
+__exportStar(require("./services/internal/LogService"), exports);
+__exportStar(require("./services/public/TweetService"), exports);
+__exportStar(require("./services/public/UserService"), exports);
 // Exporting types
-__exportStar(require("./types/CursoredData"), exports);
-__exportStar(require("./types/List"), exports);
-__exportStar(require("./types/Tweet"), exports);
-__exportStar(require("./types/User"), exports);
+__exportStar(require("./types/internal/RettiwtConfig"), exports);
+__exportStar(require("./types/public/CursoredData"), exports);
+__exportStar(require("./types/public/List"), exports);
+__exportStar(require("./types/public/Tweet"), exports);
+__exportStar(require("./types/public/User"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,kBAAkB;AAClB,oDAAkC;AAClC,+CAA6B;AAE7B,mBAAmB;AACnB,wDAAsC;AACtC,gDAA8B;AAC9B,iDAA+B;AAC/B,gDAA8B;AAE9B,qBAAqB;AACrB,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AAEvC,kBAAkB;AAClB,uDAAqC;AACrC,+CAA6B;AAC7B,gDAA8B;AAC9B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO;AACP,4CAA0B;AAE1B,kBAAkB;AAClB,oDAAkC;AAClC,+CAA6B;AAC7B,kDAAgC;AAEhC,mBAAmB;AACnB,kEAAgD;AAChD,+DAA6C;AAC7C,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AAErC,qBAAqB;AACrB,qEAAmD;AACnD,iEAA+C;AAC/C,iEAA+C;AAC/C,gEAA8C;AAE9C,kBAAkB;AAClB,iEAA+C;AAC/C,8DAA4C;AAC5C,sDAAoC;AACpC,uDAAqC;AACrC,sDAAoC"}

package/dist/models/internal/RettiwtConfig.d.ts

@@ -0,0 +1,20 @@
+import { IRettiwtConfig } from '../../types/internal/RettiwtConfig';
+/**
+ * The configuration for initializing a new Rettiwt instance.
+ *
+ * @internal
+ */
+export declare class RettiwtConfig implements IRettiwtConfig {
+    /** The apiKey (cookie) to use for authenticating Rettiwt against Twitter API. */
+    apiKey?: string;
+    /** Optional URL with proxy configuration to use for requests to Twitter API. */
+    proxyUrl?: URL;
+    /** Whether to write logs to console or not. */
+    logging?: boolean;
+    /**
+     * Initializes a new configuration object from the given config.
+     *
+     * @param config - The configuration object.
+     */
+    constructor(config: RettiwtConfig);
+}

package/dist/models/internal/RettiwtConfig.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RettiwtConfig = void 0;
+/**
+ * The configuration for initializing a new Rettiwt instance.
+ *
+ * @internal
+ */
+var RettiwtConfig = /** @class */ (function () {
+    /**
+     * Initializes a new configuration object from the given config.
+     *
+     * @param config - The configuration object.
+     */
+    function RettiwtConfig(config) {
+        this.apiKey = config.apiKey;
+        this.proxyUrl = config.proxyUrl;
+        this.logging = config.logging;
+    }
+    return RettiwtConfig;
+}());
+exports.RettiwtConfig = RettiwtConfig;
+//# sourceMappingURL=RettiwtConfig.js.map

package/dist/models/internal/RettiwtConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RettiwtConfig.js","sourceRoot":"","sources":["../../../src/models/internal/RettiwtConfig.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAUC;;;;OAIG;IACH,uBAAmB,MAAqB;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,CAAC;IACF,oBAAC;AAAD,CAAC,AApBD,IAoBC;AApBY,sCAAa"}

package/dist/models/{CursoredData.d.ts → public/CursoredData.d.ts}

@@ -1,7 +1,6 @@
-import { ITweet as IRawTweet, IUser as IRawUser } from 'rettiwt-core';
 import { Tweet } from './Tweet';
 import { User } from './User';
-import { ICursor, ICursoredData } from '../types/CursoredData';
+import { ICursor, ICursoredData } from '../../types/public/CursoredData';
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -18,7 +17,7 @@ export declare class CursoredData<T extends Tweet | User> implements ICursoredDa
      * @param list - The list of data item to store.
      * @param next - The cursor to the next batch of data.
      */
-    constructor(list?: (IRawTweet | IRawUser)[], next?: string);
+    constructor(list?: T[], next?: string);
 }
 /**
  * The cursor to the batch of data to be fetched.

package/dist/models/{CursoredData.js → public/CursoredData.js}

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cursor = exports.CursoredData = void 0;
-// MODELS
-var Tweet_1 = require("./Tweet");
-var User_1 = require("./User");
 /**
  * The data that us fetched batch-wise along with a cursor.
  *
@@ -21,19 +18,7 @@ var CursoredData = /** @class */ (function () {
         if (next === void 0) { next = ''; }
         /** The list of data of the given type. */
         this.list = [];
-        // Deserializing the input raw data and storing it in the list
-        for (var _i = 0, list_1 = list; _i < list_1.length; _i++) {
-            var item = list_1[_i];
-            // If the item is a valid raw tweet
-            if (item && item.__typename == 'Tweet' && item.rest_id) {
-                this.list.push(new Tweet_1.Tweet(item));
-            }
-            // If the item is a valid raw user
-            else if (item && item.__typename == 'User' && item.rest_id && item.id) {
-                this.list.push(new User_1.User(item));
-            }
-        }
-        // Initializing cursors
+        this.list = list;
         this.next = new Cursor(next);
     }
     return CursoredData;

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

@@ -0,0 +1 @@
+{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../../src/models/public/CursoredData.ts"],"names":[],"mappings":";;;AAOA;;;;;;GAMG;AACH;IAOC;;;OAGG;IACH,sBAAmB,IAAc,EAAE,IAAiB;QAAjC,qBAAA,EAAA,SAAc;QAAE,qBAAA,EAAA,SAAiB;QAVpD,0CAA0C;QACnC,SAAI,GAAQ,EAAE,CAAC;QAUrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACF,mBAAC;AAAD,CAAC,AAfD,IAeC;AAfY,oCAAY;AAiBzB;;;;GAIG;AACH;IAIC;;;;OAIG;IACH,gBAAmB,SAAiB;QACnC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IACxB,CAAC;IACF,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM"}

package/dist/models/{List.d.ts → public/List.d.ts}

@@ -1,5 +1,5 @@
 import { IList as IRawList } from 'rettiwt-core';
-import { IList } from '../types/List';
+import { IList } from '../../types/public/List';
 /**
  * The details of a single Twitter List.
  *

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

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/models/public/List.ts"],"names":[],"mappings":";;;AAMA;;;;GAIG;AACH;IAsBC;;;;OAIG;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;QACpC,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,AApCD,IAoCC;AApCY,oBAAI"}

package/dist/models/{Tweet.d.ts → public/Tweet.d.ts}

@@ -1,5 +1,5 @@
 import { ITweet as IRawTweet, IEntities as IRawTweetEntities, IExtendedMedia as IRawExtendedMedia, EMediaType } from 'rettiwt-core';
-import { ITweet, ITweetEntities } from '../types/Tweet';
+import { ITweet, ITweetEntities } from '../../types/public/Tweet';
 import { User } from './User';
 /**
  * The details of a single Tweet.

package/dist/models/{Tweet.js → public/Tweet.js}

@@ -6,7 +6,7 @@ var rettiwt_core_1 = require("rettiwt-core");
 // MODELS
 var User_1 = require("./User");
 // PARSERS
-var JsonUtils_1 = require("../helper/JsonUtils");
+var JsonUtils_1 = require("../../helper/JsonUtils");
 /**
  * The details of a single Tweet.
  *

package/dist/models/public/Tweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../src/models/public/Tweet.ts"],"names":[],"mappings":";;;AAAA,WAAW;AACX,6CAKsB;AAKtB,SAAS;AACT,+BAA8B;AAE9B,UAAU;AACV,oDAAuD;AAEvD;;;;GAIG;AACH;IA8CC;;;;OAIG;IACH,eAAmB,KAAgB;;QAClC,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,WAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,GAAG,MAAA,MAAA,KAAK,CAAC,MAAM,CAAC,iBAAiB,0CAAE,KAAK,0CAAE,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,IAAI,UAAU,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,CAAC;QAC1F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;IAClD,CAAC;IACF,YAAC;AAAD,CAAC,AApED,IAoEC;AApEY,sBAAK;AAsElB;;;;GAIG;AACH;IAUC;;;;OAIG;IACH,uBAAmB,QAA2B;QAd9C,mDAAmD;QAC5C,aAAQ,GAAa,EAAE,CAAC;QAE/B,+CAA+C;QACxC,SAAI,GAAa,EAAE,CAAC;QAE3B,uDAAuD;QAChD,mBAAc,GAAa,EAAE,CAAC;QAQpC,2BAA2B;QAC3B,IAAI,QAAQ,CAAC,aAAa,EAAE;YAC3B,KAAmB,UAAsB,EAAtB,KAAA,QAAQ,CAAC,aAAa,EAAtB,cAAsB,EAAtB,IAAsB,EAAE;gBAAtC,IAAM,IAAI,SAAA;gBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC3C;SACD;QAED,kBAAkB;QAClB,IAAI,QAAQ,CAAC,IAAI,EAAE;YAClB,KAAkB,UAAa,EAAb,KAAA,QAAQ,CAAC,IAAI,EAAb,cAAa,EAAb,IAAa,EAAE;gBAA5B,IAAM,GAAG,SAAA;gBACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;aACjC;SACD;QAED,sBAAsB;QACtB,IAAI,QAAQ,CAAC,QAAQ,EAAE;YACtB,KAAsB,UAAiB,EAAjB,KAAA,QAAQ,CAAC,QAAQ,EAAjB,cAAiB,EAAjB,IAAiB,EAAE;gBAApC,IAAM,OAAO,SAAA;gBACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC;SACD;IACF,CAAC;IACF,oBAAC;AAAD,CAAC,AArCD,IAqCC;AArCY,sCAAa;AAuC1B;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,oBAAmB,KAAwB;QAA3C,iBA0BC;;QAlCD,mCAAmC;QAC5B,QAAG,GAAW,EAAE,CAAC;QAQvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEvB,0BAA0B;QAC1B,IAAI,KAAK,CAAC,IAAI,IAAI,yBAAU,CAAC,KAAK,EAAE;YACnC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC;SACjC;QACD,wBAAwB;aACnB,IAAI,KAAK,CAAC,IAAI,IAAI,yBAAU,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,UAAU,0CAAE,QAAQ,CAAC,CAAC,EAAE,GAAa,CAAC;SACvD;QACD,0BAA0B;aACrB;YACJ,2CAA2C;YAC3C,IAAI,aAAW,GAAW,CAAC,CAAC;YAE5B;;eAEG;YACH,MAAA,KAAK,CAAC,UAAU,0CAAE,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO;gBAC1C,IAAI,OAAO,CAAC,OAAO,GAAG,aAAW,EAAE;oBAClC,aAAW,GAAG,OAAO,CAAC,OAAO,CAAC;oBAC9B,KAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;iBACvB;YACF,CAAC,CAAC,CAAC;SACH;IACF,CAAC;IACF,iBAAC;AAAD,CAAC,AAvCD,IAuCC;AAvCY,gCAAU"}

package/dist/models/{User.d.ts → public/User.d.ts}

@@ -1,5 +1,5 @@
 import { IUser as IRawUser } from 'rettiwt-core';
-import { IUser } from '../types/User';
+import { IUser } from '../../types/public/User';
 /**
  * The details of a single user.
  *

package/dist/models/public/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/models/public/User.ts"],"names":[],"mappings":";;;AAMA;;;;GAIG;AACH;IA2CC;;;;OAIG;IACH,cAAmB,IAAc;QAChC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACzD,CAAC;IACF,WAAC;AAAD,CAAC,AAhED,IAgEC;AAhEY,oBAAI"}

package/dist/services/{FetcherService.d.ts → internal/FetcherService.d.ts}

@@ -1,7 +1,8 @@
 import { Args, EResourceType } from 'rettiwt-core';
-import { CursoredData } from '../models/CursoredData';
-import { Tweet } from '../models/Tweet';
-import { User } from '../models/User';
+import { RettiwtConfig } from '../../models/internal/RettiwtConfig';
+import { CursoredData } from '../../models/public/CursoredData';
+import { Tweet } from '../../models/public/Tweet';
+import { User } from '../../models/public/User';
 /**
  * The base service that handles all HTTP requests.
  *
@@ -9,14 +10,17 @@ import { User } from '../models/User';
  */
 export declare class FetcherService {
     /** The credential to use for authenticating against Twitter API. */
-    private cred;
+    private cred?;
+    /** Whether the instance is authenticated or not. */
+    private readonly isAuthenticated;
     /** The HTTPS Agent to use for requests to Twitter API. */
     private readonly httpsAgent;
+    /** The log service instance to use to logging. */
+    private readonly logger;
     /**
-     * @param apiKey - The apiKey (cookie) to use for authenticating Rettiwt against Twitter API.
-     * @param proxyUrl - Optional URL with proxy configuration to use for requests to Twitter API.
+     * @param config - The config object for configuring the Rettiwt instance.
      */
-    constructor(apiKey: string, proxyUrl?: URL);
+    constructor(config?: RettiwtConfig);
     /**
      * Returns an AuthCredential generated using the given API key.
      *
@@ -24,6 +28,13 @@ export declare class FetcherService {
      * @returns The generated AuthCredential.
      */
     private getAuthCredential;
+    /**
+     * Checks the authorization status based on the requested resource.
+     *
+     * @param resourceType - The type of resource to fetch.
+     * @throws An error if not authorized to access the requested resource.
+     */
+    private checkAuthorization;
     /**
      * Gets the HttpsAgent based on whether a proxy is used or not.
      *
@@ -36,6 +47,7 @@ export declare class FetcherService {
      *
      * @param res - The response object received.
      * @returns The received response, if no HTTP errors are found.
+     * @throws An error if any HTTP-related error has occured.
      */
     private handleHttpError;
     /**
@@ -43,6 +55,7 @@ export declare class FetcherService {
      *
      * @param res - The response object received.
      * @returns The received response, if no API errors are found.
+     * @throws An error if any API-related error has occured.
      */
     private handleApiError;
     /**
@@ -57,11 +70,17 @@ export declare class FetcherService {
      *
      * @param data - The data from which extraction is to be done.
      * @param type - The type of data to extract.
-     * @typeParam BaseType - The base type of the raw data present in the input.
-     * @typeParam DeserializedType - The type of data produced after deserialization of BaseType.
      * @returns The extracted data.
      */
     private extractData;
+    /**
+     * Deserializes the extracted data into a cursored list.
+     *
+     * @param extractedData - The list of extracted data.
+     * @param next - The cursor to the next batch of data.
+     * @returns The cursored data object.
+     */
+    private deserializeData;
     /**
      * Fetches the requested resource from Twitter and returns it after processing.
      *