@civet/events 1.1.0 → 1.1.1

package/lib/ConfigProvider.js

@@ -7,15 +7,17 @@ exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _EventReceiver = require("./EventReceiver");
 var _context = require("./context");
+var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 var ConfigProvider = function ConfigProvider(_ref) {
   var eventReceiver = _ref.eventReceiver,
     children = _ref.children;
-  return /*#__PURE__*/React.createElement(_context.ConfigContext.Provider, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_context.ConfigContext.Provider, {
     value: {
       eventReceiver: eventReceiver
-    }
-  }, children);
+    },
+    children: children
+  });
 };
 ConfigProvider.propTypes = {
   eventReceiver: _EventReceiver.eventReceiverPropType,

package/lib/EventHandler.js

@@ -7,23 +7,41 @@ exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _EventReceiver = require("./EventReceiver");
 var _useEventHandler = _interopRequireDefault(require("./useEventHandler"));
+var _jsxRuntime = require("react/jsx-runtime");
 var _excluded = ["children"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-function EventHandler(_ref) {
-  var children = _ref.children,
-    props = _objectWithoutProperties(_ref, _excluded);
-  (0, _useEventHandler["default"])(props);
-  return /*#__PURE__*/React.createElement(React.Fragment, null, children);
-}
-EventHandler.propTypes = {
+var propTypes = {
+  /** EventReceiver to be used */
   eventReceiver: _EventReceiver.eventReceiverPropType,
+  /** ResourceContext to be used */
   resource: _propTypes["default"].object,
+  /** Disables the event handler */
   disabled: _propTypes["default"].bool,
+  /** Options for the EventReceiver */
   options: _propTypes["default"].object,
+  /** Callback to filter events and handle your own event logic - if true is returned, the event does not cause the resource to update */
   onEvent: _propTypes["default"].func,
+  /** Provides information on when the resource has been requested to update - events contains the events that lead to the update */
   onNotify: _propTypes["default"].func,
   children: _propTypes["default"].node
 };
+
+/**
+ * Enables automatic updating for a Resource component or useResource hook by subscribing to an EventReceiver.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext and ResourceContext.
+ *
+ * onEvent can be used to directly access events allowing you to add custom event logic to your components.
+ */
+function EventHandler(_ref) {
+  var children = _ref.children,
+    props = _objectWithoutProperties(_ref, _excluded);
+  (0, _useEventHandler["default"])(props);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+    children: children
+  });
+}
+EventHandler.propTypes = propTypes;
 var _default = exports["default"] = EventHandler;

package/lib/useEventHandler.js

@@ -15,6 +15,13 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+/**
+ * Enables automatic updating for a Resource component or useResource hook by subscribing to an EventReceiver.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext and ResourceContext.
+ *
+ * onEvent can be used to directly access events allowing you to add custom event logic to your components.
+ */
 function useEventHandler(_ref) {
   var eventReceiverProp = _ref.eventReceiver,
     resourceProp = _ref.resource,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civet/events",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Civet",
   "main": "./lib/index.js",
   "exports": {

package/src/EventHandler.jsx

@@ -2,20 +2,35 @@ import PropTypes from 'prop-types';
 import { eventReceiverPropType } from './EventReceiver';
 import useEventHandler from './useEventHandler';
 
-function EventHandler({ children, ...props }) {
-  useEventHandler(props);
-
-  return <>{children}</>;
-}
-
-EventHandler.propTypes = {
+const propTypes = {
+  /** EventReceiver to be used */
   eventReceiver: eventReceiverPropType,
+  /** ResourceContext to be used */
   resource: PropTypes.object,
+  /** Disables the event handler */
   disabled: PropTypes.bool,
+  /** Options for the EventReceiver */
   options: PropTypes.object,
+  /** Callback to filter events and handle your own event logic - if true is returned, the event does not cause the resource to update */
   onEvent: PropTypes.func,
+  /** Provides information on when the resource has been requested to update - events contains the events that lead to the update */
   onNotify: PropTypes.func,
   children: PropTypes.node,
 };
 
+/**
+ * Enables automatic updating for a Resource component or useResource hook by subscribing to an EventReceiver.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext and ResourceContext.
+ *
+ * onEvent can be used to directly access events allowing you to add custom event logic to your components.
+ */
+function EventHandler({ children, ...props }) {
+  useEventHandler(props);
+
+  return <>{children}</>;
+}
+
+EventHandler.propTypes = propTypes;
+
 export default EventHandler;

package/src/useEventHandler.js

@@ -3,12 +3,25 @@ import deepEquals from 'fast-deep-equal';
 import { useEffect, useState } from 'react';
 import { useConfigContext } from './context';
 
+/**
+ * Enables automatic updating for a Resource component or useResource hook by subscribing to an EventReceiver.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext and ResourceContext.
+ *
+ * onEvent can be used to directly access events allowing you to add custom event logic to your components.
+ */
 function useEventHandler({
+  /** EventReceiver to be used */
   eventReceiver: eventReceiverProp,
+  /** ResourceContext to be used */
   resource: resourceProp,
+  /** Disables the event handler */
   disabled,
+  /** Options for the EventReceiver */
   options: optionsProp,
+  /** Callback to filter events and handle your own event logic - if true is returned, the event does not cause the resource to update */
   onEvent,
+  /** Provides information on when the resource has been requested to update - events contains the events that lead to the update */
   onNotify,
 }) {
   const configContext = useConfigContext();