@weapnl/js-junction 0.0.1

package/src/mixins/paginationMixin.js

@@ -0,0 +1,20 @@
+/**
+ * @mixin paginationMixin
+ */
+const paginationMixin = {
+    /**
+     * @param {int} page
+     * @param {int} [perPage]
+     * @param {null|int} [findPageForId] Find the page the given id is on.
+     * @returns {this}
+     */
+    pagination (page, perPage = 25, findPageForId = null) {
+        this._pagination.page(page);
+        this._pagination.perPage(perPage);
+        this._pagination.findPageForId(findPageForId);
+
+        return this;
+    },
+};
+
+export default paginationMixin;

package/src/modifiers/appends.js

@@ -0,0 +1,28 @@
+import Modifier from './modifier';
+import Format from '../utilities/format';
+
+export default class Appends extends Modifier {
+    constructor () {
+        super();
+
+        this._appends = [];
+    }
+
+    filled () {
+        return this._appends.length > 0;
+    }
+
+    add (appends) {
+        this._appends.push(..._.map(appends, Format.snakeCase));
+    }
+
+    toObject () {
+        const data = {};
+
+        if (this.filled()) {
+            data.appends = this._appends;
+        }
+
+        return data;
+    }
+}

package/src/modifiers/hiddenFields.js

@@ -0,0 +1,27 @@
+import Modifier from './modifier';
+
+export default class HiddenFields extends Modifier {
+    constructor () {
+        super();
+
+        this._fields = [];
+    }
+
+    filled () {
+        return this._fields.length > 0;
+    }
+
+    add (fields) {
+        this._fields.push(...fields);
+    }
+
+    toObject () {
+        const data = {};
+
+        if (this.filled()) {
+            data.hidden_fields = this._fields;
+        }
+
+        return data;
+    }
+}

package/src/modifiers/modifier.js

@@ -0,0 +1,9 @@
+export default class Modifier {
+    filled () {
+        return !! this.toObject();
+    }
+
+    toObject () {
+        return null;
+    }
+}

package/src/modifiers/modifiers.js

@@ -0,0 +1,19 @@
+import Appends from './appends';
+import HiddenFields from './hiddenFields';
+
+export default class Modifiers {
+    constructor () {
+        this.appends = new Appends();
+        this.hiddenFields = new HiddenFields();
+    }
+
+    toObject () {
+        const items = [];
+
+        for (let i = 0, modifiers = ['appends', 'hiddenFields']; i < modifiers.length; i++) {
+            if (this[modifiers[i]].filled()) items.push(this[modifiers[i]].toObject());
+        }
+
+        return _.merge(...items);
+    }
+}

package/src/request/action.js

@@ -0,0 +1,29 @@
+export default class Action {
+    constructor () {
+        this._name = null;
+        this._id = null;
+    }
+
+    filled () {
+        return !! this._name;
+    }
+
+    name (name) {
+        this._name = name;
+    }
+
+    id (id) {
+        this._id = id;
+    }
+
+    toObject () {
+        if (! this.filled()) return null;
+
+        const data = {};
+
+        data.action = this._name;
+        if (this._id) data.id = this._id;
+
+        return data;
+    }
+}

package/src/request/pagination.js

@@ -0,0 +1,35 @@
+export default class Pagination {
+    constructor () {
+        this._page = null;
+        this._perPage = null;
+        this._findPageForId = null;
+    }
+
+    filled () {
+        return this._perPage && (this._page || this._findPageForId);
+    }
+
+    page (page) {
+        this._page = page;
+    }
+
+    perPage (perPage) {
+        this._perPage = perPage;
+    }
+
+    findPageForId (id) {
+        this._findPageForId = id;
+    }
+
+    toObject () {
+        const data = {};
+
+        if (this.filled()) {
+            data.page = this._page;
+            data.paginate = this._perPage;
+            data.page_for_id = this._findPageForId;
+        }
+
+        return data;
+    }
+}

package/src/request.js

@@ -0,0 +1,317 @@
+import Action from './request/action';
+import Connection from './connection';
+import Filters from './filters/filters';
+import Modifiers from './modifiers/modifiers';
+import Pagination from './request/pagination';
+
+import actionMixin from './mixins/actionMixin';
+import filterMixin from './mixins/filterMixin';
+import modifierMixin from './mixins/modifierMixin';
+import paginationMixin from './mixins/paginationMixin';
+
+/**
+ * @mixes actionMixin
+ * @mixes filterMixin
+ * @mixes modifierMixin
+ * @mixes paginationMixin
+ */
+export default class Request {
+    constructor () {
+        this.url = null;
+
+        this._action = new Action();
+        this._filters = new Filters();
+        this._modifiers = new Modifiers();
+        this._pagination = new Pagination();
+        this._customParameters = [];
+
+        this._onSuccess = () => {};
+        this._onError = () => {};
+        this._onValidationError = () => {};
+        this._onUnauthorized = () => {};
+        this._onForbidden = () => {};
+
+        this._connection = new Connection();
+
+        this._response = null;
+    }
+
+    get response () {
+        return this._response;
+    }
+
+    /**
+     * @param {string} url
+     *
+     * @returns {this} The current instance.
+     */
+    setUrl (url) {
+        this.url = url;
+
+        return this;
+    }
+
+    /**
+     * @returns {this} The current instance.
+     */
+    cancel () {
+        this._connection.cancel();
+
+        return this;
+    }
+
+    /**
+     * @returns {this} The current instance.
+     */
+    async get () {
+        const url = this.url ?? this.constructor.endpoint;
+
+        this._response = await this._connection.get(
+            `${url}`,
+            this.bodyParameters,
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return this;
+    }
+
+    /**
+     * @param {Object} data
+     *
+     * @returns {this} The current instance.
+     */
+    async post (data = {}) {
+        const url = this.url ?? this.constructor.endpoint;
+
+        this._response = await this._connection.post(
+            `${url}`,
+            data,
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return this;
+    }
+
+    /**
+     * @param {Object} data
+     *
+     * @returns {this} The current instance.
+     */
+    async put (data = {}) {
+        const url = this.url ?? this.constructor.endpoint;
+
+        this._response = await this._connection.put(
+            `${url}`,
+            { ...data, ...this.bodyParameters },
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return this;
+    }
+
+    /**
+     * @returns {this} The current instance.
+     */
+    async delete () {
+        const url = this.url ?? this.constructor.endpoint;
+
+        this._response = await this._connection.delete(
+            `${url}`,
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return this;
+    }
+
+    /**
+     * @param {Object} files
+     * @param {Object} data
+     *
+     * @returns {this} The current instance.
+     */
+    async storeFiles (files = {}, data = {}) {
+        const url = this.url ?? this.constructor.endpoint;
+
+        this._connection.setConfig({
+            headers: {
+                'Content-Type': 'multipart/form-data',
+            },
+        });
+
+        const formData = this._createFormData(_.merge({}, files, data));
+
+        this._response = await this._connection.post(
+            `${url}?${this.bodyParameters}`,
+            formData,
+        );
+
+        await this.triggerResponseEvents(this._response);
+
+        return this;
+    }
+
+    /**
+     * @returns {Object} Filter and modifier query parameters.
+     */
+    get bodyParameters () {
+        return _.merge(..._.compact([
+            this._filters.toObject(),
+            this._modifiers.toObject(),
+            this._pagination.toObject(),
+            this._action.toObject(),
+            ...this._customParameters,
+        ]));
+    }
+
+    /**
+     * @param {function(Response.data)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onSuccess (callback = () => {}) {
+        this._onSuccess = callback;
+
+        return this;
+    }
+
+    /**
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onError (callback = () => {}) {
+        this._onError = callback;
+
+        return this;
+    }
+
+    /**
+     * @param {function(Response.validation)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onValidationError (callback = () => {}) {
+        this._onValidationError = callback;
+
+        return this;
+    }
+
+    /**
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onUnauthorized (callback = () => {}) {
+        this._onUnauthorized = callback;
+
+        return this;
+    }
+
+    /**
+     * @param {function(Response)} callback
+     *
+     * @returns {this} The current instance.
+     */
+    onForbidden (callback = () => {}) {
+        this._onForbidden = callback;
+
+        return this;
+    }
+
+    /**
+     * @param {Response} response
+     * @param {*} successResponse
+     */
+    async triggerResponseEvents (response, successResponse = null) {
+        if (response.statusCode >= 200 && response.statusCode < 300) {
+            if (! this._onSuccess) return;
+
+            return await this._onSuccess(...[successResponse, response.data].filter((value) => !! value));
+        }
+
+        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;
+        }
+    }
+
+    /**
+     * Add custom parameters to the request.
+     *
+     * @param {Array} parameters
+     *
+     * @returns {this} The current instance.
+     */
+    customParameters (parameters = []) {
+        this._customParameters.push(...parameters);
+
+        return this;
+    }
+
+    /**
+     * Convert data to FormData.
+     *
+     * @param {Object} data
+     *
+     * @returns {FormData}
+     */
+    _createFormData (data = {}) {
+        const formData = new FormData();
+
+        function appendFormData (data, name) {
+            name = name || '';
+
+            if (data instanceof File) {
+                formData.append(name, data);
+            } else if (data === true || data === false) {
+                formData.append(name, data ? '1' : '0');
+            } else if (_.isArray(data) || _.isObject(data)) {
+                if (_.size(data) <= 0) {
+                    formData.append(name, '');
+                } else {
+                    _.forOwn(data, (dataItem, key) => {
+                        const newName = name === ''
+                            ? key
+                            : name + '[' + key + ']';
+
+                        appendFormData(dataItem, newName);
+                    });
+                }
+            } else {
+                formData.append(name, data);
+            }
+        }
+
+        appendFormData(data);
+
+        return formData;
+    }
+}
+
+Object.assign(Request.prototype, actionMixin);
+Object.assign(Request.prototype, filterMixin);
+Object.assign(Request.prototype, modifierMixin);
+Object.assign(Request.prototype, paginationMixin);

package/src/response.js

@@ -0,0 +1,33 @@
+export default class Response {
+    constructor () {
+        this._axiosResponse = null;
+
+        this.statusCode = null;
+
+        this.data = null;
+
+        this.validation = null;
+    }
+
+    get failed () {
+        return this.statusCode >= 400;
+    }
+
+    set (statusCode, axiosResponse) {
+        this._axiosResponse = axiosResponse;
+
+        this.statusCode = statusCode;
+
+        switch (this.statusCode) {
+            case 200:
+                this.data = this._axiosResponse.data;
+                break;
+            case 400:
+                this.data = this._axiosResponse.response.data;
+                break;
+            case 422:
+                this.validation = this._axiosResponse.response.data;
+                break;
+        }
+    }
+}

package/src/utilities/format.js

@@ -0,0 +1,11 @@
+export default class Format {
+    static snakeCase (value) {
+        const relations = _.split(value, '.');
+        const attribute = relations.pop();
+
+        return _.join([
+            ...relations,
+            _.snakeCase(attribute),
+        ], '.');
+    }
+}

package/webpack.config.js

@@ -0,0 +1,28 @@
+const path = require('path');
+const webpack = require('webpack');
+
+module.exports = {
+    entry: ['babel-polyfill', path.resolve(__dirname, 'src/index.js')],
+    output: {
+        path: path.resolve(__dirname, 'dist'),
+        filename: 'index.js',
+        library: 'Api',
+        libraryTarget: 'umd',
+    },
+    plugins: [
+        new webpack.ProvidePlugin({
+            _: 'lodash',
+            axios: 'axios',
+        }),
+    ],
+    module: {
+        rules: [
+            {
+                test: /\.(js)$/,
+                exclude: /node_modules/,
+                use: 'babel-loader',
+            },
+        ],
+    },
+    mode: 'development',
+};