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

package/README.md

@@ -10,6 +10,8 @@ State of the art approach to the global state and asynchronous data management
 in React applications, powered by hooks and Context API. Simple, efficient, with
 full server-side rendering (SSR) support.
 
+TypeScript support since v0.10.0.
+
 [⇒ Documentation ⇐](https://dr.pogodin.studio/docs/react-global-state/index.html)
 
 [![Sponsor](https://raw.githubusercontent.com/birdofpreyru/react-global-state/master/.README/sponsor.svg)](https://github.com/sponsors/birdofpreyru)

package/build/common/GlobalState.js

@@ -0,0 +1,219 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _utils = require("./utils");
+const ERR_NO_SSR_WATCH = 'GlobalState must not be watched at server side';
+class GlobalState {
+  #initialState;
+
+  // TODO: It is tempting to replace watchers here by
+  // Emitter from @dr.pogodin/js-utils, but we need to clone
+  // current watchers for emitting later, and this is not something
+  // Emitter supports right now.
+  #watchers = [];
+  #nextNotifierId;
+  #currentState;
+
+  /**
+   * Creates a new global state object.
+   * @param initialState Intial global state content.
+   * @param ssrContext Server-side rendering context.
+   */
+  constructor(initialState, ssrContext) {
+    this.#currentState = initialState;
+    this.#initialState = initialState;
+    if (ssrContext) {
+      /* eslint-disable no-param-reassign */
+      ssrContext.dirty = false;
+      ssrContext.pending = [];
+      ssrContext.state = this.#currentState;
+      /* eslint-enable no-param-reassign */
+
+      this.ssrContext = ssrContext;
+    }
+    if (process.env.NODE_ENV !== 'production' && (0, _utils.isDebugMode)()) {
+      /* eslint-disable no-console */
+      let msg = 'New ReactGlobalState created';
+      if (ssrContext) msg += ' (SSR mode)';
+      console.groupCollapsed(msg);
+      console.log('Initial state:', (0, _lodash.cloneDeep)(initialState));
+      console.groupEnd();
+      /* eslint-enable no-console */
+    }
+  }
+
+  /**
+   * Gets entire state, the same way as .get(null, opts) would do.
+   * @param opts.initialState
+   * @param opts.initialValue
+   */
+  getEntireState(opts) {
+    let state = opts?.initialState ? this.#initialState : this.#currentState;
+    if (state !== undefined || opts?.initialValue === undefined) return state;
+    const iv = opts.initialValue;
+    state = (0, _lodash.isFunction)(iv) ? iv() : iv;
+    if (this.#currentState === undefined) this.setEntireState(state);
+    return state;
+  }
+
+  /**
+   * Notifies all connected state watchers that a state update has happened.
+   */
+  notifyStateUpdate(path, value) {
+    if (process.env.NODE_ENV !== 'production' && (0, _utils.isDebugMode)()) {
+      /* eslint-disable no-console */
+      const p = typeof path === 'string' ? `"${path}"` : 'none (entire state update)';
+      console.groupCollapsed(`ReactGlobalState update. Path: ${p}`);
+      console.log('New value:', (0, _lodash.cloneDeep)(value));
+      console.log('New state:', (0, _lodash.cloneDeep)(this.#currentState));
+      console.groupEnd();
+      /* eslint-enable no-console */
+    }
+
+    if (this.ssrContext) {
+      this.ssrContext.dirty = true;
+      this.ssrContext.state = this.#currentState;
+    } else if (!this.#nextNotifierId) {
+      this.#nextNotifierId = setTimeout(() => {
+        this.#nextNotifierId = undefined;
+        const watchers = [...this.#watchers];
+        for (let i = 0; i < watchers.length; ++i) {
+          watchers[i]();
+        }
+      });
+    }
+  }
+
+  /**
+   * Sets entire state, the same way as .set(null, value) would do.
+   * @param value
+   */
+  setEntireState(value) {
+    if (this.#currentState !== value) {
+      this.#currentState = value;
+      this.notifyStateUpdate(null, value);
+    }
+    return value;
+  }
+
+  /**
+   * Gets current or initial value at the specified "path" of the global state.
+   * @param path Dot-delimitered state path.
+   * @param options Additional options.
+   * @param options.initialState If "true" the value will be read
+   *  from the initial state instead of the current one.
+   * @param options.initialValue If the value read from the "path" is
+   *  "undefined", this "initialValue" will be returned instead. In such case
+   *  "initialValue" will also be written to the "path" of the current global
+   *  state (no matter "initialState" flag), if "undefined" is stored there.
+   * @return Retrieved value.
+   */
+
+  // .get() without arguments just falls back to .getEntireState().
+  // This variant attempts to automatically resolve and check the type of value
+  // at the given path, as precise as the actual state and path types permit.
+  // If the automatic path resolution is not possible, the ValueT fallsback
+  // to `never` (or to `undefined` in some cases), effectively forbidding
+  // to use this .get() variant.
+  // This variant is not callable by default (without generic arguments),
+  // otherwise it allows to set the correct ValueT directly.
+  get(path, opts) {
+    if ((0, _lodash.isNil)(path)) {
+      const res = this.getEntireState(opts);
+      return res;
+    }
+    const state = opts?.initialState ? this.#initialState : this.#currentState;
+    let res = (0, _lodash.get)(state, path);
+    if (res !== undefined || opts?.initialValue === undefined) return res;
+    const iv = opts.initialValue;
+    res = (0, _lodash.isFunction)(iv) ? iv() : iv;
+    if (!opts?.initialState || this.get(path) === undefined) {
+      this.set(path, res);
+    }
+    return res;
+  }
+
+  /**
+   * Writes the `value` to given global state `path`.
+   * @param path Dot-delimitered state path. If not given, entire
+   * global state content is replaced by the `value`.
+   * @param value The value.
+   * @return Given `value` itself.
+   */
+
+  // This variant attempts automatic value type resolution & checking.
+  // This variant is disabled by default, otherwise allows to give
+  // expected value type explicitly.
+  set(path, value) {
+    if ((0, _lodash.isNil)(path)) return this.setEntireState(value);
+    if (value !== this.get(path)) {
+      const root = {
+        state: this.#currentState
+      };
+      let segIdx = 0;
+      let pos = root;
+      const pathSegments = (0, _lodash.toPath)(`state.${path}`);
+      for (; segIdx < pathSegments.length - 1; segIdx += 1) {
+        const seg = pathSegments[segIdx];
+        const next = pos[seg];
+        if (Array.isArray(next)) pos[seg] = [...next];else if ((0, _lodash.isObject)(next)) pos[seg] = {
+          ...next
+        };else {
+          // We arrived to a state sub-segment, where the remaining part of
+          // the update path does not exist yet. We rely on lodash's set()
+          // function to create the remaining path, and set the value.
+          (0, _lodash.set)(pos, pathSegments.slice(segIdx), value);
+          break;
+        }
+        pos = pos[seg];
+      }
+      if (segIdx === pathSegments.length - 1) {
+        pos[pathSegments[segIdx]] = value;
+      }
+      this.#currentState = root.state;
+      this.notifyStateUpdate(path, value);
+    }
+    return value;
+  }
+
+  /**
+   * Unsubscribes `callback` from watching state updates; no operation if
+   * `callback` is not subscribed to the state updates.
+   * @param callback
+   * @throws if {@link SsrContext} is attached to the state instance: the state
+   * watching functionality is intended for client-side (non-SSR) only.
+   */
+  unWatch(callback) {
+    if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);
+    const watchers = this.#watchers;
+    const pos = watchers.indexOf(callback);
+    if (pos >= 0) {
+      watchers[pos] = watchers[watchers.length - 1];
+      watchers.pop();
+    }
+  }
+
+  /**
+   * Subscribes `callback` to watch state updates; no operation if
+   * `callback` is already subscribed to this state instance.
+   * @param callback It will be called without any arguments every
+   * time the state content changes (note, howhever, separate state updates can
+   * be applied to the state at once, and watching callbacks will be called once
+   * after such bulk update).
+   * @throws if {@link SsrContext} is attached to the state instance: the state
+   * watching functionality is intended for client-side (non-SSR) only.
+   */
+  watch(callback) {
+    if (this.ssrContext) throw new Error(ERR_NO_SSR_WATCH);
+    const watchers = this.#watchers;
+    if (watchers.indexOf(callback) < 0) {
+      watchers.push(callback);
+    }
+  }
+}
+exports.default = GlobalState;
+//# sourceMappingURL=GlobalState.js.map

package/build/common/GlobalState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalState.js","names":["_lodash","require","_utils","ERR_NO_SSR_WATCH","GlobalState","initialState","watchers","nextNotifierId","currentState","constructor","ssrContext","dirty","pending","state","process","env","NODE_ENV","isDebugMode","msg","console","groupCollapsed","log","cloneDeep","groupEnd","getEntireState","opts","undefined","initialValue","iv","isFunction","setEntireState","notifyStateUpdate","path","value","p","setTimeout","i","length","get","isNil","res","set","root","segIdx","pos","pathSegments","toPath","seg","next","Array","isArray","isObject","slice","unWatch","callback","Error","indexOf","pop","watch","push","exports","default"],"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 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 | false = false, 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 | false = false, 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,IAAAA,OAAA,GAAAC,OAAA;AAYA,IAAAC,MAAA,GAAAD,OAAA;AASA,MAAME,gBAAgB,GAAG,gDAAgD;AAO1D,MAAMC,WAAW,CAG9B;EAGA,CAACC,YAAY;;EAEb;EACA;EACA;EACA;EACA,CAACC,QAAQ,GAAgB,EAAE;EAE3B,CAACC,cAAc;EAEf,CAACC,YAAY;;EAEb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CACTJ,YAAoB,EACpBK,UAAwB,EACxB;IACA,IAAI,CAAC,CAACF,YAAY,GAAGH,YAAY;IACjC,IAAI,CAAC,CAACA,YAAY,GAAGA,YAAY;IAEjC,IAAIK,UAAU,EAAE;MACd;MACAA,UAAU,CAACC,KAAK,GAAG,KAAK;MACxBD,UAAU,CAACE,OAAO,GAAG,EAAE;MACvBF,UAAU,CAACG,KAAK,GAAG,IAAI,CAAC,CAACL,YAAY;MACrC;;MAEA,IAAI,CAACE,UAAU,GAAGA,UAAU;IAC9B;IAEA,IAAII,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACA,IAAIC,GAAG,GAAG,8BAA8B;MACxC,IAAIR,UAAU,EAAEQ,GAAG,IAAI,aAAa;MACpCC,OAAO,CAACC,cAAc,CAACF,GAAG,CAAC;MAC3BC,OAAO,CAACE,GAAG,CAAC,gBAAgB,EAAE,IAAAC,iBAAS,EAACjB,YAAY,CAAC,CAAC;MACtDc,OAAO,CAACI,QAAQ,CAAC,CAAC;MAClB;IACF;EACF;;EAEA;AACF;AACA;AACA;AACA;EACEC,cAAcA,CAACC,IAAuB,EAAU;IAC9C,IAAIZ,KAAK,GAAGY,IAAI,EAAEpB,YAAY,GAAG,IAAI,CAAC,CAACA,YAAY,GAAG,IAAI,CAAC,CAACG,YAAY;IACxE,IAAIK,KAAK,KAAKa,SAAS,IAAID,IAAI,EAAEE,YAAY,KAAKD,SAAS,EAAE,OAAOb,KAAK;IAEzE,MAAMe,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5Bd,KAAK,GAAG,IAAAgB,kBAAU,EAACD,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAClC,IAAI,IAAI,CAAC,CAACpB,YAAY,KAAKkB,SAAS,EAAE,IAAI,CAACI,cAAc,CAACjB,KAAK,CAAC;IAChE,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;EACUkB,iBAAiBA,CAACC,IAA+B,EAAEC,KAAc,EAAE;IACzE,IAAInB,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,IAAI,IAAAC,kBAAW,EAAC,CAAC,EAAE;MAC1D;MACA,MAAMiB,CAAC,GAAG,OAAOF,IAAI,KAAK,QAAQ,GAC7B,IAAGA,IAAK,GAAE,GAAG,4BAA4B;MAC9Cb,OAAO,CAACC,cAAc,CAAE,kCAAiCc,CAAE,EAAC,CAAC;MAC7Df,OAAO,CAACE,GAAG,CAAC,YAAY,EAAE,IAAAC,iBAAS,EAACW,KAAK,CAAC,CAAC;MAC3Cd,OAAO,CAACE,GAAG,CAAC,YAAY,EAAE,IAAAC,iBAAS,EAAC,IAAI,CAAC,CAACd,YAAY,CAAC,CAAC;MACxDW,OAAO,CAACI,QAAQ,CAAC,CAAC;MAClB;IACF;;IAEA,IAAI,IAAI,CAACb,UAAU,EAAE;MACnB,IAAI,CAACA,UAAU,CAACC,KAAK,GAAG,IAAI;MAC5B,IAAI,CAACD,UAAU,CAACG,KAAK,GAAG,IAAI,CAAC,CAACL,YAAY;IAC5C,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAACD,cAAc,EAAE;MAChC,IAAI,CAAC,CAACA,cAAc,GAAG4B,UAAU,CAAC,MAAM;QACtC,IAAI,CAAC,CAAC5B,cAAc,GAAGmB,SAAS;QAChC,MAAMpB,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,CAACA,QAAQ,CAAC;QACpC,KAAK,IAAI8B,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG9B,QAAQ,CAAC+B,MAAM,EAAE,EAAED,CAAC,EAAE;UACxC9B,QAAQ,CAAC8B,CAAC,CAAC,CAAC,CAAC;QACf;MACF,CAAC,CAAC;IACJ;EACF;;EAEA;AACF;AACA;AACA;EACEN,cAAcA,CAACG,KAAa,EAAU;IACpC,IAAI,IAAI,CAAC,CAACzB,YAAY,KAAKyB,KAAK,EAAE;MAChC,IAAI,CAAC,CAACzB,YAAY,GAAGyB,KAAK;MAC1B,IAAI,CAACF,iBAAiB,CAAC,IAAI,EAAEE,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;EAMAK,GAAGA,CAASN,IAAoB,EAAEP,IAAuB,EAAU;IACjE,IAAI,IAAAc,aAAK,EAACP,IAAI,CAAC,EAAE;MACf,MAAMQ,GAAG,GAAG,IAAI,CAAChB,cAAc,CAAEC,IAAoC,CAAC;MACtE,OAAQe,GAAG;IACb;IAEA,MAAM3B,KAAK,GAAGY,IAAI,EAAEpB,YAAY,GAAG,IAAI,CAAC,CAACA,YAAY,GAAG,IAAI,CAAC,CAACG,YAAY;IAE1E,IAAIgC,GAAG,GAAG,IAAAF,WAAG,EAACzB,KAAK,EAAEmB,IAAI,CAAC;IAC1B,IAAIQ,GAAG,KAAKd,SAAS,IAAID,IAAI,EAAEE,YAAY,KAAKD,SAAS,EAAE,OAAOc,GAAG;IAErE,MAAMZ,EAAE,GAAGH,IAAI,CAACE,YAAY;IAC5Ba,GAAG,GAAG,IAAAX,kBAAU,EAACD,EAAE,CAAC,GAAGA,EAAE,CAAC,CAAC,GAAGA,EAAE;IAEhC,IAAI,CAACH,IAAI,EAAEpB,YAAY,IAAI,IAAI,CAACiC,GAAG,CAACN,IAAI,CAAC,KAAKN,SAAS,EAAE;MACvD,IAAI,CAACe,GAAG,CAAkBT,IAAI,EAAEQ,GAAG,CAAC;IACtC;IAEA,OAAOA,GAAG;EACZ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;;EAEE;EAOA;EACA;EAMAC,GAAGA,CAACT,IAA+B,EAAEC,KAAc,EAAW;IAC5D,IAAI,IAAAM,aAAK,EAACP,IAAI,CAAC,EAAE,OAAO,IAAI,CAACF,cAAc,CAACG,KAAe,CAAC;IAE5D,IAAIA,KAAK,KAAK,IAAI,CAACK,GAAG,CAACN,IAAI,CAAC,EAAE;MAC5B,MAAMU,IAAI,GAAG;QAAE7B,KAAK,EAAE,IAAI,CAAC,CAACL;MAAa,CAAC;MAC1C,IAAImC,MAAM,GAAG,CAAC;MACd,IAAIC,GAAQ,GAAGF,IAAI;MACnB,MAAMG,YAAY,GAAG,IAAAC,cAAM,EAAE,SAAQd,IAAK,EAAC,CAAC;MAC5C,OAAOW,MAAM,GAAGE,YAAY,CAACR,MAAM,GAAG,CAAC,EAAEM,MAAM,IAAI,CAAC,EAAE;QACpD,MAAMI,GAAG,GAAGF,YAAY,CAACF,MAAM,CAAC;QAChC,MAAMK,IAAI,GAAGJ,GAAG,CAACG,GAAG,CAAC;QACrB,IAAIE,KAAK,CAACC,OAAO,CAACF,IAAI,CAAC,EAAEJ,GAAG,CAACG,GAAG,CAAC,GAAG,CAAC,GAAGC,IAAI,CAAC,CAAC,KACzC,IAAI,IAAAG,gBAAQ,EAACH,IAAI,CAAC,EAAEJ,GAAG,CAACG,GAAG,CAAC,GAAG;UAAE,GAAGC;QAAK,CAAC,CAAC,KAC3C;UACH;UACA;UACA;UACA,IAAAP,WAAG,EAACG,GAAG,EAAEC,YAAY,CAACO,KAAK,CAACT,MAAM,CAAC,EAAEV,KAAK,CAAC;UAC3C;QACF;QACAW,GAAG,GAAGA,GAAG,CAACG,GAAG,CAAC;MAChB;MAEA,IAAIJ,MAAM,KAAKE,YAAY,CAACR,MAAM,GAAG,CAAC,EAAE;QACtCO,GAAG,CAACC,YAAY,CAACF,MAAM,CAAC,CAAC,GAAGV,KAAK;MACnC;MAEA,IAAI,CAAC,CAACzB,YAAY,GAAGkC,IAAI,CAAC7B,KAAK;MAE/B,IAAI,CAACkB,iBAAiB,CAACC,IAAI,EAAEC,KAAK,CAAC;IACrC;IACA,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEoB,OAAOA,CAACC,QAAmB,EAAE;IAC3B,IAAI,IAAI,CAAC5C,UAAU,EAAE,MAAM,IAAI6C,KAAK,CAACpD,gBAAgB,CAAC;IAEtD,MAAMG,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ;IAC/B,MAAMsC,GAAG,GAAGtC,QAAQ,CAACkD,OAAO,CAACF,QAAQ,CAAC;IACtC,IAAIV,GAAG,IAAI,CAAC,EAAE;MACZtC,QAAQ,CAACsC,GAAG,CAAC,GAAGtC,QAAQ,CAACA,QAAQ,CAAC+B,MAAM,GAAG,CAAC,CAAC;MAC7C/B,QAAQ,CAACmD,GAAG,CAAC,CAAC;IAChB;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,KAAKA,CAACJ,QAAmB,EAAE;IACzB,IAAI,IAAI,CAAC5C,UAAU,EAAE,MAAM,IAAI6C,KAAK,CAACpD,gBAAgB,CAAC;IAEtD,MAAMG,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ;IAC/B,IAAIA,QAAQ,CAACkD,OAAO,CAACF,QAAQ,CAAC,GAAG,CAAC,EAAE;MAClChD,QAAQ,CAACqD,IAAI,CAACL,QAAQ,CAAC;IACzB;EACF;AACF;AAACM,OAAA,CAAAC,OAAA,GAAAzD,WAAA"}

package/build/common/GlobalStateProvider.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = GlobalStateProvider;
+exports.getGlobalState = getGlobalState;
+exports.getSsrContext = getSsrContext;
+var _lodash = require("lodash");
+var _react = require("react");
+var _GlobalState = _interopRequireDefault(require("./GlobalState"));
+var _jsxRuntime = require("react/jsx-runtime");
+/* eslint-disable react/prop-types */
+
+const context = /*#__PURE__*/(0, _react.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
+ */
+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 = (0, _react.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>}.
+ */
+function getSsrContext(throwWithoutSsrContext = 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.
+ */
+function GlobalStateProvider({
+  children,
+  ...rest
+}) {
+  const state = (0, _react.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.default((0, _lodash.isFunction)(initialState) ? initialState() : initialState, ssrContext);
+    }
+  }
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(context.Provider, {
+    value: state.current,
+    children: children
+  });
+}
+GlobalStateProvider.defaultProps = {
+  children: undefined
+};
+//# sourceMappingURL=GlobalStateProvider.js.map

package/build/common/GlobalStateProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalStateProvider.js","names":["_lodash","require","_react","_GlobalState","_interopRequireDefault","_jsxRuntime","context","createContext","getGlobalState","globalState","useContext","Error","getSsrContext","throwWithoutSsrContext","ssrContext","GlobalStateProvider","children","rest","state","useRef","current","stateProxy","initialState","GlobalState","isFunction","jsx","Provider","value","defaultProps","undefined"],"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":";;;;;;;;;AAEA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AAOA,IAAAE,YAAA,GAAAC,sBAAA,CAAAH,OAAA;AAAwC,IAAAI,WAAA,GAAAJ,OAAA;AAXxC;;AAgBA,MAAMK,OAAO,gBAAG,IAAAC,oBAAa,EAA8B,IAAI,CAAC;;AAEhE;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,cAAcA,CAAA,EAGQ;EACpC;EACA;EACA;EACA;EACA;EACA;EACA,MAAMC,WAAW,GAAG,IAAAC,iBAAU,EAACJ,OAAO,CAAC;EACvC;EACA,IAAI,CAACG,WAAW,EAAE,MAAM,IAAIE,KAAK,CAAC,6BAA6B,CAAC;EAChE,OAAOF,WAAW;AACpB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,aAAaA,CAG3BC,sBAAsB,GAAG,IAAI,EACJ;EACzB,MAAM;IAAEC;EAAW,CAAC,GAAGN,cAAc,CAAoC,CAAC;EAC1E,IAAI,CAACM,UAAU,IAAID,sBAAsB,EAAE;IACzC,MAAM,IAAIF,KAAK,CAAC,sBAAsB,CAAC;EACzC;EACA,OAAOG,UAAU;AACnB;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASC,mBAAmBA,CAIzC;EAAEC,QAAQ;EAAE,GAAGC;AAAoD,CAAC,EACpE;EACA,MAAMC,KAAK,GAAG,IAAAC,aAAM,EAAmC,CAAC;EACxD,IAAI,CAACD,KAAK,CAACE,OAAO,EAAE;IAClB;IACA;IACA;IACA;IACA,IAAI,YAAY,IAAIH,IAAI,IAAIA,IAAI,CAACI,UAAU,EAAE;MAC3C,IAAIJ,IAAI,CAACI,UAAU,KAAK,IAAI,EAAEH,KAAK,CAACE,OAAO,GAAGZ,cAAc,CAAC,CAAC,CAAC,KAC1DU,KAAK,CAACE,OAAO,GAAGH,IAAI,CAACI,UAAU;IACtC,CAAC,MAAM;MACL,MAAM;QAAEC,YAAY;QAAER;MAAW,CAAC,GAAGG,IAA0C;MAE/EC,KAAK,CAACE,OAAO,GAAG,IAAIG,oBAAW,CAC7B,IAAAC,kBAAU,EAACF,YAAY,CAAC,GAAGA,YAAY,CAAC,CAAC,GAAGA,YAAY,EACxDR,UACF,CAAC;IACH;EACF;EACA,oBACE,IAAAT,WAAA,CAAAoB,GAAA,EAACnB,OAAO,CAACoB,QAAQ;IAACC,KAAK,EAAET,KAAK,CAACE,OAAQ;IAAAJ,QAAA,EACpCA;EAAQ,CACO,CAAC;AAEvB;AAEAD,mBAAmB,CAACa,YAAY,GAAG;EACjCZ,QAAQ,EAAEa;AACZ,CAAC"}

package/build/common/SsrContext.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+class SsrContext {
+  dirty = false;
+  pending = [];
+  constructor(state) {
+    this.state = state;
+  }
+}
+exports.default = SsrContext;
+//# sourceMappingURL=SsrContext.js.map

package/build/common/SsrContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SsrContext.js","names":["SsrContext","dirty","pending","constructor","state","exports","default"],"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":";;;;;;AAAe,MAAMA,UAAU,CAAS;EACtCC,KAAK,GAAY,KAAK;EAEtBC,OAAO,GAAoB,EAAE;EAI7BC,WAAWA,CAACC,KAAc,EAAE;IAC1B,IAAI,CAACA,KAAK,GAAGA,KAAK;EACpB;AACF;AAACC,OAAA,CAAAC,OAAA,GAAAN,UAAA"}

package/build/common/index.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "GlobalState", {
+  enumerable: true,
+  get: function () {
+    return _GlobalState.default;
+  }
+});
+Object.defineProperty(exports, "GlobalStateProvider", {
+  enumerable: true,
+  get: function () {
+    return _GlobalStateProvider.default;
+  }
+});
+Object.defineProperty(exports, "SsrContext", {
+  enumerable: true,
+  get: function () {
+    return _SsrContext.default;
+  }
+});
+Object.defineProperty(exports, "getGlobalState", {
+  enumerable: true,
+  get: function () {
+    return _GlobalStateProvider.getGlobalState;
+  }
+});
+Object.defineProperty(exports, "getSsrContext", {
+  enumerable: true,
+  get: function () {
+    return _GlobalStateProvider.getSsrContext;
+  }
+});
+Object.defineProperty(exports, "newAsyncDataEnvelope", {
+  enumerable: true,
+  get: function () {
+    return _useAsyncData.newAsyncDataEnvelope;
+  }
+});
+Object.defineProperty(exports, "useAsyncCollection", {
+  enumerable: true,
+  get: function () {
+    return _useAsyncCollection.default;
+  }
+});
+Object.defineProperty(exports, "useAsyncData", {
+  enumerable: true,
+  get: function () {
+    return _useAsyncData.default;
+  }
+});
+Object.defineProperty(exports, "useGlobalState", {
+  enumerable: true,
+  get: function () {
+    return _useGlobalState.default;
+  }
+});
+Object.defineProperty(exports, "withGlobalStateType", {
+  enumerable: true,
+  get: function () {
+    return _withGlobalStateType.default;
+  }
+});
+var _GlobalState = _interopRequireDefault(require("./GlobalState"));
+var _GlobalStateProvider = _interopRequireWildcard(require("./GlobalStateProvider"));
+var _SsrContext = _interopRequireDefault(require("./SsrContext"));
+var _useAsyncCollection = _interopRequireDefault(require("./useAsyncCollection"));
+var _useAsyncData = _interopRequireWildcard(require("./useAsyncData"));
+var _useGlobalState = _interopRequireDefault(require("./useGlobalState"));
+var _withGlobalStateType = _interopRequireDefault(require("./withGlobalStateType"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+//# sourceMappingURL=index.js.map

package/build/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_GlobalState","_interopRequireDefault","require","_GlobalStateProvider","_interopRequireWildcard","_SsrContext","_useAsyncCollection","_useAsyncData","_useGlobalState","_withGlobalStateType","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","prototype","hasOwnProperty","call","i","set"],"sources":["../../src/index.ts"],"sourcesContent":["export { default as GlobalState } from './GlobalState';\n\nexport {\n  default as GlobalStateProvider,\n  getGlobalState,\n  getSsrContext,\n} from './GlobalStateProvider';\n\nexport { default as SsrContext } from './SsrContext';\n\nexport {\n  type AsyncCollectionLoaderT,\n  default as useAsyncCollection,\n} from './useAsyncCollection';\n\nexport {\n  type AsyncDataEnvelopeT,\n  type AsyncDataLoaderT,\n  type UseAsyncDataOptionsT,\n  type UseAsyncDataResT,\n  default as useAsyncData,\n  newAsyncDataEnvelope,\n} from './useAsyncData';\n\nexport {\n  type SetterT,\n  type UseGlobalStateResT,\n  default as useGlobalState,\n} from './useGlobalState';\n\nexport { type ForceT, type ValueOrInitializerT } from './utils';\n\nexport { default as withGlobalStateType } from './withGlobalStateType';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,oBAAA,GAAAC,uBAAA,CAAAF,OAAA;AAMA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAEA,IAAAI,mBAAA,GAAAL,sBAAA,CAAAC,OAAA;AAKA,IAAAK,aAAA,GAAAH,uBAAA,CAAAF,OAAA;AASA,IAAAM,eAAA,GAAAP,sBAAA,CAAAC,OAAA;AAQA,IAAAO,oBAAA,GAAAR,sBAAA,CAAAC,OAAA;AAAuE,SAAAQ,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAP,wBAAAO,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAjB,CAAA,EAAAc,CAAA,SAAAI,CAAA,GAAAR,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAI,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAI,CAAA,IAAAV,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAgB,GAAA,CAAAnB,CAAA,EAAAQ,CAAA,GAAAA,CAAA"}

package/build/common/useAsyncCollection.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _useAsyncData = _interopRequireDefault(require("./useAsyncData"));
+/**
+ * Loads and uses an item in an async collection.
+ */
+
+/**
+ * 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, options = {}) {
+  const itemPath = path ? `${path}.${id}` : id;
+  return (0, _useAsyncData.default)(itemPath, oldData => loader(id, oldData), options);
+}
+var _default = exports.default = useAsyncCollection;
+//# sourceMappingURL=useAsyncCollection.js.map

package/build/common/useAsyncCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncCollection.js","names":["_useAsyncData","_interopRequireDefault","require","useAsyncCollection","id","path","loader","options","itemPath","useAsyncData","oldData","_default","exports","default"],"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 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 | false = false,\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"],"mappings":";;;;;;;AAIA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAJA;AACA;AACA;;AAaA;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,EACrCC,OAA6B,GAAG,CAAC,CAAC,EACT;EACzB,MAAMC,QAAQ,GAAGH,IAAI,GAAI,GAAEA,IAAK,IAAGD,EAAG,EAAC,GAAGA,EAAE;EAC5C,OAAO,IAAAK,qBAAY,EACjBD,QAAQ,EACPE,OAAqB,IAAKJ,MAAM,CAACF,EAAE,EAAEM,OAAO,CAAC,EAC9CH,OACF,CAAC;AACH;AAAC,IAAAI,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEcV,kBAAkB"}