@weapnl/js-junction 0.1.0 → 0.1.1

package/docker-compose.yml

@@ -1,14 +1,19 @@
 services:
   dev:
-    image: registry.weap.nl:5005/docker/npmnginx:8.1
+    image: node:22
+    user: "node"
+    working_dir: /home/node/app
     volumes:
-      - ./:/var/www
-      - ../Shared:/var/shared
+      - ./:/home/node/app
     command: "tail -f /dev/null"
 
-  build:
-    image: registry.weap.nl:5005/docker/npmnginx:8.1
+  build-prod:
+    image: node:22
+    profiles: [prod]
+    user: "node"
+    working_dir: /home/node/app
+    environment:
+      - NODE_ENV=production
     volumes:
-      - ./:/var/www
-      - ../Shared:/var/shared
+      - ./:/home/node/app
     command: "npm run prod"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weapnl/js-junction",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "This project allows you to easily consume API's built with Junction.",
   "main": "./src/index.js",
   "scripts": {

package/src/api.js

@@ -10,12 +10,13 @@ export default class Api {
 
         this.host('/').suffix('');
 
-        this._onSuccess = () => {};
-        this._onError = () => {};
-        this._onValidationError = () => {};
-        this._onUnauthorized = () => {};
-        this._onForbidden = () => {};
-        this._onFinished = () => {};
+        this._onSuccess = null;
+        this._onError = null;
+        this._onValidationError = null;
+        this._onUnauthorized = null;
+        this._onForbidden = null;
+        this._onFinished = null;
+        this._onCancelled = null;
     }
 
     /**
@@ -96,13 +97,15 @@ export default class Api {
         const request = new Request();
 
         request.setUrl(uri)
-            .setApi(this)
-            .onSuccess(this._onSuccess)
-            .onError(this._onError)
-            .onValidationError(this._onValidationError)
-            .onUnauthorized(this._onUnauthorized)
-            .onForbidden(this._onForbidden)
-            .onFinished(this._onFinished);
+            .setApi(this);
+
+        if (this._onSuccess) request.onSuccess(this._onSuccess);
+        if (this._onError) request.onError(this._onError);
+        if (this._onValidationError) request.onValidationError(this._onValidationError);
+        if (this._onUnauthorized) request.onUnauthorized(this._onUnauthorized);
+        if (this._onForbidden) request.onForbidden(this._onForbidden);
+        if (this._onFinished) request.onFinished(this._onFinished);
+        if (this._onCancelled) request.onCancelled(this._onCancelled);
 
         return request;
     }
@@ -166,7 +169,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onSuccess'. Can be overridden in the Request class.
+     * Set the default 'onSuccess' event handler.
      *
      * @param {function(Response.data)} callback
      *
@@ -179,7 +182,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onError'. Can be overridden in the Request class.
+     * Set the default 'onError' event handler.
      *
      * @param {function(Response)} callback
      *
@@ -192,7 +195,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onValidationError'. Can be overridden in the Request class.
+     * Set the default 'onValidationError' event handler.
      *
      * @param {function(Response.validation)} callback
      *
@@ -205,7 +208,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onUnauthorized'. Can be overridden in the Request class.
+     * Set the default 'onUnauthorized' event handler.
      *
      * @param {function(Response)} callback
      *
@@ -218,7 +221,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onForbidden'. Can be overridden in the Request class.
+     * Set the default 'onForbidden' event handler.
      *
      * @param {function(Response)} callback
      *
@@ -231,7 +234,7 @@ export default class Api {
     }
 
     /**
-     * Set the default 'onFinished'. Can be overridden in the Request class.
+     * Set the default 'onFinished' event handler.
      *
      * @param {function(Response)} callback
      *
@@ -243,6 +246,19 @@ export default class Api {
         return this;
     }
 
+    /**
+     * Set the default 'onCancelled' event handler.
+     *
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onCancelled (callback = () => {}) {
+        this._onCancelled = callback;
+
+        return this;
+    }
+
     /**
      * @param {function(Response)} onSuccess
      * @param {function(Error)} onError

package/src/batch.js

@@ -8,11 +8,11 @@ export default class Batch {
     }
 
     get successfulRequests () {
-        return _.filter(this._requests, ['response.failed', false]);
+        return _.filter(this._requests, ['response.isFailed', false]);
     }
 
     get failedRequests () {
-        return _.filter(this._requests, ['response.failed', true]);
+        return _.filter(this._requests, ['response.isFailed', true]);
     }
 
     async get () { return this.execute('get'); }

package/src/connection.js

@@ -78,18 +78,12 @@ export default class Connection {
 
         await request
             .then((axiosResponse) => {
-                response.set(axiosResponse.status, axiosResponse);
+                response.setAxiosResponse(axiosResponse);
             })
-            .catch((error) => {
+            .catch((axiosError) => {
                 this.failed = true;
 
-                let statusCode = 0;
-
-                if (error.response) {
-                    statusCode = error.response.status;
-                }
-
-                response.set(statusCode, error);
+                response.setAxiosError(axiosError);
             })
             .finally(() => {
                 this.running = false;

package/src/request.js

@@ -25,12 +25,13 @@ export default class Request {
         this._pagination = new Pagination();
         this._customParameters = [];
 
-        this._onSuccess = () => {};
-        this._onError = () => {};
-        this._onValidationError = () => {};
-        this._onUnauthorized = () => {};
-        this._onForbidden = () => {};
-        this._onFinished = () => {};
+        this._onSuccessCallbacks = [];
+        this._onErrorCallbacks = [];
+        this._onValidationErrorCallbacks = [];
+        this._onUnauthorizedCallbacks = [];
+        this._onForbiddenCallbacks = [];
+        this._onFinishedCallbacks = [];
+        this._onCancelledCallbacks = [];
 
         this._connection = new Connection();
 
@@ -223,7 +224,7 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onSuccess (callback = () => {}) {
-        this._onSuccess = callback;
+        this._onSuccessCallbacks.push(callback);
 
         return this;
     }
@@ -234,7 +235,7 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onError (callback = () => {}) {
-        this._onError = callback;
+        this._onErrorCallbacks.push(callback);
 
         return this;
     }
@@ -245,7 +246,7 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onValidationError (callback = () => {}) {
-        this._onValidationError = callback;
+        this._onValidationErrorCallbacks.push(callback);
 
         return this;
     }
@@ -256,7 +257,7 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onUnauthorized (callback = () => {}) {
-        this._onUnauthorized = callback;
+        this._onUnauthorizedCallbacks.push(callback);
 
         return this;
     }
@@ -267,7 +268,7 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onForbidden (callback = () => {}) {
-        this._onForbidden = callback;
+        this._onForbiddenCallbacks.push(callback);
 
         return this;
     }
@@ -278,7 +279,95 @@ export default class Request {
      * @returns {this} The current instance.
      */
     onFinished (callback = () => {}) {
-        this._onFinished = callback;
+        this._onFinishedCallbacks.push(callback);
+
+        return this;
+    }
+
+    /**
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onCancelled (callback = () => {}) {
+        this._onCancelledCallbacks.push(callback);
+
+        return this;
+    }
+
+    /**
+     * Clears all `onSuccess` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnSuccessCallbacks () {
+        this._onSuccessCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onError` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnErrorCallbacks () {
+        this._onErrorCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onValidationError` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnValidationErrorCallbacks () {
+        this._onValidationErrorCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onUnauthorized` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnUnauthorizedCallbacks () {
+        this._onUnauthorizedCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onForbidden` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnForbiddenCallbacks () {
+        this._onForbiddenCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onFinished` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnFinishedCallbacks () {
+        this._onFinishedCallbacks = [];
+
+        return this;
+    }
+
+    /**
+     * Clears all `onCancelled` callbacks.
+     *
+     * @returns {this} The current instance.
+     */
+    clearOnCancelledCallbacks () {
+        this._onCancelledCallbacks = [];
 
         return this;
     }
@@ -288,17 +377,21 @@ export default class Request {
      * @param {*} successResponse
      */
     async triggerResponseEvents (response, successResponse = null) {
+        function executeCallbacks(callbacks, ...data) {
+            return Promise.all(callbacks.map(async callback => {
+                await callback(...data);
+            }))
+        }
+
         if (response.statusCode >= 200 && response.statusCode < 300) {
-            if (this._onSuccess) {
-                await this._onSuccess(...[successResponse, response.data].filter((value) => !! value));
-            }
+            await executeCallbacks(this._onSuccessCallbacks, ...[successResponse, response.data].filter((value) => !! value));
         } else {
             switch (response.statusCode) {
                 case 401:
-                    if (this._onUnauthorized) await this._onUnauthorized(response);
+                    await executeCallbacks(this._onUnauthorizedCallbacks, response);
                     break;
                 case 403:
-                    if (this._onForbidden) await this._onForbidden(response);
+                    await executeCallbacks(this._onForbiddenCallbacks, response);
                     break;
                 case 422:
                     const validation = {
@@ -310,18 +403,20 @@ export default class Request {
                         return _.set(validation.errors, key, value);
                     });
 
-                    if (this._onValidationError) await this._onValidationError(validation);
+                    await executeCallbacks(this._onValidationErrorCallbacks, validation);
                     break;
                 default:
-                    if (this._onError) await this._onError(response);
+                    await executeCallbacks(this._onErrorCallbacks, response);
                     break;
             }
         }
 
-        if (response.statusCode !== 0) {
-            if (this._onFinished) {
-                await this._onFinished(response);
-            }
+        if (response.isFinished) {
+            await executeCallbacks(this._onFinishedCallbacks, response);
+        }
+
+        if (response.isCancelled) {
+            await executeCallbacks(this._onCancelledCallbacks, response);
         }
     }
 

package/src/response.js

@@ -1,33 +1,73 @@
+import axios from 'axios';
+
 export default class Response {
     constructor () {
         this._axiosResponse = null;
-
-        this.statusCode = null;
+        this._axiosError = null;
 
         this.data = null;
-
         this.validation = null;
     }
 
+    /**
+     * @deprecated Use `isFailed` instead.
+     * @returns {boolean}
+     */
     get failed () {
+        return this.isFailed;
+    }
+
+    /**
+     * @returns {boolean}
+     */
+    get isFailed () {
         return this.statusCode >= 400;
     }
 
-    set (statusCode, axiosResponse) {
-        this._axiosResponse = axiosResponse;
+    /**
+     * Check whether the request is finished and returned a response.
+     *
+     * @returns {boolean}
+     */
+    get isFinished () {
+        return this._axiosResponse !== null;
+    }
 
-        this.statusCode = statusCode;
+    /**
+     * Check whether the request was cancelled.
+     *
+     * @returns {boolean}
+     */
+    get isCancelled () {
+        return axios.isCancel(this._axiosError);
+    }
+
+    /**
+     * @returns {Number} The HTTP response status code.
+     */
+    get statusCode () {
+        return this._axiosResponse?.status;
+    }
+
+    setAxiosResponse(axiosResponse) {
+        this._axiosResponse = axiosResponse;
 
         switch (this.statusCode) {
             case 200:
-                this.data = this._axiosResponse.data;
-                break;
             case 400:
-                this.data = this._axiosResponse.response.data;
+                this.data = this._axiosResponse.data;
                 break;
             case 422:
-                this.validation = this._axiosResponse.response.data;
+                this.validation = this._axiosResponse.data;
                 break;
         }
     }
+
+    setAxiosError (axiosError) {
+        this._axiosError = axiosError;
+
+        if (axiosError.response) {
+            this.setAxiosResponse(axiosError.response);
+        }
+    }
 }