@rljson/io 0.0.5 → 0.0.7

package/README.contributors.md

@@ -17,11 +17,12 @@
   - [Install GitHub CLI](#install-github-cli)
 - [Develop](#develop)
   - [Read architecture doc](#read-architecture-doc)
-  - [Checkout main](#checkout-main)
-  - [Create a branch](#create-a-branch)
   - [Debug](#debug)
   - [Update goldens](#update-goldens)
   - [Test and Build](#test-and-build)
+- [Workflow](#workflow)
+  - [Checkout main](#checkout-main)
+  - [Create a branch](#create-a-branch)
   - [Commit](#commit)
   - [Update dependencies](#update-dependencies)
   - [Increase version](#increase-version)
@@ -40,10 +41,10 @@
 ### Check out
 
 ```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/io.git
+mkdir io
 cd io
+git clone https://github.com/rljson/io.git
+cd db
 ```
 
 ### Install pnpm
@@ -108,25 +109,6 @@ gh auth login
 Read [README.architecture.md](./README.architecture.md) to get an overview
 of the package's architecture.
 
-### Checkout main
-
-```bash
-git checkout main && \
-git fetch && \
-git pull
-```
-
-### Create a branch
-
-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="Take over code from old rljson-js lib" && \
-export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
-git checkout -b $BRANCH
-```
-
 ### Debug
 
 In Vscode: At the `left side bar` click on the `Test tube` icon to open the `Test explorer`.
@@ -157,14 +139,39 @@ pnpm test &&\
 pnpm build
 ```
 
+<!-- ........................................................................-->
+
+## Workflow
+
+### Checkout main
+
+```bash
+git checkout main && \
+git fetch && \
+git pull
+```
+
+### Create a branch
+
+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="Update README.contributors.m" && \
+export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+git checkout -b $BRANCH
+```
+
 ### Commit
 
 Develop your feature
 
 Commit your changes
 
+If you only have one thing, execute
+
 ```bash
-git commit -am"$MESSAGE"
+git add . && git commit -m "$MESSAGE"
 ```
 
 ### Update dependencies
@@ -173,7 +180,7 @@ We aim to work with the latest versions of our dependencies.
 
 ```bash
 pnpm update --latest &&\
-git commit -am"Update dependencies"
+git commit -m"Update dependencies"
 ```
 
 ### Increase version
@@ -196,11 +203,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

@@ -17,11 +17,12 @@
   - [Install GitHub CLI](#install-github-cli)
 - [Develop](#develop)
   - [Read architecture doc](#read-architecture-doc)
-  - [Checkout main](#checkout-main)
-  - [Create a branch](#create-a-branch)
   - [Debug](#debug)
   - [Update goldens](#update-goldens)
   - [Test and Build](#test-and-build)
+- [Workflow](#workflow)
+  - [Checkout main](#checkout-main)
+  - [Create a branch](#create-a-branch)
   - [Commit](#commit)
   - [Update dependencies](#update-dependencies)
   - [Increase version](#increase-version)
@@ -40,10 +41,10 @@
 ### Check out
 
 ```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/io.git
+mkdir io
 cd io
+git clone https://github.com/rljson/io.git
+cd db
 ```
 
 ### Install pnpm
@@ -108,25 +109,6 @@ gh auth login
 Read [README.architecture.md](./README.architecture.md) to get an overview
 of the package's architecture.
 
-### Checkout main
-
-```bash
-git checkout main && \
-git fetch && \
-git pull
-```
-
-### Create a branch
-
-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="Take over code from old rljson-js lib" && \
-export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
-git checkout -b $BRANCH
-```
-
 ### Debug
 
 In Vscode: At the `left side bar` click on the `Test tube` icon to open the `Test explorer`.
@@ -157,14 +139,39 @@ pnpm test &&\
 pnpm build
 ```
 
+<!-- ........................................................................-->
+
+## Workflow
+
+### Checkout main
+
+```bash
+git checkout main && \
+git fetch && \
+git pull
+```
+
+### Create a branch
+
+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="Update README.contributors.m" && \
+export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+git checkout -b $BRANCH
+```
+
 ### Commit
 
 Develop your feature
 
 Commit your changes
 
+If you only have one thing, execute
+
 ```bash
-git commit -am"$MESSAGE"
+git add . && git commit -m "$MESSAGE"
 ```
 
 ### Update dependencies
@@ -173,7 +180,7 @@ We aim to work with the latest versions of our dependencies.
 
 ```bash
 pnpm update --latest &&\
-git commit -am"Update dependencies"
+git commit -m"Update dependencies"
 ```
 
 ### Increase version
@@ -196,11 +203,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/index.d.ts

@@ -1 +1,2 @@
+export * from './io-mem.ts';
 export * from './io.ts';

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

@@ -5,6 +5,10 @@ export interface Io {
     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;

package/dist/io.js

@@ -1,5 +1,167 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+import { hip, hsh } from "@rljson/hash";
+import { copy, equals } from "@rljson/json";
+// @license
+const _IoMem = class _IoMem {
+  constructor() {
+    // ######################
+    // Private
+    // ######################
+    __publicField(this, "_mem", hip({}));
+  }
+  // ...........................................................................
+  // General
+  isReady() {
+    return Promise.resolve();
+  }
+  // ...........................................................................
+  // Dump
+  dump() {
+    return this._dump();
+  }
+  async dumpTable(request) {
+    return this._dumpTable(request);
+  }
+  // ...........................................................................
+  // Rows
+  readRow(request) {
+    return this._readRow(request);
+  }
+  readRows(request) {
+    return this._readRows(request);
+  }
+  // ...........................................................................
+  // Write
+  write(request) {
+    return this._write(request);
+  }
+  // ...........................................................................
+  // Table management
+  createTable(request) {
+    return this._createTable(request);
+  }
+  async tables() {
+    const keys = Object.keys(this._mem);
+    const tables = keys.filter((key) => !key.startsWith("_"));
+    return tables;
+  }
+  // ...........................................................................
+  async _createTable(request) {
+    var _a;
+    const { name, type } = request;
+    const existing = this._mem[name];
+    if (existing) {
+      if (existing._type !== type) {
+        throw new Error(
+          `Table ${name} already exists with different type: "${existing._type}" vs "${request.type}"`
+        );
+      }
+    } else {
+      (_a = this._mem)[name] ?? (_a[name] = {
+        _data: [],
+        _type: type
+      });
+    }
+  }
+  // ...........................................................................
+  async _readRow(request) {
+    const table = this._mem[request.table];
+    if (!table) {
+      throw new Error(`Table ${request.table} not found`);
+    }
+    const row = table._data.find((row2) => row2._hash === request.rowHash);
+    if (!row) {
+      throw new Error(
+        `Row "${request.rowHash}" not found in table ${request.table}`
+      );
+    }
+    const result = {
+      [request.table]: {
+        _data: [row]
+      }
+    };
+    return result;
+  }
+  // ...........................................................................
+  async _dump() {
+    return copy(this._mem);
+  }
+  // ...........................................................................
+  async _dumpTable(request) {
+    const table = this._mem[request.name];
+    if (!table) {
+      throw new Error(`Table ${request.name} not found`);
+    }
+    return {
+      [request.name]: copy(table)
+    };
+  }
+  // ...........................................................................
+  async _write(request) {
+    const addedData = hsh(request.data);
+    const tables = Object.keys(addedData);
+    for (const table of tables) {
+      if (table.startsWith("_")) {
+        continue;
+      } else {
+        if (!this._mem[table]) {
+          throw new Error(`Table ${table} does not exist`);
+        }
+      }
+      const oldTable = this._mem[table];
+      const newTable = addedData[table];
+      if (oldTable._type !== newTable._type) {
+        throw new Error(
+          `Table ${table} has different types: "${oldTable._type}" vs "${newTable._type}"`
+        );
+      }
+      for (const item of newTable._data) {
+        const hash = item._hash;
+        const exists = oldTable._data.find((i) => i._hash === hash);
+        if (!exists) {
+          oldTable._data.push(item);
+        }
+      }
+    }
+    this._mem._hash = "";
+    const updateExistingHashes = false;
+    const throwIfOnWrongHashes = false;
+    hip(this._mem, updateExistingHashes, throwIfOnWrongHashes);
+  }
+  // ...........................................................................
+  async _readRows(request) {
+    const table = this._mem[request.table];
+    if (!table) {
+      throw new Error(`Table ${request.table} not found`);
+    }
+    const result = {
+      [request.table]: {
+        _data: table._data.filter((row) => {
+          for (const column in request.where) {
+            const a = row[column];
+            const b = request.where[column];
+            if (!equals(a, b)) {
+              return false;
+            }
+          }
+          return true;
+        })
+      }
+    };
+    return result;
+  }
+};
+// ...........................................................................
+// Constructor & example
+__publicField(_IoMem, "example", () => {
+  return new _IoMem();
+});
+let IoMem = _IoMem;
 // @license
 const exampleIo = "Checkout @rljson/io-mem for an example implementation";
 export {
+  IoMem,
   exampleIo
 };

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.5",
+  "version": "0.0.7",
   "packageManager": "pnpm@10.6.2",
   "description": "Low level interface for reading and writing RLJSON data",
   "homepage": "https://github.com/rljson/io",
@@ -57,8 +57,8 @@
   },
   "dependencies": {
     "@rljson/hash": "^0.0.10",
-    "@rljson/json": "^0.0.8",
-    "@rljson/rljson": "^0.0.7",
-    "@rljson/validate": "^0.0.5"
+    "@rljson/json": "^0.0.9",
+    "@rljson/rljson": "^0.0.9",
+    "@rljson/validate": "^0.0.6"
   }
 }