@esri/solution-common 1.3.10 → 1.3.13

package/dist/node/featureServiceHelpers.js

@@ -39,8 +39,8 @@ const trackingHelpers_1 = require("./trackingHelpers");
  * @param dependencies Array of IDependency for name mapping
  * @param templatizeFieldReferences Templatize all field references within a layer
  * @param templateDictionary Hash mapping property names to replacement values
- * @return A promise that will resolve when template has been updated
- * @protected
+ * @returns A promise that will resolve when template has been updated
+ * @private
  */
 function templatize(itemTemplate, dependencies, templatizeFieldReferences, templateDictionary) {
     templateDictionary = templateDictionary || {};
@@ -130,7 +130,7 @@ exports.deleteViewProps = deleteViewProps;
  * @param layer The data layer instance with field name references within
  * @param fieldInfos the object that stores the cached field infos
  * @param isPortal Controls what properties should be removed.
- * @return An updated instance of the fieldInfos
+ * @returns An updated instance of the fieldInfos
  */
 function cacheFieldInfos(layer, fieldInfos, isPortal) {
     // cache the source fields as they are in the original source
@@ -166,6 +166,7 @@ exports.cacheFieldInfos = cacheFieldInfos;
  * @param layer the data layer being cloned
  * @param prop the property name used to cache
  * @param fieldInfos the object that will store the cached property
+ * @private
  */
 function _cacheFieldInfo(layer, prop, fieldInfos, removeProp) {
     /* istanbul ignore else */
@@ -187,7 +188,7 @@ exports._cacheFieldInfo = _cacheFieldInfo;
  * Cache popup info that can contain field references
  *
  * @param data The items data property
- * @return An updated instance of the popupInfos
+ * @returns An updated instance of the popupInfos
  */
 function cachePopupInfos(data) {
     // store any popupInfo so we can update after any potential name changes
@@ -211,6 +212,7 @@ exports.cachePopupInfos = cachePopupInfos;
  * @param popupInfos object to store the cahced popupInfo
  * @param type is it a layer or table
  * @param _items list or either layers or tables
+ * @private
  */
 function _cachePopupInfo(popupInfos, type, _items) {
     _items.forEach((item) => {
@@ -227,8 +229,8 @@ exports._cachePopupInfo = _cachePopupInfo;
  * @param itemTemplate Item to be created; n.b.: this item is modified
  * @param templateDictionary Hash mapping property names to replacement values
  * @param createResponse Response from create service
- * @return An updated instance of the template
- * @protected
+ * @returns An updated instance of the template
+ * @private
  */
 function updateTemplate(itemTemplate, templateDictionary, createResponse) {
     // Update the item with any typeKeywords that were added on create
@@ -250,8 +252,8 @@ exports.updateTemplate = updateTemplate;
  *
  * @param itemTemplate Item to be created; n.b.: this item is modified
  * @param createResponse Response from create service
- * @return An updated instance of the template
- * @protected
+ * @returns An updated instance of the template
+ * @private
  */
 function _updateTypeKeywords(itemTemplate, createResponse) {
     // https://github.com/Esri/solution.js/issues/589
@@ -271,7 +273,7 @@ exports._updateTypeKeywords = _updateTypeKeywords;
  * Example... { layer0: { fields: { lowerCaseSourceFieldName: newFieldNameAfterDeployment } } }
  *
  * @param layerInfos The object that stores the cached layer properties and name mapping
- * @return The settings object that will be used to de-templatize the field references.
+ * @returns The settings object that will be used to de-templatize the field references.
  */
 function getLayerSettings(layerInfos, url, itemId, enterpriseIDMapping) {
     const settings = {};
@@ -304,7 +306,7 @@ exports.getLayerSettings = getLayerSettings;
  *
  * @param templates A collection of AGO item templates.
  * @param solutionItemId The item id for the deployed solution item.
- * @return An updated collection of AGO templates with unique feature service names.
+ * @returns An updated collection of AGO templates with unique feature service names.
  */
 function setNamesAndTitles(templates, solutionItemId) {
     const names = [];
@@ -379,8 +381,8 @@ exports.updateSettingsFieldInfos = updateSettingsFieldInfos;
  *
  * @param template Template for feature service item
  * @param authentication Credentials for the request
- * @return A promise that will resolve when template has been updated
- * @protected
+ * @returns A promise that will resolve when template has been updated
+ * @private
  */
 function updateTemplateForInvalidDesignations(template, authentication) {
     return new Promise((resolve, reject) => {
@@ -418,7 +420,7 @@ exports.updateTemplateForInvalidDesignations = updateTemplateForInvalidDesignati
  * @param popupInfos The object from the popupInfo property for the layer
  * @param adminLayerInfos The object from the adminLayerInfo property for the layer
  * @param settings The settings object that has all of the mappings for de-templatizing.
- * @return An object that contains updated instances of popupInfos, fieldInfos, and adminLayerInfos
+ * @returns An object that contains updated instances of popupInfos, fieldInfos, and adminLayerInfos
  */
 function deTemplatizeFieldInfos(fieldInfos, popupInfos, adminLayerInfos, settings) {
     const fieldInfoKeys = Object.keys(fieldInfos);
@@ -449,7 +451,7 @@ exports.deTemplatizeFieldInfos = deTemplatizeFieldInfos;
  * to the item settings for the view.
  *
  * @param itemTemplate The current itemTemplate being processed.
- * @return array of layers and tables
+ * @returns array of layers and tables
  */
 function getLayersAndTables(itemTemplate) {
     const properties = itemTemplate.properties;
@@ -477,8 +479,8 @@ exports.getLayersAndTables = getLayersAndTables;
  * @param url Feature service endpoint
  * @param ids layer and table ids
  * @param authentication Credentials for the request
- * @return A promise that will resolve an array of promises with either a failure or the data
- * @protected
+ * @returns A promise that will resolve an array of promises with either a failure or the data
+ * @private
  */
 function getExistingLayersAndTables(url, ids, authentication) {
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -501,8 +503,8 @@ exports.getExistingLayersAndTables = getExistingLayersAndTables;
  *            service)
  * @param popupInfos the cached popup info from the layers
  * @param authentication Credentials for the request
- * @return A promise that will resolve when all layers and tables have been added
- * @protected
+ * @returns A promise that will resolve when all layers and tables have been added
+ * @private
  */
 function addFeatureServiceLayersAndTables(itemTemplate, templateDictionary, popupInfos, authentication) {
     return new Promise((resolve, reject) => {
@@ -564,8 +566,8 @@ exports.addFeatureServiceLayersAndTables = addFeatureServiceLayersAndTables;
  * @param adminLayerInfos Hash map of a layers adminLayerInfo
  * @param fieldInfos Hash map of properties that contain field references
  * @param itemTemplate
- * @return A promise that will resolve when the feature service has been updated
- * @protected
+ * @returns A promise that will resolve when the feature service has been updated
+ * @private
  */
 function addFeatureServiceDefinition(serviceUrl, listToAdd, templateDictionary, authentication, key, adminLayerInfos, fieldInfos, itemTemplate) {
     return new Promise((resolve, reject) => {
@@ -670,8 +672,8 @@ exports.addFeatureServiceDefinition = addFeatureServiceDefinition;
  * @param layerChunks Groups of layers or tables to add to the service
  * @param authentication Credentials for the request
  *
- * @return Add to service definition options
- * @protected
+ * @returns Add to service definition options
+ * @private
  */
 function _updateAddOptions(itemTemplate, item, options, layerChunks, authentication) {
     const isMsView = (0, generalHelpers_1.getProp)(itemTemplate, "properties.service.isMultiServicesView") || false;
@@ -705,7 +707,7 @@ exports._updateAddOptions = _updateAddOptions;
  * Remove "multiScaleGeometryInfo" for issue #526 to prevent invalid enablement of layer optimization
  *
  * @param layer the layer to evaluate
- * @protected
+ * @private
  */
 function removeLayerOptimization(layer) {
     /* istanbul ignore else */
@@ -721,8 +723,8 @@ exports.removeLayerOptimization = removeLayerOptimization;
  * @param itemTemplate the item template
  * @param templateDictionary Hash mapping Solution source id to id of its clone
  *
- * @return the updated item
- * @protected
+ * @returns the updated item
+ * @private
  */
 function _updateForPortal(item, itemTemplate, templateDictionary) {
     // When deploying to portal we need to adjust the uniquie ID field up front
@@ -787,8 +789,8 @@ exports._updateForPortal = _updateForPortal;
  * @param itemTemplate the item template
  * @param templateDictionary Hash mapping Solution source id to id of its clone
  *
- * @return an array of the source layers fields
- * @protected
+ * @returns an array of the source layers fields
+ * @private
  */
 function _getFieldNames(table, itemTemplate, templateDictionary) {
     let sourceLayerFields = [];
@@ -820,8 +822,8 @@ exports._getFieldNames = _getFieldNames;
  * @param item Layer or table
  * @param templateDictionary Hash mapping Solution source id to id of its clone
  *
- * @return updated layer or table
- * @protected
+ * @returns updated layer or table
+ * @private
  */
 function _updateItemFields(item, fieldNames) {
     /* istanbul ignore else */
@@ -843,8 +845,8 @@ exports._updateItemFields = _updateItemFields;
  *
  * @param table the table instance to evaluate
  * @param sourceLayerFields array of fields from the source service
- * @return Updated instance of the table
- * @protected
+ * @returns Updated instance of the table
+ * @private
  */
 function _updateSourceLayerFields(table, sourceLayerFields) {
     /* istanbul ignore else */
@@ -865,7 +867,7 @@ exports._updateSourceLayerFields = _updateSourceLayerFields;
  *
  * @param item the item details from the current template
  * @param templateDictionary Hash mapping property names to replacement values
- * @protected
+ * @private
  */
 function _updateGeomFieldName(adminLayerInfo, templateDictionary) {
     // issue #471
@@ -894,7 +896,7 @@ exports._updateGeomFieldName = _updateGeomFieldName;
  *
  * @param itemTemplate
  * @param templateDictionary Hash mapping Solution source id to id of its clone (and name & URL for feature service)
- * @protected
+ * @private
  */
 function _updateTemplateDictionaryFields(itemTemplate, templateDictionary, compareItemId = true) {
     const layers = itemTemplate.properties.layers;
@@ -925,7 +927,7 @@ exports._updateTemplateDictionaryFields = _updateTemplateDictionaryFields;
  * @param templateDictionary Hash mapping Solution source id to id of its clone (and name & URL for feature service)
  * @param itemId The source id for the item
  * @param spatialReference { wkid: 102100 } for example
- * @protected
+ * @private
  */
 function setDefaultSpatialReference(templateDictionary, itemId, spatialReference) {
     /* istanbul ignore else */
@@ -942,7 +944,7 @@ exports.setDefaultSpatialReference = setDefaultSpatialReference;
  * @param serviceInfo Basic service information
  * @param itemTemplate The current template to process
  * @param templateDictionary Hash mapping Solution source id to id of its clone (and name & URL for feature service)
- * @protected
+ * @private
  */
 function validateSpatialReferenceAndExtent(serviceInfo, itemTemplate, templateDictionary) {
     /* istanbul ignore else */
@@ -988,8 +990,8 @@ exports.validateSpatialReferenceAndExtent = validateSpatialReferenceAndExtent;
  * @param adminLayerInfos Hash map of a layers adminLayerInfo
  * @param templateDictionary Hash mapping Solution source id to id of its clone (and name & URL for feature service)
  * @param authentication Credentials for the request
- * @return A promise that will resolve when the feature service has been updated
- * @protected
+ * @returns A promise that will resolve when the feature service has been updated
+ * @private
  */
 function updateLayerFieldReferences(itemTemplate, fieldInfos, popupInfos, adminLayerInfos, templateDictionary) {
     return new Promise((resolveFn, rejectFn) => {
@@ -1016,8 +1018,8 @@ exports.updateLayerFieldReferences = updateLayerFieldReferences;
  * @param adminLayerInfos Hash map of a layers adminLayerInfo
  * @param templateDictionary
  * @param authentication Credentials for the request
- * @return An object with detemplatized field references
- * @protected
+ * @returns An object with detemplatized field references
+ * @private
  */
 function postProcessFields(itemTemplate, layerInfos, popupInfos, adminLayerInfos, templateDictionary) {
     return new Promise((resolveFn, rejectFn) => {
@@ -1099,8 +1101,8 @@ exports.postProcessFields = postProcessFields;
  *  we need to pass it via an updateDef call or it will be set as the typeIdField of the source service
  *
  * @param item current layer or table
- * @return name of field to set for typeIdField in the update call
- * @protected
+ * @returns name of field to set for typeIdField in the update call
+ * @private
  */
 function _getTypeIdField(item) {
     const typeIdFields = item.fields.filter((f) => {
@@ -1119,8 +1121,8 @@ exports._getTypeIdField = _getTypeIdField;
  *  visible true when added with the layer definition
  *
  * @param fieldInfo current layers or tables fieldInfo
- * @return Array of fields that should not be visible in the view
- * @protected
+ * @returns Array of fields that should not be visible in the view
+ * @private
  */
 function _getFieldVisibilityUpdates(fieldInfo) {
     const visibilityUpdates = [];
@@ -1149,8 +1151,8 @@ exports._getFieldVisibilityUpdates = _getFieldVisibilityUpdates;
  *
  * @param fieldInfo current view layer or table fieldInfo
  * @param fieldUpdates any existing field updates
- * @return Array of fields to be updated
- * @protected
+ * @returns Array of fields to be updated
+ * @private
  */
 function _validateDomains(fieldInfo, fieldUpdates) {
     const domainAliasInfos = _getDomainAndAliasInfos(fieldInfo);
@@ -1176,7 +1178,7 @@ exports._validateDomains = _validateDomains;
  * @param fields the alias or domain fields
  * @param key the field key to evaluate
  * @param fieldUpdates any existing field updates
- * @protected
+ * @private
  */
 function _getPortalViewFieldUpdates(field, names, fields, key, fieldUpdates) {
     if (field.hasOwnProperty(key) && field[key]) {
@@ -1206,8 +1208,8 @@ exports._getPortalViewFieldUpdates = _getPortalViewFieldUpdates;
  *
  * @param fieldInfo current view layer or table fieldInfo
  * @param fieldUpdates any existing field updates
- * @return Array of fields to be updated
- * @protected
+ * @returns Array of fields to be updated
+ * @private
  */
 function _validateViewDomainsAndAlias(fieldInfo, item) {
     const domainAliasInfos = _getDomainAndAliasInfos(fieldInfo);
@@ -1228,7 +1230,7 @@ exports._validateViewDomainsAndAlias = _validateViewDomainsAndAlias;
  *  Get array of domain fields and names and alias fields and names
  *
  * @param fieldInfo current view layer or table fieldInfo
- *
+ * @private
  */
 function _getDomainAndAliasInfos(fieldInfo) {
     const domainFields = [];
@@ -1272,7 +1274,7 @@ exports._getDomainAndAliasInfos = _getDomainAndAliasInfos;
  * @param names array of field names
  * @param fields array of fields
  * @param key the field key to compare
- * @protected
+ * @private
  */
 function _isViewFieldOverride(field, names, fields, key) {
     /* istanbul ignore else */
@@ -1290,7 +1292,7 @@ exports._isViewFieldOverride = _isViewFieldOverride;
  *
  * @param itemTemplate
  * @param popupInfos popup info to be added back to the layer
- * @protected
+ * @private
  */
 function updatePopupInfo(itemTemplate, popupInfos) {
     ["layers", "tables"].forEach(type => {
@@ -1311,6 +1313,7 @@ exports.updatePopupInfo = updatePopupInfo;
  *
  * @param basePath path used to de-templatize while deploying
  * @param value to be converted to lower case for lookup while deploying
+ * @private
  */
 function _templatize(basePath, value, suffix) {
     if (value.startsWith("{{")) {
@@ -1327,6 +1330,7 @@ exports._templatize = _templatize;
  * @param object the object with the property to templatize
  * @param property the property of the object to templatize
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeProperty(object, property, basePath, suffix) {
     if (object && object.hasOwnProperty(property) && object[property]) {
@@ -1342,8 +1346,8 @@ exports._templatizeProperty = _templatizeProperty;
  * @param itemTemplate Template for feature service item
  * @param dependencies Array of IDependency for name mapping
  * @param templatizeFieldReferences Templatize all field references within a layer
- * @return A promise that will resolve when template has been updated
- * @protected
+ * @returns A promise that will resolve when template has been updated
+ * @private
  */
 function _templatizeLayer(dataItem, adminItem, itemTemplate, dependencies, templatizeFieldReferences, templateDictionary) {
     // check for and repair common field issues
@@ -1400,6 +1404,7 @@ exports._validateFields = _validateFields;
  *
  * @param adminItem layer or table from the service
  * @param fieldNames string list of fields names
+ * @private
  */
 function _validateDisplayField(adminItem, fieldNames) {
     const displayField = adminItem.displayField || "";
@@ -1441,6 +1446,7 @@ exports._validateDisplayField = _validateDisplayField;
  *
  * @param adminItem layer or table from the service
  * @param fieldNames string list of fields names
+ * @private
  */
 function _validateIndexes(adminItem, fieldNames) {
     const indexes = adminItem.indexes;
@@ -1477,6 +1483,7 @@ exports._validateIndexes = _validateIndexes;
  *
  * @param adminItem layer or table from the service
  * @param fieldNames string list of fields names
+ * @private
  */
 function _validateTemplatesFields(adminItem, fieldNames) {
     const templates = adminItem.templates;
@@ -1504,6 +1511,7 @@ exports._validateTemplatesFields = _validateTemplatesFields;
  *
  * @param adminItem layer or table from the service
  * @param fieldNames string list of fields names
+ * @private
  */
 function _validateTypesTemplates(adminItem, fieldNames) {
     const types = adminItem.types;
@@ -1521,6 +1529,7 @@ exports._validateTypesTemplates = _validateTypesTemplates;
  *
  * @param adminItem layer or table from the service
  * @param fieldNames string list of fields names
+ * @private
  */
 function _validateEditFieldsInfo(adminItem, fieldNames) {
     const editFieldsInfo = adminItem.editFieldsInfo;
@@ -1558,7 +1567,8 @@ exports._validateEditFieldsInfo = _validateEditFieldsInfo;
  * @param itemID The id for the item that contains this layer.
  * @param layer JSON return from the layer being templatized.
  * @param dependencies
- * @return An updated instance of the layer
+ * @returns An updated instance of the layer
+ * @private
  */
 function _templatizeLayerFieldReferences(dataItem, itemID, layer, dependencies) {
     // This is the value that will be used as the template for adlib replacement
@@ -1588,8 +1598,8 @@ exports._templatizeLayerFieldReferences = _templatizeLayerFieldReferences;
  *
  * @param layer The layer to be modified
  * @param dependencies Array of service dependencies
- * @return A new copy of the modified adminLayerInfo for the given layer
- * @protected
+ * @returns A new copy of the modified adminLayerInfo for the given layer
+ * @private
  */
 function _templatizeAdminLayerInfo(layer, dependencies, templateDictionary) {
     // Create new instance of adminLayerInfo to update for clone
@@ -1623,7 +1633,7 @@ exports._templatizeAdminLayerInfo = _templatizeAdminLayerInfo;
  *
  * @param object The layer to be modified
  * @param dependencies Array of service dependencies
- * @protected
+ * @private
  */
 function _processAdminObject(object, dependencies) {
     (0, generalHelpers_1.deleteProp)(object, "sourceId");
@@ -1637,8 +1647,8 @@ exports._processAdminObject = _processAdminObject;
  *
  * @param lookupName The current name from the source service
  * @param dependencies Array of IDependency for name mapping
- * @return The templatized name || undefined when no matching dependency is found
- * @protected
+ * @returns The templatized name || undefined when no matching dependency is found
+ * @private
  */
 function _templatizeSourceServiceName(lookupName, dependencies) {
     const deps = dependencies.filter(dependency => dependency.name === lookupName);
@@ -1651,6 +1661,7 @@ exports._templatizeSourceServiceName = _templatizeSourceServiceName;
  * @param layer the layer object with the adminLayerInfo property to templatize
  * @param basePath path used to de-templatize while deploying
  * @param itemID the id for the item that contains this layer
+ * @private
  */
 function _templatizeAdminLayerInfoFields(layer, dependencies) {
     // templatize the source layer fields
@@ -1685,6 +1696,7 @@ exports._templatizeAdminLayerInfoFields = _templatizeAdminLayerInfoFields;
  *
  * @param lookupName name of dependency we want to find the id of
  * @param dependencies array of item dependencies
+ * @private
  */
 function _getDependantItemId(lookupName, dependencies) {
     const deps = dependencies.filter(dependency => dependency.name === lookupName);
@@ -1696,6 +1708,7 @@ exports._getDependantItemId = _getDependantItemId;
  *
  * @param fields array of sourceLayerFields to templatize
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeAdminSourceLayerFields(fields, basePath) {
     fields.forEach(f => _templatizeProperty(f, "source", basePath, "name"));
@@ -1706,6 +1719,7 @@ exports._templatizeAdminSourceLayerFields = _templatizeAdminSourceLayerFields;
  *
  * @param topFilter the topFilter object to templatize
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeTopFilter(topFilter, basePath) {
     /* istanbul ignore else */
@@ -1737,6 +1751,7 @@ exports._templatizeTopFilter = _templatizeTopFilter;
  *
  * @param layer the layer that has the relationships to templatize
  * @param itemID the id of the item that contains the related table
+ * @private
  */
 function _templatizeRelationshipFields(layer, itemID) {
     if (layer && layer.relationships) {
@@ -1759,6 +1774,7 @@ exports._templatizeRelationshipFields = _templatizeRelationshipFields;
  * @param basePath path used to de-templatize while deploying
  * @param itemID the id for the item that contains this layer
  * @param fieldNames array of fieldNames
+ * @private
  */
 function _templatizePopupInfo(layerDefinition, layer, basePath, itemID, fieldNames) {
     // the data layer does not have the fields...will need to get those
@@ -1786,6 +1802,7 @@ exports._templatizePopupInfo = _templatizePopupInfo;
  * @param property that could have a field name referenced
  * @param fieldNames array for field names for the layer
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeName(object, property, fieldNames, basePath) {
     if (object.hasOwnProperty(property)) {
@@ -1808,6 +1825,7 @@ exports._templatizeName = _templatizeName;
  * @param layer json of layer being cloned
  * @param itemID id of the item that contains the current layer
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizePopupInfoFieldInfos(fieldInfos, layer, itemID, basePath) {
     fieldInfos.forEach((f) => {
@@ -1823,6 +1841,7 @@ exports._templatizePopupInfoFieldInfos = _templatizePopupInfoFieldInfos;
  * @param layer json of layer being cloned
  * @param itemID id of the item that contains the current layer
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeFieldName(name, layer, itemID, basePath) {
     if (name.indexOf("relationships/") > -1) {
@@ -1859,6 +1878,7 @@ exports._templatizeFieldName = _templatizeFieldName;
  * @param expressionInfos the popups expressionInfos to check
  * @param fieldNames array of the layers field names
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeExpressionInfos(expressionInfos, fieldNames, basePath) {
     return expressionInfos.map((i) => {
@@ -1877,6 +1897,7 @@ exports._templatizeExpressionInfos = _templatizeExpressionInfos;
  * @param layer json of layer being cloned
  * @param itemID id of the item that contains the current layer
  * @param fieldNames array of field names
+ * @private
  */
 function _templatizePopupElements(popupElelments, basePath, layer, itemID, fieldNames) {
     popupElelments.forEach((pe) => {
@@ -1897,6 +1918,7 @@ exports._templatizePopupElements = _templatizePopupElements;
  * @param basePath path used to de-templatize while deploying
  * @param layer json of layer being cloned
  * @param itemID id of the item that contains the current layer
+ * @private
  */
 function _templatizeMediaInfos(mediaInfos, fieldNames, basePath, layer, itemId) {
     // templatize various properties of mediaInfos
@@ -1925,6 +1947,7 @@ exports._templatizeMediaInfos = _templatizeMediaInfos;
  * @param layer the layer with the definition editor
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames json of layer being cloned
+ * @private
  */
 function _templatizeDefinitionEditor(layer, basePath, fieldNames) {
     if (layer) {
@@ -1955,6 +1978,7 @@ exports._templatizeDefinitionEditor = _templatizeDefinitionEditor;
  * @param layer the layer with the definition editor
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of field names
+ * @private
  */
 function _templatizeDefinitionExpression(layer, basePath, fieldNames) {
     if (layer && layer.hasOwnProperty("definitionExpression")) {
@@ -1968,6 +1992,7 @@ exports._templatizeDefinitionExpression = _templatizeDefinitionExpression;
  * @param expression the expression to test for field name references
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of the layers field names
+ * @private
  */
 function _templatizeSimpleName(expression, basePath, fieldNames, suffix) {
     fieldNames.forEach(name => {
@@ -1986,6 +2011,7 @@ exports._templatizeSimpleName = _templatizeSimpleName;
  * @param layer the data layer
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of the layers field names
+ * @private
  */
 function _templatizeDrawingInfo(layer, basePath, fieldNames) {
     if (layer) {
@@ -2007,6 +2033,7 @@ exports._templatizeDrawingInfo = _templatizeDrawingInfo;
  * @param renderer the layers renderer
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of the layers field names
+ * @private
  */
 function _templatizeRenderer(renderer, basePath, fieldNames) {
     switch (renderer.type) {
@@ -2031,6 +2058,7 @@ exports._templatizeRenderer = _templatizeRenderer;
  * @param renderer the renderer object to check for field references
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of field names that will be used to search expressions
+ * @private
  */
 function _templatizeGenRenderer(renderer, basePath, fieldNames) {
     /* istanbul ignore else */
@@ -2081,6 +2109,7 @@ exports._templatizeGenRenderer = _templatizeGenRenderer;
  * @param renderer the renderer object to check for field references
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of field names that will be used to search expressions
+ * @private
  */
 function _templatizeTemporalRenderer(renderer, basePath, fieldNames) {
     const renderers = [
@@ -2099,6 +2128,7 @@ exports._templatizeTemporalRenderer = _templatizeTemporalRenderer;
  * @param authoringInfo  object containing metadata about the authoring process
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames the name of fields from the layer
+ * @private
  */
 function _templatizeAuthoringInfo(authoringInfo, basePath, fieldNames) {
     /* istanbul ignore else */
@@ -2131,6 +2161,7 @@ exports._templatizeAuthoringInfo = _templatizeAuthoringInfo;
  * @param text the text that contains the expression
  * @param fieldName name of the field to test for
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeArcadeExpressions(text, fieldName, basePath) {
     const t = _templatize(basePath, fieldName, "name");
@@ -2179,6 +2210,7 @@ exports._templatizeArcadeExpressions = _templatizeArcadeExpressions;
  * @param labelingInfo the object that contains the labelingInfo
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of the layers field names
+ * @private
  */
 function _templatizeLabelingInfo(labelingInfo, basePath, fieldNames) {
     labelingInfo.forEach((li) => {
@@ -2221,6 +2253,7 @@ exports._templatizeLabelingInfo = _templatizeLabelingInfo;
  *
  * @param layer the data layer being cloned
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeTemplates(layer, basePath) {
     const templates = layer.templates || [];
@@ -2239,6 +2272,7 @@ exports._templatizeTemplates = _templatizeTemplates;
  *
  * @param layer the data layer being cloned
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeTypeTemplates(layer, basePath) {
     const types = layer.types;
@@ -2271,6 +2305,7 @@ exports._templatizeTypeTemplates = _templatizeTypeTemplates;
  * @param obj the object to templatize
  * @param basePath path used to de-templatize while deploying
  * @param suffix expected suffix for template variable
+ * @private
  */
 function _templatizeKeys(obj, basePath, suffix) {
     let _obj;
@@ -2293,6 +2328,7 @@ exports._templatizeKeys = _templatizeKeys;
  *
  * @param layer the data layer being cloned
  * @param basePath path used to de-templatize while deploying
+ * @private
  */
 function _templatizeTimeInfo(layer, basePath) {
     if (layer.timeInfo) {
@@ -2319,6 +2355,7 @@ exports._templatizeTimeInfo = _templatizeTimeInfo;
  * @param layer the data layer being cloned
  * @param basePath path used to de-templatize while deploying
  * @param fieldNames array of the layers field names
+ * @private
  */
 function _templatizeDefinitionQuery(layer, basePath, fieldNames) {
     // templatize view definition query
@@ -2336,6 +2373,7 @@ exports._templatizeDefinitionQuery = _templatizeDefinitionQuery;
  *
  * @param fieldInfos the object that stores the cached information
  * @param id the id for the current layer being processed
+ * @private
  */
 function _getNameMapping(fieldInfos, id) {
     // create name mapping
@@ -2417,7 +2455,8 @@ exports._getNameMapping = _getNameMapping;
 /**
  * Helper function to ensure same chunk size value is used in multiple locations
  *
- * @return a number that represents how many layers should be included per addToDef call
+ * @returns a number that represents how many layers should be included per addToDef call
+ * @private
  */
 function _getLayerChunkSize() {
     return 20;