@taraai/read-write/src/constants.js

Synchronous NoSQL/Firestore for React

/**
 * @constant
 * @type {string}
 * @description Prefix for all actions within library
 * @example
 * import { constants } from 'react-redux-firebase'
 * constants.actionsPrefix === '::readwrite' // true
 */
export const actionsPrefix = '::readwrite';

/**
 * @constant
 * @type {object}
 * @description Object containing all action types
 * @property {string} START - `::readwrite/START`
 * @property {string} ERROR - `::readwrite/ERROR`
 * @property {string} SET_LISTENER - `::readwrite/SET_LISTENER`
 * @property {string} UNSET_LISTENER - `::readwrite/UNSET_LISTENER`
 * @property {string} LISTENER_RESPONSE - `::readwrite/LISTENER_RESPONSE`
 * @property {string} LISTENER_ERROR - `::readwrite/LISTENER_ERROR`
 * @property {string} CLEAR_DATA - `::readwrite/CLEAR_DATA`
 * @property {string} CLEAR_ERROR - `::readwrite/CLEAR_ERROR`
 * @property {string} CLEAR_ERRORS - `::readwrite/CLEAR_ERRORS`
 * @property {string} GET_REQUEST - `::readwrite/GET_REQUEST`
 * @property {string} GET_SUCCESS - `::readwrite/GET_SUCCESS`
 * @property {string} GET_FAILURE - `::readwrite/GET_FAILURE`
 * @property {string} SET_REQUEST - `::readwrite/SET_REQUEST`
 * @property {string} SET_SUCCESS - `::readwrite/SET_SUCCESS`
 * @property {string} SET_FAILURE - `::readwrite/SET_FAILURE`
 * @property {string} ADD_REQUEST - `::readwrite/ADD_REQUEST`
 * @property {string} ADD_SUCCESS - `::readwrite/ADD_SUCCESS`
 * @property {string} ADD_FAILURE - `::readwrite/ADD_FAILURE`
 * @property {string} UPDATE_REQUEST - `::readwrite/UPDATE_REQUEST`
 * @property {string} UPDATE_SUCCESS - `::readwrite/UPDATE_SUCCESS`
 * @property {string} UPDATE_FAILURE - `::readwrite/UPDATE_FAILURE`
 * @property {string} DELETE_REQUEST - `::readwrite/DELETE_REQUEST`
 * @property {string} DELETE_SUCCESS - `::readwrite/DELETE_SUCCESS`
 * @property {string} DELETE_FAILURE - `::readwrite/DELETE_FAILURE`
 * @property {string} ON_SNAPSHOT_REQUEST - `::readwrite/ON_SNAPSHOT_REQUEST`
 * @property {string} ON_SNAPSHOT_SUCCESS - `::readwrite/ON_SNAPSHOT_SUCCESS`
 * @property {string} ON_SNAPSHOT_FAILURE - `::readwrite/ON_SNAPSHOT_FAILURE`
 * @property {string} TRANSACTION_START - `::readwrite/TRANSACTION_START`
 * @property {string} TRANSACTION_SUCCESS - `::readwrite/TRANSACTION_SUCCESS`
 * @property {string} TRANSACTION_FAILURE - `::readwrite/TRANSACTION_FAILURE`
 * @example
 * import { actionTypes } from 'react-redux-firebase'
 * actionTypes.SET === '::readwrite/SET' // true
 */
export const actionTypes = {
  START: `${actionsPrefix}/START`,
  ERROR: `${actionsPrefix}/ERROR`,
  CLEAR_DATA: `${actionsPrefix}/CLEAR_DATA`,
  CLEAR_ERROR: `${actionsPrefix}/CLEAR_ERROR`,
  CLEAR_ERRORS: `${actionsPrefix}/CLEAR_ERRORS`,
  SET_LISTENER: `${actionsPrefix}/SET_LISTENER`,
  UNSET_LISTENER: `${actionsPrefix}/UNSET_LISTENER`,
  GET_REQUEST: `${actionsPrefix}/GET_REQUEST`,
  GET_SUCCESS: `${actionsPrefix}/GET_SUCCESS`,
  GET_FAILURE: `${actionsPrefix}/GET_FAILURE`,
  SET_REQUEST: `${actionsPrefix}/SET_REQUEST`,
  SET_SUCCESS: `${actionsPrefix}/SET_SUCCESS`,
  SET_FAILURE: `${actionsPrefix}/SET_FAILURE`,
  ADD_REQUEST: `${actionsPrefix}/ADD_REQUEST`,
  ADD_SUCCESS: `${actionsPrefix}/ADD_SUCCESS`,
  ADD_FAILURE: `${actionsPrefix}/ADD_FAILURE`,
  UPDATE_REQUEST: `${actionsPrefix}/UPDATE_REQUEST`,
  UPDATE_SUCCESS: `${actionsPrefix}/UPDATE_SUCCESS`,
  UPDATE_FAILURE: `${actionsPrefix}/UPDATE_FAILURE`,
  DELETE_REQUEST: `${actionsPrefix}/DELETE_REQUEST`,
  DELETE_SUCCESS: `${actionsPrefix}/DELETE_SUCCESS`,
  DELETE_FAILURE: `${actionsPrefix}/DELETE_FAILURE`,
  ATTACH_LISTENER: `${actionsPrefix}/ATTACH_LISTENER`,
  LISTENER_RESPONSE: `${actionsPrefix}/LISTENER_RESPONSE`,
  LISTENER_ERROR: `${actionsPrefix}/LISTENER_ERROR`,
  ON_SNAPSHOT_REQUEST: `${actionsPrefix}/ON_SNAPSHOT_REQUEST`,
  ON_SNAPSHOT_SUCCESS: `${actionsPrefix}/ON_SNAPSHOT_SUCCESS`,
  ON_SNAPSHOT_FAILURE: `${actionsPrefix}/ON_SNAPSHOT_FAILURE`,
  DOCUMENT_ADDED: `${actionsPrefix}/DOCUMENT_ADDED`,
  DOCUMENT_MODIFIED: `${actionsPrefix}/DOCUMENT_MODIFIED`,
  DOCUMENT_REMOVED: `${actionsPrefix}/DOCUMENT_REMOVED`,
  TRANSACTION_START: `${actionsPrefix}/TRANSACTION_START`,
  TRANSACTION_SUCCESS: `${actionsPrefix}/TRANSACTION_SUCCESS`,
  TRANSACTION_FAILURE: `${actionsPrefix}/TRANSACTION_FAILURE`,
  OPTIMISTIC_ADDED: `${actionsPrefix}/OPTIMISTIC_ADDED`,
  OPTIMISTIC_MODIFIED: `${actionsPrefix}/OPTIMISTIC_MODIFIED`,
  OPTIMISTIC_REMOVED: `${actionsPrefix}/OPTIMISTIC_REMOVED`,
  MUTATE_START: `${actionsPrefix}/MUTATE_START`,
  MUTATE_SUCCESS: `${actionsPrefix}/MUTATE_SUCCESS`,
  MUTATE_FAILURE: `${actionsPrefix}/MUTATE_FAILURE`,
};

/**
 * @constant
 * @type {object}
 * @name defaultConfig
 * @description Default configuration options
 * @property {boolean} logListenerError - `true` Whether or not to use
 * console.error to log listener error objects. Errors from listeners
 * are helpful to developers on multiple occasions including when index
 * needs to be added.
 * @property {object} preserveOnDelete - `null` Values to
 * preserve from state when DELETE_SUCCESS action is dispatched. Note that this
 * will not prevent the LISTENER_RESPONSE action from removing items from
 * state.ordered if you have a listener attached.
 * @property {object} preserveOnListenerError - `null` Values to
 * preserve from state when LISTENER_ERROR action is dispatched.
 * @property {boolean} preserveCacheAfterUnset - `true` Indicates whether to
 * preserve or remove the cache data from the store after a listener is unset.
 * @property {boolean} enhancerNamespace - `'firestore'` Namespace under which
 * enhancer places internal instance on redux store (i.e. store.firestore).
 * @property {boolean|Function} allowMultipleListeners - `false` Whether or not
 * to allow multiple listeners to be attached for the same query. If a function
 * is passed the arguments it receives are `listenerToAttach`,
 * `currentListeners`, and the function should return a boolean.
 * @property {Function} onAttemptCollectionDelete - `null` (arguments:
 * `(queryOption, dispatch, firebase)`) Function run when attempting to delete
 * a collection. If not provided (default) delete promise will be rejected with
 * "Only documents can be deleted" unless. This is due to the fact that
 * Collections can not be deleted from a client, it should instead be handled
 * within a cloud function (which can be called by providing a promise
 * to `onAttemptCollectionDelete` that calls the cloud function).
 * @type {object}
 */
export const defaultConfig = {
  logListenerError: true,
  enhancerNamespace: 'firestore',
  helpersNamespace: null,
  allowMultipleListeners: false,
  preserveOnDelete: null,
  preserveOnListenerError: null,
  preserveCacheAfterUnset: true,
  onAttemptCollectionDelete: null,
  mergeOrdered: true,
  mergeOrderedDocUpdates: true,
  mergeOrderedCollectionUpdates: true,
  globalDataConverter: null,
  userProfile: 'users',
  useFirestoreForProfile: true,
};

export const methodsToAddFromFirestore = [
  'collection',
  'collectionGroup',
  'configureClient',
  'doc',
  'batch',
  'disableNetwork',
  'enableNetwork',
  'enablePersistence',
  'ensureClientConfigured',
  'setLogLevel',
  'settings',
  'mutate',
];

export default {
  actionsPrefix,
  actionTypes,
  defaultConfig,
};