@youmind-openlab/rettiwt-api 1.0.0

package/dist/services/public/FetcherService.d.ts

@@ -0,0 +1,95 @@
+import { ResourceType } from '../../enums/Resource';
+import { AuthCredential } from '../../models/auth/AuthCredential';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { IFetchArgs } from '../../types/args/FetchArgs';
+import { IPostArgs } from '../../types/args/PostArgs';
+import { ITransactionHeader } from '../../types/auth/TransactionHeader';
+import { AuthService } from '../internal/AuthService';
+/**
+ * The base service that handles all HTTP requests.
+ *
+ * @public
+ */
+export declare class FetcherService {
+    /** The AuthService instance to use. */
+    protected readonly _auth: AuthService;
+    /** The delay/delay function to use (ms). */
+    private readonly _delay?;
+    /** The service used to handle HTTP and API errors */
+    private readonly _errorHandler;
+    /** The max wait time for a response. */
+    private readonly _timeout;
+    /** The config object. */
+    protected readonly config: RettiwtConfig;
+    /**
+     * @param config - The config object for configuring the Rettiwt instance.
+     */
+    constructor(config: RettiwtConfig);
+    /**
+     * Checks the authorization status based on the requested resource.
+     *
+     * @param resource - The requested resource.
+     *
+     * @throws An error if not authorized to access the requested resource.
+     */
+    private _checkAuthorization;
+    /**
+     * Returns the AuthCredentials based on the type of key present.
+     *
+     * @returns The generated AuthCredential
+     */
+    protected _getCredential(): Promise<AuthCredential>;
+    /**
+     * Generates the header for the transaction ID.
+     *
+     * @param method - The target method.
+     * @param url - The target URL.
+     *
+     * @returns The header containing the transaction ID.
+     */
+    protected _getTransactionHeader(method: string, url: string): Promise<ITransactionHeader>;
+    protected _handleXMigration(): Promise<Document>;
+    /**
+     * Validates the given args against the given resource.
+     *
+     * @param resource - The resource against which validation is to be done.
+     * @param args - The args to be validated.
+     *
+     * @returns The validated args.
+     */
+    private _validateArgs;
+    /**
+     * Introduces a delay using the configured delay/delay function.
+     */
+    private _wait;
+    /**
+     * Makes an HTTP request according to the given parameters.
+     *
+     * @param resource - The requested resource.
+     * @param config - The request configuration.
+     *
+     * @typeParam T - The type of the returned response data.
+     *
+     * @returns The raw data response received.
+     *
+     * @example
+     *
+     * #### Fetching the raw details of a single user, using their username
+     * ```ts
+     * import { FetcherService, ResourceType } from 'rettiwt-api';
+     *
+     * // Creating a new FetcherService instance using the given 'API_KEY'
+     * const fetcher = new FetcherService({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with username 'user1'
+     * fetcher.request(ResourceType.USER_DETAILS_BY_USERNAME, { id: 'user1' })
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    request<T = unknown>(resource: ResourceType, args: IFetchArgs | IPostArgs): Promise<T>;
+}

package/dist/services/public/FetcherService.js

@@ -0,0 +1,344 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetcherService = void 0;
+const axios_1 = __importStar(require("axios"));
+const cookiejar_1 = require("cookiejar");
+const jsdom_1 = require("jsdom");
+const x_client_transaction_id_1 = require("x-client-transaction-id");
+const Groups_1 = require("../../collections/Groups");
+const Requests_1 = require("../../collections/Requests");
+const Api_1 = require("../../enums/Api");
+const Logging_1 = require("../../enums/Logging");
+const FetchArgs_1 = require("../../models/args/FetchArgs");
+const PostArgs_1 = require("../../models/args/PostArgs");
+const AuthCredential_1 = require("../../models/auth/AuthCredential");
+const TwitterError_1 = require("../../models/errors/TwitterError");
+const AuthService_1 = require("../internal/AuthService");
+const ErrorService_1 = require("../internal/ErrorService");
+const LogService_1 = require("../internal/LogService");
+/**
+ * The base service that handles all HTTP requests.
+ *
+ * @public
+ */
+class FetcherService {
+    /** The AuthService instance to use. */
+    _auth;
+    /** The delay/delay function to use (ms). */
+    _delay;
+    /** The service used to handle HTTP and API errors */
+    _errorHandler;
+    /** The max wait time for a response. */
+    _timeout;
+    /** The config object. */
+    config;
+    /**
+     * @param config - The config object for configuring the Rettiwt instance.
+     */
+    constructor(config) {
+        LogService_1.LogService.enabled = config.logging ?? false;
+        this.config = config;
+        this._delay = config.delay;
+        this._errorHandler = config.errorHandler ?? new ErrorService_1.ErrorService();
+        this._timeout = config.timeout ?? 0;
+        this._auth = new AuthService_1.AuthService(config);
+    }
+    /**
+     * Checks the authorization status based on the requested resource.
+     *
+     * @param resource - The requested resource.
+     *
+     * @throws An error if not authorized to access the requested resource.
+     */
+    _checkAuthorization(resource) {
+        // Logging
+        LogService_1.LogService.log(Logging_1.LogActions.AUTHORIZATION, { authenticated: this.config.userId != undefined });
+        // Checking authorization status
+        if (!Groups_1.AllowGuestAuthenticationGroup.includes(resource) && this.config.userId == undefined) {
+            throw new Error(Api_1.ApiErrors.RESOURCE_NOT_ALLOWED);
+        }
+    }
+    /**
+     * Returns the AuthCredentials based on the type of key present.
+     *
+     * @returns The generated AuthCredential
+     */
+    async _getCredential() {
+        if (this.config.apiKey) {
+            // Logging
+            LogService_1.LogService.log(Logging_1.LogActions.GET, { target: 'USER_CREDENTIAL' });
+            return new AuthCredential_1.AuthCredential(AuthService_1.AuthService.decodeCookie(this.config.apiKey)
+                .split(';')
+                .map((item) => new cookiejar_1.Cookie(item)));
+        }
+        else {
+            // Logging
+            LogService_1.LogService.log(Logging_1.LogActions.GET, { target: 'NEW_GUEST_CREDENTIAL' });
+            return this._auth.guest();
+        }
+    }
+    /**
+     * Generates the header for the transaction ID.
+     *
+     * @param method - The target method.
+     * @param url - The target URL.
+     *
+     * @returns The header containing the transaction ID.
+     */
+    async _getTransactionHeader(method, url) {
+        // Get the X homepage HTML document (using utility function)
+        const document = await this._handleXMigration();
+        // Create and initialize ClientTransaction instance
+        const transaction = await x_client_transaction_id_1.ClientTransaction.create(document);
+        // Getting the URL path excluding all params
+        const path = new URL(url).pathname.split('?')[0].trim();
+        // Generating the transaction ID
+        const tid = await transaction.generateTransactionId(method.toUpperCase(), path);
+        return {
+            /* eslint-disable @typescript-eslint/naming-convention */
+            'x-client-transaction-id': tid,
+            /* eslint-enable @typescript-eslint/naming-convention */
+        };
+    }
+    async _handleXMigration() {
+        // Fetch X.com homepage
+        const homePageResponse = await axios_1.default.get('https://x.com', {
+            headers: this.config.headers,
+            httpAgent: this.config.httpsAgent,
+            httpsAgent: this.config.httpsAgent,
+        });
+        // Parse HTML using linkedom
+        let dom = new jsdom_1.JSDOM(homePageResponse.data);
+        let document = dom.window.document;
+        // Check for migration redirection links
+        const migrationRedirectionRegex = new RegExp('(http(?:s)?://(?:www\\.)?(twitter|x){1}\\.com(/x)?/migrate([/?])?tok=[a-zA-Z0-9%\\-_]+)+', 'i');
+        const metaRefresh = document.querySelector("meta[http-equiv='refresh']");
+        const metaContent = metaRefresh ? metaRefresh.getAttribute('content') || '' : '';
+        const migrationRedirectionUrl = migrationRedirectionRegex.exec(metaContent) || migrationRedirectionRegex.exec(homePageResponse.data);
+        if (migrationRedirectionUrl) {
+            // Follow redirection URL
+            const redirectResponse = await axios_1.default.get(migrationRedirectionUrl[0], {
+                httpAgent: this.config.httpsAgent,
+                httpsAgent: this.config.httpsAgent,
+            });
+            dom = new jsdom_1.JSDOM(redirectResponse.data);
+            document = dom.window.document;
+        }
+        // Handle migration form if present
+        const migrationForm = document.querySelector("form[name='f']") ||
+            document.querySelector("form[action='https://x.com/x/migrate']");
+        if (migrationForm) {
+            const url = migrationForm.getAttribute('action') || 'https://x.com/x/migrate';
+            const method = migrationForm.getAttribute('method') || 'POST';
+            // Collect form input fields
+            const requestPayload = new FormData();
+            const inputFields = migrationForm.querySelectorAll('input');
+            for (const element of Array.from(inputFields)) {
+                const name = element.getAttribute('name');
+                const value = element.getAttribute('value');
+                if (name && value) {
+                    requestPayload.append(name, value);
+                }
+            }
+            // Submit form using POST request
+            const formResponse = await axios_1.default.request({
+                method: method,
+                url: url,
+                data: requestPayload,
+                headers: {
+                    /* eslint-disable @typescript-eslint/naming-convention */
+                    'Content-Type': 'multipart/form-data',
+                    ...this.config.headers,
+                    /* eslint-enable @typescript-eslint/naming-convention */
+                },
+                httpAgent: this.config.httpsAgent,
+                httpsAgent: this.config.httpsAgent,
+            });
+            dom = new jsdom_1.JSDOM(formResponse.data);
+            document = dom.window.document;
+        }
+        // Return final DOM document
+        return document;
+    }
+    /**
+     * Validates the given args against the given resource.
+     *
+     * @param resource - The resource against which validation is to be done.
+     * @param args - The args to be validated.
+     *
+     * @returns The validated args.
+     */
+    _validateArgs(resource, args) {
+        if (Groups_1.FetchResourcesGroup.includes(resource)) {
+            // Logging
+            LogService_1.LogService.log(Logging_1.LogActions.VALIDATE, { target: 'FETCH_ARGS' });
+            return new FetchArgs_1.FetchArgs(args);
+        }
+        else if (Groups_1.PostResourcesGroup.includes(resource)) {
+            // Logging
+            LogService_1.LogService.log(Logging_1.LogActions.VALIDATE, { target: 'POST_ARGS' });
+            return new PostArgs_1.PostArgs(args);
+        }
+    }
+    /**
+     * Introduces a delay using the configured delay/delay function.
+     */
+    async _wait() {
+        // If no delay is set, skip
+        if (this._delay == undefined) {
+            return;
+        }
+        /** The delay (in ms) to use. */
+        let delay = 0;
+        // Getting the delay
+        if (this._delay && typeof this._delay == 'number') {
+            delay = this._delay;
+        }
+        else if (this._delay && typeof this._delay == 'function') {
+            delay = await this._delay();
+        }
+        // Awaiting for the delay time
+        await new Promise((resolve) => setTimeout(resolve, delay));
+    }
+    /**
+     * Makes an HTTP request according to the given parameters.
+     *
+     * @param resource - The requested resource.
+     * @param config - The request configuration.
+     *
+     * @typeParam T - The type of the returned response data.
+     *
+     * @returns The raw data response received.
+     *
+     * @example
+     *
+     * #### Fetching the raw details of a single user, using their username
+     * ```ts
+     * import { FetcherService, ResourceType } from 'rettiwt-api';
+     *
+     * // Creating a new FetcherService instance using the given 'API_KEY'
+     * const fetcher = new FetcherService({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the User with username 'user1'
+     * fetcher.request(ResourceType.USER_DETAILS_BY_USERNAME, { id: 'user1' })
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    async request(resource, args) {
+        /** The current retry number. */
+        let retry = 0;
+        /** The error, if any. */
+        let error = undefined;
+        // Logging
+        LogService_1.LogService.log(Logging_1.LogActions.REQUEST, { resource: resource, args: args });
+        // Checking authorization for the requested resource
+        this._checkAuthorization(resource);
+        // Validating args
+        args = this._validateArgs(resource, args);
+        // Getting credentials from key
+        const cred = await this._getCredential();
+        // Getting request configuration
+        const config = Requests_1.Requests[resource](args);
+        // Setting additional request parameters
+        config.headers = {
+            ...config.headers,
+            ...cred.toHeader(),
+            ...this.config.headers,
+        };
+        config.httpAgent = this.config.httpsAgent;
+        config.httpsAgent = this.config.httpsAgent;
+        config.timeout = this._timeout;
+        // Using retries for error 404
+        do {
+            // Sending the request
+            try {
+                // Getting and appending transaction information
+                config.headers = {
+                    ...(await this._getTransactionHeader(config.method ?? '', config.url ?? '')),
+                    ...config.headers,
+                };
+                // Introducing a delay
+                await this._wait();
+                // Getting the response body
+                const responseData = (await (0, axios_1.default)(config)).data;
+                // Check for Twitter API errors in response body
+                // Type guard to check if response contains errors
+                const potentialErrorResponse = responseData;
+                if (potentialErrorResponse.errors &&
+                    Array.isArray(potentialErrorResponse.errors) &&
+                    (potentialErrorResponse.data === undefined ||
+                        JSON.stringify(potentialErrorResponse.data) === JSON.stringify({}))) {
+                    // Throw TwitterError using existing error class
+                    const axiosError = {
+                        response: {
+                            data: { errors: potentialErrorResponse.errors },
+                            status: 200,
+                        },
+                        message: potentialErrorResponse.errors[0]?.message ?? 'Twitter API Error',
+                        status: 200,
+                    };
+                    throw new TwitterError_1.TwitterError(axiosError);
+                }
+                // Returning the reponse body
+                return responseData;
+            }
+            catch (err) {
+                // If it's an error 404, retry
+                if ((0, axios_1.isAxiosError)(err) && err.status === 404) {
+                    error = err;
+                    continue;
+                }
+                // Else, delegate error handling
+                else {
+                    this._errorHandler.handle(err);
+                }
+            }
+            finally {
+                // Incrementing the number of retries done
+                retry++;
+            }
+        } while (retry < this.config.maxRetries);
+        /** If request not successful even after retries, throw the error */
+        throw error;
+    }
+}
+exports.FetcherService = FetcherService;
+//# sourceMappingURL=FetcherService.js.map

package/dist/services/public/FetcherService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetcherService.js","sourceRoot":"","sources":["../../../src/services/public/FetcherService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAwD;AACxD,yCAAmC;AACnC,iCAA8B;AAC9B,qEAA4D;AAE5D,qDAAkH;AAClH,yDAAsD;AACtD,yCAA4C;AAC5C,iDAAiD;AAEjD,2DAAwD;AACxD,yDAAsD;AACtD,qEAAkE;AAClE,mEAAgE;AAQhE,yDAAsD;AACtD,2DAAwD;AACxD,uDAAoD;AAEpD;;;;GAIG;AACH,MAAa,cAAc;IAC1B,uCAAuC;IACpB,KAAK,CAAc;IAEtC,4CAA4C;IAC3B,MAAM,CAA6C;IAEpE,qDAAqD;IACpC,aAAa,CAAgB;IAE9C,wCAAwC;IACvB,QAAQ,CAAS;IAElC,yBAAyB;IACN,MAAM,CAAgB;IAEzC;;OAEG;IACH,YAAmB,MAAqB;QACvC,uBAAU,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,2BAAY,EAAE,CAAC;QAC/D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,QAAsB;QACjD,UAAU;QACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,aAAa,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;QAE7F,gCAAgC;QAChC,IAAI,CAAC,sCAA6B,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC1F,MAAM,IAAI,KAAK,CAAC,eAAS,CAAC,oBAAoB,CAAC,CAAC;QACjD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,cAAc;QAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,UAAU;YACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAE9D,OAAO,IAAI,+BAAc,CACxB,yBAAW,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC1C,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,kBAAM,CAAC,IAAI,CAAC,CAAC,CACjC,CAAC;QACH,CAAC;aAAM,CAAC;YACP,UAAU;YACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAC;YAEnE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,qBAAqB,CAAC,MAAc,EAAE,GAAW;QAChE,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEhD,mDAAmD;QACnD,MAAM,WAAW,GAAG,MAAM,2CAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE7D,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAExD,gCAAgC;QAChC,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;QAEhF,OAAO;YACN,yDAAyD;YACzD,yBAAyB,EAAE,GAAG;YAC9B,wDAAwD;SACxD,CAAC;IACH,CAAC;IAES,KAAK,CAAC,iBAAiB;QAChC,uBAAuB;QACvB,MAAM,gBAAgB,GAAG,MAAM,eAAK,CAAC,GAAG,CAAS,eAAe,EAAE;YACjE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;YACjC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;SAClC,CAAC,CAAC;QAEH,4BAA4B;QAC5B,IAAI,GAAG,GAAG,IAAI,aAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QAEnC,wCAAwC;QACxC,MAAM,yBAAyB,GAAG,IAAI,MAAM,CAC3C,0FAA0F,EAC1F,GAAG,CACH,CAAC;QAEF,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QACzE,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEjF,MAAM,uBAAuB,GAC5B,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,yBAAyB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEtG,IAAI,uBAAuB,EAAE,CAAC;YAC7B,yBAAyB;YACzB,MAAM,gBAAgB,GAAG,MAAM,eAAK,CAAC,GAAG,CAAS,uBAAuB,CAAC,CAAC,CAAC,EAAE;gBAC5E,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBACjC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;aAClC,CAAC,CAAC;YAEH,GAAG,GAAG,IAAI,aAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACvC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChC,CAAC;QAED,mCAAmC;QACnC,MAAM,aAAa,GAClB,QAAQ,CAAC,aAAa,CAAC,gBAAgB,CAAC;YACxC,QAAQ,CAAC,aAAa,CAAC,wCAAwC,CAAC,CAAC;QAElE,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,yBAAyB,CAAC;YAC9E,MAAM,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC;YAE9D,4BAA4B;YAC5B,MAAM,cAAc,GAAG,IAAI,QAAQ,EAAE,CAAC;YAEtC,MAAM,WAAW,GAAG,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC5D,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC5C,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;oBACnB,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACpC,CAAC;YACF,CAAC;YAED,iCAAiC;YACjC,MAAM,YAAY,GAAG,MAAM,eAAK,CAAC,OAAO,CAAS;gBAChD,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,GAAG;gBACR,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE;oBACR,yDAAyD;oBAEzD,cAAc,EAAE,qBAAqB;oBACrC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;oBAEtB,wDAAwD;iBACxD;gBACD,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBACjC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;aAClC,CAAC,CAAC;YAEH,GAAG,GAAG,IAAI,aAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACnC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChC,CAAC;QAED,4BAA4B;QAC5B,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACK,aAAa,CAAC,QAAsB,EAAE,IAA4B;QACzE,IAAI,4BAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,UAAU;YACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;YAE9D,OAAO,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;aAAM,IAAI,2BAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClD,UAAU;YACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;YAE7D,OAAO,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;IACF,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,KAAK;QAClB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC9B,OAAO;QACR,CAAC;QAED,gCAAgC;QAChC,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,oBAAoB;QACpB,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;YACnD,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,MAAM,IAAI,UAAU,EAAE,CAAC;YAC5D,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,CAAC;QAED,8BAA8B;QAC9B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,OAAO,CAAc,QAAsB,EAAE,IAA4B;QACrF,gCAAgC;QAChC,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,yBAAyB;QACzB,IAAI,KAAK,GAAY,SAAS,CAAC;QAE/B,UAAU;QACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvE,oDAAoD;QACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAEnC,kBAAkB;QAClB,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAE,CAAC;QAE3C,+BAA+B;QAC/B,MAAM,IAAI,GAAmB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAEzD,gCAAgC;QAChC,MAAM,MAAM,GAAG,mBAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;QAExC,wCAAwC;QACxC,MAAM,CAAC,OAAO,GAAG;YAChB,GAAG,MAAM,CAAC,OAAO;YACjB,GAAG,IAAI,CAAC,QAAQ,EAAE;YAClB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;SACtB,CAAC;QACF,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QAC1C,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QAC3C,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,8BAA8B;QAC9B,GAAG,CAAC;YACH,sBAAsB;YACtB,IAAI,CAAC;gBACJ,gDAAgD;gBAChD,MAAM,CAAC,OAAO,GAAG;oBAChB,GAAG,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;oBAC5E,GAAG,MAAM,CAAC,OAAO;iBACjB,CAAC;gBAEF,sBAAsB;gBACtB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBAEnB,4BAA4B;gBAC5B,MAAM,YAAY,GAAG,CAAC,MAAM,IAAA,eAAK,EAAI,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;gBAEnD,gDAAgD;gBAChD,kDAAkD;gBAClD,MAAM,sBAAsB,GAAG,YAA8C,CAAC;gBAC9E,IACC,sBAAsB,CAAC,MAAM;oBAC7B,KAAK,CAAC,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC;oBAC5C,CAAC,sBAAsB,CAAC,IAAI,KAAK,SAAS;wBACzC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,EACnE,CAAC;oBACF,gDAAgD;oBAChD,MAAM,UAAU,GAAG;wBAClB,QAAQ,EAAE;4BACT,IAAI,EAAE,EAAE,MAAM,EAAE,sBAAsB,CAAC,MAAM,EAAE;4BAC/C,MAAM,EAAE,GAAG;yBACX;wBACD,OAAO,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,mBAAmB;wBACzE,MAAM,EAAE,GAAG;qBACe,CAAC;oBAC5B,MAAM,IAAI,2BAAY,CAAC,UAAU,CAAC,CAAC;gBACpC,CAAC;gBAED,6BAA6B;gBAC7B,OAAO,YAAY,CAAC;YACrB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,8BAA8B;gBAC9B,IAAI,IAAA,oBAAY,EAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBAC7C,KAAK,GAAG,GAAG,CAAC;oBACZ,SAAS;gBACV,CAAC;gBACD,gCAAgC;qBAC3B,CAAC;oBACL,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChC,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,0CAA0C;gBAC1C,KAAK,EAAE,CAAC;YACT,CAAC;QACF,CAAC,QAAQ,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;QAEzC,oEAAoE;QACpE,MAAM,KAAK,CAAC;IACb,CAAC;CACD;AArVD,wCAqVC"}

package/dist/services/public/ListService.d.ts

@@ -0,0 +1,158 @@
+import { CursoredData } from '../../models/data/CursoredData';
+import { List } from '../../models/data/List';
+import { Tweet } from '../../models/data/Tweet';
+import { User } from '../../models/data/User';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { FetcherService } from './FetcherService';
+export declare class ListService extends FetcherService {
+    /**
+     * @param config - The config object for configuring the Rettiwt instance.
+     *
+     * @internal
+     */
+    constructor(config: RettiwtConfig);
+    /**
+     * Add a user as a member of a list.
+     *
+     * @param listId - The ID of the target list.
+     * @param userId - The ID of the target user to be added as a member.
+     *
+     * @returns The new member count of the list. If adding was unsuccessful, return `undefined`.
+     *
+     * @example
+     *
+     * ```ts
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Adding a user with ID '123456789' as a member to the list with ID '987654321'
+     * rettiwt.list.addMember('987654321', '123456789')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    addMember(listId: string, userId: string): Promise<number | undefined>;
+    /**
+     * Get the details of a list.
+     *
+     * @param id - The ID of the target list.
+     *
+     * @returns
+     * The details of the target list.
+     *
+     * If list not found, returns undefined.
+     *
+     * @example
+     *
+     * #### Fetching the details of a list
+     * ```ts
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the details of the list with the id '1234567890'
+     * rettiwt.list.details('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    details(id: string): Promise<List | undefined>;
+    /**
+     * Get the list of members of a tweet list.
+     *
+     * @param id - The ID of target list.
+     * @param count - The number of members to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of members to fetch.
+     *
+     * @returns The list tweets in the given list.
+     *
+     * @example
+     *
+     * ```ts
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the first 100 members of the Twitter list with id '1234567890'
+     * rettiwt.list.members('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
+     */
+    members(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Remove a member from a list.
+     *
+     * @param listId - The ID of the target list.
+     * @param userId - The ID of the target user to removed from the members.
+     *
+     * @returns The new member count of the list. If removal was unsuccessful, return `undefined`.
+     *
+     * @example
+     *
+     * ```ts
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Removing a user with ID '123456789' from the member of the list with ID '987654321'
+     * rettiwt.list.removeMember('987654321', '123456789')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     */
+    removeMember(listId: string, userId: string): Promise<number | undefined>;
+    /**
+     * Get the list of tweets from a tweet list.
+     *
+     * @param id - The ID of target list.
+     * @param count - The number of tweets to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     *
+     * @returns The list tweets in the given list.
+     *
+     * @example
+     *
+     * ```ts
+     * import { Rettiwt } from 'rettiwt-api';
+     *
+     * // Creating a new Rettiwt instance using the given 'API_KEY'
+     * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+     *
+     * // Fetching the most recent 100 tweets of the Twitter list with id '1234567890'
+     * rettiwt.list.tweets('1234567890')
+     * .then(res => {
+     * 	console.log(res);
+     * })
+     * .catch(err => {
+     * 	console.log(err);
+     * });
+     * ```
+     *
+     * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
+     */
+    tweets(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+}