@esri/solutions-components 0.6.11 → 0.6.13

package/dist/collection/utils/downloadUtils.js

@@ -23,26 +23,44 @@ import { exportCSV } from "./csvUtils";
 import { exportPDF } from "./pdfUtils";
 import { loadModules } from "./loadModules";
 import { queryFeaturesByID } from "./queryUtils";
+//import * as common from "@esri/solution-common";
 export { ILabel } from "./pdfUtils";
 const lineSeparatorChar = "|";
+import { queryRelated } from "@esri/arcgis-rest-feature-layer";
+/**
+ * Get the related records for a feature service.
+ *
+ * @param url Feature service's URL, e.g., layer.url
+ * @param relationshipId Id of relationship
+ * @param objectIds Objects in the feature service whose related records are sought
+ */
+export function getFeatureServiceRelatedRecords(url, relationshipId, objectIds) {
+  const options = {
+    url: url + `/${relationshipId}`,
+    relationshipId,
+    objectIds
+  };
+  return queryRelated(options);
+}
 //#endregion
 // ------------------------------------------------------------------------------------------------------------------ //
 //#region Public functions
 /**
  * Create and consolidate labels from all layers
  *
+ * @param webmap Webmap containing layer
  * @param exportInfos Key details about what to export (ids, layer, and selectionSetNames)
  * @param formatUsingLayerPopup When true, the layer's popup is used to choose attributes for each column; when false,
  * all attributes are exported
  * @param includeHeaderNames Add the label format at the front of the list of generated labels
  * @returns selectionSetNames that will be used for export filenames
  */
-export async function consolidateLabels(exportInfos, formatUsingLayerPopup = true, includeHeaderNames = false, isCSVExport = false) {
+export async function consolidateLabels(webmap, exportInfos, formatUsingLayerPopup = true, includeHeaderNames = false, isCSVExport = false) {
   const labelRequests = [];
   Object.keys(exportInfos).forEach(k => {
     var _a;
     const labelInfo = exportInfos[k];
-    labelRequests.push(_prepareLabels(((_a = labelInfo.layerView) === null || _a === void 0 ? void 0 : _a.layer) || labelInfo.layer, labelInfo.ids, formatUsingLayerPopup, includeHeaderNames));
+    labelRequests.push(_prepareLabels(webmap, ((_a = labelInfo.layerView) === null || _a === void 0 ? void 0 : _a.layer) || labelInfo.layer, labelInfo.ids, formatUsingLayerPopup, includeHeaderNames));
     if (isCSVExport) {
       // add the layer id as a temp value separator that we can use to split values for CSV export
       labelRequests.push(Promise.resolve([[k]]));
@@ -54,6 +72,7 @@ export async function consolidateLabels(exportInfos, formatUsingLayerPopup = tru
 /**
  * Downloads csv of mailing labels for the provided list of ids
  *
+ * @param webmap Webmap containing layer
  * @param exportInfos Key details about what to export (ids, layer, and selectionSetNames)
  * @param formatUsingLayerPopup When true, the layer's popup is used to choose attributes for each column; when false,
  * all attributes are exported
@@ -61,8 +80,8 @@ export async function consolidateLabels(exportInfos, formatUsingLayerPopup = tru
  * @param addColumnTitle Indicates if column headings should be included in output
  * @returns Promise resolving when function is done
  */
-export async function downloadCSV(exportInfos, formatUsingLayerPopup, removeDuplicates = false, addColumnTitle = false) {
-  let labels = await consolidateLabels(exportInfos, formatUsingLayerPopup, addColumnTitle, true);
+export async function downloadCSV(webmap, exportInfos, formatUsingLayerPopup, removeDuplicates = false, addColumnTitle = false) {
+  let labels = await consolidateLabels(webmap, exportInfos, formatUsingLayerPopup, addColumnTitle, true);
   labels = removeDuplicates ? removeDuplicateLabels(labels) : labels;
   const layerIds = Object.keys(exportInfos);
   let layerLabels = [];
@@ -84,6 +103,7 @@ export async function downloadCSV(exportInfos, formatUsingLayerPopup, removeDupl
 /**
  * Downloads csv of mailing labels for the provided list of ids
  *
+ * @param webmap Webmap containing layer
  * @param exportInfos Key details about what to export (ids, layer, and selectionSetNames)
  * @param labelPageDescription Provides PDF page layout info
  * @param removeDuplicates When true a single label is generated when multiple featues have a shared address value
@@ -91,8 +111,8 @@ export async function downloadCSV(exportInfos, formatUsingLayerPopup, removeDupl
  * @param initialImageDataUrl Data URL of image for first page
  * @returns Promise resolving when function is done
  */
-export async function downloadPDF(exportInfos, labelPageDescription, removeDuplicates = false, title = "", initialImageDataUrl = "") {
-  let labels = await consolidateLabels(exportInfos);
+export async function downloadPDF(webmap, exportInfos, labelPageDescription, removeDuplicates = false, title = "", initialImageDataUrl = "") {
+  let labels = await consolidateLabels(webmap, exportInfos);
   const selectionSetNames = _getSelectionSetNames(exportInfos);
   labels =
     // Remove empty lines in labels
@@ -224,6 +244,87 @@ export async function _convertPopupArcadeToLabelSpec(expressionInfo) {
     format: executor
   });
 }
+/**
+ * Extracts Arcade expressions from the lines of a label format and creates an Arcade executor for each
+ * referenced expression name.
+ *
+ * @param labelFormat Label to examine
+ * @param layer Layer from which to fetch features
+ * @return Promise resolving to a set of executors keyed using the expression name
+ */
+/*
+async function _createArcadeExecutors(
+  labelFormat: string,
+  layer: __esri.FeatureLayer
+): Promise<IArcadeExecutors> {
+  const arcadeExecutors: IArcadeExecutors = {};
+
+  // Are any Arcade expressions in the layer?
+  if (!Array.isArray(layer.popupTemplate.expressionInfos) || layer.popupTemplate.expressionInfos.length === 0) {
+    return Promise.resolve(arcadeExecutors);
+  }
+
+  // Are there any Arcade expressions in the label format?
+  const arcadeExpressionRegExp = /\{expression\/\w+\}/g;
+  const arcadeExpressionsMatches = labelFormat.match(arcadeExpressionRegExp);
+  if (!arcadeExpressionsMatches) {
+    return Promise.resolve(arcadeExecutors);
+  }
+
+  // Generate an Arcade executor for each match
+  const [arcade] = await loadModules(["esri/arcade"]);
+  const labelingProfile: __esri.Profile = {
+    variables: [
+      {
+        name: "$feature",
+        type: "feature"
+      },
+      {
+        name: "$layer",
+        type: "featureSet"
+      },
+      {
+        name: "$datastore",
+        type: "featureSetCollection"
+      },
+      {
+        name: "$map",
+        type: "featureSetCollection"
+      }
+    ]
+  };
+
+  const createArcadeExecutorPromises: IArcadeExecutorPromises = {};
+  arcadeExpressionsMatches.forEach(
+    (match: string) => {
+      const expressionName = match.substring(match.indexOf("/") + 1, match.length - 1);
+
+      (layer.popupTemplate.expressionInfos || []).forEach(
+        expressionInfo => {
+          if (expressionInfo.name === expressionName) {
+            createArcadeExecutorPromises[expressionName] =
+              arcade.createArcadeExecutor(expressionInfo.expression, labelingProfile);
+          }
+        }
+      );
+    }
+  );
+
+  const promises = Object.values(createArcadeExecutorPromises);
+  return Promise.all(promises)
+  .then(
+    executors => {
+      const expressionNames = Object.keys(createArcadeExecutorPromises);
+
+      for (let i = 0; i < expressionNames.length; ++i) {
+        arcadeExecutors[expressionNames[i]] = executors[i].valueOf() as __esri.ArcadeExecutor;
+      }
+
+      return arcadeExecutors;
+    }
+  );
+}
+*/
 /**
  * Creates a title from a list of selection set names.
  *
@@ -236,38 +337,6 @@ export function _createFilename(selectionSetNames) {
   const title = selectionSetNames.length > 0 ? selectionSetNames.join(", ") : "download";
   return title;
 }
-/**
- * Creates relationship queries for each relationship flag in a popup.
- * @param layer Layer whose popup is to be examined
- * @return Hash of relationships by their id, or null if there are no relationship flags in the
- * popup; each relationship has the properties layer and relatedQuery for the related layer
- * and the query for that layer
- */
-export function _createRelationshipQueries(layer) {
-  const relationships = {};
-  const relationshipFieldPattern = /\{relationships\/\d+\//gm;
-  const relationshipIdPattern = /\d+/;
-  // Test if this popup has any relationship references
-  const matches = layer.popupTemplate.content[0].text.match(relationshipFieldPattern);
-  if (matches) {
-    matches.forEach(match => {
-      // Add a query to a found relationship if we don't already have one
-      const id = match.match(relationshipIdPattern)[0];
-      if (!relationships.hasOwnProperty(id)) {
-        const relatedQuery = {
-          outFields: ['*'],
-          relationshipId: id,
-          returnGeometry: false
-        };
-        relationships[id] = {
-          layer,
-          relatedQuery
-        };
-      }
-    });
-  }
-  return relationships;
-}
 /**
  * Extracts Arcade expression references from the lines of a label format.
  *
@@ -319,52 +388,73 @@ export function _getFieldNamesFromFieldExpressions(fieldExpressions) {
 /**
  * Extracts the label format from the layer.
  *
+ * @param webmap Webmap containing layer
  * @param layer Layer with label format
  * @param formatUsingLayerPopup When true, the layer's popup is used to choose attributes for each column; when false,
  * all attributes are exported
- * @param attributeFormats Empty object to hold the formats for each attribute in a feature; the object is filled
- * with formats by this function
  * @returns A Promise resolving to the format of a single label with fields coerced to lowercase, e.g.,
- * for ILabelFormat type "pattern": "{name}|{street}|{city}, {state} {zip}"
+ * for ILabelFormatProps type "pattern": "{name}|{street}|{city}, {state} {zip}"
  */
-export async function _getLabelFormat(layer, formatUsingLayerPopup, attributeFormats) {
-  var _a, _b, _c, _d, _e, _f;
-  let labelFormat = {
-    type: "unsupported",
-    format: undefined
+export async function _getLabelFormat(webmap, layer, formatUsingLayerPopup) {
+  var _a, _b;
+  let labelFormatProps = {
+    layer,
+    attributeFormats: {},
+    relationshipId: undefined,
+    labelFormat: {
+      type: "unsupported",
+      format: undefined
+    }
   };
   if (layer.popupEnabled) {
     layer.popupTemplate.fieldInfos.forEach(
     // Extract any format info that we have
     fieldInfo => {
       if (fieldInfo.format) {
-        attributeFormats[fieldInfo.fieldName.toLowerCase()] = fieldInfo.format;
+        labelFormatProps.attributeFormats[fieldInfo.fieldName.toLowerCase()] = fieldInfo.format;
       }
     });
     // What is the nature of the label content?
     // Fields list
-    if (formatUsingLayerPopup && ((_b = (_a = layer.popupTemplate) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.type) === "fields") {
-      labelFormat = _convertPopupFieldsToLabelSpec(layer.popupTemplate.fieldInfos);
-      // If popup is configured with "no attribute information", then no fields will visible
-      if (labelFormat.format.length === 0) {
-        // Can we use the popup title?
-        labelFormat = layer.popupTemplate.title && typeof layer.popupTemplate.title === "string" ?
-          { type: "pattern", format: layer.popupTemplate.title }
-          :
-            // Otherwise revert to using attributes
-            _convertPopupFieldsToLabelSpec(layer.popupTemplate.fieldInfos, true);
+    if (formatUsingLayerPopup) {
+      const labelFormatType = (_b = (_a = layer.popupTemplate) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.type;
+      if (labelFormatType === "relationship") {
+        const relationshipId = layer.popupTemplate.content[0].relationshipId;
+        const webmapLayers = webmap.layers.toArray().concat(webmap.tables.toArray())
+          .filter((entry) => entry.type === "feature"
+          && entry.id !== layer.id
+          && entry.relationships
+          && entry.relationships.some(relationship => relationship.id === relationshipId));
+        labelFormatProps = await _getLabelFormat(webmap, webmapLayers[0], formatUsingLayerPopup);
+        labelFormatProps.relationshipId = relationshipId;
+      }
+      else if (labelFormatType === "fields") {
+        labelFormatProps.labelFormat = _convertPopupFieldsToLabelSpec(layer.popupTemplate.fieldInfos);
+        // If popup is configured with "no attribute information", then no fields will visible
+        if (labelFormatProps.labelFormat.format.length === 0) {
+          // Can we use the popup title?
+          labelFormatProps.labelFormat = layer.popupTemplate.title && typeof layer.popupTemplate.title === "string" ?
+            { type: "pattern", format: layer.popupTemplate.title }
+            :
+              // Otherwise revert to using attributes
+              _convertPopupFieldsToLabelSpec(layer.popupTemplate.fieldInfos, true);
+        }
+        // Example text: '<p>{name} {age} years &nbsp;</p><p>started: {start}</p>'
+      }
+      else if (labelFormatType === "text") {
+        labelFormatProps.labelFormat = _convertPopupTextToLabelSpec(layer.popupTemplate.content[0].text);
+        // Example expression: 'var feat = $feature\nvar label = `\n\t${feat["name"]} ${feat["age"]} years <br>\n\tstarted: ${feat["start"]}\n`\n\nreturn { \n  type : \'text\', \n  text : label\n}',
+      }
+      else if (labelFormatType === "expression") {
+        labelFormatProps.labelFormat = await _convertPopupArcadeToLabelSpec(layer.popupTemplate.content[0].expressionInfo);
+        // Fallback to all fields
+      }
+      else {
+        labelFormatProps.labelFormat = _convertPopupFieldsToLabelSpec(layer.popupTemplate.fieldInfos);
       }
-      // Example text: '<p>{name} {age} years &nbsp;</p><p>started: {start}</p>'
-    }
-    else if (formatUsingLayerPopup && ((_d = (_c = layer.popupTemplate) === null || _c === void 0 ? void 0 : _c.content[0]) === null || _d === void 0 ? void 0 : _d.type) === "text") {
-      labelFormat = _convertPopupTextToLabelSpec(layer.popupTemplate.content[0].text);
-      // Example expression: 'var feat = $feature\nvar label = `\n\t${feat["name"]} ${feat["age"]} years <br>\n\tstarted: ${feat["start"]}\n`\n\nreturn { \n  type : \'text\', \n  text : label\n}',
-    }
-    else if (formatUsingLayerPopup && ((_f = (_e = layer.popupTemplate) === null || _e === void 0 ? void 0 : _e.content[0]) === null || _f === void 0 ? void 0 : _f.type) === "expression") {
-      labelFormat = await _convertPopupArcadeToLabelSpec(layer.popupTemplate.content[0].expressionInfo);
     }
   }
-  return Promise.resolve(labelFormat);
+  return Promise.resolve(labelFormatProps);
 }
 /**
  * Extract selectionSetNames from the provided exportInfos
@@ -436,6 +526,7 @@ export function _prepareAttributeValue(attributeValue, attributeType, attributeD
 /**
  * Creates labels from items.
  *
+ * @param webmap Webmap containing layer
  * @param layer Layer from which to fetch features
  * @param ids List of ids to download
  * @param formatUsingLayerPopup When true, the layer's popup is used to choose attributes for each column; when false,
@@ -443,32 +534,51 @@ export function _prepareAttributeValue(attributeValue, attributeType, attributeD
  * @param includeHeaderNames Add the label format at the front of the list of generated labels
  * @returns Promise resolving when function is done
  */
-export async function _prepareLabels(layer, ids, formatUsingLayerPopup = true, includeHeaderNames = false) {
-  // Get the features to export
-  const featureSet = await queryFeaturesByID(ids, layer, [], false);
+export async function _prepareLabels(webmap, layer, ids, formatUsingLayerPopup = true, includeHeaderNames = false) {
+  // Get the label formatting, if any
+  const labelFormatProps = await _getLabelFormat(webmap, layer, formatUsingLayerPopup);
+  // Because the label may actually come from a related layer, we'll use the layer that comes back from _getLabelFormat.
+  // That function returns the supplied layer in all cases except for a "relationship" type of popup.
+  const featureLayer = labelFormatProps.layer;
+  let featureSet = [];
+  if (typeof (labelFormatProps.relationshipId) !== "undefined") {
+    // Get the related items for each id
+    const relatedRecResponse = await getFeatureServiceRelatedRecords(layer.url, labelFormatProps.relationshipId, ids);
+    const objectIdField = layer.objectIdField;
+    let relatedFeatureIds = [];
+    relatedRecResponse.relatedRecordGroups.forEach((relatedRecGroup) => {
+      relatedFeatureIds = relatedFeatureIds.concat(relatedRecGroup.relatedRecords.map((rec) => rec.attributes[objectIdField]));
+    });
+    // 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);
+  }
+  else {
+    // Get the features to export
+    featureSet = await queryFeaturesByID(ids, featureLayer, [], false);
+  }
   // Get field data types. Do we have any domain-based fields?
   const attributeOrigNames = {};
   const attributeTypes = {};
   const attributeDomains = {};
-  layer.fields.forEach(field => {
+  featureLayer.fields.forEach(field => {
     const lowercaseFieldname = field.name.toLowerCase();
     attributeOrigNames[lowercaseFieldname] = field.name;
     attributeDomains[lowercaseFieldname] = field.domain;
     attributeTypes[lowercaseFieldname] = field.type;
   });
-  const attributeFormats = {};
-  // Get the label formatting, if any
-  const labelFormat = await _getLabelFormat(layer, formatUsingLayerPopup, attributeFormats);
   // Apply the label format
-  const labels = labelFormat.type === "unsupported" ?
-    // Export all attributes
-    await _prepareLabelsFromAll(featureSet, attributeTypes, attributeDomains, includeHeaderNames)
-    : labelFormat.type == "pattern" ?
-      // Export attributes in format
-      await _prepareLabelsFromPattern(featureSet, attributeOrigNames, attributeTypes, attributeDomains, attributeFormats, labelFormat.format, includeHeaderNames)
+  const labels = labelFormatProps.labelFormat.type === "pattern" ?
+    // Export attributes in format
+    await _prepareLabelsFromPattern(/*layer,*/ featureSet, attributeOrigNames, attributeTypes, attributeDomains, labelFormatProps.attributeFormats, labelFormatProps.labelFormat.format, includeHeaderNames)
+    : labelFormatProps.labelFormat.type === "executor" ?
+      // Export attributes in expression
+      await _prepareLabelsUsingExecutor(featureSet, labelFormatProps.labelFormat.format)
       :
-        // Export attributes in expression
-        await _prepareLabelsUsingExecutor(featureSet, labelFormat.format);
+        // Export all attributes
+        await _prepareLabelsFromAll(featureSet, attributeTypes, attributeDomains, includeHeaderNames);
   return Promise.resolve(labels);
 }
 /**
@@ -512,14 +622,30 @@ export async function _prepareLabelsFromAll(featureSet, attributeTypes, attribut
  * @param includeHeaderNames Add the label format at the front of the list of generated labels
  * @returns Promise resolving with list of labels, each of which is a list of label lines
  */
-export async function _prepareLabelsFromPattern(featureSet, attributeOrigNames, attributeTypes, attributeDomains, attributeFormats, labelFormat, includeHeaderNames = false) {
+export async function _prepareLabelsFromPattern(
+//layer: __esri.FeatureLayer,
+featureSet, attributeOrigNames, attributeTypes, attributeDomains, attributeFormats, labelFormat, includeHeaderNames = false) {
   const [intl] = await loadModules(["esri/intl"]);
   // Find the label fields that we need to replace with values
   const attributeExpressionMatches = _getFieldExpressionsFromLabel(labelFormat);
   const attributeNames = _getFieldNamesFromFieldExpressions(attributeExpressionMatches);
+  // Do we need any Arcade executors?
+  //const arcadeExecutors = await _createArcadeExecutors(labelFormat, layer);
+  //const arcadeExpressionRegExp = /\{expression\/\w+\}/g;
+  // Find the label fields that we need to replace with values
+  //const arcadeExpressionMatches = labelFormat.match(arcadeExpressionRegExp) ?? [];
   // Convert feature attributes into an array of labels
   const labels = await Promise.all(featureSet.map(async (feature) => {
     let labelPrep = labelFormat;
+    /*
+    // Replace Arcade expressions in this feature
+    for (let i = 0; i < arcadeExpressionMatches.length; i++) {
+      const match: string = arcadeExpressionMatches[i];
+      const expressionName = match.substring(match.indexOf("/") + 1, match.length - 1);
+      const value = await arcadeExecutors[expressionName].executeAsync({"$feature": feature, "$layer", layer});
+      labelPrep = labelPrep.replace(match, value);
+    }
+    */
     // Replace non-Arcade fields in this feature
     attributeNames.forEach((attributeName, i) => {
       const lowercaseFieldname = attributeName.toLowerCase();