@weapnl/js-junction 0.0.8 → 0.0.10

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## v0.0.10
+- Updated Readme.md
+- Added onFinished to the index.d.ts file (TS support).
+- Remove request from _requests array after the request was finished.
+- Added support for simple pagination.
+
+## v0.0.9
+- Added option to override the config of an request.
+- Added the body parameters to the post request.
+- Updated the requests variable from a object to an array.
+
 ## v0.0.8
 - Model post requests.
 - Added onFinished callback.

package/README.md

@@ -45,20 +45,20 @@ class User extends Model {
 // Create a new user.
 const user = new User();
 user.name = 'John';
-user.store();
+user.store(); // Or .save()
 
 // Retrieve a user.
-const user = User.show(1);
+const user = await new User().show(1);
 
 // Update the user.
 user.name = 'Jane';
-user.update();
+user.update(); // Or .save()
 
 // Delete the user.
 user.destroy();
 
 // List all users.
-const users = User.index();
+const users = await new User().index();
 ```
 
 ## Usage
@@ -165,7 +165,7 @@ user.name = 'John';
 user.store();
 
 // Retrieve a user.
-const user = new User().show(1);
+const user = await new User().show(1);
 
 // Update the user.
 user.name = 'Jane';
@@ -175,7 +175,7 @@ user.save(); // This will call store() or update() depending on the id of the mo
 user.destroy();
 
 // List all users.
-const users = new User().index();
+const users = await new User().index();
 ```
 
 #### Applying filters and scopes
@@ -203,6 +203,7 @@ const request = await new User()
     .pluck(['name', 'company.name']) // Only retrieve the given fields 
     .pagination(1, 25) // Paginate 25 per page, page 1
     .pagination(1, 25, 50) // The 3th parameter is a pageForId parameter. This is used to find the correct page for the given id. If the id can not be found, the given page will be used. It will now look for the user with id 50, and returns that page.
+    .simplePagination(1, 25) // You can use this to simply navigate through pages (without receiving the total pages). This can be helpful for large database tables. The first parameter is the page number and the second parameter is the `items per page` amount.
     .get();
 ```
 
@@ -215,15 +216,16 @@ To create a new record or update an existing one, you can use the `.save()` meth
 **Cloning a model's instance.**
 ```javascript
 // Return a clone of the model
+const user = await new User().show(1);
 const clonedUser = user.clone();
 ```
 
 **Batch requests**
 ```javascript
-const firstUser = new User().show(1);
+const firstUser = await new User().show(1);
 firstUser.name = 'John';
 
-const secondUser = new User().show(2);
+const secondUser = await new User().show(2);
 secondUser.name = 'Jane';
 
 const batch = await api.batch([
@@ -266,7 +268,7 @@ const request = await api
         // Extra data
     });
 
-const user = new User().show(1);
+const user = await new User().show(1);
 
 const request = await user
     .action('actionName') // It will take the id of the user now, since it is a model. The id is 1 in this case.
@@ -337,7 +339,7 @@ A previously pending request with the same key will be cancelled, and this new r
 
 This is also possible on a model:
 ```javascript
-const user = new User()
+const user = await new User()
         .setKey('get-user')
         .index();
 ```

package/index.d.ts

@@ -29,6 +29,7 @@ declare class Api {
     onValidationError(callback?: (validation: any) => void): this;
     onUnauthorized(callback?: (response: AxiosResponse) => void): this;
     onForbidden(callback?: (response: AxiosResponse) => void): this;
+    onFinished(callback?: (response: AxiosResponse) => void): this;
 
     responseInterceptors(
         onSuccess?: (response: AxiosResponse) => void,
@@ -67,6 +68,7 @@ declare class Mixins {
     action(name: string, id?: number): this;
 
     pagination(page: number, perPage?: number, findPageForId?: number | null): this;
+    simplePagination(page: number, perPage?: number): this;
 }
 
 declare class Request extends Mixins {
@@ -86,8 +88,10 @@ declare class Request extends Mixins {
     onValidationError(callback?: (validation: object) => void): this;
     onUnauthorized(callback?: (response: Response) => void): this;
     onForbidden(callback?: (response: Response) => void): this;
+    onFinished(callback?: (response: Response) => void): this;
     triggerResponseEvents(response: Response, successResponse?: any): Promise<void>;
     customParameters(parameters?: object): this;
+    setConfig(config: object): this;
     setApi(api: Api): this;
 }
 

package/package.json

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

package/src/api.js

@@ -6,7 +6,7 @@ export default class Api {
     constructor () {
         this.setHeader('X-Requested-With', 'XMLHttpRequest');
 
-        this._requests = {};
+        this._requests = [];
 
         this.host('/').suffix('');
 
@@ -56,6 +56,9 @@ export default class Api {
         return url;
     }
 
+    /**
+     * @param {Request} request
+     */
     cancelRunning (request) {
         if (! request.key) {
             return;
@@ -65,6 +68,17 @@ export default class Api {
         this._requests[request.key] = request;
     }
 
+    /**
+     * @param {Request} request
+     */
+    removeRequest (request) {
+        if (! request.key) {
+            return;
+        }
+
+        delete this._requests[request.key];
+    }
+
     /**
      * @param {string} uri
      *

package/src/builder/model.js

@@ -123,6 +123,8 @@ export default class Model extends Request {
             this.bodyParameters,
         );
 
+        this._connection.removeRequest(this);
+
         let items;
 
         if (this._response.data) {
@@ -155,6 +157,8 @@ export default class Model extends Request {
             this.bodyParameters,
         );
 
+        this._connection.removeRequest(this);
+
         let item;
 
         if (this._response.data) {
@@ -181,6 +185,8 @@ export default class Model extends Request {
             { ...this._attributes.toJson(this), ...extraData },
         );
 
+        this._connection.removeRequest(this);
+
         let item;
 
         if (this._response.data) {
@@ -207,6 +213,8 @@ export default class Model extends Request {
             { ...this._attributes.toJson(this), ...extraData },
         );
 
+        this._connection.removeRequest(this);
+
         let item;
 
         if (this._response.data) {
@@ -230,6 +238,8 @@ export default class Model extends Request {
             this._queryString(this._identifier),
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return !! this._response.data;

package/src/connection.js

@@ -25,6 +25,14 @@ export default class Connection {
         this._api.cancelRunning(request);
     }
 
+    removeRequest (request) {
+        this._api.removeRequest(request);
+    }
+
+    getConfig () {
+        return this._config;
+    }
+
     setConfig (config) {
         this._config = config;
     }

package/src/mixins/paginationMixin.js

@@ -12,6 +12,20 @@ const paginationMixin = {
         this._pagination.page(page);
         this._pagination.perPage(perPage);
         this._pagination.findPageForId(findPageForId);
+        this._pagination.simplePagination(false);
+
+        return this;
+    },
+
+    /**
+     * @param {int} page
+     * @param {int} [perPage]
+     * @returns {this}
+     */
+    simplePagination (page, perPage = 25) {
+        this._pagination.page(page);
+        this._pagination.perPage(perPage);
+        this._pagination.simplePagination(true);
 
         return this;
     },

package/src/request/pagination.js

@@ -3,6 +3,7 @@ export default class Pagination {
         this._page = null;
         this._perPage = null;
         this._findPageForId = null;
+        this._simplePagination = false;
     }
 
     filled () {
@@ -21,6 +22,10 @@ export default class Pagination {
         this._findPageForId = id;
     }
 
+    simplePagination (simplePagination) {
+        this._simplePagination = simplePagination;
+    }
+
     toObject () {
         const data = {};
 
@@ -28,6 +33,7 @@ export default class Pagination {
             data.page = this._page;
             data.paginate = this._perPage;
             data.page_for_id = this._findPageForId;
+            data.simple_pagination = this._simplePagination;
         }
 
         return data;

package/src/request.js

@@ -59,6 +59,17 @@ export default class Request {
         return this;
     }
 
+    /**
+     * @param {object} config
+     *
+     * @returns {this} The current instance.
+     */
+    setConfig (config) {
+        this._connection.setConfig(_.merge(this._connection.getConfig(), config));
+
+        return this;
+    }
+
     /**
      * @returns {this} The current instance.
      */
@@ -81,6 +92,8 @@ export default class Request {
             this.bodyParameters,
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return this;
@@ -98,9 +111,11 @@ export default class Request {
 
         this._response = await this._connection.post(
             url,
-            data,
+            { ...data, ...this.bodyParameters },
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return this;
@@ -121,6 +136,8 @@ export default class Request {
             { ...data, ...this.bodyParameters },
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return this;
@@ -138,6 +155,8 @@ export default class Request {
             url,
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return this;
@@ -154,7 +173,7 @@ export default class Request {
 
         this._connection.cancelRunning(this);
 
-        this._connection.setConfig({
+        this.setConfig({
             headers: {
                 'Content-Type': 'multipart/form-data',
             },
@@ -167,6 +186,8 @@ export default class Request {
             formData,
         );
 
+        this._connection.removeRequest(this);
+
         await this.triggerResponseEvents(this._response);
 
         return this;