Apply new naming scheme

Author: simolus3

.changeset/giant-ladybugs-dress.md

@@ -2,7 +2,7 @@
 '@powersync/common': minor
 ---
 
-- Add `includeOld` option on `Table` which sets `CrudEntry.oldData` to previous values on updates.
-- Add `includeMetadata` option on `Table` which adds a `_metadata` column that can be used for updates.
+- Add `trackOld` option on `Table` which sets `CrudEntry.oldData` to previous values on updates.
+- Add `trackMetadata` option on `Table` which adds a `_metadata` column that can be used for updates.
   The configured metadata is available through `CrudEntry.metadata`.
-- Add `ignoreEmptyUpdate` option which skips creating CRUD entries for updates that don't change any values.
+- Add `ignoreEmptyUpdates` option which skips creating CRUD entries for updates that don't change any values.

packages/common/src/client/sync/bucket/CrudEntry.ts

@@ -66,7 +66,7 @@ export class CrudEntry {
   opData?: Record<string, any>;
 
   /**
-   * For tables where the `includeOld` option has been enabled, this tracks previous values for
+   * For tables where the `trackOld` option has been enabled, this tracks previous values for
    * `UPDATE` and `DELETE` statements.
    */
   oldData?: Record<string, any>;
@@ -83,7 +83,7 @@ export class CrudEntry {
   /**
    * Client-side metadata attached with this write.
    *
-   * This field is only available when the `includeMetadata` option was set to `true` when creating a table
+   * This field is only available when the `trackMetadata` option was set to `true` when creating a table
    * and the insert or update statement set the `_metadata` column.
    */
   metadata?: string;

packages/common/src/db/schema/Table.ts

@@ -14,17 +14,17 @@ interface SharedTableOptions {
   localOnly?: boolean;
   insertOnly?: boolean;
   viewName?: string;
-  includeOld?: boolean | IncludeOldOptions;
-  includeMetadata?: boolean;
-  ignoreEmptyUpdate?: boolean;
+  trackOld?: boolean | TrackOldOptions;
+  trackMetadata?: boolean;
+  ignoreEmptyUpdates?: boolean;
 }
 
 /** Whether to include old columns when PowerSync tracks local changes.
  *
  * Including old columns may be helpful for some backend connector implementations, which is
  * why it can be enabled on per-table or per-columm basis.
  */
-export interface IncludeOldOptions {
+export interface TrackOldOptions {
   /** When defined, a list of column names for which old values should be tracked. */
   columns?: string[];
   /** When enabled, only include values that have actually been changed by an update. */
@@ -56,9 +56,9 @@ export const DEFAULT_TABLE_OPTIONS = {
   indexes: [],
   insertOnly: false,
   localOnly: false,
-  includeOld: false,
-  includeMetadata: false,
-  ignoreEmptyUpdate: false
+  trackOld: false,
+  trackMetadata: false,
+  ignoreEmptyUpdates: false
 };
 
 export const InvalidSQLCharacters = /["'%,.#\s[\]]/;
@@ -200,9 +200,9 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
       viewName: options?.viewName,
       insertOnly: options?.insertOnly,
       localOnly: options?.localOnly,
-      includeOld: options?.includeOld,
-      includeMetadata: options?.includeMetadata,
-      ignoreEmptyUpdate: options?.ignoreEmptyUpdate
+      trackOld: options?.trackOld,
+      trackMetadata: options?.trackMetadata,
+      ignoreEmptyUpdates: options?.ignoreEmptyUpdates
     };
     this.applyDefaultOptions();
 
@@ -212,9 +212,9 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
   private applyDefaultOptions() {
     this.options.insertOnly ??= DEFAULT_TABLE_OPTIONS.insertOnly;
     this.options.localOnly ??= DEFAULT_TABLE_OPTIONS.localOnly;
-    this.options.includeOld ??= DEFAULT_TABLE_OPTIONS.includeOld;
-    this.options.includeMetadata ??= DEFAULT_TABLE_OPTIONS.includeMetadata;
-    this.options.ignoreEmptyUpdate ??= DEFAULT_TABLE_OPTIONS.ignoreEmptyUpdate;
+    this.options.trackOld ??= DEFAULT_TABLE_OPTIONS.trackOld;
+    this.options.trackMetadata ??= DEFAULT_TABLE_OPTIONS.trackMetadata;
+    this.options.ignoreEmptyUpdates ??= DEFAULT_TABLE_OPTIONS.ignoreEmptyUpdates;
   }
 
   get name() {
@@ -255,16 +255,16 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
     return this.options.insertOnly!;
   }
 
-  get includeOld() {
-    return this.options.includeOld!;
+  get trackOld() {
+    return this.options.trackOld!;
   }
 
-  get includeMetadata() {
-    return this.options.includeMetadata!;
+  get trackMetadata() {
+    return this.options.trackMetadata!;
   }
 
-  get ignoreEmptyUpdate() {
-    return this.options.ignoreEmptyUpdate!;
+  get ignoreEmptyUpdates() {
+    return this.options.ignoreEmptyUpdates!;
   }
 
   get internalName() {
@@ -298,10 +298,10 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
       throw new Error(`Table has too many columns. The maximum number of columns is ${MAX_AMOUNT_OF_COLUMNS}.`);
     }
 
-    if (this.includeMetadata && this.localOnly) {
+    if (this.trackMetadata && this.localOnly) {
       throw new Error(`Can't include metadata for local-only tables.`);
     }
-    if (this.includeOld != false && this.localOnly) {
+    if (this.trackOld != false && this.localOnly) {
       throw new Error(`Can't include old values for local-only tables.`);
     }
 
@@ -341,17 +341,17 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
   }
 
   toJSON() {
-    const includeOld = this.includeOld;
+    const trackOld = this.trackOld;
 
     return {
       name: this.name,
       view_name: this.viewName,
       local_only: this.localOnly,
       insert_only: this.insertOnly,
-      include_old: includeOld && ((includeOld as any).columns ?? true),
-      include_old_only_when_changed: typeof includeOld == 'object' && includeOld.onlyWhenChanged == true,
-      include_metadata: this.includeMetadata,
-      ignore_empty_update: this.ignoreEmptyUpdate,
+      include_old: trackOld && ((trackOld as any).columns ?? true),
+      include_old_only_when_changed: typeof trackOld == 'object' && trackOld.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))
     };

packages/common/tests/db/schema/Table.test.ts

@@ -136,19 +136,19 @@ describe('Table', () => {
     }
 
     expect(createTable({}).toJSON().include_metadata).toBe(false);
-    expect(createTable({ includeMetadata: true }).toJSON().include_metadata).toBe(true);
+    expect(createTable({ trackMetadata: true }).toJSON().include_metadata).toBe(true);
 
-    expect(createTable({ includeOld: true }).toJSON().include_old).toBe(true);
-    expect(createTable({ includeOld: true }).toJSON().include_old_only_when_changed).toBe(false);
+    expect(createTable({ trackOld: true }).toJSON().include_old).toBe(true);
+    expect(createTable({ trackOld: true }).toJSON().include_old_only_when_changed).toBe(false);
 
-    const complexIncldueOld = createTable({ includeOld: {
+    const complexIncldueOld = createTable({ trackOld: {
       columns: ['foo', 'bar'],
       onlyWhenChanged: true,
     } });
     expect(complexIncldueOld.toJSON().include_old).toStrictEqual(['foo', 'bar']);
     expect(complexIncldueOld.toJSON().include_old_only_when_changed).toBe(true);
 
-    expect(createTable({ ignoreEmptyUpdate: true }).toJSON().ignore_empty_update).toBe(true);
+    expect(createTable({ ignoreEmptyUpdates: true }).toJSON().ignore_empty_update).toBe(true);
   });
 
   describe('validate', () => {
@@ -205,7 +205,7 @@ describe('Table', () => {
           {
             name: column.text
           },
-          { localOnly: true, includeMetadata: true }
+          { localOnly: true, trackMetadata: true }
         ).validate()
       ).toThrowError("Can't include metadata for local-only tables.");
     });
@@ -216,7 +216,7 @@ describe('Table', () => {
           {
             name: column.text
           },
-          { localOnly: true, includeOld: true }
+          { localOnly: true, trackOld: true }
         ).validate()
       ).toThrowError("Can't include old values for local-only tables.");
 
@@ -225,7 +225,7 @@ describe('Table', () => {
           {
             name: column.text
           },
-          { localOnly: true, includeOld: { onlyWhenChanged: false } }
+          { localOnly: true, trackOld: { onlyWhenChanged: false } }
         ).validate()
       ).toThrowError("Can't include old values for local-only tables.");
     });

packages/node/tests/crud.test.ts

@@ -9,7 +9,7 @@ databaseTest('include metadata', async ({ database }) => {
       {
         name: column.text
       },
-      { includeMetadata: true }
+      { trackMetadata: true }
     )
   });
   await database.updateSchema(schema);
@@ -26,7 +26,7 @@ databaseTest('include old values', async ({ database }) => {
       {
         name: column.text
       },
-      { includeOld: true }
+      { trackOld: true }
     )
   });
   await database.updateSchema(schema);
@@ -46,7 +46,7 @@ databaseTest('include old values with column filter', async ({ database }) => {
         name: column.text,
         content: column.text
       },
-      { includeOld: { columns: ['name'] } }
+      { trackOld: { columns: ['name'] } }
     )
   });
   await database.updateSchema(schema);
@@ -66,7 +66,7 @@ databaseTest('include old values when changed', async ({ database }) => {
         name: column.text,
         content: column.text
       },
-      { includeOld: { onlyWhenChanged: true } }
+      { trackOld: { onlyWhenChanged: true } }
     )
   });
   await database.updateSchema(schema);
@@ -85,7 +85,7 @@ databaseTest('ignore empty update', async ({ database }) => {
       {
         name: column.text
       },
-      { ignoreEmptyUpdate: true }
+      { ignoreEmptyUpdates: true }
     )
   });
   await database.updateSchema(schema);