cogsbox-state 0.5.3 → 0.5.4

package/dist/CogsState.d.ts

@@ -31,15 +31,8 @@ export type FormElementParmas<T> = {
     };
 };
 export type StateKeys = string;
-type findWithFuncType<U> = (thisKey: keyof U, thisValue: U[keyof U]) => EndType<U> & {
-    upsert: UpdateType<U>;
-} & StateObject<U>;
-export type PushArgs<U> = (update: Prettify<U> | ((prevState: NonNullable<Prettify<U>>[]) => NonNullable<Prettify<U>>), opts?: UpdateOpts) => void;
-export interface GlobalState<T, K extends keyof T = keyof T> {
-    getKeyState: () => T;
-    setState: (newState: T | ((previousState: T) => T)) => void;
-    key: K;
-}
+type findWithFuncType<U> = (thisKey: keyof U, thisValue: U[keyof U]) => EndType<U> & StateObject<U>;
+export type PushArgs<U> = (update: Prettify<U> | ((prevState: NonNullable<Prettify<U>>[]) => NonNullable<Prettify<U>>), opts?: UpdateOpts<U>) => void;
 type CutFunctionType = (index?: number, options?: {
     waitForSync?: boolean;
 }) => void;
@@ -53,13 +46,16 @@ export type ArrayEndType<TShape extends unknown> = {
     } & EndType<InferArrayElement<TShape>>;
     insert: PushArgs<InferArrayElement<TShape>>;
     cut: CutFunctionType;
-    stateEach: (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;
     stateFilter: (callbackfn: (value: InferArrayElement<TShape>, index: number) => void) => ArrayEndType<TShape>;
     getSelected: () => StateObject<InferArrayElement<TShape>> | undefined;
-} & EndType<TShape>;
-export type UpdateType<T> = (payload: UpdateArg<Prettify<T>>, opts?: UpdateOpts) => void;
+} & EndType<TShape> & {
+    [K in keyof (any[] extends infer T ? T : never)]: never;
+};
+export type UpdateType<T> = (payload: UpdateArg<Prettify<T>>, opts?: UpdateOpts<T>) => void;
 export type FormOptsType = {
     key?: string;
     validation?: {
@@ -74,10 +70,8 @@ export type FormOptsType = {
 };
 export type FormControl<T> = (obj: FormElementParmas<T>) => JSX.Element;
 export type UpdateArg<S> = S | ((prevState: S) => S);
-export type UpdateOpts = {
-    timelineLabel?: string;
-    timeLineMessage?: string;
-    validate?: boolean;
+export type UpdateOpts<T> = {
+    afterUpdate?: (state: T) => void;
 };
 export type ObjectEndType<T> = EndType<T> & {
     [K in keyof T]-?: ObjectEndType<T[K]>;
@@ -85,13 +79,15 @@ export type ObjectEndType<T> = EndType<T> & {
     stateObject: (callbackfn: (value: T, setter: StateObject<T>) => void) => any;
     delete: () => void;
 };
-export type EndType<T> = {
+type EffectFunction<T, R> = (state: T) => R;
+export type EndType<T, IsArrayElement = false> = {
     update: UpdateType<T>;
     _path: string[];
     _stateKey: string;
     formElement: (validationKey: string, control: FormControl<T>, opts?: FormOptsType) => JSX.Element;
     get: () => T;
     $get: () => T;
+    $effect: <R>(fn: EffectFunction<T, R>) => R;
     _status: "fresh" | "stale" | "synced";
     showValidationErrors: (ctx: string) => string[];
     setValidation: (ctx: string) => void;
@@ -104,10 +100,14 @@ export type EndType<T> = {
         hideMessage?: boolean;
     }) => JSX.Element;
     lastSynced?: SyncInfo;
+} & (IsArrayElement extends true ? {
+    cut: () => void;
+} : {}) & {
+    [K in keyof (any extends infer T ? T : never)]: never;
 };
 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> & {
+} & ObjectEndType<T> : T extends string | number | boolean | null ? T : never) & EndType<T, true> & {
     _componentId: string | null;
     _initialState: T;
     updateInitialState: (newState: T | null) => {
@@ -128,7 +128,7 @@ export type StateObject<T> = (T extends any[] ? ArrayEndType<T> : T extends Reco
 export type CogsUpdate<T extends unknown> = UpdateType<T>;
 export type EffectiveSetState<TStateObject> = (newStateOrFunction: TStateObject | ((prevState: TStateObject) => TStateObject), path: string[], updateObj: {
     updateType: "update" | "insert" | "cut";
-}, validationKey?: string, opts?: UpdateOpts) => void;
+}, validationKey?: string, opts?: UpdateOpts<TStateObject>) => void;
 export type UpdateTypeDetail = {
     timeStamp: number;
     stateKey: string;
@@ -249,8 +249,10 @@ 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) => {
-    useCogsState: <StateKey extends keyof State>(stateKey: StateKey, options?: OptionsType<TransformedStateType<State>[StateKey]>) => readonly [TransformedStateType<State>[StateKey], StateObject<TransformedStateType<State>[StateKey]>];
+export declare const createCogsState: <State extends Record<string, unknown>>(initialState: State, opts?: {
+    reRenderType?: "get" | "state" | "none";
+}) => {
+    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;
 };
 type LocalStorageData<T> = {
@@ -266,10 +268,12 @@ export declare function useCogsStateFn<TStateObject extends unknown>(stateObject
 export declare function $cogsSignal(proxy: {
     _path: string[];
     _stateKey: string;
+    _effect?: string;
 }): import('react').FunctionComponentElement<{
     proxy: {
         _path: string[];
         _stateKey: string;
+        _effect?: string;
     };
 }>;
 export declare function $cogsSignalStore(proxy: {