@rljson/rljson 0.0.10 → 0.0.12

package/README.contributors.md

@@ -1,15 +1,15 @@
 <!--
-// @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)
+  - [Checkout](#checkout)
   - [Install pnpm](#install-pnpm)
   - [Install dependencies](#install-dependencies)
   - [Install Vscode extensions](#install-vscode-extensions)
@@ -20,13 +20,16 @@
   - [Debug](#debug)
   - [Update goldens](#update-goldens)
   - [Test and Build](#test-and-build)
+  - [Rename classes](#rename-classes)
 - [Workflow](#workflow)
+  - [Set a PR title](#set-a-pr-title)
   - [Checkout main](#checkout-main)
-  - [Create a branch](#create-a-branch)
-  - [Commit](#commit)
+  - [Create a feature branch](#create-a-feature-branch)
   - [Update dependencies](#update-dependencies)
+  - [Debug and develop](#debug-and-develop)
+  - [Commit](#commit)
   - [Increase version](#increase-version)
-  - [Push the branch](#push-the-branch)
+  - [Build](#build)
   - [Create a pull request](#create-a-pull-request)
   - [Wait until PR is merged](#wait-until-pr-is-merged)
   - [Delete feature branch](#delete-feature-branch)
@@ -39,13 +42,13 @@
 
 ## Install
 
-### Check out
+### Checkout
 
 ```bash
 mkdir rljson
 cd rljson
 git clone https://github.com/rljson/rljson.git
-cd io
+cd rljson
 ```
 
 ### Install pnpm
@@ -136,102 +139,156 @@ pnpm updateGoldens
 ### Test and Build
 
 ```bash
-pnpm test &&\
+pnpm test
 pnpm build
 ```
 
+### Rename classes
+
+Replace `ClassA` by `ClassB` in the following script and run it:
+
+```bash
+export CLASS_A="ColumnSelection"
+export CLASS_B="ColumnsConfig"
+
+to_snake_case() {
+    echo "$1" | sed -E 's/([a-z0-9])([A-Z])/\1-\2/g' | tr '[:upper:]' '[:lower:]'
+}
+
+to_lower_first() {
+    first_char=$(echo "$1" | cut -c1 | tr '[:upper:]' '[:lower:]')
+    rest_chars=$(echo "$1" | cut -c2-)
+    echo "$first_char$rest_chars"
+}
+
+export LOWER_CLASS_A=$(to_lower_first "$CLASS_A")
+export LOWER_CLASS_B=$(to_lower_first "$CLASS_B")
+export SNAKE_CLASS_A=$(to_snake_case "$CLASS_A")
+export SNAKE_CLASS_B=$(to_snake_case "$CLASS_B")
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$CLASS_A/$CLASS_B/g" {} +
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$LOWER_CLASS_A/$LOWER_CLASS_B/g" {} +
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$SNAKE_CLASS_A/$SNAKE_CLASS_B/g" {} +
+
+find . -type f -not -path "*/node_modules/*" -not -path "*/.*" -name "*$SNAKE_CLASS_A*" \
+    -exec bash -c 'mv "$1" "${1//'"$SNAKE_CLASS_A"'/'"$SNAKE_CLASS_B"'}"' _ {} \;
+
+rm -rf test/goldens
+pnpm updateGoldens
+```
+
+Review the changes.
+
+Commit
+
+```bash
+git stage .
+git commit -am"Rename $CLASS_A to $CLASS_B"
+```
+
 <!-- ........................................................................-->
 
 ## Workflow
 
+### Set a PR title
+
+```bash
+export PR_TITLE="PR Title"
+```
+
 ### Checkout main
 
 ```bash
-git checkout main && \
-git fetch && \
+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
+### Create a feature branch
 
 ```bash
-export MESSAGE="Add multi row example" && \
-export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+export BRANCH=`echo "$PR_TITLE" | 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
+### Update dependencies
 
 ```bash
-git add . && git commit -m "$MESSAGE"
+pnpm update --latest
+git commit -am"Update dependencies"
 ```
 
-### Update dependencies
+### Debug and develop
+
+Debug and develop
+
+### Commit
 
-We aim to work with the latest versions of our dependencies
+If you only have one thing changed, execute
 
 ```bash
-pnpm update --latest &&\
-git commit -m"Update dependencies"
+git add . && git commit -m "$PR_TITLE"
 ```
 
 ### Increase version
 
 ```bash
-pnpm version patch --no-git-tag-version && \
+pnpm version patch --no-git-tag-version
 git commit -am"Increase version"
 ```
 
-### Push the branch
-
-Use your ID or this git command to push the branch
+### Build
 
 ```bash
-git push -u origin $BRANCH
+npm run build
 ```
 
 ### Create a pull request
 
 ```bash
-gh pr create --base main --title "$MESSAGE" --body "" && \
+git push -u origin $BRANCH
+gh pr create --base main --title "$PR_TITLE" --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;
+echo -e "\033[33mWait until PR is closed or merged ...\033[0m"
+
+while true; do
+  STATUS=$(gh pr view --json state | jq -r '.state')
+  if [ "$STATUS" = "CLOSED" ] || [ "$STATUS" = "MERGED" ]; then
+    echo -e "\033[32mPR has been merged or closed.\033[0m"
+    break
+  elif [ "$STATUS" = "FAILED" ]; then
+    echo -e "\033[31mError: PR has failed.\033[0m"
+    break
+  fi
+  sleep 2
+done
 ```
 
 ### Delete feature branch
 
 ```bash
-git fetch && git checkout main && \
-git reset --soft origin/main && \
-git stash -m"PR Aftermath" && \
-git pull && \
+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 && \
+npm publish --access public
 git tag $(npm pkg get version | tr -d '\\"')
 ```
 

package/dist/README.contributors.md

@@ -1,15 +1,15 @@
 <!--
-// @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)
+  - [Checkout](#checkout)
   - [Install pnpm](#install-pnpm)
   - [Install dependencies](#install-dependencies)
   - [Install Vscode extensions](#install-vscode-extensions)
@@ -20,13 +20,16 @@
   - [Debug](#debug)
   - [Update goldens](#update-goldens)
   - [Test and Build](#test-and-build)
+  - [Rename classes](#rename-classes)
 - [Workflow](#workflow)
+  - [Set a PR title](#set-a-pr-title)
   - [Checkout main](#checkout-main)
-  - [Create a branch](#create-a-branch)
-  - [Commit](#commit)
+  - [Create a feature branch](#create-a-feature-branch)
   - [Update dependencies](#update-dependencies)
+  - [Debug and develop](#debug-and-develop)
+  - [Commit](#commit)
   - [Increase version](#increase-version)
-  - [Push the branch](#push-the-branch)
+  - [Build](#build)
   - [Create a pull request](#create-a-pull-request)
   - [Wait until PR is merged](#wait-until-pr-is-merged)
   - [Delete feature branch](#delete-feature-branch)
@@ -39,13 +42,13 @@
 
 ## Install
 
-### Check out
+### Checkout
 
 ```bash
 mkdir rljson
 cd rljson
 git clone https://github.com/rljson/rljson.git
-cd io
+cd rljson
 ```
 
 ### Install pnpm
@@ -136,102 +139,156 @@ pnpm updateGoldens
 ### Test and Build
 
 ```bash
-pnpm test &&\
+pnpm test
 pnpm build
 ```
 
+### Rename classes
+
+Replace `ClassA` by `ClassB` in the following script and run it:
+
+```bash
+export CLASS_A="ColumnSelection"
+export CLASS_B="ColumnsConfig"
+
+to_snake_case() {
+    echo "$1" | sed -E 's/([a-z0-9])([A-Z])/\1-\2/g' | tr '[:upper:]' '[:lower:]'
+}
+
+to_lower_first() {
+    first_char=$(echo "$1" | cut -c1 | tr '[:upper:]' '[:lower:]')
+    rest_chars=$(echo "$1" | cut -c2-)
+    echo "$first_char$rest_chars"
+}
+
+export LOWER_CLASS_A=$(to_lower_first "$CLASS_A")
+export LOWER_CLASS_B=$(to_lower_first "$CLASS_B")
+export SNAKE_CLASS_A=$(to_snake_case "$CLASS_A")
+export SNAKE_CLASS_B=$(to_snake_case "$CLASS_B")
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$CLASS_A/$CLASS_B/g" {} +
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$LOWER_CLASS_A/$LOWER_CLASS_B/g" {} +
+
+find . -type f \( -name "*.ts" -o -name "*.md" -o -name "package.json" \) -not -path "./node_modules/*" \
+    -exec sed -i '' "s/$SNAKE_CLASS_A/$SNAKE_CLASS_B/g" {} +
+
+find . -type f -not -path "*/node_modules/*" -not -path "*/.*" -name "*$SNAKE_CLASS_A*" \
+    -exec bash -c 'mv "$1" "${1//'"$SNAKE_CLASS_A"'/'"$SNAKE_CLASS_B"'}"' _ {} \;
+
+rm -rf test/goldens
+pnpm updateGoldens
+```
+
+Review the changes.
+
+Commit
+
+```bash
+git stage .
+git commit -am"Rename $CLASS_A to $CLASS_B"
+```
+
 <!-- ........................................................................-->
 
 ## Workflow
 
+### Set a PR title
+
+```bash
+export PR_TITLE="PR Title"
+```
+
 ### Checkout main
 
 ```bash
-git checkout main && \
-git fetch && \
+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
+### Create a feature branch
 
 ```bash
-export MESSAGE="Add multi row example" && \
-export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
+export BRANCH=`echo "$PR_TITLE" | 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
+### Update dependencies
 
 ```bash
-git add . && git commit -m "$MESSAGE"
+pnpm update --latest
+git commit -am"Update dependencies"
 ```
 
-### Update dependencies
+### Debug and develop
+
+Debug and develop
+
+### Commit
 
-We aim to work with the latest versions of our dependencies
+If you only have one thing changed, execute
 
 ```bash
-pnpm update --latest &&\
-git commit -m"Update dependencies"
+git add . && git commit -m "$PR_TITLE"
 ```
 
 ### Increase version
 
 ```bash
-pnpm version patch --no-git-tag-version && \
+pnpm version patch --no-git-tag-version
 git commit -am"Increase version"
 ```
 
-### Push the branch
-
-Use your ID or this git command to push the branch
+### Build
 
 ```bash
-git push -u origin $BRANCH
+npm run build
 ```
 
 ### Create a pull request
 
 ```bash
-gh pr create --base main --title "$MESSAGE" --body "" && \
+git push -u origin $BRANCH
+gh pr create --base main --title "$PR_TITLE" --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;
+echo -e "\033[33mWait until PR is closed or merged ...\033[0m"
+
+while true; do
+  STATUS=$(gh pr view --json state | jq -r '.state')
+  if [ "$STATUS" = "CLOSED" ] || [ "$STATUS" = "MERGED" ]; then
+    echo -e "\033[32mPR has been merged or closed.\033[0m"
+    break
+  elif [ "$STATUS" = "FAILED" ]; then
+    echo -e "\033[31mError: PR has failed.\033[0m"
+    break
+  fi
+  sleep 2
+done
 ```
 
 ### Delete feature branch
 
 ```bash
-git fetch && git checkout main && \
-git reset --soft origin/main && \
-git stash -m"PR Aftermath" && \
-git pull && \
+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 && \
+npm publish --access public
 git tag $(npm pkg get version | tr -d '\\"')
 ```
 

package/dist/example.d.ts

@@ -1,4 +1,31 @@
+import { Rljson } from './rljson.ts';
 /**
- * The example function demonstrates how the package works
+ * Provides Rljson examples
  */
-export declare const example: () => void;
+export declare class Example {
+    /**
+     * Returns the Rljson bakery example
+     */
+    static bakery(): Rljson;
+    /**
+     * Returns an Rljson object with one row containing all JSON types
+     */
+    static withAllJsonTypes(): Rljson;
+    /**
+     * Returns an empty Rljson object
+     */
+    static empty(): Rljson;
+    /**
+     * Returns an Rljson with a table containing all combinations of true and
+     * false. This is useful for testing search operators.
+     */
+    static binary(): Rljson;
+    /**
+     * An more complex example containing an table with multiple rows
+     */
+    static multiRow(): Rljson;
+    /**
+     * Returns an Rljson object with a broken table name
+     */
+    static withBrokenTableName(): Rljson;
+}

package/dist/index.d.ts

@@ -1 +1,8 @@
+export * from './content/buffet.ts';
+export * from './content/cake.ts';
+export * from './content/collection.ts';
+export * from './content/id-set.ts';
+export * from './content/properties.ts';
+export * from './example.ts';
 export * from './rljson.ts';
+export * from './typedefs.ts';

package/dist/rljson.d.ts

@@ -1,28 +1,22 @@
-import { Json, JsonValue } from '@rljson/json';
+import { Json } from '@rljson/json';
+import { BuffetsTable } from './content/buffet.ts';
+import { CakesTable } from './content/cake.ts';
+import { CollectionsTable } from './content/collection.ts';
+import { IdSetsTable } from './content/id-set.ts';
+import { PropertiesTable } from './content/properties.ts';
+import { ContentType, TableName } from './typedefs.ts';
+export declare const reservedFieldNames: string[];
+export declare const reservedTableNames: string[];
 /**
- * A ref is a hash that references to another element
- */
-export type Ref = string;
-/**
- * An `id` is a *user defined* name or identifier of an item.
- * It exists in parallel with the auto generated `_hash`.
- */
-export type ItemId = string;
-/**
- * A table id reference to a table. The table ids are used as keys in the top
- * level structure of an Rljson data object.
- */
-export type TableName = ItemId;
-/**
- * Types of tables that can be stored in an Rljson object
- *
- * - `buffets` Tables containing buffets
- * - `cakes` Tables containing cakes
- * - `collections` Tables containing collections
- * - `ids` Tables containing item ids
- * - `properties` Tables containing item properties
+ * One of the supported Rljson table types
  */
-export type ContentType = 'buffet' | 'cake' | 'collection' | 'ids' | 'properties';
+export type TableType = BuffetsTable | PropertiesTable<any> | CollectionsTable | IdSetsTable | CakesTable;
+/** The rljson data format */
+export type Rljson = {
+    [tableId: TableName]: TableType;
+};
+/** An example rljson object */
+export declare const exampleRljson: () => Rljson;
 /** A table in the rljson format */
 export interface RljsonTable<Data extends Json, Type extends ContentType> extends Json {
     /** The data rows of the table */
@@ -30,142 +24,3 @@ export interface RljsonTable<Data extends Json, Type extends ContentType> extend
     /**  The type of the table */
     _type: Type;
 }
-/**
- * A reference to a properties row in a properties table
- */
-export type PropertiesRef = Ref;
-/**
- * A table containing item properties
- */
-export type PropertiesTable = RljsonTable<Json, 'properties'>;
-/**
- * An IdSetRef is a hash pointing to an Ids
- */
-export type IdSetRef = Ref;
-/**
- * An Ids manages list of item ids
- */
-export interface IdSet extends Json {
-    /**
-     * The hash of another item id list which is extended by this one.
-     * Must be empty or null, when the list is the root.
-     */
-    base: IdSetRef | null;
-    /**
-     * The item ids added to base
-     */
-    add: ItemId[];
-    /**
-     * The item ids removed from base
-     */
-    remove: ItemId[];
-}
-/**
- * A table containing item ids
- */
-export type IdSetsTable = RljsonTable<IdSet, 'ids'>;
-/**
- * A CollectionRef is a hash pointing to a collection
- */
-export type CollectionRef = Ref;
-/**
- * A collection assigns properties to item ids
- */
-export interface Collection extends Json {
-    /**
-     * `base` an optional base collection that is extended by this collection
-     */
-    base: CollectionRef | null;
-    /**
-     * The table containing the item set of this collection
-     */
-    idSetsTable: TableName;
-    /**
-     * A reference to the ids of the items the collection is based on
-     */
-    idSet: IdSetRef;
-    /**
-     * The table containing the properties assigned to the items of this collection
-     */
-    properties: TableName;
-    /**
-     * Assign properties to each item of the collection.
-     */
-    assign: Record<ItemId, PropertiesRef>;
-}
-/**
- * A table containing collections
- */
-export type CollectionsTable = RljsonTable<Collection, 'collection'>;
-/**
- * A `CakeLayerId` assigns an id or name to a cake layer
- */
-export type CakeLayerId = ItemId;
-/**
- * A `CakeLayerIds` is a set of cake layer ids / cake layer names
- */
-export type CakeLayerIds = IdSet;
-/**
- * A cake is a collection of layers.
- *
- * A layer is a collection of items.
- * All layers of a cake refer to the same items.
- */
-export interface Cake extends Json {
-    /**
-     * The table containing the item ids of the cake
-     */
-    itemIdsTable: TableName;
-    /**
-     * All layers of a cake share the same item ids.
-     */
-    itemIds: IdSetRef;
-    /**
-     * The table containing the layers of this cake
-     */
-    layersTable: TableName;
-    /**
-     * Assigns a collection to each layer of the cake.
-     */
-    layers: {
-        [layerId: CakeLayerId]: CollectionRef;
-    };
-}
-/**
- * A table containing cakes
- */
-export type CakesTable = RljsonTable<Cake, 'cake'>;
-/**
- * A buffet id is a name or id of a buffet
- */
-export type BuffetId = ItemId;
-/**
- * A buffet is a collection of arbitrary but related items, e.g. cakes,
- * collections, or items.
- */
-export interface Buffet extends Json {
-    /**
-     * The items of the buffet
-     */
-    items: Array<{
-        table: TableName;
-        ref: Ref;
-        [key: string]: JsonValue;
-    }>;
-}
-/**
- * A table containing buffets
- */
-export type BuffetsTable = RljsonTable<Buffet, 'buffet'>;
-/**
- * One of the supported Rljson table types
- */
-export type TableType = BuffetsTable | PropertiesTable | CollectionsTable | IdSetsTable | CakesTable;
-/** The rljson data format */
-export interface Rljson extends Json {
-    [tableId: TableName]: TableType | string;
-}
-export declare const exampleRljson: () => Rljson;
-export declare const exampleRljsonEmpty: () => Rljson;
-export declare const exampleRljsonWithErrors: () => Rljson;
-export declare const exampleRljsonWithMultipleRows: () => Rljson;

package/dist/rljson.js

@@ -1,49 +1,237 @@
 import { exampleJsonObject } from "@rljson/json";
 // @license
-const exampleRljson = () => ({
-  table: {
-    _type: "properties",
-    _data: [exampleJsonObject()]
-  }
-});
-const exampleRljsonEmpty = () => ({});
-const exampleRljsonWithErrors = () => ({
-  brok$en: {
-    _type: "properties",
-    _data: []
-  }
-});
-const exampleRljsonWithMultipleRows = () => ({
-  table: {
-    _type: "properties",
+const bakeryExample = {
+  buffets: {
+    _type: "buffets",
     _data: [
+      // Counter
       {
-        string: "str0",
-        boolean: true,
-        number: 1,
-        array: [1, "str0", true, { a: { b: "c" } }],
-        object: { a: { b: "c" } }
+        items: [
+          // Angle pie
+          {
+            table: "cakes",
+            ref: "ap"
+          },
+          // Cumb cake
+          {
+            table: "cakes",
+            ref: "cc"
+          }
+        ]
       },
+      // Fridge
       {
-        string: "str1",
-        boolean: true,
-        number: 1,
-        array: [1, "str1", true, { a: { b: "c" } }],
-        object: { a: { b: "c" } }
-      },
+        id: "fridge",
+        items: [
+          // Black forest cake
+          {
+            table: "cakes",
+            ref: "bfc"
+          },
+          // Lemon cheese cake
+          {
+            table: "cakes",
+            ref: "lcc"
+          }
+        ]
+      }
+    ]
+  },
+  cakes: {
+    _type: "cakes",
+    _data: []
+  },
+  layers: {
+    _type: "collections",
+    _data: []
+  },
+  sliceIds: {
+    _type: "idSets",
+    _data: [
       {
-        string: "str2",
-        boolean: false,
-        number: 1,
-        array: [1, "str1", true, { a: { b: "c" } }],
-        object: { d: { e: "f" } }
+        base: null,
+        add: [
+          "slice0",
+          "slice1",
+          "slice2",
+          "slice3",
+          "slice4",
+          "slice5",
+          "slice6",
+          "slice7",
+          "slice8",
+          "slice9",
+          "slice10",
+          "slice11"
+        ],
+        remove: []
       }
     ]
+  },
+  nutritiveValues: {
+    _type: "properties",
+    _data: []
+  }
+};
+// @license
+const exampleBuffetsTable = bakeryExample.buffets;
+// @license
+const exampleCakesTable = Object.freeze(bakeryExample.cakes);
+// @license
+const exampleCollectionsTable = Object.freeze(
+  bakeryExample.layers
+);
+// @license
+const exampleIdSetsTable = Object.freeze(bakeryExample.sliceIds);
+// @license
+const examplePropertiesTable = Object.freeze(bakeryExample.nutritiveValues);
+// @license
+class Example {
+  /**
+   * Returns the Rljson bakery example
+   */
+  static bakery() {
+    return {
+      // A bakery is a collection of buffets
+      bakery: {
+        name: "Bakery",
+        _type: "buffets",
+        _data: [
+          // Counter
+          {
+            id: "counter",
+            items: [
+              // Angle pie
+              {
+                table: "cakes",
+                ref: "ap"
+              },
+              // Cumb cake
+              {
+                table: "cakes",
+                ref: "cc"
+              }
+            ]
+          },
+          // Fridge
+          {
+            id: "fridge",
+            items: [
+              // Black forest
+              {
+                table: "cakes",
+                ref: "bf"
+              },
+              // Lemon cheese cake
+              {
+                table: "cakes",
+                ref: "cc"
+              }
+            ]
+          }
+        ]
+      }
+    };
+  }
+  /**
+   * Returns an Rljson object with one row containing all JSON types
+   */
+  static withAllJsonTypes() {
+    return {
+      table: {
+        _type: "properties",
+        _data: [exampleJsonObject()]
+      }
+    };
   }
+  /**
+   * Returns an empty Rljson object
+   */
+  static empty() {
+    return {};
+  }
+  /**
+   * Returns an Rljson with a table containing all combinations of true and
+   * false. This is useful for testing search operators.
+   */
+  static binary() {
+    return {
+      table: {
+        _type: "properties",
+        _data: [
+          { a: false, b: false },
+          { a: false, b: true },
+          { a: true, b: false },
+          { a: true, b: true }
+        ]
+      }
+    };
+  }
+  /**
+   * An more complex example containing an table with multiple rows
+   */
+  static multiRow() {
+    return {
+      table: {
+        _type: "properties",
+        _data: [
+          {
+            string: "str0",
+            boolean: true,
+            number: 1,
+            array: [1, "str0", true, { a: { b: "c" } }],
+            object: { a: { b: "c" } }
+          },
+          {
+            string: "str1",
+            boolean: true,
+            number: 1,
+            array: [1, "str1", true, { a: { b: "c" } }],
+            object: { a: { b: "c" } }
+          },
+          {
+            string: "str2",
+            boolean: false,
+            number: 1,
+            array: [1, "str1", true, { a: { b: "c" } }],
+            object: { d: { e: "f" } }
+          }
+        ]
+      }
+    };
+  }
+  /**
+   * Returns an Rljson object with a broken table name
+   */
+  static withBrokenTableName() {
+    return {
+      brok$en: {
+        _type: "properties",
+        _data: []
+      }
+    };
+  }
+}
+// @license
+const reservedFieldNames = ["_type", "_data"];
+const reservedTableNames = ["_hash", "_tables", "_columns"];
+const exampleRljson = () => Example.withAllJsonTypes();
+// @license
+const exampleTypedefs = Object.freeze({
+  ref: "ref",
+  itemId: "itemId",
+  tableName: "tableName",
+  contentType: "collections"
 });
 export {
+  Example,
+  exampleBuffetsTable,
+  exampleCakesTable,
+  exampleCollectionsTable,
+  exampleIdSetsTable,
+  examplePropertiesTable,
   exampleRljson,
-  exampleRljsonEmpty,
-  exampleRljsonWithErrors,
-  exampleRljsonWithMultipleRows
+  exampleTypedefs,
+  reservedFieldNames,
+  reservedTableNames
 };

package/dist/src/example.ts

@@ -4,15 +4,147 @@
 // Use of this source code is governed by terms that can be
 // found in the LICENSE file in the root of this package.
 
-import { exampleRljson } from './rljson.ts';
+import { exampleJsonObject } from '@rljson/json';
+
+import { BuffetsTable } from './content/buffet.ts';
+import { Rljson } from './rljson.ts';
 
 /**
- * The example function demonstrates how the package works
+ * Provides Rljson examples
  */
-export const example = () => {
-  const print = console.log;
-  const stringify = JSON.stringify;
+export class Example {
+  /**
+   * Returns the Rljson bakery example
+   */
+  static bakery(): Rljson {
+    return {
+      // A bakery is a collection of buffets
+      bakery: {
+        name: 'Bakery',
+        _type: 'buffets',
+        _data: [
+          // Counter
+          {
+            id: 'counter',
+            items: [
+              // Angle pie
+              {
+                table: 'cakes',
+                ref: 'ap',
+              },
+
+              // Cumb cake
+              {
+                table: 'cakes',
+                ref: 'cc',
+              },
+            ],
+          },
+
+          // Fridge
+          {
+            id: 'fridge',
+            items: [
+              // Black forest
+              {
+                table: 'cakes',
+                ref: 'bf',
+              },
+
+              // Lemon cheese cake
+              {
+                table: 'cakes',
+                ref: 'cc',
+              },
+            ],
+          },
+        ],
+      } as BuffetsTable,
+    };
+  }
+
+  /**
+   * Returns an Rljson object with one row containing all JSON types
+   */
+  static withAllJsonTypes(): Rljson {
+    return {
+      table: {
+        _type: 'properties',
+        _data: [exampleJsonObject()],
+      },
+    };
+  }
+
+  /**
+   * Returns an empty Rljson object
+   */
+  static empty(): Rljson {
+    return {};
+  }
+
+  /**
+   * Returns an Rljson with a table containing all combinations of true and
+   * false. This is useful for testing search operators.
+   */
+  static binary(): Rljson {
+    return {
+      table: {
+        _type: 'properties',
+        _data: [
+          { a: false, b: false },
+          { a: false, b: true },
+          { a: true, b: false },
+          { a: true, b: true },
+        ],
+      },
+    };
+  }
+
+  /**
+   * An more complex example containing an table with multiple rows
+   */
+  static multiRow(): Rljson {
+    return {
+      table: {
+        _type: 'properties',
+        _data: [
+          {
+            string: 'str0',
+            boolean: true,
+            number: 1,
+            array: [1, 'str0', true, { a: { b: 'c' } }],
+            object: { a: { b: 'c' } },
+          },
+
+          {
+            string: 'str1',
+            boolean: true,
+            number: 1,
+            array: [1, 'str1', true, { a: { b: 'c' } }],
+            object: { a: { b: 'c' } },
+          },
+
+          {
+            string: 'str2',
+            boolean: false,
+            number: 1,
+            array: [1, 'str1', true, { a: { b: 'c' } }],
+            object: { d: { e: 'f' } },
+          },
+        ],
+      },
+    };
+  }
 
-  const rljson = exampleRljson();
-  print(stringify(rljson, null, 2));
-};
+  /**
+   * Returns an Rljson object with a broken table name
+   */
+  static withBrokenTableName(): Rljson {
+    return {
+      brok$en: {
+        _type: 'properties',
+        _data: [],
+      },
+    };
+  }
+}

package/dist/typedefs.d.ts

@@ -0,0 +1,30 @@
+/**
+ * A ref is a hash that references to another element
+ */
+export type Ref = string;
+/**
+ * An `id` is a *user defined* name or identifier of an item.
+ * It exists in parallel with the auto generated `_hash`.
+ */
+export type ItemId = string;
+/**
+ * A table id reference to a table. The table ids are used as keys in the top
+ * level structure of an Rljson data object.
+ */
+export type TableName = ItemId;
+/**
+ * Types of tables that can be stored in an Rljson object
+ *
+ * - `buffets` Tables containing buffets
+ * - `cakes` Tables containing cakes
+ * - `collections` Tables containing collections
+ * - `ids` Tables containing item ids
+ * - `properties` Tables containing item properties
+ */
+export type ContentType = 'buffets' | 'cakes' | 'collections' | 'idSets' | 'properties';
+export declare const exampleTypedefs: {
+    ref: Ref;
+    itemId: ItemId;
+    tableName: TableName;
+    contentType: ContentType;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "packageManager": "pnpm@10.6.2",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
@@ -42,7 +42,7 @@
     "read-pkg": "^9.0.1",
     "typescript": "~5.8.2",
     "typescript-eslint": "^8.26.1",
-    "vite": "^6.2.1",
+    "vite": "^6.2.2",
     "vite-node": "^3.0.8",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
@@ -50,8 +50,8 @@
     "vitest-dom": "^0.1.1"
   },
   "dependencies": {
-    "@rljson/hash": "^0.0.10",
-    "@rljson/json": "^0.0.9"
+    "@rljson/hash": "^0.0.11",
+    "@rljson/json": "^0.0.13"
   },
   "pnpm": {
     "onlyBuiltDependencies": [