@youmind-openlab/rettiwt-api 1.0.0

package/examples/browser-extension/src/popup.ts

@@ -0,0 +1,333 @@
+import { RettiwtBrowser, User, Tweet } from 'rettiwt-api/browser';
+
+// DOM Elements
+const statusEl = document.getElementById('status') as HTMLDivElement;
+const loginPromptEl = document.getElementById('login-prompt') as HTMLDivElement;
+const mainContentEl = document.getElementById('main-content') as HTMLDivElement;
+const retryBtn = document.getElementById('retry-btn') as HTMLButtonElement;
+
+// Profile elements
+const profileAvatarEl = document.getElementById('profile-avatar') as HTMLImageElement;
+const profileNameEl = document.getElementById('profile-name') as HTMLElement;
+const profileUsernameEl = document.getElementById('profile-username') as HTMLElement;
+const followersCountEl = document.getElementById('followers-count') as HTMLElement;
+const followingCountEl = document.getElementById('following-count') as HTMLElement;
+const tweetsCountEl = document.getElementById('tweets-count') as HTMLElement;
+
+// Tab elements
+const tabBookmarksEl = document.getElementById('tab-bookmarks') as HTMLButtonElement;
+const tabSearchEl = document.getElementById('tab-search') as HTMLButtonElement;
+const searchSectionEl = document.getElementById('search-section') as HTMLDivElement;
+const searchInputEl = document.getElementById('search-input') as HTMLInputElement;
+const searchBtnEl = document.getElementById('search-btn') as HTMLButtonElement;
+
+// Content elements
+const sectionTitleEl = document.getElementById('section-title') as HTMLElement;
+const itemCountEl = document.getElementById('item-count') as HTMLElement;
+const contentListEl = document.getElementById('content-list') as HTMLDivElement;
+const loadMoreEl = document.getElementById('load-more') as HTMLDivElement;
+
+// Global state
+let rettiwt: RettiwtBrowser | null = null;
+let currentTab: 'bookmarks' | 'search' = 'bookmarks';
+let bookmarks: Tweet[] = [];
+let searchResults: Tweet[] = [];
+let bookmarksCursor: string | undefined;
+let searchCursor: string | undefined;
+let isLoading = false;
+let hasMoreBookmarks = true;
+let hasMoreSearch = true;
+let currentSearchQuery = '';
+
+/**
+ * Update status display
+ */
+function setStatus(message: string, type: 'loading' | 'success' | 'error') {
+	statusEl.className = `status ${type}`;
+	if (type === 'loading') {
+		statusEl.innerHTML = `<span class="loading-spinner"></span>${message}`;
+	} else {
+		statusEl.textContent = message;
+	}
+}
+
+/**
+ * Format large numbers (e.g., 1000 -> 1K)
+ */
+function formatNumber(num: number): string {
+	if (num >= 1000000) {
+		return (num / 1000000).toFixed(1) + 'M';
+	}
+	if (num >= 1000) {
+		return (num / 1000).toFixed(1) + 'K';
+	}
+	return num.toString();
+}
+
+/**
+ * Display user profile
+ */
+function displayProfile(user: User) {
+	profileAvatarEl.src = user.profileImage || '';
+	profileNameEl.textContent = user.fullName || 'Unknown';
+	profileUsernameEl.textContent = `@${user.userName || 'unknown'}`;
+	followersCountEl.textContent = formatNumber(user.followersCount || 0);
+	followingCountEl.textContent = formatNumber(user.followingsCount || 0);
+	tweetsCountEl.textContent = formatNumber(user.statusesCount || 0);
+}
+
+/**
+ * Escape HTML to prevent XSS
+ */
+function escapeHtml(text: string): string {
+	const div = document.createElement('div');
+	div.textContent = text;
+	return div.innerHTML;
+}
+
+/**
+ * Render a single tweet card
+ */
+function renderTweetCard(tweet: Tweet): string {
+	const author = tweet.tweetBy;
+	const avatarUrl = author?.profileImage || '';
+	const authorName = author?.fullName || 'Unknown';
+	const authorHandle = author?.userName || 'unknown';
+	const text = tweet.fullText || '';
+	const likes = formatNumber(tweet.likeCount || 0);
+	const retweets = formatNumber(tweet.retweetCount || 0);
+	const replies = formatNumber(tweet.replyCount || 0);
+
+	return `
+    <div class="tweet-card">
+      <div class="tweet-header">
+        <img class="tweet-avatar" src="${avatarUrl}" alt="Avatar" onerror="this.style.display='none'">
+        <div>
+          <div class="tweet-author">${escapeHtml(authorName)}</div>
+          <div class="tweet-handle">@${escapeHtml(authorHandle)}</div>
+        </div>
+      </div>
+      <div class="tweet-text">${escapeHtml(text)}</div>
+      <div class="tweet-stats">
+        <span>${replies} replies</span>
+        <span>${retweets} retweets</span>
+        <span>${likes} likes</span>
+      </div>
+    </div>
+  `;
+}
+
+/**
+ * Update the content list display
+ */
+function updateContentList() {
+	const items = currentTab === 'bookmarks' ? bookmarks : searchResults;
+	const hasMore = currentTab === 'bookmarks' ? hasMoreBookmarks : hasMoreSearch;
+
+	if (items.length === 0 && !isLoading) {
+		contentListEl.innerHTML = `<div class="empty-state">${
+			currentTab === 'bookmarks' ? 'No bookmarks found' : 'No search results'
+		}</div>`;
+	} else {
+		contentListEl.innerHTML = items.map(renderTweetCard).join('');
+	}
+
+	itemCountEl.textContent = items.length > 0 ? `${items.length} items` : '';
+
+	// Only hide load-more when there's definitely no more content
+	// The loading indicator is managed by the load functions
+	if (!hasMore && !isLoading) {
+		loadMoreEl.classList.add('hidden');
+	}
+}
+
+/**
+ * Load more bookmarks
+ */
+async function loadMoreBookmarks() {
+	if (!rettiwt || isLoading || !hasMoreBookmarks) return;
+
+	isLoading = true;
+	loadMoreEl.classList.remove('hidden');
+
+	try {
+		const result = await rettiwt.user.bookmarks(20, bookmarksCursor);
+
+		if (!result.list || result.list.length === 0) {
+			hasMoreBookmarks = false;
+		} else {
+			bookmarks.push(...result.list);
+			bookmarksCursor = result.next;
+			hasMoreBookmarks = !!bookmarksCursor;
+		}
+	} catch (error) {
+		console.error('Error loading bookmarks:', error);
+		hasMoreBookmarks = false; // Stop trying on error
+	} finally {
+		isLoading = false;
+		loadMoreEl.classList.add('hidden');
+		updateContentList();
+	}
+}
+
+/**
+ * Load more search results
+ */
+async function loadMoreSearchResults() {
+	if (!rettiwt || isLoading || !hasMoreSearch || !currentSearchQuery) return;
+
+	isLoading = true;
+	loadMoreEl.classList.remove('hidden');
+
+	try {
+		console.log('Searching for:', currentSearchQuery, 'cursor:', searchCursor);
+		const result = await rettiwt.tweet.search(
+			{ includeWords: [currentSearchQuery] },
+			20,
+			searchCursor,
+		);
+		console.log('Search result:', result);
+
+		if (!result.list || result.list.length === 0) {
+			hasMoreSearch = false;
+		} else {
+			searchResults.push(...result.list);
+			searchCursor = result.next;
+			hasMoreSearch = !!searchCursor;
+		}
+	} catch (error) {
+		console.error('Error loading search results:', error);
+		// Show error to user
+		if (searchResults.length === 0) {
+			contentListEl.innerHTML = `<div class="empty-state">Search failed: ${error instanceof Error ? error.message : 'Unknown error'}</div>`;
+		}
+		hasMoreSearch = false; // Stop trying on error
+	} finally {
+		isLoading = false;
+		loadMoreEl.classList.add('hidden');
+		updateContentList();
+	}
+}
+
+/**
+ * Perform search
+ */
+async function performSearch() {
+	if (!rettiwt) return;
+
+	const query = searchInputEl.value.trim();
+	if (!query) return;
+
+	// Reset search state
+	currentSearchQuery = query;
+	searchResults = [];
+	searchCursor = undefined;
+	hasMoreSearch = true;
+
+	searchBtnEl.disabled = true;
+	searchBtnEl.textContent = 'Searching...';
+
+	try {
+		await loadMoreSearchResults();
+	} finally {
+		searchBtnEl.disabled = false;
+		searchBtnEl.textContent = 'Search';
+	}
+}
+
+/**
+ * Switch tab
+ */
+function switchTab(tab: 'bookmarks' | 'search') {
+	currentTab = tab;
+
+	// Update tab styles
+	tabBookmarksEl.classList.toggle('active', tab === 'bookmarks');
+	tabSearchEl.classList.toggle('active', tab === 'search');
+
+	// Show/hide search section
+	searchSectionEl.classList.toggle('hidden', tab !== 'search');
+
+	// Update section title
+	sectionTitleEl.textContent = tab === 'bookmarks' ? 'Bookmarks' : 'Search Results';
+
+	// Update content
+	updateContentList();
+
+	// Auto-load bookmarks if switching to bookmarks tab and empty
+	if (tab === 'bookmarks' && bookmarks.length === 0 && hasMoreBookmarks) {
+		loadMoreBookmarks();
+	}
+}
+
+/**
+ * Handle scroll for infinite loading
+ */
+function handleScroll() {
+	const scrollTop = contentListEl.scrollTop;
+	const scrollHeight = contentListEl.scrollHeight;
+	const clientHeight = contentListEl.clientHeight;
+
+	// Load more when scrolled near bottom (within 150px)
+	if (scrollTop + clientHeight >= scrollHeight - 150) {
+		console.log('Near bottom detected', { scrollTop, scrollHeight, clientHeight, isLoading, hasMoreBookmarks, hasMoreSearch });
+		if (currentTab === 'bookmarks' && !isLoading && hasMoreBookmarks) {
+			loadMoreBookmarks();
+		} else if (currentTab === 'search' && currentSearchQuery && !isLoading && hasMoreSearch) {
+			loadMoreSearchResults();
+		}
+	}
+}
+
+/**
+ * Initialize the extension
+ */
+async function initialize() {
+	setStatus('Checking login status...', 'loading');
+	loginPromptEl.classList.add('hidden');
+	mainContentEl.classList.add('hidden');
+
+	try {
+		rettiwt = new RettiwtBrowser();
+
+		// Check if logged in (just checks cookies, no API call)
+		const isLoggedIn = await rettiwt.isLoggedIn();
+
+		if (!isLoggedIn) {
+			setStatus('Not logged in to X.com', 'error');
+			loginPromptEl.classList.remove('hidden');
+			return;
+		}
+
+		setStatus('Verifying credentials...', 'loading');
+
+		// Initialize and verify (fetches user profile)
+		const user = await rettiwt.initialize();
+
+		setStatus('Successfully connected!', 'success');
+		mainContentEl.classList.remove('hidden');
+		displayProfile(user);
+
+		// Auto-load bookmarks
+		await loadMoreBookmarks();
+	} catch (error) {
+		console.error('Initialization error:', error);
+		setStatus(`Error: ${error instanceof Error ? error.message : 'Failed to initialize'}`, 'error');
+		loginPromptEl.classList.remove('hidden');
+	}
+}
+
+// Event listeners
+retryBtn.addEventListener('click', initialize);
+tabBookmarksEl.addEventListener('click', () => switchTab('bookmarks'));
+tabSearchEl.addEventListener('click', () => switchTab('search'));
+searchBtnEl.addEventListener('click', performSearch);
+searchInputEl.addEventListener('keypress', (e) => {
+	if (e.key === 'Enter') {
+		performSearch();
+	}
+});
+contentListEl.addEventListener('scroll', handleScroll);
+
+// Initialize on load
+document.addEventListener('DOMContentLoaded', initialize);

package/examples/browser-extension/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "declaration": false,
+    "types": ["chrome"],
+    "paths": {
+      "rettiwt-api/browser": ["../../dist/browser/browser/index"]
+    },
+    "baseUrl": "."
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/examples/browser-extension/webpack.config.js

@@ -0,0 +1,71 @@
+const path = require('path');
+const webpack = require('webpack');
+
+module.exports = {
+  entry: {
+    popup: './src/popup.ts',
+  },
+  output: {
+    path: path.resolve(__dirname, 'dist'),
+    filename: '[name].js',
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: {
+          loader: 'ts-loader',
+          options: {
+            transpileOnly: true, // Skip type checking for faster builds
+            compilerOptions: {
+              // Override rootDir for external files
+              rootDir: undefined,
+            },
+          },
+        },
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+    alias: {
+      // Point to the compiled browser module
+      'rettiwt-api/browser': path.resolve(__dirname, '../../dist/browser/browser/index.js'),
+      // Alias for process/browser
+      'process/browser': require.resolve('process/browser'),
+    },
+    fallback: {
+      // Polyfills for Node.js modules used by the library
+      querystring: require.resolve('querystring-es3'),
+      stream: require.resolve('stream-browserify'),
+      buffer: require.resolve('buffer/'),
+      util: require.resolve('util/'),
+      url: require.resolve('url/'),
+      process: require.resolve('process/browser'),
+      path: false,
+      fs: false,
+      https: false,
+      http: false,
+      net: false,
+      tls: false,
+      crypto: false,
+      zlib: false,
+      perf_hooks: false,
+      canvas: false,
+    },
+    // Also look in the example's node_modules for resolving
+    modules: [
+      path.resolve(__dirname, 'node_modules'),
+      'node_modules',
+    ],
+  },
+  plugins: [
+    // Provide Buffer and process globally
+    new webpack.ProvidePlugin({
+      Buffer: ['buffer', 'Buffer'],
+      process: 'process/browser',
+    }),
+  ],
+  devtool: 'source-map',
+};

package/package.json

@@ -0,0 +1,72 @@
+{
+	"name": "@youmind-openlab/rettiwt-api",
+	"version": "1.0.0",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"description": "YouMind Open Lab fork - An API for fetching data from TwitterAPI, with browser extension support!",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./browser": {
+			"types": "./dist/browser/index.d.ts",
+			"default": "./dist/browser/index.js"
+		}
+	},
+	"bin": {
+		"rettiwt": "dist/cli.js"
+	},
+	"scripts": {
+		"build": "tsc",
+		"build:browser": "tsc -p tsconfig.browser.json",
+		"build:all": "npm run build && npm run build:browser",
+		"prepare": "tsc",
+		"format": "prettier --write .",
+		"format:check": "prettier --check .",
+		"lint": "eslint --max-warnings 0 --fix .",
+		"lint:check": "eslint --max-warnings 0 .",
+		"docs": "typedoc --excludePrivate --excludeProtected --excludeInternal src/index.ts"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Rishikant181/twitter-api.git"
+	},
+	"author": {
+		"email": "rishikantsahu181@gmail.com",
+		"name": "Rishikant Sahu"
+	},
+	"license": "ISC",
+	"bugs": {
+		"url": "https://github.com/Rishikant181/Rettiwt-API/issues"
+	},
+	"homepage": "https://rishikant181.github.io/Rettiwt-API/",
+	"engines": {
+		"node": "^22.21.0"
+	},
+	"devDependencies": {
+		"@types/chrome": "^0.0.300",
+		"@types/cookiejar": "^2.1.5",
+		"@types/jsdom": "^27.0.0",
+		"@types/node": "^22.13.1",
+		"@typescript-eslint/eslint-plugin": "^8.24.0",
+		"@typescript-eslint/parser": "^8.24.0",
+		"eslint": "^9.20.1",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-tsdoc": "^0.4.0",
+		"nodemon": "^3.1.9",
+		"prettier": "^3.5.1",
+		"typedoc": "^0.27.7",
+		"typescript": "^5.7.3"
+	},
+	"dependencies": {
+		"axios": "^1.8.4",
+		"chalk": "^5.4.1",
+		"commander": "^11.1.0",
+		"cookiejar": "^2.1.4",
+		"https-proxy-agent": "^7.0.6",
+		"jsdom": "^27.2.0",
+		"node-html-parser": "^7.0.1",
+		"x-client-transaction-id": "^0.1.9"
+	}
+}

package/playground/.env.example

@@ -0,0 +1 @@
+API_KEY=""

package/playground/README.md

@@ -0,0 +1,53 @@
+# Rettiwt Playground
+
+This playground is intended for developers to test and experiment with features from the Rettiwt-API package in a local development environment.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v22 or higher recommended)
+- npm (v7+ recommended for workspace support)
+
+### Setup
+
+1. **Install dependencies**
+   From the root of the monorepo, run:
+
+    ```sh
+    npm install
+    ```
+
+    This will install dependencies for all workspaces, including `playground` and `src`.
+
+2. **Environment Variables**
+   Create a `.env` file in the `playground` directory with your API credentials:
+    ```env
+    API_KEY=your_api_key_here
+    ```
+
+### Usage
+
+- The main entry point is [`index.js`](./index.js), which demonstrates usage of the Rettiwt-API.
+- To run the playground:
+    ```sh
+    npm start --workspace=playground
+    ```
+    or from the `playground` directory:
+    ```sh
+    npm start
+    ```
+
+### Modifying Playground Code
+
+- Edit `index.js` to try different API features or test new functionality.
+- The `rettiwt-api` dependency is linked via npm workspaces, so changes in `src` are immediately available in the playground after rebuilding if necessary.
+
+## Notes
+
+- This playground is for development and testing only. Do not use production credentials.
+- For more advanced usage, add scripts or files as needed.
+
+---
+
+For questions or issues, see the main project README or open an issue.

package/playground/index.js

@@ -0,0 +1,15 @@
+import { Rettiwt } from 'rettiwt-api';
+import 'dotenv/config';
+
+const rettiwt = new Rettiwt({ apiKey: process.env.API_KEY });
+
+async function userDetails() {
+	try {
+		const user = await rettiwt.user.details();
+		console.log(user);
+	} catch (error) {
+		console.error('Error fetching user details:', error);
+	}
+}
+
+await userDetails();

package/playground/package.json

@@ -0,0 +1,15 @@
+{
+	"name": "rettiwt-playground",
+	"version": "1.0.0",
+	"description": "A playground for testing Rettiwt-API features and functionalities.",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"start": "node index.js",
+		"test": "echo \"No tests specified\" && exit 0"
+	},
+	"dependencies": {
+		"dotenv": "^17.2.0",
+		"rettiwt-api": "file:../"
+	}
+}

package/src/Rettiwt.ts

@@ -0,0 +1,97 @@
+import { RettiwtConfig } from './models/RettiwtConfig';
+import { DirectMessageService } from './services/public/DirectMessageService';
+import { ListService } from './services/public/ListService';
+import { TweetService } from './services/public/TweetService';
+import { UserService } from './services/public/UserService';
+import { IRettiwtConfig } from './types/RettiwtConfig';
+
+/**
+ * The class for accessing Twitter API.
+ *
+ * The created Rettiwt instance can be configured by passing in a configuration object to the constructor.
+ *
+ * For details regarding the available configuration options, refer to {@link IRettiwtConfig}
+ *
+ * @example Creating a Rettiwt instance with 'guest' authentication:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt();
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'guest' authentication, using a pre-generated guest key:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ guestKey: 'GUEST_KEY' });
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'user' authentication:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ apiKey: 'API_KEY' });
+ * ```
+ *
+ * @example Creating a Rettiwt instance with 'user'authentication, along with enabling debug logs and using a proxy:
+ * ```
+ * import { Rettiwt } from 'rettiwt-api';
+ *
+ * // Creating a new Rettiwt instance
+ * const rettiwt = new Rettiwt({ apiKey: 'API_KEY', logging: true, proxyUrl: 'URL_TO_PROXY_SERVER' });
+ * ```
+ *
+ * @public
+ */
+export class Rettiwt {
+	/** The configuration for Rettiwt. */
+	private _config: RettiwtConfig;
+
+	/** The instance used to fetch data related to direct messages. */
+	public dm: DirectMessageService;
+
+	/** The instance used to fetch data related to lists. */
+	public list: ListService;
+
+	/** The instance used to fetch data related to tweets. */
+	public tweet: TweetService;
+
+	/** The instance used to fetch data related to users. */
+	public user: UserService;
+
+	/**
+	 * Initializes a new Rettiwt instance using the given api key.
+	 *
+	 * @param config - The config object for configuring the Rettiwt instance.
+	 */
+	public constructor(config?: IRettiwtConfig) {
+		this._config = new RettiwtConfig(config);
+		this.dm = new DirectMessageService(this._config);
+		this.list = new ListService(this._config);
+		this.tweet = new TweetService(this._config);
+		this.user = new UserService(this._config);
+	}
+
+	/** Get the current API key associated with this instance. */
+	public get apiKey(): string | undefined {
+		return this._config.apiKey;
+	}
+
+	/** Set the API key for the current instance. */
+	public set apiKey(apiKey: string | undefined) {
+		this._config.apiKey = apiKey;
+	}
+
+	/** Set the custom headers for the current instance. */
+	public set headers(headers: { [key: string]: string }) {
+		this._config.headers = headers;
+	}
+
+	/** Set the proxy URL for the current instance. */
+	public set proxyUrl(proxyUrl: URL) {
+		this._config.proxyUrl = proxyUrl;
+	}
+}