cogsbox-sync 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,903 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as zustand from 'zustand';
+import { ReactNode } from 'react';
+import z$1, { z } from 'zod';
+import * as cogsbox_state from 'cogsbox-state';
+
+type UpdateTypeDetail = {
+    timeStamp: number;
+    stateKey: string;
+    updateType: "update" | "insert" | "cut" | "insert_many";
+    path: string[];
+    status: "new" | "sent" | "synced";
+    oldValue: any;
+    newValue: any;
+    userId?: number;
+    itemId?: string;
+    insertAfterId?: string;
+    validation?: any[];
+    version?: string;
+    metaData?: Record<string, any>;
+};
+declare const clientActivitySchema: z.ZodIntersection<z.ZodObject<{
+    path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    timestamp: z.ZodNumber;
+    duration: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+    activityType: z.ZodLiteral<"focus">;
+    details: z.ZodObject<{
+        cursorPosition: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"blur">;
+    details: z.ZodObject<{
+        duration: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"input">;
+    details: z.ZodObject<{
+        value: z.ZodAny;
+        inputLength: z.ZodOptional<z.ZodNumber>;
+        isComposing: z.ZodOptional<z.ZodBoolean>;
+        isPasting: z.ZodOptional<z.ZodBoolean>;
+        keystrokeCount: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"select">;
+    details: z.ZodObject<{
+        selectionStart: z.ZodNumber;
+        selectionEnd: z.ZodNumber;
+        selectedText: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"hover_enter">;
+    details: z.ZodObject<{
+        cursorPosition: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"hover_exit">;
+    details: z.ZodObject<{
+        duration: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"scroll">;
+    details: z.ZodObject<{
+        scrollTop: z.ZodNumber;
+        scrollLeft: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    activityType: z.ZodLiteral<"cursor_move">;
+    details: z.ZodObject<{
+        cursorPosition: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>], "activityType">>;
+type ClientActivityType = z.infer<typeof clientActivitySchema>;
+
+type Notification = {
+    [key: string]: any;
+    timestamp: number;
+};
+type SubscriberCallback = (notifications: Notification[]) => void;
+type NotificationState = {
+    isConnected: boolean;
+    notificationsByChannel: Record<string, Notification[]>;
+    channelSubscribers: Map<string, Set<SubscriberCallback>>;
+    setConnectionStatus: (status: boolean) => void;
+    addNotifications: (newNotifications: Notification[]) => void;
+    addSubscriber: (channel: string, callback: SubscriberCallback) => () => void;
+    subscribeToPath: (path: string, callback: SubscriberCallback) => () => void;
+};
+declare const useNotificationStore: zustand.UseBoundStore<zustand.StoreApi<NotificationState>>;
+declare function SyncProvider({ children, tokens, }: {
+    children: ReactNode;
+    tokens?: {
+        sessionToken: string;
+        refreshToken: string;
+        serverUrl: string;
+        clientId: string;
+    };
+}): react_jsx_runtime.JSX.Element;
+type ClientActivityEvent = ClientActivityType & {
+    path: string[];
+    stateKey: string;
+};
+declare function useSync<TStateRoom = any, TApiParams = any>(options: {
+    stateKey: string;
+    stateRoom: TStateRoom;
+    connect?: boolean;
+    inMemoryState?: boolean;
+    apiParams?: TApiParams;
+}): {
+    sessionId: string;
+    connected: boolean;
+    clientId: string | null;
+    subscribers: string[];
+    onInitialState: (handler: (data: any, version: string) => void) => void;
+    onPatch: (handler: (patch: UpdateTypeDetail, sessionId: string, version: string) => void) => void;
+    onValidationError: (handler: (errors: any, sessionId: string) => void) => void;
+    onStateRequest: (handler: () => any) => void;
+    onSubscribersUpdate: (handler: (subscribers: string[]) => void) => void;
+    onClientActivity: (handler: (status: {
+        clientId: string;
+        event: ClientActivityEvent;
+        metaData: any;
+    }) => void) => void;
+    reportClientActivity: (event: ClientActivityEvent) => void;
+    sendUpdate: (operation: UpdateTypeDetail) => void;
+    clientActivity: {
+        clientId: string;
+        clientActivity: ClientActivityEvent;
+    };
+    requestState: () => void;
+};
+declare function useNotifications(channel: string): {
+    notifications: null;
+    isConnected: boolean;
+};
+declare function createNotificationHook<TNotifications extends Record<string, (state: any, context: any) => object | null>>(syncSchema: {
+    notifications: TNotifications;
+}): {
+    useSyncNotifications: <K extends keyof TNotifications>(type: K) => {
+        notifications: (ReturnType<TNotifications[K]> & {
+            timestamp: number;
+        })[];
+        isConnected: boolean;
+    };
+};
+
+type InferZodMap<T extends Record<string, Record<string, z$1.ZodTypeAny>>> = {
+    [K in keyof T]: {
+        [P in keyof T[K]]: z$1.infer<T[K][P]>;
+    };
+};
+type SyncSchemaForPlugin = {
+    clientSchemas: Record<string, z$1.ZodTypeAny>;
+    apiParams: Record<string, Record<string, z$1.ZodTypeAny>>;
+    metadataSchema: z$1.ZodObject<any>;
+    clientActivitySchema: typeof clientActivitySchema;
+};
+declare function createSyncPlugin<TSyncSchema extends SyncSchemaForPlugin>(syncSchema: TSyncSchema): {
+    name: "syncPlugin";
+    useHook?: ((params: cogsbox_state.UseHookParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }) | undefined;
+    transformState?: ((params: cogsbox_state.TransformStateParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => void) | undefined;
+    onUpdate?: ((params: cogsbox_state.OnUpdateParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => void) | undefined;
+    onFormUpdate?: ((params: cogsbox_state.OnFormUpdateParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => void) | undefined;
+    formWrapper?: ((params: cogsbox_state.FormWrapperParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => React.ReactNode) | undefined;
+} & {
+    transformState(fn: (params: cogsbox_state.TransformStateParams<{
+        stateRoom: string;
+        apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+    }, {
+        sessionId: string;
+        updateState: (operation: UpdateTypeDetail) => void;
+        reportClientActivity: (event: ({
+            path: (string | number)[];
+            timestamp: number;
+            duration?: number | undefined;
+        } & ({
+            activityType: "focus";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "blur";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "input";
+            details: {
+                value: any;
+                inputLength?: number | undefined;
+                isComposing?: boolean | undefined;
+                isPasting?: boolean | undefined;
+                keystrokeCount?: number | undefined;
+            };
+        } | {
+            activityType: "select";
+            details: {
+                selectionStart: number;
+                selectionEnd: number;
+                selectedText?: string | undefined;
+            };
+        } | {
+            activityType: "hover_enter";
+            details: {
+                cursorPosition?: number | undefined;
+            };
+        } | {
+            activityType: "hover_exit";
+            details: {
+                duration: number;
+            };
+        } | {
+            activityType: "scroll";
+            details: {
+                scrollTop: number;
+                scrollLeft: number;
+            };
+        } | {
+            activityType: "cursor_move";
+            details: {
+                cursorPosition: number;
+            };
+        })) & {
+            path: string[];
+            stateKey: string;
+        }) => void;
+    }, {
+        sessionId: string;
+        stateVersion: string;
+    }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+        clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+    }, any>) => void): {
+        name: "syncPlugin";
+        useHook?: ((params: cogsbox_state.UseHookParams<{
+            stateRoom: string;
+            apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+        }, {
+            sessionId: string;
+            stateVersion: string;
+        }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+            clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+        }, any>) => {
+            sessionId: string;
+            updateState: (operation: UpdateTypeDetail) => void;
+            reportClientActivity: (event: ({
+                path: (string | number)[];
+                timestamp: number;
+                duration?: number | undefined;
+            } & ({
+                activityType: "focus";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "blur";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "input";
+                details: {
+                    value: any;
+                    inputLength?: number | undefined;
+                    isComposing?: boolean | undefined;
+                    isPasting?: boolean | undefined;
+                    keystrokeCount?: number | undefined;
+                };
+            } | {
+                activityType: "select";
+                details: {
+                    selectionStart: number;
+                    selectionEnd: number;
+                    selectedText?: string | undefined;
+                };
+            } | {
+                activityType: "hover_enter";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "hover_exit";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "scroll";
+                details: {
+                    scrollTop: number;
+                    scrollLeft: number;
+                };
+            } | {
+                activityType: "cursor_move";
+                details: {
+                    cursorPosition: number;
+                };
+            })) & {
+                path: string[];
+                stateKey: string;
+            }) => void;
+        }) | undefined;
+        transformState?: ((params: cogsbox_state.TransformStateParams<{
+            stateRoom: string;
+            apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+        }, {
+            sessionId: string;
+            updateState: (operation: UpdateTypeDetail) => void;
+            reportClientActivity: (event: ({
+                path: (string | number)[];
+                timestamp: number;
+                duration?: number | undefined;
+            } & ({
+                activityType: "focus";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "blur";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "input";
+                details: {
+                    value: any;
+                    inputLength?: number | undefined;
+                    isComposing?: boolean | undefined;
+                    isPasting?: boolean | undefined;
+                    keystrokeCount?: number | undefined;
+                };
+            } | {
+                activityType: "select";
+                details: {
+                    selectionStart: number;
+                    selectionEnd: number;
+                    selectedText?: string | undefined;
+                };
+            } | {
+                activityType: "hover_enter";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "hover_exit";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "scroll";
+                details: {
+                    scrollTop: number;
+                    scrollLeft: number;
+                };
+            } | {
+                activityType: "cursor_move";
+                details: {
+                    cursorPosition: number;
+                };
+            })) & {
+                path: string[];
+                stateKey: string;
+            }) => void;
+        }, {
+            sessionId: string;
+            stateVersion: string;
+        }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+            clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+        }, any>) => void) | undefined;
+        onUpdate?: ((params: cogsbox_state.OnUpdateParams<{
+            stateRoom: string;
+            apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+        }, {
+            sessionId: string;
+            updateState: (operation: UpdateTypeDetail) => void;
+            reportClientActivity: (event: ({
+                path: (string | number)[];
+                timestamp: number;
+                duration?: number | undefined;
+            } & ({
+                activityType: "focus";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "blur";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "input";
+                details: {
+                    value: any;
+                    inputLength?: number | undefined;
+                    isComposing?: boolean | undefined;
+                    isPasting?: boolean | undefined;
+                    keystrokeCount?: number | undefined;
+                };
+            } | {
+                activityType: "select";
+                details: {
+                    selectionStart: number;
+                    selectionEnd: number;
+                    selectedText?: string | undefined;
+                };
+            } | {
+                activityType: "hover_enter";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "hover_exit";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "scroll";
+                details: {
+                    scrollTop: number;
+                    scrollLeft: number;
+                };
+            } | {
+                activityType: "cursor_move";
+                details: {
+                    cursorPosition: number;
+                };
+            })) & {
+                path: string[];
+                stateKey: string;
+            }) => void;
+        }, {
+            sessionId: string;
+            stateVersion: string;
+        }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+            clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+        }, any>) => void) | undefined;
+        onFormUpdate?: ((params: cogsbox_state.OnFormUpdateParams<{
+            stateRoom: string;
+            apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+        }, {
+            sessionId: string;
+            updateState: (operation: UpdateTypeDetail) => void;
+            reportClientActivity: (event: ({
+                path: (string | number)[];
+                timestamp: number;
+                duration?: number | undefined;
+            } & ({
+                activityType: "focus";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "blur";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "input";
+                details: {
+                    value: any;
+                    inputLength?: number | undefined;
+                    isComposing?: boolean | undefined;
+                    isPasting?: boolean | undefined;
+                    keystrokeCount?: number | undefined;
+                };
+            } | {
+                activityType: "select";
+                details: {
+                    selectionStart: number;
+                    selectionEnd: number;
+                    selectedText?: string | undefined;
+                };
+            } | {
+                activityType: "hover_enter";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "hover_exit";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "scroll";
+                details: {
+                    scrollTop: number;
+                    scrollLeft: number;
+                };
+            } | {
+                activityType: "cursor_move";
+                details: {
+                    cursorPosition: number;
+                };
+            })) & {
+                path: string[];
+                stateKey: string;
+            }) => void;
+        }, {
+            sessionId: string;
+            stateVersion: string;
+        }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+            clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+        }, any>) => void) | undefined;
+        formWrapper?: ((params: cogsbox_state.FormWrapperParams<{
+            stateRoom: string;
+            apiParams: cogsbox_state.KeyedTypes<InferZodMap<TSyncSchema["apiParams"]>>;
+        }, {
+            sessionId: string;
+            updateState: (operation: UpdateTypeDetail) => void;
+            reportClientActivity: (event: ({
+                path: (string | number)[];
+                timestamp: number;
+                duration?: number | undefined;
+            } & ({
+                activityType: "focus";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "blur";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "input";
+                details: {
+                    value: any;
+                    inputLength?: number | undefined;
+                    isComposing?: boolean | undefined;
+                    isPasting?: boolean | undefined;
+                    keystrokeCount?: number | undefined;
+                };
+            } | {
+                activityType: "select";
+                details: {
+                    selectionStart: number;
+                    selectionEnd: number;
+                    selectedText?: string | undefined;
+                };
+            } | {
+                activityType: "hover_enter";
+                details: {
+                    cursorPosition?: number | undefined;
+                };
+            } | {
+                activityType: "hover_exit";
+                details: {
+                    duration: number;
+                };
+            } | {
+                activityType: "scroll";
+                details: {
+                    scrollTop: number;
+                    scrollLeft: number;
+                };
+            } | {
+                activityType: "cursor_move";
+                details: {
+                    cursorPosition: number;
+                };
+            })) & {
+                path: string[];
+                stateKey: string;
+            }) => void;
+        }, {
+            sessionId: string;
+            stateVersion: string;
+        }, z$1.core.output<TSyncSchema["metadataSchema"]> & {
+            clientActivity?: z$1.core.output<TSyncSchema["clientActivitySchema"]>;
+        }, any>) => React.ReactNode) | undefined;
+    };
+};
+
+export { SyncProvider, createNotificationHook, createSyncPlugin, useNotificationStore, useNotifications, useSync };