manyfest 1.0.2 → 1.0.4

package/.config/configstore/update-notifier-npm.json

@@ -1,4 +1,4 @@
 {
 	"optOut": false,
-	"lastUpdateCheck": 1665021956542
+	"lastUpdateCheck": 1665932798321
 }

package/README.md

@@ -46,7 +46,7 @@ let animalManyfest = new libManyfest(
         "Scope": "Animal",
         "Descriptors":
             {
-                "IDAnimal": { "Name":"Database ID", "Description":"The unique integer-based database identifier for an Animal record.", "DataType":"Integer" },
+                "IDAnimal": { "Name":"Database ID", "Description":"The unique integer-based database identifier for an Animal record.", "DataType":"Integer", "Default":0 },
                 "Name": { "Description":"The animal's colloquial species name (e.g. Rabbit, Dog, Bear, Mongoose)." },
                 "Type": { "Description":"Whether or not the animal is wild, domesticated, agricultural, in a research lab or a part of a zoo.." }
             }
@@ -70,16 +70,19 @@ Error does not mean the software throws an exception.  It comes back as well-for
 Below is a lexicon of terms used throughout this documentation.  If you see anything missing, want more elaboration or just dislike a particular term, please file an issue in github!
 
 | Term | Description |
-| Scope | The scope of this representation; generally the clustered or parent record name (e.g. Animal, User, Transaction, etc.) -- does not have functional purpose; only for information and logging. |
-| Schema | The stateful representation of an object's structural definition. |
-| Element | A defined element of data in an object. |
-| Address | The address where that data lies in the object. |
-| Descriptor | A description of an element including data such as Name, NameShort, Hash, Description, and other important properties. |
-| Name | The name of the element.  Meant to be the most succinct human readable name possible. |
-| NameShort | A shorter name for the element.  Meant to be useful enough to identify the property in log lines, tabular views, graphs and anywhere where we don't always want to see the full name. |
-| Description | A description for the element.  Very useful when consuming other APIs with their own terse naming standards (or no naming standards)! |
-| Hash | A unique within this scope string-based key for this element.  Used for easy access of data. |
-| Constraint | A validation constraint for an element such as MaxLength, MinLength, Required, Default and such. |
+| ---- | ----------- |
+Scope | The scope of this representation; generally the clustered or parent record name (e.g. Animal, User, Transaction, etc.) -- does not have functional purpose; only for information and logging.
+Schema | The stateful representation of an object's structural definition.
+Element | A defined element of data in an object.
+Address | The address where that data lies in the object.
+Hash | A unique within this scope string-based key for this element.  Used for easy access of data.
+Descriptor | A description of an element including data such as Name, NameShort, Hash, Description, and other important properties.
+Name | The name of the element.  Meant to be the most succinct human readable name possible.
+NameShort | A shorter name for the element.  Meant to be useful enough to identify the property in log lines, tabular views, graphs and anywhere where we don't always want to see the full name.
+Description | A description for the element.  Very useful when consuming other APIs with their own terse naming standards (or no naming standards)!
+Required | Set to true if this element is required.
+
+Okay so these are a lot of crazy words.  The important two are *Address* and *Hash*.  Every element in a schema must have an address.  Having a hash just multiplies the usefulness of these addresses.
 
 ## A More Advanced Schema Example
 
@@ -108,6 +111,7 @@ let animalManyfest = new libManyfest(
                         "Name":"Comfortable Environmental Temperature",
                         "NameShort":"Comf Env Temp",
                         "Hash":"ComfET",
+                        "DataType":"Float",
                         "Description":"The most comfortable temperature for this animal to survive in."
                     }
             }
@@ -118,6 +122,22 @@ Notice in this example, the addresses are more complex.  They have a dot syntax.
 
 To aid in this discovery, reference and such, we've given it a NameShort (for use in things like tabular views and graphs/charts), a longer Name and a Hash (to enable easy reading and writing using the object element read/write functions described later in this documentation).
 
+### Data Types
+
+| Type | Description |
+| ---- | ----------- |
+String | A pretty basic string
+Integer | An integer number
+Float | A floating point number; does not require a decimal point
+Number | A number of any type
+Boolean | A boolean value represented by the JSON true or false
+Binary | A boolean value represented as 1 or 0
+YesNo | A boolean value represented as Y or N
+DateTime | A javascript date
+Array | A plain old javascript array
+Object | A plain old javascript object
+Null | A null value
+
 ## Reading and Writing Element Properties
 
 Lastly, when working with objects, Manyfest provides a set of functions to read and write from/to these element addresses.  This can be useful for consistently accessing objects across boundaries as well as filling out element defaults without requiring a crazy amount of boilerplate code.
@@ -187,6 +207,10 @@ console.log(animalManyfest.getValueByHash(favAnimal,'ComfET'));
 
 For any elements that haven't defined a Hash, the Address is used.  This allows code to gracefully fall back.
 
+## Hash Translation Tables
+
+Sometimes we want to reuse the structure of a schema, but look up values by hash using translations.
+
 ## Programmatically Defining a Schema
 
 Sometimes we don't have schemas, and want to define object element structure on the fly.  This can be done programmatically.  As a refresher, here is how we loaded our simplest schema manifest above:

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "manyfest",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "JSON Object Manifest for Data Description and Parsing",
   "main": "source/Manyfest.js",
   "scripts": {
     "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/manyfest:local",
     "docker-dev-run": "docker run -it -d --name manyfest -p 12340:8080 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/manyfest\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/manyfest:local",
     "test": "./node_modules/mocha/bin/_mocha -u tdd -R spec",
-    "tests": "./node_modules/mocha/bin/_mocha -u tdd -R spec --grep"
+    "tests": "./node_modules/mocha/bin/_mocha -u tdd -R spec --grep",
+    "coverage": "nyc npm run test && nyc report --reporter=lcov"
   },
   "repository": {
     "type": "git",

package/source/Manyfest-HashTranslation.js

@@ -0,0 +1,118 @@
+/**
+* @license MIT
+* @author <steven@velozo.com>
+*/
+let libSimpleLog = require('./Manyfest-LogToConsole.js');
+
+/**
+* Hash Translation
+*
+* This is a very simple translation table for hashes, which allows the same schema to resolve 
+* differently based on a loaded translation table.
+*
+* This is to prevent the requirement for mutating schemas over and over again when we want to
+* reuse the structure but look up data elements by different addresses.
+*
+* One side-effect of this is that a translation table can "override" the built-in hashes, since
+* this is always used to resolve hashes before any of the functionCallByHash(pHash, ...) perform
+* their lookups by hash.
+*
+* @class ManyfestHashTranslation
+*/
+class ManyfestHashTranslation
+{
+	constructor(pInfoLog, pErrorLog)
+	{
+		// Wire in logging
+		this.logInfo = (typeof(pInfoLog) === 'function') ? pInfoLog : libSimpleLog;
+		this.logError = (typeof(pErrorLog) === 'function') ? pErrorLog : libSimpleLog;
+
+        this.translationTable = {};
+	}
+
+    translationCount()
+    {
+        return Object.keys(this.translationTable).length;
+    }
+
+    addTranslation(pTranslation)
+    {
+        // This adds a translation in the form of:
+        // { "SourceHash": "DestinationHash", "SecondSourceHash":"SecondDestinationHash" }
+        if (typeof(pTranslation) != 'object')
+        {
+            this.logError(`Hash translation addTranslation expected a translation be type object but was passed in ${typeof(pTranslation)}`);
+            return false;
+        }
+
+        let tmpTranslationSources = Object.keys(pTranslation)
+
+        tmpTranslationSources.forEach(
+            (pTranslationSource) =>
+            {
+                if (typeof(pTranslation[pTranslationSource]) != 'string')
+                {
+                    this.logError(`Hash translation addTranslation expected a translation destination hash for [${pTranslationSource}] to be a string but the referrant was a ${typeof(pTranslation[pTranslationSource])}`);
+                }
+                else
+                {
+                    this.translationTable[pTranslationSource] = pTranslation[pTranslationSource];
+                }
+            });
+    }
+
+    removeTranslationHash(pTranslationHash)
+    {
+        if (this.translationTable.hasOwnProperty(pTranslationHash))
+        {
+            delete this.translationTable[pTranslationHash];
+        }
+    }
+
+    // This removes translations.
+    // If passed a string, just removes the single one.
+    // If passed an object, it does all the source keys.
+    removeTranslation(pTranslation)
+    {
+        if (typeof(pTranslation) == 'string')
+        {
+            this.removeTranslationHash(pTranslation);
+            return true;
+        }
+        else if (typeof(pTranslation) == 'object')
+        {
+            let tmpTranslationSources = Object.keys(pTranslation)
+
+            tmpTranslationSources.forEach(
+                (pTranslationSource) =>
+                {
+                    this.removeTranslation(pTranslationSource);
+                });
+            return true;
+        }
+        else
+        {
+            this.logError(`Hash translation removeTranslation expected either a string or an object but the passed-in translation was type ${typeof(pTranslation)}`);
+            return false;
+        }
+    }
+
+    clearTranslations()
+    {
+        this.translationTable = {};
+    }
+
+    translate(pTranslation)
+    {
+        if (this.translationTable.hasOwnProperty(pTranslation))
+        {
+            return this.translationTable[pTranslation];
+        }
+        else
+        {
+            return pTranslation;
+        }
+    }
+}
+
+module.exports = ManyfestHashTranslation;

package/source/Manyfest-LogToConsole.js

@@ -13,7 +13,7 @@ const logToConsole = (pLogLine, pLogObject) =>
 
     console.log(`[Manyfest] ${tmpLogLine}`);
 
-    if (pLogObject) console.log(JSON.stringify(tmpLogObject,null,4)+"\n");
+    if (pLogObject) console.log(JSON.stringify(pLogObject));
 };
 
 module.exports = logToConsole;