@legendapp/state 3.0.0-beta.4 → 3.0.0-beta.41

package/sync-plugins/firebase.mjs

@@ -1,4 +1,4 @@
-import { observable, symbolDelete, isString, isArray, isObject, computeSelector, isFunction, isNullOrUndefined, isPromise, isNumber, when } from '@legendapp/state';
+import { observable, symbolDelete, isString, isArray, isObject, computeSelector, isFunction, isNullOrUndefined, isPromise, isNumber } from '@legendapp/state';
 import { syncedCrud } from '@legendapp/state/sync-plugins/crud';
 import { getAuth } from 'firebase/auth';
 import { ref, getDatabase, query, orderByChild, startAt, update, onValue, onChildAdded, onChildChanged, onChildRemoved, serverTimestamp, remove, push } from 'firebase/database';
@@ -101,6 +101,61 @@ if (process.env.NODE_ENV === "development") {
   };
 }
 
+// src/is.ts
+function isMap(obj) {
+  return obj instanceof Map || obj instanceof WeakMap;
+}
+var globalState = {
+  pendingNodes: /* @__PURE__ */ new Map(),
+  dirtyNodes: /* @__PURE__ */ new Set()
+};
+function replacer(key, value) {
+  if (isMap(value)) {
+    return {
+      __LSType: "Map",
+      value: Array.from(value.entries())
+      // or with spread: value: [...value]
+    };
+  } else if (value instanceof Set) {
+    return {
+      __LSType: "Set",
+      value: Array.from(value)
+      // or with spread: value: [...value]
+    };
+  } else if (globalState.replacer) {
+    value = globalState.replacer(key, value);
+  }
+  return value;
+}
+var ISO8601 = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/;
+function reviver(key, value) {
+  if (value) {
+    if (typeof value === "string" && ISO8601.test(value)) {
+      return new Date(value);
+    }
+    if (typeof value === "object") {
+      if (value.__LSType === "Map") {
+        return new Map(value.value);
+      } else if (value.__LSType === "Set") {
+        return new Set(value.value);
+      }
+    }
+    if (globalState.reviver) {
+      value = globalState.reviver(key, value);
+    }
+  }
+  return value;
+}
+function safeStringify(value) {
+  return value ? JSON.stringify(value, replacer) : value;
+}
+function safeParse(value) {
+  return value ? JSON.parse(value, reviver) : value;
+}
+function clone(value) {
+  return safeParse(safeStringify(value));
+}
+
 // src/sync-plugins/firebase.ts
 var isEnabled$ = observable(true);
 var firebaseConfig = {};
@@ -152,9 +207,6 @@ var fns = {
 };
 function syncedFirebase(props) {
   props = { ...firebaseConfig, ...props };
-  const saving$ = observable({});
-  const pendingOutgoing$ = observable({});
-  const pendingIncoming$ = observable({});
   let didList = false;
   const {
     refPath,
@@ -172,6 +224,102 @@ function syncedFirebase(props) {
   const { fieldCreatedAt, changesSince } = props;
   const asType = props.as || "value";
   const fieldUpdatedAt = props.fieldUpdatedAt || "@";
+  const isRealtime = realtime !== false;
+  const pendingWrites = /* @__PURE__ */ new Map();
+  const enqueuePendingWrite = (key) => {
+    let resolveFn;
+    let rejectFn;
+    const promise = new Promise((resolve, reject) => {
+      resolveFn = resolve;
+      rejectFn = reject;
+    });
+    const entry = {
+      resolve: resolveFn,
+      reject: rejectFn
+    };
+    const state = pendingWrites.get(key);
+    if (state) {
+      state.waiting.push(entry);
+      state.pendingCount += 1;
+    } else {
+      pendingWrites.set(key, {
+        waiting: [entry],
+        ready: [],
+        pendingCount: 1
+      });
+    }
+    return { promise, entry };
+  };
+  const flushPending = (key) => {
+    const state = pendingWrites.get(key);
+    if (!state) {
+      return;
+    }
+    if (state.pendingCount === 0 && state.staged) {
+      const { value, apply } = state.staged;
+      state.staged = void 0;
+      while (state.ready.length) {
+        const entry = state.ready.shift();
+        entry.resolve(value);
+      }
+      if (!state.waiting.length && !state.ready.length) {
+        pendingWrites.delete(key);
+      }
+      apply == null ? void 0 : apply(value);
+    }
+  };
+  const resolvePendingWrite = (key, entry) => {
+    const state = pendingWrites.get(key);
+    if (!state) {
+      return;
+    }
+    const waitingIndex = state.waiting.indexOf(entry);
+    if (waitingIndex >= 0) {
+      state.waiting.splice(waitingIndex, 1);
+      state.pendingCount = Math.max(0, state.pendingCount - 1);
+    }
+    state.ready.push(entry);
+    flushPending(key);
+  };
+  const rejectPendingWrite = (key, entry, error) => {
+    const state = pendingWrites.get(key);
+    if (state) {
+      const waitingIndex = state.waiting.indexOf(entry);
+      if (waitingIndex >= 0) {
+        state.waiting.splice(waitingIndex, 1);
+        state.pendingCount = Math.max(0, state.pendingCount - 1);
+      } else {
+        const readyIndex = state.ready.indexOf(entry);
+        if (readyIndex >= 0) {
+          state.ready.splice(readyIndex, 1);
+        }
+      }
+      if (!state.waiting.length && !state.ready.length) {
+        pendingWrites.delete(key);
+      }
+    }
+    entry.reject(error);
+  };
+  const handleServerValue = (key, value, apply) => {
+    var _a;
+    const state = pendingWrites.get(key);
+    if (!state || !state.waiting.length && !state.ready.length) {
+      pendingWrites.delete(key);
+      apply == null ? void 0 : apply(value);
+    } else {
+      state.staged = {
+        value: value && typeof value === "object" ? clone(value) : value,
+        apply: apply != null ? apply : (_a = state.staged) == null ? void 0 : _a.apply
+      };
+      flushPending(key);
+    }
+  };
+  const ensureFieldId = (key, value) => {
+    if (fieldId && key && value && typeof value === "object" && !value[fieldId]) {
+      value[fieldId] = key;
+    }
+    return value;
+  };
   const computeRef = (lastSync) => {
     const pathFirebase = refPath(fns.getCurrentUser());
     let ref = fns.ref(pathFirebase);
@@ -183,7 +331,8 @@ function syncedFirebase(props) {
     }
     return ref;
   };
-  const list = async ({ lastSync, onError }) => {
+  const list = async (getParams) => {
+    const { lastSync, onError } = getParams;
     const ref = computeRef(lastSync);
     return new Promise((resolve) => {
       fns.once(
@@ -193,20 +342,17 @@ function syncedFirebase(props) {
           let values = [];
           if (!isNullOrUndefined(val)) {
             values = asType === "value" ? [val] : Object.entries(val).map(([key, value]) => {
-              if (fieldId && !value[fieldId]) {
-                value[fieldId] = key;
-              }
-              return value;
+              return ensureFieldId(key, value);
             });
           }
           didList = true;
           resolve(values);
         },
-        onError
+        (error) => onError(error, { source: "list", type: "get", retry: getParams })
       );
     });
   };
-  const subscribe = realtime ? ({ lastSync, update: update2, onError }) => {
+  const subscribe = isRealtime ? ({ lastSync, update: update2, onError }) => {
     const ref = computeRef(lastSync);
     let unsubscribes;
     if (asType === "value") {
@@ -214,14 +360,12 @@ function syncedFirebase(props) {
         if (!didList)
           return;
         const val = snap.val();
-        if (saving$[""].get()) {
-          pendingIncoming$[""].set(val);
-        } else {
+        handleServerValue("", val, (resolvedValue) => {
           update2({
-            value: [val],
+            value: [resolvedValue],
             mode: "set"
           });
-        }
+        });
       };
       unsubscribes = [fns.onValue(ref, onValue2, onError)];
     } else {
@@ -229,31 +373,26 @@ function syncedFirebase(props) {
         if (!didList)
           return;
         const key = snap.key;
-        const val = snap.val();
-        if (fieldId && !val[fieldId]) {
-          val[fieldId] = key;
-        }
-        if (saving$[key].get()) {
-          pendingIncoming$[key].set(val);
-        } else {
+        const val = ensureFieldId(key, snap.val());
+        handleServerValue(key, val, (resolvedValue) => {
           update2({
-            value: [val],
-            mode: "assign"
+            value: [resolvedValue],
+            mode: "merge"
           });
-        }
+        });
       };
       const onChildDelete = (snap) => {
         if (!didList)
           return;
         const key = snap.key;
-        const val = snap.val();
-        if (fieldId && !val[fieldId]) {
-          val[fieldId] = key;
-        }
-        val[symbolDelete] = true;
-        update2({
-          value: [val],
-          mode: "assign"
+        const valueRaw = snap.val();
+        const valueWithId = ensureFieldId(key, isNullOrUndefined(valueRaw) ? {} : valueRaw);
+        valueWithId[symbolDelete] = true;
+        handleServerValue(key, valueWithId, (resolvedValue) => {
+          update2({
+            value: [resolvedValue],
+            mode: "merge"
+          });
         });
       };
       unsubscribes = [
@@ -277,42 +416,52 @@ function syncedFirebase(props) {
     }
     return addUpdatedAt(input);
   };
-  const upsert = async (input) => {
-    const id = fieldId ? input[fieldId] : "";
-    if (saving$[id].get()) {
-      pendingOutgoing$[id].set(input);
-    } else {
-      saving$[id].set(true);
-      const path = joinPaths(refPath(fns.getCurrentUser()), fieldId ? id : "");
-      await fns.update(fns.ref(path), input);
-      saving$[id].set(false);
-      flushAfterSave();
-    }
-    return when(
-      () => !pendingOutgoing$[id].get(),
-      () => {
-        const value = pendingIncoming$[id].get();
-        if (value) {
-          pendingIncoming$[id].delete();
-          return value;
-        }
-      }
-    );
-  };
-  const flushAfterSave = () => {
-    const outgoing = pendingOutgoing$.get();
-    Object.values(outgoing).forEach((value) => {
-      upsert(value);
+  const upsert = (input, params) => {
+    const id = fieldId && asType !== "value" ? input[fieldId] : "";
+    const pendingKey = fieldId && asType !== "value" ? String(id != null ? id : "") : "";
+    const { promise, entry } = enqueuePendingWrite(pendingKey);
+    const userId = fns.getCurrentUser();
+    const basePath = refPath(userId);
+    const childPath = fieldId && asType !== "value" ? pendingKey : "";
+    const path = joinPaths(basePath, childPath);
+    const ref = fns.ref(path);
+    const updatePromise = fns.update(ref, input);
+    updatePromise.then(() => {
+      resolvePendingWrite(pendingKey, entry);
+    }).catch((error) => {
+      rejectPendingWrite(pendingKey, entry, error);
     });
-    pendingOutgoing$.set({});
+    if (!isRealtime) {
+      updatePromise.then(() => {
+        const onceRef = fieldId && asType !== "value" ? ref : fns.ref(basePath);
+        fns.once(
+          onceRef,
+          (snap) => {
+            const rawValue = snap.val();
+            const value = fieldId && asType !== "value" ? ensureFieldId(pendingKey, isNullOrUndefined(rawValue) ? {} : rawValue) : rawValue;
+            handleServerValue(pendingKey, value, (resolvedValue) => {
+              params.update({
+                value: resolvedValue,
+                mode: "merge"
+              });
+            });
+          },
+          (error) => {
+            rejectPendingWrite(pendingKey, entry, error);
+          }
+        );
+      }).catch(() => {
+      });
+    }
+    return promise;
   };
-  const create = readonly ? void 0 : (input) => {
+  const create = readonly ? void 0 : (input, params) => {
     addCreatedAt(input);
-    return upsert(input);
+    return upsert(input, params);
   };
-  const update = readonly ? void 0 : (input) => {
+  const update = readonly ? void 0 : (input, params) => {
     addUpdatedAt(input);
-    return upsert(input);
+    return upsert(input, params);
   };
   const deleteFn = readonly ? void 0 : (input) => {
     const path = joinPaths(
@@ -352,6 +501,7 @@ function syncedFirebase(props) {
   }
   return syncedCrud({
     ...rest,
+    // Workaround for type errors
     list,
     subscribe,
     create,

package/sync-plugins/keel.d.mts

@@ -1,5 +1,5 @@
-import { SyncedGetSetSubscribeBaseParams, OnErrorRetryParams, SyncedSetParams } from '@legendapp/state/sync';
-import { SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
+import { SyncedGetSetSubscribeBaseParams } from '@legendapp/state/sync';
+import { CrudErrorParams, SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
 
 interface KeelObjectBase {
     id: string;
@@ -13,6 +13,7 @@ type APIError = {
     type: string;
     message: string;
     requestId?: string;
+    error?: unknown;
 };
 type APIResult<T> = Result<T, APIError>;
 type Data<T> = {
@@ -24,7 +25,6 @@ type Err<U> = {
     error: U;
 };
 type Result<T, U> = NonNullable<Data<T> | Err<U>>;
-declare function generateKeelId(): string;
 interface KeelGetParams {
 }
 interface KeelListParams<Where = {}> {
@@ -50,6 +50,9 @@ interface KeelClient {
     api: {
         queries: Record<string, (i: any) => Promise<any>>;
     };
+    client: {
+        rawRequest: <T>(action: string, body: any) => Promise<APIResult<T>>;
+    };
 }
 interface SyncedKeelPropsManyBase<TRemote extends {
     id: string;
@@ -62,7 +65,7 @@ interface SyncedKeelPropsManyWhere<TRemote extends {
 }, TLocal, AOption extends CrudAsOption, Where extends Record<string, any>> extends SyncedKeelPropsManyBase<TRemote, TLocal, AOption> {
     list?: (params: KeelListParams<NoInfer<Where>>) => Promise<CrudResult<APIResult<{
         results: TRemote[];
-        pageInfo: any;
+        pageInfo?: any;
     }>>>;
     where?: Where | (() => Where);
 }
@@ -71,7 +74,7 @@ interface SyncedKeelPropsManyNoWhere<TRemote extends {
 }, TLocal, AOption extends CrudAsOption> extends SyncedKeelPropsManyBase<TRemote, TLocal, AOption> {
     list?: (params: KeelListParams<{}>) => Promise<CrudResult<APIResult<{
         results: TRemote[];
-        pageInfo: any;
+        pageInfo?: any;
     }>>>;
     where?: never | {};
 }
@@ -88,12 +91,8 @@ interface SyncedKeelPropsSingle<TRemote extends {
     list?: never;
     as?: never;
 }
-interface ErrorDetails {
-    type: 'create' | 'update' | 'delete';
-    params: SyncedSetParams<any>;
-    input: any;
+interface KeelErrorParams extends CrudErrorParams {
     action: string;
-    error: APIResult<any>['error'];
 }
 interface SyncedKeelPropsBase<TRemote extends {
     id: string;
@@ -102,7 +101,7 @@ interface SyncedKeelPropsBase<TRemote extends {
     create?: (i: NoInfer<Partial<TRemote>>) => Promise<APIResult<NoInfer<TRemote>>>;
     update?: (params: {
         where: any;
-        values?: Partial<TRemote>;
+        values?: Partial<NoInfer<TRemote>>;
     }) => Promise<APIResult<TRemote>>;
     delete?: (params: {
         id: string;
@@ -113,7 +112,7 @@ interface SyncedKeelPropsBase<TRemote extends {
     };
     refreshAuth?: () => void | Promise<void>;
     requireAuth?: boolean;
-    onError?: (error: Error, retryParams: OnErrorRetryParams, details: ErrorDetails) => void;
+    onError?: (error: Error, params: KeelErrorParams) => void;
 }
 declare function syncedKeel<TRemote extends {
     id: string;
@@ -122,4 +121,4 @@ declare function syncedKeel<TRemote extends {
     id: string;
 }, TLocal = TRemote, TOption extends CrudAsOption = 'object', Where extends Record<string, any> = {}>(props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsMany<TRemote, TLocal, TOption, Where>): SyncedCrudReturnType<TLocal, Exclude<TOption, 'value'>>;
 
-export { type KeelClient, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, generateKeelId, syncedKeel };
+export { type KeelClient, type KeelErrorParams, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, syncedKeel };

package/sync-plugins/keel.d.ts

@@ -1,5 +1,5 @@
-import { SyncedGetSetSubscribeBaseParams, OnErrorRetryParams, SyncedSetParams } from '@legendapp/state/sync';
-import { SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
+import { SyncedGetSetSubscribeBaseParams } from '@legendapp/state/sync';
+import { CrudErrorParams, SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
 
 interface KeelObjectBase {
     id: string;
@@ -13,6 +13,7 @@ type APIError = {
     type: string;
     message: string;
     requestId?: string;
+    error?: unknown;
 };
 type APIResult<T> = Result<T, APIError>;
 type Data<T> = {
@@ -24,7 +25,6 @@ type Err<U> = {
     error: U;
 };
 type Result<T, U> = NonNullable<Data<T> | Err<U>>;
-declare function generateKeelId(): string;
 interface KeelGetParams {
 }
 interface KeelListParams<Where = {}> {
@@ -50,6 +50,9 @@ interface KeelClient {
     api: {
         queries: Record<string, (i: any) => Promise<any>>;
     };
+    client: {
+        rawRequest: <T>(action: string, body: any) => Promise<APIResult<T>>;
+    };
 }
 interface SyncedKeelPropsManyBase<TRemote extends {
     id: string;
@@ -62,7 +65,7 @@ interface SyncedKeelPropsManyWhere<TRemote extends {
 }, TLocal, AOption extends CrudAsOption, Where extends Record<string, any>> extends SyncedKeelPropsManyBase<TRemote, TLocal, AOption> {
     list?: (params: KeelListParams<NoInfer<Where>>) => Promise<CrudResult<APIResult<{
         results: TRemote[];
-        pageInfo: any;
+        pageInfo?: any;
     }>>>;
     where?: Where | (() => Where);
 }
@@ -71,7 +74,7 @@ interface SyncedKeelPropsManyNoWhere<TRemote extends {
 }, TLocal, AOption extends CrudAsOption> extends SyncedKeelPropsManyBase<TRemote, TLocal, AOption> {
     list?: (params: KeelListParams<{}>) => Promise<CrudResult<APIResult<{
         results: TRemote[];
-        pageInfo: any;
+        pageInfo?: any;
     }>>>;
     where?: never | {};
 }
@@ -88,12 +91,8 @@ interface SyncedKeelPropsSingle<TRemote extends {
     list?: never;
     as?: never;
 }
-interface ErrorDetails {
-    type: 'create' | 'update' | 'delete';
-    params: SyncedSetParams<any>;
-    input: any;
+interface KeelErrorParams extends CrudErrorParams {
     action: string;
-    error: APIResult<any>['error'];
 }
 interface SyncedKeelPropsBase<TRemote extends {
     id: string;
@@ -102,7 +101,7 @@ interface SyncedKeelPropsBase<TRemote extends {
     create?: (i: NoInfer<Partial<TRemote>>) => Promise<APIResult<NoInfer<TRemote>>>;
     update?: (params: {
         where: any;
-        values?: Partial<TRemote>;
+        values?: Partial<NoInfer<TRemote>>;
     }) => Promise<APIResult<TRemote>>;
     delete?: (params: {
         id: string;
@@ -113,7 +112,7 @@ interface SyncedKeelPropsBase<TRemote extends {
     };
     refreshAuth?: () => void | Promise<void>;
     requireAuth?: boolean;
-    onError?: (error: Error, retryParams: OnErrorRetryParams, details: ErrorDetails) => void;
+    onError?: (error: Error, params: KeelErrorParams) => void;
 }
 declare function syncedKeel<TRemote extends {
     id: string;
@@ -122,4 +121,4 @@ declare function syncedKeel<TRemote extends {
     id: string;
 }, TLocal = TRemote, TOption extends CrudAsOption = 'object', Where extends Record<string, any> = {}>(props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsMany<TRemote, TLocal, TOption, Where>): SyncedCrudReturnType<TLocal, Exclude<TOption, 'value'>>;
 
-export { type KeelClient, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, generateKeelId, syncedKeel };
+export { type KeelClient, type KeelErrorParams, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, syncedKeel };