@rljson/rljson 0.0.56 → 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

@@ -0,0 +1,29 @@
+import { Json, JsonH, JsonValueH } from '@rljson/json';
+import { Ref } from '../typedefs.ts';
+import { RouteRef } from './route.ts';
+import { RljsonTable } from '../rljson.ts';
+/**
+ * An Edit Object describing edits on data basically
+ */
+export type EditRef = Ref;
+export type Edit<T extends Json> = {
+    value: T & JsonValueH;
+    route: RouteRef;
+    origin?: Ref;
+    previous?: EditProtocolTimeId[];
+    acknowledged?: boolean;
+} & JsonH;
+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: () => EditProtocol<any>;

package/dist/edit/route.d.ts

@@ -0,0 +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,6 +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 { EditProtocol } from '../edit/edit.ts';
 import { Rljson } from '../rljson.ts';
 import { Ref } from '../typedefs.ts';
 export interface Ingredient extends Json {
@@ -31,5 +32,6 @@ export interface Bakery extends Rljson {
     recipeIngredients: ComponentsTable<RecipIngredient>;
     ingredients: ComponentsTable<Ingredient>;
     nutritionalValues: ComponentsTable<NutritionalValues>;
+    ingredientsEdits: EditProtocol<'Ingredients'>;
 }
 export declare const bakeryExample: () => Bakery;

package/dist/index.d.ts

@@ -5,10 +5,13 @@ export * from './content/layer.ts';
 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,13 +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 { 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;
+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;