@gitbeaker/rest 39.27.0 → 39.27.1

package/README.md

@@ -339,17 +339,26 @@ const api = new Gitlab({
 
 Request errors are returned back within a plain Error instance, using the cause to hold the original response and a text description of the error pulled from the response's error or message fields if JSON, or its plain text value:
 
-```js
-Error: Bad Request
-<stack trace>
-{
-  [cause]: {
-    description: <text description>,
-    response: <original Response object>
+```ts
+class GitbeakerError extends Error {
+  constructor(
+    message: string,
+    options?: {
+      cause: {
+        description: string;
+        request: Request;
+        response: Response;
+      };
+    },
+  ) {
+    super(message, options);
+    this.name = 'GitbeakerError';
   }
 }
 ```
 
+Note, the message is assigned to the Response's `statusText`, and the [Request](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#request) and [Response](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#response) types are from the NodeJS API.
+
 ## Examples
 
 Once you have your library instantiated, you can utilize many of the API's functionality:

package/dist/index.js

@@ -72,7 +72,7 @@ async function throwFailedRequestError(request, response) {
   } else {
     description = content;
   }
-  throw new Error(response.statusText, {
+  throw new requesterUtils.GitbeakerRequestError(response.statusText, {
     cause: {
       description,
       request,
@@ -101,7 +101,7 @@ async function defaultRequestHandler(endpoint, options) {
     await endpointRateLimit();
     const response = await fetch(request).catch((e) => {
       if (e.name === "TimeoutError" || e.name === "AbortError") {
-        throw new Error("Query timeout was reached");
+        throw new requesterUtils.GitbeakerTimeoutError("Query timeout was reached");
       }
       throw e;
     });
@@ -112,7 +112,7 @@ async function defaultRequestHandler(endpoint, options) {
     await delay(2 ** i * 0.25);
     continue;
   }
-  throw new Error(
+  throw new requesterUtils.GitbeakerRetryError(
     `Could not successfully complete this request due to Error 429. Check the applicable rate limits for this endpoint.`
   );
 }

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import * as Resources from '@gitbeaker/core';
-import { createRequesterFn, presetResourceArguments, getMatchingRateLimiter } from '@gitbeaker/requester-utils';
+import { createRequesterFn, presetResourceArguments, getMatchingRateLimiter, GitbeakerTimeoutError, GitbeakerRetryError, GitbeakerRequestError } from '@gitbeaker/requester-utils';
 
 // src/index.ts
 async function defaultOptionsHandler(resourceOptions, requestOptions) {
@@ -50,7 +50,7 @@ async function throwFailedRequestError(request, response) {
   } else {
     description = content;
   }
-  throw new Error(response.statusText, {
+  throw new GitbeakerRequestError(response.statusText, {
     cause: {
       description,
       request,
@@ -79,7 +79,7 @@ async function defaultRequestHandler(endpoint, options) {
     await endpointRateLimit();
     const response = await fetch(request).catch((e) => {
       if (e.name === "TimeoutError" || e.name === "AbortError") {
-        throw new Error("Query timeout was reached");
+        throw new GitbeakerTimeoutError("Query timeout was reached");
       }
       throw e;
     });
@@ -90,7 +90,7 @@ async function defaultRequestHandler(endpoint, options) {
     await delay(2 ** i * 0.25);
     continue;
   }
-  throw new Error(
+  throw new GitbeakerRetryError(
     `Could not successfully complete this request due to Error 429. Check the applicable rate limits for this endpoint.`
   );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/rest",
-  "version": "39.27.0",
+  "version": "39.27.1",
   "description": "Cross Platform implementation of the GitLab API",
   "license": "MIT",
   "engines": {
@@ -56,8 +56,8 @@
     "release": "auto shipit"
   },
   "dependencies": {
-    "@gitbeaker/core": "^39.27.0",
-    "@gitbeaker/requester-utils": "^39.27.0"
+    "@gitbeaker/core": "^39.27.1",
+    "@gitbeaker/requester-utils": "^39.27.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.40.1",
@@ -65,5 +65,5 @@
     "tsup": "^8.0.1",
     "typescript": "^5.3.3"
   },
-  "gitHead": "6166bc65c1d44bc025b51aa088d1ecc097db9d25"
+  "gitHead": "4de10dcc0b1ecb50c47d8d5088b9dd28ebf7ab92"
 }