fixed error handling

Author: golsch

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@mycore-test/js-common",
-  "version": "0.1.26",
+  "version": "0.1.28",
   "exports": {
     "./i18n": "./src/i18n/index.ts",
     "./access-key": "./src/access-key/index.ts",

src/access-key/access-key.service.ts

@@ -17,7 +17,7 @@
  */
 
 import { AuthStrategy } from '../auth';
-import { handleError } from '../utils/http';
+import { handleError, ensureOk } from '../utils/http';
 import {
   AccessKey,
   CreateAccessKey,
@@ -51,6 +51,23 @@ export interface GetAccessKeysOptions {
   limit?: number;
 }
 
+const buildSearchParams = (options?: GetAccessKeysOptions): string => {
+  const searchParams = new URLSearchParams();
+  if (options?.reference) {
+    searchParams.set('reference', options.reference);
+  }
+  if (options?.permissions?.length) {
+    searchParams.set('permissions', options.permissions.join(','));
+  }
+  if (options?.offset) {
+    searchParams.set('offset', String(options.offset));
+  }
+  if (options?.limit) {
+    searchParams.set('limit', String(options.limit));
+  }
+  return searchParams.toString();
+};
+
 /**
  * Base path for access key resource endpoint.
  */
@@ -76,40 +93,29 @@ export class AccessKeyService {
    * @returns A promise that resolves with the access keys information.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to request access keys.
+   * @throws {Error} If an unknown error occurred.
    */
   public async getAccessKeys(
     options?: GetAccessKeysOptions
   ): Promise<AccessKeysSummary> {
-    const searchParams = new URLSearchParams();
-    if (options?.reference) {
-      searchParams.set('reference', options.reference);
-    }
-    if (options?.permissions && options.permissions.length > 0) {
-      searchParams.set('permissions', options.permissions.join(','));
-    }
-    if (options?.offset) {
-      searchParams.set('offset', String(options.offset));
-    }
-    if (options?.limit) {
-      searchParams.set('limit', String(options.limit));
-    }
     try {
-      const response = await fetch(this.getUrl(`?${searchParams.toString()}`), {
-        headers: {
-          ...this.getAuthHeaders(),
-          Accept: 'application/json',
-        },
-      });
-      if (!response.ok) {
-        handleError(response);
-      }
+      const response = await fetch(
+        this.getUrl(`?${buildSearchParams(options)}`),
+        {
+          headers: {
+            ...this.getAuthHeaders(),
+            Accept: 'application/json',
+          },
+        }
+      );
+      ensureOk(response);
       const totalCount = response.headers.get('x-total-count');
       return {
         accessKeys: (await response.json()) as AccessKey[],
         totalCount: totalCount ? parseInt(totalCount, 10) : 0,
       } as AccessKeysSummary;
-    } catch {
-      throw new Error('Failed to get access keys');
+    } catch (error) {
+      throw handleError(error, 'Failed to get access keys');
     }
   }
 
@@ -120,6 +126,7 @@ export class AccessKeyService {
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to request access keys.
    * @throws {ResourceNotFoundError} If the access key does not exist.
+   * @throws {Error} If an unknown error occurred.
    */
   public async getAccessKey(id: string): Promise<AccessKey> {
     try {
@@ -129,12 +136,10 @@ export class AccessKeyService {
           Accept: 'application/json',
         },
       });
-      if (!response.ok) {
-        handleError(response);
-      }
+      ensureOk(response);
       return (await response.json()) as AccessKey;
-    } catch {
-      throw new Error('Failed to get access key');
+    } catch (error) {
+      throw handleError(error, 'Failed to get access key');
     }
   }
 
@@ -144,6 +149,7 @@ export class AccessKeyService {
    * @returns A promise that resolves with the ID of the created access key.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to create access key.
+   * @throws {Error} If an unknown error occurred.
    */
   public async createAccessKey(accessKey: CreateAccessKey): Promise<string> {
     try {
@@ -155,12 +161,10 @@ export class AccessKeyService {
         },
         body: JSON.stringify(accessKey),
       });
-      if (!response.ok) {
-        handleError(response);
-      }
+      ensureOk(response);
       return response.headers.get('location')?.split('/').pop() as string;
-    } catch {
-      throw new Error('Failed to create access key');
+    } catch (error) {
+      throw handleError(error, 'Failed to create access key');
     }
   }
 
@@ -171,6 +175,7 @@ export class AccessKeyService {
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to update access key.
    * @throws {ResourceNotFoundError} If the access key does not exist.
+   * @throws {Error} If an unknown error occurred.
    */
   public async updateAccessKey(
     id: string,
@@ -185,11 +190,9 @@ export class AccessKeyService {
         },
         body: JSON.stringify(accessKey),
       });
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error('Failed to update access key');
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(error, 'Failed to update access key');
     }
   }
 
@@ -200,6 +203,7 @@ export class AccessKeyService {
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to update access key.
    * @throws {ResourceNotFoundError} If the access key does not exist.
+   * @throws {Error} If an unknown error occurred.
    */
   public async patchAccessKey(
     id: string,
@@ -214,11 +218,9 @@ export class AccessKeyService {
         },
         body: JSON.stringify(accessKey),
       });
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error('Failed to update access key');
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(error, 'Failed to update access key');
     }
   }
 
@@ -228,6 +230,7 @@ export class AccessKeyService {
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to delete access key.
    * @throws {ResourceNotFoundError} If the access key does not exist.
+   * @throws {Error} If an unknown error occurred.
    */
   public async deleteAccessKey(id: string): Promise<void> {
     try {
@@ -237,11 +240,9 @@ export class AccessKeyService {
           ...this.getAuthHeaders(),
         },
       });
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error('Failed to delete access key');
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(error, 'Failed to delete access key');
     }
   }
 

src/orcid/orcid-user.service.ts

@@ -17,7 +17,7 @@
  */
 
 import { AuthStrategy } from '../auth/types.ts';
-import { handleError } from '../utils/http/index.ts';
+import { handleError, ensureOk } from '../utils/http';
 import { OrcidUserSettings, OrcidUserStatus } from './types.ts';
 
 /**
@@ -47,6 +47,7 @@ export class OrcidUserService {
    * @throws An error if the request fails or the status cannot be retrieved.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to get user status.
+   * @throws {Error} If an unknown error occurred.
    */
   public getUserStatus = async (): Promise<OrcidUserStatus> => {
     try {
@@ -56,12 +57,10 @@ export class OrcidUserService {
           Accept: 'application/json',
         },
       });
-      if (!response.ok) {
-        handleError(response);
-      }
+      ensureOk(response);
       return (await response.json()) as OrcidUserStatus;
-    } catch {
-      throw new Error('Failed to fetch Orcid user status');
+    } catch (error) {
+      throw handleError(error, 'Failed to fetch Orcid user status');
     }
   };
 
@@ -71,6 +70,7 @@ export class OrcidUserService {
    * @returns A promise that resolves when the authentication is successfully revoked.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to revoke ORCID.
+   * @throws {Error} If an unknown error occurred.
    */
   public revokeAuth = async (orcid: string): Promise<void> => {
     try {
@@ -80,11 +80,9 @@ export class OrcidUserService {
           ...this.getAuthHeaders(),
         },
       });
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error('Failed to revoke ORCID');
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(error, 'Failed to revoke ORCID');
     }
   };
 
@@ -96,6 +94,7 @@ export class OrcidUserService {
    * @throws An error if the request fails or the settings cannot be retrieved.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to get user settings.
+   * @throws {Error} If an unknown error occurred.
    */
   public getUserSettings = async (
     orcid: string
@@ -107,12 +106,13 @@ export class OrcidUserService {
           Accept: 'application/json',
         },
       });
-      if (!response.ok) {
-        handleError(response);
-      }
+      ensureOk(response);
       return (await response.json()) as OrcidUserSettings;
-    } catch {
-      throw new Error(`Failed to fetch ORCID user settings for ${orcid}.`);
+    } catch (error) {
+      throw handleError(
+        error,
+        `Failed to fetch ORCID user settings for ${orcid}.`
+      );
     }
   };
 
@@ -125,6 +125,7 @@ export class OrcidUserService {
    * @throws An error if the request fails or the settings cannot be updated.
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to update user settings.
+   * @throws {Error} If an unknown error occurred.
    */
   public updateUserSettings = async (
     orcid: string,
@@ -139,11 +140,12 @@ export class OrcidUserService {
         },
         body: JSON.stringify(settings),
       });
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error(`Failed to update ORCID user settings for ${orcid}.`);
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(
+        error,
+        `Failed to update ORCID user settings for ${orcid}.`
+      );
     }
   };
 

src/orcid/orcid-work.service.ts

@@ -17,7 +17,7 @@
  */
 
 import { AuthStrategy } from '../auth';
-import { handleError } from '../utils/http';
+import { handleError, ensureOk } from '../utils/http';
 import { OrcidWorkStatus } from './types';
 
 /**
@@ -53,6 +53,7 @@ export class OrcidWorkService {
    * @returns A promise that resolves to an `OrcidWorkStatusDto` object containing the status of the work
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to get work status.
+   * @throws {Error} If an unknown error occurred.
    */
   public getWorkStatus = async (
     orcid: string,
@@ -68,12 +69,10 @@ export class OrcidWorkService {
           },
         }
       );
-      if (!response.ok) {
-        handleError(response);
-      }
+      ensureOk(response);
       return (await response.json()) as OrcidWorkStatus;
-    } catch {
-      throw new Error(`Failed to fetch work status for ${objectId}.`);
+    } catch (error) {
+      throw handleError(error, `Failed to fetch work status for ${objectId}.`);
     }
   };
 
@@ -86,6 +85,7 @@ export class OrcidWorkService {
    * @throws {UnauthorizedActionError} If the user is not authorized.
    * @throws {PermissionError} If the user is not allowed to export object.
    * @throws {ResourceNotFoundError} If the object does not exist.
+   * @throws {Error} If an unknown error occurred.
    */
   public exportObject = async (
     orcid: string,
@@ -98,11 +98,9 @@ export class OrcidWorkService {
           method: 'POST',
         }
       );
-      if (!response.ok) {
-        handleError(response);
-      }
-    } catch {
-      throw new Error(`Failed to export ${objectId} to ${orcid}.`);
+      ensureOk(response);
+    } catch (error) {
+      throw handleError(error, `Failed to export ${objectId} to ${orcid}.`);
     }
   };