@rljson/rljson 0.0.71 → 0.0.73

package/dist/content/cake.d.ts

@@ -1,6 +1,6 @@
 import { Json } from '@rljson/json';
 import { RljsonTable } from '../rljson.ts';
-import { TableKey } from '../typedefs.ts';
+import { Ref, SliceId, TableKey } from '../typedefs.ts';
 import { LayerRef } from './layer.ts';
 import { SliceIdsRef } from './slice-ids.ts';
 import { TableCfg } from './table-cfg.ts';
@@ -8,6 +8,15 @@ import { TableCfg } from './table-cfg.ts';
  * A `CakeLayerId` assigns an id or name to a cake layer
  */
 export type CakeLayerId = string;
+/**
+ * A reference to a cake
+ *
+ * A cake reference can optionally restrict the slice ids that are used in the cake.
+ */
+export interface CakeReference extends Json {
+    ref: Ref;
+    sliceIds?: SliceId[];
+}
 /**
  * A cake is a collection of layers.
  *

package/dist/content/head.d.ts

@@ -0,0 +1,10 @@
+import { Json } from '@rljson/json';
+import { RljsonTable } from '../rljson.ts';
+import { TableCfg } from './table-cfg.ts';
+export interface Head extends Json {
+    timeId: string;
+    cakeRef: string;
+    _hash: string;
+}
+export type HeadsTable = RljsonTable<Head, 'head'>;
+export declare const createHeadsTableCfg: (cakeKey: string) => TableCfg;

package/dist/content/slice-ids.d.ts

@@ -1,6 +1,7 @@
 import { Json } from '@rljson/json';
 import { RljsonTable } from '../rljson.ts';
 import { Ref, SliceId } from '../typedefs.ts';
+import { TableCfg } from './table-cfg.ts';
 /**
  * An SliceIdsRef is a hash pointing to an Ids
  */
@@ -30,3 +31,9 @@ export type SliceIdsTable = RljsonTable<SliceIds, 'sliceIds'>;
  * Returns one of the layers of the example cake
  */
 export declare const exampleSliceIdsTable: () => SliceIdsTable;
+/**
+ * Creates a table configuration for slice ids table
+ * @param tableKey - the table key
+ * @returns the table configuration
+ */
+export declare const createSliceIdsTableCfg: (tableKey: string) => TableCfg;

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

@@ -29,6 +29,7 @@ export interface ColumnCfg extends Json {
      * Defines if the column is reference column to another table (foreign key)
      */
     ref?: {
+        type: ContentType;
         tableKey: TableKey;
         columnKey?: ColumnKey;
     };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './content/buffet.ts';
 export * from './content/cake.ts';
 export * from './content/components.ts';
+export * from './content/head.ts';
 export * from './content/layer.ts';
 export * from './content/revision.ts';
 export * from './content/slice-ids.ts';

package/dist/rljson.d.ts

@@ -2,6 +2,7 @@ import { Json } from '@rljson/json';
 import { BuffetsTable } from './content/buffet.ts';
 import { CakesTable } from './content/cake.ts';
 import { ComponentsTable } from './content/components.ts';
+import { HeadsTable } from './content/head.ts';
 import { LayersTable } from './content/layer.ts';
 import { RevisionsTable } from './content/revision.ts';
 import { SliceIdsTable } from './content/slice-ids.ts';
@@ -16,7 +17,7 @@ export declare const reservedTableKeys: string[];
 /**
  * One of the supported Rljson table types
  */
-export type TableType = BuffetsTable | ComponentsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable | TablesCfgTable | InsertHistoryTable<any> | EditsTable | MultiEditsTable | EditHistoryTable;
+export type TableType = BuffetsTable | ComponentsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable | TablesCfgTable | InsertHistoryTable<any> | EditsTable | MultiEditsTable | EditHistoryTable | HeadsTable;
 /** The rljson data format */
 export interface Rljson extends Json {
     [tableId: TableKey]: TableType;

package/dist/rljson.js

@@ -1,6 +1,9 @@
 import { hip, hsh } from "@rljson/hash";
 import { exampleJsonObject, jsonValueTypes, jsonValueMatchesType, jsonValueType } from "@rljson/json";
 import { nanoid } from "nanoid";
+const routeRefSeperator = "@";
+const routeSliceIdIndicators = ["(", ")"];
+const routeSliceIdSeperator = ",";
 class Route {
   constructor(_segments) {
     this._segments = _segments;
@@ -16,12 +19,20 @@ class Route {
     const segmentsFlat = route.split("/").filter((s) => s.length > 0);
     const segments = [];
     for (const segmentFlat of segmentsFlat) {
-      const [tableKey, refFlat] = segmentFlat.split("@");
+      const [tableKeyAndSliceId, refFlat] = segmentFlat.split(routeRefSeperator);
+      const sliceIds = tableKeyAndSliceId.substring(
+        tableKeyAndSliceId.indexOf(routeSliceIdIndicators[0]) + 1,
+        tableKeyAndSliceId.indexOf(routeSliceIdIndicators[1])
+      ).split(routeSliceIdSeperator).filter((s) => s.length > 0);
+      const tableKey = tableKeyAndSliceId.split(routeSliceIdIndicators[0])[0];
       const ref = !!refFlat ? refFlat.split(":").length == 2 ? { [tableKey + "InsertHistoryRef"]: refFlat } : { [tableKey + "Ref"]: refFlat } : {};
       const segment = {
         tableKey,
         ...ref
       };
+      if (sliceIds.length > 0) {
+        segment.sliceIds = sliceIds;
+      }
       segments.push(segment);
     }
     return new Route(segments);
@@ -46,8 +57,9 @@ class Route {
    * @returns A new Route that is one level deeper or 'steps' levels deeper
    */
   deeper(steps) {
+    let deeperRoute;
     if (steps === void 0) {
-      return new Route(this._segments.slice(1, this._segments.length));
+      deeperRoute = new Route(this._segments.slice(1, this._segments.length));
     } else {
       if (steps < 1) {
         throw new Error("Steps must be greater than 0");
@@ -55,8 +67,14 @@ class Route {
       if (steps >= this._segments.length) {
         throw new Error("Cannot go deeper than the root");
       }
-      return new Route(this._segments.slice(steps, this._segments.length));
+      deeperRoute = new Route(
+        this._segments.slice(steps, this._segments.length)
+      );
     }
+    if (!!this.propertyKey) {
+      deeperRoute.propertyKey = this.propertyKey;
+    }
+    return deeperRoute;
   }
   // .............................................................................
   /**
@@ -159,8 +177,13 @@ class Route {
     let flat = "";
     for (const segment of this._segments) {
       const tableKey = segment.tableKey;
-      const ref = Object.keys(segment).filter((k) => k !== "tableKey")[0];
-      flat += `/${tableKey}${ref ? `@${segment[ref]}` : ""}`;
+      const tableKeyAndSliceId = segment.sliceIds ? `${tableKey}${routeSliceIdIndicators[0]}${segment.sliceIds.join(
+        routeSliceIdSeperator
+      )}${routeSliceIdIndicators[1]}` : tableKey;
+      const ref = Object.keys(segment).filter(
+        (k) => ["tableKey", "sliceIds"].indexOf(k) === -1
+      )[0];
+      flat += `/${tableKeyAndSliceId}${ref ? `${routeRefSeperator}${segment[ref]}` : ""}`;
     }
     return flat;
   }
@@ -504,6 +527,36 @@ const createCakeTableCfg = (cakeKey) => ({
 });
 const exampleCakesTable = () => bakeryExample().cakes;
 const exampleComponentsTable = () => bakeryExample().nutritionalValues;
+const createHeadsTableCfg = (cakeKey) => ({
+  key: `${cakeKey}Heads`,
+  type: "head",
+  columns: [
+    {
+      key: "_hash",
+      type: "string",
+      titleLong: "Hash",
+      titleShort: "Hash"
+    },
+    {
+      key: "timeId",
+      type: "string",
+      titleLong: "Time Identifier",
+      titleShort: "Time ID"
+    },
+    {
+      key: "cakeRef",
+      type: "string",
+      titleLong: "Cake Reference",
+      titleShort: "Cake Ref",
+      ref: {
+        tableKey: `${cakeKey}`
+      }
+    }
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
+});
 const createLayerTableCfg = (layerKey) => ({
   key: layerKey,
   type: "layers",
@@ -544,6 +597,34 @@ const exampleRevision = () => ({
   timestamp: 1743558427
 });
 const exampleSliceIdsTable = () => bakeryExample().slices;
+const createSliceIdsTableCfg = (tableKey) => ({
+  key: tableKey,
+  type: "sliceIds",
+  columns: [
+    { key: "_hash", type: "string", titleLong: "Hash", titleShort: "Hash" },
+    {
+      key: "base",
+      type: "string",
+      titleLong: "Base SliceId",
+      titleShort: "Base SliceId"
+    },
+    {
+      key: "add",
+      type: "jsonArray",
+      titleLong: "Added SliceIds",
+      titleShort: "Add"
+    },
+    {
+      key: "remove",
+      type: "jsonArray",
+      titleLong: "Removed SliceIds",
+      titleShort: "Remove"
+    }
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
+});
 class Example {
   static ok = {
     bakery: () => bakeryExample(),
@@ -1458,7 +1539,7 @@ const createEditHistoryTableCfg = (cakeKey) => ({
       titleLong: "Multi Edit Reference",
       titleShort: "Multi Edit Ref",
       ref: {
-        tableKey: `${cakeKey}MultiEdit`
+        tableKey: `${cakeKey}MultiEdits`
       }
     },
     {
@@ -1476,7 +1557,10 @@ const createEditHistoryTableCfg = (cakeKey) => ({
       titleLong: "Previous Values",
       titleShort: "Previous"
     }
-  ]
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
 });
 const createEditTableCfg = (cakeKey) => ({
   key: `${cakeKey}Edits`,
@@ -1500,7 +1584,10 @@ const createEditTableCfg = (cakeKey) => ({
       titleLong: "Edit Action Data",
       titleShort: "Action"
     }
-  ]
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
 });
 const createMultiEditTableCfg = (cakeKey) => ({
   key: `${cakeKey}MultiEdits`,
@@ -1527,7 +1614,10 @@ const createMultiEditTableCfg = (cakeKey) => ({
         tableKey: `${cakeKey}Edits`
       }
     }
-  ]
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
 });
 const objectDepth = (o) => Object(o) === o ? 1 + Math.max(-1, ...Object.values(o).map(objectDepth)) : 0;
 class InsertValidator {
@@ -1758,7 +1848,8 @@ const contentTypes = [
   "insertHistory",
   "edits",
   "multiEdits",
-  "editHistory"
+  "editHistory",
+  "head"
 ];
 const exampleTypedefs = () => {
   return {
@@ -2612,9 +2703,11 @@ export {
   createCakeTableCfg,
   createEditHistoryTableCfg,
   createEditTableCfg,
+  createHeadsTableCfg,
   createInsertHistoryTableCfg,
   createLayerTableCfg,
   createMultiEditTableCfg,
+  createSliceIdsTableCfg,
   exampleBuffetsTable,
   exampleCakesTable,
   exampleComponentsTable,
@@ -2636,6 +2729,9 @@ export {
   removeDuplicates,
   reservedFieldNames,
   reservedTableKeys,
+  routeRefSeperator,
+  routeSliceIdIndicators,
+  routeSliceIdSeperator,
   throwOnInvalidTableCfg,
   timeId,
   validateInsert,

package/dist/route/route.d.ts

@@ -1,10 +1,14 @@
-import { TableKey } from '../typedefs.ts';
+import { SliceId, TableKey } from '../typedefs.ts';
 export type RouteRef = string;
 export type RouteSegment<Str extends string> = {
     [key in Str as `${Uncapitalize<string & key>}Ref`]: string;
 } & {
     tableKey: TableKey;
+    sliceIds?: SliceId[];
 };
+export declare const routeRefSeperator = "@";
+export declare const routeSliceIdIndicators: readonly ["(", ")"];
+export declare const routeSliceIdSeperator: ",";
 export type RouteSegmentFlat<N extends string> = `${N}` | `${N}@${string}` | `${N}@${string}:${string}`;
 /**
  * A class to handle routes in an Rljson object.

package/dist/tools/time-id.d.ts

@@ -1,16 +1,16 @@
 /**
  * Generates a new TimeId.
- * A TimeId is a string in the format "xxxx:timestamp" where:
- * - "xxxx" is a 4-character unique identifier
+ * A TimeId has the format "timestamp:xxxx" where:
  * - "timestamp" is the current time in milliseconds since epoch
+ * - "xxxx" is a 4-character unique identifier
  * @returns A new TimeId string
  */
 export declare const timeId: () => string;
 /**
  * Checks if a given id is a valid TimeId.
- * A valid TimeId has the format "xxxx:timestamp" where:
- * - "xxxx" is a 4-character string
- * - "timestamp" is a valid number representing milliseconds since epoch
+ * A TimeId has the format "timestamp:xxxx" where:
+ * - "timestamp" is the current time in milliseconds since epoch
+ * - "xxxx" is a 4-character unique identifier
  * @param id - The id to check
  * @returns True if the id is a valid TimeId, false otherwise
  */

package/dist/typedefs.d.ts

@@ -26,7 +26,7 @@ export type ColumnKey = JsonKey;
  * - `ids` Tables containing slice ids
  * - `components` Tables containing slice components
  */
-export declare const contentTypes: readonly ["buffets", "cakes", "layers", "sliceIds", "components", "revisions", "tableCfgs", "insertHistory", "edits", "multiEdits", "editHistory"];
+export declare const contentTypes: readonly ["buffets", "cakes", "layers", "sliceIds", "components", "revisions", "tableCfgs", "insertHistory", "edits", "multiEdits", "editHistory", "head"];
 export type ContentType = (typeof contentTypes)[number];
 /**
  * An example object using the typedefs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.71",
+  "version": "0.0.73",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
   "bugs": "https://github.com/rljson/rljson/issues",
@@ -21,23 +21,23 @@
   "type": "module",
   "devDependencies": {
     "@types/node": "^24.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.46.4",
-    "@typescript-eslint/parser": "^8.46.4",
-    "@vitest/coverage-v8": "^4.0.9",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "cross-env": "^10.1.0",
     "eslint": "^9.39.1",
-    "eslint-plugin-jsdoc": "^61.2.1",
+    "eslint-plugin-jsdoc": "^61.4.1",
     "eslint-plugin-tsdoc": "^0.5.0",
     "globals": "^16.5.0",
     "jsdoc": "^4.0.5",
     "read-pkg": "^10.0.0",
     "typescript": "~5.9.3",
-    "typescript-eslint": "^8.46.4",
-    "vite": "^7.2.2",
-    "vite-node": "^5.1.0",
+    "typescript-eslint": "^8.48.1",
+    "vite": "^7.2.6",
+    "vite-node": "^5.2.0",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^4.0.9",
+    "vitest": "^4.0.15",
     "vitest-dom": "^0.1.1"
   },
   "dependencies": {