@esri/solutions-components 0.7.23 → 0.7.24

package/dist/types/components/crowdsource-manager/crowdsource-manager.d.ts

@@ -154,6 +154,10 @@ export declare class CrowdsourceManager {
      * All UI strings should be defined here.
      */
     _translations: typeof CrowdsourceManager_T9n;
+    /**
+     * esri/views/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+     */
+    _layer: __esri.FeatureLayer;
     /**
      * Controls the layout of the application
      */
@@ -263,6 +267,10 @@ export declare class CrowdsourceManager {
      * Listen for beforeMapChanged and minimize the popup if it's expanded
      */
     beforeMapChanged(): Promise<void>;
+    /**
+     * Get the layer for the provided layer id
+     */
+    layerSelectionChange(evt: CustomEvent): Promise<void>;
     /**
      * StencilJS: Called once just after the component is first connected to the DOM.
      *

package/dist/types/components/crowdsource-reporter/crowdsource-reporter.d.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 /// <reference types="arcgis-js-api" />
-import { ISearchConfiguration } from "../../utils/interfaces";
+import { VNode } from "../../stencil-public-runtime";
+import { IMapChange, IMapInfo, ISearchConfiguration, theme } from "../../utils/interfaces";
+import CrowdsourceReporter_T9n from "../../assets/t9n/crowdsource-reporter/resources.json";
 export declare class CrowdsourceReporter {
     el: HTMLCrowdsourceReporterElement;
     /**
@@ -49,10 +51,6 @@ export declare class CrowdsourceReporter {
      * string: The text that will display at the top of the landing page
      */
     loginTitle: string;
-    /**
-     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
-     */
-    mapView: __esri.MapView;
     /**
      * string: The word(s) to display in the reports submit button
      */
@@ -73,25 +71,175 @@ export declare class CrowdsourceReporter {
      * boolean: When true the comments from all users will be visible
      */
     showComments: boolean;
+    /**
+     * string: Item ID of the web map that should be selected by default
+     */
+    defaultWebmap: string;
+    /**
+     * boolean: when true the search widget will be available
+     */
+    enableSearch: boolean;
+    /**
+     * boolean: when true the home widget will be available
+     */
+    enableHome: boolean;
+    /**
+     * IMapInfo[]: array of map infos (name and id)
+     */
+    mapInfos: IMapInfo[];
+    /**
+     * theme: "light" | "dark" theme to be used
+     */
+    theme: theme;
+    /**
+     * boolean: when true the zoom widget will be available
+     */
+    enableZoom: boolean;
+    /**
+     * IMapInfo: The current map info stores configuration details
+     */
+    _mapInfo: IMapInfo;
+    /**
+     * __esri.MapView: Stores the current map view
+     */
+    _mapView: __esri.MapView;
+    /**
+     * boolean: When true the application will be in mobile mode, controls the mobile or desktop view
+     */
+    _isMobile: boolean;
+    /**
+     * string[]: Reporter flow items list
+     */
+    _flowItems: string[];
+    /**
+     * boolean: Controls the state for panel in mobile view
+     */
+    _sidePanelCollapsed: boolean;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations: typeof CrowdsourceReporter_T9n;
+    /**
+     * boolean: When true show the sort and filter icon
+     */
+    _hasValidLayers: boolean;
+    /**
+     * IMapChange: The current map change details
+     */
+    protected _mapChange: IMapChange;
+    /**
+     * number[]: X,Y pair used to center the map
+     */
+    protected _defaultCenter: number[];
+    /**
+     * number: zoom level the map should go to
+     */
+    protected _defaultLevel: number;
+    /**
+     * string: The selected feature layer's id from the layer's list
+     */
+    protected _selectedLayerId: string;
+    /**
+     * string: The selected feature layer's name from the layer's list
+     */
+    protected _selectedLayerName: string;
+    /**
+     * __esri.Graphic: The selected feature
+     */
+    protected _selectedFeature: __esri.Graphic[];
+    /**
+     * Listen for mapChanged event to be fired then store the new mapView so components will be updated
+     */
+    mapChanged(evt: CustomEvent): Promise<void>;
     /**
      * StencilJS: Called once just after the component is first connected to the DOM.
-     *
+     * Create component translations and monitor the mediaQuery change to detect mobile/desktop mode
      * @returns Promise when complete
      */
+    componentWillLoad(): Promise<void>;
     /**
      * Renders the component.
      */
     render(): any;
     /**
-     * Load esri javascript api modules
-     *
-     * @returns Promise resolving when function is done
-     *
+     * Get the reporter app functionality
+     * @protected
+     */
+    protected _getReporter(): VNode;
+    /**
+     * Get the feature layer list
+     * @returns the layer list items
+     * @protected
+     */
+    protected getLayerListFlowItem(): Node;
+    /**
+     * When layer list is loaded, we will receive the list of layers, if its  means we don't have any valid layer to be listed
+     * @param evt Event which has list of layers
+     * @protected
+     */
+    protected layerListLoaded(evt: CustomEvent): void;
+    /**On click of layer list item show feature list
+     * @param evt Event which has details of selected layerId and layerName
+     * @protected
+     */
+    protected displayFeaturesList(evt: CustomEvent): void;
+    /**
+     * On back from feature list navigate to the Layer list panel
+     * @protected
+     */
+    protected backFromFeatureList(): void;
+    /**
+     * Toggle side panel in case of mobile mode
+     * @protected
+     */
+    protected toggleSidePanel(): void;
+    /**
+     * When feature is selected from list store that and show feature details
+     * @param evt Event which has details of selected feature
+     */
+    protected onFeatureSelectFromList(evt: CustomEvent): Promise<void>;
+    /**
+     * Get feature list of the selected feature layer
+     * @param layerId Layer id
+     * @returns feature list node
+     * @protected
+     */
+    protected getFeatureListFlowItem(layerId: string, layerName: string): Node;
+    /**
+     * Returns the calcite-flow item for feature details
+     * @returns Node
+     */
+    protected getFeatureDetailsFlowItem(): Node;
+    /**
+     * Returns the action button to Expand/Collapse side panel in mobile mode
+     */
+    protected getActionToExpandCollapsePanel(): Node;
+    /**
+     * Get the map node based for the current layout options
+     * @returns the map node
+     * @protected
+     */
+    protected _getMapNode(): VNode;
+    /**
+     * Get the current map info (configuration details) when maps change
+     * @param id Id of the map to be returned
+     * @returns IMapInfo for the provided id
+     * @protected
+     */
+    protected getMapInfo(id: string): IMapInfo;
+    /**
+     * Set the current map info when maps change
+     * @protected
+     */
+    protected setMapView(): Promise<void>;
+    /**
+     * Add/remove zoom tools based on enableZoom prop
      * @protected
      */
+    protected initMapZoom(): void;
     /**
      * Fetches the component's translations
-     *
      * @returns Promise when complete
      * @protected
      */

package/dist/types/components/delete-button/delete-button.d.ts

@@ -0,0 +1,120 @@
+/** @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 { EventEmitter, VNode } from '../../stencil-public-runtime';
+import DeleteButton_T9n from "../../assets/t9n/delete-button/resources.json";
+import { ButtonType, EditType } from "../../utils/interfaces";
+export declare class DeleteButton {
+    el: HTMLBufferToolsElement;
+    /**
+     * ButtonType (button | action): Support usage as action or button
+     */
+    buttonType: ButtonType;
+    /**
+     * boolean: This overrides internal enable/disable logic that is based on checks if the layer supports delete
+     */
+    disabled: boolean;
+    /**
+     * string: The icon to display in the component
+     */
+    icon: string;
+    /**
+     * number[]: The ids that would be deleted
+     */
+    ids: any[];
+    /**
+     * esri/views/layers/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+     */
+    layer: __esri.FeatureLayer;
+    /**
+     * boolean: When true the user will be asked to confirm the delete operation
+     */
+    _confirmDelete: boolean;
+    /**
+     * boolean: When true the user can delete the current features
+     */
+    _deleteEndabled: boolean;
+    /**
+     * boolean: When true a loading indicator will be shown in the delete button
+     */
+    _isDeleting: boolean;
+    /**
+     * boolean: When true the layer supports delete and a button will be returned
+     */
+    _supportsDelete: boolean;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations: typeof DeleteButton_T9n;
+    /**
+     * watch for changes in layer view and verify if it has editing enabled
+     */
+    idsWatchHandler(): Promise<void>;
+    /**
+     * watch for changes in layer view and verify if it has editing enabled
+     */
+    layerWatchHandler(): Promise<void>;
+    /**
+     * Emitted on demand when features have been deleted
+     */
+    editsComplete: EventEmitter<EditType>;
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     *
+     * @returns Promise when complete
+     */
+    componentWillLoad(): Promise<void>;
+    /**
+     * Renders the component.
+     */
+    render(): any;
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     */
+    componentDidLoad(): Promise<void>;
+    /**
+     * Verify if the layer supports delete and that we have 1 or more ids
+     */
+    protected _setDeleteEnabled(): void;
+    /**
+     * Delete all selected records or shows an alert if the layer does not have editing enabled
+     *
+     * @returns a promise that will resolve when the operation is complete
+     */
+    protected _delete(): void;
+    /**
+     * Show delete confirmation message
+     *
+     * @returns node to confirm or deny the delete operation
+     */
+    protected _deleteMessage(): VNode;
+    /**
+     * Delete the currently selected features
+     */
+    protected _deleteFeatures(): Promise<void>;
+    /**
+     * Set the alertOpen member to false when the alert is closed
+     */
+    protected _deleteClosed(): void;
+    /**
+     * Fetches the component's translations
+     *
+     * @returns Promise when complete
+     * @protected
+     */
+    protected _getTranslations(): Promise<void>;
+}

package/dist/types/components/feature-list/feature-list.d.ts

@@ -0,0 +1,128 @@
+/** @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 { VNode, EventEmitter } from "../../stencil-public-runtime";
+import { IPopupUtils } from "../../utils/interfaces";
+import FeatureList_T9n from "../../assets/t9n/feature-list/resources.json";
+export declare class FeatureList {
+    el: HTMLFeatureListElement;
+    /**
+     * string: Layer id of the feature layer to show the list
+     */
+    selectedLayerId: string;
+    /**
+     * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView: __esri.MapView;
+    /**
+     * string: Message to be displayed when features are not found
+     */
+    noFeaturesFoundMsg?: string;
+    /**
+     * number: Number features to be fetched per page, by default 100 features will be fetched
+     */
+    pageSize?: number;
+    /**
+     * boolean: Highlight feature on map optional (default false) boolean to indicate if we should highlight and zoom to the extent of the feature geometry
+     */
+    highlightOnMap?: boolean;
+    /**
+     * calcite-list-item list of features with popup titles
+     */
+    _featureItems: any[];
+    /**
+     * number: Total number of feature count
+     */
+    _featuresCount: number;
+    /**
+     * boolean: Check if selected layer's features fetching process is completed
+     */
+    _isLoading: boolean;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations: typeof FeatureList_T9n;
+    /**
+     * IPopupUtils: To fetch the list label using popup titles
+     */
+    protected _popupUtils: IPopupUtils;
+    /**
+     * __esri.FeatureLayer: Selected feature layer from the layer list
+     */
+    protected _selectedLayer: __esri.FeatureLayer;
+    /**
+     * __esri.Handle: Highlight handle of the selections
+     */
+    protected _highlightHandle: __esri.Handle;
+    /**
+     * Emitted on demand when feature is selected using the list
+     */
+    featureSelect: EventEmitter<__esri.Graphic>;
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     * @returns Promise when complete
+     */
+    componentWillLoad(): Promise<void>;
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     */
+    componentDidLoad(): Promise<void>;
+    /**
+     * Renders the component.
+     */
+    render(): any;
+    /**
+     * On page change get the next updated feature list
+     * @param event page change event
+     * @protected
+     */
+    protected pageChanged(event: any): Promise<void>;
+    /**
+     * On feature click in feature list highlight the feature on the map
+     * @param event feature clicked event
+     * @protected
+     */
+    protected featureClicked(event: any, selectedFeature: __esri.Graphic): Promise<void>;
+    /**
+     * Query the selected feature layer, in descending order of object id's
+     * @param page 0th page number in the pagination item
+     * @returns List of features items to be rendered
+     * @protected
+     */
+    protected queryPage(page: number): Promise<VNode[]>;
+    /**
+     * Creates list of items using the popup titles
+     * @param featureSet Queried FeatureSet
+     * @returns List of features items to be rendered
+     * @protected
+     */
+    protected createFeatureItem(featureSet: any): Promise<VNode[]>;
+    /**
+     * Get each feature item
+     * @param selectedFeature Each individual feature instance to be listed
+     * @param popupTitle feature popup title
+     * @returns individual feature item to be rendered
+     * @protected
+     */
+    protected getFeatureItem(selectedFeature: __esri.Graphic, popupTitle: string): VNode;
+    /**
+     * Fetches the component's translations
+     * @returns Promise when complete
+     * @protected
+     */
+    protected _getTranslations(): Promise<void>;
+}

package/dist/types/components/info-card/info-card.d.ts

@@ -39,6 +39,10 @@ export declare class InfoCard {
      * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
      */
     zoomAndScrollToSelected: boolean;
+    /**
+     * boolean: If true will show edit button
+     */
+    allowEditing?: boolean;
     /**
      * boolean: When true a alert will be shown to indicate a problem or confirm the current action
      */
@@ -80,6 +84,10 @@ export declare class InfoCard {
      * used for widget instance
      */
     protected _features: __esri.Features;
+    /**
+     * esri/widgets/FeatureLayer: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html
+     */
+    protected _layer: __esri.FeatureLayer;
     /**
      * IPopupUtils: When false alerts will be shown to indicate that the layer must have editing enabled for edit actions
      */
@@ -136,6 +144,11 @@ export declare class InfoCard {
      * @returns Promise when complete
      */
     componentWillLoad(): Promise<void>;
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     * @returns Promise when complete
+     */
+    componentDidLoad(): Promise<void>;
     /**
      * Renders the component.
      */
@@ -148,6 +161,12 @@ export declare class InfoCard {
      * @protected
      */
     protected _initModules(): Promise<void>;
+    /**
+     * Initializes the features widget if not created and updates the feature widget and other required states
+     *
+     * @protected
+     */
+    protected setGraphics(): Promise<void>;
     /**
      * Init the Feature widget so we can display the popup content
      *

package/dist/types/components/layer-list/layer-list.d.ts

@@ -0,0 +1,133 @@
+/** @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 { VNode, EventEmitter } from "../../stencil-public-runtime";
+import LayerList_T9n from "../../assets/t9n/layer-list/resources.json";
+interface ILayerItemsHash {
+    [key: string]: ILayerDetailsHash;
+}
+interface ILayerDetailsHash {
+    name: string;
+    formattedFeatureCount: string;
+    supportsUpdate: boolean;
+}
+export declare class LayerList {
+    el: HTMLLayerListElement;
+    /**
+     * esri/views/View: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView: __esri.MapView;
+    /**
+     * string[]: If passed will show only these layers in the list if they are present in map and are editable
+     */
+    layers: string[];
+    /**
+     * string: Error message to be displayed when no layers found
+     */
+    noLayerErrorMsg?: string;
+    /**
+     * boolean: When true will display message no layers found
+     */
+    _noLayersToDisplay: boolean;
+    /**
+     * string[]: list of layer ids from the map which will be listed
+     */
+    _mapLayerIds: string[];
+    /**
+     * boolean: When true display the loading indicator
+     */
+    _isLoading: boolean;
+    /**
+     * Contains the translations for this component.
+     */
+    _translations: typeof LayerList_T9n;
+    /**
+     * ILayerItemHash: id/name lookup
+     */
+    protected _layerItemsHash: ILayerItemsHash;
+    /**
+     * Emitted on demand when feature layer clicked with details layerId and layerName
+     */
+    layerSelect: EventEmitter<{
+        layerId: string;
+        layerName: string;
+    }>;
+    /**
+     * Emitted on demand when list of layers to be listed are created.
+     * When empty array received in this event means no valid layers are found to be listed
+     */
+    layersListLoaded: EventEmitter<string[]>;
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     * @returns Promise when complete
+     */
+    componentWillLoad(): Promise<void>;
+    /**
+     * StencilJS: Called once just after the component is fully loaded and the first render() occurs.
+     */
+    componentDidLoad(): Promise<void>;
+    /**
+     * Renders the component.
+     */
+    render(): any;
+    /**
+     * Fetch the ids of the layers from the map
+     * @returns Promise when the operation has completed
+     * @protected
+     */
+    setLayers(): Promise<void>;
+    /**
+     * Create a layer hash for layer name display
+     * @returns Promise when the operation has completed
+     * @protected
+     */
+    protected initLayerHash(): Promise<void>;
+    /**
+     * Set no layers to display state and emit event
+     */
+    protected handleNoLayersToDisplay(): void;
+    /**
+     * Returns the ids of all OR configured layers that support edits with the update capability
+     * @param hash each layer item details
+     * @returns array of layer ids
+     */
+    protected getEditableIds(hash: ILayerItemsHash): string[];
+    /**
+     * Render feature layer list
+     * @returns layer list
+     * @protected
+     */
+    protected renderLayerList(): Node[];
+    /**
+     * Get each item
+     * @param layerId Layer id
+     * @returns individual item
+     * @protected
+     */
+    protected getLayerListItem(layerId: string): VNode;
+    /**On click of layer list item show feature list
+     * @param layerId Layer id
+     * @protected
+     */
+    protected showFeaturesList(layerId: string): void;
+    /**
+     * Fetches the component's translations
+     * @returns Promise when complete
+     * @protected
+     */
+    protected _getTranslations(): Promise<void>;
+}
+export {};