@powersync/common 1.28.0 → 1.30.0

package/lib/db/schema/Table.js

@@ -4,7 +4,10 @@ import { IndexedColumn } from './IndexedColumn.js';
 export const DEFAULT_TABLE_OPTIONS = {
     indexes: [],
     insertOnly: false,
-    localOnly: false
+    localOnly: false,
+    trackPrevious: false,
+    trackMetadata: false,
+    ignoreEmptyUpdates: false
 };
 export const InvalidSQLCharacters = /["'%,.#\s[\]]/;
 export class Table {
@@ -41,16 +44,21 @@ export class Table {
             this.initTableV2(optionsOrColumns, v2Options);
         }
     }
+    copyWithName(name) {
+        return new Table({
+            ...this.options,
+            name
+        });
+    }
     isTableV1(arg) {
         return 'columns' in arg && Array.isArray(arg.columns);
     }
     initTableV1(options) {
         this.options = {
             ...options,
-            indexes: options.indexes || [],
-            insertOnly: options.insertOnly ?? DEFAULT_TABLE_OPTIONS.insertOnly,
-            localOnly: options.localOnly ?? DEFAULT_TABLE_OPTIONS.localOnly
+            indexes: options.indexes || []
         };
+        this.applyDefaultOptions();
     }
     initTableV2(columns, options) {
         const convertedColumns = Object.entries(columns).map(([name, columnInfo]) => new Column({ name, type: columnInfo.type }));
@@ -65,12 +73,23 @@ export class Table {
             name: '',
             columns: convertedColumns,
             indexes: convertedIndexes,
-            insertOnly: options?.insertOnly ?? DEFAULT_TABLE_OPTIONS.insertOnly,
-            localOnly: options?.localOnly ?? DEFAULT_TABLE_OPTIONS.localOnly,
-            viewName: options?.viewName
+            viewName: options?.viewName,
+            insertOnly: options?.insertOnly,
+            localOnly: options?.localOnly,
+            trackPrevious: options?.trackPrevious,
+            trackMetadata: options?.trackMetadata,
+            ignoreEmptyUpdates: options?.ignoreEmptyUpdates
         };
+        this.applyDefaultOptions();
         this._mappedColumns = columns;
     }
+    applyDefaultOptions() {
+        this.options.insertOnly ??= DEFAULT_TABLE_OPTIONS.insertOnly;
+        this.options.localOnly ??= DEFAULT_TABLE_OPTIONS.localOnly;
+        this.options.trackPrevious ??= DEFAULT_TABLE_OPTIONS.trackPrevious;
+        this.options.trackMetadata ??= DEFAULT_TABLE_OPTIONS.trackMetadata;
+        this.options.ignoreEmptyUpdates ??= DEFAULT_TABLE_OPTIONS.ignoreEmptyUpdates;
+    }
     get name() {
         return this.options.name;
     }
@@ -94,10 +113,19 @@ export class Table {
         return this.options.indexes ?? [];
     }
     get localOnly() {
-        return this.options.localOnly ?? false;
+        return this.options.localOnly;
     }
     get insertOnly() {
-        return this.options.insertOnly ?? false;
+        return this.options.insertOnly;
+    }
+    get trackPrevious() {
+        return this.options.trackPrevious;
+    }
+    get trackMetadata() {
+        return this.options.trackMetadata;
+    }
+    get ignoreEmptyUpdates() {
+        return this.options.ignoreEmptyUpdates;
     }
     get internalName() {
         if (this.options.localOnly) {
@@ -124,6 +152,12 @@ export class Table {
         if (this.columns.length > MAX_AMOUNT_OF_COLUMNS) {
             throw new Error(`Table has too many columns. The maximum number of columns is ${MAX_AMOUNT_OF_COLUMNS}.`);
         }
+        if (this.trackMetadata && this.localOnly) {
+            throw new Error(`Can't include metadata for local-only tables.`);
+        }
+        if (this.trackPrevious != false && this.localOnly) {
+            throw new Error(`Can't include old values for local-only tables.`);
+        }
         const columnNames = new Set();
         columnNames.add('id');
         for (const column of this.columns) {
@@ -156,11 +190,16 @@ export class Table {
         }
     }
     toJSON() {
+        const trackPrevious = this.trackPrevious;
         return {
             name: this.name,
             view_name: this.viewName,
             local_only: this.localOnly,
             insert_only: this.insertOnly,
+            include_old: trackPrevious && (trackPrevious.columns ?? true),
+            include_old_only_when_changed: typeof trackPrevious == 'object' && trackPrevious.onlyWhenChanged == true,
+            include_metadata: this.trackMetadata,
+            ignore_empty_update: this.ignoreEmptyUpdates,
             columns: this.columns.map((c) => c.toJSON()),
             indexes: this.indexes.map((e) => e.toJSON(this))
         };

package/lib/index.d.ts

@@ -18,6 +18,7 @@ export * from './client/sync/stream/AbstractRemote.js';
 export * from './client/sync/stream/AbstractStreamingSyncImplementation.js';
 export * from './client/sync/stream/streaming-sync-types.js';
 export { MAX_OP_ID } from './client/constants.js';
+export { ProgressWithOperations, SyncProgress } from './db/crud/SyncProgress.js';
 export * from './db/crud/SyncStatus.js';
 export * from './db/crud/UploadQueueStatus.js';
 export * from './db/schema/Schema.js';

package/lib/index.js

@@ -18,6 +18,7 @@ export * from './client/sync/stream/AbstractRemote.js';
 export * from './client/sync/stream/AbstractStreamingSyncImplementation.js';
 export * from './client/sync/stream/streaming-sync-types.js';
 export { MAX_OP_ID } from './client/constants.js';
+export { SyncProgress } from './db/crud/SyncProgress.js';
 export * from './db/crud/SyncStatus.js';
 export * from './db/crud/UploadQueueStatus.js';
 export * from './db/schema/Schema.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/common",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"