@rljson/rljson 0.0.50 → 0.0.52

package/README.architecture.md

@@ -29,7 +29,7 @@ This document describes the architecture of the Rljson format.
   - [Hashes](#hashes)
   - [Linking Tables Using References](#linking-tables-using-references)
 - [Data Types](#data-types)
-  - [Ingredients](#ingredients)
+  - [Components](#components)
   - [SliceIds](#sliceids)
   - [Layer](#layer)
   - [Cake](#cake)
@@ -145,7 +145,7 @@ This results in:
 ```json
 {
   "_hash": "D1CtRUBswzGVc1o9yHQKEh",
-  "a": {
+  "tableA": {
     "_data": [
       {
         "_hash": "LeFJOCQVgToOfbUuKJQ-GO",
@@ -165,7 +165,7 @@ table `b` references table `a` using `aRef`:
 ```json
 {
   "b": {
-    "_data": [{ "aRef": "LeFJOCQVgToOfbUuKJQ-GO" }]
+    "_data": [{ "tableARef": "LeFJOCQVgToOfbUuKJQ-GO" }]
   }
 }
 ```
@@ -177,33 +177,58 @@ This reference structure enables automated denormalization of JSON data.
 Rljson provides several core data structures and table types to manage and
 synchronize large datasets.
 
-### Ingredients
+### Components
 
-`Ingredients` are the fundamental data concept. An `IngredientsTable` contains
-key-value pairs assigning values to ingredient names.
+`Components` are the fundamental data concept. An `ComponentsTable` contains
+key-value pairs assigning values to component names.
 
 ```json
 {
   "ingredients": {
+    "_type": "components",
     "_data": [
       {
-        "name": "flour",
+        "id": "flour",
         "amountUnit": "g",
-        "nutritionalValuesRef": "gZXFSlrl5QAs5hOVsq5sWB"
+        "nutritionalValuesRef": "R165gWZn_Pcj_je3AwSsXI",
+        "_hash": "A5d-4if1fQpQERfwFsjKqb"
       }
-    ]
+    ],
+    "_hash": "t5oZrLJOxAj-5nlE1ZV488"
   },
-
   "nutritionalValues": {
+    "_type": "components",
     "_data": [
       {
+        "id": "flour",
         "energy": 364,
         "fat": 0.98,
         "protein": 10.33,
         "carbohydrates": 76.31,
-        "_hash": "gZXFSlrl5QAs5hOVsq5sWB"
+        "_hash": "R165gWZn_Pcj_je3AwSsXI"
+      },
+      {
+        "id": "flour",
+        "energy": 364.1,
+        "fat": 0.981,
+        "protein": 10.331,
+        "carbohydrates": 76.311,
+        "_hash": "IqeoWJjZQNlr-NVk2QT15B"
       }
-    ]
+    ],
+    "_hash": "4tYazUV23SSH0tW9sQznO1"
+  },
+  "recipeIngredients": {
+    "_type": "components",
+    "_data": [
+      {
+        "id": "flour",
+        "ingredientsRef": "A5d-4if1fQpQERfwFsjKqb",
+        "quantity": 500,
+        "_hash": "4coxp7hPCsH7hSnAVeUVZj"
+      }
+    ],
+    "_hash": "nJ4SAM641VlxYxekNiXkKI"
   }
 }
 ```
@@ -211,19 +236,21 @@ key-value pairs assigning values to ingredient names.
 ### SliceIds
 
 For efficient management of large layers, slice IDs are separated from their
-ingredients. This allows fetching IDs first and retrieving details later. The
+components. This allows fetching IDs first and retrieving details later. The
 following `SliceIds` define a set of three slice IDs:
 
 ```json
 {
   "slices": {
+    "_type": "sliceIds",
     "_data": [
       {
         "add": ["slice0", "slice1"],
         "remove": [],
         "_hash": "wyYfK5E4ArrMKQ_zvi2-EE"
       }
-    ]
+    ],
+    "_hash": "cnGg1WO4AHE2QX2CO2_aQL"
   }
 }
 ```
@@ -233,6 +260,7 @@ Derived `SliceIds` can be created by modifying an existing set:
 ```json
 {
   "slices": {
+    "_type": "sliceIds",
     "_data": [
       {
         "add": ["slice0", "slice1"],
@@ -240,32 +268,49 @@ Derived `SliceIds` can be created by modifying an existing set:
         "_hash": "wyYfK5E4ArrMKQ_zvi2-EE"
       },
       {
-        "base": "wyYfK5E4ArrMKQ_zvi2-EE",
+        "base": "wyYfK5E4ArrMKQ_zvi2-EE", // Hash of first id set
         "add": ["slice2"],
-        "remove": []
+        "remove": ["slice0"]
       }
     ]
+  },
+
+  "ingredientTypes": {
+    "_type": "sliceIds",
+    "_data": [
+      {
+        "add": ["flour"],
+        "remove": [],
+        "_hash": "UNxHIyPK7AACyUsbISW7bp"
+      }
+    ],
+    "_hash": "c1w4IVG4J4JANpcTu8p7Jd"
   }
 }
 ```
 
 ### Layer
 
-Cake layers assign ingredients to slices.
+Layers assign components to slices.
 
 ```json
 {
-  "layers": {
+  "recipes": {
+    "_type": "layers",
     "_data": [
       {
-        "ingredientsTable": "recipes",
-        "assign": {
-          "slice0": "H8KK9vMjOxxQr_G_9XeDM-",
-          "slice1": "H8KK9vMjOxxQr_G_9XeDM-"
+        "id": "tastyCake",
+        "componentsTable": "recipeIngredients",
+        "sliceIdsTable": "ingredientTypes",
+        "sliceIdsTableRow": "UNxHIyPK7AACyUsbISW7bp",
+        "add": {
+          "flour": "4coxp7hPCsH7hSnAVeUVZj",
+          "_hash": "5LxOnZOPBtIqV3PlOC_ulB"
         },
-        "_hash": "rrFBguLFLhXjrDqAxJx1p-"
+        "_hash": "NOVdgwVKlShXT1FTLaLrqK"
       }
-    ]
+    ],
+    "_hash": "FFblMN2aS4hPtJKPTMspXl"
   }
 }
 ```
@@ -274,24 +319,25 @@ Cake layers assign ingredients to slices.
 
 A `Cake` consists of layers of slices.
 All layers share the same slice structure, i.e. the same slice ids.
-Each layer assigns different ingredients to slices.
+Each layer assigns different components to slices.
 
 ```json
 {
   "cakes": {
+    "_type": "cakes",
     "_data": [
       {
+        "id": "cake1",
         "sliceIdsTable": "slices",
-        "idSet": "wyYfK5E4ArrMKQ_zvi2-EE",
-        "layersTable": "layers",
+        "sliceIdsRow": "wyYfK5E4ArrMKQ_zvi2-EE",
         "layers": {
-          "flour": "rrFBguLFLhXjrDqAxJx1p-",
-          "_hash": "JSoUx1N6lso-18vkzG63Pm"
+          "recipeLayers": "PZhgu3fmAtLceImvnW7fTj",
+          "_hash": "fudiDz_SXuMQbcqmAd-JOp"
         },
-        "_hash": "bOlQ1lPpZEYB00F14nGvOP"
+        "_hash": "Mge0ULLEbsemMq1ndUNZ6b"
       }
     ],
-    "_hash": "hsL7dD0mFDqmT2i-1fx_1a"
+    "_hash": "NeM6k972PwtYT8uXM9w27T"
   }
 }
 ```
@@ -299,24 +345,26 @@ Each layer assigns different ingredients to slices.
 ### Buffet
 
 A `Buffet` is a heterogeneous collection of different but related items,
-such as cakes, layers, or ingredients:
+such as cakes, layers, or components:
 
 ```json
 {
   "buffets": {
+    "_type": "buffets",
     "_data": [
       {
+        "id": "salesCounter",
         "items": [
           {
             "table": "cakes",
-            "ref": "bOlQ1lPpZEYB00F14nGvOP",
-            "_hash": "ma47UGAZbu5Ql5yXWFHLAT"
+            "ref": "Mge0ULLEbsemMq1ndUNZ6b",
+            "_hash": "VC_7itbevmNKG3Rc4XWyJz"
           }
         ],
-        "_hash": "jPv5bXjs3XVOLRbQvoWcjw"
+        "_hash": "G7ZX04bp0TdBG9fHDR7Sgu"
       }
     ],
-    "_hash": "FYK9ItHMDCe2CnD_TGRs8_"
+    "_hash": "0RyzLpZX1Nkfxej2WgXbEF"
   }
 }
 ```

package/dist/README.architecture.md

@@ -29,7 +29,7 @@ This document describes the architecture of the Rljson format.
   - [Hashes](#hashes)
   - [Linking Tables Using References](#linking-tables-using-references)
 - [Data Types](#data-types)
-  - [Ingredients](#ingredients)
+  - [Components](#components)
   - [SliceIds](#sliceids)
   - [Layer](#layer)
   - [Cake](#cake)
@@ -145,7 +145,7 @@ This results in:
 ```json
 {
   "_hash": "D1CtRUBswzGVc1o9yHQKEh",
-  "a": {
+  "tableA": {
     "_data": [
       {
         "_hash": "LeFJOCQVgToOfbUuKJQ-GO",
@@ -165,7 +165,7 @@ table `b` references table `a` using `aRef`:
 ```json
 {
   "b": {
-    "_data": [{ "aRef": "LeFJOCQVgToOfbUuKJQ-GO" }]
+    "_data": [{ "tableARef": "LeFJOCQVgToOfbUuKJQ-GO" }]
   }
 }
 ```
@@ -177,33 +177,58 @@ This reference structure enables automated denormalization of JSON data.
 Rljson provides several core data structures and table types to manage and
 synchronize large datasets.
 
-### Ingredients
+### Components
 
-`Ingredients` are the fundamental data concept. An `IngredientsTable` contains
-key-value pairs assigning values to ingredient names.
+`Components` are the fundamental data concept. An `ComponentsTable` contains
+key-value pairs assigning values to component names.
 
 ```json
 {
   "ingredients": {
+    "_type": "components",
     "_data": [
       {
-        "name": "flour",
+        "id": "flour",
         "amountUnit": "g",
-        "nutritionalValuesRef": "gZXFSlrl5QAs5hOVsq5sWB"
+        "nutritionalValuesRef": "R165gWZn_Pcj_je3AwSsXI",
+        "_hash": "A5d-4if1fQpQERfwFsjKqb"
       }
-    ]
+    ],
+    "_hash": "t5oZrLJOxAj-5nlE1ZV488"
   },
-
   "nutritionalValues": {
+    "_type": "components",
     "_data": [
       {
+        "id": "flour",
         "energy": 364,
         "fat": 0.98,
         "protein": 10.33,
         "carbohydrates": 76.31,
-        "_hash": "gZXFSlrl5QAs5hOVsq5sWB"
+        "_hash": "R165gWZn_Pcj_je3AwSsXI"
+      },
+      {
+        "id": "flour",
+        "energy": 364.1,
+        "fat": 0.981,
+        "protein": 10.331,
+        "carbohydrates": 76.311,
+        "_hash": "IqeoWJjZQNlr-NVk2QT15B"
       }
-    ]
+    ],
+    "_hash": "4tYazUV23SSH0tW9sQznO1"
+  },
+  "recipeIngredients": {
+    "_type": "components",
+    "_data": [
+      {
+        "id": "flour",
+        "ingredientsRef": "A5d-4if1fQpQERfwFsjKqb",
+        "quantity": 500,
+        "_hash": "4coxp7hPCsH7hSnAVeUVZj"
+      }
+    ],
+    "_hash": "nJ4SAM641VlxYxekNiXkKI"
   }
 }
 ```
@@ -211,19 +236,21 @@ key-value pairs assigning values to ingredient names.
 ### SliceIds
 
 For efficient management of large layers, slice IDs are separated from their
-ingredients. This allows fetching IDs first and retrieving details later. The
+components. This allows fetching IDs first and retrieving details later. The
 following `SliceIds` define a set of three slice IDs:
 
 ```json
 {
   "slices": {
+    "_type": "sliceIds",
     "_data": [
       {
         "add": ["slice0", "slice1"],
         "remove": [],
         "_hash": "wyYfK5E4ArrMKQ_zvi2-EE"
       }
-    ]
+    ],
+    "_hash": "cnGg1WO4AHE2QX2CO2_aQL"
   }
 }
 ```
@@ -233,6 +260,7 @@ Derived `SliceIds` can be created by modifying an existing set:
 ```json
 {
   "slices": {
+    "_type": "sliceIds",
     "_data": [
       {
         "add": ["slice0", "slice1"],
@@ -240,32 +268,49 @@ Derived `SliceIds` can be created by modifying an existing set:
         "_hash": "wyYfK5E4ArrMKQ_zvi2-EE"
       },
       {
-        "base": "wyYfK5E4ArrMKQ_zvi2-EE",
+        "base": "wyYfK5E4ArrMKQ_zvi2-EE", // Hash of first id set
         "add": ["slice2"],
-        "remove": []
+        "remove": ["slice0"]
       }
     ]
+  },
+
+  "ingredientTypes": {
+    "_type": "sliceIds",
+    "_data": [
+      {
+        "add": ["flour"],
+        "remove": [],
+        "_hash": "UNxHIyPK7AACyUsbISW7bp"
+      }
+    ],
+    "_hash": "c1w4IVG4J4JANpcTu8p7Jd"
   }
 }
 ```
 
 ### Layer
 
-Cake layers assign ingredients to slices.
+Layers assign components to slices.
 
 ```json
 {
-  "layers": {
+  "recipes": {
+    "_type": "layers",
     "_data": [
       {
-        "ingredientsTable": "recipes",
-        "assign": {
-          "slice0": "H8KK9vMjOxxQr_G_9XeDM-",
-          "slice1": "H8KK9vMjOxxQr_G_9XeDM-"
+        "id": "tastyCake",
+        "componentsTable": "recipeIngredients",
+        "sliceIdsTable": "ingredientTypes",
+        "sliceIdsTableRow": "UNxHIyPK7AACyUsbISW7bp",
+        "add": {
+          "flour": "4coxp7hPCsH7hSnAVeUVZj",
+          "_hash": "5LxOnZOPBtIqV3PlOC_ulB"
         },
-        "_hash": "rrFBguLFLhXjrDqAxJx1p-"
+        "_hash": "NOVdgwVKlShXT1FTLaLrqK"
       }
-    ]
+    ],
+    "_hash": "FFblMN2aS4hPtJKPTMspXl"
   }
 }
 ```
@@ -274,24 +319,25 @@ Cake layers assign ingredients to slices.
 
 A `Cake` consists of layers of slices.
 All layers share the same slice structure, i.e. the same slice ids.
-Each layer assigns different ingredients to slices.
+Each layer assigns different components to slices.
 
 ```json
 {
   "cakes": {
+    "_type": "cakes",
     "_data": [
       {
+        "id": "cake1",
         "sliceIdsTable": "slices",
-        "idSet": "wyYfK5E4ArrMKQ_zvi2-EE",
-        "layersTable": "layers",
+        "sliceIdsRow": "wyYfK5E4ArrMKQ_zvi2-EE",
         "layers": {
-          "flour": "rrFBguLFLhXjrDqAxJx1p-",
-          "_hash": "JSoUx1N6lso-18vkzG63Pm"
+          "recipeLayers": "PZhgu3fmAtLceImvnW7fTj",
+          "_hash": "fudiDz_SXuMQbcqmAd-JOp"
         },
-        "_hash": "bOlQ1lPpZEYB00F14nGvOP"
+        "_hash": "Mge0ULLEbsemMq1ndUNZ6b"
       }
     ],
-    "_hash": "hsL7dD0mFDqmT2i-1fx_1a"
+    "_hash": "NeM6k972PwtYT8uXM9w27T"
   }
 }
 ```
@@ -299,24 +345,26 @@ Each layer assigns different ingredients to slices.
 ### Buffet
 
 A `Buffet` is a heterogeneous collection of different but related items,
-such as cakes, layers, or ingredients:
+such as cakes, layers, or components:
 
 ```json
 {
   "buffets": {
+    "_type": "buffets",
     "_data": [
       {
+        "id": "salesCounter",
         "items": [
           {
             "table": "cakes",
-            "ref": "bOlQ1lPpZEYB00F14nGvOP",
-            "_hash": "ma47UGAZbu5Ql5yXWFHLAT"
+            "ref": "Mge0ULLEbsemMq1ndUNZ6b",
+            "_hash": "VC_7itbevmNKG3Rc4XWyJz"
           }
         ],
-        "_hash": "jPv5bXjs3XVOLRbQvoWcjw"
+        "_hash": "G7ZX04bp0TdBG9fHDR7Sgu"
       }
     ],
-    "_hash": "FYK9ItHMDCe2CnD_TGRs8_"
+    "_hash": "0RyzLpZX1Nkfxej2WgXbEF"
   }
 }
 ```

package/dist/content/buffet.d.ts

@@ -31,5 +31,5 @@ export interface Buffet extends Json {
 /**
  * A table containing buffets
  */
-export type BuffetsTable = RljsonTable<Buffet>;
+export type BuffetsTable = RljsonTable<Buffet, 'buffets'>;
 export declare const exampleBuffetsTable: () => BuffetsTable;

package/dist/content/cake.d.ts

@@ -24,15 +24,11 @@ export interface Cake extends Json {
      * A row in table, that contains the slice ids of the layer
      */
     sliceIdsRow: SliceIdsRef;
-    /**
-     * The table containing the slice layers defining the layers
-     */
-    layersTable: TableKey;
     /**
      * Assigns a layer to each layer of the cake.
      */
     layers: {
-        [layerId: CakeLayerId]: LayerRef;
+        [layerTable: TableKey]: LayerRef;
     };
     /**
      * An optional ID of the cake.
@@ -42,7 +38,7 @@ export interface Cake extends Json {
 /**
  * A table containing cakes
  */
-export type CakesTable = RljsonTable<Cake>;
+export type CakesTable = RljsonTable<Cake, 'cakes'>;
 /**
  * Provides an example cakes table for test purposes
  */

package/dist/content/components.d.ts

@@ -0,0 +1,15 @@
+import { NutritionalValues } from '../example/bakery-example.ts';
+import { RljsonTable } from '../rljson.ts';
+import { JsonWithId, Ref } from '../typedefs.ts';
+/**
+ * A reference to a components row in a components table
+ */
+export type ComponentRef = Ref;
+/**
+ * A table containing components
+ */
+export type ComponentsTable<T extends JsonWithId> = RljsonTable<T, 'components'>;
+/**
+ * Provides an example components table for test purposes
+ */
+export declare const exampleComponentsTable: () => ComponentsTable<NutritionalValues>;

package/dist/content/layer.d.ts

@@ -1,18 +1,18 @@
 import { Json } from '@rljson/json';
 import { RljsonTable } from '../rljson.ts';
 import { Ref, SliceId, TableKey } from '../typedefs.ts';
-import { IngredientsRef } from './ingredients.ts';
+import { ComponentRef } from './components.ts';
 import { SliceIdsRef } from './slice-ids.ts';
 /**
  * A LayerRef is a hash pointing to a layer
  */
 export type LayerRef = Ref;
 /**
- * A layer assigns ingredients to item ids
+ * A layer assigns components to item ids
  */
 export interface Layer extends Json {
     /**
-     * `base` an optional base layer that is extended by this layer
+     * `base` an optional base layer that is extended or shrinked by this layer
      */
     base?: LayerRef;
     /**
@@ -24,19 +24,26 @@ export interface Layer extends Json {
      */
     sliceIdsTableRow: SliceIdsRef;
     /**
-     * The table containing the ingredients that are assigned to the items
+     * The table containing the components that are assigned to the items
      * with the assign property below
      */
-    ingredientsTable: TableKey;
+    componentsTable: TableKey;
     /**
-     * Assign ingredients to each item of the layer.
+     * Assigns component properties to slice ids.
+     *
+     * If base is defined this will add
+     * or override assignments of the base layer.
      */
-    assign: Record<SliceId, IngredientsRef>;
+    add: Record<SliceId, ComponentRef>;
+    /**
+     * Use this property to remove assignments from the base layer.
+     */
+    remove?: Record<SliceId, ComponentRef>;
 }
 /**
  * A table containing layers
  */
-export type LayersTable = RljsonTable<Layer>;
+export type LayersTable = RljsonTable<Layer, 'layers'>;
 /**
  * Provides an example layersTable for test purposes
  */

package/dist/content/revision.d.ts

@@ -23,14 +23,14 @@ export interface Revision extends Json {
     timestamp: number;
     /**
      * The optional ID of the revisioned element.
-     * Can be used get all revisions of a specific ingredient.
+     * Can be used get all revisions of a specific component.
      */
     id?: string;
 }
 /**
  * A table containing revisions
  */
-export type RevisionsTable = RljsonTable<Revision>;
+export type RevisionsTable = RljsonTable<Revision, 'revisions'>;
 /**
  * Example revision object for test purposes
  */

package/dist/content/slice-ids.d.ts

@@ -25,7 +25,7 @@ export interface SliceIds extends Json {
 /**
  * A table containing slice ids
  */
-export type SliceIdsTable = RljsonTable<SliceIds>;
+export type SliceIdsTable = RljsonTable<SliceIds, 'sliceIds'>;
 /**
  * Returns one of the layers of the example cake
  */

package/dist/content/table-cfg.d.ts

@@ -66,7 +66,7 @@ export interface TableCfg extends Json {
 /**
  * A table containing columns
  */
-export type TablesCfgTable = RljsonTable<TableCfg>;
+export type TablesCfgTable = RljsonTable<TableCfg, 'tableCfgs'>;
 /**
  * Throws an error if the table configuration is not valid.
  * @param tableCfg - The table configuration to check
@@ -84,6 +84,7 @@ export declare const validateRljsonAgainstTableCfg: (rows: Json[], tableCfg: Tab
  * @param tableCfg - The table configuration to add columns to
  * @param columns - The columns to add
  * @returns The updated table configuration
+ // eslint-disable-next-line tsdoc/syntax
  * @throws Error if the columns already exist in the table configuration
  */
 export declare const addColumnsToTableCfg: (tableCfg: TableCfg, columns: ColumnCfg[]) => TableCfg;