@legendapp/state 3.0.0-alpha.33 → 3.0.0-alpha.35

package/sync-plugins/keel.d.mts

@@ -1,5 +1,5 @@
-import { SyncedGetSetSubscribeBaseParams, SyncedOptions, SyncedSetParams } from '@legendapp/state/sync';
-import { SyncedCrudPropsBase, CrudAsOption, SyncedCrudReturnType, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
+import { SyncedGetSetSubscribeBaseParams, OnErrorRetryParams, SyncedSetParams } from '@legendapp/state/sync';
+import { SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
 
 interface KeelObjectBase {
     id: string;
@@ -39,30 +39,17 @@ interface KeelListParams<Where = {}> {
     before?: string;
 }
 interface KeelRealtimePlugin {
-    subscribe: (realtimeKey: string, params: SyncedGetSetSubscribeBaseParams) => void;
-    setLatestChange: (realtimeKey: string, time: Date) => void;
+    subscribe: (realtimeKey: string, params: SyncedGetSetSubscribeBaseParams) => () => void;
+    setSaved: (realtimeKey: string) => void;
 }
-interface SyncedKeelConfiguration extends Omit<SyncedCrudPropsBase<any>, keyof SyncedOptions | 'create' | 'update' | 'delete' | 'onSaved' | 'updatePartial' | 'fieldCreatedAt' | 'fieldUpdatedAt' | 'generateId'> {
-    client: {
-        auth: {
-            refresh: () => Promise<APIResult<boolean>>;
-            isAuthenticated: () => Promise<APIResult<boolean>>;
-        };
-        api: {
-            queries: Record<string, (i: any) => Promise<any>>;
-        };
+interface KeelClient {
+    auth: {
+        refresh: () => Promise<APIResult<boolean>>;
+        isAuthenticated: () => Promise<APIResult<boolean>>;
+    };
+    api: {
+        queries: Record<string, (i: any) => Promise<any>>;
     };
-    realtimePlugin?: KeelRealtimePlugin;
-    as?: Exclude<CrudAsOption, 'value'>;
-    enabled?: boolean;
-    onError?: (params: {
-        type: 'create' | 'update' | 'delete';
-        params: SyncedSetParams<any>;
-        input: any;
-        action: string;
-        error: APIResult<any>['error'];
-    }) => void;
-    refreshAuth?: () => void | Promise<void>;
 }
 interface SyncedKeelPropsManyBase<TRemote extends {
     id: string;
@@ -101,9 +88,17 @@ interface SyncedKeelPropsSingle<TRemote extends {
     list?: never;
     as?: never;
 }
+interface ErrorDetails {
+    type: 'create' | 'update' | 'delete';
+    params: SyncedSetParams<any>;
+    input: any;
+    action: string;
+    error: APIResult<any>['error'];
+}
 interface SyncedKeelPropsBase<TRemote extends {
     id: string;
-}, TLocal = TRemote> extends Omit<SyncedCrudPropsBase<TRemote, TLocal>, 'create' | 'update' | 'delete' | 'updatePartial' | 'fieldUpdatedAt' | 'fieldCreatedAt'> {
+}, TLocal = TRemote> extends Omit<SyncedCrudPropsBase<TRemote, TLocal>, 'create' | 'update' | 'delete' | 'updatePartial' | 'fieldUpdatedAt' | 'fieldCreatedAt' | 'onError'> {
+    client?: KeelClient;
     create?: (i: NoInfer<Partial<TRemote>>) => Promise<APIResult<NoInfer<TRemote>>>;
     update?: (params: {
         where: any;
@@ -112,9 +107,14 @@ interface SyncedKeelPropsBase<TRemote extends {
     delete?: (params: {
         id: string;
     }) => Promise<APIResult<string>>;
+    realtime?: {
+        path?: (action: string, inputs: any) => string | Promise<string>;
+        plugin?: KeelRealtimePlugin;
+    };
+    refreshAuth?: () => void | Promise<void>;
+    requireAuth?: boolean;
+    onError?: (error: Error, retryParams: OnErrorRetryParams, details: ErrorDetails) => void;
 }
-declare function getSyncedKeelConfiguration(): SyncedKeelConfiguration;
-declare function configureSyncedKeel(config: SyncedKeelConfiguration): void;
 declare function syncedKeel<TRemote extends {
     id: string;
 }, TLocal = TRemote>(props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
@@ -122,4 +122,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 KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelConfiguration, configureSyncedKeel, generateKeelId, getSyncedKeelConfiguration, syncedKeel };
+export { type KeelClient, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, generateKeelId, syncedKeel };

package/sync-plugins/keel.d.ts

@@ -1,5 +1,5 @@
-import { SyncedGetSetSubscribeBaseParams, SyncedOptions, SyncedSetParams } from '@legendapp/state/sync';
-import { SyncedCrudPropsBase, CrudAsOption, SyncedCrudReturnType, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
+import { SyncedGetSetSubscribeBaseParams, OnErrorRetryParams, SyncedSetParams } from '@legendapp/state/sync';
+import { SyncedCrudPropsBase, SyncedCrudReturnType, CrudAsOption, SyncedCrudPropsSingle, CrudResult, SyncedCrudPropsMany } from '@legendapp/state/sync-plugins/crud';
 
 interface KeelObjectBase {
     id: string;
@@ -39,30 +39,17 @@ interface KeelListParams<Where = {}> {
     before?: string;
 }
 interface KeelRealtimePlugin {
-    subscribe: (realtimeKey: string, params: SyncedGetSetSubscribeBaseParams) => void;
-    setLatestChange: (realtimeKey: string, time: Date) => void;
+    subscribe: (realtimeKey: string, params: SyncedGetSetSubscribeBaseParams) => () => void;
+    setSaved: (realtimeKey: string) => void;
 }
-interface SyncedKeelConfiguration extends Omit<SyncedCrudPropsBase<any>, keyof SyncedOptions | 'create' | 'update' | 'delete' | 'onSaved' | 'updatePartial' | 'fieldCreatedAt' | 'fieldUpdatedAt' | 'generateId'> {
-    client: {
-        auth: {
-            refresh: () => Promise<APIResult<boolean>>;
-            isAuthenticated: () => Promise<APIResult<boolean>>;
-        };
-        api: {
-            queries: Record<string, (i: any) => Promise<any>>;
-        };
+interface KeelClient {
+    auth: {
+        refresh: () => Promise<APIResult<boolean>>;
+        isAuthenticated: () => Promise<APIResult<boolean>>;
+    };
+    api: {
+        queries: Record<string, (i: any) => Promise<any>>;
     };
-    realtimePlugin?: KeelRealtimePlugin;
-    as?: Exclude<CrudAsOption, 'value'>;
-    enabled?: boolean;
-    onError?: (params: {
-        type: 'create' | 'update' | 'delete';
-        params: SyncedSetParams<any>;
-        input: any;
-        action: string;
-        error: APIResult<any>['error'];
-    }) => void;
-    refreshAuth?: () => void | Promise<void>;
 }
 interface SyncedKeelPropsManyBase<TRemote extends {
     id: string;
@@ -101,9 +88,17 @@ interface SyncedKeelPropsSingle<TRemote extends {
     list?: never;
     as?: never;
 }
+interface ErrorDetails {
+    type: 'create' | 'update' | 'delete';
+    params: SyncedSetParams<any>;
+    input: any;
+    action: string;
+    error: APIResult<any>['error'];
+}
 interface SyncedKeelPropsBase<TRemote extends {
     id: string;
-}, TLocal = TRemote> extends Omit<SyncedCrudPropsBase<TRemote, TLocal>, 'create' | 'update' | 'delete' | 'updatePartial' | 'fieldUpdatedAt' | 'fieldCreatedAt'> {
+}, TLocal = TRemote> extends Omit<SyncedCrudPropsBase<TRemote, TLocal>, 'create' | 'update' | 'delete' | 'updatePartial' | 'fieldUpdatedAt' | 'fieldCreatedAt' | 'onError'> {
+    client?: KeelClient;
     create?: (i: NoInfer<Partial<TRemote>>) => Promise<APIResult<NoInfer<TRemote>>>;
     update?: (params: {
         where: any;
@@ -112,9 +107,14 @@ interface SyncedKeelPropsBase<TRemote extends {
     delete?: (params: {
         id: string;
     }) => Promise<APIResult<string>>;
+    realtime?: {
+        path?: (action: string, inputs: any) => string | Promise<string>;
+        plugin?: KeelRealtimePlugin;
+    };
+    refreshAuth?: () => void | Promise<void>;
+    requireAuth?: boolean;
+    onError?: (error: Error, retryParams: OnErrorRetryParams, details: ErrorDetails) => void;
 }
-declare function getSyncedKeelConfiguration(): SyncedKeelConfiguration;
-declare function configureSyncedKeel(config: SyncedKeelConfiguration): void;
 declare function syncedKeel<TRemote extends {
     id: string;
 }, TLocal = TRemote>(props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
@@ -122,4 +122,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 KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelConfiguration, configureSyncedKeel, generateKeelId, getSyncedKeelConfiguration, syncedKeel };
+export { type KeelClient, type KeelGetParams, type KeelKey, KeelKeys, type KeelListParams, type KeelObjectBase, type KeelRealtimePlugin, type OmitKeelBuiltins, type SyncedKeelPropsBase, generateKeelId, syncedKeel };

package/sync-plugins/keel.js

@@ -1,7 +1,6 @@
 'use strict';
 
 var state = require('@legendapp/state');
-var sync = require('@legendapp/state/sync');
 var crud = require('@legendapp/state/sync-plugins/crud');
 var ksuid = require('ksuid');
 
@@ -14,24 +13,50 @@ var KeelKeys = ["createdAt", "updatedAt"];
 function generateKeelId() {
   return ksuid__default.default.randomSync().string;
 }
-var keelConfig = {};
 var modifiedClients = /* @__PURE__ */ new WeakSet();
-var isEnabled$ = state.observable(true);
-async function ensureAuthToken() {
-  await state.when(isEnabled$.get());
-  if (keelConfig.refreshAuth) {
-    await keelConfig.refreshAuth();
+var isAuthed$ = state.observable(false);
+var isAuthing$ = state.observable(false);
+async function ensureAuthToken(props, force) {
+  if (!force && isAuthed$.get()) {
+    return true;
   }
-  let isAuthed = await keelConfig.client.auth.isAuthenticated();
+  const { client, refreshAuth } = props;
+  let isAuthed = await client.auth.isAuthenticated().then(({ data }) => data);
   if (!isAuthed) {
-    isAuthed = await keelConfig.client.auth.refresh();
+    if (!force && isAuthing$.get()) {
+      return state.when(
+        () => !isAuthing$.get(),
+        () => isAuthed$.get()
+      );
+    }
+    isAuthing$.set(true);
+    if (refreshAuth) {
+      await refreshAuth();
+    }
+    isAuthed = await client.auth.isAuthenticated().then(({ data }) => data);
+    if (!isAuthed) {
+      isAuthed = await client.auth.refresh().then(({ data }) => data);
+    }
+  }
+  if (isAuthed) {
+    state.batch(() => {
+      isAuthed$.set(true);
+      isAuthing$.set(false);
+    });
+  } else {
+    setTimeout(() => ensureAuthToken(
+      props,
+      /*force*/
+      true
+    ), 1e3);
   }
   return isAuthed;
 }
-async function handleApiError(error, retry) {
+async function handleApiError(props, error, retry) {
   if (error.type === "unauthorized" || error.type === "forbidden") {
     console.warn("Keel token expired, refreshing...");
-    await ensureAuthToken();
+    isAuthed$.set(false);
+    await ensureAuthToken(props);
   }
 }
 function convertObjectToCreate(item) {
@@ -51,49 +76,30 @@ function convertObjectToCreate(item) {
   });
   return cloned;
 }
-function getSyncedKeelConfiguration() {
-  return keelConfig;
-}
-function configureSyncedKeel(config) {
-  const { enabled, realtimePlugin, client, ...rest } = config;
-  Object.assign(keelConfig, sync.removeNullUndefined(rest));
-  if (enabled !== void 0) {
-    isEnabled$.set(enabled);
-  }
-  if (realtimePlugin) {
-    keelConfig.realtimePlugin = realtimePlugin;
-    if (client && !modifiedClients.has(client)) {
-      modifiedClients.add(client);
-      const queries = client.api.queries;
-      Object.keys(queries).forEach((key) => {
-        if (key.startsWith("list")) {
-          const oldFn = queries[key];
-          queries[key] = (i) => {
-            const realtimeKey = [key, ...Object.values(i.where || {})].filter((value) => value && typeof value !== "object").join("/");
-            const subscribe = (params) => {
-              if (realtimeKey) {
-                return realtimePlugin.subscribe(realtimeKey, params);
-              }
-            };
-            return oldFn(i).then((ret) => {
-              if (subscribe) {
-                ret.subscribe = subscribe;
-                ret.subscribeKey = realtimeKey;
-              }
-              return ret;
-            });
+var realtimeState = { current: {} };
+function setupRealtime(props) {
+  const { client } = props;
+  if (client && !modifiedClients.has(client)) {
+    modifiedClients.add(client);
+    const queries = client.api.queries;
+    Object.keys(queries).forEach((key) => {
+      if (key.startsWith("list")) {
+        const origFn = queries[key];
+        queries[key] = (i) => {
+          realtimeState.current = {
+            lastAction: key,
+            lastParams: i
           };
-        }
-      });
-    }
+          return origFn(i);
+        };
+      }
+    });
   }
 }
 var NumPerPage = 200;
-async function getAllPages(listFn, params) {
+async function getAllPages(props, listFn, params) {
   const allData = [];
   let pageInfo = void 0;
-  let subscribe_;
-  let subscribeKey_;
   const { first: firstParam } = params;
   do {
     const first = firstParam ? Math.min(firstParam - allData.length, NumPerPage) : NumPerPage;
@@ -105,13 +111,9 @@ async function getAllPages(listFn, params) {
     pageInfo = void 0;
     const ret = await listFn(paramsWithCursor);
     if (ret) {
-      const { data, error, subscribe, subscribeKey } = ret;
-      if (subscribe) {
-        subscribe_ = subscribe;
-        subscribeKey_ = subscribeKey;
-      }
+      const { data, error } = ret;
       if (error) {
-        await handleApiError(error);
+        await handleApiError(props, error);
         throw new Error(error.message);
       } else if (data) {
         pageInfo = data.pageInfo;
@@ -119,23 +121,25 @@ async function getAllPages(listFn, params) {
       }
     }
   } while (pageInfo == null ? void 0 : pageInfo.hasNextPage);
-  return { results: allData, subscribe: subscribe_, subscribeKey: subscribeKey_ };
+  return allData;
 }
 function syncedKeel(props) {
-  const { realtimePlugin } = keelConfig;
-  props = { ...keelConfig, ...props };
   const {
     get: getParam,
     list: listParam,
     create: createParam,
     update: updateParam,
     delete: deleteParam,
+    subscribe: subscribeParam,
     first,
     where: whereParam,
     waitFor,
     waitForSet,
     fieldDeleted,
+    realtime,
     mode,
+    onError,
+    requireAuth = true,
     ...rest
   } = props;
   const { changesSince } = props;
@@ -144,13 +148,15 @@ function syncedKeel(props) {
   const subscribeFnKey$ = state.observable("");
   const fieldCreatedAt = "createdAt";
   const fieldUpdatedAt = "updatedAt";
-  const setupSubscribe = (doSubscribe, subscribeKey, lastSync) => {
-    subscribeFn = doSubscribe;
-    subscribeFnKey$.set(subscribeKey);
-    if (realtimePlugin && lastSync) {
-      realtimePlugin.setLatestChange(subscribeKey, new Date(lastSync));
+  const setupSubscribe = realtime ? async (getParams) => {
+    const { lastAction, lastParams } = realtimeState.current;
+    const { path, plugin } = realtime;
+    if (lastAction && path && plugin) {
+      const key = await path(lastAction, lastParams);
+      subscribeFn = () => realtime.plugin.subscribe(key, getParams);
+      subscribeFnKey$.set(key);
     }
-  };
+  } : void 0;
   const list = listParam ? async (listParams) => {
     const { lastSync } = listParams;
     const queryBySync = !!lastSync && changesSince === "last-sync";
@@ -159,18 +165,21 @@ function syncedKeel(props) {
       state.isFunction(whereParam) ? whereParam() : whereParam
     );
     const params = { where, first };
-    const { results, subscribe: subscribe2, subscribeKey } = await getAllPages(listParam, params);
-    if (subscribe2) {
-      setupSubscribe(() => subscribe2(listParams), subscribeKey, lastSync);
+    realtimeState.current = {};
+    const promise = getAllPages(props, listParam, params);
+    if (realtime) {
+      setupSubscribe(listParams);
     }
-    return results;
+    return promise;
   } : void 0;
   const get = getParam ? async (getParams) => {
     const { refresh } = getParams;
-    const { data, error, subscribe: subscribe2, subscribeKey } = await getParam({ refresh });
-    if (subscribe2) {
-      setupSubscribe(() => subscribe2(getParams), subscribeKey);
+    realtimeState.current = {};
+    const promise = getParam({ refresh });
+    if (realtime) {
+      setupSubscribe(getParams);
     }
+    const { data, error } = await promise;
     if (error) {
       throw new Error(error.message);
     } else {
@@ -179,17 +188,16 @@ function syncedKeel(props) {
   } : void 0;
   const onSaved = ({ saved }) => {
     if (saved) {
-      const updatedAt = saved[fieldUpdatedAt];
-      if (updatedAt && realtimePlugin) {
+      if (realtime == null ? void 0 : realtime.plugin) {
         const subscribeFnKey = subscribeFnKey$.get();
         if (subscribeFnKey) {
-          realtimePlugin.setLatestChange(subscribeFnKey, updatedAt);
+          realtime == null ? void 0 : realtime.plugin.setSaved(subscribeFnKey);
         }
       }
     }
   };
   const handleSetError = async (error, params, input, fn, from) => {
-    var _a, _b, _c;
+    var _a, _b;
     const { retryNum, update: update2 } = params;
     if (from === "create" && ((_a = error.message) == null ? void 0 : _a.includes("for the unique")) && ((_b = error.message) == null ? void 0 : _b.includes("must be unique"))) {
       if (__DEV__) {
@@ -208,13 +216,19 @@ function syncedKeel(props) {
         params.cancelRetry = true;
       }
     } else if (error.type === "bad_request") {
-      (_c = keelConfig.onError) == null ? void 0 : _c.call(keelConfig, { error, params, input, type: from, action: fn.name || fn.toString() });
+      onError == null ? void 0 : onError(new Error(error.message), params, {
+        error,
+        params,
+        input,
+        type: from,
+        action: fn.name || fn.toString()
+      });
       if (retryNum > 4) {
         params.cancelRetry = true;
       }
       throw new Error(error.message, { cause: { input } });
     } else {
-      await handleApiError(error);
+      await handleApiError(props, error);
       throw new Error(error.message, { cause: { input } });
     }
   };
@@ -244,7 +258,10 @@ function syncedKeel(props) {
     }
     return data;
   } : void 0;
-  const subscribe = (params) => {
+  if (realtime) {
+    setupRealtime(props);
+  }
+  const subscribe = subscribeParam || (realtime ? (params) => {
     let unsubscribe = void 0;
     state.when(subscribeFnKey$, () => {
       unsubscribe = subscribeFn(params);
@@ -252,7 +269,7 @@ function syncedKeel(props) {
     return () => {
       unsubscribe == null ? void 0 : unsubscribe();
     };
-  };
+  } : void 0);
   return crud.syncedCrud({
     ...rest,
     as: asType,
@@ -261,8 +278,17 @@ function syncedKeel(props) {
     create,
     update,
     delete: deleteFn,
-    waitFor: () => isEnabled$.get() && (waitFor ? state.computeSelector(waitFor) : true),
-    waitForSet: (params) => isEnabled$.get() && (waitForSet ? state.isFunction(waitForSet) ? waitForSet(params) : waitForSet : true),
+    waitFor: () => {
+      ensureAuthToken(props);
+      return [requireAuth ? isAuthed$ : true, waitFor || true];
+    },
+    waitForSet: (params) => {
+      ensureAuthToken(props);
+      return [
+        requireAuth ? isAuthed$ : true,
+        () => waitForSet ? state.isFunction(waitForSet) ? waitForSet(params) : waitForSet : true
+      ];
+    },
     onSaved,
     fieldCreatedAt,
     fieldUpdatedAt,
@@ -277,7 +303,5 @@ function syncedKeel(props) {
 }
 
 exports.KeelKeys = KeelKeys;
-exports.configureSyncedKeel = configureSyncedKeel;
 exports.generateKeelId = generateKeelId;
-exports.getSyncedKeelConfiguration = getSyncedKeelConfiguration;
 exports.syncedKeel = syncedKeel;