@leaddreamer/inventorylogic 0.0.3-beta.39 → 0.0.3-beta.40

package/README.md

@@ -62,6 +62,10 @@ users</p>
 <dd><p>Typedefs, constants, support functions and database operations related to usage Units
 and conversions</p>
 </dd>
+<dt><a href="#module_Utilities">Utilities</a></dt>
+<dd><p>Typedefs, constants, support functions and database operations for
+general Utilities</p>
+</dd>
 <dt><a href="#module_Boilerplate">Boilerplate</a></dt>
 <dd><p>Shared constants and symbols</p>
 </dd>
@@ -2422,11 +2426,29 @@ and conversions
         * [.saveForm(type)](#module_Utilities.saveForm) ⇒ <code>callback</code>
         * [.updateChangeForm(type)](#module_Utilities.updateChangeForm) ⇒ <code>callback</code>
         * [.choicesForm(fieldname)](#module_Utilities.choicesForm) ⇒ <code>object</code>
+        * [.saveHost(host)](#module_Utilities.saveHost) ⇒ <code>Promise.OrganizationType</code>
+        * [.simpleObjectCompare(object1, object2)](#module_Utilities.simpleObjectCompare) ⇒ <code>boolean</code>
+        * [.formatItem(thisItem, thisFormat)](#module_Utilities.formatItem) ⇒ <code>string</code>
+        * [.compare(thisItem, anotherItem, sort)](#module_Utilities.compare) ⇒ <code>string</code>
+        * [.anyInAny(findFrom, findIn)](#module_Utilities.anyInAny) ⇒ <code>boolean</code>
+        * [.PromisePoolRunner(entryArray, actionFunction, promiseOptions)](#module_Utilities.PromisePoolRunner) ⇒ <code>Promise</code>
+        * [.lesserOf(args)](#module_Utilities.lesserOf) ⇒ <code>number</code>
+        * [.largerOf(args)](#module_Utilities.largerOf) ⇒ <code>number</code>
+        * [.archiveRecord(record)](#module_Utilities.archiveRecord) ⇒ <code>Promise</code>
+        * [.refPathToBaseRecord(refPath)](#module_Utilities.refPathToBaseRecord) ⇒ <code>RecordDocument</code>
+        * [.bound(value, lowerBound, upperBound)](#module_Utilities.bound) ⇒ <code>number</code>
+        * [.blindPush(targetArray, newObject)](#module_Utilities.blindPush)
+        * [.addToArrayObject(arrayObject, key, object)](#module_Utilities.addToArrayObject)
+        * [.makeHexAsNeeded(color)](#module_Utilities.makeHexAsNeeded) ⇒ <code>string</code>
     * _inner_
+        * [~PromisePool](#module_Utilities..PromisePool)
+        * [~promiseOptionsDefault](#module_Utilities..promiseOptionsDefault) : <code>PromiseOptions</code>
         * [~stripDocIdFromRefPath(refPath)](#module_Utilities..stripDocIdFromRefPath) ⇒ <code>string</code>
         * [~UpdateChange
 Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceObject)](#module_Utilities..UpdateChange
 Function Signature for UpdateChange functions) ⇒ <code>object</code>
+        * [~generateIterator(entryArray, actionFunction)](#module_Utilities..generateIterator)
+        * [~PromiseOptions](#module_Utilities..PromiseOptions) : <code>object</code>
 
 <a name="module_Utilities.recordByIdAndType"></a>
 
@@ -2677,6 +2699,182 @@ usage are defined in business logic elsewhere
 | --- | --- | --- |
 | fieldname | <code>string</code> | which business type is being processes |
 
+<a name="module_Utilities.saveHost"></a>
+
+### Utilities.saveHost(host) ⇒ <code>Promise.OrganizationType</code>
+A convenience function for some shared artist/host front-end pages
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| host | <code>OrganizationType</code> | 
+
+<a name="module_Utilities.simpleObjectCompare"></a>
+
+### Utilities.simpleObjectCompare(object1, object2) ⇒ <code>boolean</code>
+Simple top-level object compare - assumes objects have similar structure - or
+AT LEAST all the fields of object1 are present in object2
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| object1 | <code>object</code> | 
+| object2 | <code>object</code> | 
+
+<a name="module_Utilities.formatItem"></a>
+
+### Utilities.formatItem(thisItem, thisFormat) ⇒ <code>string</code>
+Allows string substitution from an object
+field names support Dot notation
+field names allow ":" extension for alternate formatting
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| thisItem | <code>object</code> | object to create formated string from |
+| thisFormat | <code>string</code> | string describing formatted output - fieldname wrapped in {} will be substituted.  DOT notation allowed for fields. |
+
+<a name="module_Utilities.compare"></a>
+
+### Utilities.compare(thisItem, anotherItem, sort) ⇒ <code>string</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| thisItem | <code>object</code> | one of two objects being compared |
+| anotherItem | <code>object</code> | the other of two objects being compared |
+| sort | <code>string</code> | string describing sort - format "fieldName:sortType" - sort Type is "string, "date" or "number" (default) |
+
+<a name="module_Utilities.anyInAny"></a>
+
+### Utilities.anyInAny(findFrom, findIn) ⇒ <code>boolean</code>
+An array based compare function - is any entry of findFrom present in findIn
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| findFrom | <code>Array.any</code> | 
+| findIn | <code>Array.any</code> | 
+
+<a name="module_Utilities.PromisePoolRunner"></a>
+
+### Utilities.PromisePoolRunner(entryArray, actionFunction, promiseOptions) ⇒ <code>Promise</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| entryArray | <code>Array.object</code> | 
+| actionFunction | <code>callback</code> | 
+| promiseOptions | <code>PromiseOptions</code> | 
+
+<a name="module_Utilities.lesserOf"></a>
+
+### Utilities.lesserOf(args) ⇒ <code>number</code>
+A convenience function for legibility
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>number</code> - the least of any of the arguments
+b  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>any</code> | unbounded list of arguments |
+
+<a name="module_Utilities.largerOf"></a>
+
+### Utilities.largerOf(args) ⇒ <code>number</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>number</code> - the largest of any of the arguments  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>any</code> | unbounded list of arguments |
+
+<a name="module_Utilities.archiveRecord"></a>
+
+### Utilities.archiveRecord(record) ⇒ <code>Promise</code>
+"Moves" a record from our standard tree structureto a parallel archival
+structure, by prepending a "_" to the collection names in the path
+This prevents the archived record from appearing in collectionGroup queries
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| record | <code>RecordDocument</code> | 
+| record.refPath | <code>string</code> | 
+
+<a name="module_Utilities.refPathToBaseRecord"></a>
+
+### Utilities.refPathToBaseRecord(refPath) ⇒ <code>RecordDocument</code>
+uses a passed refPath to create the most basic document record form
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| refPath | <code>string</code> | "/" separated document path reference |
+
+<a name="module_Utilities.bound"></a>
+
+### Utilities.bound(value, lowerBound, upperBound) ⇒ <code>number</code>
+clips value to given bounds
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| value | <code>number</code> | 
+| lowerBound | <code>number</code> | 
+| upperBound | <code>number</code> | 
+
+<a name="module_Utilities.blindPush"></a>
+
+### Utilities.blindPush(targetArray, newObject)
+function to push an element to an array which may not be initialized
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| targetArray | <code>Array.object</code> | 
+| newObject | <code>object</code> | 
+
+<a name="module_Utilities.addToArrayObject"></a>
+
+### Utilities.addToArrayObject(arrayObject, key, object)
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arrayObject | <code>Array.Array.object</code> |  |
+| key | <code>string</code> | key or index to choose which Array.object to add *this* object to |
+| object | <code>object</code> |  |
+
+<a name="module_Utilities.makeHexAsNeeded"></a>
+
+### Utilities.makeHexAsNeeded(color) ⇒ <code>string</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>string</code> - hex value of named color  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| color | <code>string</code> | name of color |
+
+<a name="module_Utilities..PromisePool"></a>
+
+### Utilities~PromisePool
+**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)  
+<a name="module_Utilities..promiseOptionsDefault"></a>
+
+### Utilities~promiseOptionsDefault : <code>PromiseOptions</code>
+**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)  
+**Default**: <code>{&quot;concurrency&quot;:3,&quot;rate&quot;:10}</code>  
+**Read only**: true  
 <a name="module_Utilities..stripDocIdFromRefPath"></a>
 
 ### Utilities~stripDocIdFromRefPath(refPath) ⇒ <code>string</code>
@@ -2703,6 +2901,560 @@ Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceOb
 | itemFor | <code>string</code> | 
 | fullChoiceObject | <code>object</code> | 
 
+<a name="module_Utilities..generateIterator"></a>
+
+### Utilities~generateIterator(entryArray, actionFunction)
+An Action Iterator Generator.  Cycles through the entries in the passed array,
+yielding the result of a function for each entry.
+Only cares that inputs are an array, and a function that returns a
+promise
+
+**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| entryArray | <code>Array.any</code> | 
+| actionFunction | <code>callback</code> | 
+
+<a name="module_Utilities..PromiseOptions"></a>
+
+### Utilities~PromiseOptions : <code>object</code>
+**Kind**: inner typedef of [<code>Utilities</code>](#module_Utilities)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| concurrency | <code>number</code> | 
+| rate | <code>number</code> | 
+
+<a name="module_Utilities"></a>
+
+## Utilities
+Typedefs, constants, support functions and database operations for
+general Utilities
+
+
+* [Utilities](#module_Utilities)
+    * _static_
+        * [.recordByIdAndType](#module_Utilities.recordByIdAndType) ⇒ <code>AccountType</code>
+        * [.fetchLinkedItem(type, link, refPath)](#module_Utilities.fetchLinkedItem) ⇒ <code>Promise.RecordDocument</code>
+        * [.fetchSubItem(type, refPath)](#module_Utilities.fetchSubItem) ⇒ <code>Promise.RecordDocument</code>
+        * [.fetchType(type, refPath)](#module_Utilities.fetchType) ⇒ <code>Promise.Array.RecordDocument</code>
+        * [.searchType(type, parent, prompt, limit)](#module_Utilities.searchType) ⇒ <code>Promise.Array.OrganizationType</code>
+        * [.typedRecordFromChild(type, child)](#module_Utilities.typedRecordFromChild) ⇒ <code>Record</code>
+        * [.typedSortArray(type)](#module_Utilities.typedSortArray) ⇒ <code>Array.SortObject</code>
+        * [.processItemType(item, type, refPath)](#module_Utilities.processItemType) ⇒ <code>Promise.RecordDocument</code>
+        * [.formatLinkedItem(link, type, refPath)](#module_Utilities.formatLinkedItem) ⇒ <code>Promise.string</code>
+        * [.summarizeItem(item, type)](#module_Utilities.summarizeItem) ⇒ <code>string</code>
+        * [.baseItem(type)](#module_Utilities.baseItem) ⇒ <code>object</code>
+        * [.baseForm(type)](#module_Utilities.baseForm) ⇒ <code>object</code>
+        * [.dataForm(type)](#module_Utilities.dataForm) ⇒ <code>object</code>
+        * [.createForm(type)](#module_Utilities.createForm) ⇒ <code>object</code>
+        * [.accountForm(type)](#module_Utilities.accountForm) ⇒ <code>object</code>
+        * [.saveForm(type)](#module_Utilities.saveForm) ⇒ <code>callback</code>
+        * [.updateChangeForm(type)](#module_Utilities.updateChangeForm) ⇒ <code>callback</code>
+        * [.choicesForm(fieldname)](#module_Utilities.choicesForm) ⇒ <code>object</code>
+        * [.saveHost(host)](#module_Utilities.saveHost) ⇒ <code>Promise.OrganizationType</code>
+        * [.simpleObjectCompare(object1, object2)](#module_Utilities.simpleObjectCompare) ⇒ <code>boolean</code>
+        * [.formatItem(thisItem, thisFormat)](#module_Utilities.formatItem) ⇒ <code>string</code>
+        * [.compare(thisItem, anotherItem, sort)](#module_Utilities.compare) ⇒ <code>string</code>
+        * [.anyInAny(findFrom, findIn)](#module_Utilities.anyInAny) ⇒ <code>boolean</code>
+        * [.PromisePoolRunner(entryArray, actionFunction, promiseOptions)](#module_Utilities.PromisePoolRunner) ⇒ <code>Promise</code>
+        * [.lesserOf(args)](#module_Utilities.lesserOf) ⇒ <code>number</code>
+        * [.largerOf(args)](#module_Utilities.largerOf) ⇒ <code>number</code>
+        * [.archiveRecord(record)](#module_Utilities.archiveRecord) ⇒ <code>Promise</code>
+        * [.refPathToBaseRecord(refPath)](#module_Utilities.refPathToBaseRecord) ⇒ <code>RecordDocument</code>
+        * [.bound(value, lowerBound, upperBound)](#module_Utilities.bound) ⇒ <code>number</code>
+        * [.blindPush(targetArray, newObject)](#module_Utilities.blindPush)
+        * [.addToArrayObject(arrayObject, key, object)](#module_Utilities.addToArrayObject)
+        * [.makeHexAsNeeded(color)](#module_Utilities.makeHexAsNeeded) ⇒ <code>string</code>
+    * _inner_
+        * [~PromisePool](#module_Utilities..PromisePool)
+        * [~promiseOptionsDefault](#module_Utilities..promiseOptionsDefault) : <code>PromiseOptions</code>
+        * [~stripDocIdFromRefPath(refPath)](#module_Utilities..stripDocIdFromRefPath) ⇒ <code>string</code>
+        * [~UpdateChange
+Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceObject)](#module_Utilities..UpdateChange
+Function Signature for UpdateChange functions) ⇒ <code>object</code>
+        * [~generateIterator(entryArray, actionFunction)](#module_Utilities..generateIterator)
+        * [~PromiseOptions](#module_Utilities..PromiseOptions) : <code>object</code>
+
+<a name="module_Utilities.recordByIdAndType"></a>
+
+### Utilities.recordByIdAndType ⇒ <code>AccountType</code>
+creates and returns a minimal record from an Id and `type`
+
+**Kind**: static constant of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| Id | <code>string</code> | 
+| Type | <code>string</code> | 
+
+<a name="module_Utilities.fetchLinkedItem"></a>
+
+### Utilities.fetchLinkedItem(type, link, refPath) ⇒ <code>Promise.RecordDocument</code>
+used generic for constructing forms for input and display
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| type | <code>string</code> | refers to the sub-collection name |
+| link | <code>string</code> | refers to the linking "value" - a documentID |
+| refPath | <code>string</code> | optionally refers to the "/" separate path to the parent document in firebase |
+
+<a name="module_Utilities.fetchSubItem"></a>
+
+### Utilities.fetchSubItem(type, refPath) ⇒ <code>Promise.RecordDocument</code>
+some items are stored in the database as a single-record collection, using
+the same Id as the parent
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| type | <code>string</code> | refers to the sub-collection name |
+| refPath | <code>string</code> | refers to the "/" separate path to the required parent document in firebase |
+
+<a name="module_Utilities.fetchType"></a>
+
+### Utilities.fetchType(type, refPath) ⇒ <code>Promise.Array.RecordDocument</code>
+returns an entire sub-collection by "type" (sub-collection name).
+If refpath is omitted, assumes "type" is a top-level collection
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| type | <code>string</code> | refers to the sub-collection name |
+| refPath | <code>string</code> | optionally refers to the "/" separate path to the parent document in firebase |
+
+<a name="module_Utilities.searchType"></a>
+
+### Utilities.searchType(type, parent, prompt, limit) ⇒ <code>Promise.Array.OrganizationType</code>
+returns a Promise which resolves to an array of all Type's whose
+name begins with the provided prompt, optionally limited to a provided number
+CASE SENSITIVE FOR NOW
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| type | <code>string</code> | type of record to search |
+| parent | <code>Record</code> | parent object of records, if any |
+| prompt | <code>string</code> | Used to query for matching records |
+| limit | <code>string</code> \| <code>number</code> | Used to limit the number of results |
+
+<a name="module_Utilities.typedRecordFromChild"></a>
+
+### Utilities.typedRecordFromChild(type, child) ⇒ <code>Record</code>
+builds a representation of a parent from a child, by type
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+| child | <code>Record</code> | 
+
+<a name="module_Utilities.typedSortArray"></a>
+
+### Utilities.typedSortArray(type) ⇒ <code>Array.SortObject</code>
+Firebase query support - builds default sort options
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.processItemType"></a>
+
+### Utilities.processItemType(item, type, refPath) ⇒ <code>Promise.RecordDocument</code>
+generic form data processing for database by "type" (collection name)
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>RecordDocument</code> |  |
+| type | <code>string</code> | refers to the sub-collection name |
+| refPath | <code>string</code> | optionally refers to the "/" separate path to the parent document in firebase |
+
+<a name="module_Utilities.formatLinkedItem"></a>
+
+### Utilities.formatLinkedItem(link, type, refPath) ⇒ <code>Promise.string</code>
+fetches a sub-record from the database and returns the result as a summary string
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| link | <code>string</code> | refers to the linking "value" - a documentID |
+| type | <code>string</code> | refers to the sub-collection name |
+| refPath | <code>string</code> | refers to the "/" separate path to the required parent document in firebase |
+
+<a name="module_Utilities.summarizeItem"></a>
+
+### Utilities.summarizeItem(item, type) ⇒ <code>string</code>
+parameterized function to return string summary of an object
+By default, returns the "name" property of the item.
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>object</code> | data object to summarize |
+| type | <code>String</code> \| <code>&quot;User&quot;</code> \| <code>&quot;Product&quot;</code> \| <code>&quot;LineItem&quot;</code> \| <code>&quot;Commodities&quot;</code> \| <code>&quot;Units&quot;</code> | - type of the object to summarize |
+
+<a name="module_Utilities.baseItem"></a>
+
+### Utilities.baseItem(type) ⇒ <code>object</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns the "base" item sample for a business-object type,
+where the keys are the field/property names, and the values are the
+default values as defined in the business logic
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>object</code> - keys and default values  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.baseForm"></a>
+
+### Utilities.baseForm(type) ⇒ <code>object</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns the "baseForm" withe keys/properties, and
+values are strings with ":" separated definitions for EditForm and
+similar functionality - see "EditForm" for more details
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>object</code> - keys and default values  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.dataForm"></a>
+
+### Utilities.dataForm(type) ⇒ <code>object</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns the "Data" object with keys/properties, and
+values are strings with ":" separated definitions for Faker and
+similar functionality - to generate "fake" simulated data for testing
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>object</code> - keys and default values  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.createForm"></a>
+
+### Utilities.createForm(type) ⇒ <code>object</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns the "createForm" withe keys/properties, and
+values are strings with ":" separated definitions for EditForm and
+similar functionality - see "EditForm" for more details
+Specifically for limited "front-end" use to CREATE new
+business-objects with the minimum entries necessary
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>object</code> - keys and default values  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.accountForm"></a>
+
+### Utilities.accountForm(type) ⇒ <code>object</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns the "createForm" withe keys/properties, and
+values are strings with ":" separated definitions for EditForm and
+similar functionality - see "EditForm" for more details
+Specifically for limited "front-end" use on ACCOUNT business-objects
+with the minimum entries necessary
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>object</code> - keys and default values  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.saveForm"></a>
+
+### Utilities.saveForm(type) ⇒ <code>callback</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns a FUNCTION to use for saving a business-object
+to the database - abstracting type-specific features and functionality
+from the front end
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.updateChangeForm"></a>
+
+### Utilities.updateChangeForm(type) ⇒ <code>callback</code>
+Convenience function to mask actual Forms array from the front-end
+This version returns a FUNCTION to respond to cross-field dependent
+chnages during editing with EditForm, reactdatagrid, etc
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| type | <code>string</code> | 
+
+<a name="module_Utilities.choicesForm"></a>
+
+### Utilities.choicesForm(fieldname) ⇒ <code>object</code>
+Returns an object whose keys are the available choices for a
+business-object field, and whose values represent the sort order
+Most fieldname have no such choices.  Both the definitions and 
+usage are defined in business logic elsewhere
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fieldname | <code>string</code> | which business type is being processes |
+
+<a name="module_Utilities.saveHost"></a>
+
+### Utilities.saveHost(host) ⇒ <code>Promise.OrganizationType</code>
+A convenience function for some shared artist/host front-end pages
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| host | <code>OrganizationType</code> | 
+
+<a name="module_Utilities.simpleObjectCompare"></a>
+
+### Utilities.simpleObjectCompare(object1, object2) ⇒ <code>boolean</code>
+Simple top-level object compare - assumes objects have similar structure - or
+AT LEAST all the fields of object1 are present in object2
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| object1 | <code>object</code> | 
+| object2 | <code>object</code> | 
+
+<a name="module_Utilities.formatItem"></a>
+
+### Utilities.formatItem(thisItem, thisFormat) ⇒ <code>string</code>
+Allows string substitution from an object
+field names support Dot notation
+field names allow ":" extension for alternate formatting
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| thisItem | <code>object</code> | object to create formated string from |
+| thisFormat | <code>string</code> | string describing formatted output - fieldname wrapped in {} will be substituted.  DOT notation allowed for fields. |
+
+<a name="module_Utilities.compare"></a>
+
+### Utilities.compare(thisItem, anotherItem, sort) ⇒ <code>string</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| thisItem | <code>object</code> | one of two objects being compared |
+| anotherItem | <code>object</code> | the other of two objects being compared |
+| sort | <code>string</code> | string describing sort - format "fieldName:sortType" - sort Type is "string, "date" or "number" (default) |
+
+<a name="module_Utilities.anyInAny"></a>
+
+### Utilities.anyInAny(findFrom, findIn) ⇒ <code>boolean</code>
+An array based compare function - is any entry of findFrom present in findIn
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| findFrom | <code>Array.any</code> | 
+| findIn | <code>Array.any</code> | 
+
+<a name="module_Utilities.PromisePoolRunner"></a>
+
+### Utilities.PromisePoolRunner(entryArray, actionFunction, promiseOptions) ⇒ <code>Promise</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| entryArray | <code>Array.object</code> | 
+| actionFunction | <code>callback</code> | 
+| promiseOptions | <code>PromiseOptions</code> | 
+
+<a name="module_Utilities.lesserOf"></a>
+
+### Utilities.lesserOf(args) ⇒ <code>number</code>
+A convenience function for legibility
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>number</code> - the least of any of the arguments
+b  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>any</code> | unbounded list of arguments |
+
+<a name="module_Utilities.largerOf"></a>
+
+### Utilities.largerOf(args) ⇒ <code>number</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>number</code> - the largest of any of the arguments  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>any</code> | unbounded list of arguments |
+
+<a name="module_Utilities.archiveRecord"></a>
+
+### Utilities.archiveRecord(record) ⇒ <code>Promise</code>
+"Moves" a record from our standard tree structureto a parallel archival
+structure, by prepending a "_" to the collection names in the path
+This prevents the archived record from appearing in collectionGroup queries
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| record | <code>RecordDocument</code> | 
+| record.refPath | <code>string</code> | 
+
+<a name="module_Utilities.refPathToBaseRecord"></a>
+
+### Utilities.refPathToBaseRecord(refPath) ⇒ <code>RecordDocument</code>
+uses a passed refPath to create the most basic document record form
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| refPath | <code>string</code> | "/" separated document path reference |
+
+<a name="module_Utilities.bound"></a>
+
+### Utilities.bound(value, lowerBound, upperBound) ⇒ <code>number</code>
+clips value to given bounds
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| value | <code>number</code> | 
+| lowerBound | <code>number</code> | 
+| upperBound | <code>number</code> | 
+
+<a name="module_Utilities.blindPush"></a>
+
+### Utilities.blindPush(targetArray, newObject)
+function to push an element to an array which may not be initialized
+
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| targetArray | <code>Array.object</code> | 
+| newObject | <code>object</code> | 
+
+<a name="module_Utilities.addToArrayObject"></a>
+
+### Utilities.addToArrayObject(arrayObject, key, object)
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arrayObject | <code>Array.Array.object</code> |  |
+| key | <code>string</code> | key or index to choose which Array.object to add *this* object to |
+| object | <code>object</code> |  |
+
+<a name="module_Utilities.makeHexAsNeeded"></a>
+
+### Utilities.makeHexAsNeeded(color) ⇒ <code>string</code>
+**Kind**: static method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>string</code> - hex value of named color  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| color | <code>string</code> | name of color |
+
+<a name="module_Utilities..PromisePool"></a>
+
+### Utilities~PromisePool
+**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)  
+<a name="module_Utilities..promiseOptionsDefault"></a>
+
+### Utilities~promiseOptionsDefault : <code>PromiseOptions</code>
+**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)  
+**Default**: <code>{&quot;concurrency&quot;:3,&quot;rate&quot;:10}</code>  
+**Read only**: true  
+<a name="module_Utilities..stripDocIdFromRefPath"></a>
+
+### Utilities~stripDocIdFromRefPath(refPath) ⇒ <code>string</code>
+pulls the document Id from a passed refPath string (firebase dependent)
+
+**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)  
+**Returns**: <code>string</code> - Id  
+
+| Param | Type |
+| --- | --- |
+| refPath | <code>string</code> | 
+
+<a name="module_Utilities..UpdateChange
+Function Signature for UpdateChange functions"></a>
+
+### Utilities~UpdateChange
+Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceObject) ⇒ <code>object</code>
+**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| prev | <code>object</code> | 
+| value | <code>object</code> | 
+| itemFor | <code>string</code> | 
+| fullChoiceObject | <code>object</code> | 
+
+<a name="module_Utilities..generateIterator"></a>
+
+### Utilities~generateIterator(entryArray, actionFunction)
+An Action Iterator Generator.  Cycles through the entries in the passed array,
+yielding the result of a function for each entry.
+Only cares that inputs are an array, and a function that returns a
+promise
+
+**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)  
+
+| Param | Type |
+| --- | --- |
+| entryArray | <code>Array.any</code> | 
+| actionFunction | <code>callback</code> | 
+
+<a name="module_Utilities..PromiseOptions"></a>
+
+### Utilities~PromiseOptions : <code>object</code>
+**Kind**: inner typedef of [<code>Utilities</code>](#module_Utilities)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| concurrency | <code>number</code> | 
+| rate | <code>number</code> | 
+
 <a name="module_Boilerplate"></a>
 
 ## Boilerplate