@feathersjs/vuex/src/index.ts

FeathersJS, Vue 3, and Nuxt for the artisan developer

/*
eslint
@typescript-eslint/explicit-function-return-type: 0,
@typescript-eslint/no-explicit-any: 0
*/
import {
  // Components
  FeathersVuexFind,
  FeathersVuexGet,
  FeathersVuexFormWrapper,
  FeathersVuexInputWrapper,
  FeathersVuexPagination,
  // Mixins
  makeFindMixin,
  makeGetMixin,
  // Composition API Utils
  useFind,
  useGet,
  // Models
  models,
  makeBaseModel,
  // Clients
  clients,
  addClient,
  // Plugin Factories
  prepareMakeServicePlugin,
  prepareMakeAuthPlugin,
  // Utils,
  initAuth,
  hydrateApi,
  // Types
  FeathersVuexOptions,
  HandleEvents,
  Model,
  ModelStatic,
  ModelSetupContext,
  Id,
  FeathersVuexStoreState,
  FeathersVuexGlobalModels,
  GlobalModels,
  ServiceState,
  AuthState,
} from '@feathersjs/vuex-commons'
import { FeathersVuex } from './app-plugin'
import makeServiceMutations from './service-module.mutations-vue3'
import { merge } from './utils.vue3'

const defaults: FeathersVuexOptions = {
  autoRemove: false, // Automatically remove records missing from responses (only use with feathers-rest)
  addOnUpsert: false, // Add new records pushed by 'updated/patched' socketio events into store, instead of discarding them
  enableEvents: true, // Listens to socket.io events when available
  idField: 'id', // The field in each record that will contain the id
  tempIdField: '__id',
  debug: false, // Set to true to enable logging messages.
  keepCopiesInStore: false, // Set to true to store cloned copies in the store instead of on the Model.
  nameStyle: 'short', // Determines the source of the module name. 'short', 'path', or 'explicit'
  paramsForServer: ['$populateParams'], // Custom query operators that are ignored in the find getter, but will pass through to the server. $populateParams is for https://feathers-graph-populate.netlify.app/
  preferUpdate: false, // When true, calling model.save() will do an update instead of a patch.
  replaceItems: false, // Instad of merging in changes in the store, replace the entire record.
  serverAlias: 'api',
  handleEvents: {} as HandleEvents,
  skipRequestIfExists: false, // For get action, if the record already exists in store, skip the remote request
  makeServiceMutations,
  merge,
  whitelist: [], // Custom query operators that will be allowed in the find getter.
}
const events = ['created', 'patched', 'updated', 'removed']

export default function feathersVuex(feathers, options: FeathersVuexOptions) {
  if (!feathers || !feathers.service) {
    throw new Error('The first argument to feathersVuex must be a feathers client.')
  }

  // Setup the event handlers. By default they just return the value of `options.enableEvents`
  defaults.handleEvents = events.reduce((obj, eventName) => {
    obj[eventName] = () => options.enableEvents || true
    return obj
  }, {} as HandleEvents)

  options = Object.assign({}, defaults, options)

  if (!options.serverAlias) {
    throw new Error(`You must provide a 'serverAlias' in the options to feathersVuex`)
  }

  addClient({ client: feathers, serverAlias: options.serverAlias })

  const BaseModel = makeBaseModel(options)
  const makeServicePlugin = prepareMakeServicePlugin(options)
  const makeAuthPlugin = prepareMakeAuthPlugin(feathers, options)

  return {
    makeServicePlugin,
    BaseModel,
    makeAuthPlugin,
    FeathersVuex,
    models: models as GlobalModels,
    clients,
  }
}

export {
  initAuth,
  hydrateApi,
  FeathersVuexFind,
  FeathersVuexGet,
  FeathersVuexFormWrapper,
  FeathersVuexInputWrapper,
  FeathersVuexPagination,
  FeathersVuex,
  makeFindMixin,
  makeGetMixin,
  models,
  clients,
  useFind,
  useGet,
  AuthState,
  Id,
  Model,
  ModelStatic,
  ModelSetupContext,
  ServiceState,
  FeathersVuexGlobalModels,
  FeathersVuexStoreState,
}