Source: registry.js

  1. /**
  2.  * Internal. This is the core of react-cmf.
  3.  * The registry will register everything from a react component to redux action.
  4.  * @module react-cmf/lib/registry
  5.  */
  6. /* eslint no-underscore-dangle: ["error", {"allow": ["_registry", "_isLocked"] }] */
  8. /**
  9.  * @typedef {Object<string, *>} Registry
  10.  */
  12. /**
  13.  * The registry that will have the singleton
  14.  * - getRegistry() -> the registry which is a simple key/value POJO
  15.  * @type {Registry}
  16.  */
  17. const Registry = {
  18. 	_registry: {},
  19. 	_isLocked: false,
  20. 	getRegistry() {
  21. 		return this._registry;
  22. 	},
  23. 	lock() {
  24. 		this._isLocked = true;
  25. 	},
  26. 	isLocked() {
  27. 		return this._isLocked;
  28. 	},
  29. };
  31. /**
  32.  * Returns the global registry if no context found. If count is found it returns
  33.  * the context.registry
  34.  * @param {object} context React context
  35.  * @return {Registry} the registry singleton instance
  36.  */
  37. function getRegistry(context) {
  38. 	if (context && context.registry) {
  39. 		return context.registry;
  40. 	}
  41. 	return Registry.getRegistry();
  42. }
  44. /**
  45.  * Internal. Call this one to add anything you want into the registry.
  46.  * It will be added only if not locked.
  47.  * Be warned any existing content will be overridden.
  48.  * You should use this to add a new configurable concept to CMF.
  49.  * By default it's internally used to register expression, component and actionCreator
  50.  * @param {string} id Where you want it to store in the registry to get it later
  51.  * @param {any} item Everything you want, a function, an object or whatever
  52.  */
  53. function addToRegistry(id, item, context) {
  54. 	if (Registry.isLocked()) {
  55. 		throw new Error(
  56. 			`CMF: The registry is locked, you cannot therefore add '${id}' in it. ` +
  57. 				'Please check your CMF configuration, it should not move after the initial ' +
  58. 				'configuration before bootstrap.',
  59. 		);
  60. 	}
  62. 	const registry = getRegistry(context);
  63. 	if (registry[id]) {
  64. 		// eslint-disable-next-line no-console
  65. 		console.warn(
  66. 			`CMF: The '${id}' object is registered, overriding an existing '${id}' object. ` +
  67. 				'Please check your CMF configuration, you might not want that.',
  68. 		);
  69. 	}
  70. 	if (item === undefined) {
  71. 		throw new Error(
  72. 			`CMF: you can't register undefined in '${id}'.
  73. 			You may have an import error in your configuration`,
  74. 		);
  75. 	}
  76. 	registry[id] = item;
  77. }
  79. /**
  80.  * Internal: return element registred under the ID.
  81.  * @param  {string} id the object's id in the registry you want to get
  82.  * @param  {object} context cmf context
  83.  * @return {any}    the object you are looking for
  84.  */
  85. function getFromRegistry(id, context) {
  86. 	return getRegistry(context)[id];
  87. }
  89. /**
  90.  * This function is a curry that return a generic function to register components in registry
  91.  * @param {function} registerFn a function that register a item in the registry
  92.  */
  93. function getRegisterMany(registerFn) {
  94. 	return (itemsToRegister, context) => {
  95. 		Object.keys(itemsToRegister).forEach(key => {
  96. 			registerFn(key, itemsToRegister[key], context);
  97. 		});
  98. 	};
  99. }
  101. const registerMany = getRegisterMany(addToRegistry);
  103. /**
  104.  * Lock the registry
  105.  */
  106. function lock() {
  107. 	Registry.lock();
  108. }
  110. export default {
  111. 	Registry,
  112. 	addToRegistry,
  113. 	getRegistry,
  114. 	getFromRegistry,
  115. 	getRegisterMany,
  116. 	lock,
  117. 	registerMany,
  118. };