@rljson/rljson 0.0.12 → 0.0.15

package/dist/src/example.ts

@@ -4,147 +4,395 @@
 // Use of this source code is governed by terms that can be
 // found in the LICENSE file in the root of this package.
 
+import { hip } from '@rljson/hash';
 import { exampleJsonObject } from '@rljson/json';
 
-import { BuffetsTable } from './content/buffet.ts';
+import { TablesCfgTable } from './content/table-cfg.ts';
+import { bakeryExample } from './example/bakery-example.ts';
 import { Rljson } from './rljson.ts';
 
-/**
- * Provides Rljson examples
- */
 export class Example {
-  /**
-   * Returns the Rljson bakery example
-   */
-  static bakery(): Rljson {
-    return {
-      // A bakery is a collection of buffets
-      bakery: {
-        name: 'Bakery',
-        _type: 'buffets',
+  static readonly ok = {
+    bakery: (): Rljson => bakeryExample(),
+
+    empty: (): Rljson => {
+      return {};
+    },
+
+    binary: (): Rljson => {
+      return {
+        table: {
+          _type: 'properties',
+          _data: [
+            { a: false, b: false },
+            { a: false, b: true },
+            { a: true, b: false },
+            { a: true, b: true },
+          ],
+        },
+      };
+    },
+
+    singleRow: (): Rljson => {
+      const tableCfgs: TablesCfgTable = {
+        _hash: '',
+        _type: 'properties',
         _data: [
-          // Counter
           {
-            id: 'counter',
-            items: [
-              // Angle pie
-              {
-                table: 'cakes',
-                ref: 'ap',
+            _hash: 'R-rCQ4YwYYJAp6uAo6S_6n',
+            name: 'Single Row Table',
+            jsonKey: 'table',
+            columns: {
+              int: {
+                jsonKey: 'int',
+                type: 'number',
+                name: 'Integer',
+                nameShort: 'Int',
+              },
+              double: {
+                jsonKey: 'double',
+                type: 'number',
+                name: 'Double',
+                nameShort: 'Dbl',
+              },
+              string: {
+                jsonKey: 'string',
+                type: 'string',
+                name: 'String',
+                nameShort: 'Str',
+              },
+              boolean: {
+                jsonKey: 'boolean',
+                type: 'boolean',
+                name: 'Boolean',
+                nameShort: 'Bool',
+              },
+              null: {
+                jsonKey: 'null',
+                type: 'null',
+                name: 'null',
+                nameShort: 'null',
+              },
+              jsonArray: {
+                jsonKey: 'jsonArray',
+                type: 'jsonArray',
+                name: 'Json Array',
+                nameShort: 'Jarray',
+              },
+              json: {
+                jsonKey: 'json',
+                type: 'json',
+                name: 'Json',
+                nameShort: 'Json',
+              },
+              jsonValue: {
+                jsonKey: 'jsonValue',
+                type: 'jsonValue',
+                name: 'Json Value',
+                nameShort: 'Jval',
+              },
+            },
+          },
+        ],
+      };
+
+      const result: Rljson = {
+        _tableCfgs: tableCfgs,
+        table: {
+          _type: 'properties',
+          _tableCfg: 'R-rCQ4YwYYJAp6uAo6S_6n',
+          _data: [exampleJsonObject()],
+          _hash: '',
+        },
+      };
+      return result as Rljson;
+    },
+
+    multipleRows: (): Rljson => {
+      return {
+        table: {
+          _type: 'properties',
+          _data: [
+            {
+              string: 'str0',
+              boolean: true,
+              number: 1,
+              array: [1, 'str0', true, { a: { b: 'c' } }],
+              object: { a: { b: 'c' } },
+            },
+
+            {
+              string: 'str1',
+              boolean: true,
+              number: 1,
+              array: [1, 'str1', true, { a: { b: 'c' } }],
+              object: { a: { b: 'c' } },
+            },
+
+            {
+              string: 'str2',
+              boolean: false,
+              number: 1,
+              array: [1, 'str1', true, { a: { b: 'c' } }],
+              object: { d: { e: 'f' } },
+            },
+          ],
+        },
+      };
+    },
+
+    singleRef: (): Rljson => {
+      return {
+        tableA: {
+          _type: 'properties',
+          _data: [
+            {
+              keyA0: 'a0',
+            },
+            {
+              keyA1: 'a1',
+            },
+          ],
+        },
+        tableB: {
+          _type: 'properties',
+          _data: [
+            {
+              tableARef: 'KFQrf4mEz0UPmUaFHwH4T6',
+            },
+          ],
+        },
+      };
+    },
+    complete: (): Rljson => {
+      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-',
+                },
+              ],
+            },
+          ],
+        },
+      };
+    },
+  };
+
+  static readonly broken = {
+    base: {
+      brokenTableName: () => {
+        return {
+          brok$en: {
+            _type: 'properties',
+            _data: [],
+          },
+        };
+      },
 
-              // Cumb cake
+      missingData: () => {
+        return {
+          table: {
+            _type: 'properties',
+          },
+        } as unknown as Rljson;
+      },
+
+      dataNotBeingAnArray: () => {
+        return {
+          table: {
+            _type: 'properties',
+            _data: {},
+          },
+        } as unknown as Rljson;
+      },
+
+      missingRef: (): Rljson => {
+        return {
+          tableA: {
+            _type: 'properties',
+            _data: [
+              {
+                keyA0: 'a0',
+              },
               {
-                table: 'cakes',
-                ref: 'cc',
+                keyA1: 'a1',
               },
             ],
           },
-
-          // Fridge
-          {
-            id: 'fridge',
-            items: [
-              // Black forest
+          tableB: {
+            _type: 'properties',
+            _data: [
               {
-                table: 'cakes',
-                ref: 'bf',
+                tableARef: 'MISSINGREF', // MISSINGREF does not exist in tableA
               },
+            ],
+          },
+        };
+      },
 
-              // Lemon cheese cake
+      missingReferencedTable: (): Rljson => {
+        return {
+          tableB: {
+            _type: 'properties',
+            _data: [
               {
-                table: 'cakes',
-                ref: 'cc',
+                tableARef: 'MISSINGREF', // tableA is missing
               },
             ],
           },
-        ],
-      } as BuffetsTable,
-    };
-  }
-
-  /**
-   * Returns an Rljson object with one row containing all JSON types
-   */
-  static withAllJsonTypes(): Rljson {
-    return {
-      table: {
-        _type: 'properties',
-        _data: [exampleJsonObject()],
+        };
       },
-    };
-  }
-
-  /**
-   * Returns an empty Rljson object
-   */
-  static empty(): Rljson {
-    return {};
-  }
-
-  /**
-   * Returns an Rljson with a table containing all combinations of true and
-   * false. This is useful for testing search operators.
-   */
-  static binary(): Rljson {
-    return {
-      table: {
-        _type: 'properties',
-        _data: [
-          { a: false, b: false },
-          { a: false, b: true },
-          { a: true, b: false },
-          { a: true, b: true },
-        ],
+    },
+
+    tableCfg: {
+      wrongType: () => {
+        const result = Example.ok.singleRow();
+        const tableCfg = result._tableCfgs._data[0];
+        tableCfg.columns['int'].type = 'numberBroken'; // Break one of the types
+        return hip(result, true, false);
       },
-    };
-  }
-
-  /**
-   * An more complex example containing an table with multiple rows
-   */
-  static multiRow(): Rljson {
-    return {
-      table: {
-        _type: 'properties',
-        _data: [
-          {
-            string: 'str0',
-            boolean: true,
-            number: 1,
-            array: [1, 'str0', true, { a: { b: 'c' } }],
-            object: { a: { b: 'c' } },
-          },
+    },
 
-          {
-            string: 'str1',
-            boolean: true,
-            number: 1,
-            array: [1, 'str1', true, { a: { b: 'c' } }],
-            object: { a: { b: 'c' } },
-          },
+    collections: {
+      missingBase: (): Rljson => {
+        const result = Example.ok.complete();
+        const collection1 = result.collections._data[1];
+        collection1.base = 'MISSING'; // Missing base
 
-          {
-            string: 'str2',
-            boolean: false,
-            number: 1,
-            array: [1, 'str1', true, { a: { b: 'c' } }],
-            object: { d: { e: 'f' } },
-          },
-        ],
+        // Recalculate hashes
+        return hip(result, true, false);
       },
-    };
-  }
-
-  /**
-   * Returns an Rljson object with a broken table name
-   */
-  static withBrokenTableName(): Rljson {
-    return {
-      brok$en: {
-        _type: 'properties',
-        _data: [],
+
+      missingIdSet: (): Rljson => {
+        const result = Example.ok.complete();
+        const collection1 = result.collections._data[1];
+
+        collection1.idSet = 'MISSING1';
+
+        // Recalculate hashes
+        return hip(result, true, false);
+      },
+
+      missingAssignedPropertyTable: (): Rljson => {
+        const result = Example.ok.complete();
+        delete result.properties; // Remove properties table
+        return result;
+      },
+
+      missingAssignedProperty: (): Rljson => {
+        const result = Example.ok.complete();
+        result.properties._data.splice(1, 2); // Remove an property that is assigne
+        return result;
+      },
+    },
+
+    cakes: {
+      missingIdSet: (): Rljson => {
+        const result = Example.ok.complete();
+        result.cakes._data[0].idSet = 'MISSING'; // Missing ID set
+        hip(result.cakes, true, false);
+        return result;
+      },
+
+      missingCollectionsTable: (): Rljson => {
+        const result = Example.ok.complete();
+        result.cakes._data[0].collections = 'MISSING'; // Missing collections table
+        hip(result.cakes, true, false);
+        return result;
+      },
+
+      missingLayerCollection: (): Rljson => {
+        const result = Example.ok.complete();
+        result.cakes._data[0].layers['layer0'] = 'MISSING0';
+        result.cakes._data[0].layers['layer1'] = 'MISSING1';
+        hip(result.cakes, true, false);
+        return result;
+      },
+    },
+
+    buffets: {
+      missingTable: (): Rljson => {
+        const result = Example.ok.complete();
+        const buffet = result.buffets._data[0];
+        buffet.items[0].table = 'MISSING0';
+        buffet.items[1].table = 'MISSING1';
+        hip(buffet, true, false);
+        return result;
+      },
+
+      missingItems: (): Rljson => {
+        const result = Example.ok.complete();
+        const buffet = result.buffets._data[0];
+        buffet.items[0].ref = 'MISSING0';
+        buffet.items[1].ref = 'MISSING1';
+        hip(buffet, true, false);
+        return result;
       },
-    };
-  }
+    },
+  };
 }

package/dist/typedefs.d.ts

@@ -22,7 +22,10 @@ export type TableName = ItemId;
  * - `properties` Tables containing item properties
  */
 export type ContentType = 'buffets' | 'cakes' | 'collections' | 'idSets' | 'properties';
-export declare const exampleTypedefs: {
+/**
+ * An example object using the typedefs
+ */
+export declare const exampleTypedefs: () => {
     ref: Ref;
     itemId: ItemId;
     tableName: TableName;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.12",
-  "packageManager": "pnpm@10.6.2",
+  "version": "0.0.15",
+  "packageManager": "pnpm@10.6.3",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
   "bugs": "https://github.com/rljson/rljson/issues",
@@ -32,10 +32,10 @@
     "@types/node": "^22.13.10",
     "@typescript-eslint/eslint-plugin": "^8.26.1",
     "@typescript-eslint/parser": "^8.26.1",
-    "@vitest/coverage-v8": "^3.0.8",
+    "@vitest/coverage-v8": "^3.0.9",
     "cross-env": "^7.0.3",
     "eslint": "^9.22.0",
-    "eslint-plugin-jsdoc": "^50.6.6",
+    "eslint-plugin-jsdoc": "^50.6.8",
     "eslint-plugin-tsdoc": "^0.4.0",
     "globals": "^16.0.0",
     "jsdoc": "^4.0.4",
@@ -43,15 +43,15 @@
     "typescript": "~5.8.2",
     "typescript-eslint": "^8.26.1",
     "vite": "^6.2.2",
-    "vite-node": "^3.0.8",
+    "vite-node": "^3.0.9",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.0.8",
+    "vitest": "^3.0.9",
     "vitest-dom": "^0.1.1"
   },
   "dependencies": {
-    "@rljson/hash": "^0.0.11",
-    "@rljson/json": "^0.0.13"
+    "@rljson/hash": "^0.0.12",
+    "@rljson/json": "^0.0.18"
   },
   "pnpm": {
     "onlyBuiltDependencies": [