rettiwt-api 6.3.0-alpha.0 → 7.0.0

package/src/index.ts

@@ -26,14 +26,17 @@ export * from './models/data/DirectMessage';
 export * from './models/data/Inbox';
 export * from './models/data/List';
 export * from './models/data/Notification';
+export * from './models/data/Space';
 export * from './models/data/Tweet';
 export * from './models/data/User';
+export * from './models/data/UserAbout';
 export * from './models/errors/TwitterError';
 
 // REQUESTS
 export * from './requests/DirectMessage';
 export * from './requests/List';
 export * from './requests/Media';
+export * from './requests/Space';
 export * from './requests/Tweet';
 export * from './requests/User';
 
@@ -41,6 +44,7 @@ export * from './requests/User';
 export * from './services/public/DirectMessageService';
 export * from './services/public/FetcherService';
 export * from './services/public/ListService';
+export * from './services/public/SpaceService';
 export * from './services/public/TweetService';
 export * from './services/public/UserService';
 
@@ -55,8 +59,10 @@ export * from './types/data/DirectMessage';
 export * from './types/data/Inbox';
 export * from './types/data/List';
 export * from './types/data/Notification';
+export * from './types/data/Space';
 export * from './types/data/Tweet';
 export * from './types/data/User';
+export * from './types/data/UserAbout';
 export * from './types/errors/TwitterError';
 export * from './types/params/Variables';
 export { IAnalytics as IRawAnalytics } from './types/raw/base/Analytic';
@@ -68,7 +74,7 @@ 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 { 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';
@@ -83,6 +89,7 @@ export { IListTweetsResponse as IRawListTweetsResponse } from './types/raw/list/
 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 { IAudioSpaceByIdResponse as IRawSpaceDetailsResponse } from './types/raw/space/AudioSpaceById';
 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';
@@ -97,6 +104,7 @@ export { ITweetUnlikeResponse as IRawTweetUnlikeResponse } from './types/raw/twe
 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 { IUserAboutResponse as IRawUserAboutResponse } from './types/raw/user/About';
 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';
@@ -120,6 +128,8 @@ export { IUserTweetsResponse as IRawUserTweetsResponse } from './types/raw/user/
 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 { IUserSettingsResponse as IRawUserSettingsResponse } from './types/raw/user/Settings';
+export { IUserChangePasswordResponse as IRawUserChangePasswordResponse } from './types/raw/user/ChangePassword';
 export * from './types/ErrorHandler';
 export * from './types/RettiwtConfig';
 export { IConversationTimelineResponse as IRawConversationTimelineResponse } from './types/raw/dm/Conversation';

package/src/models/RettiwtConfig.ts

@@ -1,6 +1,10 @@
-import { Agent } from 'https';
+import { Agent as HttpAgent } from 'http';
+import { Agent as HttpsAgent } from 'https';
 
+import { AxiosProxyConfig, AxiosResponse } from 'axios';
+import { HttpProxyAgent } from 'http-proxy-agent';
 import { HttpsProxyAgent } from 'https-proxy-agent';
+import { SocksProxyAgent } from 'socks-proxy-agent';
 
 import { AuthService } from '../services/internal/AuthService';
 import { IErrorHandler } from '../types/ErrorHandler';
@@ -34,7 +38,9 @@ export class RettiwtConfig implements IRettiwtConfig {
 	// Parameters for internal use
 	private _apiKey?: string;
 	private _headers: { [key: string]: string };
-	private _httpsAgent: Agent;
+	private _httpAgent: HttpAgent;
+	private _httpsAgent: HttpsAgent;
+	private _proxy?: AxiosProxyConfig | string | null;
 	private _userId: string | undefined;
 
 	// Parameters that can be set once, upon initialization
@@ -42,6 +48,7 @@ export class RettiwtConfig implements IRettiwtConfig {
 	public readonly errorHandler?: IErrorHandler;
 	public readonly logging?: boolean;
 	public readonly maxRetries: number;
+	public readonly responseMiddleware?: (response: AxiosResponse) => void | Promise<void>;
 	public readonly timeout?: number;
 
 	/**
@@ -49,11 +56,12 @@ export class RettiwtConfig implements IRettiwtConfig {
 	 */
 	public constructor(config?: IRettiwtConfig) {
 		this._apiKey = config?.apiKey;
-		this._httpsAgent = config?.proxyUrl ? new HttpsProxyAgent(config?.proxyUrl) : new Agent();
+		this._proxy = config?.proxy;
 		this._userId = config?.apiKey ? AuthService.getUserId(config?.apiKey) : undefined;
 		this.delay = config?.delay ?? 0;
 		this.maxRetries = config?.maxRetries ?? 0;
 		this.errorHandler = config?.errorHandler;
+		this.responseMiddleware = config?.responseMiddleware;
 		this.logging = config?.logging;
 		this.timeout = config?.timeout;
 		this.apiKey = config?.apiKey;
@@ -61,18 +69,49 @@ export class RettiwtConfig implements IRettiwtConfig {
 			...DefaultHeaders,
 			...config?.headers,
 		};
+
+		// Initializing the HTTP(S) agent(s)
+		const agents = this._getRequestAgents(config?.proxy);
+		this._httpAgent = agents.httpAgent;
+		this._httpsAgent = agents.httpsAgent;
 	}
 
 	public get apiKey(): string | undefined {
 		return this._apiKey;
 	}
 
+	/**
+	 * The Axios proxy configuration to use.
+	 *
+	 * @remarks
+	 * <br>
+	 * - If `proxy` is set, Axios' built-in env-variable-based proxy is disabled.
+	 */
+	public get axiosProxyConfig(): AxiosProxyConfig | false | undefined {
+		// If user explicitly set to null or a proxy URL, disable Axios' built-in proxy
+		if (this._proxy === null || typeof this._proxy === 'string') {
+			return false;
+		}
+		// If user has set an AxiosProxyConfig, use that
+		if (this._proxy !== undefined) {
+			return this._proxy;
+		}
+
+		// Default: Let axios use it's built-in env-variable-based proxy.
+		return undefined;
+	}
+
 	public get headers(): { [key: string]: string } {
 		return this._headers;
 	}
 
+	/** The HTTP agent instance to use. */
+	public get httpAgent(): HttpAgent {
+		return this._httpAgent;
+	}
+
 	/** The HTTPS agent instance to use. */
-	public get httpsAgent(): Agent {
+	public get httpsAgent(): HttpsAgent {
 		return this._httpsAgent;
 	}
 
@@ -93,8 +132,44 @@ export class RettiwtConfig implements IRettiwtConfig {
 		};
 	}
 
-	public set proxyUrl(proxyUrl: URL | undefined) {
-		this._httpsAgent = proxyUrl ? new HttpsProxyAgent(proxyUrl) : new Agent();
+	public set proxy(proxy: AxiosProxyConfig | string | null | undefined) {
+		// Update HTTP(s) agents
+		const agents = this._getRequestAgents(proxy);
+		this._httpAgent = agents.httpAgent;
+		this._httpsAgent = agents.httpsAgent;
+
+		this._proxy = proxy;
+	}
+
+	/**
+	 * Returns the appropriate HTTP(s) agents based on the type of proxy config.
+	 *
+	 * @param proxy - The proxy configuration.
+	 *
+	 * @returns The HTTP(s) agents.
+	 */
+	private _getRequestAgents(proxy?: AxiosProxyConfig | string | null): {
+		httpAgent: HttpAgent;
+		httpsAgent: HttpsAgent;
+	} {
+		let httpAgent: HttpAgent | undefined;
+		let httpsAgent: HttpsAgent | undefined;
+
+		if (typeof proxy === 'string' && (proxy.startsWith('http://') || proxy.startsWith('https://'))) {
+			httpAgent = new HttpProxyAgent(proxy);
+			httpsAgent = new HttpsProxyAgent(proxy);
+		} else if (typeof proxy === 'string' && proxy.startsWith('socks')) {
+			httpAgent = new SocksProxyAgent(proxy);
+			httpsAgent = new SocksProxyAgent(proxy);
+		} else {
+			httpAgent = new HttpAgent();
+			httpsAgent = new HttpsAgent();
+		}
+
+		return {
+			httpAgent: httpAgent,
+			httpsAgent: httpsAgent,
+		};
 	}
 }
 

package/src/models/args/FetchArgs.ts

@@ -17,11 +17,14 @@ export class FetchArgs implements IFetchArgs {
 	public granularity?: RawAnalyticsGranularity;
 	public id?: string;
 	public ids?: string[];
+	public isMetatagsQuery?: boolean;
 	public maxId?: string;
 	public metrics?: RawAnalyticsMetric[];
 	public showVerifiedFollowers?: boolean;
 	public sortBy?: TweetRepliesSortType;
 	public toTime?: Date;
+	public withListeners?: boolean;
+	public withReplays?: boolean;
 
 	/**
 	 * @param args - Additional user-defined arguments for fetching the resource.
@@ -29,6 +32,7 @@ export class FetchArgs implements IFetchArgs {
 	public constructor(args: IFetchArgs) {
 		this.id = args.id;
 		this.ids = args.ids;
+		this.isMetatagsQuery = args.isMetatagsQuery;
 		this.count = args.count;
 		this.cursor = args.cursor;
 		this.filter = args.filter ? new TweetFilter(args.filter) : undefined;
@@ -41,6 +45,8 @@ export class FetchArgs implements IFetchArgs {
 		this.activeConversationId = args.activeConversationId;
 		this.conversationId = args.conversationId;
 		this.maxId = args.maxId;
+		this.withListeners = args.withListeners;
+		this.withReplays = args.withReplays;
 	}
 }
 

package/src/models/args/PostArgs.ts

@@ -1,4 +1,4 @@
-import { INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
+import { IChangePasswordArgs, INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
 
 import { ProfileUpdateOptions } from './ProfileArgs';
 
@@ -8,12 +8,16 @@ import { ProfileUpdateOptions } from './ProfileArgs';
  * @public
  */
 export class PostArgs implements IPostArgs {
+	public changePassword?: ChangePasswordArgs;
 	public conversationId?: string;
 	public id?: string;
+	public profileBanner?: string;
+	public profileImage?: string;
 	public profileOptions?: ProfileUpdateOptions;
 	public tweet?: NewTweet;
 	public upload?: UploadArgs;
 	public userId?: string;
+	public username?: string;
 
 	/**
 	 * @param resource - The resource to be posted.
@@ -24,8 +28,36 @@ export class PostArgs implements IPostArgs {
 		this.tweet = args.tweet ? new NewTweet(args.tweet) : undefined;
 		this.upload = args.upload ? new UploadArgs(args.upload) : undefined;
 		this.userId = args.userId;
+		this.username = PostArgs._validateNonEmptyString(args.username, 'Username');
 		this.conversationId = args.conversationId;
 		this.profileOptions = args.profileOptions ? new ProfileUpdateOptions(args.profileOptions) : undefined;
+		this.profileImage = PostArgs._validateNonEmptyString(args.profileImage, 'Profile image');
+		this.profileBanner = PostArgs._validateNonEmptyString(args.profileBanner, 'Profile banner');
+		this.changePassword = args.changePassword ? new ChangePasswordArgs(args.changePassword) : undefined;
+	}
+
+	/**
+	 * Validates if a data value is a valid string.
+	 *
+	 * @param value - The data to validate.
+	 * @param fieldName - The field name whose value is to be validated.
+	 *
+	 * @returns The validated, parsed string. If data was `undefined`, returns `undefined`.
+	 */
+	private static _validateNonEmptyString(value: unknown, fieldName: string): string | undefined {
+		if (value === undefined) {
+			return undefined;
+		}
+
+		if (typeof value !== 'string') {
+			throw new Error(`${fieldName} must be a string`);
+		}
+
+		if (value.trim().length === 0) {
+			throw new Error(`${fieldName} cannot be empty`);
+		}
+
+		return value;
 	}
 }
 
@@ -91,3 +123,28 @@ export class UploadArgs implements IUploadArgs {
 		this.id = args.id;
 	}
 }
+
+/**
+ * The args for changing authenticated user's password.
+ *
+ * @public
+ */
+export class ChangePasswordArgs implements IChangePasswordArgs {
+	public currentPassword: string;
+	public newPassword: string;
+
+	public constructor(args: IChangePasswordArgs) {
+		if (!args.currentPassword || args.currentPassword.trim().length === 0) {
+			throw new Error('Current password cannot be empty');
+		}
+		if (!args.newPassword || args.newPassword.trim().length === 0) {
+			throw new Error('New password cannot be empty');
+		}
+		if (args.newPassword.length < 8) {
+			throw new Error('New password must be at least 8 characters long');
+		}
+
+		this.currentPassword = args.currentPassword;
+		this.newPassword = args.newPassword;
+	}
+}

package/src/models/data/Space.ts

@@ -0,0 +1,201 @@
+import { LogActions } from '../../enums/Logging';
+import { LogService } from '../../services/internal/LogService';
+import { ISpace, ISpaceParticipant, ISpaceParticipants } from '../../types/data/Space';
+import {
+	IAudioSpace,
+	IAudioSpaceByIdResponse,
+	IAudioSpaceParticipant,
+	IAudioSpaceParticipants,
+} from '../../types/raw/space/AudioSpaceById';
+
+/**
+ * The details of a single Space.
+ *
+ * @public
+ */
+export class Space implements ISpace {
+	/** The raw space details. */
+	private readonly _raw: IAudioSpace;
+
+	public conversationControls?: number;
+	public createdAt?: string;
+	public creatorId?: string;
+	public disallowJoin?: boolean;
+	public endedAt?: string;
+	public id: string;
+	public isEmployeeOnly?: boolean;
+	public isLocked?: boolean;
+	public isMuted?: boolean;
+	public isSpaceAvailableForClipping?: boolean;
+	public isSpaceAvailableForReplay?: boolean;
+	public isSubscribed?: boolean;
+	public mediaKey?: string;
+	public noIncognito?: boolean;
+	public participantCount?: number;
+	public participants?: ISpaceParticipants;
+	public scheduledStart?: string;
+	public startedAt?: string;
+	public state?: string;
+	public title?: string;
+	public totalLiveListeners?: number;
+	public totalReplayWatched?: number;
+	public updatedAt?: string;
+
+	/**
+	 * @param space - The raw space details.
+	 */
+	public constructor(space: IAudioSpace) {
+		this._raw = { ...space };
+
+		const metadata = space.metadata;
+
+		this.id = metadata?.rest_id ?? '';
+		this.state = metadata?.state;
+		this.title = metadata?.title;
+		this.mediaKey = metadata?.media_key;
+		this.createdAt = Space._timestampToIso(metadata?.created_at);
+		this.scheduledStart = Space._timestampToIso(metadata?.scheduled_start);
+		this.startedAt = Space._timestampToIso(metadata?.started_at);
+		this.endedAt = Space._timestampToIso(metadata?.ended_at);
+		this.updatedAt = Space._timestampToIso(metadata?.updated_at);
+		this.creatorId = metadata?.creator_results?.result?.rest_id ?? metadata?.creator_id;
+		this.conversationControls = metadata?.conversation_controls;
+		this.disallowJoin = metadata?.disallow_join;
+		this.isEmployeeOnly = metadata?.is_employee_only;
+		this.isLocked = metadata?.is_locked;
+		this.isMuted = metadata?.is_muted;
+		this.isSpaceAvailableForClipping = metadata?.is_space_available_for_clipping;
+		this.isSpaceAvailableForReplay = metadata?.is_space_available_for_replay;
+		this.noIncognito = metadata?.no_incognito;
+		this.totalLiveListeners = metadata?.total_live_listeners;
+		this.totalReplayWatched = metadata?.total_replay_watched;
+		this.participantCount = space.participants?.total ?? metadata?.participant_count;
+		this.isSubscribed = space.is_subscribed;
+		this.participants = Space._mapParticipants(space.participants);
+	}
+
+	/** The raw space details. */
+	public get raw(): IAudioSpace {
+		return { ...this._raw };
+	}
+
+	/**
+	 * Maps a raw participant to a deserialized participant.
+	 *
+	 * @param participant - The raw participant data.
+	 */
+	private static _mapParticipant(participant: IAudioSpaceParticipant): ISpaceParticipant {
+		const userId = participant.user_results?.rest_id ?? participant.user_results?.result?.rest_id;
+
+		return {
+			id: userId,
+			screenName: participant.twitter_screen_name,
+			displayName: participant.display_name,
+			avatarUrl: participant.avatar_url,
+			isVerified: participant.is_verified,
+			isMutedByAdmin: participant.is_muted_by_admin,
+			isMutedByGuest: participant.is_muted_by_guest,
+		};
+	}
+
+	/**
+	 * Maps raw participants to deserialized participants.
+	 *
+	 * @param participants - The raw participants data.
+	 */
+	private static _mapParticipants(participants?: IAudioSpaceParticipants): ISpaceParticipants | undefined {
+		if (!participants) {
+			return undefined;
+		}
+
+		return {
+			total: participants.total,
+			admins: (participants.admins ?? []).map((participant) => Space._mapParticipant(participant)),
+			speakers: (participants.speakers ?? []).map((participant) => Space._mapParticipant(participant)),
+			listeners: (participants.listeners ?? []).map((participant) => Space._mapParticipant(participant)),
+		};
+	}
+
+	/**
+	 * Convert timestamp to ISO string.
+	 *
+	 * @param value - The timestamp value.
+	 */
+	private static _timestampToIso(value?: number | string): string | undefined {
+		if (value == undefined) {
+			return undefined;
+		}
+
+		const numeric = typeof value === 'string' ? Number(value) : value;
+
+		if (!Number.isNaN(numeric)) {
+			return new Date(numeric).toISOString();
+		}
+
+		const parsed = new Date(value);
+
+		if (!Number.isNaN(parsed.getTime())) {
+			return parsed.toISOString();
+		}
+
+		return undefined;
+	}
+
+	/**
+	 * Extracts and deserializes a single target space from the given raw response data.
+	 *
+	 * @param response - The raw response data.
+	 *
+	 * @returns The target deserialized space.
+	 */
+	public static single(response: IAudioSpaceByIdResponse): Space | undefined {
+		const audioSpace = response.data?.audioSpace;
+		const spaceId = audioSpace?.metadata?.rest_id;
+
+		if (audioSpace && spaceId) {
+			// Logging
+			LogService.log(LogActions.DESERIALIZE, { id: spaceId });
+
+			return new Space(audioSpace);
+		}
+
+		// Logging
+		LogService.log(LogActions.WARNING, {
+			action: LogActions.DESERIALIZE,
+			message: 'Space not found, skipping',
+		});
+
+		return undefined;
+	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): ISpace {
+		return {
+			id: this.id,
+			state: this.state,
+			title: this.title,
+			mediaKey: this.mediaKey,
+			createdAt: this.createdAt,
+			scheduledStart: this.scheduledStart,
+			startedAt: this.startedAt,
+			endedAt: this.endedAt,
+			updatedAt: this.updatedAt,
+			creatorId: this.creatorId,
+			conversationControls: this.conversationControls,
+			disallowJoin: this.disallowJoin,
+			isEmployeeOnly: this.isEmployeeOnly,
+			isLocked: this.isLocked,
+			isMuted: this.isMuted,
+			isSpaceAvailableForClipping: this.isSpaceAvailableForClipping,
+			isSpaceAvailableForReplay: this.isSpaceAvailableForReplay,
+			noIncognito: this.noIncognito,
+			totalLiveListeners: this.totalLiveListeners,
+			totalReplayWatched: this.totalReplayWatched,
+			participantCount: this.participantCount,
+			isSubscribed: this.isSubscribed,
+			participants: this.participants,
+		};
+	}
+}

package/src/models/data/UserAbout.ts

@@ -0,0 +1,161 @@
+import { LogActions } from '../../enums/Logging';
+import { LogService } from '../../services/internal/LogService';
+import {
+	IUserAbout,
+	IUserAboutProfile,
+	IUserAboutUsernameChanges,
+	IUserAboutVerificationInfo,
+} from '../../types/data/UserAbout';
+import { IUserAboutResponse, IUserAboutResult } from '../../types/raw/user/About';
+
+/* eslint-disable @typescript-eslint/naming-convention */
+type IRawUsernameChanges = {
+	count?: string;
+	last_changed_at_msec?: string;
+};
+/* eslint-enable @typescript-eslint/naming-convention */
+
+/**
+ * The about profile details of a single user.
+ *
+ * @public
+ */
+export class UserAbout implements IUserAbout {
+	/** The raw about profile details. */
+	private readonly _raw: IUserAboutResult;
+
+	public aboutProfile?: IUserAboutProfile;
+	public createdAt: string;
+	public fullName: string;
+	public id: string;
+	public isProtected?: boolean;
+	public isVerified: boolean;
+	public profileImage: string;
+	public profileImageShape?: string;
+	public userName: string;
+	public verificationInfo?: IUserAboutVerificationInfo;
+
+	/**
+	 * @param user - The raw about profile details.
+	 */
+	public constructor(user: IUserAboutResult) {
+		this._raw = { ...user };
+
+		this.id = user.rest_id ?? user.id ?? '';
+		this.userName = user.core?.screen_name ?? '';
+		this.fullName = user.core?.name ?? '';
+		this.createdAt = new Date(user.core?.created_at ?? 0).toISOString();
+		this.profileImage = user.avatar?.image_url ?? '';
+		this.profileImageShape = user.profile_image_shape;
+		this.isVerified = user.is_blue_verified ?? false;
+		this.isProtected = user.privacy?.protected;
+		this.aboutProfile = UserAbout._buildAboutProfile(user);
+		this.verificationInfo = UserAbout._buildVerificationInfo(user);
+	}
+
+	/** The raw about profile details. */
+	public get raw(): IUserAboutResult {
+		return { ...this._raw };
+	}
+
+	private static _buildAboutProfile(user: IUserAboutResult): IUserAboutProfile | undefined {
+		const profile = user.about_profile;
+
+		if (!profile) {
+			return undefined;
+		}
+
+		const usernameChanges = UserAbout._buildUsernameChanges(profile.username_changes);
+
+		return {
+			createdCountryAccurate: profile.created_country_accurate,
+			accountBasedIn: profile.account_based_in,
+			locationAccurate: profile.location_accurate,
+			learnMoreUrl: profile.learn_more_url,
+			source: profile.source,
+			usernameChanges: usernameChanges,
+		};
+	}
+
+	private static _buildUsernameChanges(changes?: IRawUsernameChanges): IUserAboutUsernameChanges | undefined {
+		if (!changes) {
+			return undefined;
+		}
+
+		return {
+			count: UserAbout._toNumber(changes.count),
+			lastChangedAt: UserAbout._toIsoFromMsec(changes.last_changed_at_msec),
+		};
+	}
+
+	private static _buildVerificationInfo(user: IUserAboutResult): IUserAboutVerificationInfo | undefined {
+		const info = user.verification_info;
+
+		if (!info) {
+			return undefined;
+		}
+
+		return {
+			isIdentityVerified: info.is_identity_verified,
+			verifiedSince: UserAbout._toIsoFromMsec(info.reason?.verified_since_msec),
+		};
+	}
+
+	private static _toIsoFromMsec(value?: string | number): string | undefined {
+		const parsed = UserAbout._toNumber(value);
+
+		return parsed === undefined ? undefined : new Date(parsed).toISOString();
+	}
+
+	private static _toNumber(value?: string | number): number | undefined {
+		if (value === undefined || value === null) {
+			return undefined;
+		}
+
+		const parsed = typeof value === 'number' ? value : Number(value);
+
+		return Number.isFinite(parsed) ? parsed : undefined;
+	}
+
+	/**
+	 * Extracts and deserializes a single target user about profile from the given raw response data.
+	 *
+	 * @param response - The raw response data.
+	 *
+	 * @returns The target deserialized user about profile.
+	 */
+	public static single(response: NonNullable<unknown>): UserAbout | undefined {
+		const result = (response as IUserAboutResponse)?.data?.user_result_by_screen_name?.result;
+
+		if (!result || result.__typename !== 'User') {
+			LogService.log(LogActions.WARNING, {
+				action: LogActions.DESERIALIZE,
+				message: `User not found, skipping`,
+			});
+			return undefined;
+		}
+
+		// Logging
+		LogService.log(LogActions.DESERIALIZE, { id: result.rest_id ?? result.id });
+
+		return new UserAbout(result);
+	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): IUserAbout {
+		return {
+			id: this.id,
+			userName: this.userName,
+			fullName: this.fullName,
+			createdAt: this.createdAt,
+			profileImage: this.profileImage,
+			profileImageShape: this.profileImageShape,
+			isVerified: this.isVerified,
+			isProtected: this.isProtected,
+			aboutProfile: this.aboutProfile,
+			verificationInfo: this.verificationInfo,
+		};
+	}
+}