manyfest 1.0.42 → 1.0.44

package/source/Manyfest-HashTranslation.js

@@ -20,6 +20,10 @@ let libSimpleLog = require('./Manyfest-LogToConsole.js');
 */
 class ManyfestHashTranslation
 {
+    /**
+     * @param {function} [pInfoLog] - (optional) A logging function for info messages
+     * @param {function} [pErrorLog] - (optional) A logging function for error messages
+     */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -29,11 +33,17 @@ class ManyfestHashTranslation
         this.translationTable = {};
 	}
 
+    /**
+     * @return {number} The number of translations in the table
+     */
     translationCount()
     {
         return Object.keys(this.translationTable).length;
     }
 
+    /**
+     * @param {object} pTranslation - An object containing source:destination hash pairs to add to the translation table
+     */
     addTranslation(pTranslation)
     {
         // This adds a translation in the form of:
@@ -60,17 +70,23 @@ class ManyfestHashTranslation
             });
     }
 
+    /**
+     * @param {string} pTranslationHash - The source hash to remove from the translation table
+     */
     removeTranslationHash(pTranslationHash)
     {
-        if (pTranslationHash in this.translationTable)
-        {
-            delete this.translationTable[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.
+    /**
+     * This removes translations.
+     * If passed a string, just removes the single one.
+     * If passed an object, it does all the source keys.
+     *
+     * @param {string|object} pTranslation - Either a source hash string to remove, or an object containing source:destination hash pairs to remove
+     *
+     * @return {boolean} True if the removal was successful, false otherwise
+     */
     removeTranslation(pTranslation)
     {
         if (typeof(pTranslation) == 'string')
@@ -101,6 +117,11 @@ class ManyfestHashTranslation
         this.translationTable = {};
     }
 
+    /**
+     * @param {string} pTranslation - The source hash to translate
+     *
+     * @return {string} The translated hash, or the original if no translation exists
+     */
     translate(pTranslation)
     {
         if (pTranslation in this.translationTable)
@@ -114,4 +135,4 @@ class ManyfestHashTranslation
     }
 }
 
-module.exports = ManyfestHashTranslation;
+module.exports = ManyfestHashTranslation;

package/source/Manyfest-ObjectAddress-CheckAddressExists.js

@@ -5,6 +5,8 @@ const libSimpleLog = require('./Manyfest-LogToConsole.js');
 // This is for resolving functions mid-address
 const libGetObjectValue = require('./Manyfest-ObjectAddress-GetValue.js');
 
+const fCleanWrapCharacters = require('./Manyfest-CleanWrapCharacters.js');
+
 // TODO: Just until this is a fable service.
 let _MockFable = { DataFormat: require('./Manyfest-ObjectAddress-Parser.js') };
 
@@ -28,6 +30,10 @@ let _MockFable = { DataFormat: require('./Manyfest-ObjectAddress-Parser.js') };
 */
 class ManyfestObjectAddressResolverCheckAddressExists
 {
+	/**
+	 * @param {function} [pInfoLog] - (optional) Function to use for info logging
+	 * @param {function} [pErrorLog] - (optional) Function to use for error logging
+	 */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -35,15 +41,24 @@ class ManyfestObjectAddressResolverCheckAddressExists
 		this.logError = (typeof(pErrorLog) == 'function') ? pErrorLog : libSimpleLog;
 
 		this.getObjectValueClass = new libGetObjectValue(this.logInfo, this.logError);
+		this.cleanWrapCharacters = fCleanWrapCharacters;
 	}
 
-	// Check if an address exists.
-	//
-	// This is necessary because the getValueAtAddress function is ambiguous on
-	// whether the element/property is actually there or not (it returns
-	// undefined whether the property exists or not).  This function checks for
-	// existance and returns true or false dependent.
-	checkAddressExists (pObject, pAddress, pRootObject)
+	/**
+	 * Check if an address exists.
+	 *
+	 * This is necessary because the getValueAtAddress function is ambiguous on
+	 * whether the element/property is actually there or not (it returns
+	 * undefined whether the property exists or not).  This function checks for
+	 * existance and returns true or false dependent.
+	 *
+	 * @param {object} pObject - The object to check within
+	 * @param {string} pAddress - The address to check for
+	 * @param {object} [pRootObject] - (optional) The root object for function resolution context
+	 *
+	 * @return {boolean} - True if the address exists, false if it does not
+	 */
+	checkAddressExists(pObject, pAddress, pRootObject)
 	{
 		// TODO: Should these throw an error?
 		// Make sure pObject is an object
@@ -193,7 +208,7 @@ class ManyfestObjectAddressResolverCheckAddressExists
 				let tmpFunctionAddress = tmpSubObjectName.substring(0, tmpFunctionStartIndex).trim();
 				//tmpParentAddress = `${tmpParentAddress}${(tmpParentAddress.length > 0) ? '.' : ''}${tmpSubObjectName}`;
 
-				if (!typeof(pObject[tmpFunctionAddress]) == 'function')
+				if (typeof pObject[tmpFunctionAddress] !== 'function')
 				{
 					// The address suggests it is a function, but it is not.
 					return false;
@@ -214,14 +229,14 @@ class ManyfestObjectAddressResolverCheckAddressExists
 						catch(pError)
 						{
 							// The function call failed, so the address doesn't exist
-							libSimpleLog.log(`Error calling function ${tmpFunctionAddress} (address [${pAddress}]): ${pError.message}`);
+							libSimpleLog(`Error calling function ${tmpFunctionAddress} (address [${pAddress}]): ${pError.message}`);
 							return false;
 						}
 					}
 					else
 					{
 						// The function doesn't exist, so the address doesn't exist
-						libSimpleLog.log(`Function ${tmpFunctionAddress} does not exist (address [${pAddress}])`);
+						libSimpleLog(`Function ${tmpFunctionAddress} does not exist (address [${pAddress}])`);
 						return false;
 					}
 				}
@@ -229,7 +244,7 @@ class ManyfestObjectAddressResolverCheckAddressExists
 				{
 					let tmpArgumentValues = [];
 
-					let tmpRootObject = (typeof(pRootObject) == 'undefined') ? pObject : pRootObject;
+
 
 					// Now get the value for each argument
 					for (let i = 0; i < tmpFunctionArguments.length; i++)
@@ -249,14 +264,14 @@ class ManyfestObjectAddressResolverCheckAddressExists
 						catch(pError)
 						{
 							// The function call failed, so the address doesn't exist
-							libSimpleLog.log(`Error calling function ${tmpFunctionAddress} (address [${pAddress}]): ${pError.message}`);
+							libSimpleLog(`Error calling function ${tmpFunctionAddress} (address [${pAddress}]): ${pError.message}`);
 							return false;
 						}
 					}
 					else
 					{
 						// The function doesn't exist, so the address doesn't exist
-						libSimpleLog.log(`Function ${tmpFunctionAddress} does not exist (address [${pAddress}])`);
+						libSimpleLog(`Function ${tmpFunctionAddress} does not exist (address [${pAddress}])`);
 						return false;
 					}
 				}
@@ -336,12 +351,11 @@ class ManyfestObjectAddressResolverCheckAddressExists
 			}
 			else
 			{
-				// Create a subobject and then pass that
-				pObject[tmpSubObjectName] = {};
-				return this.checkAddressExists(pObject[tmpSubObjectName], tmpNewAddress, tmpRootObject);
+				// The sub-object doesn't exist, so the address doesn't exist
+				return false;
 			}
 		}
 	}
-};
+}
 
 module.exports = ManyfestObjectAddressResolverCheckAddressExists;

package/source/Manyfest-ObjectAddress-DeleteValue.js

@@ -5,6 +5,8 @@ let libSimpleLog = require('./Manyfest-LogToConsole.js');
 let fCleanWrapCharacters = require('./Manyfest-CleanWrapCharacters.js');
 let fParseConditionals = require(`../source/Manyfest-ParseConditionals.js`)
 
+let _MockFable = { DataFormat: require('./Manyfest-ObjectAddress-Parser.js') };
+
 /**
 * Object Address Resolver - DeleteValue
 *
@@ -27,6 +29,10 @@ let fParseConditionals = require(`../source/Manyfest-ParseConditionals.js`)
 */
 class ManyfestObjectAddressResolverDeleteValue
 {
+	/**
+	 * @param {function} [pInfoLog] - (optional) A logging function for info messages
+	 * @param {function} [pErrorLog] - (optional) A logging function for error messages
+	 */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -37,12 +43,26 @@ class ManyfestObjectAddressResolverDeleteValue
 	}
 
 	// TODO: Dry me
+	/**
+	 * @param {string} pAddress - The address being evaluated
+	 * @param {object} pRecord - The record being evaluated
+	 *
+	 * @return {boolean} True if the record passes the filters, false if it does not
+	 */
 	checkRecordFilters(pAddress, pRecord)
 	{
 		return fParseConditionals(this, pAddress, pRecord);
 	}
 
-	// Delete the value of an element at an address
+	/**
+	 * Delete the value of an element at an address
+	 *
+	 * @param {object} pObject - The object to delete the value from
+	 * @param {string} pAddress - The address to delete the value at
+	 * @param {string} [pParentAddress] - (optional) The parent address for recursion
+	 *
+	 * @return {boolean|object|undefined} - True if the value was deleted, false if it could not be deleted, undefined on error
+	 */
 	deleteValueAtAddress (pObject, pAddress, pParentAddress)
 	{
 		// Make sure pObject (the object we are meant to be recursing) is an object (which could be an array or object)
@@ -56,11 +76,11 @@ class ManyfestObjectAddressResolverDeleteValue
 			tmpParentAddress = pParentAddress;
 		}
 
-		// TODO: Make this work for things like SomeRootObject.Metadata["Some.People.Use.Bad.Object.Property.Names"]
-		let tmpSeparatorIndex = pAddress.indexOf('.');
+		// Use enclosure-aware parser to find the first segment separator
+		let tmpAddressPartBeginning = _MockFable.DataFormat.stringGetFirstSegment(pAddress);
 
 		// This is the terminal address string (no more dots so the RECUSION ENDS IN HERE somehow)
-		if (tmpSeparatorIndex == -1)
+		if (tmpAddressPartBeginning.length == pAddress.length)
 		{
 			// Check if the address refers to a boxed property
 			let tmpBracketStartIndex = pAddress.indexOf('[');
@@ -183,8 +203,8 @@ class ManyfestObjectAddressResolverDeleteValue
 		}
 		else
 		{
-			let tmpSubObjectName = pAddress.substring(0, tmpSeparatorIndex);
-			let tmpNewAddress = pAddress.substring(tmpSeparatorIndex+1);
+			let tmpSubObjectName = tmpAddressPartBeginning;
+			let tmpNewAddress = pAddress.substring(tmpAddressPartBeginning.length+1);
 
 			// BOXED ELEMENTS
 			// Test if the tmpNewAddress is an array or object
@@ -352,4 +372,4 @@ class ManyfestObjectAddressResolverDeleteValue
 	}
 };
 
-module.exports = ManyfestObjectAddressResolverDeleteValue;
+module.exports = ManyfestObjectAddressResolverDeleteValue;

package/source/Manyfest-ObjectAddress-GetValue.js

@@ -29,6 +29,10 @@ let _MockFable = { DataFormat: require('./Manyfest-ObjectAddress-Parser.js') };
 */
 class ManyfestObjectAddressResolverGetValue
 {
+	/**
+	 * @param {function} [pInfoLog] - (optional) A logging function for info messages
+	 * @param {function} [pErrorLog] - (optional) A logging function for error messages
+	 */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -38,12 +42,27 @@ class ManyfestObjectAddressResolverGetValue
 		this.cleanWrapCharacters = fCleanWrapCharacters;
 	}
 
+	/**
+	 * @param {string} pAddress - The address of the record to check
+	 * @param {object} pRecord - The record to check against the filters
+	 *
+	 * @return {boolean} - True if the record passes the filters, false otherwise
+	 */
 	checkRecordFilters(pAddress, pRecord)
 	{
 		return fParseConditionals(this, pAddress, pRecord);
 	}
 
-	// Get the value of an element at an address
+	/**
+	 * Get the value of an element at an address
+	 *
+	 * @param {object} pObject - The object to resolve the address against
+	 * @param {string} pAddress - The address to resolve
+	 * @param {string} [pParentAddress] - (optional) The parent address for back-navigation
+	 * @param {object} [pRootObject] - (optional) The root object for function argument resolution
+	 *
+	 * @return {any} The value at the address, or undefined if not found
+	 */
 	getValueAtAddress (pObject, pAddress, pParentAddress, pRootObject)
 	{
 		// Make sure pObject (the object we are meant to be recursing) is an object (which could be an array or object)
@@ -150,7 +169,7 @@ class ManyfestObjectAddressResolverGetValue
 			{
 				let tmpFunctionAddress = pAddress.substring(0, tmpFunctionStartIndex).trim();
 
-				if (!typeof(pObject[tmpFunctionAddress]) == 'function')
+				if (typeof pObject[tmpFunctionAddress] !== 'function')
 				{
 					// The address suggests it is a function, but it is not.
 					return false;
@@ -186,8 +205,6 @@ class ManyfestObjectAddressResolverGetValue
 				{
 					let tmpArgumentValues = [];
 
-					let tmpRootObject = (typeof(pRootObject) == 'undefined') ? pObject : pRootObject;
-
 					// Now get the value for each argument
 					for (let i = 0; i < tmpFunctionArguments.length; i++)
 					{
@@ -339,13 +356,13 @@ class ManyfestObjectAddressResolverGetValue
 			else
 			{
 				// Now is the point in recursion to return the value in the address
-				if (typeof(pObject[pAddress]) != null)
+				if (typeof(pObject[pAddress]) != 'undefined')
 				{
 					return pObject[pAddress];
 				}
 				else
 				{
-					return null;
+					return undefined;
 				}
 			}
 		}
@@ -384,7 +401,7 @@ class ManyfestObjectAddressResolverGetValue
 				let tmpFunctionAddress = tmpSubObjectName.substring(0, tmpFunctionStartIndex).trim();
 				tmpParentAddress = `${tmpParentAddress}${(tmpParentAddress.length > 0) ? '.' : ''}${tmpSubObjectName}`;
 
-				if (!typeof(pObject[tmpFunctionAddress]) == 'function')
+				if (typeof pObject[tmpFunctionAddress] !== 'function')
 				{
 					// The address suggests it is a function, but it is not.
 					return false;
@@ -420,8 +437,6 @@ class ManyfestObjectAddressResolverGetValue
 				{
 					let tmpArgumentValues = [];
 
-					let tmpRootObject = (typeof(pRootObject) == 'undefined') ? pObject : pRootObject;
-
 					// Now get the value for each argument
 					for (let i = 0; i < tmpFunctionArguments.length; i++)
 					{
@@ -631,4 +646,4 @@ class ManyfestObjectAddressResolverGetValue
 	}
 };
 
-module.exports = ManyfestObjectAddressResolverGetValue;
+module.exports = ManyfestObjectAddressResolverGetValue;

package/source/Manyfest-ObjectAddress-Parser.js

@@ -8,15 +8,19 @@
 // Until we shift Manyfest to be a fable service, these three functions were pulled out of
 // fable to aid in parsing functions with nested enclosures.
 
+const DEFAULT_START_SYMBOL_MAP = { '{': 0, '[': 1, '(': 2 };
+const DEFAULT_END_SYMBOL_MAP = { '}': 0, ']': 1, ')': 2 };
+
 module.exports = {
 	/**
 	 * Count the number of segments in a string, respecting enclosures
-	 * 
-	 * @param {string} pString 
-	 * @param {string} pSeparator 
-	 * @param {object} pEnclosureStartSymbolMap 
-	 * @param {object} pEnclosureEndSymbolMap 
-	 * @returns the count of segments in the string as a number
+	 *
+	 * @param {string} pString
+	 * @param {string} [pSeparator]
+	 * @param {Record<string, number>} [pEnclosureStartSymbolMap]
+	 * @param {Record<string, number>} [pEnclosureEndSymbolMap]
+	 *
+	 * @return {number} - The number of segments in the string
 	 */
 	stringCountSegments: (pString, pSeparator, pEnclosureStartSymbolMap, pEnclosureEndSymbolMap) =>
 	{
@@ -24,10 +28,10 @@ module.exports = {
 
 		let tmpSeparator = (typeof(pSeparator) == 'string') ? pSeparator : '.';
 
-		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStart : { '{': 0, '[': 1, '(': 2 };
-		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEnd : { '}': 0, ']': 1, ')': 2 };
+		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStartSymbolMap : DEFAULT_START_SYMBOL_MAP;
+		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEndSymbolMap : DEFAULT_END_SYMBOL_MAP;
 
-		if (pString.length < 1)
+		if (tmpString.length < 1)
 		{
 			return 0;
 		}
@@ -66,12 +70,13 @@ module.exports = {
 
 	/**
 	 * Get the first segment in a string, respecting enclosures
-	 * 
-	 * @param {string} pString 
-	 * @param {string} pSeparator 
-	 * @param {object} pEnclosureStartSymbolMap 
-	 * @param {object} pEnclosureEndSymbolMap 
-	 * @returns the first segment in the string as a string
+	 *
+	 * @param {string} pString
+	 * @param {string} [pSeparator]
+	 * @param {Record<string, number>} [pEnclosureStartSymbolMap]
+	 * @param {Record<string, number>} [pEnclosureEndSymbolMap]
+	 *
+	 * @return {string} - the first segment in the string as a string
 	 */
 	stringGetFirstSegment: (pString, pSeparator, pEnclosureStartSymbolMap, pEnclosureEndSymbolMap) =>
 	{
@@ -79,12 +84,12 @@ module.exports = {
 
 		let tmpSeparator = (typeof(pSeparator) == 'string') ? pSeparator : '.';
 
-		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStart : { '{': 0, '[': 1, '(': 2 };
-		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEnd : { '}': 0, ']': 1, ')': 2 };
+		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStartSymbolMap : DEFAULT_START_SYMBOL_MAP;
+		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEndSymbolMap : DEFAULT_END_SYMBOL_MAP;
 
-		if (pString.length < 1)
+		if (tmpString.length < 1)
 		{
-			return 0;
+			return '';
 		}
 
 		let tmpEnclosureStack = [];
@@ -120,26 +125,27 @@ module.exports = {
 
 	/**
 	 * Get all segments in a string, respecting enclosures
-	 * 
-	 * @param {string} pString 
-	 * @param {string} pSeparator 
-	 * @param {object} pEnclosureStartSymbolMap 
-	 * @param {object} pEnclosureEndSymbolMap 
-	 * @returns the first segment in the string as a string
+	 *
+	 * @param {string} pString
+	 * @param {string} [pSeparator]
+	 * @param {Record<string, number>} [pEnclosureStartSymbolMap]
+	 * @param {Record<string, number>} [pEnclosureEndSymbolMap]
+	 *
+	 * @return {Array<string>} - the segments in the string as an array of strings
 	 */
-	stringGetSegments: (pString, pSeparator, pEnclosureStartSymbolMap, pEnclosureEndSymbolMap)=>
+	stringGetSegments: (pString, pSeparator, pEnclosureStartSymbolMap, pEnclosureEndSymbolMap) =>
 	{
 		let tmpString = (typeof(pString) == 'string') ? pString : '';
 
 		let tmpSeparator = (typeof(pSeparator) == 'string') ? pSeparator : '.';
 
-		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStart : { '{': 0, '[': 1, '(': 2 };
-		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEnd : { '}': 0, ']': 1, ')': 2 };
+		let tmpEnclosureStartSymbolMap = (typeof(pEnclosureStartSymbolMap) == 'object') ? pEnclosureStartSymbolMap : DEFAULT_START_SYMBOL_MAP;
+		let tmpEnclosureEndSymbolMap = (typeof(pEnclosureEndSymbolMap) == 'object') ? pEnclosureEndSymbolMap : DEFAULT_END_SYMBOL_MAP;
 
 		let tmpCurrentSegmentStart = 0;
 		let tmpSegmentList = [];
 
-		if (pString.length < 1)
+		if (tmpString.length < 1)
 		{
 			return tmpSegmentList;
 		}
@@ -187,8 +193,8 @@ module.exports = {
 	 * If no start or end characters are specified, it will default to parentheses.  If the string is not a string, it will return 0.
 	 *
 	 * @param {string} pString
-	 * @param {string} pEnclosureStart
-	 * @param {string} pEnclosureEnd
+	 * @param {string} [pEnclosureStart]
+	 * @param {string} [pEnclosureEnd]
 	 * @returns the count of full in the string
 	 */
 	stringCountEnclosures: (pString, pEnclosureStart, pEnclosureEnd) =>
@@ -227,9 +233,10 @@ module.exports = {
 	 *
 	 * @param {string} pString
 	 * @param {number} pEnclosureIndexToGet
-	 * @param {string} pEnclosureStart
-	 * @param {string}} pEnclosureEnd
-	 * @returns {string}
+	 * @param {string} [pEnclosureStart]
+	 * @param {string} [pEnclosureEnd]
+	 *
+	 * @return {string} - The value of the enclosure at the specified index
 	 */
 	stringGetEnclosureValueByIndex: (pString, pEnclosureIndexToGet, pEnclosureStart, pEnclosureEnd) =>
 	{
@@ -295,4 +302,4 @@ module.exports = {
 			return tmpString.substring(tmpEnclosedValueStartIndex+1);
 		}
 	}
-}
+}

package/source/Manyfest-ObjectAddress-SetValue.js

@@ -4,6 +4,8 @@
 let libSimpleLog = require('./Manyfest-LogToConsole.js');
 let fCleanWrapCharacters = require('./Manyfest-CleanWrapCharacters.js');
 
+let _MockFable = { DataFormat: require('./Manyfest-ObjectAddress-Parser.js') };
+
 /**
 * Object Address Resolver - SetValue
 *
@@ -24,6 +26,10 @@ let fCleanWrapCharacters = require('./Manyfest-CleanWrapCharacters.js');
 */
 class ManyfestObjectAddressSetValue
 {
+	/**
+	 * @param {function} [pInfoLog] - (optional) A logging function for info messages
+	 * @param {function} [pErrorLog] - (optional) A logging function for error messages
+	 */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -33,7 +39,15 @@ class ManyfestObjectAddressSetValue
 		this.cleanWrapCharacters = fCleanWrapCharacters;
 	}
 
-	// Set the value of an element at an address
+	/**
+	 * Set the value of an element at an address
+	 *
+	 * @param {object} pObject - The object to set the value in
+	 * @param {string} pAddress - The address to set the value at
+	 * @param {any} pValue - The value to set at the address
+	 *
+	 * @return {boolean} True if the value was set, false otherwise
+	 */
 	setValueAtAddress (pObject, pAddress, pValue)
 	{
 		// Make sure pObject is an object
@@ -41,9 +55,10 @@ class ManyfestObjectAddressSetValue
 		// Make sure pAddress is a string
 		if (typeof(pAddress) != 'string') return false;
 
-		let tmpSeparatorIndex = pAddress.indexOf('.');
+		// Use enclosure-aware parser to find the first segment separator
+		let tmpAddressPartBeginning = _MockFable.DataFormat.stringGetFirstSegment(pAddress);
 
-		if (tmpSeparatorIndex == -1)
+		if (tmpAddressPartBeginning.length == pAddress.length)
 		{
 			// Check if it's a boxed property
 			let tmpBracketStartIndex = pAddress.indexOf('[');
@@ -143,8 +158,8 @@ class ManyfestObjectAddressSetValue
 		}
 		else
 		{
-			let tmpSubObjectName = pAddress.substring(0, tmpSeparatorIndex);
-			let tmpNewAddress = pAddress.substring(tmpSeparatorIndex+1);
+			let tmpSubObjectName = tmpAddressPartBeginning;
+			let tmpNewAddress = pAddress.substring(tmpAddressPartBeginning.length+1);
 
 			// Test if the tmpNewAddress is an array or object
 			// Check if it's a boxed property
@@ -261,4 +276,4 @@ class ManyfestObjectAddressSetValue
 	}
 };
 
-module.exports = ManyfestObjectAddressSetValue;
+module.exports = ManyfestObjectAddressSetValue;

package/source/Manyfest-ObjectAddressGeneration.js

@@ -27,6 +27,10 @@ let libSimpleLog = require('./Manyfest-LogToConsole.js');
 */
 class ManyfestObjectAddressGeneration
 {
+	/**
+	 * @param {function} [pInfoLog] - (optional) A logging function for info messages
+	 * @param {function} [pErrorLog] - (optional) A logging function for error messages
+	 */
 	constructor(pInfoLog, pErrorLog)
 	{
 		// Wire in logging
@@ -34,15 +38,23 @@ class ManyfestObjectAddressGeneration
 		this.logError = (typeof(pErrorLog) == 'function') ? pErrorLog : libSimpleLog;
 	}
 
-	// generateAddressses
-	//
-	// This flattens an object into a set of key:value pairs for *EVERY SINGLE
-	// POSSIBLE ADDRESS* in the object.  It can get ... really insane really
-	// quickly.  This is not meant to be used directly to generate schemas, but
-	// instead as a starting point for scripts or UIs.
-	//
-	// This will return a mega set of key:value pairs with all possible schema
-	// permutations and default values (when not an object) and everything else.
+	/**
+	 * generateAddressses
+	 *
+	 * This flattens an object into a set of key:value pairs for *EVERY SINGLE
+	 * POSSIBLE ADDRESS* in the object.  It can get ... really insane really
+	 * quickly.  This is not meant to be used directly to generate schemas, but
+	 * instead as a starting point for scripts or UIs.
+	 *
+	 * This will return a mega set of key:value pairs with all possible schema
+	 * permutations and default values (when not an object) and everything else.
+	 *
+	 * @param {any} pObject - The object to generate addresses for
+	 * @param {string} [pBaseAddress] - (optional) The base address to start from
+	 * @param {object} [pSchema] - (optional) The schema object to append to
+	 *
+	 * @return {object} The generated schema object
+	 */
 	generateAddressses (pObject, pBaseAddress, pSchema)
 	{
 		let tmpBaseAddress = (typeof(pBaseAddress) == 'string') ? pBaseAddress : '';
@@ -62,7 +74,7 @@ class ManyfestObjectAddressGeneration
 
 		if ((tmpObjectType == 'object') && (pObject == null))
 		{
-			tmpObjectType = 'null';
+			tmpObjectType = 'undefined';
 		}
 
 		switch(tmpObjectType)
@@ -79,7 +91,6 @@ class ManyfestObjectAddressGeneration
 				tmpSchema[tmpBaseAddress] = tmpSchemaObjectEntry;
 				break;
 			case 'undefined':
-			case 'null':
 				tmpSchemaObjectEntry.DataType = 'Any';
 				tmpSchemaObjectEntry.Default = pObject;
 				tmpSchema[tmpBaseAddress] = tmpSchemaObjectEntry;
@@ -125,4 +136,4 @@ class ManyfestObjectAddressGeneration
 	}
 };
 
-module.exports = ManyfestObjectAddressGeneration;
+module.exports = ManyfestObjectAddressGeneration;