@dr.pogodin/react-global-state 0.16.1 → 0.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncData.js","names":["_react","require","_uuid","_jsUtils","_GlobalStateProvider","_useGlobalState","_interopRequireDefault","_utils","DEFAULT_MAXAGE","exports","MIN_MS","newAsyncDataEnvelope","initialData","numRefs","timestamp","data","operationId","load","path","loader","globalState","old","uuid","process","env","NODE_ENV","isDebugMode","console","log","operationIdPath","set","definedOld","e","get","dataOrPromise","isAborted","opid","oldDataTimestamp","Promise","state","groupCollapsed","cloneDeepForLog","Date","now","groupEnd","useAsyncData","options","maxage","refreshAge","garbageCollectAge","getGlobalState","initialValue","current","heap","useRef","reload","customLoader","localLoader","Error","ssrContext","noSSR","pending","push","useEffect","numRefsPath","state2","dropDependencies","loadTriggered","deps","hasChangedDependencies","charAt","localState","useGlobalState","loading","Boolean"],"sources":["../../src/useAsyncData.ts"],"sourcesContent":["/**\n * Loads and uses async data into the GlobalState path.\n */\n\nimport { useEffect, useRef } from 'react';\nimport { v4 as uuid } from 'uuid';\n\nimport { MIN_MS } from '@dr.pogodin/js-utils';\n\nimport { getGlobalState } from './GlobalStateProvider';\nimport useGlobalState from './useGlobalState';\n\nimport {\n type ForceT,\n type LockT,\n type TypeLock,\n type ValueAtPathT,\n cloneDeepForLog,\n isDebugMode,\n} from './utils';\n\nimport GlobalState from './GlobalState';\nimport SsrContext from './SsrContext';\n\nexport const DEFAULT_MAXAGE = 5 * MIN_MS; // 5 minutes.\n\nexport type AsyncDataLoaderT<DataT>\n= (oldData: null | DataT, meta: {\n isAborted: () => boolean;\n oldDataTimestamp: number;\n}) => DataT | Promise<DataT | null> | null;\n\nexport type AsyncDataReloaderT<DataT>\n= (loader?: AsyncDataLoaderT<DataT>) => Promise<void>;\n\nexport type AsyncDataEnvelopeT<DataT> = {\n data: null | DataT;\n numRefs: number;\n operationId: string;\n timestamp: number;\n};\n\nexport type OperationIdT = `${'C' | 'S'}${string}`;\n\nexport function newAsyncDataEnvelope<DataT>(\n initialData: DataT | null = null,\n { numRefs = 0, timestamp = 0 } = {},\n): AsyncDataEnvelopeT<DataT> {\n return {\n data: initialData,\n numRefs,\n operationId: '',\n timestamp,\n };\n}\n\nexport type UseAsyncDataOptionsT = {\n deps?: unknown[];\n garbageCollectAge?: number;\n maxage?: number;\n noSSR?: boolean;\n refreshAge?: number;\n};\n\nexport type UseAsyncDataResT<DataT> = {\n data: DataT | null;\n loading: boolean;\n reload: AsyncDataReloaderT<DataT>;\n timestamp: number;\n};\n\n/**\n * Executes the data loading operation.\n * @param path Data segment path inside the global state.\n * @param loader Data loader.\n * @param globalState The global state instance.\n * @param oldData Optional. Previously fetched data, currently stored in\n * the state, if already fetched by the caller; otherwise, they will be fetched\n * by the load() function itself.\n * @param opIdPrefix operationId prefix to use, which should be\n * 'C' at the client-side (default), or 'S' at the server-side (within SSR\n * context).\n * @return Resolves once the operation is done.\n * @ignore\n */\nexport async function load<DataT>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<DataT>,\n globalState: GlobalState<unknown, SsrContext<unknown>>,\n old?: { data: DataT | null, timestamp: number },\n operationId: OperationIdT = `C${uuid()}`,\n): Promise<void> {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.log(\n `ReactGlobalState: async data (re-)loading. Path: \"${path || ''}\"`,\n );\n /* eslint-enable no-console */\n }\n\n const operationIdPath = path ? `${path}.operationId` : 'operationId';\n globalState.set<ForceT, string>(operationIdPath, operationId);\n\n let definedOld = old;\n if (!definedOld) {\n // TODO: Can we improve the typing, to avoid ForceT?\n const e = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path);\n definedOld = { data: e.data, timestamp: e.timestamp };\n }\n\n const dataOrPromise = loader(definedOld.data, {\n isAborted: () => {\n // TODO: Can we improve the typing, to avoid ForceT?\n const opid = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path).operationId;\n return opid !== operationId;\n },\n oldDataTimestamp: definedOld.timestamp,\n });\n\n const data: DataT | null = dataOrPromise instanceof Promise\n ? await dataOrPromise : dataOrPromise;\n\n const state: AsyncDataEnvelopeT<DataT> = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path);\n if (operationId === state.operationId) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.groupCollapsed(\n `ReactGlobalState: async data (re-)loaded. Path: \"${\n path || ''\n }\"`,\n );\n console.log('Data:', cloneDeepForLog(data, path ?? ''));\n /* eslint-enable no-console */\n }\n globalState.set<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n ...state,\n data,\n operationId: '',\n timestamp: Date.now(),\n });\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.groupEnd();\n /* eslint-enable no-console */\n }\n }\n}\n\n/**\n * Resolves asynchronous data, and stores them at given `path` of global\n * state.\n */\n\nexport type DataInEnvelopeAtPathT<\n StateT,\n PathT extends null | string | undefined,\n> = Exclude<Extract<ValueAtPathT<StateT, PathT, void>, AsyncDataEnvelopeT<unknown>>['data'], null>;\n\ntype HeapT<DataT> = {\n // Note: these heap fields are necessary to make reload() a stable function.\n globalState?: GlobalState<unknown>;\n path?: null | string;\n loader?: AsyncDataLoaderT<DataT>;\n reload?: AsyncDataReloaderT<DataT>;\n};\n\nfunction useAsyncData<\n StateT,\n PathT extends null | string | undefined,\n\n DataT extends DataInEnvelopeAtPathT<StateT, PathT> =\n DataInEnvelopeAtPathT<StateT, PathT>,\n>(\n path: PathT,\n loader: AsyncDataLoaderT<DataT>,\n options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<DataT>;\n\nfunction useAsyncData<\n Forced extends ForceT | LockT = LockT,\n DataT = void,\n>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<TypeLock<Forced, void, DataT>>,\n options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n\nfunction useAsyncData<DataT>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<DataT>,\n options: UseAsyncDataOptionsT = {},\n): UseAsyncDataResT<DataT> {\n const maxage: number = options.maxage ?? DEFAULT_MAXAGE;\n const refreshAge: number = options.refreshAge ?? maxage;\n const garbageCollectAge: number = options.garbageCollectAge ?? maxage;\n\n // Note: here we can't depend on useGlobalState() to init the initial value,\n // because that way we'll have issues with SSR (see details below).\n const globalState = getGlobalState();\n const state = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n initialValue: newAsyncDataEnvelope<DataT>(),\n });\n\n const { current: heap } = useRef<HeapT<DataT>>({});\n heap.globalState = globalState;\n heap.path = path;\n heap.loader = loader;\n\n if (!heap.reload) {\n heap.reload = (customLoader?: AsyncDataLoaderT<DataT>) => {\n const localLoader = customLoader || heap.loader;\n if (!localLoader || !heap.globalState) throw Error('Internal error');\n return load(heap.path, localLoader, heap.globalState);\n };\n }\n\n if (globalState.ssrContext && !options.noSSR) {\n if (!state.timestamp && !state.operationId) {\n globalState.ssrContext.pending.push(\n load(path, loader, globalState, {\n data: state.data,\n timestamp: state.timestamp,\n }, `S${uuid()}`),\n );\n }\n } else {\n // This takes care about the client-side reference counting, and garbage\n // collection.\n //\n // Note: the Rules of Hook below are violated by conditional call to a hook,\n // but as the condition is actually server-side or client-side environment,\n // it is effectively non-conditional at the runtime.\n //\n // TODO: Though, maybe there is a way to refactor it into a cleaner code.\n // The same applies to other useEffect() hooks below.\n useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n const numRefsPath = path ? `${path}.numRefs` : 'numRefs';\n const numRefs = globalState.get<ForceT, number>(numRefsPath);\n globalState.set<ForceT, number>(numRefsPath, numRefs + 1);\n return () => {\n const state2: AsyncDataEnvelopeT<DataT> = globalState.get<\n ForceT, AsyncDataEnvelopeT<DataT>>(\n path,\n );\n if (\n state2.numRefs === 1\n && garbageCollectAge < Date.now() - state2.timestamp\n ) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.log(\n `ReactGlobalState - useAsyncData garbage collected at path ${\n path || ''\n }`,\n );\n /* eslint-enable no-console */\n }\n globalState.dropDependencies(path || '');\n globalState.set<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n ...state2,\n data: null,\n numRefs: 0,\n timestamp: 0,\n });\n } else globalState.set<ForceT, number>(numRefsPath, state2.numRefs - 1);\n };\n }, [garbageCollectAge, globalState, path]);\n\n // Note: a bunch of Rules of Hooks ignored belows because in our very\n // special case the otherwise wrong behavior is actually what we need.\n\n // Data loading and refreshing.\n let loadTriggered = false;\n useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n const state2: AsyncDataEnvelopeT<DataT> = globalState.get<\n ForceT, AsyncDataEnvelopeT<DataT>>(path);\n\n const { deps } = options;\n if (\n // The hook is called with a list of dependencies, that mismatch\n // dependencies last used to retrieve the data at given path.\n (deps && globalState.hasChangedDependencies(path || '', deps))\n\n // Data at the path are stale, and are not being loaded.\n || (\n refreshAge < Date.now() - state2.timestamp\n && (!state2.operationId || state2.operationId.charAt(0) === 'S')\n )\n ) {\n loadTriggered = true; // eslint-disable-line react-hooks/exhaustive-deps\n if (!deps) globalState.dropDependencies(path || '');\n load(path, loader, globalState, {\n data: state2.data,\n timestamp: state2.timestamp,\n });\n }\n });\n\n useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n const { deps } = options;\n if (\n deps\n && globalState.hasChangedDependencies(path || '', deps)\n && !loadTriggered\n ) {\n load(path, loader, globalState);\n }\n\n // Here we need to default to empty array, so that this hook is re-evaluated\n // only when dependencies specified in options change, and it should not be\n // re-evaluated at all if no `deps` option is used.\n }, options.deps || []); // eslint-disable-line react-hooks/exhaustive-deps\n }\n\n const [localState] = useGlobalState<ForceT, AsyncDataEnvelopeT<DataT>>(\n path,\n newAsyncDataEnvelope<DataT>(),\n );\n\n return {\n data: maxage < Date.now() - localState.timestamp ? null : localState.data,\n loading: Boolean(localState.operationId),\n reload: heap.reload,\n timestamp: localState.timestamp,\n };\n}\n\nexport { useAsyncData };\n\nexport interface UseAsyncDataI<StateT> {\n <PathT extends null | string | undefined>(\n path: PathT,\n loader: AsyncDataLoaderT<DataInEnvelopeAtPathT<StateT, PathT>>,\n options?: UseAsyncDataOptionsT,\n ): UseAsyncDataResT<DataInEnvelopeAtPathT<StateT, PathT>>;\n\n <Forced extends ForceT | LockT = LockT, DataT = unknown>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<TypeLock<Forced, void, DataT>>,\n options?: UseAsyncDataOptionsT,\n ): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n}\n"],"mappings":";;;;;;;;;;AAIA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,KAAA,GAAAD,OAAA;AAEA,IAAAE,QAAA,GAAAF,OAAA;AAEA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,eAAA,GAAAC,sBAAA,CAAAL,OAAA;AAEA,IAAAM,MAAA,GAAAN,OAAA;AAZA;AACA;AACA;;AAsBO,MAAMO,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,CAAC,GAAGE,eAAM,CAAC,CAAC;;AAoBnC,SAASC,oBAAoBA,CAClCC,WAAyB,GAAG,IAAI,EAChC;EAAEC,OAAO,GAAG,CAAC;EAAEC,SAAS,GAAG;AAAE,CAAC,GAAG,CAAC,CAAC,EACR;EAC3B,OAAO;IACLC,IAAI,EAAEH,WAAW;IACjBC,OAAO;IACPG,WAAW,EAAE,EAAE;IACfF;EACF,CAAC;AACH;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeG,IAAIA,CACxBC,IAA+B,EAC/BC,MAA+B,EAC/BC,WAAsD,EACtDC,GAA+C,EAC/CL,WAAyB,GAAG,IAAI,IAAAM,QAAI,EAAC,CAAC,EAAE,EACzB;EACf,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;IAC1D;IACAC,OAAO,CAACC,GAAG,CACT,qDAAqDV,IAAI,IAAI,EAAE,GACjE,CAAC;IACD;EACF;EAEA,MAAMW,eAAe,GAAGX,IAAI,GAAG,GAAGA,IAAI,cAAc,GAAG,aAAa;EACpEE,WAAW,CAACU,GAAG,CAAiBD,eAAe,EAAEb,WAAW,CAAC;EAE7D,IAAIe,UAAU,GAAGV,GAAG;EACpB,IAAI,CAACU,UAAU,EAAE;IACf;IACA,MAAMC,CAAC,GAAGZ,WAAW,CAACa,GAAG,CAAoCf,IAAI,CAAC;IAClEa,UAAU,GAAG;MAAEhB,IAAI,EAAEiB,CAAC,CAACjB,IAAI;MAAED,SAAS,EAAEkB,CAAC,CAAClB;IAAU,CAAC;EACvD;EAEA,MAAMoB,aAAa,GAAGf,MAAM,CAACY,UAAU,CAAChB,IAAI,EAAE;IAC5CoB,SAAS,EAAEA,CAAA,KAAM;MACf;MACA,MAAMC,IAAI,GAAGhB,WAAW,CAACa,GAAG,CAAoCf,IAAI,CAAC,CAACF,WAAW;MACjF,OAAOoB,IAAI,KAAKpB,WAAW;IAC7B,CAAC;IACDqB,gBAAgB,EAAEN,UAAU,CAACjB;EAC/B,CAAC,CAAC;EAEF,MAAMC,IAAkB,GAAGmB,aAAa,YAAYI,OAAO,GACvD,MAAMJ,aAAa,GAAGA,aAAa;EAEvC,MAAMK,KAAgC,GAAGnB,WAAW,CAACa,GAAG,CAAoCf,IAAI,CAAC;EACjG,IAAIF,WAAW,KAAKuB,KAAK,CAACvB,WAAW,EAAE;IACrC,IAAIO,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACAC,OAAO,CAACa,cAAc,CACpB,oDACEtB,IAAI,IAAI,EAAE,GAEd,CAAC;MACDS,OAAO,CAACC,GAAG,CAAC,OAAO,EAAE,IAAAa,sBAAe,EAAC1B,IAAI,EAAEG,IAAI,IAAI,EAAE,CAAC,CAAC;MACvD;IACF;IACAE,WAAW,CAACU,GAAG,CAAoCZ,IAAI,EAAE;MACvD,GAAGqB,KAAK;MACRxB,IAAI;MACJC,WAAW,EAAE,EAAE;MACfF,SAAS,EAAE4B,IAAI,CAACC,GAAG,CAAC;IACtB,CAAC,CAAC;IACF,IAAIpB,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACAC,OAAO,CAACiB,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;AACF;;AAEA;AACA;AACA;AACA;;AAoCA,SAASC,YAAYA,CACnB3B,IAA+B,EAC/BC,MAA+B,EAC/B2B,OAA6B,GAAG,CAAC,CAAC,EACT;EACzB,MAAMC,MAAc,GAAGD,OAAO,CAACC,MAAM,IAAIvC,cAAc;EACvD,MAAMwC,UAAkB,GAAGF,OAAO,CAACE,UAAU,IAAID,MAAM;EACvD,MAAME,iBAAyB,GAAGH,OAAO,CAACG,iBAAiB,IAAIF,MAAM;;EAErE;EACA;EACA,MAAM3B,WAAW,GAAG,IAAA8B,mCAAc,EAAC,CAAC;EACpC,MAAMX,KAAK,GAAGnB,WAAW,CAACa,GAAG,CAAoCf,IAAI,EAAE;IACrEiC,YAAY,EAAExC,oBAAoB,CAAQ;EAC5C,CAAC,CAAC;EAEF,MAAM;IAAEyC,OAAO,EAAEC;EAAK,CAAC,GAAG,IAAAC,aAAM,EAAe,CAAC,CAAC,CAAC;EAClDD,IAAI,CAACjC,WAAW,GAAGA,WAAW;EAC9BiC,IAAI,CAACnC,IAAI,GAAGA,IAAI;EAChBmC,IAAI,CAAClC,MAAM,GAAGA,MAAM;EAEpB,IAAI,CAACkC,IAAI,CAACE,MAAM,EAAE;IAChBF,IAAI,CAACE,MAAM,GAAIC,YAAsC,IAAK;MACxD,MAAMC,WAAW,GAAGD,YAAY,IAAIH,IAAI,CAAClC,MAAM;MAC/C,IAAI,CAACsC,WAAW,IAAI,CAACJ,IAAI,CAACjC,WAAW,EAAE,MAAMsC,KAAK,CAAC,gBAAgB,CAAC;MACpE,OAAOzC,IAAI,CAACoC,IAAI,CAACnC,IAAI,EAAEuC,WAAW,EAAEJ,IAAI,CAACjC,WAAW,CAAC;IACvD,CAAC;EACH;EAEA,IAAIA,WAAW,CAACuC,UAAU,IAAI,CAACb,OAAO,CAACc,KAAK,EAAE;IAC5C,IAAI,CAACrB,KAAK,CAACzB,SAAS,IAAI,CAACyB,KAAK,CAACvB,WAAW,EAAE;MAC1CI,WAAW,CAACuC,UAAU,CAACE,OAAO,CAACC,IAAI,CACjC7C,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE;QAC9BL,IAAI,EAAEwB,KAAK,CAACxB,IAAI;QAChBD,SAAS,EAAEyB,KAAK,CAACzB;MACnB,CAAC,EAAE,IAAI,IAAAQ,QAAI,EAAC,CAAC,EAAE,CACjB,CAAC;IACH;EACF,CAAC,MAAM;IACL;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA,IAAAyC,gBAAS,EAAC,MAAM;MAAE;MAChB,MAAMC,WAAW,GAAG9C,IAAI,GAAG,GAAGA,IAAI,UAAU,GAAG,SAAS;MACxD,MAAML,OAAO,GAAGO,WAAW,CAACa,GAAG,CAAiB+B,WAAW,CAAC;MAC5D5C,WAAW,CAACU,GAAG,CAAiBkC,WAAW,EAAEnD,OAAO,GAAG,CAAC,CAAC;MACzD,OAAO,MAAM;QACX,MAAMoD,MAAiC,GAAG7C,WAAW,CAACa,GAAG,CAEvDf,IACF,CAAC;QACD,IACE+C,MAAM,CAACpD,OAAO,KAAK,CAAC,IACjBoC,iBAAiB,GAAGP,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGsB,MAAM,CAACnD,SAAS,EACpD;UACA,IAAIS,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;YAC1D;YACAC,OAAO,CAACC,GAAG,CACT,6DACEV,IAAI,IAAI,EAAE,EAEd,CAAC;YACD;UACF;UACAE,WAAW,CAAC8C,gBAAgB,CAAChD,IAAI,IAAI,EAAE,CAAC;UACxCE,WAAW,CAACU,GAAG,CAAoCZ,IAAI,EAAE;YACvD,GAAG+C,MAAM;YACTlD,IAAI,EAAE,IAAI;YACVF,OAAO,EAAE,CAAC;YACVC,SAAS,EAAE;UACb,CAAC,CAAC;QACJ,CAAC,MAAMM,WAAW,CAACU,GAAG,CAAiBkC,WAAW,EAAEC,MAAM,CAACpD,OAAO,GAAG,CAAC,CAAC;MACzE,CAAC;IACH,CAAC,EAAE,CAACoC,iBAAiB,EAAE7B,WAAW,EAAEF,IAAI,CAAC,CAAC;;IAE1C;IACA;;IAEA;IACA,IAAIiD,aAAa,GAAG,KAAK;IACzB,IAAAJ,gBAAS,EAAC,MAAM;MAAE;MAChB,MAAME,MAAiC,GAAG7C,WAAW,CAACa,GAAG,CACtBf,IAAI,CAAC;MAExC,MAAM;QAAEkD;MAAK,CAAC,GAAGtB,OAAO;MACxB;MACE;MACA;MACCsB,IAAI,IAAIhD,WAAW,CAACiD,sBAAsB,CAACnD,IAAI,IAAI,EAAE,EAAEkD,IAAI;;MAE5D;MAAA,GAEEpB,UAAU,GAAGN,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGsB,MAAM,CAACnD,SAAS,KACtC,CAACmD,MAAM,CAACjD,WAAW,IAAIiD,MAAM,CAACjD,WAAW,CAACsD,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAChE,EACD;QACAH,aAAa,GAAG,IAAI,CAAC,CAAC;QACtB,IAAI,CAACC,IAAI,EAAEhD,WAAW,CAAC8C,gBAAgB,CAAChD,IAAI,IAAI,EAAE,CAAC;QACnDD,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE;UAC9BL,IAAI,EAAEkD,MAAM,CAAClD,IAAI;UACjBD,SAAS,EAAEmD,MAAM,CAACnD;QACpB,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,IAAAiD,gBAAS,EAAC,MAAM;MAAE;MAChB,MAAM;QAAEK;MAAK,CAAC,GAAGtB,OAAO;MACxB,IACEsB,IAAI,IACDhD,WAAW,CAACiD,sBAAsB,CAACnD,IAAI,IAAI,EAAE,EAAEkD,IAAI,CAAC,IACpD,CAACD,aAAa,EACjB;QACAlD,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,CAAC;MACjC;;MAEF;MACA;MACA;IACA,CAAC,EAAE0B,OAAO,CAACsB,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;EAC1B;EAEA,MAAM,CAACG,UAAU,CAAC,GAAG,IAAAC,uBAAc,EACjCtD,IAAI,EACJP,oBAAoB,CAAQ,CAC9B,CAAC;EAED,OAAO;IACLI,IAAI,EAAEgC,MAAM,GAAGL,IAAI,CAACC,GAAG,CAAC,CAAC,GAAG4B,UAAU,CAACzD,SAAS,GAAG,IAAI,GAAGyD,UAAU,CAACxD,IAAI;IACzE0D,OAAO,EAAEC,OAAO,CAACH,UAAU,CAACvD,WAAW,CAAC;IACxCuC,MAAM,EAAEF,IAAI,CAACE,MAAM;IACnBzC,SAAS,EAAEyD,UAAU,CAACzD;EACxB,CAAC;AACH","ignoreList":[]}
1
+ {"version":3,"file":"useAsyncData.js","names":["_react","require","_uuid","_jsUtils","_GlobalStateProvider","_useGlobalState","_interopRequireDefault","_utils","DEFAULT_MAXAGE","exports","MIN_MS","newAsyncDataEnvelope","initialData","numRefs","timestamp","data","operationId","load","path","loader","globalState","old","uuid","process","env","NODE_ENV","isDebugMode","console","log","operationIdPath","prevOperationId","get","asyncDataLoadDone","set","definedOld","e","dataOrPromise","isAborted","opid","oldDataTimestamp","setAbortCallback","cb","Error","setAsyncDataAbortCallback","Promise","state","groupCollapsed","cloneDeepForLog","Date","now","groupEnd","useAsyncData","options","maxage","refreshAge","garbageCollectAge","getGlobalState","initialValue","current","heap","useRef","reload","customLoader","localLoader","ssrContext","noSSR","pending","push","useEffect","numRefsPath","state2","dropDependencies","deps","hasChangedDependencies","charAt","localState","useGlobalState","loading","Boolean"],"sources":["../../src/useAsyncData.ts"],"sourcesContent":["/**\n * Loads and uses async data into the GlobalState path.\n */\n\nimport { useEffect, useRef } from 'react';\nimport { v4 as uuid } from 'uuid';\n\nimport { MIN_MS } from '@dr.pogodin/js-utils';\n\nimport { getGlobalState } from './GlobalStateProvider';\nimport useGlobalState from './useGlobalState';\n\nimport {\n type ForceT,\n type LockT,\n type TypeLock,\n type ValueAtPathT,\n cloneDeepForLog,\n isDebugMode,\n} from './utils';\n\nimport GlobalState from './GlobalState';\nimport SsrContext from './SsrContext';\n\nexport const DEFAULT_MAXAGE = 5 * MIN_MS; // 5 minutes.\n\nexport type AsyncDataLoaderT<DataT>\n= (oldData: null | DataT, meta: {\n isAborted: () => boolean;\n oldDataTimestamp: number;\n setAbortCallback: (cb: () => void) => void;\n}) => DataT | Promise<DataT | null> | null;\n\nexport type AsyncDataReloaderT<DataT>\n= (loader?: AsyncDataLoaderT<DataT>) => Promise<void>;\n\nexport type AsyncDataEnvelopeT<DataT> = {\n data: null | DataT;\n numRefs: number;\n operationId: string;\n timestamp: number;\n};\n\nexport type OperationIdT = `${'C' | 'S'}${string}`;\n\nexport function newAsyncDataEnvelope<DataT>(\n initialData: DataT | null = null,\n { numRefs = 0, timestamp = 0 } = {},\n): AsyncDataEnvelopeT<DataT> {\n return {\n data: initialData,\n numRefs,\n operationId: '',\n timestamp,\n };\n}\n\nexport type UseAsyncDataOptionsT = {\n deps?: unknown[];\n garbageCollectAge?: number;\n maxage?: number;\n noSSR?: boolean;\n refreshAge?: number;\n};\n\nexport type UseAsyncDataResT<DataT> = {\n data: DataT | null;\n loading: boolean;\n reload: AsyncDataReloaderT<DataT>;\n timestamp: number;\n};\n\n/**\n * Executes the data loading operation.\n * @param path Data segment path inside the global state.\n * @param loader Data loader.\n * @param globalState The global state instance.\n * @param oldData Optional. Previously fetched data, currently stored in\n * the state, if already fetched by the caller; otherwise, they will be fetched\n * by the load() function itself.\n * @param opIdPrefix operationId prefix to use, which should be\n * 'C' at the client-side (default), or 'S' at the server-side (within SSR\n * context).\n * @return Resolves once the operation is done.\n * @ignore\n */\nexport async function load<DataT>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<DataT>,\n globalState: GlobalState<unknown, SsrContext<unknown>>,\n old?: { data: DataT | null, timestamp: number },\n\n // TODO: Should this parameter be just a binary flag (client or server),\n // and UUID always generated inside this function? Or do we need it in\n // the caller methods as well, in some cases (see useAsyncCollection()\n // use case as well).\n operationId: OperationIdT = `C${uuid()}`,\n): Promise<void> {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.log(\n `ReactGlobalState: async data (re-)loading. Path: \"${path || ''}\"`,\n );\n /* eslint-enable no-console */\n }\n\n const operationIdPath = path ? `${path}.operationId` : 'operationId';\n {\n const prevOperationId = globalState.get<ForceT, string>(operationIdPath);\n if (prevOperationId) globalState.asyncDataLoadDone(prevOperationId, true);\n }\n globalState.set<ForceT, string>(operationIdPath, operationId);\n\n let definedOld = old;\n if (!definedOld) {\n // TODO: Can we improve the typing, to avoid ForceT?\n const e = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path);\n definedOld = { data: e.data, timestamp: e.timestamp };\n }\n\n const dataOrPromise = loader(definedOld.data, {\n isAborted: () => {\n // TODO: Can we improve the typing, to avoid ForceT?\n const opid = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path).operationId;\n return opid !== operationId;\n },\n oldDataTimestamp: definedOld.timestamp,\n setAbortCallback(cb: () => void) {\n const opid = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path).operationId;\n if (opid !== operationId) {\n throw Error(`Operation #${operationId} has completed already`);\n }\n globalState.setAsyncDataAbortCallback(operationId, cb);\n },\n });\n\n let data: DataT | null;\n\n try {\n data = dataOrPromise instanceof Promise\n ? await dataOrPromise : dataOrPromise;\n } finally {\n // NOTE: We don't really mean that it hasn't been aborted,\n // the \"false\" flag rather says we don't need to trigger \"on aborted\"\n // callback for this operation, if any is registered - just drop it.\n globalState.asyncDataLoadDone(operationId, false);\n }\n\n const state: AsyncDataEnvelopeT<DataT> = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path);\n if (operationId === state.operationId) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.groupCollapsed(\n `ReactGlobalState: async data (re-)loaded. Path: \"${\n path || ''\n }\"`,\n );\n console.log('Data:', cloneDeepForLog(data, path ?? ''));\n /* eslint-enable no-console */\n }\n globalState.set<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n ...state,\n data,\n operationId: '',\n timestamp: Date.now(),\n });\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.groupEnd();\n /* eslint-enable no-console */\n }\n }\n}\n\n/**\n * Resolves asynchronous data, and stores them at given `path` of global\n * state.\n */\n\nexport type DataInEnvelopeAtPathT<\n StateT,\n PathT extends null | string | undefined,\n> = Exclude<Extract<ValueAtPathT<StateT, PathT, void>, AsyncDataEnvelopeT<unknown>>['data'], null>;\n\ntype HeapT<DataT> = {\n // Note: these heap fields are necessary to make reload() a stable function.\n globalState?: GlobalState<unknown>;\n path?: null | string;\n loader?: AsyncDataLoaderT<DataT>;\n reload?: AsyncDataReloaderT<DataT>;\n};\n\nfunction useAsyncData<\n StateT,\n PathT extends null | string | undefined,\n\n DataT extends DataInEnvelopeAtPathT<StateT, PathT> =\n DataInEnvelopeAtPathT<StateT, PathT>,\n>(\n path: PathT,\n loader: AsyncDataLoaderT<DataT>,\n options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<DataT>;\n\nfunction useAsyncData<\n Forced extends ForceT | LockT = LockT,\n DataT = void,\n>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<TypeLock<Forced, void, DataT>>,\n options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n\nfunction useAsyncData<DataT>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<DataT>,\n options: UseAsyncDataOptionsT = {},\n): UseAsyncDataResT<DataT> {\n const maxage: number = options.maxage ?? DEFAULT_MAXAGE;\n const refreshAge: number = options.refreshAge ?? maxage;\n const garbageCollectAge: number = options.garbageCollectAge ?? maxage;\n\n // Note: here we can't depend on useGlobalState() to init the initial value,\n // because that way we'll have issues with SSR (see details below).\n const globalState = getGlobalState();\n const state = globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n initialValue: newAsyncDataEnvelope<DataT>(),\n });\n\n const { current: heap } = useRef<HeapT<DataT>>({});\n heap.globalState = globalState;\n heap.path = path;\n heap.loader = loader;\n\n if (!heap.reload) {\n heap.reload = (customLoader?: AsyncDataLoaderT<DataT>) => {\n const localLoader = customLoader || heap.loader;\n if (!localLoader || !heap.globalState) throw Error('Internal error');\n return load(heap.path, localLoader, heap.globalState);\n };\n }\n\n if (globalState.ssrContext && !options.noSSR) {\n if (!state.timestamp && !state.operationId) {\n globalState.ssrContext.pending.push(\n load(path, loader, globalState, {\n data: state.data,\n timestamp: state.timestamp,\n }, `S${uuid()}`),\n );\n }\n } else {\n // This takes care about the client-side reference counting, and garbage\n // collection.\n //\n // Note: the Rules of Hook below are violated by conditional call to a hook,\n // but as the condition is actually server-side or client-side environment,\n // it is effectively non-conditional at the runtime.\n //\n // TODO: Though, maybe there is a way to refactor it into a cleaner code.\n // The same applies to other useEffect() hooks below.\n useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n const numRefsPath = path ? `${path}.numRefs` : 'numRefs';\n const numRefs = globalState.get<ForceT, number>(numRefsPath);\n globalState.set<ForceT, number>(numRefsPath, numRefs + 1);\n return () => {\n const state2: AsyncDataEnvelopeT<DataT> = globalState.get<\n ForceT, AsyncDataEnvelopeT<DataT>>(\n path,\n );\n if (\n state2.numRefs === 1\n && garbageCollectAge < Date.now() - state2.timestamp\n ) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n console.log(\n `ReactGlobalState - useAsyncData garbage collected at path ${\n path || ''\n }`,\n );\n /* eslint-enable no-console */\n }\n globalState.dropDependencies(path || '');\n globalState.set<ForceT, AsyncDataEnvelopeT<DataT>>(path, {\n ...state2,\n data: null,\n numRefs: 0,\n timestamp: 0,\n });\n } else globalState.set<ForceT, number>(numRefsPath, state2.numRefs - 1);\n };\n }, [garbageCollectAge, globalState, path]);\n\n // Note: a bunch of Rules of Hooks ignored belows because in our very\n // special case the otherwise wrong behavior is actually what we need.\n\n // Data loading and refreshing.\n useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n const state2: AsyncDataEnvelopeT<DataT> = globalState.get<\n ForceT, AsyncDataEnvelopeT<DataT>>(path);\n\n const { deps } = options;\n if (\n // The hook is called with a list of dependencies, that mismatch\n // dependencies last used to retrieve the data at given path.\n (deps && globalState.hasChangedDependencies(path || '', deps))\n\n // Data at the path are stale, and are not being loaded.\n || (\n refreshAge < Date.now() - state2.timestamp\n && (!state2.operationId || state2.operationId.charAt(0) === 'S')\n )\n ) {\n if (!deps) globalState.dropDependencies(path || '');\n load(path, loader, globalState, {\n data: state2.data,\n timestamp: state2.timestamp,\n });\n }\n });\n }\n\n const [localState] = useGlobalState<ForceT, AsyncDataEnvelopeT<DataT>>(\n path,\n newAsyncDataEnvelope<DataT>(),\n );\n\n return {\n data: maxage < Date.now() - localState.timestamp ? null : localState.data,\n loading: Boolean(localState.operationId),\n reload: heap.reload,\n timestamp: localState.timestamp,\n };\n}\n\nexport { useAsyncData };\n\nexport interface UseAsyncDataI<StateT> {\n <PathT extends null | string | undefined>(\n path: PathT,\n loader: AsyncDataLoaderT<DataInEnvelopeAtPathT<StateT, PathT>>,\n options?: UseAsyncDataOptionsT,\n ): UseAsyncDataResT<DataInEnvelopeAtPathT<StateT, PathT>>;\n\n <Forced extends ForceT | LockT = LockT, DataT = unknown>(\n path: null | string | undefined,\n loader: AsyncDataLoaderT<TypeLock<Forced, void, DataT>>,\n options?: UseAsyncDataOptionsT,\n ): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n}\n"],"mappings":";;;;;;;;;;AAIA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,KAAA,GAAAD,OAAA;AAEA,IAAAE,QAAA,GAAAF,OAAA;AAEA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,eAAA,GAAAC,sBAAA,CAAAL,OAAA;AAEA,IAAAM,MAAA,GAAAN,OAAA;AAZA;AACA;AACA;;AAsBO,MAAMO,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,CAAC,GAAGE,eAAM,CAAC,CAAC;;AAqBnC,SAASC,oBAAoBA,CAClCC,WAAyB,GAAG,IAAI,EAChC;EAAEC,OAAO,GAAG,CAAC;EAAEC,SAAS,GAAG;AAAE,CAAC,GAAG,CAAC,CAAC,EACR;EAC3B,OAAO;IACLC,IAAI,EAAEH,WAAW;IACjBC,OAAO;IACPG,WAAW,EAAE,EAAE;IACfF;EACF,CAAC;AACH;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeG,IAAIA,CACxBC,IAA+B,EAC/BC,MAA+B,EAC/BC,WAAsD,EACtDC,GAA+C;AAE/C;AACA;AACA;AACA;AACAL,WAAyB,GAAG,IAAI,IAAAM,QAAI,EAAC,CAAC,EAAE,EACzB;EACf,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;IAC1D;IACAC,OAAO,CAACC,GAAG,CACT,qDAAqDV,IAAI,IAAI,EAAE,GACjE,CAAC;IACD;EACF;EAEA,MAAMW,eAAe,GAAGX,IAAI,GAAG,GAAGA,IAAI,cAAc,GAAG,aAAa;EACpE;IACE,MAAMY,eAAe,GAAGV,WAAW,CAACW,GAAG,CAAiBF,eAAe,CAAC;IACxE,IAAIC,eAAe,EAAEV,WAAW,CAACY,iBAAiB,CAACF,eAAe,EAAE,IAAI,CAAC;EAC3E;EACAV,WAAW,CAACa,GAAG,CAAiBJ,eAAe,EAAEb,WAAW,CAAC;EAE7D,IAAIkB,UAAU,GAAGb,GAAG;EACpB,IAAI,CAACa,UAAU,EAAE;IACf;IACA,MAAMC,CAAC,GAAGf,WAAW,CAACW,GAAG,CAAoCb,IAAI,CAAC;IAClEgB,UAAU,GAAG;MAAEnB,IAAI,EAAEoB,CAAC,CAACpB,IAAI;MAAED,SAAS,EAAEqB,CAAC,CAACrB;IAAU,CAAC;EACvD;EAEA,MAAMsB,aAAa,GAAGjB,MAAM,CAACe,UAAU,CAACnB,IAAI,EAAE;IAC5CsB,SAAS,EAAEA,CAAA,KAAM;MACf;MACA,MAAMC,IAAI,GAAGlB,WAAW,CAACW,GAAG,CAAoCb,IAAI,CAAC,CAACF,WAAW;MACjF,OAAOsB,IAAI,KAAKtB,WAAW;IAC7B,CAAC;IACDuB,gBAAgB,EAAEL,UAAU,CAACpB,SAAS;IACtC0B,gBAAgBA,CAACC,EAAc,EAAE;MAC/B,MAAMH,IAAI,GAAGlB,WAAW,CAACW,GAAG,CAAoCb,IAAI,CAAC,CAACF,WAAW;MACjF,IAAIsB,IAAI,KAAKtB,WAAW,EAAE;QACxB,MAAM0B,KAAK,CAAC,cAAc1B,WAAW,wBAAwB,CAAC;MAChE;MACAI,WAAW,CAACuB,yBAAyB,CAAC3B,WAAW,EAAEyB,EAAE,CAAC;IACxD;EACF,CAAC,CAAC;EAEF,IAAI1B,IAAkB;EAEtB,IAAI;IACFA,IAAI,GAAGqB,aAAa,YAAYQ,OAAO,GACnC,MAAMR,aAAa,GAAGA,aAAa;EACzC,CAAC,SAAS;IACR;IACA;IACA;IACAhB,WAAW,CAACY,iBAAiB,CAAChB,WAAW,EAAE,KAAK,CAAC;EACnD;EAEA,MAAM6B,KAAgC,GAAGzB,WAAW,CAACW,GAAG,CAAoCb,IAAI,CAAC;EACjG,IAAIF,WAAW,KAAK6B,KAAK,CAAC7B,WAAW,EAAE;IACrC,IAAIO,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACAC,OAAO,CAACmB,cAAc,CACpB,oDACE5B,IAAI,IAAI,EAAE,GAEd,CAAC;MACDS,OAAO,CAACC,GAAG,CAAC,OAAO,EAAE,IAAAmB,sBAAe,EAAChC,IAAI,EAAEG,IAAI,IAAI,EAAE,CAAC,CAAC;MACvD;IACF;IACAE,WAAW,CAACa,GAAG,CAAoCf,IAAI,EAAE;MACvD,GAAG2B,KAAK;MACR9B,IAAI;MACJC,WAAW,EAAE,EAAE;MACfF,SAAS,EAAEkC,IAAI,CAACC,GAAG,CAAC;IACtB,CAAC,CAAC;IACF,IAAI1B,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACAC,OAAO,CAACuB,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;AACF;;AAEA;AACA;AACA;AACA;;AAoCA,SAASC,YAAYA,CACnBjC,IAA+B,EAC/BC,MAA+B,EAC/BiC,OAA6B,GAAG,CAAC,CAAC,EACT;EACzB,MAAMC,MAAc,GAAGD,OAAO,CAACC,MAAM,IAAI7C,cAAc;EACvD,MAAM8C,UAAkB,GAAGF,OAAO,CAACE,UAAU,IAAID,MAAM;EACvD,MAAME,iBAAyB,GAAGH,OAAO,CAACG,iBAAiB,IAAIF,MAAM;;EAErE;EACA;EACA,MAAMjC,WAAW,GAAG,IAAAoC,mCAAc,EAAC,CAAC;EACpC,MAAMX,KAAK,GAAGzB,WAAW,CAACW,GAAG,CAAoCb,IAAI,EAAE;IACrEuC,YAAY,EAAE9C,oBAAoB,CAAQ;EAC5C,CAAC,CAAC;EAEF,MAAM;IAAE+C,OAAO,EAAEC;EAAK,CAAC,GAAG,IAAAC,aAAM,EAAe,CAAC,CAAC,CAAC;EAClDD,IAAI,CAACvC,WAAW,GAAGA,WAAW;EAC9BuC,IAAI,CAACzC,IAAI,GAAGA,IAAI;EAChByC,IAAI,CAACxC,MAAM,GAAGA,MAAM;EAEpB,IAAI,CAACwC,IAAI,CAACE,MAAM,EAAE;IAChBF,IAAI,CAACE,MAAM,GAAIC,YAAsC,IAAK;MACxD,MAAMC,WAAW,GAAGD,YAAY,IAAIH,IAAI,CAACxC,MAAM;MAC/C,IAAI,CAAC4C,WAAW,IAAI,CAACJ,IAAI,CAACvC,WAAW,EAAE,MAAMsB,KAAK,CAAC,gBAAgB,CAAC;MACpE,OAAOzB,IAAI,CAAC0C,IAAI,CAACzC,IAAI,EAAE6C,WAAW,EAAEJ,IAAI,CAACvC,WAAW,CAAC;IACvD,CAAC;EACH;EAEA,IAAIA,WAAW,CAAC4C,UAAU,IAAI,CAACZ,OAAO,CAACa,KAAK,EAAE;IAC5C,IAAI,CAACpB,KAAK,CAAC/B,SAAS,IAAI,CAAC+B,KAAK,CAAC7B,WAAW,EAAE;MAC1CI,WAAW,CAAC4C,UAAU,CAACE,OAAO,CAACC,IAAI,CACjClD,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE;QAC9BL,IAAI,EAAE8B,KAAK,CAAC9B,IAAI;QAChBD,SAAS,EAAE+B,KAAK,CAAC/B;MACnB,CAAC,EAAE,IAAI,IAAAQ,QAAI,EAAC,CAAC,EAAE,CACjB,CAAC;IACH;EACF,CAAC,MAAM;IACL;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA,IAAA8C,gBAAS,EAAC,MAAM;MAAE;MAChB,MAAMC,WAAW,GAAGnD,IAAI,GAAG,GAAGA,IAAI,UAAU,GAAG,SAAS;MACxD,MAAML,OAAO,GAAGO,WAAW,CAACW,GAAG,CAAiBsC,WAAW,CAAC;MAC5DjD,WAAW,CAACa,GAAG,CAAiBoC,WAAW,EAAExD,OAAO,GAAG,CAAC,CAAC;MACzD,OAAO,MAAM;QACX,MAAMyD,MAAiC,GAAGlD,WAAW,CAACW,GAAG,CAEvDb,IACF,CAAC;QACD,IACEoD,MAAM,CAACzD,OAAO,KAAK,CAAC,IACjB0C,iBAAiB,GAAGP,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGqB,MAAM,CAACxD,SAAS,EACpD;UACA,IAAIS,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;YAC1D;YACAC,OAAO,CAACC,GAAG,CACT,6DACEV,IAAI,IAAI,EAAE,EAEd,CAAC;YACD;UACF;UACAE,WAAW,CAACmD,gBAAgB,CAACrD,IAAI,IAAI,EAAE,CAAC;UACxCE,WAAW,CAACa,GAAG,CAAoCf,IAAI,EAAE;YACvD,GAAGoD,MAAM;YACTvD,IAAI,EAAE,IAAI;YACVF,OAAO,EAAE,CAAC;YACVC,SAAS,EAAE;UACb,CAAC,CAAC;QACJ,CAAC,MAAMM,WAAW,CAACa,GAAG,CAAiBoC,WAAW,EAAEC,MAAM,CAACzD,OAAO,GAAG,CAAC,CAAC;MACzE,CAAC;IACH,CAAC,EAAE,CAAC0C,iBAAiB,EAAEnC,WAAW,EAAEF,IAAI,CAAC,CAAC;;IAE1C;IACA;;IAEA;IACA,IAAAkD,gBAAS,EAAC,MAAM;MAAE;MAChB,MAAME,MAAiC,GAAGlD,WAAW,CAACW,GAAG,CACtBb,IAAI,CAAC;MAExC,MAAM;QAAEsD;MAAK,CAAC,GAAGpB,OAAO;MACxB;MACE;MACA;MACCoB,IAAI,IAAIpD,WAAW,CAACqD,sBAAsB,CAACvD,IAAI,IAAI,EAAE,EAAEsD,IAAI;;MAE5D;MAAA,GAEElB,UAAU,GAAGN,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGqB,MAAM,CAACxD,SAAS,KACtC,CAACwD,MAAM,CAACtD,WAAW,IAAIsD,MAAM,CAACtD,WAAW,CAAC0D,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAChE,EACD;QACA,IAAI,CAACF,IAAI,EAAEpD,WAAW,CAACmD,gBAAgB,CAACrD,IAAI,IAAI,EAAE,CAAC;QACnDD,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE;UAC9BL,IAAI,EAAEuD,MAAM,CAACvD,IAAI;UACjBD,SAAS,EAAEwD,MAAM,CAACxD;QACpB,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;EACJ;EAEA,MAAM,CAAC6D,UAAU,CAAC,GAAG,IAAAC,uBAAc,EACjC1D,IAAI,EACJP,oBAAoB,CAAQ,CAC9B,CAAC;EAED,OAAO;IACLI,IAAI,EAAEsC,MAAM,GAAGL,IAAI,CAACC,GAAG,CAAC,CAAC,GAAG0B,UAAU,CAAC7D,SAAS,GAAG,IAAI,GAAG6D,UAAU,CAAC5D,IAAI;IACzE8D,OAAO,EAAEC,OAAO,CAACH,UAAU,CAAC3D,WAAW,CAAC;IACxC6C,MAAM,EAAEF,IAAI,CAACE,MAAM;IACnB/C,SAAS,EAAE6D,UAAU,CAAC7D;EACxB,CAAC;AACH","ignoreList":[]}
@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.cloneDeepForLog = cloneDeepForLog;
7
+ exports.escape = escape;
8
+ exports.hash = hash;
7
9
  exports.isDebugMode = isDebugMode;
8
10
  var _lodash = require("lodash");
9
11
  // TODO: This (ForceT, LockT, and TypeLock) probably should be moved to JS Utils
@@ -52,6 +54,7 @@ const cloneDeepBailKeys = new Set();
52
54
  */
53
55
  function cloneDeepForLog(value, key = '') {
54
56
  if (cloneDeepBailKeys.has(key)) {
57
+ // eslint-disable-next-line no-console
55
58
  console.warn(`The logged value won't be clonned (key "${key}").`);
56
59
  return value;
57
60
  }
@@ -59,9 +62,30 @@ function cloneDeepForLog(value, key = '') {
59
62
  const res = (0, _lodash.cloneDeep)(value);
60
63
  const time = Date.now() - start;
61
64
  if (time > 300) {
65
+ // eslint-disable-next-line no-console
62
66
  console.warn(`${time}ms spent to clone the logged value (key "${key}").`);
63
67
  cloneDeepBailKeys.add(key);
64
68
  }
65
69
  return res;
66
70
  }
71
+
72
+ /**
73
+ * Converts given value to an escaped string. For now, we are good with the most
74
+ * trivial escape logic:
75
+ * - '%' characters are replaced by '%0' code pair;
76
+ * - '/' characters are replaced by '%1' code pair.
77
+ */
78
+ function escape(x) {
79
+ return typeof x === 'string' ? x.replace(/%/g, '%0').replace(/\//g, '%1') : x.toString();
80
+ }
81
+
82
+ /**
83
+ * Hashes given string array. For our current needs we are fine to go with
84
+ * the most trivial implementation, which probably should not be called "hash"
85
+ * in the strict sense: we just escape each given string to not include '/'
86
+ * characters, and then we join all those strings using '/' as the separator.
87
+ */
88
+ function hash(items) {
89
+ return items.map(escape).join('/');
90
+ }
67
91
  //# sourceMappingURL=utils.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","names":["_lodash","require","isDebugMode","process","env","NODE_ENV","REACT_GLOBAL_STATE_DEBUG","error","cloneDeepBailKeys","Set","cloneDeepForLog","value","key","has","console","warn","start","Date","now","res","cloneDeep","time","add"],"sources":["../../src/utils.ts"],"sourcesContent":["import { type GetFieldType, cloneDeep } from 'lodash';\n\nexport type CallbackT = () => void;\n\n// TODO: This (ForceT, LockT, and TypeLock) probably should be moved to JS Utils\n// lib.\n\ndeclare const force: unique symbol;\ndeclare const lock: unique symbol;\n\nexport type ForceT = typeof force;\nexport type LockT = typeof lock;\n\nexport type TypeLock<\n Unlocked extends ForceT | LockT,\n LockedT extends never | void,\n UnlockedT,\n> = Unlocked extends ForceT ? UnlockedT : LockedT;\n\n/**\n * Given the type of state, `StateT`, and the type of state path, `PathT`,\n * it evaluates the type of value at that path of the state, if it can be\n * evaluated from the path type (it is possible when `PathT` is a string\n * literal type, and `StateT` elements along this path have appropriate\n * types); otherwise it falls back to the specified `UnknownT` type,\n * which should be set either `never` (for input arguments), or `void`\n * (for return types) - `never` and `void` in those places forbid assignments,\n * and are not auto-inferred to more permissible types.\n *\n * BEWARE: When StateT is any the construct resolves to any for any string\n * paths.\n */\nexport type ValueAtPathT<\n StateT,\n PathT extends null | string | undefined,\n UnknownT extends never | undefined | void,\n> = unknown extends StateT\n ? UnknownT\n : string extends PathT\n ? UnknownT\n : PathT extends null | undefined\n ? StateT\n : GetFieldType<StateT, PathT> extends undefined\n ? UnknownT : GetFieldType<StateT, PathT>;\n\nexport type ValueOrInitializerT<ValueT> = ValueT | (() => ValueT);\n\n/**\n * Returns 'true' if debug logging should be performed; 'false' otherwise.\n *\n * BEWARE: The actual safeguards for the debug logging still should read\n * if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n * // Some debug logging\n * }\n * to ensure that debug code is stripped out by Webpack in production mode.\n *\n * @returns\n * @ignore\n */\nexport function isDebugMode(): boolean {\n try {\n return process.env.NODE_ENV !== 'production'\n && !!process.env.REACT_GLOBAL_STATE_DEBUG;\n } catch (error) {\n return false;\n }\n}\n\nconst cloneDeepBailKeys = new Set<string>();\n\n/**\n * Deep-clones given value for logging purposes, or returns the value itself\n * if the previous clone attempt, with the same key, took more than 300ms\n * (to avoid situations when large payload in the global state slows down\n * development versions of the app due to the logging overhead).\n */\nexport function cloneDeepForLog<T>(value: T, key: string = ''): T {\n if (cloneDeepBailKeys.has(key)) {\n console.warn(`The logged value won't be clonned (key \"${key}\").`);\n return value;\n }\n\n const start = Date.now();\n const res = cloneDeep(value);\n const time = Date.now() - start;\n if (time > 300) {\n console.warn(`${time}ms spent to clone the logged value (key \"${key}\").`);\n cloneDeepBailKeys.add(key);\n }\n\n return res;\n}\n"],"mappings":";;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAIA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,WAAWA,CAAA,EAAY;EACrC,IAAI;IACF,OAAOC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IACvC,CAAC,CAACF,OAAO,CAACC,GAAG,CAACE,wBAAwB;EAC7C,CAAC,CAAC,OAAOC,KAAK,EAAE;IACd,OAAO,KAAK;EACd;AACF;AAEA,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,CAAS,CAAC;;AAE3C;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAAIC,KAAQ,EAAEC,GAAW,GAAG,EAAE,EAAK;EAChE,IAAIJ,iBAAiB,CAACK,GAAG,CAACD,GAAG,CAAC,EAAE;IAC9BE,OAAO,CAACC,IAAI,CAAC,2CAA2CH,GAAG,KAAK,CAAC;IACjE,OAAOD,KAAK;EACd;EAEA,MAAMK,KAAK,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;EACxB,MAAMC,GAAG,GAAG,IAAAC,iBAAS,EAACT,KAAK,CAAC;EAC5B,MAAMU,IAAI,GAAGJ,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGF,KAAK;EAC/B,IAAIK,IAAI,GAAG,GAAG,EAAE;IACdP,OAAO,CAACC,IAAI,CAAC,GAAGM,IAAI,4CAA4CT,GAAG,KAAK,CAAC;IACzEJ,iBAAiB,CAACc,GAAG,CAACV,GAAG,CAAC;EAC5B;EAEA,OAAOO,GAAG;AACZ","ignoreList":[]}
1
+ {"version":3,"file":"utils.js","names":["_lodash","require","isDebugMode","process","env","NODE_ENV","REACT_GLOBAL_STATE_DEBUG","error","cloneDeepBailKeys","Set","cloneDeepForLog","value","key","has","console","warn","start","Date","now","res","cloneDeep","time","add","escape","x","replace","toString","hash","items","map","join"],"sources":["../../src/utils.ts"],"sourcesContent":["import { type GetFieldType, cloneDeep } from 'lodash';\n\nexport type CallbackT = () => void;\n\n// TODO: This (ForceT, LockT, and TypeLock) probably should be moved to JS Utils\n// lib.\n\ndeclare const force: unique symbol;\ndeclare const lock: unique symbol;\n\nexport type ForceT = typeof force;\nexport type LockT = typeof lock;\n\nexport type TypeLock<\n Unlocked extends ForceT | LockT,\n LockedT extends never | void,\n UnlockedT,\n> = Unlocked extends ForceT ? UnlockedT : LockedT;\n\n/**\n * Given the type of state, `StateT`, and the type of state path, `PathT`,\n * it evaluates the type of value at that path of the state, if it can be\n * evaluated from the path type (it is possible when `PathT` is a string\n * literal type, and `StateT` elements along this path have appropriate\n * types); otherwise it falls back to the specified `UnknownT` type,\n * which should be set either `never` (for input arguments), or `void`\n * (for return types) - `never` and `void` in those places forbid assignments,\n * and are not auto-inferred to more permissible types.\n *\n * BEWARE: When StateT is any the construct resolves to any for any string\n * paths.\n */\nexport type ValueAtPathT<\n StateT,\n PathT extends null | string | undefined,\n UnknownT extends never | undefined | void,\n> = unknown extends StateT\n ? UnknownT\n : string extends PathT\n ? UnknownT\n : PathT extends null | undefined\n ? StateT\n : GetFieldType<StateT, PathT> extends undefined\n ? UnknownT : GetFieldType<StateT, PathT>;\n\nexport type ValueOrInitializerT<ValueT> = ValueT | (() => ValueT);\n\n/**\n * Returns 'true' if debug logging should be performed; 'false' otherwise.\n *\n * BEWARE: The actual safeguards for the debug logging still should read\n * if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n * // Some debug logging\n * }\n * to ensure that debug code is stripped out by Webpack in production mode.\n *\n * @returns\n * @ignore\n */\nexport function isDebugMode(): boolean {\n try {\n return process.env.NODE_ENV !== 'production'\n && !!process.env.REACT_GLOBAL_STATE_DEBUG;\n } catch (error) {\n return false;\n }\n}\n\nconst cloneDeepBailKeys = new Set<string>();\n\n/**\n * Deep-clones given value for logging purposes, or returns the value itself\n * if the previous clone attempt, with the same key, took more than 300ms\n * (to avoid situations when large payload in the global state slows down\n * development versions of the app due to the logging overhead).\n */\nexport function cloneDeepForLog<T>(value: T, key: string = ''): T {\n if (cloneDeepBailKeys.has(key)) {\n // eslint-disable-next-line no-console\n console.warn(`The logged value won't be clonned (key \"${key}\").`);\n return value;\n }\n\n const start = Date.now();\n const res = cloneDeep(value);\n const time = Date.now() - start;\n if (time > 300) {\n // eslint-disable-next-line no-console\n console.warn(`${time}ms spent to clone the logged value (key \"${key}\").`);\n cloneDeepBailKeys.add(key);\n }\n\n return res;\n}\n\n/**\n * Converts given value to an escaped string. For now, we are good with the most\n * trivial escape logic:\n * - '%' characters are replaced by '%0' code pair;\n * - '/' characters are replaced by '%1' code pair.\n */\nexport function escape(x: number | string): string {\n return typeof x === 'string'\n ? x.replace(/%/g, '%0').replace(/\\//g, '%1')\n : x.toString();\n}\n\n/**\n * Hashes given string array. For our current needs we are fine to go with\n * the most trivial implementation, which probably should not be called \"hash\"\n * in the strict sense: we just escape each given string to not include '/'\n * characters, and then we join all those strings using '/' as the separator.\n */\nexport function hash(items: Array<number | string>): string {\n return items.map(escape).join('/');\n}\n"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAIA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,WAAWA,CAAA,EAAY;EACrC,IAAI;IACF,OAAOC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IACvC,CAAC,CAACF,OAAO,CAACC,GAAG,CAACE,wBAAwB;EAC7C,CAAC,CAAC,OAAOC,KAAK,EAAE;IACd,OAAO,KAAK;EACd;AACF;AAEA,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,CAAS,CAAC;;AAE3C;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAAIC,KAAQ,EAAEC,GAAW,GAAG,EAAE,EAAK;EAChE,IAAIJ,iBAAiB,CAACK,GAAG,CAACD,GAAG,CAAC,EAAE;IAC9B;IACAE,OAAO,CAACC,IAAI,CAAC,2CAA2CH,GAAG,KAAK,CAAC;IACjE,OAAOD,KAAK;EACd;EAEA,MAAMK,KAAK,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;EACxB,MAAMC,GAAG,GAAG,IAAAC,iBAAS,EAACT,KAAK,CAAC;EAC5B,MAAMU,IAAI,GAAGJ,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGF,KAAK;EAC/B,IAAIK,IAAI,GAAG,GAAG,EAAE;IACd;IACAP,OAAO,CAACC,IAAI,CAAC,GAAGM,IAAI,4CAA4CT,GAAG,KAAK,CAAC;IACzEJ,iBAAiB,CAACc,GAAG,CAACV,GAAG,CAAC;EAC5B;EAEA,OAAOO,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASI,MAAMA,CAACC,CAAkB,EAAU;EACjD,OAAO,OAAOA,CAAC,KAAK,QAAQ,GACxBA,CAAC,CAACC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAACA,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,GAC1CD,CAAC,CAACE,QAAQ,CAAC,CAAC;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,IAAIA,CAACC,KAA6B,EAAU;EAC1D,OAAOA,KAAK,CAACC,GAAG,CAACN,MAAM,CAAC,CAACO,IAAI,CAAC,GAAG,CAAC;AACpC","ignoreList":[]}
@@ -6,6 +6,7 @@ function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.h
6
6
  import { get, isFunction, isObject, isNil, set, toPath } from 'lodash';
7
7
  import { cloneDeepForLog, isDebugMode } from "./utils";
8
8
  const ERR_NO_SSR_WATCH = 'GlobalState must not be watched at server side';
9
+ var _asyncDataAbortCallbacks = /*#__PURE__*/new WeakMap();
9
10
  var _dependencies = /*#__PURE__*/new WeakMap();
10
11
  var _initialState = /*#__PURE__*/new WeakMap();
11
12
  var _watchers = /*#__PURE__*/new WeakMap();
@@ -18,6 +19,7 @@ export default class GlobalState {
18
19
  * @param ssrContext Server-side rendering context.
19
20
  */
20
21
  constructor(initialState, ssrContext) {
22
+ _classPrivateFieldInitSpec(this, _asyncDataAbortCallbacks, {});
21
23
  _classPrivateFieldInitSpec(this, _dependencies, {});
22
24
  _classPrivateFieldInitSpec(this, _initialState, void 0);
23
25
  // TODO: It is tempting to replace watchers here by
@@ -49,6 +51,25 @@ export default class GlobalState {
49
51
  }
50
52
  }
51
53
 
54
+ /**
55
+ * Returns the number of currently registered async data abort callbacks,
56
+ * just for the sake of testing the library.
57
+ */
58
+ get numAsyncDataAbortCallbacks() {
59
+ return Object.keys(_classPrivateFieldGet(_asyncDataAbortCallbacks, this)).length;
60
+ }
61
+
62
+ /**
63
+ * If `aborted` is "true" and there is an abort callback registered for
64
+ * the specified operation, it triggers the callback. Then, in any case,
65
+ * it drops the callback.
66
+ */
67
+ asyncDataLoadDone(opid, aborted) {
68
+ var _classPrivateFieldGet2, _classPrivateFieldGet3;
69
+ if (aborted) (_classPrivateFieldGet2 = (_classPrivateFieldGet3 = _classPrivateFieldGet(_asyncDataAbortCallbacks, this))[opid]) === null || _classPrivateFieldGet2 === void 0 || _classPrivateFieldGet2.call(_classPrivateFieldGet3);
70
+ delete _classPrivateFieldGet(_asyncDataAbortCallbacks, this)[opid];
71
+ }
72
+
52
73
  /**
53
74
  * Drops the record of dependencies, if any, for the given path.
54
75
  */
@@ -61,6 +82,11 @@ export default class GlobalState {
61
82
  * the given `path`. If they are, `deps` are recorded as the new deps for
62
83
  * the `path`, and also the array is frozen, to prevent it from being
63
84
  * modified.
85
+ *
86
+ * TODO: This may not work as expected if path string is not normalized,
87
+ * and the for the same path different alternative ways to spell it down
88
+ * are used. We should normalize given path here, I guess, or on a higher
89
+ * level in the logic?
64
90
  */
65
91
  hasChangedDependencies(path, deps) {
66
92
  const prevDeps = _classPrivateFieldGet(_dependencies, this)[path];
@@ -113,6 +139,14 @@ export default class GlobalState {
113
139
  }
114
140
  }
115
141
 
142
+ /**
143
+ * Registers an abort callback for an async data retrieval operation with
144
+ * the given operation ID. Throws if already registered.
145
+ */
146
+ setAsyncDataAbortCallback(opid, cb) {
147
+ _classPrivateFieldGet(_asyncDataAbortCallbacks, this)[opid] = cb;
148
+ }
149
+
116
150
  /**
117
151
  * Sets entire state, the same way as .set(null, value) would do.
118
152
  * @param value
@@ -1 +1 @@
1
- {"version":3,"file":"GlobalState.js","names":["get","isFunction","isObject","isNil","set","toPath","cloneDeepForLog","isDebugMode","ERR_NO_SSR_WATCH","_dependencies","WeakMap","_initialState","_watchers","_nextNotifierId","_currentState","GlobalState","constructor","initialState","ssrContext","_classPrivateFieldInitSpec","_classPrivateFieldSet","dirty","pending","state","_classPrivateFieldGet","process","env","NODE_ENV","msg","console","groupCollapsed","log","groupEnd","dropDependencies","path","hasChangedDependencies","deps","prevDeps","changed","length","i","Object","freeze","getEntireState","opts","undefined","initialValue","iv","setEntireState","notifyStateUpdate","value","p","setTimeout","watchers","res","root","segIdx","pos","pathSegments","seg","next","Array","isArray","slice","unWatch","callback","Error","indexOf","pop","watch","push"],"sources":["../../src/GlobalState.ts"],"sourcesContent":["import {\n get,\n isFunction,\n isObject,\n isNil,\n set,\n toPath,\n} from 'lodash';\n\nimport SsrContext from './SsrContext';\n\nimport {\n type CallbackT,\n type ForceT,\n type LockT,\n type TypeLock,\n type ValueAtPathT,\n type ValueOrInitializerT,\n cloneDeepForLog,\n isDebugMode,\n} from './utils';\n\nconst ERR_NO_SSR_WATCH = 'GlobalState must not be watched at server side';\n\ntype GetOptsT<T> = {\n initialState?: boolean;\n initialValue?: ValueOrInitializerT<T>;\n};\n\nexport default class GlobalState<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n> {\n readonly ssrContext?: SsrContextT;\n\n #dependencies: { [key: string]: Readonly<any[]> } = {};\n\n #initialState: StateT;\n\n // TODO: It is tempting to replace watchers here by\n // Emitter from @dr.pogodin/js-utils, but we need to clone\n // current watchers for emitting later, and this is not something\n // Emitter supports right now.\n #watchers: CallbackT[] = [];\n\n #nextNotifierId?: NodeJS.Timeout;\n\n #currentState: StateT;\n\n /**\n * Creates a new global state object.\n * @param initialState Intial global state content.\n * @param ssrContext Server-side rendering context.\n */\n constructor(\n initialState: StateT,\n ssrContext?: SsrContextT,\n ) {\n this.#currentState = initialState;\n this.#initialState = initialState;\n\n if (ssrContext) {\n /* eslint-disable no-param-reassign */\n ssrContext.dirty = false;\n ssrContext.pending = [];\n ssrContext.state = this.#currentState;\n /* eslint-enable no-param-reassign */\n\n this.ssrContext = ssrContext;\n }\n\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n let msg = 'New ReactGlobalState created';\n if (ssrContext) msg += ' (SSR mode)';\n console.groupCollapsed(msg);\n console.log('Initial state:', cloneDeepForLog(initialState));\n console.groupEnd();\n /* eslint-enable no-console */\n }\n }\n\n /**\n * Drops the record of dependencies, if any, for the given path.\n */\n dropDependencies(path: string) {\n delete this.#dependencies[path];\n }\n\n /**\n * Checks if given `deps` are different from previously recorded ones for\n * the given `path`. If they are, `deps` are recorded as the new deps for\n * the `path`, and also the array is frozen, to prevent it from being\n * modified.\n */\n hasChangedDependencies(path: string, deps: any[]): boolean {\n const prevDeps = this.#dependencies[path];\n let changed = !prevDeps || prevDeps.length !== deps.length;\n for (let i = 0; !changed && i < deps.length; ++i) {\n changed = prevDeps![i] !== deps[i];\n }\n this.#dependencies[path] = Object.freeze(deps);\n return changed;\n }\n\n /**\n * Gets entire state, the same way as .get(null, opts) would do.\n * @param opts.initialState\n * @param opts.initialValue\n */\n getEntireState(opts?: GetOptsT<StateT>): StateT {\n let state = opts?.initialState ? this.#initialState : this.#currentState;\n if (state !== undefined || opts?.initialValue === undefined) return state;\n\n const iv = opts.initialValue;\n state = isFunction(iv) ? iv() : iv;\n if (this.#currentState === undefined) this.setEntireState(state);\n return state;\n }\n\n /**\n * Notifies all connected state watchers that a state update has happened.\n */\n private notifyStateUpdate(path: null | string | undefined, value: unknown) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n const p = typeof path === 'string'\n ? `\"${path}\"` : 'none (entire state update)';\n console.groupCollapsed(`ReactGlobalState update. Path: ${p}`);\n console.log('New value:', cloneDeepForLog(value, path ?? ''));\n console.log('New state:', cloneDeepForLog(this.#currentState));\n console.groupEnd();\n /* eslint-enable no-console */\n }\n\n if (this.ssrContext) {\n this.ssrContext.dirty = true;\n this.ssrContext.state = this.#currentState;\n } else if (!this.#nextNotifierId) {\n this.#nextNotifierId = setTimeout(() => {\n this.#nextNotifierId = undefined;\n const watchers = [...this.#watchers];\n for (let i = 0; i < watchers.length; ++i) {\n watchers[i]!();\n }\n });\n }\n }\n\n /**\n * Sets entire state, the same way as .set(null, value) would do.\n * @param value\n */\n setEntireState(value: StateT): StateT {\n if (this.#currentState !== value) {\n this.#currentState = value;\n this.notifyStateUpdate(null, value);\n }\n return value;\n }\n\n /**\n * Gets current or initial value at the specified \"path\" of the global state.\n * @param path Dot-delimitered state path.\n * @param options Additional options.\n * @param options.initialState If \"true\" the value will be read\n * from the initial state instead of the current one.\n * @param options.initialValue If the value read from the \"path\" is\n * \"undefined\", this \"initialValue\" will be returned instead. In such case\n * \"initialValue\" will also be written to the \"path\" of the current global\n * state (no matter \"initialState\" flag), if \"undefined\" is stored there.\n * @return Retrieved value.\n */\n\n // .get() without arguments just falls back to .getEntireState().\n get(): StateT;\n\n // This variant attempts to automatically resolve and check the type of value\n // at the given path, as precise as the actual state and path types permit.\n // If the automatic path resolution is not possible, the ValueT fallsback\n // to `never` (or to `undefined` in some cases), effectively forbidding\n // to use this .get() variant.\n get<\n PathT extends null | string | undefined,\n ValueArgT extends ValueAtPathT<StateT, PathT, never>,\n ValueResT extends ValueAtPathT<StateT, PathT, void>,\n >(path: PathT, opts?: GetOptsT<ValueArgT>): ValueResT;\n\n // This variant is not callable by default (without generic arguments),\n // otherwise it allows to set the correct ValueT directly.\n get<Forced extends ForceT | LockT = LockT, ValueT = void>(\n path?: null | string,\n opts?: GetOptsT<TypeLock<Forced, never, ValueT>>,\n ): TypeLock<Forced, void, ValueT>;\n\n get<ValueT>(path?: null | string, opts?: GetOptsT<ValueT>): ValueT {\n if (isNil(path)) {\n const res = this.getEntireState((opts as unknown) as GetOptsT<StateT>);\n return (res as unknown) as ValueT;\n }\n\n const state = opts?.initialState ? this.#initialState : this.#currentState;\n\n let res = get(state, path);\n if (res !== undefined || opts?.initialValue === undefined) return res;\n\n const iv = opts.initialValue;\n res = isFunction(iv) ? iv() : iv;\n\n if (!opts?.initialState || this.get(path) === undefined) {\n this.set<ForceT, unknown>(path, res);\n }\n\n return res;\n }\n\n /**\n * Writes the `value` to given global state `path`.\n * @param path Dot-delimitered state path. If not given, entire\n * global state content is replaced by the `value`.\n * @param value The value.\n * @return Given `value` itself.\n */\n\n // This variant attempts automatic value type resolution & checking.\n set<\n PathT extends null | string | undefined,\n ValueArgT extends ValueAtPathT<StateT, PathT, never>,\n ValueResT extends ValueAtPathT<StateT, PathT, void>,\n >(path: PathT, value: ValueArgT): ValueResT;\n\n // This variant is disabled by default, otherwise allows to give\n // expected value type explicitly.\n set<Forced extends ForceT | LockT = LockT, ValueT = never>(\n path: null | string | undefined,\n value: TypeLock<Forced, never, ValueT>,\n ): TypeLock<Forced, void, ValueT>;\n\n set(path: null | string | undefined, value: unknown): unknown {\n if (isNil(path)) return this.setEntireState(value as StateT);\n\n if (value !== this.get(path)) {\n const root = { state: this.#currentState };\n let segIdx = 0;\n let pos: any = root;\n const pathSegments = toPath(`state.${path}`);\n for (; segIdx < pathSegments.length - 1; segIdx += 1) {\n const seg = pathSegments[segIdx]!;\n const next = pos[seg];\n if (Array.isArray(next)) pos[seg] = [...next];\n else if (isObject(next)) pos[seg] = { ...next };\n else {\n // We arrived to a state sub-segment, where the remaining part of\n // the update path does not exist yet. We rely on lodash's set()\n // function to create the remaining path, and set the value.\n set(pos, pathSegments.slice(segIdx), value);\n break;\n }\n pos = pos[seg];\n }\n\n if (segIdx === pathSegments.length - 1) {\n pos[pathSegments[segIdx]!] = value;\n }\n\n this.#currentState = root.state;\n\n this.notifyStateUpdate(path, value);\n }\n return value;\n }\n\n /**\n * Unsubscribes `callback` from watching state updates; no operation if\n * `callback` is not subscribed to the state updates.\n * @param callback\n * @throws if {@link SsrContext} is attached to the state instance: the state\n * watching functionality is intended for client-side (non-SSR) only.\n */\n unWatch(callback: CallbackT) {\n if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);\n\n const watchers = this.#watchers;\n const pos = watchers.indexOf(callback);\n if (pos >= 0) {\n watchers[pos] = watchers[watchers.length - 1]!;\n watchers.pop();\n }\n }\n\n /**\n * Subscribes `callback` to watch state updates; no operation if\n * `callback` is already subscribed to this state instance.\n * @param callback It will be called without any arguments every\n * time the state content changes (note, howhever, separate state updates can\n * be applied to the state at once, and watching callbacks will be called once\n * after such bulk update).\n * @throws if {@link SsrContext} is attached to the state instance: the state\n * watching functionality is intended for client-side (non-SSR) only.\n */\n watch(callback: CallbackT) {\n if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);\n\n const watchers = this.#watchers;\n if (watchers.indexOf(callback) < 0) {\n watchers.push(callback);\n }\n }\n}\n"],"mappings":";;;;;AAAA,SACEA,GAAG,EACHC,UAAU,EACVC,QAAQ,EACRC,KAAK,EACLC,GAAG,EACHC,MAAM,QACD,QAAQ;AAIf,SAOEC,eAAe,EACfC,WAAW;AAGb,MAAMC,gBAAgB,GAAG,gDAAgD;AAAC,IAAAC,aAAA,oBAAAC,OAAA;AAAA,IAAAC,aAAA,oBAAAD,OAAA;AAAA,IAAAE,SAAA,oBAAAF,OAAA;AAAA,IAAAG,eAAA,oBAAAH,OAAA;AAAA,IAAAI,aAAA,oBAAAJ,OAAA;AAO1E,eAAe,MAAMK,WAAW,CAG9B;EAiBA;AACF;AACA;AACA;AACA;EACEC,WAAWA,CACTC,YAAoB,EACpBC,UAAwB,EACxB;IAtBFC,0BAAA,OAAAV,aAAa,EAAuC,CAAC,CAAC;IAEtDU,0BAAA,OAAAR,aAAa;IAEb;IACA;IACA;IACA;IACAQ,0BAAA,OAAAP,SAAS,EAAgB,EAAE;IAE3BO,0BAAA,OAAAN,eAAe;IAEfM,0BAAA,OAAAL,aAAa;IAWXM,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiBG,YAAJ,CAAC;IAClBG,qBAAA,CAAKT,aAAa,EAAlB,IAAI,EAAiBM,YAAJ,CAAC;IAElB,IAAIC,UAAU,EAAE;MACd;MACAA,UAAU,CAACG,KAAK,GAAG,KAAK;MACxBH,UAAU,CAACI,OAAO,GAAG,EAAE;MACvBJ,UAAU,CAACK,KAAK,GAAGC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;MACrC;;MAEA,IAAI,CAACI,UAAU,GAAGA,UAAU;IAC9B;IAEA,IAAIO,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIpB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,IAAIqB,GAAG,GAAG,8BAA8B;MACxC,IAAIV,UAAU,EAAEU,GAAG,IAAI,aAAa;MACpCC,OAAO,CAACC,cAAc,CAACF,GAAG,CAAC;MAC3BC,OAAO,CAACE,GAAG,CAAC,gBAAgB,EAAEzB,eAAe,CAACW,YAAY,CAAC,CAAC;MAC5DY,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;;EAEA;AACF;AACA;EACEC,gBAAgBA,CAACC,IAAY,EAAE;IAC7B,OAAOV,qBAAA,CAAKf,aAAa,EAAlB,IAAiB,CAAC,CAACyB,IAAI,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,sBAAsBA,CAACD,IAAY,EAAEE,IAAW,EAAW;IACzD,MAAMC,QAAQ,GAAGb,qBAAA,CAAKf,aAAa,EAAlB,IAAiB,CAAC,CAACyB,IAAI,CAAC;IACzC,IAAII,OAAO,GAAG,CAACD,QAAQ,IAAIA,QAAQ,CAACE,MAAM,KAAKH,IAAI,CAACG,MAAM;IAC1D,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAE,CAACF,OAAO,IAAIE,CAAC,GAAGJ,IAAI,CAACG,MAAM,EAAE,EAAEC,CAAC,EAAE;MAChDF,OAAO,GAAGD,QAAQ,CAAEG,CAAC,CAAC,KAAKJ,IAAI,CAACI,CAAC,CAAC;IACpC;IACAhB,qBAAA,CAAKf,aAAa,EAAlB,IAAiB,CAAC,CAACyB,IAAI,CAAC,GAAGO,MAAM,CAACC,MAAM,CAACN,IAAI,CAAC;IAC9C,OAAOE,OAAO;EAChB;;EAEA;AACF;AACA;AACA;AACA;EACEK,cAAcA,CAACC,IAAuB,EAAU;IAC9C,IAAIrB,KAAK,GAAGqB,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAE3B,YAAY,GAAGO,qBAAA,CAAKb,aAAa,EAAlB,IAAiB,CAAC,GAAGa,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IACxE,IAAIS,KAAK,KAAKsB,SAAS,IAAI,CAAAD,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEE,YAAY,MAAKD,SAAS,EAAE,OAAOtB,KAAK;IAEzE,MAAMwB,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5BvB,KAAK,GAAGtB,UAAU,CAAC8C,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAClC,IAAIvB,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,KAAK+B,SAAS,EAAE,IAAI,CAACG,cAAc,CAACzB,KAAK,CAAC;IAChE,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;EACU0B,iBAAiBA,CAACf,IAA+B,EAAEgB,KAAc,EAAE;IACzE,IAAIzB,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIpB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,MAAM4C,CAAC,GAAG,OAAOjB,IAAI,KAAK,QAAQ,GAC9B,IAAIA,IAAI,GAAG,GAAG,4BAA4B;MAC9CL,OAAO,CAACC,cAAc,CAAC,kCAAkCqB,CAAC,EAAE,CAAC;MAC7DtB,OAAO,CAACE,GAAG,CAAC,YAAY,EAAEzB,eAAe,CAAC4C,KAAK,EAAEhB,IAAI,aAAJA,IAAI,cAAJA,IAAI,GAAI,EAAE,CAAC,CAAC;MAC7DL,OAAO,CAACE,GAAG,CAAC,YAAY,EAAEzB,eAAe,CAACkB,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,CAAC,CAAC;MAC9De,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;IAEA,IAAI,IAAI,CAACd,UAAU,EAAE;MACnB,IAAI,CAACA,UAAU,CAACG,KAAK,GAAG,IAAI;MAC5B,IAAI,CAACH,UAAU,CAACK,KAAK,GAAGC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IAC5C,CAAC,MAAM,IAAI,CAACU,qBAAA,CAAKX,eAAe,EAApB,IAAmB,CAAC,EAAE;MAChCO,qBAAA,CAAKP,eAAe,EAApB,IAAI,EAAmBuC,UAAU,CAAC,MAAM;QACtChC,qBAAA,CAAKP,eAAe,EAApB,IAAI,EAAmBgC,SAAJ,CAAC;QACpB,MAAMQ,QAAQ,GAAG,CAAC,GAAG7B,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC,CAAC;QACpC,KAAK,IAAI4B,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGa,QAAQ,CAACd,MAAM,EAAE,EAAEC,CAAC,EAAE;UACxCa,QAAQ,CAACb,CAAC,CAAC,CAAE,CAAC;QAChB;MACF,CAAC,CANkB,CAAC;IAOtB;EACF;;EAEA;AACF;AACA;AACA;EACEQ,cAAcA,CAACE,KAAa,EAAU;IACpC,IAAI1B,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,KAAKoC,KAAK,EAAE;MAChC9B,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiBoC,KAAJ,CAAC;MAClB,IAAI,CAACD,iBAAiB,CAAC,IAAI,EAAEC,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAEE;;EAGA;EACA;EACA;EACA;EACA;;EAOA;EACA;;EAMAlD,GAAGA,CAASkC,IAAoB,EAAEU,IAAuB,EAAU;IACjE,IAAIzC,KAAK,CAAC+B,IAAI,CAAC,EAAE;MACf,MAAMoB,GAAG,GAAG,IAAI,CAACX,cAAc,CAAEC,IAAoC,CAAC;MACtE,OAAQU,GAAG;IACb;IAEA,MAAM/B,KAAK,GAAGqB,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAE3B,YAAY,GAAGO,qBAAA,CAAKb,aAAa,EAAlB,IAAiB,CAAC,GAAGa,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IAE1E,IAAIwC,GAAG,GAAGtD,GAAG,CAACuB,KAAK,EAAEW,IAAI,CAAC;IAC1B,IAAIoB,GAAG,KAAKT,SAAS,IAAI,CAAAD,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEE,YAAY,MAAKD,SAAS,EAAE,OAAOS,GAAG;IAErE,MAAMP,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5BQ,GAAG,GAAGrD,UAAU,CAAC8C,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAEhC,IAAI,EAACH,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAE3B,YAAY,KAAI,IAAI,CAACjB,GAAG,CAACkC,IAAI,CAAC,KAAKW,SAAS,EAAE;MACvD,IAAI,CAACzC,GAAG,CAAkB8B,IAAI,EAAEoB,GAAG,CAAC;IACtC;IAEA,OAAOA,GAAG;EACZ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;;EAEE;;EAOA;EACA;;EAMAlD,GAAGA,CAAC8B,IAA+B,EAAEgB,KAAc,EAAW;IAC5D,IAAI/C,KAAK,CAAC+B,IAAI,CAAC,EAAE,OAAO,IAAI,CAACc,cAAc,CAACE,KAAe,CAAC;IAE5D,IAAIA,KAAK,KAAK,IAAI,CAAClD,GAAG,CAACkC,IAAI,CAAC,EAAE;MAC5B,MAAMqB,IAAI,GAAG;QAAEhC,KAAK,EAAEC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB;MAAE,CAAC;MAC1C,IAAI0C,MAAM,GAAG,CAAC;MACd,IAAIC,GAAQ,GAAGF,IAAI;MACnB,MAAMG,YAAY,GAAGrD,MAAM,CAAC,SAAS6B,IAAI,EAAE,CAAC;MAC5C,OAAOsB,MAAM,GAAGE,YAAY,CAACnB,MAAM,GAAG,CAAC,EAAEiB,MAAM,IAAI,CAAC,EAAE;QACpD,MAAMG,GAAG,GAAGD,YAAY,CAACF,MAAM,CAAE;QACjC,MAAMI,IAAI,GAAGH,GAAG,CAACE,GAAG,CAAC;QACrB,IAAIE,KAAK,CAACC,OAAO,CAACF,IAAI,CAAC,EAAEH,GAAG,CAACE,GAAG,CAAC,GAAG,CAAC,GAAGC,IAAI,CAAC,CAAC,KACzC,IAAI1D,QAAQ,CAAC0D,IAAI,CAAC,EAAEH,GAAG,CAACE,GAAG,CAAC,GAAG;UAAE,GAAGC;QAAK,CAAC,CAAC,KAC3C;UACH;UACA;UACA;UACAxD,GAAG,CAACqD,GAAG,EAAEC,YAAY,CAACK,KAAK,CAACP,MAAM,CAAC,EAAEN,KAAK,CAAC;UAC3C;QACF;QACAO,GAAG,GAAGA,GAAG,CAACE,GAAG,CAAC;MAChB;MAEA,IAAIH,MAAM,KAAKE,YAAY,CAACnB,MAAM,GAAG,CAAC,EAAE;QACtCkB,GAAG,CAACC,YAAY,CAACF,MAAM,CAAC,CAAE,GAAGN,KAAK;MACpC;MAEA9B,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiByC,IAAI,CAAChC,KAAT,CAAC;MAElB,IAAI,CAAC0B,iBAAiB,CAACf,IAAI,EAAEgB,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEc,OAAOA,CAACC,QAAmB,EAAE;IAC3B,IAAI,IAAI,CAAC/C,UAAU,EAAE,MAAM,IAAIgD,KAAK,CAAC1D,gBAAgB,CAAC;IAEtD,MAAM6C,QAAQ,GAAG7B,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC;IAC/B,MAAM6C,GAAG,GAAGJ,QAAQ,CAACc,OAAO,CAACF,QAAQ,CAAC;IACtC,IAAIR,GAAG,IAAI,CAAC,EAAE;MACZJ,QAAQ,CAACI,GAAG,CAAC,GAAGJ,QAAQ,CAACA,QAAQ,CAACd,MAAM,GAAG,CAAC,CAAE;MAC9Cc,QAAQ,CAACe,GAAG,CAAC,CAAC;IAChB;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,KAAKA,CAACJ,QAAmB,EAAE;IACzB,IAAI,IAAI,CAAC/C,UAAU,EAAE,MAAM,IAAIgD,KAAK,CAAC1D,gBAAgB,CAAC;IAEtD,MAAM6C,QAAQ,GAAG7B,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC;IAC/B,IAAIyC,QAAQ,CAACc,OAAO,CAACF,QAAQ,CAAC,GAAG,CAAC,EAAE;MAClCZ,QAAQ,CAACiB,IAAI,CAACL,QAAQ,CAAC;IACzB;EACF;AACF","ignoreList":[]}
1
+ {"version":3,"file":"GlobalState.js","names":["get","isFunction","isObject","isNil","set","toPath","cloneDeepForLog","isDebugMode","ERR_NO_SSR_WATCH","_asyncDataAbortCallbacks","WeakMap","_dependencies","_initialState","_watchers","_nextNotifierId","_currentState","GlobalState","constructor","initialState","ssrContext","_classPrivateFieldInitSpec","_classPrivateFieldSet","dirty","pending","state","_classPrivateFieldGet","process","env","NODE_ENV","msg","console","groupCollapsed","log","groupEnd","numAsyncDataAbortCallbacks","Object","keys","length","asyncDataLoadDone","opid","aborted","_classPrivateFieldGet2","_classPrivateFieldGet3","call","dropDependencies","path","hasChangedDependencies","deps","prevDeps","changed","i","freeze","getEntireState","opts","undefined","initialValue","iv","setEntireState","notifyStateUpdate","value","p","setTimeout","watchers","setAsyncDataAbortCallback","cb","res","root","segIdx","pos","pathSegments","seg","next","Array","isArray","slice","unWatch","callback","Error","indexOf","pop","watch","push"],"sources":["../../src/GlobalState.ts"],"sourcesContent":["import {\n get,\n isFunction,\n isObject,\n isNil,\n set,\n toPath,\n} from 'lodash';\n\nimport SsrContext from './SsrContext';\n\nimport {\n type CallbackT,\n type ForceT,\n type LockT,\n type TypeLock,\n type ValueAtPathT,\n type ValueOrInitializerT,\n cloneDeepForLog,\n isDebugMode,\n} from './utils';\n\nconst ERR_NO_SSR_WATCH = 'GlobalState must not be watched at server side';\n\ntype GetOptsT<T> = {\n initialState?: boolean;\n initialValue?: ValueOrInitializerT<T>;\n};\n\nexport default class GlobalState<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n> {\n readonly ssrContext?: SsrContextT;\n\n #asyncDataAbortCallbacks: Record<string, () => void> = {};\n\n #dependencies: { [key: string]: Readonly<any[]> } = {};\n\n #initialState: StateT;\n\n // TODO: It is tempting to replace watchers here by\n // Emitter from @dr.pogodin/js-utils, but we need to clone\n // current watchers for emitting later, and this is not something\n // Emitter supports right now.\n #watchers: CallbackT[] = [];\n\n #nextNotifierId?: NodeJS.Timeout;\n\n #currentState: StateT;\n\n /**\n * Creates a new global state object.\n * @param initialState Intial global state content.\n * @param ssrContext Server-side rendering context.\n */\n constructor(\n initialState: StateT,\n ssrContext?: SsrContextT,\n ) {\n this.#currentState = initialState;\n this.#initialState = initialState;\n\n if (ssrContext) {\n /* eslint-disable no-param-reassign */\n ssrContext.dirty = false;\n ssrContext.pending = [];\n ssrContext.state = this.#currentState;\n /* eslint-enable no-param-reassign */\n\n this.ssrContext = ssrContext;\n }\n\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n let msg = 'New ReactGlobalState created';\n if (ssrContext) msg += ' (SSR mode)';\n console.groupCollapsed(msg);\n console.log('Initial state:', cloneDeepForLog(initialState));\n console.groupEnd();\n /* eslint-enable no-console */\n }\n }\n\n /**\n * Returns the number of currently registered async data abort callbacks,\n * just for the sake of testing the library.\n */\n get numAsyncDataAbortCallbacks(): number {\n return Object.keys(this.#asyncDataAbortCallbacks).length;\n }\n\n /**\n * If `aborted` is \"true\" and there is an abort callback registered for\n * the specified operation, it triggers the callback. Then, in any case,\n * it drops the callback.\n */\n asyncDataLoadDone(opid: string, aborted: boolean) {\n if (aborted) this.#asyncDataAbortCallbacks[opid]?.();\n delete this.#asyncDataAbortCallbacks[opid];\n }\n\n /**\n * Drops the record of dependencies, if any, for the given path.\n */\n dropDependencies(path: string) {\n delete this.#dependencies[path];\n }\n\n /**\n * Checks if given `deps` are different from previously recorded ones for\n * the given `path`. If they are, `deps` are recorded as the new deps for\n * the `path`, and also the array is frozen, to prevent it from being\n * modified.\n *\n * TODO: This may not work as expected if path string is not normalized,\n * and the for the same path different alternative ways to spell it down\n * are used. We should normalize given path here, I guess, or on a higher\n * level in the logic?\n */\n hasChangedDependencies(path: string, deps: any[]): boolean {\n const prevDeps = this.#dependencies[path];\n let changed = !prevDeps || prevDeps.length !== deps.length;\n for (let i = 0; !changed && i < deps.length; ++i) {\n changed = prevDeps![i] !== deps[i];\n }\n this.#dependencies[path] = Object.freeze(deps);\n return changed;\n }\n\n /**\n * Gets entire state, the same way as .get(null, opts) would do.\n * @param opts.initialState\n * @param opts.initialValue\n */\n getEntireState(opts?: GetOptsT<StateT>): StateT {\n let state = opts?.initialState ? this.#initialState : this.#currentState;\n if (state !== undefined || opts?.initialValue === undefined) return state;\n\n const iv = opts.initialValue;\n state = isFunction(iv) ? iv() : iv;\n if (this.#currentState === undefined) this.setEntireState(state);\n return state;\n }\n\n /**\n * Notifies all connected state watchers that a state update has happened.\n */\n private notifyStateUpdate(path: null | string | undefined, value: unknown) {\n if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n /* eslint-disable no-console */\n const p = typeof path === 'string'\n ? `\"${path}\"` : 'none (entire state update)';\n console.groupCollapsed(`ReactGlobalState update. Path: ${p}`);\n console.log('New value:', cloneDeepForLog(value, path ?? ''));\n console.log('New state:', cloneDeepForLog(this.#currentState));\n console.groupEnd();\n /* eslint-enable no-console */\n }\n\n if (this.ssrContext) {\n this.ssrContext.dirty = true;\n this.ssrContext.state = this.#currentState;\n } else if (!this.#nextNotifierId) {\n this.#nextNotifierId = setTimeout(() => {\n this.#nextNotifierId = undefined;\n const watchers = [...this.#watchers];\n for (let i = 0; i < watchers.length; ++i) {\n watchers[i]!();\n }\n });\n }\n }\n\n /**\n * Registers an abort callback for an async data retrieval operation with\n * the given operation ID. Throws if already registered.\n */\n setAsyncDataAbortCallback(opid: string, cb: () => void) {\n this.#asyncDataAbortCallbacks[opid] = cb;\n }\n\n /**\n * Sets entire state, the same way as .set(null, value) would do.\n * @param value\n */\n setEntireState(value: StateT): StateT {\n if (this.#currentState !== value) {\n this.#currentState = value;\n this.notifyStateUpdate(null, value);\n }\n return value;\n }\n\n /**\n * Gets current or initial value at the specified \"path\" of the global state.\n * @param path Dot-delimitered state path.\n * @param options Additional options.\n * @param options.initialState If \"true\" the value will be read\n * from the initial state instead of the current one.\n * @param options.initialValue If the value read from the \"path\" is\n * \"undefined\", this \"initialValue\" will be returned instead. In such case\n * \"initialValue\" will also be written to the \"path\" of the current global\n * state (no matter \"initialState\" flag), if \"undefined\" is stored there.\n * @return Retrieved value.\n */\n\n // .get() without arguments just falls back to .getEntireState().\n get(): StateT;\n\n // This variant attempts to automatically resolve and check the type of value\n // at the given path, as precise as the actual state and path types permit.\n // If the automatic path resolution is not possible, the ValueT fallsback\n // to `never` (or to `undefined` in some cases), effectively forbidding\n // to use this .get() variant.\n get<\n PathT extends null | string | undefined,\n ValueArgT extends ValueAtPathT<StateT, PathT, never>,\n ValueResT extends ValueAtPathT<StateT, PathT, void>,\n >(path: PathT, opts?: GetOptsT<ValueArgT>): ValueResT;\n\n // This variant is not callable by default (without generic arguments),\n // otherwise it allows to set the correct ValueT directly.\n get<Forced extends ForceT | LockT = LockT, ValueT = void>(\n path?: null | string,\n opts?: GetOptsT<TypeLock<Forced, never, ValueT>>,\n ): TypeLock<Forced, void, ValueT>;\n\n get<ValueT>(path?: null | string, opts?: GetOptsT<ValueT>): ValueT {\n if (isNil(path)) {\n const res = this.getEntireState((opts as unknown) as GetOptsT<StateT>);\n return (res as unknown) as ValueT;\n }\n\n const state = opts?.initialState ? this.#initialState : this.#currentState;\n\n let res = get(state, path);\n if (res !== undefined || opts?.initialValue === undefined) return res;\n\n const iv = opts.initialValue;\n res = isFunction(iv) ? iv() : iv;\n\n if (!opts?.initialState || this.get(path) === undefined) {\n this.set<ForceT, unknown>(path, res);\n }\n\n return res;\n }\n\n /**\n * Writes the `value` to given global state `path`.\n * @param path Dot-delimitered state path. If not given, entire\n * global state content is replaced by the `value`.\n * @param value The value.\n * @return Given `value` itself.\n */\n\n // This variant attempts automatic value type resolution & checking.\n set<\n PathT extends null | string | undefined,\n ValueArgT extends ValueAtPathT<StateT, PathT, never>,\n ValueResT extends ValueAtPathT<StateT, PathT, void>,\n >(path: PathT, value: ValueArgT): ValueResT;\n\n // This variant is disabled by default, otherwise allows to give\n // expected value type explicitly.\n set<Forced extends ForceT | LockT = LockT, ValueT = never>(\n path: null | string | undefined,\n value: TypeLock<Forced, never, ValueT>,\n ): TypeLock<Forced, void, ValueT>;\n\n set(path: null | string | undefined, value: unknown): unknown {\n if (isNil(path)) return this.setEntireState(value as StateT);\n\n if (value !== this.get(path)) {\n const root = { state: this.#currentState };\n let segIdx = 0;\n let pos: any = root;\n const pathSegments = toPath(`state.${path}`);\n for (; segIdx < pathSegments.length - 1; segIdx += 1) {\n const seg = pathSegments[segIdx]!;\n const next = pos[seg];\n if (Array.isArray(next)) pos[seg] = [...next];\n else if (isObject(next)) pos[seg] = { ...next };\n else {\n // We arrived to a state sub-segment, where the remaining part of\n // the update path does not exist yet. We rely on lodash's set()\n // function to create the remaining path, and set the value.\n set(pos, pathSegments.slice(segIdx), value);\n break;\n }\n pos = pos[seg];\n }\n\n if (segIdx === pathSegments.length - 1) {\n pos[pathSegments[segIdx]!] = value;\n }\n\n this.#currentState = root.state;\n\n this.notifyStateUpdate(path, value);\n }\n return value;\n }\n\n /**\n * Unsubscribes `callback` from watching state updates; no operation if\n * `callback` is not subscribed to the state updates.\n * @param callback\n * @throws if {@link SsrContext} is attached to the state instance: the state\n * watching functionality is intended for client-side (non-SSR) only.\n */\n unWatch(callback: CallbackT) {\n if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);\n\n const watchers = this.#watchers;\n const pos = watchers.indexOf(callback);\n if (pos >= 0) {\n watchers[pos] = watchers[watchers.length - 1]!;\n watchers.pop();\n }\n }\n\n /**\n * Subscribes `callback` to watch state updates; no operation if\n * `callback` is already subscribed to this state instance.\n * @param callback It will be called without any arguments every\n * time the state content changes (note, howhever, separate state updates can\n * be applied to the state at once, and watching callbacks will be called once\n * after such bulk update).\n * @throws if {@link SsrContext} is attached to the state instance: the state\n * watching functionality is intended for client-side (non-SSR) only.\n */\n watch(callback: CallbackT) {\n if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);\n\n const watchers = this.#watchers;\n if (watchers.indexOf(callback) < 0) {\n watchers.push(callback);\n }\n }\n}\n"],"mappings":";;;;;AAAA,SACEA,GAAG,EACHC,UAAU,EACVC,QAAQ,EACRC,KAAK,EACLC,GAAG,EACHC,MAAM,QACD,QAAQ;AAIf,SAOEC,eAAe,EACfC,WAAW;AAGb,MAAMC,gBAAgB,GAAG,gDAAgD;AAAC,IAAAC,wBAAA,oBAAAC,OAAA;AAAA,IAAAC,aAAA,oBAAAD,OAAA;AAAA,IAAAE,aAAA,oBAAAF,OAAA;AAAA,IAAAG,SAAA,oBAAAH,OAAA;AAAA,IAAAI,eAAA,oBAAAJ,OAAA;AAAA,IAAAK,aAAA,oBAAAL,OAAA;AAO1E,eAAe,MAAMM,WAAW,CAG9B;EAmBA;AACF;AACA;AACA;AACA;EACEC,WAAWA,CACTC,YAAoB,EACpBC,UAAwB,EACxB;IAxBFC,0BAAA,OAAAX,wBAAwB,EAA+B,CAAC,CAAC;IAEzDW,0BAAA,OAAAT,aAAa,EAAuC,CAAC,CAAC;IAEtDS,0BAAA,OAAAR,aAAa;IAEb;IACA;IACA;IACA;IACAQ,0BAAA,OAAAP,SAAS,EAAgB,EAAE;IAE3BO,0BAAA,OAAAN,eAAe;IAEfM,0BAAA,OAAAL,aAAa;IAWXM,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiBG,YAAJ,CAAC;IAClBG,qBAAA,CAAKT,aAAa,EAAlB,IAAI,EAAiBM,YAAJ,CAAC;IAElB,IAAIC,UAAU,EAAE;MACd;MACAA,UAAU,CAACG,KAAK,GAAG,KAAK;MACxBH,UAAU,CAACI,OAAO,GAAG,EAAE;MACvBJ,UAAU,CAACK,KAAK,GAAGC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;MACrC;;MAEA,IAAI,CAACI,UAAU,GAAGA,UAAU;IAC9B;IAEA,IAAIO,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIrB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,IAAIsB,GAAG,GAAG,8BAA8B;MACxC,IAAIV,UAAU,EAAEU,GAAG,IAAI,aAAa;MACpCC,OAAO,CAACC,cAAc,CAACF,GAAG,CAAC;MAC3BC,OAAO,CAACE,GAAG,CAAC,gBAAgB,EAAE1B,eAAe,CAACY,YAAY,CAAC,CAAC;MAC5DY,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;;EAEA;AACF;AACA;AACA;EACE,IAAIC,0BAA0BA,CAAA,EAAW;IACvC,OAAOC,MAAM,CAACC,IAAI,CAACX,qBAAA,CAAKhB,wBAAwB,EAA7B,IAA4B,CAAC,CAAC,CAAC4B,MAAM;EAC1D;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAACC,IAAY,EAAEC,OAAgB,EAAE;IAAA,IAAAC,sBAAA,EAAAC,sBAAA;IAChD,IAAIF,OAAO,EAAE,CAAAC,sBAAA,IAAAC,sBAAA,GAAAjB,qBAAA,CAAKhB,wBAAwB,EAA7B,IAA4B,CAAC,EAAC8B,IAAI,CAAC,cAAAE,sBAAA,eAAnCA,sBAAA,CAAAE,IAAA,CAAAD,sBAAsC,CAAC;IACpD,OAAOjB,qBAAA,CAAKhB,wBAAwB,EAA7B,IAA4B,CAAC,CAAC8B,IAAI,CAAC;EAC5C;;EAEA;AACF;AACA;EACEK,gBAAgBA,CAACC,IAAY,EAAE;IAC7B,OAAOpB,qBAAA,CAAKd,aAAa,EAAlB,IAAiB,CAAC,CAACkC,IAAI,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,sBAAsBA,CAACD,IAAY,EAAEE,IAAW,EAAW;IACzD,MAAMC,QAAQ,GAAGvB,qBAAA,CAAKd,aAAa,EAAlB,IAAiB,CAAC,CAACkC,IAAI,CAAC;IACzC,IAAII,OAAO,GAAG,CAACD,QAAQ,IAAIA,QAAQ,CAACX,MAAM,KAAKU,IAAI,CAACV,MAAM;IAC1D,KAAK,IAAIa,CAAC,GAAG,CAAC,EAAE,CAACD,OAAO,IAAIC,CAAC,GAAGH,IAAI,CAACV,MAAM,EAAE,EAAEa,CAAC,EAAE;MAChDD,OAAO,GAAGD,QAAQ,CAAEE,CAAC,CAAC,KAAKH,IAAI,CAACG,CAAC,CAAC;IACpC;IACAzB,qBAAA,CAAKd,aAAa,EAAlB,IAAiB,CAAC,CAACkC,IAAI,CAAC,GAAGV,MAAM,CAACgB,MAAM,CAACJ,IAAI,CAAC;IAC9C,OAAOE,OAAO;EAChB;;EAEA;AACF;AACA;AACA;AACA;EACEG,cAAcA,CAACC,IAAuB,EAAU;IAC9C,IAAI7B,KAAK,GAAG6B,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnC,YAAY,GAAGO,qBAAA,CAAKb,aAAa,EAAlB,IAAiB,CAAC,GAAGa,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IACxE,IAAIS,KAAK,KAAK8B,SAAS,IAAI,CAAAD,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEE,YAAY,MAAKD,SAAS,EAAE,OAAO9B,KAAK;IAEzE,MAAMgC,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5B/B,KAAK,GAAGvB,UAAU,CAACuD,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAClC,IAAI/B,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,KAAKuC,SAAS,EAAE,IAAI,CAACG,cAAc,CAACjC,KAAK,CAAC;IAChE,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;EACUkC,iBAAiBA,CAACb,IAA+B,EAAEc,KAAc,EAAE;IACzE,IAAIjC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIrB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,MAAMqD,CAAC,GAAG,OAAOf,IAAI,KAAK,QAAQ,GAC9B,IAAIA,IAAI,GAAG,GAAG,4BAA4B;MAC9Cf,OAAO,CAACC,cAAc,CAAC,kCAAkC6B,CAAC,EAAE,CAAC;MAC7D9B,OAAO,CAACE,GAAG,CAAC,YAAY,EAAE1B,eAAe,CAACqD,KAAK,EAAEd,IAAI,aAAJA,IAAI,cAAJA,IAAI,GAAI,EAAE,CAAC,CAAC;MAC7Df,OAAO,CAACE,GAAG,CAAC,YAAY,EAAE1B,eAAe,CAACmB,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,CAAC,CAAC;MAC9De,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;IAEA,IAAI,IAAI,CAACd,UAAU,EAAE;MACnB,IAAI,CAACA,UAAU,CAACG,KAAK,GAAG,IAAI;MAC5B,IAAI,CAACH,UAAU,CAACK,KAAK,GAAGC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IAC5C,CAAC,MAAM,IAAI,CAACU,qBAAA,CAAKX,eAAe,EAApB,IAAmB,CAAC,EAAE;MAChCO,qBAAA,CAAKP,eAAe,EAApB,IAAI,EAAmB+C,UAAU,CAAC,MAAM;QACtCxC,qBAAA,CAAKP,eAAe,EAApB,IAAI,EAAmBwC,SAAJ,CAAC;QACpB,MAAMQ,QAAQ,GAAG,CAAC,GAAGrC,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC,CAAC;QACpC,KAAK,IAAIqC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGY,QAAQ,CAACzB,MAAM,EAAE,EAAEa,CAAC,EAAE;UACxCY,QAAQ,CAACZ,CAAC,CAAC,CAAE,CAAC;QAChB;MACF,CAAC,CANkB,CAAC;IAOtB;EACF;;EAEA;AACF;AACA;AACA;EACEa,yBAAyBA,CAACxB,IAAY,EAAEyB,EAAc,EAAE;IACtDvC,qBAAA,CAAKhB,wBAAwB,EAA7B,IAA4B,CAAC,CAAC8B,IAAI,CAAC,GAAGyB,EAAE;EAC1C;;EAEA;AACF;AACA;AACA;EACEP,cAAcA,CAACE,KAAa,EAAU;IACpC,IAAIlC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC,KAAK4C,KAAK,EAAE;MAChCtC,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiB4C,KAAJ,CAAC;MAClB,IAAI,CAACD,iBAAiB,CAAC,IAAI,EAAEC,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAEE;;EAGA;EACA;EACA;EACA;EACA;;EAOA;EACA;;EAMA3D,GAAGA,CAAS6C,IAAoB,EAAEQ,IAAuB,EAAU;IACjE,IAAIlD,KAAK,CAAC0C,IAAI,CAAC,EAAE;MACf,MAAMoB,GAAG,GAAG,IAAI,CAACb,cAAc,CAAEC,IAAoC,CAAC;MACtE,OAAQY,GAAG;IACb;IAEA,MAAMzC,KAAK,GAAG6B,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnC,YAAY,GAAGO,qBAAA,CAAKb,aAAa,EAAlB,IAAiB,CAAC,GAAGa,qBAAA,CAAKV,aAAa,EAAlB,IAAiB,CAAC;IAE1E,IAAIkD,GAAG,GAAGjE,GAAG,CAACwB,KAAK,EAAEqB,IAAI,CAAC;IAC1B,IAAIoB,GAAG,KAAKX,SAAS,IAAI,CAAAD,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEE,YAAY,MAAKD,SAAS,EAAE,OAAOW,GAAG;IAErE,MAAMT,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5BU,GAAG,GAAGhE,UAAU,CAACuD,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAEhC,IAAI,EAACH,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnC,YAAY,KAAI,IAAI,CAAClB,GAAG,CAAC6C,IAAI,CAAC,KAAKS,SAAS,EAAE;MACvD,IAAI,CAAClD,GAAG,CAAkByC,IAAI,EAAEoB,GAAG,CAAC;IACtC;IAEA,OAAOA,GAAG;EACZ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;;EAEE;;EAOA;EACA;;EAMA7D,GAAGA,CAACyC,IAA+B,EAAEc,KAAc,EAAW;IAC5D,IAAIxD,KAAK,CAAC0C,IAAI,CAAC,EAAE,OAAO,IAAI,CAACY,cAAc,CAACE,KAAe,CAAC;IAE5D,IAAIA,KAAK,KAAK,IAAI,CAAC3D,GAAG,CAAC6C,IAAI,CAAC,EAAE;MAC5B,MAAMqB,IAAI,GAAG;QAAE1C,KAAK,EAAEC,qBAAA,CAAKV,aAAa,EAAlB,IAAiB;MAAE,CAAC;MAC1C,IAAIoD,MAAM,GAAG,CAAC;MACd,IAAIC,GAAQ,GAAGF,IAAI;MACnB,MAAMG,YAAY,GAAGhE,MAAM,CAAC,SAASwC,IAAI,EAAE,CAAC;MAC5C,OAAOsB,MAAM,GAAGE,YAAY,CAAChC,MAAM,GAAG,CAAC,EAAE8B,MAAM,IAAI,CAAC,EAAE;QACpD,MAAMG,GAAG,GAAGD,YAAY,CAACF,MAAM,CAAE;QACjC,MAAMI,IAAI,GAAGH,GAAG,CAACE,GAAG,CAAC;QACrB,IAAIE,KAAK,CAACC,OAAO,CAACF,IAAI,CAAC,EAAEH,GAAG,CAACE,GAAG,CAAC,GAAG,CAAC,GAAGC,IAAI,CAAC,CAAC,KACzC,IAAIrE,QAAQ,CAACqE,IAAI,CAAC,EAAEH,GAAG,CAACE,GAAG,CAAC,GAAG;UAAE,GAAGC;QAAK,CAAC,CAAC,KAC3C;UACH;UACA;UACA;UACAnE,GAAG,CAACgE,GAAG,EAAEC,YAAY,CAACK,KAAK,CAACP,MAAM,CAAC,EAAER,KAAK,CAAC;UAC3C;QACF;QACAS,GAAG,GAAGA,GAAG,CAACE,GAAG,CAAC;MAChB;MAEA,IAAIH,MAAM,KAAKE,YAAY,CAAChC,MAAM,GAAG,CAAC,EAAE;QACtC+B,GAAG,CAACC,YAAY,CAACF,MAAM,CAAC,CAAE,GAAGR,KAAK;MACpC;MAEAtC,qBAAA,CAAKN,aAAa,EAAlB,IAAI,EAAiBmD,IAAI,CAAC1C,KAAT,CAAC;MAElB,IAAI,CAACkC,iBAAiB,CAACb,IAAI,EAAEc,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEgB,OAAOA,CAACC,QAAmB,EAAE;IAC3B,IAAI,IAAI,CAACzD,UAAU,EAAE,MAAM,IAAI0D,KAAK,CAACrE,gBAAgB,CAAC;IAEtD,MAAMsD,QAAQ,GAAGrC,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC;IAC/B,MAAMuD,GAAG,GAAGN,QAAQ,CAACgB,OAAO,CAACF,QAAQ,CAAC;IACtC,IAAIR,GAAG,IAAI,CAAC,EAAE;MACZN,QAAQ,CAACM,GAAG,CAAC,GAAGN,QAAQ,CAACA,QAAQ,CAACzB,MAAM,GAAG,CAAC,CAAE;MAC9CyB,QAAQ,CAACiB,GAAG,CAAC,CAAC;IAChB;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,KAAKA,CAACJ,QAAmB,EAAE;IACzB,IAAI,IAAI,CAACzD,UAAU,EAAE,MAAM,IAAI0D,KAAK,CAACrE,gBAAgB,CAAC;IAEtD,MAAMsD,QAAQ,GAAGrC,qBAAA,CAAKZ,SAAS,EAAd,IAAa,CAAC;IAC/B,IAAIiD,QAAQ,CAACgB,OAAO,CAACF,QAAQ,CAAC,GAAG,CAAC,EAAE;MAClCd,QAAQ,CAACmB,IAAI,CAACL,QAAQ,CAAC;IACzB;EACF;AACF","ignoreList":[]}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":["GlobalState","GlobalStateProvider","getGlobalState","getSsrContext","SsrContext","useAsyncCollection","newAsyncDataEnvelope","useAsyncData","useGlobalState","api","withGlobalStateType"],"sources":["../../src/index.ts"],"sourcesContent":["import GlobalState from './GlobalState';\n\nimport GlobalStateProvider, {\n getGlobalState,\n getSsrContext,\n} from './GlobalStateProvider';\n\nimport SsrContext from './SsrContext';\n\nimport useAsyncCollection, {\n type UseAsyncCollectionI,\n type UseAsyncCollectionResT,\n} from './useAsyncCollection';\n\nimport {\n type AsyncDataEnvelopeT,\n type AsyncDataLoaderT,\n type AsyncDataReloaderT,\n type UseAsyncDataI,\n type UseAsyncDataOptionsT,\n type UseAsyncDataResT,\n newAsyncDataEnvelope,\n useAsyncData,\n} from './useAsyncData';\n\nimport useGlobalState, { type UseGlobalStateI } from './useGlobalState';\n\nexport type { AsyncCollectionLoaderT } from './useAsyncCollection';\n\nexport type { SetterT, UseGlobalStateResT } from './useGlobalState';\n\nexport type { ForceT, ValueOrInitializerT } from './utils';\n\nexport {\n type AsyncDataEnvelopeT,\n type AsyncDataLoaderT,\n type AsyncDataReloaderT,\n type UseAsyncCollectionResT,\n type UseAsyncDataOptionsT,\n type UseAsyncDataResT,\n getGlobalState,\n getSsrContext,\n GlobalState,\n GlobalStateProvider,\n newAsyncDataEnvelope,\n SsrContext,\n useAsyncCollection,\n useAsyncData,\n useGlobalState,\n};\n\ninterface API<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n> {\n getGlobalState: typeof getGlobalState<StateT, SsrContextT>;\n getSsrContext: typeof getSsrContext<SsrContextT>,\n GlobalState: typeof GlobalState<StateT, SsrContextT>,\n GlobalStateProvider: typeof GlobalStateProvider<StateT, SsrContextT>,\n newAsyncDataEnvelope: typeof newAsyncDataEnvelope,\n SsrContext: typeof SsrContext<StateT>,\n useAsyncCollection: UseAsyncCollectionI<StateT>,\n useAsyncData: UseAsyncDataI<StateT>,\n useGlobalState: UseGlobalStateI<StateT>,\n}\n\nconst api = {\n getGlobalState,\n getSsrContext,\n GlobalState,\n GlobalStateProvider,\n newAsyncDataEnvelope,\n SsrContext,\n useAsyncCollection,\n useAsyncData,\n useGlobalState,\n};\n\nexport function withGlobalStateType<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n>() {\n return api as API<StateT, SsrContextT>;\n}\n"],"mappings":"AAAA,OAAOA,WAAW;AAElB,OAAOC,mBAAmB,IACxBC,cAAc,EACdC,aAAa;AAGf,OAAOC,UAAU;AAEjB,OAAOC,kBAAkB;AAKzB,SAOEC,oBAAoB,EACpBC,YAAY;AAGd,OAAOC,cAAc;AAQrB,SAOEN,cAAc,EACdC,aAAa,EACbH,WAAW,EACXC,mBAAmB,EACnBK,oBAAoB,EACpBF,UAAU,EACVC,kBAAkB,EAClBE,YAAY,EACZC,cAAc;AAkBhB,MAAMC,GAAG,GAAG;EACVP,cAAc;EACdC,aAAa;EACbH,WAAW;EACXC,mBAAmB;EACnBK,oBAAoB;EACpBF,UAAU;EACVC,kBAAkB;EAClBE,YAAY;EACZC;AACF,CAAC;AAED,OAAO,SAASE,mBAAmBA,CAAA,EAG/B;EACF,OAAOD,GAAG;AACZ","ignoreList":[]}
1
+ {"version":3,"file":"index.js","names":["GlobalState","GlobalStateProvider","getGlobalState","getSsrContext","SsrContext","useAsyncCollection","newAsyncDataEnvelope","useAsyncData","useGlobalState","api","withGlobalStateType"],"sources":["../../src/index.ts"],"sourcesContent":["import GlobalState from './GlobalState';\n\nimport GlobalStateProvider, {\n getGlobalState,\n getSsrContext,\n} from './GlobalStateProvider';\n\nimport SsrContext from './SsrContext';\n\nimport useAsyncCollection, {\n type UseAsyncCollectionI,\n type UseAsyncCollectionResT,\n} from './useAsyncCollection';\n\nimport {\n type AsyncDataEnvelopeT,\n type AsyncDataLoaderT,\n type AsyncDataReloaderT,\n type UseAsyncDataI,\n type UseAsyncDataOptionsT,\n type UseAsyncDataResT,\n newAsyncDataEnvelope,\n useAsyncData,\n} from './useAsyncData';\n\nimport useGlobalState, { type UseGlobalStateI } from './useGlobalState';\n\nexport type { AsyncCollectionLoaderT, AsyncCollectionT } from './useAsyncCollection';\n\nexport type { SetterT, UseGlobalStateResT } from './useGlobalState';\n\nexport type { ForceT, ValueOrInitializerT } from './utils';\n\nexport {\n type AsyncDataEnvelopeT,\n type AsyncDataLoaderT,\n type AsyncDataReloaderT,\n type UseAsyncCollectionResT,\n type UseAsyncDataOptionsT,\n type UseAsyncDataResT,\n getGlobalState,\n getSsrContext,\n GlobalState,\n GlobalStateProvider,\n newAsyncDataEnvelope,\n SsrContext,\n useAsyncCollection,\n useAsyncData,\n useGlobalState,\n};\n\ninterface API<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n> {\n getGlobalState: typeof getGlobalState<StateT, SsrContextT>;\n getSsrContext: typeof getSsrContext<SsrContextT>,\n GlobalState: typeof GlobalState<StateT, SsrContextT>,\n GlobalStateProvider: typeof GlobalStateProvider<StateT, SsrContextT>,\n newAsyncDataEnvelope: typeof newAsyncDataEnvelope,\n SsrContext: typeof SsrContext<StateT>,\n useAsyncCollection: UseAsyncCollectionI<StateT>,\n useAsyncData: UseAsyncDataI<StateT>,\n useGlobalState: UseGlobalStateI<StateT>,\n}\n\nconst api = {\n getGlobalState,\n getSsrContext,\n GlobalState,\n GlobalStateProvider,\n newAsyncDataEnvelope,\n SsrContext,\n useAsyncCollection,\n useAsyncData,\n useGlobalState,\n};\n\nexport function withGlobalStateType<\n StateT,\n SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n>() {\n return api as API<StateT, SsrContextT>;\n}\n"],"mappings":"AAAA,OAAOA,WAAW;AAElB,OAAOC,mBAAmB,IACxBC,cAAc,EACdC,aAAa;AAGf,OAAOC,UAAU;AAEjB,OAAOC,kBAAkB;AAKzB,SAOEC,oBAAoB,EACpBC,YAAY;AAGd,OAAOC,cAAc;AAQrB,SAOEN,cAAc,EACdC,aAAa,EACbH,WAAW,EACXC,mBAAmB,EACnBK,oBAAoB,EACpBF,UAAU,EACVC,kBAAkB,EAClBE,YAAY,EACZC,cAAc;AAkBhB,MAAMC,GAAG,GAAG;EACVP,cAAc;EACdC,aAAa;EACbH,WAAW;EACXC,mBAAmB;EACnBK,oBAAoB;EACpBF,UAAU;EACVC,kBAAkB;EAClBE,YAAY;EACZC;AACF,CAAC;AAED,OAAO,SAASE,mBAAmBA,CAAA,EAG/B;EACF,OAAOD,GAAG;AACZ","ignoreList":[]}
@@ -7,7 +7,125 @@ import { v4 as uuid } from 'uuid';
7
7
  import { getGlobalState } from "./GlobalStateProvider";
8
8
  import { DEFAULT_MAXAGE, load, newAsyncDataEnvelope } from "./useAsyncData";
9
9
  import useGlobalState from "./useGlobalState";
10
- import { isDebugMode } from "./utils";
10
+ import { hash, isDebugMode } from "./utils";
11
+ /**
12
+ * GarbageCollector: the piece of logic executed on mounting of
13
+ * an useAsyncCollection() hook, and on update of hook params, to update
14
+ * the state according to the new param values. It increments by 1 `numRefs`
15
+ * counters for the requested collection items.
16
+ */
17
+ function gcOnWithhold(ids, path, gs) {
18
+ const collection = {
19
+ ...gs.get(path)
20
+ };
21
+ for (let i = 0; i < ids.length; ++i) {
22
+ const id = ids[i];
23
+ let envelope = collection[id];
24
+ if (envelope) envelope = {
25
+ ...envelope,
26
+ numRefs: 1 + envelope.numRefs
27
+ };else envelope = newAsyncDataEnvelope(null, {
28
+ numRefs: 1
29
+ });
30
+ collection[id] = envelope;
31
+ }
32
+ gs.set(path, collection);
33
+ }
34
+ function idsToStringSet(ids) {
35
+ const res = new Set();
36
+ for (let i = 0; i < ids.length; ++i) {
37
+ res.add(ids[i].toString());
38
+ }
39
+ return res;
40
+ }
41
+
42
+ /**
43
+ * GarbageCollector: the piece of logic executed on un-mounting of
44
+ * an useAsyncCollection() hook, and on update of hook params, to clean-up
45
+ * after the previous param values. It decrements by 1 `numRefs` counters
46
+ * for previously requested collection items, and also drops from the state
47
+ * stale records.
48
+ */
49
+ function gcOnRelease(ids, path, gs, gcAge) {
50
+ const entries = Object.entries(gs.get(path));
51
+ const now = Date.now();
52
+ const idSet = idsToStringSet(ids);
53
+ const collection = {};
54
+ for (let i = 0; i < entries.length; ++i) {
55
+ const [id, envelope] = entries[i];
56
+ if (envelope) {
57
+ const toBeReleased = idSet.has(id);
58
+ let {
59
+ numRefs
60
+ } = envelope;
61
+ if (toBeReleased) --numRefs;
62
+ if (gcAge > now - envelope.timestamp || numRefs > 0) {
63
+ collection[id] = toBeReleased ? {
64
+ ...envelope,
65
+ numRefs
66
+ } : envelope;
67
+ } else if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
68
+ // eslint-disable-next-line no-console
69
+ console.log(`useAsyncCollection(): Garbage collected at the path "${path}", ID = ${id}`);
70
+ }
71
+ }
72
+ }
73
+ gs.set(path, collection);
74
+ }
75
+ function normalizeIds(idOrIds) {
76
+ if (Array.isArray(idOrIds)) {
77
+ const res = [...idOrIds];
78
+ res.sort();
79
+ return res;
80
+ }
81
+ return [idOrIds];
82
+ }
83
+
84
+ /**
85
+ * Inits/updates, and returns the heap.
86
+ */
87
+ function useHeap(ids, path, loader, gs) {
88
+ const ref = useRef();
89
+ let heap = ref.current;
90
+ if (heap) {
91
+ // Update.
92
+ heap.ids = ids;
93
+ heap.path = path;
94
+ heap.loader = loader;
95
+ heap.globalState = gs;
96
+ } else {
97
+ // Initialization.
98
+ const reload = async customLoader => {
99
+ const heap2 = ref.current;
100
+ const localLoader = customLoader || heap2.loader;
101
+ if (!localLoader || !heap2.globalState || !heap2.ids) {
102
+ throw Error('Internal error');
103
+ }
104
+ for (let i = 0; i < heap2.ids.length; ++i) {
105
+ const id = heap2.ids[i];
106
+ const itemPath = heap2.path ? `${heap2.path}.${id}` : `${id}`;
107
+
108
+ // eslint-disable-next-line no-await-in-loop
109
+ await load(itemPath, (oldData, meta) => localLoader(id, oldData, meta), heap2.globalState);
110
+ }
111
+ };
112
+ heap = {
113
+ globalState: gs,
114
+ ids,
115
+ path,
116
+ loader,
117
+ reload,
118
+ reloadSingle: customLoader => ref.current.reload(customLoader && function (id) {
119
+ for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
120
+ args[_key - 1] = arguments[_key];
121
+ }
122
+ return customLoader(...args);
123
+ })
124
+ };
125
+ ref.current = heap;
126
+ }
127
+ return heap;
128
+ }
11
129
 
12
130
  /**
13
131
  * Resolves and stores at the given `path` of the global state elements of
@@ -20,47 +138,12 @@ import { isDebugMode } from "./utils";
20
138
  function useAsyncCollection(idOrIds, path, loader) {
21
139
  var _options$maxage, _options$refreshAge, _options$garbageColle;
22
140
  let options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
23
- const ids = Array.isArray(idOrIds) ? idOrIds : [idOrIds];
141
+ const ids = normalizeIds(idOrIds);
24
142
  const maxage = (_options$maxage = options.maxage) !== null && _options$maxage !== void 0 ? _options$maxage : DEFAULT_MAXAGE;
25
143
  const refreshAge = (_options$refreshAge = options.refreshAge) !== null && _options$refreshAge !== void 0 ? _options$refreshAge : maxage;
26
144
  const garbageCollectAge = (_options$garbageColle = options.garbageCollectAge) !== null && _options$garbageColle !== void 0 ? _options$garbageColle : maxage;
27
-
28
- // To avoid unnecessary work if consumer passes down the same IDs
29
- // in an unstable order.
30
- // TODO: Should we also filter out any duplicates? Or just assume consumer
31
- // knows what he is doing, and won't place duplicates into IDs array?e
32
- ids.sort();
33
145
  const globalState = getGlobalState();
34
- const {
35
- current: heap
36
- } = useRef({});
37
- heap.globalState = globalState;
38
- heap.ids = ids;
39
- heap.path = path;
40
- heap.loader = loader;
41
- if (!heap.reload) {
42
- heap.reload = async customLoader => {
43
- const localLoader = customLoader || heap.loader;
44
- if (!localLoader || !heap.globalState || !heap.ids) {
45
- throw Error('Internal error');
46
- }
47
- for (let i = 0; i < heap.ids.length; ++i) {
48
- const id = heap.ids[i];
49
- const itemPath = heap.path ? `${heap.path}.${id}` : `${id}`;
50
-
51
- // eslint-disable-next-line no-await-in-loop
52
- await load(itemPath, (oldData, meta) => localLoader(id, oldData, meta), heap.globalState);
53
- }
54
- };
55
- }
56
- if (!Array.isArray(idOrIds)) {
57
- heap.reloadD = customLoader => heap.reload(customLoader && function (id) {
58
- for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
59
- args[_key - 1] = arguments[_key];
60
- }
61
- return customLoader(...args);
62
- });
63
- }
146
+ const heap = useHeap(ids, path, loader, globalState);
64
147
 
65
148
  // Server-side logic.
66
149
  if (globalState.ssrContext && !options.noSSR) {
@@ -88,51 +171,24 @@ function useAsyncCollection(idOrIds, path, loader) {
88
171
  } else {
89
172
  // Reference-counting & garbage collection.
90
173
 
174
+ const idsHash = hash(ids);
175
+
91
176
  // TODO: Violation of rules of hooks is fine here,
92
177
  // but perhaps it can be refactored to avoid the need for it.
93
178
  useEffect(() => {
94
179
  // eslint-disable-line react-hooks/rules-of-hooks
95
- for (let i = 0; i < ids.length; ++i) {
96
- const id = ids[i];
97
- const itemPath = path ? `${path}.${id}` : `${id}`;
98
- const state = globalState.get(itemPath, {
99
- initialValue: newAsyncDataEnvelope()
100
- });
101
- const numRefsPath = itemPath ? `${itemPath}.numRefs` : 'numRefs';
102
- globalState.set(numRefsPath, state.numRefs + 1);
103
- }
104
- return () => {
105
- for (let i = 0; i < ids.length; ++i) {
106
- const id = ids[i];
107
- const itemPath = path ? `${path}.${id}` : `${id}`;
108
- const state2 = globalState.get(itemPath);
109
- if (state2.numRefs === 1 && garbageCollectAge < Date.now() - state2.timestamp) {
110
- if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
111
- /* eslint-disable no-console */
112
- console.log(`ReactGlobalState - useAsyncCollection garbage collected at path ${itemPath || ''}`);
113
- /* eslint-enable no-console */
114
- }
115
- globalState.dropDependencies(itemPath || '');
116
- globalState.set(itemPath, {
117
- ...state2,
118
- data: null,
119
- numRefs: 0,
120
- timestamp: 0
121
- });
122
- } else {
123
- const numRefsPath = itemPath ? `${itemPath}.numRefs` : 'numRefs';
124
- globalState.set(numRefsPath, state2.numRefs - 1);
125
- }
126
- }
127
- };
180
+ gcOnWithhold(ids, path, globalState);
181
+ return () => gcOnRelease(ids, path, globalState, garbageCollectAge);
182
+
183
+ // `ids` are represented in the dependencies array by `idsHash` value,
184
+ // as useEffect() hook requires a constant size of dependencies array.
128
185
  // eslint-disable-next-line react-hooks/exhaustive-deps
129
- }, [garbageCollectAge, globalState, path, ...ids]);
186
+ }, [garbageCollectAge, globalState, idsHash, path]);
130
187
 
131
188
  // NOTE: a bunch of Rules of Hooks ignored belows because in our very
132
189
  // special case the otherwise wrong behavior is actually what we need.
133
190
 
134
191
  // Data loading and refreshing.
135
- const loadTriggeredForIds = new Set();
136
192
  useEffect(() => {
137
193
  // eslint-disable-line react-hooks/rules-of-hooks
138
194
  (async () => {
@@ -145,7 +201,6 @@ function useAsyncCollection(idOrIds, path, loader) {
145
201
  } = options;
146
202
  if (deps && globalState.hasChangedDependencies(itemPath, deps) || refreshAge < Date.now() - state2.timestamp && (!state2.operationId || state2.operationId.charAt(0) === 'S')) {
147
203
  if (!deps) globalState.dropDependencies(itemPath);
148
- loadTriggeredForIds.add(id);
149
204
  // eslint-disable-next-line no-await-in-loop
150
205
  await load(itemPath, function () {
151
206
  for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
@@ -160,26 +215,6 @@ function useAsyncCollection(idOrIds, path, loader) {
160
215
  }
161
216
  })();
162
217
  });
163
- useEffect(() => {
164
- // eslint-disable-line react-hooks/rules-of-hooks
165
- (async () => {
166
- const {
167
- deps
168
- } = options;
169
- for (let i = 0; i < ids.length; ++i) {
170
- const id = ids[i];
171
- const itemPath = path ? `${path}.${id}` : `${id}`;
172
- if (deps && globalState.hasChangedDependencies(itemPath || '', deps) && !loadTriggeredForIds.has(id)) {
173
- // eslint-disable-next-line no-await-in-loop
174
- await load(itemPath, (oldData, meta) => loader(id, oldData, meta), globalState);
175
- }
176
- }
177
- })();
178
-
179
- // Here we need to default to empty array, so that this hook is re-evaluated
180
- // only when dependencies specified in options change, and it should not be
181
- // re-evaluated at all if no `deps` option is used.
182
- }, options.deps || []); // eslint-disable-line react-hooks/exhaustive-deps
183
218
  }
184
219
  const [localState] = useGlobalState(path, {});
185
220
  if (!Array.isArray(idOrIds)) {
@@ -189,7 +224,7 @@ function useAsyncCollection(idOrIds, path, loader) {
189
224
  return {
190
225
  data: maxage < Date.now() - timestamp ? null : (_e$data = e === null || e === void 0 ? void 0 : e.data) !== null && _e$data !== void 0 ? _e$data : null,
191
226
  loading: !!(e !== null && e !== void 0 && e.operationId),
192
- reload: heap.reloadD,
227
+ reload: heap.reloadSingle,
193
228
  timestamp
194
229
  };
195
230
  }