@encorejs/react 1.0.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,144 @@
+# @encorejs/react
+
+Utilities for using [Encore](https://www.theatrejs.com) or
+[Dataverse](https://github.com/ikanishakm/encore/tree/main/packages/dataverse)
+with React.
+
+## Documentation
+
+### `useVal(pointerOrPrism)`
+
+A React hook that returns the value of the given prism or pointer.
+
+Usage with Dataverse pointers:
+
+```tsx
+import {Atom} from '@encorejs/dataverse'
+import {useVal} from '@encorejs/react'
+
+const atom = new Atom({foo: 'foo'})
+
+function Component() {
+  const foo = useVal(atom.pointer.foo)
+  return <div>{foo}</div>
+}
+```
+
+Usage with Dataverse prisms:
+
+```tsx
+import {prism} from '@encorejs/dataverse'
+import {useVal} from '@encorejs/react'
+
+const pr = prism(() => 'some value')
+
+function Component() {
+  const value = useVal(pr)
+  return <div>{value}</div>
+}
+```
+
+Usage with Encore pointers:
+
+```tsx
+import {useVal} from '@encorejs/react'
+import {getProject} from '@encorejs/core'
+
+const obj = getProject('my project')
+  .sheet('my sheet')
+  .object('my object', {foo: 'default value of props.foo'})
+
+function Component() {
+  const value = useVal(obj.props.foo)
+  return <div>obj.foo is {value}</div>
+}
+```
+
+_Note that `useVal()` is a React hook, so it can only be used inside a React
+component's render function. `val()` on the other hand, can be used either
+inside a `prism` (which would be reactive) or anywhere where reactive values are
+not needed._
+
+### `usePrism(fn, deps)`
+
+Creates a prism out of `fn` and subscribes the element to the value of the
+created prism.
+
+```tsx
+import {Atom, val, prism} from '@encorejs/dataverse'
+import {usePrism} from '@encorejs/react'
+
+const state = new Atom({a: 1, b: 1})
+
+function Component(props: {which: 'a' | 'b'}) {
+  const value = usePrism(
+    () => {
+      prism.isPrism() // true
+      // note that this function is running inside a prism, so all of prism's
+      // hooks (prism.memo(), prism.effect(), etc) are available
+      const num = val(props.which === 'a' ? state.pointer.a : state.pointer.b)
+      return doExpensiveComputation(num)
+    },
+    // since our prism reads `props.which`, we should include it in the deps array
+    [props.which],
+  )
+  return <div>{value}</div>
+}
+```
+
+> Note that just like `useMemo(..., deps)`, it's necessary to provide a `deps`
+> array to `usePrism()`.
+
+### `usePrismInstance(prismInstance)`
+
+Subscribes the element to the value of the given prism instance.
+
+```tsx
+import {Atom, val, prism} from '@encorejs/dataverse'
+import {usePrismInstance} from '@encorejs/react'
+
+const state = new Atom({a: 1, b: 1})
+
+const p = prism(() => {
+  return val(state.pointer.a) + val(state.pointer.b)
+})
+
+function Component() {
+  const value = usePrismInstance(p)
+  return <div>{value}</div>
+}
+```
+
+### `useAtom(initialValue)`
+
+/\*\* Creates a new Atom, similar to useState(), but the component won't
+re-render if the value of the atom changes.
+
+```tsx
+import {useAtom, useVal} from '@encorejs/react'
+import {useEffect} from 'react'
+
+function MyComponent() {
+  const atom = useAtom({count: 0, ready: false})
+
+  const onClick = () =>
+    atom.setByPointer(
+      (p) => p.count,
+      (count) => count + 1,
+    )
+
+  useEffect(() => {
+    setTimeout(() => {
+      atom.setByPointer((p) => p.ready, true)
+    }, 1000)
+  }, [])
+
+  const ready = useVal(atom.pointer.ready)
+  if (!ready) return <div>Loading...</div>
+  return <button onClick={onClick}>Click me</button>
+}
+```
+
+## Links
+
+- Learn more about [Dataverse](../dataverse/README.md)

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+/**
+ * React bindings for dataverse.
+ *
+ * @packageDocumentation
+ */
+import type { Prism } from '@encorejs/dataverse';
+import { val, Atom } from '@encorejs/dataverse';
+/**
+ * A React hook that executes the callback function and returns its return value
+ * whenever there's a change in the values of the dependency array, or in the
+ * prisms that are used within the callback function.
+ *
+ * @param fn - The callback function
+ * @param deps - The dependency array
+ * @param debugLabel - The label used by the debugger
+ *
+ * @remarks
+ *
+ * A common mistake with `usePrism()` is not including its deps in its dependency array. Let's
+ * have an eslint rule to catch that.
+ */
+export declare function usePrism<T>(fn: () => T, deps: unknown[], debugLabel?: string): T;
+export declare const useVal: typeof val;
+/**
+ * Like `usePrismInstance()`, but it expects the prism's instance to be
+ * static and never change between renders.
+ *
+ * @param der - The prism
+ * @param debugLabel - The label used by the debugger
+ * @returns The value of the prism
+ */
+export declare function _usePrismStaticInstance<T>(der: Prism<T>, debugLabel?: string): T;
+/**
+ * A React hook that returns the value of the prism that it received as the first argument.
+ * It works like an implementation of Dataverse's Ticker, except that it runs the side effects in
+ * an order where a component's prism is guaranteed to run before any of its descendents' prisms.
+ *
+ * @param der - The prism
+ * @param debugLabel - The label used by the debugger
+ *
+ * @remarks
+ * It looks like this new implementation of usePrism() manages to:
+ * 1. Not over-calculate the prisms
+ * 2. Render prism in ancestor -\> descendent order
+ * 3. Not set off React's concurrent mode alarms
+ *
+ *
+ * I'm happy with how little bookkeeping we ended up doing here.
+ *
+ * ---
+ *
+ * Notes on the latest implementation:
+ *
+ * # Remove cold prism reads
+ *
+ * Prior to the latest change, the first render of every `usePrismInstance()` resulted in a cold read of its inner prism.
+ * Cold reads are predictably slow. The reason we'd run cold reads was to comply with react's rule of not running side-effects
+ * during render. (Turning a prism hot is _technically_ a side-effect).
+ *
+ * However, now that users are animating scenes with hundreds of objects in the same sequence, the lag started to be noticable.
+ *
+ * This commit changes `usePrismInstance()` so that it turns its prism hot before rendering them.
+ *
+ * # Freshen prisms before render
+ *
+ * Previously in order to avoid the zombie child problem (https://kaihao.dev/posts/stale-props-and-zombie-children-in-redux)
+ * we deferred freshening the prisms to the render phase of components. This meant that if a prism's dependencies
+ * changed, `usePrismInstance()` would schedule a re-render, regardless of whether that change actually affected the prism's
+ * value. Here is a contrived example:
+ *
+ * ```ts
+ * const num = new Box(1)
+ * const isPositiveD = prism(() => num.prism.getValue() >= 0)
+ *
+ * const Comp = () => {
+ *   return <div>{usePrismInstance(isPositiveD)}</div>
+ * }
+ *
+ * num.set(2) // would cause Comp to re-render- even though 1 is still a positive number
+ * ```
+ *
+ * We now avoid this problem by freshening the prism (i.e. calling `der.getValue()`) inside `runQueue()`,
+ * and then only causing a re-render if the prism's value is actually changed.
+ *
+ * This still avoids the zombie-child problem because `runQueue` reads the prisms in-order of their position in
+ * the mounting tree.
+ *
+ * On the off-chance that one of them still turns out to be a zombile child, `runQueue` will defer that particular
+ * `usePrismInstance()` to be read inside a normal react render phase.
+ */
+export declare function usePrismInstance<T>(der: Prism<T>, debugLabel?: string): T;
+/**
+ * Creates a new Atom, similar to useState(), but the component
+ * won't re-render if the value of the atom changes.
+ *
+ * @param initialState - Initial state
+ * @returns The Atom
+ *
+ * @example
+ *
+ * Usage
+ * ```tsx
+ * import {useAtom, useVal} from '@encorejs/react'
+ * import {useEffect} from 'react'
+ *
+ * function MyComponent() {
+ *   const atom = useAtom({count: 0, ready: false})
+ *
+ *   const onClick = () =>
+ *     atom.setByPointer(
+ *       (p) => p.count,
+ *       (count) => count + 1,
+ *     )
+ *
+ *   useEffect(() => {
+ *     setTimeout(() => {
+ *       atom.setByPointer((p) => p.ready, true)
+ *     }, 1000)
+ *   }, [])
+ *
+ *   const ready = useVal(atom.pointer.ready)
+ *   if (!ready) return <div>Loading...</div>
+ *   return <button onClick={onClick}>Click me</button>
+ * }
+ * ```
+ */
+export declare function useAtom<T>(initialState: T): Atom<T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAQ,GAAG,EAAE,IAAI,EAAC,MAAM,qBAAqB,CAAA;AAyBpD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,EAAE,EAAE,MAAM,CAAC,EACX,IAAI,EAAE,OAAO,EAAE,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,CAAC,CAgCH;AAED,eAAO,MAAM,MAAM,EAAE,OAAO,GAE3B,CAAA;AAuKD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,CAAC,CAoEH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAEzE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAMnD"}

package/dist/index.js

@@ -0,0 +1,211 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __reExport = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+};
+
+// src/index.ts
+__export(exports, {
+  _usePrismStaticInstance: () => _usePrismStaticInstance,
+  useAtom: () => useAtom,
+  usePrism: () => usePrism,
+  usePrismInstance: () => usePrismInstance,
+  useVal: () => useVal
+});
+var import_dataverse = __toModule(require("@encorejs/dataverse"));
+var import_lodash_es = __toModule(require("lodash-es"));
+var import_queue_microtask = __toModule(require("queue-microtask"));
+var import_react = __toModule(require("react"));
+var import_react_dom = __toModule(require("react-dom"));
+var TRACE = false;
+function useForceUpdate(debugLabel) {
+  const [, setTick] = (0, import_react.useState)(0);
+  const update = (0, import_react.useCallback)(() => {
+    setTick((tick) => tick + 1);
+  }, []);
+  return update;
+}
+function usePrism(fn, deps, debugLabel) {
+  const refs = (0, import_react.useRef)(void 0);
+  if (!refs.current) {
+    refs.current = {
+      atom: new import_dataverse.Atom(fn),
+      prism: (0, import_dataverse.prism)(() => {
+        const fn2 = refs.current.atom.prism.getValue();
+        return fn2();
+      }),
+      deps
+    };
+  } else {
+    if (deps.length !== refs.current.deps.length) {
+      refs.current.deps = deps;
+      refs.current.atom.set(fn);
+    } else {
+      for (let i = 0; i < deps.length; i++) {
+        if (deps[i] !== refs.current.deps[i]) {
+          refs.current.deps = deps;
+          refs.current.atom.set(fn);
+          break;
+        }
+      }
+    }
+  }
+  return _usePrismStaticInstance(refs.current.prism, debugLabel);
+}
+var useVal = (p, debugLabel) => {
+  return usePrism(() => (0, import_dataverse.val)(p), [p], debugLabel);
+};
+var lastOrder = 0;
+var queue = [];
+var setOfQueuedItems = new Set();
+var microtaskIsQueued = false;
+var pushToQueue = (item) => {
+  _pushToQueue(item);
+  queueIfNeeded();
+};
+var _pushToQueue = (item) => {
+  if (setOfQueuedItems.has(item))
+    return;
+  setOfQueuedItems.add(item);
+  if (queue.length === 0) {
+    queue.push(item);
+  } else {
+    const index = (0, import_lodash_es.findIndex)(queue, (existingItem) => existingItem.order >= item.order);
+    if (index === -1) {
+      queue.push(item);
+    } else {
+      const right = queue[index];
+      if (right.order > item.order) {
+        queue.splice(index, 0, item);
+      }
+    }
+  }
+};
+var removeFromQueue = (item) => {
+  if (!setOfQueuedItems.has(item))
+    return;
+  setOfQueuedItems.delete(item);
+  const index = (0, import_lodash_es.findIndex)(queue, (o) => o === item);
+  queue.splice(index, 1);
+};
+function queueIfNeeded() {
+  if (microtaskIsQueued)
+    return;
+  microtaskIsQueued = true;
+  (0, import_queue_microtask.default)(() => {
+    (0, import_react_dom.unstable_batchedUpdates)(function runQueue() {
+      var _a, _b;
+      while (queue.length > 0) {
+        const item = queue.shift();
+        setOfQueuedItems.delete(item);
+        let newValue;
+        if (TRACE) {
+          (_a = item.debug) == null ? void 0 : _a.history.push(`queue reached`);
+        }
+        try {
+          newValue = item.der.getValue();
+        } catch (error) {
+          if (TRACE) {
+            (_b = item.debug) == null ? void 0 : _b.history.push(`queue: der.getValue() errored`);
+          }
+          console.error("A `der.getValue()` in `usePrismInstance(der)` threw an error. This may be a zombie child issue, so we're gonna try to get its value again in a normal react render phase.If you see the same error again, then you either have an error in your prism code, or the deps array in `usePrism(fn, deps)` is missing a dependency and causing the prism to read stale values.");
+          console.error(error);
+          item.runUpdate();
+          continue;
+        }
+        if (newValue !== item.lastValue) {
+          item.lastValue = newValue;
+          item.runUpdate();
+        }
+      }
+      microtaskIsQueued = false;
+    }, 1);
+  });
+}
+function _usePrismStaticInstance(der, debugLabel) {
+  var _a;
+  const _forceUpdate = useForceUpdate(debugLabel);
+  const ref = (0, import_react.useRef)(void 0);
+  if (!ref.current) {
+    lastOrder++;
+    ref.current = {
+      order: lastOrder,
+      runUpdate: () => {
+        if (!ref.current.unmounted) {
+          _forceUpdate();
+        }
+      },
+      der,
+      lastValue: void 0,
+      unmounted: false,
+      queueUpdate: () => {
+        var _a2;
+        if (TRACE) {
+          (_a2 = ref.current.debug) == null ? void 0 : _a2.history.push(`queueUpdate()`);
+        }
+        pushToQueue(ref.current);
+      },
+      untap: der.onStale(() => {
+        if (TRACE) {
+          ref.current.debug.history.push(`onStale(cb)`);
+        }
+        ref.current.queueUpdate();
+      })
+    };
+    if (TRACE) {
+      ref.current.debug = {
+        label: debugLabel,
+        traceOfFirstTimeRender: new Error(),
+        history: []
+      };
+    }
+  }
+  if (process.env.NODE_ENV !== "production") {
+    if (der !== ref.current.der) {
+      console.error("Argument `der` in `usePrismInstance(der)` should not change between renders.");
+    }
+  }
+  (0, import_react.useLayoutEffect)(() => {
+    return function onUnmount() {
+      ref.current.unmounted = true;
+      ref.current.untap();
+      removeFromQueue(ref.current);
+    };
+  }, []);
+  removeFromQueue(ref.current);
+  const newValue = ref.current.der.getValue();
+  ref.current.lastValue = newValue;
+  if (TRACE) {
+    (_a = ref.current.debug) == null ? void 0 : _a.history.push(`rendered`);
+  }
+  return newValue;
+}
+function usePrismInstance(der, debugLabel) {
+  return usePrism(() => der.getValue(), [der], debugLabel);
+}
+function useAtom(initialState) {
+  const ref = (0, import_react.useRef)(void 0);
+  if (!ref.current) {
+    ref.current = new import_dataverse.Atom(initialState);
+  }
+  return ref.current;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["/**\r\n * React bindings for dataverse.\r\n *\r\n * @packageDocumentation\r\n */\r\n\r\nimport type {Prism} from '@encorejs/dataverse'\r\nimport {prism, val, Atom} from '@encorejs/dataverse'\r\nimport {findIndex} from 'lodash-es'\r\nimport queueMicrotask from 'queue-microtask'\r\nimport {useCallback, useLayoutEffect, useRef, useState} from 'react'\r\nimport {unstable_batchedUpdates} from 'react-dom'\r\n\r\ntype $IntentionalAny = any\r\ntype VoidFn = () => void\r\n\r\n/**\r\n * Enables a few traces and debug points to help identify performance glitches in `@encorejs/react`.\r\n * Look up references to this value to see how to make use of those traces.\r\n */\r\nconst TRACE: boolean = false && process.env.NODE_ENV !== 'production'\r\n\r\nfunction useForceUpdate(debugLabel?: string) {\r\n  const [, setTick] = useState(0)\r\n\r\n  const update = useCallback(() => {\r\n    setTick((tick) => tick + 1)\r\n  }, [])\r\n\r\n  return update\r\n}\r\n\r\n/**\r\n * A React hook that executes the callback function and returns its return value\r\n * whenever there's a change in the values of the dependency array, or in the\r\n * prisms that are used within the callback function.\r\n *\r\n * @param fn - The callback function\r\n * @param deps - The dependency array\r\n * @param debugLabel - The label used by the debugger\r\n *\r\n * @remarks\r\n *\r\n * A common mistake with `usePrism()` is not including its deps in its dependency array. Let's\r\n * have an eslint rule to catch that.\r\n */\r\nexport function usePrism<T>(\r\n  fn: () => T,\r\n  deps: unknown[],\r\n  debugLabel?: string,\r\n): T {\r\n  const refs = useRef<{\r\n    atom: Atom<typeof fn>\r\n    prism: Prism<T>\r\n    deps: unknown[]\r\n  }>(undefined as $IntentionalAny)\r\n\r\n  if (!refs.current) {\r\n    refs.current = {\r\n      atom: new Atom(fn),\r\n      prism: prism(() => {\r\n        const fn = refs.current!.atom.prism.getValue()\r\n        return fn()\r\n      }),\r\n      deps,\r\n    }\r\n  } else {\r\n    if (deps.length !== refs.current.deps.length) {\r\n      refs.current.deps = deps\r\n      refs.current.atom.set(fn)\r\n    } else {\r\n      for (let i = 0; i < deps.length; i++) {\r\n        if (deps[i] !== refs.current.deps[i]) {\r\n          refs.current.deps = deps\r\n          refs.current.atom.set(fn)\r\n          break\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  return _usePrismStaticInstance(refs.current.prism, debugLabel)\r\n}\r\n\r\nexport const useVal: typeof val = (p: $IntentionalAny, debugLabel?: string) => {\r\n  return usePrism(() => val(p), [p], debugLabel)\r\n}\r\n\r\n/**\r\n * Each usePrism() call is assigned an `order`. Parents have a smaller\r\n * order than their children, and so on.\r\n */\r\nlet lastOrder = 0\r\n\r\n/**\r\n * A sorted array of prisms that need to be refreshed. The prisms are sorted\r\n * by their order, which means a parent prism always gets priority to children\r\n * and descendents. Ie. we refresh the prisms top to bottom.\r\n */\r\nconst queue: QueueItem[] = []\r\nconst setOfQueuedItems = new Set<QueueItem>()\r\n\r\ntype QueueItem<T = unknown> = {\r\n  order: number\r\n  /**\r\n   * runUpdate() is the equivalent of a forceUpdate() call. It would only be called\r\n   * if the value of the inner prism has _actually_ changed.\r\n   */\r\n  runUpdate: VoidFn\r\n  /**\r\n   * Some debugging info that are only present if {@link TRACE} is true\r\n   */\r\n  debug?: {\r\n    /**\r\n     * The `debugLabel` given to `usePrism()/usePrismInstance()`\r\n     */\r\n    label?: string\r\n    /**\r\n     * A trace of the first time the component got rendered\r\n     */\r\n    traceOfFirstTimeRender: Error\r\n    /**\r\n     * An array of the operations done on/about this usePrismInstance. This is helpful to trace\r\n     * why a usePrismInstance's update was added to the queue and why it re-rendered\r\n     */\r\n    history: Array<\r\n      /**\r\n       * Item reached its turn in the queue\r\n       */\r\n      | `queue reached`\r\n      /**\r\n       * Item reached its turn in the queue, and errored (likely something in `prism()` threw an error)\r\n       */\r\n      | `queue: der.getValue() errored`\r\n      /**\r\n       * The item was added to the queue (may be called multiple times, but will only queue once)\r\n       */\r\n      | `queueUpdate()`\r\n      /**\r\n       * `cb` in `item.der.onStale(cb)` was called\r\n       */\r\n      | `onStale(cb)`\r\n      /**\r\n       * Item was rendered\r\n       */\r\n      | `rendered`\r\n    >\r\n  }\r\n  /**\r\n   * A reference to the prism\r\n   */\r\n  der: Prism<T>\r\n  /**\r\n   * The last value of this prism.\r\n   */\r\n  lastValue: T\r\n  /**\r\n   * Would be set to true if the element hosting the `usePrismInstance()` was unmounted\r\n   */\r\n  unmounted: boolean\r\n  /**\r\n   * Adds the `usePrismInstance` to the update queue\r\n   */\r\n  queueUpdate: () => void\r\n  /**\r\n   * Untaps from `this.der.unStale()`\r\n   */\r\n  untap: () => void\r\n}\r\n\r\nlet microtaskIsQueued = false\r\n\r\nconst pushToQueue = (item: QueueItem) => {\r\n  _pushToQueue(item)\r\n  queueIfNeeded()\r\n}\r\n\r\nconst _pushToQueue = (item: QueueItem) => {\r\n  if (setOfQueuedItems.has(item)) return\r\n  setOfQueuedItems.add(item)\r\n\r\n  if (queue.length === 0) {\r\n    queue.push(item)\r\n  } else {\r\n    const index = findIndex(\r\n      queue,\r\n      (existingItem) => existingItem.order >= item.order,\r\n    )\r\n    if (index === -1) {\r\n      queue.push(item)\r\n    } else {\r\n      const right = queue[index]\r\n      if (right.order > item.order) {\r\n        queue.splice(index, 0, item)\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Plucks items from the queue\r\n */\r\nconst removeFromQueue = (item: QueueItem) => {\r\n  if (!setOfQueuedItems.has(item)) return\r\n  setOfQueuedItems.delete(item)\r\n\r\n  const index = findIndex(queue, (o) => o === item)\r\n  queue.splice(index, 1)\r\n}\r\n\r\nfunction queueIfNeeded() {\r\n  if (microtaskIsQueued) return\r\n  microtaskIsQueued = true\r\n\r\n  queueMicrotask(() => {\r\n    unstable_batchedUpdates(function runQueue() {\r\n      while (queue.length > 0) {\r\n        const item = queue.shift()!\r\n        setOfQueuedItems.delete(item)\r\n\r\n        let newValue\r\n        if (TRACE) {\r\n          item.debug?.history.push(`queue reached`)\r\n        }\r\n        try {\r\n          newValue = item.der.getValue()\r\n        } catch (error) {\r\n          if (TRACE) {\r\n            item.debug?.history.push(`queue: der.getValue() errored`)\r\n          }\r\n          console.error(\r\n            'A `der.getValue()` in `usePrismInstance(der)` threw an error. ' +\r\n              \"This may be a zombie child issue, so we're gonna try to get its value again in a normal react render phase.\" +\r\n              'If you see the same error again, then you either have an error in your prism code, or the deps array in `usePrism(fn, deps)` is missing ' +\r\n              'a dependency and causing the prism to read stale values.',\r\n          )\r\n          console.error(error)\r\n\r\n          item.runUpdate()\r\n\r\n          continue\r\n        }\r\n        if (newValue !== item.lastValue) {\r\n          item.lastValue = newValue\r\n          item.runUpdate()\r\n        }\r\n      }\r\n\r\n      microtaskIsQueued = false\r\n    }, 1)\r\n  })\r\n}\r\n\r\n/**\r\n * Like `usePrismInstance()`, but it expects the prism's instance to be\r\n * static and never change between renders.\r\n *\r\n * @param der - The prism\r\n * @param debugLabel - The label used by the debugger\r\n * @returns The value of the prism\r\n */\r\nexport function _usePrismStaticInstance<T>(\r\n  der: Prism<T>,\r\n  debugLabel?: string,\r\n): T {\r\n  const _forceUpdate = useForceUpdate(debugLabel)\r\n\r\n  const ref = useRef<QueueItem<T>>(undefined as $IntentionalAny)\r\n\r\n  if (!ref.current) {\r\n    lastOrder++\r\n\r\n    ref.current = {\r\n      order: lastOrder,\r\n      runUpdate: () => {\r\n        if (!ref.current.unmounted) {\r\n          _forceUpdate()\r\n        }\r\n      },\r\n      der,\r\n      lastValue: undefined as $IntentionalAny,\r\n      unmounted: false,\r\n      queueUpdate: () => {\r\n        if (TRACE) {\r\n          ref.current.debug?.history.push(`queueUpdate()`)\r\n        }\r\n        pushToQueue(ref.current)\r\n      },\r\n      untap: der.onStale(() => {\r\n        if (TRACE) {\r\n          ref.current.debug!.history.push(`onStale(cb)`)\r\n        }\r\n        ref.current!.queueUpdate()\r\n      }),\r\n    }\r\n\r\n    if (TRACE) {\r\n      ref.current.debug = {\r\n        label: debugLabel,\r\n        traceOfFirstTimeRender: new Error(),\r\n        history: [],\r\n      }\r\n    }\r\n  }\r\n\r\n  if (process.env.NODE_ENV !== 'production') {\r\n    if (der !== ref.current.der) {\r\n      console.error(\r\n        'Argument `der` in `usePrismInstance(der)` should not change between renders.',\r\n      )\r\n    }\r\n  }\r\n\r\n  useLayoutEffect(() => {\r\n    return function onUnmount() {\r\n      ref.current.unmounted = true\r\n      ref.current.untap()\r\n      removeFromQueue(ref.current)\r\n    }\r\n  }, [])\r\n\r\n  // if we're queued but are rendering before our turn, remove us from the queue\r\n  removeFromQueue(ref.current)\r\n\r\n  const newValue = ref.current.der.getValue()\r\n  ref.current.lastValue = newValue\r\n\r\n  if (TRACE) {\r\n    ref.current.debug?.history.push(`rendered`)\r\n  }\r\n\r\n  return newValue\r\n}\r\n\r\n/**\r\n * A React hook that returns the value of the prism that it received as the first argument.\r\n * It works like an implementation of Dataverse's Ticker, except that it runs the side effects in\r\n * an order where a component's prism is guaranteed to run before any of its descendents' prisms.\r\n *\r\n * @param der - The prism\r\n * @param debugLabel - The label used by the debugger\r\n *\r\n * @remarks\r\n * It looks like this new implementation of usePrism() manages to:\r\n * 1. Not over-calculate the prisms\r\n * 2. Render prism in ancestor -\\> descendent order\r\n * 3. Not set off React's concurrent mode alarms\r\n *\r\n *\r\n * I'm happy with how little bookkeeping we ended up doing here.\r\n *\r\n * ---\r\n *\r\n * Notes on the latest implementation:\r\n *\r\n * # Remove cold prism reads\r\n *\r\n * Prior to the latest change, the first render of every `usePrismInstance()` resulted in a cold read of its inner prism.\r\n * Cold reads are predictably slow. The reason we'd run cold reads was to comply with react's rule of not running side-effects\r\n * during render. (Turning a prism hot is _technically_ a side-effect).\r\n *\r\n * However, now that users are animating scenes with hundreds of objects in the same sequence, the lag started to be noticable.\r\n *\r\n * This commit changes `usePrismInstance()` so that it turns its prism hot before rendering them.\r\n *\r\n * # Freshen prisms before render\r\n *\r\n * Previously in order to avoid the zombie child problem (https://kaihao.dev/posts/stale-props-and-zombie-children-in-redux)\r\n * we deferred freshening the prisms to the render phase of components. This meant that if a prism's dependencies\r\n * changed, `usePrismInstance()` would schedule a re-render, regardless of whether that change actually affected the prism's\r\n * value. Here is a contrived example:\r\n *\r\n * ```ts\r\n * const num = new Box(1)\r\n * const isPositiveD = prism(() => num.prism.getValue() >= 0)\r\n *\r\n * const Comp = () => {\r\n *   return <div>{usePrismInstance(isPositiveD)}</div>\r\n * }\r\n *\r\n * num.set(2) // would cause Comp to re-render- even though 1 is still a positive number\r\n * ```\r\n *\r\n * We now avoid this problem by freshening the prism (i.e. calling `der.getValue()`) inside `runQueue()`,\r\n * and then only causing a re-render if the prism's value is actually changed.\r\n *\r\n * This still avoids the zombie-child problem because `runQueue` reads the prisms in-order of their position in\r\n * the mounting tree.\r\n *\r\n * On the off-chance that one of them still turns out to be a zombile child, `runQueue` will defer that particular\r\n * `usePrismInstance()` to be read inside a normal react render phase.\r\n */\r\nexport function usePrismInstance<T>(der: Prism<T>, debugLabel?: string): T {\r\n  return usePrism(() => der.getValue(), [der], debugLabel)\r\n}\r\n\r\n/**\r\n * Creates a new Atom, similar to useState(), but the component\r\n * won't re-render if the value of the atom changes.\r\n *\r\n * @param initialState - Initial state\r\n * @returns The Atom\r\n *\r\n * @example\r\n *\r\n * Usage\r\n * ```tsx\r\n * import {useAtom, useVal} from '@encorejs/react'\r\n * import {useEffect} from 'react'\r\n *\r\n * function MyComponent() {\r\n *   const atom = useAtom({count: 0, ready: false})\r\n *\r\n *   const onClick = () =>\r\n *     atom.setByPointer(\r\n *       (p) => p.count,\r\n *       (count) => count + 1,\r\n *     )\r\n *\r\n *   useEffect(() => {\r\n *     setTimeout(() => {\r\n *       atom.setByPointer((p) => p.ready, true)\r\n *     }, 1000)\r\n *   }, [])\r\n *\r\n *   const ready = useVal(atom.pointer.ready)\r\n *   if (!ready) return <div>Loading...</div>\r\n *   return <button onClick={onClick}>Click me</button>\r\n * }\r\n * ```\r\n */\r\nexport function useAtom<T>(initialState: T): Atom<T> {\r\n  const ref = useRef<Atom<T>>(undefined as $IntentionalAny)\r\n  if (!ref.current) {\r\n    ref.current = new Atom(initialState)\r\n  }\r\n  return ref.current\r\n}\r\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,uBAA+B;AAC/B,uBAAwB;AACxB,6BAA2B;AAC3B,mBAA6D;AAC7D,uBAAsC;AAStC,IAAM,QAAiB;AAEvB,wBAAwB,YAAqB;AAC3C,QAAM,CAAC,EAAE,WAAW,2BAAS;AAE7B,QAAM,SAAS,8BAAY,MAAM;AAC/B,YAAQ,CAAC,SAAS,OAAO;AAAA,KACxB;AAEH,SAAO;AAAA;AAiBF,kBACL,IACA,MACA,YACG;AACH,QAAM,OAAO,yBAIV;AAEH,MAAI,CAAC,KAAK,SAAS;AACjB,SAAK,UAAU;AAAA,MACb,MAAM,IAAI,sBAAK;AAAA,MACf,OAAO,4BAAM,MAAM;AACjB,cAAM,MAAK,KAAK,QAAS,KAAK,MAAM;AACpC,eAAO;AAAA;AAAA,MAET;AAAA;AAAA,SAEG;AACL,QAAI,KAAK,WAAW,KAAK,QAAQ,KAAK,QAAQ;AAC5C,WAAK,QAAQ,OAAO;AACpB,WAAK,QAAQ,KAAK,IAAI;AAAA,WACjB;AACL,eAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,YAAI,KAAK,OAAO,KAAK,QAAQ,KAAK,IAAI;AACpC,eAAK,QAAQ,OAAO;AACpB,eAAK,QAAQ,KAAK,IAAI;AACtB;AAAA;AAAA;AAAA;AAAA;AAMR,SAAO,wBAAwB,KAAK,QAAQ,OAAO;AAAA;AAG9C,IAAM,SAAqB,CAAC,GAAoB,eAAwB;AAC7E,SAAO,SAAS,MAAM,0BAAI,IAAI,CAAC,IAAI;AAAA;AAOrC,IAAI,YAAY;AAOhB,IAAM,QAAqB;AAC3B,IAAM,mBAAmB,IAAI;AAsE7B,IAAI,oBAAoB;AAExB,IAAM,cAAc,CAAC,SAAoB;AACvC,eAAa;AACb;AAAA;AAGF,IAAM,eAAe,CAAC,SAAoB;AACxC,MAAI,iBAAiB,IAAI;AAAO;AAChC,mBAAiB,IAAI;AAErB,MAAI,MAAM,WAAW,GAAG;AACtB,UAAM,KAAK;AAAA,SACN;AACL,UAAM,QAAQ,gCACZ,OACA,CAAC,iBAAiB,aAAa,SAAS,KAAK;AAE/C,QAAI,UAAU,IAAI;AAChB,YAAM,KAAK;AAAA,WACN;AACL,YAAM,QAAQ,MAAM;AACpB,UAAI,MAAM,QAAQ,KAAK,OAAO;AAC5B,cAAM,OAAO,OAAO,GAAG;AAAA;AAAA;AAAA;AAAA;AAS/B,IAAM,kBAAkB,CAAC,SAAoB;AAC3C,MAAI,CAAC,iBAAiB,IAAI;AAAO;AACjC,mBAAiB,OAAO;AAExB,QAAM,QAAQ,gCAAU,OAAO,CAAC,MAAM,MAAM;AAC5C,QAAM,OAAO,OAAO;AAAA;AAGtB,yBAAyB;AACvB,MAAI;AAAmB;AACvB,sBAAoB;AAEpB,sCAAe,MAAM;AACnB,kDAAwB,oBAAoB;AAvNhD;AAwNM,aAAO,MAAM,SAAS,GAAG;AACvB,cAAM,OAAO,MAAM;AACnB,yBAAiB,OAAO;AAExB,YAAI;AACJ,YAAI,OAAO;AACT,qBAAK,UAAL,mBAAY,QAAQ,KAAK;AAAA;AAE3B,YAAI;AACF,qBAAW,KAAK,IAAI;AAAA,iBACb,OAAP;AACA,cAAI,OAAO;AACT,uBAAK,UAAL,mBAAY,QAAQ,KAAK;AAAA;AAE3B,kBAAQ,MACN;AAKF,kBAAQ,MAAM;AAEd,eAAK;AAEL;AAAA;AAEF,YAAI,aAAa,KAAK,WAAW;AAC/B,eAAK,YAAY;AACjB,eAAK;AAAA;AAAA;AAIT,0BAAoB;AAAA,OACnB;AAAA;AAAA;AAYA,iCACL,KACA,YACG;AAxQL;AAyQE,QAAM,eAAe,eAAe;AAEpC,QAAM,MAAM,yBAAqB;AAEjC,MAAI,CAAC,IAAI,SAAS;AAChB;AAEA,QAAI,UAAU;AAAA,MACZ,OAAO;AAAA,MACP,WAAW,MAAM;AACf,YAAI,CAAC,IAAI,QAAQ,WAAW;AAC1B;AAAA;AAAA;AAAA,MAGJ;AAAA,MACA,WAAW;AAAA,MACX,WAAW;AAAA,MACX,aAAa,MAAM;AA1RzB;AA2RQ,YAAI,OAAO;AACT,qBAAI,QAAQ,UAAZ,oBAAmB,QAAQ,KAAK;AAAA;AAElC,oBAAY,IAAI;AAAA;AAAA,MAElB,OAAO,IAAI,QAAQ,MAAM;AACvB,YAAI,OAAO;AACT,cAAI,QAAQ,MAAO,QAAQ,KAAK;AAAA;AAElC,YAAI,QAAS;AAAA;AAAA;AAIjB,QAAI,OAAO;AACT,UAAI,QAAQ,QAAQ;AAAA,QAClB,OAAO;AAAA,QACP,wBAAwB,IAAI;AAAA,QAC5B,SAAS;AAAA;AAAA;AAAA;AAKf,MAAI,QAAQ,IAAI,aAAa,cAAc;AACzC,QAAI,QAAQ,IAAI,QAAQ,KAAK;AAC3B,cAAQ,MACN;AAAA;AAAA;AAKN,oCAAgB,MAAM;AACpB,WAAO,qBAAqB;AAC1B,UAAI,QAAQ,YAAY;AACxB,UAAI,QAAQ;AACZ,sBAAgB,IAAI;AAAA;AAAA,KAErB;AAGH,kBAAgB,IAAI;AAEpB,QAAM,WAAW,IAAI,QAAQ,IAAI;AACjC,MAAI,QAAQ,YAAY;AAExB,MAAI,OAAO;AACT,cAAI,QAAQ,UAAZ,mBAAmB,QAAQ,KAAK;AAAA;AAGlC,SAAO;AAAA;AA6DF,0BAA6B,KAAe,YAAwB;AACzE,SAAO,SAAS,MAAM,IAAI,YAAY,CAAC,MAAM;AAAA;AAsCxC,iBAAoB,cAA0B;AACnD,QAAM,MAAM,yBAAgB;AAC5B,MAAI,CAAC,IAAI,SAAS;AAChB,QAAI,UAAU,IAAI,sBAAK;AAAA;AAEzB,SAAO,IAAI;AAAA;",
+  "names": []
+}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.18.11"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@encorejs/react",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Aria Minaei",
+    "email": "aria@theatrejs.com",
+    "url": "https://github.com/AriaMinaei"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ikanishakm/encore",
+    "directory": "packages/react"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "prepack": "node ../../devEnv/ensurePublishing.js",
+    "typecheck": "yarn run build",
+    "build": "run-s build:ts build:js build:api-json",
+    "build:ts": "tsc --build ./tsconfig.json",
+    "build:js": "tsx ./devEnv/build.ts",
+    "build:api-json": "api-extractor run --local --config devEnv/api-extractor.json",
+    "prepublish": "node ../../devEnv/ensurePublishing.js",
+    "clean": "rm -rf ./dist && rm -f tsconfig.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.18.11",
+    "@types/jest": "^26.0.23",
+    "@types/lodash-es": "^4.17.4",
+    "@types/node": "^15.6.2",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "esbuild": "^0.12.15",
+    "npm-run-all": "^4.1.5",
+    "tsx": "4.7.0",
+    "typescript": "5.1.6"
+  },
+  "dependencies": {
+    "@encorejs/dataverse": "1.0.0",
+    "lodash-es": "^4.17.21",
+    "queue-microtask": "^1.2.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
+  }
+}