@legendapp/state 1.10.2 → 1.11.0

package/index.js

@@ -106,6 +106,7 @@ const globalState = {
     isLoadingLocal: false,
     isLoadingRemote: false,
     isMerging: false,
+    noDepWarn: false,
 };
 function checkActivate(node) {
     var _a;
@@ -500,184 +501,14 @@ function afterBatch(fn) {
     }
 }
 
-function isObservable(obs) {
-    return obs && !!obs[symbolGetNode];
-}
-function isEvent(obs) {
-    var _a;
-    return obs && ((_a = obs[symbolGetNode]) === null || _a === void 0 ? void 0 : _a.isEvent);
-}
-function computeSelector(selector, e, retainObservable) {
-    let c = selector;
-    if (isFunction(c)) {
-        c = e ? c(e) : c();
-    }
-    return isObservable(c) && !retainObservable ? c.get() : c;
-}
-function getObservableIndex(obs) {
-    const node = getNode(obs);
-    const n = +node.key;
-    return n - n < 1 ? +n : -1;
-}
-function opaqueObject(value) {
-    if (value) {
-        value[symbolOpaque] = true;
-    }
-    return value;
-}
-function lockObservable(obs, value) {
-    var _a;
-    const root = (_a = getNode(obs)) === null || _a === void 0 ? void 0 : _a.root;
-    if (root) {
-        root.locked = value;
-    }
-}
-function setAtPath(obj, path, pathTypes, value, fullObj, restore) {
-    let o = obj;
-    let oFull = fullObj;
-    if (path.length > 0) {
-        for (let i = 0; i < path.length; i++) {
-            const p = path[i];
-            if (i === path.length - 1) {
-                // Don't set if the value is the same. This prevents creating a new key
-                // when setting undefined on an object without this key
-                if (o[p] !== value) {
-                    o[p] = value;
-                }
-            }
-            else if (o[p] === symbolDelete) {
-                // If this was previously deleted, restore it
-                if (oFull) {
-                    o[p] = oFull[p];
-                    restore === null || restore === void 0 ? void 0 : restore(path.slice(0, i + 1), o[p]);
-                }
-                break;
-            }
-            else if (o[p] === undefined || o[p] === null) {
-                o[p] = pathTypes[i] === 'array' ? [] : {};
-            }
-            o = o[p];
-            if (oFull) {
-                oFull = oFull[p];
-            }
-        }
-    }
-    else {
-        obj = value;
-    }
-    return obj;
-}
-function setInObservableAtPath(obs, path, value, mode) {
-    let o = obs;
-    let v = value;
-    for (let i = 0; i < path.length; i++) {
-        const p = path[i];
-        o = o[p];
-        v = v[p];
-    }
-    if (v === symbolDelete) {
-        o.delete();
-    }
-    // Assign if possible, or set otherwise
-    else if (mode === 'assign' && o.assign && isObject(o.peek())) {
-        o.assign(v);
-    }
-    else {
-        o.set(v);
-    }
-}
-function mergeIntoObservable(target, ...sources) {
-    beginBatch();
-    globalState.isMerging = true;
-    const value = _mergeIntoObservable(target, ...sources);
-    globalState.isMerging = false;
-    endBatch();
-    return value;
-}
-function _mergeIntoObservable(target, ...sources) {
-    var _a;
-    if (!sources.length)
-        return target;
-    for (let u = 0; u < sources.length; u++) {
-        const source = sources[u];
-        const needsSet = isObservable(target);
-        const targetValue = needsSet ? target.peek() : target;
-        const isTargetArr = isArray(targetValue);
-        const isTargetObj = !isTargetArr && isObject(targetValue);
-        if ((isTargetObj && isObject(source) && !isEmpty(targetValue)) ||
-            (isTargetArr && isArray(source) && targetValue.length > 0)) {
-            for (const key in source) {
-                const sourceValue = source[key];
-                if (sourceValue === symbolDelete) {
-                    needsSet && ((_a = target[key]) === null || _a === void 0 ? void 0 : _a.delete)
-                        ? target[key].delete()
-                        : delete target[key];
-                }
-                else {
-                    const isObj = isObject(sourceValue);
-                    const isArr = !isObj && isArray(sourceValue);
-                    const targetChild = target[key];
-                    if ((isObj || isArr) && targetChild && (needsSet || !isEmpty(targetChild))) {
-                        if (!needsSet && (!targetChild || (isObj ? !isObject(targetChild) : !isArray(targetChild)))) {
-                            target[key] = sourceValue;
-                        }
-                        else {
-                            _mergeIntoObservable(targetChild, sourceValue);
-                        }
-                    }
-                    else {
-                        needsSet
-                            ? targetChild.set(sourceValue)
-                            : (target[key] = sourceValue);
-                    }
-                }
-            }
-        }
-        else if (source !== undefined) {
-            needsSet ? target.set(source) : (target = source);
-        }
-    }
-    return target;
-}
-function constructObjectWithPath(path, value, pathTypes) {
-    let out;
-    if (path.length > 0) {
-        let o = (out = {});
-        for (let i = 0; i < path.length; i++) {
-            const p = path[i];
-            o[p] = i === path.length - 1 ? value : pathTypes[i] === 'array' ? [] : {};
-            o = o[p];
-        }
-    }
-    else {
-        out = value;
-    }
-    return out;
-}
-function deconstructObjectWithPath(path, value) {
-    let o = value;
-    for (let i = 0; i < path.length; i++) {
-        const p = path[i];
-        o = o[p];
-    }
-    return o;
-}
-function isObservableValueReady(value) {
-    return !!value && ((!isObject(value) && !isArray(value)) || !isEmpty(value));
-}
-function setSilently(obs, newValue) {
-    const node = getNode(obs);
-    return setNodeValue(node, newValue).newValue;
-}
-
 function onChange(node, callback, options = {}) {
     const { initial, immediate, noArgs } = options;
     let { trackingType } = options;
     // Temporary migration of string to symbol
     // TODOV2 remove this
     if (trackingType === 'optimize') {
-        if (process.env.NODE_ENV === 'development') {
-            console.log('[legend-state]: "optimize" prop is deprecated and will be removed in the next major version. Please import { optimize } from "@legendapp/state" and use that instead.');
+        if (process.env.NODE_ENV === 'development' && !globalState.noDepWarn) {
+            console.warn('[legend-state]: "optimize" prop is deprecated and will be removed in version 2.0. Please import { optimize } from "@legendapp/state" and use that instead.');
         }
         trackingType = optimized;
     }
@@ -721,65 +552,6 @@ function onChange(node, callback, options = {}) {
     return () => listeners.delete(listener);
 }
 
-function setupTracking(nodes, update, noArgs, immediate) {
-    let listeners = [];
-    // Listen to tracked nodes
-    nodes === null || nodes === void 0 ? void 0 : nodes.forEach((tracked) => {
-        const { node, track } = tracked;
-        listeners.push(onChange(node, update, { trackingType: track, immediate, noArgs }));
-    });
-    return () => {
-        if (listeners) {
-            for (let i = 0; i < listeners.length; i++) {
-                listeners[i]();
-            }
-            listeners = undefined;
-        }
-    };
-}
-
-function trackSelector(selector, update, observeEvent, observeOptions, createResubscribe, inRender) {
-    var _a;
-    let nodes;
-    let value;
-    let dispose;
-    let tracker;
-    let resubscribe;
-    let updateFn = update;
-    let noArgs = true;
-    if (isObservable(selector)) {
-        value = selector.peek();
-        dispose = selector.onChange(update, { noArgs: true });
-        resubscribe = createResubscribe ? selector.onChange(update, { noArgs: true }) : undefined;
-    }
-    else {
-        // Compute the selector inside a tracking context
-        beginTracking(inRender);
-        value = selector ? computeSelector(selector, observeEvent, observeOptions === null || observeOptions === void 0 ? void 0 : observeOptions.retainObservable) : selector;
-        tracker = tracking.current;
-        nodes = tracker.nodes;
-        endTracking(inRender);
-        if ((process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') && tracker && nodes) {
-            (_a = tracker.traceListeners) === null || _a === void 0 ? void 0 : _a.call(tracker, nodes);
-            if (tracker.traceUpdates) {
-                noArgs = false;
-                updateFn = tracker.traceUpdates(update);
-            }
-            // Clear tracing so it doesn't leak to other components
-            tracker.traceListeners = undefined;
-            tracker.traceUpdates = undefined;
-        }
-    }
-    if (!(observeEvent === null || observeEvent === void 0 ? void 0 : observeEvent.cancel)) {
-        // Do tracing if it was requested
-        // useSyncExternalStore doesn't subscribe until after the component mount.
-        // We want to subscribe immediately so we don't miss any updates
-        dispose = setupTracking(nodes, updateFn, noArgs, observeOptions === null || observeOptions === void 0 ? void 0 : observeOptions.immediate);
-        resubscribe = createResubscribe ? () => setupTracking(nodes, updateFn, noArgs) : undefined;
-    }
-    return { value, dispose, resubscribe };
-}
-
 const ArrayModifiers = new Set([
     'copyWithin',
     'fill',
@@ -1388,29 +1160,199 @@ function updateNodesAndNotify(node, newValue, prevValue, childNode, isPrim, isRo
     endBatch();
 }
 
-const fns = ['get', 'set', 'peek', 'onChange', 'toggle'];
-function ObservablePrimitiveClass(node) {
-    this._node = node;
-    // Bind to this
-    for (let i = 0; i < fns.length; i++) {
-        const key = fns[i];
-        this[key] = this[key].bind(this);
-    }
+function isObservable(obs) {
+    return obs && !!obs[symbolGetNode];
 }
-// Add observable functions to prototype
-function proto(key, fn) {
-    ObservablePrimitiveClass.prototype[key] = function (...args) {
-        return fn.call(this, this._node, ...args);
-    };
+function isEvent(obs) {
+    var _a;
+    return obs && ((_a = obs[symbolGetNode]) === null || _a === void 0 ? void 0 : _a.isEvent);
 }
-proto('peek', peek);
-proto('get', get);
-proto('set', set);
-proto('onChange', onChange);
-// Getters
-Object.defineProperty(ObservablePrimitiveClass.prototype, symbolGetNode, {
-    configurable: true,
-    get() {
+function computeSelector(selector, e, retainObservable) {
+    let c = selector;
+    if (isFunction(c)) {
+        c = e ? c(e) : c();
+    }
+    return isObservable(c) && !retainObservable ? c.get() : c;
+}
+function getObservableIndex(obs) {
+    const node = getNode(obs);
+    const n = +node.key;
+    return n - n < 1 ? +n : -1;
+}
+function opaqueObject(value) {
+    if (value) {
+        value[symbolOpaque] = true;
+    }
+    return value;
+}
+function lockObservable(obs, value) {
+    var _a;
+    const root = (_a = getNode(obs)) === null || _a === void 0 ? void 0 : _a.root;
+    if (root) {
+        root.locked = value;
+    }
+}
+function setAtPath(obj, path, pathTypes, value, fullObj, restore) {
+    let o = obj;
+    let oFull = fullObj;
+    if (path.length > 0) {
+        for (let i = 0; i < path.length; i++) {
+            const p = path[i];
+            if (i === path.length - 1) {
+                // Don't set if the value is the same. This prevents creating a new key
+                // when setting undefined on an object without this key
+                if (o[p] !== value) {
+                    o[p] = value;
+                }
+            }
+            else if (o[p] === symbolDelete) {
+                // If this was previously deleted, restore it
+                if (oFull) {
+                    o[p] = oFull[p];
+                    restore === null || restore === void 0 ? void 0 : restore(path.slice(0, i + 1), o[p]);
+                }
+                break;
+            }
+            else if (o[p] === undefined || o[p] === null) {
+                o[p] = pathTypes[i] === 'array' ? [] : {};
+            }
+            o = o[p];
+            if (oFull) {
+                oFull = oFull[p];
+            }
+        }
+    }
+    else {
+        obj = value;
+    }
+    return obj;
+}
+function setInObservableAtPath(obs, path, value, mode) {
+    let o = obs;
+    let v = value;
+    for (let i = 0; i < path.length; i++) {
+        const p = path[i];
+        o = o[p];
+        v = v[p];
+    }
+    if (v === symbolDelete) {
+        o.delete();
+    }
+    // Assign if possible, or set otherwise
+    else if (mode === 'assign' && o.assign && isObject(o.peek())) {
+        o.assign(v);
+    }
+    else {
+        o.set(v);
+    }
+}
+function mergeIntoObservable(target, ...sources) {
+    beginBatch();
+    globalState.isMerging = true;
+    const value = _mergeIntoObservable(target, ...sources);
+    globalState.isMerging = false;
+    endBatch();
+    return value;
+}
+function _mergeIntoObservable(target, ...sources) {
+    var _a;
+    if (!sources.length)
+        return target;
+    for (let u = 0; u < sources.length; u++) {
+        const source = sources[u];
+        const needsSet = isObservable(target);
+        const targetValue = needsSet ? target.peek() : target;
+        const isTargetArr = isArray(targetValue);
+        const isTargetObj = !isTargetArr && isObject(targetValue);
+        if ((isTargetObj && isObject(source) && !isEmpty(targetValue)) ||
+            (isTargetArr && isArray(source) && targetValue.length > 0)) {
+            for (const key in source) {
+                const sourceValue = source[key];
+                if (sourceValue === symbolDelete) {
+                    needsSet && ((_a = target[key]) === null || _a === void 0 ? void 0 : _a.delete)
+                        ? target[key].delete()
+                        : delete target[key];
+                }
+                else {
+                    const isObj = isObject(sourceValue);
+                    const isArr = !isObj && isArray(sourceValue);
+                    const targetChild = target[key];
+                    if ((isObj || isArr) && targetChild && (needsSet || !isEmpty(targetChild))) {
+                        if (!needsSet && (!targetChild || (isObj ? !isObject(targetChild) : !isArray(targetChild)))) {
+                            target[key] = sourceValue;
+                        }
+                        else {
+                            _mergeIntoObservable(targetChild, sourceValue);
+                        }
+                    }
+                    else {
+                        needsSet
+                            ? targetChild.set(sourceValue)
+                            : (target[key] = sourceValue);
+                    }
+                }
+            }
+        }
+        else if (source !== undefined) {
+            needsSet ? target.set(source) : (target = source);
+        }
+    }
+    return target;
+}
+function constructObjectWithPath(path, value, pathTypes) {
+    let out;
+    if (path.length > 0) {
+        let o = (out = {});
+        for (let i = 0; i < path.length; i++) {
+            const p = path[i];
+            o[p] = i === path.length - 1 ? value : pathTypes[i] === 'array' ? [] : {};
+            o = o[p];
+        }
+    }
+    else {
+        out = value;
+    }
+    return out;
+}
+function deconstructObjectWithPath(path, value) {
+    let o = value;
+    for (let i = 0; i < path.length; i++) {
+        const p = path[i];
+        o = o[p];
+    }
+    return o;
+}
+function isObservableValueReady(value) {
+    return !!value && ((!isObject(value) && !isArray(value)) || !isEmpty(value));
+}
+function setSilently(obs, newValue) {
+    const node = getNode(obs);
+    return setNodeValue(node, newValue).newValue;
+}
+
+const fns = ['get', 'set', 'peek', 'onChange', 'toggle'];
+function ObservablePrimitiveClass(node) {
+    this._node = node;
+    // Bind to this
+    for (let i = 0; i < fns.length; i++) {
+        const key = fns[i];
+        this[key] = this[key].bind(this);
+    }
+}
+// Add observable functions to prototype
+function proto(key, fn) {
+    ObservablePrimitiveClass.prototype[key] = function (...args) {
+        return fn.call(this, this._node, ...args);
+    };
+}
+proto('peek', peek);
+proto('get', get);
+proto('set', set);
+proto('onChange', onChange);
+// Getters
+Object.defineProperty(ObservablePrimitiveClass.prototype, symbolGetNode, {
+    configurable: true,
+    get() {
         return this._node;
     },
 });
@@ -1466,6 +1408,65 @@ function observablePrimitive(value) {
     return createObservable(value, /*makePrimitive*/ true);
 }
 
+function setupTracking(nodes, update, noArgs, immediate) {
+    let listeners = [];
+    // Listen to tracked nodes
+    nodes === null || nodes === void 0 ? void 0 : nodes.forEach((tracked) => {
+        const { node, track } = tracked;
+        listeners.push(onChange(node, update, { trackingType: track, immediate, noArgs }));
+    });
+    return () => {
+        if (listeners) {
+            for (let i = 0; i < listeners.length; i++) {
+                listeners[i]();
+            }
+            listeners = undefined;
+        }
+    };
+}
+
+function trackSelector(selector, update, observeEvent, observeOptions, createResubscribe, inRender) {
+    var _a;
+    let nodes;
+    let value;
+    let dispose;
+    let tracker;
+    let resubscribe;
+    let updateFn = update;
+    let noArgs = true;
+    if (isObservable(selector)) {
+        value = selector.peek();
+        dispose = selector.onChange(update, { noArgs: true });
+        resubscribe = createResubscribe ? selector.onChange(update, { noArgs: true }) : undefined;
+    }
+    else {
+        // Compute the selector inside a tracking context
+        beginTracking(inRender);
+        value = selector ? computeSelector(selector, observeEvent, observeOptions === null || observeOptions === void 0 ? void 0 : observeOptions.retainObservable) : selector;
+        tracker = tracking.current;
+        nodes = tracker.nodes;
+        endTracking(inRender);
+        if ((process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') && tracker && nodes) {
+            (_a = tracker.traceListeners) === null || _a === void 0 ? void 0 : _a.call(tracker, nodes);
+            if (tracker.traceUpdates) {
+                noArgs = false;
+                updateFn = tracker.traceUpdates(update);
+            }
+            // Clear tracing so it doesn't leak to other components
+            tracker.traceListeners = undefined;
+            tracker.traceUpdates = undefined;
+        }
+    }
+    if (!(observeEvent === null || observeEvent === void 0 ? void 0 : observeEvent.cancel)) {
+        // Do tracing if it was requested
+        // useSyncExternalStore doesn't subscribe until after the component mount.
+        // We want to subscribe immediately so we don't miss any updates
+        dispose = setupTracking(nodes, updateFn, noArgs, observeOptions === null || observeOptions === void 0 ? void 0 : observeOptions.immediate);
+        resubscribe = createResubscribe ? () => setupTracking(nodes, updateFn, noArgs) : undefined;
+    }
+    return { value, dispose, resubscribe };
+}
+
 function observe(selectorOrRun, reactionOrOptions, options) {
     let reaction;
     if (isFunction(reactionOrOptions)) {
@@ -1600,6 +1601,33 @@ function computed(compute, set$1) {
     return obs;
 }
 
+function configureLegendState({ observableFunctions, observableProperties: observableProperties$1, }) {
+    if (observableFunctions) {
+        for (const key in observableFunctions) {
+            const fn = observableFunctions[key];
+            observableFns.set(key, fn);
+            ObservablePrimitiveClass.prototype[key] = function (...args) {
+                return fn.call(this, this._node, ...args);
+            };
+        }
+    }
+    if (observableProperties$1) {
+        for (const key in observableProperties$1) {
+            const fns = observableProperties$1[key];
+            observableProperties.set(key, fns);
+            Object.defineProperty(ObservablePrimitiveClass.prototype, key, {
+                configurable: true,
+                get() {
+                    return fns.get.call(this, this._node);
+                },
+                set(value) {
+                    return fns.set.call(this, this._node, value);
+                },
+            });
+        }
+    }
+}
+
 function event() {
     // event simply wraps around a number observable
     // which increments its value to dispatch change events
@@ -1696,33 +1724,6 @@ function whenReady(predicate, effect) {
     return _when(predicate, effect, true);
 }
 
-function configureLegendState({ observableFunctions, observableProperties: observableProperties$1, }) {
-    if (observableFunctions) {
-        for (const key in observableFunctions) {
-            const fn = observableFunctions[key];
-            observableFns.set(key, fn);
-            ObservablePrimitiveClass.prototype[key] = function (...args) {
-                return fn.call(this, this._node, ...args);
-            };
-        }
-    }
-    if (observableProperties$1) {
-        for (const key in observableProperties$1) {
-            const fns = observableProperties$1[key];
-            observableProperties.set(key, fns);
-            Object.defineProperty(ObservablePrimitiveClass.prototype, key, {
-                configurable: true,
-                get() {
-                    return fns.get.call(this, this._node);
-                },
-                set(value) {
-                    return fns.set.call(this, this._node, value);
-                },
-            });
-        }
-    }
-}
-
 const internal = {
     ensureNodeValue,
     findIDKey,