build

Author: phortx

dist/actions/action.d.ts

@@ -0,0 +1,49 @@
+import { Arguments, Data, DispatchFunction } from "../support/interfaces";
+import Model from "../orm/model";
+import RootState from "@vuex-orm/core/lib/modules/contracts/RootState";
+/**
+ * Base class for all Vuex actions. Contains some utility and convenience methods.
+ */
+export default class Action {
+    /**
+     * Sends a mutation.
+     *
+     * @param {string} name Name of the mutation like 'createUser'
+     * @param {Data | undefined} variables Variables to send with the mutation
+     * @param {Function} dispatch Vuex Dispatch method for the model
+     * @param {Model} model The model this mutation affects.
+     * @param {boolean} multiple Tells if we're requesting a single record or multiple.
+     * @returns {Promise<any>}
+     */
+    protected static mutation(name: string, variables: Data | undefined, dispatch: DispatchFunction, model: Model): Promise<any>;
+    /**
+     * Convenience method to get the model from the state.
+     * @param {RootState} state Vuex state
+     * @returns {Model}
+     */
+    static getModelFromState(state: RootState): Model;
+    /**
+     * Makes sure args is a hash.
+     *
+     * @param {Arguments|undefined} args
+     * @param {any} id When not undefined, it's added to the args
+     * @returns {Arguments}
+     */
+    static prepareArgs(args?: Arguments, id?: any): Arguments;
+    /**
+     * Adds the record itself to the args and sends it through transformOutgoingData. Key is named by the singular name
+     * of the model.
+     *
+     * @param {Arguments} args
+     * @param {Model} model
+     * @param {Data} data
+     * @returns {Arguments}
+     */
+    static addRecordToArgs(args: Arguments, model: Model, data: Data): Arguments;
+    /**
+     * Transforms each field of the args which contains a model.
+     * @param {Arguments} args
+     * @returns {Arguments}
+     */
+    protected static transformArgs(args: Arguments): Arguments;
+}

dist/actions/destroy.d.ts

@@ -0,0 +1,14 @@
+import { ActionParams } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Destroy action for sending a delete mutation. Will be used for record.$destroy().
+ */
+export default class Destroy extends Action {
+    /**
+     * @param {State} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} id ID of the record to delete
+     * @returns {Promise<any>} true
+     */
+    static call({ state, dispatch }: ActionParams, { id, args }: ActionParams): Promise<boolean>;
+}

dist/actions/fetch.d.ts

@@ -0,0 +1,14 @@
+import { ActionParams, Data } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Fetch action for sending a query. Will be used for Model.fetch().
+ */
+export default class Fetch extends Action {
+    /**
+     * @param {any} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {ActionParams} params Optional params to send with the query
+     * @returns {Promise<Data>} The fetched records as hash
+     */
+    static call({ state, dispatch }: ActionParams, params?: ActionParams): Promise<Data>;
+}

dist/actions/index.d.ts

@@ -0,0 +1,7 @@
+import Action from './action';
+import Destroy from './destroy';
+import Fetch from './fetch';
+import Mutate from './mutate';
+import Persist from './persist';
+import Push from './push';
+export { Action, Destroy, Fetch, Mutate, Persist, Push };

dist/actions/mutate.d.ts

@@ -0,0 +1,16 @@
+import { ActionParams, Data } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Mutate action for sending a custom mutation. Will be used for Model.mutate() and record.$mutate().
+ */
+export default class Mutate extends Action {
+    /**
+     * @param {any} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} name Name of the query
+     * @param {boolean} multiple Fetch one or multiple?
+     * @param {Arguments} args Arguments for the mutation. Must contain a 'mutation' field.
+     * @returns {Promise<Data>} The new record if any
+     */
+    static call({ state, dispatch }: ActionParams, { args, name }: ActionParams): Promise<Data>;
+}

dist/actions/persist.d.ts

@@ -0,0 +1,23 @@
+import { ActionParams, Data } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Persist action for sending a create mutation. Will be used for record.$persist().
+ */
+export default class Persist extends Action {
+    /**
+     * @param {any} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} id ID of the record to persist
+     * @returns {Promise<Data>} The saved record
+     */
+    static call({ state, dispatch }: ActionParams, { id, args }: ActionParams): Promise<Data>;
+    /**
+     * It's very likely that the server generated different ID for this record.
+     * In this case Action.mutation has inserted a new record instead of updating the existing one.
+     *
+     * @param {Model} model
+     * @param {Data} record
+     * @returns {Promise<void>}
+     */
+    private static deleteObsoleteRecord;
+}

dist/actions/push.d.ts

@@ -0,0 +1,15 @@
+import { ActionParams, Data } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Push action for sending a update mutation. Will be used for record.$push().
+ */
+export default class Push extends Action {
+    /**
+     * @param {any} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {Arguments} data New data to save
+     * @param {Arguments} args Additional arguments
+     * @returns {Promise<Data>} The updated record
+     */
+    static call({ state, dispatch }: ActionParams, { data, args }: ActionParams): Promise<Data>;
+}

dist/actions/query.d.ts

@@ -0,0 +1,17 @@
+import { ActionParams, Data } from "../support/interfaces";
+import Action from "./action";
+/**
+ * Query action for sending a custom query. Will be used for Model.customQuery() and record.$customQuery.
+ */
+export default class Query extends Action {
+    /**
+     * @param {any} state The Vuex state
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} name Name of the query
+     * @param {boolean} multiple Fetch one or multiple?
+     * @param {object} filter Filter object (arguments)
+     * @param {boolean} bypassCache Whether to bypass the cache
+     * @returns {Promise<Data>} The fetched records as hash
+     */
+    static call({ state, dispatch }: ActionParams, { name, filter, bypassCache }: ActionParams): Promise<Data>;
+}

dist/actions/simple-mutation.d.ts

@@ -0,0 +1,14 @@
+import { ActionParams } from "../support/interfaces";
+import Action from "./action";
+/**
+ * SimpleMutation action for sending a model unrelated simple mutation.
+ */
+export default class SimpleMutation extends Action {
+    /**
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} query The query to send
+     * @param {Arguments} variables
+     * @returns {Promise<any>} The result
+     */
+    static call({ dispatch }: ActionParams, { query, variables }: ActionParams): Promise<any>;
+}

dist/actions/simple-query.d.ts

@@ -0,0 +1,15 @@
+import { ActionParams } from "../support/interfaces";
+import Action from "./action";
+/**
+ * SimpleQuery action for sending a model unrelated simple query.
+ */
+export default class SimpleQuery extends Action {
+    /**
+     * @param {DispatchFunction} dispatch Vuex Dispatch method for the model
+     * @param {string} query The query to send
+     * @param {Arguments} variables
+     * @param {boolean} bypassCache Whether to bypass the cache
+     * @returns {Promise<any>} The result
+     */
+    static call({ dispatch }: ActionParams, { query, bypassCache, variables }: ActionParams): Promise<any>;
+}