@esri/solution-common 1.3.13 → 1.3.16

package/dist/node/featureServiceHelpers.js

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._templatizeAdminLayerInfo = exports._templatizeLayerFieldReferences = exports._validateEditFieldsInfo = exports._validateTypesTemplates = exports._validateTemplatesFields = exports._validateIndexes = exports._validateDisplayField = exports._validateFields = exports._templatizeLayer = exports._templatizeProperty = exports._templatize = exports.updatePopupInfo = exports._isViewFieldOverride = exports._getDomainAndAliasInfos = exports._validateViewDomainsAndAlias = exports._getPortalViewFieldUpdates = exports._validateDomains = exports._getFieldVisibilityUpdates = exports._getTypeIdField = exports.postProcessFields = exports.updateLayerFieldReferences = exports.validateSpatialReferenceAndExtent = exports.setDefaultSpatialReference = exports._updateTemplateDictionaryFields = exports._updateGeomFieldName = exports._updateSourceLayerFields = exports._updateItemFields = exports._getFieldNames = exports._updateForPortal = exports.removeLayerOptimization = exports._updateAddOptions = exports.addFeatureServiceDefinition = exports.addFeatureServiceLayersAndTables = exports.getExistingLayersAndTables = exports.getLayersAndTables = exports.deTemplatizeFieldInfos = exports.updateTemplateForInvalidDesignations = exports.updateSettingsFieldInfos = exports.setNamesAndTitles = exports.getLayerSettings = exports._updateTypeKeywords = exports.updateTemplate = exports._cachePopupInfo = exports.cachePopupInfos = exports._cacheFieldInfo = exports.cacheFieldInfos = exports.deleteViewProps = exports.templatize = exports.rest_addFeatures = exports.rest_queryFeatures = void 0;
-exports._getLayerChunkSize = exports._getNameMapping = exports._templatizeDefinitionQuery = exports._templatizeTimeInfo = exports._templatizeKeys = exports._templatizeTypeTemplates = exports._templatizeTemplates = exports._templatizeLabelingInfo = exports._templatizeArcadeExpressions = exports._templatizeAuthoringInfo = exports._templatizeTemporalRenderer = exports._templatizeGenRenderer = exports._templatizeRenderer = exports._templatizeDrawingInfo = exports._templatizeSimpleName = exports._templatizeDefinitionExpression = exports._templatizeDefinitionEditor = exports._templatizeMediaInfos = exports._templatizePopupElements = exports._templatizeExpressionInfos = exports._templatizeFieldName = exports._templatizePopupInfoFieldInfos = exports._templatizeName = exports._templatizePopupInfo = exports._templatizeRelationshipFields = exports._templatizeTopFilter = exports._templatizeAdminSourceLayerFields = exports._getDependantItemId = exports._templatizeAdminLayerInfoFields = exports._templatizeSourceServiceName = exports._processAdminObject = void 0;
+exports._templatizeSourceServiceName = exports._processAdminObject = exports._templatizeAdminLayerInfo = exports._templatizeLayerFieldReferences = exports._validateEditFieldsInfo = exports._validateTypesTemplates = exports._validateTemplatesFields = exports._validateIndexes = exports._validateDisplayField = exports._validateFields = exports._templatizeLayer = exports._templatizeProperty = exports._templatize = exports.updatePopupInfo = exports._isViewFieldOverride = exports._getViewFieldInfos = exports._validateViewFieldInfos = exports.postProcessFields = exports.updateLayerFieldReferences = exports.validateSpatialReferenceAndExtent = exports.setDefaultSpatialReference = exports._updateTemplateDictionaryFields = exports._updateGeomFieldName = exports._updateSourceLayerFields = exports._updateItemFields = exports._getFieldNames = exports._updateForPortal = exports.removeLayerOptimization = exports._updateAddOptions = exports.addFeatureServiceDefinition = exports.addFeatureServiceLayersAndTables = exports.getExistingLayersAndTables = exports.getLayersAndTables = exports.deTemplatizeFieldInfos = exports.processContingentValues = exports.updateTemplateForInvalidDesignations = exports.updateSettingsFieldInfos = exports.setNamesAndTitles = exports.getLayerSettings = exports._updateTypeKeywords = exports.updateTemplate = exports._cachePopupInfo = exports.cachePopupInfos = exports._cacheFieldInfo = exports.cacheContingentValues = exports.cacheFieldInfos = exports.deleteViewProps = exports.templatize = exports.rest_addFeatures = exports.rest_queryFeatures = void 0;
+exports._getLayerChunkSize = exports._getNameMapping = exports._templatizeDefinitionQuery = exports._templatizeTimeInfo = exports._templatizeKeys = exports._templatizeTypeTemplates = exports._templatizeTemplates = exports._templatizeLabelingInfo = exports._templatizeArcadeExpressions = exports._templatizeAuthoringInfo = exports._templatizeTemporalRenderer = exports._templatizeGenRenderer = exports._templatizeRenderer = exports._templatizeDrawingInfo = exports._templatizeSimpleName = exports._templatizeDefinitionExpression = exports._templatizeDefinitionEditor = exports._templatizeMediaInfos = exports._templatizePopupElements = exports._templatizeExpressionInfos = exports._templatizeFieldName = exports._templatizePopupInfoFieldInfos = exports._templatizeName = exports._templatizePopupInfo = exports._templatizeRelationshipFields = exports._templatizeTopFilter = exports._templatizeAdminSourceLayerFields = exports._getDependantItemId = exports._templatizeAdminLayerInfoFields = void 0;
 /**
  * Provides general helper functions.
  *
@@ -129,10 +129,9 @@ 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.
  * @returns An updated instance of the fieldInfos
  */
-function cacheFieldInfos(layer, fieldInfos, isPortal) {
+function cacheFieldInfos(layer, fieldInfos) {
     // cache the source fields as they are in the original source
     if (layer && layer.fields) {
         fieldInfos[layer.id] = {
@@ -145,13 +144,13 @@ function cacheFieldInfos(layer, fieldInfos, isPortal) {
     // and will have associated updateDefinition calls when deploying to portal
     // as well as online for relationships...as relationships added with addToDef will cause failure
     const props = {
-        editFieldsInfo: isPortal,
-        types: isPortal,
-        templates: isPortal,
+        editFieldsInfo: false,
+        types: false,
+        templates: false,
         relationships: true,
-        drawingInfo: isPortal,
-        timeInfo: isPortal,
-        viewDefinitionQuery: isPortal
+        drawingInfo: false,
+        timeInfo: false,
+        viewDefinitionQuery: false
     };
     Object.keys(props).forEach(k => {
         _cacheFieldInfo(layer, k, fieldInfos, props[k]);
@@ -159,6 +158,22 @@ function cacheFieldInfos(layer, fieldInfos, isPortal) {
     return fieldInfos;
 }
 exports.cacheFieldInfos = cacheFieldInfos;
+/**
+ * Cache the stored contingent values so we can add them in subsequent addToDef calls
+ *
+ * @param id The layer id for the associated values to be stored with
+ * @param fieldInfos The object that stores the cached field infos
+ * @param itemTemplate The current itemTemplate being processed
+ * @returns An updated instance of the fieldInfos
+ */
+function cacheContingentValues(id, fieldInfos, itemTemplate) {
+    const contingentValues = (0, generalHelpers_1.getProp)(itemTemplate, 'properties.contingentValues');
+    if (contingentValues && contingentValues[id]) {
+        fieldInfos[id]['contingentValues'] = contingentValues[id];
+    }
+    return fieldInfos;
+}
+exports.cacheContingentValues = cacheContingentValues;
 /**
  * Helper function to cache a single property into the fieldInfos object
  * This property will be removed from the layer instance.
@@ -178,7 +193,7 @@ function _cacheFieldInfo(layer, prop, fieldInfos, removeProp) {
         // editFieldsInfo does not come through unless its with the layer
         // when it's being added
         /* istanbul ignore else */
-        if (removeProp && prop !== "editFieldsInfo") {
+        if (removeProp) {
             layer[prop] = null;
         }
     }
@@ -413,6 +428,58 @@ function updateTemplateForInvalidDesignations(template, authentication) {
     });
 }
 exports.updateTemplateForInvalidDesignations = updateTemplateForInvalidDesignations;
+/**
+ * Get the contingent values for each layer in the service.
+ * Remove key props that cannot be included with the addToDef call on deploy.
+ * Store the values alongside other key feature service properties in the template
+ *
+ * @param properties the current feature services properties
+ * @param adminUrl the current feature service url
+ * @param authentication Credentials for the request to AGOL
+ * @returns A promise that will resolve when the contingent values have been fetched.
+ * This function will update the provided properties argument when contingent values are found.
+ */
+function processContingentValues(properties, adminUrl, authentication) {
+    return new Promise((resolve, reject) => {
+        if ((0, generalHelpers_1.getProp)(properties, 'service.isView')) {
+            // views will inherit from the source service
+            resolve();
+        }
+        else {
+            const layersAndTables = (properties.layers || []).concat(properties.tables || []);
+            const layerIds = [];
+            const contingentValuePromises = layersAndTables.reduce((prev, cur) => {
+                /* istanbul ignore else */
+                if (cur.hasContingentValuesDefinition) {
+                    prev.push((0, restHelpers_1.rest_request)(`${adminUrl}/${cur['id']}/contingentValues?f=json`, { authentication }));
+                    layerIds.push(cur['id']);
+                }
+                return prev;
+            }, []);
+            if (contingentValuePromises.length > 0) {
+                Promise.all(contingentValuePromises).then((results) => {
+                    const contingentValues = {};
+                    results.forEach((r, i) => {
+                        (0, generalHelpers_1.deleteProp)(r, 'typeCodes');
+                        /* istanbul ignore else */
+                        if ((0, generalHelpers_1.getProp)(r, 'stringDicts') && (0, generalHelpers_1.getProp)(r, 'contingentValuesDefinition')) {
+                            r.contingentValuesDefinition['stringDicts'] = r.stringDicts;
+                            (0, generalHelpers_1.deleteProp)(r, 'stringDicts');
+                        }
+                        (0, generalHelpers_1.deleteProps)((0, generalHelpers_1.getProp)(r, 'contingentValuesDefinition'), ['layerID', 'layerName', 'geometryType', 'hasSubType']);
+                        contingentValues[layerIds[i]] = r;
+                    });
+                    properties.contingentValues = contingentValues;
+                    resolve();
+                }, reject);
+            }
+            else {
+                resolve();
+            }
+        }
+    });
+}
+exports.processContingentValues = processContingentValues;
 /**
  * Replace the field name reference templates with the new field names after deployment.
  *
@@ -524,16 +591,12 @@ function addFeatureServiceLayersAndTables(itemTemplate, templateDictionary, popu
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     updateLayerFieldReferences(itemTemplate, fieldInfos, popupInfos, adminLayerInfos, templateDictionary).then(r => {
                         // Update relationships and layer definitions
-                        let updates = (0, restHelpers_1.getLayerUpdates)({
+                        const updates = (0, restHelpers_1.getLayerUpdates)({
                             message: "updated layer definition",
                             objects: r.layerInfos.fieldInfos,
                             itemTemplate: r.itemTemplate,
                             authentication
                         }, templateDictionary.isPortal);
-                        // Get any updates for the service that should be performed after updates to the layers
-                        if (templateDictionary.isPortal) {
-                            updates = (0, restHelpers_1.getFinalServiceUpdates)(r.itemTemplate, authentication, updates);
-                        }
                         // Process the updates sequentially
                         updates
                             .reduce((prev, update) => {
@@ -591,7 +654,9 @@ function addFeatureServiceDefinition(serviceUrl, listToAdd, templateDictionary,
             listToAdd.forEach((toAdd, i) => {
                 let item = toAdd.item;
                 const originalId = item.id;
-                fieldInfos = cacheFieldInfos(item, fieldInfos, templateDictionary.isPortal);
+                fieldInfos = cacheFieldInfos(item, fieldInfos);
+                // cache the values to be added in seperate addToDef calls
+                fieldInfos = cacheContingentValues(item.id, fieldInfos, itemTemplate);
                 /* istanbul ignore else */
                 if (item.isView) {
                     deleteViewProps(item);
@@ -607,9 +672,7 @@ function addFeatureServiceDefinition(serviceUrl, listToAdd, templateDictionary,
                     // update adminLayerInfo before add to definition with view source fieldInfo settings
                     item.adminLayerInfo = (0, templatization_1.replaceInTemplate)(item.adminLayerInfo, templateDictionary);
                     /* istanbul ignore else */
-                    if (!templateDictionary.isPortal &&
-                        fieldInfos &&
-                        fieldInfos.hasOwnProperty(item.id)) {
+                    if (fieldInfos && fieldInfos.hasOwnProperty(item.id)) {
                         Object.keys(templateDictionary).some(k => {
                             if (templateDictionary[k].itemId === itemTemplate.itemId) {
                                 fieldInfos[item.id]["sourceServiceFields"] =
@@ -622,7 +685,7 @@ function addFeatureServiceDefinition(serviceUrl, listToAdd, templateDictionary,
                         });
                         // view field domain and alias can contain different values than the source field
                         // we need to set isViewOverride when added fields that differ from the source field
-                        _validateViewDomainsAndAlias(fieldInfos[item.id], item);
+                        _validateViewFieldInfos(fieldInfos[item.id], item);
                     }
                 }
                 /* istanbul ignore else */
@@ -777,7 +840,6 @@ function _updateForPortal(item, itemTemplate, templateDictionary) {
     }
     // not allowed to set sourceSchemaChangesAllowed or isView for portal
     // these are set when you create the service
-    (0, generalHelpers_1.deleteProp)(item, "sourceSchemaChangesAllowed");
     (0, generalHelpers_1.deleteProp)(item, "isView");
     return item;
 }
@@ -1062,25 +1124,10 @@ function postProcessFields(itemTemplate, layerInfos, popupInfos, adminLayerInfos
                         // more than case change when deployed to protal so keep track of the new names
                         layerInfo["newEditFieldsInfo"] = JSON.parse(JSON.stringify(item.editFieldsInfo));
                     }
-                    // fields that are marked as visible false on a view are all set to
-                    // visible true when added with the layer definition
-                    // update the field visibility to match that of the source
                     /* istanbul ignore else */
                     if (isView && templateInfo && templateDictionary.isPortal) {
                         // when the item is a view bring over the source service fields so we can compare the domains
                         layerInfo["sourceServiceFields"] = templateInfo.sourceServiceFields;
-                        let fieldUpdates = _getFieldVisibilityUpdates(layerInfo);
-                        // view field domains can contain different values than the source field domains
-                        // use the cached view domain when it differs from the source view domain
-                        fieldUpdates = _validateDomains(layerInfo, fieldUpdates);
-                        /* istanbul ignore else */
-                        if (fieldUpdates.length > 0) {
-                            layerInfo.fields = fieldUpdates;
-                        }
-                        layerInfo.typeIdField = _getTypeIdField(item);
-                        const fieldNames = layerInfo.newFields.map((f) => f.name);
-                        _validateTemplatesFields(layerInfo, fieldNames);
-                        _validateTypesTemplates(layerInfo, fieldNames);
                     }
                 }
             });
@@ -1097,146 +1144,36 @@ function postProcessFields(itemTemplate, layerInfos, popupInfos, adminLayerInfos
 }
 exports.postProcessFields = postProcessFields;
 /**
- * when deploying to portal if a view has a different typeIdField than what it being set on the source service
- *  we need to pass it via an updateDef call or it will be set as the typeIdField of the source service
+ * View field domain, alias, editable, and visible props can contain
+ * different values from the source.
  *
- * @param item current layer or table
- * @returns name of field to set for typeIdField in the update call
- * @private
- */
-function _getTypeIdField(item) {
-    const typeIdFields = item.fields.filter((f) => {
-        return (f.name &&
-            item.typeIdField &&
-            f.name.toLowerCase() === item.typeIdField.toLowerCase());
-    });
-    return Array.isArray(typeIdFields) && typeIdFields.length === 1
-        ? typeIdFields[0].name
-        : item.typeIdField;
-}
-exports._getTypeIdField = _getTypeIdField;
-/**
- * Update a views field visibility to match that of the source
- *  Fields that are marked as visible false on a view are all set to
- *  visible true when added with the layer definition
- *
- * @param fieldInfo current layers or tables fieldInfo
- * @returns Array of fields that should not be visible in the view
- * @private
- */
-function _getFieldVisibilityUpdates(fieldInfo) {
-    const visibilityUpdates = [];
-    if (fieldInfo && fieldInfo["sourceFields"] && fieldInfo["newFields"]) {
-        const sourceFields = fieldInfo["sourceFields"].reduce((hash, f) => {
-            hash[String(f.name).toLocaleLowerCase()] = f.visible;
-            return hash;
-        }, {});
-        fieldInfo["newFields"].forEach((f) => {
-            const name = String(f.name).toLocaleLowerCase();
-            // only add fields that are not visible
-            if (sourceFields.hasOwnProperty(name) && !sourceFields[name]) {
-                visibilityUpdates.push({
-                    name: f.name,
-                    visible: sourceFields[name]
-                });
-            }
-        });
-    }
-    return visibilityUpdates;
-}
-exports._getFieldVisibilityUpdates = _getFieldVisibilityUpdates;
-/**
- *  view field domains can contain different values than the source feature service field domains
- *  use the cached domain when it differs from the source view field domain
+ * We need to check and set isFieldOverride to true when this occurs and false when it does not
  *
  * @param fieldInfo current view layer or table fieldInfo
- * @param fieldUpdates any existing field updates
- * @returns Array of fields to be updated
- * @private
- */
-function _validateDomains(fieldInfo, fieldUpdates) {
-    const domainAliasInfos = _getDomainAndAliasInfos(fieldInfo);
-    const domainFields = domainAliasInfos.domainFields;
-    const domainNames = domainAliasInfos.domainNames;
-    const aliasFields = domainAliasInfos.aliasFields;
-    const aliasNames = domainAliasInfos.aliasNames;
-    // loop through the fields from the new view service
-    // add an update when the domains don't match
-    fieldInfo.newFields.forEach((field) => {
-        _getPortalViewFieldUpdates(field, domainNames, domainFields, "domain", fieldUpdates);
-        _getPortalViewFieldUpdates(field, aliasNames, aliasFields, "alias", fieldUpdates);
-    });
-    return fieldUpdates;
-}
-exports._validateDomains = _validateDomains;
-/**
- *  Get portal field updates to be added with an updateDefinition call after the
- * initial addToDef
+ * @param item that stores the view fields
  *
- * @param field the current field instance
- * @param names the alias of domain field names
- * @param fields the alias or domain fields
- * @param key the field key to evaluate
- * @param fieldUpdates any existing field updates
+ * This function will update the item that is provided
  * @private
  */
-function _getPortalViewFieldUpdates(field, names, fields, key, fieldUpdates) {
-    if (field.hasOwnProperty(key) && field[key]) {
-        const i = names.indexOf(String(field.name).toLocaleLowerCase());
-        if (JSON.stringify(field[key]) !== (i > -1 ? JSON.stringify(fields[i]) : "")) {
-            // should mixin the update if the field already has some other update
-            let hasUpdate = false;
-            fieldUpdates.some((update) => {
-                if (update.name === field.name) {
-                    hasUpdate = true;
-                    update[key] = field[key];
-                }
-                return hasUpdate;
-            });
-            if (!hasUpdate) {
-                const update = { name: field.name };
-                update[key] = field[key];
-                fieldUpdates.push(update);
-            }
-        }
-    }
-}
-exports._getPortalViewFieldUpdates = _getPortalViewFieldUpdates;
-/**
- *  view field domains can contain different values than the source feature service field domains
- *  use the cached domain when it differs from the source view field domain
- *
- * @param fieldInfo current view layer or table fieldInfo
- * @param fieldUpdates any existing field updates
- * @returns Array of fields to be updated
- * @private
- */
-function _validateViewDomainsAndAlias(fieldInfo, item) {
-    const domainAliasInfos = _getDomainAndAliasInfos(fieldInfo);
-    const domainFields = domainAliasInfos.domainFields;
-    const domainNames = domainAliasInfos.domainNames;
-    const aliasFields = domainAliasInfos.aliasFields;
-    const aliasNames = domainAliasInfos.aliasNames;
-    // loop through the fields from the item
-    // add isViewOverride when the domains or alias don't match
+function _validateViewFieldInfos(fieldInfo, item) {
+    const fieldInfos = _getViewFieldInfos(fieldInfo);
     item.fields.map((field) => {
-        _isViewFieldOverride(field, domainNames, domainFields, "domain");
-        _isViewFieldOverride(field, aliasNames, aliasFields, "alias");
+        Object.keys(fieldInfos).forEach(fi => {
+            _isViewFieldOverride(field, fieldInfos[fi].names, fieldInfos[fi].vals, fi);
+        });
         return field;
     });
 }
-exports._validateViewDomainsAndAlias = _validateViewDomainsAndAlias;
+exports._validateViewFieldInfos = _validateViewFieldInfos;
 /**
- *  Get array of domain fields and names and alias fields and names
+ *  Get arrays of fields and names for domain, alias, and editable props
  *
  * @param fieldInfo current view layer or table fieldInfo
  * @private
  */
-function _getDomainAndAliasInfos(fieldInfo) {
-    const domainFields = [];
-    const domainNames = [];
-    const aliasFields = [];
-    const aliasNames = [];
+function _getViewFieldInfos(fieldInfo) {
+    const fieldInfos = {};
+    const fieldOverrideKeys = ["domain", "alias", "editable"];
     /* istanbul ignore else */
     if (fieldInfo.sourceServiceFields) {
         Object.keys(fieldInfo.sourceServiceFields).forEach(k => {
@@ -1244,45 +1181,50 @@ function _getDomainAndAliasInfos(fieldInfo) {
             if (fieldInfo.sourceServiceFields[k]) {
                 Object.keys(fieldInfo.sourceServiceFields[k]).forEach(_k => {
                     fieldInfo.sourceServiceFields[k][_k].forEach((field) => {
-                        /* istanbul ignore else */
-                        if (field.hasOwnProperty("domain") && field.domain) {
-                            domainFields.push(field.domain);
-                            domainNames.push(String(field.name).toLocaleLowerCase());
-                        }
-                        /* istanbul ignore else */
-                        if (field.hasOwnProperty("alias") && field.alias) {
-                            aliasFields.push(field.alias);
-                            aliasNames.push(String(field.name).toLocaleLowerCase());
-                        }
+                        fieldOverrideKeys.forEach(o_k => {
+                            /* istanbul ignore else */
+                            if (field.hasOwnProperty(o_k)) {
+                                const name = String(field.name).toLocaleLowerCase();
+                                const v = field[o_k];
+                                if ((0, generalHelpers_1.getProp)(fieldInfos, o_k)) {
+                                    fieldInfos[o_k].names.push(name);
+                                    fieldInfos[o_k].vals.push(v);
+                                }
+                                else {
+                                    fieldInfos[o_k] = {
+                                        names: [name],
+                                        vals: [v]
+                                    };
+                                }
+                            }
+                        });
                     });
                 });
             }
         });
     }
-    return {
-        aliasFields,
-        aliasNames,
-        domainFields,
-        domainNames
-    };
+    return fieldInfos;
 }
-exports._getDomainAndAliasInfos = _getDomainAndAliasInfos;
+exports._getViewFieldInfos = _getViewFieldInfos;
 /**
  * Set isViewOverride for view fields when they have differences from the source FS field
  *
  * @param field the field instance we are testing
  * @param names array of field names
- * @param fields array of fields
+ * @param vals array of values
  * @param key the field key to compare
  * @private
  */
-function _isViewFieldOverride(field, names, fields, key) {
+function _isViewFieldOverride(field, names, vals, key) {
     /* istanbul ignore else */
-    if (field.hasOwnProperty(key) && field[key]) {
+    if (field.hasOwnProperty(key)) {
         const i = names.indexOf(String(field.name).toLocaleLowerCase());
+        const isOverride = JSON.stringify(field[key]) !== (i > -1 ? JSON.stringify(vals[i]) : "");
+        const overrideSet = field.hasOwnProperty('isViewOverride');
+        // need to skip this check if isViewOverride has already been set to true
         /* istanbul ignore else */
-        if (JSON.stringify(field[key]) !== (i > -1 ? JSON.stringify(fields[i]) : "")) {
-            field.isViewOverride = true;
+        if (((overrideSet && !field.isViewOverride) || !overrideSet)) {
+            field.isViewOverride = isOverride;
         }
     }
 }