Added Model and Module Config to each database model

Author: KaniRobinson

dist/index.js

@@ -0,0 +1,38 @@
+import _ from 'lodash';
+import Context from '../common/context';
+import { ModuleConfig, ModelConfig } from '../support/interfaces';
+
+export default class Action {
+  /**
+   * Transform Module to include ModuleConfig
+   * @param {object} model
+   */
+  static transformModule(module) {
+    return _.merge({}, ModuleConfig, module);
+  }
+
+  /**
+   * Transform Model to include ModelConfig
+   * @param {object} model
+   */
+  static transformModel(model) {
+    const context = Context.getInstance();
+    ModelConfig.http = _.merge({}, ModelConfig.http, context.options.http);
+    model.methodConf = _.merge({}, ModelConfig, model.methodConf);
+    model.methodConf.http.url = (model.methodConf.http.url === '/') ? `/${model.entity}` : model.methodConf.http.url;
+    return model;
+  }
+
+  /**
+   * Transform Params and Return Endpoint
+   * @param {string} type
+   * @param {object} model
+   * @param {object} config
+   */
+  static transformParams (type, model, config = {}) {
+    let endpoint = `${model.methodConf.http.url}${model.methodConf.methods[type].http.url}`;
+    if (config.params) _.forOwn(config.params, (value, param) => { endpoint = endpoint.replace(`:${param}`, value); });
+    if (config.query) endpoint += `?${Object.keys(config.query).map(k => `${encodeURIComponent(k)}=${encodeURIComponent(config.query[k])}`).join('&')}`;
+    return endpoint;
+  }
+}

src/actions/Action.js

@@ -0,0 +1,7 @@
+import Action from './Action'
+
+export default class Create extends Action {
+  static call ({ state, dispatch }, params = {}) {
+    // console.log(state, dispatch, params);
+  }
+}

src/actions/Create.js

@@ -0,0 +1,7 @@
+import Action from './Action'
+
+export default class Delete extends Action {
+  static call ({ state, dispatch }, params={}) {
+    console.log(state, dispatch, params);
+  }
+}

src/actions/Delete.js

@@ -0,0 +1,10 @@
+import Action from './Action'
+import Context from '../common/context'
+
+export default class Fetch extends Action {
+  static async call ({ state }, params = {}) {
+    const context = Context.getInstance();
+    const model = context.getModelFromState(state);
+    const endpoint = Action.transformParams('$fetch', model, params);
+  }
+}

src/actions/Fetch.js

@@ -0,0 +1,7 @@
+import Action from './Action'
+
+export default class Get extends Action {
+  static call ({ state, dispatch }, params={}) {
+    console.log(state, dispatch, params);
+  }
+}

src/actions/Get.js

@@ -0,0 +1,7 @@
+import Action from './Action'
+
+export default class Update extends Action {
+  static call ({ state, dispatch }, params={}) {
+    console.log(state, dispatch, params);
+  }
+}

src/actions/Update.js

@@ -37,4 +37,14 @@ export default class Context {
   static getInstance() {
     return this.instance;
   }
+
+  /**
+   * Get Model from State
+   * @param {object} state
+   */
+  getModelFromState(state) {
+    return _.find(this.database.entities, {
+      name: state.$name
+    }).model;
+  }
 }

src/common/context.js

@@ -163,3 +163,107 @@ export const VuexOrmPluginConfig = {
    */
   http: AxiosRequestConfig
 };
+
+export const ModuleConfig = {
+  /**
+   * Vuex Default Getters
+   */
+  getters: {
+    loading: state => state.loading,
+    errors: state => state.errors,
+  },
+
+  /**
+   * Vuex Default Mutations
+   */
+  mutations: {
+    /**
+     * On Default Request
+     * @param {object} state
+     */
+    onRequest(state) {
+      state.loading = true;
+      state.errors = [];
+    },
+
+    /**
+     * On Error Request
+     * @param {object} state
+     * @param {object} response
+     */
+    onError(state, response) {
+      state.loading = false;
+      state.errors = response.data;
+    },
+
+    /**
+     * On Success Request
+     * @param {object} state
+     * @param {object} response
+     */
+    onSuccess(state) {
+      state.loading = false;
+      state.errors = [];
+    },
+  },
+
+  /**
+   * Vuex Defualt State
+   */
+  state: {
+    loading: false,
+    errors: [],
+  },
+};
+
+export const FetchConfig = {
+  name: 'fetch',
+  http: {
+    url: '',
+    method: 'get',
+  },
+};
+
+export const GetConfig = {
+  name: 'get',
+  http: {
+    url: '/:id',
+    method: 'get',
+  },
+};
+
+export const CreateConfig = {
+  name: 'create',
+  alias: ['insert'],
+  http: {
+    url: '',
+    method: 'post',
+  },
+};
+
+export const UpdateConfig = {
+  name: 'update',
+  http: {
+    url: '/:id',
+    method: 'put',
+  },
+};
+
+export const DeleteConfig = {
+  name: 'delete',
+  http: {
+    url: '/:id',
+    method: 'delete',
+  },
+};
+
+export const ModelConfig = {
+  http: AxiosRequestConfig,
+  methods: {
+    $fetch: FetchConfig,
+    $get: GetConfig,
+    $create: CreateConfig,
+    $update: UpdateConfig,
+    $delete: DeleteConfig,
+  },
+};

src/support/interfaces.js

@@ -1,10 +1,70 @@
+import Context from './common/context';
+import Action from './actions/Action'
+import Fetch from './actions/Fetch'
+import Get from './actions/Get'
+import Create from './actions/Create'
+import Update from './actions/Update'
+import Delete from './actions/Delete'
+
 export default class VuexOrmAxios {
   /**
    * @constructor
    * @param {Components} components The Vuex-ORM Components collection
    * @param {Options} options The options passed to VuexORM.install
    */
   constructor(components, options) {
-    //
+    Context.setup(components, options);
+    this.setupActions();
+    this.setupModels();
+  }
+
+  /**
+   * This method will setup following Vuex actions: $fetch, $get, $create, $update, $delete
+   */
+  setupActions () {
+    const context = Context.getInstance();
+
+    context.components.Actions.$fetch = Fetch.call.bind(Fetch);
+    context.components.Actions.$get = Get.call.bind(Get);
+    context.components.Actions.$create = Create.call.bind(Create);
+    context.components.Actions.$update = Update.call.bind(Update);
+    context.components.Actions.$delete = Delete.call.bind(Delete);
+  }
+
+  /**
+   * This method will setup following model methods: Model.$fetch, Model.$get, Model.$create,
+   * Model.$update, Model.$delete
+   */
+  setupModels () {
+    const context = Context.getInstance();
+
+    /**
+     * Transform Model and Modules
+     */
+    _.map(context.database.entities, entity => {
+      entity.module = Action.transformModule(entity.module);
+      entity.model = Action.transformModel(entity.model);
+      return entity;
+    });
+
+    context.components.Model.$fetch = async function (config = {}) {
+      return this.dispatch('$fetch', config);
+    };
+
+    context.components.Model.$get = async function (config = {}) {
+      return this.dispatch('$get', config);
+    };
+
+    context.components.Model.$create = async function (config = {}) {
+      return this.dispatch('$create', config);
+    };
+
+    context.components.Model.$update = async function (config = {}) {
+      return this.dispatch('$update', config);
+    };
+
+    context.components.Model.$delete = async function (config = {}) {
+      return this.dispatch('$delete', config);
+    };
   }
 }