@weapnl/js-junction 0.0.3 → 0.0.5

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## v0.0.5
+- Added license file.
+- Private field bugfix, proxy access.
+
+## v0.0.4
+- Added support for whereNotIn.
+- Reactive bugfix, private property.
+
 ## v0.0.3
 - Added ability to override the api instance on requests.
 - Scopes & Wheres improvements.

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) WEAP informatie@weap.nl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -192,6 +192,7 @@ const request = await new User()
     .search('john doe') // Search for 'john doe', on the searchable columns of the model (defined in the API)
     .search('john doe', ['name', 'email']) // Search for 'john doe' in columns 'name' and 'email'
     .whereIn('city', ['Gemert', 'Eindhoven', 'Amsterdam']) // Set where in clause
+    .whereNotIn('city', ['Rotterdam', 'London']) // Set where not in clause
     .where('name', '=', 'John') // Add where clause
     .where('name', 'John') // If no operator is given, '=' is used
     .appends('age') // Add accessor

package/index.d.ts

@@ -57,6 +57,8 @@ declare class Mixins {
     wheres(...params: any[]): this;
     whereIn(column: string, values: any[]): this;
     whereIns(...params: any[]): this;
+    whereNotIn(column: string, values: any[]): this;
+    whereNotIns(...params: any[]): this;
     pluck(fields: any[]): this;
 
     appends(appends: string | string[]): this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weapnl/js-junction",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "This project allows you to easily consume API's built with Junction.",
   "main": "./src/index.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "prod": "webpack"
   },
   "author": "Robin",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@babel/core": "^7.12.13",
     "@babel/preset-env": "^7.12.13",

package/src/builder/model.js

@@ -26,10 +26,10 @@ export default class Model extends Request {
     static fromJson (json) {
         const instance = new (this)();
 
-        instance._accessors.fromJson(json);
-        instance._attributes.fromJson(json);
-        instance._counts.fromJson(json);
-        instance._relations.fromJson(json);
+        instance._accessors.fromJson(instance, json);
+        instance._attributes.fromJson(instance, json);
+        instance._counts.fromJson(instance, json);
+        instance._relations.fromJson(instance, json);
 
         return instance;
     }
@@ -41,10 +41,10 @@ export default class Model extends Request {
      */
     toJson () {
         return {
-            ...this._accessors.toJson(),
-            ...this._attributes.toJson(),
-            ...this._counts.toJson(),
-            ...this._relations.toJson(),
+            ...this._accessors.toJson(this),
+            ...this._attributes.toJson(this),
+            ...this._counts.toJson(this),
+            ...this._relations.toJson(this),
         };
     }
 
@@ -53,8 +53,8 @@ export default class Model extends Request {
      * @returns {this}
      */
     fill (values = {}) {
-        this._attributes.set(values);
-        this._relations.set(values);
+        this._attributes.set(this, values);
+        this._relations.set(this, values);
 
         return this;
     }
@@ -171,7 +171,7 @@ export default class Model extends Request {
     async store (extraData = {}) {
         this._response = await this._connection.post(
             this._queryString(),
-            { ...this._attributes.toJson(), ...extraData },
+            { ...this._attributes.toJson(this), ...extraData },
         );
 
         let item;
@@ -195,7 +195,7 @@ export default class Model extends Request {
     async update (extraData = {}) {
         this._response = await this._connection.put(
             this._queryString(this._identifier),
-            { ...this._attributes.toJson(), ...extraData },
+            { ...this._attributes.toJson(this), ...extraData },
         );
 
         let item;

package/src/builder/properties/accessors.js

@@ -8,18 +8,17 @@ export default class Accessors {
      * @param {Model} model Instance of the model.
      */
     constructor (model) {
-        this.model = model;
-
         _.each(model.constructor.accessors(), (options, key) => {
-            this.set(key, _.has(options, 'default') ? options.default : null);
+            this.set(model, key, _.has(options, 'default') ? options.default : null);
         });
     }
 
     /**
+     * @param {Model} model
      * @param {Object} json.
      */
-    fromJson (json) {
-        _.each(this.model.constructor.accessors(), (options, key) => {
+    fromJson (model, json) {
+        _.each(model.constructor.accessors(), (options, key) => {
             let value = _.get(json, options.jsonKey ?? _.snakeCase(key), _.get(json, _.camelCase(key)));
 
             if (_.isNil(value)) {
@@ -28,18 +27,20 @@ export default class Accessors {
                 value = Accessors._getCastedFromJsonValue(value, options);
             }
 
-            this.set(key, value);
+            this.set(model, key, value);
         });
     }
 
     /**
+     * @param {Model} model
+     *
      * @return {Object} The attributes casted to a json object.
      */
-    toJson () {
+    toJson (model) {
         const json = {};
 
-        _.each(this.model.constructor.accessors(), (options, key) => {
-            let jsonValue = this.get(key);
+        _.each(model.constructor.accessors(), (options, key) => {
+            let jsonValue = this.get(model, key);
 
             jsonValue = Accessors._getCastedToJsonValue(jsonValue, options);
 
@@ -50,22 +51,24 @@ export default class Accessors {
     }
 
     /**
+     * @param {Model} model
      * @param {string} attribute
      *
      * @returns {*} The value of the attribute.
      */
-    get (attribute) {
-        return _.get(this.model, attribute);
+    get (model, attribute) {
+        return _.get(model, attribute);
     }
 
     /**
-     * @param  {string} attribute
-     * @param  {*} value
+     * @param {Model} model
+     * @param {string} attribute
+     * @param {*} value
      *
      * @returns {*} The value that was set.
      */
-    set (attribute, value) {
-        this.model[attribute] = value;
+    set (model, attribute, value) {
+        model[attribute] = value;
 
         return value;
     }

package/src/builder/properties/attributes.js

@@ -8,18 +8,17 @@ export default class Attributes {
      * @param {Model} model Instance of the model.
      */
     constructor (model) {
-        this.model = model;
-
         _.each(model.constructor.attributes(), (options, key) => {
-            this.set(key, _.has(options, 'default') ? options.default : null);
+            this.set(model, key, _.has(options, 'default') ? options.default : null);
         });
     }
 
     /**
+     * @param {Model} model
      * @param {Object} json.
      */
-    fromJson (json) {
-        _.each(this.model.constructor.attributes(), (options, key) => {
+    fromJson (model, json) {
+        _.each(model.constructor.attributes(), (options, key) => {
             let value = _.get(json, options.jsonKey ?? _.snakeCase(key), _.get(json, _.camelCase(key)));
 
             if (_.isNil(value)) {
@@ -28,18 +27,20 @@ export default class Attributes {
                 value = Attributes._getCastedFromJsonValue(value, options);
             }
 
-            this.set(key, value);
+            this.set(model, key, value);
         });
     }
 
     /**
+     * @param {Model} model
+     *
      * @return {Object} The attributes casted to a json object.
      */
-    toJson () {
+    toJson (model) {
         const json = {};
 
-        _.each(this.model.constructor.attributes(), (options, key) => {
-            let jsonValue = this.get(key);
+        _.each(model.constructor.attributes(), (options, key) => {
+            let jsonValue = this.get(model, key);
 
             jsonValue = Attributes._getCastedToJsonValue(jsonValue, options);
 
@@ -50,32 +51,34 @@ export default class Attributes {
     }
 
     /**
+     * @param {Model} model
      * @param {string} attribute
      *
      * @returns {*} The value of the attribute.
      */
-    get (attribute) {
-        return _.get(this.model, attribute);
+    get (model, attribute) {
+        return _.get(model, attribute);
     }
 
     /**
-     * @param  {string|Object} attribute
-     * @param  {*} value
+     * @param {Model} model
+     * @param {string|Object} attribute
+     * @param {*} value
      *
      * @returns {Attributes}
      */
-    set (attribute, value = null) {
+    set (model, attribute, value = null) {
         if (_.isObject(attribute)) {
-            _.each(this.model.constructor.attributes(), (options, key) => {
+            _.each(model.constructor.attributes(), (options, key) => {
                 if (! _.has(attribute, key)) return;
 
-                this.set(key, attribute[key]);
+                this.set(model, key, attribute[key]);
             });
 
             return this;
         }
 
-        this.model[attribute] = value;
+        model[attribute] = value;
 
         return this;
     }

package/src/builder/properties/counts.js

@@ -6,58 +6,61 @@ export default class Counts {
      * @param {Model} model Instance of the model.
      */
     constructor (model) {
-        this.model = model;
-
         _.each(model.constructor.counts(), (options, key) => {
-            this.set(this.key(key, true), _.has(options, 'default') ? options.default : null);
+            this.set(model, this.key(key, true), _.has(options, 'default') ? options.default : null);
         });
     }
 
     /**
+     * @param {Model} model
      * @param {Object} json.
      */
-    fromJson (json) {
-        _.each(this.model.constructor.counts(), (options, key) => {
+    fromJson (model, json) {
+        _.each(model.constructor.counts(), (options, key) => {
             let value = _.get(json, this.key(key));
 
             value = value !== undefined
                 ? _.toInteger(value)
                 : null;
 
-            this.set(this.key(key, true), value);
+            this.set(model, this.key(key, true), value);
         });
     }
 
     /**
+     * @param {Model} model
+     *
      * @return {Object} The attributes casted to a json object.
      */
-    toJson () {
+    toJson (model) {
         const json = {};
 
-        _.each(this.model.constructor.counts(), (options, key) => {
-            _.set(json, key, this.get(key));
+        _.each(model.constructor.counts(), (options, key) => {
+            _.set(json, key, this.get(model, key));
         });
 
         return json;
     }
 
     /**
+     * @param {Model} model
      * @param {string} attribute
      *
      * @returns {*} The value of the attribute.
      */
-    get (attribute) {
-        return _.get(this.model, this.key(attribute, true));
+    get (model, attribute) {
+        return _.get(model, this.key(attribute, true));
     }
 
     /**
-     * @param  {string} attribute
-     * @param  {*} value
+     * @param {Model} model
+     * @param {string} attribute
+     * @param {*} value
      *
      * @returns {*} The value that was set.
      */
-    set (attribute, value) {
-        this.model[this.key(attribute, true)] = value;
+    set (model, attribute, value) {
+        model[this.key(attribute, true)] = value;
 
         return value;
     }

package/src/builder/properties/property.js

@@ -3,35 +3,40 @@
  */
 class Property {
     /**
+     * @param {Model} model
      * @param {string} key
      *
      * @returns {*} The value of the attribute.
      */
-    get (key) {
+    get (model, key) {
         throw new Error('not implemented');
     }
 
     /**
-     * @param  {string} key
-     * @param  {*} value
+     * @param {Model} model
+     * @param {string} key
+     * @param {*} value
      *
      * @returns {*} The value that was set.
      */
-    set (key, value) {
+    set (model, key, value) {
         throw new Error('not implemented');
     }
 
     /**
+     * @param {Model} model
      * @param {Object} json.
      */
-    fromJson (json) {
+    fromJson (model, json) {
         throw new Error('not implemented');
     }
 
     /**
+     * @param {Model} model
+     *
      * @return {Object} The json object.
      */
-    toJson () {
+    toJson (model) {
         throw new Error('not implemented');
     }
 }

package/src/builder/properties/relations.js

@@ -8,36 +8,37 @@ export default class Relations {
      * @param {Model} model Instance of the model.
      */
     constructor (model) {
-        this.model = model;
-
         _.each(model.constructor.relations(), (options, key) => {
-            this.set(key, _.has(options, 'default') ? options.default : null);
+            this.set(model, key, _.has(options, 'default') ? options.default : null);
         });
     }
 
     /**
+     * @param {Model} model
      * @param {Object} json.
      */
-    fromJson (json) {
-        _.each(this.model.constructor.relations(), (options, key) => {
+    fromJson (model, json) {
+        _.each(model.constructor.relations(), (options, key) => {
             let value = _.get(json, options.jsonKey ?? _.snakeCase(key), _.get(json, _.camelCase(key)));
 
             value = value
                 ? Relations._getCastedFromJsonValue(value, options)
                 : value;
 
-            this.set(key, value);
+            this.set(model, key, value);
         });
     }
 
     /**
+     * @param {Model} model
+     *
      * @return {Object} The attributes casted to a json object.
      */
-    toJson () {
+    toJson (model) {
         const json = {};
 
-        _.each(this.model.constructor.relations(), (options, key) => {
-            let jsonValue = this.get(key);
+        _.each(model.constructor.relations(), (options, key) => {
+            let jsonValue = this.get(model, key);
 
             jsonValue = Relations._getCastedToJsonValue(jsonValue, options);
 
@@ -48,32 +49,34 @@ export default class Relations {
     }
 
     /**
+     * @param {Model} model
      * @param {string} relation
      *
      * @returns {*} The value of the relation.
      */
-    get (relation) {
-        return _.get(this.model, relation);
+    get (model, relation) {
+        return _.get(model, relation);
     }
 
     /**
-     * @param  {string|Object} relation
-     * @param  {*} value
+     * @param {Model} model
+     * @param {string|Object} relation
+     * @param {*} value
      *
      * @returns {Relations}
      */
-    set (relation, value = null) {
+    set (model, relation, value = null) {
         if (_.isObject(relation)) {
-            _.each(this.model.constructor.relations(), (options, key) => {
+            _.each(model.constructor.relations(), (options, key) => {
                 if (! _.has(relation, key)) return;
 
-                this.set(key, relation[key]);
+                this.set(model, key, relation[key]);
             });
 
             return this;
         }
 
-        this.model[relation] = value;
+        model[relation] = value;
 
         return this;
     }

package/src/filters/filters.js

@@ -5,6 +5,7 @@ import Scopes from './scopes';
 import Search from './search';
 import Wheres from './wheres';
 import WhereIn from './whereIn';
+import WhereNotIn from './whereNotIn';
 import Count from './count';
 import Pluck from './pluck';
 
@@ -18,13 +19,14 @@ export default class Filters {
         this.search = new Search();
         this.wheres = new Wheres();
         this.whereIn = new WhereIn();
+        this.whereNotIn = new WhereNotIn();
         this.pluck = new Pluck();
     }
 
     toObject () {
         const items = [];
 
-        for (let i = 0, filters = ['count', 'limit', 'order', 'relations', 'scopes', 'search', 'wheres', 'whereIn', 'pluck']; i < filters.length; i++) {
+        for (let i = 0, filters = ['count', 'limit', 'order', 'relations', 'scopes', 'search', 'wheres', 'whereIn', 'whereNotIn', 'pluck']; i < filters.length; i++) {
             if (this[filters[i]].filled()) items.push(this[filters[i]].toObject());
         }
 

package/src/filters/whereIn.js

@@ -1,7 +1,7 @@
 import Filter from './filter';
 import Format from '../utilities/format';
 
-export default class Relations extends Filter {
+export default class WhereIn extends Filter {
     constructor () {
         super();
 

package/src/filters/whereNotIn.js

@@ -0,0 +1,31 @@
+import Filter from './filter';
+import Format from '../utilities/format';
+
+export default class WhereNotIn extends Filter {
+    constructor () {
+        super();
+
+        this._whereNotIns = [];
+    }
+
+    filled () {
+        return this._whereNotIns.length > 0;
+    }
+
+    add (column, values) {
+        this._whereNotIns.push({
+            column: Format.snakeCase(column),
+            values,
+        });
+    }
+
+    toObject () {
+        const data = {};
+
+        if (this.filled()) {
+            data.where_not_in = this._whereNotIns;
+        }
+
+        return data;
+    }
+}

package/src/mixins/filterMixin.js

@@ -112,6 +112,22 @@ const filterMixin = {
         return this;
     },
 
+    whereNotIn (column, values) {
+        if (! Array.isArray(values)) values = [values];
+
+        this._filters.whereNotIn.add(column, values);
+
+        return this;
+    },
+
+    whereNotIns (input) {
+        input.forEach(whereIn => {
+            this.whereNotIn(...whereIn);
+        });
+
+        return this;
+    },
+
     pluck (fields) {
         if (! Array.isArray(fields)) fields = [fields];
 

package/src/request.js

@@ -68,7 +68,7 @@ export default class Request {
         const url = this.url ?? this.constructor.endpoint;
 
         this._response = await this._connection.get(
-            `${url}`,
+            url,
             this.bodyParameters,
         );
 
@@ -86,7 +86,7 @@ export default class Request {
         const url = this.url ?? this.constructor.endpoint;
 
         this._response = await this._connection.post(
-            `${url}`,
+            url,
             data,
         );
 
@@ -104,7 +104,7 @@ export default class Request {
         const url = this.url ?? this.constructor.endpoint;
 
         this._response = await this._connection.put(
-            `${url}`,
+            url,
             { ...data, ...this.bodyParameters },
         );
 
@@ -120,7 +120,7 @@ export default class Request {
         const url = this.url ?? this.constructor.endpoint;
 
         this._response = await this._connection.delete(
-            `${url}`,
+            url,
         );
 
         await this.triggerResponseEvents(this._response);