@civet/events 1.0.2 → 1.1.1

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2019 Aaron Burmeister
+Copyright (c) 2024 Civet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/ConfigProvider.js

@@ -5,22 +5,22 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
-var _react = _interopRequireDefault(require("react"));
-var _context = require("./context");
 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["default"].createElement(_context.ConfigContext.Provider, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_context.ConfigContext.Provider, {
     value: {
       eventReceiver: eventReceiver
-    }
-  }, children);
+    },
+    children: children
+  });
 };
 ConfigProvider.propTypes = {
   eventReceiver: _EventReceiver.eventReceiverPropType,
   children: _propTypes["default"].node
 };
-var _default = ConfigProvider;
-exports["default"] = _default;
+var _default = exports["default"] = ConfigProvider;

package/lib/EventHandler.js

@@ -5,27 +5,43 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
-var _react = _interopRequireDefault(require("react"));
 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["default"].createElement(_react["default"].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
 };
-var _default = EventHandler;
-exports["default"] = _default;
+
+/**
+ * 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/EventReceiver.js

@@ -6,35 +6,30 @@ Object.defineProperty(exports, "__esModule", {
 exports.isEventReceiver = exports.eventReceiverPropType = exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 var EventReceiver = /*#__PURE__*/function () {
   function EventReceiver() {
     _classCallCheck(this, EventReceiver);
   }
-  _createClass(EventReceiver, [{
+  return _createClass(EventReceiver, [{
     key: "subscribe",
     value: function subscribe(resource, options, handler) {
       if (typeof handler !== 'function') throw new Error('Handler must be a function');
       var unsubscribe = this.handleSubscribe(resource, options, handler);
       if (typeof unsubscribe !== 'function') {
-        // eslint-disable-next-line no-console
         console.warn('EventReceiver.handleSubscribe should return a callback to cancel the subscription. Ignoring this warning may result in the execution of obsolete handlers and potential memory leaks.');
       }
       return unsubscribe;
     }
   }]);
-  return EventReceiver;
 }();
-var isEventReceiver = function isEventReceiver(eventReceiver) {
+var isEventReceiver = exports.isEventReceiver = function isEventReceiver(eventReceiver) {
   return eventReceiver instanceof EventReceiver;
 };
-exports.isEventReceiver = isEventReceiver;
-var eventReceiverPropType = _propTypes["default"].instanceOf(EventReceiver);
-exports.eventReceiverPropType = eventReceiverPropType;
-var _default = EventReceiver;
-exports["default"] = _default;
+var eventReceiverPropType = exports.eventReceiverPropType = _propTypes["default"].instanceOf(EventReceiver);
+var _default = exports["default"] = EventReceiver;

package/lib/composeHandlers.js

@@ -17,5 +17,4 @@ var composeHandlers = function composeHandlers() {
     }, false);
   };
 };
-var _default = composeHandlers;
-exports["default"] = _default;
+var _default = exports["default"] = composeHandlers;

package/lib/context.js

@@ -4,12 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useConfigContext = exports.ConfigContext = void 0;
-var _react = _interopRequireDefault(require("react"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-var ConfigContext = /*#__PURE__*/_react["default"].createContext({});
-exports.ConfigContext = ConfigContext;
+var _react = require("react");
+var ConfigContext = exports.ConfigContext = /*#__PURE__*/(0, _react.createContext)({});
 ConfigContext.displayName = 'Events.ConfigContext';
-var useConfigContext = function useConfigContext() {
-  return _react["default"].useContext(ConfigContext);
-};
-exports.useConfigContext = useConfigContext;
+var useConfigContext = exports.useConfigContext = function useConfigContext() {
+  return (0, _react.useContext)(ConfigContext);
+};

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -54,13 +54,12 @@ Object.defineProperty(exports, "useEventHandler", {
   }
 });
 var _context = require("./context");
-var _composeHandlers = _interopRequireDefault(require("./composeHandlers"));
 var _ConfigProvider = _interopRequireDefault(require("./ConfigProvider"));
 var _EventHandler = _interopRequireDefault(require("./EventHandler"));
 var _EventReceiver = _interopRequireWildcard(require("./EventReceiver"));
+var _composeHandlers = _interopRequireDefault(require("./composeHandlers"));
 var _useEventHandler = _interopRequireDefault(require("./useEventHandler"));
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-var ConfigConsumer = _context.ConfigContext.Consumer;
-exports.ConfigConsumer = ConfigConsumer;
+var ConfigConsumer = exports.ConfigConsumer = _context.ConfigContext.Consumer;

package/lib/useEventHandler.js

@@ -6,15 +6,22 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _core = require("@civet/core");
 var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
-var _react = _interopRequireDefault(require("react"));
+var _react = require("react");
 var _context = require("./context");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 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(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+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,
@@ -25,16 +32,24 @@ function useEventHandler(_ref) {
   var configContext = (0, _context.useConfigContext)();
   var eventReceiver = eventReceiverProp || configContext.eventReceiver;
   var resourceContext = (0, _core.useResourceContext)();
-  var resource = resourceProp || resourceContext;
-  var _React$useState = _react["default"].useState(optionsProp),
-    _React$useState2 = _slicedToArray(_React$useState, 2),
-    options = _React$useState2[0],
-    setOptions = _React$useState2[1];
+  var currentResource = resourceProp || resourceContext;
+  var _useState = (0, _react.useState)(currentResource),
+    _useState2 = _slicedToArray(_useState, 2),
+    resource = _useState2[0],
+    setResource = _useState2[1];
+  if ((currentResource === null || currentResource === void 0 ? void 0 : currentResource.request) !== (resource === null || resource === void 0 ? void 0 : resource.request)) {
+    setResource(currentResource);
+  }
+  var _useState3 = (0, _react.useState)(optionsProp),
+    _useState4 = _slicedToArray(_useState3, 2),
+    options = _useState4[0],
+    setOptions = _useState4[1];
   if (!(0, _fastDeepEqual["default"])(options, optionsProp)) {
     setOptions(optionsProp);
   }
-  _react["default"].useEffect(function () {
-    if (eventReceiver == null || disabled) return undefined;
+  var isDisabled = !!disabled;
+  (0, _react.useEffect)(function () {
+    if (eventReceiver == null || isDisabled) return undefined;
     var unsubscribe = eventReceiver.subscribe(resource, options, function (data) {
       if (((data === null || data === void 0 ? void 0 : data.length) || 0) === 0) return;
       var unhandledEvents;
@@ -54,7 +69,6 @@ function useEventHandler(_ref) {
       }
     });
     return unsubscribe;
-  }, [eventReceiver, !disabled, resource === null || resource === void 0 ? void 0 : resource.request, options, onEvent, onNotify]);
+  }, [eventReceiver, isDisabled, resource, options, onEvent, onNotify]);
 }
-var _default = useEventHandler;
-exports["default"] = _default;
+var _default = exports["default"] = useEventHandler;

package/package.json

@@ -1,22 +1,29 @@
 {
   "name": "@civet/events",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Civet",
   "main": "./lib/index.js",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./lib/index.js",
+      "default": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib",
+    "src"
+  ],
   "scripts": {
     "build:clean": "rimraf ./lib",
     "prebuild": "npm run build:clean",
-    "build": "cross-env BABEL_ENV=commonjs babel src --out-dir lib",
-    "lint": "eslint src",
+    "build": "babel src -d lib",
+    "lint": "eslint src --report-unused-disable-directives",
     "prepare": "npm run lint && npm run build",
     "preversion": "git diff HEAD --name-only --exit-code || (echo -\\> unclean working directory && exit 1)",
     "postversion": "cross-env git commit -am$npm_package_version",
     "prettify": "prettier --write src/**"
   },
-  "files": [
-    "lib",
-    "src"
-  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/civet-org/events.git"
@@ -34,32 +41,29 @@
   },
   "homepage": "https://civet.js.org/",
   "devDependencies": {
-    "@babel/cli": "^7.20.7",
-    "@babel/core": "^7.20.7",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/preset-env": "^7.20.2",
+    "@babel/cli": "^7.22.15",
+    "@babel/core": "^7.24.4",
+    "@babel/eslint-parser": "^7.22.15",
+    "@babel/preset-env": "^7.24.4",
     "@babel/preset-react": "^7.18.6",
-    "@civet/core": "^1.2.2",
-    "babel-eslint": "^10.1.0",
+    "@civet/core": "^1.3.0",
     "cross-env": "^7.0.3",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.24.1",
-    "eslint-plugin-jsx-a11y": "^6.6.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.31.11",
+    "eslint": "^8.53.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "prettier": "^2.8.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "prettier": "^3.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rimraf": "^3.0.2"
+    "rimraf": "^5.0.5"
   },
   "peerDependencies": {
-    "@civet/core": ">= 1.0.0",
-    "react": ">= 16.8",
-    "react-dom": ">= 16.8"
+    "@civet/core": ">=1.3.0",
+    "react": ">=18.0",
+    "react-dom": ">=18.0"
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",

package/src/{ConfigProvider.js → ConfigProvider.jsx}

@@ -1,8 +1,6 @@
 import PropTypes from 'prop-types';
-import React from 'react';
-
-import { ConfigContext } from './context';
 import { eventReceiverPropType } from './EventReceiver';
+import { ConfigContext } from './context';
 
 const ConfigProvider = ({ eventReceiver, children }) => (
   <ConfigContext.Provider value={{ eventReceiver }}>{children}</ConfigContext.Provider>

package/src/EventHandler.jsx

@@ -0,0 +1,36 @@
+import PropTypes from 'prop-types';
+import { eventReceiverPropType } from './EventReceiver';
+import useEventHandler from './useEventHandler';
+
+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/EventReceiver.js

@@ -5,7 +5,6 @@ class EventReceiver {
     if (typeof handler !== 'function') throw new Error('Handler must be a function');
     const unsubscribe = this.handleSubscribe(resource, options, handler);
     if (typeof unsubscribe !== 'function') {
-      // eslint-disable-next-line no-console
       console.warn(
         'EventReceiver.handleSubscribe should return a callback to cancel the subscription. Ignoring this warning may result in the execution of obsolete handlers and potential memory leaks.',
       );

package/src/context.js

@@ -1,5 +1,5 @@
-import React from 'react';
+import { createContext, useContext } from 'react';
 
-export const ConfigContext = React.createContext({});
+export const ConfigContext = createContext({});
 ConfigContext.displayName = 'Events.ConfigContext';
-export const useConfigContext = () => React.useContext(ConfigContext);
+export const useConfigContext = () => useContext(ConfigContext);

package/src/index.js

@@ -1,9 +1,9 @@
 import { ConfigContext, useConfigContext } from './context';
 
 export const { Consumer: ConfigConsumer } = ConfigContext;
-export { default as composeHandlers } from './composeHandlers';
 export { default as ConfigProvider } from './ConfigProvider';
 export { default as EventHandler } from './EventHandler';
 export { default as EventReceiver, eventReceiverPropType, isEventReceiver } from './EventReceiver';
+export { default as composeHandlers } from './composeHandlers';
 export { default as useEventHandler } from './useEventHandler';
 export { useConfigContext };

package/src/useEventHandler.js

@@ -1,30 +1,49 @@
 import { useResourceContext } from '@civet/core';
 import deepEquals from 'fast-deep-equal';
-import React from 'react';
-
+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();
   const eventReceiver = eventReceiverProp || configContext.eventReceiver;
 
   const resourceContext = useResourceContext();
-  const resource = resourceProp || resourceContext;
+  const currentResource = resourceProp || resourceContext;
+
+  const [resource, setResource] = useState(currentResource);
+  if (currentResource?.request !== resource?.request) {
+    setResource(currentResource);
+  }
 
-  const [options, setOptions] = React.useState(optionsProp);
+  const [options, setOptions] = useState(optionsProp);
   if (!deepEquals(options, optionsProp)) {
     setOptions(optionsProp);
   }
 
-  React.useEffect(() => {
-    if (eventReceiver == null || disabled) return undefined;
+  const isDisabled = !!disabled;
+
+  useEffect(() => {
+    if (eventReceiver == null || isDisabled) return undefined;
     const unsubscribe = eventReceiver.subscribe(resource, options, (data) => {
       if ((data?.length || 0) === 0) return;
       let unhandledEvents;
@@ -40,7 +59,7 @@ function useEventHandler({
       }
     });
     return unsubscribe;
-  }, [eventReceiver, !disabled, resource?.request, options, onEvent, onNotify]);
+  }, [eventReceiver, isDisabled, resource, options, onEvent, onNotify]);
 }
 
 export default useEventHandler;

package/src/EventHandler.js

@@ -1,23 +0,0 @@
-import PropTypes from 'prop-types';
-import React from 'react';
-
-import { eventReceiverPropType } from './EventReceiver';
-import useEventHandler from './useEventHandler';
-
-function EventHandler({ children, ...props }) {
-  useEventHandler(props);
-
-  return <>{children}</>;
-}
-
-EventHandler.propTypes = {
-  eventReceiver: eventReceiverPropType,
-  resource: PropTypes.object,
-  disabled: PropTypes.bool,
-  options: PropTypes.object,
-  onEvent: PropTypes.func,
-  onNotify: PropTypes.func,
-  children: PropTypes.node,
-};
-
-export default EventHandler;