@civet/events 2.0.4 → 3.0.1

package/dist/eventPlugin.d.ts

@@ -0,0 +1,21 @@
+import { GenericDataProviderImplementation } from '@civet/core';
+import { GenericEventReceiver, InferEvent, InferOptions } from './EventReceiver';
+type EventProps<EventReceiverI extends GenericEventReceiver, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>> = {
+    events?: {
+        /** EventReceiver to be used */
+        eventReceiver?: EventReceiverI;
+        /** Disables the event handler */
+        disabled?: boolean;
+        /** Options for the EventReceiver */
+        options?: OptionsI;
+        /** Callback to filter events and handle your own event logic - if true is returned, the event does not cause the resource to update */
+        onEvent?: (event: EventI) => boolean;
+        /** Provides information on when the resource has been requested to update - events contains the events that lead to the update */
+        onNotify?: (next: {
+            request: string;
+            revision: string;
+        }, events: EventI[]) => void;
+    } | boolean;
+};
+declare const eventPlugin: import('@civet/core').DataProviderPlugin<GenericDataProviderImplementation, unknown, EventProps<GenericEventReceiver, unknown, unknown>, unknown, unknown, unknown>;
+export default eventPlugin;

package/dist/main.d.ts

@@ -2,6 +2,7 @@ import { ConfigConsumer, useConfigContext } from './context';
 export { default as composeHandlers } from './composeHandlers';
 export { default as ConfigProvider } from './ConfigProvider';
 export { default as EventHandler } from './EventHandler';
+export { default as eventPlugin } from './eventPlugin';
 export { default as EventReceiver, isEventReceiver } from './EventReceiver';
 export type { EventReceiverImplementation, GenericEventReceiver, InferEvent, InferOptions, InferResource, } from './EventReceiver';
 export { default as useEventHandler } from './useEventHandler';

package/dist/main.js

@@ -1,124 +1,136 @@
-import { createContext as R, useContext as j, useMemo as q, useState as y, useEffect as S } from "react";
-import { jsx as C, Fragment as w } from "react/jsx-runtime";
-import { useResourceContext as D } from "@civet/core";
-const l = R({});
+import { createContext as j, useContext as q, useMemo as D, useState as y, useEffect as S } from "react";
+import { jsx as b, Fragment as w } from "react/jsx-runtime";
+import { useResourceContext as P, createPlugin as _ } from "@civet/core";
+const l = j({});
 l.displayName = "Events.ConfigContext";
-const J = l.Consumer, _ = () => j(l);
-function K(...r) {
-  return (...e) => r.reduce(
-    (t, n) => t || (typeof n == "function" ? n(...e) : !1),
+const K = l.Consumer, F = () => q(l);
+function L(...o) {
+  return (...e) => o.reduce(
+    (t, r) => t || (typeof r == "function" ? r(...e) : !1),
     !1
   );
 }
-class F {
+class H {
   _inferResource;
   _inferEvent;
   _inferOptions;
-  subscribe(e, t, n) {
-    if (typeof n != "function")
+  subscribe(e, t, r) {
+    if (typeof r != "function")
       throw new Error("Handler must be a function");
-    const o = this.handleSubscribe(
+    const n = this.handleSubscribe(
       e,
       t,
-      n
+      r
     );
-    return typeof o != "function" && console.warn(
+    return typeof n != "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."
-    ), o;
+    ), n;
   }
 }
-const L = (r) => r instanceof F;
-function Q({
-  eventReceiver: r,
+const Q = (o) => o instanceof H;
+function T({
+  eventReceiver: o,
   children: e
 }) {
-  const t = q(() => ({ eventReceiver: r }), [r]);
-  return /* @__PURE__ */ C(l.Provider, { value: t, children: e });
+  const t = D(() => ({ eventReceiver: o }), [o]);
+  return /* @__PURE__ */ b(l.Provider, { value: t, children: e });
 }
-function H(r) {
-  return r && r.__esModule && Object.prototype.hasOwnProperty.call(r, "default") ? r.default : r;
+function A(o) {
+  return o && o.__esModule && Object.prototype.hasOwnProperty.call(o, "default") ? o.default : o;
 }
-var d, E;
-function A() {
-  return E || (E = 1, d = function r(e, t) {
+var g, E;
+function M() {
+  return E || (E = 1, g = function o(e, t) {
     if (e === t) return !0;
     if (e && t && typeof e == "object" && typeof t == "object") {
       if (e.constructor !== t.constructor) return !1;
-      var n, o, s;
+      var r, n, s;
       if (Array.isArray(e)) {
-        if (n = e.length, n != t.length) return !1;
-        for (o = n; o-- !== 0; )
-          if (!r(e[o], t[o])) return !1;
+        if (r = e.length, r != t.length) return !1;
+        for (n = r; n-- !== 0; )
+          if (!o(e[n], t[n])) return !1;
         return !0;
       }
       if (e.constructor === RegExp) return e.source === t.source && e.flags === t.flags;
       if (e.valueOf !== Object.prototype.valueOf) return e.valueOf() === t.valueOf();
       if (e.toString !== Object.prototype.toString) return e.toString() === t.toString();
-      if (s = Object.keys(e), n = s.length, n !== Object.keys(t).length) return !1;
-      for (o = n; o-- !== 0; )
-        if (!Object.prototype.hasOwnProperty.call(t, s[o])) return !1;
-      for (o = n; o-- !== 0; ) {
-        var u = s[o];
-        if (!r(e[u], t[u])) return !1;
+      if (s = Object.keys(e), r = s.length, r !== Object.keys(t).length) return !1;
+      for (n = r; n-- !== 0; )
+        if (!Object.prototype.hasOwnProperty.call(t, s[n])) return !1;
+      for (n = r; n-- !== 0; ) {
+        var u = s[n];
+        if (!o(e[u], t[u])) return !1;
       }
       return !0;
     }
     return e !== e && t !== t;
-  }), d;
+  }), g;
 }
-var M = A();
-const P = /* @__PURE__ */ H(M);
-function B({
-  eventReceiver: r,
+var B = M();
+const I = /* @__PURE__ */ A(B);
+function C({
+  eventReceiver: o,
   resource: e,
   disabled: t,
-  options: n,
-  onEvent: o,
+  options: r,
+  onEvent: n,
   onNotify: s
 }) {
-  const u = _(), a = r || u.eventReceiver, O = D(), f = e || O, [c, b] = y(f);
-  f?.request !== c?.request && b(f);
-  const [p, h] = y(n);
-  P(p, n) || h(n);
-  const g = !!(t || f?.isEmpty);
-  S(() => a == null || g ? void 0 : a.subscribe(
+  const u = F(), a = o || u.eventReceiver, O = P(), f = e || O, [c, h] = y(f);
+  f?.request !== c?.request && h(f);
+  const [p, x] = y(r);
+  I(p, r) || x(r);
+  const m = !!(t || f?.isDisabled);
+  S(() => a == null || m ? void 0 : a.subscribe(
     c,
     p,
     (v) => {
       if ((v?.length || 0) === 0) return;
       let i;
-      if (typeof o == "function" ? i = v.filter((m) => !o(m)) : i = v, i.length === 0 || typeof c?.notify != "function")
+      if (typeof n == "function" ? i = v.filter((d) => !n(d)) : i = v, i.length === 0 || typeof c?.notify != "function")
         return;
-      const x = c.notify();
-      typeof s == "function" && x.then((m) => s(m, i));
+      const R = c.notify();
+      typeof s == "function" && R.then((d) => s(d, i));
     }
-  ), [a, g, c, p, o, s]);
+  ), [a, m, c, p, n, s]);
 }
-function T({
-  eventReceiver: r,
+function U({
+  eventReceiver: o,
   resource: e,
   disabled: t,
-  options: n,
-  onEvent: o,
+  options: r,
+  onEvent: n,
   onNotify: s,
   children: u
 }) {
-  return B({
-    eventReceiver: r,
+  return C({
+    eventReceiver: o,
     resource: e,
     disabled: t,
-    options: n,
-    onEvent: o,
+    options: r,
+    onEvent: n,
     onNotify: s
-  }), /* @__PURE__ */ C(w, { children: u });
+  }), /* @__PURE__ */ b(w, { children: u });
 }
+const V = _(
+  (o) => class extends o {
+    extend(t) {
+      t.context(
+        (r, { events: n = !1 }) => (C(
+          typeof n == "boolean" ? { disabled: !n, resource: r } : { ...n, resource: r }
+        ), r)
+      );
+    }
+  }
+);
 export {
-  J as ConfigConsumer,
-  Q as ConfigProvider,
-  T as EventHandler,
-  F as EventReceiver,
-  K as composeHandlers,
-  L as isEventReceiver,
-  _ as useConfigContext,
-  B as useEventHandler
+  K as ConfigConsumer,
+  T as ConfigProvider,
+  U as EventHandler,
+  H as EventReceiver,
+  L as composeHandlers,
+  V as eventPlugin,
+  Q as isEventReceiver,
+  F as useConfigContext,
+  C as useEventHandler
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civet/events",
-  "version": "2.0.4",
+  "version": "3.0.1",
   "description": "Civet",
   "author": {
     "name": "Aaron Burmeister"
@@ -50,12 +50,12 @@
     "uuid": "^13.0.0"
   },
   "peerDependencies": {
-    "@civet/core": ">=2.0",
+    "@civet/core": ">=6.0",
     "react": ">=18.0",
     "react-dom": ">=18.0"
   },
   "devDependencies": {
-    "@civet/core": "^3.0.1",
+    "@civet/core": "^6.0.2",
     "@eslint/js": "^9.35.0",
     "@types/react": "^19.1.12",
     "@types/react-dom": "^19.1.9",
@@ -74,7 +74,7 @@
     "react": "^19.1.1",
     "react-dom": "^19.1.1",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.43.0",
+    "typescript-eslint": "^8.56.0",
     "vite": "^7.1.5",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^6.1.1"