rettiwt-api 6.0.8 → 6.1.0

package/dist/types/raw/list/RemoveMember.d.ts

@@ -0,0 +1,150 @@
+/**
+ * The raw data received after removing a member from a tweet list.
+ *
+ * @public
+ */
+export interface IListMemberRemoveResponse {
+    data: Data;
+}
+export interface Data {
+    list: List;
+}
+export interface List {
+    created_at: number;
+    default_banner_media: DefaultBannerMedia;
+    default_banner_media_results: DefaultBannerMediaResults;
+    description: string;
+    facepile_urls: any[];
+    following: boolean;
+    id: string;
+    id_str: string;
+    is_member: boolean;
+    member_count: number;
+    mode: string;
+    muting: boolean;
+    name: string;
+    pinning: boolean;
+    subscriber_count: number;
+    user_results: UserResults;
+}
+export interface DefaultBannerMedia {
+    media_info: MediaInfo;
+}
+export interface MediaInfo {
+    original_img_url: string;
+    original_img_width: number;
+    original_img_height: number;
+    salient_rect: SalientRect;
+}
+export interface SalientRect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface DefaultBannerMediaResults {
+    result: Result;
+}
+export interface Result {
+    id: string;
+    media_key: string;
+    media_id: string;
+    media_info: MediaInfo2;
+    __typename: string;
+}
+export interface MediaInfo2 {
+    __typename: string;
+    original_img_height: number;
+    original_img_width: number;
+    original_img_url: string;
+    salient_rect: SalientRect2;
+}
+export interface SalientRect2 {
+    height: number;
+    left: number;
+    top: number;
+    width: number;
+}
+export interface UserResults {
+    result: Result2;
+}
+export interface Result2 {
+    __typename: string;
+    id: string;
+    rest_id: string;
+    affiliates_highlighted_label: AffiliatesHighlightedLabel;
+    avatar: Avatar;
+    core: Core;
+    dm_permissions: DmPermissions;
+    has_graduated_access: boolean;
+    is_blue_verified: boolean;
+    legacy: Legacy;
+    location: Location;
+    media_permissions: MediaPermissions;
+    parody_commentary_fan_label: string;
+    profile_image_shape: string;
+    privacy: Privacy;
+    relationship_perspectives: RelationshipPerspectives;
+    tipjar_settings: TipjarSettings;
+    verification: Verification;
+    verified_phone_status: boolean;
+}
+export interface AffiliatesHighlightedLabel {
+}
+export interface Avatar {
+    image_url: string;
+}
+export interface Core {
+    created_at: string;
+    name: string;
+    screen_name: string;
+}
+export interface DmPermissions {
+    can_dm: boolean;
+}
+export interface Legacy {
+    default_profile: boolean;
+    default_profile_image: boolean;
+    description: string;
+    entities: Entities;
+    fast_followers_count: number;
+    favourites_count: number;
+    followers_count: number;
+    friends_count: number;
+    has_custom_timelines: boolean;
+    is_translator: boolean;
+    listed_count: number;
+    media_count: number;
+    needs_phone_verification: boolean;
+    normal_followers_count: number;
+    pinned_tweet_ids_str: any[];
+    possibly_sensitive: boolean;
+    profile_interstitial_type: string;
+    statuses_count: number;
+    translator_type: string;
+    want_retweets: boolean;
+    withheld_in_countries: any[];
+}
+export interface Entities {
+    description: Description;
+}
+export interface Description {
+    urls: any[];
+}
+export interface Location {
+    location: string;
+}
+export interface MediaPermissions {
+    can_media_tag: boolean;
+}
+export interface Privacy {
+    protected: boolean;
+}
+export interface RelationshipPerspectives {
+    following: boolean;
+}
+export interface TipjarSettings {
+}
+export interface Verification {
+    verified: boolean;
+}

package/dist/types/raw/list/RemoveMember.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RemoveMember.js.map

package/dist/types/raw/list/RemoveMember.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveMember.js","sourceRoot":"","sources":["../../../../src/types/raw/list/RemoveMember.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/tweet/Bookmark.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The raw data received when bookmarking a given tweet.
+ *
+ * @public
+ */
+export interface ITweetBookmarkResponse {
+    data: Data;
+}
+interface Data {
+    tweet_bookmark_put: string;
+}
+export {};

package/dist/types/raw/tweet/Bookmark.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Bookmark.js.map

package/dist/types/raw/tweet/Bookmark.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bookmark.js","sourceRoot":"","sources":["../../../../src/types/raw/tweet/Bookmark.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/tweet/Unbookmark.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The raw data received when unbookmarking a given tweet.
+ *
+ * @public
+ */
+export interface ITweetUnbookmarkResponse {
+    data: Data;
+}
+export interface Data {
+    tweet_bookmark_delete: string;
+}

package/dist/types/raw/tweet/Unbookmark.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Unbookmark.js.map

package/dist/types/raw/tweet/Unbookmark.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Unbookmark.js","sourceRoot":"","sources":["../../../../src/types/raw/tweet/Unbookmark.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/user/Analytics.d.ts

@@ -1,3 +1,4 @@
+import type { IAnalytics } from '../base/Analytic';
 /**
  * The raw data received when fetching the analytic overview of the user.
  *
@@ -7,26 +8,13 @@ export interface IUserAnalyticsResponse {
     data: Data;
 }
 interface Data {
-    result: Result;
+    viewer_v2: ViewerV2;
 }
-interface Result {
-    result: Result2;
-    id: string;
+interface ViewerV2 {
+    user_results: UserResults;
 }
-interface Result2 {
-    __typename: string;
-    organic_metrics_time_series: Series[];
+interface UserResults {
     id: string;
-}
-interface Series {
-    metric_values: MetricValue[];
-    timestamp: Timestamp;
-}
-interface MetricValue {
-    metric_value: number;
-    metric_type: string;
-}
-interface Timestamp {
-    iso8601_time: string;
+    result: IAnalytics;
 }
 export {};

package/dist/types/raw/user/Analytics.js

@@ -1,4 +1,3 @@
 "use strict";
-/* eslint-disable */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Analytics.js.map

package/dist/types/raw/user/Analytics.js.map

@@ -1 +1 @@
-{"version":3,"file":"Analytics.js","sourceRoot":"","sources":["../../../../src/types/raw/user/Analytics.ts"],"names":[],"mappings":";AAAA,oBAAoB"}
+{"version":3,"file":"Analytics.js","sourceRoot":"","sources":["../../../../src/types/raw/user/Analytics.ts"],"names":[],"mappings":""}

package/dist/types/raw/user/Lists.d.ts

@@ -0,0 +1,319 @@
+/**
+ * The raw data received when fetching the lists of the given user.
+ *
+ * @public
+ */
+export interface IUserListsResponse {
+    data: Data;
+}
+export interface Data {
+    viewer: Viewer;
+}
+export interface Viewer {
+    list_management_timeline: ListManagementTimeline;
+}
+export interface ListManagementTimeline {
+    timeline: Timeline;
+}
+export interface Timeline {
+    instructions: Instruction[];
+    metadata: Metadata;
+}
+export interface Instruction {
+    type: string;
+    direction?: string;
+    entries?: Entry[];
+}
+export interface Entry {
+    entryId: string;
+    sortIndex: string;
+    content: Content;
+}
+export interface Content {
+    entryType: string;
+    __typename: string;
+    items?: Item[];
+    displayType?: string;
+    header?: Header;
+    footer?: Footer;
+    clientEventInfo?: ClientEventInfo2;
+    value?: string;
+    cursorType?: string;
+}
+export interface Item {
+    entryId: string;
+    item: Item2;
+}
+export interface Item2 {
+    itemContent: ItemContent;
+    clientEventInfo: ClientEventInfo;
+}
+export interface ItemContent {
+    itemType: string;
+    __typename: string;
+    displayType: string;
+    list: List;
+}
+export interface List {
+    created_at: number;
+    default_banner_media: DefaultBannerMedia;
+    default_banner_media_results: DefaultBannerMediaResults;
+    description: string;
+    facepile_urls: string[];
+    followers_context?: string;
+    following: boolean;
+    id: string;
+    id_str: string;
+    is_member: boolean;
+    member_count: number;
+    members_context?: string;
+    mode: string;
+    muting: boolean;
+    name: string;
+    pinning: boolean;
+    subscriber_count: number;
+    user_results: UserResults;
+    custom_banner_media?: CustomBannerMedia;
+    custom_banner_media_results?: CustomBannerMediaResults;
+}
+export interface DefaultBannerMedia {
+    media_info: MediaInfo;
+}
+export interface MediaInfo {
+    original_img_url: string;
+    original_img_width: number;
+    original_img_height: number;
+    salient_rect: SalientRect;
+}
+export interface SalientRect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface DefaultBannerMediaResults {
+    result: Result;
+}
+export interface Result {
+    id: string;
+    media_key: string;
+    media_id: string;
+    media_info: MediaInfo2;
+    __typename: string;
+}
+export interface MediaInfo2 {
+    __typename: string;
+    original_img_height: number;
+    original_img_width: number;
+    original_img_url: string;
+    salient_rect: SalientRect2;
+}
+export interface SalientRect2 {
+    height: number;
+    left: number;
+    top: number;
+    width: number;
+}
+export interface UserResults {
+    result: Result2;
+}
+export interface Result2 {
+    __typename: string;
+    id: string;
+    rest_id: string;
+    affiliates_highlighted_label: AffiliatesHighlightedLabel;
+    avatar: Avatar;
+    core: Core;
+    dm_permissions: DmPermissions;
+    has_graduated_access: boolean;
+    is_blue_verified: boolean;
+    legacy: Legacy;
+    location: Location;
+    media_permissions: MediaPermissions;
+    parody_commentary_fan_label: string;
+    profile_image_shape: string;
+    professional?: Professional;
+    privacy: Privacy;
+    relationship_perspectives: RelationshipPerspectives;
+    tipjar_settings: TipjarSettings;
+    verification: Verification;
+    verified_phone_status: boolean;
+}
+export interface AffiliatesHighlightedLabel {
+}
+export interface Avatar {
+    image_url: string;
+}
+export interface Core {
+    created_at: string;
+    name: string;
+    screen_name: string;
+}
+export interface DmPermissions {
+    can_dm: boolean;
+}
+export interface Legacy {
+    default_profile: boolean;
+    default_profile_image: boolean;
+    description: string;
+    entities: Entities;
+    fast_followers_count: number;
+    favourites_count: number;
+    followers_count: number;
+    friends_count: number;
+    has_custom_timelines: boolean;
+    is_translator: boolean;
+    listed_count: number;
+    media_count: number;
+    normal_followers_count: number;
+    pinned_tweet_ids_str: string[];
+    possibly_sensitive: boolean;
+    profile_banner_url?: string;
+    profile_interstitial_type: string;
+    statuses_count: number;
+    translator_type: string;
+    url?: string;
+    want_retweets: boolean;
+    withheld_in_countries: any[];
+    needs_phone_verification?: boolean;
+}
+export interface Entities {
+    description: Description;
+    url?: Url;
+}
+export interface Description {
+    urls: any[];
+}
+export interface Url {
+    urls: Url2[];
+}
+export interface Url2 {
+    display_url: string;
+    expanded_url: string;
+    url: string;
+    indices: number[];
+}
+export interface Location {
+    location: string;
+}
+export interface MediaPermissions {
+    can_media_tag: boolean;
+}
+export interface Professional {
+    rest_id: string;
+    professional_type: string;
+    category: Category[];
+}
+export interface Category {
+    id: number;
+    name: string;
+    icon_name: string;
+}
+export interface Privacy {
+    protected: boolean;
+}
+export interface RelationshipPerspectives {
+    following: boolean;
+}
+export interface TipjarSettings {
+    is_enabled?: boolean;
+    bitcoin_handle?: string;
+    ethereum_handle?: string;
+}
+export interface Verification {
+    verified: boolean;
+}
+export interface CustomBannerMedia {
+    media_info: MediaInfo3;
+}
+export interface MediaInfo3 {
+    original_img_url: string;
+    original_img_width: number;
+    original_img_height: number;
+    salient_rect: SalientRect3;
+}
+export interface SalientRect3 {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface CustomBannerMediaResults {
+    result: Result3;
+}
+export interface Result3 {
+    id: string;
+    media_key: string;
+    media_id: string;
+    media_info: MediaInfo4;
+    __typename: string;
+}
+export interface MediaInfo4 {
+    __typename: string;
+    original_img_height: number;
+    original_img_width: number;
+    original_img_url: string;
+    salient_rect: SalientRect4;
+    color_info: ColorInfo;
+}
+export interface SalientRect4 {
+    height: number;
+    left: number;
+    top: number;
+    width: number;
+}
+export interface ColorInfo {
+    palette: Palette[];
+}
+export interface Palette {
+    percentage: number;
+    rgb: Rgb;
+}
+export interface Rgb {
+    blue: number;
+    green: number;
+    red: number;
+}
+export interface ClientEventInfo {
+    component: string;
+    element: string;
+    details: Details;
+}
+export interface Details {
+    timelinesDetails: TimelinesDetails;
+}
+export interface TimelinesDetails {
+    injectionType: string;
+    controllerData?: string;
+}
+export interface Header {
+    displayType: string;
+    text: string;
+    sticky: boolean;
+}
+export interface Footer {
+    displayType: string;
+    text: string;
+    landingUrl: LandingUrl;
+}
+export interface LandingUrl {
+    url: string;
+    urlType: string;
+}
+export interface ClientEventInfo2 {
+    component: string;
+    details: Details2;
+}
+export interface Details2 {
+    timelinesDetails: TimelinesDetails2;
+}
+export interface TimelinesDetails2 {
+    injectionType: string;
+    controllerData?: string;
+}
+export interface Metadata {
+    scribeConfig: ScribeConfig;
+}
+export interface ScribeConfig {
+    page: string;
+}

package/dist/types/raw/user/Lists.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Lists.js.map

package/dist/types/raw/user/Lists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lists.js","sourceRoot":"","sources":["../../../../src/types/raw/user/Lists.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/eslint.config.mjs

@@ -11,7 +11,7 @@ const compat = new FlatCompat({
 
 export default [
 	{
-		ignores: ['dist/', 'node_modules/', 'docs/'],
+		ignores: ['dist/', 'node_modules/', 'docs/', 'playground/'],
 	},
 	...compat.extends('.eslintrc.js'),
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rettiwt-api",
-	"version": "6.0.8",
+	"version": "6.1.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",
@@ -11,9 +11,10 @@
 		"build": "tsc",
 		"prepare": "tsc",
 		"format": "prettier --write .",
+		"format:check": "prettier --check .",
 		"lint": "eslint --max-warnings 0 --fix .",
-		"docs": "typedoc --excludePrivate --excludeProtected --excludeInternal src/index.ts",
-		"debug": "nodemon ./dist/index.js --inspect=0.0.0.0:9229"
+		"lint:check": "eslint --max-warnings 0 .",
+		"docs": "typedoc --excludePrivate --excludeProtected --excludeInternal src/index.ts"
 	},
 	"repository": {
 		"type": "git",
@@ -29,7 +30,7 @@
 	},
 	"homepage": "https://rishikant181.github.io/Rettiwt-API/",
 	"engines": {
-		"node": "^22.13.1"
+		"node": "^22.21.0"
 	},
 	"devDependencies": {
 		"@types/cookiejar": "^2.1.5",
@@ -53,6 +54,10 @@
 		"https-proxy-agent": "^7.0.6",
 		"jsdom": "^27.2.0",
 		"node-html-parser": "^7.0.1",
-		"x-client-transaction-id-glacier": "^1.0.0"
-	}
+		"x-client-transaction-id": "^0.1.8"
+	},
+	"workspaces": [
+		"playground",
+		"src"
+	]
 }

package/playground/.env.example

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

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
+    ACCESS_TOKEN=your_access_token_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.ACCESS_TOKEN });
+
+async function userDetails() {
+	try {
+		const user = await rettiwt.user.details();
+		console.log(user);
+	} catch (error) {
+		console.error('Error fetching user details:', error);
+	}
+}
+
+await userDetails();