@rljson/db 0.0.3 → 0.0.6

package/dist/db.d.ts

@@ -1,5 +1,11 @@
 import { Io } from '@rljson/io';
+import { Json } from '@rljson/json';
+import { Insert, InsertHistoryRow, InsertHistoryTimeId, Ref, Rljson, Route } from '@rljson/rljson';
+import { Controller, 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';
 /**
  * Access Rljson data
  */
@@ -15,8 +21,150 @@ export declare class Db {
      */
     readonly core: Core;
     /**
-     * Example
-     * @returns A new Db instance for test purposes
+     * Notification system to register callbacks on data changes
      */
-    static example: () => Promise<Db>;
+    readonly notify: Notify;
+    private _cache;
+    /**
+     * 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>;
+    _get(route: Route, where: string | Json, controllers: Record<string, Controller<any, any>>, segmentLevel?: number): Promise<Rljson>;
+    /**
+     * Get the reference (hash) of a route segment, considering default refs and insertHistory refs
+     * @param segment - The route segment to get the reference for
+     * @returns
+     */
+    private _getReferenceOfRouteSegment;
+    /**
+     * Joins data from layers in an Rljson into a single dataset
+     * @param rljson - The Rljson to join data for
+     */
+    join(columnSelection: ColumnSelection, cakeKey: string, cakeRef: Ref): Promise<Join>;
+    /**
+     * Fetches data for the given ColumnSelection
+     * @param columnSelection - The ColumnSelection to fetch data for
+     */
+    private _getBaseDataForColumnSelection;
+    /**
+     * Runs an Insert by executing the appropriate controller(s) based on the Insert's route
+     * @param Insert - The Insert to run
+     * @returns The result of the Insert as an InsertHistoryRow
+     * @throws {Error} If the Insert is not valid or if any controller cannot be created
+     */
+    insert(insert: Insert<any>, options?: {
+        skipNotification?: boolean;
+    }): Promise<InsertHistoryRow<any>>;
+    /**
+     * Recursively runs controllers based on the route of the Insert
+     * @param insert - The Insert to run
+     * @param route - The route of the Insert
+     * @param runFns - A record of controller run functions, keyed by table name
+     * @returns The result of the Insert
+     * @throws {Error} If the route is not valid or if any controller cannot be created
+     */
+    private _insert;
+    /**
+     * Registers a callback to be called when an Insert is made on the given route
+     * @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;
+    /**
+     * 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;
+    /**
+     * Resolves an Insert by returning the run functions of all controllers involved in the Insert's route
+     * @param Insert - The Insert 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 _resolveInsert;
+    /**
+     * Returns the keys of child refs in a value based on a route
+     * @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 InsertHistory row to the InsertHistory table of a table
+     * @param table - The table the Insert was made on
+     * @param InsertHistoryRow - The InsertHistory row to add
+     * @throws {Error} If the InsertHistory table does not exist
+     */
+    private _writeInsertHistory;
+    /**
+     * Get the InsertHistory of a table
+     * @param table - The table to get the InsertHistory for
+     * @throws {Error} If the InsertHistory table does not exist
+     */
+    getInsertHistory(table: string, options?: {
+        sorted?: boolean;
+        ascending?: boolean;
+    }): Promise<Rljson>;
+    /**
+     * Get a specific InsertHistory row from a table
+     * @param table - The table to get the InsertHistory row from
+     * @param ref - The reference of the InsertHistory row to get
+     * @returns The InsertHistory row or null if it does not exist
+     * @throws {Error} If the Inserts table does not exist
+     */
+    getInsertHistoryRowsByRef(table: string, ref: string): Promise<InsertHistoryRow<any>[]>;
+    /**
+     * Get a specific InsertHistory row from a table by its timeId
+     * @param table - The table to get the InsertHistory row from
+     * @param timeId - The timeId of the InsertHistory row to get
+     * @returns The InsertHistory row or null if it does not exist
+     * @throws {Error} If the Inserts table does not exist
+     */
+    getInsertHistoryRowByTimeId(table: string, timeId: InsertHistoryTimeId): Promise<InsertHistoryRow<any>>;
+    /**
+     * 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 Inserts table does not exist
+     */
+    getTimeIdsForRef(table: string, ref: Ref): Promise<InsertHistoryTimeId[]>;
+    /**
+     * 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 Inserts table does not exist
+     */
+    getRefOfTimeId(table: string, timeId: InsertHistoryTimeId): Promise<Ref | null>;
+    /**
+     * Isolates the property key from the last segment of a route if it is a property of a component
+     * @param route - The route to extract property key from
+     * @returns A route with extracted property key
+     */
+    isolatePropertyKeyFromRoute(route: Route): Promise<Route>;
+    /**
+     * Isolates a property from all components in an Rljson
+     * @param rljson - The Rljson to isolate the property from
+     * @param propertyKey - The property key to isolate
+     * @returns A new Rljson with only the isolated property
+     */
+    isolatePropertyFromComponents(rljson: Rljson, propertyKey: string): Rljson;
+    /**
+     * Get the current cache of the Db instance
+     */
+    get cache(): Map<string, Rljson>;
 }