@syncular/client 0.0.6-96 → 0.1.1

package/dist/react/index.d.ts

@@ -0,0 +1,169 @@
+import { type CreateSyncularDatabaseOptions, type MutationReceipt, type MutationsApi, type SyncularBlobUploadQueueStats, type SyncularChangedRow, type SyncularClientLike, type SyncularClientStatus, type SyncularConflictStats, type SyncularConnectionState, type SyncularOutboxStats, type SyncularPresenceEntry, type SyncularRowsChangedEvent } from '@syncular/client';
+import type { BlobRef } from '@syncular/core';
+import type { CompiledQuery, Kysely } from 'kysely';
+import { createElement, type ReactNode } from 'react';
+export type SyncularReactStatus = 'idle' | 'loading' | 'ready' | 'error';
+export interface SyncProviderProps<DB> {
+    children?: ReactNode;
+    client?: SyncularClientLike<DB>;
+    options?: CreateSyncularDatabaseOptions;
+    optionsKey?: unknown;
+    closeOnUnmount?: boolean;
+    onClient?: (client: SyncularClientLike<DB>) => void;
+    onError?: (error: unknown) => void;
+}
+export interface SyncContextValue {
+    status: SyncularReactStatus;
+    error: unknown;
+}
+export interface SyncQueryContext<DB> {
+    db: Kysely<DB>;
+    selectFrom: Kysely<DB>['selectFrom'];
+}
+export interface UseSyncQueryOptions {
+    enabled?: boolean;
+    deps?: readonly unknown[];
+    keyField?: string;
+    watchTables?: readonly string[];
+    tables?: readonly string[];
+    pollIntervalMs?: number;
+    staleAfterMs?: number;
+    structuralSharing?: boolean;
+    refreshOnDataChange?: boolean;
+    loadingOnRefresh?: boolean;
+    transitionUpdates?: boolean;
+}
+export interface UseSyncQueryResult<T> {
+    data: T | undefined;
+    isLoading: boolean;
+    error: Error | null;
+    isStale: boolean;
+    lastSyncAt: number | null;
+    refetch: () => Promise<void>;
+}
+export interface UseQueryOptions {
+    enabled?: boolean;
+    deps?: readonly unknown[];
+    keyField?: string;
+}
+export interface UseQueryResult<T> {
+    data: T | undefined;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+export type MutationInput = {
+    rowId: string;
+    op: 'delete';
+    payload?: null;
+    baseVersion?: number | null;
+} | {
+    rowId: string;
+    op: 'upsert';
+    payload?: Record<string, unknown> | null;
+    baseVersion?: number | null;
+};
+export type MutationResult = MutationReceipt;
+export interface FluentMutation {
+    update: (rowId: string, payload: Record<string, unknown>, options?: {
+        baseVersion?: number | null;
+    }) => Promise<MutationResult>;
+    upsert: (rowId: string, payload: Record<string, unknown>, options?: {
+        baseVersion?: number | null;
+    }) => Promise<MutationResult>;
+    delete: (rowId: string, options?: {
+        baseVersion?: number | null;
+    }) => Promise<MutationResult>;
+}
+export interface UseMutationOptions<TTable extends string> {
+    table: TTable;
+    syncImmediately?: boolean;
+    onSuccess?: (result: MutationResult) => void;
+    onError?: (error: Error) => void;
+}
+export interface UseMutationResult {
+    mutate: FluentMutation;
+    mutateMany: (inputs: readonly MutationInput[]) => Promise<MutationResult>;
+    isPending: boolean;
+    error: Error | null;
+    reset: () => void;
+}
+export type SyncMode = 'background' | 'await' | false;
+export interface UseMutationsOptions {
+    sync?: SyncMode;
+    onSuccess?: (result: MutationReceipt & {
+        opCount: number;
+    }) => void;
+    onError?: (error: Error) => void;
+}
+export type MutationsHook<DB> = MutationsApi<DB, {
+    sync?: SyncMode;
+}> & {
+    readonly $isPending: boolean;
+    readonly $error: Error | null;
+    $reset: () => void;
+};
+export interface UseRowsChangedOptions {
+    tables?: readonly string[];
+    enabled?: boolean;
+}
+export interface UsePresenceResult<TMetadata extends Record<string, unknown> = Record<string, unknown>> {
+    presence: SyncularPresenceEntry<TMetadata>[];
+    isLoading: boolean;
+}
+export interface UsePresenceWithJoinOptions<TMetadata extends Record<string, unknown> = Record<string, unknown>> {
+    metadata?: TMetadata;
+    autoJoin?: boolean;
+    enabled?: boolean;
+}
+export interface UsePresenceWithJoinResult<TMetadata extends Record<string, unknown> = Record<string, unknown>> extends UsePresenceResult<TMetadata> {
+    updateMetadata: (metadata: TMetadata) => void;
+    join: (metadata?: TMetadata) => void;
+    leave: () => void;
+    isJoined: boolean;
+}
+export interface UseSyncConnectionResult {
+    state: SyncularConnectionState;
+    isConnected: boolean;
+    isReconnecting: boolean;
+    reconnect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+}
+export interface UseBlobUploadQueueResult {
+    stats: SyncularBlobUploadQueueStats | null;
+    refresh(): Promise<void>;
+    process(): Promise<{
+        uploaded: number;
+        failed: number;
+    }>;
+}
+type ExecutableQuery<TResult> = {
+    execute(): Promise<TResult>;
+    compile?: () => CompiledQuery;
+};
+type SyncQueryFn<DB, TResult> = (ctx: SyncQueryContext<DB>) => ExecutableQuery<TResult> | Promise<TResult> | TResult;
+type KnownTableKey<DB> = string extends keyof DB ? string : Extract<keyof DB, string>;
+export declare function createSyncularReact<DB>(): {
+    SyncProvider: (props: SyncProviderProps<DB>) => ReturnType<typeof createElement>;
+    useBlob: (ref: BlobRef | null | undefined) => Uint8Array | null;
+    useBlobUploadQueue: () => UseBlobUploadQueueResult;
+    useConflictStats: () => SyncularConflictStats | null;
+    useLeasedMutation: <TTable extends KnownTableKey<DB> & string>(options: UseMutationOptions<TTable>) => UseMutationResult;
+    useLeasedMutations: (options?: UseMutationsOptions) => MutationsHook<DB>;
+    useMutation: <TTable extends KnownTableKey<DB> & string>(options: UseMutationOptions<TTable>) => UseMutationResult;
+    useMutations: (options?: UseMutationsOptions) => MutationsHook<DB>;
+    useOutboxStats: () => SyncularOutboxStats | null;
+    usePresence: <TMetadata extends Record<string, unknown> = Record<string, unknown>>(scopeKey: string, options?: {
+        enabled?: boolean;
+    }) => UsePresenceResult<TMetadata>;
+    usePresenceWithJoin: <TMetadata extends Record<string, unknown> = Record<string, unknown>>(scopeKey: string, options?: UsePresenceWithJoinOptions<TMetadata>) => UsePresenceWithJoinResult<TMetadata>;
+    useQuery: <TResult>(query: SyncQueryFn<DB, TResult>, options?: UseQueryOptions) => UseQueryResult<TResult>;
+    useRowsChanged: (listener: (event: SyncularRowsChangedEvent) => void, options?: UseRowsChangedOptions) => void;
+    useSyncConnection: () => UseSyncConnectionResult;
+    useSyncContext: () => SyncContextValue;
+    useSyncStatus: () => SyncularClientStatus;
+    useSyncQuery: <TResult>(query: SyncQueryFn<DB, TResult>, options?: UseSyncQueryOptions) => UseSyncQueryResult<TResult>;
+};
+export declare function changedRowsForTable(event: SyncularRowsChangedEvent, table: string): SyncularChangedRow[];
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/react/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,6BAA6B,EAElC,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EAGvB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAG5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAE9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,EAEL,aAAa,EACb,KAAK,SAAS,EASf,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAEzE,MAAM,WAAW,iBAAiB,CAAC,EAAE;IACnC,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,MAAM,CAAC,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,6BAA6B,CAAC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;IACpD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB,CAAC,EAAE;IAClC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACf,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GACrB;IACE,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,QAAQ,CAAC;IACb,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,QAAQ,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACzC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,CAAC;AAEN,MAAM,MAAM,cAAc,GAAG,eAAe,CAAC;AAE7C,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,CACN,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,KACtC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,MAAM,EAAE,CACN,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,KACtC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,MAAM,EAAE,CACN,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,KACtC,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB,CAAC,MAAM,SAAS,MAAM;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;IAC7C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1E,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,KAAK,CAAC;AAEtD,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,GAAG;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACpE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,MAAM,MAAM,aAAa,CAAC,EAAE,IAAI,YAAY,CAAC,EAAE,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC,GAAG;IACtE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB,CAChC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEnE,QAAQ,EAAE,qBAAqB,CAAC,SAAS,CAAC,EAAE,CAAC;IAC7C,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B,CACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEnE,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB,CACxC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACnE,SAAQ,iBAAiB,CAAC,SAAS,CAAC;IACpC,cAAc,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;IAC9C,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,uBAAuB,CAAC;IAC/B,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAC3C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC1D;AAQD,KAAK,eAAe,CAAC,OAAO,IAAI;IAC9B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,aAAa,CAAC;CAC/B,CAAC;AAEF,KAAK,WAAW,CAAC,EAAE,EAAE,OAAO,IAAI,CAC9B,GAAG,EAAE,gBAAgB,CAAC,EAAE,CAAC,KACtB,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;AAE3D,KAAK,aAAa,CAAC,EAAE,IAAI,MAAM,SAAS,MAAM,EAAE,GAC5C,MAAM,GACN,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC;AAO9B,wBAAgB,mBAAmB,CAAC,EAAE;0BAI3B,iBAAiB,CAAC,EAAE,CAAC,KAC3B,UAAU,CAAC,OAAO,aAAa,CAAC;mBA0lBb,OAAO,GAAG,IAAI,GAAG,SAAS,KAAG,UAAU,GAAG,IAAI;8BAxBrC,wBAAwB;4BA1E1B,qBAAqB,GAAG,IAAI;wBA9K9B,MAAM,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,WACzD,kBAAkB,CAAC,MAAM,CAAC,KAClC,iBAAiB;mCA+ET,mBAAmB,KAC3B,aAAa,CAAC,EAAE,CAAC;kBAxFC,MAAM,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,WACnD,kBAAkB,CAAC,MAAM,CAAC,KAClC,iBAAiB;6BAgFW,mBAAmB,KAAQ,aAAa,CAAC,EAAE,CAAC;0BA4FhD,mBAAmB,GAAG,IAAI;kBAanD,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,sCAE/B,MAAM,YACP;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,KAC7B,iBAAiB,CAAC,SAAS,CAAC;0BAyB7B,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,sCAE/B,MAAM,YACP,0BAA0B,CAAC,SAAS,CAAC,KAC7C,yBAAyB,CAAC,SAAS,CAAC;eA7OrB,OAAO,SAChB,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,YACtB,eAAe,KACvB,cAAc,CAAC,OAAO,CAAC;+BA/Kd,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,YAC1C,qBAAqB,KAC7B,IAAI;6BA7BuB,uBAAuB;0BA9B1B,gBAAgB;yBAgBjB,oBAAoB;mBA0DxB,OAAO,SACpB,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,YACtB,mBAAmB,KAC3B,kBAAkB,CAAC,OAAO,CAAC;EAqe/B;AAkKD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,wBAAwB,EAC/B,KAAK,EAAE,MAAM,GACZ,kBAAkB,EAAE,CAEtB"}