@rljson/rljson 0.0.6 → 0.0.8

package/README.contributors.md

@@ -1,21 +1,52 @@
-# Contributors
+<!--
+// @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)
+- [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
 
-## 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/rljson/issues>
-
-Check if there is already an issue for your problem
-
-If no, report the issue
+```bash
+mkdir rljson
+cd rljson
+git clone https://github.com/rljson/rljson.git
+cd io
+```
 
-## Install pnpm
+### Install pnpm
 
 Windows:
 
@@ -29,123 +60,181 @@ Mac:
 sudo corepack enable pnpm
 ```
 
-## Check out
+### Install dependencies
 
 ```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/rljson.git
-cd rljson
+pnpm install
 ```
 
-## Install dependencies
+### Install Vscode extensions
 
-```bash
-npm install
-```
+Open this project in `vscode`.
 
-## Run the tests
+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 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
-npm run test
+brew install gh
 ```
 
-## Build the package
+Login
 
 ```bash
-npm run build
+gh auth login
 ```
 
-## Publish the package
+<!-- ........................................................................-->
 
-Open `package.json`
+## Develop
 
-Increase `version`
+### Read architecture doc
 
-Make sure all dependencies are listed in `peerDependencies`
+Read [README.architecture.md](./README.architecture.md) to get an overview
+of the package's architecture.
 
-Make sure no file references are contained
+### Checkout main
 
-Open `vite.config.mts` right beside `package.json`
+```bash
+git checkout main && \
+git fetch && \
+git pull
+```
 
-Make sure all `peerDependencies` are listed in `rollupOptions/external`
+### Create a branch
 
-Compile typescript:
+Please replace `Commit Message` in the next command by your commit message.
+It will also used for branch name and pull request
 
 ```bash
-npm run build
+export MESSAGE="Add more examples" && \
+export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+git checkout -b $BRANCH
 ```
 
-Make publish dry-run
+### 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
-npm publish --access=public --dry-run
+pnpm updateGoldens
 ```
 
-Check the changes to uploaded
-
-Publish the package
+### Test and Build
 
 ```bash
-npm publish --access=public
+pnpm test &&\
+pnpm build
 ```
 
-## Architecture
+### Commit
 
-Reade [README.architecture.md](./README.architecture.md) to get an overview
-of the package's architecture.
+Develop your feature
 
-## Install Vscode extensions
+Commit your changes
 
-Open this project in `vscode`.
+If you only have one thing, execute
 
-Press `Cmd+Shift+P`.
+```bash
+git commit -am"$MESSAGE"
+```
 
-Type `Extensions: Show Recommended Extensions` and press `Enter`.
+### Update dependencies
 
-The recommended extensions will be shown.
+We aim to work with the latest versions of our dependencies.
 
-Make sure, all recommended extensions are shown.
+```bash
+pnpm update --latest &&\
+git commit -am"Update dependencies"
+```
 
-## Uninstall all test extensions, e.g. Jest or Jasmine
+### Increase version
 
-Jest or Jasmine extensions conflict with the `Vitest` extension used for this
-project.
+```bash
+pnpm version patch --no-git-tag-version && \
+git commit -am"Increase version"
+```
 
-Uninstall them, if you have installed them.
+### Create a pull request
 
-## Debug tests
+```bash
+git push -u origin $BRANCH && \
+gh pr create --base main --title "$MESSAGE" --body "" && \
+gh pr merge --auto --squash
 
-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.
+### Wait until PR is merged
 
-Open a test file (`*.spec.ts`)
+Get the PR URL with the following command
 
-Set a breakpoint.
+```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;
+```
 
-Press `alt` and click on the play button left beside the test.
+### Delete feature branch
 
-Execution should stop at the breakpoint.
+```bash
+git fetch && git checkout main && \
+git reset --soft origin/main && \
+git stash -m"PR Aftermath" && \
+git pull && \
+git branch -d $BRANCH
+```
 
-## Update goldens
+### Publish to NPM
 
-In various tests we are creating golden files, that are reference files that
-are compared against the files created in the tests.
+```bash
+npm publish --access public && \
+git tag $(npm pkg get version | tr -d '\\"')
+```
 
-If change is detected, the fest fail.
+<!-- ........................................................................-->
 
-An example is `test/goldens/README.md` which is compared against
-`dist/README.md`.
+## Troubleshooting
 
-If the changes are desired, update the golden files:
+### Checkout README.trouble.md
 
-Open `update-goldens.ts`
+Checkout [./README.trouble.md](./README.trouble.md)
 
-Set `export const updateGoldens` to `true`
+### File issues on GitHub
 
-Run tests again.
+Visit <https://github.com/rljson/rljson/issues>
 
-Set `export const updateGoldens` to `false`.
+Check if there is already an issue for your problem.
 
-Run tests again.
+If no, report the issue.

package/dist/README.contributors.md

@@ -1,21 +1,52 @@
-# Contributors
+<!--
+// @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)
+- [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
 
-## 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/rljson/issues>
-
-Check if there is already an issue for your problem
-
-If no, report the issue
+```bash
+mkdir rljson
+cd rljson
+git clone https://github.com/rljson/rljson.git
+cd io
+```
 
-## Install pnpm
+### Install pnpm
 
 Windows:
 
@@ -29,123 +60,181 @@ Mac:
 sudo corepack enable pnpm
 ```
 
-## Check out
+### Install dependencies
 
 ```bash
-mkdir rljson
-cd rljson
-git clone https://github.com/rljson/rljson.git
-cd rljson
+pnpm install
 ```
 
-## Install dependencies
+### Install Vscode extensions
 
-```bash
-npm install
-```
+Open this project in `vscode`.
 
-## Run the tests
+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 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
-npm run test
+brew install gh
 ```
 
-## Build the package
+Login
 
 ```bash
-npm run build
+gh auth login
 ```
 
-## Publish the package
+<!-- ........................................................................-->
 
-Open `package.json`
+## Develop
 
-Increase `version`
+### Read architecture doc
 
-Make sure all dependencies are listed in `peerDependencies`
+Read [README.architecture.md](./README.architecture.md) to get an overview
+of the package's architecture.
 
-Make sure no file references are contained
+### Checkout main
 
-Open `vite.config.mts` right beside `package.json`
+```bash
+git checkout main && \
+git fetch && \
+git pull
+```
 
-Make sure all `peerDependencies` are listed in `rollupOptions/external`
+### Create a branch
 
-Compile typescript:
+Please replace `Commit Message` in the next command by your commit message.
+It will also used for branch name and pull request
 
 ```bash
-npm run build
+export MESSAGE="Add more examples" && \
+export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+git checkout -b $BRANCH
 ```
 
-Make publish dry-run
+### 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
-npm publish --access=public --dry-run
+pnpm updateGoldens
 ```
 
-Check the changes to uploaded
-
-Publish the package
+### Test and Build
 
 ```bash
-npm publish --access=public
+pnpm test &&\
+pnpm build
 ```
 
-## Architecture
+### Commit
 
-Reade [README.architecture.md](./README.architecture.md) to get an overview
-of the package's architecture.
+Develop your feature
 
-## Install Vscode extensions
+Commit your changes
 
-Open this project in `vscode`.
+If you only have one thing, execute
 
-Press `Cmd+Shift+P`.
+```bash
+git commit -am"$MESSAGE"
+```
 
-Type `Extensions: Show Recommended Extensions` and press `Enter`.
+### Update dependencies
 
-The recommended extensions will be shown.
+We aim to work with the latest versions of our dependencies.
 
-Make sure, all recommended extensions are shown.
+```bash
+pnpm update --latest &&\
+git commit -am"Update dependencies"
+```
 
-## Uninstall all test extensions, e.g. Jest or Jasmine
+### Increase version
 
-Jest or Jasmine extensions conflict with the `Vitest` extension used for this
-project.
+```bash
+pnpm version patch --no-git-tag-version && \
+git commit -am"Increase version"
+```
 
-Uninstall them, if you have installed them.
+### Create a pull request
 
-## Debug tests
+```bash
+git push -u origin $BRANCH && \
+gh pr create --base main --title "$MESSAGE" --body "" && \
+gh pr merge --auto --squash
 
-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.
+### Wait until PR is merged
 
-Open a test file (`*.spec.ts`)
+Get the PR URL with the following command
 
-Set a breakpoint.
+```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;
+```
 
-Press `alt` and click on the play button left beside the test.
+### Delete feature branch
 
-Execution should stop at the breakpoint.
+```bash
+git fetch && git checkout main && \
+git reset --soft origin/main && \
+git stash -m"PR Aftermath" && \
+git pull && \
+git branch -d $BRANCH
+```
 
-## Update goldens
+### Publish to NPM
 
-In various tests we are creating golden files, that are reference files that
-are compared against the files created in the tests.
+```bash
+npm publish --access public && \
+git tag $(npm pkg get version | tr -d '\\"')
+```
 
-If change is detected, the fest fail.
+<!-- ........................................................................-->
 
-An example is `test/goldens/README.md` which is compared against
-`dist/README.md`.
+## Troubleshooting
 
-If the changes are desired, update the golden files:
+### Checkout README.trouble.md
 
-Open `update-goldens.ts`
+Checkout [./README.trouble.md](./README.trouble.md)
 
-Set `export const updateGoldens` to `true`
+### File issues on GitHub
 
-Run tests again.
+Visit <https://github.com/rljson/rljson/issues>
 
-Set `export const updateGoldens` to `false`.
+Check if there is already an issue for your problem.
 
-Run tests again.
+If no, report the issue.

package/dist/rljson.d.ts

@@ -22,9 +22,9 @@ export type TableName = ItemId;
  * - `ids` Tables containing item ids
  * - `properties` Tables containing item properties
  */
-export type TableType = 'buffet' | 'cake' | 'collection' | 'ids' | 'properties';
+export type ContentType = 'buffet' | 'cake' | 'collection' | 'ids' | 'properties';
 /** A table in the rljson format */
-export interface RljsonTable<Data extends Json, Type extends TableType> extends Json {
+export interface RljsonTable<Data extends Json, Type extends ContentType> extends Json {
     /** The data rows of the table */
     _data: Data[];
     /**  The type of the table */
@@ -160,9 +160,11 @@ export type BuffetsTable = RljsonTable<Buffet, 'buffet'>;
 /**
  * One of the supported Rljson table types
  */
-export type RljsonTableType = BuffetsTable | PropertiesTable | CollectionsTable | IdSetsTable | CakesTable;
+export type TableType = BuffetsTable | PropertiesTable | CollectionsTable | IdSetsTable | CakesTable;
 /** The rljson data format */
 export interface Rljson extends Json {
-    [tableId: TableName]: RljsonTableType | string;
+    [tableId: TableName]: TableType | string;
 }
 export declare const exampleRljson: () => Rljson;
+export declare const exampleRljsonEmpty: () => Rljson;
+export declare const exampleRljsonWithErrors: () => Rljson;

package/dist/rljson.js

@@ -1,5 +1,20 @@
+import { exampleJsonObject } from "@rljson/json";
 // @license
-const exampleRljson = () => ({});
+const exampleRljson = () => ({
+  table: {
+    _type: "properties",
+    _data: [exampleJsonObject()]
+  }
+});
+const exampleRljsonEmpty = () => ({});
+const exampleRljsonWithErrors = () => ({
+  brok$en: {
+    _type: "properties",
+    _data: []
+  }
+});
 export {
-  exampleRljson
+  exampleRljson,
+  exampleRljsonEmpty,
+  exampleRljsonWithErrors
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "packageManager": "pnpm@10.6.2",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
@@ -49,8 +49,8 @@
     "vitest-dom": "^0.1.1"
   },
   "dependencies": {
-    "@rljson/hash": "^0.0.9",
-    "@rljson/json": "^0.0.7"
+    "@rljson/hash": "^0.0.10",
+    "@rljson/json": "^0.0.9"
   },
   "pnpm": {
     "onlyBuiltDependencies": [