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

package/dist/esm/helpers/googleTrendsAPI.js

@@ -1,8 +1,8 @@
-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';
+import { GoogleTrendsEndpoints } from '../types/enums.js';
+import { request } from './request.js';
+import { extractJsonFromResponse } from './format.js';
+import { GOOGLE_TRENDS_MAPPER } from '../constants.js';
+import { InvalidRequestError, NetworkError, ParseError, UnknownError, } from '../errors/GoogleTrendsError.js';
 export class GoogleTrendsApi {
     /**
      * Get autocomplete suggestions for a keyword
@@ -118,13 +118,33 @@ export class GoogleTrendsApi {
         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;
+            // Check if response is HTML (error page)
+            if (text.includes('<html') || text.includes('<!DOCTYPE')) {
+                return { error: new ParseError('Explore request returned HTML instead of JSON') };
+            }
+            // Try to parse as JSON
+            try {
+                // Remove the first 5 characters (JSONP wrapper) and parse
+                const data = JSON.parse(text.slice(5));
+                // Extract widgets from the response
+                if (data && Array.isArray(data) && data.length > 0) {
+                    const widgets = data[0] || [];
+                    return { widgets };
+                }
+                return { widgets: [] };
+            }
+            catch (parseError) {
+                if (parseError instanceof Error) {
+                    return { error: new ParseError(`Failed to parse explore response as JSON: ${parseError.message}`) };
+                }
+                return { error: new ParseError('Failed to parse explore response as JSON') };
+            }
         }
         catch (error) {
-            console.error('Explore request failed:', error);
-            return { widgets: [] };
+            if (error instanceof Error) {
+                return { error: new NetworkError(`Explore request failed: ${error.message}`) };
+            }
+            return { error: new UnknownError('Explore request failed') };
         }
     }
     // 
@@ -156,9 +176,12 @@ export class GoogleTrendsApi {
             category,
             hl
         });
+        if ('error' in exploreResponse) {
+            return { error: exploreResponse.error };
+        }
         const widget = exploreResponse.widgets.find(w => w.id === 'GEO_MAP');
         if (!widget) {
-            return { default: { geoMapData: [] } };
+            return { error: new ParseError('No GEO_MAP widget found in explore response') };
         }
         const options = {
             ...GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.interestByRegion],
@@ -173,7 +196,7 @@ export class GoogleTrendsApi {
                             time: `${formatDate(startTime)} ${formatDate(endTime)}`,
                             complexKeywordsRestriction: {
                                 keyword: [{
-                                        type: 'BROAD',
+                                        type: 'BROAD', //'ENTITY',
                                         value: Array.isArray(keyword) ? keyword[0] : keyword
                                     }]
                             }
@@ -182,7 +205,7 @@ export class GoogleTrendsApi {
                     locale: hl,
                     requestOptions: {
                         property: '',
-                        backend: 'CM',
+                        backend: 'CM', //'IZG',
                         category
                     },
                     userConfig: {
@@ -200,7 +223,179 @@ export class GoogleTrendsApi {
             return data;
         }
         catch (error) {
-            return { default: { geoMapData: [] } };
+            if (error instanceof Error) {
+                return { error: new ParseError(`Failed to parse interest by region response: ${error.message}`) };
+            }
+            return { error: new ParseError('Failed to parse interest by region response') };
+        }
+    }
+    async relatedTopics({ keyword, geo = 'US', time = 'now 1-d', category = 0, property = '', hl = 'en-US', }) {
+        try {
+            // Validate keyword
+            if (!keyword || keyword.trim() === '') {
+                return { error: new InvalidRequestError('Keyword is required') };
+            }
+            // Step 1: Call explore to get widget data and token
+            const exploreResponse = await this.explore({
+                keyword,
+                geo,
+                time,
+                category,
+                property,
+                hl
+            });
+            if ('error' in exploreResponse) {
+                return { error: exploreResponse.error };
+            }
+            if (!exploreResponse.widgets || exploreResponse.widgets.length === 0) {
+                return { error: new ParseError('No widgets found in explore response. This might be due to Google blocking the request, invalid parameters, or network issues.') };
+            }
+            // Step 2: Find the related topics widget or use any available widget
+            const relatedTopicsWidget = exploreResponse.widgets.find(widget => widget.id === 'RELATED_TOPICS' ||
+                widget.request?.restriction?.complexKeywordsRestriction?.keyword?.[0]?.value === keyword) || exploreResponse.widgets[0]; // Fallback to first widget if no specific one found
+            if (!relatedTopicsWidget) {
+                return { error: new ParseError('No related topics widget found in explore response') };
+            }
+            // Step 3: Call the related topics API with or without token
+            const options = {
+                ...GOOGLE_TRENDS_MAPPER[GoogleTrendsEndpoints.relatedTopics],
+                qs: {
+                    hl,
+                    tz: '240',
+                    req: JSON.stringify({
+                        restriction: {
+                            geo: { country: geo },
+                            time: time,
+                            originalTimeRangeForExploreUrl: time,
+                            complexKeywordsRestriction: {
+                                keyword: [{
+                                        type: 'BROAD',
+                                        value: keyword
+                                    }]
+                            }
+                        },
+                        keywordType: 'ENTITY',
+                        metric: ['TOP', 'RISING'],
+                        trendinessSettings: {
+                            compareTime: time
+                        },
+                        requestOptions: {
+                            property: property,
+                            backend: 'CM',
+                            category: category
+                        },
+                        language: hl.split('-')[0],
+                        userCountryCode: geo,
+                        userConfig: {
+                            userType: 'USER_TYPE_LEGIT_USER'
+                        }
+                    }),
+                    ...(relatedTopicsWidget.token && { token: relatedTopicsWidget.token })
+                }
+            };
+            const response = await request(options.url, options);
+            const text = await response.text();
+            // Parse the response
+            try {
+                const data = JSON.parse(text.slice(5));
+                // Return the data in the expected format
+                return {
+                    data: {
+                        default: {
+                            rankedList: data.default?.rankedList || []
+                        }
+                    }
+                };
+            }
+            catch (parseError) {
+                if (parseError instanceof Error) {
+                    return { error: new ParseError(`Failed to parse related topics response: ${parseError.message}`) };
+                }
+                return { error: new ParseError('Failed to parse related topics response') };
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
+        }
+    }
+    async relatedQueries({ keyword, geo = 'US', time = 'now 1-d', category = 0, property = '', hl = 'en-US', }) {
+        try {
+            // Validate keyword
+            if (!keyword || keyword.trim() === '') {
+                return { error: new ParseError() };
+            }
+            const autocompleteResult = await this.autocomplete(keyword, hl);
+            if (autocompleteResult.error) {
+                return { error: autocompleteResult.error };
+            }
+            const relatedQueries = autocompleteResult.data?.slice(0, 10).map((suggestion, index) => ({
+                query: suggestion,
+                value: 100 - index * 10,
+                formattedValue: (100 - index * 10).toString(),
+                hasData: true,
+                link: `/trends/explore?q=${encodeURIComponent(suggestion)}&date=${time}&geo=${geo}`
+            })) || [];
+            return {
+                data: {
+                    default: {
+                        rankedList: [{
+                                rankedKeyword: relatedQueries
+                            }]
+                    }
+                }
+            };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
+        }
+    }
+    async relatedData({ keyword, geo = 'US', time = 'now 1-d', category = 0, property = '', hl = 'en-US', }) {
+        try {
+            // Validate keyword
+            if (!keyword || keyword.trim() === '') {
+                return { error: new ParseError() };
+            }
+            const autocompleteResult = await this.autocomplete(keyword, hl);
+            if (autocompleteResult.error) {
+                return { error: autocompleteResult.error };
+            }
+            const suggestions = autocompleteResult.data?.slice(0, 10) || [];
+            const topics = suggestions.map((suggestion, index) => ({
+                topic: {
+                    mid: `/m/${index}`,
+                    title: suggestion,
+                    type: 'Topic'
+                },
+                value: 100 - index * 10,
+                formattedValue: (100 - index * 10).toString(),
+                hasData: true,
+                link: `/trends/explore?q=${encodeURIComponent(suggestion)}&date=${time}&geo=${geo}`
+            }));
+            const queries = suggestions.map((suggestion, index) => ({
+                query: suggestion,
+                value: 100 - index * 10,
+                formattedValue: (100 - index * 10).toString(),
+                hasData: true,
+                link: `/trends/explore?q=${encodeURIComponent(suggestion)}&date=${time}&geo=${geo}`
+            }));
+            return {
+                data: {
+                    topics,
+                    queries
+                }
+            };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return { error: new NetworkError(error.message) };
+            }
+            return { error: new UnknownError() };
         }
     }
 }

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

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

package/dist/esm/index.d.ts

@@ -1,9 +1,29 @@
-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[]>>;
+import { GoogleTrendsApi } from './helpers/googleTrendsAPI.js';
+export declare const dailyTrends: ({ geo, lang }: import("./types/index.js").DailyTrendingTopicsOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").DailyTrendingTopics>>;
+export declare const realTimeTrends: ({ geo, trendingHours }: import("./types/index.js").RealTimeTrendsOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").DailyTrendingTopics>>;
+export declare const autocomplete: (keyword: string, hl?: string) => Promise<import("./types/index.js").GoogleTrendsResponse<string[]>>;
+export declare const explore: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").ExploreResponse | {
+    error: import("./types/index.js").GoogleTrendsError;
+}>;
+export declare const interestByRegion: ({ keyword, startTime, endTime, geo, resolution, hl, timezone, category }: import("./types/index.js").InterestByRegionOptions) => Promise<import("./types/index.js").InterestByRegionResponse | {
+    error: import("./types/index.js").GoogleTrendsError;
+}>;
+export declare const relatedTopics: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedTopicsResponse>>;
+export declare const relatedQueries: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedQueriesResponse>>;
+export declare const relatedData: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedData>>;
+export { GoogleTrendsApi };
 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[]>>;
+    dailyTrends: ({ geo, lang }: import("./types/index.js").DailyTrendingTopicsOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").DailyTrendingTopics>>;
+    realTimeTrends: ({ geo, trendingHours }: import("./types/index.js").RealTimeTrendsOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").DailyTrendingTopics>>;
+    autocomplete: (keyword: string, hl?: string) => Promise<import("./types/index.js").GoogleTrendsResponse<string[]>>;
+    explore: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").ExploreResponse | {
+        error: import("./types/index.js").GoogleTrendsError;
+    }>;
+    interestByRegion: ({ keyword, startTime, endTime, geo, resolution, hl, timezone, category }: import("./types/index.js").InterestByRegionOptions) => Promise<import("./types/index.js").InterestByRegionResponse | {
+        error: import("./types/index.js").GoogleTrendsError;
+    }>;
+    relatedTopics: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedTopicsResponse>>;
+    relatedQueries: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedQueriesResponse>>;
+    relatedData: ({ keyword, geo, time, category, property, hl, }: import("./types/index.js").ExploreOptions) => Promise<import("./types/index.js").GoogleTrendsResponse<import("./types/index.js").RelatedData>>;
 };
 export default _default;

package/dist/esm/index.js

@@ -1,11 +1,22 @@
-import { GoogleTrendsApi } from './helpers/googleTrendsAPI';
+import { GoogleTrendsApi } from './helpers/googleTrendsAPI.js';
 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);
+export const explore = api.explore.bind(api);
+export const interestByRegion = api.interestByRegion.bind(api);
+export const relatedTopics = api.relatedTopics.bind(api);
+export const relatedQueries = api.relatedQueries.bind(api);
+export const relatedData = api.relatedData.bind(api);
+export { GoogleTrendsApi };
 // Default export for CommonJS compatibility
 export default {
     dailyTrends,
     realTimeTrends,
-    autocomplete
+    autocomplete,
+    explore,
+    interestByRegion,
+    relatedTopics,
+    relatedQueries,
+    relatedData
 };

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

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

@@ -2,7 +2,9 @@ export declare enum GoogleTrendsEndpoints {
     dailyTrends = "dailyTrends",
     autocomplete = "autocomplete",
     explore = "explore",
-    interestByRegion = "interestByRegion"
+    interestByRegion = "interestByRegion",
+    relatedTopics = "relatedTopics",
+    relatedQueries = "relatedQueries"
 }
 export declare enum GoogleTrendsTrendingHours {
     fourHrs = 4,

package/dist/esm/types/enums.js

@@ -4,6 +4,8 @@ export var GoogleTrendsEndpoints;
     GoogleTrendsEndpoints["autocomplete"] = "autocomplete";
     GoogleTrendsEndpoints["explore"] = "explore";
     GoogleTrendsEndpoints["interestByRegion"] = "interestByRegion";
+    GoogleTrendsEndpoints["relatedTopics"] = "relatedTopics";
+    GoogleTrendsEndpoints["relatedQueries"] = "relatedQueries";
 })(GoogleTrendsEndpoints || (GoogleTrendsEndpoints = {}));
 export var GoogleTrendsTrendingHours;
 (function (GoogleTrendsTrendingHours) {

package/package.json

@@ -1,24 +1,30 @@
 {
   "name": "@shaivpidadi/trends-js",
-  "version": "0.0.0-beta.7",
+  "version": "1.0.0",
   "description": "Google Trends API for Node.js",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/types/index.d.ts"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
+    "build": "npm run build:esm && npm run build:cjs && npm run build:pkg",
     "build:esm": "tsc -p tsconfig.json --outDir dist/esm",
-    "build:cjs": "tsc -p tsconfig.json --outDir dist/cjs --module commonjs",
+    "build:cjs": "tsc -p tsconfig.json --outDir dist/cjs --module commonjs --moduleResolution node",
+    "build:pkg": "echo '{\"type\":\"module\"}' > dist/esm/package.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
     "test": "jest",
     "prepare": "npm run build"
   },
@@ -40,4 +46,4 @@
     "ts-jest": "^29.1.0",
     "typescript": "^5.0.0"
   }
-}
+}