@dr.pogodin/react-global-state 0.10.0-alpha.2 → 0.10.0-alpha.4

package/build/module/GlobalState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalState.js","names":["cloneDeep","get","isFunction","isObject","isNil","set","toPath","isDebugMode","ERR_NO_SSR_WATCH","_initialState","WeakMap","_watchers","_nextNotifierId","_currentState","GlobalState","constructor","initialState","ssrContext","_classPrivateFieldInitSpec","writable","value","_classPrivateFieldSet","dirty","pending","state","_classPrivateFieldGet","process","env","NODE_ENV","msg","console","groupCollapsed","log","groupEnd","getEntireState","opts","undefined","initialValue","iv","setEntireState","notifyStateUpdate","path","p","setTimeout","watchers","i","length","res","root","segIdx","pos","pathSegments","seg","next","Array","isArray","slice","unWatch","callback","Error","indexOf","pop","watch","push"],"sources":["../../src/GlobalState.ts"],"sourcesContent":["import {\n  cloneDeep,\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  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  #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:', cloneDeep(initialState));\n      console.groupEnd();\n      /* eslint-enable no-console */\n    }\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:', cloneDeep(value));\n      console.log('New state:', cloneDeep(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,SAAS,EACTC,GAAG,EACHC,UAAU,EACVC,QAAQ,EACRC,KAAK,EACLC,GAAG,EACHC,MAAM,QACD,QAAQ;AAIf,SAOEC,WAAW;AAGb,MAAMC,gBAAgB,GAAG,gDAAgD;AAAC,IAAAC,aAAA,oBAAAC,OAAA;AAAA,IAAAC,SAAA,oBAAAD,OAAA;AAAA,IAAAE,eAAA,oBAAAF,OAAA;AAAA,IAAAG,aAAA,oBAAAH,OAAA;AAO1E,eAAe,MAAMI,WAAW,CAG9B;EAeA;AACF;AACA;AACA;AACA;EACEC,WAAWA,CACTC,YAAoB,EACpBC,UAAwB,EACxB;IAAAC,0BAAA,OAAAT,aAAA;MAAAU,QAAA;MAAAC,KAAA;IAAA;IAlBF;IACA;IACA;IACA;IAAAF,0BAAA,OAAAP,SAAA;MAAAQ,QAAA;MAAAC,KAAA,EACyB;IAAE;IAAAF,0BAAA,OAAAN,eAAA;MAAAO,QAAA;MAAAC,KAAA;IAAA;IAAAF,0BAAA,OAAAL,aAAA;MAAAM,QAAA;MAAAC,KAAA;IAAA;IAezBC,qBAAA,KAAI,EAAAR,aAAA,EAAiBG,YAAY;IACjCK,qBAAA,KAAI,EAAAZ,aAAA,EAAiBO,YAAY;IAEjC,IAAIC,UAAU,EAAE;MACd;MACAA,UAAU,CAACK,KAAK,GAAG,KAAK;MACxBL,UAAU,CAACM,OAAO,GAAG,EAAE;MACvBN,UAAU,CAACO,KAAK,GAAAC,qBAAA,CAAG,IAAI,EAAAZ,aAAA,CAAc;MACrC;;MAEA,IAAI,CAACI,UAAU,GAAGA,UAAU;IAC9B;IAEA,IAAIS,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIrB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,IAAIsB,GAAG,GAAG,8BAA8B;MACxC,IAAIZ,UAAU,EAAEY,GAAG,IAAI,aAAa;MACpCC,OAAO,CAACC,cAAc,CAACF,GAAG,CAAC;MAC3BC,OAAO,CAACE,GAAG,CAAC,gBAAgB,EAAEhC,SAAS,CAACgB,YAAY,CAAC,CAAC;MACtDc,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;;EAEA;AACF;AACA;AACA;AACA;EACEC,cAAcA,CAACC,IAAuB,EAAU;IAC9C,IAAIX,KAAK,GAAGW,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnB,YAAY,GAAAS,qBAAA,CAAG,IAAI,EAAAhB,aAAA,IAAAgB,qBAAA,CAAiB,IAAI,EAAAZ,aAAA,CAAc;IACxE,IAAIW,KAAK,KAAKY,SAAS,IAAI,CAAAD,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEE,YAAY,MAAKD,SAAS,EAAE,OAAOZ,KAAK;IAEzE,MAAMc,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5Bb,KAAK,GAAGtB,UAAU,CAACoC,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAClC,IAAIb,qBAAA,KAAI,EAAAZ,aAAA,MAAmBuB,SAAS,EAAE,IAAI,CAACG,cAAc,CAACf,KAAK,CAAC;IAChE,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;EACUgB,iBAAiBA,CAACC,IAA+B,EAAErB,KAAc,EAAE;IACzE,IAAIM,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAIrB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACA,MAAMmC,CAAC,GAAG,OAAOD,IAAI,KAAK,QAAQ,GAC7B,IAAGA,IAAK,GAAE,GAAG,4BAA4B;MAC9CX,OAAO,CAACC,cAAc,CAAE,kCAAiCW,CAAE,EAAC,CAAC;MAC7DZ,OAAO,CAACE,GAAG,CAAC,YAAY,EAAEhC,SAAS,CAACoB,KAAK,CAAC,CAAC;MAC3CU,OAAO,CAACE,GAAG,CAAC,YAAY,EAAEhC,SAAS,CAAAyB,qBAAA,CAAC,IAAI,EAAAZ,aAAA,CAAc,CAAC,CAAC;MACxDiB,OAAO,CAACG,QAAQ,CAAC,CAAC;MAClB;IACF;;IAEA,IAAI,IAAI,CAAChB,UAAU,EAAE;MACnB,IAAI,CAACA,UAAU,CAACK,KAAK,GAAG,IAAI;MAC5B,IAAI,CAACL,UAAU,CAACO,KAAK,GAAAC,qBAAA,CAAG,IAAI,EAAAZ,aAAA,CAAc;IAC5C,CAAC,MAAM,IAAI,CAAAY,qBAAA,CAAC,IAAI,EAAAb,eAAA,CAAgB,EAAE;MAChCS,qBAAA,KAAI,EAAAT,eAAA,EAAmB+B,UAAU,CAAC,MAAM;QACtCtB,qBAAA,KAAI,EAAAT,eAAA,EAAmBwB,SAAS;QAChC,MAAMQ,QAAQ,GAAG,CAAC,GAAAnB,qBAAA,CAAG,IAAI,EAAAd,SAAA,CAAU,CAAC;QACpC,KAAK,IAAIkC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGD,QAAQ,CAACE,MAAM,EAAE,EAAED,CAAC,EAAE;UACxCD,QAAQ,CAACC,CAAC,CAAC,CAAC,CAAC;QACf;MACF,CAAC,CAAC;IACJ;EACF;;EAEA;AACF;AACA;AACA;EACEN,cAAcA,CAACnB,KAAa,EAAU;IACpC,IAAIK,qBAAA,KAAI,EAAAZ,aAAA,MAAmBO,KAAK,EAAE;MAChCC,qBAAA,KAAI,EAAAR,aAAA,EAAiBO,KAAK;MAC1B,IAAI,CAACoB,iBAAiB,CAAC,IAAI,EAAEpB,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;EAMAnB,GAAGA,CAASwC,IAAoB,EAAEN,IAAuB,EAAU;IACjE,IAAI/B,KAAK,CAACqC,IAAI,CAAC,EAAE;MACf,MAAMM,GAAG,GAAG,IAAI,CAACb,cAAc,CAAEC,IAAoC,CAAC;MACtE,OAAQY,GAAG;IACb;IAEA,MAAMvB,KAAK,GAAGW,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnB,YAAY,GAAAS,qBAAA,CAAG,IAAI,EAAAhB,aAAA,IAAAgB,qBAAA,CAAiB,IAAI,EAAAZ,aAAA,CAAc;IAE1E,IAAIkC,GAAG,GAAG9C,GAAG,CAACuB,KAAK,EAAEiB,IAAI,CAAC;IAC1B,IAAIM,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,GAAG7C,UAAU,CAACoC,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAEhC,IAAI,EAACH,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEnB,YAAY,KAAI,IAAI,CAACf,GAAG,CAACwC,IAAI,CAAC,KAAKL,SAAS,EAAE;MACvD,IAAI,CAAC/B,GAAG,CAAkBoC,IAAI,EAAEM,GAAG,CAAC;IACtC;IAEA,OAAOA,GAAG;EACZ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;;EAEE;EAOA;EACA;EAMA1C,GAAGA,CAACoC,IAA+B,EAAErB,KAAc,EAAW;IAC5D,IAAIhB,KAAK,CAACqC,IAAI,CAAC,EAAE,OAAO,IAAI,CAACF,cAAc,CAACnB,KAAe,CAAC;IAE5D,IAAIA,KAAK,KAAK,IAAI,CAACnB,GAAG,CAACwC,IAAI,CAAC,EAAE;MAC5B,MAAMO,IAAI,GAAG;QAAExB,KAAK,EAAAC,qBAAA,CAAE,IAAI,EAAAZ,aAAA;MAAe,CAAC;MAC1C,IAAIoC,MAAM,GAAG,CAAC;MACd,IAAIC,GAAQ,GAAGF,IAAI;MACnB,MAAMG,YAAY,GAAG7C,MAAM,CAAE,SAAQmC,IAAK,EAAC,CAAC;MAC5C,OAAOQ,MAAM,GAAGE,YAAY,CAACL,MAAM,GAAG,CAAC,EAAEG,MAAM,IAAI,CAAC,EAAE;QACpD,MAAMG,GAAG,GAAGD,YAAY,CAACF,MAAM,CAAC;QAChC,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,IAAIlD,QAAQ,CAACkD,IAAI,CAAC,EAAEH,GAAG,CAACE,GAAG,CAAC,GAAG;UAAE,GAAGC;QAAK,CAAC,CAAC,KAC3C;UACH;UACA;UACA;UACAhD,GAAG,CAAC6C,GAAG,EAAEC,YAAY,CAACK,KAAK,CAACP,MAAM,CAAC,EAAE7B,KAAK,CAAC;UAC3C;QACF;QACA8B,GAAG,GAAGA,GAAG,CAACE,GAAG,CAAC;MAChB;MAEA,IAAIH,MAAM,KAAKE,YAAY,CAACL,MAAM,GAAG,CAAC,EAAE;QACtCI,GAAG,CAACC,YAAY,CAACF,MAAM,CAAC,CAAC,GAAG7B,KAAK;MACnC;MAEAC,qBAAA,KAAI,EAAAR,aAAA,EAAiBmC,IAAI,CAACxB,KAAK;MAE/B,IAAI,CAACgB,iBAAiB,CAACC,IAAI,EAAErB,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEqC,OAAOA,CAACC,QAAmB,EAAE;IAC3B,IAAI,IAAI,CAACzC,UAAU,EAAE,MAAM,IAAI0C,KAAK,CAACnD,gBAAgB,CAAC;IAEtD,MAAMoC,QAAQ,GAAAnB,qBAAA,CAAG,IAAI,EAAAd,SAAA,CAAU;IAC/B,MAAMuC,GAAG,GAAGN,QAAQ,CAACgB,OAAO,CAACF,QAAQ,CAAC;IACtC,IAAIR,GAAG,IAAI,CAAC,EAAE;MACZN,QAAQ,CAACM,GAAG,CAAC,GAAGN,QAAQ,CAACA,QAAQ,CAACE,MAAM,GAAG,CAAC,CAAC;MAC7CF,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,CAACzC,UAAU,EAAE,MAAM,IAAI0C,KAAK,CAACnD,gBAAgB,CAAC;IAEtD,MAAMoC,QAAQ,GAAAnB,qBAAA,CAAG,IAAI,EAAAd,SAAA,CAAU;IAC/B,IAAIiC,QAAQ,CAACgB,OAAO,CAACF,QAAQ,CAAC,GAAG,CAAC,EAAE;MAClCd,QAAQ,CAACmB,IAAI,CAACL,QAAQ,CAAC;IACzB;EACF;AACF"}

package/build/module/GlobalStateProvider.js

@@ -0,0 +1,94 @@
+/* eslint-disable react/prop-types */
+
+import { isFunction } from 'lodash';
+import { createContext, useContext, useRef } from 'react';
+import GlobalState from "./GlobalState";
+import { jsx as _jsx } from "react/jsx-runtime";
+const context = /*#__PURE__*/createContext(null);
+
+/**
+ * Gets {@link GlobalState} instance from the context. In most cases
+ * you should use {@link useGlobalState}, and other hooks to interact with
+ * the global state, instead of accessing it directly.
+ * @return
+ */
+export function getGlobalState() {
+  // Here Rules of Hooks are violated because "getGlobalState()" does not follow
+  // convention that hook names should start with use... This is intentional in
+  // our case, as getGlobalState() hook is intended for advance scenarious,
+  // while the normal interaction with the global state should happen via
+  // another hook, useGlobalState().
+  /* eslint-disable react-hooks/rules-of-hooks */
+  const globalState = useContext(context);
+  /* eslint-enable react-hooks/rules-of-hooks */
+  if (!globalState) throw new Error('Missing GlobalStateProvider');
+  return globalState;
+}
+
+/**
+ * @category Hooks
+ * @desc Gets SSR context.
+ * @param throwWithoutSsrContext If `true` (default),
+ * this hook will throw if no SSR context is attached to the global state;
+ * set `false` to not throw in such case. In either case the hook will throw
+ * if the {@link <GlobalStateProvider>} (hence the state) is missing.
+ * @returns SSR context.
+ * @throws
+ * - If current component has no parent {@link <GlobalStateProvider>}
+ *   in the rendered React tree.
+ * - If `throwWithoutSsrContext` is `true`, and there is no SSR context attached
+ *   to the global state provided by {@link <GlobalStateProvider>}.
+ */
+export function getSsrContext() {
+  let throwWithoutSsrContext = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  const {
+    ssrContext
+  } = getGlobalState();
+  if (!ssrContext && throwWithoutSsrContext) {
+    throw new Error('No SSR context found');
+  }
+  return ssrContext;
+}
+/**
+ * Provides global state to its children.
+ * @param prop.children Component children, which will be provided with
+ * the global state, and rendered in place of the provider.
+ * @param prop.initialState Initial content of the global state.
+ * @param prop.ssrContext Server-side rendering (SSR) context.
+ * @param prop.stateProxy This option is useful for code
+ * splitting and SSR implementation:
+ * - If `true`, this provider instance will fetch and reuse the global state
+ *   from a parent provider.
+ * - If `GlobalState` instance, it will be used by this provider.
+ * - If not given, a new `GlobalState` instance will be created and used.
+ */
+export default function GlobalStateProvider(_ref) {
+  let {
+    children,
+    ...rest
+  } = _ref;
+  const state = useRef();
+  if (!state.current) {
+    // NOTE: The last part of condition, "&& rest.stateProxy", is needed for
+    // graceful compatibility with JavaScript - if "undefined" stateProxy value
+    // is given, we want to follow the second branch, which creates a new
+    // GlobalState with whatever intiialState given.
+    if ('stateProxy' in rest && rest.stateProxy) {
+      if (rest.stateProxy === true) state.current = getGlobalState();else state.current = rest.stateProxy;
+    } else {
+      const {
+        initialState,
+        ssrContext
+      } = rest;
+      state.current = new GlobalState(isFunction(initialState) ? initialState() : initialState, ssrContext);
+    }
+  }
+  return /*#__PURE__*/_jsx(context.Provider, {
+    value: state.current,
+    children: children
+  });
+}
+GlobalStateProvider.defaultProps = {
+  children: undefined
+};
+//# sourceMappingURL=GlobalStateProvider.js.map

package/build/module/GlobalStateProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalStateProvider.js","names":["isFunction","createContext","useContext","useRef","GlobalState","jsx","_jsx","context","getGlobalState","globalState","Error","getSsrContext","throwWithoutSsrContext","arguments","length","undefined","ssrContext","GlobalStateProvider","_ref","children","rest","state","current","stateProxy","initialState","Provider","value","defaultProps"],"sources":["../../src/GlobalStateProvider.tsx"],"sourcesContent":["/* eslint-disable react/prop-types */\n\nimport { isFunction } from 'lodash';\n\nimport {\n  type ReactNode,\n  createContext,\n  useContext,\n  useRef,\n} from 'react';\n\nimport GlobalState from './GlobalState';\nimport SsrContext from './SsrContext';\n\nimport { type ValueOrInitializerT } from './utils';\n\nconst context = createContext<GlobalState<unknown> | null>(null);\n\n/**\n * Gets {@link GlobalState} instance from the context. In most cases\n * you should use {@link useGlobalState}, and other hooks to interact with\n * the global state, instead of accessing it directly.\n * @return\n */\nexport function getGlobalState<\n  StateT,\n  SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n>(): GlobalState<StateT, SsrContextT> {\n  // Here Rules of Hooks are violated because \"getGlobalState()\" does not follow\n  // convention that hook names should start with use... This is intentional in\n  // our case, as getGlobalState() hook is intended for advance scenarious,\n  // while the normal interaction with the global state should happen via\n  // another hook, useGlobalState().\n  /* eslint-disable react-hooks/rules-of-hooks */\n  const globalState = useContext(context);\n  /* eslint-enable react-hooks/rules-of-hooks */\n  if (!globalState) throw new Error('Missing GlobalStateProvider');\n  return globalState as GlobalState<StateT, SsrContextT>;\n}\n\n/**\n * @category Hooks\n * @desc Gets SSR context.\n * @param throwWithoutSsrContext If `true` (default),\n * this hook will throw if no SSR context is attached to the global state;\n * set `false` to not throw in such case. In either case the hook will throw\n * if the {@link &lt;GlobalStateProvider&gt;} (hence the state) is missing.\n * @returns SSR context.\n * @throws\n * - If current component has no parent {@link &lt;GlobalStateProvider&gt;}\n *   in the rendered React tree.\n * - If `throwWithoutSsrContext` is `true`, and there is no SSR context attached\n *   to the global state provided by {@link &lt;GlobalStateProvider&gt;}.\n */\nexport function getSsrContext<\n  SsrContextT extends SsrContext<unknown>,\n>(\n  throwWithoutSsrContext = true,\n): SsrContextT | undefined {\n  const { ssrContext } = getGlobalState<SsrContextT['state'], SsrContextT>();\n  if (!ssrContext && throwWithoutSsrContext) {\n    throw new Error('No SSR context found');\n  }\n  return ssrContext;\n}\n\ntype NewStateProps<StateT, SsrContextT extends SsrContext<StateT>> = {\n  initialState: ValueOrInitializerT<StateT>,\n  ssrContext?: SsrContextT;\n};\n\ntype GlobalStateProviderProps<\n  StateT,\n  SsrContextT extends SsrContext<StateT>,\n> = {\n  children?: ReactNode;\n} & (NewStateProps<StateT, SsrContextT> | {\n  stateProxy: true | GlobalState<StateT, SsrContextT>;\n});\n\n/**\n * Provides global state to its children.\n * @param prop.children Component children, which will be provided with\n * the global state, and rendered in place of the provider.\n * @param prop.initialState Initial content of the global state.\n * @param prop.ssrContext Server-side rendering (SSR) context.\n * @param prop.stateProxy This option is useful for code\n * splitting and SSR implementation:\n * - If `true`, this provider instance will fetch and reuse the global state\n *   from a parent provider.\n * - If `GlobalState` instance, it will be used by this provider.\n * - If not given, a new `GlobalState` instance will be created and used.\n */\nexport default function GlobalStateProvider<\n  StateT,\n  SsrContextT extends SsrContext<StateT> = SsrContext<StateT>,\n>(\n  { children, ...rest }: GlobalStateProviderProps<StateT, SsrContextT>,\n) {\n  const state = useRef<GlobalState<StateT, SsrContextT>>();\n  if (!state.current) {\n    // NOTE: The last part of condition, \"&& rest.stateProxy\", is needed for\n    // graceful compatibility with JavaScript - if \"undefined\" stateProxy value\n    // is given, we want to follow the second branch, which creates a new\n    // GlobalState with whatever intiialState given.\n    if ('stateProxy' in rest && rest.stateProxy) {\n      if (rest.stateProxy === true) state.current = getGlobalState();\n      else state.current = rest.stateProxy;\n    } else {\n      const { initialState, ssrContext } = rest as NewStateProps<StateT, SsrContextT>;\n\n      state.current = new GlobalState<StateT, SsrContextT>(\n        isFunction(initialState) ? initialState() : initialState,\n        ssrContext,\n      );\n    }\n  }\n  return (\n    <context.Provider value={state.current}>\n      {children}\n    </context.Provider>\n  );\n}\n\nGlobalStateProvider.defaultProps = {\n  children: undefined,\n};\n"],"mappings":"AAAA;;AAEA,SAASA,UAAU,QAAQ,QAAQ;AAEnC,SAEEC,aAAa,EACbC,UAAU,EACVC,MAAM,QACD,OAAO;AAEd,OAAOC,WAAW;AAAsB,SAAAC,GAAA,IAAAC,IAAA;AAKxC,MAAMC,OAAO,gBAAGN,aAAa,CAA8B,IAAI,CAAC;;AAEhE;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,cAAcA,CAAA,EAGQ;EACpC;EACA;EACA;EACA;EACA;EACA;EACA,MAAMC,WAAW,GAAGP,UAAU,CAACK,OAAO,CAAC;EACvC;EACA,IAAI,CAACE,WAAW,EAAE,MAAM,IAAIC,KAAK,CAAC,6BAA6B,CAAC;EAChE,OAAOD,WAAW;AACpB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,aAAaA,CAAA,EAIF;EAAA,IADzBC,sBAAsB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,IAAI;EAE7B,MAAM;IAAEG;EAAW,CAAC,GAAGR,cAAc,CAAoC,CAAC;EAC1E,IAAI,CAACQ,UAAU,IAAIJ,sBAAsB,EAAE;IACzC,MAAM,IAAIF,KAAK,CAAC,sBAAsB,CAAC;EACzC;EACA,OAAOM,UAAU;AACnB;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,mBAAmBA,CAAAC,IAAA,EAKzC;EAAA,IADA;IAAEC,QAAQ;IAAE,GAAGC;EAAoD,CAAC,GAAAF,IAAA;EAEpE,MAAMG,KAAK,GAAGlB,MAAM,CAAmC,CAAC;EACxD,IAAI,CAACkB,KAAK,CAACC,OAAO,EAAE;IAClB;IACA;IACA;IACA;IACA,IAAI,YAAY,IAAIF,IAAI,IAAIA,IAAI,CAACG,UAAU,EAAE;MAC3C,IAAIH,IAAI,CAACG,UAAU,KAAK,IAAI,EAAEF,KAAK,CAACC,OAAO,GAAGd,cAAc,CAAC,CAAC,CAAC,KAC1Da,KAAK,CAACC,OAAO,GAAGF,IAAI,CAACG,UAAU;IACtC,CAAC,MAAM;MACL,MAAM;QAAEC,YAAY;QAAER;MAAW,CAAC,GAAGI,IAA0C;MAE/EC,KAAK,CAACC,OAAO,GAAG,IAAIlB,WAAW,CAC7BJ,UAAU,CAACwB,YAAY,CAAC,GAAGA,YAAY,CAAC,CAAC,GAAGA,YAAY,EACxDR,UACF,CAAC;IACH;EACF;EACA,oBACEV,IAAA,CAACC,OAAO,CAACkB,QAAQ;IAACC,KAAK,EAAEL,KAAK,CAACC,OAAQ;IAAAH,QAAA,EACpCA;EAAQ,CACO,CAAC;AAEvB;AAEAF,mBAAmB,CAACU,YAAY,GAAG;EACjCR,QAAQ,EAAEJ;AACZ,CAAC"}

package/build/module/SsrContext.js

@@ -0,0 +1,9 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+export default class SsrContext {
+  constructor(state) {
+    _defineProperty(this, "dirty", false);
+    _defineProperty(this, "pending", []);
+    this.state = state;
+  }
+}
+//# sourceMappingURL=SsrContext.js.map

package/build/module/SsrContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SsrContext.js","names":["SsrContext","constructor","state","_defineProperty"],"sources":["../../src/SsrContext.ts"],"sourcesContent":["export default class SsrContext<StateT> {\n  dirty: boolean = false;\n\n  pending: Promise<void>[] = [];\n\n  state?: StateT;\n\n  constructor(state?: StateT) {\n    this.state = state;\n  }\n}\n"],"mappings":";AAAA,eAAe,MAAMA,UAAU,CAAS;EAOtCC,WAAWA,CAACC,KAAc,EAAE;IAAAC,eAAA,gBANX,KAAK;IAAAA,eAAA,kBAEK,EAAE;IAK3B,IAAI,CAACD,KAAK,GAAGA,KAAK;EACpB;AACF"}

package/build/module/index.js

@@ -0,0 +1,19 @@
+import GlobalState from "./GlobalState";
+import GlobalStateProvider, { getGlobalState, getSsrContext } from "./GlobalStateProvider";
+import SsrContext from "./SsrContext";
+import useAsyncCollection from "./useAsyncCollection";
+import useAsyncData, { newAsyncDataEnvelope } from "./useAsyncData";
+import useGlobalState from "./useGlobalState";
+export { getGlobalState, getSsrContext, GlobalState, GlobalStateProvider, newAsyncDataEnvelope, SsrContext, useAsyncCollection, useAsyncData, useGlobalState };
+export default {
+  getGlobalState,
+  getSsrContext,
+  GlobalState,
+  GlobalStateProvider,
+  newAsyncDataEnvelope,
+  SsrContext,
+  useAsyncCollection,
+  useAsyncData,
+  useGlobalState
+};
+//# sourceMappingURL=index.js.map

package/build/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["GlobalState","GlobalStateProvider","getGlobalState","getSsrContext","SsrContext","useAsyncCollection","useAsyncData","newAsyncDataEnvelope","useGlobalState"],"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} from './useAsyncCollection';\n\nimport useAsyncData, {\n  type UseAsyncDataI,\n  newAsyncDataEnvelope,\n} from './useAsyncData';\n\nimport useGlobalState, { type UseGlobalStateI } from './useGlobalState';\n\nexport type { AsyncCollectionLoaderT } from './useAsyncCollection';\n\nexport type {\n  AsyncDataEnvelopeT,\n  AsyncDataLoaderT,\n  UseAsyncDataOptionsT,\n  UseAsyncDataResT,\n} from './useAsyncData';\n\nexport type { SetterT, UseGlobalStateResT } from './useGlobalState';\n\nexport type { ForceT, ValueOrInitializerT } from './utils';\n\nexport {\n  getGlobalState,\n  getSsrContext,\n  GlobalState,\n  GlobalStateProvider,\n  newAsyncDataEnvelope,\n  SsrContext,\n  useAsyncCollection,\n  useAsyncData,\n  useGlobalState,\n};\n\nexport interface 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\nexport default {\n  getGlobalState,\n  getSsrContext,\n  GlobalState,\n  GlobalStateProvider,\n  newAsyncDataEnvelope,\n  SsrContext,\n  useAsyncCollection,\n  useAsyncData,\n  useGlobalState,\n} as API<unknown>;\n"],"mappings":"AAAA,OAAOA,WAAW;AAElB,OAAOC,mBAAmB,IACxBC,cAAc,EACdC,aAAa;AAGf,OAAOC,UAAU;AAEjB,OAAOC,kBAAkB;AAIzB,OAAOC,YAAY,IAEjBC,oBAAoB;AAGtB,OAAOC,cAAc;AAerB,SACEN,cAAc,EACdC,aAAa,EACbH,WAAW,EACXC,mBAAmB,EACnBM,oBAAoB,EACpBH,UAAU,EACVC,kBAAkB,EAClBC,YAAY,EACZE,cAAc;AAkBhB,eAAe;EACbN,cAAc;EACdC,aAAa;EACbH,WAAW;EACXC,mBAAmB;EACnBM,oBAAoB;EACpBH,UAAU;EACVC,kBAAkB;EAClBC,YAAY;EACZE;AACF,CAAC"}

package/build/module/useAsyncCollection.js

@@ -0,0 +1,56 @@
+/**
+ * Loads and uses an item in an async collection.
+ */
+
+import useAsyncData from "./useAsyncData";
+
+/**
+ * Resolves and stores at the given `path` of global state elements of
+ * an asynchronous data collection. In other words, it is an auxiliar wrapper
+ * around {@link useAsyncData}, which uses a loader which resolves to different
+ * data, based on ID argument passed in, and stores data fetched for different
+ * IDs in the state.
+ * @param id ID of the collection item to load & use.
+ * @param path The global state path where entire collection should be
+ *  stored.
+ * @param loader A loader function, which takes an
+ * ID of data to load, and resolves to the corresponding data.
+ * @param options Additional options.
+ * @param options.deps An array of dependencies, which trigger
+ * data reload when changed. Given dependency changes are watched shallowly
+ * (similarly to the standard React's
+ * [useEffect()](https://reactjs.org/docs/hooks-reference.html#useeffect)).
+ * @param options.noSSR If `true`, this hook won't load data during
+ * server-side rendering.
+ * @param options.garbageCollectAge The maximum age of data
+ * (in milliseconds), after which they are dropped from the state when the last
+ * component referencing them via `useAsyncData()` hook unmounts. Defaults to
+ * `maxage` option value.
+ * @param options.maxage The maximum age of
+ * data (in milliseconds) acceptable to the hook's caller. If loaded data are
+ * older than this value, `null` is returned instead. Defaults to 5 minutes.
+ * @param options.refreshAge The maximum age of data
+ * (in milliseconds), after which their refreshment will be triggered when
+ * any component referencing them via `useAsyncData()` hook (re-)renders.
+ * Defaults to `maxage` value.
+ * @return Returns an object with three fields: `data` holds the actual result of
+ * last `loader` invokation, if any, and if satisfies `maxage` limit; `loading`
+ * is a boolean flag, which is `true` if data are being loaded (the hook is
+ * waiting for `loader` function resolution); `timestamp` (in milliseconds)
+ * is Unix timestamp of related data currently loaded into the global state.
+ *
+ * Note that loaded data, if any, are stored at the given `path` of global state
+ * along with related meta-information, using slightly different state segment
+ * structure (see {@link AsyncDataEnvelope}). That segment of the global state
+ * can be accessed, and even modified using other hooks,
+ * _e.g._ {@link useGlobalState}, but doing so you may interfere with related
+ * `useAsyncData()` hooks logic.
+ */
+
+function useAsyncCollection(id, path, loader) {
+  let options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  const itemPath = path ? `${path}.${id}` : id;
+  return useAsyncData(itemPath, oldData => loader(id, oldData), options);
+}
+export default useAsyncCollection;
+//# sourceMappingURL=useAsyncCollection.js.map

package/build/module/useAsyncCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncCollection.js","names":["useAsyncData","useAsyncCollection","id","path","loader","options","arguments","length","undefined","itemPath","oldData"],"sources":["../../src/useAsyncCollection.ts"],"sourcesContent":["/**\n * Loads and uses an item in an async collection.\n */\n\nimport useAsyncData, {\n  type DataInEnvelopeAtPathT,\n  type UseAsyncDataOptionsT,\n  type UseAsyncDataResT,\n} from './useAsyncData';\n\nimport { type ForceT, type LockT, type TypeLock } from './utils';\n\nexport type AsyncCollectionLoaderT<DataT> =\n  (id: string, oldData: null | DataT) => DataT | Promise<DataT>;\n\n/**\n * Resolves and stores at the given `path` of global state elements of\n * an asynchronous data collection. In other words, it is an auxiliar wrapper\n * around {@link useAsyncData}, which uses a loader which resolves to different\n * data, based on ID argument passed in, and stores data fetched for different\n * IDs in the state.\n * @param id ID of the collection item to load & use.\n * @param path The global state path where entire collection should be\n *  stored.\n * @param loader A loader function, which takes an\n * ID of data to load, and resolves to the corresponding data.\n * @param options Additional options.\n * @param options.deps An array of dependencies, which trigger\n * data reload when changed. Given dependency changes are watched shallowly\n * (similarly to the standard React's\n * [useEffect()](https://reactjs.org/docs/hooks-reference.html#useeffect)).\n * @param options.noSSR If `true`, this hook won't load data during\n * server-side rendering.\n * @param options.garbageCollectAge The maximum age of data\n * (in milliseconds), after which they are dropped from the state when the last\n * component referencing them via `useAsyncData()` hook unmounts. Defaults to\n * `maxage` option value.\n * @param options.maxage The maximum age of\n * data (in milliseconds) acceptable to the hook's caller. If loaded data are\n * older than this value, `null` is returned instead. Defaults to 5 minutes.\n * @param options.refreshAge The maximum age of data\n * (in milliseconds), after which their refreshment will be triggered when\n * any component referencing them via `useAsyncData()` hook (re-)renders.\n * Defaults to `maxage` value.\n * @return Returns an object with three fields: `data` holds the actual result of\n * last `loader` invokation, if any, and if satisfies `maxage` limit; `loading`\n * is a boolean flag, which is `true` if data are being loaded (the hook is\n * waiting for `loader` function resolution); `timestamp` (in milliseconds)\n * is Unix timestamp of related data currently loaded into the global state.\n *\n * Note that loaded data, if any, are stored at the given `path` of global state\n * along with related meta-information, using slightly different state segment\n * structure (see {@link AsyncDataEnvelope}). That segment of the global state\n * can be accessed, and even modified using other hooks,\n * _e.g._ {@link useGlobalState}, but doing so you may interfere with related\n * `useAsyncData()` hooks logic.\n */\n\nfunction useAsyncCollection<\n  StateT,\n  PathT extends null | string | undefined,\n  IdT extends string,\n>(\n  id: IdT,\n  path: PathT,\n  loader: AsyncCollectionLoaderT<\n  DataInEnvelopeAtPathT<StateT, `${PathT}.${IdT}`>\n  >,\n  options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<DataInEnvelopeAtPathT<StateT, `${PathT}.${IdT}`>>;\n\nfunction useAsyncCollection<\n  Forced extends ForceT | LockT = LockT,\n  DataT = unknown,\n>(\n  id: string,\n  path: null | string | undefined,\n  loader: AsyncCollectionLoaderT<TypeLock<Forced, void, DataT>>,\n  options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n\nfunction useAsyncCollection<DataT>(\n  id: string,\n  path: null | string | undefined,\n  loader: AsyncCollectionLoaderT<DataT>,\n  options: UseAsyncDataOptionsT = {},\n): UseAsyncDataResT<DataT> {\n  const itemPath = path ? `${path}.${id}` : id;\n  return useAsyncData<ForceT, DataT>(\n    itemPath,\n    (oldData: null | DataT) => loader(id, oldData),\n    options,\n  );\n}\n\nexport default useAsyncCollection;\n\nexport interface UseAsyncCollectionI<StateT> {\n  <PathT extends null | string | undefined, IdT extends string>(\n    id: IdT,\n    path: PathT,\n    loader: AsyncCollectionLoaderT<DataInEnvelopeAtPathT<StateT, `${PathT}.${IdT}`>>,\n    options?: UseAsyncDataOptionsT,\n  ): UseAsyncDataResT<DataInEnvelopeAtPathT<StateT, `${PathT}.${IdT}`>>;\n\n  <Forced extends ForceT | LockT = LockT, DataT = unknown>(\n    id: string,\n    path: null | string | undefined,\n    loader: AsyncCollectionLoaderT<TypeLock<Forced, void, DataT>>,\n    options?: UseAsyncDataOptionsT,\n  ): UseAsyncDataResT<TypeLock<Forced, void, DataT>>;\n}\n"],"mappings":"AAAA;AACA;AACA;;AAEA,OAAOA,YAAY;;AAWnB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAyBA,SAASC,kBAAkBA,CACzBC,EAAU,EACVC,IAA+B,EAC/BC,MAAqC,EAEZ;EAAA,IADzBC,OAA6B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAElC,MAAMG,QAAQ,GAAGN,IAAI,GAAI,GAAEA,IAAK,IAAGD,EAAG,EAAC,GAAGA,EAAE;EAC5C,OAAOF,YAAY,CACjBS,QAAQ,EACPC,OAAqB,IAAKN,MAAM,CAACF,EAAE,EAAEQ,OAAO,CAAC,EAC9CL,OACF,CAAC;AACH;AAEA,eAAeJ,kBAAkB"}

package/build/module/useAsyncData.js

@@ -0,0 +1,199 @@
+/**
+ * Loads and uses async data into the GlobalState path.
+ */
+
+import { cloneDeep } from 'lodash';
+import { useEffect } from 'react';
+import { v4 as uuid } from 'uuid';
+import { MIN_MS } from '@dr.pogodin/js-utils';
+import { getGlobalState } from "./GlobalStateProvider";
+import useGlobalState from "./useGlobalState";
+import { isDebugMode } from "./utils";
+const DEFAULT_MAXAGE = 5 * MIN_MS; // 5 minutes.
+
+export function newAsyncDataEnvelope() {
+  let initialData = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+  return {
+    data: initialData,
+    numRefs: 0,
+    operationId: '',
+    timestamp: 0
+  };
+}
+/**
+ * Executes the data loading operation.
+ * @param path Data segment path inside the global state.
+ * @param loader Data loader.
+ * @param globalState The global state instance.
+ * @param oldData Optional. Previously fetched data, currently stored in
+ *  the state, if already fetched by the caller; otherwise, they will be fetched
+ *  by the load() function itself.
+ * @param opIdPrefix operationId prefix to use, which should be
+ * 'C' at the client-side (default), or 'S' at the server-side (within SSR
+ * context).
+ * @return Resolves once the operation is done.
+ * @ignore
+ */
+async function load(path, loader, globalState, oldData) {
+  let opIdPrefix = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 'C';
+  if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
+    /* eslint-disable no-console */
+    console.log(`ReactGlobalState: useAsyncData data (re-)loading. Path: "${path || ''}"`);
+    /* eslint-enable no-console */
+  }
+
+  const operationId = opIdPrefix + uuid();
+  const operationIdPath = path ? `${path}.operationId` : 'operationId';
+  globalState.set(operationIdPath, operationId);
+  const data = await loader(oldData || globalState.get(path).data);
+  const state = globalState.get(path);
+  if (operationId === state.operationId) {
+    if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
+      /* eslint-disable no-console */
+      console.groupCollapsed(`ReactGlobalState: useAsyncData data (re-)loaded. Path: "${path || ''}"`);
+      console.log('Data:', cloneDeep(data));
+      /* eslint-enable no-console */
+    }
+
+    globalState.set(path, {
+      ...state,
+      data,
+      operationId: '',
+      timestamp: Date.now()
+    });
+    if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
+      /* eslint-disable no-console */
+      console.groupEnd();
+      /* eslint-enable no-console */
+    }
+  }
+}
+
+/**
+ * Resolves asynchronous data, and stores them at given `path` of global
+ * state. When multiple components rely on asynchronous data at the same `path`,
+ * the data are resolved once, and reused until their age is within specified
+ * bounds. Once the data are stale, the hook allows to refresh them. It also
+ * garbage-collects stale data from the global state when the last component
+ * relying on them is unmounted.
+ * @param path Dot-delimitered state path, where data envelop is
+ * stored.
+ * @param loader Asynchronous function which resolves (loads)
+ * data, which should be stored at the global state `path`. When multiple
+ * components
+ * use `useAsyncData()` hook for the same `path`, the library assumes that all
+ * hook instances are called with the same `loader` (_i.e._ whichever of these
+ * loaders is used to resolve async data, the result is acceptable to be reused
+ * in all related components).
+ * @param options Additional options.
+ * @param options.deps An array of dependencies, which trigger
+ * data reload when changed. Given dependency changes are watched shallowly
+ * (similarly to the standard React's
+ * [useEffect()](https://reactjs.org/docs/hooks-reference.html#useeffect)).
+ * @param options.noSSR If `true`, this hook won't load data during
+ * server-side rendering.
+ * @param options.garbageCollectAge The maximum age of data
+ * (in milliseconds), after which they are dropped from the state when the last
+ * component referencing them via `useAsyncData()` hook unmounts. Defaults to
+ * `maxage` option value.
+ * @param options.maxage The maximum age of
+ * data (in milliseconds) acceptable to the hook's caller. If loaded data are
+ * older than this value, `null` is returned instead. Defaults to 5 minutes.
+ * @param options.refreshAge The maximum age of data
+ * (in milliseconds), after which their refreshment will be triggered when
+ * any component referencing them via `useAsyncData()` hook (re-)renders.
+ * Defaults to `maxage` value.
+ * @return Returns an object with three fields: `data` holds the actual result of
+ * last `loader` invokation, if any, and if satisfies `maxage` limit; `loading`
+ * is a boolean flag, which is `true` if data are being loaded (the hook is
+ * waiting for `loader` function resolution); `timestamp` (in milliseconds)
+ * is Unix timestamp of related data currently loaded into the global state.
+ *
+ * Note that loaded data, if any, are stored at the given `path` of global state
+ * along with related meta-information, using slightly different state segment
+ * structure (see {@link AsyncDataEnvelopeT}). That segment of the global state
+ * can be accessed, and even modified using other hooks,
+ * _e.g._ {@link useGlobalState}, but doing so you may interfere with related
+ * `useAsyncData()` hooks logic.
+ */
+
+function useAsyncData(path, loader) {
+  let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  const maxage = options.maxage === undefined ? DEFAULT_MAXAGE : options.maxage;
+  const refreshAge = options.refreshAge === undefined ? maxage : options.refreshAge;
+  const garbageCollectAge = options.garbageCollectAge === undefined ? maxage : options.garbageCollectAge;
+
+  // Note: here we can't depend on useGlobalState() to init the initial value,
+  // because that way we'll have issues with SSR (see details below).
+  const globalState = getGlobalState();
+  const state = globalState.get(path, {
+    initialValue: newAsyncDataEnvelope()
+  });
+  if (globalState.ssrContext && !options.noSSR) {
+    if (!state.timestamp && !state.operationId) {
+      globalState.ssrContext.pending.push(load(path, loader, globalState, state.data, 'S'));
+    }
+  } else {
+    // This takes care about the client-side reference counting, and garbage
+    // collection.
+    //
+    // Note: the Rules of Hook below are violated by conditional call to a hook,
+    // but as the condition is actually server-side or client-side environment,
+    // it is effectively non-conditional at the runtime.
+    //
+    // TODO: Though, maybe there is a way to refactor it into a cleaner code.
+    // The same applies to other useEffect() hooks below.
+    useEffect(() => {
+      // eslint-disable-line react-hooks/rules-of-hooks
+      const numRefsPath = path ? `${path}.numRefs` : 'numRefs';
+      const numRefs = globalState.get(numRefsPath);
+      globalState.set(numRefsPath, numRefs + 1);
+      return () => {
+        const state2 = globalState.get(path);
+        if (state2.numRefs === 1 && garbageCollectAge < Date.now() - state2.timestamp) {
+          if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
+            /* eslint-disable no-console */
+            console.log(`ReactGlobalState - useAsyncData garbage collected at path ${path || ''}`);
+            /* eslint-enable no-console */
+          }
+
+          globalState.set(path, {
+            ...state2,
+            data: null,
+            numRefs: 0,
+            timestamp: 0
+          });
+        } else globalState.set(numRefsPath, state2.numRefs - 1);
+      };
+    }, [garbageCollectAge, globalState, path]);
+
+    // Note: a bunch of Rules of Hooks ignored belows because in our very
+    // special case the otherwise wrong behavior is actually what we need.
+
+    // Data loading and refreshing.
+    let loadTriggered = false;
+    useEffect(() => {
+      // eslint-disable-line react-hooks/rules-of-hooks
+      const state2 = globalState.get(path);
+      if (refreshAge < Date.now() - state2.timestamp && (!state2.operationId || state2.operationId.charAt(0) === 'S')) {
+        load(path, loader, globalState, state2.data);
+        loadTriggered = true; // eslint-disable-line react-hooks/exhaustive-deps
+      }
+    });
+
+    const deps = options.deps || [];
+    useEffect(() => {
+      // eslint-disable-line react-hooks/rules-of-hooks
+      if (!loadTriggered && deps.length) load(path, loader, globalState, null);
+    }, deps); // eslint-disable-line react-hooks/exhaustive-deps
+  }
+
+  const [localState] = useGlobalState(path, newAsyncDataEnvelope());
+  return {
+    data: maxage < Date.now() - localState.timestamp ? null : localState.data,
+    loading: Boolean(localState.operationId),
+    timestamp: localState.timestamp
+  };
+}
+export default useAsyncData;
+//# sourceMappingURL=useAsyncData.js.map

package/build/module/useAsyncData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncData.js","names":["cloneDeep","useEffect","v4","uuid","MIN_MS","getGlobalState","useGlobalState","isDebugMode","DEFAULT_MAXAGE","newAsyncDataEnvelope","initialData","arguments","length","undefined","data","numRefs","operationId","timestamp","load","path","loader","globalState","oldData","opIdPrefix","process","env","NODE_ENV","console","log","operationIdPath","set","get","state","groupCollapsed","Date","now","groupEnd","useAsyncData","options","maxage","refreshAge","garbageCollectAge","initialValue","ssrContext","noSSR","pending","push","numRefsPath","state2","loadTriggered","charAt","deps","localState","loading","Boolean"],"sources":["../../src/useAsyncData.ts"],"sourcesContent":["/**\n * Loads and uses async data into the GlobalState path.\n */\n\nimport { cloneDeep } from 'lodash';\nimport { useEffect } 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  isDebugMode,\n} from './utils';\n\nimport GlobalState from './GlobalState';\nimport SsrContext from './SsrContext';\n\nconst DEFAULT_MAXAGE = 5 * MIN_MS; // 5 minutes.\n\nexport type AsyncDataLoaderT<DataT>\n= (oldData: null | DataT) => DataT | Promise<DataT>;\n\nexport type AsyncDataEnvelopeT<DataT> = {\n  data: null | DataT;\n  numRefs: number;\n  operationId: string;\n  timestamp: number;\n};\n\nexport function newAsyncDataEnvelope<DataT>(\n  initialData: DataT | null = null,\n): AsyncDataEnvelopeT<DataT> {\n  return {\n    data: initialData,\n    numRefs: 0,\n    operationId: '',\n    timestamp: 0,\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  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 */\nasync function load<DataT>(\n  path: null | string | undefined,\n  loader: AsyncDataLoaderT<DataT>,\n  globalState: GlobalState<unknown, SsrContext<unknown>>,\n  oldData: DataT | null,\n  opIdPrefix: 'C' | 'S' = 'C',\n): Promise<void> {\n  if (process.env.NODE_ENV !== 'production' && isDebugMode()) {\n    /* eslint-disable no-console */\n    console.log(\n      `ReactGlobalState: useAsyncData data (re-)loading. Path: \"${path || ''}\"`,\n    );\n    /* eslint-enable no-console */\n  }\n  const operationId = opIdPrefix + uuid();\n  const operationIdPath = path ? `${path}.operationId` : 'operationId';\n  globalState.set<ForceT, string>(operationIdPath, operationId);\n  const data = await loader(\n    oldData || (globalState.get<ForceT, AsyncDataEnvelopeT<DataT>>(path)).data,\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: useAsyncData data (re-)loaded. Path: \"${\n          path || ''\n        }\"`,\n      );\n      console.log('Data:', cloneDeep(data));\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. When multiple components rely on asynchronous data at the same `path`,\n * the data are resolved once, and reused until their age is within specified\n * bounds. Once the data are stale, the hook allows to refresh them. It also\n * garbage-collects stale data from the global state when the last component\n * relying on them is unmounted.\n * @param path Dot-delimitered state path, where data envelop is\n * stored.\n * @param loader Asynchronous function which resolves (loads)\n * data, which should be stored at the global state `path`. When multiple\n * components\n * use `useAsyncData()` hook for the same `path`, the library assumes that all\n * hook instances are called with the same `loader` (_i.e._ whichever of these\n * loaders is used to resolve async data, the result is acceptable to be reused\n * in all related components).\n * @param options Additional options.\n * @param options.deps An array of dependencies, which trigger\n * data reload when changed. Given dependency changes are watched shallowly\n * (similarly to the standard React's\n * [useEffect()](https://reactjs.org/docs/hooks-reference.html#useeffect)).\n * @param options.noSSR If `true`, this hook won't load data during\n * server-side rendering.\n * @param options.garbageCollectAge The maximum age of data\n * (in milliseconds), after which they are dropped from the state when the last\n * component referencing them via `useAsyncData()` hook unmounts. Defaults to\n * `maxage` option value.\n * @param options.maxage The maximum age of\n * data (in milliseconds) acceptable to the hook's caller. If loaded data are\n * older than this value, `null` is returned instead. Defaults to 5 minutes.\n * @param options.refreshAge The maximum age of data\n * (in milliseconds), after which their refreshment will be triggered when\n * any component referencing them via `useAsyncData()` hook (re-)renders.\n * Defaults to `maxage` value.\n * @return Returns an object with three fields: `data` holds the actual result of\n * last `loader` invokation, if any, and if satisfies `maxage` limit; `loading`\n * is a boolean flag, which is `true` if data are being loaded (the hook is\n * waiting for `loader` function resolution); `timestamp` (in milliseconds)\n * is Unix timestamp of related data currently loaded into the global state.\n *\n * Note that loaded data, if any, are stored at the given `path` of global state\n * along with related meta-information, using slightly different state segment\n * structure (see {@link AsyncDataEnvelopeT}). That segment of the global state\n * can be accessed, and even modified using other hooks,\n * _e.g._ {@link useGlobalState}, but doing so you may interfere with related\n * `useAsyncData()` hooks logic.\n */\n\nexport type DataInEnvelopeAtPathT<StateT, PathT extends null | string | undefined>\n= ValueAtPathT<StateT, PathT, never> extends AsyncDataEnvelopeT<unknown>\n  ? Exclude<ValueAtPathT<StateT, PathT, never>['data'], null>\n  : void;\n\nfunction useAsyncData<\n  StateT,\n  PathT extends null | string | undefined,\n>(\n  path: PathT,\n  loader: AsyncDataLoaderT<DataInEnvelopeAtPathT<StateT, PathT>>,\n  options?: UseAsyncDataOptionsT,\n): UseAsyncDataResT<DataInEnvelopeAtPathT<StateT, PathT>>;\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 === undefined\n    ? DEFAULT_MAXAGE : options.maxage;\n\n  const refreshAge: number = options.refreshAge === undefined\n    ? maxage : options.refreshAge;\n\n  const garbageCollectAge: number = options.garbageCollectAge === undefined\n    ? maxage : options.garbageCollectAge;\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  if (globalState.ssrContext && !options.noSSR) {\n    if (!state.timestamp && !state.operationId) {\n      globalState.ssrContext.pending.push(\n        load(path, loader, globalState, state.data, 'S'),\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.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      if (refreshAge < Date.now() - state2.timestamp\n      && (!state2.operationId || state2.operationId.charAt(0) === 'S')) {\n        load(path, loader, globalState, state2.data);\n        loadTriggered = true; // eslint-disable-line react-hooks/exhaustive-deps\n      }\n    });\n\n    const deps = options.deps || [];\n    useEffect(() => { // eslint-disable-line react-hooks/rules-of-hooks\n      if (!loadTriggered && deps.length) load(path, loader, globalState, null);\n    }, 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    timestamp: localState.timestamp,\n  };\n}\n\nexport default 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":"AAAA;AACA;AACA;;AAEA,SAASA,SAAS,QAAQ,QAAQ;AAClC,SAASC,SAAS,QAAQ,OAAO;AACjC,SAASC,EAAE,IAAIC,IAAI,QAAQ,MAAM;AAEjC,SAASC,MAAM,QAAQ,sBAAsB;AAE7C,SAASC,cAAc;AACvB,OAAOC,cAAc;AAErB,SAKEC,WAAW;AAMb,MAAMC,cAAc,GAAG,CAAC,GAAGJ,MAAM,CAAC,CAAC;;AAYnC,OAAO,SAASK,oBAAoBA,CAAA,EAEP;EAAA,IAD3BC,WAAyB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,IAAI;EAEhC,OAAO;IACLG,IAAI,EAAEJ,WAAW;IACjBK,OAAO,EAAE,CAAC;IACVC,WAAW,EAAE,EAAE;IACfC,SAAS,EAAE;EACb,CAAC;AACH;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeC,IAAIA,CACjBC,IAA+B,EAC/BC,MAA+B,EAC/BC,WAAsD,EACtDC,OAAqB,EAEN;EAAA,IADfC,UAAqB,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,GAAG;EAE3B,IAAIa,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAInB,WAAW,CAAC,CAAC,EAAE;IAC1D;IACAoB,OAAO,CAACC,GAAG,CACR,4DAA2DT,IAAI,IAAI,EAAG,GACzE,CAAC;IACD;EACF;;EACA,MAAMH,WAAW,GAAGO,UAAU,GAAGpB,IAAI,CAAC,CAAC;EACvC,MAAM0B,eAAe,GAAGV,IAAI,GAAI,GAAEA,IAAK,cAAa,GAAG,aAAa;EACpEE,WAAW,CAACS,GAAG,CAAiBD,eAAe,EAAEb,WAAW,CAAC;EAC7D,MAAMF,IAAI,GAAG,MAAMM,MAAM,CACvBE,OAAO,IAAKD,WAAW,CAACU,GAAG,CAAoCZ,IAAI,CAAC,CAAEL,IACxE,CAAC;EACD,MAAMkB,KAAgC,GAAGX,WAAW,CAACU,GAAG,CAAoCZ,IAAI,CAAC;EACjG,IAAIH,WAAW,KAAKgB,KAAK,CAAChB,WAAW,EAAE;IACrC,IAAIQ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAInB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACAoB,OAAO,CAACM,cAAc,CACnB,2DACCd,IAAI,IAAI,EACT,GACH,CAAC;MACDQ,OAAO,CAACC,GAAG,CAAC,OAAO,EAAE5B,SAAS,CAACc,IAAI,CAAC,CAAC;MACrC;IACF;;IACAO,WAAW,CAACS,GAAG,CAAoCX,IAAI,EAAE;MACvD,GAAGa,KAAK;MACRlB,IAAI;MACJE,WAAW,EAAE,EAAE;MACfC,SAAS,EAAEiB,IAAI,CAACC,GAAG,CAAC;IACtB,CAAC,CAAC;IACF,IAAIX,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAInB,WAAW,CAAC,CAAC,EAAE;MAC1D;MACAoB,OAAO,CAACS,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAyBA,SAASC,YAAYA,CACnBlB,IAA+B,EAC/BC,MAA+B,EAEN;EAAA,IADzBkB,OAA6B,GAAA3B,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAElC,MAAM4B,MAAc,GAAGD,OAAO,CAACC,MAAM,KAAK1B,SAAS,GAC/CL,cAAc,GAAG8B,OAAO,CAACC,MAAM;EAEnC,MAAMC,UAAkB,GAAGF,OAAO,CAACE,UAAU,KAAK3B,SAAS,GACvD0B,MAAM,GAAGD,OAAO,CAACE,UAAU;EAE/B,MAAMC,iBAAyB,GAAGH,OAAO,CAACG,iBAAiB,KAAK5B,SAAS,GACrE0B,MAAM,GAAGD,OAAO,CAACG,iBAAiB;;EAEtC;EACA;EACA,MAAMpB,WAAW,GAAGhB,cAAc,CAAC,CAAC;EACpC,MAAM2B,KAAK,GAAGX,WAAW,CAACU,GAAG,CAAoCZ,IAAI,EAAE;IACrEuB,YAAY,EAAEjC,oBAAoB,CAAQ;EAC5C,CAAC,CAAC;EAEF,IAAIY,WAAW,CAACsB,UAAU,IAAI,CAACL,OAAO,CAACM,KAAK,EAAE;IAC5C,IAAI,CAACZ,KAAK,CAACf,SAAS,IAAI,CAACe,KAAK,CAAChB,WAAW,EAAE;MAC1CK,WAAW,CAACsB,UAAU,CAACE,OAAO,CAACC,IAAI,CACjC5B,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAEW,KAAK,CAAClB,IAAI,EAAE,GAAG,CACjD,CAAC;IACH;EACF,CAAC,MAAM;IACL;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACAb,SAAS,CAAC,MAAM;MAAE;MAChB,MAAM8C,WAAW,GAAG5B,IAAI,GAAI,GAAEA,IAAK,UAAS,GAAG,SAAS;MACxD,MAAMJ,OAAO,GAAGM,WAAW,CAACU,GAAG,CAAiBgB,WAAW,CAAC;MAC5D1B,WAAW,CAACS,GAAG,CAAiBiB,WAAW,EAAEhC,OAAO,GAAG,CAAC,CAAC;MACzD,OAAO,MAAM;QACX,MAAMiC,MAAiC,GAAG3B,WAAW,CAACU,GAAG,CAEvDZ,IACF,CAAC;QACD,IACE6B,MAAM,CAACjC,OAAO,KAAK,CAAC,IACjB0B,iBAAiB,GAAGP,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGa,MAAM,CAAC/B,SAAS,EACpD;UACA,IAAIO,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAInB,WAAW,CAAC,CAAC,EAAE;YAC1D;YACAoB,OAAO,CAACC,GAAG,CACR,6DACCT,IAAI,IAAI,EACT,EACH,CAAC;YACD;UACF;;UACAE,WAAW,CAACS,GAAG,CAAoCX,IAAI,EAAE;YACvD,GAAG6B,MAAM;YACTlC,IAAI,EAAE,IAAI;YACVC,OAAO,EAAE,CAAC;YACVE,SAAS,EAAE;UACb,CAAC,CAAC;QACJ,CAAC,MAAMI,WAAW,CAACS,GAAG,CAAiBiB,WAAW,EAAEC,MAAM,CAACjC,OAAO,GAAG,CAAC,CAAC;MACzE,CAAC;IACH,CAAC,EAAE,CAAC0B,iBAAiB,EAAEpB,WAAW,EAAEF,IAAI,CAAC,CAAC;;IAE1C;IACA;;IAEA;IACA,IAAI8B,aAAa,GAAG,KAAK;IACzBhD,SAAS,CAAC,MAAM;MAAE;MAChB,MAAM+C,MAAiC,GAAG3B,WAAW,CAACU,GAAG,CACtBZ,IAAI,CAAC;MAExC,IAAIqB,UAAU,GAAGN,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGa,MAAM,CAAC/B,SAAS,KAC1C,CAAC+B,MAAM,CAAChC,WAAW,IAAIgC,MAAM,CAAChC,WAAW,CAACkC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,EAAE;QAChEhC,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE2B,MAAM,CAAClC,IAAI,CAAC;QAC5CmC,aAAa,GAAG,IAAI,CAAC,CAAC;MACxB;IACF,CAAC,CAAC;;IAEF,MAAME,IAAI,GAAGb,OAAO,CAACa,IAAI,IAAI,EAAE;IAC/BlD,SAAS,CAAC,MAAM;MAAE;MAChB,IAAI,CAACgD,aAAa,IAAIE,IAAI,CAACvC,MAAM,EAAEM,IAAI,CAACC,IAAI,EAAEC,MAAM,EAAEC,WAAW,EAAE,IAAI,CAAC;IAC1E,CAAC,EAAE8B,IAAI,CAAC,CAAC,CAAC;EACZ;;EAEA,MAAM,CAACC,UAAU,CAAC,GAAG9C,cAAc,CACjCa,IAAI,EACJV,oBAAoB,CAAQ,CAC9B,CAAC;EAED,OAAO;IACLK,IAAI,EAAEyB,MAAM,GAAGL,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGiB,UAAU,CAACnC,SAAS,GAAG,IAAI,GAAGmC,UAAU,CAACtC,IAAI;IACzEuC,OAAO,EAAEC,OAAO,CAACF,UAAU,CAACpC,WAAW,CAAC;IACxCC,SAAS,EAAEmC,UAAU,CAACnC;EACxB,CAAC;AACH;AAEA,eAAeoB,YAAY"}

package/build/module/useGlobalState.js

@@ -0,0 +1,109 @@
+// Hook for updates of global state.
+
+import { cloneDeep, isFunction } from 'lodash';
+import { useEffect, useRef, useSyncExternalStore } from 'react';
+import { Emitter } from '@dr.pogodin/js-utils';
+import { getGlobalState } from "./GlobalStateProvider";
+import { isDebugMode } from "./utils";
+
+/**
+ * The primary hook for interacting with the global state, modeled after
+ * the standard React's
+ * [useState](https://reactjs.org/docs/hooks-reference.html#usestate).
+ * It subscribes a component to a given `path` of global state, and provides
+ * a function to update it. Each time the value at `path` changes, the hook
+ * triggers re-render of its host component.
+ *
+ * **Note:**
+ * - For performance, the library does not copy objects written to / read from
+ *   global state paths. You MUST NOT manually mutate returned state values,
+ *   or change objects already written into the global state, without explicitly
+ *   clonning them first yourself.
+ * - State update notifications are asynchronous. When your code does multiple
+ *   global state updates in the same React rendering cycle, all state update
+ *   notifications are queued and dispatched together, after the current
+ *   rendering cycle. In other words, in any given rendering cycle the global
+ *   state values are "fixed", and all changes becomes visible at once in the
+ *   next triggered rendering pass.
+ *
+ * @param path Dot-delimitered state path. It can be undefined to
+ * subscribe for entire state.
+ *
+ * Under-the-hood state values are read and written using `lodash`
+ * [_.get()](https://lodash.com/docs/4.17.15#get) and
+ * [_.set()](https://lodash.com/docs/4.17.15#set) methods, thus it is safe
+ * to access state paths which have not been created before.
+ * @param initialValue Initial value to set at the `path`, or its
+ * factory:
+ * - If a function is given, it will act similar to
+ *   [the lazy initial state of the standard React's useState()](https://reactjs.org/docs/hooks-reference.html#lazy-initial-state):
+ *   only if the value at `path` is `undefined`, the function will be executed,
+ *   and the value it returns will be written to the `path`.
+ * - Otherwise, the given value itself will be written to the `path`,
+ *   if the current value at `path` is `undefined`.
+ * @return It returs an array with two elements: `[value, setValue]`:
+ *
+ * - The `value` is the current value at given `path`.
+ *
+ * - The `setValue()` is setter function to write a new value to the `path`.
+ *
+ *   Similar to the standard React's `useState()`, it supports
+ *   [functional value updates](https://reactjs.org/docs/hooks-reference.html#functional-updates):
+ *   if `setValue()` is called with a function as argument, that function will
+ *   be called and its return value will be written to `path`. Otherwise,
+ *   the argument of `setValue()` itself is written to `path`.
+ *
+ *   Also, similar to the standard React's state setters, `setValue()` is
+ *   stable function: it does not change between component re-renders.
+ */ // "Enforced type overload"
+// "Entire state overload"
+// "State evaluation overload"
+function useGlobalState(path, initialValue) {
+  const globalState = getGlobalState();
+  const ref = useRef();
+  const rc = ref.current || {
+    emitter: new Emitter(),
+    globalState,
+    path,
+    setter: value => {
+      const newState = isFunction(value) ? value(rc.state) : value;
+      if (process.env.NODE_ENV !== 'production' && isDebugMode()) {
+        /* eslint-disable no-console */
+        console.groupCollapsed(`ReactGlobalState - useGlobalState setter triggered for path ${rc.path || ''}`);
+        console.log('New value:', cloneDeep(newState));
+        console.groupEnd();
+        /* eslint-enable no-console */
+      }
+
+      rc.globalState.set(rc.path, newState);
+    },
+    state: isFunction(initialValue) ? initialValue() : initialValue,
+    watcher: () => {
+      const state = rc.globalState.get(rc.path);
+      if (state !== rc.state) rc.emitter.emit();
+    }
+  };
+  ref.current = rc;
+  rc.globalState = globalState;
+  rc.path = path;
+  rc.state = useSyncExternalStore(cb => rc.emitter.addListener(cb), () => rc.globalState.get(rc.path, {
+    initialValue
+  }), () => rc.globalState.get(rc.path, {
+    initialValue,
+    initialState: true
+  }));
+  useEffect(() => {
+    const {
+      watcher
+    } = ref.current;
+    globalState.watch(watcher);
+    watcher();
+    return () => globalState.unWatch(watcher);
+  }, [globalState]);
+  useEffect(() => {
+    ref.current.watcher();
+  }, [path]);
+  return [rc.state, rc.setter];
+}
+export default useGlobalState;
+//# sourceMappingURL=useGlobalState.js.map