@civet/events 1.1.0 → 1.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Civet
+Copyright (c) 2025 Aaron Burmeister
 
 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

@@ -7,15 +7,17 @@ exports["default"] = void 0;
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _EventReceiver = require("./EventReceiver");
 var _context = require("./context");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 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 = {
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+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/EventReceiver.js

@@ -5,11 +5,11 @@ 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 _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
 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 () {
@@ -19,7 +19,9 @@ var EventReceiver = /*#__PURE__*/function () {
   return _createClass(EventReceiver, [{
     key: "subscribe",
     value: function subscribe(resource, options, handler) {
-      if (typeof handler !== 'function') throw new Error('Handler must be a function');
+      if (typeof handler !== 'function') {
+        throw new Error('Handler must be a function');
+      }
       var unsubscribe = this.handleSubscribe(resource, options, handler);
       if (typeof unsubscribe !== 'function') {
         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/lib/index.js

@@ -61,5 +61,5 @@ var _composeHandlers = _interopRequireDefault(require("./composeHandlers"));
 var _useEventHandler = _interopRequireDefault(require("./useEventHandler"));
 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 }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 var ConfigConsumer = exports.ConfigConsumer = _context.ConfigContext.Consumer;

package/lib/useEventHandler.js

@@ -8,13 +8,20 @@ var _core = require("@civet/core");
 var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
 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 _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _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 _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 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; }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+/**
+ * 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,
@@ -40,7 +47,7 @@ function useEventHandler(_ref) {
   if (!(0, _fastDeepEqual["default"])(options, optionsProp)) {
     setOptions(optionsProp);
   }
-  var isDisabled = !!disabled;
+  var isDisabled = Boolean(disabled || (currentResource === null || currentResource === void 0 ? void 0 : currentResource.isEmpty));
   (0, _react.useEffect)(function () {
     if (eventReceiver == null || isDisabled) return undefined;
     var unsubscribe = eventReceiver.subscribe(resource, options, function (data) {
@@ -53,7 +60,9 @@ function useEventHandler(_ref) {
       } else {
         unhandledEvents = data;
       }
-      if (unhandledEvents.length === 0 || typeof (resource === null || resource === void 0 ? void 0 : resource.notify) !== 'function') return;
+      if (unhandledEvents.length === 0 || typeof (resource === null || resource === void 0 ? void 0 : resource.notify) !== 'function') {
+        return;
+      }
       var promise = resource.notify();
       if (typeof onNotify === 'function') {
         promise.then(function (result) {

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@civet/events",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Civet",
+  "type": "module",
   "main": "./lib/index.js",
   "exports": {
     ".": {
@@ -15,14 +16,14 @@
     "src"
   ],
   "scripts": {
-    "build:clean": "rimraf ./lib",
     "prebuild": "npm run build:clean",
+    "build:clean": "rimraf ./lib",
     "build": "babel src -d lib",
-    "lint": "eslint src --report-unused-disable-directives",
+    "lint": "eslint",
     "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/**"
+    "prettify": "prettier . --write"
   },
   "repository": {
     "type": "git",
@@ -40,33 +41,35 @@
     "url": "https://github.com/civet-org/events/issues"
   },
   "homepage": "https://civet.js.org/",
-  "devDependencies": {
-    "@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.3.0",
-    "cross-env": "^7.0.3",
-    "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",
-    "eslint-plugin-unused-imports": "^3.0.0",
-    "prettier": "^3.2.5",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rimraf": "^5.0.5"
+  "dependencies": {
+    "fast-deep-equal": "^3.1.3",
+    "prop-types": "^15.8.1"
   },
   "peerDependencies": {
     "@civet/core": ">=1.3.0",
     "react": ">=18.0",
     "react-dom": ">=18.0"
   },
-  "dependencies": {
-    "fast-deep-equal": "^3.1.3",
-    "prop-types": "^15.8.1"
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.10",
+    "@babel/eslint-parser": "^7.26.10",
+    "@babel/preset-env": "^7.26.9",
+    "@babel/preset-react": "^7.26.3",
+    "@civet/core": "^1.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.20.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-react": "^7.37.4",
+    "eslint-plugin-react-hooks": "^5.2.0-canary-8759c5c8-20250207",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "^16.0.0",
+    "prettier": "^3.5.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "rimraf": "^6.0.1"
   }
 }

package/src/ConfigProvider.jsx

@@ -3,7 +3,9 @@ import { eventReceiverPropType } from './EventReceiver';
 import { ConfigContext } from './context';
 
 const ConfigProvider = ({ eventReceiver, children }) => (
-  <ConfigContext.Provider value={{ eventReceiver }}>{children}</ConfigContext.Provider>
+  <ConfigContext.Provider value={{ eventReceiver }}>
+    {children}
+  </ConfigContext.Provider>
 );
 
 ConfigProvider.propTypes = {

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/EventReceiver.js

@@ -2,7 +2,9 @@ import PropTypes from 'prop-types';
 
 class EventReceiver {
   subscribe(resource, options, handler) {
-    if (typeof handler !== 'function') throw new Error('Handler must be a function');
+    if (typeof handler !== 'function') {
+      throw new Error('Handler must be a function');
+    }
     const unsubscribe = this.handleSubscribe(resource, options, handler);
     if (typeof unsubscribe !== 'function') {
       console.warn(
@@ -13,7 +15,8 @@ class EventReceiver {
   }
 }
 
-const isEventReceiver = (eventReceiver) => eventReceiver instanceof EventReceiver;
+const isEventReceiver = (eventReceiver) =>
+  eventReceiver instanceof EventReceiver;
 
 const eventReceiverPropType = PropTypes.instanceOf(EventReceiver);
 

package/src/composeHandlers.js

@@ -2,7 +2,8 @@ const composeHandlers =
   (...handlers) =>
   (...args) =>
     handlers.reduce(
-      (sum, handler) => sum || (typeof handler === 'function' ? handler(...args) : false),
+      (sum, handler) =>
+        sum || (typeof handler === 'function' ? handler(...args) : false),
       false,
     );
 

package/src/index.js

@@ -3,7 +3,11 @@ import { ConfigContext, useConfigContext } from './context';
 export const { Consumer: ConfigConsumer } = ConfigContext;
 export { default as ConfigProvider } from './ConfigProvider';
 export { default as EventHandler } from './EventHandler';
-export { default as EventReceiver, eventReceiverPropType, isEventReceiver } from './EventReceiver';
+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

@@ -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();
@@ -27,7 +40,7 @@ function useEventHandler({
     setOptions(optionsProp);
   }
 
-  const isDisabled = !!disabled;
+  const isDisabled = Boolean(disabled || currentResource?.isEmpty);
 
   useEffect(() => {
     if (eventReceiver == null || isDisabled) return undefined;
@@ -39,7 +52,12 @@ function useEventHandler({
       } else {
         unhandledEvents = data;
       }
-      if (unhandledEvents.length === 0 || typeof resource?.notify !== 'function') return;
+      if (
+        unhandledEvents.length === 0 ||
+        typeof resource?.notify !== 'function'
+      ) {
+        return;
+      }
       const promise = resource.notify();
       if (typeof onNotify === 'function') {
         promise.then((result) => onNotify(result, unhandledEvents));