Merge pull request #41 from mondaycom/feature/romka/seamless-api-erro…

…r-handling seamless api client error upgrade
mondaycom · Nov 12, 2024 · 106e27c · 106e27c
2 parents 14d9a54 + c43cbc0
commit 106e27c
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 7 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/api/CHANGELOG.MD b/packages/api/CHANGELOG.MD
@@ -1,5 +1,11 @@
 # Changelog
 
+## [7.0.0]
+
+### ⚠️ Breaking Changes
+
+- **SeamlessApiClient error type**: The `SeamlessApiClient` class now aligns its error format with the ApiClient class. Errors are now nested under response.errors. Use the SeamlessApiClientError type provided by the package to handle these errors.
+
 ## [6.0.0]
 
 ### ⚠️ Breaking Changes

diff --git a/packages/api/README.md b/packages/api/README.md
@@ -171,12 +171,15 @@ Basically, when you are making an api call from the client side of an app deploy
 ```typescript
 import {
   Board,
-} from "@mondaycom/api";
+} from "@mondaydotcomorg/api";
 
-const { boards } = await SeamlessApiClient.request<{boards: [Board];}>(`query { boards(ids: some_id) { id name } }`);
+// Option A - using pre defined types
+const seamlessApiClient = new SeamlessApiClient();
+const { boards } = await client.request<{boards: [Board];}>(`query { boards(ids: some_id) { id name } }`);
 
-// or using your own types after integrating with @mondaycom/setup-api
+// Option B - using your own types after integrating with @mondaydotcomorg/setup-api
 import { GetBoardsQueryVariables, GetBoardsQuery } from "./generated/graphql";
+const seamlessApiClient = new SeamlessApiClient();
 const variables: GetBoardsQueryVariables = { ids: ["some_id"] };
 
 export const getBoards = gql`
@@ -188,7 +191,13 @@ export const getBoards = gql`
   }
 `;
 
-const data = await SeamlessApiClient.request<GetBoardsQuery>(getBoards, variables);
+try {
+  const data = await seamlessApiClient.request<GetBoardsQuery>(getBoards, variables);
+} catch (error) { 
+  // If the error is from SeamlessApiClient, it will be of type SeamlessApiClientError, which you can import from our package. Also, error.type will also 'SeamlessApiClientError'.
+
+  console.log(error.response.errors)
+}
 ```
 
 ### Type support

diff --git a/packages/api/lib/errors/seamless-api-client-error.ts b/packages/api/lib/errors/seamless-api-client-error.ts
@@ -0,0 +1,11 @@
+export class SeamlessApiClientError extends Error {
+  response: { errors: any };
+  type: string;
+
+  constructor(message: string, errors: any) {
+    super(message);
+    this.response = { errors };
+    this.name = this.constructor.name;
+    this.type = 'SeamlessApiClientError';
+  }
+}
diff --git a/packages/api/lib/seamless-api-client.ts b/packages/api/lib/seamless-api-client.ts
@@ -1,4 +1,7 @@
 import { ApiVersionType, DEFAULT_VERSION, QueryVariables } from './constants';
+import { SeamlessApiClientError } from './errors/seamless-api-client-error';
+
+export { SeamlessApiClientError };
 
 interface ListenerCallback {
   (data: any): void;
@@ -65,7 +68,8 @@ export class SeamlessApiClient {
         clearTimeout(timeoutId);
         removeListener();
         if (data.errorMessage) {
-          reject(new Error(`${data.errorMessage} - ${data.data}`));
+          const error = new SeamlessApiClientError(data.errorMessage, data.data.errors);
+          reject(error);
         } else {
           resolve(data as T);
         }

diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/api",
-  "version": "6.0.0",
+  "version": "7.0.2",
   "description": "monday.com API client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",