rettiwt-api 1.1.8 → 1.3.0

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

@@ -1,31 +1,31 @@
-import { AuthCookie } from '../../models/auth/AuthCookie';
-import { IGuestCredentials, IAuthCredentials } from '../../types/Authentication';
-/**
- * Handles authentication of http requests and other authentication related tasks.
- *
- * @internal
- */
-export declare class AuthService {
-    /** The common bearer token for authentication. */
-    private authToken;
-    /** The current authentication credentials. */
-    private credentials;
-    /** Whether instance has been authenticated or not. */
-    isAuthenticated: boolean;
-    /**
-     * @param cookie The cookie to be used for authenticating.
-     *
-     * @remarks
-     *
-     * If no cookie is supplied, then guest authentication is used.
-     */
-    constructor(cookie?: AuthCookie);
-    /**
-     * @returns The current authentication credentials. A different credential is returned each time this is invoked
-     */
-    getAuthCredentials(): Promise<IAuthCredentials>;
-    /**
-     * @returns The guest credentials fetched from twitter.
-     */
-    getGuestCredentials(): Promise<IGuestCredentials>;
-}
+import { AuthCookie } from '../../models/auth/AuthCookie';
+import { IGuestCredentials, IAuthCredentials } from '../../types/Authentication';
+/**
+ * Handles authentication of http requests and other authentication related tasks.
+ *
+ * @internal
+ */
+export declare class AuthService {
+    /** The common bearer token for authentication. */
+    private authToken;
+    /** The current authentication credentials. */
+    private credentials;
+    /** Whether instance has been authenticated or not. */
+    isAuthenticated: boolean;
+    /**
+     * @param cookie The cookie to be used for authenticating.
+     *
+     * @remarks
+     *
+     * If no cookie is supplied, then guest authentication is used.
+     */
+    constructor(cookie?: AuthCookie);
+    /**
+     * @returns The current authentication credentials. A different credential is returned each time this is invoked
+     */
+    getAuthCredentials(): Promise<IAuthCredentials>;
+    /**
+     * @returns The guest credentials fetched from twitter.
+     */
+    getGuestCredentials(): Promise<IGuestCredentials>;
+}

package/dist/services/auth/AuthService.js

@@ -1,118 +1,118 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) 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 };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-exports.AuthService = void 0;
-// PACKAGE
-var axios_1 = __importDefault(require("axios"));
-// URLS
-var Authentication_1 = require("../helper/urls/Authentication");
-// MODELS
-var AuthCookie_1 = require("../../models/auth/AuthCookie");
-// CONFIGS
-var env_1 = require("../../config/env");
-/**
- * Handles authentication of http requests and other authentication related tasks.
- *
- * @internal
- */
-var AuthService = /** @class */ (function () {
-    /**
-     * @param cookie The cookie to be used for authenticating.
-     *
-     * @remarks
-     *
-     * If no cookie is supplied, then guest authentication is used.
-     */
-    function AuthService(cookie) {
-        // Reading the auth token from the config, since it's always the same
-        this.authToken = env_1.config.twitter_auth_token;
-        // Setting authentication status
-        this.isAuthenticated = ((cookie === null || cookie === void 0 ? void 0 : cookie.auth_token) && (cookie === null || cookie === void 0 ? void 0 : cookie.ct0) && (cookie === null || cookie === void 0 ? void 0 : cookie.kdt) && (cookie === null || cookie === void 0 ? void 0 : cookie.twid)) ? true : false;
-        // If a cookies is supplied, initializing authenticated credentials
-        if (this.isAuthenticated) {
-            // Converting the cookie from JSON to object
-            cookie = new AuthCookie_1.AuthCookie(cookie);
-            // Setting up the authenticated credentials
-            this.credentials = { authToken: this.authToken, csrfToken: cookie.ct0, cookie: cookie.toString() };
-        }
-        // If no cookie has been supplied, initializing empty credentials
-        else {
-            // Setting up the authenticated credentials
-            this.credentials = { authToken: this.authToken, csrfToken: '', cookie: '' };
-        }
-    }
-    /**
-     * @returns The current authentication credentials. A different credential is returned each time this is invoked
-     */
-    AuthService.prototype.getAuthCredentials = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, this.credentials];
-            });
-        });
-    };
-    /**
-     * @returns The guest credentials fetched from twitter.
-     */
-    AuthService.prototype.getGuestCredentials = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1["default"].post((0, Authentication_1.guestTokenUrl)(), null, {
-                            headers: {
-                                'Authorization': this.authToken
-                            }
-                        }).then(function (res) { return ({
-                            authToken: _this.authToken,
-                            guestToken: res.data.guest_token
-                        }); })];
-                    case 1: 
-                    // Getting the guest credentials from twitter
-                    return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    return AuthService;
-}());
-exports.AuthService = AuthService;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) 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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.AuthService = void 0;
+// PACKAGE
+var axios_1 = __importDefault(require("axios"));
+// URLS
+var Authentication_1 = require("../helper/urls/Authentication");
+// MODELS
+var AuthCookie_1 = require("../../models/auth/AuthCookie");
+// CONFIGS
+var env_1 = require("../../config/env");
+/**
+ * Handles authentication of http requests and other authentication related tasks.
+ *
+ * @internal
+ */
+var AuthService = /** @class */ (function () {
+    /**
+     * @param cookie The cookie to be used for authenticating.
+     *
+     * @remarks
+     *
+     * If no cookie is supplied, then guest authentication is used.
+     */
+    function AuthService(cookie) {
+        // Reading the auth token from the config, since it's always the same
+        this.authToken = env_1.config.twitter_auth_token;
+        // Setting authentication status
+        this.isAuthenticated = ((cookie === null || cookie === void 0 ? void 0 : cookie.auth_token) && (cookie === null || cookie === void 0 ? void 0 : cookie.ct0) && (cookie === null || cookie === void 0 ? void 0 : cookie.kdt) && (cookie === null || cookie === void 0 ? void 0 : cookie.twid)) ? true : false;
+        // If a cookies is supplied, initializing authenticated credentials
+        if (this.isAuthenticated) {
+            // Converting the cookie from JSON to object
+            cookie = new AuthCookie_1.AuthCookie(cookie);
+            // Setting up the authenticated credentials
+            this.credentials = { authToken: this.authToken, csrfToken: cookie.ct0, cookie: cookie.toString() };
+        }
+        // If no cookie has been supplied, initializing empty credentials
+        else {
+            // Setting up the authenticated credentials
+            this.credentials = { authToken: this.authToken, csrfToken: '', cookie: '' };
+        }
+    }
+    /**
+     * @returns The current authentication credentials. A different credential is returned each time this is invoked
+     */
+    AuthService.prototype.getAuthCredentials = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.credentials];
+            });
+        });
+    };
+    /**
+     * @returns The guest credentials fetched from twitter.
+     */
+    AuthService.prototype.getGuestCredentials = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, axios_1["default"].post((0, Authentication_1.guestTokenUrl)(), null, {
+                            headers: {
+                                'Authorization': this.authToken
+                            }
+                        }).then(function (res) { return ({
+                            authToken: _this.authToken,
+                            guestToken: res.data.guest_token
+                        }); })];
+                    case 1: 
+                    // Getting the guest credentials from twitter
+                    return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return AuthService;
+}());
+exports.AuthService = AuthService;
 //# sourceMappingURL=AuthService.js.map

package/dist/services/data/TweetService.d.ts

@@ -1,74 +1,60 @@
-import { FetcherService } from "../util/FetcherService";
-import { AuthService } from "../auth/AuthService";
-import { Tweet } from "../../models/data/Tweet";
-import { User } from "../../models/data/User";
-import { TweetFilter } from "../../models/args/TweetFilter";
-import { CursoredData } from '../../models/data/CursoredData';
-/**
- * Handles fetching of data related to tweets.
- * @public
- */
-export declare class TweetService extends FetcherService {
-    /**
-     * @param auth The AuthService instance to use for authentication.
-     */
-    constructor(auth: AuthService);
-    /**
-     * @param filter The filter be used for searching the tweets.
-     * @param count The number of tweets to fetch, must be >= 10 and <= 20
-     * @param cursor The cursor to the next batch of tweets. If blank, first batch is fetched.
-     *
-     * @returns The list of tweets that match the given filter.
-     *
-     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if an invalid count has been provided.
-     *
-     * @remarks
-     *
-     * Cookies are required to use this method!
-     */
-    getTweets(query: TweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
-    /**
-     * @param id The id of the target tweet.
-     *
-     * @returns The details of a single tweet with the given tweet id.
-     *
-     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
-     *
-     * @remarks
-     *
-     * No cookies are required to use this method.
-     */
-    getTweetDetails(id: string): Promise<Tweet>;
-    /**
-     * @param tweetId The rest id of the target tweet.
-     * @param count The batch size of the list, must be >= 10 (when no cursor is provided) and <= 20.
-     * @param cursor The cursor to the next batch of users. If blank, first batch is fetched.
-     *
-     * @returns The list of users who liked the given tweet.
-     *
-     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
-     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count is provided.
-     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
-     *
-     * @remarks
-     *
-     * Cookies are required to use this method!
-     */
-    getTweetLikers(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
-    /**
-     * @param tweetId The rest id of the target tweet.
-     * @param count The batch size of the list, must be >= 10 (when no cursor is provided) and <= 100.
-     * @param cursor The cursor to the next batch of users. If blank, first batch is fetched.
-     *
-     * @returns The list of users who retweeted the given tweet.
-     *
-     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
-     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count is provided.
-     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
-     *
-     * @remarks
-     *
-     * Cookies are required to use this method!
-     */
-    getTweetRetweeters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
-}
+import { TweetFilter } from 'rettiwt-core';
+import { FetcherService } from "../util/FetcherService";
+import { AuthService } from "../auth/AuthService";
+import { Tweet } from "../../models/data/Tweet";
+import { User } from "../../models/data/User";
+import { CursoredData } from '../../models/data/CursoredData';
+/**
+ * Handles fetching of data related to tweets.
+ * @public
+ */
+export declare class TweetService extends FetcherService {
+    /**
+     * @param auth The AuthService instance to use for authentication.
+     */
+    constructor(auth: AuthService);
+    /**
+     * @param filter The filter be used for searching the tweets.
+     * @param count The number of tweets to fetch, must be >= 10 (when no cursor is provided) and <= 20
+     * @param cursor The cursor to the next batch of tweets. If blank, first batch is fetched.
+     *
+     * @returns The list of tweets that match the given filter.
+     *
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if an invalid count has been provided.
+     */
+    getTweets(query: TweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    /**
+     * @param id The id of the target tweet.
+     *
+     * @returns The details of a single tweet with the given tweet id.
+     *
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
+     */
+    getTweetDetails(id: string): Promise<Tweet>;
+    /**
+     * @param tweetId The rest id of the target tweet.
+     * @param count The batch size of the list, must be >= 10 (when no cursor is provided) and <= 20.
+     * @param cursor The cursor to the next batch of users. If blank, first batch is fetched.
+     *
+     * @returns The list of users who liked the given tweet.
+     *
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count is provided.
+     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
+     */
+    getTweetLikers(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * @param tweetId The rest id of the target tweet.
+     * @param count The batch size of the list, must be >= 10 (when no cursor is provided) and <= 100.
+     * @param cursor The cursor to the next batch of users. If blank, first batch is fetched.
+     *
+     * @returns The list of users who retweeted the given tweet.
+     *
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count is provided.
+     * @throws {@link Errors.DataErrors.TweetNotFound} error, if no tweet with the given id was found.
+     */
+    getTweetRetweeters(tweetId: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+}