rettiwt-api 1.1.2 → 1.1.7

package/dist/models/args/TweetFilter.js

@@ -0,0 +1,101 @@
+"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 DataValidationError_1 = require("../errors/DataValidationError");
+/**
+ * The filter to be used for fetching tweets from Twitter.
+ *
+ * @internal
+ */
+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 DataValidationError_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/models/args/TweetFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TweetFilter.js","sourceRoot":"","sources":["../../../src/models/args/TweetFilter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,UAAU;AACV,mDAAuH;AAIvH,qEAAoE;AAEpE;;;;GAIG;AACH;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,yCAAmB,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/models/args/TweetListArgs.d.ts

@@ -0,0 +1,21 @@
+import { IListArgs } from '../../types/Args';
+/**
+ * The arguments for fetching cursored list in TweetService.
+ *
+ * @internal
+ */
+export declare class TweetListArgs implements IListArgs {
+    /** 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/models/args/TweetListArgs.js

@@ -0,0 +1,54 @@
+"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 DataValidationError_1 = require("../errors/DataValidationError");
+/**
+ * The arguments for fetching cursored list in TweetService.
+ *
+ * @internal
+ */
+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 DataValidationError_1.DataValidationError(validationResult);
+        }
+    }
+    __decorate([
+        (0, class_validator_1.IsInt)(),
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.Max)(100),
+        (0, class_validator_1.ValidateIf)(function (ob) { return ob.cursor.length == 0; }),
+        (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=TweetListArgs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TweetListArgs.js","sourceRoot":"","sources":["../../../src/models/args/TweetListArgs.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,WAAW;AACX,mDAAkG;AAIlG,qEAAoE;AAEpE;;;;GAIG;AACH;IAkBI;;;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,yCAAmB,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACL,CAAC;IAtBD;QALC,IAAA,uBAAK,GAAE;QACP,IAAA,4BAAU,GAAE;QACZ,IAAA,qBAAG,EAAC,GAAG,CAAC;QACR,IAAA,4BAAU,EAAC,UAAA,EAAE,IAAI,OAAA,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAArB,CAAqB,CAAC;QACvC,IAAA,qBAAG,EAAC,EAAE,CAAC;;wCACM;IAKd;QAFC,IAAA,0BAAQ,GAAE;QACV,IAAA,4BAAU,GAAE;;yCACE;IAkBnB,oBAAC;CAAA,AAlCD,IAkCC;AAlCY,sCAAa"}

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

@@ -0,0 +1,21 @@
+import { IListArgs } from '../../types/Args';
+/**
+ * The arguments for fetching cursored list in TweetService.
+ *
+ * @internal
+ */
+export declare class UserListArgs implements IListArgs {
+    /** 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/models/args/UserListArgs.js

@@ -0,0 +1,54 @@
+"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 DataValidationError_1 = require("../errors/DataValidationError");
+/**
+ * The arguments for fetching cursored list in TweetService.
+ *
+ * @internal
+ */
+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 DataValidationError_1.DataValidationError(validationResult);
+        }
+    }
+    __decorate([
+        (0, class_validator_1.IsInt)(),
+        (0, class_validator_1.IsOptional)(),
+        (0, class_validator_1.Max)(100),
+        (0, class_validator_1.ValidateIf)(function (ob) { return ob.cursor.length == 0; }),
+        (0, class_validator_1.Min)(40),
+        __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/models/args/UserListArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserListArgs.js","sourceRoot":"","sources":["../../../src/models/args/UserListArgs.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,WAAW;AACX,mDAAkG;AAIlG,qEAAoE;AAEpE;;;;GAIG;AACH;IAkBI;;;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,yCAAmB,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACL,CAAC;IAtBD;QALC,IAAA,uBAAK,GAAE;QACP,IAAA,4BAAU,GAAE;QACZ,IAAA,qBAAG,EAAC,GAAG,CAAC;QACR,IAAA,4BAAU,EAAC,UAAA,EAAE,IAAI,OAAA,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAArB,CAAqB,CAAC;QACvC,IAAA,qBAAG,EAAC,EAAE,CAAC;;uCACM;IAKd;QAFC,IAAA,0BAAQ,GAAE;QACV,IAAA,4BAAU,GAAE;;wCACE;IAkBnB,mBAAC;CAAA,AAlCD,IAkCC;AAlCY,oCAAY"}

package/dist/models/auth/AuthCookie.d.ts

@@ -0,0 +1,21 @@
+import { IAuthCookie } from '../../types/Authentication';
+/**
+ * The cookie containing the tokens that are used to authenticate against Twitter.
+ *
+ * @internal
+ */
+export declare class AuthCookie implements IAuthCookie {
+    /** Token used to authenticate a device. */
+    kdt: string;
+    /** Token used to authenticate a user using a Twitter ID. */
+    twid: string;
+    /** The CSRF token of the session. */
+    ct0: string;
+    /** The authentication token used while logging in to the account. */
+    auth_token: string;
+    constructor(cookie?: IAuthCookie);
+    /**
+     * @returns The string respresentation of this cookie in the valid cookie string format.
+     */
+    toString(): string;
+}

package/dist/models/auth/AuthCookie.js

@@ -0,0 +1,33 @@
+"use strict";
+exports.__esModule = true;
+exports.AuthCookie = void 0;
+/**
+ * The cookie containing the tokens that are used to authenticate against Twitter.
+ *
+ * @internal
+ */
+var AuthCookie = /** @class */ (function () {
+    function AuthCookie(cookie) {
+        var _a, _b, _c, _d;
+        this.auth_token = (_a = cookie === null || cookie === void 0 ? void 0 : cookie.auth_token) !== null && _a !== void 0 ? _a : '';
+        this.ct0 = (_b = cookie === null || cookie === void 0 ? void 0 : cookie.ct0) !== null && _b !== void 0 ? _b : '';
+        this.kdt = (_c = cookie === null || cookie === void 0 ? void 0 : cookie.kdt) !== null && _c !== void 0 ? _c : '';
+        this.twid = (_d = cookie === null || cookie === void 0 ? void 0 : cookie.twid) !== null && _d !== void 0 ? _d : '';
+    }
+    /**
+     * @returns The string respresentation of this cookie in the valid cookie string format.
+     */
+    AuthCookie.prototype.toString = function () {
+        /** The string representation of this cookie. */
+        var cookieString = '';
+        // Iterating through the (key, value) pairs of this cookie
+        for (var _i = 0, _a = Object.entries(this); _i < _a.length; _i++) {
+            var _b = _a[_i], key = _b[0], value = _b[1];
+            cookieString += "".concat(key, "=").concat(value, ";");
+        }
+        return cookieString;
+    };
+    return AuthCookie;
+}());
+exports.AuthCookie = AuthCookie;
+//# sourceMappingURL=AuthCookie.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AuthCookie.js","sourceRoot":"","sources":["../../../src/models/auth/AuthCookie.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAaI,oBAAY,MAAoB;;QAC5B,IAAI,CAAC,UAAU,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,mCAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,6BAAQ,GAAR;QACI,gDAAgD;QAChD,IAAI,YAAY,GAAW,EAAE,CAAC;QAE9B,0DAA0D;QAC1D,KAAyB,UAAoB,EAApB,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAApB,cAAoB,EAApB,IAAoB,EAAE;YAAtC,IAAA,WAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YAChB,YAAY,IAAI,UAAG,GAAG,cAAI,KAAK,MAAG,CAAC;SACtC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IACL,iBAAC;AAAD,CAAC,AAlCD,IAkCC;AAlCY,gCAAU"}

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

@@ -0,0 +1,34 @@
+import { ICursor, ICursoredData } from "../../types/Service";
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @internal
+ */
+export declare class Cursor implements ICursor {
+    /** The cursor string. */
+    value: string;
+    /**
+     * Initializes a new cursor from the given cursor string.
+     *
+     * @param cursorStr The string representation of the cursor.
+     */
+    constructor(cursorStr: string);
+}
+/**
+ * The data that us fetched batch-wise along with a cursor.
+ *
+ * @internal
+ *
+ * @typeParam Type - The type of data present in the list.
+ */
+export declare class CursoredData<T> implements ICursoredData<T> {
+    /** The list of data of the given type. */
+    list: T[];
+    /** The cursor to the next batch of data. */
+    next: Cursor;
+    /**
+     * @param list The list of data item to store.
+     * @param next The cursor to the next batch of data.
+     */
+    constructor(list?: T[], next?: string);
+}

package/dist/models/data/CursoredData.js

@@ -0,0 +1,42 @@
+"use strict";
+exports.__esModule = true;
+exports.CursoredData = exports.Cursor = void 0;
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @internal
+ */
+var Cursor = /** @class */ (function () {
+    /**
+     * 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;
+/**
+ * The data that us fetched batch-wise along with a cursor.
+ *
+ * @internal
+ *
+ * @typeParam Type - The type of data present in the list.
+ */
+var CursoredData = /** @class */ (function () {
+    /**
+     * @param list The list of data item to store.
+     * @param next The cursor to the next batch of data.
+     */
+    function CursoredData(list, next) {
+        if (list === void 0) { list = []; }
+        if (next === void 0) { next = ''; }
+        this.list = list;
+        this.next = new Cursor(next);
+    }
+    return CursoredData;
+}());
+exports.CursoredData = CursoredData;
+//# sourceMappingURL=CursoredData.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CursoredData.js","sourceRoot":"","sources":["../../../src/models/data/CursoredData.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAII;;;;OAIG;IACH,gBAAY,SAAiB;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IACL,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM;AAcnB;;;;;;GAMG;AACH;IAOI;;;OAGG;IACH,sBAAY,IAAc,EAAE,IAAiB;QAAjC,qBAAA,EAAA,SAAc;QAAE,qBAAA,EAAA,SAAiB;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACL,mBAAC;AAAD,CAAC,AAfD,IAeC;AAfY,oCAAY"}

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

@@ -0,0 +1,18 @@
+import { ValidationError } from "class-validator";
+/**
+ * Error when any fields of a JSON data fails to validate.
+ *
+ * @param errorDetails The details of about the specific fields that failed to validate.
+ */
+export declare class DataValidationError implements Error {
+    /** The name of the error. */
+    name: string;
+    /** The user-friendly error message. */
+    message: string;
+    /** The error data. */
+    data: ValidationError[];
+    /**
+     * @param data The error details.
+     */
+    constructor(errorDetails: ValidationError[]);
+}

package/dist/models/data/DataValidationError.js

@@ -0,0 +1,21 @@
+"use strict";
+exports.__esModule = true;
+exports.DataValidationError = void 0;
+/**
+ * Error when any fields of a JSON data fails to validate.
+ *
+ * @param errorDetails The details of about the specific fields that failed to validate.
+ */
+var DataValidationError = /** @class */ (function () {
+    /**
+     * @param data The error details.
+     */
+    function DataValidationError(errorDetails) {
+        this.name = 'ValidationError';
+        this.message = 'One or more validation errors occured. Refer to data for details';
+        this.data = errorDetails;
+    }
+    return DataValidationError;
+}());
+exports.DataValidationError = DataValidationError;
+//# sourceMappingURL=DataValidationError.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataValidationError.js","sourceRoot":"","sources":["../../../src/models/data/DataValidationError.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAUI;;OAEG;IACH,6BAAY,YAA+B;QACvC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,kEAAkE,CAAC;QAClF,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC7B,CAAC;IACL,0BAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,kDAAmB"}

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

@@ -0,0 +1,18 @@
+import { ValidationError } from "class-validator";
+/**
+ * Error when any fields of a JSON data fails to validate.
+ *
+ * @param errorDetails The details of about the specific fields that failed to validate.
+ */
+export declare class DataValidationError implements Error {
+    /** The name of the error. */
+    name: string;
+    /** The user-friendly error message. */
+    message: string;
+    /** The error data. */
+    data: ValidationError[];
+    /**
+     * @param data The error details.
+     */
+    constructor(errorDetails: ValidationError[]);
+}

package/dist/models/data/Errors.js

@@ -0,0 +1,21 @@
+"use strict";
+exports.__esModule = true;
+exports.DataValidationError = void 0;
+/**
+ * Error when any fields of a JSON data fails to validate.
+ *
+ * @param errorDetails The details of about the specific fields that failed to validate.
+ */
+var DataValidationError = /** @class */ (function () {
+    /**
+     * @param data The error details.
+     */
+    function DataValidationError(errorDetails) {
+        this.name = 'ValidationError';
+        this.message = 'One or more validation errors occured. Refer to data for details';
+        this.data = errorDetails;
+    }
+    return DataValidationError;
+}());
+exports.DataValidationError = DataValidationError;
+//# sourceMappingURL=Errors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../../../src/models/data/Errors.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAUI;;OAEG;IACH,6BAAY,YAA+B;QACvC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,kEAAkE,CAAC;QAClF,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC7B,CAAC;IACL,0BAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,kDAAmB"}

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

@@ -0,0 +1,33 @@
+import { CursoredDataInterface } from "../../types/interfaces/Service";
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+export declare class Cursor {
+    /** The cursor string. */
+    value: string;
+    /**
+     * Initializes a new cursor from the given cursor string.
+     *
+     * @param cursorStr The string representation of the cursor.
+     */
+    constructor(cursorStr: string);
+}
+/**
+ * The data that us fetched batch-wise along with a cursor.
+ *
+ * @typeParam Type - The type of data present in the list.
+ * @public
+ */
+export declare class CursoredData<T> implements CursoredDataInterface<T> {
+    /** The list of data of the given type. */
+    list: T[];
+    /** The cursor to the next batch of data. */
+    next: Cursor;
+    /**
+     * @param list The list of data item to store.
+     * @param next The cursor to the next batch of data.
+     */
+    constructor(list?: T[], next?: string);
+}

package/dist/models/data/Service.js

@@ -0,0 +1,41 @@
+"use strict";
+exports.__esModule = true;
+exports.CursoredData = exports.Cursor = void 0;
+/**
+ * The cursor to the batch of data to be fetched.
+ *
+ * @public
+ */
+var Cursor = /** @class */ (function () {
+    /**
+     * 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;
+/**
+ * The data that us fetched batch-wise along with a cursor.
+ *
+ * @typeParam Type - The type of data present in the list.
+ * @public
+ */
+var CursoredData = /** @class */ (function () {
+    /**
+     * @param list The list of data item to store.
+     * @param next The cursor to the next batch of data.
+     */
+    function CursoredData(list, next) {
+        if (list === void 0) { list = []; }
+        if (next === void 0) { next = ''; }
+        this.list = list;
+        this.next = new Cursor(next);
+    }
+    return CursoredData;
+}());
+exports.CursoredData = CursoredData;
+//# sourceMappingURL=Service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../../src/models/data/Service.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH;IAII;;;;OAIG;IACH,gBAAY,SAAiB;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IACL,aAAC;AAAD,CAAC,AAZD,IAYC;AAZY,wBAAM;AAcnB;;;;;GAKG;AACH;IAOI;;;OAGG;IACH,sBAAY,IAAc,EAAE,IAAiB;QAAjC,qBAAA,EAAA,SAAc;QAAE,qBAAA,EAAA,SAAiB;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACL,mBAAC;AAAD,CAAC,AAfD,IAeC;AAfY,oCAAY"}

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

@@ -0,0 +1,53 @@
+import { ITweet, ITweetEntities } from '../../types/Tweet';
+import { Result as RawTweet, Entities2 as RawTweetEntities } from '../../types/raw/tweet/Tweet';
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @internal
+ */
+export declare class TweetEntities implements 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[];
+    constructor(entities: RawTweetEntities);
+}
+/**
+ * The details of a single Tweet.
+ *
+ * @internal
+ */
+export declare class Tweet implements 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;
+    /** Additional tweet entities like urls, mentions, etc. */
+    entities: TweetEntities;
+    /** 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;
+    /**
+     * @param tweet The raw tweet data.
+     */
+    constructor(tweet: RawTweet);
+}