Common types for web hooks

Author: dfahlander

libs/dexie-cloud-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dexie-cloud-common",
-  "version": "1.0.53",
+  "version": "1.0.57",
   "description": "Library for shared code between dexie-cloud-addon, dexie-cloud (CLI) and dexie-cloud-server",
   "type": "module",
   "module": "dist/index.js",
@@ -15,13 +15,13 @@
   "author": "David Fahlander",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/jest": "^29.5.2",
-    "@types/node": "^18.11.18",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.3.3"
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.1",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "lib0": "^0.2.97"
+    "lib0": "^0.2.114"
   }
 }

libs/dexie-cloud-common/src/SyncChange.ts

@@ -0,0 +1,22 @@
+export type SyncChange = UpsertSyncChange | UpdateSyncChange | DeleteSyncChange;
+
+export interface UpsertSyncChange {
+  type: 'upsert';
+  realmId: string;
+  table: string;
+  key: string;
+  value: object;
+}
+export interface UpdateSyncChange {
+  type: 'update';
+  realmId: string;
+  table: string;
+  key: string;
+  updates: { [keyPath: string]: any };
+}
+export interface DeleteSyncChange {
+  type: 'delete';
+  realmId: string;
+  table: string;
+  key: string;
+}

libs/dexie-cloud-common/src/SyncChangeSet.ts

@@ -0,0 +1,9 @@
+export type SyncChangeSet = {
+  [table: string]: {
+    upsert?: object[];
+    update?: {
+      [key: string]: { [keyPath: string]: any };
+    };
+    delete?: string[];
+  };
+};

libs/dexie-cloud-common/src/change-processing/toDBOperationSet.ts

@@ -1,7 +1,5 @@
 import { DBDeleteOperation, DBOperation, DBUpdateOperation, DBUpsertOperation } from "../DBOperation.js";
 import { DBOperationsSet } from "../DBOperationsSet.js";
-import { randomString } from "../utils.js";
-import { DBKeyMutation } from "./DBKeyMutation.js";
 import { DBKeyMutationSet } from "./DBKeyMutationSet.js";
 
 /** Convert a DBKeyMutationSet (which is an internal format capable of looking up changes per ID)
@@ -10,10 +8,7 @@ import { DBKeyMutationSet } from "./DBKeyMutationSet.js";
  * @param inSet 
  * @returns DBOperationsSet representing inSet
  */
-export function toDBOperationSet(inSet: DBKeyMutationSet, txid=""): DBOperationsSet<string> {
-  // Fictive transaction:
-  if (!txid) txid = randomString(16);
-
+export function toDBOperationSet(inSet: DBKeyMutationSet, txid?: string): DBOperationsSet<string> {
   // Convert data into a temporary map to collect mutations of same table and type
   const map: {
     [table: string]: { [opType: string]: { key: any, val?: any, mod?: any }[] };

libs/dexie-cloud-common/src/change-processing/toSyncChangeSet.ts

@@ -0,0 +1,60 @@
+import { DBDeleteOperation, DBOperation, DBUpdateOperation, DBUpsertOperation } from "../DBOperation.js";
+import { DBOperationsSet } from "../DBOperationsSet.js";
+import { SyncChangeSet } from "../SyncChangeSet.js";
+import { DBKeyMutationSet } from "./DBKeyMutationSet.js";
+
+/** Convert a DBKeyMutationSet (which is an internal format capable of looking up changes per ID)
+ * ...into a SyncChangeSet (which is more optimal for performing DB operations into DB SQL UPSERT, UPDATE, DELETE)
+ * 
+ * @param inSet 
+ * @returns SyncChangeSet representing inSet
+ */
+export function toSyncChangeSet(inSet: DBKeyMutationSet): SyncChangeSet {
+  // Convert data into a temporary map to collect mutations of same table and type
+  const map: {
+    [table: string]: { [opType: string]: { key: any, val?: any, mod?: any }[] };
+  } = {};
+  for (const [table, ops] of Object.entries(inSet)) {
+    for (const [key, op] of Object.entries(ops)) {
+      const mapEntry = map[table] || (map[table] = {});
+      const ops = mapEntry[op.type] || (mapEntry[op.type] = []);
+      ops.push({ key, ...op }); // DBKeyMutation doesn't contain key, so we need to bring it in.
+    }
+  }
+
+  // Start computing the resulting format:
+  const result: SyncChangeSet = {};
+
+  for (const [table, ops] of Object.entries(map)) {
+    const resultEntry: {
+      upsert?: object[];
+      update?: { [key: string]: { [keyPath: string]: any } };
+      delete?: string[];
+    } = {};
+    
+    for (const [optype, muts] of Object.entries(ops)) {
+      switch (optype) {
+        case "ups": {
+          resultEntry.upsert = muts.map(mut => mut.val);
+          break;
+        }
+        case "upd": {
+          const updateMap: { [key: string]: { [keyPath: string]: any } } = {};
+          for (const mut of muts) {
+            updateMap[mut.key] = mut.mod;
+          }
+          resultEntry.update = updateMap;
+          break;
+        }
+        case "del": {
+          resultEntry.delete = muts.map(mut => mut.key);
+          break;
+        }
+      }
+    }
+    
+    result[table] = resultEntry;
+  }
+
+  return result;
+}

libs/dexie-cloud-common/src/index.ts

@@ -6,13 +6,15 @@ export * from "./utils.js"
 export * from "./DexieCloudSchema.js"
 export * from "./DBOperationsSet.js"
 export * from "./DBOperation.js"
+export * from "./SyncChange.js"
 export * from "./validation/isValidSyncableID.js"
 export * from "./change-processing/applyOperation.js"
 export * from "./change-processing/applyOperations.js"
 export * from "./change-processing/DBKeyMutation.js"
 export * from "./change-processing/DBKeyMutationSet.js"
 export * from "./change-processing/subtractChanges.js"
 export * from "./change-processing/toDBOperationSet.js"
+export * from "./change-processing/toSyncChangeSet.js"
 export * from "./DBPermissionSet.js";
 export * from "./entities/DBRealm.js";
 export * from "./entities/DBRealmMember.js";

libs/dexie-cloud-common/tsconfig.json

@@ -3,7 +3,7 @@
     "lib": ["es2020", "dom"],
     "moduleResolution": "node",
     "importHelpers": true,
-    "target": "es2017",
+    "target": "es2020",
     "module": "esnext",
     "outDir": "dist",
     "rootDir": "src",