Keep image API error handling consistent

Author: tanysheng

mod.ts

@@ -2,7 +2,6 @@ export type { Config } from "./src/config.ts";
 export { config } from "./src/config.ts";
 
 export {
-  ImageApiError,
   InvalidArgumentError,
   InvalidTimeoutError,
   MissingApiKeyError,

src/errors.ts

@@ -21,14 +21,6 @@ export class InvalidTimeoutError extends Error {
   }
 }
 
-export class ImageApiError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "ImageApiError";
-    Object.setPrototypeOf(this, ImageApiError.prototype);
-  }
-}
-
 export class RequestTimeoutError extends Error {
   constructor() {
     super("The request was timed out");

src/serpapi.ts

@@ -1,4 +1,4 @@
-import { ImageApiError, InvalidArgumentError } from "./errors.ts";
+import { InvalidArgumentError } from "./errors.ts";
 import { readFile } from "node:fs";
 import type {
   AccountApiParameters,
@@ -348,6 +348,8 @@ export async function uploadImage(
   parameters: ImageApiParameters,
   callback?: (result: ImageApiResponse) => void,
 ): Promise<ImageApiResponse> {
+  if (!parameters?.image) throw new InvalidArgumentError();
+
   const key = validateApiKey(parameters.api_key);
   const timeout = validateTimeout(parameters.timeout);
   let image: Uint8Array | ArrayBuffer;
@@ -362,23 +364,14 @@ export async function uploadImage(
   } else {
     image = parameters.image;
   }
-  let response: string;
-  try {
-    response = await _internals.uploadImage(
-      image,
-      {
-        api_key: key,
-        requestOptions: parameters.requestOptions,
-      },
-      timeout,
-    );
-  } catch (error) {
-    let message = "Image upload failed";
-    try {
-      message = JSON.parse(String(error)).error || message;
-    } catch { /* */ }
-    throw new ImageApiError(message);
-  }
+  const response = await _internals.uploadImage(
+    image,
+    {
+      api_key: key,
+      requestOptions: parameters.requestOptions,
+    },
+    timeout,
+  );
   const result = JSON.parse(response) as ImageApiResponse;
   callback?.(result);
   return result;

src/types.ts

@@ -29,6 +29,7 @@ export type ImageApiParameters = {
 };
 
 export type ImageApiResponse = {
-  message: string;
-  image_id: string;
+  message?: string;
+  image_id?: string;
+  error?: string;
 };

tests/serpapi_test.ts

@@ -32,7 +32,6 @@ import {
   getJson,
   getJsonBySearchId,
   getLocations,
-  ImageApiError,
   InvalidArgumentError,
   InvalidTimeoutError,
   MissingApiKeyError,
@@ -226,6 +225,14 @@ describe("uploadImage", () => {
     );
   });
 
+  it("with no image", () => {
+    assertRejects(
+      // @ts-expect-error Test runtime validation for JavaScript callers.
+      async () => await uploadImage({ api_key: "test_api_key" }),
+      InvalidArgumentError,
+    );
+  });
+
   it("accepts image bytes", async () => {
     await assertImageUpload(image);
   });
@@ -240,19 +247,17 @@ describe("uploadImage", () => {
     }
   });
 
-  it("throws ImageApiError", async () => {
+  it("rejects upon error response", async () => {
+    const apiError = '{"error":"Invalid image"}';
     const executeStub = stub(
       _internals,
       "uploadImage",
-      () => Promise.reject('{"error":"Invalid image"}'),
+      () => Promise.reject(apiError),
     );
     config.api_key = "test_api_key";
     try {
-      await assertRejects(
-        async () => await uploadImage({ image }),
-        ImageApiError,
-        "Invalid image",
-      );
+      const error = await uploadImage({ image }).catch((error) => error);
+      assertEquals(error, apiError);
     } finally {
       executeStub.restore();
     }