@youmind-openlab/rettiwt-api 1.0.0

package/dist/browser/services/internal/AuthService.js

@@ -0,0 +1,98 @@
+import axios from 'axios';
+import { ApiErrors } from '../../enums/Api';
+import { AuthCredential } from '../../models/auth/AuthCredential';
+/**
+ * The services that handles authentication.
+ *
+ * @internal
+ */
+export class AuthService {
+    /** The config object. */
+    _config;
+    /**
+     * @param config - The config for Rettiwt.
+     */
+    constructor(config) {
+        this._config = config;
+    }
+    /**
+     * Decodes the encoded cookie string.
+     *
+     * @param encodedCookies - The encoded cookie string to decode.
+     * @returns The decoded cookie string.
+     */
+    static decodeCookie(encodedCookies) {
+        // Decoding the encoded cookie string
+        const decodedCookies = Buffer.from(encodedCookies, 'base64').toString('ascii');
+        return decodedCookies;
+    }
+    /**
+     * Encodes the given cookie string.
+     *
+     * @param cookieString - The cookie string to encode.
+     * @returns The encoded cookie string.
+     */
+    static encodeCookie(cookieString) {
+        // Encoding the cookie string to base64
+        const encodedCookies = Buffer.from(cookieString).toString('base64');
+        return encodedCookies;
+    }
+    /**
+     * Gets the user's id from the given API key.
+     *
+     * @param apiKey - The API key.
+     * @returns The user id associated with the API key.
+     */
+    static getUserId(apiKey) {
+        // Getting the cookie string from the API key
+        const cookieString = AuthService.decodeCookie(apiKey);
+        // Searching for the user id in the cookie string
+        const searchResults = cookieString.match(/((?<=twid="u=)(\d+)(?="))|((?<=twid=u%3D)(\d+)(?=;))/);
+        // If user id was found
+        if (searchResults) {
+            return searchResults[0];
+        }
+        // If user id was not found
+        else {
+            throw new Error(ApiErrors.BAD_AUTHENTICATION);
+        }
+    }
+    /**
+     * Login to twitter as guest.
+     *
+     * @returns A new guest key.
+     *
+     * @example
+     * ```
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance
+     * const rettiwt = new Rettiwt();
+     *
+     * // Logging in an getting a new guest key
+     * rettiwt.auth.guest()
+     * .then(guestKey => {
+     * 	// Use the guest key
+     * 	...
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    async guest() {
+        // Creating a new blank credential
+        const cred = new AuthCredential();
+        // Getting the guest token
+        await axios
+            .post('https://api.twitter.com/1.1/guest/activate.json', undefined, {
+            headers: cred.toHeader(),
+            httpsAgent: this._config.httpsAgent,
+        })
+            .then((res) => {
+            cred.guestToken = res.data.guest_token;
+        });
+        return cred;
+    }
+}
+//# sourceMappingURL=AuthService.js.map

package/dist/browser/services/internal/AuthService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthService.js","sourceRoot":"","sources":["../../../../src/services/internal/AuthService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAGlE;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACvB,yBAAyB;IACR,OAAO,CAAgB;IAExC;;OAEG;IACH,YAAmB,MAAqB;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,cAAsB;QAChD,qCAAqC;QACrC,MAAM,cAAc,GAAW,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEvF,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,YAAoB;QAC9C,uCAAuC;QACvC,MAAM,cAAc,GAAW,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE5E,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,MAAc;QACrC,6CAA6C;QAC7C,MAAM,YAAY,GAAW,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE9D,iDAAiD;QACjD,MAAM,aAAa,GAAoB,YAAY,CAAC,KAAK,CACxD,sDAAsD,CACtD,CAAC;QAEF,uBAAuB;QACvB,IAAI,aAAa,EAAE,CAAC;YACnB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QACD,2BAA2B;aACtB,CAAC;YACL,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,KAAK;QACjB,kCAAkC;QAClC,MAAM,IAAI,GAAmB,IAAI,cAAc,EAAE,CAAC;QAElD,0BAA0B;QAC1B,MAAM,KAAK;aACT,IAAI,CAIF,iDAAiD,EAAE,SAAS,EAAE;YAChE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE;YACxB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;SACnC,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC;QACxC,CAAC,CAAC,CAAC;QAEJ,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/dist/browser/services/internal/ErrorService.d.ts

@@ -0,0 +1,24 @@
+import { IErrorHandler } from '../../types/ErrorHandler';
+/**
+ * The base service that handles any errors.
+ *
+ * @public
+ */
+export declare class ErrorService implements IErrorHandler {
+    /**
+     * Handles errors thrown by Twitter.
+     *
+     * @param error - The error response received from Twitter.
+     */
+    private _handleAxiosError;
+    /**
+     * Handle unknown error.
+     */
+    private _handleUnknownError;
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making HTTP request to Twitter API.
+     */
+    handle(error: unknown): void;
+}

package/dist/browser/services/internal/ErrorService.js

@@ -0,0 +1,37 @@
+import { isAxiosError } from 'axios';
+import { TwitterError } from '../../models/errors/TwitterError';
+/**
+ * The base service that handles any errors.
+ *
+ * @public
+ */
+export class ErrorService {
+    /**
+     * Handles errors thrown by Twitter.
+     *
+     * @param error - The error response received from Twitter.
+     */
+    _handleAxiosError(error) {
+        throw new TwitterError(error);
+    }
+    /**
+     * Handle unknown error.
+     */
+    _handleUnknownError() {
+        throw new Error('Unknown error');
+    }
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making HTTP request to Twitter API.
+     */
+    handle(error) {
+        if (isAxiosError(error)) {
+            this._handleAxiosError(error);
+        }
+        else {
+            this._handleUnknownError();
+        }
+    }
+}
+//# sourceMappingURL=ErrorService.js.map

package/dist/browser/services/internal/ErrorService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorService.js","sourceRoot":"","sources":["../../../../src/services/internal/ErrorService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAIhE;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACxB;;;;OAIG;IACK,iBAAiB,CAAC,KAAmD;QAC5E,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACK,mBAAmB;QAC1B,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAc;QAC3B,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,CAAC,KAAqD,CAAC,CAAC;QAC/E,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5B,CAAC;IACF,CAAC;CACD"}

package/dist/browser/services/internal/LogService.d.ts

@@ -0,0 +1,18 @@
+import { LogActions } from '../../enums/Logging';
+/**
+ * Handles logging of data for debug purpose.
+ *
+ * @internal
+ */
+export declare class LogService {
+    /** Whether logging is enabled or not. */
+    static enabled: boolean;
+    /**
+     * Logs the given data.
+     *
+     * @param action - The action to be logged.
+     *
+     * @param data - The data to be logged.
+     */
+    static log(action: LogActions, data: NonNullable<unknown>): void;
+}

package/dist/browser/services/internal/LogService.js

@@ -0,0 +1,30 @@
+/**
+ * Handles logging of data for debug purpose.
+ *
+ * @internal
+ */
+export class LogService {
+    /** Whether logging is enabled or not. */
+    static enabled = false;
+    /**
+     * Logs the given data.
+     *
+     * @param action - The action to be logged.
+     *
+     * @param data - The data to be logged.
+     */
+    static log(action, data) {
+        // Proceed to log only if logging is enabled
+        if (this.enabled) {
+            // Preparing the log message
+            const logPrefix = 'Rettiwt-API';
+            const logTime = new Date().toISOString();
+            const logAction = action;
+            const logData = JSON.stringify(data);
+            const logMessage = `[${logPrefix}] [${logTime}] [${logAction}] ${logData}`;
+            // Logging
+            console.log(logMessage);
+        }
+    }
+}
+//# sourceMappingURL=LogService.js.map

package/dist/browser/services/internal/LogService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogService.js","sourceRoot":"","sources":["../../../../src/services/internal/LogService.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACtB,yCAAyC;IAClC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;IAE9B;;;;;;OAMG;IACI,MAAM,CAAC,GAAG,CAAC,MAAkB,EAAE,IAA0B;QAC/D,4CAA4C;QAC5C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,4BAA4B;YAC5B,MAAM,SAAS,GAAG,aAAa,CAAC;YAChC,MAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACjD,MAAM,SAAS,GAAW,MAAM,CAAC;YACjC,MAAM,OAAO,GAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE7C,MAAM,UAAU,GAAG,IAAI,SAAS,MAAM,OAAO,MAAM,SAAS,KAAK,OAAO,EAAE,CAAC;YAE3E,UAAU;YACV,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACzB,CAAC;IACF,CAAC"}

package/dist/browser/types/ErrorHandler.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Defines the error handler that processes API/HTTP errors in the responses.
+ *
+ * @public
+ */
+export interface IErrorHandler {
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making request to Twitter API.
+     */
+    handle(error: unknown): void;
+}

package/dist/browser/types/ErrorHandler.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ErrorHandler.js.map

package/dist/browser/types/ErrorHandler.js.map

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

package/dist/browser/types/RettiwtConfig.d.ts

@@ -0,0 +1,42 @@
+import { IErrorHandler } from './ErrorHandler';
+/**
+ * The configuration for initializing a new Rettiwt instance.
+ *
+ * @public
+ */
+export interface IRettiwtConfig {
+    /** The apiKey (cookie) to use for authenticating Rettiwt against Twitter API. */
+    apiKey?: string;
+    /**
+     * Optional URL to proxy server to use for requests to Twitter API.
+     *
+     * @remarks When deploying to cloud platforms, if setting {@link IRettiwtConfig.authProxyUrl} does not resolve Error 429, then this might be required.
+     */
+    proxyUrl?: URL;
+    /** The max wait time (in milli-seconds) for a response; if not set, Twitter server timeout is used. */
+    timeout?: number;
+    /** Whether to write logs to console or not. */
+    logging?: boolean;
+    /** Optional custom error handler to define error conditions and process API/HTTP errors in responses. */
+    errorHandler?: IErrorHandler;
+    /**
+     * Optional custom HTTP headers to add to all requests to Twitter API.
+     *
+     * @remarks Custom headers can be useful for proxies, avoiding rate limits, etc.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * The delay (in ms) to use between concurrent request.
+     *
+     * Can either be a number or a function that returns a number synchronously or asynchronously.
+     */
+    delay?: number | (() => number | Promise<number>);
+    /**
+     * The maximum number of retries to use.
+     *
+     * @remarks Recommended to use a value of 5 combined with a `delay` of 1000 to prevent error 404.
+     */
+    maxRetries?: number;
+}

package/dist/browser/types/RettiwtConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RettiwtConfig.js.map

package/dist/browser/types/RettiwtConfig.js.map

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

package/dist/browser/types/args/FetchArgs.d.ts

@@ -0,0 +1,196 @@
+import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
+import { TweetRepliesSortType } from '../../enums/Tweet';
+/**
+ * Options specifying the data that is to be fetched.
+ *
+ * @public
+ */
+export interface IFetchArgs {
+    /**
+     * The id of the active conversation.
+     *
+     * @remarks
+     * - Required only for {@link ResourceType.DM_USER_UPDATES}.
+     */
+    activeConversationId?: string;
+    /**
+     * The maximum id of the data to fetch.
+     *
+     * @remarks
+     * - May be used for {@link ResourceType.DM_INBOX_TIMELINE} and {@link ResourceType.DM_CONVERSATION}.
+     */
+    maxId?: string;
+    /**
+     * The id of the conversation to fetch.
+     *
+     * @remarks
+     * - Required only for {@link ResourceType.DM_CONVERSATION} and {@link ResourceType.DM_DELETE_CONVERSATION}.
+     */
+    conversationId?: string;
+    /**
+     * The number of data items to fetch.
+     *
+     * @remarks
+     * - Works only for cursored resources.
+     * - Does not work for {@link ResourceType.TWEET_REPLIES}.
+     * - Must be \<= 20 for:
+     * 	- {@link ResourceType.USER_TIMELINE}
+     * 	- {@link ResourceType.USER_TIMELINE}
+     * 	- {@link ResourceType.USER_TIMELINE_AND_REPLIES}
+     * - Must be \<= 100 for all other cursored resources.
+     * - Due a bug on Twitter's end, count does not work for {@link ResourceType.USER_FOLLOWERS} and {@link ResourceType.USER_FOLLOWING}.
+     * - Has not effect for:
+     * 	- {@link ResourceType.USER_FEED_FOLLOWED}
+     * 	- {@link ResourceType.USER_FEED_RECOMMENDED}
+     */
+    count?: number;
+    /**
+     * The cursor to the batch of data to fetch.
+     *
+     * @remarks
+     * - May be used for cursored resources.
+     * - Has no effect for other resources.
+     */
+    cursor?: string;
+    /**
+     * The filter for searching tweets.
+     *
+     * @remarks
+     * Required when searching for tweets using {@link ResourceType.TWEET_SEARCH}.
+     */
+    filter?: ITweetFilter;
+    /**
+     * The id of the target resource.
+     *
+     * @remarks
+     * - Required for all resources except {@link ResourceType.TWEET_SEARCH} and {@link ResourceType.USER_TIMELINE_RECOMMENDED}.
+     * - For {@link ResourceType.USER_DETAILS_BY_USERNAME} and {@link ResourceType.USER_SEARCH}, can be alphanumeric, while for others, is strictly numeric.
+     */
+    id?: string;
+    /**
+     * The IDs of the target resources.
+     *
+     * @remarks
+     * - Required only for {@link ResourceType.TWEET_DETAILS_BULK} and {@link ResourceType.USER_DETAILS_BY_IDS_BULK}.
+     */
+    ids?: string[];
+    /**
+     * The sorting to use for tweet results.
+     *
+     * @remarks
+     * - Only works for {@link ResourceType.TWEET_REPLIES}.
+     */
+    sortBy?: TweetRepliesSortType;
+    /**
+     * The date to start fetching data from.
+     *
+     * @remarks
+     * - Only works for {@link EResourceType.USER_ANALYTICS}.
+     */
+    fromTime?: Date;
+    /**
+     * The date to end fetching data at.
+     *
+     * @remarks
+     * - Only works for {@link EResourceType.USER_ANALYTICS}.
+     */
+    toTime?: Date;
+    /**
+     * The granularity of the data to fetch.
+     *
+     * @remarks
+     * - Only works for {@link EResourceType.USER_ANALYTICS}.
+     */
+    granularity?: RawAnalyticsGranularity;
+    /**
+     * The metrics to fetch.
+     *
+     * @remarks
+     * - Only works for {@link EResourceType.USER_ANALYTICS}.
+     */
+    metrics?: RawAnalyticsMetric[];
+    /**
+     * Show the verified follower count and relationship counts in the response.
+     *
+     * @remarks
+     * - Only works for {@link EResourceType.USER_ANALYTICS}.
+     */
+    showVerifiedFollowers?: boolean;
+}
+/**
+ * The filter to be used for searching tweets.
+ *
+ * @public
+ */
+export interface ITweetFilter {
+    /** The date upto which tweets are to be searched. */
+    endDate?: Date;
+    /** The list of words to exclude from search. */
+    excludeWords?: string[];
+    /**
+     * The list of usernames whose tweets are to be searched.
+     *
+     * @remarks
+     * '\@' must be excluded from the username!
+     */
+    fromUsers?: string[];
+    /**
+     * The list of hashtags to search.
+     *
+     * @remarks
+     * '#' must be excluded from the hashtag!
+     */
+    hashtags?: string[];
+    /** The exact phrase to search. */
+    includePhrase?: string;
+    /** The list of words to search. */
+    includeWords?: string[];
+    /** The language of the tweets to search. */
+    language?: string;
+    /** The list from which tweets are to be searched. */
+    list?: string;
+    /** The id of the tweet, before which the tweets are to be searched. */
+    maxId?: string;
+    /**
+     * The list of username mentioned in the tweets to search.
+     *
+     * @remarks
+     * '\@' must be excluded from the username!
+     */
+    mentions?: string[];
+    /** The minimun number of likes to search by. */
+    minLikes?: number;
+    /** The minimum number of replies to search by. */
+    minReplies?: number;
+    /** The minimum number of retweets to search by. */
+    minRetweets?: number;
+    /**
+     * Whether to search only posts that contain links.
+     *
+     * @remarks 'links' includes things like media, quotes, retweets, etc.
+     */
+    onlyLinks?: boolean;
+    /** Whether to search only original posts. */
+    onlyOriginal?: boolean;
+    /** Whether to search only replies */
+    onlyReplies?: boolean;
+    /** Whether to search posts that only contain text. */
+    onlyText?: boolean;
+    /** The optional words to search. */
+    optionalWords?: string[];
+    /** The id of the tweet which is quoted in the tweets to search. */
+    quoted?: string;
+    /** The id of the tweet, after which the tweets are to be searched. */
+    sinceId?: string;
+    /** The date starting from which tweets are to be searched. */
+    startDate?: Date;
+    /**
+     * The list of username to whom the tweets to be searched, are adressed.
+     *
+     * @remarks
+     * '\@' must be excluded from the username!
+     */
+    toUsers?: string[];
+    /** Whether to fetch top tweets or not. */
+    top?: boolean;
+}

package/dist/browser/types/args/FetchArgs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FetchArgs.js.map

package/dist/browser/types/args/FetchArgs.js.map

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

package/dist/browser/types/args/PostArgs.d.ts

@@ -0,0 +1,129 @@
+import { IProfileUpdateOptions } from './ProfileArgs';
+/**
+ * Options specifying the data that is to be posted.
+ *
+ * @public
+ */
+export interface IPostArgs {
+    /**
+     * The id of the target resource.
+     *
+     * @remarks
+     * Required only when posting using the following resources:
+     * - {@link ResourceType.TWEET_BOOKMARK}
+     * - {@link ResourceType.TWEET_LIKE}
+     * - {@link ResourceType.TWEET_RETWEET}
+     * - {@link ResourceType.TWEET_UNBOOKMARK}
+     * - {@link ResourceType.TWEET_UNLIKE}
+     * - {@link ResourceType.TWEET_UNPOST}
+     * - {@link ResourceType.TWEET_UNRETWEET}
+     * - {@link ResourceType.USER_FOLLOW}
+     * - {@link ResourceType.USER_UNFOLLOW}
+     */
+    id?: string;
+    /**
+     * The tweet that is to be posted.
+     *
+     * @remarks
+     * Required only when posting a tweet using {@link ResourceType.TWEET_POST}
+     */
+    tweet?: INewTweet;
+    /**
+     * The media file to be uploaded.
+     *
+     * @remarks
+     * Required only when uploading a media using the following resources:
+     * - {@link ResourceType.MEDIA_UPLOAD_APPEND}
+     * - {@link ResourceType.MEDIA_UPLOAD_FINALIZE}
+     * - {@link ResourceType.MEDIA_UPLOAD_INITIALIZE}
+     */
+    upload?: IUploadArgs;
+    /**
+     * The id of the target user.
+     *
+     * @remarks
+     * Required only for the following resources:
+     * - {@link ResourceType.LIST_MEMBER_ADD}
+     * - {@link ResourceType.LIST_MEMBER_REMOVE}
+     */
+    userId?: string;
+    /**
+     * The id of the conversation to delete.
+     *
+     * @remarks
+     * Required only when deleting a conversation using {@link ResourceType.DM_DELETE_CONVERSATION}
+     */
+    conversationId?: string;
+    /**
+     * Profile update options.
+     *
+     * @remarks
+     * Required only when updating user profile using {@link ResourceType.USER_PROFILE_UPDATE}
+     */
+    profileOptions?: IProfileUpdateOptions;
+}
+/**
+ * Configuration for the new tweet to be posted.
+ *
+ * @public
+ */
+export interface INewTweet {
+    /**
+     * The list of media to be uploaded.
+     *
+     * @remarks
+     * - The media first needs to be uploaded.
+     * - After uploading, the returned id(s) can be used to reference the media here.
+     * - Maximum number of media items that can be posted is 4.
+     */
+    media?: INewTweetMedia[];
+    /** The id of the tweet to quote. */
+    quote?: string;
+    /** The id of the Tweet to which the given Tweet must be a reply. */
+    replyTo?: string;
+    /** The date/time at which the tweet is to be scheduled for posting. */
+    scheduleFor?: Date;
+    /**
+     * The text for the tweet to be created.
+     *
+     * @remarks
+     * Length of the tweet must be \<= 280 characters.
+     */
+    text?: string;
+}
+/**
+ * Configuration for the media to be uploaded.
+ *
+ * @public
+ */
+export interface INewTweetMedia {
+    /** The id of the media to upload. */
+    id: string;
+    /**
+     * The list of id of the users to tag in the media.
+     *
+     * @remarks
+     * Maximum number of users that can be tagged is 10.
+     */
+    tags?: string[];
+}
+/**
+ * Options specifying the media file to be uploaded.
+ *
+ * @public
+ */
+export interface IUploadArgs {
+    /** The id allocated to the media file to be uploaded. */
+    id?: string;
+    /**
+     * The media file to be uploaded.
+     * Can be a file path (Node.js), ArrayBuffer, or Blob (browser).
+     */
+    media?: string | ArrayBuffer | Blob;
+    /**
+     * The size (in bytes) of the media file to be uploaded.
+     *
+     * @remarks The size must be \<= 5242880 bytes.
+     */
+    size?: number;
+}

package/dist/browser/types/args/PostArgs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PostArgs.js.map

package/dist/browser/types/args/PostArgs.js.map

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

package/dist/browser/types/args/ProfileArgs.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Profile update options.
+ *
+ * @public
+ */
+export interface IProfileUpdateOptions {
+    /**
+     * Bio/description of the user (max 160 characters).
+     */
+    description?: string;
+    /**
+     * Location of the user (max 30 characters).
+     */
+    location?: string;
+    /**
+     * Display name (max 50 characters).
+     *
+     * @remarks
+     * The name field represents the user's display name shown on their profile.
+     * This is different from the username (screen_name/handle).
+     */
+    name?: string;
+    /**
+     * URL associated with the profile.
+     *
+     * @remarks
+     * Will be prepended with http:// if not present.
+     */
+    url?: string;
+}

package/dist/browser/types/args/ProfileArgs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ProfileArgs.js.map

package/dist/browser/types/args/ProfileArgs.js.map

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