@syncular/react 0.15.10 → 0.15.12

package/dist/client.d.ts

@@ -11,7 +11,7 @@
  * value → read it) and wraps every result in `Promise.resolve`, so a hook
  * never has to care which core it holds.
  */
-import type { ClientChangeListener, CommitOutcome, CommitOutcomeQuery, ConflictRecord, InvalidationListener, LeaseState, MutationInput, PresencePeer, QueryReadSpec, QuerySnapshot, RejectionRecord, ResolveCommitOutcomeInput, SchemaFloor, SqlRow, SqlValue, SyncStatusSnapshot, WindowBase, WindowState } from '@syncular/client';
+import type { ClientChangeListener, CommitOutcome, CommitOutcomeQuery, ConflictRecord, InvalidationListener, LeaseState, LocalDataPurgeInput, LocalDataPurgeResult, MutationInput, PresencePeer, QueryReadSpec, QuerySnapshot, RejectionRecord, ResolveCommitOutcomeInput, SchemaFloor, SqlRow, SqlValue, SyncStatusSnapshot, WindowBase, WindowState } from '@syncular/client';
 /**
  * The structural union of `SyncClient` and `SyncClientHandle`. Members that
  * diverge are typed as "value or method, sync or promise"; {@link normalizeClient}
@@ -27,6 +27,7 @@ export interface SyncClientLike {
     patch(table: string, rowId: string, partial: Readonly<Record<string, unknown>>, options?: {
         readonly baseVersion?: number;
     }): string | Promise<string>;
+    purgeLocalData(input: LocalDataPurgeInput): LocalDataPurgeResult | Promise<LocalDataPurgeResult>;
     querySnapshot<Row = SqlRow>(spec: QueryReadSpec): QuerySnapshot<Row> | Promise<QuerySnapshot<Row>>;
     statusSnapshot(): SyncStatusSnapshot | Promise<SyncStatusSnapshot>;
     conflicts: readonly ConflictRecord[] | (() => readonly ConflictRecord[] | Promise<readonly ConflictRecord[]>);
@@ -56,6 +57,7 @@ export interface NormalizedClient {
     patch(table: string, rowId: string, partial: Readonly<Record<string, unknown>>, options?: {
         readonly baseVersion?: number;
     }): Promise<string>;
+    purgeLocalData(input: LocalDataPurgeInput): Promise<LocalDataPurgeResult>;
     querySnapshot<Row = SqlRow>(spec: QueryReadSpec): Promise<QuerySnapshot<Row>>;
     statusSnapshot(): Promise<SyncStatusSnapshot>;
     conflicts(): Promise<readonly ConflictRecord[]>;

package/dist/client.js

@@ -18,6 +18,7 @@ export function normalizeClient(client) {
         query: (sql, params) => Promise.resolve(client.query(sql, params)),
         mutate: (mutations) => Promise.resolve(client.mutate(mutations)),
         patch: (table, rowId, partial, options) => Promise.resolve(client.patch(table, rowId, partial, options)),
+        purgeLocalData: (input) => Promise.resolve(client.purgeLocalData(input)),
         querySnapshot: (spec) => Promise.resolve(client.querySnapshot(spec)),
         statusSnapshot: () => Promise.resolve(client.statusSnapshot()),
         conflicts: () => resolveMember(client, 'conflicts'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncular/react",
-  "version": "0.15.10",
+  "version": "0.15.12",
   "description": "React hooks for Syncular offline-first sync",
   "license": "Apache-2.0",
   "author": "Benjamin Kniffler",
@@ -48,15 +48,15 @@
     "test": "bun test --preload ./test/setup.ts"
   },
   "dependencies": {
-    "@syncular/client": "0.15.10"
+    "@syncular/client": "0.15.12"
   },
   "peerDependencies": {
     "react": ">=18.0.0"
   },
   "devDependencies": {
     "@happy-dom/global-registrator": "^15.11.0",
-    "@syncular/core": "0.15.10",
-    "@syncular/server": "0.15.10",
+    "@syncular/core": "0.15.12",
+    "@syncular/server": "0.15.12",
     "@testing-library/react": "^16.1.0",
     "@types/react": "^18.3.0",
     "react": "^18.3.1",

package/src/client.ts

@@ -18,6 +18,8 @@ import type {
   ConflictRecord,
   InvalidationListener,
   LeaseState,
+  LocalDataPurgeInput,
+  LocalDataPurgeResult,
   MutationInput,
   PresencePeer,
   QueryReadSpec,
@@ -53,6 +55,9 @@ export interface SyncClientLike {
     partial: Readonly<Record<string, unknown>>,
     options?: { readonly baseVersion?: number },
   ): string | Promise<string>;
+  purgeLocalData(
+    input: LocalDataPurgeInput,
+  ): LocalDataPurgeResult | Promise<LocalDataPurgeResult>;
   querySnapshot<Row = SqlRow>(
     spec: QueryReadSpec,
   ): QuerySnapshot<Row> | Promise<QuerySnapshot<Row>>;
@@ -126,6 +131,7 @@ export interface NormalizedClient {
     partial: Readonly<Record<string, unknown>>,
     options?: { readonly baseVersion?: number },
   ): Promise<string>;
+  purgeLocalData(input: LocalDataPurgeInput): Promise<LocalDataPurgeResult>;
   querySnapshot<Row = SqlRow>(spec: QueryReadSpec): Promise<QuerySnapshot<Row>>;
   statusSnapshot(): Promise<SyncStatusSnapshot>;
   conflicts(): Promise<readonly ConflictRecord[]>;
@@ -158,6 +164,7 @@ export function normalizeClient(client: SyncClientLike): NormalizedClient {
     mutate: (mutations) => Promise.resolve(client.mutate(mutations)),
     patch: (table, rowId, partial, options) =>
       Promise.resolve(client.patch(table, rowId, partial, options)),
+    purgeLocalData: (input) => Promise.resolve(client.purgeLocalData(input)),
     querySnapshot: (spec) => Promise.resolve(client.querySnapshot(spec)),
     statusSnapshot: () => Promise.resolve(client.statusSnapshot()),
     conflicts: () => resolveMember(client, 'conflicts'),