@shaivpidadi/trends-js 1.0.1 → 1.0.3

package/README.md

@@ -22,7 +22,6 @@ npm install @shaivpidadi/trends-js
 - Get interest by region data
 - Get related topics for any keyword
 - Get related queries for any keyword
-- Get combined related data (topics + queries)
 - TypeScript support
 - Promise-based API
 
@@ -113,8 +112,6 @@ const suggestions = await GoogleTrendsApi.autocomplete(
   'bitcoin', // Keyword to get suggestions for
   'en-US', // Language (default: 'en-US')
 );
-
-// Returns: string[]
 ```
 
 ### Explore
@@ -124,8 +121,8 @@ Get widget data for a keyword:
 ```typescript
 const result = await GoogleTrendsApi.explore({
   keyword: 'bitcoin',
-  geo: 'US', // Default: 'US'
-  time: 'today 12-m', // Default: 'today 12-m'
+  geo: 'US' // Default: 'US',
+  time: 'today 12-m',
   category: 0, // Default: 0
   property: '', // Default: ''
   hl: 'en-US', // Default: 'en-US'
@@ -140,6 +137,7 @@ const result = await GoogleTrendsApi.explore({
 //   }>
 // }
 ```
+> **Note:** For all methods below, it is recommended to set `enableBackoff: true` in the options to automatically handle and bypass Google's rate limiting.
 
 ### Interest by Region
 
@@ -147,14 +145,15 @@ Get interest data by region:
 
 ```typescript
 const result = await GoogleTrendsApi.interestByRegion({
-  keyword: 'Stock Market', // Required - string or string[]
+  keyword: 'Stock Market', // Required - string
   startTime: new Date('2024-01-01'), // Optional - defaults to 2004-01-01
   endTime: new Date(), // Optional - defaults to current date
-  geo: 'US', // Optional - string or string[] - defaults to 'US'
+  geo: 'US', // Optional - string - defaults to 'US'
   resolution: 'REGION', // Optional - 'COUNTRY' | 'REGION' | 'CITY' | 'DMA'
   hl: 'en-US', // Optional - defaults to 'en-US'
   timezone: -240, // Optional - defaults to local timezone
   category: 0, // Optional - defaults to 0
+  enableBackoff: true // Optional - defaults to false
 });
 
 // Result structure:
@@ -176,30 +175,20 @@ const result = await GoogleTrendsApi.interestByRegion({
 // }
 ```
 
-Example with multiple keywords and regions:
-
-```typescript
-const result = await GoogleTrendsApi.interestByRegion({
-  keyword: ['wine', 'peanuts'],
-  geo: ['US-CA', 'US-VA'],
-  startTime: new Date('2024-01-01'),
-  endTime: new Date(),
-  resolution: 'CITY',
-});
-```
-
 ### Related Topics
 
 Get related topics for any keyword:
 
 ```typescript
 const result = await GoogleTrendsApi.relatedTopics({
-  keyword: 'artificial intelligence', // Required
-  geo: 'US', // Optional - defaults to 'US'
-  time: 'now 1-d', // Optional - defaults to 'now 1-d'
+  keyword: 'artificial intelligence',
+  startTime: new Date('2024-01-01'),
+  endTime: new Date(),
   category: 0, // Optional - defaults to 0
+  geo: 'US', // Optional - defaults to 'US'
   property: '', // Optional - defaults to ''
   hl: 'en-US', // Optional - defaults to 'en-US'
+  enableBackoff: true // Optional - defaults to false
 });
 
 // Result structure:
@@ -230,12 +219,13 @@ Get related queries for any keyword:
 
 ```typescript
 const result = await GoogleTrendsApi.relatedQueries({
-  keyword: 'machine learning', // Required
-  geo: 'US', // Optional - defaults to 'US'
-  time: 'now 1-d', // Optional - defaults to 'now 1-d'
-  category: 0, // Optional - defaults to 0
-  property: '', // Optional - defaults to ''
-  hl: 'en-US', // Optional - defaults to 'en-US'
+  keyword: 'machine learning',
+  geo: 'US',
+  startTime: new Date('2024-01-01'),
+  endTime: new Date(),
+  category: 0,
+  hl: 'en-US',
+  enableBackoff: true // Optional - defaults to false
 });
 
 // Result structure:
@@ -256,37 +246,14 @@ const result = await GoogleTrendsApi.relatedQueries({
 // }
 ```
 
-### Combined Related Data
-
-Get both related topics and queries in a single call:
-
-```typescript
-const result = await GoogleTrendsApi.relatedData({
-  keyword: 'blockchain', // Required
-  geo: 'US', // Optional - defaults to 'US'
-  time: 'now 1-d', // Optional - defaults to 'now 1-d'
-  category: 0, // Optional - defaults to 0
-  property: '', // Optional - defaults to ''
-  hl: 'en-US', // Optional - defaults to 'en-US'
-});
-
-// Result structure:
-// {
-//   data: {
-//     topics: Array<RelatedTopic>,
-//     queries: Array<RelatedQuery>
-//   }
-// }
-```
-
 ## API Reference
 
 ### DailyTrendsOptions
 
 ```typescript
 interface DailyTrendsOptions {
-  geo?: string; // Default: 'US'
-  lang?: string; // Default: 'en'
+  geo?: string;
+  lang?: string;
 }
 ```
 
@@ -295,7 +262,7 @@ interface DailyTrendsOptions {
 ```typescript
 interface RealTimeTrendsOptions {
   geo: string;
-  trendingHours?: number; // Default: 4
+  trendingHours?: number;
 }
 ```
 
@@ -304,11 +271,11 @@ interface RealTimeTrendsOptions {
 ```typescript
 interface ExploreOptions {
   keyword: string;
-  geo?: string; // Default: 'US'
-  time?: string; // Default: 'today 12-m'
-  category?: number; // Default: 0
-  property?: string; // Default: ''
-  hl?: string; // Default: 'en-US'
+  geo?: string;
+  time?: string;
+  category?: number;
+  property?: string;
+  hl?: string;
 }
 ```
 
@@ -316,63 +283,45 @@ interface ExploreOptions {
 
 ```typescript
 interface InterestByRegionOptions {
-  keyword: string | string[]; // Required - search term(s)
-  startTime?: Date; // Optional - start date
-  endTime?: Date; // Optional - end date
-  geo?: string | string[]; // Optional - geocode(s)
-  resolution?: 'COUNTRY' | 'REGION' | 'CITY' | 'DMA'; // Optional
-  hl?: string; // Optional - language code
-  timezone?: number; // Optional - timezone offset
-  category?: number; // Optional - category number
-}
-```
-
-### RelatedTopicsResponse
-
-```typescript
-interface RelatedTopicsResponse {
-  default: {
-    rankedList: Array<{
-      rankedKeyword: Array<{
-        topic: {
-          mid: string;
-          title: string;
-          type: string;
-        };
-        value: number;
-        formattedValue: string;
-        hasData: boolean;
-        link: string;
-      }>;
-    }>;
-  };
+  keyword: string;
+  startTime?: Date;
+  endTime?: Date;
+  geo?: string;
+  resolution?: 'COUNTRY' | 'REGION' | 'CITY' | 'DMA';
+  hl?: string;
+  timezone?: number;
+  category?: number;
+  enableBackoff?: boolean;
 }
 ```
 
-### RelatedQueriesResponse
+### RelatedTopicsOptions
 
 ```typescript
-interface RelatedQueriesResponse {
-  default: {
-    rankedList: Array<{
-      rankedKeyword: Array<{
-        query: string;
-        value: number;
-        formattedValue: string;
-        hasData: boolean;
-        link: string;
-      }>;
-    }>;
-  };
+interface RelatedTopicsOptions {
+  keyword: string;
+  geo?: string;
+  startTime?: Date;
+  endTime?: Date;
+  category?: number;
+  property?: string;
+  hl?: string;
+  enableBackoff?: boolean;
 }
 ```
 
-### RelatedData
+### RelatedQueriesOptions
 
 ```typescript
-interface RelatedData {
-  topics: Array<RelatedTopic>;
-  queries: Array<RelatedQuery>;
+interface RelatedQueriesOptions {
+  keyword: string;
+  geo?: string;
+  startTime?: Date;
+  endTime?: Date;
+  category?: number;
+  property?: string;
+  hl?: string;
+  enableBackoff?: boolean;
 }
 ```
 
@@ -380,6 +329,16 @@ interface RelatedData {
 
 ### Building
 
+```bash
+npm run build
 ```
 
+### Testing
+
+```bash
+npm test
 ```
+
+## License
+
+MIT

package/dist/cjs/constants.js

@@ -37,17 +37,17 @@ exports.GOOGLE_TRENDS_MAPPER = {
         headers: {},
     },
     [enums_js_1.GoogleTrendsEndpoints.relatedTopics]: {
-        path: '/trends/api/widgetdata/relatedtopics',
+        path: '/trends/api/widgetdata/relatedsearches',
         method: 'GET',
         host: GOOGLE_TRENDS_BASE_URL,
-        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/widgetdata/relatedtopics`,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/widgetdata/relatedsearches`,
         headers: {},
     },
     [enums_js_1.GoogleTrendsEndpoints.relatedQueries]: {
-        path: '/trends/api/widgetdata/relatedqueries',
+        path: '/trends/api/widgetdata/relatedsearches',
         method: 'GET',
         host: GOOGLE_TRENDS_BASE_URL,
-        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/widgetdata/relatedqueries`,
+        url: `https://${GOOGLE_TRENDS_BASE_URL}/trends/api/widgetdata/relatedsearches`,
         headers: {},
     },
 };

package/dist/cjs/helpers/format.d.ts

@@ -1,2 +1,4 @@
 import { DailyTrendingTopics } from '../types/index.js';
+export declare const formatTrendsDate: (date: Date) => string;
+export declare const formatDate: (date: Date) => string;
 export declare const extractJsonFromResponse: (text: string) => DailyTrendingTopics | null;

package/dist/cjs/helpers/format.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractJsonFromResponse = void 0;
+exports.extractJsonFromResponse = exports.formatDate = exports.formatTrendsDate = void 0;
 const GoogleTrendsError_js_1 = require("../errors/GoogleTrendsError.js");
 // For future reference and update: from google trends page rpc call response,
 // 0	"twitter down"	The main trending search term.
@@ -16,6 +16,21 @@ const GoogleTrendsError_js_1 = require("../errors/GoogleTrendsError.js");
 // 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 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}`;
+};
+exports.formatTrendsDate = formatTrendsDate;
+const formatDate = (date) => {
+    return date.toISOString().split('T')[0];
+};
+exports.formatDate = formatDate;
 const extractJsonFromResponse = (text) => {
     const cleanedText = text.replace(/^\)\]\}'/, '').trim();
     try {

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

@@ -1,4 +1,4 @@
-import { DailyTrendingTopics, DailyTrendingTopicsOptions, RealTimeTrendsOptions, ExploreOptions, ExploreResponse, InterestByRegionOptions, InterestByRegionResponse, GoogleTrendsResponse, GoogleTrendsError, RelatedTopicsResponse, RelatedQueriesResponse, RelatedData } from '../types/index.js';
+import { DailyTrendingTopics, DailyTrendingTopicsOptions, RealTimeTrendsOptions, ExploreOptions, ExploreResponse, InterestByRegionOptions, InterestByRegionResponse, GoogleTrendsResponse, GoogleTrendsError, RelatedTopicsResponse, RelatedTopicsOptions, RelatedQueriesResponse, RelatedData, RelatedQueriesOptions } from '../types/index.js';
 export declare class GoogleTrendsApi {
     /**
      * Get autocomplete suggestions for a keyword
@@ -19,14 +19,12 @@ export declare class GoogleTrendsApi {
      * @returns Promise with trending topics data
      */
     realTimeTrends({ geo, trendingHours }: RealTimeTrendsOptions): Promise<GoogleTrendsResponse<DailyTrendingTopics>>;
-    explore({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<ExploreResponse | {
+    explore({ keyword, geo, time, category, property, hl, enableBackoff, }: ExploreOptions): Promise<ExploreResponse | {
         error: GoogleTrendsError;
     }>;
-    interestByRegion({ keyword, startTime, endTime, geo, resolution, hl, timezone, category }: InterestByRegionOptions): Promise<InterestByRegionResponse | {
-        error: GoogleTrendsError;
-    }>;
-    relatedTopics({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<GoogleTrendsResponse<RelatedTopicsResponse>>;
-    relatedQueries({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<GoogleTrendsResponse<RelatedQueriesResponse>>;
+    interestByRegion({ keyword, startTime, endTime, geo, resolution, hl, timezone, category, enableBackoff }: InterestByRegionOptions): Promise<GoogleTrendsResponse<InterestByRegionResponse>>;
+    relatedTopics({ keyword, geo, startTime, endTime, category, property, hl, enableBackoff, }: RelatedTopicsOptions): Promise<GoogleTrendsResponse<RelatedTopicsResponse>>;
+    relatedQueries({ keyword, geo, startTime, endTime, category, property, hl, enableBackoff, }: RelatedQueriesOptions): Promise<GoogleTrendsResponse<RelatedQueriesResponse>>;
     relatedData({ keyword, geo, time, category, property, hl, }: ExploreOptions): Promise<GoogleTrendsResponse<RelatedData>>;
 }
 declare const _default: GoogleTrendsApi;