Simplify EngineParameters and BaseResponse

Author: zyc9012

examples/deno/basic_ts/example.ts

@@ -1,12 +1,12 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import { config, EngineParameters, getJson } from "../../../mod.ts";
+import { config, getJson } from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 const params = {
   engine: "google",
   q: "Coffee",
   api_key: apiKey,
-} as EngineParameters;
+};
 
 // Show result as JSON (async/await)
 const response1 = await getJson(params);

examples/deno/pagination_ts/example.ts

@@ -1,5 +1,5 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import { config, EngineParameters, getJson } from "../../../mod.ts";
+import { config, getJson } from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 
@@ -10,7 +10,7 @@ const params = {
   engine: "google",
   q: "Coffee",
   api_key: apiKey,
-} satisfies EngineParameters;
+};
 
 // Pagination (async/await)
 let page1 = await getJson(params);

examples/node/basic_ts_node_14_up/example.ts

@@ -7,7 +7,7 @@
  */
 
 import * as Dotenv from "dotenv";
-import { config, EngineParameters, getJson } from "serpapi";
+import { config, getJson } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
@@ -16,7 +16,7 @@ const params = {
   engine: "google",
   q: "Coffee",
   api_key: apiKey,
-} satisfies EngineParameters;
+};
 
 // Show result as JSON (async/await)
 const response1 = await getJson(params);

examples/node/pagination_ts_node_14_up/example.ts

@@ -9,7 +9,7 @@
  */
 
 import * as Dotenv from "dotenv";
-import { config, EngineParameters, getJson } from "serpapi";
+import { config, getJson } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
@@ -21,7 +21,7 @@ const params = {
   engine: "google",
   q: "Coffee",
   api_key: apiKey,
-} satisfies EngineParameters;
+};
 
 // Pagination (async/await)
 let page1 = await getJson(params);

mod.ts

@@ -10,7 +10,6 @@ export {
 export type {
   AccountApiParameters,
   AccountInformation,
-  BaseParameters,
   BaseResponse,
   EngineParameters,
   GetBySearchIdParameters,

src/serpapi.ts

@@ -75,7 +75,7 @@ export function getJson(
     ]
     | [
       engine: string,
-      parameters: EngineParameters<false>,
+      parameters: EngineParameters,
       callback?: (json: BaseResponse) => void,
     ]
 ): Promise<BaseResponse> {
@@ -87,7 +87,7 @@ export function getJson(
     const newParameters = { ...parameters, engine } as EngineParameters;
     return _getJson(newParameters, callback);
   } else if (
-    typeof args[0] === "object" &&
+    typeof args[0] === "object" && typeof args[1] !== "object" &&
     (typeof args[1] === "undefined" || typeof args[1] === "function")
   ) {
     const [parameters, callback] = args;
@@ -155,7 +155,7 @@ export function getHtml(
     ]
     | [
       engine: string,
-      parameters: EngineParameters<false>,
+      parameters: EngineParameters,
       callback?: (html: string) => void,
     ]
 ): Promise<string> {
@@ -167,7 +167,7 @@ export function getHtml(
     const newParameters = { ...parameters, engine } as EngineParameters;
     return _getHtml(newParameters, callback);
   } else if (
-    typeof args[0] === "object" &&
+    typeof args[0] === "object" && typeof args[1] !== "object" &&
     (typeof args[1] === "undefined" || typeof args[1] === "function")
   ) {
     const [parameters, callback] = args;

src/types.ts

@@ -1,75 +1,12 @@
-export type BaseParameters = {
-  /**
-   * Parameter defines the device to use to get the results. It can be set to
-   * `desktop` (default) to use a regular browser, `tablet` to use a tablet browser
-   * (currently using iPads), or `mobile` to use a mobile browser (currently
-   * using iPhones).
-   */
-  device?: "desktop" | "tablet" | "mobile";
-
-  /**
-   * Parameter will force SerpApi to fetch the Google results even if a cached
-   * version is already present. A cache is served only if the query and all
-   * parameters are exactly the same. Cache expires after 1h. Cached searches
-   * are free, and are not counted towards your searches per month. It can be set
-   * to `false` (default) to allow results from the cache, or `true` to disallow
-   * results from the cache. `no_cache` and `async` parameters should not be used together.
-   */
-  no_cache?: boolean;
-
-  /**
-   * Parameter defines the way you want to submit your search to SerpApi. It can
-   * be set to `false` (default) to open an HTTP connection and keep it open until
-   * you got your search results, or `true` to just submit your search to SerpApi
-   * and retrieve them later. In this case, you'll need to use our
-   * [Searches Archive API](https://serpapi.com/search-archive-api) to retrieve
-   * your results. `async` and `no_cache` parameters should not be used together.
-   * `async` should not be used on accounts with
-   * [Ludicrous Speed](https://serpapi.com/plan) enabled.
-   */
-  async?: boolean;
-
-  /**
-   * Parameter defines the SerpApi private key to use.
-   */
-  api_key?: string | null;
-
-  /**
-   * Specify the client-side timeout of the request. In milliseconds.
-   */
-  timeout?: number;
-};
-
-export type EngineParameters<
-  EngineRequired = true,
-> =
-  & (EngineRequired extends true ? { engine: string }
-    : { engine?: string })
-  & BaseParameters
-  & Record<string, unknown>;
+// deno-lint-ignore no-explicit-any
+export type EngineParameters = Record<string, any>;
 
 export type BaseResponse = {
-  search_metadata: {
-    id: string;
-    status: "Queued" | "Processing" | "Success";
-    json_endpoint: string;
-    created_at: string;
-    processed_at: string;
-    raw_html_file: string;
-    total_time_taken: number;
-  };
-  search_parameters: Omit<
-    EngineParameters,
-    "api_key" | "no_cache" | "async" | "timeout"
-  >;
-  serpapi_pagination?: { next: string };
-  pagination?: { next: string };
   next?: (
     callback?: (json: BaseResponse) => void,
   ) => Promise<BaseResponse>;
   // deno-lint-ignore no-explicit-any
-  [key: string]: any; // TODO(seb): use recursive type
-};
+} & Record<string, any>;
 
 export type GetBySearchIdParameters = {
   api_key?: string;

src/utils.ts

@@ -31,10 +31,8 @@ type NextParameters = {
   ]: string;
 };
 export function extractNextParameters(
-  json: {
-    serpapi_pagination?: { next: string };
-    pagination?: { next: string };
-  },
+  // deno-lint-ignore no-explicit-any
+  json: any,
 ) {
   const nextUrlString = json["serpapi_pagination"]?.["next"] ||
     json["pagination"]?.["next"];

tests/serpapi_test.ts

@@ -293,7 +293,7 @@ describe("getJson", {
   it("callback", {
     ignore: !HAS_API_KEY,
   }, async () => {
-    const json = await new Promise<BaseResponse<"google">>((done) => {
+    const json = await new Promise<BaseResponse>((done) => {
       getJson({
         engine: "google",
         q: "Paris",
@@ -305,7 +305,7 @@ describe("getJson", {
     assertExists(json.organic_results);
 
     // old API
-    const json2 = await new Promise<BaseResponse<"google">>((done) => {
+    const json2 = await new Promise<BaseResponse>((done) => {
       getJson("google", {
         q: "Paris",
         api_key: SERPAPI_TEST_KEY,

tests/utils_test.ts

@@ -29,7 +29,7 @@ const BASE_URL = Deno.env.get("ENV_TYPE") === "local"
 describe("extractNextParameters", () => {
   it("with serpapi_pagination property", async () => {
     assertEquals(
-      await extractNextParameters<"google">({
+      await extractNextParameters({
         serpapi_pagination: {
           next:
             "https://serpapi.com/search.json?device=desktop&engine=google&gl=us&google_domain=google.com&hl=en&location=Austin%2C+Texas%2C+United+States&q=coffee&start=10",
@@ -50,7 +50,7 @@ describe("extractNextParameters", () => {
 
   it("with pagination property", async () => {
     assertEquals(
-      await extractNextParameters<"google_scholar_profiles">(
+      await extractNextParameters(
         {
           pagination: {
             next: