@rljson/rljson 0.0.12 → 0.0.15

package/dist/example.d.ts

@@ -1,31 +1,44 @@
 import { Rljson } from './rljson.ts';
-/**
- * Provides Rljson examples
- */
 export declare class Example {
-    /**
-     * Returns the Rljson bakery example
-     */
-    static bakery(): Rljson;
-    /**
-     * Returns an Rljson object with one row containing all JSON types
-     */
-    static withAllJsonTypes(): Rljson;
-    /**
-     * Returns an empty Rljson object
-     */
-    static empty(): Rljson;
-    /**
-     * Returns an Rljson with a table containing all combinations of true and
-     * false. This is useful for testing search operators.
-     */
-    static binary(): Rljson;
-    /**
-     * An more complex example containing an table with multiple rows
-     */
-    static multiRow(): Rljson;
-    /**
-     * Returns an Rljson object with a broken table name
-     */
-    static withBrokenTableName(): Rljson;
+    static readonly ok: {
+        bakery: () => Rljson;
+        empty: () => Rljson;
+        binary: () => Rljson;
+        singleRow: () => Rljson;
+        multipleRows: () => Rljson;
+        singleRef: () => Rljson;
+        complete: () => Rljson;
+    };
+    static readonly broken: {
+        base: {
+            brokenTableName: () => {
+                brok$en: {
+                    _type: string;
+                    _data: never[];
+                };
+            };
+            missingData: () => Rljson;
+            dataNotBeingAnArray: () => Rljson;
+            missingRef: () => Rljson;
+            missingReferencedTable: () => Rljson;
+        };
+        tableCfg: {
+            wrongType: () => import('@rljson/hash').Hashed<Rljson>;
+        };
+        collections: {
+            missingBase: () => Rljson;
+            missingIdSet: () => Rljson;
+            missingAssignedPropertyTable: () => Rljson;
+            missingAssignedProperty: () => Rljson;
+        };
+        cakes: {
+            missingIdSet: () => Rljson;
+            missingCollectionsTable: () => Rljson;
+            missingLayerCollection: () => Rljson;
+        };
+        buffets: {
+            missingTable: () => Rljson;
+            missingItems: () => Rljson;
+        };
+    };
 }

package/dist/index.d.ts

@@ -4,5 +4,6 @@ export * from './content/collection.ts';
 export * from './content/id-set.ts';
 export * from './content/properties.ts';
 export * from './example.ts';
+export * from './rljson-indexed.ts';
 export * from './rljson.ts';
 export * from './typedefs.ts';

package/dist/rljson-indexed.d.ts

@@ -0,0 +1,19 @@
+import { Json } from '@rljson/json';
+import { Rljson } from './rljson.ts';
+/**
+ * An Rljson object where all tables' rows are indexed by their hash.
+ */
+export interface RljsonIndexed {
+    [tableName: string]: {
+        _data: {
+            [rowHash: string]: Json;
+        };
+    };
+    [key: `_${string}`]: any;
+}
+/**
+ * Returns an rljson where all tables' rows are indexed by their hash.
+ * @param rljson - The Rljson object to index
+ * @returns The indexed Rljson object
+ */
+export declare const rljsonIndexed: (rljson: Rljson) => RljsonIndexed;

package/dist/rljson.d.ts

@@ -4,7 +4,8 @@ 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 { ContentType, TableName } from './typedefs.ts';
+import { TableCfgRef, TablesCfgTable } from './content/table-cfg.ts';
+import { ContentType, Ref, TableName } from './typedefs.ts';
 export declare const reservedFieldNames: string[];
 export declare const reservedTableNames: string[];
 /**
@@ -12,8 +13,33 @@ export declare const reservedTableNames: string[];
  */
 export type TableType = BuffetsTable | PropertiesTable<any> | CollectionsTable | IdSetsTable | CakesTable;
 /** The rljson data format */
-export type Rljson = {
+export interface Rljson extends Json {
     [tableId: TableName]: TableType;
+}
+/**
+ * Rljson set with private fields
+ */
+export type RljsonPrivate = {
+    /**
+     * The hash of the Rljson object
+     */
+    _hash: string;
+    /**
+     * Contains id sets used accross the Rljson object
+     */
+    _idSet?: IdSetsTable;
+    /**
+     * References that are not part of the Rljson object
+     */
+    _externalRefs?: Ref[];
+    /**
+     * Referenced tables that are not part of the Rljson object
+     */
+    _externalTables?: Ref[];
+    /**
+     * Column configurations used accross the Rljson object
+     */
+    _tableCfgs?: TablesCfgTable;
 };
 /** An example rljson object */
 export declare const exampleRljson: () => Rljson;
@@ -21,6 +47,15 @@ export declare const exampleRljson: () => Rljson;
 export interface RljsonTable<Data extends Json, Type extends ContentType> extends Json {
     /** The data rows of the table */
     _data: Data[];
-    /**  The type of the table */
+    /**  The type of the table. If not set, the type is "properties" */
     _type: Type;
+    /** The columns configuration of the table */
+    _tableCfg?: TableCfgRef;
 }
+/**
+ * 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
+ */
+export declare const iterateTables: (rljson: Rljson, callback: (tableName: string, table: TableType) => void) => void;