@rljson/rljson 0.0.37 → 0.0.39

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

@@ -68,6 +68,17 @@ export interface TableCfg extends Json {
  * A table containing columns
  */
 export type TablesCfgTable = RljsonTable<TableCfg, 'ingredients'>;
+/**
+ * Offers tools for working with table configurations
+ */
+export declare class TableCfgTools {
+    readonly tableCfg: TableCfg;
+    constructor(tableCfg: TableCfg);
+    /**
+     * Returns all column keys
+     */
+    get columnKeys(): ColumnKey[];
+}
 /**
  * Example matching allTypesRow
  */

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 {
@@ -516,6 +524,20 @@ __publicField(_Example, "broken", {
 });
 let Example = _Example;
 // @license
+class TableCfgTools {
+  constructor(tableCfg) {
+    this.tableCfg = tableCfg;
+  }
+  /**
+   * Returns all column keys
+   */
+  get columnKeys() {
+    const columnNames = Object.keys(this.tableCfg.columns).filter(
+      (e) => !e.startsWith("_")
+    );
+    return columnNames;
+  }
+}
 const exampleTableCfgTable = () => Example.ok.singleRow().tableCfgs;
 const exampleTableCfg = (tableCfg = void 0) => {
   return {
@@ -568,15 +590,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 +864,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 +889,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 +928,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 +1105,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 +1149,7 @@ class _BaseValidator {
   }
   _layerBasesNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1136,7 +1179,7 @@ class _BaseValidator {
   }
   _layerSliceIdsTableNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1161,7 +1204,7 @@ class _BaseValidator {
   }
   _layerSliceIdsRowNotFound() {
     const brokenLayers = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1189,7 +1232,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 +1281,7 @@ class _BaseValidator {
   }
   _layerAssignmentsDoNotMatchSliceIds() {
     const layersWithMissingAssignments = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
         return;
       }
@@ -1273,7 +1316,7 @@ class _BaseValidator {
   }
   _cakeSliceIdsTableNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
@@ -1298,7 +1341,7 @@ class _BaseValidator {
   }
   _cakeSliceIdsNotFound() {
     const brokenCakes = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
@@ -1326,7 +1369,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 +1419,7 @@ class _BaseValidator {
   _buffetReferencedTableNotFound() {
     const missingTables = [];
     const missingItems = [];
-    iterateTables(this.rljson, (tableKey, table) => {
+    iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "buffets") {
         return;
       }
@@ -1461,6 +1504,7 @@ class Validate {
 export {
   BaseValidator,
   Example,
+  TableCfgTools,
   Validate,
   bakeryExample,
   contentTypes,
@@ -1468,6 +1512,7 @@ export {
   exampleCakesTable,
   exampleIngredientsTable,
   exampleLayersTable,
+  exampleRevision,
   exampleRljson,
   exampleSliceIdsTable,
   exampleTableCfg,
@@ -1475,6 +1520,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.39",
   "packageManager": "pnpm@10.6.3",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
@@ -29,20 +29,20 @@
     "updateGoldens": "cross-env UPDATE_GOLDENS=true npm test"
   },
   "devDependencies": {
-    "@types/node": "^22.13.17",
-    "@typescript-eslint/eslint-plugin": "^8.29.0",
-    "@typescript-eslint/parser": "^8.29.0",
+    "@types/node": "^22.14.1",
+    "@typescript-eslint/eslint-plugin": "^8.30.1",
+    "@typescript-eslint/parser": "^8.30.1",
     "@vitest/coverage-v8": "^3.1.1",
     "cross-env": "^7.0.3",
-    "eslint": "^9.23.0",
+    "eslint": "^9.25.0",
     "eslint-plugin-jsdoc": "^50.6.9",
     "eslint-plugin-tsdoc": "^0.4.0",
     "globals": "^16.0.0",
     "jsdoc": "^4.0.4",
     "read-pkg": "^9.0.1",
-    "typescript": "~5.8.2",
-    "typescript-eslint": "^8.29.0",
-    "vite": "^6.2.4",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.30.1",
+    "vite": "^6.3.2",
     "vite-node": "^3.1.1",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",