@chhsiao1981/use-thunk 10.2.0 → 10.3.0

package/README.md

@@ -290,11 +290,11 @@ classStateUser = {
 
 ### Basic
 
-##### `useThunk(theDo: ThunkModuleFunc): [ClassState, DispatchedAction]`
+##### `useThunk(theDo: ThunkModuleFunc): [ClassState, DispatchedFuncMap]`
 
 Similar to `React.useReducer`, but we use `useThunk`, and we also bind the actions with dispatch (similar concept as `mapDispatchToProps`).s
 
-return: `[ClassState<S>, DispatchedAction<S>]`
+return: `[ClassState<S>, DispatchedFuncMap<S, R>]`
 
 ##### `init({myID, parentID, doParent, state}, myuuidv4?)`
 
@@ -318,14 +318,16 @@ generate uuid for react-object.
 
 Get the state of `myID`. Get the state of `defaultID` if `myID` is not present. Return `null` if not available.
 
-##### `getStateOrDefault(state: ClassState, myID?: string): State`
+##### `mustGetState(state: ClassState, myID?: string): State`
 
 Get the state of `myID`. Get the state of `defaultID` if `myID` is not present. Return `defaultState` if not available.
 
-##### `getStateByThunk(theUseThunk: UseThunk, myID?: string): [State, DispatchedActionMap, theID]`
+##### `mustGetStateByThunk(theUseThunk: UseThunk, myID?: string): [State, DispatchedActionMap, theID]`
 
 Get the state of `myID` by `UseThunk`. Get the state of `defaultID` if `myID` is not present. Return `defaultState` if not available.
 
+return: `[S, DispatchedFuncMap<S, R>, theID]`
+
 ##### `getDefaultID(state: ClassState): string`
 
 get the default id.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chhsiao1981/use-thunk",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "type": "module",
   "description": "A framework easily using useThunk to manage the data-state.",
   "homepage": "https://github.com/chhsiao1981/use-thunk",

package/src/index.ts

@@ -7,8 +7,8 @@ import registerThunk from './registerThunk'
 import { remove } from './remove'
 import { setData } from './setData'
 import { setDefaultID } from './setDefaultID'
-import { getDefaultID, getNode, getState, getStateByThunk, getStateOrDefault } from './states'
-import type { ClassState, NodeMeta, NodeState, NodeStateMap, State } from './stateTypes'
+import { getDefaultID, getNode, getState, mustGetState, mustGetStateByThunk } from './states'
+import type { ClassState, NodeState, NodeStateMap, State } from './stateTypes'
 import ThunkContext from './ThunkContext'
 import type { ThunkModule, ThunkModuleToFunc } from './thunk'
 import useThunk, { type UseThunk } from './useThunk'
@@ -20,7 +20,6 @@ export {
   type UseThunk,
   type State,
   type NodeState,
-  type NodeMeta,
   type NodeStateMap,
   // type NodeStateMapByClass, // XXX for global state
   type ClassState,
@@ -39,8 +38,8 @@ export {
   getDefaultID,
   getNode,
   getState,
-  getStateOrDefault,
-  getStateByThunk,
+  mustGetState,
+  mustGetStateByThunk,
   init,
   type InitParams,
   setData,

package/src/stateTypes.ts

@@ -13,10 +13,6 @@ export type NodeStateMap<S extends State> = {
   [key: string]: NodeState<S>
 }
 
-export type NodeStateMapByClass<S extends State> = {
-  [className: string]: NodeStateMap<S>
-}
-
 // ClassState
 export type ClassState<S extends State> = {
   myClass: string
@@ -24,11 +20,3 @@ export type ClassState<S extends State> = {
   nodes: NodeStateMap<S>
   defaultState: S
 }
-
-// Node
-export type NodeMeta = {
-  id: string
-  theClass: string
-  // @ts-expect-error do can be any type.
-  do: DispatchFuncMap
-}

package/src/states.ts

@@ -32,16 +32,16 @@ export const getState = <S extends State>(classState: ClassState<S>, myID?: stri
   return me.state
 }
 
-export const getStateOrDefault = <S extends State>(classState: ClassState<S>, myID?: string): S => {
+export const mustGetState = <S extends State>(classState: ClassState<S>, myID?: string): S => {
   return getState(classState, myID) || classState.defaultState
 }
 
-export const getStateByThunk = <S extends State, R extends ThunkModuleFunc<S>>(
+export const mustGetStateByThunk = <S extends State, R extends ThunkModuleFunc<S>>(
   theUseThunk: UseThunk<S, R>,
   myID?: string,
 ): [S, DispatchFuncMap<S, R>, string] => {
   const [classState, theDo] = theUseThunk
   const theID = myID ? myID : getDefaultID(classState)
-  const state = getStateOrDefault(classState, theID)
+  const state = mustGetState(classState, theID)
   return [state, theDo, theID]
 }

package/types/index.d.ts

@@ -7,9 +7,9 @@ import registerThunk from './registerThunk';
 import { remove } from './remove';
 import { setData } from './setData';
 import { setDefaultID } from './setDefaultID';
-import { getDefaultID, getNode, getState, getStateByThunk, getStateOrDefault } from './states';
-import type { ClassState, NodeMeta, NodeState, NodeStateMap, State } from './stateTypes';
+import { getDefaultID, getNode, getState, mustGetState, mustGetStateByThunk } from './states';
+import type { ClassState, NodeState, NodeStateMap, State } from './stateTypes';
 import ThunkContext from './ThunkContext';
 import type { ThunkModule, ThunkModuleToFunc } from './thunk';
 import useThunk, { type UseThunk } from './useThunk';
-export { registerThunk, useThunk, ThunkContext, type UseThunk, type State, type NodeState, type NodeMeta, type NodeStateMap, type ClassState, type GetClassState, type Thunk, type ThunkModule, type ThunkModuleToFunc, type Dispatch, type DispatchFuncMap, getDefaultID, getNode, getState, getStateOrDefault, getStateByThunk, init, type InitParams, setData, remove, setDefaultID, genUUID, };
+export { registerThunk, useThunk, ThunkContext, type UseThunk, type State, type NodeState, type NodeStateMap, type ClassState, type GetClassState, type Thunk, type ThunkModule, type ThunkModuleToFunc, type Dispatch, type DispatchFuncMap, getDefaultID, getNode, getState, mustGetState, mustGetStateByThunk, init, type InitParams, setData, remove, setDefaultID, genUUID, };

package/types/stateTypes.d.ts

@@ -8,17 +8,9 @@ export type NodeState<S extends State> = {
 export type NodeStateMap<S extends State> = {
     [key: string]: NodeState<S>;
 };
-export type NodeStateMapByClass<S extends State> = {
-    [className: string]: NodeStateMap<S>;
-};
 export type ClassState<S extends State> = {
     myClass: string;
     defaultID?: string | null;
     nodes: NodeStateMap<S>;
     defaultState: S;
 };
-export type NodeMeta = {
-    id: string;
-    theClass: string;
-    do: DispatchFuncMap;
-};

package/types/states.d.ts

@@ -5,5 +5,5 @@ import type { UseThunk } from './useThunk';
 export declare const getDefaultID: <S extends State>(classState: ClassState<S>) => string;
 export declare const getNode: <S extends State>(classState: ClassState<S>, myID?: string) => NodeState<S> | null;
 export declare const getState: <S extends State>(classState: ClassState<S>, myID?: string) => S | null;
-export declare const getStateOrDefault: <S extends State>(classState: ClassState<S>, myID?: string) => S;
-export declare const getStateByThunk: <S extends State, R extends ThunkModuleFunc<S>>(theUseThunk: UseThunk<S, R>, myID?: string) => [S, DispatchFuncMap<S, R>, string];
+export declare const mustGetState: <S extends State>(classState: ClassState<S>, myID?: string) => S;
+export declare const mustGetStateByThunk: <S extends State, R extends ThunkModuleFunc<S>>(theUseThunk: UseThunk<S, R>, myID?: string) => [S, DispatchFuncMap<S, R>, string];