@youmind-openlab/rettiwt-api 1.0.0

package/src/index.ts

@@ -0,0 +1,128 @@
+// MAIN
+export * from './Rettiwt';
+
+// ENUMS
+export * from './enums/raw/Analytics';
+export * from './enums/raw/Media';
+export * from './enums/raw/Notification';
+export * from './enums/raw/Tweet';
+export * from './enums/Api';
+export * from './enums/Authentication';
+export * from './enums/Data';
+export * from './enums/Logging';
+export * from './enums/Media';
+export * from './enums/Notification';
+export * from './enums/Resource';
+export * from './enums/Tweet';
+
+// MODELS
+export * from './models/args/FetchArgs';
+export * from './models/args/PostArgs';
+export * from './models/args/ProfileArgs';
+export * from './models/data/BookmarkFolder';
+export * from './models/data/Conversation';
+export * from './models/data/CursoredData';
+export * from './models/data/DirectMessage';
+export * from './models/data/Inbox';
+export * from './models/data/List';
+export * from './models/data/Notification';
+export * from './models/data/Tweet';
+export * from './models/data/User';
+export * from './models/errors/TwitterError';
+
+// REQUESTS
+export * from './requests/DirectMessage';
+export * from './requests/List';
+export * from './requests/Media';
+export * from './requests/Tweet';
+export * from './requests/User';
+
+// SERVICES
+export * from './services/public/DirectMessageService';
+export * from './services/public/FetcherService';
+export * from './services/public/ListService';
+export * from './services/public/TweetService';
+export * from './services/public/UserService';
+
+// TYPES
+export * from './types/args/FetchArgs';
+export * from './types/args/PostArgs';
+export * from './types/args/ProfileArgs';
+export * from './types/data/BookmarkFolder';
+export * from './types/data/Conversation';
+export * from './types/data/CursoredData';
+export * from './types/data/DirectMessage';
+export * from './types/data/Inbox';
+export * from './types/data/List';
+export * from './types/data/Notification';
+export * from './types/data/Tweet';
+export * from './types/data/User';
+export * from './types/errors/TwitterError';
+export * from './types/params/Variables';
+export { IAnalytics as IRawAnalytics } from './types/raw/base/Analytic';
+export { IBookmarkFolder as IRawBookmarkFolder } from './types/raw/base/BookmarkFolder';
+export { ICursor as IRawCursor } from './types/raw/base/Cursor';
+export { IErrorData as IRawErrorData, IErrorDetails as IRawErrorDetails } from './types/raw/base/Error';
+export { ILimitedVisibilityTweet as IRawLimitedVisibilityTweet } from './types/raw/base/LimitedVisibilityTweet';
+export { IList as IRawList } from './types/raw/base/List';
+export { IMedia as IRawMedia } from './types/raw/base/Media';
+export { IMessage as IRawMessage } from './types/raw/base/Message';
+export { INotification as IRawNotification } from './types/raw/base/Notification';
+export { ISpace as IRawSpace } from './types/raw/base/Space';
+export { ITweet as IRawTweet } from './types/raw/base/Tweet';
+export { IUser as IRawUser } from './types/raw/base/User';
+export { IDataResult as IRawDataResult } from './types/raw/composite/DataResult';
+export { ITimelineTweet as IRawTimelineTweet } from './types/raw/composite/TimelineTweet';
+export { ITimelineUser as IRawTimelineUser } from './types/raw/composite/TimelineUser';
+export { IResponse as IRawResponse } from './types/raw/generic/Response';
+export { IListMemberAddResponse as IRawListMemberAddResponse } from './types/raw/list/AddMember';
+export { IListMemberRemoveResponse as IRawListMemberRemoveResponse } from './types/raw/list/RemoveMember';
+export { IListDetailsResponse as IRawListDetailsResponse } from './types/raw/list/Details';
+export { IListMembersResponse as IRawListMembersResponse } from './types/raw/list/Members';
+export { IListTweetsResponse as IRawListTweetsResponse } from './types/raw/list/Tweets';
+export { IMediaFinalizeUploadResponse as IRawMediaFinalizeUploadResponse } from './types/raw/media/FinalizeUpload';
+export { IMediaInitializeUploadResponse as IRawMediaInitializeUploadResponse } from './types/raw/media/InitalizeUpload';
+export { IMediaLiveVideoStreamResponse as IRawMediaLiveVideoStreamResponse } from './types/raw/media/LiveVideoStream';
+export { ITweetDetailsResponse as IRawTweetDetailsResponse } from './types/raw/tweet/Details';
+export { ITweetDetailsBulkResponse as IRawTweetDetailsBulkResponse } from './types/raw/tweet/DetailsBulk';
+export { ITweetLikeResponse as IRawTweetLikeResponse } from './types/raw/tweet/Like';
+export { ITweetLikersResponse as IRawTweetLikersResponse } from './types/raw/tweet/Likers';
+export { ITweetPostResponse as IRawTweetPostResponse } from './types/raw/tweet/Post';
+export { ITweetRepliesResponse as IRawTweetRepliesResponse } from './types/raw/tweet/Replies';
+export { ITweetRetweetResponse as IRawTweetRetweetResponse } from './types/raw/tweet/Retweet';
+export { ITweetRetweetersResponse as IRawTweetRetweetersResponse } from './types/raw/tweet/Retweeters';
+export { ITweetScheduleResponse as IRawTweetScheduleResponse } from './types/raw/tweet/Schedule';
+export { ITweetSearchResponse as IRawTweetSearchResponse } from './types/raw/tweet/Search';
+export { ITweetUnlikeResponse as IRawTweetUnlikeResponse } from './types/raw/tweet/Unlike';
+export { ITweetUnpostResponse as IRawTweetUnpostResponse } from './types/raw/tweet/Unpost';
+export { ITweetUnretweetResponse as IRawTweetUnretweetResponse } from './types/raw/tweet/Unretweet';
+export { ITweetUnscheduleResponse as ITRawTweetUnscheduleResponse } from './types/raw/tweet/Unschedule';
+export { IUserAffiliatesResponse as IRawUserAffiliatesResponse } from './types/raw/user/Affiliates';
+export { IUserAnalyticsResponse as IRawUserAnalyticsResponse } from './types/raw/user/Analytics';
+export { IUserBookmarkFoldersResponse as IRawUserBookmarkFoldersResponse } from './types/raw/user/BookmarkFolders';
+export { IUserBookmarkFolderTweetsResponse as IRawUserBookmarkFolderTweetsResponse } from './types/raw/user/BookmarkFolderTweets';
+export { IUserBookmarksResponse as IRawUserBookmarksResponse } from './types/raw/user/Bookmarks';
+export { IUserDetailsResponse as IRawUserDetailsResponse } from './types/raw/user/Details';
+export { IUserDetailsBulkResponse as IRawUserDetailsBulkResponse } from './types/raw/user/DetailsBulk';
+export { IUserFollowResponse as IRawUserFollowResponse } from './types/raw/user/Follow';
+export { IUserFollowedResponse as IRawUserFollowedResponse } from './types/raw/user/Followed';
+export { IUserFollowersResponse as IRawUserFollowersResponse } from './types/raw/user/Followers';
+export { IUserFollowingResponse as IRawUserFollowingResponse } from './types/raw/user/Following';
+export { IUserHighlightsResponse as IRawUserHighlightsResponse } from './types/raw/user/Highlights';
+export { IUserLikesResponse as IRawUserLikesResponse } from './types/raw/user/Likes';
+export { IUserMediaResponse as IRawUserMediaResponse } from './types/raw/user/Media';
+export { IUserNotificationsResponse as IRawUserNotificationsResponse } from './types/raw/user/Notifications';
+export { IUserRecommendedResponse as IRawUserRecommendedResponse } from './types/raw/user/Recommended';
+export { IUserSearchResponse as IRawUserSearchResponse } from './types/raw/user/Search';
+export { IUserScheduledResponse as IRawUserScheduledResponse } from './types/raw/user/Scheduled';
+export { IUserSubscriptionsResponse as IRawUserSubscriptionsResponse } from './types/raw/user/Subscriptions';
+export { IUserTweetsResponse as IRawUserTweetsResponse } from './types/raw/user/Tweets';
+export { IUserTweetsAndRepliesResponse as IRawUserTweetsAndRepliesResponse } from './types/raw/user/TweetsAndReplies';
+export { IUserUnfollowResponse as IRawUserUnfollowResponse } from './types/raw/user/Unfollow';
+export { IUserProfileUpdateResponse as IRawUserProfileUpdateResponse } from './types/raw/user/ProfileUpdate';
+export * from './types/ErrorHandler';
+export * from './types/RettiwtConfig';
+export { IConversationTimelineResponse as IRawConversationTimelineResponse } from './types/raw/dm/Conversation';
+export { IInboxInitialResponse as IRawInboxInitialResponse } from './types/raw/dm/InboxInitial';
+export { IInboxTimelineResponse as IRawInboxTimelineResponse } from './types/raw/dm/InboxTimeline';
+export { IUserUpdatesResponse as IRawUserUpdatesResponse } from './types/raw/dm/UserUpdates';

package/src/models/RettiwtConfig.ts

@@ -0,0 +1,101 @@
+import { Agent } from 'https';
+
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+import { AuthService } from '../services/internal/AuthService';
+import { IErrorHandler } from '../types/ErrorHandler';
+import { IRettiwtConfig } from '../types/RettiwtConfig';
+
+/**
+ * The default headers.
+ *
+ * @public
+ */
+const DefaultHeaders = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	Authority: 'x.com',
+	'Accept-Language': 'en-US,en;q=0.9',
+	'Cache-Control': 'no-cache',
+	Referer: 'https://x.com',
+	'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0',
+	'X-Twitter-Active-User': 'yes',
+	'X-Twitter-Client-Language': 'en',
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};
+
+/**
+ * The configuration for initializing a new Rettiwt instance.
+ *
+ * @public
+ */
+export class RettiwtConfig implements IRettiwtConfig {
+	// Parameters for internal use
+	private _apiKey?: string;
+	private _headers: { [key: string]: string };
+	private _httpsAgent: Agent;
+	private _userId: string | undefined;
+
+	// Parameters that can be set once, upon initialization
+	public readonly delay?: number | (() => number | Promise<number>);
+	public readonly errorHandler?: IErrorHandler;
+	public readonly logging?: boolean;
+	public readonly maxRetries: number;
+	public readonly timeout?: number;
+
+	/**
+	 * @param config - The config for Rettiwt of type {@link IRettiwtConfig}.
+	 */
+	public constructor(config?: IRettiwtConfig) {
+		this._apiKey = config?.apiKey;
+		this._httpsAgent = config?.proxyUrl ? new HttpsProxyAgent(config?.proxyUrl) : new Agent();
+		this._userId = config?.apiKey ? AuthService.getUserId(config?.apiKey) : undefined;
+		this.delay = config?.delay ?? 0;
+		this.maxRetries = config?.maxRetries ?? 0;
+		this.errorHandler = config?.errorHandler;
+		this.logging = config?.logging;
+		this.timeout = config?.timeout;
+		this.apiKey = config?.apiKey;
+		this._headers = {
+			...DefaultHeaders,
+			...config?.headers,
+		};
+	}
+
+	public get apiKey(): string | undefined {
+		return this._apiKey;
+	}
+
+	public get headers(): { [key: string]: string } {
+		return this._headers;
+	}
+
+	/** The HTTPS agent instance to use. */
+	public get httpsAgent(): Agent {
+		return this._httpsAgent;
+	}
+
+	/** The ID of the user associated with the API key, if any. */
+	public get userId(): string | undefined {
+		return this._userId;
+	}
+
+	public set apiKey(apiKey: string | undefined) {
+		this._apiKey = apiKey;
+		this._userId = apiKey ? AuthService.getUserId(apiKey) : undefined;
+	}
+
+	public set headers(headers: { [key: string]: string } | undefined) {
+		this._headers = {
+			...DefaultHeaders,
+			...headers,
+		};
+	}
+
+	public set proxyUrl(proxyUrl: URL | undefined) {
+		this._httpsAgent = proxyUrl ? new HttpsProxyAgent(proxyUrl) : new Agent();
+	}
+}
+
+export { DefaultHeaders as DefaultRettiwtHeaders };

package/src/models/args/FetchArgs.ts

@@ -0,0 +1,169 @@
+import { TweetRepliesSortType } from '../../enums/Tweet';
+import { IFetchArgs, ITweetFilter } from '../../types/args/FetchArgs';
+
+import type { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
+/**
+ * Options specifying the data that is to be fetched.
+ *
+ * @public
+ */
+export class FetchArgs implements IFetchArgs {
+	public activeConversationId?: string;
+	public conversationId?: string;
+	public count?: number;
+	public cursor?: string;
+	public filter?: TweetFilter;
+	public fromTime?: Date;
+	public granularity?: RawAnalyticsGranularity;
+	public id?: string;
+	public ids?: string[];
+	public maxId?: string;
+	public metrics?: RawAnalyticsMetric[];
+	public showVerifiedFollowers?: boolean;
+	public sortBy?: TweetRepliesSortType;
+	public toTime?: Date;
+
+	/**
+	 * @param args - Additional user-defined arguments for fetching the resource.
+	 */
+	public constructor(args: IFetchArgs) {
+		this.id = args.id;
+		this.ids = args.ids;
+		this.count = args.count;
+		this.cursor = args.cursor;
+		this.filter = args.filter ? new TweetFilter(args.filter) : undefined;
+		this.sortBy = args.sortBy;
+		this.fromTime = args.fromTime;
+		this.toTime = args.toTime;
+		this.granularity = args.granularity;
+		this.metrics = args.metrics;
+		this.showVerifiedFollowers = args.showVerifiedFollowers;
+		this.activeConversationId = args.activeConversationId;
+		this.conversationId = args.conversationId;
+		this.maxId = args.maxId;
+	}
+}
+
+/**
+ * The filter to be used for searching tweets.
+ *
+ * @public
+ */
+export class TweetFilter implements ITweetFilter {
+	public endDate?: Date;
+	public excludeWords?: string[];
+	public fromUsers?: string[];
+	public hashtags?: string[];
+	public includePhrase?: string;
+	public includeWords?: string[];
+	public language?: string;
+	public list?: string;
+	public maxId?: string;
+	public mentions?: string[];
+	public minLikes?: number;
+	public minReplies?: number;
+	public minRetweets?: number;
+	public onlyLinks?: boolean;
+	public onlyOriginal?: boolean;
+	public onlyReplies?: boolean;
+	public onlyText?: boolean;
+	public optionalWords?: string[];
+	public quoted?: string;
+	public sinceId?: string;
+	public startDate?: Date;
+	public toUsers?: string[];
+	public top?: boolean;
+
+	/**
+	 * @param filter - The filter configuration.
+	 */
+	public constructor(filter: ITweetFilter) {
+		this.endDate = filter.endDate;
+		this.excludeWords = filter.excludeWords;
+		this.fromUsers = filter.fromUsers;
+		this.hashtags = filter.hashtags;
+		this.includePhrase = filter.includePhrase;
+		this.language = filter.language;
+		this.list = filter.list;
+		this.mentions = filter.mentions;
+		this.quoted = filter.quoted;
+		this.sinceId = filter.sinceId;
+		this.maxId = filter.maxId;
+		this.minLikes = filter.minLikes;
+		this.minReplies = filter.minReplies;
+		this.minRetweets = filter.minRetweets;
+		this.onlyLinks = filter.onlyLinks;
+		this.onlyOriginal = filter.onlyOriginal;
+		this.onlyReplies = filter.onlyReplies;
+		this.onlyText = filter.onlyText;
+		this.optionalWords = filter.optionalWords;
+		this.startDate = filter.startDate;
+		this.toUsers = filter.toUsers;
+		this.top = filter.top;
+		this.includeWords = filter.includeWords;
+	}
+
+	/**
+	 * Convert Date object to Twitter string representation.
+	 * eg - 2023-06-23_11:21:06_UTC
+	 *
+	 * @param date - The date object to convert.
+	 * @returns The Twitter string representation of the date.
+	 */
+	private static _dateToTwitterString(date: Date): string {
+		// Converting localized date to UTC date
+		const utc = new Date(
+			Date.UTC(
+				date.getUTCFullYear(),
+				date.getUTCMonth(),
+				date.getUTCDate(),
+				date.getUTCHours(),
+				date.getUTCMinutes(),
+				date.getUTCSeconds(),
+			),
+		);
+
+		/**
+		 * To convert ISO 8601 date string to Twitter date string:
+		 *
+		 * - 'T' between date and time substring is replace with '_'.
+		 * - Milliseconds substring is omitted.
+		 * - '_UTC' is appended as suffix.
+		 */
+		return utc.toISOString().replace(/T/, '_').replace(/\..+/, '') + '_UTC';
+	}
+
+	/**
+	 * @returns The string representation of 'this' filter.
+	 */
+	public toString(): string {
+		return (
+			[
+				this.includeWords ? this.includeWords.join(' ') : '',
+				this.includePhrase ? `"${this.includePhrase}"` : '',
+				this.optionalWords ? `(${this.optionalWords.join(' OR ')})` : '',
+				this.excludeWords ? `${this.excludeWords.map((word) => '-' + word).join(' ')}` : '',
+				this.hashtags ? `(${this.hashtags.map((hashtag) => '#' + hashtag).join(' OR ')})` : '',
+				this.fromUsers ? `(${this.fromUsers.map((user) => `from:${user}`).join(' OR ')})` : '',
+				this.toUsers ? `(${this.toUsers.map((user) => `to:${user}`).join(' OR ')})` : '',
+				this.list ? `list:${this.list}` : '',
+				this.mentions ? `(${this.mentions.map((mention) => '@' + mention).join(' OR ')})` : '',
+				this.minReplies ? `min_replies:${this.minReplies}` : '',
+				this.minLikes ? `min_faves:${this.minLikes}` : '',
+				this.minRetweets ? `min_retweets:${this.minRetweets}` : '',
+				this.language ? `lang:${this.language}` : '',
+				this.startDate ? `since:${TweetFilter._dateToTwitterString(this.startDate)}` : '',
+				this.endDate ? `until:${TweetFilter._dateToTwitterString(this.endDate)}` : '',
+				this.sinceId ? `since_id:${this.sinceId}` : '',
+				this.maxId ? `max_id:${this.maxId}` : '',
+				this.quoted ? `quoted_tweet_id:${this.quoted}` : '',
+			]
+				.filter((item) => item !== '()' && item !== '')
+				.join(' ') +
+			(this.onlyText === true ? ' -filter:links' : '') +
+			(this.onlyOriginal === true ? ' -filter:replies' : '') +
+			(this.onlyLinks === true ? ' filter:links' : '') +
+			(this.onlyReplies === true ? ' filter:replies' : '')
+		);
+	}
+}

package/src/models/args/PostArgs.ts

@@ -0,0 +1,93 @@
+import { INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
+
+import { ProfileUpdateOptions } from './ProfileArgs';
+
+/**
+ * Options specifying the data that is to be posted.
+ *
+ * @public
+ */
+export class PostArgs implements IPostArgs {
+	public conversationId?: string;
+	public id?: string;
+	public profileOptions?: ProfileUpdateOptions;
+	public tweet?: NewTweet;
+	public upload?: UploadArgs;
+	public userId?: string;
+
+	/**
+	 * @param resource - The resource to be posted.
+	 * @param args - Additional user-defined arguments for posting the resource.
+	 */
+	public constructor(args: IPostArgs) {
+		this.id = args.id;
+		this.tweet = args.tweet ? new NewTweet(args.tweet) : undefined;
+		this.upload = args.upload ? new UploadArgs(args.upload) : undefined;
+		this.userId = args.userId;
+		this.conversationId = args.conversationId;
+		this.profileOptions = args.profileOptions ? new ProfileUpdateOptions(args.profileOptions) : undefined;
+	}
+}
+
+/**
+ * Configuration for the new tweet to be posted.
+ *
+ * @public
+ */
+export class NewTweet implements INewTweet {
+	public media?: NewTweetMedia[];
+	public quote?: string;
+	public replyTo?: string;
+	public scheduleFor?: Date;
+	public text: string;
+
+	/**
+	 * @param newTweet - The args specifying the new tweet to be posted.
+	 */
+	public constructor(newTweet: INewTweet) {
+		this.media = newTweet.media;
+		this.quote = newTweet.quote;
+		this.replyTo = newTweet.replyTo;
+		this.scheduleFor = newTweet.scheduleFor;
+		this.text = newTweet.text ?? '';
+	}
+}
+
+/**
+ * Configuration for the media to be uploaded.
+ *
+ * @public
+ */
+export class NewTweetMedia implements INewTweetMedia {
+	public id: string;
+	public tags?: string[];
+
+	/**
+	 * @param newTweetMedia - The args specifying the new media to be posted along with the tweet.
+	 */
+	public constructor(newTweetMedia: INewTweetMedia) {
+		this.id = newTweetMedia.id;
+		this.tags = newTweetMedia.tags;
+	}
+}
+
+/**
+ * Options specifying the media file to be uploaded.
+ *
+ * @public
+ */
+export class UploadArgs implements IUploadArgs {
+	public id?: string;
+	public media?: string | ArrayBuffer | Blob;
+	public size?: number;
+
+	/**
+	 * @param step - The upload step.
+	 * @param args - The upload arguments for uploading the media file.
+	 */
+	public constructor(args: IUploadArgs) {
+		this.size = args.size;
+		this.media = args.media;
+		this.id = args.id;
+	}
+}

package/src/models/args/ProfileArgs.ts

@@ -0,0 +1,68 @@
+import { IProfileUpdateOptions } from '../../types/args/ProfileArgs';
+
+/**
+ * Configuration for profile update.
+ *
+ * @public
+ */
+export class ProfileUpdateOptions implements IProfileUpdateOptions {
+	public description?: string;
+	public location?: string;
+	public name?: string;
+	public url?: string;
+
+	/**
+	 * @param options - The options specifying the profile fields to update.
+	 */
+	public constructor(options: IProfileUpdateOptions) {
+		this.description = options.description;
+		this.location = options.location;
+		this.name = options.name;
+		this.url = options.url;
+
+		// At least one field must be provided
+		if (
+			this.name === undefined &&
+			this.url === undefined &&
+			this.location === undefined &&
+			this.description === undefined
+		) {
+			throw new Error('At least one profile field must be provided');
+		}
+
+		// Name validation
+		if (this.name !== undefined) {
+			if (this.name.trim().length === 0) {
+				throw new Error('Name cannot be empty');
+			}
+			if (this.name.length > 50) {
+				throw new Error('Name cannot exceed 50 characters');
+			}
+		}
+
+		// URL validation (minimal - just check if not empty when provided)
+		if (this.url !== undefined && this.url.trim().length === 0) {
+			throw new Error('URL cannot be empty');
+		}
+
+		// Location validation
+		if (this.location !== undefined) {
+			if (this.location.trim().length === 0) {
+				throw new Error('Location cannot be empty');
+			}
+			if (this.location.length > 30) {
+				throw new Error('Location cannot exceed 30 characters');
+			}
+		}
+
+		// Description validation
+		if (this.description !== undefined) {
+			if (this.description.trim().length === 0) {
+				throw new Error('Description cannot be empty');
+			}
+			if (this.description.length > 160) {
+				throw new Error('Description cannot exceed 160 characters');
+			}
+		}
+	}
+}

package/src/models/auth/AuthCookie.ts

@@ -0,0 +1,58 @@
+import { Cookie } from 'cookiejar';
+
+import { IAuthCookie } from '../../types/auth/AuthCookie';
+
+/**
+ * The cookie containing the tokens that are used to authenticate against Twitter.
+ *
+ * @internal
+ */
+export class AuthCookie implements IAuthCookie {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	public auth_token: string;
+	public ct0: string;
+	public kdt: string;
+	public twid: string;
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+
+	/**
+	 * @param cookies - The cookie list obtained from the browser.
+	 */
+	public constructor(cookies: Cookie[]) {
+		// Initializing defaults
+		this.auth_token = '';
+		this.ct0 = '';
+		this.kdt = '';
+		this.twid = '';
+
+		// Parsing the cookies
+		for (const cookie of cookies) {
+			if (cookie.name == 'kdt') {
+				this.kdt = cookie.value;
+			} else if (cookie.name == 'twid') {
+				this.twid = cookie.value;
+			} else if (cookie.name == 'ct0') {
+				this.ct0 = cookie.value;
+			} else if (cookie.name == 'auth_token') {
+				this.auth_token = cookie.value;
+			}
+		}
+	}
+
+	/**
+	 * @returns the string representation of 'this' object.
+	 */
+	public toString(): string {
+		/** The string representation of 'this' object. */
+		let outStr = '';
+
+		// Iterating through the (key, value) pairs of this cookie
+		for (const [key, value] of Object.entries(this)) {
+			outStr += `${key}=${value as string};`;
+		}
+
+		return outStr;
+	}
+}