@rljson/rljson 0.0.11 → 0.0.14

package/dist/rljson.d.ts

@@ -1,172 +1,47 @@
-import { Json, JsonValue } from '@rljson/json';
+import { Json } from '@rljson/json';
+import { BuffetsTable } from './content/buffet.ts';
+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, Ref, TableName } from './typedefs.ts';
+export declare const reservedFieldNames: string[];
+export declare const reservedTableNames: string[];
 /**
- * A ref is a hash that references to another element
- */
-export type Ref = string;
-/**
- * An `id` is a *user defined* name or identifier of an item.
- * It exists in parallel with the auto generated `_hash`.
- */
-export type ItemId = string;
-/**
- * A table id reference to a table. The table ids are used as keys in the top
- * level structure of an Rljson data object.
- */
-export type TableName = ItemId;
-/**
- * Types of tables that can be stored in an Rljson object
- *
- * - `buffets` Tables containing buffets
- * - `cakes` Tables containing cakes
- * - `collections` Tables containing collections
- * - `ids` Tables containing item ids
- * - `properties` Tables containing item properties
- */
-export type ContentType = 'buffet' | 'cake' | 'collection' | 'ids' | 'properties';
-/** A table in the rljson format */
-export interface RljsonTable<Data extends Json, Type extends ContentType> extends Json {
-    /** The data rows of the table */
-    _data: Data[];
-    /**  The type of the table */
-    _type: Type;
-}
-/**
- * A reference to a properties row in a properties table
- */
-export type PropertiesRef = Ref;
-/**
- * A table containing item properties
- */
-export type PropertiesTable = RljsonTable<Json, 'properties'>;
-/**
- * An IdSetRef is a hash pointing to an Ids
- */
-export type IdSetRef = Ref;
-/**
- * An Ids manages list of item ids
- */
-export interface IdSet extends Json {
-    /**
-     * The hash of another item id list which is extended by this one.
-     * Must be empty or null, when the list is the root.
-     */
-    base: IdSetRef | null;
-    /**
-     * The item ids added to base
-     */
-    add: ItemId[];
-    /**
-     * The item ids removed from base
-     */
-    remove: ItemId[];
-}
-/**
- * A table containing item ids
- */
-export type IdSetsTable = RljsonTable<IdSet, 'ids'>;
-/**
- * A CollectionRef is a hash pointing to a collection
- */
-export type CollectionRef = Ref;
-/**
- * A collection assigns properties to item ids
+ * One of the supported Rljson table types
  */
-export interface Collection extends Json {
-    /**
-     * `base` an optional base collection that is extended by this collection
-     */
-    base: CollectionRef | null;
-    /**
-     * The table containing the item set of this collection
-     */
-    idSetsTable: TableName;
-    /**
-     * A reference to the ids of the items the collection is based on
-     */
-    idSet: IdSetRef;
-    /**
-     * The table containing the properties assigned to the items of this collection
-     */
-    properties: TableName;
-    /**
-     * Assign properties to each item of the collection.
-     */
-    assign: Record<ItemId, PropertiesRef>;
+export type TableType = BuffetsTable | PropertiesTable<any> | CollectionsTable | IdSetsTable | CakesTable;
+/** The rljson data format */
+export interface Rljson extends Json {
+    [tableId: TableName]: TableType;
 }
 /**
- * A table containing collections
- */
-export type CollectionsTable = RljsonTable<Collection, 'collection'>;
-/**
- * A `CakeLayerId` assigns an id or name to a cake layer
- */
-export type CakeLayerId = ItemId;
-/**
- * A `CakeLayerIds` is a set of cake layer ids / cake layer names
- */
-export type CakeLayerIds = IdSet;
-/**
- * A cake is a collection of layers.
- *
- * A layer is a collection of items.
- * All layers of a cake refer to the same items.
+ * Rljson set with private fields
  */
-export interface Cake extends Json {
-    /**
-     * The table containing the item ids of the cake
-     */
-    itemIdsTable: TableName;
+export type RljsonPrivate = {
     /**
-     * All layers of a cake share the same item ids.
+     * Contains id sets used accross the Rljson object
      */
-    itemIds: IdSetRef;
+    _idSets: IdSetsTable;
     /**
-     * The table containing the layers of this cake
+     * Used by validation. If external references are not present,
+     * validation does not throw an error.
      */
-    layersTable: TableName;
-    /**
-     * Assigns a collection to each layer of the cake.
-     */
-    layers: {
-        [layerId: CakeLayerId]: CollectionRef;
-    };
-}
-/**
- * A table containing cakes
- */
-export type CakesTable = RljsonTable<Cake, 'cake'>;
-/**
- * A buffet id is a name or id of a buffet
- */
-export type BuffetId = ItemId;
-/**
- * A buffet is a collection of arbitrary but related items, e.g. cakes,
- * collections, or items.
- */
-export interface Buffet extends Json {
-    /**
-     * The items of the buffet
-     */
-    items: Array<{
-        table: TableName;
-        ref: Ref;
-        [key: string]: JsonValue;
-    }>;
+    _externalRefs: Ref[];
+};
+/** An example rljson object */
+export declare const exampleRljson: () => Rljson;
+/** A table in the rljson format */
+export interface RljsonTable<Data extends Json, Type extends ContentType> extends Json {
+    /** The data rows of the table */
+    _data: Data[];
+    /**  The type of the table. If not set, the type is "properties" */
+    _type: Type;
 }
 /**
- * A table containing buffets
- */
-export type BuffetsTable = RljsonTable<Buffet, 'buffet'>;
-/**
- * One of the supported Rljson table types
+ * 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 type TableType = BuffetsTable | PropertiesTable | CollectionsTable | IdSetsTable | CakesTable;
-/** The rljson data format */
-export interface Rljson extends Json {
-    [tableId: TableName]: TableType | string;
-}
-export declare const exampleRljson: () => Rljson;
-export declare const exampleBinary: () => Rljson;
-export declare const exampleRljsonEmpty: () => Rljson;
-export declare const exampleRljsonWithErrors: () => Rljson;
-export declare const exampleRljsonWithMultipleRows: () => Rljson;
+export declare const iterateTables: (rljson: Rljson, callback: (tableName: string, table: TableType) => void) => void;