@legendapp/state 2.2.0-next.8 → 2.2.0-next.80

package/src/sync-plugins/fetch.ts

@@ -0,0 +1,72 @@
+import { Selector, computeSelector } from '@legendapp/state';
+import { synced, SyncTransform, Synced, SyncedOptions, SyncedSetParams } from '@legendapp/state/sync';
+
+export interface SyncedFetchProps<TRemote, TLocal> extends Omit<SyncedOptions, 'get' | 'set' | 'transform'> {
+    get: Selector<string>;
+    set?: Selector<string>;
+    getInit?: RequestInit;
+    setInit?: RequestInit;
+    transform?: SyncTransform<TLocal, TRemote>;
+    valueType?: 'arrayBuffer' | 'blob' | 'formData' | 'json' | 'text';
+    onSavedValueType?: 'arrayBuffer' | 'blob' | 'formData' | 'json' | 'text';
+    onSaved?(saved: TLocal, input: TRemote): Partial<TLocal> | void;
+}
+
+export function syncedFetch<TRemote, TLocal = TRemote>(props: SyncedFetchProps<TRemote, TLocal>): Synced<TLocal> {
+    const {
+        get: getParam,
+        set: setParam,
+        getInit,
+        setInit,
+        valueType,
+        onSaved,
+        onSavedValueType,
+        transform,
+        ...rest
+    } = props;
+    const get = async () => {
+        const url = computeSelector(getParam);
+        const response = await fetch(url, getInit);
+
+        if (!response.ok) {
+            throw new Error(response.statusText);
+        }
+
+        let value = await response[valueType || 'json']();
+
+        if (transform?.load) {
+            value = transform?.load(value, 'get');
+        }
+
+        return value;
+    };
+
+    let set: ((params: SyncedSetParams<TRemote>) => void | Promise<any>) | undefined = undefined;
+    if (setParam) {
+        set = async ({ value, update }: SyncedSetParams<any>) => {
+            const url = computeSelector(setParam);
+
+            const response = await fetch(
+                url,
+                Object.assign({ method: 'POST' }, setInit, { body: JSON.stringify(value) }),
+            );
+            if (!response.ok) {
+                throw new Error(response.statusText);
+            }
+            if (onSaved) {
+                const responseValue = await response[onSavedValueType || valueType || 'json']();
+                const transformed = transform?.load ? await transform.load(responseValue, 'set') : responseValue;
+                const valueSave = onSaved(transformed, value);
+                update({
+                    value: valueSave,
+                });
+            }
+        };
+    }
+
+    return synced({
+        ...rest,
+        get,
+        set,
+    });
+}

package/src/sync-plugins/keel.ts

@@ -0,0 +1,452 @@
+import { computeSelector, observable, when, internal } from '@legendapp/state';
+import {
+    SyncedOptions,
+    removeNullUndefined,
+    type SyncedGetParams,
+    type SyncedSetParams,
+    type SyncedSubscribeParams,
+} from '@legendapp/state/sync';
+import {
+    CrudAsOption,
+    CrudResult,
+    SyncedCrudPropsBase,
+    SyncedCrudPropsMany,
+    SyncedCrudPropsSingle,
+    SyncedCrudReturnType,
+    syncedCrud,
+} from '@legendapp/state/sync-plugins/crud';
+const { clone } = internal;
+
+// Keel types
+export interface KeelObjectBase {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export type KeelKey = 'createdAt' | 'updatedAt';
+export const KeelKeys: KeelKey[] = ['createdAt', 'updatedAt'];
+export type OmitKeelBuiltins<T, T2 extends string = ''> = Omit<T, KeelKey | T2>;
+type APIError = { type: string; message: string; requestId?: string };
+
+type APIResult<T> = Result<T, APIError>;
+
+type Data<T> = {
+    data: T;
+    error?: never;
+};
+
+type Err<U> = {
+    data?: never;
+    error: U;
+};
+
+type Result<T, U> = NonNullable<Data<T> | Err<U>>;
+
+// Keel plugin types
+
+interface GetGetParams {
+    refresh: () => void;
+}
+
+interface ListGetParams {
+    where: { updatedAt?: { after: Date } };
+    refresh?: () => void;
+    after?: string;
+    first?: number;
+}
+
+export interface KeelRealtimePlugin {
+    subscribe: (realtimeKey: string, refresh: () => void) => void;
+    setLatestChange: (realtimeKey: string, time: Date) => void;
+}
+
+export interface SyncedKeelConfiguration
+    extends Omit<
+        SyncedCrudPropsBase<any>,
+        | keyof SyncedOptions
+        | 'create'
+        | 'update'
+        | 'delete'
+        | 'onSaved'
+        | 'transform'
+        | 'updatePartial'
+        | 'subscribe'
+        | 'fieldCreatedAt'
+        | 'fieldUpdatedAt'
+    > {
+    client: {
+        auth: { refresh: () => Promise<boolean>; isAuthenticated: () => Promise<boolean> };
+        api: { queries: Record<string, (i: any) => Promise<any>> };
+    };
+    realtimePlugin?: KeelRealtimePlugin;
+    as?: Exclude<CrudAsOption, 'first'>;
+    enabled?: boolean;
+    onError?: (params: APIResult<any>['error']) => void;
+}
+
+interface PageInfo {
+    count: number;
+    endCursor: string;
+    hasNextPage: boolean;
+    startCursor: string;
+    totalCount: number;
+}
+
+interface SyncedKeelPropsMany<TRemote, TLocal, AOption extends CrudAsOption>
+    extends Omit<SyncedCrudPropsMany<TRemote, TLocal, AOption>, 'list'> {
+    list?: (params: ListGetParams) => Promise<CrudResult<APIResult<{ results: TRemote[]; pageInfo: any }>>>;
+    first?: number;
+    get?: never;
+}
+
+interface SyncedKeelPropsSingle<TRemote, TLocal> extends Omit<SyncedCrudPropsSingle<TRemote, TLocal>, 'get'> {
+    get?: (params: GetGetParams) => Promise<APIResult<TRemote>>;
+
+    first?: never;
+    list?: never;
+    as?: never;
+}
+
+interface SyncedKeelPropsBase<TRemote extends { id: string }, TLocal = TRemote>
+    extends Omit<SyncedCrudPropsBase<TRemote, TLocal>, 'create' | 'update' | 'delete'> {
+    create?: (i: NoInfer<Partial<TRemote>>) => Promise<APIResult<NoInfer<TRemote>>>;
+    update?: (params: { where: any; values?: Partial<TRemote> }) => Promise<APIResult<TRemote>>;
+    delete?: (params: { id: string }) => Promise<APIResult<string>>;
+}
+
+const keelConfig: SyncedKeelConfiguration = {} as SyncedKeelConfiguration;
+const modifiedClients = new WeakSet<Record<string, any>>();
+const isEnabled$ = observable(true);
+
+async function ensureAuthToken() {
+    await when(isEnabled$.get());
+    let isAuthed = await keelConfig.client.auth.isAuthenticated();
+    if (!isAuthed) {
+        isAuthed = await keelConfig.client.auth.refresh();
+    }
+
+    return isAuthed;
+}
+
+async function handleApiError(error: APIError, retry?: () => any) {
+    if (error.type === 'unauthorized' || error.type === 'forbidden') {
+        console.warn('Keel token expired, refreshing...');
+        await ensureAuthToken();
+        // Retry
+        retry?.();
+    }
+}
+
+function convertObjectToCreate<TRemote, TLocal>(item: TRemote) {
+    const cloned = clone(item);
+    Object.keys(cloned).forEach((key) => {
+        if (key.endsWith('Id')) {
+            if (cloned[key]) {
+                cloned[key.slice(0, -2)] = { id: cloned[key] };
+            }
+            delete cloned[key];
+        }
+    });
+    delete cloned.createdAt;
+    delete cloned.updatedAt;
+    return cloned as unknown as TLocal;
+}
+
+export function configureSyncedKeel(config: SyncedKeelConfiguration) {
+    const { enabled, realtimePlugin, ...rest } = config;
+    Object.assign(keelConfig, removeNullUndefined(rest));
+
+    if (enabled !== undefined) {
+        isEnabled$.set(enabled);
+    }
+    const { client } = keelConfig;
+
+    if (realtimePlugin) {
+        keelConfig.realtimePlugin = realtimePlugin;
+        if (client && !modifiedClients.has(client)) {
+            modifiedClients.add(client);
+            const queries = client.api.queries;
+            Object.keys(queries).forEach((key) => {
+                const oldFn = queries[key];
+                queries[key] = (i) => {
+                    const subscribe =
+                        key.startsWith('list') &&
+                        i.where &&
+                        (({ refresh }: SyncedSubscribeParams) => {
+                            const realtimeChild = Object.values(i.where)
+                                .filter((value) => value && typeof value !== 'object')
+                                .join('/');
+
+                            if (realtimeChild) {
+                                const realtimeKey = `${key}/${realtimeChild}`;
+
+                                realtimePlugin.subscribe(realtimeKey, refresh);
+                                return realtimeKey;
+                            }
+                        });
+                    return oldFn(i).then((ret) => {
+                        if (subscribe) {
+                            ret.subscribe = subscribe;
+                        }
+                        return ret;
+                    });
+                };
+            });
+        }
+    }
+}
+
+const NumPerPage = 200;
+async function getAllPages<TRemote>(
+    listFn: (params: ListGetParams) => Promise<
+        APIResult<{
+            results: TRemote[];
+            pageInfo: any;
+        }>
+    >,
+    params: ListGetParams,
+): Promise<{ results: TRemote[]; subscribe: (params: { refresh: () => void }) => string }> {
+    const allData: TRemote[] = [];
+    let pageInfo: PageInfo | undefined = undefined;
+    let subscribe_;
+
+    const { first: firstParam } = params;
+
+    do {
+        const first = firstParam ? Math.min(firstParam - allData.length, NumPerPage) : NumPerPage;
+        if (first < 1) {
+            break;
+        }
+        const pageEndCursor = pageInfo?.endCursor;
+        const paramsWithCursor: ListGetParams = pageEndCursor
+            ? { first, ...params, after: pageEndCursor }
+            : { first, ...params };
+        pageInfo = undefined;
+        const ret = await listFn(paramsWithCursor);
+
+        if (ret) {
+            // @ts-expect-error TODOKEEL
+            const { data, error, subscribe } = ret;
+
+            if (subscribe) {
+                subscribe_ = subscribe;
+            }
+
+            if (error) {
+                await handleApiError(error);
+                throw new Error(error.message);
+            } else if (data) {
+                pageInfo = data.pageInfo as PageInfo;
+                allData.push(...data.results);
+            }
+        }
+    } while (pageInfo?.hasNextPage);
+
+    return { results: allData, subscribe: subscribe_ };
+}
+
+export function syncedKeel<TRemote extends { id: string }, TLocal = TRemote>(
+    props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsSingle<TRemote, TLocal>,
+): SyncedCrudReturnType<TLocal, 'first'>;
+export function syncedKeel<TRemote extends { id: string }, TLocal = TRemote, TOption extends CrudAsOption = 'object'>(
+    props: SyncedKeelPropsBase<TRemote, TLocal> & SyncedKeelPropsMany<TRemote, TLocal, TOption>,
+): SyncedCrudReturnType<TLocal, Exclude<TOption, 'first'>>;
+export function syncedKeel<TRemote extends { id: string }, TLocal = TRemote, TOption extends CrudAsOption = 'object'>(
+    props: SyncedKeelPropsBase<TRemote, TLocal> &
+        (SyncedKeelPropsSingle<TRemote, TLocal> | SyncedKeelPropsMany<TRemote, TLocal, TOption>),
+): SyncedCrudReturnType<TLocal, TOption> {
+    const {
+        get: getParam,
+        list: listParam,
+        create: createParam,
+        update: updateParam,
+        delete: deleteParam,
+        first,
+        waitFor,
+        waitForSet,
+        generateId: generateIdParam,
+        ...rest
+    } = props;
+
+    const { changesSince } = props;
+
+    let asType = props.as as TOption;
+
+    if (!asType) {
+        asType = (getParam ? 'first' : keelConfig.as || undefined) as TOption;
+    }
+
+    const generateId = generateIdParam || keelConfig.generateId;
+
+    const realtimePlugin = keelConfig.realtimePlugin;
+    let realtimeKeyList: string | undefined = undefined;
+    let realtimeKeyGet: string | undefined = undefined;
+
+    const fieldCreatedAt: KeelKey = 'createdAt';
+    const fieldUpdatedAt: KeelKey = 'updatedAt';
+
+    const list = listParam
+        ? async (listParams: SyncedGetParams) => {
+              const { lastSync, refresh } = listParams;
+              const queryBySync = !!lastSync && changesSince === 'last-sync';
+              // If this is one of the customized functions for use with realtime then we need to pass
+              // the refresh function to it
+              const isRawRequest = (listParam || getParam).toString().includes('rawRequest');
+              // If querying with lastSync pass it to the "where" parameters
+              const where = queryBySync ? { updatedAt: { after: new Date(+new Date(lastSync) + 1) } } : {};
+              const params: ListGetParams = isRawRequest ? { where, first } : { where, refresh, first };
+
+              // TODO: Error?
+              const { results, subscribe } = await getAllPages(listParam, params);
+              if (!realtimeKeyList) {
+                  realtimeKeyList = subscribe?.({ refresh });
+              }
+
+              return results;
+          }
+        : undefined;
+
+    const get = getParam
+        ? async (getParams: SyncedGetParams) => {
+              const { refresh } = getParams;
+              //   @ts-expect-error TODOKEEL
+              const { data, error, subscribe } = await getParam({ refresh });
+              if (!realtimeKeyGet) {
+                  realtimeKeyGet = subscribe?.({ refresh });
+              }
+
+              if (error) {
+                  throw new Error(error.message);
+              } else {
+                  return data as TRemote;
+              }
+          }
+        : undefined;
+
+    const onSaved = (data: TLocal, input: TRemote, isCreate: boolean): Partial<TLocal> | void => {
+        if (data) {
+            const savedOut: Partial<TLocal> = {};
+            if (isCreate) {
+                // Update with any fields that were undefined when creating
+                Object.keys(data).forEach((key) => {
+                    if (input[key as keyof TRemote] === undefined) {
+                        savedOut[key as keyof TLocal] = data[key as keyof TLocal];
+                    }
+                });
+            } else {
+                // Update with any fields ending in createdAt or updatedAt
+                Object.keys(data).forEach((key) => {
+                    const k = key as keyof TLocal;
+                    const keyLower = key.toLowerCase();
+                    if ((keyLower.endsWith('createdat') || keyLower.endsWith('updatedat')) && data[k] instanceof Date) {
+                        savedOut[k] = data[k];
+                    }
+                });
+            }
+
+            const updatedAt = data[fieldUpdatedAt as keyof TLocal] as Date;
+
+            if (updatedAt && realtimePlugin) {
+                if (realtimeKeyGet) {
+                    realtimePlugin.setLatestChange(realtimeKeyGet, updatedAt);
+                }
+                if (realtimeKeyList) {
+                    realtimePlugin.setLatestChange(realtimeKeyList, updatedAt);
+                }
+            }
+
+            return savedOut;
+        }
+    };
+
+    const handleSetError = async (error: APIError, params: SyncedSetParams<TRemote>, isCreate: boolean) => {
+        const { retryNum, cancelRetry, update } = params;
+
+        if (
+            isCreate &&
+            (error.message as string)?.includes('for the unique') &&
+            (error.message as string)?.includes('must be unique')
+        ) {
+            if (__DEV__) {
+                console.log('Creating duplicate data already saved, just ignore.');
+            }
+            // This has already been saved but didn't update pending changes, so just update with {} to clear the pending state
+            update({
+                value: {},
+                mode: 'assign',
+            });
+        } else if (error.type === 'bad_request') {
+            keelConfig.onError?.(error);
+
+            if (retryNum > 4) {
+                cancelRetry();
+            }
+
+            throw new Error(error.message);
+        } else {
+            await handleApiError(error);
+
+            throw new Error(error.message);
+        }
+    };
+
+    const create = createParam
+        ? async (input: TRemote, params: SyncedSetParams<TRemote>) => {
+              const { data, error } = await createParam(convertObjectToCreate(input));
+
+              if (error) {
+                  handleSetError(error, params, true);
+              }
+
+              return data;
+          }
+        : undefined;
+
+    const update = updateParam
+        ? async (input: TRemote, params: SyncedSetParams<TRemote>) => {
+              const id = input.id;
+              const values = input as unknown as Partial<KeelObjectBase>;
+              delete values.id;
+              delete values.createdAt;
+              delete values.updatedAt;
+
+              const { data, error } = await updateParam({ where: { id }, values: input });
+
+              if (error) {
+                  handleSetError(error, params, false);
+              }
+
+              return data;
+          }
+        : undefined;
+    const deleteFn = deleteParam
+        ? async (input: TRemote & { id: string }, params: SyncedSetParams<TRemote>) => {
+              const { data, error } = await deleteParam({ id: input.id });
+
+              if (error) {
+                  handleSetError(error, params, false);
+              }
+
+              return data;
+          }
+        : undefined;
+
+    return syncedCrud<TRemote, TLocal, TOption>({
+        ...rest,
+        as: asType,
+        list,
+        create,
+        update,
+        delete: deleteFn,
+        waitFor: () => isEnabled$.get() && (waitFor ? computeSelector(waitFor) : true),
+        waitForSet: () => isEnabled$.get() && (waitForSet ? computeSelector(waitForSet) : true),
+        onSaved,
+        fieldCreatedAt,
+        fieldUpdatedAt,
+        changesSince,
+        updatePartial: true,
+        generateId,
+        // @ts-expect-error This errors because of the get/list union type
+        get: get as any,
+    }) as SyncedCrudReturnType<TLocal, TOption>;
+}