rettiwt-api 1.1.2 → 1.1.5

package/dist/types/Service.d.ts

@@ -1,30 +1,22 @@
-import { AccountService } from "../services/accounts/AccountService";
-import { TweetService } from "../services/data/TweetService";
-import { UserAccountService } from "../services/data/UserAccountService";
 /**
- * @summary Stores the cursor to the batch of data
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
  */
-export declare class Cursor {
+export interface ICursor {
+    /** The cursor string. */
     value: string;
-    /**
-     * @summary Initializes a new cursor from the given cursor string
-     * @param cursorStr The string representation of the cursor
-     */
-    constructor(cursorStr: string);
 }
 /**
- * @summary Stores cursored data that is returned by services
+ * The data that us fetched batch-wise along with a cursor.
+ *
+ * @typeParam Type - The type of data present in the list.
+ *
+ * @public
  */
-export interface CursoredData<Type> {
-    list?: Type[];
-    next?: Cursor;
-    error?: Error;
-}
-/**
- * @summary Stores the data context from where data is to be fetched
- */
-export interface DataContext {
-    users: UserAccountService;
-    tweets: TweetService;
-    account: AccountService;
+export interface ICursoredData<Type> {
+    /** The list of data of the given type. */
+    list: Type[];
+    /** The cursor to the next batch of data. */
+    next: ICursor;
 }

package/dist/types/Service.js

@@ -1,19 +1,5 @@
 "use strict";
 exports.__esModule = true;
-exports.Cursor = void 0;
-/**
- * @summary Stores the cursor to the batch of data
- */
-var Cursor = /** @class */ (function () {
-    // MEMBER DATA
-    /**
-     * @summary Initializes a new cursor from the given cursor string
-     * @param cursorStr The string representation of the cursor
-     */
-    function Cursor(cursorStr) {
-        this.value = cursorStr;
-    }
-    return Cursor;
-}());
-exports.Cursor = Cursor;
+;
+;
 //# sourceMappingURL=Service.js.map

package/dist/types/Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/types/Service.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH;IAII,cAAc;IACd;;;OAGG;IACH,gBAAY,SAAiB;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IACL,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM"}
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/types/Service.ts"],"names":[],"mappings":";;AAQC,CAAC;AAeD,CAAC"}

package/dist/types/Tweet.d.ts

@@ -1,40 +1,46 @@
 /**
- * @summary Stores the filter to be used for fetching tweets from TwitterAPI
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
  */
-export interface TweetFilter {
-    words?: string[];
-    hashtags?: string[];
-    fromUsers?: string[];
-    toUsers?: string[];
-    mentions?: string[];
-    startDate?: string;
-    endDate?: string;
-    quoted?: string;
-    links?: boolean;
-}
-/**
- * @summary Stores the different types of tweet elements like urls, media, mentions, hashtags, etc
- */
-export interface TweetEntities {
+export interface ITweetEntities {
+    /** The list of hashtags mentioned in the tweet. */
     hashtags: string[];
+    /** The list of urls mentioned in the tweet. */
     urls: string[];
+    /** The list of IDs of users mentioned in the tweet. */
     mentionedUsers: string[];
+    /** The list of urls to various media mentioned in the tweet. */
     media: string[];
 }
 /**
- * @summary Stores a single tweet
+ * The details of a single Tweet.
+ *
+ * @public
  */
-export interface Tweet {
+export interface ITweet {
+    /** The rest id of the tweet. */
     id: string;
+    /** The rest id of the user who made the tweet. */
     tweetBy: string;
+    /** The date and time of creation of the tweet, in UTC string format. */
     createdAt: string;
-    entities: TweetEntities;
+    /** Additional tweet entities like urls, mentions, etc. */
+    entities: ITweetEntities;
+    /** The rest id of the tweet which is quoted in the tweet. */
     quoted: string;
+    /** The full text content of the tweet. */
     fullText: string;
+    /** The rest id of the user to which the tweet is a reply. */
     replyTo: string;
+    /** The language in which the tweet is written. */
     lang: string;
+    /** The number of quotes of the tweet. */
     quoteCount: number;
+    /** The number of replies to the tweet. */
     replyCount: number;
+    /** The number of retweets of the tweet. */
     retweetCount: number;
+    /** The number of likes of the tweet. */
     likeCount: number;
 }

package/dist/types/Tweet.js

@@ -1,5 +1,3 @@
 "use strict";
-// This file contains various objects related to handling of Tweets made by a user
 exports.__esModule = true;
-;
 //# sourceMappingURL=Tweet.js.map

package/dist/types/Tweet.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../src/types/Tweet.ts"],"names":[],"mappings":";AAAA,kFAAkF;;AAejF,CAAC"}
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../src/types/Tweet.ts"],"names":[],"mappings":""}

package/dist/types/User.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+export interface IUser {
+    /** The rest id of the user. */
+    id: string;
+    /** The username/screenname of the user. */
+    userName: string;
+    /** The full name of the user. */
+    fullName: string;
+    /** The creation date of user's account. */
+    createdAt: string;
+    /** The user's description. */
+    description: string;
+    /** Whether the account is verified or not. */
+    isVerified: boolean;
+    /** The number of tweets liked by the user. */
+    favouritesCount: number;
+    /** The number of followers of the user. */
+    followersCount: number;
+    /** The number of following of the user. */
+    followingsCount: number;
+    /** The number of tweets made by the user. */
+    statusesCount: number;
+    /** The location of user as provided by user. */
+    location: string;
+    /** The rest id of the tweet pinned in the user's profile. */
+    pinnedTweet: string;
+    /** The url of the profile banner image. */
+    profileBanner: string;
+    /** The url of the profile image. */
+    profileImage: string;
+}

package/dist/types/User.js

@@ -0,0 +1,3 @@
+"use strict";
+exports.__esModule = true;
+//# sourceMappingURL=User.js.map

package/dist/types/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../src/types/User.ts"],"names":[],"mappings":""}

package/dist/types/args/TweetFilter.d.ts

@@ -0,0 +1,54 @@
+import { TweetFilterInterface } from '../interfaces/Args';
+export declare class TweetFilter implements TweetFilterInterface {
+    /** The list of words to search. */
+    words?: string[];
+    /** The list of hashtags to search.
+     *
+     * @remarks
+     * '#' must be excluded from the hashtag!
+     */
+    hashtags?: string[];
+    /** The list of usernames whose tweets are to be searched.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    fromUsers?: string[];
+    /** The list of username to whom the tweets to be searched, are adressed.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    toUsers?: string[];
+    /** The list of username mentioned in the tweets to search.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    mentions?: string[];
+    /** The date starting from which tweets are to be searched.
+     *
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    startDate?: string;
+    /** The date upto which tweets are to be searched.
+     *
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    endDate?: string;
+    /** The id of the tweet, after which the tweets are to be searched. */
+    sinceId?: string;
+    /** The id of the tweet which is quoted in the tweets to search. */
+    quoted?: string;
+    /** Whether to fetch tweets that are links or not.
+     *
+     * @defaultValue false
+     */
+    links?: boolean;
+    /**
+     * @param filter The incoming filter in JSON format.
+     */
+    constructor(filter: TweetFilter);
+}

package/dist/types/args/TweetFilter.js

@@ -0,0 +1,96 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+exports.__esModule = true;
+exports.TweetFilter = void 0;
+// PACKAGE
+var class_validator_1 = require("class-validator");
+var Errors_1 = require("../data/Errors");
+var TweetFilter = /** @class */ (function () {
+    /**
+     * @param filter The incoming filter in JSON format.
+     */
+    function TweetFilter(filter) {
+        this.endDate = filter.endDate;
+        this.fromUsers = filter.fromUsers;
+        this.hashtags = filter.hashtags;
+        this.links = filter.links;
+        this.mentions = filter.mentions;
+        this.quoted = filter.quoted;
+        this.sinceId = filter.sinceId;
+        this.startDate = filter.startDate;
+        this.toUsers = filter.toUsers;
+        this.words = filter.words;
+        // Validating the filter
+        var validationResult = (0, class_validator_1.validateSync)(this);
+        // If valiation error occured
+        if (validationResult.length) {
+            throw new Errors_1.DataValidationError(validationResult);
+        }
+    }
+    __decorate([
+        (0, class_validator_1.IsArray)(),
+        (0, class_validator_1.IsString)({ each: true }),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Array)
+    ], TweetFilter.prototype, "words");
+    __decorate([
+        (0, class_validator_1.IsArray)(),
+        (0, class_validator_1.IsString)({ each: true }),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Array)
+    ], TweetFilter.prototype, "hashtags");
+    __decorate([
+        (0, class_validator_1.IsArray)(),
+        (0, class_validator_1.IsString)({ each: true }),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Array)
+    ], TweetFilter.prototype, "fromUsers");
+    __decorate([
+        (0, class_validator_1.IsArray)(),
+        (0, class_validator_1.IsString)({ each: true }),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Array)
+    ], TweetFilter.prototype, "toUsers");
+    __decorate([
+        (0, class_validator_1.IsArray)(),
+        (0, class_validator_1.IsString)({ each: true }),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Array)
+    ], TweetFilter.prototype, "mentions");
+    __decorate([
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.IsDateString)(),
+        __metadata("design:type", String)
+    ], TweetFilter.prototype, "startDate");
+    __decorate([
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.IsDateString)(),
+        __metadata("design:type", String)
+    ], TweetFilter.prototype, "endDate");
+    __decorate([
+        (0, class_validator_1.IsNumberString)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", String)
+    ], TweetFilter.prototype, "sinceId");
+    __decorate([
+        (0, class_validator_1.IsNumberString)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", String)
+    ], TweetFilter.prototype, "quoted");
+    __decorate([
+        (0, class_validator_1.IsBoolean)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", Boolean)
+    ], TweetFilter.prototype, "links");
+    return TweetFilter;
+}());
+exports.TweetFilter = TweetFilter;
+//# sourceMappingURL=TweetFilter.js.map

package/dist/types/args/TweetFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TweetFilter.js","sourceRoot":"","sources":["../../../src/types/args/TweetFilter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,UAAU;AACV,mDAAuH;AAIvH,yCAAqD;AAErD;IAmFI;;OAEG;IACH,qBAAY,MAAmB;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE1B,wBAAwB;QACxB,IAAM,gBAAgB,GAAG,IAAA,8BAAY,EAAC,IAAI,CAAC,CAAC;QAE5C,6BAA6B;QAC7B,IAAI,gBAAgB,CAAC,MAAM,EAAE;YACzB,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACL,CAAC;IApGD;QAHC,IAAA,yBAAO,GAAE;QACT,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxB,IAAA,4BAAU,GAAE;;sCACI;IAUjB;QAHC,IAAA,yBAAO,GAAE;QACT,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxB,IAAA,4BAAU,GAAE;;yCACO;IAUpB;QAHC,IAAA,yBAAO,GAAE;QACT,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxB,IAAA,4BAAU,GAAE;;0CACQ;IAUrB;QAHC,IAAA,yBAAO,GAAE;QACT,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxB,IAAA,4BAAU,GAAE;;wCACM;IAUnB;QAHC,IAAA,yBAAO,GAAE;QACT,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxB,IAAA,4BAAU,GAAE;;yCACO;IASpB;QAFC,IAAA,4BAAU,GAAE;QACZ,IAAA,8BAAY,GAAE;;0CACI;IASnB;QAFC,IAAA,4BAAU,GAAE;QACZ,IAAA,8BAAY,GAAE;;wCACE;IAKjB;QAFC,IAAA,gCAAc,GAAE;QAChB,IAAA,4BAAU,GAAE;;wCACI;IAKjB;QAFC,IAAA,gCAAc,GAAE;QAChB,IAAA,4BAAU,GAAE;;uCACG;IAQhB;QAFC,IAAA,2BAAS,GAAE;QACX,IAAA,4BAAU,GAAE;;sCACG;IAyBpB,kBAAC;CAAA,AA1GD,IA0GC;AA1GY,kCAAW"}

package/dist/types/args/TweetListArg.d.ts

@@ -0,0 +1,10 @@
+export declare class TweetListArgs {
+    /** The number of data items to fetch.
+     *
+     * @defaultValue 10
+     * @remarks Must be >= 10
+     */
+    count?: number;
+    /** The cursor to the batch of data to fetch. */
+    cursor?: string;
+}

package/dist/types/args/TweetListArg.js

@@ -0,0 +1,42 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+exports.__esModule = true;
+exports.TweetListArgs = void 0;
+// PACKAGES
+var class_transformer_1 = require("class-transformer");
+var class_validator_1 = require("class-validator");
+var TweetListArgs = /** @class */ (function () {
+    function TweetListArgs() {
+        /** The number of data items to fetch.
+         *
+         * @defaultValue 10
+         * @remarks Must be >= 10
+         */
+        this.count = 10;
+        /** The cursor to the batch of data to fetch. */
+        this.cursor = '';
+    }
+    __decorate([
+        (0, class_transformer_1.Type)(function () { return Number; }),
+        (0, class_validator_1.IsInt)(),
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.Min)(10),
+        __metadata("design:type", Number)
+    ], TweetListArgs.prototype, "count");
+    __decorate([
+        (0, class_validator_1.IsString)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", String)
+    ], TweetListArgs.prototype, "cursor");
+    return TweetListArgs;
+}());
+exports.TweetListArgs = TweetListArgs;
+//# sourceMappingURL=TweetListArg.js.map

package/dist/types/args/TweetListArg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TweetListArg.js","sourceRoot":"","sources":["../../../src/types/args/TweetListArg.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,WAAW;AACX,uDAAyC;AACzC,mDAAmE;AAEnE;IAAA;QACI;;;;WAIG;QAKH,UAAK,GAAY,EAAE,CAAC;QAEpB,gDAAgD;QAGhD,WAAM,GAAY,EAAE,CAAC;IACzB,CAAC;IANG;QAJC,IAAA,wBAAI,EAAC,cAAM,OAAA,MAAM,EAAN,CAAM,CAAC;QAClB,IAAA,uBAAK,GAAE;QACP,IAAA,4BAAU,GAAE;QACZ,IAAA,qBAAG,EAAC,EAAE,CAAC;;wCACY;IAKpB;QAFC,IAAA,0BAAQ,GAAE;QACV,IAAA,4BAAU,GAAE;;yCACQ;IACzB,oBAAC;CAAA,AAhBD,IAgBC;AAhBY,sCAAa"}

package/dist/types/args/TweetListArgs.d.ts

@@ -0,0 +1,20 @@
+import { ListArgs } from '../interfaces/Args';
+/**
+ * @param count The number of data items to fetch.
+ * @param cursor The cursor to the next batch of data.
+ */
+export declare class TweetListArgs implements ListArgs {
+    /** The number of data items to fetch.
+     *
+     * @defaultValue 10
+     * @remarks Must be >= 10 and <= 100
+     */
+    count: number;
+    /** The cursor to the batch of data to fetch. */
+    cursor: string;
+    /**
+     * @param count The number of data items to fetch.
+     * @param cursor The cursor to the batch of data to fetch.
+     */
+    constructor(count?: number, cursor?: string);
+}

package/dist/types/args/TweetListArgs.js

@@ -0,0 +1,52 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+exports.__esModule = true;
+exports.TweetListArgs = void 0;
+// PACKAGES
+var class_validator_1 = require("class-validator");
+var Errors_1 = require("../data/Errors");
+/**
+ * @param count The number of data items to fetch.
+ * @param cursor The cursor to the next batch of data.
+ */
+var TweetListArgs = /** @class */ (function () {
+    /**
+     * @param count The number of data items to fetch.
+     * @param cursor The cursor to the batch of data to fetch.
+     */
+    function TweetListArgs(count, cursor) {
+        if (count === void 0) { count = 10; }
+        if (cursor === void 0) { cursor = ''; }
+        this.count = count;
+        this.cursor = cursor;
+        // Validating the arguments
+        var validationResult = (0, class_validator_1.validateSync)(this);
+        // If valiation error occured
+        if (validationResult.length) {
+            throw new Errors_1.DataValidationError(validationResult);
+        }
+    }
+    __decorate([
+        (0, class_validator_1.IsInt)(),
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.Min)(10),
+        (0, class_validator_1.Max)(100),
+        __metadata("design:type", Number)
+    ], TweetListArgs.prototype, "count");
+    __decorate([
+        (0, class_validator_1.IsString)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", String)
+    ], TweetListArgs.prototype, "cursor");
+    return TweetListArgs;
+}());
+exports.TweetListArgs = TweetListArgs;
+//# sourceMappingURL=TweetListArgs.js.map

package/dist/types/args/TweetListArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TweetListArgs.js","sourceRoot":"","sources":["../../../src/types/args/TweetListArgs.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,WAAW;AACX,mDAAsF;AAItF,yCAAqD;AAErD;;;GAGG;AACH;IAiBI;;;OAGG;IACH,uBAAY,KAAkB,EAAE,MAAmB;QAAvC,sBAAA,EAAA,UAAkB;QAAE,uBAAA,EAAA,WAAmB;QAC/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,2BAA2B;QAC3B,IAAM,gBAAgB,GAAG,IAAA,8BAAY,EAAC,IAAI,CAAC,CAAC;QAE5C,6BAA6B;QAC7B,IAAI,gBAAgB,CAAC,MAAM,EAAE;YACzB,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACL,CAAC;IAtBD;QAJC,IAAA,uBAAK,GAAE;QACP,IAAA,4BAAU,GAAE;QACZ,IAAA,qBAAG,EAAC,EAAE,CAAC;QACP,IAAA,qBAAG,EAAC,GAAG,CAAC;;wCACK;IAKd;QAFC,IAAA,0BAAQ,GAAE;QACV,IAAA,4BAAU,GAAE;;yCACE;IAkBnB,oBAAC;CAAA,AAjCD,IAiCC;AAjCY,sCAAa"}

package/dist/types/args/UserListArgs.d.ts

@@ -0,0 +1,16 @@
+import { ListArgs } from '../interfaces/Args';
+export declare class UserListArgs implements ListArgs {
+    /** The number of data items to fetch.
+     *
+     * @defaultValue 40
+     * @remarks Must be >= 40 and <= 100
+     */
+    count: number;
+    /** The cursor to the batch of data to fetch. */
+    cursor: string;
+    /**
+     * @param count The number of data items to fetch.
+     * @param cursor The cursor to the batch of data to fetch.
+     */
+    constructor(count?: number, cursor?: string);
+}

package/dist/types/args/UserListArgs.js

@@ -0,0 +1,48 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+exports.__esModule = true;
+exports.UserListArgs = void 0;
+// PACKAGES
+var class_validator_1 = require("class-validator");
+var Errors_1 = require("../data/Errors");
+var UserListArgs = /** @class */ (function () {
+    /**
+     * @param count The number of data items to fetch.
+     * @param cursor The cursor to the batch of data to fetch.
+     */
+    function UserListArgs(count, cursor) {
+        if (count === void 0) { count = 40; }
+        if (cursor === void 0) { cursor = ''; }
+        this.count = count;
+        this.cursor = cursor;
+        // Validating the arguments
+        var validationResult = (0, class_validator_1.validateSync)(this);
+        // If valiation error occured
+        if (validationResult.length) {
+            throw new Errors_1.DataValidationError(validationResult);
+        }
+    }
+    __decorate([
+        (0, class_validator_1.IsInt)(),
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.Min)(40),
+        (0, class_validator_1.Max)(100),
+        __metadata("design:type", Number)
+    ], UserListArgs.prototype, "count");
+    __decorate([
+        (0, class_validator_1.IsString)(),
+        (0, class_validator_1.IsOptional)(),
+        __metadata("design:type", String)
+    ], UserListArgs.prototype, "cursor");
+    return UserListArgs;
+}());
+exports.UserListArgs = UserListArgs;
+//# sourceMappingURL=UserListArgs.js.map

package/dist/types/args/UserListArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserListArgs.js","sourceRoot":"","sources":["../../../src/types/args/UserListArgs.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,WAAW;AACX,mDAAsF;AAItF,yCAAqD;AAErD;IAiBI;;;OAGG;IACH,sBAAY,KAAkB,EAAE,MAAmB;QAAvC,sBAAA,EAAA,UAAkB;QAAE,uBAAA,EAAA,WAAmB;QAC/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,2BAA2B;QAC3B,IAAM,gBAAgB,GAAG,IAAA,8BAAY,EAAC,IAAI,CAAC,CAAC;QAE5C,6BAA6B;QAC7B,IAAI,gBAAgB,CAAC,MAAM,EAAE;YACzB,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACL,CAAC;IAtBD;QAJC,IAAA,uBAAK,GAAE;QACP,IAAA,4BAAU,GAAE;QACZ,IAAA,qBAAG,EAAC,EAAE,CAAC;QACP,IAAA,qBAAG,EAAC,GAAG,CAAC;;uCACK;IAKd;QAFC,IAAA,0BAAQ,GAAE;QACV,IAAA,4BAAU,GAAE;;wCACE;IAkBnB,mBAAC;CAAA,AAjCD,IAiCC;AAjCY,oCAAY"}

package/dist/types/data/TweetFilter.d.ts

@@ -0,0 +1,49 @@
+export declare class TweetFilter {
+    /** The list of words to search. */
+    words?: string[];
+    /** The list of hashtags to search.
+     *
+     * @remarks
+     * '#' must be excluded from the hashtag!
+     */
+    hashtags?: string[];
+    /** The list of usernames whose tweets are to be searched.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    fromUsers?: string[];
+    /** The list of username to whom the tweets to be searched, are adressed.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    toUsers?: string[];
+    /** The list of username mentioned in the tweets to search.
+     *
+     * @remarks
+     * '@' must be excluded from the username!
+     */
+    mentions?: string[];
+    /** The date starting from which tweets are to be searched.
+     *
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    startDate?: string;
+    /** The date upto which tweets are to be searched.
+     *
+     * @remarks
+     * Must be in the format YYYY-MM-DD.
+     */
+    endDate?: string;
+    /** The id of the tweet, after which the tweets are to be searched. */
+    sinceId?: string;
+    /** The id of the tweet which is quoted in the tweets to search. */
+    quoted?: string;
+    /** Whether to fetch tweets that are links or not.
+     *
+     * @defaultValue false
+     */
+    links?: boolean;
+}