@rljson/rljson 0.0.36 → 0.0.38

package/dist/content/cake.d.ts

@@ -19,16 +19,11 @@ export interface Cake extends Json {
      * must match these slice ids of the layers.
      * The slice ids can be found in the idSet table.
      */
-    sliceIds: {
-        /**
-         * The table containing the item ids of the layer
-         */
-        table: TableKey;
-        /**
-         * A row in table, that contains the slice ids of the layer
-         */
-        row: SliceIdsRef;
-    };
+    sliceIdsTable: TableKey;
+    /**
+     * A row in table, that contains the slice ids of the layer
+     */
+    sliceIdsRow: SliceIdsRef;
     /**
      * The table containing the slice layers defining the layers
      */

package/dist/content/layer.d.ts

@@ -15,16 +15,14 @@ export interface Layer extends Json {
      * `base` an optional base layer that is extended by this layer
      */
     base?: LayerRef;
-    sliceIds: {
-        /**
-         * The table containing the item ids of the layer
-         */
-        table: TableKey;
-        /**
-         * A row in table, that contains the slice ids of the layer
-         */
-        row: SliceIdsRef;
-    };
+    /**
+     * The table containing the item ids of the layer
+     */
+    sliceIdsTable: TableKey;
+    /**
+     * A row in table, that contains the slice ids of the layer
+     */
+    sliceIdsTableRow: SliceIdsRef;
     /**
      * The table containing the ingredients that are assigned to the items
      * with the assign property below

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './content/buffet.ts';
 export * from './content/cake.ts';
 export * from './content/ingredients.ts';
 export * from './content/layer.ts';
+export * from './content/revision.ts';
 export * from './content/slice-ids.ts';
 export * from './content/table-cfg.ts';
 export * from './example.ts';

package/dist/rljson.d.ts

@@ -59,4 +59,13 @@ export interface RljsonTable<Data extends Json, Type extends ContentType> extend
  * @param rljson - The Rljson object to iterate
  * @param callback - The callback to call for each table
  */
-export declare const iterateTables: (rljson: Rljson, callback: (tableKey: string, table: TableType) => void) => void;
+export declare const iterateTablesSync: (rljson: Rljson, callback: (tableKey: string, table: TableType) => void) => void;
+/**
+ * Iterates over all tables of an Rljson object.
+ * Skips private members starting with _
+ * @param rljson - The Rljson object to iterate
+ * @param callback - The callback to call for each table
+ *
+ * Note: The callbacks are executed in parallel.
+ */
+export declare const iterateTables: (rljson: Rljson, callback: (tableKey: string, table: TableType) => Promise<void>) => Promise<void>;

package/dist/rljson.js

@@ -75,10 +75,8 @@ const bakeryExample = () => {
       {
         id: "tastyCake",
         ingredientsTable: "recipeIngredients",
-        sliceIds: {
-          table: "ingredientTypes",
-          row: ingredientTypes._data[0]._hash
-        },
+        sliceIdsTable: "ingredientTypes",
+        sliceIdsTableRow: ingredientTypes._data[0]._hash,
         assign: {
           flour: recipeIngredients._data[0]._hash
         },
@@ -91,10 +89,8 @@ const bakeryExample = () => {
     _data: [
       {
         ingredientsTable: "recipes",
-        sliceIds: {
-          table: "slices",
-          row: slices._data[0]._hash
-        },
+        sliceIdsTable: "slices",
+        sliceIdsTableRow: slices._data[0]._hash,
         assign: {
           slice0: recipes._data[0]._hash,
           slice1: recipes._data[0]._hash
@@ -107,10 +103,8 @@ const bakeryExample = () => {
     _data: [
       {
         id: "cake1",
-        sliceIds: {
-          table: "slices",
-          row: slices._data[0]._hash
-        },
+        sliceIdsTable: "slices",
+        sliceIdsRow: slices._data[0]._hash,
         layersTable: "layers",
         layers: {
           flour: layers._data[0]._hash
@@ -154,6 +148,14 @@ const exampleIngredientsTable = () => bakeryExample().nutritionalValues;
 // @license
 const exampleLayersTable = () => bakeryExample().layers;
 // @license
+const exampleRevision = () => ({
+  table: "nutritionalValues",
+  id: "flour",
+  predecessor: "gZXFSlrl5QAs5hOVsq5sWB",
+  successor: "IqeoWJjZQNlr-NVk2QT15B",
+  timestamp: 1743558427
+});
+// @license
 const exampleSliceIdsTable = () => bakeryExample().slices;
 // @license
 const _Example = class _Example {
@@ -298,10 +300,8 @@ __publicField(_Example, "ok", {
     const ingredient0 = ingredients._data[0];
     const ingredient1 = ingredients._data[1];
     const layer0 = hip({
-      sliceIds: {
-        table: "sliceIds",
-        row: "MgHRBYSrhpyl4rvsOmAWcQ"
-      },
+      sliceIdsTable: "sliceIds",
+      sliceIdsTableRow: "MgHRBYSrhpyl4rvsOmAWcQ",
       ingredientsTable: "ingredients",
       assign: {
         id0: ingredient0._hash,
@@ -310,10 +310,8 @@ __publicField(_Example, "ok", {
     });
     const layer1 = hip({
       base: layer0._hash,
-      sliceIds: {
-        table: "sliceIds",
-        row: "MgHRBYSrhpyl4rvsOmAWcQ"
-      },
+      sliceIdsTable: "sliceIds",
+      sliceIdsTableRow: "MgHRBYSrhpyl4rvsOmAWcQ",
       ingredientsTable: "ingredients",
       assign: {
         id0: ingredient0._hash,
@@ -325,10 +323,8 @@ __publicField(_Example, "ok", {
       _data: [layer0, layer1]
     });
     const cake = hip({
-      sliceIds: {
-        table: "sliceIds",
-        row: sliceIds._data[0]._hash
-      },
+      sliceIdsTable: "sliceIds",
+      sliceIdsRow: sliceIds._data[0]._hash,
       layersTable: "layers",
       layers: {
         layer0: layer0._hash,
@@ -452,7 +448,7 @@ __publicField(_Example, "broken", {
     missingSliceIdSet: () => {
       const result = _Example.ok.complete();
       const layer1 = result.layers._data[1];
-      layer1.sliceIds.row = "MISSING1";
+      layer1.sliceIdsTableRow = "MISSING1";
       return hip(result, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
@@ -475,7 +471,7 @@ __publicField(_Example, "broken", {
   cakes: {
     missingSliceIdSet: () => {
       const result = _Example.ok.complete();
-      result.cakes._data[0].sliceIds.row = "MISSING";
+      result.cakes._data[0].sliceIdsRow = "MISSING";
       hip(result.cakes, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
@@ -580,15 +576,36 @@ const reservedTableKeys = [
   "revisions"
 ];
 const exampleRljson = () => Example.ok.singleRow();
-const iterateTables = (rljson, callback) => {
+const _isTable = (value) => {
+  return !(typeof value !== "object" || !Array.isArray(value._data));
+};
+const iterateTablesSync = (rljson, callback) => {
   for (const tableKey in rljson) {
     const value = rljson[tableKey];
-    if (typeof value !== "object" || !Array.isArray(value._data)) {
+    if (!_isTable(value)) {
       continue;
     }
     callback(tableKey, rljson[tableKey]);
   }
 };
+const iterateTables = async (rljson, callback) => {
+  const array = [];
+  const errors = [];
+  for (const tableKey in rljson) {
+    const value = rljson[tableKey];
+    if (!_isTable(value)) {
+      continue;
+    }
+    const promise = callback(tableKey, rljson[tableKey]).catch((error) => {
+      errors.push({ tableKey, error });
+    });
+    array.push(promise);
+  }
+  await Promise.all(array);
+  if (errors.length) {
+    throw errors;
+  }
+};
 // @license
 const contentTypes = [
   "buffets",
@@ -833,7 +850,7 @@ class _BaseValidator {
   _tableCfgNotFound() {
     const tableCfgs = this.rljsonIndexed.tableCfgs;
     const tableCfgNotFound = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       const tableCfgRef = table._tableCfg;
       if (!tableCfgRef) {
         return;
@@ -858,7 +875,7 @@ class _BaseValidator {
   _missingColumnConfigs() {
     const tableCfgs = this.rljsonIndexed.tableCfgs;
     const missingColumnConfigs = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       const tableCfgRef = table._tableCfg;
       if (!tableCfgRef) {
         return;
@@ -897,7 +914,7 @@ class _BaseValidator {
   _dataDoesNotMatchColumnConfig() {
     const tableCfgs = this.rljsonIndexed.tableCfgs;
     const brokenValues = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       const tableCfgRef = table._tableCfg;
       if (!tableCfgRef) {
         return;
@@ -1074,7 +1091,7 @@ class _BaseValidator {
   }
   _refsNotFound() {
     const missingRefs = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       const tableData = table._data;
       for (const item of tableData) {
         for (const key of Object.keys(item)) {
@@ -1118,7 +1135,7 @@ class _BaseValidator {
   }
   _layerBasesNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1148,22 +1165,18 @@ class _BaseValidator {
   }
   _layerSliceIdsTableNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
       const layersTable = table;
       for (const layer of layersTable._data) {
-        const sliceIds = layer.sliceIds;
-        if (!sliceIds) {
-          continue;
-        }
-        const sliceIdsTable = this.rljsonIndexed[sliceIds.table];
+        const sliceIdsTable = this.rljsonIndexed[layer.sliceIdsTable];
         if (!sliceIdsTable) {
           brokenLayers.push({
             layersTable: tableKey,
             layerHash: layer._hash,
-            missingSliceIdsTable: sliceIds.table
+            missingSliceIdsTable: layer.sliceIdsTable
           });
         }
       }
@@ -1177,24 +1190,20 @@ class _BaseValidator {
   }
   _layerSliceIdsRowNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
       const layersTable = table;
       for (const layer of layersTable._data) {
-        const sliceIds = layer.sliceIds;
-        if (!sliceIds) {
-          continue;
-        }
-        const sliceIdsTableName = sliceIds.table;
+        const sliceIdsTableName = layer.sliceIdsTable;
         const sliceIdsTable = this.rljsonIndexed[sliceIdsTableName];
-        const idSet = sliceIdsTable._data[sliceIds.row];
+        const idSet = sliceIdsTable._data[layer.sliceIdsTableRow];
         if (!idSet) {
           brokenLayers.push({
             layersTable: tableKey,
             layerHash: layer._hash,
-            missingSliceIdsRow: sliceIds.row
+            missingSliceIdsRow: layer.sliceIdsTableRow
           });
         }
       }
@@ -1209,7 +1218,7 @@ class _BaseValidator {
   _layerIngredientAssignmentsNotFound() {
     const missingIngredientTables = [];
     const brokenAssignments = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1258,17 +1267,14 @@ class _BaseValidator {
   }
   _layerAssignmentsDoNotMatchSliceIds() {
     const layersWithMissingAssignments = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
       const layersTable = table;
       for (const layer of layersTable._data) {
-        if (!layer.sliceIds) {
-          continue;
-        }
-        const sliceIdsTable = this.rljsonIndexed[layer.sliceIds.table];
-        const sliceIdsRow = sliceIdsTable._data[layer.sliceIds.row];
+        const sliceIdsTable = this.rljsonIndexed[layer.sliceIdsTable];
+        const sliceIdsRow = sliceIdsTable._data[layer.sliceIdsTableRow];
         const sliceIds = sliceIdsRow.add;
         const sliceIdsInLayer = Object.keys(layer.assign);
         const unassignedSliceIds = [];
@@ -1296,22 +1302,18 @@ class _BaseValidator {
   }
   _cakeSliceIdsTableNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
       const cakesTable = table;
       for (const cake of cakesTable._data) {
-        const sliceIds = cake.sliceIds;
-        if (!sliceIds) {
-          continue;
-        }
-        const sliceIdsTable = this.rljsonIndexed[sliceIds.table];
+        const sliceIdsTable = this.rljsonIndexed[cake.sliceIdsTable];
         if (!sliceIdsTable) {
           brokenCakes.push({
             cakeTable: tableKey,
             brokenCake: cake._hash,
-            missingSliceIdsTable: sliceIds.table
+            missingSliceIdsTable: cake.sliceIdsTable
           });
         }
       }
@@ -1325,24 +1327,20 @@ class _BaseValidator {
   }
   _cakeSliceIdsNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
       const cakesTable = table;
       for (const cake of cakesTable._data) {
-        const sliceIds = cake.sliceIds;
-        if (!sliceIds) {
-          continue;
-        }
-        const sliceIdsTableName = cake.sliceIds.table;
+        const sliceIdsTableName = cake.sliceIdsTable;
         const sliceIdsTable = this.rljsonIndexed[sliceIdsTableName];
-        const sliceIdValues = sliceIdsTable._data[sliceIds.row];
+        const sliceIdValues = sliceIdsTable._data[cake.sliceIdsRow];
         if (!sliceIdValues) {
           brokenCakes.push({
             cakeTable: tableKey,
             brokenCake: cake._hash,
-            missingSliceIdsRow: sliceIds.row
+            missingSliceIdsRow: cake.sliceIdsRow
           });
         }
       }
@@ -1357,7 +1355,7 @@ class _BaseValidator {
   _cakeLayerTablesNotFound() {
     const missingLayerTables = [];
     const missingCakeLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
@@ -1407,7 +1405,7 @@ class _BaseValidator {
   _buffetReferencedTableNotFound() {
     const missingTables = [];
     const missingItems = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "buffets") {
         return;
       }
@@ -1499,6 +1497,7 @@ export {
   exampleCakesTable,
   exampleIngredientsTable,
   exampleLayersTable,
+  exampleRevision,
   exampleRljson,
   exampleSliceIdsTable,
   exampleTableCfg,
@@ -1506,6 +1505,7 @@ export {
   exampleTypedefs,
   isValidFieldName,
   iterateTables,
+  iterateTablesSync,
   reservedFieldNames,
   reservedTableKeys,
   rljsonIndexed

package/dist/src/example.ts

@@ -39,7 +39,7 @@ export class Example {
     },
 
     singleRow: (): Rljson => {
-      const tableCfgs: TablesCfgTable = hip({
+      const tableCfgs = hip<TablesCfgTable>({
         _hash: '',
 
         _type: 'ingredients',
@@ -151,7 +151,7 @@ export class Example {
       };
     },
     complete: (): Rljson => {
-      const sliceIds: SliceIdsTable = hip({
+      const sliceIds = hip<SliceIdsTable>({
         _type: 'sliceIds',
         _data: [
           {
@@ -160,18 +160,16 @@ export class Example {
         ],
       });
 
-      const ingredients: IngredientsTable<any> = hip({
+      const ingredients = hip<IngredientsTable<any>>({
         _type: 'ingredients',
         _data: [{ a: '0' }, { a: '1' }],
       });
       const ingredient0 = ingredients._data[0];
       const ingredient1 = ingredients._data[1];
 
-      const layer0: Layer = hip({
-        sliceIds: {
-          table: 'sliceIds',
-          row: 'MgHRBYSrhpyl4rvsOmAWcQ',
-        },
+      const layer0 = hip<Layer>({
+        sliceIdsTable: 'sliceIds',
+        sliceIdsTableRow: 'MgHRBYSrhpyl4rvsOmAWcQ',
         ingredientsTable: 'ingredients',
         assign: {
           id0: ingredient0._hash,
@@ -179,12 +177,10 @@ export class Example {
         },
       });
 
-      const layer1: Layer = hip({
+      const layer1 = hip<Layer>({
         base: layer0._hash as string,
-        sliceIds: {
-          table: 'sliceIds',
-          row: 'MgHRBYSrhpyl4rvsOmAWcQ',
-        },
+        sliceIdsTable: 'sliceIds',
+        sliceIdsTableRow: 'MgHRBYSrhpyl4rvsOmAWcQ',
         ingredientsTable: 'ingredients',
         assign: {
           id0: ingredient0._hash,
@@ -192,16 +188,14 @@ export class Example {
         },
       });
 
-      const layers: LayersTable = hip({
+      const layers = hip<LayersTable>({
         _type: 'layers',
         _data: [layer0, layer1],
       } as LayersTable);
 
-      const cake: Cake = hip({
-        sliceIds: {
-          table: 'sliceIds',
-          row: sliceIds._data[0]._hash as string,
-        },
+      const cake = hip<Cake>({
+        sliceIdsTable: 'sliceIds',
+        sliceIdsRow: sliceIds._data[0]._hash as string,
         layersTable: 'layers',
         layers: {
           layer0: layer0._hash as string,
@@ -209,12 +203,12 @@ export class Example {
         },
       });
 
-      const cakes: CakesTable = hip({
+      const cakes = hip<CakesTable>({
         _type: 'cakes',
         _data: [cake],
       });
 
-      const buffets: BuffetsTable = hip({
+      const buffets = hip<BuffetsTable>({
         _type: 'buffets',
         _data: [
           {
@@ -335,9 +329,9 @@ export class Example {
 
       missingSliceIdSet: (): Rljson => {
         const result = Example.ok.complete();
-        const layer1 = result.layers._data[1];
+        const layer1 = (result.layers as LayersTable)._data[1];
 
-        layer1.sliceIds.row = 'MISSING1';
+        layer1.sliceIdsTableRow = 'MISSING1';
 
         // Recalculate hashes
         return hip(result, {
@@ -365,14 +359,15 @@ export class Example {
     cakes: {
       missingSliceIdSet: (): Rljson => {
         const result = Example.ok.complete();
-        result.cakes._data[0].sliceIds.row = 'MISSING'; // Missing ID set
+        (result.cakes as CakesTable)._data[0].sliceIdsRow = 'MISSING'; // Missing ID set
+
         hip(result.cakes, {
           updateExistingHashes: true,
           throwOnWrongHashes: false,
         });
 
-        result.buffets._data[0].items[0].ref = result.cakes._data[0]
-          ._hash as string; // Update buffet reference
+        (result.buffets as BuffetsTable)._data[0].items[0].ref = result.cakes
+          ._data[0]._hash as string; // Update buffet reference
 
         hip(result.buffets, {
           updateExistingHashes: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.36",
+  "version": "0.0.38",
   "packageManager": "pnpm@10.6.3",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",