@rljson/rljson 0.0.11 → 0.0.14

package/dist/rljson.js

@@ -1,61 +1,475 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+import { hip, hsh } from "@rljson/hash";
 import { exampleJsonObject } from "@rljson/json";
 // @license
-const exampleRljson = () => ({
-  table: {
-    _type: "properties",
-    _data: [exampleJsonObject()]
+const bakeryExample = () => {
+  return {
+    // Every rljson object has a list of id-sets other objects can refer to
+    _idSets: {
+      _type: "idSets",
+      _data: [
+        {
+          add: ["slice0", "slice1"],
+          _hash: "KAwCRFD4mdx8b1bzxBb2_O"
+        }
+      ]
+    },
+    // A bakery offers a variety of buffets containing different pastries
+    buffets: {
+      _type: "buffets",
+      _data: [
+        {
+          items: [{ table: "cakes", ref: "fw8IrV05Z1ZekPXTdUdmt8" }]
+        }
+      ]
+    },
+    // A cake is a collection of layers, i.e. a base, a filling and a topping.
+    // Each layer of the cake has the same slice structure.
+    cakes: {
+      _type: "cakes",
+      _data: [
+        {
+          idSet: "KAwCRFD4mdx8b1bzxBb2_O",
+          collections: "layers",
+          layers: {
+            _hash: "50ZHxZ8KeUYJ3NC7ax5CbR"
+          },
+          _hash: "gMqFPTkYU66L32jDYZiZ79"
+        }
+      ],
+      _hash: "fw8IrV05Z1ZekPXTdUdmt8"
+    },
+    // Cakes are cut into slices. The cake layers are shared among the slices.
+    slices: {
+      _type: "idSets",
+      _data: [
+        {
+          add: ["slice0", "slice1"],
+          remove: []
+        }
+      ]
+    },
+    // A layer is a collection of ingredients described by a recipe
+    layers: {
+      _type: "collections",
+      _data: [
+        {
+          properties: "recipes",
+          assign: {
+            slice0: "VXUW79JrkOAG_pQ-75ahH5",
+            slice1: "VXUW79JrkOAG_pQ-75ahH5",
+            _hash: "Di4uG3-DHSq3_ArFu0V68m"
+          },
+          _hash: "IIg0e-6Qr73s7sNZe0RhKs"
+        }
+      ],
+      _hash: "e3utfEf_VS1-ljAMgqesua"
+    },
+    // Recipes are sets of ingredients
+    recipes: {
+      _type: "collections",
+      _data: [
+        {
+          properties: "recipeIngredients",
+          assign: {
+            flour: "mqLl7Q44V1t2MotJvaVRM_",
+            _hash: "UImWlyWZTSGhNAMC1JUzF1"
+          },
+          _hash: "G1YV_P8-_vTxtkXXHJeNBI"
+        }
+      ],
+      _hash: "r3lw7VsnywyasRmtynZqIt"
+    },
+    // A recipe ingredient combines an ingredient type with a quantity
+    recipeIngredients: {
+      _type: "properties",
+      _data: [
+        {
+          ingredientTypesRef: "WOfnFT1svec3iJ6x",
+          quantity: 500,
+          _hash: "mqLl7Q44V1t2MotJvaVRM_"
+        }
+      ],
+      _hash: "J7GJEjCRXLNfdAHARg_fzx"
+    },
+    // A table describing basic properties of ingredients
+    ingredients: {
+      _type: "properties",
+      _data: [
+        {
+          name: "flour",
+          amountUnit: "g",
+          nutritiveValuesRef: "gZXFSlrl5QAs5hOVsq5sWB",
+          _hash: "CdSJV-WOfnFT1svec3iJ6x"
+        }
+      ],
+      _hash: "FgJeTM0NcZvXwFcU-PD8Jf"
+    },
+    // A table with nutritive values of ingredients
+    nutritiveValues: {
+      _type: "properties",
+      _data: [
+        {
+          energy: 364,
+          fat: 0.98,
+          protein: 10.33,
+          carbohydrates: 76.31,
+          _hash: "gZXFSlrl5QAs5hOVsq5sWB"
+        }
+      ],
+      _hash: "7k4OqQtk71w3yVGMoA9F6p"
+    }
+  };
+};
+// @license
+const exampleBuffetsTable = () => bakeryExample().buffets;
+// @license
+const exampleCakesTable = () => bakeryExample().cakes;
+// @license
+const exampleCollectionsTable = () => bakeryExample().layers;
+// @license
+const exampleIdSetsTable = () => bakeryExample().slices;
+// @license
+const examplePropertiesTable = () => bakeryExample().nutritiveValues;
+// @license
+const _Example = class _Example {
+};
+__publicField(_Example, "ok", {
+  bakery: () => bakeryExample(),
+  empty: () => {
+    return {};
+  },
+  binary: () => {
+    return {
+      table: {
+        _type: "properties",
+        _data: [
+          { a: false, b: false },
+          { a: false, b: true },
+          { a: true, b: false },
+          { a: true, b: true }
+        ]
+      }
+    };
+  },
+  singleRow: () => {
+    return {
+      table: {
+        _type: "properties",
+        _data: [exampleJsonObject()]
+      }
+    };
+  },
+  multipleRows: () => {
+    return {
+      table: {
+        _type: "properties",
+        _data: [
+          {
+            string: "str0",
+            boolean: true,
+            number: 1,
+            array: [1, "str0", true, { a: { b: "c" } }],
+            object: { a: { b: "c" } }
+          },
+          {
+            string: "str1",
+            boolean: true,
+            number: 1,
+            array: [1, "str1", true, { a: { b: "c" } }],
+            object: { a: { b: "c" } }
+          },
+          {
+            string: "str2",
+            boolean: false,
+            number: 1,
+            array: [1, "str1", true, { a: { b: "c" } }],
+            object: { d: { e: "f" } }
+          }
+        ]
+      }
+    };
+  },
+  singleRef: () => {
+    return {
+      tableA: {
+        _type: "properties",
+        _data: [
+          {
+            keyA0: "a0"
+          },
+          {
+            keyA1: "a1"
+          }
+        ]
+      },
+      tableB: {
+        _type: "properties",
+        _data: [
+          {
+            tableARef: "KFQrf4mEz0UPmUaFHwH4T6"
+          }
+        ]
+      }
+    };
+  },
+  complete: () => {
+    return {
+      _idSets: {
+        _type: "idSets",
+        _data: [
+          {
+            add: ["id0", "id1"],
+            _hash: "MgHRBYSrhpyl4rvsOmAWcQ"
+          }
+        ]
+      },
+      properties: {
+        _type: "properties",
+        _data: [
+          { a: "0", _hash: "AFhW-fMzdCiz6bUZscp1Lf" },
+          { a: "1", _hash: "mv6w8rID8lQxLsje1EHQMY" }
+        ]
+      },
+      collections: {
+        _type: "collections",
+        _data: [
+          {
+            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
+            properties: "properties",
+            _hash: "sxv2NCM6UNOcX-i9FhOs5W",
+            assign: {}
+          },
+          {
+            base: "sxv2NCM6UNOcX-i9FhOs5W",
+            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
+            properties: "properties",
+            assign: {
+              id0: "AFhW-fMzdCiz6bUZscp1Lf",
+              id1: "mv6w8rID8lQxLsje1EHQMY"
+            },
+            _hash: "QB2JC6X_-rUAoixuldzWP-"
+          }
+        ]
+      },
+      cakes: {
+        _type: "cakes",
+        _data: [
+          {
+            idSet: "MgHRBYSrhpyl4rvsOmAWcQ",
+            collections: "collections",
+            layers: {
+              layer0: "sxv2NCM6UNOcX-i9FhOs5W",
+              layer1: "QB2JC6X_-rUAoixuldzWP-"
+            },
+            _hash: "QlTVJL3uoXO1L_fw2evLPe"
+          }
+        ]
+      },
+      buffets: {
+        _type: "buffets",
+        _data: [
+          {
+            items: [
+              {
+                table: "cakes",
+                ref: "QlTVJL3uoXO1L_fw2evLPe"
+              },
+              {
+                table: "collections",
+                ref: "QB2JC6X_-rUAoixuldzWP-"
+              }
+            ]
+          }
+        ]
+      }
+    };
   }
 });
-const exampleBinary = () => ({
-  table: {
-    _type: "properties",
-    _data: [
-      { a: 0, b: 0 },
-      { a: 0, b: 1 },
-      { a: 1, b: 0 },
-      { a: 1, b: 1 }
-    ]
+__publicField(_Example, "broken", {
+  brokenTableName: () => {
+    return {
+      brok$en: {
+        _type: "properties",
+        _data: []
+      }
+    };
+  },
+  missingData: () => {
+    return {
+      table: {
+        _type: "properties"
+      }
+    };
+  },
+  dataNotBeingAnArray: () => {
+    return {
+      table: {
+        _type: "properties",
+        _data: {}
+      }
+    };
+  },
+  missingRef: () => {
+    return {
+      tableA: {
+        _type: "properties",
+        _data: [
+          {
+            keyA0: "a0"
+          },
+          {
+            keyA1: "a1"
+          }
+        ]
+      },
+      tableB: {
+        _type: "properties",
+        _data: [
+          {
+            tableARef: "MISSINGREF"
+            // MISSINGREF does not exist in tableA
+          }
+        ]
+      }
+    };
+  },
+  missingReferencedTable: () => {
+    return {
+      tableB: {
+        _type: "properties",
+        _data: [
+          {
+            tableARef: "MISSINGREF"
+            // tableA is missing
+          }
+        ]
+      }
+    };
+  },
+  collections: {
+    missingBase: () => {
+      const result = _Example.ok.complete();
+      const collection1 = result.collections._data[1];
+      collection1.base = "MISSING";
+      return hip(result, true, false);
+    },
+    missingIdSet: () => {
+      const result = _Example.ok.complete();
+      const collection1 = result.collections._data[1];
+      collection1.idSet = "MISSING1";
+      return hip(result, true, false);
+    },
+    missingAssignedPropertyTable: () => {
+      const result = _Example.ok.complete();
+      delete result.properties;
+      return result;
+    },
+    missingAssignedProperty: () => {
+      const result = _Example.ok.complete();
+      result.properties._data.splice(1, 2);
+      return result;
+    }
+  },
+  cakes: {
+    missingIdSet: () => {
+      const result = _Example.ok.complete();
+      result.cakes._data[0].idSet = "MISSING";
+      hip(result.cakes, true, false);
+      return result;
+    },
+    missingCollectionsTable: () => {
+      const result = _Example.ok.complete();
+      result.cakes._data[0].collections = "MISSING";
+      hip(result.cakes, true, false);
+      return result;
+    },
+    missingLayerCollection: () => {
+      const result = _Example.ok.complete();
+      result.cakes._data[0].layers["layer0"] = "MISSING0";
+      result.cakes._data[0].layers["layer1"] = "MISSING1";
+      hip(result.cakes, true, false);
+      return result;
+    }
+  },
+  buffets: {
+    missingTable: () => {
+      const result = _Example.ok.complete();
+      const buffet = result.buffets._data[0];
+      buffet.items[0].table = "MISSING0";
+      buffet.items[1].table = "MISSING1";
+      hip(buffet, true, false);
+      return result;
+    },
+    missingItems: () => {
+      const result = _Example.ok.complete();
+      const buffet = result.buffets._data[0];
+      buffet.items[0].ref = "MISSING0";
+      buffet.items[1].ref = "MISSING1";
+      hip(buffet, true, false);
+      return result;
+    }
   }
 });
-const exampleRljsonEmpty = () => ({});
-const exampleRljsonWithErrors = () => ({
-  brok$en: {
-    _type: "properties",
-    _data: []
+let Example = _Example;
+// @license
+const rljsonIndexed = (rljson) => {
+  const result = {};
+  for (const key in rljson) {
+    const item = rljson[key];
+    if (typeof item != "object") {
+      result[key] = item;
+      continue;
+    }
+    const dataIndexed = {};
+    result[key] = { ...item };
+    if (!Array.isArray(item._data)) {
+      continue;
+    }
+    for (const row of item._data) {
+      const hashedRow = row._hash ? row : hsh(row);
+      const hash = hashedRow._hash;
+      dataIndexed[hash] = hashedRow;
+    }
+    result[key]._data = dataIndexed;
   }
-});
-const exampleRljsonWithMultipleRows = () => ({
-  table: {
-    _type: "properties",
-    _data: [
-      {
-        string: "str0",
-        boolean: true,
-        number: 1,
-        array: [1, "str0", true, { a: { b: "c" } }],
-        object: { a: { b: "c" } }
-      },
-      {
-        string: "str1",
-        boolean: true,
-        number: 1,
-        array: [1, "str1", true, { a: { b: "c" } }],
-        object: { a: { b: "c" } }
-      },
-      {
-        string: "str2",
-        boolean: false,
-        number: 1,
-        array: [1, "str1", true, { a: { b: "c" } }],
-        object: { d: { e: "f" } }
-      }
-    ]
+  return result;
+};
+// @license
+const reservedFieldNames = ["_type", "_data"];
+const reservedTableNames = ["_hash", "_tables", "_columns"];
+const exampleRljson = () => Example.ok.singleRow();
+const iterateTables = (rljson, callback) => {
+  for (const tableName in rljson) {
+    const value = rljson[tableName];
+    if (typeof value !== "object" || !Array.isArray(value._data)) {
+      continue;
+    }
+    callback(tableName, rljson[tableName]);
   }
-});
+};
+// @license
+const exampleTypedefs = () => {
+  return {
+    ref: "ref",
+    itemId: "itemId",
+    tableName: "tableName",
+    contentType: "collections"
+  };
+};
 export {
-  exampleBinary,
+  Example,
+  exampleBuffetsTable,
+  exampleCakesTable,
+  exampleCollectionsTable,
+  exampleIdSetsTable,
+  examplePropertiesTable,
   exampleRljson,
-  exampleRljsonEmpty,
-  exampleRljsonWithErrors,
-  exampleRljsonWithMultipleRows
+  exampleTypedefs,
+  iterateTables,
+  reservedFieldNames,
+  reservedTableNames,
+  rljsonIndexed
 };