@rljson/io 0.0.6 → 0.0.8

package/README.contributors.md

@@ -1,240 +1,32 @@
 <!--
-// @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.
+@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
 
-- [Install](#install)
-  - [Check out](#check-out)
-  - [Install pnpm](#install-pnpm)
-  - [Install dependencies](#install-dependencies)
-  - [Install Vscode extensions](#install-vscode-extensions)
-  - [Uninstall Jest and Jasmine](#uninstall-jest-and-jasmine)
-  - [Install GitHub CLI](#install-github-cli)
+- [Prepare](#prepare)
 - [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)
-  - [Commit](#commit)
-  - [Update dependencies](#update-dependencies)
-  - [Increase version](#increase-version)
-  - [Create a pull request](#create-a-pull-request)
-  - [Wait until PR is merged](#wait-until-pr-is-merged)
-  - [Delete feature branch](#delete-feature-branch)
-  - [Publish to NPM](#publish-to-npm)
-- [Troubleshooting](#troubleshooting)
-  - [Checkout README.trouble.md](#checkout-readmetroublemd)
-  - [File issues on GitHub](#file-issues-on-github)
-
-<!-- ........................................................................-->
-
-## Install
-
-### Check out
-
-```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/io.git
-cd io
-```
-
-### Install pnpm
-
-Windows:
-
-```bash
-corepack enable pnpm
-```
-
-Mac:
-
-```bash
-sudo corepack enable pnpm
-```
-
-### Install dependencies
-
-```bash
-pnpm install
-```
-
-### Install Vscode extensions
-
-Open this project in `vscode`.
-
-Press `Cmd+Shift+P`.
-
-Type `Extensions: Show Recommended Extensions` and press `Enter`.
+- [Tools](#tools)
+- [Superheros](#superheros)
 
-The recommended extensions will be shown.
+## Prepare
 
-Make sure, all recommended extensions are shown.
-
-### Uninstall Jest and Jasmine
-
-Jest or Jasmine extensions conflict with the `Vitest` extension used for this
-project.
-
-Uninstall them, if you have installed them.
-
-### Install GitHub CLI
-
-Install GitHub CLI on Mac
-
-```bash
-brew install gh
-```
-
-Login
-
-```bash
-gh auth login
-```
+Read [prepare.md](doc/workflows/prepare.md)
 
 <!-- ........................................................................-->
 
 ## Develop
 
-### Read architecture doc
-
-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="Add IoMem and dump table" && \
-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`.
-
-At the `top`, click on the `refresh` icon to show update the tests.
-
-Open a test file (`*.spec.ts`)
-
-Set a breakpoint.
-
-Press `alt` and click on the play button left beside the test.
-
-Execution should stop at the breakpoint.
-
-### Update goldens
-
-In various tests we are creating golden files, that are reference files that
-are compared against the files created in the tests.
-
-```bash
-pnpm updateGoldens
-```
-
-### Test and Build
-
-```bash
-pnpm test &&\
-pnpm build
-```
-
-### Commit
-
-Develop your feature
-
-Commit your changes
-
-If you only have one thing, execute
-
-```bash
-git commit -am"$MESSAGE"
-```
-
-### Update dependencies
-
-We aim to work with the latest versions of our dependencies.
-
-```bash
-pnpm update --latest &&\
-git commit -am"Update dependencies"
-```
-
-### Increase version
-
-```bash
-pnpm version patch --no-git-tag-version && \
-git commit -am"Increase version"
-```
-
-### Create a pull request
-
-```bash
-git push -u origin $BRANCH && \
-gh pr create --base main --title "$MESSAGE" --body "" && \
-gh pr merge --auto --squash && \
-
-```
-
-### Wait until PR is merged
-
-Get the PR URL with the following command
-
-```bash
-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;
-```
-
-### Delete feature branch
-
-```bash
-git fetch && git checkout main && \
-git reset --soft origin/main && \
-git stash -m"PR Aftermath" && \
-git pull && \
-git branch -d $BRANCH
-```
-
-### Publish to NPM
-
-```bash
-npm publish --access public && \
-git tag $(npm pkg get version | tr -d '\\"')
-```
-
-<!-- ........................................................................-->
-
-## Troubleshooting
-
-### Checkout README.trouble.md
-
-Checkout [./README.trouble.md](./README.trouble.md)
+Read [develop.md](doc/workflows/develop.md)
 
-### File issues on GitHub
+## Tools
 
-Visit <https://github.com/rljson/io/issues>
+Read [tools.md](doc/workflows/tools.md)
 
-Check if there is already an issue for your problem.
+## Superheros
 
-If no, report the issue.
+Read [super-hero.md](doc/workflows/super-hero.md)

package/dist/README.contributors.md

@@ -1,240 +1,32 @@
 <!--
-// @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.
+@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
 
-- [Install](#install)
-  - [Check out](#check-out)
-  - [Install pnpm](#install-pnpm)
-  - [Install dependencies](#install-dependencies)
-  - [Install Vscode extensions](#install-vscode-extensions)
-  - [Uninstall Jest and Jasmine](#uninstall-jest-and-jasmine)
-  - [Install GitHub CLI](#install-github-cli)
+- [Prepare](#prepare)
 - [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)
-  - [Commit](#commit)
-  - [Update dependencies](#update-dependencies)
-  - [Increase version](#increase-version)
-  - [Create a pull request](#create-a-pull-request)
-  - [Wait until PR is merged](#wait-until-pr-is-merged)
-  - [Delete feature branch](#delete-feature-branch)
-  - [Publish to NPM](#publish-to-npm)
-- [Troubleshooting](#troubleshooting)
-  - [Checkout README.trouble.md](#checkout-readmetroublemd)
-  - [File issues on GitHub](#file-issues-on-github)
-
-<!-- ........................................................................-->
-
-## Install
-
-### Check out
-
-```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/io.git
-cd io
-```
-
-### Install pnpm
-
-Windows:
-
-```bash
-corepack enable pnpm
-```
-
-Mac:
-
-```bash
-sudo corepack enable pnpm
-```
-
-### Install dependencies
-
-```bash
-pnpm install
-```
-
-### Install Vscode extensions
-
-Open this project in `vscode`.
-
-Press `Cmd+Shift+P`.
-
-Type `Extensions: Show Recommended Extensions` and press `Enter`.
+- [Tools](#tools)
+- [Superheros](#superheros)
 
-The recommended extensions will be shown.
+## Prepare
 
-Make sure, all recommended extensions are shown.
-
-### Uninstall Jest and Jasmine
-
-Jest or Jasmine extensions conflict with the `Vitest` extension used for this
-project.
-
-Uninstall them, if you have installed them.
-
-### Install GitHub CLI
-
-Install GitHub CLI on Mac
-
-```bash
-brew install gh
-```
-
-Login
-
-```bash
-gh auth login
-```
+Read [prepare.md](doc/workflows/prepare.md)
 
 <!-- ........................................................................-->
 
 ## Develop
 
-### Read architecture doc
-
-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="Add IoMem and dump table" && \
-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`.
-
-At the `top`, click on the `refresh` icon to show update the tests.
-
-Open a test file (`*.spec.ts`)
-
-Set a breakpoint.
-
-Press `alt` and click on the play button left beside the test.
-
-Execution should stop at the breakpoint.
-
-### Update goldens
-
-In various tests we are creating golden files, that are reference files that
-are compared against the files created in the tests.
-
-```bash
-pnpm updateGoldens
-```
-
-### Test and Build
-
-```bash
-pnpm test &&\
-pnpm build
-```
-
-### Commit
-
-Develop your feature
-
-Commit your changes
-
-If you only have one thing, execute
-
-```bash
-git commit -am"$MESSAGE"
-```
-
-### Update dependencies
-
-We aim to work with the latest versions of our dependencies.
-
-```bash
-pnpm update --latest &&\
-git commit -am"Update dependencies"
-```
-
-### Increase version
-
-```bash
-pnpm version patch --no-git-tag-version && \
-git commit -am"Increase version"
-```
-
-### Create a pull request
-
-```bash
-git push -u origin $BRANCH && \
-gh pr create --base main --title "$MESSAGE" --body "" && \
-gh pr merge --auto --squash && \
-
-```
-
-### Wait until PR is merged
-
-Get the PR URL with the following command
-
-```bash
-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;
-```
-
-### Delete feature branch
-
-```bash
-git fetch && git checkout main && \
-git reset --soft origin/main && \
-git stash -m"PR Aftermath" && \
-git pull && \
-git branch -d $BRANCH
-```
-
-### Publish to NPM
-
-```bash
-npm publish --access public && \
-git tag $(npm pkg get version | tr -d '\\"')
-```
-
-<!-- ........................................................................-->
-
-## Troubleshooting
-
-### Checkout README.trouble.md
-
-Checkout [./README.trouble.md](./README.trouble.md)
+Read [develop.md](doc/workflows/develop.md)
 
-### File issues on GitHub
+## Tools
 
-Visit <https://github.com/rljson/io/issues>
+Read [tools.md](doc/workflows/tools.md)
 
-Check if there is already an issue for your problem.
+## Superheros
 
-If no, report the issue.
+Read [super-hero.md](doc/workflows/super-hero.md)

package/dist/index.d.ts

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

package/dist/io.js

@@ -1,5 +1,168 @@
+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 {
+      const table = hip({
+        _data: [],
+        _type: type
+      });
+      (_a = this._mem)[name] ?? (_a[name] = table);
+    }
+  }
+  // ...........................................................................
+  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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/io",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "packageManager": "pnpm@10.6.2",
   "description": "Low level interface for reading and writing RLJSON data",
   "homepage": "https://github.com/rljson/io",
@@ -29,24 +29,24 @@
     "updateGoldens": "cross-env UPDATE_GOLDENS=true npm test"
   },
   "devDependencies": {
-    "@types/node": "^22.13.10",
-    "@typescript-eslint/eslint-plugin": "^8.26.1",
-    "@typescript-eslint/parser": "^8.26.1",
-    "@vitest/coverage-v8": "^3.0.8",
+    "@types/node": "^22.13.11",
+    "@typescript-eslint/eslint-plugin": "^8.27.0",
+    "@typescript-eslint/parser": "^8.27.0",
+    "@vitest/coverage-v8": "^3.0.9",
     "cross-env": "^7.0.3",
     "eslint": "^9.22.0",
-    "eslint-plugin-jsdoc": "^50.6.6",
+    "eslint-plugin-jsdoc": "^50.6.8",
     "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",
-    "vite-node": "^3.0.8",
+    "typescript-eslint": "^8.27.0",
+    "vite": "^6.2.2",
+    "vite-node": "^3.0.9",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.0.8",
+    "vitest": "^3.0.9",
     "vitest-dom": "^0.1.1"
   },
   "pnpm": {
@@ -56,9 +56,9 @@
     "overrides": {}
   },
   "dependencies": {
-    "@rljson/hash": "^0.0.10",
-    "@rljson/json": "^0.0.8",
-    "@rljson/rljson": "^0.0.7",
-    "@rljson/validate": "^0.0.5"
+    "@rljson/hash": "^0.0.12",
+    "@rljson/json": "^0.0.18",
+    "@rljson/rljson": "^0.0.19",
+    "@rljson/validate": "^0.0.8"
   }
 }