@anfenn/dync 1.0.25 → 1.0.27

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/@anfenn/dync.svg)](https://www.npmjs.com/package/@anfenn/dync)
 
-A complete React offline-first data layer with sync engine for any local storage (IndexedDB, Sqlite, etc.), and any backend (Restful, GraphQL, Supabase, etc.) in a Website, PWA, CapacitorJs, React Native, or Electron app.
+A complete Typescript offline-first data layer with sync engine for any local storage (IndexedDB, Sqlite, etc.), and any backend (Restful, GraphQL, Supabase, etc.) in a Website, PWA, CapacitorJs, React Native, or Electron app.
 
 Start with a Website or PWA using IndexedDB, sync with your existing REST API, and later ship native apps with encrypted SQLite - without changing a line of code.
 
@@ -48,9 +48,9 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
     - Option 1: Map remote api CRUD urls to a local collection:
 
         ```ts
-        const db = makeDync(
+        const db = new Dync({
             ...,
-            {
+            sync: {
                 // Only add an entry here for tables that should be synced
                 // Pseudocode here, see examples for working code
                 items: {
@@ -60,15 +60,15 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
                     list: (since) => fetch(`/api/items?since=${since}`),
                 },
             },
-        );
+        });
         ```
 
     - Option 2: Batch sync to remote /push & /pull endpoints:
 
         ```ts
-        const db = makeDync(
+        const db = new Dync({
             ...,
-            {
+            sync: {
                 syncTables: ['items'], // Only add tables to this array that should be synced
                 push: async (changes) => {
                     const res = await fetch('/api/sync/push', {
@@ -79,14 +79,12 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
                     return res.json();
                 },
                 pull: async (since) => {
-                    const params = new URLSearchParams(
-                        Object.entries(since).map(([table, date]) => [table, date.toISOString()])
-                    );
+                    const params = new URLSearchParams(Object.entries(since).map(([table, date]) => [table, date.toISOString()]));
                     const res = await fetch(`/api/sync/pull?${params}`);
                     return res.json();
                 },
             },
-        );
+        });
         ```
 
         See [examples/shared/api.ts](examples/shared/api.ts) for a fully documented example of these two options.
@@ -94,7 +92,7 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
 - Full conflict resolution: `local-wins`, `remote-wins` or with `try-shallow-merge` the user can resolve with:
 
     ```ts
-    const { syncState, db } = useDync();
+    const syncState = useSyncState(db);
     syncState.conflicts; // Record<localId, Conflict>
     db.sync.resolveConflict(localId, true);
     ```
@@ -107,11 +105,12 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
 
     ```ts
     useLiveQuery(
-        async (db) => {
+        db,
+        async () => {
             const items = await db.items.toArray(); // toArray() executes the query
             setTodos(items);
         },
-        [], // Re-run when variables change
+        [], // Re-run when variables change (None defined)
         ['items'], // Re-run when tables change
     );
     ```
@@ -124,6 +123,7 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
 
 - Full IndexedDB & SQL unified query language:
     - Using IndexedDB functions or raw SQL will always be more expressive independently
+    - When required, best performance will always come from native api
     - No need to learn another api when you might only need one storage type
     - Would greatly increase complexity of this library
 

package/dist/{dexie-DRLMKLl5.d.ts → dexie-BFPA0JU2.d.ts}

@@ -440,4 +440,4 @@ declare class DexieAdapter implements StorageAdapter {
     transaction<T>(mode: TransactionMode, tableNames: string[], callback: (context: StorageTransactionContext) => Promise<T>): Promise<T>;
 }
 
-export { DexieQueryContext as D, MemoryAdapter as M, SQLiteAdapter as S, type TableSchemaDefinition as T, MemoryQueryContext as a, SqliteQueryContext as b, type StorageAdapter as c, type StorageTable as d, DexieAdapter as e };
+export { DexieQueryContext as D, MemoryQueryContext as M, SqliteQueryContext as S, type TableSchemaDefinition as T, type StorageTable as a, MemoryAdapter as b, SQLiteAdapter as c, type StorageAdapter as d, DexieAdapter as e };

package/dist/{dexie-BqktVP7s.d.cts → dexie-T9m1mP1h.d.cts}

@@ -440,4 +440,4 @@ declare class DexieAdapter implements StorageAdapter {
     transaction<T>(mode: TransactionMode, tableNames: string[], callback: (context: StorageTransactionContext) => Promise<T>): Promise<T>;
 }
 
-export { DexieQueryContext as D, MemoryAdapter as M, SQLiteAdapter as S, type TableSchemaDefinition as T, MemoryQueryContext as a, SqliteQueryContext as b, type StorageAdapter as c, type StorageTable as d, DexieAdapter as e };
+export { DexieQueryContext as D, MemoryQueryContext as M, SqliteQueryContext as S, type TableSchemaDefinition as T, type StorageTable as a, MemoryAdapter as b, SQLiteAdapter as c, type StorageAdapter as d, DexieAdapter as e };

package/dist/dexie.d.cts

@@ -1,3 +1,3 @@
-export { e as DexieAdapter, D as DexieQueryContext, c as StorageAdapter } from './dexie-BqktVP7s.cjs';
+export { e as DexieAdapter, D as DexieQueryContext, d as StorageAdapter } from './dexie-T9m1mP1h.cjs';
 import 'dexie';
 import './types-CSbIAfu2.cjs';

package/dist/dexie.d.ts

@@ -1,3 +1,3 @@
-export { e as DexieAdapter, D as DexieQueryContext, c as StorageAdapter } from './dexie-DRLMKLl5.js';
+export { e as DexieAdapter, D as DexieQueryContext, d as StorageAdapter } from './dexie-BFPA0JU2.js';
 import 'dexie';
 import './types-CSbIAfu2.js';

package/dist/index.cjs

@@ -1317,13 +1317,35 @@ var DyncBase = class {
   mutationsDuringSync = false;
   state;
   name;
-  constructor(databaseName, syncApisOrBatchSync, storageAdapter, options) {
-    const isBatchMode = typeof syncApisOrBatchSync.push === "function";
+  /**
+   * Create a new Dync instance.
+   *
+   * @example Per-table sync mode
+   * ```ts
+   * const db = new Dync<Store>({
+   *     databaseName: 'my-app',
+   *     storageAdapter: new SQLiteAdapter(driver),
+   *     sync: { todos: todoSyncApi },
+   * });
+   * ```
+   *
+   * @example Batch sync mode
+   * ```ts
+   * const db = new Dync<Store>({
+   *     databaseName: 'my-app',
+   *     storageAdapter: new SQLiteAdapter(driver),
+   *     sync: { syncTables: ['todos'], push, pull },
+   * });
+   * ```
+   */
+  constructor(config) {
+    const { databaseName, storageAdapter, sync: syncConfig, options } = config;
+    const isBatchMode = typeof syncConfig.push === "function" && typeof syncConfig.pull === "function";
     if (isBatchMode) {
-      this.batchSync = syncApisOrBatchSync;
+      this.batchSync = syncConfig;
       this.syncedTables = new Set(this.batchSync.syncTables);
     } else {
-      this.syncApis = syncApisOrBatchSync;
+      this.syncApis = syncConfig;
       this.syncedTables = new Set(Object.keys(this.syncApis));
     }
     this.adapter = storageAdapter;
@@ -1340,6 +1362,10 @@ var DyncBase = class {
     this.state = new StateManager({
       storageAdapter: this.adapter
     });
+    Object.defineProperty(this.sync, "state", {
+      get: () => this.getSyncState(),
+      enumerable: true
+    });
     const driverInfo = "driverType" in this.adapter ? ` (Driver: ${this.adapter.driverType})` : "";
     this.logger.debug(`[dync] Initialized with ${this.adapter.type}${driverInfo}`);
   }
@@ -1383,6 +1409,17 @@ var DyncBase = class {
         storesDefined = true;
         self.adapter.defineSchema(versionNumber, fullSchema, schemaOptions);
         self.setupEnhancedTables(Object.keys(schema));
+        for (const tableName of Object.keys(schema)) {
+          if (!(tableName in self)) {
+            Object.defineProperty(self, tableName, {
+              get() {
+                return self.table(tableName);
+              },
+              enumerable: true,
+              configurable: false
+            });
+          }
+        }
         return builder;
       },
       sqlite(configure) {
@@ -1714,14 +1751,14 @@ var DyncBase = class {
   sync = {
     enable: this.enableSync.bind(this),
     startFirstLoad: this.startFirstLoad.bind(this),
-    getState: this.getSyncState.bind(this),
+    state: void 0,
+    // getter in constructor
     resolveConflict: this.resolveConflict.bind(this),
     onStateChange: this.onSyncStateChange.bind(this),
     onMutation: this.onMutation.bind(this)
   };
 };
-var DyncConstructor = DyncBase;
-var Dync = DyncConstructor;
+var Dync = DyncBase;
 
 // src/storage/memory/MemoryQueryContext.ts
 var MemoryQueryContext = class {