cogsbox-state 0.5.4 → 0.5.6

package/dist/CogsState.d.ts

@@ -1,6 +1,7 @@
 import { GenericObject } from './utility.js';
 import { UseMutationResult } from '@tanstack/react-query';
-import { ZodObject, ZodRawShape } from 'zod';
+import { ZodArray, ZodObject, ZodRawShape } from 'zod';
+import { ComponentsType } from './store.js';
 
 type Prettify<T> = {
     [K in keyof T]: T[K];
@@ -17,7 +18,7 @@ export type SyncInfo = {
     timeStamp: number;
     userId: number;
 };
-export type FormElementParmas<T> = {
+export type FormElementParams<T> = {
     get: () => T;
     set: UpdateType<T>;
     syncStatus: (SyncInfo & {
@@ -25,9 +26,12 @@ export type FormElementParmas<T> = {
     }) | null;
     path: string[];
     validationErrors: () => string[];
+    addValidationError: (message?: string) => void;
     inputProps: {
-        value?: T;
+        ref?: React.RefObject<any>;
+        value?: T extends boolean ? never : T;
         onChange?: (event: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
+        onBlur?: () => void;
     };
 };
 export type StateKeys = string;
@@ -46,10 +50,11 @@ export type ArrayEndType<TShape extends unknown> = {
     } & EndType<InferArrayElement<TShape>>;
     insert: PushArgs<InferArrayElement<TShape>>;
     cut: CutFunctionType;
+    stateMapNoRender: (callbackfn: (value: InferArrayElement<TShape>, setter: StateObject<InferArrayElement<TShape>>, index: number, array: TShape, arraySetter: StateObject<TShape>) => void) => any;
     stateMap: (callbackfn: (value: InferArrayElement<TShape>, setter: StateObject<InferArrayElement<TShape>>, index: number, array: TShape, arraySetter: StateObject<TShape>) => void) => any;
     $stateMap: (callbackfn: (value: InferArrayElement<TShape>, setter: StateObject<InferArrayElement<TShape>>, index: number, array: TShape, arraySetter: StateObject<TShape>) => void) => any;
     stateFlattenOn: <K extends keyof InferArrayElement<TShape>>(field: K) => StateObject<InferArrayElement<InferArrayElement<TShape>[K]>[]>;
-    uniqueInsert: (payload: UpdateArg<InferArrayElement<TShape>>, fields?: (keyof InferArrayElement<TShape>)[]) => void;
+    uniqueInsert: (payload: UpdateArg<InferArrayElement<TShape>>, fields?: (keyof InferArrayElement<TShape>)[], onMatch?: (existingItem: any) => any) => void;
     stateFilter: (callbackfn: (value: InferArrayElement<TShape>, index: number) => void) => ArrayEndType<TShape>;
     getSelected: () => StateObject<InferArrayElement<TShape>> | undefined;
 } & EndType<TShape> & {
@@ -59,6 +64,7 @@ export type UpdateType<T> = (payload: UpdateArg<Prettify<T>>, opts?: UpdateOpts<
 export type FormOptsType = {
     key?: string;
     validation?: {
+        hideMessage?: boolean;
         message?: string;
         stretch?: boolean;
         props?: GenericObject;
@@ -68,10 +74,11 @@ export type FormOptsType = {
     debounceTime?: number;
     stateServerDifferences?: string[][];
 };
-export type FormControl<T> = (obj: FormElementParmas<T>) => JSX.Element;
+export type FormControl<T> = (obj: FormElementParams<T>) => JSX.Element;
 export type UpdateArg<S> = S | ((prevState: S) => S);
 export type UpdateOpts<T> = {
     afterUpdate?: (state: T) => void;
+    debounce?: number;
 };
 export type ObjectEndType<T> = EndType<T> & {
     [K in keyof T]-?: ObjectEndType<T[K]>;
@@ -84,17 +91,18 @@ export type EndType<T, IsArrayElement = false> = {
     update: UpdateType<T>;
     _path: string[];
     _stateKey: string;
-    formElement: (validationKey: string, control: FormControl<T>, opts?: FormOptsType) => JSX.Element;
+    formElement: (control: FormControl<T>, opts?: FormOptsType) => JSX.Element;
     get: () => T;
     $get: () => T;
-    $effect: <R>(fn: EffectFunction<T, R>) => R;
+    $derive: <R>(fn: EffectFunction<T, R>) => R;
     _status: "fresh" | "stale" | "synced";
-    showValidationErrors: (ctx: string) => string[];
+    showValidationErrors: () => string[];
     setValidation: (ctx: string) => void;
     removeValidation: (ctx: string) => void;
     ignoreFields: (fields: string[]) => StateObject<T>;
     _selected: boolean;
     setSelected: (value: boolean) => void;
+    getFormRef: () => React.RefObject<any> | undefined;
     validationWrapper: ({ children, hideMessage, }: {
         children: React.ReactNode;
         hideMessage?: boolean;
@@ -108,7 +116,10 @@ export type EndType<T, IsArrayElement = false> = {
 export type StateObject<T> = (T extends any[] ? ArrayEndType<T> : T extends Record<string, unknown> | object ? {
     [K in keyof T]-?: StateObject<T[K]>;
 } & ObjectEndType<T> : T extends string | number | boolean | null ? T : never) & EndType<T, true> & {
+    getAllFormRefs: () => Map<string, React.RefObject<any>>;
     _componentId: string | null;
+    getComponents: () => ComponentsType;
+    validateZodSchema: () => void;
     _initialState: T;
     updateInitialState: (newState: T | null) => {
         fetchId: (field: keyof T) => string | number;
@@ -155,15 +166,20 @@ type CookieType<T> = {
     OnUnMountCookie?: Boolean;
 };
 export type CogsCookiesType<T extends string[] = string[]> = CookieType<ArrayToObject<T>>;
+export type ReactivityType = "none" | "component" | "deps" | "all";
 export type OptionsType<T extends unknown = unknown> = {
+    componentId?: string;
     serverSync?: ServerSyncType<T>;
-    validationKey?: string;
+    validation?: {
+        key?: string;
+        zodSchema?: ZodObject<ZodRawShape> | ZodArray<ZodObject<ZodRawShape>>;
+        onBlur?: boolean;
+    };
     enableServerState?: boolean;
     middleware?: ({ updateLog, update, }: {
         updateLog: UpdateTypeDetail[] | undefined;
         update: UpdateTypeDetail;
     }) => void;
-    zodSchema?: ZodObject<ZodRawShape>;
     modifyState?: (state: T) => T;
     localStorage?: {
         key: string | ((state: T) => string);
@@ -171,9 +187,10 @@ export type OptionsType<T extends unknown = unknown> = {
     formElements?: FormsElementsType;
     enabledSync?: (state: T) => boolean;
     reactiveDeps?: (state: T) => any[] | true;
+    reactiveType?: ReactivityType[] | ReactivityType;
     syncUpdate?: Partial<UpdateTypeDetail>;
+    localStorageKey?: string;
     initState?: {
-        localStorageKey?: string;
         ctx?: Record<string, any>;
         initialState: T;
         dependencies?: any[];
@@ -248,7 +265,6 @@ export type CogsInitialState<T> = {
 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, zodSchema }: OptionsType<T>): T;
 export declare const createCogsState: <State extends Record<string, unknown>>(initialState: State, opts?: {
     reRenderType?: "get" | "state" | "none";
 }) => {
@@ -261,7 +277,8 @@ type LocalStorageData<T> = {
     lastSyncedWithServer?: number;
     baseServerState?: T;
 };
-export declare function useCogsStateFn<TStateObject extends unknown>(stateObject: TStateObject, { stateKey, serverSync, zodSchema, localStorage, formElements, middleware, reactiveDeps, componentId, initState, syncUpdate, }?: {
+export declare const notifyComponent: (stateKey: string, componentId: string) => void;
+export declare function useCogsStateFn<TStateObject extends unknown>(stateObject: TStateObject, { stateKey, serverSync, localStorage, formElements, middleware, reactiveDeps, reactiveType, componentId, localStorageKey, initState, syncUpdate, }?: {
     stateKey?: string;
     componentId?: string;
 } & OptionsType<TStateObject>): [TStateObject, StateObject<TStateObject>];