Refactoring of actions

Author: phortx

src/actions/destroy.ts

@@ -1,12 +1,33 @@
-import { ActionParams, Data } from "../support/interfaces";
+import { ActionParams, Data, PatchedModel } from "../support/interfaces";
 import Action from "./action";
 import { Store } from "../orm/store";
 import Context from "../common/context";
+import { toNumber } from "../support/utils";
 
 /**
  * Destroy action for sending a delete mutation. Will be used for record.$destroy().
  */
 export default class Destroy extends Action {
+  /**
+   * Registers the record.$destroy() and record.$deleteAndDestroy() methods and
+   * the destroy Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const record: PatchedModel = context.components.Model.prototype as PatchedModel;
+
+    context.components.Actions.destroy = Destroy.call.bind(Destroy);
+
+    record.$destroy = async function() {
+      return this.$dispatch("destroy", { id: toNumber(this.$id) });
+    };
+
+    record.$deleteAndDestroy = async function() {
+      await this.$delete();
+      return this.$destroy();
+    };
+  }
+
   /**
    * @param {State} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/fetch.ts

@@ -2,13 +2,31 @@ import QueryBuilder from "../graphql/query-builder";
 import Context from "../common/context";
 import { Store } from "../orm/store";
 import Transformer from "../graphql/transformer";
-import { ActionParams, Arguments, Data } from "../support/interfaces";
+import { ActionParams, Data, PatchedModel } from "../support/interfaces";
 import Action from "./action";
+import { isPlainObject } from "../support/utils";
 
 /**
  * Fetch action for sending a query. Will be used for Model.fetch().
  */
 export default class Fetch extends Action {
+  /**
+   * Registers the Model.fetch() method and the fetch Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const model: typeof PatchedModel = context.components.Model as typeof PatchedModel;
+
+    context.components.Actions.fetch = Fetch.call.bind(Fetch);
+
+    model.fetch = async function(filter: any, bypassCache = false) {
+      let filterObj = filter;
+      if (!isPlainObject(filterObj)) filterObj = { id: filter };
+
+      return this.dispatch("fetch", { filter: filterObj, bypassCache });
+    };
+  }
+
   /**
    * @param {any} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/index.ts

@@ -1,8 +1,11 @@
-import Action from './action';
-import Destroy from './destroy';
-import Fetch from './fetch';
-import Mutate from './mutate';
-import Persist from './persist';
-import Push from './push';
+import Action from "./action";
+import Destroy from "./destroy";
+import Fetch from "./fetch";
+import Mutate from "./mutate";
+import Persist from "./persist";
+import Push from "./push";
+import Query from "./query";
+import SimpleQuery from "./simple-query";
+import SimpleMutation from "./simple-mutation";
 
-export { Action, Destroy, Fetch, Mutate, Persist, Push };
+export { SimpleQuery, SimpleMutation, Query, Action, Destroy, Fetch, Mutate, Persist, Push };

src/actions/mutate.ts

@@ -1,13 +1,36 @@
-import { ActionParams, Arguments, Data } from "../support/interfaces";
+import { ActionParams, PatchedModel, Data } from "../support/interfaces";
 import Action from "./action";
 import Context from "../common/context";
 import Schema from "../graphql/schema";
 import { Store } from "../orm/store";
+import { toNumber } from "../support/utils";
 
 /**
  * Mutate action for sending a custom mutation. Will be used for Model.mutate() and record.$mutate().
  */
 export default class Mutate extends Action {
+  /**
+   * Registers the Model.mutate() and the record.$mutate() methods and the mutate Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const model: typeof PatchedModel = context.components.Model as typeof PatchedModel;
+    const record: PatchedModel = context.components.Model.prototype as PatchedModel;
+
+    context.components.Actions.mutate = Mutate.call.bind(Mutate);
+
+    model.mutate = async function(params: ActionParams) {
+      return this.dispatch("mutate", params);
+    };
+
+    record.$mutate = async function({ name, args, multiple }: ActionParams) {
+      args = args || {};
+      if (!args["id"]) args["id"] = toNumber(this.$id);
+
+      return this.$dispatch("mutate", { name, args, multiple });
+    };
+  }
+
   /**
    * @param {any} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/persist.ts

@@ -1,5 +1,5 @@
 import Context from "../common/context";
-import { ActionParams, Data } from "../support/interfaces";
+import { ActionParams, Data, PatchedModel } from "../support/interfaces";
 import Action from "./action";
 import Model from "../orm/model";
 import { Store } from "../orm/store";
@@ -9,6 +9,20 @@ import { toNumber } from "../support/utils";
  * Persist action for sending a create mutation. Will be used for record.$persist().
  */
 export default class Persist extends Action {
+  /**
+   * Registers the record.$persist() method and the persist Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const record: PatchedModel = context.components.Model.prototype as PatchedModel;
+
+    context.components.Actions.persist = Persist.call.bind(Persist);
+
+    record.$persist = async function(args: any) {
+      return this.$dispatch("persist", { id: this.$id, args });
+    };
+  }
+
   /**
    * @param {any} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/push.ts

@@ -1,4 +1,4 @@
-import { ActionParams, Data } from "../support/interfaces";
+import { ActionParams, Data, PatchedModel } from "../support/interfaces";
 import Action from "./action";
 import { Store } from "../orm/store";
 import Context from "../common/context";
@@ -7,6 +7,20 @@ import Context from "../common/context";
  * Push action for sending a update mutation. Will be used for record.$push().
  */
 export default class Push extends Action {
+  /**
+   * Registers the record.$push() method and the push Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const model: PatchedModel = context.components.Model.prototype as PatchedModel;
+
+    context.components.Actions.push = Push.call.bind(Push);
+
+    model.$push = async function(args: any) {
+      return this.$dispatch("push", { data: this, args });
+    };
+  }
+
   /**
    * @param {any} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/query.ts

@@ -2,14 +2,38 @@ import QueryBuilder from "../graphql/query-builder";
 import Context from "../common/context";
 import { Store } from "../orm/store";
 import Transformer from "../graphql/transformer";
-import { ActionParams, Data } from "../support/interfaces";
+import { ActionParams, Data, PatchedModel } from "../support/interfaces";
 import Action from "./action";
 import Schema from "../graphql/schema";
+import { toNumber } from "../support/utils";
 
 /**
  * Query action for sending a custom query. Will be used for Model.customQuery() and record.$customQuery.
  */
 export default class Query extends Action {
+  /**
+   * Registers the Model.customQuery and the record.$customQuery() methods and the
+   * query Vuex Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    const model: typeof PatchedModel = context.components.Model as typeof PatchedModel;
+    const record: PatchedModel = context.components.Model.prototype as PatchedModel;
+
+    context.components.Actions.query = Query.call.bind(Query);
+
+    model.customQuery = async function({ name, filter, multiple, bypassCache }: ActionParams) {
+      return this.dispatch("query", { name, filter, multiple, bypassCache });
+    };
+
+    record.$customQuery = async function({ name, filter, multiple, bypassCache }: ActionParams) {
+      filter = filter || {};
+      if (!filter["id"]) filter["id"] = toNumber(this.$id);
+
+      return this.$dispatch("query", { name, filter, multiple, bypassCache });
+    };
+  }
+
   /**
    * @param {any} state The Vuex state
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model

src/actions/simple-mutation.ts

@@ -7,6 +7,14 @@ import { clone, graphQlDocumentToString, parseQuery } from "../support/utils";
  * SimpleMutation action for sending a model unrelated simple mutation.
  */
 export default class SimpleMutation extends Action {
+  /**
+   * Registers the Model.simpleMutation() Vuex Root Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    context.components.RootActions.simpleMutation = SimpleMutation.call.bind(SimpleMutation);
+  }
+
   /**
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
    * @param {string} query The query to send

src/actions/simple-query.ts

@@ -7,6 +7,14 @@ import { clone, graphQlDocumentToString, parseQuery, removeSymbols } from "../su
  * SimpleQuery action for sending a model unrelated simple query.
  */
 export default class SimpleQuery extends Action {
+  /**
+   * Registers the Model.simpleQuery() Vuex Root Action.
+   */
+  public static setup() {
+    const context = Context.getInstance();
+    context.components.RootActions.simpleQuery = SimpleQuery.call.bind(SimpleQuery);
+  }
+
   /**
    * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
    * @param {string} query The query to send

src/vuex-orm-graphql.ts

@@ -1,11 +1,16 @@
-import { PatchedModel, Options, ActionParams } from "./support/interfaces";
+import { Options } from "./support/interfaces";
 import Context from "./common/context";
 import { PluginComponents } from "@vuex-orm/core/lib/plugins/use";
-import { Destroy, Fetch, Mutate, Persist, Push } from "./actions";
-import Query from "./actions/query";
-import SimpleQuery from "./actions/simple-query";
-import SimpleMutation from "./actions/simple-mutation";
-import { isPlainObject, toNumber } from "./support/utils";
+import {
+  Destroy,
+  Fetch,
+  Mutate,
+  Persist,
+  Push,
+  Query,
+  SimpleQuery,
+  SimpleMutation
+} from "./actions";
 
 /**
  * Main class of the plugin. Setups the internal context, Vuex actions and model methods
@@ -19,7 +24,6 @@ export default class VuexORMGraphQL {
   public constructor(components: PluginComponents, options: Options) {
     Context.setup(components, options);
     VuexORMGraphQL.setupActions();
-    VuexORMGraphQL.setupModelMethods();
   }
 
   /**
@@ -30,86 +34,19 @@ export default class VuexORMGraphQL {
   }
 
   /**
-   * This method will setup following Vuex actions: fetch, persist, push, destroy, mutate
+   * This method will setup:
+   *   - Vuex actions: fetch, persist, push, destroy, mutate
+   *   - Model methods: fetch(), mutate(), customQuery()
+   *   - Record method: $mutate(), $persist(), $push(), $destroy(), $deleteAndDestroy(), $customQuery()
    */
   private static setupActions() {
-    const context = Context.getInstance();
-
-    context.components.RootActions.simpleQuery = SimpleQuery.call.bind(SimpleQuery);
-    context.components.RootActions.simpleMutation = SimpleMutation.call.bind(SimpleMutation);
-
-    context.components.Actions.fetch = Fetch.call.bind(Fetch);
-    context.components.Actions.persist = Persist.call.bind(Persist);
-    context.components.Actions.push = Push.call.bind(Push);
-    context.components.Actions.destroy = Destroy.call.bind(Destroy);
-    context.components.Actions.mutate = Mutate.call.bind(Mutate);
-    context.components.Actions.query = Query.call.bind(Query);
-  }
-
-  /**
-   * This method will setup following model methods: Model.fetch, Model.mutate, Model.customQuery, record.$mutate,
-   * record.$persist, record.$push, record.$destroy and record.$deleteAndDestroy, record.$customQuery
-   */
-  private static setupModelMethods() {
-    const context = Context.getInstance();
-
-    // Register static model convenience methods
-    (context.components.Model as typeof PatchedModel).fetch = async function(
-      filter: any,
-      bypassCache = false
-    ) {
-      let filterObj = filter;
-      if (!isPlainObject(filterObj)) {
-        filterObj = { id: filter };
-      }
-      return this.dispatch("fetch", { filter: filterObj, bypassCache });
-    };
-
-    (context.components.Model as typeof PatchedModel).mutate = async function(
-      params: ActionParams
-    ) {
-      return this.dispatch("mutate", params);
-    };
-
-    (context.components.Model as typeof PatchedModel).customQuery = async function({
-      name,
-      filter,
-      multiple,
-      bypassCache
-    }: ActionParams) {
-      return this.dispatch("query", { name, filter, multiple, bypassCache });
-    };
-
-    // Register model convenience methods
-    const model: PatchedModel = context.components.Model.prototype as PatchedModel;
-
-    model.$mutate = async function({ name, args, multiple }: ActionParams) {
-      args = args || {};
-      if (!args["id"]) args["id"] = toNumber(this.$id);
-      return this.$dispatch("mutate", { name, args, multiple });
-    };
-
-    model.$customQuery = async function({ name, filter, multiple, bypassCache }: ActionParams) {
-      filter = filter || {};
-      if (!filter["id"]) filter["id"] = toNumber(this.$id);
-      return this.$dispatch("query", { name, filter, multiple, bypassCache });
-    };
-
-    model.$persist = async function(args: any) {
-      return this.$dispatch("persist", { id: this.$id, args });
-    };
-
-    model.$push = async function(args: any) {
-      return this.$dispatch("push", { data: this, args });
-    };
-
-    model.$destroy = async function() {
-      return this.$dispatch("destroy", { id: toNumber(this.$id) });
-    };
-
-    model.$deleteAndDestroy = async function() {
-      await this.$delete();
-      return this.$destroy();
-    };
+    Fetch.setup();
+    Persist.setup();
+    Push.setup();
+    Destroy.setup();
+    Mutate.setup();
+    Query.setup();
+    SimpleQuery.setup();
+    SimpleMutation.setup();
   }
 }