@esri/solutions-components 0.5.1 → 0.5.2

package/dist/collection/utils/csvDownload.js

@@ -0,0 +1,41 @@
+/*!
+ * Copyright 2022 Esri
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+/** @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+//#region Public functions
+/**
+ * Download the CSV file
+ *
+ * @param title Title (without file extension) to use for file; defaults to "export"
+ * @param outputLines Lines of output to write to file
+ *
+ * @see {@link https://medium.com/@danny.pule/export-json-to-csv-file-using-javascript-a0b7bc5b00d2}
+ */
+export function downloadCSVFile(title, outputLines) {
+  const link = document.createElement("a");
+  if (link.download !== undefined) {
+    link.href = URL.createObjectURL(new Blob(outputLines, { type: "text/csv;charset=utf-8;" }));
+    link.download = `${title}.csv` || "export.csv";
+    link.style.visibility = "hidden";
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+  }
+}
+//#endregion

package/dist/collection/utils/csvDownload.ts

@@ -0,0 +1,42 @@
+/** @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//#region Public functions
+
+/**
+ * Download the CSV file
+ *
+ * @param title Title (without file extension) to use for file; defaults to "export"
+ * @param outputLines Lines of output to write to file
+ *
+ * @see {@link https://medium.com/@danny.pule/export-json-to-csv-file-using-javascript-a0b7bc5b00d2}
+ */
+export function downloadCSVFile(
+  title: string,
+  outputLines: string[]
+): void {
+  const link = document.createElement("a");
+  if (link.download !== undefined) {
+    link.href = URL.createObjectURL(new Blob(outputLines, { type: "text/csv;charset=utf-8;" }));
+    link.download = `${title}.csv` || "export.csv";
+    link.style.visibility = "hidden";
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+  }
+}
+
+//#endregion

package/dist/collection/utils/csvUtils.js

@@ -18,37 +18,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+//#region Declarations
+import * as csvDownload from "./csvDownload";
+//#endregion
 //#region Public functions
 /**
  * Export a csv of the attributes from the features that match the provided ids
  *
+ * @param title Title to use for file
  * @param labels Labels to write
  */
-export function exportCSV(labels) {
+export function exportCSV(title, labels) {
   // Format values to string so it doesn't get tripped up when a value has a comma
   // another option could be to export with a different delimiter
   const outputLines = labels.map(label => Object.values(label).map(v => `"${v}"`).join(",") + "\r\n");
-  _downloadCSVFile(outputLines, `notify-${Date.now().toString()}`);
-}
-//#endregion
-//#region Private functions
-/**
- * Download the CSV file
- *
- * @param outputLines Lines of output to write to file
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
- *
- * @see {@link https://medium.com/@danny.pule/export-json-to-csv-file-using-javascript-a0b7bc5b00d2}
- */
-function _downloadCSVFile(outputLines, fileTitle) {
-  const link = document.createElement("a");
-  if (link.download !== undefined) {
-    link.href = URL.createObjectURL(new Blob(outputLines, { type: "text/csv;charset=utf-8;" }));
-    link.download = `${fileTitle}.csv` || "export.csv";
-    link.style.visibility = "hidden";
-    document.body.appendChild(link);
-    link.click();
-    document.body.removeChild(link);
-  }
+  csvDownload.downloadCSVFile(title, outputLines);
 }
 //#endregion

package/dist/collection/utils/csvUtils.ts

@@ -14,47 +14,28 @@
  * limitations under the License.
  */
 
+//#region Declarations
+
+import * as csvDownload from "./csvDownload";
+
+//#endregion
 //#region Public functions
 
 /**
  * Export a csv of the attributes from the features that match the provided ids
  *
+ * @param title Title to use for file
  * @param labels Labels to write
  */
 export function exportCSV(
+  title: string,
   labels: string[][],
 ): void {
   // Format values to string so it doesn't get tripped up when a value has a comma
   // another option could be to export with a different delimiter
   const outputLines = labels.map(label => Object.values(label).map(v => `"${v}"`).join(",") + "\r\n");
 
-  _downloadCSVFile(outputLines, `notify-${Date.now().toString()}`);
-}
-
-//#endregion
-//#region Private functions
-
-/**
- * Download the CSV file
- *
- * @param outputLines Lines of output to write to file
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
- *
- * @see {@link https://medium.com/@danny.pule/export-json-to-csv-file-using-javascript-a0b7bc5b00d2}
- */
-function _downloadCSVFile(
-  outputLines: string[],
-  fileTitle: string
-): void {
-  const link = document.createElement("a");
-  if (link.download !== undefined) {
-    link.href = URL.createObjectURL(new Blob(outputLines, { type: "text/csv;charset=utf-8;" }));
-    link.download = `${fileTitle}.csv` || "export.csv";
-    link.style.visibility = "hidden";
-    document.body.appendChild(link);
-    link.click();
-    document.body.removeChild(link);
-  }
+  csvDownload.downloadCSVFile(title, outputLines);
 }
 
 //#endregion

package/dist/collection/utils/downloadUtils.js

@@ -40,10 +40,8 @@ const lineSeparatorChar = "|";
  * @returns Promise resolving when function is done
  */
 export async function downloadCSV(selectionSetNames, layer, ids, formatUsingLayerPopup, removeDuplicates = false, addColumnTitle = false) {
-  console.log("downloadCSV using selectionSetNames " + JSON.stringify(selectionSetNames)); //???
-  console.log("downloadCSV removeDuplicates", removeDuplicates); //???
   const labels = await _prepareLabels(layer, ids, removeDuplicates, formatUsingLayerPopup, addColumnTitle);
-  exportCSV(labels);
+  exportCSV(_createTitle(selectionSetNames), labels);
   return Promise.resolve();
 }
 /**
@@ -57,15 +55,13 @@ export async function downloadCSV(selectionSetNames, layer, ids, formatUsingLaye
  * @returns Promise resolving when function is done
  */
 export async function downloadPDF(selectionSetNames, layer, ids, removeDuplicates, labelPageDescription) {
-  console.log("downloadPDF using selectionSetNames " + JSON.stringify(selectionSetNames)); //???
-  console.log("downloadPDF removeDuplicates", removeDuplicates); //???
   let labels = await _prepareLabels(layer, ids, removeDuplicates);
   labels =
     // Remove empty lines in labels
     labels.map(labelLines => labelLines.filter(line => line.length > 0))
       // Remove empty labels
       .filter(label => label.length > 0);
-  exportPDF(labels, labelPageDescription);
+  exportPDF(_createTitle(selectionSetNames), labels, labelPageDescription);
   return Promise.resolve();
 }
 //#endregion
@@ -77,7 +73,7 @@ export async function downloadPDF(selectionSetNames, layer, ids, removeDuplicate
  * @param bypassFieldVisiblity Indicates if the configured fieldInfo visibility property should be ignored
  * @return Label spec with lines separated by `lineSeparatorChar`
  */
-function _convertPopupFieldsToLabelSpec(fieldInfos, bypassFieldVisiblity = false) {
+export function _convertPopupFieldsToLabelSpec(fieldInfos, bypassFieldVisiblity = false) {
   const labelSpec = [];
   // Every visible attribute is used
   fieldInfos.forEach(fieldInfo => {
@@ -96,24 +92,32 @@ function _convertPopupFieldsToLabelSpec(fieldInfos, bypassFieldVisiblity = false
  * "<div style='text-align: left;'>{NAME}<br />{STREET}<br />{CITY}, {STATE} {ZIP} <br /></div>"
  * @return Label spec with lines separated by `lineSeparatorChar`
  */
-function _convertPopupTextToLabelSpec(popupInfo) {
+export function _convertPopupTextToLabelSpec(popupInfo) {
   // Replace <br> variants with the line separator character
   popupInfo = popupInfo.replace(/<br\s*\/?>/gi, lineSeparatorChar);
   // Replace <p> variants with the line separator character, except in the first position
   popupInfo = popupInfo.replace(/<p[^>]*>/gi, lineSeparatorChar).trim().replace(/^\|/, "");
   // Remove </p>
   popupInfo = popupInfo.replace(/<\/p>/gi, "");
-  // Remove \n
-  popupInfo = popupInfo.replace(/\n/gi, "");
-  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations,
-  // and split the label back into individual lines
-  const labelSpec = popupInfo
+  // Replace \n with the line separator character
+  popupInfo = popupInfo.replace(/\n/gi, "|");
+  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations
+  let labelSpec = popupInfo
     .replace(/<[\s.]*[^<>]*\/?>/gi, "")
     .replace(/\xA0/gi, " ")
     .replace(/&lt;/gi, "<")
     .replace(/&gt;/gi, ">")
     .replace(/&nbsp;/gi, " ");
-  return labelSpec;
+  // Trim each line
+  labelSpec = labelSpec.replace(/\s*\|\s*/g, "|");
+  // Remove empty lines
+  while (labelSpec.match(/\|\|/)) {
+    labelSpec = labelSpec.replace(/\|\|/, "|");
+  }
+  // Remove leading and trailing line feeds
+  labelSpec = labelSpec.replace(/^\|/, "");
+  labelSpec = labelSpec.replace(/\|$/, "");
+  return labelSpec.trim();
 }
 ;
 /**
@@ -178,6 +182,18 @@ async function _createArcadeExecutors(labelFormat, layer) {
     return arcadeExecutors;
   });
 }
+/**
+ * Creates a title from a list of selection set names.
+ *
+ * @param selectionSetNames Names to use in title
+ * @return Title composed of the selectionSetNames separated by commas; if there are no
+ * selection set names supplied, "download" is returned
+ */
+export function _createTitle(selectionSetNames) {
+  // Windows doesn't permit the characters \/:*?"<>|
+  const title = selectionSetNames.length > 0 ? selectionSetNames.join(", ") : "download";
+  return title;
+}
 /**
  * Prepares an attribute's value by applying domain and type information.
  *

package/dist/collection/utils/downloadUtils.ts

@@ -68,11 +68,9 @@ export async function downloadCSV(
   removeDuplicates = false,
   addColumnTitle = false
 ): Promise<void> {
-  console.log("downloadCSV using selectionSetNames " + JSON.stringify(selectionSetNames));//???
-  console.log("downloadCSV removeDuplicates", removeDuplicates);//???
   const labels = await _prepareLabels(layer, ids, removeDuplicates, formatUsingLayerPopup, addColumnTitle);
 
-  exportCSV(labels);
+  exportCSV(_createTitle(selectionSetNames), labels);
 
   return Promise.resolve();
 }
@@ -94,8 +92,6 @@ export async function downloadPDF(
   removeDuplicates: boolean,
   labelPageDescription: ILabel
 ): Promise<void> {
-  console.log("downloadPDF using selectionSetNames " + JSON.stringify(selectionSetNames));//???
-  console.log("downloadPDF removeDuplicates", removeDuplicates);//???
   let labels = await _prepareLabels(layer, ids, removeDuplicates);
 
   labels =
@@ -104,7 +100,7 @@ export async function downloadPDF(
     // Remove empty labels
     .filter(label => label.length > 0);
 
-  exportPDF(labels, labelPageDescription);
+  exportPDF(_createTitle(selectionSetNames), labels, labelPageDescription);
 
   return Promise.resolve();
 }
@@ -119,7 +115,7 @@ export async function downloadPDF(
  * @param bypassFieldVisiblity Indicates if the configured fieldInfo visibility property should be ignored
  * @return Label spec with lines separated by `lineSeparatorChar`
  */
-function _convertPopupFieldsToLabelSpec(
+export function _convertPopupFieldsToLabelSpec(
   fieldInfos: __esri.FieldInfo[],
   bypassFieldVisiblity = false
 ): string {
@@ -145,7 +141,7 @@ function _convertPopupFieldsToLabelSpec(
  * "<div style='text-align: left;'>{NAME}<br />{STREET}<br />{CITY}, {STATE} {ZIP} <br /></div>"
  * @return Label spec with lines separated by `lineSeparatorChar`
  */
-function _convertPopupTextToLabelSpec(
+export function _convertPopupTextToLabelSpec(
   popupInfo: string,
 ): string {
   // Replace <br> variants with the line separator character
@@ -157,19 +153,30 @@ function _convertPopupTextToLabelSpec(
   // Remove </p>
   popupInfo = popupInfo.replace(/<\/p>/gi, "");
 
-  // Remove \n
-  popupInfo = popupInfo.replace(/\n/gi, "");
+  // Replace \n with the line separator character
+  popupInfo = popupInfo.replace(/\n/gi, "|");
 
-  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations,
-  // and split the label back into individual lines
-  const labelSpec = popupInfo
+  // Remove remaining HTML tags, replace 0xA0 that popup uses for spaces, and replace some char representations
+  let labelSpec = popupInfo
     .replace(/<[\s.]*[^<>]*\/?>/gi, "")
     .replace(/\xA0/gi, " ")
     .replace(/&lt;/gi, "<")
     .replace(/&gt;/gi, ">")
     .replace(/&nbsp;/gi, " ");
 
-  return labelSpec;
+  // Trim each line
+  labelSpec = labelSpec.replace(/\s*\|\s*/g, "|");
+
+  // Remove empty lines
+  while (labelSpec.match(/\|\|/)) {
+    labelSpec = labelSpec.replace(/\|\|/, "|");
+  }
+
+  // Remove leading and trailing line feeds
+  labelSpec = labelSpec.replace(/^\|/, "");
+  labelSpec = labelSpec.replace(/\|$/, "");
+
+  return labelSpec.trim();
 };
 
 /**
@@ -252,6 +259,21 @@ async function _createArcadeExecutors(
   );
 }
 
+/**
+ * Creates a title from a list of selection set names.
+ *
+ * @param selectionSetNames Names to use in title
+ * @return Title composed of the selectionSetNames separated by commas; if there are no
+ * selection set names supplied, "download" is returned
+ */
+export function _createTitle(
+  selectionSetNames: string[]
+): string {
+  // Windows doesn't permit the characters \/:*?"<>|
+  const title = selectionSetNames.length > 0 ? selectionSetNames.join(", ") : "download";
+  return title;
+}
+
 /**
  * Prepares an attribute's value by applying domain and type information.
  *

package/dist/collection/utils/interfaces.js

@@ -18,6 +18,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export var ELayoutMode;
+(function (ELayoutMode) {
+  ELayoutMode["GRID"] = "GRID";
+  ELayoutMode["HORIZONTAL"] = "HORIZONTAL";
+  ELayoutMode["VERTICAL"] = "VERTICAL";
+})(ELayoutMode || (ELayoutMode = {}));
 /**
  * Resource update types
  */

package/dist/collection/utils/interfaces.ts

@@ -19,6 +19,12 @@ import {
   IItemTemplate
 } from '@esri/solution-common';
 
+export enum ELayoutMode {
+  GRID = "GRID",
+  HORIZONTAL = "HORIZONTAL",
+  VERTICAL = "VERTICAL"
+}
+
 /**
  * Resource update types
  */

package/dist/collection/utils/pdfUtils.js

@@ -28,31 +28,34 @@ export { ILabel } from "../assets/arcgis-pdf-creator/PDFLabels";
 /**
  * Exports a PDF of labels.
  *
+ * @param title Title to use for file
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
  */
-export function exportPDF(labels, labelPageDescription) {
-  _downloadPDFFile(labels, labelPageDescription, `notify-${Date.now().toString()}`);
+export function exportPDF(title, labels, labelPageDescription) {
+  downloadPDFFile(title, labels, labelPageDescription);
 }
 //#endregion
 //#region Private functions
 /**
  * Downloads the PDF file.
  *
+ * @param title Title (without file extension) to use for file; defaults to "export"
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
  */
-function _downloadPDFFile(labels, labelPageDescription, fileTitle) {
+function downloadPDFFile(title, labels, labelPageDescription) {
   const pdfLib = new PDFCreator_jsPDF.PDFCreator_jsPDF();
   pdfLib.initialize({
     pageType: "ANSI_A"
-  }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en", fileTitle, false)
+  }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en", title)
     .then(() => {
     const labeller = new PDFLabels.PDFLabels();
     labeller.initialize(pdfLib)
       .then(async () => {
-      await labeller.addLabelsToDoc(labels, labelPageDescription.labelSpec, 1);
+      await labeller.addLabelsToDoc(labels, labelPageDescription.labelSpec, 1, // startingPageNum
+      title // heading
+      );
       pdfLib.save();
     });
   });

package/dist/collection/utils/pdfUtils.ts

@@ -27,14 +27,16 @@ export { ILabel } from "../assets/arcgis-pdf-creator/PDFLabels";
 /**
  * Exports a PDF of labels.
  *
+ * @param title Title to use for file
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
  */
 export function exportPDF(
+  title: string,
   labels: string[][],
   labelPageDescription: PDFLabels.ILabel
 ): void {
-  _downloadPDFFile(labels, labelPageDescription, `notify-${Date.now().toString()}`);
+  downloadPDFFile(title, labels, labelPageDescription);
 }
 
 //#endregion
@@ -43,21 +45,23 @@ export function exportPDF(
 /**
  * Downloads the PDF file.
  *
+ * @param title Title (without file extension) to use for file; defaults to "export"
  * @param labels Labels to write
  * @param labelPageDescription Page format to use for labels
- * @param fileTitle Title (without file extension) to use for file; defaults to "export"
  */
-function _downloadPDFFile(
+function downloadPDFFile(
+  title: string,
   labels: string[][],
-  labelPageDescription: PDFLabels.ILabel,
-  fileTitle: string
+  labelPageDescription: PDFLabels.ILabel
 ): void {
   const pdfLib = new PDFCreator_jsPDF.PDFCreator_jsPDF();
   pdfLib.initialize(
     {
       pageType: "ANSI_A"
-    }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en",
-    fileTitle, false
+    },
+    getAssetPath(`../assets/arcgis-pdf-creator/`),
+    "en",
+    title
   )
   .then(
     () => {
@@ -68,7 +72,8 @@ function _downloadPDFFile(
           await labeller.addLabelsToDoc(
             labels,
             labelPageDescription.labelSpec,
-            1
+            1,  // startingPageNum
+            title  // heading
           );
 
           pdfLib.save();

package/dist/collection/utils/test/csvUtils.spec.tsx

@@ -0,0 +1,56 @@
+/** @license
+ * Copyright 2023 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as csvDownload from "../csvDownload";
+import * as csvUtils from "../csvUtils";
+import {expect, jest, test} from "@jest/globals";
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe("csvUtils", () => {
+
+  describe("exportCSV", () => {
+
+    it("prepares output lines 1", () => {
+      const title = "title";
+      const labels = [
+        ["Cyd Charise", "1922 Main St", "Amarillo, TX 79118"],
+        ["Fred Astaire", "1899 Main St", "Omaha, NE 68022"],
+        ["Gene Kelly", "1912 Main St", "Pittsburgh, PA 15215"],
+        ["Ginger Rogers", "1911 Main St", "Independence, MO 64050"]
+      ];
+      const expectedOutputLines = [
+        "\"Cyd Charise\",\"1922 Main St\",\"Amarillo, TX 79118\"\r\n",
+        "\"Fred Astaire\",\"1899 Main St\",\"Omaha, NE 68022\"\r\n",
+        "\"Gene Kelly\",\"1912 Main St\",\"Pittsburgh, PA 15215\"\r\n",
+        "\"Ginger Rogers\",\"1911 Main St\",\"Independence, MO 64050\"\r\n"
+      ];
+
+      const downloadCSVFileMock = jest.spyOn(csvDownload, "downloadCSVFile")
+        .mockImplementation(
+          (fileTitle: string, outputLines: string[]) => {}
+        );
+      csvUtils.exportCSV(title, labels);
+      expect(downloadCSVFileMock).toBeCalledTimes(1);
+      expect(downloadCSVFileMock.mock.calls[0][0]).toEqual(title);
+      expect(downloadCSVFileMock.mock.calls[0][1]).toEqual(expectedOutputLines);
+    });
+
+  });
+
+});