@esri/solutions-components 0.5.3 → 0.5.4

package/dist/solutions-components/utils/pdfUtils.js

@@ -0,0 +1,62 @@
+/** @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 Declarations
+import * as PDFCreator_jsPDF from "../assets/arcgis-pdf-creator/PDFCreator_jsPDF";
+import * as PDFLabels from "../assets/arcgis-pdf-creator/PDFLabels";
+import { getAssetPath } from "@stencil/core";
+export { ILabel } from "../assets/arcgis-pdf-creator/PDFLabels";
+//#endregion
+//#region Public functions
+/**
+ * Exports a PDF of labels.
+ *
+ * @param filename Name to use for file
+ * @param labels Labels to write
+ * @param labelPageDescription Page format to use for labels
+ * @param includeMap When true, the first page of the output is a map showing the selection area
+ * @param includeTitle When true, a title is included on every page
+ * @param title Title for each page when `includeTitle` is true
+ */
+export function exportPDF(filename, labels, labelPageDescription, includeMap = false, includeTitle = false, title = "") {
+    downloadPDFFile(filename, 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
+ */
+function downloadPDFFile(title, labels, labelPageDescription) {
+    const pdfLib = new PDFCreator_jsPDF.PDFCreator_jsPDF();
+    pdfLib.initialize({
+        pageType: "ANSI_A"
+    }, getAssetPath(`../assets/arcgis-pdf-creator/`), "en", title // filename without ".pdf"
+    )
+        .then(() => {
+        const labeller = new PDFLabels.PDFLabels();
+        labeller.initialize(pdfLib)
+            .then(async () => {
+            await labeller.addLabelsToDoc(labels, labelPageDescription.labelSpec, 1, // startingPageNum
+            title // heading
+            );
+            pdfLib.save();
+        });
+    });
+}
+//#endregion

package/dist/solutions-components/utils/publicNotificationStore.js

@@ -0,0 +1,38 @@
+/** @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 { createStore } from "@stencil/store";
+const { state, onChange } = createStore({
+    // List of layers added and managed by the component
+    managedLayers: [],
+    // Handle[]: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#Handle
+    highlightHandles: [],
+    // ILayerHash title: id lookup to be used across components
+    layerNameHash: {},
+    // remove all handles
+    removeHandles: () => {
+        state.highlightHandles.forEach(h => h === null || h === void 0 ? void 0 : h.remove());
+        state.highlightHandles = [];
+    }
+});
+const managedLayersChangedEvent = new CustomEvent("managedLayersChanged", {
+    bubbles: true,
+    cancelable: false,
+    composed: true
+});
+onChange("managedLayers", () => {
+    dispatchEvent(managedLayersChangedEvent);
+});
+export default state;

package/dist/solutions-components/utils/publicNotificationUtils.js

@@ -0,0 +1,45 @@
+/** @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 function getSelectionIds(selectionSets) {
+    return Object.keys(selectionSets).reduce((prev, cur) => {
+        return [
+            ...prev,
+            ...selectionSets[cur].download ? selectionSets[cur].selectedIds : []
+        ];
+    }, []);
+}
+export function getSelectionIdsAndViews(selectionSets) {
+    return selectionSets.reduce((prev, cur) => {
+        if (Object.keys(prev).indexOf(cur.layerView.layer.id) > -1) {
+            prev[cur.layerView.layer.id].ids = [
+                ...prev[cur.layerView.layer.id].ids,
+                ...cur.selectedIds
+            ];
+            prev[cur.layerView.layer.id].selectionSetNames.push(cur.label);
+        }
+        else {
+            prev[cur.layerView.layer.id] = {
+                ids: cur.selectedIds,
+                layerView: cur.layerView,
+                selectionSetNames: [cur.label]
+            };
+        }
+        return prev;
+    }, {});
+}
+export function getTotal(selectionSets) {
+    return [...new Set(getSelectionIds(selectionSets))].length;
+}

package/dist/solutions-components/utils/queryUtils.js

@@ -0,0 +1,148 @@
+/** @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.
+ */
+/**
+ * Query the layer for all features
+ *
+ * @param start zero-based index indicating where to begin retrieving features
+ * @param layer the layer to retrieve features from
+ * @param graphics stores the features
+ *
+ * @returns Promise with the featureSet from the layer that match the provided ids
+ */
+export async function queryAllFeatures(start, layer, graphics) {
+    const num = layer.capabilities.query.maxRecordCount;
+    const query = layer.createQuery();
+    query.start = start;
+    query.num = num;
+    // TODO think through this once I'm back on crowdsource...seems like we may want an arg to control this
+    query.where = layer.definitionExpression || "1=1";
+    const result = await layer.queryFeatures(query);
+    graphics = graphics.concat(result.features);
+    return result.exceededTransferLimit ?
+        queryAllFeatures(start += num, layer, graphics) :
+        Promise.resolve(graphics);
+}
+/**
+ * Query the layer for OIDs based on any user drawn geometries or buffers
+ *
+ * @param geometries Array of geometries used for the selection of ids from the layer
+ * @param layer the layer to retrieve ids from
+ *
+ * @returns Promise with the OIDs of features from the layer that interset the provided geometries
+ */
+export async function queryObjectIds(geometries, layer) {
+    let ids = [];
+    const queryDefs = geometries ? geometries.map(g => _intersectQuery(g, layer)) : [Promise.resolve()];
+    const results = await Promise.all(queryDefs);
+    results.forEach(resultIds => {
+        ids = [
+            ...ids,
+            ...resultIds || []
+        ];
+    });
+    return ids;
+}
+/**
+ * Query the layer for features that have the provided OIDs
+ *
+ * @param ids array of ObjectIDs to be used to query for features in a layer
+ * @param layer the layer to retrieve features from
+ *
+ * @returns Promise with the featureSet from the layer that match the provided ids
+ */
+export async function queryFeaturesByID(ids, layer) {
+    const q = layer.createQuery();
+    q.objectIds = ids;
+    return layer.queryFeatures(q);
+}
+/**
+ * Query the layer for features that intersect the provided geometry
+ *
+ * @param start zero-based index indicating where to begin retrieving features
+ * @param layer the layer to retrieve features from
+ * @param geometry the geometry to apply to the spatial filter
+ * @param featuresCollection
+ *
+ * @returns Promise with the featureSet from the layer that match the provided ids
+ */
+export async function queryFeaturesByGeometry(start, layer, geometry, featuresCollection) {
+    const num = layer.capabilities.query.maxRecordCount;
+    const query = layer.createQuery();
+    query.start = start;
+    query.num = num;
+    query.geometry = geometry;
+    const result = await layer.queryFeatures(query);
+    featuresCollection[layer.id] = featuresCollection[layer.id].concat(result.features);
+    return result.exceededTransferLimit ?
+        queryFeaturesByGeometry(start += num, layer, geometry, featuresCollection) :
+        Promise.resolve(featuresCollection);
+}
+/**
+ * Query the layer for the extent of features with the provided OIDs
+ *
+ * @param ids array of ObjectIDs to be used to query for features in a layer
+ * @param layer the layer to query
+ *
+ * @returns Promise with the Extent of all features that match the provided ids
+ */
+export async function queryExtent(ids, layer) {
+    const query = layer.createQuery();
+    query.objectIds = ids;
+    return layer.queryExtent(query);
+}
+/**
+ * Union geometries based on geometry type
+ *
+ * @param geometries Array of geometries to union
+ * @param geometryEngine the geometry engine instance to perform the unions
+ *
+ * @returns Array of single unioned geometry for each geometry type
+ */
+export function getQueryGeoms(geometries, geometryEngine) {
+    // sort and union by geom type so we have a single geom for each type to query with
+    return [
+        ..._unionGeoms(geometries, "polygon", geometryEngine),
+        ..._unionGeoms(geometries, "polyline", geometryEngine),
+        ..._unionGeoms(geometries, "point", geometryEngine)
+    ];
+}
+/**
+ * Union geometries based on geometry type
+ *
+ * @param geometries array of geometries to union
+ * @param type the current geometry type to union
+ * @param geometryEngine the geometry engine instance to perform the unions
+ *
+ * @returns Array of single unioned geometry for the provided geometry type
+ */
+function _unionGeoms(geometries, type, geometryEngine) {
+    const geoms = (geometries === null || geometries === void 0 ? void 0 : geometries.filter(g => g.type === type)) || [];
+    return geoms.length <= 1 ? geoms : [geometryEngine.union(geoms)];
+}
+/**
+ * Query the layer for ObjectIds of features that intersect the provided geometry
+ *
+ * @param geometry Geometry used for the selection of ids from the select layer view
+ * @param layer the layer to query
+ *
+ * @returns Promise that will contain the selected ids
+ */
+async function _intersectQuery(geometry, layer) {
+    const q = layer.createQuery();
+    q.spatialRelationship = "intersects";
+    q.geometry = geometry;
+    return layer.queryObjectIds(q);
+}