cogsbox-state 0.5.434 → 0.5.436

package/dist/CogsState.d.ts

@@ -1,8 +1,9 @@
 import { CSSProperties, RefObject } from 'react';
 import { GenericObject } from './utility.js';
-import { z } from 'zod';
-import { ComponentsType } from './store.js';
+import { ValidationStatus, ComponentsType } from './store.js';
 
+import * as z3 from 'zod/v3';
+import * as z4 from 'zod/v4';
 type Prettify<T> = T extends any ? {
     [K in keyof T]: T[K];
 } : never;
@@ -101,11 +102,13 @@ export type FormOptsType = {
     validation?: {
         hideMessage?: boolean;
         message?: string;
-        stretch?: boolean;
         props?: GenericObject;
         disable?: boolean;
     };
     debounceTime?: number;
+    sync?: {
+        allowInvalidValues?: boolean;
+    };
 };
 export type FormControl<T> = (obj: FormElementParams<T>) => JSX.Element;
 export type UpdateArg<S> = S | ((prevState: S) => S);
@@ -113,7 +116,9 @@ export type InsertParams<S> = S | ((prevState: {
     state: S;
     uuid: string;
 }) => S);
-export type UpdateType<T> = (payload: UpdateArg<T>) => void;
+export type UpdateType<T> = (payload: UpdateArg<T>) => {
+    synced: () => void;
+};
 export type InsertType<T> = (payload: InsertParams<T>, index?: number) => void;
 export type InsertTypeObj<T> = (payload: InsertParams<T>) => void;
 export type ValidationError = {
@@ -129,6 +134,7 @@ export type EndType<T, IsArrayElement = false> = {
     _stateKey: string;
     formElement: (control: FormControl<T>, opts?: FormOptsType) => JSX.Element;
     get: () => T;
+    getState: () => T;
     $get: () => T;
     $derive: <R>(fn: EffectFunction<T, R>) => R;
     _status: 'fresh' | 'dirty' | 'synced' | 'restored' | 'unknown';
@@ -188,15 +194,24 @@ export type UpdateTypeDetail = {
 };
 export type ReactivityUnion = 'none' | 'component' | 'deps' | 'all';
 export type ReactivityType = 'none' | 'component' | 'deps' | 'all' | Array<Prettify<'none' | 'component' | 'deps' | 'all'>>;
+type SyncApi = {
+    updateState: (data: {
+        operation: any;
+    }) => void;
+    connected: boolean;
+    clientId: string | null;
+    subscribers: string[];
+};
 type ValidationOptionsType = {
     key?: string;
-    zodSchema?: z.ZodTypeAny;
+    zodSchemaV3?: z3.ZodType<any, any, any>;
+    zodSchemaV4?: z4.ZodType<any, any, any>;
     onBlur?: boolean;
 };
 export type OptionsType<T extends unknown = unknown> = {
     log?: boolean;
     componentId?: string;
-    serverSync?: ServerSyncType<T>;
+    cogsSync?: (stateObject: StateObject<T>) => SyncApi;
     validation?: ValidationOptionsType;
     serverState?: {
         id?: string | number;
@@ -230,48 +245,28 @@ export type OptionsType<T extends unknown = unknown> = {
         key: string | ((state: T) => string);
         onChange?: (state: T) => void;
     };
-    formElements?: FormsElementsType;
+    formElements?: FormsElementsType<T>;
     reactiveDeps?: (state: T) => any[] | true;
     reactiveType?: ReactivityType;
     syncUpdate?: Partial<UpdateTypeDetail>;
     defaultState?: T;
     dependencies?: any[];
 };
-export type ServerSyncType<T> = {
-    testKey?: string;
-    syncKey: (({ state }: {
-        state: T;
-    }) => string) | string;
-    syncFunction: ({ state }: {
-        state: T;
-    }) => void;
-    debounce?: number;
-    snapshot?: {
-        name: (({ state }: {
-            state: T;
-        }) => string) | string;
-        stateKeys: StateKeys[];
-        currentUrl: string;
-        currentParams?: URLSearchParams;
-    };
-};
-export type ValidationWrapperOptions<T extends unknown = unknown> = {
-    children: React.ReactNode;
-    active: boolean;
-    stretch?: boolean;
-    path: string[];
-    message?: string;
-    data?: T;
-    key?: string;
-};
 export type SyncRenderOptions<T extends unknown = unknown> = {
     children: React.ReactNode;
     time: number;
     data?: T;
     key?: string;
 };
-type FormsElementsType<T extends unknown = unknown> = {
-    validation?: (options: ValidationWrapperOptions<T>) => React.ReactNode;
+type FormsElementsType<T> = {
+    validation?: (options: {
+        children: React.ReactNode;
+        status: ValidationStatus;
+        path: string[];
+        message?: string;
+        data?: T;
+        key?: string;
+    }) => React.ReactNode;
     syncRender?: (options: SyncRenderOptions<T>) => React.ReactNode;
 };
 export type InitialStateInnerType<T extends unknown = unknown> = {
@@ -289,13 +284,16 @@ export type TransformedStateType<T> = {
     [P in keyof T]: T[P] extends CogsInitialState<infer U> ? U : T[P];
 };
 export declare function addStateOptions<T extends unknown>(initialState: T, { formElements, validation }: OptionsType<T>): T;
+type UseCogsStateHook<T extends Record<string, any>> = <StateKey extends keyof TransformedStateType<T>>(stateKey: StateKey, options?: Prettify<OptionsType<TransformedStateType<T>[StateKey]>>) => StateObject<TransformedStateType<T>[StateKey]>;
+type SetCogsOptionsFunc<T extends Record<string, any>> = <StateKey extends keyof TransformedStateType<T>>(stateKey: StateKey, options: OptionsType<TransformedStateType<T>[StateKey]>) => void;
+type CogsApi<T extends Record<string, any>> = {
+    useCogsState: UseCogsStateHook<T>;
+    setCogsOptions: SetCogsOptionsFunc<T>;
+};
 export declare const createCogsState: <State extends Record<StateKeys, unknown>>(initialState: State, opt?: {
-    formElements?: FormsElementsType;
+    formElements?: FormsElementsType<State>;
     validation?: ValidationOptionsType;
-}) => {
-    useCogsState: <StateKey extends keyof State>(stateKey: StateKey, options?: OptionsType<TransformedStateType<State>[StateKey]>) => StateObject<TransformedStateType<State>[StateKey]>;
-    setCogsOptions: <StateKey extends keyof State>(stateKey: StateKey, options: OptionsType<TransformedStateType<State>[StateKey]>) => void;
-};
+}) => CogsApi<State>;
 type LocalStorageData<T> = {
     state: T;
     lastUpdated: number;
@@ -304,7 +302,7 @@ type LocalStorageData<T> = {
     stateSource?: 'default' | 'server' | 'localStorage';
 };
 export declare const notifyComponent: (stateKey: string, componentId: string) => void;
-export declare function useCogsStateFn<TStateObject extends unknown>(stateObject: TStateObject, { stateKey, serverSync, localStorage, formElements, reactiveDeps, reactiveType, componentId, defaultState, syncUpdate, dependencies, serverState, }?: {
+export declare function useCogsStateFn<TStateObject extends unknown>(stateObject: TStateObject, { stateKey, localStorage, formElements, reactiveDeps, reactiveType, componentId, defaultState, syncUpdate, dependencies, serverState, }?: {
     stateKey?: string;
     componentId?: string;
     defaultState?: TStateObject;