@rljson/rljson 0.0.28 → 0.0.30

package/README.architecture.md

@@ -221,7 +221,7 @@ properties:
 
 ```json
 {
-  "idSetsTable": "personIds",
+  "idSets": "personIds",
   "idSet": "IDS0",
   "properties": "addresses",
   "assign": {

package/dist/README.architecture.md

@@ -221,7 +221,7 @@ properties:
 
 ```json
 {
-  "idSetsTable": "personIds",
+  "idSets": "personIds",
   "idSet": "IDS0",
   "properties": "addresses",
   "assign": {

package/dist/content/cake.d.ts

@@ -19,6 +19,10 @@ export interface Cake extends Json {
      * must match these ids. The item id sets can be found in the idSets table.
      */
     idSet?: IdSetRef;
+    /**
+     * The table containing the item ids of the collection
+     */
+    idSetsTable?: TableKey;
     /**
      * The table containing the item collections defining the layers
      */

package/dist/content/collection.d.ts

@@ -16,10 +16,14 @@ export interface Collection extends Json {
      */
     base?: CollectionRef;
     /**
-     * The item ids of the collection. If presnet, the item ids in `assign`
+     * The item ids of the collection. If present, the item ids in `assign`
      * must match these ids. The item id sets can be found in the idSets table.
      */
     idSet?: IdSetRef;
+    /**
+     * The table containing the item ids of the collection
+     */
+    idSetsTable?: TableKey;
     /**
      * The table containing the properties that are assigned to the items
      * with the assign property below

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

@@ -38,6 +38,11 @@ export interface TableCfg extends Json {
      * The previous version of the table
      */
     previous?: TableCfgRef;
+    /**
+     * The version of the table.
+     * Needs to be increased when new columns are added.
+     */
+    version: number;
 }
 /**
  * A table containing columns

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

@@ -1,8 +1,8 @@
 import { Json } from '@rljson/json';
+import { IdSetsTable } from '../../dist/content/id-set.ts';
 import { BuffetsTable } from '../content/buffet.ts';
 import { CakesTable } from '../content/cake.ts';
 import { CollectionsTable } from '../content/collection.ts';
-import { IdSetsTable } from '../content/id-set.ts';
 import { PropertiesTable } from '../content/properties.ts';
 import { Rljson } from '../rljson.ts';
 import { Ref } from '../typedefs.ts';

package/dist/rljson.js

@@ -76,21 +76,12 @@ const bakeryExample = () => {
     ],
     _hash: ""
   });
-  const idSets = hip({
-    _type: "idSets",
-    _data: [
-      {
-        add: ["slice0", "slice1"],
-        _hash: ""
-      }
-    ],
-    _hash: ""
-  });
   const cakes = hip({
     _type: "cakes",
     _data: [
       {
-        idSet: idSets._data[0]._hash,
+        idSetsTable: "slices",
+        idSet: slices._data[0]._hash,
         collections: "layers",
         layers: {
           flour: layers._data[0]._hash
@@ -113,7 +104,6 @@ const bakeryExample = () => {
     ]
   });
   const result = {
-    idSets,
     buffets,
     cakes,
     slices,
@@ -162,6 +152,7 @@ __publicField(_Example, "ok", {
       _type: "properties",
       _data: [
         {
+          version: 0,
           _hash: "",
           key: "table",
           type: "properties",
@@ -267,75 +258,76 @@ __publicField(_Example, "ok", {
     };
   },
   complete: () => {
-    return {
-      idSets: {
-        _type: "idSets",
-        _data: [
-          {
-            add: ["id0", "id1"],
-            _hash: "MgHRBYSrhpyl4rvsOmAWcQ"
-          }
-        ]
-      },
-      properties: {
-        _type: "properties",
-        _data: [
-          { a: "0", _hash: "AFhW-fMzdCiz6bUZscp1Lf" },
-          { a: "1", _hash: "mv6w8rID8lQxLsje1EHQMY" }
-        ]
-      },
-      collections: {
-        _type: "collections",
-        _data: [
-          {
-            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
-            properties: "properties",
-            _hash: "sxv2NCM6UNOcX-i9FhOs5W",
-            assign: {}
-          },
-          {
-            base: "sxv2NCM6UNOcX-i9FhOs5W",
-            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
-            properties: "properties",
-            assign: {
-              id0: "AFhW-fMzdCiz6bUZscp1Lf",
-              id1: "mv6w8rID8lQxLsje1EHQMY"
-            },
-            _hash: "QB2JC6X_-rUAoixuldzWP-"
-          }
-        ]
-      },
-      cakes: {
-        _type: "cakes",
-        _data: [
-          {
-            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
-            collections: "collections",
-            layers: {
-              layer0: "sxv2NCM6UNOcX-i9FhOs5W",
-              layer1: "QB2JC6X_-rUAoixuldzWP-"
-            },
-            _hash: "QlTVJL3uoXO1L_fw2evLPe"
-          }
-        ]
-      },
-      buffets: {
-        _type: "buffets",
-        _data: [
-          {
-            items: [
-              {
-                table: "cakes",
-                ref: "QlTVJL3uoXO1L_fw2evLPe"
-              },
-              {
-                table: "collections",
-                ref: "QB2JC6X_-rUAoixuldzWP-"
-              }
-            ]
-          }
-        ]
+    const idSets = hip({
+      _type: "idSets",
+      _data: [
+        {
+          add: ["id0", "id1"]
+        }
+      ]
+    });
+    const properties = hip({
+      _type: "properties",
+      _data: [{ a: "0" }, { a: "1" }]
+    });
+    const property0 = properties._data[0];
+    const property1 = properties._data[1];
+    const collection0 = hip({
+      idSetsTable: "idSets",
+      idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
+      properties: "properties",
+      assign: {}
+    });
+    const collection1 = hip({
+      base: collection0._hash,
+      idSetsTable: "idSets",
+      idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
+      properties: "properties",
+      assign: {
+        id0: property0._hash,
+        id1: property1._hash
       }
+    });
+    const collections = hip({
+      _type: "collections",
+      _data: [collection0, collection1]
+    });
+    const cake = hip({
+      idSetsTable: "idSets",
+      idSet: idSets._data[0]._hash,
+      collections: "collections",
+      layers: {
+        layer0: collection0._hash,
+        layer1: collection1._hash
+      }
+    });
+    const cakes = hip({
+      _type: "cakes",
+      _data: [cake]
+    });
+    const buffets = hip({
+      _type: "buffets",
+      _data: [
+        {
+          items: [
+            {
+              table: "cakes",
+              ref: cakes._data[0]._hash
+            },
+            {
+              table: "collections",
+              ref: collection0._hash
+            }
+          ]
+        }
+      ]
+    });
+    return {
+      idSets,
+      properties,
+      collections,
+      cakes,
+      buffets
     };
   }
 });
@@ -431,7 +423,7 @@ __publicField(_Example, "broken", {
     missingAssignedProperty: () => {
       const result = _Example.ok.complete();
       result.properties._data.splice(1, 2);
-      return result;
+      return hip(result, true, false);
     }
   },
   cakes: {
@@ -461,7 +453,7 @@ __publicField(_Example, "broken", {
       const buffet = result.buffets._data[0];
       buffet.items[0].table = "MISSING0";
       buffet.items[1].table = "MISSING1";
-      hip(buffet, true, false);
+      hip(result, true, false);
       return result;
     },
     missingItems: () => {
@@ -469,7 +461,7 @@ __publicField(_Example, "broken", {
       const buffet = result.buffets._data[0];
       buffet.items[0].ref = "MISSING0";
       buffet.items[1].ref = "MISSING1";
-      hip(buffet, true, false);
+      hip(result, true, false);
       return result;
     }
   }
@@ -480,6 +472,7 @@ const exampleTableCfgTable = () => Example.ok.singleRow().tableCfgs;
 const exampleTableCfg = (tableCfg = void 0) => {
   return {
     key: (tableCfg == null ? void 0 : tableCfg.key) ?? "table",
+    version: 1,
     columns: (tableCfg == null ? void 0 : tableCfg.columns) ?? {
       a: {
         key: "a",
@@ -598,10 +591,12 @@ class _BaseValidator {
       () => this._refsNotFound(),
       // Check collections
       () => this._collectionBasesNotFound(),
-      () => this._collectionIdSetsExist(),
+      () => this._collectionIdSetsTableNotFound(),
+      () => this._collectionIdSetNotFound(),
       () => this._collectionPropertyAssignmentsNotFound(),
       // Check cakes
-      () => this._cakeIdSetsNotFound(),
+      () => this._cakeIdSetsTableNotFound(),
+      () => this._cakeIdSetNotFound(),
       () => this._cakeCollectionTablesNotFound(),
       // Check buffets
       () => this._buffetReferencedTableNotFound()
@@ -1011,20 +1006,50 @@ class _BaseValidator {
       };
     }
   }
-  _collectionIdSetsExist() {
+  _collectionIdSetsTableNotFound() {
+    const brokenCollections = [];
+    iterateTables(this.rljson, (tableKey, table) => {
+      if (table._type !== "collections") {
+        return;
+      }
+      const collectionsTable = table;
+      for (const collection of collectionsTable._data) {
+        const idSets = collection.idSetsTable;
+        if (!idSets) {
+          continue;
+        }
+        const idSetsTable = this.rljsonIndexed[idSets];
+        if (!idSetsTable) {
+          brokenCollections.push({
+            collectionsTable: tableKey,
+            collectionHash: collection._hash,
+            missingIdSetsTable: idSets
+          });
+        }
+      }
+    });
+    if (brokenCollections.length > 0) {
+      this.errors.collectionIdSetsTableNotFound = {
+        error: "Id sets tables are missing",
+        brokenCollections
+      };
+    }
+  }
+  _collectionIdSetNotFound() {
     const brokenCollections = [];
     iterateTables(this.rljson, (tableKey, table) => {
       if (table._type !== "collections") {
         return;
       }
-      const idSets = this.rljsonIndexed.idSets;
       const collectionsTable = table;
       for (const collection of collectionsTable._data) {
         const idSetRef = collection.idSet;
         if (!idSetRef) {
           continue;
         }
-        const idSet = idSets._data[idSetRef];
+        const idSets = collection.idSetsTable;
+        const idSetsTable = this.rljsonIndexed[idSets];
+        const idSet = idSetsTable._data[idSetRef];
         if (!idSet) {
           brokenCollections.push({
             collectionsTable: tableKey,
@@ -1035,7 +1060,7 @@ class _BaseValidator {
       }
     });
     if (brokenCollections.length > 0) {
-      this.errors.collectionIdSetsExist = {
+      this.errors.collectionIdSetNotFound = {
         error: "Id sets of collections are missing",
         brokenCollections
       };
@@ -1091,19 +1116,49 @@ class _BaseValidator {
       };
     }
   }
-  _cakeIdSetsNotFound() {
+  _cakeIdSetsTableNotFound() {
+    const brokenCakes = [];
+    iterateTables(this.rljson, (tableKey, table) => {
+      if (table._type !== "cakes") {
+        return;
+      }
+      const cakesTable = table;
+      for (const cake of cakesTable._data) {
+        const idSetsRef = cake.idSetsTable;
+        if (!idSetsRef) {
+          continue;
+        }
+        const idSets = this.rljsonIndexed[idSetsRef];
+        if (!idSets) {
+          brokenCakes.push({
+            cakeTable: tableKey,
+            brokenCake: cake._hash,
+            missingIdSets: idSetsRef
+          });
+        }
+      }
+    });
+    if (brokenCakes.length > 0) {
+      this.errors.cakeIdSetsTableNotFound = {
+        error: "Id sets tables referenced by cakes are missing",
+        brokenCakes
+      };
+    }
+  }
+  _cakeIdSetNotFound() {
     const brokenCakes = [];
     iterateTables(this.rljson, (tableKey, table) => {
       if (table._type !== "cakes") {
         return;
       }
-      const idSets = this.rljsonIndexed.idSets;
       const cakesTable = table;
       for (const cake of cakesTable._data) {
         const idSetRef = cake.idSet;
         if (!idSetRef) {
           continue;
         }
+        const idSetsRef = cake.idSetsTable;
+        const idSets = this.rljsonIndexed[idSetsRef];
         const idSet = idSets._data[idSetRef];
         if (!idSet) {
           brokenCakes.push({
@@ -1115,7 +1170,7 @@ class _BaseValidator {
       }
     });
     if (brokenCakes.length > 0) {
-      this.errors.cakeIdSetsNotFound = {
+      this.errors.cakeIdSetNotFound = {
         error: "Id sets of cakes are missing",
         brokenCakes
       };

package/dist/src/example.ts

@@ -7,6 +7,11 @@
 import { hip } from '@rljson/hash';
 import { exampleJsonObject } from '@rljson/json';
 
+import { BuffetsTable } from './content/buffet.ts';
+import { Cake, CakesTable } from './content/cake.ts';
+import { Collection, CollectionsTable } from './content/collection.ts';
+import { IdSetsTable } from './content/id-set.ts';
+import { PropertiesTable } from './content/properties.ts';
 import { TablesCfgTable } from './content/table-cfg.ts';
 import { bakeryExample } from './example/bakery-example.ts';
 import { Rljson } from './rljson.ts';
@@ -36,9 +41,11 @@ export class Example {
     singleRow: (): Rljson => {
       const tableCfgs: TablesCfgTable = hip({
         _hash: '',
+
         _type: 'properties',
         _data: [
           {
+            version: 0,
             _hash: '',
             key: 'table',
             type: 'properties',
@@ -149,80 +156,84 @@ export class Example {
       };
     },
     complete: (): Rljson => {
-      return {
-        idSets: {
-          _type: 'idSets',
+      const idSets: IdSetsTable = hip({
+        _type: 'idSets',
+        _data: [
+          {
+            add: ['id0', 'id1'],
+          },
+        ],
+      });
 
-          _data: [
-            {
-              add: ['id0', 'id1'],
-              _hash: 'MgHRBYSrhpyl4rvsOmAWcQ',
-            },
-          ],
-        },
+      const properties: PropertiesTable<any> = hip({
+        _type: 'properties',
+        _data: [{ a: '0' }, { a: '1' }],
+      });
+      const property0 = properties._data[0];
+      const property1 = properties._data[1];
+
+      const collection0: Collection = hip({
+        idSetsTable: 'idSets',
+        idSet: 'MgHRBYSrhpyl4rvsOmAWcQ',
+        properties: 'properties',
+        assign: {},
+      });
 
-        properties: {
-          _type: 'properties',
-          _data: [
-            { a: '0', _hash: 'AFhW-fMzdCiz6bUZscp1Lf' },
-            { a: '1', _hash: 'mv6w8rID8lQxLsje1EHQMY' },
-          ],
+      const collection1: Collection = hip({
+        base: collection0._hash as string,
+        idSetsTable: 'idSets',
+        idSet: 'MgHRBYSrhpyl4rvsOmAWcQ',
+        properties: 'properties',
+        assign: {
+          id0: property0._hash,
+          id1: property1._hash,
         },
+      });
 
-        collections: {
-          _type: 'collections',
-          _data: [
-            {
-              idSet: 'MgHRBYSrhpyl4rvsOmAWcQ',
-              properties: 'properties',
-              _hash: 'sxv2NCM6UNOcX-i9FhOs5W',
-              assign: {},
-            },
-            {
-              base: 'sxv2NCM6UNOcX-i9FhOs5W',
-              idSet: 'MgHRBYSrhpyl4rvsOmAWcQ',
-              properties: 'properties',
-              assign: {
-                id0: 'AFhW-fMzdCiz6bUZscp1Lf',
-                id1: 'mv6w8rID8lQxLsje1EHQMY',
-              },
-              _hash: 'QB2JC6X_-rUAoixuldzWP-',
-            },
-          ],
+      const collections: CollectionsTable = hip({
+        _type: 'collections',
+        _data: [collection0, collection1],
+      } as CollectionsTable);
+
+      const cake: Cake = hip({
+        idSetsTable: 'idSets',
+        idSet: idSets._data[0]._hash as string,
+        collections: 'collections',
+        layers: {
+          layer0: collection0._hash as string,
+          layer1: collection1._hash as string,
         },
+      });
 
-        cakes: {
-          _type: 'cakes',
-          _data: [
-            {
-              idSet: 'MgHRBYSrhpyl4rvsOmAWcQ',
-              collections: 'collections',
-              layers: {
-                layer0: 'sxv2NCM6UNOcX-i9FhOs5W',
-                layer1: 'QB2JC6X_-rUAoixuldzWP-',
+      const cakes: CakesTable = hip({
+        _type: 'cakes',
+        _data: [cake],
+      });
+
+      const buffets: BuffetsTable = hip({
+        _type: 'buffets',
+        _data: [
+          {
+            items: [
+              {
+                table: 'cakes',
+                ref: cakes._data[0]._hash as string,
               },
-              _hash: 'QlTVJL3uoXO1L_fw2evLPe',
-            },
-          ],
-        },
+              {
+                table: 'collections',
+                ref: collection0._hash as string,
+              },
+            ],
+          },
+        ],
+      });
 
-        buffets: {
-          _type: 'buffets',
-          _data: [
-            {
-              items: [
-                {
-                  table: 'cakes',
-                  ref: 'QlTVJL3uoXO1L_fw2evLPe',
-                },
-                {
-                  table: 'collections',
-                  ref: 'QB2JC6X_-rUAoixuldzWP-',
-                },
-              ],
-            },
-          ],
-        },
+      return {
+        idSets,
+        properties,
+        collections,
+        cakes,
+        buffets,
       };
     },
   };
@@ -330,8 +341,8 @@ export class Example {
 
       missingAssignedProperty: (): Rljson => {
         const result = Example.ok.complete();
-        result.properties._data.splice(1, 2); // Remove an property that is assigne
-        return result;
+        result.properties._data.splice(1, 2); // Remove an property that is assigned
+        return hip(result, true, false);
       },
     },
 
@@ -365,7 +376,7 @@ export class Example {
         const buffet = result.buffets._data[0];
         buffet.items[0].table = 'MISSING0';
         buffet.items[1].table = 'MISSING1';
-        hip(buffet, true, false);
+        hip(result, true, false);
         return result;
       },
 
@@ -374,7 +385,7 @@ export class Example {
         const buffet = result.buffets._data[0];
         buffet.items[0].ref = 'MISSING0';
         buffet.items[1].ref = 'MISSING1';
-        hip(buffet, true, false);
+        hip(result, true, false);
         return result;
       },
     },

package/dist/validate/base-validator.d.ts

@@ -18,10 +18,12 @@ export interface BaseErrors extends Errors {
     tableTypesDoNotMatch?: Json;
     refsNotFound?: Json;
     collectionBasesNotFound?: Json;
-    collectionIdSetsNotFound?: Json;
+    collectionIdSetsTableNotFound?: Json;
+    collectionIdSetNotFound?: Json;
     collectionPropertyTablesNotFound?: Json;
     collectionPropertyAssignmentsNotFound?: Json;
-    cakeIdSetsNotFound?: Json;
+    cakeIdSetsTableNotFound?: Json;
+    cakeIdSetNotFound?: Json;
     cakeCollectionTablesNotFound?: Json;
     cakeLayerCollectionsNotFound?: Json;
     buffetReferencedTablesNotFound?: Json;

package/package.json

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