Source: actions/collectionsActions.js

  1. /**
  2.  * @module react-cmf/lib/actions/collectionsActions
  3.  */
  4. import curry from 'lodash/curry';
  5. import CONSTANTS from '../constant';
  7. // keep backward compatibility
  8. export const { COLLECTION_ADD_OR_REPLACE, COLLECTION_REMOVE, COLLECTION_MUTATE } = CONSTANTS;
  10. /**
  11.  * Add or replace collection data in store
  12.  * curried function
  13.  * @param {string | Array<string>} collectionId - path to collection
  14.  * @param {any} data element that represent business data
  15.  */
  16. export const addOrReplace = curry((collectionId, data) => ({
  17. 	type: CONSTANTS.COLLECTION_ADD_OR_REPLACE,
  18. 	collectionId,
  19. 	data,
  20. }));
  22. /**
  23.  * Remove collection data in store to free space
  24.  * @param {string | Array<string>} collectionId - path to collection
  25.  *
  26.  * @throws if you try to remove non existent collection
  27.  */
  28. export function remove(collectionId) {
  29. 	return {
  30. 		type: CONSTANTS.COLLECTION_REMOVE,
  31. 		collectionId,
  32. 	};
  33. }
  35. /**
  36.  * mutateCollection let's you apply operations on a given collection
  37.  * curried function
  38.  * @param {string | Array<string>} collectionId - path to collection
  39.  * @param {object} operations operations to be applied on the collection
  40.  * {
  41.  * 		add: [],
  42.  * 		update: {},
  43.  * 		delete: []
  44.  * }
  45.  */
  46. export const mutate = curry((id, operations) => ({
  47. 	type: CONSTANTS.COLLECTION_MUTATE,
  48. 	id,
  49. 	operations,
  50. }));
  52. // backward compatibility
  53. export const addOrReplaceCollection = addOrReplace;
  54. export const mutateCollection = mutate;
  55. export const removeCollection = remove;