@rljson/rljson 0.0.58 → 0.0.60

package/dist/content/cake.d.ts

@@ -3,6 +3,7 @@ import { RljsonTable } from '../rljson.ts';
 import { TableKey } from '../typedefs.ts';
 import { LayerRef } from './layer.ts';
 import { SliceIdsRef } from './slice-ids.ts';
+import { TableCfg } from './table-cfg.ts';
 /**
  * A `CakeLayerId` assigns an id or name to a cake layer
  */
@@ -39,6 +40,14 @@ export interface Cake extends Json {
  * A table containing cakes
  */
 export type CakesTable = RljsonTable<Cake, 'cakes'>;
+/**
+ * Sample Table as BoilerPlate for Tests and Examples
+ */
+/**
+ * Sample Table as BoilerPlate for Tests and Examples
+ * @param cakeKey - the key of the cake table cfg
+ */
+export declare const createCakeTableCfg: (cakeKey: string) => TableCfg;
 /**
  * Provides an example cakes table for test purposes
  */

package/dist/content/components.d.ts

@@ -1,6 +1,7 @@
+import { Json } from '@rljson/json';
 import { NutritionalValues } from '../example/bakery-example.ts';
 import { RljsonTable } from '../rljson.ts';
-import { JsonWithId, Ref } from '../typedefs.ts';
+import { Ref } from '../typedefs.ts';
 /**
  * A reference to a components row in a components table
  */
@@ -8,7 +9,7 @@ export type ComponentRef = Ref;
 /**
  * A table containing components
  */
-export type ComponentsTable<T extends JsonWithId> = RljsonTable<T, 'components'>;
+export type ComponentsTable<T extends Json> = RljsonTable<T, 'components'>;
 /**
  * Provides an example components table for test purposes
  */

package/dist/content/layer.d.ts

@@ -3,6 +3,7 @@ import { RljsonTable } from '../rljson.ts';
 import { Ref, SliceId, TableKey } from '../typedefs.ts';
 import { ComponentRef } from './components.ts';
 import { SliceIdsRef } from './slice-ids.ts';
+import { TableCfg } from './table-cfg.ts';
 /**
  * A LayerRef is a hash pointing to a layer
  */
@@ -44,6 +45,11 @@ export interface Layer extends Json {
  * A table containing layers
  */
 export type LayersTable = RljsonTable<Layer, 'layers'>;
+/**
+ * Sample Table as BoilerPlate for Tests and Examples
+ * @param layerKey - the key of the layer table
+ */
+export declare const createLayerTableCfg: (layerKey: string) => TableCfg;
 /**
  * Provides an example layersTable for test purposes
  */

package/dist/edit/edit.d.ts

@@ -1,23 +1,29 @@
 import { Json, JsonH, JsonValueH } from '@rljson/json';
-import { Ingredient } from '../example/bakery-example.ts';
-import { RljsonTable } from '../rljson.ts';
 import { Ref } from '../typedefs.ts';
+import { RouteRef } from './route.ts';
+import { RljsonTable } from '../rljson.ts';
 /**
- * A reference to a Edit row in a Edit table
+ * An Edit Object describing edits on data basically
  */
 export type EditRef = Ref;
 export type Edit<T extends Json> = {
     value: T & JsonValueH;
-    route: string;
+    route: RouteRef;
     origin?: Ref;
-    previous?: EditRef;
+    previous?: EditProtocolTimeId[];
     acknowledged?: boolean;
 } & JsonH;
-/**
- * A table containing components
- */
-export type EditsTable<T extends Json> = RljsonTable<Edit<T>, 'edits'>;
+export type EditProtocolTimeId = string;
+export type EditProtocolRow<Str extends string> = {
+    [key in Str as `${Uncapitalize<string & key>}Ref`]: string;
+} & {
+    timeId: EditProtocolTimeId;
+    route: RouteRef;
+    origin?: Ref;
+    previous?: EditProtocolTimeId[];
+};
+export type EditProtocol<Str extends string> = RljsonTable<EditProtocolRow<Str>, 'edits'>;
 /**
  * Provides an example Edits table for test purposes
  */
-export declare const exampleEditsTable: () => EditsTable<Ingredient>;
+export declare const exampleEditsTable: () => EditProtocol<any>;

package/dist/edit/route.d.ts

@@ -1,6 +1,13 @@
+export type RouteRef = string;
+/**
+ * A class to handle routes in an Rljson object.
+ */
 export declare class Route {
     private segments;
     constructor(segments: string[]);
     static fromFlat(route: string): Route;
+    segment(index?: number): string;
+    deeper(steps?: number): Route;
+    get isRoot(): boolean;
     get flat(): string;
 }

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

@@ -4,7 +4,7 @@ import { CakesTable } from '../content/cake.ts';
 import { ComponentsTable } from '../content/components.ts';
 import { LayersTable } from '../content/layer.ts';
 import { SliceIdsTable } from '../content/slice-ids.ts';
-import { EditsTable } from '../edit/edit.ts';
+import { EditProtocol } from '../edit/edit.ts';
 import { Rljson } from '../rljson.ts';
 import { Ref } from '../typedefs.ts';
 export interface Ingredient extends Json {
@@ -32,6 +32,6 @@ export interface Bakery extends Rljson {
     recipeIngredients: ComponentsTable<RecipIngredient>;
     ingredients: ComponentsTable<Ingredient>;
     nutritionalValues: ComponentsTable<NutritionalValues>;
-    ingredientsEdits: EditsTable<Ingredient>;
+    ingredientsEdits: EditProtocol<'Ingredients'>;
 }
 export declare const bakeryExample: () => Bakery;

package/dist/index.d.ts

@@ -6,10 +6,12 @@ export * from './content/revision.ts';
 export * from './content/slice-ids.ts';
 export * from './content/table-cfg.ts';
 export * from './edit/edit.ts';
+export * from './edit/route.ts';
 export * from './example.ts';
 export * from './example/bakery-example.ts';
 export * from './rljson.ts';
 export * from './tools/remove-duplicates.ts';
+export * from './tools/time-id.ts';
 export * from './typedefs.ts';
 export * from './validate/base-validator.ts';
 export * from './validate/validate.ts';

package/dist/rljson.d.ts

@@ -6,14 +6,14 @@ import { LayersTable } from './content/layer.ts';
 import { RevisionsTable } from './content/revision.ts';
 import { SliceIdsTable } from './content/slice-ids.ts';
 import { TableCfgRef, TablesCfgTable } from './content/table-cfg.ts';
-import { EditsTable } from './edit/edit.ts';
+import { EditProtocol } from './edit/edit.ts';
 import { ContentType, Ref, TableKey } from './typedefs.ts';
 export declare const reservedFieldNames: string[];
 export declare const reservedTableKeys: string[];
 /**
  * One of the supported Rljson table types
  */
-export type TableType = BuffetsTable | ComponentsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable | TablesCfgTable | EditsTable<any>;
+export type TableType = BuffetsTable | ComponentsTable<any> | LayersTable | SliceIdsTable | CakesTable | RevisionsTable | TablesCfgTable | EditProtocol<any>;
 /** The rljson data format */
 export interface Rljson extends Json {
     [tableId: TableKey]: TableType;

package/dist/rljson.js

@@ -1,5 +1,6 @@
 import { hip, hsh } from "@rljson/hash";
 import { exampleJsonObject, jsonValueTypes, jsonValueMatchesType, jsonValueType } from "@rljson/json";
+import { nanoid } from "nanoid";
 // @license
 class Route {
   constructor(segments) {
@@ -8,6 +9,28 @@ class Route {
   static fromFlat(route) {
     return new Route(route.split("/").filter(Boolean));
   }
+  segment(index) {
+    if (index === void 0) {
+      return this.segments[this.segments.length - 1];
+    }
+    return this.segments[index];
+  }
+  deeper(steps) {
+    if (steps === void 0) {
+      return new Route(this.segments.slice(1, this.segments.length));
+    } else {
+      if (steps < 1) {
+        throw new Error("Steps must be greater than 0");
+      }
+      if (steps >= this.segments.length) {
+        throw new Error("Cannot go deeper than the root");
+      }
+      return new Route(this.segments.slice(steps, this.segments.length));
+    }
+  }
+  get isRoot() {
+    return this.segments.length === 1;
+  }
   get flat() {
     return "/" + this.segments.join("/");
   }
@@ -44,6 +67,12 @@ const bakeryExample = () => {
         amountUnit: "g",
         nutritionalValuesRef: nutritionalValues._data[0]._hash,
         _hash: ""
+      },
+      {
+        id: "flourB",
+        amountUnit: "g",
+        nutritionalValuesRef: nutritionalValues._data[1]._hash,
+        _hash: ""
       }
     ],
     _hash: ""
@@ -138,25 +167,18 @@ const bakeryExample = () => {
     _type: "edits",
     _data: [
       {
-        value: {
-          name: "Flour A",
-          amountUnit: "g",
-          nutritionalValuesRef: nutritionalValues._data[0]._hash,
-          _hash: ""
-        },
+        timeId: "de72:1759123957292",
+        ingredientsRef: ingredients._data[0]._hash,
         route: Route.fromFlat("/ingredients/").flat,
-        _hash: ""
+        origin: "H45H",
+        previous: []
       },
       {
-        value: {
-          name: "Flour B",
-          amountUnit: "g",
-          nutritionalValuesRef: nutritionalValues._data[0]._hash,
-          _hash: ""
-        },
-        previous: "D2Rp36U1DBa69zAya-16EJ",
+        timeId: "a8e0:1759123987505",
+        ingredientsRef: ingredients._data[1]._hash,
         route: Route.fromFlat("/ingredients/").flat,
-        _hash: ""
+        origin: "H45H",
+        previous: ["de72:1759123957292"]
       }
     ],
     _hash: ""
@@ -178,10 +200,38 @@ const bakeryExample = () => {
 // @license
 const exampleBuffetsTable = () => bakeryExample().buffets;
 // @license
+const createCakeTableCfg = (cakeKey) => ({
+  key: cakeKey,
+  type: "cakes",
+  columns: [
+    { key: "sliceIdsTable", type: "string" },
+    { key: "sliceIdsRow", type: "string" },
+    { key: "layers", type: "jsonArray" },
+    { key: "id", type: "string" }
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
+});
 const exampleCakesTable = () => bakeryExample().cakes;
 // @license
 const exampleComponentsTable = () => bakeryExample().nutritionalValues;
 // @license
+const createLayerTableCfg = (layerKey) => ({
+  key: layerKey,
+  type: "layers",
+  columns: [
+    { key: "base", type: "string" },
+    { key: "sliceIdsTable", type: "string" },
+    { key: "sliceIdsTableRow", type: "string" },
+    { key: "componentsTable", type: "string" },
+    { key: "add", type: "jsonArray" },
+    { key: "remove", type: "jsonArray" }
+  ],
+  isHead: false,
+  isRoot: false,
+  isShared: true
+});
 const exampleLayersTable = () => bakeryExample().recipeLayers;
 // @license
 const exampleRevision = () => ({
@@ -924,6 +974,10 @@ const removeDuplicates = (rljson) => {
   return hip(result, { throwOnWrongHashes: false });
 };
 // @license
+const timeId = () => {
+  return nanoid(4) + ":" + Date.now();
+};
+// @license
 const contentTypes = [
   "buffets",
   "cakes",
@@ -1448,10 +1502,9 @@ class _BaseValidator {
                 continue;
               }
               const targetSliceIdsTable = this.rljson[key];
-              const targetSliceIds2 = targetSliceIdsTable._data.flatMap((d) => [
-                ...d.add,
-                ...d.remove ?? []
-              ]);
+              const targetSliceIds2 = targetSliceIdsTable._data.flatMap(
+                (d) => [...d.add, ...d.remove ?? []]
+              );
               if (targetSliceIds2.indexOf(targetSliceId) === -1) {
                 missingSliceIdRefs.push({
                   sourceTable: tableKey,
@@ -1823,10 +1876,13 @@ class Validate {
 export {
   BaseValidator,
   Example,
+  Route,
   Validate,
   addColumnsToTableCfg,
   bakeryExample,
   contentTypes,
+  createCakeTableCfg,
+  createLayerTableCfg,
   exampleBuffetsTable,
   exampleCakesTable,
   exampleComponentsTable,
@@ -1845,5 +1901,6 @@ export {
   reservedFieldNames,
   reservedTableKeys,
   throwOnInvalidTableCfg,
+  timeId,
   validateRljsonAgainstTableCfg
 };

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

@@ -0,0 +1 @@
+export declare const timeId: () => string;

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@rljson/rljson",
-  "version": "0.0.58",
-  "packageManager": "pnpm@10.11.0",
+  "version": "0.0.60",
   "description": "The RLJSON data format specification",
   "homepage": "https://github.com/rljson/rljson",
   "bugs": "https://github.com/rljson/rljson/issues",
@@ -20,14 +19,6 @@
     "dist"
   ],
   "type": "module",
-  "scripts": {
-    "build": "npx vite build && tsc && cp README* dist && mkdir dist/src && cp src/example.ts dist/src",
-    "test": "npx vitest run --coverage && npm run lint",
-    "prebuild": "npm run test",
-    "prepublishOnly": "npm run build && npm run test",
-    "lint": "npx eslint",
-    "updateGoldens": "cross-env UPDATE_GOLDENS=true npm test"
-  },
   "devDependencies": {
     "@types/node": "^24.5.2",
     "@typescript-eslint/eslint-plugin": "^8.44.1",
@@ -51,12 +42,14 @@
   },
   "dependencies": {
     "@rljson/hash": "^0.0.16",
-    "@rljson/json": "^0.0.21"
+    "@rljson/json": "^0.0.21",
+    "nanoid": "^5.1.6"
   },
-  "pnpm": {
-    "onlyBuiltDependencies": [
-      "esbuild"
-    ],
-    "overrides": {}
+  "scripts": {
+    "build": "npx vite build && tsc && cp README* dist && mkdir dist/src && cp src/example.ts dist/src",
+    "test": "npx vitest run --coverage && npm run lint",
+    "prebuild": "npm run test",
+    "lint": "npx eslint",
+    "updateGoldens": "cross-env UPDATE_GOLDENS=true npm test"
   }
-}
+}