Source: action.js

  1. import get from 'lodash/get';
  2. import deprecated from './deprecated';
  3. import actionCreatorAPI from './actionCreator';
  5. /**
  6.  * This module is DEPRECATED and will be removed in future version.
  7.  * it provide low level api to register and handle action in a CMF App.
  8.  * @module react-cmf/lib/action
  9.  * @see module:react-cmf/lib/Dispatcher
  10.  */
  12. /**
  13.  * get the global actions registered in the settings
  14.  * @param  {object} context
  15.  * @return {object} actions with key === action id
  16.  */
  17. function getActionsById(context) {
  18. 	const state = context.store.getState();
  19. 	return get(state, 'cmf.settings.actions', {});
  20. }
  22. /**
  23.  * return actions registered for a given content type
  24.  * @param  {object} context
  25.  * @param  {String} contentType
  26.  * @param  {String} category
  27.  * @return {Array} actions
  28.  */
  29. function getContentTypeActions(context, contentType, category) {
  30. 	const state = context.store.getState();
  31. 	return get(state, `cmf.settings.contentTypes[${contentType}.actions[${category}]`, []);
  32. }
  34. /**
  35.  * Return information available about this action
  36.  * @param  {object} context
  37.  * @param  {String} id
  38.  * @return {object}
  39.  */
  40. function getActionInfo(context, id) {
  41. 	const action = getActionsById(context)[id];
  42. 	if (!action) {
  43. 		throw new Error(`action not found id: ${id}`);
  44. 	}
  45. 	return { ...action };
  46. }
  48. /**
  49.  * Return the action object ready to be dispatched
  50.  * This is supposed to be used outside of content type
  51.  * @param  {object} context
  52.  * @param  {String|Object} action or the action
  53.  * @param  {object} event event which have trigger this action
  54.  * @param  {object} data data attached to the action
  55.  */
  56. function getActionObject(context, action, event, data) {
  57. 	let actionInfo;
  58. 	if (typeof action === 'string') {
  59. 		actionInfo = getActionInfo(context, action);
  60. 	} else {
  61. 		actionInfo = action;
  62. 	}
  63. 	if (actionInfo.actionCreator) {
  64. 		const actionCreator = actionCreatorAPI.get(context, actionInfo.actionCreator);
  65. 		return actionCreator(event, data, {
  66. 			store: context.store,
  67. 			getState: context.store.getState,
  68. 			registry: context.registry,
  69. 			actionInfo,
  70. 		});
  71. 	}
  72. 	return { ...actionInfo.payload, event, data, context };
  73. }
  75. /**
  76.  * return every props name that start with 'on'
  77.  * @param  {object} props react props
  78.  * @return {Array}       of string
  79.  */
  80. function getOnProps(props) {
  81. 	return Object.keys(props).filter(
  82. 		name => ({}).hasOwnProperty.call(props, name) && /^on.+/.test(name),
  83. 	);
  84. }
  86. /**
  87.  * create a map dispatchable action function expecting event object, props, and context information
  88.  * merge this map with non event properties
  89.  * @param  {Function} dispatch the dispatch function
  90.  * @param  {object} props    props object containing maybe on(event) with string
  91.  *                           or action creator function]
  92.  * @return {object}          the connected object
  93.  * @throws if an action is unknown in configuration, throw
  94.  */
  95. function mapDispatchToProps(dispatch, props) {
  96. 	const resolvedActions = {};
  97. 	getOnProps(props).forEach(name => {
  98. 		resolvedActions[name] = (event, data, context) => {
  99. 			let action = props[name];
  100. 			if (typeof action === 'string') {
  101. 				action = getActionObject(context, action, event, data);
  102. 			}
  103. 			dispatch(action);
  104. 		};
  105. 	});
  106. 	return { ...props, ...resolvedActions };
  107. }
  109. const registerActionCreator = deprecated(
  110. 	(id, actionCreator, context) => actionCreatorAPI.register(id, actionCreator, context),
  111. 	'stop use cmf.action.registerActionCreator. please use cmf.actionCreator.register',
  112. );
  114. const getActionCreatorFunction = deprecated(
  115. 	(context, id) => actionCreatorAPI.get(context, id),
  116. 	'stop use cmf.action.getActionCreatorFunction. please use cmf.actionCreator.get',
  117. );
  119. export default {
  120. 	getActionsById,
  121. 	getActionCreatorFunction,
  122. 	getActionInfo,
  123. 	getActionObject,
  124. 	getContentTypeActions,
  125. 	getOnProps,
  126. 	mapDispatchToProps,
  127. 	registerActionCreator,
  128. };