http-request-manager 18.11.21 → 18.11.23

package/README.md

@@ -128,7 +128,7 @@ export class UsersComponent {
 
   ngOnInit() {
     this.httpManager.getRequest(
-      ApiRequest.adapt({ path: ['users'] })
+      ApiRequest.adapt({ path: ['users'], displaySuccess: true, successMessage: 'Loaded users!' })
     ).subscribe();
   }
 }
@@ -218,6 +218,9 @@ export class AppModule { }
 | `retry` | `RetryOptions` | Default retry configuration | `{ times: 0, delay: 3 }` |
 | `stream` | `boolean` | Enable streaming by default | `false` |
 | `displayError` | `boolean` | Show toast errors by default | `false` |
+| `displaySuccess` | `boolean` | Show toast on success by default | `false` |
+| `successMessage` | `string` | Custom success toast message (optional) | `undefined` |
+| `errorMessage` | `string` | Custom error toast message (optional, overrides default) | `undefined` |
 
 #### Local Storage Options (`LocalStorageOptions`)
 

package/fesm2022/http-request-manager.mjs

@@ -2935,15 +2935,17 @@ class RetryOptions {
 }
 
 class BatchOptions {
-    constructor(mode = 'sequential', stopOnError = false, concurrency = 3, ignoreErrors = false, logErrors = true) {
+    constructor(mode = 'sequential', stopOnError = false, concurrency = 3, ignoreErrors = false, logErrors = true, displaySuccess, displayError) {
         this.mode = mode;
         this.stopOnError = stopOnError;
         this.concurrency = concurrency;
         this.ignoreErrors = ignoreErrors;
         this.logErrors = logErrors;
+        this.displaySuccess = displaySuccess;
+        this.displayError = displayError;
     }
     static adapt(item) {
-        return new BatchOptions(item?.mode ?? 'sequential', item?.stopOnError ?? false, item?.concurrency ?? 3, item?.ignoreErrors ?? false, item?.logErrors !== false);
+        return new BatchOptions(item?.mode ?? 'sequential', item?.stopOnError ?? false, item?.concurrency ?? 3, item?.ignoreErrors ?? false, item?.logErrors !== false, item?.displaySuccess ?? false, item?.displayError ?? false);
     }
 }
 
@@ -2988,7 +2990,7 @@ var DataType;
 })(DataType || (DataType = {}));
 
 class ConfigHTTPOptions {
-    constructor(server = '', path, headers, polling, retry, stream, displayError) {
+    constructor(server = '', path, headers, polling, retry, stream, displayError, displaySuccess) {
         this.server = server;
         this.path = path;
         this.headers = headers;
@@ -2996,11 +2998,12 @@ class ConfigHTTPOptions {
         this.retry = retry;
         this.stream = stream;
         this.displayError = displayError;
+        this.displaySuccess = displaySuccess;
     }
     static adapt(item) {
         const server = Array.isArray(item?.server) ? item.server.join('/') : item?.server || '';
         const retryOptions = item?.retry ? RetryOptions.adapt(item.retry) : RetryOptions.adapt();
-        return new ConfigHTTPOptions(server, (item?.path) ? item.path : [], (item?.headers) ? item.headers : {}, item?.polling ? Math.floor(item.polling) : 0, retryOptions, (item?.stream) ? item.stream : false, (item?.displayError) ? item.displayError : false);
+        return new ConfigHTTPOptions(server, (item?.path) ? item.path : [], (item?.headers) ? item.headers : {}, item?.polling ? Math.floor(item.polling) : 0, retryOptions, (item?.stream) ? item.stream : false, (item?.displayError) ? item.displayError : false, (item?.displaySuccess) ? item.displaySuccess : false);
     }
 }
 
@@ -3618,9 +3621,13 @@ class HTTPManagerService extends RequestService {
         const func = this.getRecordRequest;
         const requests = this.createRequest(func, updatedOptions);
         return this.createObservable(updatedOptions, requests, func.name)
-            .pipe(tap(data => this.data.next(data))).pipe(finalize(() => this.isPending.next(false)), catchError((err) => {
+            .pipe(tap(data => {
+            this.data.next(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        })).pipe(finalize(() => this.isPending.next(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage || err?.message);
             this.isPending.next(false);
             return this.handleError(err);
         }));
@@ -3631,10 +3638,13 @@ class HTTPManagerService extends RequestService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.createRecordRequest;
         const requests = this.createRequest(func, updatedOptions, data);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.next(data)))
-            .pipe(finalize(() => this.isPending.next(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.next(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.next(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage || err?.message);
             this.isPending.next(false);
             return this.handleError(err);
         }));
@@ -3645,10 +3655,13 @@ class HTTPManagerService extends RequestService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.updateRecordRequest;
         const requests = this.createRequest(func, updatedOptions, data);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.next(data)))
-            .pipe(finalize(() => this.isPending.next(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.next(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.next(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage || err?.message);
             this.isPending.next(false);
             return this.handleError(err);
         }));
@@ -3659,10 +3672,13 @@ class HTTPManagerService extends RequestService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.deleteRecordRequest;
         const requests = this.createRequest(func, updatedOptions);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.next(data)))
-            .pipe(finalize(() => this.isPending.next(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.next(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.next(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage || err?.message);
             this.isPending.next(false);
             return this.handleError(err);
         }));
@@ -3751,9 +3767,9 @@ class HTTPManagerService extends RequestService {
         this.error.next(error.message || `${error.status} - ${error.statusText}`);
         return throwError(() => error);
     }
-    handleErrorWithSnackBar(error) {
+    handleErrorWithSnackBar(error, message) {
         const displayError = ToastDisplay.adapt({
-            message: error.message || `${error.status} - ${error.statusText}`,
+            message: message || error.message || `${error.status} - ${error.statusText}`,
             action: 'OK',
             color: ToastColors.ERROR,
             icon: 'error',
@@ -3761,6 +3777,16 @@ class HTTPManagerService extends RequestService {
         });
         this.toastMessage.toastMessage(displayError);
     }
+    handleSuccessWithSnackBar(message) {
+        const displaySuccess = ToastDisplay.adapt({
+            message: message || 'Success',
+            action: 'OK',
+            color: ToastColors.SUCCESS,
+            icon: 'check_circle',
+            duration: 3 * 1000, //3 seconds
+        });
+        this.toastMessage.toastMessage(displaySuccess);
+    }
     stopPolling() {
         this.isPending.next(false);
         this.polling$.next();
@@ -3796,14 +3822,17 @@ class HTTPManagerService extends RequestService {
      * @param options Optional batch configuration
      * @returns Observable emitting array of data when all requests complete
      */
-    getSequentialRequest(requests, options) {
+    getSequentialRequest(requests, options, successMessage, errorMessage) {
         const batchOptions = BatchOptions.adapt(options);
         const results = new Array(requests.length);
         return from(requests).pipe(concatMap((req, index) => {
-            return this.getRequest(req).pipe(tap(data => {
+            return this.getRequest(req, undefined).pipe(tap(data => {
                 results[index] = data;
             }), catchError(error => this.handleSequentialError(req, error, index, batchOptions)));
-        }), toArray(), map(() => results));
+        }), toArray(), tap(() => {
+            if (batchOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(successMessage);
+        }), map(() => results));
     }
     /**
      * Execute requests in parallel with concurrency control
@@ -3811,15 +3840,18 @@ class HTTPManagerService extends RequestService {
      * @param options Optional batch configuration with concurrency limit
      * @returns Observable emitting array of data when all requests complete
      */
-    getParallelRequest(requests, options) {
+    getParallelRequest(requests, options, successMessage, errorMessage) {
         const batchOptions = BatchOptions.adapt(options);
         const concurrency = batchOptions.concurrency || 3;
         const results = new Array(requests.length);
         return from(requests).pipe(mergeMap((req, index) => {
-            return this.getRequest(req).pipe(tap(data => {
+            return this.getRequest(req, undefined).pipe(tap(data => {
                 results[index] = data;
             }), catchError(error => this.handleParallelError(req, error, index, batchOptions)));
-        }, concurrency), toArray(), map(() => results));
+        }, concurrency), toArray(), tap(() => {
+            if (batchOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(successMessage);
+        }), map(() => results));
     }
     /**
      * Execute multiple HTTP requests and emit individual state changes in real-time
@@ -4273,9 +4305,13 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.getRecordRequest;
         const requests = this.createRequest(func, updatedOptions);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.set(data)), finalize(() => this.isPending.set(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.set(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.set(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage || err?.message);
             this.isPending.set(false);
             return this.handleError(err);
         }));
@@ -4286,9 +4322,13 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.createRecordRequest;
         const requests = this.createRequest(func, updatedOptions, data);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.set(data)), finalize(() => this.isPending.set(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.set(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.set(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage);
             this.isPending.set(false);
             return this.handleError(err);
         }));
@@ -4299,9 +4339,13 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.updateRecordRequest;
         const requests = this.createRequest(func, updatedOptions, data);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.set(data)), finalize(() => this.isPending.set(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.set(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.set(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage);
             this.isPending.set(false);
             return this.handleError(err);
         }));
@@ -4312,9 +4356,13 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         const updatedOptions = this.defineReqOptions(options, params);
         const func = this.deleteRecordRequest;
         const requests = this.createRequest(func, updatedOptions);
-        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => this.data.set(data)), finalize(() => this.isPending.set(false)), catchError((err) => {
+        return this.createObservable(updatedOptions, requests, func.name).pipe(tap(data => {
+            this.data.set(data);
+            if (updatedOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(updatedOptions.successMessage);
+        }), finalize(() => this.isPending.set(false)), catchError((err) => {
             if (updatedOptions.displayError)
-                this.handleErrorWithSnackBar(err);
+                this.handleErrorWithSnackBar(err, updatedOptions.errorMessage);
             this.isPending.set(false);
             return this.handleError(err);
         }));
@@ -4399,9 +4447,9 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         this.error.set(error.message || `${error.status} - ${error.statusText}`);
         return throwError(() => error);
     }
-    handleErrorWithSnackBar(error) {
+    handleErrorWithSnackBar(error, message) {
         const displayError = ToastDisplay.adapt({
-            message: error.message || `${error.status} - ${error.statusText}`,
+            message: message || error.message || `${error.status} - ${error.statusText}`,
             action: 'OK',
             color: ToastColors.ERROR,
             icon: 'error',
@@ -4409,6 +4457,16 @@ class HTTPManagerSignalsService extends RequestSignalsService {
         });
         this.toastMessage.toastMessage(displayError);
     }
+    handleSuccessWithSnackBar(message) {
+        const displaySuccess = ToastDisplay.adapt({
+            message: message || 'Success',
+            action: 'OK',
+            color: ToastColors.SUCCESS,
+            icon: 'check_circle',
+            duration: 3 * 1000,
+        });
+        this.toastMessage.toastMessage(displaySuccess);
+    }
     stopPolling() {
         this.isPending.set(false);
         this.polling$.next();
@@ -4444,14 +4502,17 @@ class HTTPManagerSignalsService extends RequestSignalsService {
      * @param options Optional batch configuration
      * @returns Observable emitting array of data when all requests complete
      */
-    getSequentialRequest(requests, options) {
+    getSequentialRequest(requests, options, successMessage, errorMessage) {
         const batchOptions = BatchOptions.adapt(options);
         const results = new Array(requests.length);
         return from(requests).pipe(concatMap((req, index) => {
-            return this.getRequest(req).pipe(tap(data => {
+            return this.getRequest(req, undefined).pipe(tap(data => {
                 results[index] = data;
             }), catchError(error => this.handleSequentialError(req, error, index, batchOptions)));
-        }), toArray(), map(() => results));
+        }), toArray(), tap(() => {
+            if (batchOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(successMessage);
+        }), map(() => results));
     }
     /**
      * Execute requests in parallel with concurrency control
@@ -4459,15 +4520,18 @@ class HTTPManagerSignalsService extends RequestSignalsService {
      * @param options Optional batch configuration with concurrency limit
      * @returns Observable emitting array of data when all requests complete
      */
-    getParallelRequest(requests, options) {
+    getParallelRequest(requests, options, successMessage, errorMessage) {
         const batchOptions = BatchOptions.adapt(options);
         const concurrency = batchOptions.concurrency || 3;
         const results = new Array(requests.length);
         return from(requests).pipe(mergeMap((req, index) => {
-            return this.getRequest(req).pipe(tap(data => {
+            return this.getRequest(req, undefined).pipe(tap(data => {
                 results[index] = data;
             }), catchError(error => this.handleParallelError(req, error, index, batchOptions)));
-        }, concurrency), toArray(), map(() => results));
+        }, concurrency), toArray(), tap(() => {
+            if (batchOptions.displaySuccess)
+                this.handleSuccessWithSnackBar(successMessage);
+        }), map(() => results));
     }
     /**
      * Execute multiple HTTP requests and emit individual state changes in real-time
@@ -4571,7 +4635,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.14", ngImpo
                 }] }] });
 
 class ApiRequest {
-    constructor(server = '', path, headers, adapter, mapper, polling, retry, stream, streamType, displayError, saveAs, fileContentHeader, ws, env) {
+    constructor(server = '', path, headers, adapter, mapper, polling, retry, stream, streamType, displayError, displaySuccess, successMessage, errorMessage, saveAs, fileContentHeader, ws, env) {
         this.server = server;
         this.path = path;
         this.headers = headers;
@@ -4582,6 +4646,9 @@ class ApiRequest {
         this.stream = stream;
         this.streamType = streamType;
         this.displayError = displayError;
+        this.displaySuccess = displaySuccess;
+        this.successMessage = successMessage;
+        this.errorMessage = errorMessage;
         this.saveAs = saveAs;
         this.fileContentHeader = fileContentHeader;
         this.ws = ws;
@@ -4589,7 +4656,7 @@ class ApiRequest {
     }
     static adapt(item) {
         const server = Array.isArray(item?.server) ? item.server.join('/') : item?.server || '';
-        return new ApiRequest(server, (item?.path) ? item.path : [], (item?.headers) ? item.headers : {}, item?.adapter, item?.mapper, item?.polling ? Math.floor(item.polling) : 0, item?.retry ? RetryOptions.adapt(item.retry) : RetryOptions.adapt(), (item?.stream) ? item.stream : false, item?.streamType || StreamType.AI_STREAMING, (item?.displayError) ? item.displayError : false, item?.saveAs, item?.fileContentHeader, item?.ws, item?.env || 'dev');
+        return new ApiRequest(server, item?.path ? item.path : [], item?.headers ? item.headers : {}, item?.adapter, item?.mapper, item?.polling ? Math.floor(item.polling) : 0, item?.retry ? RetryOptions.adapt(item.retry) : RetryOptions.adapt(), item?.stream ? item.stream : false, item?.streamType || StreamType.AI_STREAMING, item?.displayError ? item.displayError : false, item?.displaySuccess ? item.displaySuccess : false, item?.successMessage, item?.errorMessage, item?.saveAs, item?.fileContentHeader, item?.ws, item?.env || 'dev');
     }
 }