@weapnl/js-junction 0.0.1

package/src/builder/model.js

@@ -0,0 +1,259 @@
+import Accessors from './properties/accessors';
+import Attributes from './properties/attributes';
+import Counts from './properties/counts';
+import Relations from './properties/relations';
+import Request from '../request';
+
+export default class Model extends Request {
+    constructor (defaults = {}) {
+        super();
+
+        this._accessors = new Accessors(this);
+        this._attributes = new Attributes(this);
+        this._counts = new Counts(this);
+        this._relations = new Relations(this);
+
+        this.fill(defaults);
+    }
+
+    /**
+     * Create an instance of the model for the given json object.
+     *
+     * @param {Object} json
+     *
+     * @returns {this} An instance of the model.
+     */
+    static fromJson (json) {
+        const instance = new (this)();
+
+        instance._accessors.fromJson(json);
+        instance._attributes.fromJson(json);
+        instance._counts.fromJson(json);
+        instance._relations.fromJson(json);
+
+        return instance;
+    }
+
+    /**
+     * Convert the attributes of the current instance to json.
+     *
+     * @return {Object} The attributes of the current instance as json object.
+     */
+    toJson () {
+        return {
+            ...this._accessors.toJson(),
+            ...this._attributes.toJson(),
+            ...this._counts.toJson(),
+            ...this._relations.toJson(),
+        };
+    }
+
+    /**
+     * @param values
+     * @returns {this}
+     */
+    fill (values = {}) {
+        this._attributes.set(values);
+        this._relations.set(values);
+
+        return this;
+    }
+
+    /**
+     * The accessors of the model which were appended on the api side.
+     *
+     * @returns {Object.<any, Object>}
+     */
+    static accessors () {
+        return {};
+    }
+
+    /**
+     * The attributes of the model.
+     *
+     * @returns {Object.<any, Object>}
+     */
+    static attributes () {
+        return {};
+    }
+
+    /**
+     * The counts of relations of the model.
+     *
+     * @returns {Object.<any, Object>}
+     */
+    static counts () {
+        return {};
+    }
+
+    /**
+     * The relations of the model.
+     *
+     * @returns {Object.<any, Object>}
+     */
+    static relations () {
+        return {};
+    }
+
+    /**
+     * @returns {string} Endpoint of the model for the API.
+     */
+    static get endpoint () {
+        throw new Error('No endpoint defined in the model.');
+    }
+
+    /**
+     * @returns {int} Identifier attribute name of the model.
+     */
+    get _identifier () {
+        return _.get(this, 'id');
+    }
+
+    /**
+     * Get a list of models.
+     *
+     * @returns {this[]} List of models.
+     */
+    async index () {
+        this._response = await this._connection.get(
+            this._queryString(),
+            this.bodyParameters,
+        );
+
+        let items;
+
+        if (this._response.data) {
+            items = _.map(this._response.data.items, (item) => {
+                return this.constructor.fromJson(item);
+            });
+        }
+
+        await this.triggerResponseEvents(this._response, items);
+
+        return items;
+    }
+
+    /**
+     * Get a single model.
+     *
+     * @param {int} [identifier]
+     *
+     * @returns {this} Model found for the given id.
+     */
+    async show (identifier) {
+        identifier ??= this._identifier;
+
+        if (! identifier) return null;
+
+        this._response = await this._connection.get(
+            this._queryString(identifier),
+            this.bodyParameters,
+        );
+
+        let item;
+
+        if (this._response.data) {
+            item = this.constructor.fromJson(this._response.data);
+        }
+
+        await this.triggerResponseEvents(this._response, item);
+
+        return item;
+    }
+
+    /**
+     * Create an model.
+     *
+     * @param {Object} [extraData] Extra data to send to the API
+     *
+     * @returns {this} The created model.
+     */
+    async store (extraData = {}) {
+        this._response = await this._connection.post(
+            this._queryString(),
+            { ...this._attributes.toJson(), ...extraData },
+        );
+
+        let item;
+
+        if (this._response.data) {
+            item = this.constructor.fromJson(this._response.data);
+        }
+
+        await this.triggerResponseEvents(this._response, item);
+
+        return item;
+    }
+
+    /**
+     * Update the current model.
+     *
+     * @param {Object} [extraData] Extra data to send to the API
+     *
+     * @returns {this} The updated model.
+     */
+    async update (extraData = {}) {
+        this._response = await this._connection.put(
+            this._queryString(this._identifier),
+            { ...this._attributes.toJson(), ...extraData },
+        );
+
+        let item;
+
+        if (this._response.data) {
+            item = this.constructor.fromJson(this._response.data);
+        }
+
+        await this.triggerResponseEvents(this._response, item);
+
+        return item;
+    }
+
+    /**
+     * Delete the current model.
+     *
+     * @returns {boolean} Whether the deletion was successful.
+     */
+    async destroy () {
+        this._response = await this._connection.delete(
+            this._queryString(this._identifier),
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return !! this._response.data;
+    }
+
+    /**
+     * Save the current model. Based on the value of the identifier `store` or `update` will be called.
+     *
+     * @param {Object} [extraData] Extra data to send to the API
+     *
+     * @returns {this} The created or updated model.
+     */
+    async save (extraData = {}) {
+        return ! this._identifier
+            ? this.store(extraData)
+            : this.update(extraData);
+    }
+
+    /**
+     * @returns {this} The new clone of the current model.
+     */
+    clone () {
+        return this.constructor.fromJson(this.toJson());
+    }
+
+    /**
+     * Generate the query string for this model.
+     * @private
+     *
+     * @param {int} [identifier] The identifier of the model.
+     *
+     * @returns {string} The querystring for the model.
+     */
+    _queryString (identifier) {
+        return this.constructor.endpoint
+            + (identifier ? `/${identifier}` : '');
+    }
+}

package/src/builder/properties/accessors.js

@@ -0,0 +1,116 @@
+import Caster from '../caster';
+
+/**
+ * @implements {Property}
+ */
+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);
+        });
+    }
+
+    /**
+     * @param {Object} json.
+     */
+    fromJson (json) {
+        _.each(this.model.constructor.accessors(), (options, key) => {
+            let value = _.get(json, options.jsonKey ?? _.snakeCase(key), _.get(json, _.camelCase(key)));
+
+            if (_.isNil(value)) {
+                value = _.has(options, 'default') ? options.default : null;
+            } else {
+                value = Accessors._getCastedFromJsonValue(value, options);
+            }
+
+            this.set(key, value);
+        });
+    }
+
+    /**
+     * @return {Object} The attributes casted to a json object.
+     */
+    toJson () {
+        const json = {};
+
+        _.each(this.model.constructor.accessors(), (options, key) => {
+            let jsonValue = this.get(key);
+
+            jsonValue = Accessors._getCastedToJsonValue(jsonValue, options);
+
+            _.set(json, options.jsonKey ?? _.snakeCase(key), jsonValue);
+        });
+
+        return json;
+    }
+
+    /**
+     * @param {string} attribute
+     *
+     * @returns {*} The value of the attribute.
+     */
+    get (attribute) {
+        return _.get(this.model, attribute);
+    }
+
+    /**
+     * @param  {string} attribute
+     * @param  {*} value
+     *
+     * @returns {*} The value that was set.
+     */
+    set (attribute, value) {
+        this.model[attribute] = value;
+
+        return value;
+    }
+
+    /**
+     * @private
+     *
+     * @param {*} value
+     * @param {Object} options
+     *
+     * @returns {*} The casted value.
+     */
+    static _getCastedFromJsonValue (value, options) {
+        if (_.has(options, 'type') || _.has(options, 'fromJson')) {
+            const cast = options.type ? options.type : options.fromJson;
+
+            if (_.isArray(value)) {
+                return _.map(value, (val) => Caster.fromJson(cast, val));
+            } else {
+                return Caster.fromJson(cast, value);
+            }
+        }
+
+        return value;
+    }
+
+    /**
+     * @private
+     *
+     * @param {*} value
+     * @param {Object} options
+     *
+     * @returns {*} The casted value.
+     */
+    static _getCastedToJsonValue (value, options) {
+        if (_.has(options, 'type') || _.has(options, 'toJson')) {
+            const cast = options.type ? options.type : options.toJson;
+
+            if (_.isArray(value)) {
+                return _.map(value, (val) => Caster.toJson(cast, val));
+            } else {
+                return Caster.toJson(cast, value);
+            }
+        }
+
+        return value;
+    }
+}

package/src/builder/properties/attributes.js

@@ -0,0 +1,118 @@
+import Caster from '../caster';
+
+/**
+ * @implements {Property}
+ */
+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);
+        });
+    }
+
+    /**
+     * @param {Object} json.
+     */
+    fromJson (json) {
+        _.each(this.model.constructor.attributes(), (options, key) => {
+            let value = _.get(json, options.jsonKey ?? _.snakeCase(key), _.get(json, _.camelCase(key)));
+
+            if (_.isNil(value)) {
+                value = _.has(options, 'default') ? options.default : null;
+            } else {
+                value = Attributes._getCastedFromJsonValue(value, options);
+            }
+
+            this.set(key, value);
+        });
+    }
+
+    /**
+     * @return {Object} The attributes casted to a json object.
+     */
+    toJson () {
+        const json = {};
+
+        _.each(this.model.constructor.attributes(), (options, key) => {
+            let jsonValue = this.get(key);
+
+            jsonValue = Attributes._getCastedToJsonValue(jsonValue, options);
+
+            _.set(json, options.jsonKey ?? _.snakeCase(key), jsonValue);
+        });
+
+        return json;
+    }
+
+    /**
+     * @param {string} attribute
+     *
+     * @returns {*} The value of the attribute.
+     */
+    get (attribute) {
+        return _.get(this.model, attribute);
+    }
+
+    /**
+     * @param  {string|Object} attribute
+     * @param  {*} value
+     *
+     * @returns {Attributes}
+     */
+    set (attribute, value = null) {
+        if (_.isObject(attribute)) {
+            _.each(this.model.constructor.attributes(), (options, key) => {
+                if (! _.has(attribute, key)) return;
+
+                this.set(key, attribute[key]);
+            });
+
+            return this;
+        }
+
+        this.model[attribute] = value;
+
+        return this;
+    }
+
+    /**
+     * @private
+     *
+     * @param {*} value
+     * @param {Object} options
+     *
+     * @returns {*} The casted value.
+     */
+    static _getCastedFromJsonValue (value, options) {
+        if (_.has(options, 'type') || _.has(options, 'fromJson')) {
+            const cast = options.type ? options.type : options.fromJson;
+
+            return Caster.fromJson(cast, value);
+        }
+
+        return value;
+    }
+
+    /**
+     * @private
+     *
+     * @param {*} value
+     * @param {Object} options
+     *
+     * @returns {*} The casted value.
+     */
+    static _getCastedToJsonValue (value, options) {
+        if (_.has(options, 'type') || _.has(options, 'toJson')) {
+            const cast = options.type ? options.type : options.toJson;
+
+            return Caster.toJson(cast, value);
+        }
+
+        return value;
+    }
+}

package/src/builder/properties/counts.js

@@ -0,0 +1,79 @@
+/**
+ * @implements {Property}
+ */
+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);
+        });
+    }
+
+    /**
+     * @param {Object} json.
+     */
+    fromJson (json) {
+        _.each(this.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);
+        });
+    }
+
+    /**
+     * @return {Object} The attributes casted to a json object.
+     */
+    toJson () {
+        const json = {};
+
+        _.each(this.model.constructor.counts(), (options, key) => {
+            _.set(json, key, this.get(key));
+        });
+
+        return json;
+    }
+
+    /**
+     * @param {string} attribute
+     *
+     * @returns {*} The value of the attribute.
+     */
+    get (attribute) {
+        return _.get(this.model, this.key(attribute, true));
+    }
+
+    /**
+     * @param  {string} attribute
+     * @param  {*} value
+     *
+     * @returns {*} The value that was set.
+     */
+    set (attribute, value) {
+        this.model[this.key(attribute, true)] = value;
+
+        return value;
+    }
+
+    /**
+     * @param {string} key
+     * @param {boolean} camelCase
+     * @returns {string} The key with `count` appended to it, in specified casing.
+     */
+    key (key, camelCase = false) {
+        key = _.snakeCase(key);
+
+        if (! _.endsWith(key, '_count')) {
+            key = `${key}_count`;
+        }
+
+        return camelCase ? _.camelCase(key) : key;
+    }
+}

package/src/builder/properties/property.js

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