@rljson/rljson 0.0.21 → 0.0.23

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

@@ -1,6 +1,6 @@
 import { Json, JsonKey, JsonValueType } from '@rljson/json';
 import { RljsonTable } from '../rljson.ts';
-import { Ref } from '../typedefs.ts';
+import { ContentType, Ref } from '../typedefs.ts';
 /**
  * A ColumnsRef is a hash pointing to columns metadata
  */
@@ -13,14 +13,6 @@ export interface ColumnCfg extends Json {
      * The jsonKey of the column used in data
      */
     jsonKey: JsonKey;
-    /**
-     * Average number of characters in the column
-     */
-    avgChars?: number;
-    /**
-     * Maximum number of characters in the column
-     */
-    maxChars?: number;
     /**
      * The type of the column
      */
@@ -38,6 +30,10 @@ export interface TableCfg extends Json {
      * A short description of the table
      */
     columns: Record<JsonKey, ColumnCfg>;
+    /**
+     * The content type of the table
+     */
+    type: ContentType;
 }
 /**
  * A table containing columns

package/dist/rljson.js

@@ -157,72 +157,56 @@ __publicField(_Example, "ok", {
     };
   },
   singleRow: () => {
-    const tableCfgs = {
+    const tableCfgs = hip({
       _hash: "",
       _type: "properties",
       _data: [
         {
-          _hash: "R-rCQ4YwYYJAp6uAo6S_6n",
-          name: "Single Row Table",
+          _hash: "",
           jsonKey: "table",
+          type: "properties",
           columns: {
             int: {
               jsonKey: "int",
-              type: "number",
-              name: "Integer",
-              nameShort: "Int"
+              type: "number"
             },
             double: {
               jsonKey: "double",
-              type: "number",
-              name: "Double",
-              nameShort: "Dbl"
+              type: "number"
             },
             string: {
               jsonKey: "string",
-              type: "string",
-              name: "String",
-              nameShort: "Str"
+              type: "string"
             },
             boolean: {
               jsonKey: "boolean",
-              type: "boolean",
-              name: "Boolean",
-              nameShort: "Bool"
+              type: "boolean"
             },
             null: {
               jsonKey: "null",
-              type: "null",
-              name: "null",
-              nameShort: "null"
+              type: "null"
             },
             jsonArray: {
               jsonKey: "jsonArray",
-              type: "jsonArray",
-              name: "Json Array",
-              nameShort: "Jarray"
+              type: "jsonArray"
             },
             json: {
               jsonKey: "json",
-              type: "json",
-              name: "Json",
-              nameShort: "Json"
+              type: "json"
             },
             jsonValue: {
               jsonKey: "jsonValue",
-              type: "jsonValue",
-              name: "Json Value",
-              nameShort: "Jval"
+              type: "jsonValue"
             }
           }
         }
       ]
-    };
+    });
     const result = {
       tableCfgs,
       table: {
         _type: "properties",
-        _tableCfg: "R-rCQ4YwYYJAp6uAo6S_6n",
+        _tableCfg: tableCfgs._data[0]._hash,
         _data: [exampleJsonObject()],
         _hash: ""
       }
@@ -518,7 +502,7 @@ const rljsonIndexed = (rljson) => {
 };
 // @license
 const reservedFieldNames = ["_type", "_data"];
-const reservedTableNames = ["_hash", "_tables", "_columns"];
+const reservedTableNames = ["_hash", "idSets", "tableCfgs"];
 const exampleRljson = () => Example.ok.singleRow();
 const iterateTables = (rljson, callback) => {
   for (const tableName in rljson) {
@@ -530,6 +514,13 @@ const iterateTables = (rljson, callback) => {
   }
 };
 // @license
+const contentTypes = [
+  "buffets",
+  "cakes",
+  "collections",
+  "idSets",
+  "properties"
+];
 const exampleTypedefs = () => {
   return {
     ref: "ref",
@@ -579,12 +570,14 @@ class _BaseValidator {
       () => this._columnNamesNotLowerCamelCase(),
       () => this._dataNotFound(),
       () => this._dataHasWrongType(),
+      () => this._invalidTableTypes(),
       // Check table cfg
-      () => this.tableCfgsReferencedTableNameNotFound(),
-      () => this.tableCfgsHaveWrongType(),
+      () => this._tableCfgsReferencedTableNameNotFound(),
+      () => this._tableCfgsHaveWrongType(),
       () => this._tableCfgNotFound(),
       () => this._missingColumnConfigs(),
       () => this._dataDoesNotMatchColumnConfig(),
+      () => this._tableTypesDoNotMatch(),
       // Check references
       () => this._refsNotFound(),
       // Check collections
@@ -704,7 +697,7 @@ class _BaseValidator {
     }
   }
   // ...........................................................................
-  tableCfgsReferencedTableNameNotFound() {
+  _tableCfgsReferencedTableNameNotFound() {
     const tableCfgs = this.rljson.tableCfgs;
     if (!tableCfgs) {
       return;
@@ -727,7 +720,7 @@ class _BaseValidator {
     }
   }
   // ...........................................................................
-  tableCfgsHaveWrongType() {
+  _tableCfgsHaveWrongType() {
     const tableCfgs = this.rljson.tableCfgs;
     if (!tableCfgs) {
       return;
@@ -749,7 +742,7 @@ class _BaseValidator {
       }
     }
     if (brokenCfgs.length > 0) {
-      this.errors.tableCfgsHaveWrongTypes = {
+      this.errors.columnsHaveWrongType = {
         error: "Some of the columns have invalid types. Valid types are: " + jsonValueTypes.join(", "),
         brokenCfgs
       };
@@ -860,6 +853,35 @@ class _BaseValidator {
     }
   }
   // ...........................................................................
+  _tableTypesDoNotMatch() {
+    const rljson = this.rljson;
+    const tablesWithTypeMissmatch = [];
+    for (const tableName of this.tableNames) {
+      const table = rljson[tableName];
+      const cfgRef = table._tableCfg;
+      if (!cfgRef) {
+        continue;
+      }
+      const cfg = this.rljsonIndexed.tableCfgs._data[cfgRef];
+      const typeShould = cfg.type;
+      const typeIs = table._type;
+      if (typeShould !== typeIs) {
+        tablesWithTypeMissmatch.push({
+          table: tableName,
+          typeInTable: typeIs,
+          typeInConfig: typeShould,
+          tableCfg: cfgRef
+        });
+      }
+    }
+    if (tablesWithTypeMissmatch.length > 0) {
+      this.errors.tableTypesDoNotMatch = {
+        error: "Table types do not match table config",
+        tables: tablesWithTypeMissmatch
+      };
+    }
+  }
+  // ...........................................................................
   _dataHasWrongType() {
     const rljson = this.rljson;
     const tablesWithWrongType = [];
@@ -877,6 +899,28 @@ class _BaseValidator {
       };
     }
   }
+  // ...........................................................................
+  _invalidTableTypes() {
+    const rljson = this.rljson;
+    const tablesWithWrongType = [];
+    for (const tableName of this.tableNames) {
+      const table = rljson[tableName];
+      const type = table._type;
+      if (contentTypes.indexOf(type) === -1) {
+        tablesWithWrongType.push({
+          table: tableName,
+          type,
+          allowedTypes: contentTypes.join(" | ")
+        });
+      }
+    }
+    if (tablesWithWrongType.length > 0) {
+      this.errors.invalidTableTypes = {
+        error: "Tables with invalid types",
+        tables: tablesWithWrongType
+      };
+    }
+  }
   _refsNotFound() {
     const missingRefs = [];
     iterateTables(this.rljson, (tableName, table) => {
@@ -1201,6 +1245,7 @@ export {
   Example,
   Validate,
   bakeryExample,
+  contentTypes,
   exampleBuffetsTable,
   exampleCakesTable,
   exampleCollectionsTable,

package/dist/src/example.ts

@@ -11,6 +11,7 @@ import { TablesCfgTable } from './content/table-cfg.ts';
 import { bakeryExample } from './example/bakery-example.ts';
 import { Rljson } from './rljson.ts';
 
+
 export class Example {
   static readonly ok = {
     bakery: (): Rljson => bakeryExample(),
@@ -34,73 +35,57 @@ export class Example {
     },
 
     singleRow: (): Rljson => {
-      const tableCfgs: TablesCfgTable = {
+      const tableCfgs: TablesCfgTable = hip({
         _hash: '',
         _type: 'properties',
         _data: [
           {
-            _hash: 'R-rCQ4YwYYJAp6uAo6S_6n',
-            name: 'Single Row Table',
+            _hash: '',
             jsonKey: 'table',
+            type: 'properties',
             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',
+          _tableCfg: tableCfgs._data[0]._hash as string,
           _data: [exampleJsonObject()],
           _hash: '',
         },

package/dist/typedefs.d.ts

@@ -21,7 +21,8 @@ export type TableName = ItemId;
  * - `ids` Tables containing item ids
  * - `properties` Tables containing item properties
  */
-export type ContentType = 'buffets' | 'cakes' | 'collections' | 'idSets' | 'properties';
+export declare const contentTypes: readonly ["buffets", "cakes", "collections", "idSets", "properties"];
+export type ContentType = (typeof contentTypes)[number];
 /**
  * An example object using the typedefs
  */

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

@@ -9,11 +9,13 @@ export interface BaseErrors extends Errors {
     hashesNotValid?: Json;
     dataNotFound?: Json;
     dataHasWrongType?: Json;
+    invalidTableTypes?: Json;
     tableCfgsReferencedTableNameNotFound?: Json;
-    tableCfgsHaveWrongTypes?: Json;
+    columnsHaveWrongType?: Json;
     tableCfgReferencedNotFound?: Json;
     columnConfigNotFound?: Json;
     dataDoesNotMatchColumnConfig?: Json;
+    tableTypesDoNotMatch?: Json;
     refsNotFound?: Json;
     collectionBasesNotFound?: Json;
     collectionIdSetsNotFound?: Json;

package/package.json

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