@esri/solutions-components 0.6.42 → 0.6.44

package/dist/collection/utils/__b302600c5c884ab280e2ff6dc2e1fc78.json

@@ -0,0 +1,387 @@
+{
+    "operationalLayers": [
+        {
+            "id": "18a09252edc-layer-3",
+            "title": "PN related records - Site Addresses",
+            "url": "https://services6.arcgis.com/Pu6Fai10JE2L2xUd/arcgis/rest/services/PN_related_records/FeatureServer/0",
+            "itemId": "e8549e36bdbd4b8d82e69172339d0224",
+            "layerType": "ArcGISFeatureLayer",
+            "popupInfo": {
+                "popupElements": [
+                    {
+                        "type": "relationship",
+                        "description": "",
+                        "displayCount": 1,
+                        "displayType": "list",
+                        "orderByFields": [
+                            {
+                                "field": "OBJECTID",
+                                "order": "asc"
+                            }
+                        ],
+                        "relationshipId": 0,
+                        "title": ""
+                    }
+                ],
+                "relatedRecordsInfo": {
+                    "showRelatedRecords": true,
+                    "orderByFields": [
+                        {
+                            "field": "relationships/0/OBJECTID",
+                            "order": "asc"
+                        }
+                    ]
+                },
+                "expressionInfos": [
+                    {
+                        "name": "expr0",
+                        "title": "Get first record from the parent layer",
+                        "expression": "// Write a script to return a value to show in the pop-up. \n// For example, get the average of 4 fields:\n// Average($feature.SalesQ1, $feature.SalesQ2, $feature.SalesQ3, $feature.SalesQ4)\nvar relatedFeatures = FeatureSetByRelationshipName($feature, \"\", [\"*\"], false)\n//return relatedFeatures\nreturn First(relatedFeatures)['SITEADDkey']\n",
+                        "returnType": "string"
+                    }
+                ],
+                "fieldInfos": [
+                    {
+                        "fieldName": "OBJECTID",
+                        "format": {
+                            "digitSeparator": false,
+                            "places": 0
+                        },
+                        "isEditable": false,
+                        "label": "OBJECTID",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "SITEADDID",
+                        "isEditable": true,
+                        "label": "Site Address ID",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ADDPTKEY",
+                        "isEditable": true,
+                        "label": "Address Point ID",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PREADDRNUM",
+                        "isEditable": true,
+                        "label": "Address Number Prefix",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ADDRNUMSUF",
+                        "isEditable": true,
+                        "label": "Address Number Suffix",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ADDRNUM",
+                        "isEditable": true,
+                        "label": "Full Address Number",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ADDRRANGE",
+                        "isEditable": true,
+                        "label": "Address Range",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "UNITTYPE",
+                        "isEditable": true,
+                        "label": "Address Unit Type",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "UNITID",
+                        "isEditable": true,
+                        "label": "Address Unit Number",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ALTUNITTYPE",
+                        "isEditable": true,
+                        "label": "Alternate Address Unit Type",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ALTUNITID",
+                        "isEditable": true,
+                        "label": "Alternate Address Unit Number",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "FULLNAME",
+                        "isEditable": true,
+                        "label": "Full Road Name",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "FULLADDR",
+                        "isEditable": true,
+                        "label": "Full Address",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PLACENAME",
+                        "isEditable": true,
+                        "label": "Place Name",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "MUNICIPALITY",
+                        "isEditable": true,
+                        "label": "Municipality Name",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ESN",
+                        "isEditable": true,
+                        "label": "Emergency Service Number",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSAP",
+                        "isEditable": true,
+                        "label": "Public Safety Answering Point",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "MSAG",
+                        "isEditable": true,
+                        "label": "MSAG Community",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "USNGCOORD",
+                        "isEditable": true,
+                        "label": "USNG Coordinate",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "ADDRCLASS",
+                        "format": {
+                            "digitSeparator": false,
+                            "places": 0
+                        },
+                        "isEditable": true,
+                        "label": "Description",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "POINTTYPE",
+                        "isEditable": true,
+                        "label": "Location",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "CAPTUREMETH",
+                        "isEditable": true,
+                        "label": "Capture Method",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "STATUS",
+                        "isEditable": true,
+                        "label": "Status",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "expression/expr0",
+                        "isEditable": true,
+                        "visible": false
+                    }
+                ],
+                "title": ""
+            }
+        }
+    ],
+    "tables": [
+        {
+            "id": "18a09252edd-layer-4",
+            "title": "PN related records - Postal Addresses",
+            "url": "https://services6.arcgis.com/Pu6Fai10JE2L2xUd/arcgis/rest/services/PN_related_records/FeatureServer/3",
+            "itemId": "e8549e36bdbd4b8d82e69172339d0224",
+            "popupInfo": {
+                "popupElements": [
+                    {
+                        "type": "text",
+                        "text": "<p>{expression/expr0}&nbsp;&nbsp;&nbsp;<br />{OWNERNM1}&nbsp;&nbsp;&nbsp;<br />{PSTLADDRESS}&nbsp;&nbsp;&nbsp;<br />{PSTLCITY} , {PSTLSTATE}, {PSTLZIP5}&nbsp;<\/p>"
+                    }
+                ],
+                "description": "<p>{expression/expr0}&nbsp;&nbsp;&nbsp;<br />{OWNERNM1}&nbsp;&nbsp;&nbsp;<br />{PSTLADDRESS}&nbsp;&nbsp;&nbsp;<br />{PSTLCITY} , {PSTLSTATE}, {PSTLZIP5}&nbsp;<\/p>",
+                "expressionInfos": [
+                    {
+                        "name": "expr0",
+                        "title": "New expression",
+                        "expression": "// Write a script to return a value to show in the pop-up. \n// For example, get the average of 4 fields:\n// Average($feature.SalesQ1, $feature.SalesQ2, $feature.SalesQ3, $feature.SalesQ4)\nvar relatedFeatures = FeatureSetByRelationshipName($feature, \"\", [\"*\"], false)\nreturn First(relatedFeatures)['SITEADDID']\n",
+                        "returnType": "string"
+                    }
+                ],
+                "fieldInfos": [
+                    {
+                        "fieldName": "OBJECTID",
+                        "format": {
+                            "digitSeparator": false,
+                            "places": 0
+                        },
+                        "isEditable": false,
+                        "label": "OBJECTID",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLADDID",
+                        "isEditable": true,
+                        "label": "Postal Address Identifier",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "SITEADDKEY",
+                        "isEditable": true,
+                        "label": "Site Address ID",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "OWNERNM1",
+                        "isEditable": true,
+                        "label": "Owner Name",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "OWNERNM2",
+                        "isEditable": true,
+                        "label": "Owner Name",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLADDRESS",
+                        "isEditable": true,
+                        "label": "Postal Address",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLCITY",
+                        "isEditable": true,
+                        "label": "Postal City",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLSTATE",
+                        "isEditable": true,
+                        "label": "Postal State",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLZIP5",
+                        "isEditable": true,
+                        "label": "Postal Zip 5",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "PSTLZIP4",
+                        "isEditable": true,
+                        "label": "Postal Zip +4",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "INTSTATE",
+                        "isEditable": true,
+                        "label": "International State",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "INTPSTLCD",
+                        "isEditable": true,
+                        "label": "International Postal Code",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "COUNTRY",
+                        "isEditable": true,
+                        "label": "Country",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "USPSBOXTYPE",
+                        "isEditable": true,
+                        "label": "USPS Box Type",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "USPSBOXID",
+                        "isEditable": true,
+                        "label": "USPS Box Identifier",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "USPSBOXGRP",
+                        "isEditable": true,
+                        "label": "USPS Box Group",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "REPRESENT",
+                        "isEditable": true,
+                        "label": "Owner / Occupant",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "STATUS",
+                        "isEditable": true,
+                        "label": "Status",
+                        "visible": true
+                    },
+                    {
+                        "fieldName": "expression/expr0",
+                        "isEditable": true,
+                        "visible": false
+                    }
+                ],
+                "title": ""
+            }
+        }
+    ],
+    "baseMap": {
+        "baseMapLayers": [
+            {
+                "id": "World_Hillshade_3805",
+                "opacity": 1,
+                "title": "World Hillshade",
+                "url": "https://services.arcgisonline.com/arcgis/rest/services/Elevation/World_Hillshade/MapServer",
+                "visibility": true,
+                "layerType": "ArcGISTiledMapServiceLayer"
+            },
+            {
+                "id": "VectorTile_2333",
+                "opacity": 1,
+                "title": "World Topographic Map",
+                "visibility": true,
+                "layerType": "VectorTileLayer",
+                "styleUrl": "https://cdn.arcgis.com/sharing/rest/content/items/7dc6cea0b1764a1f9af2e679f642f0f5/resources/styles/root.json"
+            }
+        ],
+        "title": "Topographic"
+    },
+    "authoringApp": "ArcGISMapViewer",
+    "authoringAppVersion": "2023.2",
+    "initialState": {
+        "viewpoint": {
+            "targetGeometry": {
+                "spatialReference": {
+                    "latestWkid": 3857,
+                    "wkid": 102100
+                },
+                "xmin": -9907730.599516412,
+                "ymin": 5079172.794841483,
+                "xmax": -9781762.376902392,
+                "ymax": 5179916.798121383
+            }
+        }
+    },
+    "spatialReference": {
+        "latestWkid": 3857,
+        "wkid": 102100
+    },
+    "version": "2.28"
+}

package/dist/collection/utils/downloadUtils.js

@@ -335,12 +335,13 @@ export function _getExpressionsFromLabel(labelFormat) {
   return (_a = labelFormat.match(arcadeExpressionRegExp)) !== null && _a !== void 0 ? _a : [];
 }
 /**
- * Get the related records for a feature service.
+ * Gets the related records for a feature service.
  *
  * @param url Feature service's URL, e.g., layer.url
  * @param layerId Id of layer within a feature service
  * @param relationshipId Id of relationship
  * @param objectIds Objects in the feature service whose related records are sought
+ * @returns Promise resolving to an array of objects and their related records
  */
 export function _getFeatureServiceRelatedRecords(url, layerId, relationshipId, objectIds) {
   // See if the URL points to a service rather than a layer
@@ -349,11 +350,33 @@ export function _getFeatureServiceRelatedRecords(url, layerId, relationshipId, o
     url += "/" + layerId.toString();
   }
   const options = {
-    url,
+    definitionExpression: "1=1",
+    httpMethod: "POST",
+    objectIds,
+    outFields: "*",
     relationshipId,
-    objectIds
+    url
   };
-  return queryRelated(options);
+  return _getFeatureServiceRelatedRecordsTranche(options);
+}
+/**
+ * Gets a tranche of related records for a feature service.
+ *
+ * @param options Options for arcgis-rest-js' queryRelated function
+ * @param relationships Array of related records accumulated so far
+ * @param resultOffset Number of records already retrieved
+ * @returns Promise resolving to an array of objects and their related records
+ */
+export function _getFeatureServiceRelatedRecordsTranche(options, relationships = [], resultOffset = 0) {
+  return queryRelated(Object.assign(Object.assign({}, options), { params: {
+      resultOffset
+    } }))
+    .then((response) => {
+    relationships.push(...response.relatedRecordGroups);
+    // If exceededTransferLimit is true, then there are more records to retrieve and the feature service
+    // supports the resultOffset parameter
+    return response.exceededTransferLimit ? _getFeatureServiceRelatedRecordsTranche(options, relationships, resultOffset + response.relatedRecordGroups.length) : Promise.resolve(relationships);
+  });
 }
 /**
  * Extracts field name expressions from the lines of a label format.
@@ -428,11 +451,9 @@ export async function _getLabelFormat(webmap, layer, formatUsingLayerPopup) {
       if (labelFormatType === "relationship") {
         const relationshipId = layer.popupTemplate.content[0].relationshipId;
         // Get related layer
+        const layerRelationship = layer.relationships.find(relationship => relationship.id === relationshipId);
         let webmapLayers = webmap.layers.toArray().concat(webmap.tables.toArray());
-        webmapLayers = webmapLayers.filter((webmapLayer) => webmapLayer.type === "feature"
-          && webmapLayer.id !== layer.id
-          && webmapLayer.relationships
-          && webmapLayer.relationships.some(relationship => relationship.id === relationshipId));
+        webmapLayers = webmapLayers.filter((webmapLayer) => webmapLayer.type === "feature" && webmapLayer.layerId === layerRelationship.relatedTableId);
         if (webmapLayers.length > 0) {
           labelFormatProps = await _getLabelFormat(webmap, webmapLayers[0], formatUsingLayerPopup);
           labelFormatProps.relationshipId = relationshipId;
@@ -611,18 +632,54 @@ export async function _prepareLabels(webmap, layer, ids, formatUsingLayerPopup =
   const featureLayer = labelFormatProps.layer;
   let featureSet = [];
   if (typeof (labelFormatProps.relationshipId) !== "undefined") {
-    // Get the related items for each id
-    const relatedRecResponse = await _getFeatureServiceRelatedRecords(layer.url, layer.layerId, labelFormatProps.relationshipId, ids);
+    // Get the related items for each id; we're asking for the full item
+    const relatedRecordGroups = await _getFeatureServiceRelatedRecords(layer.url, layer.layerId, labelFormatProps.relationshipId, ids);
+    // Extract the attributes from the results and merge them into a single list. relatedRecordGroups has the form
+    //    [{
+    //      "objectId",
+    //      "relatedRecords": [{
+    //        "attributes": {}
+    //      }, {
+    //        "attributes": {}
+    //      }, {
+    //        "attributes": {}
+    //      }]
+    //    }, {
+    //      "objectId",
+    //      "relatedRecords": [{
+    //        "attributes": {}
+    //      }, {
+    //        "attributes": {}
+    //      }, {
+    //        :    :
+    //      }]
+    //    }, {
+    //      :    :
+    //    }]
+    const relatedFeatures = [];
+    relatedRecordGroups.forEach((relatedRecGroup) => {
+      relatedRecGroup.relatedRecords.forEach((relatedRec) => {
+        relatedFeatures.push(relatedRec.attributes);
+      });
+    });
+    // Sort and remove duplicates
     const objectIdField = layer.objectIdField;
-    let relatedFeatureIds = [];
-    relatedRecResponse.relatedRecordGroups.forEach((relatedRecGroup) => {
-      relatedFeatureIds = relatedFeatureIds.concat(relatedRecGroup.relatedRecords.map((rec) => rec.attributes[objectIdField]));
+    relatedFeatures.sort((a, b) => {
+      if (a[objectIdField] < b[objectIdField]) {
+        return -1;
+      }
+      else if (a[objectIdField] > b[objectIdField]) {
+        return 1;
+      }
+      else {
+        return 0;
+      }
     });
-    // Remove duplicates
-    relatedFeatureIds.sort();
-    relatedFeatureIds = relatedFeatureIds.filter((id, i) => i === 0 ? true : id !== relatedFeatureIds[i - 1]);
-    // Get the full items
-    featureSet = await queryFeaturesByID(relatedFeatureIds, featureLayer, [], false);
+    featureSet = relatedFeatures.filter((feature, i) => i === 0 ? true : feature[objectIdField] !== relatedFeatures[i - 1][objectIdField]);
+    // Handle the special case where no related records were found for the set of features
+    if (featureSet.length === 0) {
+      return Promise.resolve([]);
+    }
   }
   else {
     // Get the features to export
@@ -632,12 +689,21 @@ export async function _prepareLabels(webmap, layer, ids, formatUsingLayerPopup =
   const attributeOrigNames = {};
   const attributeTypes = {};
   const attributeDomains = {};
-  featureLayer.fields.forEach(field => {
-    const lowercaseFieldname = field.name.toLowerCase();
-    attributeOrigNames[lowercaseFieldname] = field.name;
-    attributeDomains[lowercaseFieldname] = field.domain;
-    attributeTypes[lowercaseFieldname] = field.type;
-  });
+  if (featureLayer.fields) {
+    featureLayer.fields.forEach(field => {
+      const lowercaseFieldname = field.name.toLowerCase();
+      attributeOrigNames[lowercaseFieldname] = field.name;
+      attributeDomains[lowercaseFieldname] = field.domain;
+      attributeTypes[lowercaseFieldname] = field.type;
+    });
+  }
+  else {
+    // Feature layer is missing fields, so get info from first feature
+    Object.keys(featureSet[0]).forEach(fieldName => {
+      const lowercaseFieldname = fieldName.toLowerCase();
+      attributeOrigNames[lowercaseFieldname] = fieldName;
+    });
+  }
   // Apply the label format
   const labels = labelFormatProps.labelFormat.type === "pattern" ?
     // Export attributes in format
@@ -705,6 +771,7 @@ featureSet, attributeOrigNames, attributeTypes, attributeDomains, attributeForma
   //const arcadeExpressionMatches = labelFormat.match(arcadeExpressionRegExp) ?? [];
   // Convert feature attributes into an array of labels
   const labels = await Promise.all(featureSet.map(async (feature) => {
+    var _a;
     let labelPrep = labelFormat;
     /*
     // Replace Arcade expressions in this feature
@@ -716,9 +783,10 @@ featureSet, attributeOrigNames, attributeTypes, attributeDomains, attributeForma
     }
     */
     // Replace non-Arcade fields in this feature
+    const attributeValues = (_a = feature.attributes) !== null && _a !== void 0 ? _a : feature;
     attributeNames.forEach((attributeName, i) => {
       const lowercaseFieldname = attributeName.toLowerCase();
-      const value = _prepareAttributeValue(feature.attributes[attributeOrigNames[lowercaseFieldname]], attributeTypes[lowercaseFieldname], attributeDomains[lowercaseFieldname], attributeFormats[lowercaseFieldname], intl);
+      const value = _prepareAttributeValue(attributeValues[attributeOrigNames[lowercaseFieldname]], attributeTypes[lowercaseFieldname], attributeDomains[lowercaseFieldname], attributeFormats[lowercaseFieldname], intl);
       labelPrep = labelPrep.replace(attributeExpressionMatches[i], value);
     });
     // Split label into lines