@rljson/db 0.0.8 → 0.0.9

package/dist/db.d.ts

@@ -1,15 +1,15 @@
 import { Io } from '@rljson/io';
 import { Json, JsonValue } from '@rljson/json';
-import { InsertHistoryRow, InsertHistoryTimeId, Ref, Rljson, Route, SliceId, TableType } from '@rljson/rljson';
+import { Edit, EditHistory, InsertHistoryRow, InsertHistoryTimeId, MultiEdit, Ref, Rljson, Route, SliceId, TableType } from '@rljson/rljson';
 import { Controller, ControllerChildProperty, ControllerRefs } from './controller/controller.ts';
 import { Core } from './core.ts';
 import { Join } from './join/join.ts';
 import { ColumnSelection } from './join/selection/column-selection.ts';
-import { Notify } from './notify.ts';
+import { Notify, NotifyCallback } from './notify.ts';
 export type Cell = {
     route: Route;
-    value: JsonValue[] | null;
-    row: JsonValue[] | null;
+    value: JsonValue | JsonValue[] | null;
+    row: JsonValue | JsonValue[] | null;
     path: Array<Array<string | number>>;
 };
 export type Container = {
@@ -97,13 +97,13 @@ export declare class Db {
      * @param route - The route to register the callback on
      * @param callback - The callback to be called when an Insert is made
      */
-    registerObserver(route: Route, callback: (InsertHistoryRow: InsertHistoryRow<any>) => void): void;
+    registerObserver(route: Route, callback: NotifyCallback<any>): void;
     /**
      * Unregisters a callback from the given route
      * @param route - The route to unregister the callback from
      * @param callback - The callback to be unregistered
      */
-    unregisterObserver(route: Route, callback: (InsertHistoryRow: InsertHistoryRow<any>) => void): void;
+    unregisterObserver(route: Route, callback: NotifyCallback<any>): void;
     /**
      * Get a controller for a specific table
      * @param tableKey - The key of the table to get the controller for
@@ -120,6 +120,48 @@ export declare class Db {
      * @throws {Error} If the InsertHistory table does not exist
      */
     private _writeInsertHistory;
+    /**
+     * Add a head revision for a cake
+     * @param cakeKey - The cake table key
+     * @param cakeRef - The cake reference
+     */
+    addHeadRevision(cakeKey: string, cakeRef: Ref): Promise<InsertHistoryRow<string>[]>;
+    /**
+     * Add a multiEdit
+     * @param cakeKey - The cake table key
+     * @param multiEdit - The multiEdit to add
+     */
+    addMultiEdit(cakeKey: string, multiEdit: MultiEdit): Promise<InsertHistoryRow<any>[]>;
+    /**
+     * Get multiEdits
+     * @param cakeKey - The cake table key
+     * @param where - The where clause to filter multiEdits
+     */
+    getMultiEdits(cakeKey: string, where: string | Json): Promise<MultiEdit[]>;
+    /**
+     * Add an edit
+     * @param cakeKey - The cake table key
+     * @param edit - The edit to add
+     */
+    addEdit(cakeKey: string, edit: Edit): Promise<InsertHistoryRow<any>[]>;
+    /**
+     * Get edits
+     * @param cakeKey - The cake table key
+     * @param where - The where clause to filter edits
+     */
+    getEdits(cakeKey: string, where: string | Json): Promise<Edit[]>;
+    /**
+     * Add an edit history entry
+     * @param cakeKey - The cake table key
+     * @param editHistory - The edit history entry to add
+     */
+    addEditHistory(cakeKey: string, editHistory: EditHistory): Promise<InsertHistoryRow<any>[]>;
+    /**
+     * Get edit history entries
+     * @param cakeKey - The cake table key
+     * @param where - The where clause to filter edit history entries
+     */
+    getEditHistories(cakeKey: string, where: string | Json): Promise<EditHistory[]>;
     /**
      * Get the InsertHistory of a table
      * @param table - The table to get the InsertHistory for

package/dist/db.js

@@ -217,7 +217,8 @@ class ComponentController extends BaseController {
     "components",
     "edits",
     "editHistory",
-    "multiEdits"
+    "multiEdits",
+    "head"
   ];
   _resolvedColumns = null;
   _refTableKeyToColumnKeyMap = null;
@@ -888,6 +889,7 @@ const createController = async (type, core, tableKey, refs) => {
     case "edits":
     case "editHistory":
     case "multiEdits":
+    case "head":
       ctrl = new ComponentController(core, tableKey, refs);
       break;
     case "cakes":
@@ -2564,9 +2566,12 @@ class Notify {
   notify(route, insertHistoryRow) {
     const callbacks = this._callbacks.get(route.flat);
     if (callbacks) {
-      for (const cb of callbacks) {
-        cb(insertHistoryRow);
-      }
+      Promise.all(callbacks.map((cb) => cb(insertHistoryRow))).catch((err) => {
+        console.error(
+          `Error notifying callbacks for route ${route.flat}:`,
+          err
+        );
+      });
     }
   }
   // ...........................................................................
@@ -3278,9 +3283,13 @@ class Db {
           );
         }
       }
-      if (["components", "edits", "multiEdits"].includes(
-        nodeType
-      )) {
+      if ([
+        "components",
+        "edits",
+        "multiEdits",
+        "editHistory",
+        "head"
+      ].includes(nodeType)) {
         const runFn = runFns[nodeTableKey];
         const components = nodeTree._data;
         for (const component of components) {
@@ -3313,9 +3322,13 @@ class Db {
       }
     } else {
       const runFn = runFns[nodeTableKey];
-      if (["components", "edits", "multiEdits"].includes(
-        nodeType
-      )) {
+      if ([
+        "components",
+        "edits",
+        "multiEdits",
+        "editHistory",
+        "head"
+      ].includes(nodeType)) {
         const components = rmhsh(
           tree[nodeTableKey]
         );
@@ -3435,6 +3448,114 @@ class Db {
     });
   }
   // ...........................................................................
+  /**
+   * Add a head revision for a cake
+   * @param cakeKey - The cake table key
+   * @param cakeRef - The cake reference
+   */
+  async addHeadRevision(cakeKey, cakeRef) {
+    const cakeHeadKey = cakeKey + "Heads";
+    const cakeHeadController = await this.getController(cakeHeadKey);
+    return await cakeHeadController.insert("add", {
+      cakeRef,
+      timeId: timeId(),
+      _hash: ""
+    });
+  }
+  // ...........................................................................
+  /**
+   * Add a multiEdit
+   * @param cakeKey - The cake table key
+   * @param multiEdit - The multiEdit to add
+   */
+  async addMultiEdit(cakeKey, multiEdit) {
+    return this.insert(
+      Route.fromFlat(cakeKey + "MultiEdits"),
+      {
+        [cakeKey + "MultiEdits"]: {
+          _data: [multiEdit],
+          _type: "multiEdits"
+        }
+      },
+      { skipHistory: true }
+    );
+  }
+  // ...........................................................................
+  /**
+   * Get multiEdits
+   * @param cakeKey - The cake table key
+   * @param where - The where clause to filter multiEdits
+   */
+  async getMultiEdits(cakeKey, where) {
+    const multiEditController = await this.getController(
+      cakeKey + "MultiEdits"
+    );
+    const { [cakeKey + "MultiEdits"]: result } = await multiEditController.get(
+      where
+    );
+    return result._data;
+  }
+  // ...........................................................................
+  /**
+   * Add an edit
+   * @param cakeKey - The cake table key
+   * @param edit - The edit to add
+   */
+  async addEdit(cakeKey, edit) {
+    return this.insert(
+      Route.fromFlat(cakeKey + "Edits"),
+      {
+        [cakeKey + "Edits"]: {
+          _data: [edit],
+          _type: "edits"
+        }
+      },
+      { skipHistory: true }
+    );
+  }
+  // ...........................................................................
+  /**
+   * Get edits
+   * @param cakeKey - The cake table key
+   * @param where - The where clause to filter edits
+   */
+  async getEdits(cakeKey, where) {
+    const editController = await this.getController(cakeKey + "Edits");
+    const { [cakeKey + "Edits"]: result } = await editController.get(where);
+    return result._data;
+  }
+  // ...........................................................................
+  /**
+   * Add an edit history entry
+   * @param cakeKey - The cake table key
+   * @param editHistory - The edit history entry to add
+   */
+  async addEditHistory(cakeKey, editHistory) {
+    return this.insert(
+      Route.fromFlat(cakeKey + "EditHistory"),
+      {
+        [cakeKey + "EditHistory"]: {
+          _data: [editHistory],
+          _type: "editHistory"
+        }
+      },
+      { skipHistory: true }
+    );
+  }
+  // ...........................................................................
+  /**
+   * Get edit history entries
+   * @param cakeKey - The cake table key
+   * @param where - The where clause to filter edit history entries
+   */
+  async getEditHistories(cakeKey, where) {
+    const editHistoryController = await this.getController(
+      cakeKey + "EditHistory"
+    );
+    const { [cakeKey + "EditHistory"]: result } = await editHistoryController.get(where);
+    return result._data;
+  }
+  // ...........................................................................
   /**
    * Get the InsertHistory of a table
    * @param table - The table to get the InsertHistory for

package/dist/notify.d.ts

@@ -1,5 +1,5 @@
 import { InsertHistoryRow, Route } from '@rljson/rljson';
-type NotifyCallback<N extends string> = (InsertHistoryRow: InsertHistoryRow<N>) => void;
+export type NotifyCallback<N extends string> = (InsertHistoryRow: InsertHistoryRow<N>) => Promise<any>;
 /**
  * Notification system to manage callbacks for specific routes and notify them with edit protocol rows.
  */
@@ -36,4 +36,3 @@ export declare class Notify {
      */
     getCallBacksForRoute(route: Route): NotifyCallback<any>[];
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/db",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A high level interface to read and write RLJSON data from and into a database",
   "homepage": "https://github.com/rljson/db",
   "bugs": "https://github.com/rljson/db/issues",
@@ -21,30 +21,30 @@
   "type": "module",
   "devDependencies": {
     "@types/node": "^24.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.48.0",
-    "@typescript-eslint/parser": "^8.48.0",
-    "@vitest/coverage-v8": "^4.0.14",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "cross-env": "^10.1.0",
     "eslint": "^9.39.1",
-    "eslint-plugin-jsdoc": "^61.4.1",
+    "eslint-plugin-jsdoc": "^61.5.0",
     "eslint-plugin-tsdoc": "^0.5.0",
     "globals": "^16.5.0",
     "jsdoc": "^4.0.5",
     "read-pkg": "^10.0.0",
     "typescript": "~5.9.3",
-    "typescript-eslint": "^8.48.0",
-    "vite": "^7.2.6",
+    "typescript-eslint": "^8.48.1",
+    "vite": "^7.2.7",
     "vite-node": "^5.2.0",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^4.0.14",
+    "vitest": "^4.0.15",
     "vitest-dom": "^0.1.1"
   },
   "dependencies": {
     "@rljson/hash": "^0.0.17",
-    "@rljson/io": "^0.0.60",
+    "@rljson/io": "^0.0.61",
     "@rljson/json": "^0.0.23",
-    "@rljson/rljson": "^0.0.72",
+    "@rljson/rljson": "^0.0.73",
     "@rljson/validate": "^0.0.11",
     "filtrex": "^3.1.0",
     "object-traversal": "^1.0.1",