@omnia/fx 7.8.64-preview → 7.8.65-preview

package/internal-do-not-import-from-here/core/http/HttpClient.d.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestConfig, AxiosInstance, AxiosResponse } from "axios";
-import { GuidValue, HttpHeaders, IContextProviderCollection, IContextProvider } from "../../models";
+import { GuidValue, HttpHeaders, IContextProviderCollection, IContextProvider, Future } from "../../models";
 export interface HttpClientConstructor {
     configPromise?: Promise<AxiosRequestConfig>;
 }
@@ -43,33 +43,70 @@ export declare class HttpClient {
     constructor(configPromise?: Promise<AxiosRequestConfig>);
     useConfig(conf: AxiosRequestConfig): void;
     /**
-    * Perform request using the provided request config
-    */
-    request<T = any>(config: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Handle abort functionality of abort setup
+     * @param config axios config
+     * @param httpClientOnAbort abort setup function of Future object type
+     * @returns
+     */
+    private tryConfigAxiosAbortSignal;
     /**
-    * Perform GET request for provided url
-    */
-    get<T = any>(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Perform request using the provided request config
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    request<T = any>(config: AxiosRequestConfig): Future<AxiosResponse<T>>;
     /**
-    * Perform DELETE request for provided url
-    */
-    delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Perform GET request for provided url
+     * @param url url
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    get<T = any>(url: string, config?: AxiosRequestConfig): Future<AxiosResponse<T>>;
+    /**
+     * Perform DELETE request for provided url
+     * @param url url
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    delete<T = any>(url: string, config?: AxiosRequestConfig): Future<AxiosResponse<T>>;
     /**
-    * Perform HEAD request for provided url
-    */
+     * Perform HEAD request for provided url
+     * @param url url
+     * @param config axios request config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
     head(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse<any>>;
     /**
-    * Perform POST request for provided url
-    */
-    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Perform POST request for provided url
+     * @param url url
+     * @param data data
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Future<AxiosResponse<T>>;
     /**
-    * Perform PUT request for provided url
-    */
-    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Perform PUT request for provided url
+     * @param url url
+     * @param data data
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Future<AxiosResponse<T>>;
     /**
-    * Perform PATCH request for provided url
-    */
-    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+     * Perform PATCH request for provided url
+     * @param url url
+     * @param data data
+     * @param config axios config
+     * @param onAbortCallback abort call back of Future type from outside
+     * @returns
+     */
+    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Future<AxiosResponse<T>>;
     private handleAxiosError;
     private handleSuccessResponse;
     private enableCircuitBreaker;

package/internal-do-not-import-from-here/shared/models/Future.d.ts

@@ -15,6 +15,12 @@ export declare class Future<T> extends Promise<T> {
      * @memberof Future
      */
     tryCatch(): Future<[success: T, error: Error]>;
+    /**
+     * Expose abort for other future to use.
+     * chain method for future
+     * @param onAbort
+     */
+    abortIf(onAbort: (cb: (reason?: any) => void) => void): this;
     /**
      * Aborts the request
      *

package/internal-do-not-import-from-here/shared/models/Future.js

@@ -53,6 +53,20 @@ class Future extends Promise {
             }
         });
     }
+    /**
+     * Expose abort for other future to use.
+     * chain method for future
+     * @param onAbort
+     */
+    abortIf(onAbort) {
+        //to avoid "Illegal invocation" from lost context of this 
+        const abort = (reason) => { this.abort(reason); };
+        onAbort(abort);
+        return this;
+    }
+    // then<TResult1 = T, TResult2 = never>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2> {
+    //         this.then();
+    // }
     /**
      * Aborts the request
      *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@omnia/fx",
   "license": "MIT",
-  "version": "7.8.64-preview",
+  "version": "7.8.65-preview",
   "description": "Provide Omnia Fx typings and tooling for clientside Omnia development.",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -20,7 +20,7 @@
   ],
   "author": "Omnia Digital Workplace AB",
   "dependencies": {
-    "@omnia/fx-models": "7.8.64-preview",
+    "@omnia/fx-models": "7.8.65-preview",
     "@microsoft/signalr": "6.0.1",
     "broadcast-channel": "4.8.0",
     "dayjs": "1.10.7",