manyfest 1.0.2 → 1.0.3

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

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

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,17 @@ 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.
+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.
+Required | Set to true if this element is required.
 
 ## A More Advanced Schema Example
 
@@ -108,6 +109,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 +120,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.

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "manyfest",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "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-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;