@legendapp/state 3.0.0-beta.1 → 3.0.0-beta.12

package/sync-plugins/crud.d.ts

@@ -5,11 +5,13 @@ type CrudAsOption = 'Map' | 'object' | 'value' | 'array';
 type CrudResult<T> = T;
 interface SyncedCrudPropsSingle<TRemote extends object, TLocal> {
     get?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
+    list?: never | undefined;
     initial?: InitialValue<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>;
+    get?: never | undefined;
     as?: TAsOption;
     initial?: InitialValue<TLocal, TAsOption>;
 }
@@ -45,7 +47,8 @@ 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>(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 };

package/sync-plugins/crud.js

@@ -256,40 +256,38 @@ function syncedCrud(props) {
     const saveResult = async (itemKey, input, data, isCreate) => {
       var _a;
       if (data) {
-        const saved = (transform == null ? void 0 : transform.load) ? await transform.load(data, "set") : data;
+        let saved = (transform == null ? void 0 : transform.load) ? await transform.load(data, "set") : data;
         const isChild = itemKey !== "undefined" && asType !== "value";
         const currentPeeked = state.getNodeValue(node);
         const currentValue = isChild ? (_a = asType === "array" && state.isArray(currentPeeked) ? currentPeeked.find((v) => v[fieldId] === itemKey) : void 0) != null ? _a : currentPeeked[itemKey] : currentPeeked;
-        const dataOnSaved = {
-          saved,
-          input,
-          currentValue,
-          isCreate,
-          props
-        };
-        let savedOut = saved;
-        if (savedOut && !state.isNullOrUndefined(currentValue)) {
-          savedOut = clone(savedOut);
-          Object.keys(savedOut).forEach((key) => {
+        if (saved && !state.isNullOrUndefined(currentValue)) {
+          if (onSaved) {
+            const ret = onSaved({
+              saved,
+              input,
+              currentValue,
+              isCreate,
+              props
+            });
+            if (ret) {
+              saved = ret;
+            }
+          }
+          saved = clone(saved);
+          Object.keys(saved).forEach((key) => {
             const i = input[key];
             const c = currentValue[key];
             if (
               // value is already the new value, can ignore
-              savedOut[key] === c || // user has changed local value
-              key !== "id" && i !== c
+              saved[key] === c || // user has changed local value
+              key !== fieldId && i !== c
             ) {
-              delete savedOut[key];
+              delete saved[key];
             }
           });
-          if (onSaved) {
-            const ret = onSaved(dataOnSaved);
-            if (ret) {
-              savedOut = ret;
-            }
-          }
-          const createdAt = fieldCreatedAt ? savedOut[fieldCreatedAt] : void 0;
-          const updatedAt = fieldUpdatedAt ? savedOut[fieldUpdatedAt] : void 0;
-          const value2 = itemKey !== "undefined" && asType !== "value" ? { [itemKey]: savedOut } : savedOut;
+          const createdAt = fieldCreatedAt ? saved[fieldCreatedAt] : void 0;
+          const updatedAt = fieldUpdatedAt ? saved[fieldUpdatedAt] : void 0;
+          const value2 = itemKey !== "undefined" && asType !== "value" ? { [itemKey]: saved } : saved;
           update({
             value: value2,
             lastSync: updatedAt || createdAt ? +new Date(updatedAt || createdAt) : void 0,

package/sync-plugins/crud.mjs

@@ -254,40 +254,38 @@ function syncedCrud(props) {
     const saveResult = async (itemKey, input, data, isCreate) => {
       var _a;
       if (data) {
-        const saved = (transform == null ? void 0 : transform.load) ? await transform.load(data, "set") : data;
+        let saved = (transform == null ? void 0 : transform.load) ? await transform.load(data, "set") : data;
         const isChild = itemKey !== "undefined" && asType !== "value";
         const currentPeeked = getNodeValue(node);
         const currentValue = isChild ? (_a = asType === "array" && isArray(currentPeeked) ? currentPeeked.find((v) => v[fieldId] === itemKey) : void 0) != null ? _a : currentPeeked[itemKey] : currentPeeked;
-        const dataOnSaved = {
-          saved,
-          input,
-          currentValue,
-          isCreate,
-          props
-        };
-        let savedOut = saved;
-        if (savedOut && !isNullOrUndefined(currentValue)) {
-          savedOut = clone(savedOut);
-          Object.keys(savedOut).forEach((key) => {
+        if (saved && !isNullOrUndefined(currentValue)) {
+          if (onSaved) {
+            const ret = onSaved({
+              saved,
+              input,
+              currentValue,
+              isCreate,
+              props
+            });
+            if (ret) {
+              saved = ret;
+            }
+          }
+          saved = clone(saved);
+          Object.keys(saved).forEach((key) => {
             const i = input[key];
             const c = currentValue[key];
             if (
               // value is already the new value, can ignore
-              savedOut[key] === c || // user has changed local value
-              key !== "id" && i !== c
+              saved[key] === c || // user has changed local value
+              key !== fieldId && i !== c
             ) {
-              delete savedOut[key];
+              delete saved[key];
             }
           });
-          if (onSaved) {
-            const ret = onSaved(dataOnSaved);
-            if (ret) {
-              savedOut = ret;
-            }
-          }
-          const createdAt = fieldCreatedAt ? savedOut[fieldCreatedAt] : void 0;
-          const updatedAt = fieldUpdatedAt ? savedOut[fieldUpdatedAt] : void 0;
-          const value2 = itemKey !== "undefined" && asType !== "value" ? { [itemKey]: savedOut } : savedOut;
+          const createdAt = fieldCreatedAt ? saved[fieldCreatedAt] : void 0;
+          const updatedAt = fieldUpdatedAt ? saved[fieldUpdatedAt] : void 0;
+          const value2 = itemKey !== "undefined" && asType !== "value" ? { [itemKey]: saved } : saved;
           update({
             value: value2,
             lastSync: updatedAt || createdAt ? +new Date(updatedAt || createdAt) : void 0,

package/sync-plugins/keel.js

@@ -274,6 +274,7 @@ function syncedKeel(props) {
   } : subscribeParam;
   return crud.syncedCrud({
     ...rest,
+    // Workaround for type errors
     as: asType,
     mode: mode || "merge",
     list,
@@ -299,7 +300,6 @@ function syncedKeel(props) {
     updatePartial: true,
     subscribe,
     generateId: generateKeelId,
-    // @ts-expect-error This errors because of the get/list union type
     get
   });
 }

package/sync-plugins/keel.mjs

@@ -268,6 +268,7 @@ function syncedKeel(props) {
   } : subscribeParam;
   return syncedCrud({
     ...rest,
+    // Workaround for type errors
     as: asType,
     mode: mode || "merge",
     list,
@@ -293,7 +294,6 @@ function syncedKeel(props) {
     updatePartial: true,
     subscribe,
     generateId: generateKeelId,
-    // @ts-expect-error This errors because of the get/list union type
     get
   });
 }

package/sync-plugins/supabase.js

@@ -36,9 +36,9 @@ function syncedSupabase(props) {
     schema,
     filter,
     actions,
-    fieldCreatedAt: fieldCreatedAtParam,
-    fieldUpdatedAt: fieldUpdatedAtParam,
-    fieldDeleted: fieldDeletedParam,
+    fieldCreatedAt,
+    fieldUpdatedAt,
+    fieldDeleted,
     realtime,
     changesSince,
     transform: transformParam,
@@ -54,9 +54,17 @@ function syncedSupabase(props) {
     ...rest
   } = props;
   const client = supabase;
-  const fieldCreatedAt = fieldCreatedAtParam || (changesSince === "last-sync" ? "created_at" : void 0);
-  const fieldUpdatedAt = fieldUpdatedAtParam || (changesSince === "last-sync" ? "updated_at" : void 0);
-  const fieldDeleted = fieldDeletedParam || (changesSince === "last-sync" ? "deleted" : void 0);
+  if (process.env.NODE_ENV === "development" && changesSince === "last-sync") {
+    if (!fieldCreatedAt) {
+      console.warn("[legend-state] fieldCreatedAt is required when using last-sync mode");
+    }
+    if (!fieldUpdatedAt) {
+      console.warn("[legend-state] fieldUpdatedAt is required when using last-sync mode");
+    }
+    if (!fieldDeleted) {
+      console.warn("[legend-state] fieldDeleted is required when using last-sync mode");
+    }
+  }
   const list = !actions || actions.includes("read") ? listParam ? wrapSupabaseFn(listParam) : async (params) => {
     const { lastSync } = params;
     const clientSchema = schema ? client.schema(schema) : client;

package/sync-plugins/supabase.mjs

@@ -34,9 +34,9 @@ function syncedSupabase(props) {
     schema,
     filter,
     actions,
-    fieldCreatedAt: fieldCreatedAtParam,
-    fieldUpdatedAt: fieldUpdatedAtParam,
-    fieldDeleted: fieldDeletedParam,
+    fieldCreatedAt,
+    fieldUpdatedAt,
+    fieldDeleted,
     realtime,
     changesSince,
     transform: transformParam,
@@ -52,9 +52,17 @@ function syncedSupabase(props) {
     ...rest
   } = props;
   const client = supabase;
-  const fieldCreatedAt = fieldCreatedAtParam || (changesSince === "last-sync" ? "created_at" : void 0);
-  const fieldUpdatedAt = fieldUpdatedAtParam || (changesSince === "last-sync" ? "updated_at" : void 0);
-  const fieldDeleted = fieldDeletedParam || (changesSince === "last-sync" ? "deleted" : void 0);
+  if (process.env.NODE_ENV === "development" && changesSince === "last-sync") {
+    if (!fieldCreatedAt) {
+      console.warn("[legend-state] fieldCreatedAt is required when using last-sync mode");
+    }
+    if (!fieldUpdatedAt) {
+      console.warn("[legend-state] fieldUpdatedAt is required when using last-sync mode");
+    }
+    if (!fieldDeleted) {
+      console.warn("[legend-state] fieldDeleted is required when using last-sync mode");
+    }
+  }
   const list = !actions || actions.includes("read") ? listParam ? wrapSupabaseFn(listParam) : async (params) => {
     const { lastSync } = params;
     const clientSchema = schema ? client.schema(schema) : client;

package/sync-plugins/tanstack-query.d.mts

@@ -1,14 +1,14 @@
-import { SyncedOptions } from '@legendapp/state/sync';
+import { SyncedOptions, Synced } from '@legendapp/state/sync';
 import { QueryKey, QueryObserverOptions, QueryClient, MutationObserverOptions, DefaultError } from '@tanstack/query-core';
 
-interface ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'> {
+interface ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TData, TQueryKey>, 'queryKey'> {
     queryKey?: TQueryKey | (() => TQueryKey);
 }
-interface SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<SyncedOptions<TData>, 'get' | 'set'> {
+interface SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<SyncedOptions<TData>, 'get' | 'set' | 'retry'> {
     queryClient: QueryClient;
     query: ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey>;
-    mutation?: MutationObserverOptions<TData, TError, void>;
+    mutation?: MutationObserverOptions<TQueryFnData, TError, TData>;
 }
-declare function syncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): TData;
+declare function syncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): Synced<TData>;
 
 export { type ObservableQueryOptions, type SyncedQueryParams, syncedQuery };

package/sync-plugins/tanstack-query.d.ts

@@ -1,14 +1,14 @@
-import { SyncedOptions } from '@legendapp/state/sync';
+import { SyncedOptions, Synced } from '@legendapp/state/sync';
 import { QueryKey, QueryObserverOptions, QueryClient, MutationObserverOptions, DefaultError } from '@tanstack/query-core';
 
-interface ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'> {
+interface ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TData, TQueryKey>, 'queryKey'> {
     queryKey?: TQueryKey | (() => TQueryKey);
 }
-interface SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<SyncedOptions<TData>, 'get' | 'set'> {
+interface SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey extends QueryKey> extends Omit<SyncedOptions<TData>, 'get' | 'set' | 'retry'> {
     queryClient: QueryClient;
     query: ObservableQueryOptions<TQueryFnData, TError, TData, TQueryKey>;
-    mutation?: MutationObserverOptions<TData, TError, void>;
+    mutation?: MutationObserverOptions<TQueryFnData, TError, TData>;
 }
-declare function syncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): TData;
+declare function syncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): Synced<TData>;
 
 export { type ObservableQueryOptions, type SyncedQueryParams, syncedQuery };

package/sync-plugins/tanstack-query.js

@@ -5,8 +5,14 @@ var sync = require('@legendapp/state/sync');
 var queryCore = require('@tanstack/query-core');
 
 // src/sync-plugins/tanstack-query.ts
+var nextMutationKey = 0;
 function syncedQuery(params) {
-  const { query: options, mutation: mutationOptions, queryClient, ...rest } = params;
+  const { query: options, mutation: mutationOptions, queryClient, initial: initialParam, ...rest } = params;
+  if (initialParam !== void 0) {
+    const initialValue = state.isFunction(initialParam) ? initialParam() : initialParam;
+    options.initialData = initialValue;
+  }
+  const initial = options.initialData;
   const Observer = queryCore.QueryObserver;
   const defaultedOptions = queryClient.defaultQueryOptions(
     options
@@ -66,8 +72,16 @@ function syncedQuery(params) {
   };
   let set = void 0;
   if (mutationOptions) {
-    const mutator = new queryCore.MutationObserver(queryClient, mutationOptions);
+    const options2 = {
+      mutationKey: ["LS-mutation", nextMutationKey++],
+      ...mutationOptions
+    };
+    const mutator = new queryCore.MutationObserver(queryClient, options2);
     set = ({ value }) => {
+      const mutationCache = queryClient.getMutationCache();
+      mutationCache.findAll({ mutationKey: options2.mutationKey }).forEach((mutation) => {
+        mutationCache.remove(mutation);
+      });
       return mutator.mutate(value);
     };
   }
@@ -75,6 +89,7 @@ function syncedQuery(params) {
     get,
     set,
     subscribe,
+    initial,
     ...rest
   });
 }

package/sync-plugins/tanstack-query.mjs

@@ -3,8 +3,14 @@ import { synced } from '@legendapp/state/sync';
 import { MutationObserver, QueryObserver, notifyManager } from '@tanstack/query-core';
 
 // src/sync-plugins/tanstack-query.ts
+var nextMutationKey = 0;
 function syncedQuery(params) {
-  const { query: options, mutation: mutationOptions, queryClient, ...rest } = params;
+  const { query: options, mutation: mutationOptions, queryClient, initial: initialParam, ...rest } = params;
+  if (initialParam !== void 0) {
+    const initialValue = isFunction(initialParam) ? initialParam() : initialParam;
+    options.initialData = initialValue;
+  }
+  const initial = options.initialData;
   const Observer = QueryObserver;
   const defaultedOptions = queryClient.defaultQueryOptions(
     options
@@ -64,8 +70,16 @@ function syncedQuery(params) {
   };
   let set = void 0;
   if (mutationOptions) {
-    const mutator = new MutationObserver(queryClient, mutationOptions);
+    const options2 = {
+      mutationKey: ["LS-mutation", nextMutationKey++],
+      ...mutationOptions
+    };
+    const mutator = new MutationObserver(queryClient, options2);
     set = ({ value }) => {
+      const mutationCache = queryClient.getMutationCache();
+      mutationCache.findAll({ mutationKey: options2.mutationKey }).forEach((mutation) => {
+        mutationCache.remove(mutation);
+      });
       return mutator.mutate(value);
     };
   }
@@ -73,6 +87,7 @@ function syncedQuery(params) {
     get,
     set,
     subscribe,
+    initial,
     ...rest
   });
 }

package/sync-plugins/tanstack-react-query.d.mts

@@ -1,8 +1,10 @@
 import { SyncedQueryParams } from '@legendapp/state/sync-plugins/tanstack-query';
-import { DefaultError, QueryKey } from '@tanstack/query-core';
+import { DefaultError, QueryKey, QueryClient } from '@tanstack/query-core';
 import { Observable } from '@legendapp/state';
 import { Synced } from '@legendapp/state/sync';
 
-declare function useObservableSyncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): Observable<Synced<TData>>;
+declare function useObservableSyncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: Omit<SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>, 'queryClient'> & {
+    queryClient?: QueryClient;
+}): Observable<Synced<TData>>;
 
 export { useObservableSyncedQuery };

package/sync-plugins/tanstack-react-query.d.ts

@@ -1,8 +1,10 @@
 import { SyncedQueryParams } from '@legendapp/state/sync-plugins/tanstack-query';
-import { DefaultError, QueryKey } from '@tanstack/query-core';
+import { DefaultError, QueryKey, QueryClient } from '@tanstack/query-core';
 import { Observable } from '@legendapp/state';
 import { Synced } from '@legendapp/state/sync';
 
-declare function useObservableSyncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>): Observable<Synced<TData>>;
+declare function useObservableSyncedQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(params: Omit<SyncedQueryParams<TQueryFnData, TError, TData, TQueryKey>, 'queryClient'> & {
+    queryClient?: QueryClient;
+}): Observable<Synced<TData>>;
 
 export { useObservableSyncedQuery };