@rendomnet/apiservice 1.3.3 → 1.3.5

package/README.md

@@ -194,6 +194,41 @@ const result = await api.call({
 
 If no accountId is provided, ApiService automatically uses 'default' as the account ID.
 
+## Request Cancellation
+
+ApiService supports request cancellation using the standard `AbortController` API. This allows you to cancel ongoing API requests, including those that are being retried.
+
+```typescript
+// Create an AbortController
+const controller = new AbortController();
+
+// Make an API call with the controller's signal
+const apiPromise = api.call({
+  method: 'GET',
+  route: '/users',
+  abortSignal: controller.signal
+});
+
+// Cancel the request at any time
+controller.abort();
+
+try {
+  await apiPromise;
+} catch (error) {
+  if (error.name === 'AbortError' || error.message === 'Request aborted') {
+    console.log('Request was successfully aborted');
+  } else {
+    console.error('An error occurred:', error);
+  }
+}
+```
+
+The abort functionality works with all features of ApiService:
+- Cancels ongoing requests immediately
+- Prevents retry attempts from starting
+- Works with cached and non-cached requests
+- Compatible with all authentication providers
+
 ## AuthProvider Interface
 
 ```typescript

package/dist/HttpClient.js

@@ -15,7 +15,7 @@ class HttpClient {
      * Make an HTTP request
      */
     async makeRequest(apiParams, authToken) {
-        const { accountId, method, route, base, body, data, headers, queryParams, contentType = 'application/json', accessToken: forcedAccessToken, useAuth = true, files, } = apiParams;
+        const { accountId, method, route, base, body, data, headers, queryParams, contentType = 'application/json', accessToken: forcedAccessToken, useAuth = true, files, abortSignal, } = apiParams;
         // Build URL and request body
         const url = this.buildUrl(base, route, queryParams);
         const requestBody = body || data;
@@ -32,6 +32,7 @@ class HttpClient {
             forcedAccessToken,
             useAuth,
             headers,
+            abortSignal,
         });
         // Make the request
         try {
@@ -71,10 +72,11 @@ class HttpClient {
     /**
      * Build fetch options for request
      */
-    buildFetchOptions({ method, body, formData, contentType, authToken, forcedAccessToken, useAuth, headers, }) {
+    buildFetchOptions({ method, body, formData, contentType, authToken, forcedAccessToken, useAuth, headers, abortSignal, }) {
         const allowedMethods = ['POST', 'PUT', 'PATCH'];
         return {
             method,
+            signal: abortSignal,
             headers: {
                 ...(useAuth && {
                     Authorization: `Bearer ${forcedAccessToken || authToken.access_token}`

package/dist/index.d.ts

@@ -42,6 +42,7 @@ declare class ApiService {
      */
     call(apiCallParams: Omit<ApiCallParams, 'accountId'> & {
         accountId?: string;
+        abortSignal?: AbortSignal;
     }): Promise<any>;
     /**
      * Legacy method for backward compatibility
@@ -49,6 +50,7 @@ declare class ApiService {
      */
     makeApiCall(apiCallParams: Omit<ApiCallParams, 'accountId'> & {
         accountId?: string;
+        abortSignal?: AbortSignal;
     }): Promise<any>;
     /**
      * Make a request with retry capability

package/dist/index.js

@@ -135,7 +135,7 @@ class ApiService {
      */
     async makeRequestWithRetry(apiCallParams) {
         var _a;
-        const { accountId } = apiCallParams;
+        const { accountId, abortSignal } = apiCallParams;
         let attempts = 0;
         const statusRetries = {};
         let currentParams = { ...apiCallParams };
@@ -150,6 +150,9 @@ class ApiService {
         }
         // Main retry loop
         while (attempts < this.maxAttempts) {
+            if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+                throw new Error('Request aborted');
+            }
             attempts++;
             try {
                 // Get authentication headers if needed

package/dist/types.d.ts

@@ -38,6 +38,7 @@ interface ApiCallParams {
     contentType?: string;
     cacheTime?: number;
     files?: File[];
+    abortSignal?: AbortSignal;
 }
 interface HookSettings {
     /**

package/package.json

@@ -1,12 +1,22 @@
 {
   "name": "@rendomnet/apiservice",
-  "version": "1.3.3",
+  "version": "1.3.5",
   "description": "A robust TypeScript API service framework for making authenticated API calls",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "prepare": "npm run build"
+  },
   "keywords": [
     "api",
     "service",
@@ -40,13 +50,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "build": "tsc",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
   }
-}
+}