@rljson/io 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rljson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.architecture.md

@@ -0,0 +1 @@
+# Architecture

package/README.blog.md

@@ -0,0 +1,3 @@
+# Blog
+
+Add latest posts at the end.

package/README.contributors.md

@@ -0,0 +1,143 @@
+# Contributors
+
+## Important
+
+⚠️ IMPORTANT: On `Windows, please checkout the repo on drive C`.
+There is a bug in the Vscode vitest extension v 1.14.4, making debugging tests
+not work. <https://github.com/vitest-dev/vscode/issues/548>
+Please check from time to time, if the issue is fixed and remove this hint.
+
+## Report issues
+
+Visit <https://github.com/rljson/io/issues>
+
+Check if there is already an issue for your problem
+
+If no, report the issue
+
+## 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
+```
+
+## Run the tests
+
+```bash
+pnpm run test
+```
+
+## Build the package
+
+```bash
+pnpm run build
+```
+
+## Publish the package
+
+Open `package.json`.
+
+Increase `version`.
+
+Compile typescript:
+
+```bash
+pnpm run build
+```
+
+Make publish dry-run
+
+```bash
+pnpm publish --access=public --dry-run
+```
+
+Check the changes to uploaded
+
+Publish the package
+
+```bash
+pnpm publish --access=public
+```
+
+## Architecture
+
+Reade [README.architecture.md](./README.architecture.md) to get an overview
+of the package's architecture.
+
+## Install Vscode extensions
+
+Open this project in `vscode`.
+
+Press `Cmd+Shift+P`.
+
+Type `Extensions: Show Recommended Extensions` and press `Enter`.
+
+The recommended extensions will be shown.
+
+Make sure, all recommended extensions are shown.
+
+## Uninstall all test extensions, e.g. Jest or Jasmine
+
+Jest or Jasmine extensions conflict with the `Vitest` extension used for this
+project.
+
+Uninstall them, if you have installed them.
+
+## Debug tests
+
+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.
+
+If change is detected, the fest fail.
+
+An example is `test/goldens/README.md` which is compared against
+`dist/README.md`.
+
+If the changes are desired, update the golden files:
+
+Open `update-goldens.ts`
+
+Set `export const updateGoldens` to `true`
+
+Run tests again.
+
+Set `export const updateGoldens` to `false`.
+
+Run tests again.

package/README.md

@@ -0,0 +1,18 @@
+# @rljson/io
+
+Low level interface for reading and writing RLJSON data
+
+## Users
+
+| File                                 | Purpose                     |
+| ------------------------------------ | --------------------------- |
+| [README.public.md](README.public.md) | Install and use the package |
+
+## Contributors
+
+| File                                             | Purpose                       |
+| ------------------------------------------------ | ----------------------------- |
+| [README.contributors.md](README.contributors.md) | Run, debug, build and publish |
+| [README.architecture.md](README.architecture.md) | Software architecture guide   |
+| [README.trouble.md](README.trouble.md)           | Errors & solutions            |
+| [README.blog.md](README.blog.md)                 | Blog                          |

package/README.public.md

@@ -0,0 +1,7 @@
+# @rljson/
+
+Todo: Add description here
+
+## Example
+
+[src/example.ts](src/example.ts)

package/README.trouble.md

@@ -0,0 +1,36 @@
+<!--
+
+-->
+
+# Trouble shooting
+
+## Table of contents <!-- omit in toc -->
+
+- [Vscode Windows: Debugging is not working](#vscode-windows-debugging-is-not-working)
+- [GitHub actions: Cannot find module @rollup/rollup-linux-x64-gnu](#github-actions-cannot-find-module-rolluprollup-linux-x64-gnu)
+
+## Vscode Windows: Debugging is not working
+
+Date: 2025-03-08
+
+⚠️ IMPORTANT: On Windows, please check out the repo on drive C. There is a bug
+in the VS Code Vitest extension (v1.14.4), which prevents test debugging from
+working: <https://github.com/vitest-dev/vscode/issues/548> Please check from
+time to time if the issue has been fixed and remove this note once it is
+resolved.
+
+## GitHub actions: Cannot find module @rollup/rollup-linux-x64-gnu
+
+⚠️ Error: Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to
+optional dependencies (<https://github.com/npm/cli/issues/4828>). Please try `npm
+i` again after removing both package-lock.json and node_modules directory.
+
+Solution:
+
+```bash
+rm -rf node_modules
+rm package-lock.json
+npm install
+```
+
+Then push `package-lock.yaml` again

package/dist/README.architecture.md

@@ -0,0 +1 @@
+# Architecture

package/dist/README.blog.md

@@ -0,0 +1,3 @@
+# Blog
+
+Add latest posts at the end.

package/dist/README.contributors.md

@@ -0,0 +1,143 @@
+# Contributors
+
+## Important
+
+⚠️ IMPORTANT: On `Windows, please checkout the repo on drive C`.
+There is a bug in the Vscode vitest extension v 1.14.4, making debugging tests
+not work. <https://github.com/vitest-dev/vscode/issues/548>
+Please check from time to time, if the issue is fixed and remove this hint.
+
+## Report issues
+
+Visit <https://github.com/rljson/io/issues>
+
+Check if there is already an issue for your problem
+
+If no, report the issue
+
+## 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
+```
+
+## Run the tests
+
+```bash
+pnpm run test
+```
+
+## Build the package
+
+```bash
+pnpm run build
+```
+
+## Publish the package
+
+Open `package.json`.
+
+Increase `version`.
+
+Compile typescript:
+
+```bash
+pnpm run build
+```
+
+Make publish dry-run
+
+```bash
+pnpm publish --access=public --dry-run
+```
+
+Check the changes to uploaded
+
+Publish the package
+
+```bash
+pnpm publish --access=public
+```
+
+## Architecture
+
+Reade [README.architecture.md](./README.architecture.md) to get an overview
+of the package's architecture.
+
+## Install Vscode extensions
+
+Open this project in `vscode`.
+
+Press `Cmd+Shift+P`.
+
+Type `Extensions: Show Recommended Extensions` and press `Enter`.
+
+The recommended extensions will be shown.
+
+Make sure, all recommended extensions are shown.
+
+## Uninstall all test extensions, e.g. Jest or Jasmine
+
+Jest or Jasmine extensions conflict with the `Vitest` extension used for this
+project.
+
+Uninstall them, if you have installed them.
+
+## Debug tests
+
+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.
+
+If change is detected, the fest fail.
+
+An example is `test/goldens/README.md` which is compared against
+`dist/README.md`.
+
+If the changes are desired, update the golden files:
+
+Open `update-goldens.ts`
+
+Set `export const updateGoldens` to `true`
+
+Run tests again.
+
+Set `export const updateGoldens` to `false`.
+
+Run tests again.

package/dist/README.md

@@ -0,0 +1,18 @@
+# @rljson/io
+
+Low level interface for reading and writing RLJSON data
+
+## Users
+
+| File                                 | Purpose                     |
+| ------------------------------------ | --------------------------- |
+| [README.public.md](README.public.md) | Install and use the package |
+
+## Contributors
+
+| File                                             | Purpose                       |
+| ------------------------------------------------ | ----------------------------- |
+| [README.contributors.md](README.contributors.md) | Run, debug, build and publish |
+| [README.architecture.md](README.architecture.md) | Software architecture guide   |
+| [README.trouble.md](README.trouble.md)           | Errors & solutions            |
+| [README.blog.md](README.blog.md)                 | Blog                          |

package/dist/README.public.md

@@ -0,0 +1,7 @@
+# @rljson/
+
+Todo: Add description here
+
+## Example
+
+[src/example.ts](src/example.ts)

package/dist/README.trouble.md

@@ -0,0 +1,36 @@
+<!--
+
+-->
+
+# Trouble shooting
+
+## Table of contents <!-- omit in toc -->
+
+- [Vscode Windows: Debugging is not working](#vscode-windows-debugging-is-not-working)
+- [GitHub actions: Cannot find module @rollup/rollup-linux-x64-gnu](#github-actions-cannot-find-module-rolluprollup-linux-x64-gnu)
+
+## Vscode Windows: Debugging is not working
+
+Date: 2025-03-08
+
+⚠️ IMPORTANT: On Windows, please check out the repo on drive C. There is a bug
+in the VS Code Vitest extension (v1.14.4), which prevents test debugging from
+working: <https://github.com/vitest-dev/vscode/issues/548> Please check from
+time to time if the issue has been fixed and remove this note once it is
+resolved.
+
+## GitHub actions: Cannot find module @rollup/rollup-linux-x64-gnu
+
+⚠️ Error: Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to
+optional dependencies (<https://github.com/npm/cli/issues/4828>). Please try `npm
+i` again after removing both package-lock.json and node_modules directory.
+
+Solution:
+
+```bash
+rm -rf node_modules
+rm package-lock.json
+npm install
+```
+
+Then push `package-lock.yaml` again

package/dist/example.d.ts

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

package/dist/index.d.ts

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

package/dist/io.d.ts

@@ -0,0 +1,11 @@
+import { Rljson } from '@rljson/rljson';
+export interface Io {
+    write(request: {
+        data: Rljson;
+    }): Promise<void>;
+    readRow(request: {
+        table: string;
+        where: Record<string, any>;
+    }): Promise<Rljson>;
+}
+export declare const exampleIo = "Checkout @rljson/io-mem for an example implementation";

package/dist/io.js

@@ -0,0 +1,5 @@
+// @license
+const exampleIo = "Checkout @rljson/io-mem for an example implementation";
+export {
+  exampleIo
+};

package/dist/src/example.ts

@@ -0,0 +1,12 @@
+// @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.
+
+/**
+ * The example function demonstrates how the package works
+ */
+export const example = () => {
+  console.log('exampleIo');
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@rljson/io",
+  "version": "0.0.1",
+  "packageManager": "pnpm@10.6.2",
+  "description": "Low level interface for reading and writing RLJSON data",
+  "homepage": "https://github.com/rljson/io",
+  "bugs": "https://github.com/rljson/io/issues",
+  "private": false,
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rljson/io.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "scripts": {
+    "build": "npx vite build && tsc && cp README* dist && mkdir dist/src && cp src/example.ts dist/src",
+    "test": "npx vitest run --coverage && npm run lint",
+    "prebuild": "npm run test",
+    "prepublishOnly": "npm run build && npm run test",
+    "lint": "npx eslint",
+    "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",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.22.0",
+    "eslint-plugin-jsdoc": "^50.6.6",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "globals": "^16.0.0",
+    "jsdoc": "^4.0.4",
+    "typescript": "~5.8.2",
+    "typescript-eslint": "^8.26.1",
+    "vite": "^6.2.1",
+    "vite-node": "^3.0.8",
+    "vite-plugin-dts": "^4.5.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.8",
+    "vitest-dom": "^0.1.1"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ]
+  },
+  "dependencies": {
+    "@rljson/hash": "^0.0.9",
+    "@rljson/json": "^0.0.7",
+    "@rljson/rljson": "^0.0.6",
+    "@rljson/validate": "^0.0.4"
+  }
+}