@legendapp/state 3.0.0-beta.3 → 3.0.0-beta.31

package/react.js

@@ -45,6 +45,7 @@ function createSelectorFunctions(options, isPaused$) {
     } = state.trackSelector(
       _selector,
       _update,
+      options,
       void 0,
       void 0,
       /*createResubscribe*/
@@ -100,12 +101,24 @@ function createSelectorFunctions(options, isPaused$) {
     }
   };
 }
+function doSuspense(selector) {
+  const vProm = state.when(selector);
+  if (React__default.default.use) {
+    React__default.default.use(vProm);
+  } else {
+    throw vProm;
+  }
+}
 function useSelector(selector, options) {
   var _a;
+  let value;
   if (reactGlobals.inObserver && state.isObservable(selector) && !(options == null ? void 0 : options.suspense)) {
-    return state.computeSelector(selector);
+    value = state.computeSelector(selector, options);
+    if ((options == null ? void 0 : options.suspense) && value === void 0) {
+      doSuspense(selector);
+    }
+    return value;
   }
-  let value;
   try {
     const isPaused$ = React.useContext(getPauseContext());
     const selectorFn = React.useMemo(() => createSelectorFunctions(options, isPaused$), []);
@@ -120,16 +133,8 @@ function useSelector(selector, options) {
     }
     throw err;
   }
-  if (options == null ? void 0 : options.suspense) {
-    const isProm = state.isPromise(value);
-    if (state.isPromise(value) || !value && state.isObservable(selector)) {
-      const vProm = isProm ? value : state.when(selector);
-      if (React__default.default.use) {
-        React__default.default.use(vProm);
-      } else {
-        throw vProm;
-      }
-    }
+  if ((options == null ? void 0 : options.suspense) && value === void 0) {
+    doSuspense(selector);
   }
   return value;
 }
@@ -140,7 +145,7 @@ function Computed({ children }) {
 }
 var hasSymbol = typeof Symbol === "function" && Symbol.for;
 var didWarnProps = false;
-function createReactiveComponent(component, observe3, reactive2, bindKeys) {
+function createReactiveComponent(component, observe3, reactive2, keysReactive, bindKeys) {
   const ReactForwardRefSymbol = hasSymbol ? Symbol.for("react.forward_ref") : (
     // eslint-disable-next-line react/display-name, @typescript-eslint/no-unused-vars
     typeof React.forwardRef === "function" && React.forwardRef((props) => null)["$$typeof"]
@@ -165,6 +170,7 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
       throw new Error(`[legend-state] \`render\` property of ForwardRef was not a function`);
     }
   }
+  const keysReactiveSet = keysReactive ? new Set(keysReactive) : void 0;
   const proxyHandler = {
     apply(target, thisArg, argArray) {
       if (reactive2) {
@@ -174,9 +180,10 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
         for (let i = 0; i < keys.length; i++) {
           const key = keys[i];
           const p = props[key];
+          const isReactiveKey = keysReactiveSet && keysReactiveSet.has(key);
           if (key === "children" && (state.isFunction(p) || state.isObservable(p))) {
             props[key] = useSelector(p, { skipCheck: true });
-          } else if (key.startsWith("$") || key.endsWith("$")) {
+          } else if (isReactiveKey || key.startsWith("$") || key.endsWith("$")) {
             if (process.env.NODE_ENV === "development" && !didWarnProps && key.endsWith("$")) {
               didWarnProps = true;
               console.warn(
@@ -186,7 +193,7 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
                 )}. See https://legendapp.com/open-source/state/migrating for more details.`
               );
             }
-            const k = key.endsWith("$") ? key.slice(0, -1) : key.slice(1);
+            const k = isReactiveKey ? key : key.endsWith("$") ? key.slice(0, -1) : key.slice(1);
             const bind = bindKeys == null ? void 0 : bindKeys[k];
             const shouldBind = bind && state.isObservable(p);
             propsOut[k] = shouldBind && (bind == null ? void 0 : bind.selector) ? bind.selector(propsOut, p) : useSelector(p);
@@ -204,7 +211,9 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
                 process.env.NODE_ENV === "development" ? handlerFn : React.useCallback(handlerFn, [props[bind.handler], bindKeys]);
               }
             }
-            delete propsOut[key];
+            if (!isReactiveKey) {
+              delete propsOut[key];
+            }
           } else if (propsOut[key] === void 0) {
             propsOut[key] = p;
           }
@@ -241,11 +250,11 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
 function observer(component) {
   return createReactiveComponent(component, true);
 }
-function reactive(component, bindKeys) {
-  return createReactiveComponent(component, false, true, bindKeys);
+function reactive(component, keys, bindKeys) {
+  return createReactiveComponent(component, false, true, keys, bindKeys);
 }
-function reactiveObserver(component, bindKeys) {
-  return createReactiveComponent(component, true, true, bindKeys);
+function reactiveObserver(component, keys, bindKeys) {
+  return createReactiveComponent(component, true, true, keys, bindKeys);
 }
 function reactiveComponents(components) {
   return new Proxy(
@@ -336,7 +345,10 @@ function For({
   }
   return out;
 }
-var Memo = React.memo(Computed, () => true);
+var Memo = React.memo(
+  Computed,
+  (prev, next) => next.scoped ? prev.children === next.children : true
+);
 
 // src/react/configureReactive.ts
 var ReactiveFns = /* @__PURE__ */ new Map();
@@ -371,7 +383,7 @@ var Reactive = new Proxy(
           }
           return React.createElement(Component, propsOut);
         });
-        target[p] = reactive(render, ReactiveFnBinders.get(p));
+        target[p] = reactive(render, [], ReactiveFnBinders.get(p));
       }
       return target[p];
     }
@@ -399,38 +411,6 @@ function Switch({
   const child = children[useSelector(value)];
   return (_b = child ? child() : (_a = children["default"]) == null ? void 0 : _a.call(children)) != null ? _b : null;
 }
-function useObservable(initialValue, deps) {
-  var _a;
-  const ref = React.useRef({});
-  ref.current.value = initialValue;
-  const depsObs$ = deps ? useObservable(deps) : void 0;
-  if (!((_a = ref.current) == null ? void 0 : _a.obs$)) {
-    const value = depsObs$ ? state.isFunction(initialValue) && initialValue.length === 1 ? (p) => {
-      depsObs$.get();
-      return ref.current.value(p);
-    } : () => {
-      depsObs$.get();
-      return state.computeSelector(ref.current.value);
-    } : initialValue;
-    ref.current.obs$ = state.observable(value);
-  }
-  if (depsObs$) {
-    depsObs$.set(deps);
-  }
-  return ref.current.obs$;
-}
-
-// src/react/useComputed.ts
-function useComputed(get, set, deps) {
-  if (!deps && state.isArray(set)) {
-    deps = set;
-    set = void 0;
-  }
-  return useObservable(
-    set ? state.linked({ get, set: ({ value }) => set(value) }) : get,
-    deps
-  );
-}
 var useEffectOnce = (effect, deps) => {
   if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
     const refDispose = React.useRef({ num: 0 });
@@ -459,6 +439,8 @@ var useEffectOnce = (effect, deps) => {
     React.useEffect(effect, deps);
   }
 };
+
+// src/react/useMount.ts
 function useMount(fn) {
   return useEffectOnce(() => {
     const ret = fn();
@@ -469,6 +451,54 @@ function useMount(fn) {
 }
 var useMountOnce = useMount;
 
+// src/react/useUnmount.ts
+function useUnmount(fn) {
+  return useMount(() => fn);
+}
+var useUnmountOnce = useUnmount;
+
+// src/react/useObservable.ts
+var { deactivateNode } = state.internal;
+function useObservable(initialValue, deps) {
+  var _a;
+  const ref = React.useRef({});
+  ref.current.value = initialValue;
+  const depsObs$ = deps ? useObservable(deps) : void 0;
+  if (!((_a = ref.current) == null ? void 0 : _a.obs$)) {
+    const value = depsObs$ ? state.isFunction(initialValue) && initialValue.length === 1 ? (p) => {
+      depsObs$.get();
+      return ref.current.value(p);
+    } : () => {
+      depsObs$.get();
+      return state.computeSelector(ref.current.value);
+    } : initialValue;
+    ref.current.obs$ = state.observable(value);
+  }
+  if (depsObs$) {
+    depsObs$.set(deps);
+  }
+  useUnmount(() => {
+    const obs = ref.current.obs$;
+    if (obs) {
+      const node = state.getNode(obs);
+      deactivateNode(node);
+    }
+  });
+  return ref.current.obs$;
+}
+
+// src/react/useComputed.ts
+function useComputed(get, set, deps) {
+  if (!deps && state.isArray(set)) {
+    deps = set;
+    set = void 0;
+  }
+  return useObservable(
+    set ? state.linked({ get, set: ({ value }) => set(value) }) : get,
+    deps
+  );
+}
+
 // src/react/useIsMounted.ts
 function useIsMounted() {
   const obs = useObservable(false);
@@ -488,14 +518,6 @@ function useObservableReducer(reducer, initializerArg, initializer) {
   };
   return [obs, dispatch];
 }
-
-// src/react/useUnmount.ts
-function useUnmount(fn) {
-  return useMount(() => fn);
-}
-var useUnmountOnce = useUnmount;
-
-// src/react/useObserve.ts
 function useObserve(selector, reactionOrOptions, options) {
   let reaction;
   if (state.isFunction(reactionOrOptions)) {
@@ -516,7 +538,7 @@ function useObserve(selector, reactionOrOptions, options) {
   ref.current.reaction = reaction;
   if (!ref.current.dispose) {
     ref.current.dispose = state.observe(
-      (e) => state.computeSelector(ref.current.selector, e),
+      (e) => state.computeSelector(ref.current.selector, void 0, e),
       (e) => {
         var _a, _b;
         return (_b = (_a = ref.current).reaction) == null ? void 0 : _b.call(_a, e);
@@ -578,6 +600,7 @@ exports.observer = observer;
 exports.reactive = reactive;
 exports.reactiveComponents = reactiveComponents;
 exports.reactiveObserver = reactiveObserver;
+exports.use$ = useSelector;
 exports.useComputed = useComputed;
 exports.useEffectOnce = useEffectOnce;
 exports.useIsMounted = useIsMounted;

package/react.mjs

@@ -1,4 +1,4 @@
-import { isFunction, isEmpty, observable, isPromise, isObservable, when, computeSelector, isArray, isMap, isObservableValueReady, linked, observe, whenReady, internal, trackSelector, isPrimitive } from '@legendapp/state';
+import { isFunction, isEmpty, observable, computeSelector, isArray, isMap, isObservableValueReady, isPromise, getNode as getNode$1, linked, observe, when, whenReady, internal, trackSelector, isPrimitive, isObservable } from '@legendapp/state';
 import React, { memo, forwardRef, createElement, useState, useContext, useMemo, useRef, useEffect, createContext, useCallback } from 'react';
 import { useSyncExternalStore } from 'use-sync-external-store/shim/index.js';
 import { enableReactive } from '@legendapp/state/react-reactive/enableReactive';
@@ -39,6 +39,7 @@ function createSelectorFunctions(options, isPaused$) {
     } = trackSelector(
       _selector,
       _update,
+      options,
       void 0,
       void 0,
       /*createResubscribe*/
@@ -94,12 +95,24 @@ function createSelectorFunctions(options, isPaused$) {
     }
   };
 }
+function doSuspense(selector) {
+  const vProm = when(selector);
+  if (React.use) {
+    React.use(vProm);
+  } else {
+    throw vProm;
+  }
+}
 function useSelector(selector, options) {
   var _a;
+  let value;
   if (reactGlobals.inObserver && isObservable(selector) && !(options == null ? void 0 : options.suspense)) {
-    return computeSelector(selector);
+    value = computeSelector(selector, options);
+    if ((options == null ? void 0 : options.suspense) && value === void 0) {
+      doSuspense(selector);
+    }
+    return value;
   }
-  let value;
   try {
     const isPaused$ = useContext(getPauseContext());
     const selectorFn = useMemo(() => createSelectorFunctions(options, isPaused$), []);
@@ -114,16 +127,8 @@ function useSelector(selector, options) {
     }
     throw err;
   }
-  if (options == null ? void 0 : options.suspense) {
-    const isProm = isPromise(value);
-    if (isPromise(value) || !value && isObservable(selector)) {
-      const vProm = isProm ? value : when(selector);
-      if (React.use) {
-        React.use(vProm);
-      } else {
-        throw vProm;
-      }
-    }
+  if ((options == null ? void 0 : options.suspense) && value === void 0) {
+    doSuspense(selector);
   }
   return value;
 }
@@ -134,7 +139,7 @@ function Computed({ children }) {
 }
 var hasSymbol = typeof Symbol === "function" && Symbol.for;
 var didWarnProps = false;
-function createReactiveComponent(component, observe3, reactive2, bindKeys) {
+function createReactiveComponent(component, observe3, reactive2, keysReactive, bindKeys) {
   const ReactForwardRefSymbol = hasSymbol ? Symbol.for("react.forward_ref") : (
     // eslint-disable-next-line react/display-name, @typescript-eslint/no-unused-vars
     typeof forwardRef === "function" && forwardRef((props) => null)["$$typeof"]
@@ -159,6 +164,7 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
       throw new Error(`[legend-state] \`render\` property of ForwardRef was not a function`);
     }
   }
+  const keysReactiveSet = keysReactive ? new Set(keysReactive) : void 0;
   const proxyHandler = {
     apply(target, thisArg, argArray) {
       if (reactive2) {
@@ -168,9 +174,10 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
         for (let i = 0; i < keys.length; i++) {
           const key = keys[i];
           const p = props[key];
+          const isReactiveKey = keysReactiveSet && keysReactiveSet.has(key);
           if (key === "children" && (isFunction(p) || isObservable(p))) {
             props[key] = useSelector(p, { skipCheck: true });
-          } else if (key.startsWith("$") || key.endsWith("$")) {
+          } else if (isReactiveKey || key.startsWith("$") || key.endsWith("$")) {
             if (process.env.NODE_ENV === "development" && !didWarnProps && key.endsWith("$")) {
               didWarnProps = true;
               console.warn(
@@ -180,7 +187,7 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
                 )}. See https://legendapp.com/open-source/state/migrating for more details.`
               );
             }
-            const k = key.endsWith("$") ? key.slice(0, -1) : key.slice(1);
+            const k = isReactiveKey ? key : key.endsWith("$") ? key.slice(0, -1) : key.slice(1);
             const bind = bindKeys == null ? void 0 : bindKeys[k];
             const shouldBind = bind && isObservable(p);
             propsOut[k] = shouldBind && (bind == null ? void 0 : bind.selector) ? bind.selector(propsOut, p) : useSelector(p);
@@ -198,7 +205,9 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
                 process.env.NODE_ENV === "development" ? handlerFn : useCallback(handlerFn, [props[bind.handler], bindKeys]);
               }
             }
-            delete propsOut[key];
+            if (!isReactiveKey) {
+              delete propsOut[key];
+            }
           } else if (propsOut[key] === void 0) {
             propsOut[key] = p;
           }
@@ -235,11 +244,11 @@ function createReactiveComponent(component, observe3, reactive2, bindKeys) {
 function observer(component) {
   return createReactiveComponent(component, true);
 }
-function reactive(component, bindKeys) {
-  return createReactiveComponent(component, false, true, bindKeys);
+function reactive(component, keys, bindKeys) {
+  return createReactiveComponent(component, false, true, keys, bindKeys);
 }
-function reactiveObserver(component, bindKeys) {
-  return createReactiveComponent(component, true, true, bindKeys);
+function reactiveObserver(component, keys, bindKeys) {
+  return createReactiveComponent(component, true, true, keys, bindKeys);
 }
 function reactiveComponents(components) {
   return new Proxy(
@@ -330,7 +339,10 @@ function For({
   }
   return out;
 }
-var Memo = memo(Computed, () => true);
+var Memo = memo(
+  Computed,
+  (prev, next) => next.scoped ? prev.children === next.children : true
+);
 
 // src/react/configureReactive.ts
 var ReactiveFns = /* @__PURE__ */ new Map();
@@ -365,7 +377,7 @@ var Reactive = new Proxy(
           }
           return createElement(Component, propsOut);
         });
-        target[p] = reactive(render, ReactiveFnBinders.get(p));
+        target[p] = reactive(render, [], ReactiveFnBinders.get(p));
       }
       return target[p];
     }
@@ -393,38 +405,6 @@ function Switch({
   const child = children[useSelector(value)];
   return (_b = child ? child() : (_a = children["default"]) == null ? void 0 : _a.call(children)) != null ? _b : null;
 }
-function useObservable(initialValue, deps) {
-  var _a;
-  const ref = useRef({});
-  ref.current.value = initialValue;
-  const depsObs$ = deps ? useObservable(deps) : void 0;
-  if (!((_a = ref.current) == null ? void 0 : _a.obs$)) {
-    const value = depsObs$ ? isFunction(initialValue) && initialValue.length === 1 ? (p) => {
-      depsObs$.get();
-      return ref.current.value(p);
-    } : () => {
-      depsObs$.get();
-      return computeSelector(ref.current.value);
-    } : initialValue;
-    ref.current.obs$ = observable(value);
-  }
-  if (depsObs$) {
-    depsObs$.set(deps);
-  }
-  return ref.current.obs$;
-}
-
-// src/react/useComputed.ts
-function useComputed(get, set, deps) {
-  if (!deps && isArray(set)) {
-    deps = set;
-    set = void 0;
-  }
-  return useObservable(
-    set ? linked({ get, set: ({ value }) => set(value) }) : get,
-    deps
-  );
-}
 var useEffectOnce = (effect, deps) => {
   if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
     const refDispose = useRef({ num: 0 });
@@ -453,6 +433,8 @@ var useEffectOnce = (effect, deps) => {
     useEffect(effect, deps);
   }
 };
+
+// src/react/useMount.ts
 function useMount(fn) {
   return useEffectOnce(() => {
     const ret = fn();
@@ -463,6 +445,54 @@ function useMount(fn) {
 }
 var useMountOnce = useMount;
 
+// src/react/useUnmount.ts
+function useUnmount(fn) {
+  return useMount(() => fn);
+}
+var useUnmountOnce = useUnmount;
+
+// src/react/useObservable.ts
+var { deactivateNode } = internal;
+function useObservable(initialValue, deps) {
+  var _a;
+  const ref = useRef({});
+  ref.current.value = initialValue;
+  const depsObs$ = deps ? useObservable(deps) : void 0;
+  if (!((_a = ref.current) == null ? void 0 : _a.obs$)) {
+    const value = depsObs$ ? isFunction(initialValue) && initialValue.length === 1 ? (p) => {
+      depsObs$.get();
+      return ref.current.value(p);
+    } : () => {
+      depsObs$.get();
+      return computeSelector(ref.current.value);
+    } : initialValue;
+    ref.current.obs$ = observable(value);
+  }
+  if (depsObs$) {
+    depsObs$.set(deps);
+  }
+  useUnmount(() => {
+    const obs = ref.current.obs$;
+    if (obs) {
+      const node = getNode$1(obs);
+      deactivateNode(node);
+    }
+  });
+  return ref.current.obs$;
+}
+
+// src/react/useComputed.ts
+function useComputed(get, set, deps) {
+  if (!deps && isArray(set)) {
+    deps = set;
+    set = void 0;
+  }
+  return useObservable(
+    set ? linked({ get, set: ({ value }) => set(value) }) : get,
+    deps
+  );
+}
+
 // src/react/useIsMounted.ts
 function useIsMounted() {
   const obs = useObservable(false);
@@ -482,14 +512,6 @@ function useObservableReducer(reducer, initializerArg, initializer) {
   };
   return [obs, dispatch];
 }
-
-// src/react/useUnmount.ts
-function useUnmount(fn) {
-  return useMount(() => fn);
-}
-var useUnmountOnce = useUnmount;
-
-// src/react/useObserve.ts
 function useObserve(selector, reactionOrOptions, options) {
   let reaction;
   if (isFunction(reactionOrOptions)) {
@@ -510,7 +532,7 @@ function useObserve(selector, reactionOrOptions, options) {
   ref.current.reaction = reaction;
   if (!ref.current.dispose) {
     ref.current.dispose = observe(
-      (e) => computeSelector(ref.current.selector, e),
+      (e) => computeSelector(ref.current.selector, void 0, e),
       (e) => {
         var _a, _b;
         return (_b = (_a = ref.current).reaction) == null ? void 0 : _b.call(_a, e);
@@ -560,4 +582,4 @@ function useWhenReady(predicate, effect) {
   return useMemo(() => whenReady(predicate, effect), []);
 }
 
-export { Computed, For, Memo, Reactive, Show, Switch, configureReactive, hasSymbol, observer, reactive, reactiveComponents, reactiveObserver, useComputed, useEffectOnce, useIsMounted, useMount, useMountOnce, useObservable, useObservableReducer, useObserve, useObserveEffect, usePauseProvider, useSelector, useUnmount, useUnmountOnce, useWhen, useWhenReady };
+export { Computed, For, Memo, Reactive, Show, Switch, configureReactive, hasSymbol, observer, reactive, reactiveComponents, reactiveObserver, useSelector as use$, useComputed, useEffectOnce, useIsMounted, useMount, useMountOnce, useObservable, useObservableReducer, useObserve, useObserveEffect, usePauseProvider, useSelector, useUnmount, useUnmountOnce, useWhen, useWhenReady };

package/sync-plugins/crud.d.mts

@@ -1,17 +1,25 @@
 import { WaitForSetFnParams, ObservableParam, ObservableEvent } from '@legendapp/state';
-import { SyncedGetParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
+import { SyncedGetParams, SyncedErrorParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
 
 type CrudAsOption = 'Map' | 'object' | 'value' | 'array';
 type CrudResult<T> = T;
+interface SyncedCrudPropsNoRead<TLocal, TAsOption extends CrudAsOption> {
+    get?: never | undefined;
+    list?: never | undefined;
+    initial?: InitialValue<TLocal, TAsOption>;
+    as?: TAsOption;
+}
 interface SyncedCrudPropsSingle<TRemote extends object, TLocal> {
-    get?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
-    initial?: InitialValue<TLocal, 'value'>;
+    get: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
+    list?: never | undefined;
+    initial?: InitialValue<Partial<NoInfer<TLocal>>, 'value'>;
     as?: never | 'value';
 }
 interface SyncedCrudPropsMany<TRemote extends object, TLocal, TAsOption extends CrudAsOption> {
-    list?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+    list: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+    get?: never | undefined;
     as?: TAsOption;
-    initial?: InitialValue<TLocal, TAsOption>;
+    initial?: InitialValue<Partial<NoInfer<TLocal>>, TAsOption>;
 }
 interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
     saved: TLocal;
@@ -23,7 +31,11 @@ interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
 interface WaitForSetCrudFnParams<T> extends WaitForSetFnParams<T> {
     type: 'create' | 'update' | 'delete';
 }
-interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe' | 'waitForSet'> {
+interface CrudErrorParams extends Omit<SyncedErrorParams, 'source'> {
+    source: 'list' | 'get' | 'create' | 'update' | 'delete' | 'unknown';
+}
+type CrudOnErrorFn = (error: Error, params: CrudErrorParams) => void;
+interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe' | 'waitForSet' | 'onError'> {
     create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined | void>;
     update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined | void>>;
     delete?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<any>;
@@ -38,6 +50,7 @@ interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends
     generateId?: () => string | number;
     subscribe?: (params: SyncedSubscribeParams<TRemote[]>) => (() => void) | void;
     waitForSet?: ((params: WaitForSetCrudFnParams<TLocal>) => any) | Promise<any> | ObservableParam<any> | ObservableEvent;
+    onError?: (error: Error, params: CrudErrorParams) => void;
 }
 type InitialValue<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<string | number, TLocal> : TAsOption extends 'object' ? Record<string | number, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
 type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<TLocal extends {
@@ -45,7 +58,9 @@ type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption ex
 } ? number : string, TLocal> : TAsOption extends 'object' ? Record<TLocal extends {
     id: number;
 } ? number : string, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
-declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
-declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsNoRead<TRemote, TAsOption> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, TAsOption>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsSingle<TRemote, TLocal> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsMany<TRemote, TLocal, TAsOption> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: (SyncedCrudPropsSingle<TRemote, TLocal> | SyncedCrudPropsMany<TRemote, TLocal, TAsOption>) & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, TAsOption>;
 
-export { type CrudAsOption, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsSingle, type SyncedCrudReturnType, type WaitForSetCrudFnParams, syncedCrud };
+export { type CrudAsOption, type CrudErrorParams, type CrudOnErrorFn, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsNoRead, type SyncedCrudPropsSingle, type SyncedCrudReturnType, type WaitForSetCrudFnParams, syncedCrud };

package/sync-plugins/crud.d.ts

@@ -1,17 +1,25 @@
 import { WaitForSetFnParams, ObservableParam, ObservableEvent } from '@legendapp/state';
-import { SyncedGetParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
+import { SyncedGetParams, SyncedErrorParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
 
 type CrudAsOption = 'Map' | 'object' | 'value' | 'array';
 type CrudResult<T> = T;
+interface SyncedCrudPropsNoRead<TLocal, TAsOption extends CrudAsOption> {
+    get?: never | undefined;
+    list?: never | undefined;
+    initial?: InitialValue<TLocal, TAsOption>;
+    as?: TAsOption;
+}
 interface SyncedCrudPropsSingle<TRemote extends object, TLocal> {
-    get?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
-    initial?: InitialValue<TLocal, 'value'>;
+    get: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
+    list?: never | undefined;
+    initial?: InitialValue<Partial<NoInfer<TLocal>>, 'value'>;
     as?: never | 'value';
 }
 interface SyncedCrudPropsMany<TRemote extends object, TLocal, TAsOption extends CrudAsOption> {
-    list?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+    list: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+    get?: never | undefined;
     as?: TAsOption;
-    initial?: InitialValue<TLocal, TAsOption>;
+    initial?: InitialValue<Partial<NoInfer<TLocal>>, TAsOption>;
 }
 interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
     saved: TLocal;
@@ -23,7 +31,11 @@ interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
 interface WaitForSetCrudFnParams<T> extends WaitForSetFnParams<T> {
     type: 'create' | 'update' | 'delete';
 }
-interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe' | 'waitForSet'> {
+interface CrudErrorParams extends Omit<SyncedErrorParams, 'source'> {
+    source: 'list' | 'get' | 'create' | 'update' | 'delete' | 'unknown';
+}
+type CrudOnErrorFn = (error: Error, params: CrudErrorParams) => void;
+interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe' | 'waitForSet' | 'onError'> {
     create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined | void>;
     update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined | void>>;
     delete?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<any>;
@@ -38,6 +50,7 @@ interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends
     generateId?: () => string | number;
     subscribe?: (params: SyncedSubscribeParams<TRemote[]>) => (() => void) | void;
     waitForSet?: ((params: WaitForSetCrudFnParams<TLocal>) => any) | Promise<any> | ObservableParam<any> | ObservableEvent;
+    onError?: (error: Error, params: CrudErrorParams) => void;
 }
 type InitialValue<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<string | number, TLocal> : TAsOption extends 'object' ? Record<string | number, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
 type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<TLocal extends {
@@ -45,7 +58,9 @@ type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption ex
 } ? number : string, TLocal> : TAsOption extends 'object' ? Record<TLocal extends {
     id: number;
 } ? number : string, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
-declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
-declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsNoRead<TRemote, TAsOption> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, TAsOption>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsSingle<TRemote, TLocal> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsMany<TRemote, TLocal, TAsOption> & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: (SyncedCrudPropsSingle<TRemote, TLocal> | SyncedCrudPropsMany<TRemote, TLocal, TAsOption>) & SyncedCrudPropsBase<TRemote, TLocal>): SyncedCrudReturnType<TLocal, TAsOption>;
 
-export { type CrudAsOption, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsSingle, type SyncedCrudReturnType, type WaitForSetCrudFnParams, syncedCrud };
+export { type CrudAsOption, type CrudErrorParams, type CrudOnErrorFn, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsNoRead, type SyncedCrudPropsSingle, type SyncedCrudReturnType, type WaitForSetCrudFnParams, syncedCrud };