@atlascity/vuex-orm-plugin-lokijs/src/common/Interfaces.ts

vuex-orm LokiJS persistance plugin.

// Copyright (C) Atlas City Global <https://atlascity.io>
// This file is part of vuex-orm-plugin-lokijs <https://github.com/atlascity/vuex-orm-plugin-lokijs>.
//
// vuex-orm-plugin-lokijs is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// vuex-orm-plugin-lokijs is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with vuex-orm-plugin-lokijs.  If not, see <http://www.gnu.org/licenses/>.

import ORMModel from '@vuex-orm/core/lib/model/Model'
import { Components } from '@vuex-orm/core/lib/plugins/use'
import Database from '@vuex-orm/core/lib/database/Database'
import RootState from '@vuex-orm/core/lib/modules/contracts/RootState'
import Context from './Context'

export type DispatchFunction = (action: string, data: Data) => Promise<any>

/**
 * Defines contxt singleton interface.
 */
export interface ContextInterface {
  instance: Context;
  components: Components;
  options: Partial<LokiConstructorOptions> & Partial<LokiConfigOptions> & Partial<ThrottledSaveDrainOptions>;
  database: Database;
  loki: Loki;
}

/**
 * defines options passed to new plugin-lokijs.
 */
export interface VuexORMLokiOptions {
  database: Database,
  options: Partial<LokiConstructorOptions> & Partial<LokiConfigOptions> & Partial<ThrottledSaveDrainOptions>;
  hydrationCompletedCallback: any;
}

/**
 * defines payload sent to a insert dispatch method.
 */
export interface dispatchInsertPayload {
  data: Object;
};

/**
 * defines payload sent to a get dispatch method.
 */
export interface dispatchGetPayload {
  id: Number;
}

/**
 * defines action parameters object.
 */
export interface ActionParams {
  commit: any;
  dispatch: DispatchFunction;
  getters: any;
  rootGetters: any;
  rootState: any;
  state: RootState;
  filter?: Filter;
  id?: number;
  data?: Data;
  args?: Arguments;
  variables?: Arguments;
  query?: string;
  multiple?: boolean;
  name?: string;
}

/**
 * defines interface
 */
export interface insertDocCollection {
  [key: string]: Array<Object>;
}

/**
 * data objet definition
 */
export interface Data {
  [index: string]: any;
}

export interface Filter {
  [index: string]: any;
}

export interface Arguments {
  [index: string]: any;
}