@civet/events 4.1.1 → 4.1.3

package/dist/EventHandler.d.ts

@@ -1,5 +1,6 @@
-import { ReactNode } from 'react';
+import { PropsWithChildren } from 'react';
 import { GenericEventReceiver, InferEvent, InferOptions, InferResource } from './EventReceiver';
+import { EventProps } from './useEventHandler';
 /**
  * Enables automatic updating for a Resource component or useResource hook by subscribing to an EventReceiver.
  *
@@ -7,21 +8,4 @@ import { GenericEventReceiver, InferEvent, InferOptions, InferResource } from '.
  *
  * onEvent can be used to directly access events allowing you to add custom event logic to your components.
  */
-export default function EventHandler<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>>({ eventReceiver, resource, disabled, options, onEvent, onNotify, children, }: {
-    /** EventReceiver to be used */
-    eventReceiver?: EventReceiverI;
-    /** ResourceContext to be used */
-    resource?: ResourceI;
-    /** 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;
-    children?: ReactNode;
-}): import("react/jsx-runtime").JSX.Element;
+export default function EventHandler<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>>({ eventReceiver, resource, disabled, options, onEvent, onNotify, children, }: PropsWithChildren<EventProps<EventReceiverI, EventI, ResourceI, OptionsI>>): import("react/jsx-runtime").JSX.Element;

package/dist/eventPlugin.d.ts

@@ -1,21 +1,8 @@
 import { GenericDataProviderImplementation } from '@civet/core';
-import { GenericEventReceiver, InferEvent, InferOptions } from './EventReceiver';
-type EventProps<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<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;
+import { GenericEventReceiver, InferEvent, InferOptions, InferResource } from './EventReceiver';
+import { EventProps } from './useEventHandler';
+type EventPluginContextProps = {
+    events?: Omit<EventProps<GenericEventReceiver, InferEvent<GenericEventReceiver>, InferResource<GenericEventReceiver>, InferOptions<GenericEventReceiver>>, 'resource'> | boolean;
 };
-declare const eventPlugin: import('@civet/core').DataProviderPlugin<GenericDataProviderImplementation, unknown, EventProps<GenericEventReceiver, unknown, unknown>, unknown, unknown, unknown>;
+declare const eventPlugin: import('@civet/core').DataProviderPlugin<GenericDataProviderImplementation, unknown, EventPluginContextProps, unknown, unknown, unknown>;
 export default eventPlugin;

package/dist/main.js

@@ -138,7 +138,7 @@ function Z({
 const $ = I(
   (o) => class extends o {
     extend(t) {
-      t.context(
+      super.extend(t), t.context(
         (r, { events: n = !1 }) => (w(
           typeof n == "boolean" ? { disabled: !n, resource: r } : { ...n, resource: r }
         ), r)

package/dist/useEventHandler.d.ts

@@ -1,12 +1,5 @@
 import { GenericEventReceiver, InferEvent, InferOptions, InferResource } from './EventReceiver';
-/**
- * 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.
- */
-export default function useEventHandler<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>>({ eventReceiver: eventReceiverProp, resource: resourceProp, disabled, options: optionsProp, onEvent, onNotify, }: {
+export type EventProps<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>> = {
     /** EventReceiver to be used */
     eventReceiver?: EventReceiverI;
     /** ResourceContext to be used */
@@ -22,4 +15,12 @@ export default function useEventHandler<EventReceiverI extends GenericEventRecei
         request: string;
         revision: string;
     }, events: EventI[]) => void;
-}): void;
+};
+/**
+ * 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.
+ */
+export default function useEventHandler<EventReceiverI extends GenericEventReceiver, EventI extends InferEvent<EventReceiverI> = InferEvent<EventReceiverI>, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>>({ eventReceiver: eventReceiverProp, resource: resourceProp, disabled, options: optionsProp, onEvent, onNotify, }: EventProps<EventReceiverI, EventI, ResourceI, OptionsI>): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civet/events",
-  "version": "4.1.1",
+  "version": "4.1.3",
   "description": "Civet",
   "author": {
     "name": "Aaron Burmeister"
@@ -55,7 +55,7 @@
     "react-dom": ">=18.0"
   },
   "devDependencies": {
-    "@civet/core": "^6.2.2",
+    "@civet/core": "^6.2.4",
     "@eslint/js": "^9.39.3",
     "@types/react": "^19.1.12",
     "@types/react-dom": "^19.1.9",
@@ -67,14 +67,14 @@
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.5.1",
+    "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-unused-imports": "^4.2.0",
     "globals": "^17.3.0",
     "prettier": "^3.6.2",
     "react": "^19.1.1",
     "react-dom": "^19.1.1",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.56.0",
+    "typescript-eslint": "^8.56.1",
     "vite": "^7.1.5",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^6.1.1"