laravel-request 1.2.7 → 1.2.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "laravel-request",
   "productName": "laravel-request",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "description": "laravel-request",
   "main": "src/index.js",
   "module": "src/index.js",

package/readme.md

@@ -96,3 +96,16 @@ response must be like below, for 200 status should contains key "result" with te
     "data": [],
 }
 
+you can cancel request by
+
+```
+
+let cancelTokenSource = Api.get('active', SearchAllTypesHelper.ALL_TYPES, {
+            item_search: searchQuery,
+            user_id: clientId,
+            search_stock: 1
+        }).call(({data}) => {}, () => {}).getSource()
+        
+cancelTokenSource.cancel();
+        
+```

package/src/Api.js

@@ -244,7 +244,17 @@ export default class Api {
    * @param obj
    * @return {*}
    */
-  static async makeRequest({url, method, data = {}, params = {}, source, headers = {}, success = () => {}, error = () => {}})
+  static async makeRequest({
+       url,
+       method,
+       data = {},
+       params = {},
+       source,
+       headers = {},
+       success = () => {},
+       error = () => {},
+       final = () => {}
+  })
   {
     try {
       headers['Accept'] = 'application/json, application/msgpack, text/plain, */*';
@@ -284,6 +294,8 @@ export default class Api {
         console.error(error);
       }
 
+      final();
+
       return responseData;
     } catch(e) {
       if (axios.isAxiosError(e))
@@ -332,6 +344,8 @@ export default class Api {
           console.error(error);
         }
       }
+
+      final();
     }
   }
 

package/src/ApiRequest.js

@@ -46,6 +46,9 @@ export default class ApiRequest {
     };
     this.callError = () => {
 
+    };
+    this.callFinal = () => {
+
     };
     this.source = null;
 
@@ -110,26 +113,32 @@ export default class ApiRequest {
    *
    * @param successCallback
    * @param errorCallback
-   * @returns {*}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  first(successCallback = (r) => {
-  }, errorCallback = () => {
-  }) {
+  first(
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      finalCallback = () => {}
+  ) {
     this.data['paginateType'] = 'first';
-    return this.executeRequest(successCallback, errorCallback);
+    return this.executeRequest(successCallback, errorCallback, finalCallback);
   }
 
   /**
    *
    * @param successCallback
    * @param errorCallback
-   * @returns {*}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  all(successCallback = (r) => {
-  }, errorCallback = () => {
-  }) {
+  all(
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      finalCallback = () => {}
+  ) {
     this.data['paginateType'] = 'all';
-    return this.executeRequest(successCallback, errorCallback);
+    return this.executeRequest(successCallback, errorCallback, finalCallback);
   }
 
   /**
@@ -138,15 +147,20 @@ export default class ApiRequest {
    * @param perPage
    * @param successCallback
    * @param errorCallback
-   * @returns {*}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  paginate(page = 1, perPage = 10, successCallback = (r) => {
-  }, errorCallback = () => {
-  }) {
+  paginate(
+      page = 1,
+      perPage = 10,
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      finalCallback = () => {}
+  ) {
     this.data['paginateType'] = 'paginate';
     this.data['page'] = page;
     this.data['perPage'] = perPage;
-    return this.executeRequest(successCallback, errorCallback);
+    return this.executeRequest(successCallback, errorCallback, finalCallback);
   }
 
   /**
@@ -154,14 +168,18 @@ export default class ApiRequest {
    * @param fields
    * @param successCallback
    * @param errorCallback
-   * @return {ApiRequest}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  pluck(fields, successCallback = (r) => {
-  }, errorCallback = () => {
-  }) {
+  pluck(
+      fields,
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      finalCallback = () => {}
+  ) {
     this.data['paginateType'] = 'pluck';
     this.data['fields'] = fields;
-    return this.executeRequest(successCallback, errorCallback);
+    return this.executeRequest(successCallback, errorCallback, finalCallback);
   }
 
   /**
@@ -192,13 +210,21 @@ export default class ApiRequest {
    * @param argumentsKey
    * @param queryKey
    * @param byUrl
-   * @return {ApiRequest}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  call(successCallback = (r) => {
-  }, errorCallback = () => {
-  }, params = {}, dataKey = 'data', argumentsKey = 'arguments', queryKey = 'query', byUrl = false)
+  call(
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      params = {},
+      dataKey = 'data',
+      argumentsKey = 'arguments',
+      queryKey = 'query',
+      byUrl = false,
+      finalCallback = () => {}
+  )
   {
-    return this.executeRequest(successCallback, errorCallback, params, dataKey, argumentsKey, queryKey, byUrl)
+    return this.executeRequest(successCallback, errorCallback, finalCallback, params, dataKey, argumentsKey, queryKey, byUrl)
   }
 
   /**
@@ -296,20 +322,31 @@ export default class ApiRequest {
   }
 
   /**
-   * Function to handle the common request logic
+   *
    * @param successCallback
    * @param errorCallback
+   * @param finalCallback
    * @param params
    * @param dataKey
    * @param argumentsKey
    * @param queryKey
    * @param byUrl
-   * @return {ApiRequest}
+   * @returns {ApiRequest}
    */
-  executeRequest(successCallback, errorCallback, params = {}, dataKey = 'data', argumentsKey = 'arguments', queryKey = 'query', byUrl = false) {
+  executeRequest(
+      successCallback,
+      errorCallback,
+      finalCallback,
+      params = {},
+      dataKey = 'data',
+      argumentsKey = 'arguments',
+      queryKey = 'query',
+      byUrl = false,
+  ) {
     let self = this;
     this.callSuccess = successCallback;
     this.callError = errorCallback;
+    this.callFinal = finalCallback;
     this.source = axios.CancelToken.source();
 
     let url = byUrl ? this.url : this.getUrl();
@@ -332,7 +369,8 @@ export default class ApiRequest {
       },
       error: (response, responseData, status, errorText) => {
         this.handleError(notify, errorCallback, response, responseData, errorText);
-      }
+      },
+      final: finalCallback
     });
 
     return this;
@@ -370,10 +408,6 @@ export default class ApiRequest {
    */
   handleError(notify, errorCallback, response, responseData, errorText)
   {
-    console.log('------------');
-    console.log(responseData);
-    console.log(errorText);
-
     try {
       let result = this.notifyCallback(response.status);
       if (result) notify = this.getErrorNotification(response, responseData, errorText);
@@ -389,12 +423,15 @@ export default class ApiRequest {
    *
    * @param successCallback
    * @param errorCallback
-   * @return {ApiRequest}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  callSync(successCallback = (r) => {
-  }, errorCallback = () => {
-  }) {
-    return this.executeRequest(successCallback, errorCallback, {async: false});
+  callSync(
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      finalCallback = () => {}
+  ) {
+    return this.executeRequest(successCallback, errorCallback, finalCallback, {async: false});
   }
 
   /**
@@ -405,13 +442,20 @@ export default class ApiRequest {
    * @param dataKey
    * @param argumentsKey
    * @param queryKey
-   * @return {ApiRequest}
+   * @param finalCallback
+   * @returns {ApiRequest}
    */
-  callUrl(successCallback = (r) => {
-  }, errorCallback = () => {
-  }, params = {}, dataKey = 'data', argumentsKey = 'arguments', queryKey = 'query')
+  callUrl(
+      successCallback = (response) => {},
+      errorCallback = () => {},
+      params = {},
+      dataKey = 'data',
+      argumentsKey = 'arguments',
+      queryKey = 'query',
+      finalCallback = () => {}
+    )
   {
-    return this.executeRequest(successCallback, errorCallback, params, dataKey, argumentsKey, queryKey, true)
+    return this.executeRequest(successCallback, errorCallback, finalCallback, params, dataKey, argumentsKey, queryKey, true)
   }
 
   /**

package/src/types.d.ts

@@ -31,21 +31,31 @@ declare module 'laravel-request' {
 
         addArg(arg: any | any[]): ApiRequest;
 
-        first(successCallback?: (r: any) => void, errorCallback?: () => void): any;
+        first(
+            successCallback?: (response: {data: any, result: string, meta?: any, }) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
+        ): any;
 
-        all(successCallback?: (r: any) => void, errorCallback?: () => void): any;
+        all(
+            successCallback?: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
+        ): any;
 
         paginate(
             page?: number,
             perPage?: number,
-            successCallback?: (r: any) => void,
-            errorCallback?: () => void
+            successCallback?: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
         ): any;
 
         pluck(
             fields: any,
-            successCallback?: (r: any) => void,
-            errorCallback?: () => void
+            successCallback?: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
         ): ApiRequest;
 
         getUrl(): string;
@@ -53,8 +63,9 @@ declare module 'laravel-request' {
         getSource(): axios.CancelTokenSource|null;
 
         call(
-            successCallback?: (r: any) => void,
-            errorCallback?: () => void,
+            successCallback?: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
             params?: object,
             dataKey?: string,
             argumentsKey?: string,
@@ -63,13 +74,15 @@ declare module 'laravel-request' {
         ): ApiRequest;
 
         callSync(
-            successCallback?: (r: any) => void,
-            errorCallback?: () => void
+            successCallback?: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void
         ): ApiRequest;
 
         callUrl(
-            successCallback?: (r: any) => void,
-            errorCallback?: () => void,
+            successCallback?: (response: {response: {data: any, result: string, meta?: any}}) => void,
+            errorCallback?: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
             params?: object,
             dataKey?: string,
             argumentsKey?: string,
@@ -82,15 +95,20 @@ declare module 'laravel-request' {
             queryKey: string
         ): object;
 
-        getErrorNotification(xhr: XMLHttpRequest, errorText: string): object | null;
+        getErrorNotification(
+            xhr: XMLHttpRequest, errorText: string
+        ): object | null;
 
-        defaultErrorMessage(xhr: XMLHttpRequest, errorText: string): object | null;
+        defaultErrorMessage(
+            xhr: XMLHttpRequest, errorText: string
+        ): object | null;
 
         getErrorNotificationFallback(e: Error): object | null;
 
         executeRequest(
-            successCallback: (r: any) => void,
-            errorCallback: () => void,
+            successCallback: (response: {data: any, result: string, meta?: any}) => void,
+            errorCallback: (xhr: XMLHttpRequest, responseData: any) => void,
+            finalCallback?: () => void,
             params?: object,
             dataKey?: string,
             argumentsKey?: string,
@@ -105,7 +123,7 @@ declare module 'laravel-request' {
 
         handleError(
             notify: object | null,
-            errorCallback: (xhr: XMLHttpRequest) => void,
+            errorCallback: (xhr: XMLHttpRequest, responseData: any) => void,
             xhr: XMLHttpRequest,
             errorText: string
         ): void;