@esri/solutions-components 0.6.42 → 0.6.44

package/dist/solutions-components/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/solutions-components/utils/downloadUtils.ts

@@ -72,6 +72,22 @@ export interface ILayerRelationshipQueryHash {
   [relationshipId: string]: ILayerRelationshipQuery;
 }
 
+/**
+ * Related record query request options with new exceededTransferLimit property.
+ */
+export interface IQueryRelatedOptionsOffset extends IQueryRelatedOptions {
+  params: {
+    resultOffset: number;
+  }
+}
+
+/**
+ * Related record response structure with new exceededTransferLimit property.
+ */
+export interface IQueryRelatedResponseOffset extends IQueryRelatedResponse {
+  exceededTransferLimit?: boolean;
+}
+
 // Class RelationshipQuery doesn't appear to work, and so since
 // https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryRelatedFeatures
 // says that the relationshipQuery argument is autocast, we'll set up a variant for the class
@@ -468,19 +484,20 @@ export function _getExpressionsFromLabel(
 }
 
 /**
- * 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: string,
   layerId: number,
   relationshipId?: number,
   objectIds?: number[]
-): Promise<IQueryRelatedResponse> {
+): Promise<IRelatedRecordGroup[]> {
   // See if the URL points to a service rather than a layer
   const endOfUrl = url.substring(url.lastIndexOf("/") + 1);
   if (isNaN(parseInt(endOfUrl))) {
@@ -488,12 +505,46 @@ export function _getFeatureServiceRelatedRecords(
   }
 
   const options: IQueryRelatedOptions = {
-    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: IQueryRelatedOptions,
+  relationships: IRelatedRecordGroup[] = [],
+  resultOffset = 0
+): Promise<IRelatedRecordGroup[]> {
+  return queryRelated({
+    ...options,
+    params: {
+      resultOffset
+    }
+  } as IQueryRelatedOptionsOffset)
+  .then(
+    (response: IQueryRelatedResponseOffset) => {
+      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);
+    }
+  );
 }
 
 /**
@@ -585,14 +636,12 @@ export async function _getLabelFormat(
         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()) as  __esri.FeatureLayer[];
         webmapLayers = webmapLayers.filter(
           (webmapLayer: __esri.FeatureLayer) =>
-            webmapLayer.type === "feature"
-            && webmapLayer.id !== layer.id
-            && webmapLayer.relationships
-            && webmapLayer.relationships.some(relationship => relationship.id === relationshipId)
-          );
+            webmapLayer.type === "feature" && webmapLayer.layerId === layerRelationship.relatedTableId
+        );
 
         if (webmapLayers.length > 0) {
           labelFormatProps = await _getLabelFormat(webmap, webmapLayers[0], formatUsingLayerPopup);
@@ -804,23 +853,63 @@ export async function _prepareLabels(
 
   let featureSet: __esri.Graphic[] = [];
   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: any[] = [];
+    relatedRecordGroups.forEach(
+      (relatedRecGroup: IRelatedRecordGroup) => {
+        relatedRecGroup.relatedRecords.forEach(
+          (relatedRec: IFeature) => {
+            relatedFeatures.push(relatedRec.attributes);
+          }
+        );
+      }
+    );
 
+    // Sort and remove duplicates
     const objectIdField = layer.objectIdField;
-    let relatedFeatureIds: number[] = [];
-    relatedRecResponse.relatedRecordGroups.forEach(
-      (relatedRecGroup: IRelatedRecordGroup) => {
-        relatedFeatureIds = relatedFeatureIds.concat(relatedRecGroup.relatedRecords.map((rec: IFeature) => 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]);
+    featureSet = relatedFeatures.filter((feature, i) => i === 0 ? true : feature[objectIdField] !== relatedFeatures[i-1][objectIdField]);
 
-    // Get the full items
-    featureSet = await queryFeaturesByID(relatedFeatureIds, featureLayer, [], false);
+    // 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
@@ -831,14 +920,25 @@ export async function _prepareLabels(
   const attributeOrigNames: IAttributeOrigNames = {};
   const attributeTypes: IAttributeTypes = {};
   const attributeDomains: IAttributeDomains = {};
-  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
@@ -953,10 +1053,11 @@ export async function _prepareLabelsFromPattern(
       */
 
       // Replace non-Arcade fields in this feature
+      const attributeValues = feature.attributes ?? feature;
       attributeNames.forEach(
         (attributeName: string, i: number) => {
           const lowercaseFieldname = attributeName.toLowerCase();
-          const value = _prepareAttributeValue(feature.attributes[attributeOrigNames[lowercaseFieldname]],
+          const value = _prepareAttributeValue(attributeValues[attributeOrigNames[lowercaseFieldname]],
             attributeTypes[lowercaseFieldname], attributeDomains[lowercaseFieldname],
             attributeFormats[lowercaseFieldname], intl);
           labelPrep = labelPrep.replace(attributeExpressionMatches[i], value);

package/dist/solutions-components/utils/test/downloadUtils.spec.tsx

@@ -267,7 +267,15 @@ describe("downloadUtils", () => {
     it("handles a feature layer", () => {
       const url = "https://servicesdev.arcgis.com/D2C14713795/ArcGIS/rest/services/addresses/FeatureServer/0";
       const layerId = 5;
-      const expectedOptions: restFeatureLayer.IQueryRelatedOptions = {
+      const expectedOptions: downloadUtils.IQueryRelatedOptionsOffset = {
+        definitionExpression: "1=1",
+        httpMethod: "POST",
+        objectIds: undefined,
+        outFields: "*",
+        relationshipId: undefined,
+        params: {
+          resultOffset: 0
+        },
         url
       };
       const queryResponse: restFeatureLayer.IQueryRelatedResponse = { relatedRecordGroups: [] };
@@ -280,7 +288,15 @@ describe("downloadUtils", () => {
     it("handles a feature service", () => {
       const url = "https://servicesdev.arcgis.com/D2C14713795/ArcGIS/rest/services/addresses/FeatureServer";
       const layerId = 5;
-      const expectedOptions: restFeatureLayer.IQueryRelatedOptions = {
+      const expectedOptions: downloadUtils.IQueryRelatedOptionsOffset = {
+        definitionExpression: "1=1",
+        httpMethod: "POST",
+        objectIds: undefined,
+        outFields: "*",
+        relationshipId: undefined,
+        params: {
+          resultOffset: 0
+        },
         url: "https://servicesdev.arcgis.com/D2C14713795/ArcGIS/rest/services/addresses/FeatureServer/5"
       };
       const queryResponse: restFeatureLayer.IQueryRelatedResponse = { relatedRecordGroups: [] };
@@ -295,10 +311,16 @@ describe("downloadUtils", () => {
       const layerId = 5;
       const relationshipId = 3;
       const objectIds = [7, 8, 9];
-      const expectedOptions: restFeatureLayer.IQueryRelatedOptions = {
-        url,
+      const expectedOptions: downloadUtils.IQueryRelatedOptionsOffset = {
+        definitionExpression: "1=1",
+        httpMethod: "POST",
+        objectIds,
+        outFields: "*",
         relationshipId,
-        objectIds
+        params: {
+          resultOffset: 0
+        },
+        url
       };
       const queryResponse: restFeatureLayer.IQueryRelatedResponse = { relatedRecordGroups: [] };
       const queryRelatedSpy = jest.spyOn(restFeatureLayer, "queryRelated").mockResolvedValue(queryResponse);

package/dist/solutions-components_commit.txt

@@ -0,0 +1,7 @@
+Built 10/30/2023 13:30:16.75 
+bug/409-incorrect-related-records
+commit fe67289b8e74ab51b352897722920a7e8031ed5a
+Author: Mike Tschudi <mtschudi@esri.com>
+Date:   Mon Oct 30 13:15:48 2023 -0700
+
+    Remove deprecated package causing GitHub server error