@civet/events 1.2.0 → 2.0.0

package/dist/ConfigProvider.d.ts

@@ -0,0 +1,8 @@
+import { PropsWithChildren, ReactNode } from 'react';
+import { GenericEventReceiver } from './EventReceiver';
+/**
+ * Provides general configuration to its descendants using React's context API.
+ */
+export default function ConfigProvider<EventReceiverI extends GenericEventReceiver>({ eventReceiver, children, }: PropsWithChildren<{
+    eventReceiver: EventReceiverI;
+}>): ReactNode;

package/dist/EventHandler.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode } from 'react';
+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 EventHandler<EventReceiverI extends GenericEventReceiver, ResourceI extends InferResource<EventReceiverI> = InferResource<EventReceiverI>, OptionsI extends InferOptions<EventReceiverI> = InferOptions<EventReceiverI>, EventI extends InferEvent<EventReceiverI> = InferEvent<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;

package/dist/EventReceiver.d.ts

@@ -0,0 +1,16 @@
+import { Constructor, GenericDataProvider, ResourceContextValue } from '@civet/core';
+export default abstract class EventReceiver<Resource extends ResourceContextValue<GenericDataProvider>, Event, Options> {
+    readonly _inferResource: Resource;
+    readonly _inferEvent: Event;
+    readonly _inferOptions: Options;
+    subscribe<ResourceI extends Resource, OptionsI extends Options, EventI extends Event>(resource: ResourceI, options: OptionsI | undefined, handler: (events: EventI[]) => void): () => void;
+    abstract handleSubscribe(resource: Resource, options: Options | undefined, handler: (events: Event[]) => void): () => void;
+}
+export declare const isEventReceiver: (eventReceiver: unknown) => boolean;
+export type EventReceiverImplementation<EventReceiverI extends GenericEventReceiver, ConstructorArgs extends any[]> = Constructor<ConstructorArgs, EventReceiverI & {
+    handleSubscribe(resource: InferResource<EventReceiverI>, options: InferOptions<EventReceiverI> | undefined, handler: (events: InferEvent<EventReceiverI>[]) => void): () => void;
+}>;
+export type GenericEventReceiver = EventReceiver<ResourceContextValue<GenericDataProvider>, unknown, unknown>;
+export type InferResource<EventReceiverI extends GenericEventReceiver> = EventReceiverI['_inferResource'];
+export type InferEvent<EventReceiverI extends GenericEventReceiver> = EventReceiverI['_inferEvent'];
+export type InferOptions<EventReceiverI extends GenericEventReceiver> = EventReceiverI['_inferOptions'];

package/dist/composeHandlers.d.ts

@@ -0,0 +1 @@
+export default function composeHandlers<Args extends any[]>(...handlers: ((...args: Args) => boolean)[]): (...args: Args) => boolean;

package/dist/context.d.ts

@@ -0,0 +1,10 @@
+import { ConsumerProps, ExoticComponent, ReactNode } from 'react';
+import { GenericEventReceiver } from './EventReceiver';
+export type ConfigContextValue<EventReceiverI extends GenericEventReceiver> = {
+    eventReceiver?: EventReceiverI;
+};
+export declare const ConfigContext: import('react').Context<ConfigContextValue<GenericEventReceiver>>;
+export declare const ConfigConsumer: ExoticComponent<GenericEventReceiver> & {
+    <DataProviderI extends GenericEventReceiver>(props: ConsumerProps<ConfigContextValue<DataProviderI>>): ReactNode;
+};
+export declare const useConfigContext: <DataProviderI extends GenericEventReceiver>() => ConfigContextValue<DataProviderI>;

package/dist/main.d.ts

@@ -0,0 +1,8 @@
+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 EventReceiver, isEventReceiver } from './EventReceiver';
+export type { EventReceiverImplementation, GenericEventReceiver, InferEvent, InferOptions, InferResource, } from './EventReceiver';
+export { default as useEventHandler } from './useEventHandler';
+export { ConfigConsumer, useConfigContext };