@shaivpidadi/trends-js 0.0.0-beta.2

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2025 Hebert Cisco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/constants.d.ts

@@ -0,0 +1,2 @@
+import { GoogleTrendsEndpoints, GoogleTrendsMapper } from './types';
+export declare const GOOGLE_TRENDS_MAPPER: Record<GoogleTrendsEndpoints, GoogleTrendsMapper>;

package/lib/constants.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GOOGLE_TRENDS_MAPPER = void 0;
+const GOOGLE_TRENDS_BASE_URL = 'trends.google.com';
+exports.GOOGLE_TRENDS_MAPPER = {
+    ["dailyTrends" /* GoogleTrendsEndpoints.dailyTrends */]: {
+        path: '/_/TrendsUi/data/batchexecute',
+        method: 'POST',
+        host: GOOGLE_TRENDS_BASE_URL,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/_/TrendsUi/data/batchexecute`,
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
+        },
+    },
+    ["autocomplete" /* GoogleTrendsEndpoints.autocomplete */]: {
+        path: '/trends/api/autocomplete',
+        method: 'GET',
+        host: GOOGLE_TRENDS_BASE_URL,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/autocomplete`,
+        headers: {
+            accept: 'application/json, text/plain, */*',
+        },
+    },
+    ["explore" /* GoogleTrendsEndpoints.explore */]: {
+        path: '/trends/api/explore',
+        method: 'GET',
+        host: GOOGLE_TRENDS_BASE_URL,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/explore`,
+        headers: {},
+    },
+    ["interestByRegion" /* GoogleTrendsEndpoints.interestByRegion */]: {
+        path: '/trends/api/widgetdata/comparedgeo',
+        method: 'GET',
+        host: GOOGLE_TRENDS_BASE_URL,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/widgetdata/comparedgeo`,
+        headers: {},
+    },
+};

package/lib/helpers/format.d.ts

@@ -0,0 +1,2 @@
+import { DailyTrendingTopics } from '../types';
+export declare const extractJsonFromResponse: (text: string) => DailyTrendingTopics | null;

package/lib/helpers/format.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractJsonFromResponse = void 0;
+// For future refrence and update: from google trends page rpc call response,
+// 0	"twitter down"	The main trending search term.
+// 1	null	Unused (reserved for future Google Trends data).
+// 2	"US"	Country code (where the trend is happening).
+// 3	[1741599600]	Unix timestamp (represents when the search started trending).
+// 4	null	Unused (reserved for future data).
+// 5	null	Unused (reserved for future data).
+// 6	500000	Search volume index (estimated search interest for the term).
+// 7	null	Unused (reserved for future data).
+// 8	1000	Trend ranking score (higher means more popular).
+// 9	["twitter down", "is twitter down", "is x down", ...]	Related searches (other queries that users searched alongside this term).
+// 10	[11]	Unclear, possibly a category identifier.
+// 11	[[3606769742, "en", "US"], [3596035008, "en", "US"]]	User demographics or trending sources, with numerical IDs, language ("en" for English), and country ("US" for United States).
+// 12	"twitter down"	The original trending keyword (sometimes a duplicate of index 0).
+const extractJsonFromResponse = (text) => {
+    const cleanedText = text.replace(/^\)\]\}'/, '').trim();
+    try {
+        const parsedResponse = JSON.parse(cleanedText);
+        if (!Array.isArray(parsedResponse) || parsedResponse.length === 0) {
+            return null;
+        }
+        const nestedJsonString = parsedResponse[0][2];
+        if (!nestedJsonString) {
+            return null;
+        }
+        const data = JSON.parse(nestedJsonString);
+        if (!data || !Array.isArray(data) || data.length < 2) {
+            return null;
+        }
+        return updateResponseObject(data[1]);
+    }
+    catch (e) {
+        console.error('Failed to parse response:', e);
+        return null;
+    }
+};
+exports.extractJsonFromResponse = extractJsonFromResponse;
+const updateResponseObject = (data) => {
+    if (!Array.isArray(data)) {
+        return null;
+    }
+    const allTrendingStories = data;
+    const summary = [];
+    data.forEach((item) => {
+        if (Array.isArray(item) && typeof item[0] === 'string') {
+            summary.push(item[0]); // First element is usually the trending keyword
+        }
+    });
+    return { allTrendingStories, summary };
+};

package/lib/helpers/googleTrendsAPI.d.ts

@@ -0,0 +1,10 @@
+import { DailyTrendingTopics, DailyTrendingTopicsOptions, RealTimeTrendsOptions, ExploreOptions, ExploreResponse, InterestByRegionOptions, InterestByRegionResponse } from '../types/index';
+export declare class GoogleTrendsApi {
+    autocomplete(keyword: string, hl?: string): Promise<string[]>;
+    dailyTrends({ geo, lang }: DailyTrendingTopicsOptions): Promise<DailyTrendingTopics>;
+    realTimeTrends({ geo, trendingHours }: RealTimeTrendsOptions): Promise<DailyTrendingTopics>;
+    explore({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<ExploreResponse>;
+    interestByRegion({ keyword, geo, time, resolution, hl, }: InterestByRegionOptions): Promise<InterestByRegionResponse>;
+}
+declare const _default: GoogleTrendsApi;
+export default _default;

package/lib/helpers/googleTrendsAPI.js

@@ -0,0 +1,177 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoogleTrendsApi = void 0;
+const request_1 = require("./request");
+const format_1 = require("./format");
+const constants_1 = require("../constants");
+class GoogleTrendsApi {
+    autocomplete(keyword, hl = 'en-US') {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!keyword) {
+                return [];
+            }
+            const options = Object.assign(Object.assign({}, constants_1.GOOGLE_TRENDS_MAPPER["autocomplete" /* GoogleTrendsEndpoints.autocomplete */]), { qs: {
+                    hl,
+                    tz: '240',
+                } });
+            try {
+                const response = yield (0, request_1.request)(`${options.url}/${encodeURIComponent(keyword)}`, options);
+                const text = yield response.text();
+                // Remove the first 5 characters (JSONP wrapper) and parse
+                const data = JSON.parse(text.slice(5));
+                return data.default.topics.map((topic) => topic.title);
+            }
+            catch (error) {
+                console.error('Autocomplete request failed:', error);
+                return [];
+            }
+        });
+    }
+    dailyTrends({ geo = 'US', lang = 'en' }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const defaultOptions = constants_1.GOOGLE_TRENDS_MAPPER["dailyTrends" /* GoogleTrendsEndpoints.dailyTrends */];
+            const options = Object.assign(Object.assign({}, defaultOptions), { body: new URLSearchParams({
+                    'f.req': `[[["i0OFE","[null,null,\\"${geo}\\",0,\\"${lang}\\",24,1]",null,"generic"]]]`,
+                }).toString() });
+            try {
+                const response = yield (0, request_1.request)(options.url, options);
+                const text = yield response.text();
+                const trendingTopics = (0, format_1.extractJsonFromResponse)(text);
+                if (!trendingTopics) {
+                    return {
+                        allTrendingStories: [],
+                        summary: [],
+                    };
+                }
+                return trendingTopics;
+            }
+            catch (error) {
+                console.error(error);
+                return {
+                    allTrendingStories: [],
+                    summary: [],
+                };
+            }
+        });
+    }
+    realTimeTrends({ geo = 'US', trendingHours = 4 }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const defaultOptions = constants_1.GOOGLE_TRENDS_MAPPER["dailyTrends" /* GoogleTrendsEndpoints.dailyTrends */];
+            const options = Object.assign(Object.assign({}, defaultOptions), { body: new URLSearchParams({
+                    'f.req': `[[["i0OFE","[null,null,\\"${geo}\\",0,\\"en\\",${trendingHours},1]",null,"generic"]]]`,
+                }).toString() });
+            try {
+                const response = yield (0, request_1.request)(options.url, options);
+                const text = yield response.text();
+                const trendingTopics = (0, format_1.extractJsonFromResponse)(text);
+                if (!trendingTopics) {
+                    return {
+                        allTrendingStories: [],
+                        summary: [],
+                    };
+                }
+                return trendingTopics;
+            }
+            catch (error) {
+                console.error(error);
+                return {
+                    allTrendingStories: [],
+                    summary: [],
+                };
+            }
+        });
+    }
+    explore({ keyword, geo = 'US', time = 'today 12-m', category = 0, property = '', hl = 'en-US', }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = Object.assign(Object.assign({}, constants_1.GOOGLE_TRENDS_MAPPER["explore" /* GoogleTrendsEndpoints.explore */]), { qs: {
+                    hl,
+                    tz: '240',
+                    req: JSON.stringify({
+                        comparisonItem: [
+                            {
+                                keyword,
+                                geo,
+                                time,
+                            },
+                        ],
+                        category,
+                        property,
+                    }),
+                } });
+            try {
+                const response = yield (0, request_1.request)(options.url, options);
+                const text = yield response.text();
+                // Remove the first 5 characters (JSONP wrapper) and parse
+                const data = JSON.parse(text.slice(5));
+                return data;
+            }
+            catch (error) {
+                console.error('Explore request failed:', error);
+                return { widgets: [] };
+            }
+        });
+    }
+    interestByRegion({ keyword, geo = 'US', time = 'today 12-m', resolution = 'REGION', hl = 'en-US', }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // First get the widget token from explore
+            const exploreResponse = yield this.explore({ keyword, geo, time, hl });
+            const widget = exploreResponse.widgets.find((w) => w.id === 'GEO_MAP_0');
+            if (!widget) {
+                return { default: { geoMapData: [] } };
+            }
+            const options = Object.assign(Object.assign({}, constants_1.GOOGLE_TRENDS_MAPPER["interestByRegion" /* GoogleTrendsEndpoints.interestByRegion */]), { qs: {
+                    hl,
+                    tz: '240',
+                    req: JSON.stringify({
+                        geo: { country: geo },
+                        comparisonItem: [
+                            {
+                                time,
+                                complexKeywordsRestriction: {
+                                    keyword: [
+                                        {
+                                            type: 'BROAD',
+                                            value: keyword,
+                                        },
+                                    ],
+                                },
+                            },
+                        ],
+                        resolution,
+                        locale: hl,
+                        requestOptions: {
+                            property: '',
+                            backend: 'IZG',
+                            category: 0,
+                        },
+                        userConfig: {
+                            userType: 'USER_TYPE_SCRAPER',
+                        },
+                    }),
+                    token: widget.token,
+                } });
+            try {
+                const response = yield (0, request_1.request)(options.url, options);
+                const text = yield response.text();
+                // Remove the first 5 characters (JSONP wrapper) and parse
+                const data = JSON.parse(text.slice(5));
+                return data;
+            }
+            catch (error) {
+                console.error('Interest by region request failed:', error);
+                return { default: { geoMapData: [] } };
+            }
+        });
+    }
+}
+exports.GoogleTrendsApi = GoogleTrendsApi;
+exports.default = new GoogleTrendsApi();

package/lib/helpers/request.d.ts

@@ -0,0 +1 @@
+export declare const request: (url: string, options: RequestInit) => Promise<any>;

package/lib/helpers/request.js

@@ -0,0 +1,17 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.request = void 0;
+const request = (url, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(url, options);
+    return response;
+});
+exports.request = request;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import GoogleTrendsApi from './helpers/googleTrendsAPI';
+export default GoogleTrendsApi;

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const googleTrendsAPI_1 = __importDefault(require("./helpers/googleTrendsAPI"));
+exports.default = googleTrendsAPI_1.default;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@shaivpidadi/trends-js",
+  "version": "0.0.0-beta.2",
+  "description": "Google Trends API for Node.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.(js|ts)\"",
+    "lint": "eslint src --ext .js,.ts",
+    "lint:fix": "eslint src --fix --ext .js,.ts",
+    "test": "jest --config jest.config.js",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Shaivpidadi/trends-js.git"
+  },
+  "keywords": [
+    "boilerplate",
+    "typescript",
+    "npm",
+    "module"
+  ],
+  "author": "Shaishav Pidadi",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "29.5.14",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "5.62.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-jest": "27.9.0",
+    "jest": "29.7.0",
+    "prettier": "2.8.8",
+    "ts-jest": "29.2.5",
+    "typescript": "4.9.5"
+  },
+  "files": [
+    "lib/**/*"
+  ]
+}