@shaivpidadi/trends-js 0.0.0-beta.5 → 0.0.0-beta.7

package/dist/esm/helpers/format.js

@@ -0,0 +1,76 @@
+import { ParseError } from '../errors/GoogleTrendsError';
+// 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).
+export const extractJsonFromResponse = (text) => {
+    const cleanedText = text.replace(/^\)\]\}'/, '').trim();
+    try {
+        const parsedResponse = JSON.parse(cleanedText);
+        if (!Array.isArray(parsedResponse) || parsedResponse.length === 0) {
+            throw new ParseError('Invalid response format: empty array');
+        }
+        const nestedJsonString = parsedResponse[0][2];
+        if (!nestedJsonString) {
+            throw new ParseError('Invalid response format: missing nested JSON');
+        }
+        const data = JSON.parse(nestedJsonString);
+        if (!data || !Array.isArray(data) || data.length < 2) {
+            throw new ParseError('Invalid response format: missing data array');
+        }
+        return updateResponseObject(data[1]);
+    }
+    catch (e) {
+        if (e instanceof ParseError) {
+            throw e;
+        }
+        throw new ParseError('Failed to parse response');
+    }
+};
+const updateResponseObject = (data) => {
+    if (!Array.isArray(data)) {
+        throw new ParseError('Invalid data format: expected array');
+    }
+    const allTrendingStories = [];
+    const summary = [];
+    data.forEach((item) => {
+        if (Array.isArray(item)) {
+            const story = {
+                title: String(item[0] || ''),
+                traffic: String(item[6] || '0'),
+                articles: Array.isArray(item[9]) ? item[9].map((article) => ({
+                    title: String(article[0] || ''),
+                    url: String(article[1] || ''),
+                    source: String(article[2] || ''),
+                    time: String(article[3] || ''),
+                    snippet: String(article[4] || '')
+                })) : [],
+                shareUrl: String(item[12] || '')
+            };
+            if (item[1]) {
+                story.image = {
+                    newsUrl: String(item[1][0] || ''),
+                    source: String(item[1][1] || ''),
+                    imageUrl: String(item[1][2] || '')
+                };
+            }
+            allTrendingStories.push(story);
+            summary.push({
+                title: story.title,
+                traffic: story.traffic,
+                articles: story.articles
+            });
+        }
+    });
+    return { allTrendingStories, summary };
+};

package/dist/esm/helpers/googleTrendsAPI.d.ts

@@ -0,0 +1,26 @@
+import { DailyTrendingTopics, DailyTrendingTopicsOptions, RealTimeTrendsOptions, ExploreOptions, ExploreResponse, InterestByRegionOptions, InterestByRegionResponse, GoogleTrendsResponse } from '../types/index';
+export declare class GoogleTrendsApi {
+    /**
+     * Get autocomplete suggestions for a keyword
+     * @param keyword - The keyword to get suggestions for
+     * @param hl - Language code (default: 'en-US')
+     * @returns Promise with array of suggestion strings
+     */
+    autocomplete(keyword: string, hl?: string): Promise<GoogleTrendsResponse<string[]>>;
+    /**
+     * Get daily trending topics
+     * @param options - Options for daily trends request
+     * @returns Promise with trending topics data
+     */
+    dailyTrends({ geo, lang }: DailyTrendingTopicsOptions): Promise<GoogleTrendsResponse<DailyTrendingTopics>>;
+    /**
+     * Get real-time trending topics
+     * @param options - Options for real-time trends request
+     * @returns Promise with trending topics data
+     */
+    realTimeTrends({ geo, trendingHours }: RealTimeTrendsOptions): Promise<GoogleTrendsResponse<DailyTrendingTopics>>;
+    explore({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<ExploreResponse>;
+    interestByRegion({ keyword, startTime, endTime, geo, resolution, hl, timezone, category }: InterestByRegionOptions): Promise<InterestByRegionResponse>;
+}
+declare const _default: GoogleTrendsApi;
+export default _default;

package/dist/esm/helpers/googleTrendsAPI.js

@@ -0,0 +1,207 @@
+import { GoogleTrendsEndpoints } from '../types/enums';
+import { request } from './request';
+import { extractJsonFromResponse } from './format';
+import { GOOGLE_TRENDS_MAPPER } from '../constants';
+import { NetworkError, ParseError, UnknownError, } from '../errors/GoogleTrendsError';
+export class GoogleTrendsApi {
+    /**
+     * Get autocomplete suggestions for a keyword
+     * @param keyword - The keyword to get suggestions for
+     * @param hl - Language code (default: 'en-US')
+     * @returns Promise with array of suggestion strings
+     */
+    async autocomplete(keyword, hl = 'en-US') {
+        if (!keyword) {
+            return { data: [] };
+        }
+        const options = {
+            ...GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.autocomplete],
+            qs: {
+                hl,
+                tz: '240',
+            },
+        };
+        try {
+            const response = await request(`${options.url}/${encodeURIComponent(keyword)}`, options);
+            const text = await response.text();
+            // Remove the first 5 characters (JSONP wrapper) and parse
+            const data = JSON.parse(text.slice(5));
+            return { data: data.default.topics.map((topic) => topic.title) };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
+        }
+    }
+    /**
+     * Get daily trending topics
+     * @param options - Options for daily trends request
+     * @returns Promise with trending topics data
+     */
+    async dailyTrends({ geo = 'US', lang = 'en' }) {
+        const defaultOptions = GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.dailyTrends];
+        const options = {
+            ...defaultOptions,
+            body: new URLSearchParams({
+                'f.req': `[[["i0OFE","[null,null,\\"${geo}\\",0,\\"${lang}\\",24,1]",null,"generic"]]]`,
+            }).toString(),
+            contentType: 'form'
+        };
+        try {
+            const response = await request(options.url, options);
+            const text = await response.text();
+            const trendingTopics = extractJsonFromResponse(text);
+            if (!trendingTopics) {
+                return { error: new ParseError() };
+            }
+            return { data: trendingTopics };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
+        }
+    }
+    /**
+     * Get real-time trending topics
+     * @param options - Options for real-time trends request
+     * @returns Promise with trending topics data
+     */
+    async realTimeTrends({ geo = 'US', trendingHours = 4 }) {
+        const defaultOptions = GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.dailyTrends];
+        const options = {
+            ...defaultOptions,
+            body: new URLSearchParams({
+                'f.req': `[[["i0OFE","[null,null,\\"${geo}\\",0,\\"en\\",${trendingHours},1]",null,"generic"]]]`,
+            }).toString(),
+            contentType: 'form'
+        };
+        try {
+            const response = await request(options.url, options);
+            const text = await response.text();
+            const trendingTopics = extractJsonFromResponse(text);
+            if (!trendingTopics) {
+                return { error: new ParseError() };
+            }
+            return { data: trendingTopics };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
+        }
+    }
+    async explore({ keyword, geo = 'US', time = 'now 1-d', category = 0, property = '', hl = 'en-US', }) {
+        const options = {
+            ...GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.explore],
+            qs: {
+                hl,
+                tz: '240',
+                req: JSON.stringify({
+                    comparisonItem: [
+                        {
+                            keyword,
+                            geo,
+                            time,
+                        },
+                    ],
+                    category,
+                    property,
+                }),
+            },
+            contentType: 'form'
+        };
+        try {
+            const response = await request(options.url, options);
+            const text = await 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: [] };
+        }
+    }
+    // 
+    async interestByRegion({ keyword, startTime = new Date('2004-01-01'), endTime = new Date(), geo = 'US', resolution = 'REGION', hl = 'en-US', timezone = new Date().getTimezoneOffset(), category = 0 }) {
+        const formatDate = (date) => {
+            return date.toISOString().split('T')[0];
+        };
+        const formatTrendsDate = (date) => {
+            const pad = (n) => n.toString().padStart(2, '0');
+            const yyyy = date.getFullYear();
+            const mm = pad(date.getMonth() + 1);
+            const dd = pad(date.getDate());
+            const hh = pad(date.getHours());
+            const min = pad(date.getMinutes());
+            const ss = pad(date.getSeconds());
+            return `${yyyy}-${mm}-${dd}T${hh}\\:${min}\\:${ss}`;
+        };
+        const getDateRangeParam = (date) => {
+            const yesterday = new Date(date);
+            yesterday.setDate(date.getDate() - 1);
+            const formattedStart = formatTrendsDate(yesterday);
+            const formattedEnd = formatTrendsDate(date);
+            return `${formattedStart} ${formattedEnd}`;
+        };
+        const exploreResponse = await this.explore({
+            keyword: Array.isArray(keyword) ? keyword[0] : keyword,
+            geo: Array.isArray(geo) ? geo[0] : geo,
+            time: `${getDateRangeParam(startTime)} ${getDateRangeParam(endTime)}`,
+            category,
+            hl
+        });
+        const widget = exploreResponse.widgets.find(w => w.id === 'GEO_MAP');
+        if (!widget) {
+            return { default: { geoMapData: [] } };
+        }
+        const options = {
+            ...GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.interestByRegion],
+            qs: {
+                hl,
+                tz: timezone.toString(),
+                req: JSON.stringify({
+                    geo: {
+                        country: Array.isArray(geo) ? geo[0] : geo
+                    },
+                    comparisonItem: [{
+                            time: `${formatDate(startTime)} ${formatDate(endTime)}`,
+                            complexKeywordsRestriction: {
+                                keyword: [{
+                                        type: 'BROAD',
+                                        value: Array.isArray(keyword) ? keyword[0] : keyword
+                                    }]
+                            }
+                        }],
+                    resolution,
+                    locale: hl,
+                    requestOptions: {
+                        property: '',
+                        backend: 'CM',
+                        category
+                    },
+                    userConfig: {
+                        userType: 'USER_TYPE_LEGIT_USER'
+                    }
+                }),
+                token: widget.token
+            }
+        };
+        try {
+            const response = await request(options.url, options);
+            const text = await response.text();
+            // Remove the first 5 characters (JSONP wrapper) and parse
+            const data = JSON.parse(text.slice(5));
+            return data;
+        }
+        catch (error) {
+            return { default: { geoMapData: [] } };
+        }
+    }
+}
+export default new GoogleTrendsApi();

package/dist/esm/helpers/request.d.ts

@@ -0,0 +1,9 @@
+export declare const request: (url: string, options: {
+    method?: string;
+    qs?: Record<string, any>;
+    body?: string | Record<string, any>;
+    headers?: Record<string, string>;
+    contentType?: 'json' | 'form';
+}) => Promise<{
+    text: () => Promise<string>;
+}>;

package/dist/esm/helpers/request.js

@@ -0,0 +1,75 @@
+import https from 'https';
+import querystring from 'querystring';
+let cookieVal;
+function rereq(options, body) {
+    return new Promise((resolve, reject) => {
+        const req = https.request(options, (res) => {
+            let chunk = '';
+            res.on('data', (data) => { chunk += data; });
+            res.on('end', () => resolve(chunk));
+        });
+        req.on('error', reject);
+        if (body)
+            req.write(body);
+        req.end();
+    });
+}
+export const request = async (url, options) => {
+    const parsedUrl = new URL(url);
+    const method = options.method || 'POST';
+    // Prepare body
+    let bodyString = '';
+    const contentType = options.contentType || 'json';
+    if (typeof options.body === 'string') {
+        bodyString = options.body;
+    }
+    else if (contentType === 'form') {
+        bodyString = querystring.stringify(options.body || {});
+    }
+    else if (options.body) {
+        bodyString = JSON.stringify(options.body);
+    }
+    const requestOptions = {
+        hostname: parsedUrl.hostname,
+        port: parsedUrl.port || 443,
+        path: `${parsedUrl.pathname}${options.qs ? '?' + querystring.stringify(options.qs) : ''}`,
+        method,
+        headers: {
+            ...(options.headers || {}),
+            ...(contentType === 'form'
+                ? { 'Content-Type': 'application/x-www-form-urlencoded' }
+                : { 'Content-Type': 'application/json' }),
+            ...(bodyString ? { 'Content-Length': Buffer.byteLength(bodyString).toString() } : {}),
+            ...(cookieVal ? { cookie: cookieVal } : {})
+        }
+    };
+    const response = await new Promise((resolve, reject) => {
+        const req = https.request(requestOptions, (res) => {
+            let chunk = '';
+            res.on('data', (data) => { chunk += data; });
+            res.on('end', async () => {
+                if (res.statusCode === 429 && res.headers['set-cookie']) {
+                    cookieVal = res.headers['set-cookie'][0].split(';')[0];
+                    requestOptions.headers['cookie'] = cookieVal;
+                    try {
+                        const retryResponse = await rereq(requestOptions, bodyString);
+                        resolve(retryResponse);
+                    }
+                    catch (err) {
+                        reject(err);
+                    }
+                }
+                else {
+                    resolve(chunk);
+                }
+            });
+        });
+        req.on('error', reject);
+        if (bodyString)
+            req.write(bodyString);
+        req.end();
+    });
+    return {
+        text: () => Promise.resolve(response)
+    };
+};

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+export declare const dailyTrends: ({ geo, lang }: import("./types").DailyTrendingTopicsOptions) => Promise<import("./types").GoogleTrendsResponse<import("./types").DailyTrendingTopics>>;
+export declare const realTimeTrends: ({ geo, trendingHours }: import("./types").RealTimeTrendsOptions) => Promise<import("./types").GoogleTrendsResponse<import("./types").DailyTrendingTopics>>;
+export declare const autocomplete: (keyword: string, hl?: string) => Promise<import("./types").GoogleTrendsResponse<string[]>>;
+declare const _default: {
+    dailyTrends: ({ geo, lang }: import("./types").DailyTrendingTopicsOptions) => Promise<import("./types").GoogleTrendsResponse<import("./types").DailyTrendingTopics>>;
+    realTimeTrends: ({ geo, trendingHours }: import("./types").RealTimeTrendsOptions) => Promise<import("./types").GoogleTrendsResponse<import("./types").DailyTrendingTopics>>;
+    autocomplete: (keyword: string, hl?: string) => Promise<import("./types").GoogleTrendsResponse<string[]>>;
+};
+export default _default;

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+import { GoogleTrendsApi } from './helpers/googleTrendsAPI';
+const api = new GoogleTrendsApi();
+export const dailyTrends = api.dailyTrends.bind(api);
+export const realTimeTrends = api.realTimeTrends.bind(api);
+export const autocomplete = api.autocomplete.bind(api);
+// Default export for CommonJS compatibility
+export default {
+    dailyTrends,
+    realTimeTrends,
+    autocomplete
+};

package/dist/esm/types/enums.d.ts

@@ -0,0 +1,12 @@
+export declare enum GoogleTrendsEndpoints {
+    dailyTrends = "dailyTrends",
+    autocomplete = "autocomplete",
+    explore = "explore",
+    interestByRegion = "interestByRegion"
+}
+export declare enum GoogleTrendsTrendingHours {
+    fourHrs = 4,
+    oneDay = 24,
+    twoDays = 48,
+    sevenDays = 168
+}

package/dist/esm/types/enums.js

@@ -0,0 +1,14 @@
+export var GoogleTrendsEndpoints;
+(function (GoogleTrendsEndpoints) {
+    GoogleTrendsEndpoints["dailyTrends"] = "dailyTrends";
+    GoogleTrendsEndpoints["autocomplete"] = "autocomplete";
+    GoogleTrendsEndpoints["explore"] = "explore";
+    GoogleTrendsEndpoints["interestByRegion"] = "interestByRegion";
+})(GoogleTrendsEndpoints || (GoogleTrendsEndpoints = {}));
+export var GoogleTrendsTrendingHours;
+(function (GoogleTrendsTrendingHours) {
+    GoogleTrendsTrendingHours[GoogleTrendsTrendingHours["fourHrs"] = 4] = "fourHrs";
+    GoogleTrendsTrendingHours[GoogleTrendsTrendingHours["oneDay"] = 24] = "oneDay";
+    GoogleTrendsTrendingHours[GoogleTrendsTrendingHours["twoDays"] = 48] = "twoDays";
+    GoogleTrendsTrendingHours[GoogleTrendsTrendingHours["sevenDays"] = 168] = "sevenDays";
+})(GoogleTrendsTrendingHours || (GoogleTrendsTrendingHours = {}));

package/package.json

@@ -1,49 +1,43 @@
 {
   "name": "@shaivpidadi/trends-js",
-  "version": "0.0.0-beta.5",
+  "version": "0.0.0-beta.7",
   "description": "Google Trends API for Node.js",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "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"
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p tsconfig.json --outDir dist/esm",
+    "build:cjs": "tsc -p tsconfig.json --outDir dist/cjs --module commonjs",
+    "test": "jest",
+    "prepare": "npm run build"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Shaivpidadi/trends-js.git"
   },
   "keywords": [
-    "boilerplate",
-    "typescript",
-    "npm",
-    "module"
+    "google-trends",
+    "api",
+    "typescript"
   ],
-  "author": "Shaishav Pidadi",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
+  "author": "",
   "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/**/*"
-  ]
-}
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.0"
+  }
+}

package/lib/constants.d.ts

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

package/lib/helpers/googleTrendsAPI.d.ts

@@ -1,10 +0,0 @@
-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, startTime, endTime, geo, resolution, hl, timezone, category }: InterestByRegionOptions): Promise<InterestByRegionResponse>;
-}
-declare const _default: GoogleTrendsApi;
-export default _default;