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

package/dist/services/public/ListService.js

@@ -1,69 +1,17 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListService = void 0;
-var Extractors_1 = require("../../collections/Extractors");
-var Resource_1 = require("../../enums/Resource");
-var FetcherService_1 = require("./FetcherService");
-var ListService = /** @class */ (function (_super) {
-    __extends(ListService, _super);
+const Extractors_1 = require("../../collections/Extractors");
+const Resource_1 = require("../../enums/Resource");
+const FetcherService_1 = require("./FetcherService");
+class ListService extends FetcherService_1.FetcherService {
     /**
      * @param config - The config object for configuring the Rettiwt instance.
      *
      * @internal
      */
-    function ListService(config) {
-        return _super.call(this, config) || this;
+    constructor(config) {
+        super(config);
     }
     /**
      * Get the list of members of a tweet list.
@@ -93,26 +41,18 @@ var ListService = /** @class */ (function (_super) {
      *
      * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
-    ListService.prototype.members = function (id, count, cursor) {
-        return __awaiter(this, void 0, void 0, function () {
-            var resource, response, data;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        resource = Resource_1.EResourceType.LIST_MEMBERS;
-                        return [4 /*yield*/, this.request(resource, {
-                                id: id,
-                                count: count,
-                                cursor: cursor,
-                            })];
-                    case 1:
-                        response = _a.sent();
-                        data = Extractors_1.extractors[resource](response);
-                        return [2 /*return*/, data];
-                }
-            });
+    async members(id, count, cursor) {
+        const resource = Resource_1.EResourceType.LIST_MEMBERS;
+        // Fetching the raw list of members
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
         });
-    };
+        // Deserializing response
+        const data = Extractors_1.extractors[resource](response);
+        return data;
+    }
     /**
      * Get the list of tweets from a tweet list.
      *
@@ -141,29 +81,20 @@ var ListService = /** @class */ (function (_super) {
      *
      * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
-    ListService.prototype.tweets = function (id, count, cursor) {
-        return __awaiter(this, void 0, void 0, function () {
-            var resource, response, data;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        resource = Resource_1.EResourceType.LIST_TWEETS;
-                        return [4 /*yield*/, this.request(resource, {
-                                id: id,
-                                count: count,
-                                cursor: cursor,
-                            })];
-                    case 1:
-                        response = _a.sent();
-                        data = Extractors_1.extractors[resource](response);
-                        // Sorting the tweets by date, from recent to oldest
-                        data.list.sort(function (a, b) { return new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf(); });
-                        return [2 /*return*/, data];
-                }
-            });
+    async tweets(id, count, cursor) {
+        const resource = Resource_1.EResourceType.LIST_TWEETS;
+        // Fetching raw list tweets
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
         });
-    };
-    return ListService;
-}(FetcherService_1.FetcherService));
+        // Deserializing response
+        const data = Extractors_1.extractors[resource](response);
+        // Sorting the tweets by date, from recent to oldest
+        data.list.sort((a, b) => new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf());
+        return data;
+    }
+}
 exports.ListService = ListService;
 //# sourceMappingURL=ListService.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,2DAA0D;AAC1D,iDAAqD;AAMrD,mDAAkD;AAElD;IAAiC,+BAAc;IAC9C;;;;OAIG;IACH,qBAAmB,MAAuB;eACzC,kBAAM,MAAM,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,6BAAO,GAApB,UAAqB,EAAU,EAAE,KAAc,EAAE,MAAe;;;;;;wBACzD,QAAQ,GAAkB,wBAAa,CAAC,YAAY,CAAC;wBAG1C,qBAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;gCACnE,EAAE,EAAE,EAAE;gCACN,KAAK,EAAE,KAAK;gCACZ,MAAM,EAAE,MAAM;6BACd,CAAC,EAAA;;wBAJI,QAAQ,GAAG,SAIf;wBAGI,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;wBAE5C,sBAAO,IAAI,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,4BAAM,GAAnB,UAAoB,EAAU,EAAE,KAAc,EAAE,MAAe;;;;;;wBACxD,QAAQ,GAAG,wBAAa,CAAC,WAAW,CAAC;wBAG1B,qBAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;gCAClE,EAAE,EAAE,EAAE;gCACN,KAAK,EAAE,KAAK;gCACZ,MAAM,EAAE,MAAM;6BACd,CAAC,EAAA;;wBAJI,QAAQ,GAAG,SAIf;wBAGI,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;wBAE5C,oDAAoD;wBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAjE,CAAiE,CAAC,CAAC;wBAE5F,sBAAO,IAAI,EAAC;;;;KACZ;IACF,kBAAC;AAAD,CAAC,AApGD,CAAiC,+BAAc,GAoG9C;AApGY,kCAAW"}
+{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAqD;AAQrD,qDAAkD;AAElD,MAAa,WAAY,SAAQ,+BAAc;IAC9C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,MAAM,QAAQ,GAAkB,wBAAa,CAAC,YAAY,CAAC;QAE3D,mCAAmC;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,wBAAa,CAAC,WAAW,CAAC;QAE3C,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AApGD,kCAoGC"}

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

@@ -1,9 +1,9 @@
-import { ESearchResultType, TweetFilter } from 'rettiwt-core';
-import { TweetArgs } from '../../models/args/PostArgs';
 import { CursoredData } from '../../models/data/CursoredData';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
-import { IRettiwtConfig } from '../../types/RettiwtConfig';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { ITweetFilter } from '../../types/args/FetchArgs';
+import { INewTweet } from '../../types/args/PostArgs';
 import { FetcherService } from './FetcherService';
 /**
  * Handles interacting with resources related to tweets.
@@ -16,11 +16,11 @@ export declare class TweetService extends FetcherService {
      *
      * @internal
      */
-    constructor(config?: IRettiwtConfig);
+    constructor(config: RettiwtConfig);
     /**
      * Get the details of a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The id(s) of the target tweet/tweets.
      *
      * @returns
      * The details of the tweet with the given id.
@@ -43,7 +43,7 @@ export declare class TweetService extends FetcherService {
      * });
      * ```
      */
-    details(id: string): Promise<Tweet | undefined>;
+    details<T extends string | string[]>(id: T): Promise<T extends string ? Tweet | undefined : Tweet[]>;
     /**
      * Like a tweet.
      *
@@ -69,6 +69,33 @@ export declare class TweetService extends FetcherService {
      * ```
      */
     like(id: string): Promise<boolean>;
+    /**
+     * Get the list of users who liked a tweet. Only works for your own tweets.
+     *
+     * @param id - The id of the target tweet.
+     * @param count - The number of likers to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of likers to fetch.
+     *
+     * @returns The list of users who liked the given tweet.
+     *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 likers of the Tweet with id '1234567890'
+     * rettiwt.tweet.likers('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    likers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
     /**
      * Get the list of tweets from a tweet list.
      *
@@ -177,7 +204,33 @@ export declare class TweetService extends FetcherService {
      * });
      * ```
      */
-    post(options: TweetArgs): Promise<string | undefined>;
+    post(options: INewTweet): Promise<string | undefined>;
+    /**
+     * Get the list of replies to a tweet.
+     *
+     * @param id - The id of the target tweet.
+     * @param cursor - The cursor to the batch of replies to fetch.
+     *
+     * @returns The list of replies to the given tweet.
+     *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 replies to the Tweet with id '1234567890'
+     * rettiwt.tweet.replies('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    replies(id: string, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
      * Retweet a tweet.
      *
@@ -258,7 +311,7 @@ export declare class TweetService extends FetcherService {
      * @remarks
      * Scheduling a tweet is similar to {@link post}ing, except that an extra parameter called `scheduleFor` is used.
      */
-    schedule(options: TweetArgs): Promise<string | undefined>;
+    schedule(options: INewTweet): Promise<string | undefined>;
     /**
      * Search for tweets using a filter.
      *
@@ -288,7 +341,7 @@ export declare class TweetService extends FetcherService {
      *
      * @remarks For details about available filters, refer to {@link TweetFilter}
      */
-    search(filter: TweetFilter, count?: number, cursor?: string, results?: ESearchResultType): Promise<CursoredData<Tweet>>;
+    search(filter: ITweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
      * Stream tweets in pseudo real-time using a filter.
      *
@@ -321,7 +374,7 @@ export declare class TweetService extends FetcherService {
      * streamTweets();
      * ```
      */
-    stream(filter: TweetFilter, pollingInterval?: number): AsyncGenerator<Tweet>;
+    stream(filter: ITweetFilter, pollingInterval?: number): AsyncGenerator<Tweet>;
     /**
      * Unlike a tweet.
      *