@legendapp/state 3.0.0-alpha.6 → 3.0.0-alpha.8

package/LICENSE

@@ -1 +1,21 @@
-LICENSE
+MIT License
+
+Copyright (c) 2022 Moo.do LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,141 @@
-README.md
+# Legend-State
+
+Legend-State is a super fast all-in-one state and sync library that lets you write less code to make faster apps. Legend-State has four primary goals:
+
+### 1. 🦄 As easy as possible to use
+
+There is no boilerplate and there are no contexts, actions, reducers, dispatchers, sagas, thunks, or epics. It doesn't modify your data at all, and you can just call `get()` to get the raw data and `set()` to change it.
+
+In React components you can call `use()` on any observable to get the raw data and automatically re-render whenever it changes.
+
+```jsx
+import { observable, observe } from "@legendapp/state"
+import { observer } from "@legendapp/state/react"
+
+const settings$ = observable({ theme: 'dark' })
+
+// get returns the raw data
+settings$.theme.get() // 'dark'
+// set sets
+settings$.theme.set('light')
+
+// Computed observables with just a function
+const isDark$ = observable(() => settings$.theme.get() === 'dark')
+
+// observing contexts re-run when tracked observables change
+observe(() => {
+  console.log(settings$.theme.get())
+})
+
+const Component = observer(function Component() {
+    const theme = state$.settings.theme.get()
+
+    return <div>Theme: {theme}</div>
+})
+```
+
+### 2. ⚡️ The fastest React state library
+
+Legend-State beats every other state library on just about every metric and is so optimized for arrays that it even beats vanilla JS on the "swap" and "replace all rows" benchmarks. At only `4kb` and with the massive reduction in boilerplate code, you'll have big savings in file size too.
+
+<p>
+    <img src="https://www.legendapp.com/img/dev/state/times.png" />
+</p>
+
+See [Fast 🔥](https://www.legendapp.com/open-source/state/v3/intro/fast/) for more details of why Legend-State is so fast.
+
+### 3. 🔥 Fine-grained reactivity for minimal renders
+
+Legend-State lets you make your renders super fine-grained, so your apps will be much faster because React has to do less work. The best way to be fast is to render less, less often.
+
+```jsx
+function FineGrained() {
+    const count$ = useObservable(0)
+
+    useInterval(() => {
+        count$.set(v => v + 1)
+    }, 600)
+
+    // The text updates itself so the component doesn't re-render
+    return (
+        <div>
+            Count: <Memo>{count$}</Memo>
+        </div>
+    )
+}
+```
+
+### 4. 💾 Powerful sync and persistence
+
+Legend-State includes a powerful [sync and persistence system](../../usage/persist-sync). It easily enables local-first apps by optimistically applying all changes locally first, retrying changes even after restart until they eventually sync, and syncing minimal diffs. We use Legend-State as the sync systems in [Legend](https://legendapp.com) and [Bravely](https://bravely.io), so it is by necessity very full featured while being simple to set up.
+
+Local persistence plugins for the browser and React Native are included, with sync plugins for [Keel](https://www.keel.so), [Supabase](https://www.supabase.com), [TanStack Query](https://tanstack.com/query), and `fetch`.
+
+```js
+const state$ = observable(
+    users: syncedKeel({
+        list: queries.getUsers,
+        create: mutations.createUsers,
+        update: mutations.updateUsers,
+        delete: mutations.deleteUsers,
+        persist: { name: 'users', retrySync: true },
+        debounceSet: 500,
+        retry: {
+            infinite: true,
+        },
+        changesSince: 'last-sync',
+    }),
+    // direct link to my user within the users observable
+    me: () => state$.users['myuid']
+)
+
+observe(() => {
+    // get() activates through to state$.users and starts syncing.
+    // it updates itself and re-runs observers when name changes
+    const name = me$.name.get()
+})
+
+// Setting a value goes through to state$.users and saves update to server
+me$.name.set('Annyong')
+```
+
+## Install
+
+`bun add @legendapp/state` or `npm install @legendapp/state` or `yarn add @legendapp/state`
+
+## Highlights
+
+- ✨ Super easy to use 😌
+- ✨ Super fast ⚡️
+- ✨ Super small at 4kb 🐥
+- ✨ Fine-grained reactivity 🔥
+- ✨ No boilerplate
+- ✨ Designed for maximum performance and scalability
+- ✨ React components re-render only on changes
+- ✨ Very strongly typed with TypeScript
+- ✨ Persistence plugins for automatically saving/loading from storage
+- ✨ State can be global or within components
+
+[Read more](https://www.legendapp.com/open-source/state/v3/intro/why/) about why Legend-State might be right for you.
+
+## Documentation
+
+See [the documentation site](https://www.legendapp.com/open-source/state/).
+
+## Community
+
+Join us on [Discord](https://discord.gg/5CBaNtADNX) to get involved with the Legend community.
+
+## 👩‍⚖️ License
+
+[MIT](LICENSE)
+
+---
+
+Legend-State is created and maintained by [Jay Meistrich](https://github.com/jmeistrich) with [Legend](https://www.legendapp.com) and [Bravely](https://www.bravely.io).
+
+<p>
+    <a href="https://www.legendapp.com"><img src="https://www.legendapp.com/img/LogoTextOnWhite.png" height="56" alt="Legend" /></a>
+    <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
+    <a href="https://www.bravely.io"><img src="https://www.legendapp.com/img/bravely-logo.png" height="56" alt="Bravely" /></a>
+</p>

package/babel.js

@@ -15,7 +15,6 @@ function babel_default() {
               const s = specifiers[i].imported.name;
               if (!hasLegendImport && (s === "Computed" || s === "Memo" || s === "Show")) {
                 hasLegendImport = true;
-                path.skip();
                 break;
               }
             }
@@ -25,7 +24,6 @@ function babel_default() {
       JSXElement: {
         enter(path) {
           if (!hasLegendImport) {
-            path.skip();
             return;
           }
           const openingElement = path.node.openingElement;

package/babel.mjs

@@ -13,7 +13,6 @@ function babel_default() {
               const s = specifiers[i].imported.name;
               if (!hasLegendImport && (s === "Computed" || s === "Memo" || s === "Show")) {
                 hasLegendImport = true;
-                path.skip();
                 break;
               }
             }
@@ -23,7 +22,6 @@ function babel_default() {
       JSXElement: {
         enter(path) {
           if (!hasLegendImport) {
-            path.skip();
             return;
           }
           const openingElement = path.node.openingElement;

package/index.js

@@ -2038,7 +2038,7 @@ function setToObservable(node, value) {
   return value;
 }
 function recursivelyAutoActivate(obj, node) {
-  if (isObject(obj) || isArray(obj)) {
+  if ((isObject(obj) || isArray(obj)) && !obj[symbolOpaque]) {
     const pathStack = [];
     const getNodeAtPath2 = () => {
       var _a;
@@ -2056,27 +2056,29 @@ function recursivelyAutoActivate(obj, node) {
 }
 function recursivelyAutoActivateInner(obj, pathStack, getNodeAtPath2) {
   var _a;
-  for (const key in obj) {
-    if (hasOwnProperty.call(obj, key)) {
-      const value = obj[key];
-      if (isObservable(value)) {
-        const childNode = getNodeAtPath2();
-        extractFunctionOrComputed(childNode, key, value);
-        delete childNode.lazy;
-      } else {
-        const linkedOptions = isFunction(value) && ((_a = value.prototype) == null ? void 0 : _a[symbolLinked]);
-        if (linkedOptions) {
-          const activate = linkedOptions.activate;
-          if (!activate || activate === "auto") {
-            const childNode = getNodeAtPath2();
-            peek(getChildNode(childNode, key, value));
+  if ((isObject(obj) || isArray(obj)) && !obj[symbolOpaque]) {
+    for (const key in obj) {
+      if (hasOwnProperty.call(obj, key)) {
+        const value = obj[key];
+        if (isObservable(value)) {
+          const childNode = getNodeAtPath2();
+          extractFunctionOrComputed(childNode, key, value);
+          delete childNode.lazy;
+        } else {
+          const linkedOptions = isFunction(value) && ((_a = value.prototype) == null ? void 0 : _a[symbolLinked]);
+          if (linkedOptions) {
+            const activate = linkedOptions.activate;
+            if (!activate || activate === "auto") {
+              const childNode = getNodeAtPath2();
+              peek(getChildNode(childNode, key, value));
+            }
           }
         }
-      }
-      if (typeof value === "object") {
-        pathStack.push({ key, value });
-        recursivelyAutoActivateInner(value, pathStack, getNodeAtPath2);
-        pathStack.pop();
+        if (typeof value === "object") {
+          pathStack.push({ key, value });
+          recursivelyAutoActivateInner(value, pathStack, getNodeAtPath2);
+          pathStack.pop();
+        }
       }
     }
   }

package/index.mjs

@@ -2036,7 +2036,7 @@ function setToObservable(node, value) {
   return value;
 }
 function recursivelyAutoActivate(obj, node) {
-  if (isObject(obj) || isArray(obj)) {
+  if ((isObject(obj) || isArray(obj)) && !obj[symbolOpaque]) {
     const pathStack = [];
     const getNodeAtPath2 = () => {
       var _a;
@@ -2054,27 +2054,29 @@ function recursivelyAutoActivate(obj, node) {
 }
 function recursivelyAutoActivateInner(obj, pathStack, getNodeAtPath2) {
   var _a;
-  for (const key in obj) {
-    if (hasOwnProperty.call(obj, key)) {
-      const value = obj[key];
-      if (isObservable(value)) {
-        const childNode = getNodeAtPath2();
-        extractFunctionOrComputed(childNode, key, value);
-        delete childNode.lazy;
-      } else {
-        const linkedOptions = isFunction(value) && ((_a = value.prototype) == null ? void 0 : _a[symbolLinked]);
-        if (linkedOptions) {
-          const activate = linkedOptions.activate;
-          if (!activate || activate === "auto") {
-            const childNode = getNodeAtPath2();
-            peek(getChildNode(childNode, key, value));
+  if ((isObject(obj) || isArray(obj)) && !obj[symbolOpaque]) {
+    for (const key in obj) {
+      if (hasOwnProperty.call(obj, key)) {
+        const value = obj[key];
+        if (isObservable(value)) {
+          const childNode = getNodeAtPath2();
+          extractFunctionOrComputed(childNode, key, value);
+          delete childNode.lazy;
+        } else {
+          const linkedOptions = isFunction(value) && ((_a = value.prototype) == null ? void 0 : _a[symbolLinked]);
+          if (linkedOptions) {
+            const activate = linkedOptions.activate;
+            if (!activate || activate === "auto") {
+              const childNode = getNodeAtPath2();
+              peek(getChildNode(childNode, key, value));
+            }
           }
         }
-      }
-      if (typeof value === "object") {
-        pathStack.push({ key, value });
-        recursivelyAutoActivateInner(value, pathStack, getNodeAtPath2);
-        pathStack.pop();
+        if (typeof value === "object") {
+          pathStack.push({ key, value });
+          recursivelyAutoActivateInner(value, pathStack, getNodeAtPath2);
+          pathStack.pop();
+        }
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legendapp/state",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-alpha.8",
   "description": "legend-state",
   "sideEffects": false,
   "private": false,

package/sync.js

@@ -484,21 +484,24 @@ async function doChangeLocal(changeInfo) {
   const { value$: obs, syncState, localState, syncOptions } = queuedChange;
   const { pluginPersist } = localState;
   const persist = syncOptions.persist;
-  const { table, config: configLocal } = parseLocalConfig(persist);
-  const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
-  if (saveRemote && shouldSaveMetadata) {
-    await updateMetadataImmediate(obs, localState, syncState, syncOptions, {
-      pending: localState.pendingChanges
-    });
-  }
-  if (changesLocal.length > 0) {
-    let promiseSet = pluginPersist.set(table, changesLocal, configLocal);
-    if (promiseSet) {
-      promiseSet = promiseSet.then(() => {
-        promisesLocalSaves.delete(promiseSet);
+  const saveLocal = !!(persist == null ? void 0 : persist.name);
+  if (saveLocal) {
+    const { table, config: configLocal } = parseLocalConfig(persist);
+    const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
+    if (saveRemote && shouldSaveMetadata) {
+      await updateMetadataImmediate(obs, localState, syncState, syncOptions, {
+        pending: localState.pendingChanges
       });
-      promisesLocalSaves.add(promiseSet);
-      await promiseSet;
+    }
+    if (changesLocal.length > 0) {
+      let promiseSet = pluginPersist.set(table, changesLocal, configLocal);
+      if (promiseSet) {
+        promiseSet = promiseSet.then(() => {
+          promisesLocalSaves.delete(promiseSet);
+        });
+        promisesLocalSaves.add(promiseSet);
+        await promiseSet;
+      }
     }
   }
 }
@@ -513,6 +516,7 @@ async function doChangeRemote(changeInfo) {
   const { table, config: configLocal } = parseLocalConfig(persist);
   const { allowSetIfGetError, onBeforeSet, onSetError, waitForSet, onAfterSet } = syncOptions || {};
   const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
+  const saveLocal = !!(persist == null ? void 0 : persist.name);
   if (changesRemote.length > 0) {
     await state.when(() => syncState.isLoaded.get() || allowSetIfGetError && syncState.error.get());
     if (waitForSet) {
@@ -547,7 +551,7 @@ async function doChangeRemote(changeInfo) {
       if (pathStrs.length > 0) {
         let transformedChanges = void 0;
         const metadata = {};
-        if (persist) {
+        if (saveLocal) {
           const pendingMetadata = (_b = pluginPersist.getMetadata(table, configLocal)) == null ? void 0 : _b.pending;
           const pending = localState.pendingChanges;
           for (let i = 0; i < pathStrs.length; i++) {
@@ -584,7 +588,7 @@ async function doChangeRemote(changeInfo) {
             }
             onChangeRemote(() => state.mergeIntoObservable(obs, ...allChanges));
           }
-          if (persist) {
+          if (saveLocal) {
             if (shouldSaveMetadata && !state.isEmpty(metadata)) {
               updateMetadata(obs, localState, syncState, syncOptions, metadata);
             }
@@ -618,10 +622,11 @@ function onObsChange(value$, syncState, localState, syncOptions, { changes, load
 async function loadLocal(value$, syncOptions, syncState, localState) {
   var _a, _b, _c;
   const { persist } = syncOptions;
-  if (persist) {
+  const node = getNode(value$);
+  const nodeValue = getNodeValue(getNode(node.state));
+  if (persist == null ? void 0 : persist.name) {
     const PersistPlugin = persist.plugin || ((_a = observableSyncConfiguration.persist) == null ? void 0 : _a.plugin);
     const { table, config } = parseLocalConfig(persist);
-    const node = getNode(value$);
     if (!PersistPlugin) {
       throw new Error("Local persist is not configured");
     }
@@ -673,10 +678,13 @@ async function loadLocal(value$, syncOptions, syncState, localState) {
       }
       state.internal.globalState.isLoadingLocal = false;
     }
-    getNodeValue(getNode(node.state)).clearPersist = () => Promise.all([
+    nodeValue.clearPersist = () => Promise.all([
       persistPlugin.deleteTable(table, config),
       persistPlugin.deleteMetadata(table, config)
     ]);
+  } else {
+    nodeValue.clearPersist = () => {
+    };
   }
   syncState.isPersistLoaded.set(true);
 }

package/sync.mjs

@@ -482,21 +482,24 @@ async function doChangeLocal(changeInfo) {
   const { value$: obs, syncState, localState, syncOptions } = queuedChange;
   const { pluginPersist } = localState;
   const persist = syncOptions.persist;
-  const { table, config: configLocal } = parseLocalConfig(persist);
-  const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
-  if (saveRemote && shouldSaveMetadata) {
-    await updateMetadataImmediate(obs, localState, syncState, syncOptions, {
-      pending: localState.pendingChanges
-    });
-  }
-  if (changesLocal.length > 0) {
-    let promiseSet = pluginPersist.set(table, changesLocal, configLocal);
-    if (promiseSet) {
-      promiseSet = promiseSet.then(() => {
-        promisesLocalSaves.delete(promiseSet);
+  const saveLocal = !!(persist == null ? void 0 : persist.name);
+  if (saveLocal) {
+    const { table, config: configLocal } = parseLocalConfig(persist);
+    const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
+    if (saveRemote && shouldSaveMetadata) {
+      await updateMetadataImmediate(obs, localState, syncState, syncOptions, {
+        pending: localState.pendingChanges
       });
-      promisesLocalSaves.add(promiseSet);
-      await promiseSet;
+    }
+    if (changesLocal.length > 0) {
+      let promiseSet = pluginPersist.set(table, changesLocal, configLocal);
+      if (promiseSet) {
+        promiseSet = promiseSet.then(() => {
+          promisesLocalSaves.delete(promiseSet);
+        });
+        promisesLocalSaves.add(promiseSet);
+        await promiseSet;
+      }
     }
   }
 }
@@ -511,6 +514,7 @@ async function doChangeRemote(changeInfo) {
   const { table, config: configLocal } = parseLocalConfig(persist);
   const { allowSetIfGetError, onBeforeSet, onSetError, waitForSet, onAfterSet } = syncOptions || {};
   const shouldSaveMetadata = persist == null ? void 0 : persist.retrySync;
+  const saveLocal = !!(persist == null ? void 0 : persist.name);
   if (changesRemote.length > 0) {
     await when(() => syncState.isLoaded.get() || allowSetIfGetError && syncState.error.get());
     if (waitForSet) {
@@ -545,7 +549,7 @@ async function doChangeRemote(changeInfo) {
       if (pathStrs.length > 0) {
         let transformedChanges = void 0;
         const metadata = {};
-        if (persist) {
+        if (saveLocal) {
           const pendingMetadata = (_b = pluginPersist.getMetadata(table, configLocal)) == null ? void 0 : _b.pending;
           const pending = localState.pendingChanges;
           for (let i = 0; i < pathStrs.length; i++) {
@@ -582,7 +586,7 @@ async function doChangeRemote(changeInfo) {
             }
             onChangeRemote(() => mergeIntoObservable(obs, ...allChanges));
           }
-          if (persist) {
+          if (saveLocal) {
             if (shouldSaveMetadata && !isEmpty(metadata)) {
               updateMetadata(obs, localState, syncState, syncOptions, metadata);
             }
@@ -616,10 +620,11 @@ function onObsChange(value$, syncState, localState, syncOptions, { changes, load
 async function loadLocal(value$, syncOptions, syncState, localState) {
   var _a, _b, _c;
   const { persist } = syncOptions;
-  if (persist) {
+  const node = getNode(value$);
+  const nodeValue = getNodeValue(getNode(node.state));
+  if (persist == null ? void 0 : persist.name) {
     const PersistPlugin = persist.plugin || ((_a = observableSyncConfiguration.persist) == null ? void 0 : _a.plugin);
     const { table, config } = parseLocalConfig(persist);
-    const node = getNode(value$);
     if (!PersistPlugin) {
       throw new Error("Local persist is not configured");
     }
@@ -671,10 +676,13 @@ async function loadLocal(value$, syncOptions, syncState, localState) {
       }
       internal.globalState.isLoadingLocal = false;
     }
-    getNodeValue(getNode(node.state)).clearPersist = () => Promise.all([
+    nodeValue.clearPersist = () => Promise.all([
       persistPlugin.deleteTable(table, config),
       persistPlugin.deleteMetadata(table, config)
     ]);
+  } else {
+    nodeValue.clearPersist = () => {
+    };
   }
   syncState.isPersistLoaded.set(true);
 }

package/types/babel.d.ts

@@ -1 +1,12 @@
-src/types/babel.d.ts
+import type { ObservableParam } from '@legendapp/state';
+import { ReactNode } from 'react';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { Computed, Memo } from '@legendapp/state/react';
+declare module '@legendapp/state/react' {
+    export declare const Computed: (props: {
+        children: ObservableParam | (() => ReactNode) | ReactNode;
+    }) => React.ReactElement;
+    export declare const Memo: (props: {
+        children: ObservableParam | (() => ReactNode) | ReactNode;
+    }) => React.ReactElement;
+}