@rljson/rljson 0.0.37 → 0.0.38

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

@@ -148,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 {
@@ -568,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",
@@ -821,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;
@@ -846,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;
@@ -885,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;
@@ -1062,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)) {
@@ -1106,7 +1135,7 @@ class _BaseValidator {
   }
   _layerBasesNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1136,7 +1165,7 @@ class _BaseValidator {
   }
   _layerSliceIdsTableNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1161,7 +1190,7 @@ class _BaseValidator {
   }
   _layerSliceIdsRowNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1189,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;
       }
@@ -1238,7 +1267,7 @@ class _BaseValidator {
   }
   _layerAssignmentsDoNotMatchSliceIds() {
     const layersWithMissingAssignments = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1273,7 +1302,7 @@ class _BaseValidator {
   }
   _cakeSliceIdsTableNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
@@ -1298,7 +1327,7 @@ class _BaseValidator {
   }
   _cakeSliceIdsNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
@@ -1326,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;
       }
@@ -1376,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;
       }
@@ -1468,6 +1497,7 @@ export {
   exampleCakesTable,
   exampleIngredientsTable,
   exampleLayersTable,
+  exampleRevision,
   exampleRljson,
   exampleSliceIdsTable,
   exampleTableCfg,
@@ -1475,6 +1505,7 @@ export {
   exampleTypedefs,
   isValidFieldName,
   iterateTables,
+  iterateTablesSync,
   reservedFieldNames,
   reservedTableKeys,
   rljsonIndexed

package/package.json

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