@rljson/io 0.0.4 → 0.0.6

package/README.contributors.md

@@ -1,5 +1,9 @@
 <!--
-
+// @license
+// Copyright (c) 2025 Rljson
+//
+// Use of this source code is governed by terms that can be
+// found in the LICENSE file in the root of this package.
 -->
 
 # Contributors Guide
@@ -118,7 +122,7 @@ Please replace `Commit Message` in the next command by your commit message.
 It will also used for branch name and pull request
 
 ```bash
-export MESSAGE="Fix small things in README" && \
+export MESSAGE="Add IoMem and dump table" && \
 export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
 git checkout -b $BRANCH
 ```
@@ -159,6 +163,8 @@ Develop your feature
 
 Commit your changes
 
+If you only have one thing, execute
+
 ```bash
 git commit -am"$MESSAGE"
 ```
@@ -184,7 +190,8 @@ git commit -am"Increase version"
 ```bash
 git push -u origin $BRANCH && \
 gh pr create --base main --title "$MESSAGE" --body "" && \
-gh pr merge --auto --squash
+gh pr merge --auto --squash && \
+
 ```
 
 ### Wait until PR is merged
@@ -192,11 +199,13 @@ gh pr merge --auto --squash
 Get the PR URL with the following command
 
 ```bash
-gh pr view --json url -q .url
+echo -e "\033[34m$(gh pr view --json url | jq -r '.url')\033[0m"
+echo "Wait until PR is closed ..." && \
+until gh pr view --json closed | jq -e '.closed == true' >/dev/null; do
+  sleep 2 >/dev/null;
+done;
 ```
 
-Visit it
-
 ### Delete feature branch
 
 ```bash

package/dist/README.contributors.md

@@ -1,5 +1,9 @@
 <!--
-
+// @license
+// Copyright (c) 2025 Rljson
+//
+// Use of this source code is governed by terms that can be
+// found in the LICENSE file in the root of this package.
 -->
 
 # Contributors Guide
@@ -118,7 +122,7 @@ Please replace `Commit Message` in the next command by your commit message.
 It will also used for branch name and pull request
 
 ```bash
-export MESSAGE="Fix small things in README" && \
+export MESSAGE="Add IoMem and dump table" && \
 export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
 git checkout -b $BRANCH
 ```
@@ -159,6 +163,8 @@ Develop your feature
 
 Commit your changes
 
+If you only have one thing, execute
+
 ```bash
 git commit -am"$MESSAGE"
 ```
@@ -184,7 +190,8 @@ git commit -am"Increase version"
 ```bash
 git push -u origin $BRANCH && \
 gh pr create --base main --title "$MESSAGE" --body "" && \
-gh pr merge --auto --squash
+gh pr merge --auto --squash && \
+
 ```
 
 ### Wait until PR is merged
@@ -192,11 +199,13 @@ gh pr merge --auto --squash
 Get the PR URL with the following command
 
 ```bash
-gh pr view --json url -q .url
+echo -e "\033[34m$(gh pr view --json url | jq -r '.url')\033[0m"
+echo "Wait until PR is closed ..." && \
+until gh pr view --json closed | jq -e '.closed == true' >/dev/null; do
+  sleep 2 >/dev/null;
+done;
 ```
 
-Visit it
-
 ### Delete feature branch
 
 ```bash

package/dist/example.d.ts

@@ -1,4 +1 @@
-/**
- * The example function demonstrates how the package works
- */
-export declare const example: () => void;
+export declare const example: () => Promise<void>;

package/dist/io-mem.d.ts

@@ -0,0 +1,39 @@
+import { JsonValue } from '@rljson/json';
+import { ContentType, Rljson } from '@rljson/rljson';
+import { Io } from './io.ts';
+/**
+ * In-Memory implementation of the Rljson Io interface.
+ */
+export declare class IoMem implements Io {
+    static example: () => IoMem;
+    isReady(): Promise<void>;
+    dump(): Promise<Rljson>;
+    dumpTable(request: {
+        name: string;
+    }): Promise<Rljson>;
+    readRow(request: {
+        table: string;
+        rowHash: string;
+    }): Promise<Rljson>;
+    readRows(request: {
+        table: string;
+        where: {
+            [column: string]: JsonValue;
+        };
+    }): Promise<Rljson>;
+    write(request: {
+        data: Rljson;
+    }): Promise<void>;
+    createTable(request: {
+        name: string;
+        type: ContentType;
+    }): Promise<void>;
+    tables(): Promise<string[]>;
+    private _mem;
+    private _createTable;
+    private _readRow;
+    private _dump;
+    private _dumpTable;
+    private _write;
+    private _readRows;
+}

package/dist/io.d.ts

@@ -1,14 +1,21 @@
+import { JsonValue } from '@rljson/json';
 import { ContentType, Rljson } from '@rljson/rljson';
 export interface Io {
     /** A promise resolving once the Io interface is ready */
     isReady(): Promise<void>;
     /** Returns the complete db content as Rljson */
     dump(): Promise<Rljson>;
+    /** Returns the dump of a complete table */
+    dumpTable(request: {
+        name: string;
+    }): Promise<Rljson>;
     /** Creates a table with a given type */
     createTable(request: {
         name: string;
         type: ContentType;
     }): Promise<void>;
+    /** Returns the available table names */
+    tables(): Promise<string[]>;
     /** Writes Rljson data in to the database */
     write(request: {
         data: Rljson;
@@ -18,5 +25,12 @@ export interface Io {
         table: string;
         rowHash: string;
     }): Promise<Rljson>;
+    /** Queries a list of rows */
+    readRows(request: {
+        table: string;
+        where: {
+            [column: string]: JsonValue;
+        };
+    }): Promise<Rljson>;
 }
 export declare const exampleIo = "Checkout @rljson/io-mem for an example implementation";

package/dist/src/example.ts

@@ -4,9 +4,39 @@
 // Use of this source code is governed by terms that can be
 // found in the LICENSE file in the root of this package.
 
-/**
- * The example function demonstrates how the package works
- */
-export const example = () => {
-  console.log('exampleIo');
+import { hsh } from '@rljson/hash';
+import { Rljson } from '@rljson/rljson';
+
+import { IoMem } from './io-mem.ts';
+
+// Run »pnpm updateGoldens« when you change this file
+export const example = async () => {
+  const ioMem = new IoMem();
+
+  const row = { keyA2: 'a2' };
+  const rowWithHash = hsh(row);
+
+  // Create a table first
+  await ioMem.createTable({ name: 'tableA', type: 'properties' });
+
+  // Write data into the table
+  await ioMem.write({
+    data: {
+      tableA: {
+        _type: 'properties',
+        _data: [row],
+      },
+    },
+  });
+
+  // Read data from the table
+  const data: Rljson = await ioMem.readRow({
+    table: 'tableA',
+    rowHash: rowWithHash._hash,
+  });
+
+  // Print the return rljson data
+  console.log(JSON.stringify(data, null, 2));
 };
+
+// example();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/io",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "packageManager": "pnpm@10.6.2",
   "description": "Low level interface for reading and writing RLJSON data",
   "homepage": "https://github.com/rljson/io",
@@ -14,7 +14,7 @@
     "type": "git",
     "url": "git+https://github.com/rljson/io.git"
   },
-  "main": "dist/index.js",
+  "main": "dist/io.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
@@ -39,6 +39,7 @@
     "eslint-plugin-tsdoc": "^0.4.0",
     "globals": "^16.0.0",
     "jsdoc": "^4.0.4",
+    "read-pkg": "^9.0.1",
     "typescript": "~5.8.2",
     "typescript-eslint": "^8.26.1",
     "vite": "^6.2.1",
@@ -55,9 +56,9 @@
     "overrides": {}
   },
   "dependencies": {
-    "@rljson/hash": "^0.0.9",
-    "@rljson/json": "^0.0.7",
+    "@rljson/hash": "^0.0.10",
+    "@rljson/json": "^0.0.8",
     "@rljson/rljson": "^0.0.7",
-    "@rljson/validate": "^0.0.4"
+    "@rljson/validate": "^0.0.5"
   }
 }