@chhsiao1981/use-thunk 13.0.0 → 14.0.2

package/src/set/setMap.ts

@@ -1,59 +0,0 @@
-import type { ActionFunc } from '../action'
-import type { set } from '../set'
-import type { State } from '../states'
-import type { doModule, ThunkModule } from '../thunkModule'
-import { DEFAULT_DO_MODULE, type defaultDoModule } from '../thunkModule'
-
-// biome-ignore lint/suspicious/noExplicitAny: unknown requires same type in list, use any for possible different types.
-type VoidReturnType<T extends (...params: any[]) => unknown> = (...params: Parameters<T>) => void
-
-export type setMap<S extends State, T extends doModule<S>> = {
-  [action in keyof T]: VoidReturnType<T[action]>
-} & Omit<DefaultSetMap, keyof T>
-
-export type DefaultSetMap = {
-  [action in keyof defaultDoModule]: VoidReturnType<defaultDoModule[action]>
-}
-
-export interface setMapByModuleMap<S extends State, T extends doModule<S>> {
-  [moduleMap: string]: setMap<S, T>
-}
-
-export const constructSetMap = <S extends State, T extends doModule<S>>(
-  theDo: ThunkModule<S>,
-  set: set<S>,
-  setMap: setMap<S, T>,
-) => {
-  Object.keys(theDo)
-    // default and name are reserved words.
-    // functions starting reduce are included in default and not exported.
-    .filter((each) => typeof theDo[each] === 'function')
-    .reduce((val, eachAction) => {
-      if (val[eachAction]) {
-        return val
-      }
-
-      // because action is a function.
-      const action = theDo[eachAction] as ActionFunc<S>
-
-      // @ts-expect-error eachAction is in setMap<S, R>
-      // biome-ignore lint/suspicious/noExplicitAny: action parameters can be any types.
-      val[eachAction] = (...params: any[]) => set(action(...params))
-      return val
-    }, setMap)
-
-  Object.keys(DEFAULT_DO_MODULE).reduce((val, eachAction) => {
-    if (val[eachAction]) {
-      return val
-    }
-
-    const action = DEFAULT_DO_MODULE[eachAction]
-
-    // @ts-expect-error eachAction is in setMap<S, R>
-    // biome-ignore lint/suspicious/noExplicitAny: action parameters can be any types.
-    val[eachAction] = (...params: any[]) => set(action(...params))
-    return val
-  }, setMap)
-
-  return setMap
-}

package/src/states/index.ts

@@ -1,84 +0,0 @@
-import type { setMap } from '../set'
-import type { doModule } from '../thunkModule'
-import type { UseThunk } from '../useThunk'
-import { deepCopy } from '../utils'
-import type { ModuleState, NodeState, NodeStateMap, State } from './types'
-
-export type { ModuleState, NodeState, State, NodeStateMap }
-
-export const getDefaultID = <S extends State>(moduleState: ModuleState<S>): string => {
-  return moduleState.defaultID ?? ''
-}
-
-export const getNodeOrNull = <S extends State>(
-  moduleState: ModuleState<S>,
-  myID?: string,
-): Readonly<NodeState<S> | null> => {
-  const theID = myID ? myID : getDefaultID(moduleState)
-  if (!theID) {
-    return null
-  }
-
-  return moduleState.nodes[theID] || null
-}
-
-export const getStateOrNullByModule = <S extends State>(
-  moduleState: ModuleState<S>,
-  myID?: string,
-): Readonly<S | null> => {
-  const theID = myID ? myID : getDefaultID(moduleState)
-  if (!theID) {
-    return null
-  }
-
-  const me = moduleState.nodes[theID]
-  if (!me) {
-    return null
-  }
-
-  return me.state
-}
-
-export const getStateByModule = <S extends State>(
-  moduleState: ModuleState<S>,
-  myID?: string,
-): Readonly<S> => {
-  const theID = myID ? myID : getDefaultID(moduleState)
-  if (!theID) {
-    return moduleState.defaultState
-  }
-
-  const state = getStateOrNullByModule(moduleState, theID)
-  if (state) {
-    return state
-  }
-
-  // XXX magic for new nodes
-  // 1. reduceInit
-  const newState = deepCopy(moduleState.defaultState)
-  const newNode = { id: theID, state: newState }
-  moduleState.nodes[theID] = newNode
-
-  // 2. already init default-id, no need to init default-id here.
-  if (moduleState.isInitDefaultID) {
-    return newState
-  }
-
-  // 3. check defaultID
-  if (!moduleState.defaultID) {
-    moduleState.defaultID = theID
-    moduleState.isInitDefaultID = true
-  }
-
-  return newState
-}
-
-export const getState = <S extends State, R extends doModule<S>>(
-  theUseThunk: UseThunk<S, R>,
-  myID?: string,
-): [Readonly<S>, setMap<S, R>, string] => {
-  const [moduleState, theDo] = theUseThunk
-  const theID = myID ? myID : getDefaultID(moduleState)
-  const state = getStateByModule(moduleState, theID)
-  return [state, theDo, theID]
-}

package/src/states/types.ts

@@ -1,23 +0,0 @@
-//State
-export interface State {
-  [key: string]: unknown
-}
-
-// NodeState
-export type NodeState<S extends State> = {
-  id: string
-  state: S
-}
-
-// ModuleState
-export type ModuleState<S extends State> = {
-  name: string
-  nodes: NodeStateMap<S>
-  defaultState: S
-  defaultID?: string | null
-  isInitDefaultID?: boolean
-}
-
-export type NodeStateMap<S extends State> = {
-  [key: string]: NodeState<S>
-}

package/src/thunkContext/ThunkContext.tsx

@@ -1,46 +0,0 @@
-import { type ReactNode, useMemo, useState } from 'react'
-import { THUNK_CONTEXT_MAP } from './thunkContextMap'
-
-type Props = {
-  modules?: string[]
-  children?: ReactNode
-}
-
-const ThunkContext = (props: Props): ReactNode => {
-  const { modules: propsModules, children } = props
-  const modules = propsModules || THUNK_CONTEXT_MAP.theList
-  // 0. if there is no Thunk modules (no createThunk): return children.
-  if (modules.length === 0) {
-    return children
-  }
-
-  // render the 0th module.
-  const theModule = modules[0]
-
-  // 1. get the context and moduleState from context map.
-  const { context: Context_m, refModuleState } = THUNK_CONTEXT_MAP.theMap[theModule]
-
-  // 2. setup moduleState.
-  // biome-ignore lint/correctness/useHookAtTopLevel: the order is fixed.
-  const [moduleState, setModuleState] = useState(refModuleState.current)
-  refModuleState.current = moduleState
-
-  // 3. value reset only if moduleState is changed.
-  // biome-ignore lint/correctness/useHookAtTopLevel: the order is fixed.
-  const value = useMemo(
-    () => ({
-      refModuleState: refModuleState,
-      setModuleState: setModuleState,
-    }),
-    [moduleState],
-  )
-
-  // 4. get theChildren
-  const theChildren =
-    modules.length === 1 ? children : ThunkContext({ modules: modules.slice(1), children })
-
-  // 5. return context.
-  return <Context_m.Provider value={value}>{theChildren}</Context_m.Provider>
-}
-
-export default ThunkContext

package/src/thunkContext/index.ts

@@ -1,9 +0,0 @@
-import type { Context } from './types'
-export type { Context }
-
-// THUNK_CONTEXT_MAP is used in registerThunk and useThunkReducer
-import { THUNK_CONTEXT_MAP, type ThunkContextMap } from './thunkContextMap'
-export { THUNK_CONTEXT_MAP, type ThunkContextMap }
-
-import ThunkContext from './ThunkContext'
-export { ThunkContext }

package/src/thunkContext/thunkContextMap.ts

@@ -1,22 +0,0 @@
-import type { Context as rContext } from 'react'
-import type { ModuleState } from '../states'
-import type { Context } from './types'
-
-export type ThunkContextMap = {
-  theMap: {
-    [moduleName: string]: {
-      // biome-ignore lint/suspicious/noExplicitAny: ThunkContextMap can be any type
-      context: rContext<Context<any>>
-
-      // we need to use refModuleState to sync all the moduleState in all ops.
-      // biome-ignore lint/suspicious/noExplicitAny: ThunkContextMap can be any type
-      refModuleState: { current: ModuleState<any> }
-    }
-  }
-  theList: string[]
-}
-
-export const THUNK_CONTEXT_MAP: ThunkContextMap = {
-  theMap: {},
-  theList: [],
-}

package/src/thunkContext/types.ts

@@ -1,8 +0,0 @@
-import type { Dispatch, SetStateAction } from 'react'
-import type { ModuleState, State } from '../states'
-
-export type Context<S extends State> = {
-  // INFO: we use refModuleState to reference across all the useThunk of the same module in different ops.
-  refModuleState: { current: ModuleState<S> }
-  setModuleState: Dispatch<SetStateAction<ModuleState<S>>>
-}

package/src/thunkModule/defaultDoModule.ts

@@ -1,13 +0,0 @@
-import type { ActionFunc } from '../action'
-import { init, remove, update } from '../defaultThunks'
-
-export const DEFAULT_DO_MODULE: defaultDoModule = {
-  init,
-  update,
-  remove,
-}
-
-export type defaultDoModule = {
-  // biome-ignore lint/suspicious/noExplicitAny: defaultDoModule can be any type.
-  [action: string]: ActionFunc<any>
-}

package/src/thunkModule/index.ts

@@ -1,21 +0,0 @@
-import type { ThunkFunc } from '../action'
-import type { State } from '../states'
-import { DEFAULT_DO_MODULE, type defaultDoModule } from './defaultDoModule'
-export { DEFAULT_DO_MODULE, type defaultDoModule }
-
-export interface doModule<S extends State> {
-  [action: string]: ThunkFunc<S>
-}
-
-// This is used as the parameter for useThunk.
-export type ThunkModule<S extends State> = {
-  name: string
-  defaultState: S
-
-  // The rest of the variables are doModule.
-  // Specifying index-signatures to include all the variables.
-  [action: string]: ThunkFunc<S> | string | S
-}
-
-// biome-ignore lint/suspicious/noExplicitAny: ok for type utility functions.
-export type toDoModule<T extends ThunkModule<any>> = Omit<T, 'name' | 'default' | 'defaultState'>

package/src/useThunk/index.ts

@@ -1,48 +0,0 @@
-import { useMemo } from 'react'
-import { createReducer } from '../reducer'
-import { constructSetMap, type setMap, type setMapByModuleMap } from '../set'
-import type { ModuleState, State } from '../states'
-import type { doModule, ThunkModule } from '../thunkModule'
-import useThunkReducer from './useThunkReducer'
-
-// biome-ignore lint/suspicious/noExplicitAny: SET_MAP_BY_MODULE can by any type
-const SET_MAP_BY_MODULE: setMapByModuleMap<any, any> = {}
-
-export type UseThunk<S extends State, R extends doModule<S>> = [Readonly<ModuleState<S>>, setMap<S, R>]
-
-/**********
- * useThunk
- **********/
-export default <S extends State, R extends doModule<S>>(theDo: ThunkModule<S>): UseThunk<S, R> => {
-  const { name } = theDo
-
-  // 1. It requires shared nodes for the same module to have the same setMap.
-  const isFirstTime = !SET_MAP_BY_MODULE[name]
-  if (isFirstTime) {
-    SET_MAP_BY_MODULE[name] = {}
-  }
-  const setMap = SET_MAP_BY_MODULE[name] as setMap<S, R>
-
-  // 2. reducer.
-  //    theReducer is different for different useThunk,
-  //    even within the same module.
-  //    However, because theReducer is a pure function by
-  //    having ModuleState as the input. It is ok to have
-  //    different reducers within the same module.
-  const theReducer = useMemo(() => createReducer<S>(), [])
-
-  // 3. useThunkReducer
-  const [moduleState, set] = useThunkReducer(theReducer, name)
-
-  const ret: UseThunk<S, R> = useMemo(() => {
-    return [moduleState, setMap]
-  }, [moduleState, setMap])
-
-  if (!isFirstTime) {
-    return ret
-  }
-
-  constructSetMap(theDo, set, setMap)
-
-  return ret
-}

package/src/useThunk/useThunkReducer.ts

@@ -1,100 +0,0 @@
-//https://medium.com/solute-labs/configuring-thunk-action-creators-and-redux-dev-tools-with-reacts-usereducer-hook-5a1608476812
-//https://github.com/nathanbuchar/react-hook-thunk-reducer/blob/master/src/thunk-reducer.js
-
-import { useCallback, useContext } from 'react'
-import type { BaseAction } from '../action'
-import { upsert } from '../defaultThunks/upsert'
-import type { dispatch } from '../dispatch'
-import type { get, getOrNull } from '../get'
-import type { Reducer } from '../reducer'
-import type { set } from '../set'
-import { getStateByModule, getStateOrNullByModule, type ModuleState, type State } from '../states'
-import { THUNK_CONTEXT_MAP } from '../thunkContext'
-
-/**
- * useThunkReducer
- *
- * Augments React's useReducer() hook so that the action
- * setter (dispatcher) supports thunks.
- */
-export default <S extends State>(reducer: Reducer<S>, moduleName: string): [ModuleState<S>, set<S>] => {
-  const { context } = THUNK_CONTEXT_MAP.theMap[moduleName]
-
-  const { refModuleState, setModuleState: setModuleState_c } = useContext(context)
-  const getModuleState = useCallback(() => {
-    return refModuleState.current
-  }, [refModuleState]) as () => ModuleState<S>
-
-  const setModuleState = useCallback(
-    (newModuleState: ModuleState<S>) => {
-      refModuleState.current = newModuleState
-      setModuleState_c(newModuleState)
-    },
-    [refModuleState, setModuleState_c],
-  )
-
-  const getOrNull: getOrNull<S> = useCallback(
-    (id?: string) => {
-      const moduleState = getModuleState()
-      const state = getStateOrNullByModule(moduleState, id)
-      return state
-    },
-    [getModuleState],
-  )
-
-  const get: get<S> = useCallback(
-    (id?: string) => {
-      const moduleState = getModuleState()
-      const state = getStateByModule(moduleState, id)
-      return state
-    },
-    [getModuleState],
-  )
-
-  const reduce = useCallback(
-    (action: BaseAction): ModuleState<S> => {
-      const moduleState = getModuleState()
-      const newModuleState = reducer(moduleState, action)
-      return newModuleState
-    },
-    [reducer, getModuleState],
-  )
-
-  const dispatch: dispatch<S> = useCallback(
-    (action) => {
-      if (typeof action === 'function') {
-        // action is Thunk<S, A>
-        action(set, get, getOrNull, dispatch, getModuleState)
-        return
-      }
-
-      // action is not function. so action is BaseAction
-      const newModuleState = reduce(action)
-      setModuleState(newModuleState)
-    },
-    [getModuleState, setModuleState, reduce],
-  )
-
-  const set: set<S> = useCallback(
-    (actionOrID, data) => {
-      if (typeof actionOrID === 'string') {
-        // actionOrID is id
-        if (!data) {
-          return
-        }
-
-        // we have the data, we can do upsert.
-        const action = upsert(actionOrID, data)
-        const newModuleState = reduce(action)
-        setModuleState(newModuleState)
-        return
-      }
-
-      // actionOrID is action
-      dispatch(actionOrID)
-    },
-    [getModuleState, setModuleState, reduce],
-  )
-
-  return [refModuleState.current, set]
-}

package/src/utils/deepCopy.ts

@@ -1,30 +0,0 @@
-// biome-ignore lint/suspicious/noExplicitAny: obj in deepCopy can be any type.
-const deepCopy = (obj: any): any => {
-  // Handle primitives, functions, null, or undefined
-  if (obj === null || typeof obj !== 'object') {
-    return obj
-  }
-
-  // Handle Date objects
-  if (obj instanceof Date) {
-    return new Date(obj.getTime())
-  }
-
-  // Handle Arrays
-  if (Array.isArray(obj)) {
-    return obj.map((item) => deepCopy(item))
-  }
-
-  // Handle Objects
-  // biome-ignore lint/suspicious/noExplicitAny: clonedObj can be any type.
-  const clonedObj: any = {}
-  for (const key in obj) {
-    if (obj.hasOwnProperty(key)) {
-      clonedObj[key] = deepCopy(obj[key])
-    }
-  }
-
-  return clonedObj
-}
-
-export default deepCopy

package/src/utils/genID.ts

@@ -1,6 +0,0 @@
-let _GLOBAL_ID = 1
-
-export const genID = (): string => {
-  _GLOBAL_ID += 1
-  return `${_GLOBAL_ID}`
-}

package/src/utils/index.ts

@@ -1,3 +0,0 @@
-import deepCopy from './deepCopy'
-import { genID } from './genID'
-export { deepCopy, genID }

package/types/dispatch.d.ts

@@ -1,4 +0,0 @@
-import type { Dispatch } from 'react';
-import type { ActionOrThunk } from './action';
-import type { State } from './states';
-export type dispatch<S extends State> = Dispatch<ActionOrThunk<S>>;

package/types/index.d.ts

@@ -1,12 +0,0 @@
-import type { getModuleState, Thunk, ThunkFunc } from './action';
-import { type InitParams, init, remove, setDefaultID, update, upsert } from './defaultThunks';
-import type { dispatch } from './dispatch';
-import type { get, getOrNull } from './get';
-import registerThunk from './registerThunk';
-import type { set, setMap } from './set';
-import { getDefaultID, getNodeOrNull, getState, getStateByModule, getStateOrNullByModule, type ModuleState, type State } from './states';
-import { ThunkContext } from './thunkContext';
-import type { doModule, ThunkModule, toDoModule } from './thunkModule';
-import useThunk, { type UseThunk } from './useThunk';
-import { genID } from './utils';
-export { type Thunk, type set, type get, type getOrNull, type dispatch, type getModuleState, registerThunk, useThunk, type UseThunk, ThunkContext, type State, getState, type ModuleState, type ThunkModule, type toDoModule, type doModule, type ThunkFunc, init, type InitParams, update, upsert, remove, genID, type setMap, setDefaultID, getNodeOrNull, getDefaultID, getStateOrNullByModule, getStateByModule, };

package/types/thunkContext/ThunkContext.d.ts

@@ -1,7 +0,0 @@
-import { type ReactNode } from 'react';
-type Props = {
-    modules?: string[];
-    children?: ReactNode;
-};
-declare const ThunkContext: (props: Props) => ReactNode;
-export default ThunkContext;