http-request-manager 4.1.2 → 4.1.4

package/README.md

@@ -2,29 +2,57 @@
 
 This library has 4 main services that simplify http requests, http request state and local storage states.
 
-1) [HttpRequestManager](./README/REQUEST_MANAGER_README.md) (service): This service provides http requests (CRUD operations)
+Here is an example:
 
-2) [HttpRequestStateManager](./README/REQUEST_STATE_MANAGER_README.md) (service): This service manages HTTP requests by maintaining state, eliminating the need to construct separate API calls for POST, PUT, and DELETE operations. It uses a GET request to retrieve an array of items and applies standard REST rules to update the state. When the state changes—either by adding a new record or modifying an existing one—the service automatically performs the appropriate POST, PUT, or DELETE requests without requiring explicit API calls.
+In this example we want to GET data from this URL with the following query params: 
+`http://localhost:4200/assets/as/auth/1234/users?sortBy=asc`
 
-3) [LocalStorageManager](./README/LOCAL_STORAGE_MANAGER_README.md) (service):  Enables the storage of data object structures in either localStorage or sessionStorage, maintaining an updated state to reflect storage changes. This approach eliminates the need to manually serialize and deserialize data structures using JSON.stringify and JSON.parse, streamlining data handling. By synchronizing state with storage updates, the service ensures immediate availability of the current state without relying on timers, thereby preventing potential side effects associated with delayed storage operations.
+Setup the options
 
-4) [DatabaseManagerService](./README/DATABASE_MANAGER_README.md) (beta): This extends the `Http-Request-State-Manager` with persistent storage using `DexieJS`, a minimalistic wrapper for IndexedDB (local browser DB). This service defines a table linked to HTTP requests, storing the retrieved data locally. Upon subsequent requests, the `Http-Request-State-Manager` checks the local database first; if the data is absent, it proceeds with the HTTP request. This approach reduces redundant HTTP requests, enhances application responsiveness, and enables offline functionality without requiring an internet connection.
+```ts
+const reqParams = ApiRequest.adapt({
+  server: 'http://localhost:4200/assets', // baseUrl
+  path: ['as', 'auth'], // additional paths you want to add
+  polling: 30, //make same request every 30s
+  retry: { times: 3, delay: 3 }, // retry 3 times spacing next the retry by 3 seconds
+  displayError: true // display toast if error occurs
+  adapter: ClientInfo.adpat // Client Model/Adapter class
+})
+```
+Now we use the base configs made above and when we make the request we want to add an `userId` which contains `1234` and path `'/users'`
+We also want to add query params to the request `{ sortBy: 'asc'}` which will be 'sortBy=asc'
 
-5) [Interceptors](./README/INTERCEPTORS_README.md): General interceptors that may be applied to the providers for requests. 
-    This includes: 
-      
-    - credentials - adds the { credentials: true } options for secure cookies to be persistent
+```ts
+this.data$ = this.httpManagerService.getRequest<ClientInfo[]>(reqParams, [userId, 'users', { sortBy: 'asc' }])
+```
 
-    - proxy-debugger for debugging api requests
+This returns an Observable which you then can implement it in your template as
 
-    - request-error for catching all requests the error with 400-500 status and presents a toast-message (snackbar) with the error
+`{{ (data$ | async) | json }}`
 
-    - request-header provides a few properties that are added to all requests
-      - 'Content-Type': 'application/json', // BE header for json type requests
-      - 'Accept-Language': this.language || 'en-CA', //language localization
-      - 'Current-Date': this.currentDate //todays date
+## Overview
 
+1) [HttpRequestManager](./README/REQUEST_MANAGER_README.md) (service): This service provides http requests (CRUD operations)
+2) [HttpRequestStateManager](./README/REQUEST_STATE_MANAGER_README.md) (service): This service manages HTTP requests by maintaining state, eliminating the need to construct separate API calls for POST, PUT, and DELETE operations. It uses a GET request to retrieve an array of items and applies standard REST rules to update the state. When the state changes—either by adding a new record or modifying an existing one—the service automatically performs the appropriate POST, PUT, or DELETE requests without requiring explicit API calls.
+3) [LocalStorageManager](./README/LOCAL_STORAGE_MANAGER_README.md) (service):  Enables the storage of data object structures in either localStorage or sessionStorage, maintaining an updated state to reflect storage changes. This approach eliminates the need to manually serialize and deserialize data structures using JSON.stringify and JSON.parse, streamlining data handling. By synchronizing state with storage updates, the service ensures immediate availability of the current state without relying on timers, thereby preventing potential side effects associated with delayed storage operations.
+4) [DatabaseManagerService](./README/DATABASE_MANAGER_README.md) (beta): This extends the `Http-Request-State-Manager` with persistent storage using `DexieJS`, a minimalistic wrapper for IndexedDB (local browser DB). This service defines a table linked to HTTP requests, storing the retrieved data locally. Upon subsequent requests, the `Http-Request-State-Manager` checks the local database first; if the data is absent, it proceeds with the HTTP request. This approach reduces redundant HTTP requests, enhances application responsiveness, and enables offline functionality without requiring an internet connection.
+5) [Interceptors](./README/INTERCEPTORS_README.md): General interceptors that may be applied to the providers for requests.
+   This includes:
+
+   - credentials - adds the { credentials: true } options for secure cookies to be persistent
+   - proxy-debugger for debugging api requests
+   - request-error for catching all requests the error with 400-500 status and presents a toast-message (snackbar) with the error
+   - request-header provides a few properties that are added to all requests
+
+     - 'Content-Type': 'application/json', // BE header for json type requests
+     - 'Accept-Language': this.language || 'en-CA', //language localization
+     - 'Current-Date': this.currentDate //todays date
 6) [Proxy-Config](./README/INTERCEPTORS_README.md) Support: This allows for proxies to be used when requests are made that are defined.
+7) Demos available for all the above that demonstrate all functionality
+
+    - import `HttpRequestManagerModule`
+    -  add the selector `<app-http-request-services-demo></app-http-request-services-demo>` to a template
+    - explore the many options - Top right menus toggles between the above services
 
 ## HttpServiceManager, HttpRequestStateManager and DatabaseManagerService Features:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-manager",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "description": "This library has 4 main services that simplify http requests, http request state and local storage states.",
   "author": "Michele Bonifacio",
   "company": "wavecoders.ca",