@rljson/rljson 0.0.50 → 0.0.52

package/dist/example/bakery-example.d.ts

@@ -1,7 +1,7 @@
 import { Json } from '@rljson/json';
 import { BuffetsTable } from '../content/buffet.ts';
 import { CakesTable } from '../content/cake.ts';
-import { IngredientsTable } from '../content/ingredients.ts';
+import { ComponentsTable } from '../content/components.ts';
 import { LayersTable } from '../content/layer.ts';
 import { SliceIdsTable } from '../content/slice-ids.ts';
 import { Rljson } from '../rljson.ts';
@@ -11,11 +11,11 @@ export interface Ingredient extends Json {
     amountUnit: 'g' | 'ml';
     nutritionalValuesRef: Ref;
 }
-export interface RecipeIngredient extends Json {
+export interface RecipIngredient extends Json {
     ingredientsRef: string;
     quantity: number;
 }
-export type IngredientsTypeTable = IngredientsTable<Ingredient>;
+export type IngredientsTypeTable = ComponentsTable<Ingredient>;
 export interface NutritionalValues extends Json {
     energy: number;
     fat: number;
@@ -26,10 +26,10 @@ export interface Bakery extends Rljson {
     buffets: BuffetsTable;
     cakes: CakesTable;
     slices: SliceIdsTable;
-    layers: LayersTable;
     recipes: LayersTable;
-    recipeIngredients: IngredientsTable<RecipeIngredient>;
-    ingredients: IngredientsTable<Ingredient>;
-    nutritionalValues: IngredientsTable<NutritionalValues>;
+    recipeLayers: LayersTable;
+    recipeIngredients: ComponentsTable<RecipIngredient>;
+    ingredients: ComponentsTable<Ingredient>;
+    nutritionalValues: ComponentsTable<NutritionalValues>;
 }
 export declare const bakeryExample: () => Bakery;

package/dist/example.d.ts

@@ -27,8 +27,8 @@ export declare class Example {
         layers: {
             missingBase: () => Rljson;
             missingSliceIdSet: () => Rljson;
-            missingAssignedIngredientTable: () => Rljson;
-            missingAssignedIngredient: () => Rljson;
+            missingAssignedComponentTable: () => Rljson;
+            missingAssignedComponent: () => Rljson;
         };
         cakes: {
             missingSliceIdSet: () => Rljson;

package/dist/index.d.ts

@@ -1,13 +1,12 @@
 export * from './content/buffet.ts';
 export * from './content/cake.ts';
-export * from './content/ingredients.ts';
+export * from './content/components.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';
 export * from './example/bakery-example.ts';
-export * from './rljson-indexed.ts';
 export * from './rljson.ts';
 export * from './typedefs.ts';
 export * from './validate/base-validator.ts';

package/dist/rljson.d.ts

@@ -1,18 +1,18 @@
 import { Json } from '@rljson/json';
 import { BuffetsTable } from './content/buffet.ts';
 import { CakesTable } from './content/cake.ts';
-import { IngredientsTable } from './content/ingredients.ts';
+import { ComponentsTable } from './content/components.ts';
 import { LayersTable } from './content/layer.ts';
 import { RevisionsTable } from './content/revision.ts';
 import { SliceIdsTable } from './content/slice-ids.ts';
 import { TableCfgRef, TablesCfgTable } from './content/table-cfg.ts';
-import { Ref, TableKey } from './typedefs.ts';
+import { ContentType, Ref, TableKey } from './typedefs.ts';
 export declare const reservedFieldNames: string[];
 export declare const reservedTableKeys: string[];
 /**
  * One of the supported Rljson table types
  */
-export type TableType = BuffetsTable | IngredientsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable;
+export type TableType = BuffetsTable | ComponentsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable | TablesCfgTable;
 /** The rljson data format */
 export interface Rljson extends Json {
     [tableId: TableKey]: TableType;
@@ -45,11 +45,13 @@ export type RljsonPrivate = {
 /** An example rljson object */
 export declare const exampleRljson: () => Rljson;
 /** A table in the rljson format */
-export interface RljsonTable<Data extends Json> extends Json {
+export interface RljsonTable<Data extends Json, T extends ContentType> extends Json {
     /** The data rows of the table */
     _data: Data[];
     /** The columns configuration of the table */
     _tableCfg?: TableCfgRef;
+    /** The type of the table. Must match the one in table cfg table */
+    _type: T;
 }
 /**
  * Iterates over all tables of an Rljson object.

package/dist/rljson.js

@@ -6,6 +6,7 @@ import { exampleJsonObject, jsonValueTypes, jsonValueType, jsonValueMatchesType
 // @license
 const bakeryExample = () => {
   const nutritionalValues = hip({
+    _type: "components",
     _data: [
       {
         id: "flour",
@@ -27,6 +28,7 @@ const bakeryExample = () => {
     _hash: ""
   });
   const ingredients = hip({
+    _type: "components",
     _data: [
       {
         id: "flour",
@@ -38,6 +40,7 @@ const bakeryExample = () => {
     _hash: ""
   });
   const recipeIngredients = hip({
+    _type: "components",
     _data: [
       {
         id: "flour",
@@ -49,6 +52,7 @@ const bakeryExample = () => {
     _hash: ""
   });
   const slices = hip({
+    _type: "sliceIds",
     _data: [
       {
         add: ["slice0", "slice1"],
@@ -57,6 +61,7 @@ const bakeryExample = () => {
     ]
   });
   const ingredientTypes = hip({
+    _type: "sliceIds",
     _data: [
       {
         add: ["flour"],
@@ -65,26 +70,28 @@ const bakeryExample = () => {
     ]
   });
   const recipes = hip({
+    _type: "layers",
     _data: [
       {
         id: "tastyCake",
-        ingredientsTable: "recipeIngredients",
+        componentsTable: "recipeIngredients",
         sliceIdsTable: "ingredientTypes",
         sliceIdsTableRow: ingredientTypes._data[0]._hash,
-        assign: {
+        add: {
           flour: recipeIngredients._data[0]._hash
         },
         _hash: ""
       }
     ]
   });
-  const layers = hip({
+  const recipeLayers = hip({
+    _type: "layers",
     _data: [
       {
-        ingredientsTable: "recipes",
+        componentsTable: "recipes",
         sliceIdsTable: "slices",
         sliceIdsTableRow: slices._data[0]._hash,
-        assign: {
+        add: {
           slice0: recipes._data[0]._hash,
           slice1: recipes._data[0]._hash
         }
@@ -92,19 +99,20 @@ const bakeryExample = () => {
     ]
   });
   const cakes = hip({
+    _type: "cakes",
     _data: [
       {
         id: "cake1",
         sliceIdsTable: "slices",
         sliceIdsRow: slices._data[0]._hash,
-        layersTable: "layers",
         layers: {
-          flour: layers._data[0]._hash
+          recipeLayers: recipeLayers._data[0]._hash
         }
       }
     ]
   });
   const buffets = hip({
+    _type: "buffets",
     _data: [
       {
         id: "salesCounter",
@@ -122,7 +130,7 @@ const bakeryExample = () => {
     cakes,
     slices,
     ingredientTypes,
-    layers,
+    recipeLayers,
     recipes,
     recipeIngredients,
     ingredients,
@@ -135,9 +143,9 @@ const exampleBuffetsTable = () => bakeryExample().buffets;
 // @license
 const exampleCakesTable = () => bakeryExample().cakes;
 // @license
-const exampleIngredientsTable = () => bakeryExample().nutritionalValues;
+const exampleComponentsTable = () => bakeryExample().nutritionalValues;
 // @license
-const exampleLayersTable = () => bakeryExample().layers;
+const exampleLayersTable = () => bakeryExample().recipeLayers;
 // @license
 const exampleRevision = () => ({
   table: "nutritionalValues",
@@ -159,6 +167,7 @@ __publicField(_Example, "ok", {
   binary: () => {
     return {
       table: {
+        _type: "components",
         _data: [
           { a: false, b: false },
           { a: false, b: true },
@@ -171,12 +180,13 @@ __publicField(_Example, "ok", {
   singleRow: () => {
     const tableCfgs = hip({
       _hash: "",
+      _type: "tableCfgs",
       _data: [
         {
           version: 0,
           _hash: "",
           key: "table",
-          type: "ingredients",
+          type: "components",
           isHead: false,
           isRoot: false,
           isShared: true,
@@ -221,6 +231,7 @@ __publicField(_Example, "ok", {
       tableCfgs,
       table: {
         _tableCfg: tableCfgs._data[0]._hash,
+        _type: "components",
         _data: [exampleJsonObject()],
         _hash: ""
       }
@@ -230,6 +241,7 @@ __publicField(_Example, "ok", {
   multipleRows: () => {
     return {
       table: {
+        _type: "components",
         _data: [
           {
             string: "str0",
@@ -259,6 +271,7 @@ __publicField(_Example, "ok", {
   singleRef: () => {
     return {
       tableA: {
+        _type: "components",
         _data: [
           {
             keyA0: "a0"
@@ -269,6 +282,7 @@ __publicField(_Example, "ok", {
         ]
       },
       tableB: {
+        _type: "components",
         _data: [
           {
             tableARef: "KFQrf4mEz0UPmUaFHwH4T6"
@@ -279,52 +293,55 @@ __publicField(_Example, "ok", {
   },
   complete: () => {
     const sliceIds = hip({
+      _type: "sliceIds",
       _data: [
         {
           add: ["id0", "id1"]
         }
       ]
     });
-    const ingredients = hip({
+    const components = hip({
+      _type: "components",
       _data: [{ a: "0" }, { a: "1" }]
     });
-    const ingredient0 = ingredients._data[0];
-    const ingredient1 = ingredients._data[1];
-    const layer0 = hip({
+    const component0 = components._data[0];
+    const component1 = components._data[1];
+    const abLayer0 = hip({
       sliceIdsTable: "sliceIds",
       sliceIdsTableRow: "MgHRBYSrhpyl4rvsOmAWcQ",
-      ingredientsTable: "ingredients",
-      assign: {
-        id0: ingredient0._hash,
-        id1: ingredient1._hash
+      componentsTable: "components",
+      add: {
+        id0: component0._hash,
+        id1: component1._hash
       }
     });
-    const layer1 = hip({
-      base: layer0._hash,
+    const abLayer1 = hip({
+      base: abLayer0._hash,
       sliceIdsTable: "sliceIds",
       sliceIdsTableRow: "MgHRBYSrhpyl4rvsOmAWcQ",
-      ingredientsTable: "ingredients",
-      assign: {
-        id0: ingredient0._hash,
-        id1: ingredient1._hash
+      componentsTable: "components",
+      add: {
+        id0: component0._hash,
+        id1: component1._hash
       }
     });
-    const layers = hip({
-      _data: [layer0, layer1]
+    const abLayers = hip({
+      _type: "layers",
+      _data: [abLayer0, abLayer1]
     });
     const cake = hip({
       sliceIdsTable: "sliceIds",
       sliceIdsRow: sliceIds._data[0]._hash,
-      layersTable: "layers",
       layers: {
-        layer0: layer0._hash,
-        layer1: layer1._hash
+        abLayers: abLayer1._hash
       }
     });
     const cakes = hip({
+      _type: "cakes",
       _data: [cake]
     });
     const buffets = hip({
+      _type: "buffets",
       _data: [
         {
           items: [
@@ -333,8 +350,8 @@ __publicField(_Example, "ok", {
               ref: cakes._data[0]._hash
             },
             {
-              table: "layers",
-              ref: layer0._hash
+              table: "abLayers",
+              ref: abLayer0._hash
             }
           ]
         }
@@ -342,8 +359,8 @@ __publicField(_Example, "ok", {
     });
     return {
       sliceIds,
-      ingredients,
-      layers,
+      components,
+      abLayers,
       cakes,
       buffets
     };
@@ -373,6 +390,7 @@ __publicField(_Example, "broken", {
     missingRef: () => {
       return {
         tableA: {
+          _type: "components",
           _data: [
             {
               keyA0: "a0"
@@ -383,6 +401,7 @@ __publicField(_Example, "broken", {
           ]
         },
         tableB: {
+          _type: "components",
           _data: [
             {
               tableARef: "MISSINGREF"
@@ -395,6 +414,7 @@ __publicField(_Example, "broken", {
     missingReferencedTable: () => {
       return {
         tableB: {
+          _type: "components",
           _data: [
             {
               tableARef: "MISSINGREF"
@@ -420,7 +440,7 @@ __publicField(_Example, "broken", {
   layers: {
     missingBase: () => {
       const result = _Example.ok.complete();
-      const layer1 = result.layers._data[1];
+      const layer1 = result.abLayers._data[1];
       layer1.base = "MISSING";
       return hip(result, {
         updateExistingHashes: true,
@@ -429,21 +449,21 @@ __publicField(_Example, "broken", {
     },
     missingSliceIdSet: () => {
       const result = _Example.ok.complete();
-      const layer1 = result.layers._data[1];
+      const layer1 = result.abLayers._data[1];
       layer1.sliceIdsTableRow = "MISSING1";
       return hip(result, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
       });
     },
-    missingAssignedIngredientTable: () => {
+    missingAssignedComponentTable: () => {
       const result = _Example.ok.complete();
-      delete result.ingredients;
+      delete result.components;
       return result;
     },
-    missingAssignedIngredient: () => {
+    missingAssignedComponent: () => {
       const result = _Example.ok.complete();
-      result.ingredients._data.splice(1, 2);
+      result.components._data.splice(1, 2);
       return hip(result, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
@@ -467,7 +487,7 @@ __publicField(_Example, "broken", {
     },
     missingLayersTable: () => {
       const result = _Example.ok.complete();
-      result.cakes._data[0].layersTable = "MISSING";
+      result.cakes._data[0].layers = { MISSING: "HASH" };
       hip(result.cakes, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
@@ -476,8 +496,7 @@ __publicField(_Example, "broken", {
     },
     missingCakeLayer: () => {
       const result = _Example.ok.complete();
-      result.cakes._data[0].layers["layer0"] = "MISSING0";
-      result.cakes._data[0].layers["layer1"] = "MISSING1";
+      result.cakes._data[0].layers["abLayers"] = "MISSING0";
       hip(result.cakes, {
         updateExistingHashes: true,
         throwOnWrongHashes: false
@@ -598,36 +617,13 @@ const exampleTableCfg = (tableCfg = void 0) => {
         type: "number"
       }
     ],
-    type: (tableCfg == null ? void 0 : tableCfg.type) ?? "ingredients",
+    type: (tableCfg == null ? void 0 : tableCfg.type) ?? "components",
     isHead: true,
     isRoot: true,
     isShared: false
   };
 };
 // @license
-const rljsonIndexed = (rljson) => {
-  const result = {};
-  for (const key in rljson) {
-    const slice = rljson[key];
-    if (typeof slice != "object") {
-      result[key] = slice;
-      continue;
-    }
-    const dataIndexed = {};
-    result[key] = { ...slice };
-    if (!Array.isArray(slice._data)) {
-      continue;
-    }
-    for (const row of slice._data) {
-      const hashedRow = row._hash ? row : hsh(row);
-      const hash = hashedRow._hash;
-      dataIndexed[hash] = hashedRow;
-    }
-    result[key]._data = dataIndexed;
-  }
-  return result;
-};
-// @license
 const reservedFieldNames = ["_data"];
 const reservedTableKeys = [
   "_hash",
@@ -673,7 +669,9 @@ const contentTypes = [
   "cakes",
   "layers",
   "sliceIds",
-  "ingredients"
+  "components",
+  "revisions",
+  "tableCfgs"
 ];
 const exampleTypedefs = () => {
   return {
@@ -684,6 +682,29 @@ const exampleTypedefs = () => {
   };
 };
 // @license
+const rljsonIndexed = (rljson) => {
+  const result = {};
+  for (const key in rljson) {
+    const slice = rljson[key];
+    if (typeof slice != "object") {
+      result[key] = slice;
+      continue;
+    }
+    const dataIndexed = {};
+    result[key] = { ...slice };
+    if (!Array.isArray(slice._data)) {
+      continue;
+    }
+    for (const row of slice._data) {
+      const hashedRow = row._hash ? row : hsh(row);
+      const hash = hashedRow._hash;
+      dataIndexed[hash] = hashedRow;
+    }
+    result[key]._data = dataIndexed;
+  }
+  return result;
+};
+// @license
 class BaseValidator {
   constructor() {
     __publicField(this, "name", "base");
@@ -738,7 +759,7 @@ class _BaseValidator {
       () => this._layerBasesNotFound(),
       () => this._layerSliceIdsTableNotFound(),
       () => this._layerSliceIdsRowNotFound(),
-      () => this._layerIngredientAssignmentsNotFound(),
+      () => this._layerComponentAssignmentsNotFound(),
       () => this._layerAssignmentsDoNotMatchSliceIds(),
       // Check cakes
       () => this._cakeSliceIdsTableNotFound(),
@@ -1171,7 +1192,6 @@ class _BaseValidator {
       };
     }
   }
-  /* v8 ignore start */
   _layerSliceIdsTableNotFound() {
     const brokenLayers = [];
     iterateTablesSync(this.rljson, (tableKey, table) => {
@@ -1224,8 +1244,8 @@ class _BaseValidator {
       };
     }
   }
-  _layerIngredientAssignmentsNotFound() {
-    const missingIngredientTables = [];
+  _layerComponentAssignmentsNotFound() {
+    const missingComponentTables = [];
     const brokenAssignments = [];
     iterateTablesSync(this.rljson, (tableKey, table) => {
       if (table._type !== "layers") {
@@ -1233,43 +1253,43 @@ class _BaseValidator {
       }
       const layersTable = table;
       for (const layer of layersTable._data) {
-        const ingredientTableKey = layer.ingredientsTable;
-        const ingredientsTable = this.rljsonIndexed[ingredientTableKey];
-        if (!ingredientsTable) {
-          missingIngredientTables.push({
+        const componentTableKey = layer.componentsTable;
+        const componentsTable = this.rljsonIndexed[componentTableKey];
+        if (!componentsTable) {
+          missingComponentTables.push({
             brokenLayer: layer._hash,
             layersTable: tableKey,
-            missingIngredientTable: ingredientTableKey
+            missingComponentTable: componentTableKey
           });
           continue;
         }
-        const assignments = layer.assign;
+        const assignments = layer.add;
         for (const sliceId in assignments) {
           if (sliceId.startsWith("_")) {
             continue;
           }
-          const ingredientHash = assignments[sliceId];
-          if (!ingredientsTable._data[ingredientHash]) {
+          const componentHash = assignments[sliceId];
+          if (!componentsTable._data[componentHash]) {
             brokenAssignments.push({
               layersTable: tableKey,
               brokenLayer: layer._hash,
-              referencedIngredientTable: ingredientTableKey,
+              referencedComponentTable: componentTableKey,
               brokenAssignment: sliceId,
-              missingIngredient: ingredientHash
+              missingComponent: componentHash
             });
           }
         }
       }
     });
-    if (missingIngredientTables.length > 0) {
-      this.errors.layerIngredientTablesNotFound = {
-        error: "Layer ingredient tables do not exist",
-        layers: missingIngredientTables
+    if (missingComponentTables.length > 0) {
+      this.errors.layerComponentTablesNotFound = {
+        error: "Layer component tables do not exist",
+        layers: missingComponentTables
       };
     }
     if (brokenAssignments.length > 0) {
-      this.errors.layerIngredientAssignmentsNotFound = {
-        error: "Layer ingredient assignments are broken",
+      this.errors.layerComponentAssignmentsNotFound = {
+        error: "Layer component assignments are broken",
         brokenAssignments
       };
     }
@@ -1285,7 +1305,7 @@ class _BaseValidator {
         const sliceIdsTable = this.rljsonIndexed[layer.sliceIdsTable];
         const sliceIdsRow = sliceIdsTable._data[layer.sliceIdsTableRow];
         const sliceIds = sliceIdsRow.add;
-        const sliceIdsInLayer = Object.keys(layer.assign);
+        const sliceIdsInLayer = Object.keys(layer.add);
         const unassignedSliceIds = [];
         for (const expectedSliceId of sliceIds) {
           if (sliceIdsInLayer.indexOf(expectedSliceId) === -1) {
@@ -1370,27 +1390,25 @@ class _BaseValidator {
       }
       const cakesTable = table;
       for (const cake of cakesTable._data) {
-        const layersTableKey = cake.layersTable;
-        const layersTable = this.rljsonIndexed[layersTableKey];
-        if (!layersTable) {
-          missingLayerTables.push({
-            cakeTable: tableKey,
-            brokenCake: cake._hash,
-            missingLayersTable: layersTableKey
-          });
-          continue;
-        }
-        for (const layerKey in cake.layers) {
-          if (layerKey.startsWith("_")) {
+        for (const layersTableKey in cake.layers) {
+          if (layersTableKey.startsWith("_")) {
+            continue;
+          }
+          const layersTable = this.rljsonIndexed[layersTableKey];
+          if (!layersTable) {
+            missingLayerTables.push({
+              cakeTable: tableKey,
+              brokenCake: cake._hash,
+              missingLayersTable: layersTableKey
+            });
             continue;
           }
-          const layerRef = cake.layers[layerKey];
+          const layerRef = cake.layers[layersTableKey];
           const layer = layersTable._data[layerRef];
           if (!layer) {
             missingCakeLayers.push({
               cakeTable: tableKey,
               brokenCake: cake._hash,
-              brokenLayerName: layerKey,
               layersTable: layersTableKey,
               missingLayer: layerRef
             });
@@ -1457,7 +1475,6 @@ class _BaseValidator {
       };
     }
   }
-  /* v8 ignore end */
 }
 const isValidFieldName = (fieldName) => BaseValidator.isValidFieldName(fieldName);
 // @license
@@ -1506,7 +1523,7 @@ export {
   contentTypes,
   exampleBuffetsTable,
   exampleCakesTable,
-  exampleIngredientsTable,
+  exampleComponentsTable,
   exampleLayersTable,
   exampleRevision,
   exampleRljson,
@@ -1519,7 +1536,6 @@ export {
   iterateTablesSync,
   reservedFieldNames,
   reservedTableKeys,
-  rljsonIndexed,
   throwOnInvalidTableCfg,
   validateRljsonAgainstTableCfg
 };