@esri/solutions-components 0.6.6 → 0.6.7

package/dist/types/utils/common.d.ts

@@ -1,49 +1,49 @@
-/** @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.
- */
-import { UserSession } from "@esri/solution-common";
-import { IResponse, ISolutionModels } from "./interfaces";
-/**
- * Get an array from a list of nodes
- *
- * @param nodeList list of nodes
- *
- * @returns array of nodes
- */
-export declare function nodeListToArray<T extends Element>(nodeList: HTMLCollectionOf<T> | NodeListOf<T> | T[]): T[];
-/**
- * Saves any updated templates to the current solution item
- *
- * @param templates the updated templates array
- * @param thumbnailurl url for the items thumbnail
- * @param id for the solution item
- * @param data the current solution items data
- * @param authentication credentials for the request
- * @param translations translated strings for messages
- *
- * @returns a promise that will resolve with a success true/false response
- */
-export declare function save(id: string, data: any, models: ISolutionModels, authentication: UserSession, translations: any): Promise<IResponse>;
-/**
- * Updates the solutions thumbnail and data resources
- *
- * @param solutionId id for the solution
- * @param models the models for the solutions templates
- * @param data the current data object for the solution
- * @param authentication credentials for the request
- *
- * @returns a promise that will resolve with response results
- */
-export declare function _updateResources(solutionId: string, models: ISolutionModels, data: any, authentication: UserSession): Promise<any>;
+/** @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.
+ */
+import { UserSession } from "@esri/solution-common";
+import { IResponse, ISolutionModels } from "./interfaces";
+/**
+ * Get an array from a list of nodes
+ *
+ * @param nodeList list of nodes
+ *
+ * @returns array of nodes
+ */
+export declare function nodeListToArray<T extends Element>(nodeList: HTMLCollectionOf<T> | NodeListOf<T> | T[]): T[];
+/**
+ * Saves any updated templates to the current solution item
+ *
+ * @param templates the updated templates array
+ * @param thumbnailurl url for the items thumbnail
+ * @param id for the solution item
+ * @param data the current solution items data
+ * @param authentication credentials for the request
+ * @param translations translated strings for messages
+ *
+ * @returns a promise that will resolve with a success true/false response
+ */
+export declare function save(id: string, data: any, models: ISolutionModels, authentication: UserSession, translations: any): Promise<IResponse>;
+/**
+ * Updates the solutions thumbnail and data resources
+ *
+ * @param solutionId id for the solution
+ * @param models the models for the solutions templates
+ * @param data the current data object for the solution
+ * @param authentication credentials for the request
+ *
+ * @returns a promise that will resolve with response results
+ */
+export declare function _updateResources(solutionId: string, models: ISolutionModels, data: any, authentication: UserSession): Promise<any>;

package/dist/types/utils/csvDownload.d.ts

@@ -1,24 +1,24 @@
-/** @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.
- */
-/**
- * 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 declare function downloadCSVFile(title: string, outputLines: string[]): void;
+/** @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.
+ */
+/**
+ * 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 declare function downloadCSVFile(title: string, outputLines: string[]): void;

package/dist/types/utils/csvUtils.d.ts

@@ -1,22 +1,22 @@
-/** @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.
- */
-/**
- * Export a csv of the attributes from the features that match the provided ids
- *
- * @param filename Name to use for file
- * @param labels Labels to write
- */
-export declare function exportCSV(filename: string, labels: string[][]): void;
+/** @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.
+ */
+/**
+ * Export a csv of the attributes from the features that match the provided ids
+ *
+ * @param filename Name to use for file
+ * @param labels Labels to write
+ */
+export declare function exportCSV(filename: string, labels: string[][]): void;

package/dist/types/utils/downloadUtils.d.ts

@@ -1,118 +1,118 @@
-/** @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.
- */
-/// <reference types="arcgis-js-api" />
-import { ILabel } from "./pdfUtils";
-import { IExportInfos } from "../utils/interfaces";
-export { ILabel } from "./pdfUtils";
-interface ILayerRelationshipQuery {
-  layer: __esri.FeatureLayer;
-  relatedQuery: IRelatedFeaturesQuery;
-}
-interface ILayerRelationshipQueryHash {
-  [relationshipId: string]: ILayerRelationshipQuery;
-}
-interface IRelatedFeaturesQuery {
-  outFields: string[];
-  relationshipId: string;
-  returnGeometry: boolean;
-  objectIds?: number;
-}
-/**
- * Downloads csv of mailing labels for the provided list of ids
- *
- * @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 removeDuplicates When true a single label is generated when multiple featues have a shared address value
- * @param addColumnTitle Indicates if column headings should be included in output
- * @returns Promise resolving when function is done
- */
-export declare function downloadCSV(exportInfos: IExportInfos, formatUsingLayerPopup: boolean, removeDuplicates?: boolean, addColumnTitle?: boolean): Promise<void>;
-/**
- * Downloads csv of mailing labels for the provided list of ids
- *
- * @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
- * @param title Title for each page
- * @param initialImageDataUrl Data URL of image for first page
- * @returns Promise resolving when function is done
- */
-export declare function downloadPDF(exportInfos: IExportInfos, labelPageDescription: ILabel, removeDuplicates?: boolean, title?: string, initialImageDataUrl?: string): Promise<void>;
-/**
- * Converts a set of fieldInfos into template lines.
- *
- * @param fieldInfos Layer's fieldInfos structure
- * @param bypassFieldVisiblity Indicates if the configured fieldInfo visibility property should be ignored
- * @return Label spec with lines separated by `lineSeparatorChar`
- */
-export declare function _convertPopupFieldsToLabelSpec(fieldInfos: __esri.FieldInfo[], bypassFieldVisiblity?: boolean): string;
-/**
- * Converts the text of a custom popup into a multiline label specification; conversion splits text into
- * lines on <br>s, and removes HTML tags. It does not handle Arcade and related records.
- *
- * @param popupInfo Layer's popupInfo structure containing description, fieldInfos, and expressionInfos, e.g.,
- * "<div style='text-align: left;'>{NAME}<br />{STREET}<br />{CITY}, {STATE} {ZIP} <br /></div>"
- * @return Label spec with lines separated by `lineSeparatorChar`
- */
-export declare function _convertPopupTextToLabelSpec(popupInfo: string): string;
-/**
- * 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 declare function _createFilename(selectionSetNames: string[]): string;
-/**
- * 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 declare function _createRelationshipQueries(layer: __esri.FeatureLayer): ILayerRelationshipQueryHash;
-/**
- * Extracts Arcade expression references from the lines of a label format.
- *
- * @param labelFormat Label to examine
- * @return Array of Arcade expression references, e.g., ["{expression/expr1}", "{expression/expr2}"]
- */
-export declare function _getExpressionsFromLabel(labelFormat: string): string[];
-/**
- * Extracts field name expressions from the lines of a label format.
- *
- * @param labelFormat Label to examine
- * @returns Array of field name expressions, e.g., ["{NAME}", "{STREET}", "{CITY}", "{STATE}", "{ZIP}"]
- */
-export declare function _getFieldsFromLabel(labelFormat: string): string[];
-/**
- * Remove any duplicate labels
- *
- * @param labels Labels to evaluate for duplicates
- * @returns labels with duplicates removed
- */
-export declare function removeDuplicateLabels(labels: string[][]): string[][];
-/**
- * Create and consolidate labels from all layers
- *
- * @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 declare function consolidateLabels(exportInfos: IExportInfos, formatUsingLayerPopup?: boolean, includeHeaderNames?: boolean, isCSVExport?: boolean): Promise<string[][]>;
+/** @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.
+ */
+/// <reference types="arcgis-js-api" />
+import { ILabel } from "./pdfUtils";
+import { IExportInfos } from "../utils/interfaces";
+export { ILabel } from "./pdfUtils";
+interface ILayerRelationshipQuery {
+  layer: __esri.FeatureLayer;
+  relatedQuery: IRelatedFeaturesQuery;
+}
+interface ILayerRelationshipQueryHash {
+  [relationshipId: string]: ILayerRelationshipQuery;
+}
+interface IRelatedFeaturesQuery {
+  outFields: string[];
+  relationshipId: string;
+  returnGeometry: boolean;
+  objectIds?: number;
+}
+/**
+ * Downloads csv of mailing labels for the provided list of ids
+ *
+ * @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 removeDuplicates When true a single label is generated when multiple featues have a shared address value
+ * @param addColumnTitle Indicates if column headings should be included in output
+ * @returns Promise resolving when function is done
+ */
+export declare function downloadCSV(exportInfos: IExportInfos, formatUsingLayerPopup: boolean, removeDuplicates?: boolean, addColumnTitle?: boolean): Promise<void>;
+/**
+ * Downloads csv of mailing labels for the provided list of ids
+ *
+ * @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
+ * @param title Title for each page
+ * @param initialImageDataUrl Data URL of image for first page
+ * @returns Promise resolving when function is done
+ */
+export declare function downloadPDF(exportInfos: IExportInfos, labelPageDescription: ILabel, removeDuplicates?: boolean, title?: string, initialImageDataUrl?: string): Promise<void>;
+/**
+ * Converts a set of fieldInfos into template lines.
+ *
+ * @param fieldInfos Layer's fieldInfos structure
+ * @param bypassFieldVisiblity Indicates if the configured fieldInfo visibility property should be ignored
+ * @return Label spec with lines separated by `lineSeparatorChar`
+ */
+export declare function _convertPopupFieldsToLabelSpec(fieldInfos: __esri.FieldInfo[], bypassFieldVisiblity?: boolean): string;
+/**
+ * Converts the text of a custom popup into a multiline label specification; conversion splits text into
+ * lines on <br>s, and removes HTML tags. It does not handle Arcade and related records.
+ *
+ * @param popupInfo Layer's popupInfo structure containing description, fieldInfos, and expressionInfos, e.g.,
+ * "<div style='text-align: left;'>{NAME}<br />{STREET}<br />{CITY}, {STATE} {ZIP} <br /></div>"
+ * @return Label spec with lines separated by `lineSeparatorChar`
+ */
+export declare function _convertPopupTextToLabelSpec(popupInfo: string): string;
+/**
+ * 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 declare function _createFilename(selectionSetNames: string[]): string;
+/**
+ * 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 declare function _createRelationshipQueries(layer: __esri.FeatureLayer): ILayerRelationshipQueryHash;
+/**
+ * Extracts Arcade expression references from the lines of a label format.
+ *
+ * @param labelFormat Label to examine
+ * @return Array of Arcade expression references, e.g., ["{expression/expr1}", "{expression/expr2}"]
+ */
+export declare function _getExpressionsFromLabel(labelFormat: string): string[];
+/**
+ * Extracts field name expressions from the lines of a label format.
+ *
+ * @param labelFormat Label to examine
+ * @returns Array of field name expressions, e.g., ["{NAME}", "{STREET}", "{CITY}", "{STATE}", "{ZIP}"]
+ */
+export declare function _getFieldsFromLabel(labelFormat: string): string[];
+/**
+ * Remove any duplicate labels
+ *
+ * @param labels Labels to evaluate for duplicates
+ * @returns labels with duplicates removed
+ */
+export declare function removeDuplicateLabels(labels: string[][]): string[][];
+/**
+ * Create and consolidate labels from all layers
+ *
+ * @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 declare function consolidateLabels(exportInfos: IExportInfos, formatUsingLayerPopup?: boolean, includeHeaderNames?: boolean, isCSVExport?: boolean): Promise<string[][]>;