[Types] Update types

Author: sebastianquek

mod.ts

@@ -33,12 +33,14 @@ export type { GoogleScholarAuthorParameters } from "./src/engines/google_scholar
 export type { GoogleProductParameters } from "./src/engines/google_product.ts";
 export type { GoogleMapsParameters } from "./src/engines/google_maps.ts";
 export type { GoogleMapsPhotosParameters } from "./src/engines/google_maps_photos.ts";
+export type { GoogleMapsPhotoMetaParameters } from "./src/engines/google_maps_photo_meta.ts";
 export type { GoogleMapsReviewsParameters } from "./src/engines/google_maps_reviews.ts";
 export type { GoogleEventsParameters } from "./src/engines/google_events.ts";
 export type { GoogleAutocompleteParameters } from "./src/engines/google_autocomplete.ts";
 export type { GoogleRelatedQuestionsParameters } from "./src/engines/google_related_questions.ts";
 export type { GoogleTrendsParameters } from "./src/engines/google_trends.ts";
 export type { GoogleTrendsAutocompleteParameters } from "./src/engines/google_trends_autocomplete.ts";
+export type { GoogleFinanceParameters } from "./src/engines/google_finance.ts";
 export type { GoogleFinanceMarketsParameters } from "./src/engines/google_finance_markets.ts";
 export type { GoogleImmersiveProductParameters } from "./src/engines/google_immersive_product.ts";
 export type { BingParameters } from "./src/engines/bing.ts";

src/engines/apple_reviews.ts

@@ -35,7 +35,9 @@ export type AppleReviewsParameters = BaseParameters & {
    * Parameter is used for sorting reviews.
    * It can be set to:
    * `mostrecent`: Most recent (default),
-   * `mosthelpful`: Most helpful
+   * `mosthelpful`: Most helpful,
+   * `mostfavorable`: Most favorable,
+   * `mostcritical`: Most critical
    */
   sort?: string;
 };

src/engines/engine_map.ts

@@ -9,12 +9,14 @@ import type { GoogleScholarAuthorParameters } from "./google_scholar_author.ts";
 import type { GoogleProductParameters } from "./google_product.ts";
 import type { GoogleMapsParameters } from "./google_maps.ts";
 import type { GoogleMapsPhotosParameters } from "./google_maps_photos.ts";
+import type { GoogleMapsPhotoMetaParameters } from "./google_maps_photo_meta.ts";
 import type { GoogleMapsReviewsParameters } from "./google_maps_reviews.ts";
 import type { GoogleEventsParameters } from "./google_events.ts";
 import type { GoogleAutocompleteParameters } from "./google_autocomplete.ts";
 import type { GoogleRelatedQuestionsParameters } from "./google_related_questions.ts";
 import type { GoogleTrendsParameters } from "./google_trends.ts";
 import type { GoogleTrendsAutocompleteParameters } from "./google_trends_autocomplete.ts";
+import type { GoogleFinanceParameters } from "./google_finance.ts";
 import type { GoogleFinanceMarketsParameters } from "./google_finance_markets.ts";
 import type { GoogleImmersiveProductParameters } from "./google_immersive_product.ts";
 import type { BingParameters } from "./bing.ts";
@@ -63,6 +65,7 @@ export type EngineMap = {
   google_product: { parameters: GoogleProductParameters };
   google_maps: { parameters: GoogleMapsParameters };
   google_maps_photos: { parameters: GoogleMapsPhotosParameters };
+  google_maps_photo_meta: { parameters: GoogleMapsPhotoMetaParameters };
   google_maps_reviews: { parameters: GoogleMapsReviewsParameters };
   google_events: { parameters: GoogleEventsParameters };
   google_autocomplete: { parameters: GoogleAutocompleteParameters };
@@ -71,6 +74,7 @@ export type EngineMap = {
   google_trends_autocomplete: {
     parameters: GoogleTrendsAutocompleteParameters;
   };
+  google_finance: { parameters: GoogleFinanceParameters };
   google_finance_markets: { parameters: GoogleFinanceMarketsParameters };
   google_immersive_product: { parameters: GoogleImmersiveProductParameters };
   bing: { parameters: BingParameters };

src/engines/google.ts

@@ -47,6 +47,26 @@ export type GoogleParameters = BaseParameters & {
    */
   lsig?: string;
 
+  /**
+   * Google Knowledge Graph ID
+   * Parameter defines the id (`KGMID`) of the Google Knowledge Graph listing you
+   * want to scrape. Also known as Google Knowledge Graph ID. Searches with kgmid
+   * parameter will return results for the originally encrypted search parameters.
+   * For some searches, kgmid may override all other parameters except start, and num
+   * parameters.
+   */
+  kgmid?: string;
+
+  /**
+   * Google Cached Search Parameters ID
+   * Parameter defines the cached search parameters of the Google Search you want to
+   * scrape. Searches with si parameter will return results for the originally
+   * encrypted search parameters. For some searches, si may override all other
+   * parameters except start, and num parameters. si can be used to scrape Google
+   * Knowledge Graph Tabs.
+   */
+  si?: string;
+
   /**
    * Domain
    * Parameter defines the Google domain to use. It defaults to `google.com`. Head to
@@ -230,6 +250,8 @@ export type GoogleParameters = BaseParameters & {
    * Parameter defines the result offset. It skips the given number of results. It's
    * used for pagination. (e.g., `0` (default) is the first page of results, `10` is
    * the 2nd page of results, `20` is the 3rd page of results, etc.).
+   * Google Local Results only accepts multiples of `20`(e.g. `20` for the second
+   * page results, `40` for the third page results, etc.) as the start value.
    */
   start?: number;
 

src/engines/google_finance.ts

@@ -0,0 +1,20 @@
+import type { BaseParameters } from "../types.ts";
+
+export type GoogleFinanceParameters = BaseParameters & {
+  /**
+   * Search Query
+   * Parameter defines the query you want to search. It can be a stock, index, mutual
+   * fund, currency or futures.
+   */
+  q: string;
+
+  /**
+   * Language
+   * Parameter defines the language to use for the Google Finance search. It's a
+   * two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for
+   * French). Head to the [Google languages
+   * page](https://serpapi.com/google-languages) for a full list of supported Google
+   * languages.
+   */
+  hl?: string;
+};

src/engines/google_maps.ts

@@ -54,11 +54,24 @@ export type GoogleMapsParameters = BaseParameters & {
    */
   data?: string;
 
+  /**
+   * Place ID
+   * Parameter defines the unique reference to a place on a Google Map. Place IDs are
+   * available for most locations, including businesses, landmarks, parks, and
+   * intersections. You can find the place_id using our [Google Maps
+   * API](https://serpapi.com/maps-local-results).
+   * You can read more about Place IDs
+   * [here](https://developers.google.com/maps/documentation/places/web-service/place-id).
+   * place_id can be used without any other optional parameter.
+   */
+  place_id?: string;
+
   /**
    * Type of search
    * Parameter defines the type of search you want to make. It can be set to:
    * `search` - returns a list of results for the set q parameter,
    * `place` - returns results for a specific place when data parameter is set
+   * Parameter is not required when using place_id.
    */
   type: string;
 

src/engines/google_maps_photo_meta.ts

@@ -0,0 +1,10 @@
+import type { BaseParameters } from "../types.ts";
+
+export type GoogleMapsPhotoMetaParameters = BaseParameters & {
+  /**
+   * Data ID
+   * Parameter defines the Google Maps Photos' data ID. Find the data ID of a photo
+   * using our [Google Maps Photos API](https://serpapi.com/google-maps-photos-api).
+   */
+  data_id: string;
+};

src/engines/google_trends.ts

@@ -65,8 +65,15 @@ export type GoogleTrendsParameters = BaseParameters & {
   /**
    * Time Zone
    * Parameter is used to define a time zone. The default value is set to `420`
-   * (Pacific time zone: -07:00). Value is shown in minutes and can span from `-1439`
-   * to `1439`. tz parameter affects timestamps in response.
+   * (Pacific Day Time(PDT): -07:00). Value is shown in minutes and can span from
+   * `-1439` to `1439`.
+   * tz can be calculated using the time difference between UTC +0 and desired
+   * timezone.
+   * Example: `60 x ((Time in UTC+0 Now) - (Time in PDT Now)) = 420` will give
+   * results for PDT now. Because the reference point is UTC+0, the positive time
+   * zones will result in negative tz whereas negative time zones will result in
+   * positive tz.
+   * tz parameter also affects timestamps in response.
    */
   tz?: string;