@chhsiao1981/use-thunk 10.0.4 → 10.1.0

package/README.md

@@ -67,7 +67,7 @@ export const increment = (myID: string): Thunk<State> => {
 App.tsx:
 
 ```tsx
-import { type ThunkModuleToFunc, useThunk, getRootID, getState } from '@chhsiao1981/use-thunk'
+import { type ThunkModuleToFunc, useThunk, getDefaultID, getState } from '@chhsiao1981/use-thunk'
 import * as DoIncrement from './reducers/increment'
 
 type TDoIncrement = ThunkModuleToFunc(typeof DoIncrement)
@@ -84,7 +84,7 @@ export default (props: Props) => {
   }, [])
 
   // states
-  const incrementID = getRootID(classStateIncrement)
+  const incrementID = getDefaultID(classStateIncrement)
   const increment = getState(classStateIncrement) || DoIncrement.defaultState
 
   // to render
@@ -136,7 +136,7 @@ export interface State extends rState {
 ### Must Included in a Top-level Component
 
 ```ts
-import { type ThunkModuleToFunc, useThunk, getRootID, getState } from '@chhsiao1981/use-thunk'
+import { type ThunkModuleToFunc, useThunk, getDefaultID, getState } from '@chhsiao1981/use-thunk'
 import * as DoModule from '../reducers/module'
 
 type TDoModule = ThunkModuleToFunc<typeof DoModule>
@@ -144,7 +144,7 @@ type TDoModule = ThunkModuleToFunc<typeof DoModule>
 const Component = () => {
   const [stateModule, doModule] = useThunk<DoModule.State, TDoModule>(DoModule)
 
-  const moduleID = getRootID(stateModule)
+  const moduleID = getDefaultID(stateModule)
   const theModule = getState(stateModule)
 
   .
@@ -175,7 +175,7 @@ createRoot(document.getElementById("root")!).render(
 The general concept of normalized state can be found in [Normalizing State Shape](https://redux.js.org/recipes/structuring-reducers/normalizing-state-shape)
 with the following features:
 
-1. ClassState: the state of the class, including the nodes and the root of the class.
+1. ClassState: the state of the class, including the nodes and the defaultID of the class.
 2. NodeState: the state of a node, including the id of the node and the content (state) of the node.
 3. State: the content of the node, represented as a state.
 
@@ -313,14 +313,19 @@ generate uuid for react-object.
 
 ##### `getState(state: ClassState, myID?: string): State`
 
-Get the state of `myID`. Get the state of `rootID` if `myID` is not present.
+Get the state of `myID`. Get the state of `defaultID` if `myID` is not present.
+
+##### `getDefaultID(state: ClassState): string`
+
+get the default id.
 
 ##### `getRootID(state: ClassState): string`
 
-get the root id.
+(to be deprecated in 10.2.0.)
+alias of `getDefaultID` for compatibility.
 
 ### NodeState
 
 ##### `getNode(state: ClassState, myID?: string): NodeState`
 
-Get the node of `myID`. Get the node of `rootID` if `myID` is not present.
+Get the node of `myID`. Get the node of `defaultID` if `myID` is not present.

package/package.json

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

package/src/ThunkContext.tsx

@@ -4,7 +4,7 @@ import { THUNK_CONTEXT_MAP } from './thunkContextMap'
 
 type Props = {
   classes?: string[]
-  children?: JSX.Element
+  children?: JSX.Element[]
 }
 const ThunkContext = (props: Props): JSX.Element => {
   let { classes, children } = props

package/src/index.ts

@@ -6,7 +6,8 @@ import { type InitParams, init } from './init'
 import registerThunk from './registerThunk'
 import { remove } from './remove'
 import { setData } from './setData'
-import { getNode, getRootID, getState } from './states'
+import { setDefaultID } from './setDefaultID'
+import { getDefaultID, getNode, getRootID, getState } from './states'
 import type { ClassState, NodeMeta, NodeState, NodeStateMap, State } from './stateTypes'
 import ThunkContext from './ThunkContext'
 import type { ThunkModule, ThunkModuleToFunc } from './thunk'
@@ -35,6 +36,7 @@ export {
   type Dispatch,
   type DispatchFuncMap,
   // type DefaultDispatchFuncMap, // XXX deemphasize default
+  getDefaultID,
   getRootID,
   getNode,
   getState,
@@ -45,5 +47,6 @@ export {
   // type DefaultThunkModuleFuncMap as DefaultReducerModuleFuncMap, // XXX deemphasize default
   // type ReduceMap, // XXX deemphasize reducer
   // createReducer, // XXX deemphasize reducer
+  setDefaultID,
   genUUID,
 }

package/src/init.ts

@@ -1,6 +1,6 @@
 import type { BaseAction, Thunk } from './action'
 import { genUUID } from './genUUID'
-import { setRoot } from './setRoot'
+import { setDefaultID } from './setDefaultID'
 import type { ClassState, NodeState, NodeStateMap, State } from './stateTypes'
 
 // InitParams
@@ -21,10 +21,10 @@ export const init = <S extends State>(params: InitParams<S>, myuuidv4?: () => st
     const { state } = params
     dispatch(initCore(myID, state))
 
-    const { root } = getClassState()
+    const { defaultID } = getClassState()
 
-    if (!root) {
-      dispatch(setRoot(myID))
+    if (!defaultID) {
+      dispatch(setDefaultID(myID))
     }
   }
 }

package/src/reduceMap.ts

@@ -2,7 +2,7 @@ import { INIT, reduceInit } from './init'
 import type { ReduceFunc } from './reducer'
 import { REMOVE, reduceRemove } from './remove'
 import { reduceSetData, SET_DATA } from './setData'
-import { reduceSetRoot, SET_ROOT } from './setRoot'
+import { reduceSetDefaultID, SET_DEFAULT_ID } from './setDefaultID'
 import type { State } from './stateTypes'
 
 export interface ReduceMap<S extends State> {
@@ -16,8 +16,8 @@ export const DEFAULT_REDUCE_MAP: <S extends State>() => ReduceMap<S> = () => ({
   [SET_DATA]: reduceSetData,
   [REMOVE]: reduceRemove,
 
-  // setRoot.
+  // setDefaultID.
   // Typically we don't need this in programming.
-  // The root is automatically determined if root is not set.
-  [SET_ROOT]: reduceSetRoot,
+  // The defaultID is automatically determined if defaultID is not set.
+  [SET_DEFAULT_ID]: reduceSetDefaultID,
 })

package/src/remove.ts

@@ -40,10 +40,10 @@ export const reduceRemove = <S extends State>(
       return r
     }, {})
 
-  // root
+  // defaultID
   const newState = Object.assign({}, classState, { nodes: newNodes })
-  if (newState.root === myID) {
-    newState.root = null
+  if (newState.defaultID === myID) {
+    newState.defaultID = null
   }
 
   return newState

package/src/setDefaultID.ts

@@ -0,0 +1,17 @@
+import type { BaseAction } from './action'
+import type { ClassState, State } from './stateTypes'
+
+export const SET_DEFAULT_ID = '@chhsiao1981/use-thunk/SET_DEFAULT_ID'
+export const setDefaultID = (myID: string): BaseAction => ({
+  myID,
+  type: SET_DEFAULT_ID,
+})
+
+export const reduceSetDefaultID = <S extends State>(
+  classState: ClassState<S>,
+  action: BaseAction,
+): ClassState<S> => {
+  const { myID } = action
+
+  return Object.assign({}, classState, { defaultID: myID })
+}

package/src/stateTypes.ts

@@ -20,7 +20,7 @@ export type NodeStateMapByClass<S extends State> = {
 // ClassState
 export type ClassState<S extends State> = {
   myClass: string
-  root?: string | null
+  defaultID?: string | null
   // XXX doMe is a hidden variable for ClassState
   //     used only for parents / children / links.
   // doMe: DispatchFuncMap

package/src/states.ts

@@ -1,46 +1,33 @@
 import type { ClassState, NodeState, State } from './stateTypes'
 
-const getRootNode = <S extends State>(classState: ClassState<S>): NodeState<S> | null => {
-  const root = classState.root
-  if (!root) {
-    return null
-  }
-  return classState.nodes[root] || null
+export const getDefaultID = <S extends State>(classState: ClassState<S>): string => {
+  return classState.defaultID ?? ''
 }
 
 export const getRootID = <S extends State>(classState: ClassState<S>): string => {
-  return classState.root ?? ''
-}
-
-const getRoot = <S extends State>(classState: ClassState<S>): S | null => {
-  const root = classState.root
-  if (!root) {
-    return null
-  }
-  const me = classState.nodes[root]
-  if (!me) {
-    return null
-  }
-  return me.state
+  console.warn('[DEPRECATE] getRootID will be deprecated in 10.2.0.')
+  return getDefaultID(classState)
 }
 
 export const getNode = <S extends State>(
   classState: ClassState<S>,
   myID?: string,
 ): NodeState<S> | null => {
-  if (!myID) {
-    return getRootNode(classState)
+  const theID = myID ? myID : getDefaultID(classState)
+  if (!theID) {
+    return null
   }
 
-  return classState.nodes[myID] || null
+  return classState.nodes[theID] || null
 }
 
 export const getState = <S extends State>(classState: ClassState<S>, myID?: string): S | null => {
-  if (!myID) {
-    return getRoot(classState)
+  const theID = myID ? myID : getDefaultID(classState)
+  if (!theID) {
+    return null
   }
 
-  const me = classState.nodes[myID]
+  const me = classState.nodes[theID]
   if (!me) {
     return null
   }

package/types/index.d.ts

@@ -6,9 +6,10 @@ import { type InitParams, init } from './init';
 import registerThunk from './registerThunk';
 import { remove } from './remove';
 import { setData } from './setData';
-import { getNode, getRootID, getState } from './states';
+import { setDefaultID } from './setDefaultID';
+import { getDefaultID, getNode, getRootID, getState } from './states';
 import type { ClassState, NodeMeta, 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, getRootID, getNode, getState, init, type InitParams, setData, remove, genUUID, };
+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, getRootID, getNode, getState, init, type InitParams, setData, remove, setDefaultID, genUUID, };

package/types/setDefaultID.d.ts

@@ -0,0 +1,5 @@
+import type { BaseAction } from './action';
+import type { ClassState, State } from './stateTypes';
+export declare const SET_DEFAULT_ID = "@chhsiao1981/use-thunk/SET_DEFAULT_ID";
+export declare const setDefaultID: (myID: string) => BaseAction;
+export declare const reduceSetDefaultID: <S extends State>(classState: ClassState<S>, action: BaseAction) => ClassState<S>;

package/types/stateTypes.d.ts

@@ -13,7 +13,7 @@ export type NodeStateMapByClass<S extends State> = {
 };
 export type ClassState<S extends State> = {
     myClass: string;
-    root?: string | null;
+    defaultID?: string | null;
     nodes: NodeStateMap<S>;
 };
 export type NodeMeta = {

package/types/states.d.ts

@@ -1,4 +1,5 @@
 import type { ClassState, NodeState, State } from './stateTypes';
+export declare const getDefaultID: <S extends State>(classState: ClassState<S>) => string;
 export declare const getRootID: <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;

package/src/setRoot.ts

@@ -1,17 +0,0 @@
-import type { BaseAction } from './action'
-import type { ClassState, State } from './stateTypes'
-
-export const SET_ROOT = '@chhsiao1981/use-thunk/SET_ROOT'
-export const setRoot = (myID: string): BaseAction => ({
-  myID,
-  type: SET_ROOT,
-})
-
-export const reduceSetRoot = <S extends State>(
-  classState: ClassState<S>,
-  action: BaseAction,
-): ClassState<S> => {
-  const { myID } = action
-
-  return Object.assign({}, classState, { root: myID })
-}

package/types/setRoot.d.ts

@@ -1,5 +0,0 @@
-import type { BaseAction } from './action';
-import type { ClassState, State } from './stateTypes';
-export declare const SET_ROOT = "@chhsiao1981/use-thunk/SET_ROOT";
-export declare const setRoot: (myID: string) => BaseAction;
-export declare const reduceSetRoot: <S extends State>(classState: ClassState<S>, action: BaseAction) => ClassState<S>;