@rljson/db 0.0.3 → 0.0.5

package/dist/db.d.ts

@@ -1,5 +1,9 @@
 import { Io } from '@rljson/io';
+import { Json } from '@rljson/json';
+import { Edit, EditProtocolRow, EditProtocolTimeId, Ref, Rljson, Route } from '@rljson/rljson';
+import { Controller, ControllerRefs } from './controller/controller.ts';
 import { Core } from './core.ts';
+import { Notify } from './notify.ts';
 /**
  * Access Rljson data
  */
@@ -14,6 +18,127 @@ export declare class Db {
      * Core functionalities like importing data, setting and getting tables
      */
     readonly core: Core;
+    /**
+     * Notification system to register callbacks on data changes
+     */
+    readonly notify: Notify;
+    /**
+     * Get data from a route with optional filtering
+     * @param route - The route to get data from
+     * @param where - Optional filter to apply to the data
+     * @returns An array of Rljson objects matching the route and filter
+     * @throws {Error} If the route is not valid or if any controller cannot be created
+     */
+    get(route: Route, where: string | Json): Promise<Rljson[]>;
+    /**
+     * Recursively fetches data from the given route using the provided controllers
+     * @param route - The route to fetch data from
+     * @param where - The filter to apply to the root table
+     * @param controllers - A record of controllers keyed by table name
+     * @returns An array of Rljson objects matching the route and filter
+     */
+    private _get;
+    /**
+     * Runs an edit by executing the appropriate controller(s) based on the edit's route
+     * @param edit - The edit to run
+     * @returns The result of the edit as an EditProtocolRow
+     * @throws {Error} If the edit is not valid or if any controller cannot be created
+     */
+    run(edit: Edit<any>, options?: {
+        skipNotification?: boolean;
+    }): Promise<EditProtocolRow<any>>;
+    /**
+     * Recursively runs controllers based on the route of the edit
+     * @param edit - The edit to run
+     * @param route - The route of the edit
+     * @param runFns - A record of controller run functions, keyed by table name
+     * @returns The result of the edit
+     * @throws {Error} If the route is not valid or if any controller cannot be created
+     */
+    private _run;
+    /**
+     * Registers a callback to be called when an edit is made on the given route
+     * @param route - The route to register the callback on
+     * @param callback - The callback to be called when an edit is made
+     */
+    registerObserver(route: Route, callback: (EditProtocolRow: EditProtocolRow<any>) => void): 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: (EditProtocolRow: EditProtocolRow<any>) => void): void;
+    /**
+     * Resolves an edit by returning the run functions of all controllers involved in the edit's route
+     * @param edit - The edit to resolve
+     * @returns A record of controller run functions, keyed by table name
+     * @throws {Error} If the route is not valid or if any controller cannot be created
+     */
+    private _resolveRuns;
+    /**
+     * Returns the keys of child refs in a value based on a route
+     * @param route - The route to check
+     * @param value - The value to check
+     * @returns An array of keys of child refs in the value
+     */
+    private _childKeys;
+    /**
+     * Get a controller for a specific table
+     * @param tableKey - The key of the table to get the controller for
+     * @param refs - Optional references required by some controllers
+     * @returns A controller for the specified table
+     * @throws {Error} If the table does not exist or if the table type is not supported
+     */
+    getController(tableKey: string, refs?: ControllerRefs): Promise<Controller<any, string>>;
+    private _indexedControllers;
+    /**
+     * Adds an edit protocol row to the edits table of a table
+     * @param table - The table the edit was made on
+     * @param editProtocolRow - The edit protocol row to add
+     * @throws {Error} If the edits table does not exist
+     */
+    private _writeProtocol;
+    /**
+     * Get the edit protocol of a table
+     * @param table - The table to get the edit protocol for
+     * @throws {Error} If the edits table does not exist
+     */
+    getProtocol(table: string, options?: {
+        sorted?: boolean;
+        ascending?: boolean;
+    }): Promise<Rljson>;
+    /**
+     * Get a specific edit protocol row from a table
+     * @param table - The table to get the edit protocol row from
+     * @param ref - The reference of the edit protocol row to get
+     * @returns The edit protocol row or null if it does not exist
+     * @throws {Error} If the edits table does not exist
+     */
+    getProtocolRowsByRef(table: string, ref: string): Promise<EditProtocolRow<any>[] | null>;
+    /**
+     * Get a specific edit protocol row from a table by its timeId
+     * @param table - The table to get the edit protocol row from
+     * @param timeId - The timeId of the edit protocol row to get
+     * @returns The edit protocol row or null if it does not exist
+     * @throws {Error} If the edits table does not exist
+     */
+    getProtocolRowByTimeId(table: string, timeId: EditProtocolTimeId): Promise<EditProtocolRow<any> | null>;
+    /**
+     * Get all timeIds for a specific ref in a table
+     * @param table - The table to get the timeIds from
+     * @param ref - The reference to get the timeIds for
+     * @returns An array of timeIds
+     * @throws {Error} If the edits table does not exist
+     */
+    getTimeIdsForRef(table: string, ref: Ref): Promise<EditProtocolTimeId[]>;
+    /**
+     * Get the ref for a specific timeId in a table
+     * @param table - The table to get the ref from
+     * @param timeId - The timeId to get the ref for
+     * @returns The ref or null if it does not exist
+     * @throws {Error} If the edits table does not exist
+     */
+    getRefOfTimeId(table: string, timeId: EditProtocolTimeId): Promise<Ref | null>;
     /**
      * Example
      * @returns A new Db instance for test purposes