@rljson/io 0.0.61 → 0.0.63

package/dist/conformance-tests/goldens/tableCfgs-1.json

@@ -1,159 +1,5 @@
 [
-  {
-    "_hash": "jERNpYntKnsV66yxoS2xOg",
-    "key": "tableCfgs",
-    "type": "tableCfgs",
-    "isHead": false,
-    "isRoot": false,
-    "isShared": true,
-    "previous": "",
-    "columns": [
-      {
-        "key": "_hash",
-        "type": "string",
-        "titleShort": "Hash",
-        "titleLong": "Row Hash",
-        "_hash": "2QxgcOKzL6zsVCo9Yi_5Ke"
-      },
-      {
-        "key": "key",
-        "type": "string",
-        "titleShort": "Key",
-        "titleLong": "Table Key",
-        "_hash": "vXW6G031fGusGpEgdnVWmt"
-      },
-      {
-        "key": "type",
-        "type": "string",
-        "titleShort": "Type",
-        "titleLong": "Content Type",
-        "_hash": "X2upWVtQ02TKW3mj6SqU0c"
-      },
-      {
-        "key": "isHead",
-        "type": "boolean",
-        "titleShort": "Is Head",
-        "titleLong": "Is Head Table",
-        "_hash": "A-q9m5MVPMRVN6hk4pAMLH"
-      },
-      {
-        "key": "isRoot",
-        "type": "boolean",
-        "titleShort": "Is Root",
-        "titleLong": "Is Root Table",
-        "_hash": "qYiiwGCxzUtxlqIvZeU1rh"
-      },
-      {
-        "key": "isShared",
-        "type": "boolean",
-        "titleShort": "Is Shared",
-        "titleLong": "Is Shared Table",
-        "_hash": "jS9CqQBxXDhz1IB6PET4-P"
-      },
-      {
-        "key": "previous",
-        "type": "string",
-        "titleShort": "Previous",
-        "titleLong": "Previous Table Configuration Hash",
-        "_hash": "0EgSa6oJSjOqjUCqlJzb5E"
-      },
-      {
-        "key": "columns",
-        "type": "jsonArray",
-        "titleShort": "Columns",
-        "titleLong": "Column Configurations",
-        "_hash": "GRV_4vc3xouarDpc1ZXE2_"
-      }
-    ]
-  },
-  {
-    "key": "revisions",
-    "type": "revisions",
-    "isHead": true,
-    "isRoot": true,
-    "isShared": false,
-    "columns": [
-      {
-        "key": "_hash",
-        "type": "string",
-        "titleShort": "Hash",
-        "titleLong": "Row Hash",
-        "_hash": "2QxgcOKzL6zsVCo9Yi_5Ke"
-      },
-      {
-        "key": "table",
-        "type": "string",
-        "titleShort": "Table",
-        "titleLong": "Table Key",
-        "_hash": "dxePvdUNnwg2TdHEAPlzcL"
-      },
-      {
-        "key": "predecessor",
-        "type": "string",
-        "titleShort": "Predecessor",
-        "titleLong": "Predecessor Revision Hash",
-        "_hash": "DX2BPCXbaK-WFn4Oy9hYjg"
-      },
-      {
-        "key": "successor",
-        "type": "string",
-        "titleShort": "Successor",
-        "titleLong": "Successor Revision Hash",
-        "_hash": "w-IMk9JjuBkgt88ddVGV7B"
-      },
-      {
-        "key": "timestamp",
-        "type": "number",
-        "titleShort": "Timestamp",
-        "titleLong": "Revision Timestamp",
-        "_hash": "G9EloAJ1OVidMrffwSVrLt"
-      },
-      {
-        "key": "id",
-        "type": "string",
-        "titleShort": "ID",
-        "titleLong": "Revision ID",
-        "_hash": "gwBBBa7SXFx2Zfz00JYdCR"
-      }
-    ],
-    "_hash": "KFWwSAaR3bnqCwesHeAN4k"
-  },
-  {
-    "key": "table0",
-    "type": "components",
-    "isHead": false,
-    "isRoot": false,
-    "isShared": true,
-    "columns": [
-      {
-        "key": "_hash",
-        "type": "string",
-        "titleShort": "_hash",
-        "titleLong": "Hash",
-        "_hash": "L9iUlNEZRCGaQQts9mi--U"
-      },
-      {
-        "key": "col0",
-        "type": "string",
-        "titleShort": "col0",
-        "titleLong": "Col0",
-        "_hash": "dCXjY3cV-nGTHT-40a9SLj"
-      },
-      {
-        "key": "col1",
-        "type": "string",
-        "titleShort": "col1",
-        "titleLong": "Col1",
-        "_hash": "FMQLo4Apkp7E3LwlW9Fzuy"
-      },
-      {
-        "key": "col2",
-        "type": "string",
-        "titleShort": "col2",
-        "titleLong": "Col2",
-        "_hash": "jeJdZQXgk22xyinIGX6IeM"
-      }
-    ],
-    "_hash": "XyGTK9tL8OKBWGtsV0Ni-6"
-  }
+  "revisions",
+  "table0",
+  "tableCfgs"
 ]

package/dist/conformance-tests/io-conformance.spec.ts

@@ -154,12 +154,13 @@ export const runIoConformanceTests = (
 
         // Check the tableCfgs
         // Sort it in advance to have a stable order for the golden file
-        const actualTableCfgs = (await ioTools.tableCfgs()).sort((a, b) =>
-          (a as any)._hash.localeCompare(b._hash),
-        );
+        const actualTableCfgs = await ioTools.tableCfgs();
+        const actualTableCfgsSorted = actualTableCfgs
+          .sort((a, b) => a.key.localeCompare(b.key))
+          .map((cfg) => cfg.key);
 
         await expectGolden('io-conformance/tableCfgs-1.json', ego).toBe(
-          actualTableCfgs,
+          actualTableCfgsSorted,
         );
       });
     });

package/dist/index.d.ts

@@ -1,5 +1,9 @@
 export * from './io-db-name-mapping.ts';
 export * from './io-mem.ts';
+export * from './io-multi.ts';
+export * from './io-peer-bridge.ts';
+export * from './io-peer.ts';
+export * from './io-server.ts';
 export * from './io-test-setup.ts';
 export * from './io-tools.ts';
 export * from './io.ts';

package/dist/io-multi.d.ts

@@ -0,0 +1,117 @@
+import { JsonValue } from '@rljson/json';
+import { ContentType, Rljson, TableCfg, TableKey } from '@rljson/rljson';
+import { Io } from './io.ts';
+/**
+ * Type representing an Io instance along with its capabilities and priority.
+ */
+export type IoMultiIo = {
+    io: Io;
+    id?: string;
+    priority: number;
+    read: boolean;
+    write: boolean;
+    dump: boolean;
+};
+/**
+ * Multi Io implementation that combines multiple underlying Io instances
+ * with different capabilities (read, write, dump) and priorities.
+ */
+export declare class IoMulti implements Io {
+    private _ios;
+    isOpen: boolean;
+    constructor(_ios: Array<IoMultiIo>);
+    /**
+     *
+     * Initializes all underlying Io instances.
+     * @returns
+     */
+    init(): Promise<void>;
+    /**
+     * Closes all underlying Io instances.
+     * @returns
+     */
+    close(): Promise<void>;
+    /**
+     * Returns a promise that resolves once all underlying Io instances are ready.
+     * @returns
+     */
+    isReady(): Promise<void>;
+    /**
+     * Dumps the entire database content by merging dumps from all dumpable underlying Io instances.
+     * @returns
+     */
+    dump(): Promise<Rljson>;
+    /**
+     * Dumps a specific table by merging dumps from all dumpable underlying Io instances that contain the table.
+     * @param request An object containing the table name to dump.
+     * @returns A promise that resolves to the dumped table data.
+     */
+    dumpTable(request: {
+        table: string;
+    }): Promise<Rljson>;
+    /**
+     * Retrieves the content type of a specific table from the first underlying readable Io instance that contains the table.
+     * @param request An object containing the table name.
+     * @returns A promise that resolves to the content type of the table.
+     */
+    contentType(request: {
+        table: string;
+    }): Promise<ContentType>;
+    /**
+     * Checks if a specific table exists in any of the underlying readable Io instances.
+     * @param tableKey The key of the table to check.
+     * @returns A promise that resolves to true if the table exists in any readable Io, false otherwise.
+     */
+    tableExists(tableKey: TableKey): Promise<boolean>;
+    /**
+     * Creates or extends a table in all underlying writable Io instances.
+     * @param request An object containing the table configuration.
+     * @returns A promise that resolves once the table has been created or extended in all writable Io instances.
+     */
+    createOrExtendTable(request: {
+        tableCfg: TableCfg;
+    }): Promise<void>;
+    /**
+     * Retrieves the raw table configurations from the highest priority underlying readable Io instance.
+     * @returns A promise that resolves to an array of table configurations.
+     */
+    rawTableCfgs(): Promise<TableCfg[]>;
+    /**
+     * Writes data to all underlying writable Io instances.
+     * @param request - An object containing the data to write.
+     * @returns A promise that resolves once the data has been written to all writable Io instances.
+     */
+    write(request: {
+        data: Rljson;
+    }): Promise<void>;
+    /**
+     * Reads rows from a specific table by merging rows from all underlying readable Io instances.
+     * @param request An object containing the table name and where clause.
+     * @returns A promise that resolves to the read rows.
+     */
+    readRows(request: {
+        table: string;
+        where: {
+            [column: string]: JsonValue | null;
+        };
+    }): Promise<Rljson>;
+    /**
+     * Retrieves the row count of a specific table by aggregating row counts from all dumpable underlying Io instances.
+     * @param table The name of the table.
+     * @returns A promise that resolves to the row count of the table.
+     */
+    rowCount(table: string): Promise<number>;
+    /**
+     * Gets the list of underlying readable Io instances, sorted by priority.
+     */
+    get readables(): Array<IoMultiIo>;
+    /**
+     * Gets the list of underlying writable Io instances, sorted by priority.
+     */
+    get writables(): Array<IoMultiIo>;
+    /**
+     * Gets the list of underlying dumpable Io instances, sorted by priority.
+     */
+    get dumpables(): Array<IoMultiIo>;
+    static example: () => Promise<IoMulti>;
+}

package/dist/io-peer-bridge.d.ts

@@ -0,0 +1,75 @@
+import { Io } from './io.ts';
+import { Socket } from './socket.ts';
+/**
+ * Bridges Socket events to Io method calls.
+ *
+ * This class listens to socket events and translates them into corresponding
+ * Io method calls, automatically registering all Io interface methods.
+ */
+export declare class IoPeerBridge {
+    private _io;
+    private _socket;
+    private _eventHandlers;
+    constructor(_io: Io, _socket: Socket);
+    /**
+     * Starts the bridge by setting up connection event handlers and
+     * automatically registering all Io methods.
+     */
+    start(): void;
+    /**
+     * Stops the bridge by removing all event handlers.
+     */
+    stop(): void;
+    /**
+     * Automatically registers all Io interface methods as socket event handlers.
+     */
+    private _registerIoMethods;
+    /**
+     * Registers a socket event to be translated to an Io method call.
+     *
+     * @param eventName - The socket event name (should match an Io method name)
+     * @param ioMethodName - (Optional) The Io method name if different from eventName
+     */
+    registerEvent(eventName: string, ioMethodName?: string): void;
+    /**
+     * Registers multiple socket events at once.
+     *
+     * @param eventNames - Array of event names to register
+     */
+    registerEvents(eventNames: string[]): void;
+    /**
+     * Unregisters a socket event handler.
+     *
+     * @param eventName - The event name to unregister
+     */
+    unregisterEvent(eventName: string | symbol): void;
+    /**
+     * Emits a result back through the socket.
+     *
+     * @param eventName - The event name to emit
+     * @param data - The data to send
+     */
+    emitToSocket(eventName: string | symbol, ...data: any[]): void;
+    /**
+     * Calls an Io method directly and emits the result through the socket.
+     *
+     * @param ioMethodName - The Io method to call
+     * @param socketEventName - The socket event to emit with the result
+     * @param args - Arguments to pass to the Io method
+     */
+    callIoAndEmit(ioMethodName: string, socketEventName: string | symbol, ...args: any[]): Promise<void>;
+    private _handleConnect;
+    private _handleDisconnect;
+    /**
+     * Gets the current socket instance.
+     */
+    get socket(): Socket;
+    /**
+     * Gets the current Io instance.
+     */
+    get io(): Io;
+    /**
+     * Returns whether the socket is currently connected.
+     */
+    get isConnected(): boolean;
+}