@weapnl/js-junction 0.0.6 → 0.0.8

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## v0.0.8
+- Model post requests.
+- Added onFinished callback.
+
+## v0.0.7
+- Request cancel improvements.
+
 ## v0.0.6
 - Added support for request cancellation by key.
 

package/README.md

@@ -292,20 +292,23 @@ let request = await api.request('users/files')
 ```javascript
 let request = await api.request('users')
     .onSuccess((data) => {
-        // Request successful
+        // Request successful.
     })
     .onUnauthorized((response) => {
-        // Missing or invalid token
+        // Missing or invalid token.
     })
     .onForbidden((response) => {
-        // Access not allowed
+        // Access not allowed.
     })
     .onValidationError((validation) => {
         // validation.message
         // validation.errors
     })
     .onError((response) => {
-        // Any other status code not caught by other callbacks
+        // Any other status code not caught by other callbacks.
+    })
+    .onFinished((response) => {
+        // After the request was finished (cancelled requests excluded).
     })
     .get();
 ```

package/package.json

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

package/src/api.js

@@ -15,6 +15,7 @@ export default class Api {
         this._onValidationError = () => {};
         this._onUnauthorized = () => {};
         this._onForbidden = () => {};
+        this._onFinished = () => {};
     }
 
     /**
@@ -84,7 +85,8 @@ export default class Api {
             .onError(this._onError)
             .onValidationError(this._onValidationError)
             .onUnauthorized(this._onUnauthorized)
-            .onForbidden(this._onForbidden);
+            .onForbidden(this._onForbidden)
+            .onFinished(this._onFinished);
 
         return request;
     }
@@ -212,6 +214,19 @@ export default class Api {
         return this;
     }
 
+    /**
+     * Set the default 'onFinished'. Can be overridden in the Request class.
+     *
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onFinished (callback = () => {}) {
+        this._onFinished = callback;
+
+        return this;
+    }
+
     /**
      * @param {function(Response)} onSuccess
      * @param {function(Error)} onError

package/src/builder/model.js

@@ -116,8 +116,10 @@ export default class Model extends Request {
      * @returns {this[]} List of models.
      */
     async index () {
-        this._response = await this._connection.get(
-            this._queryString(),
+        this._connection.cancelRunning(this);
+
+        this._response = await this._connection.post(
+            this._queryString() + '/index',
             this.bodyParameters,
         );
 
@@ -146,8 +148,10 @@ export default class Model extends Request {
 
         if (! identifier) return null;
 
-        this._response = await this._connection.get(
-            this._queryString(identifier),
+        this._connection.cancelRunning(this);
+
+        this._response = await this._connection.post(
+            this._queryString(identifier) + '/show',
             this.bodyParameters,
         );
 
@@ -170,6 +174,8 @@ export default class Model extends Request {
      * @returns {this} The created model.
      */
     async store (extraData = {}) {
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.post(
             this._queryString(),
             { ...this._attributes.toJson(this), ...extraData },
@@ -194,6 +200,8 @@ export default class Model extends Request {
      * @returns {this} The updated model.
      */
     async update (extraData = {}) {
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.put(
             this._queryString(this._identifier),
             { ...this._attributes.toJson(this), ...extraData },
@@ -216,6 +224,8 @@ export default class Model extends Request {
      * @returns {boolean} Whether the deletion was successful.
      */
     async destroy () {
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.delete(
             this._queryString(this._identifier),
         );

package/src/connection.js

@@ -11,8 +11,6 @@ export default class Connection {
         this.running = false;
         this.canceled = false;
         this.failed = false;
-
-        this._request = null;
     }
 
     cancel () {
@@ -23,8 +21,8 @@ export default class Connection {
         this.canceled = true;
     }
 
-    setRequest (request) {
-        this._request = request;
+    cancelRunning (request) {
+        this._api.cancelRunning(request);
     }
 
     setConfig (config) {
@@ -58,8 +56,6 @@ export default class Connection {
             url = `/${url}`;
         }
 
-        this._api.cancelRunning(this._request);
-
         const config = {
             url: (this._api ? this._api.baseUrl : api.baseUrl) + url,
             method,

package/src/request.js

@@ -30,9 +30,9 @@ export default class Request {
         this._onValidationError = () => {};
         this._onUnauthorized = () => {};
         this._onForbidden = () => {};
+        this._onFinished = () => {};
 
         this._connection = new Connection();
-        this._connection.setRequest(this);
 
         this._response = null;
         this.key = null;
@@ -74,6 +74,8 @@ export default class Request {
     async get () {
         const url = this.url ?? this.constructor.endpoint;
 
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.get(
             url,
             this.bodyParameters,
@@ -92,6 +94,8 @@ export default class Request {
     async post (data = {}) {
         const url = this.url ?? this.constructor.endpoint;
 
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.post(
             url,
             data,
@@ -110,6 +114,8 @@ export default class Request {
     async put (data = {}) {
         const url = this.url ?? this.constructor.endpoint;
 
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.put(
             url,
             { ...data, ...this.bodyParameters },
@@ -126,6 +132,8 @@ export default class Request {
     async delete () {
         const url = this.url ?? this.constructor.endpoint;
 
+        this._connection.cancelRunning(this);
+
         this._response = await this._connection.delete(
             url,
         );
@@ -144,6 +152,8 @@ export default class Request {
     async storeFiles (files = {}, data = {}) {
         const url = this.url ?? this.constructor.endpoint;
 
+        this._connection.cancelRunning(this);
+
         this._connection.setConfig({
             headers: {
                 'Content-Type': 'multipart/form-data',
@@ -230,39 +240,56 @@ export default class Request {
         return this;
     }
 
+    /**
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onFinished (callback = () => {}) {
+        this._onFinished = callback;
+
+        return this;
+    }
+
     /**
      * @param {Response} response
      * @param {*} successResponse
      */
     async triggerResponseEvents (response, successResponse = null) {
         if (response.statusCode >= 200 && response.statusCode < 300) {
-            if (! this._onSuccess) return;
+            if (this._onSuccess) {
+                await this._onSuccess(...[successResponse, response.data].filter((value) => !! value));
+            }
+        } else {
+            switch (response.statusCode) {
+                case 401:
+                    if (this._onUnauthorized) await this._onUnauthorized(response);
+                    break;
+                case 403:
+                    if (this._onForbidden) await this._onForbidden(response);
+                    break;
+                case 422:
+                    const validation = {
+                        message: response.validation.message,
+                        errors: {},
+                    };
+
+                    _.each(response.validation.errors, (value, key) => {
+                        return _.set(validation.errors, key, value);
+                    });
 
-            return await this._onSuccess(...[successResponse, response.data].filter((value) => !! value));
+                    if (this._onValidationError) await this._onValidationError(validation);
+                    break;
+                default:
+                    if (this._onError) await this._onError(response);
+                    break;
+            }
         }
 
-        switch (response.statusCode) {
-            case 401:
-                if (this._onUnauthorized) await this._onUnauthorized(response);
-                break;
-            case 403:
-                if (this._onForbidden) await this._onForbidden(response);
-                break;
-            case 422:
-                const validation = {
-                    message: response.validation.message,
-                    errors: {},
-                };
-
-                _.each(response.validation.errors, (value, key) => {
-                    return _.set(validation.errors, key, value);
-                });
-
-                if (this._onValidationError) await this._onValidationError(validation);
-                break;
-            default:
-                if (this._onError) await this._onError(response);
-                break;
+        if (response.statusCode !== 0) {
+            if (this._onFinished) {
+                await this._onFinished(response);
+            }
         }
     }