@tomorrowevening/theatre-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 @@
+# @theatre/react
+
+Utilities for using [Theatre.js](https://www.theatrejs.com) or
+[Dataverse](https://github.com/theatre-js/theatre/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 '@theatre/dataverse'
+import {useVal} from '@theatre/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 '@theatre/dataverse'
+import {useVal} from '@theatre/react'
+
+const pr = prism(() => 'some value')
+
+function Component() {
+  const value = useVal(pr)
+  return <div>{value}</div>
+}
+```
+
+Usage with Theatre.js pointers:
+
+```tsx
+import {useVal} from '@theatre/react'
+import {getProject} from '@theatre/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 '@theatre/dataverse'
+import {usePrism} from '@theatre/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 '@theatre/dataverse'
+import {usePrismInstance} from '@theatre/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 '@theatre/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 '@tomorrowevening/theatre-dataverse';
+import { val, Atom } from '@tomorrowevening/theatre-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 '@tomorrowevening/theatre-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,oBAAoB,CAAA;AAC7C,OAAO,EAAQ,GAAG,EAAE,IAAI,EAAC,MAAM,oBAAoB,CAAA;AAyBnD;;;;;;;;;;;;;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/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tomorrowevening/theatre-react",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Colin Duffy",
+    "email": "colin@tomorrowevening.com",
+    "url": "https://tomorrowevening.com/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tomorrowevening/theatre",
+    "directory": "packages/react"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "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": "^17.0.9",
+    "@types/react-dom": "^17.0.6",
+    "esbuild": "^0.12.15",
+    "npm-run-all": "^4.1.5",
+    "tsx": "4.7.0",
+    "typescript": "5.1.6"
+  },
+  "dependencies": {
+    "@tomorrowevening/theatre-dataverse": "workspace:*",
+    "lodash-es": "^4.17.21",
+    "queue-microtask": "^1.2.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
+  }
+}