Source: actions/componentsActions.js

  1. /**
  2.  * @module react-cmf/lib/actions/componentsActions
  3.  */
  4. import curry from 'lodash/curry';
  5. import CONSTANTS from '../constant';
  7. // keep backward compatibility
  8. export const { COMPONENT_ADD_STATE, COMPONENT_MERGE_STATE, COMPONENT_REMOVE_STATE } = CONSTANTS;
  10. /**
  11.  * add a new component state with optional initialComponentState to the store
  12.  *
  13.  * @param {string} componentName : name of the component
  14.  * @param {string} key : identifier of state used by this component
  15.  * @param {object} initialComponentState : initial state of the component if required
  16.  *
  17.  * @throw if a component with this componentName associated to this key already exist
  18.  */
  19. export function addState(componentName, key, initialComponentState) {
  20. 	return {
  21. 		type: CONSTANTS.COMPONENT_ADD_STATE,
  22. 		componentName,
  23. 		key,
  24. 		initialComponentState,
  25. 	};
  26. }
  28. /**
  29.  * Merge new component state into actual component state in the store
  30.  * curried function
  31.  * @param {string} componentName : name of the component
  32.  * @param {string} key : identifier of state used by this component
  33.  * @param {object} componentState	: initial state of the component if required
  34.  *
  35.  * @throw if no componentName associated with this collectionId exist
  36.  */
  37. export const mergeState = curry((componentName, key, componentState) => ({
  38. 	type: CONSTANTS.COMPONENT_MERGE_STATE,
  39. 	componentName,
  40. 	key,
  41. 	componentState,
  42. }));
  44. /**
  45.  * Remove component state from the store
  46.  * curried function
  47.  * @param {string} componentName : name of the component
  48.  * @param {string} key	: identifier of collection used by the component
  49.  *
  50.  * @throw if no componentName associated with this collectionId exist
  51.  */
  52. export const removeState = curry((componentName, key) => ({
  53. 	type: CONSTANTS.COMPONENT_REMOVE_STATE,
  54. 	componentName,
  55. 	key,
  56. }));
  58. // backward compatbility
  59. export const addComponentState = addState;
  60. export const removeComponentState = removeState;
  61. export const mergeComponentState = mergeState;