@esri/solutions-components 0.8.14 → 0.8.16

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

@@ -15,19 +15,29 @@
  */
 /// <reference types="arcgis-js-api" />
 import { VNode, EventEmitter } from "../../stencil-public-runtime";
-import { ILayerExpression, IMapChange, IMapClick, IMapInfo, IReportingOptions, ISearchConfiguration, theme } from "../../utils/interfaces";
+import { ILayerExpression, IMapChange, IMapClick, IMapInfo, IReportingOptions, ISearchConfiguration, ISortingInfo, theme } from "../../utils/interfaces";
 import CrowdsourceReporter_T9n from "../../assets/t9n/crowdsource-reporter/resources.json";
 import { ILayerItemsHash } from "../layer-list/layer-list";
 export declare class CrowdsourceReporter {
     el: HTMLCrowdsourceReporterElement;
     /**
-     * string: The text that will display under the title on the landing page
+     * string: Semicolon delimited numbers that will be used as the maps center point from URL params
      */
-    description: string;
+    center: string;
     /**
-     * boolean: When true the application will be in mobile mode, controls the mobile or desktop view
+     * boolean: When true a cover page has been enabled in the consuming application.
+     * Also when true a floating button will be shown in the lower right of the window that
+     * will emit an event when clicked that the consuming application can respond to that will open the cover page.
      */
-    isMobile: boolean;
+    coverPageEnabled: boolean;
+    /**
+     * string: Item ID of the web map that should be selected by default
+     */
+    defaultWebmap: string;
+    /**
+     * string: The text that will display under the title on the landing page
+     */
+    description: string;
     /**
      * boolean: When true the anonymous users will be allowed to submit reports and comments
      */
@@ -40,6 +50,10 @@ export declare class CrowdsourceReporter {
      * boolean: When true the user will be allowed to submit comments
      */
     enableComments: boolean;
+    /**
+     * boolean: when true the home widget will be available
+     */
+    enableHome: boolean;
     /**
      * boolean: When true the user will be provided a login page
      */
@@ -49,41 +63,57 @@ export declare class CrowdsourceReporter {
      */
     enableNewReports: boolean;
     /**
-     * string: The text that will display at the top of the landing page
+     * boolean: when true the search widget will be available
      */
-    loginTitle: string;
+    enableSearch: boolean;
     /**
-     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     * boolean: when true the zoom widget will be available
      */
-    mapView: __esri.MapView;
+    enableZoom: boolean;
     /**
-     * string: Layer id of the feature from URL params
+     * boolean: When true the application will be in mobile mode, controls the mobile or desktop view
      */
-    layerId: string;
+    isMobile: boolean;
     /**
-     * string: Object id of the feature from URL params
+     * ILayerExpression[]: Array of layer expressions for layers (filter configuration)
      */
-    objectId: string;
+    layerExpressions: ILayerExpression[];
     /**
-     * string: Semicolon delimited numbers that will be used as the maps center point from URL params
+     * string: Layer id of the feature from URL params
      */
-    center: string;
+    layerId: string;
     /**
      * string: Id of the zoom level from URL params
      */
     level: string;
     /**
-     * string: The word(s) to display in the reports submit button
+     * string: The text that will display at the top of the landing page
      */
-    reportButtonText: string;
+    loginTitle: string;
     /**
-     * string: The word(s) to display in the reports header
+     * IMapInfo[]: array of map infos (name and id)
      */
-    reportsHeader: string;
+    mapInfos: IMapInfo[];
+    /**
+     * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+     */
+    mapView: __esri.MapView;
+    /**
+     * string: Object id of the feature from URL params
+     */
+    objectId: string;
+    /**
+     * string: The word(s) to display in the reports submit button
+     */
+    reportButtonText: string;
     /**
      * IReportingOptions: Key options for reporting
      */
     reportingOptions: IReportingOptions;
+    /**
+     * string: The word(s) to display in the reports header
+     */
+    reportsHeader: string;
     /**
      * string: The message to display when the report has been submitted
      */
@@ -97,45 +127,57 @@ export declare class CrowdsourceReporter {
      */
     showComments: boolean;
     /**
-     * string: Item ID of the web map that should be selected by default
+     * theme: "light" | "dark" theme to be used
      */
-    defaultWebmap: string;
+    theme: theme;
     /**
-     * boolean: when true the search widget will be available
+     * number: default scale to zoom to when zooming to a single point feature
      */
-    enableSearch: boolean;
+    zoomToScale: number;
     /**
-     * boolean: when true the home widget will be available
+     * string: Error message when feature creation fails
      */
-    enableHome: boolean;
+    _featureCreationFailedErrorMsg: string;
     /**
-     * IMapInfo[]: array of map infos (name and id)
+     * boolean: When true an indicator will be shown on the action
      */
-    mapInfos: IMapInfo[];
+    _filterActive: boolean;
     /**
-     * theme: "light" | "dark" theme to be used
+     * boolean: When true the filter component will be displayed
      */
-    theme: theme;
+    _filterOpen: boolean;
     /**
-     * boolean: when true the zoom widget will be available
+     * string[]: Reporter flow items list
      */
-    enableZoom: boolean;
+    _flowItems: string[];
     /**
-     * number: default scale to zoom to when zooming to a single point feature
+     * boolean: When true show the sort and filter icon
      */
-    zoomToScale: number;
+    _hasValidLayers: boolean;
     /**
-     * ILayerExpression[]: Array of layer expressions for layers (filter configuration)
+     * boolean: show loading indicator for feature details component upto completing pending operations
      */
-    layerExpressions: ILayerExpression[];
+    _loadingFeatureDetails: boolean;
     /**
      * IMapInfo: The current map info stores configuration details
      */
     _mapInfo: IMapInfo;
     /**
-     * string[]: Reporter flow items list
+     * boolean: When true show the success message in the panel
      */
-    _flowItems: string[];
+    _reportSubmitted: boolean;
+    /**
+    * string: The selected feature layer's name from the layer's list
+    */
+    _selectedLayerName: string;
+    /**
+     * boolean: When true show the submit and cancel button
+     */
+    _showSubmitCancelButton: boolean;
+    /**
+     * boolean: show loading indicator in the reporter component
+     */
+    _showLoadingIndicator: boolean;
     /**
      * boolean: Controls the state for panel in mobile view
      */
@@ -146,122 +188,125 @@ export declare class CrowdsourceReporter {
      */
     _translations: typeof CrowdsourceReporter_T9n;
     /**
-     * boolean: When true show the sort and filter icon
+     * number: Show the updated progress bar status
      */
-    _hasValidLayers: boolean;
+    _updatedProgressBarStatus: number;
     /**
-    * string: The selected feature layer's name from the layer's list
-    */
-    _selectedLayerName: string;
+     * ISortingInfo: Sort the feature list depending on the sort field and order
+     */
+    _updatedSorting: ISortingInfo;
+    /**
+     * string: Selected sort option
+     */
+    _updatedSortOption: string;
     /**
      * boolean: When true show the success message in the panel
      */
-    _reportSubmitted: boolean;
+    _commentSubmitted: boolean;
     /**
-     * boolean: When true show the submit and cancel button
+     * string: Error message when feature creation fails
      */
-    _showSubmitCancelButton: boolean;
+    _addingCommentFailed: boolean;
     /**
-     * boolean: show loading indicator for feature details component upto completing pending operations
+     * HTMLCreateFeatureElement: Create Feature component instance
      */
-    _loadingFeatureDetails: boolean;
+    protected _createFeature: HTMLCreateFeatureElement;
     /**
-     * string: Error message when feature creation fails
+     * ObjectId of the feature currently shown in the details
      */
-    _featureCreationFailedErrorMsg: string;
+    protected _currentFeatureId: string;
     /**
-     * number: Show the updated progress bar status
+     * number[]: X,Y pair used to center the map
      */
-    _updatedProgressBarStatus: number;
+    protected _defaultCenter: number[];
     /**
-     * boolean: When true the filter component will be displayed
+     * number: zoom level the map should go to
      */
-    _filterOpen: boolean;
+    protected _defaultLevel: number;
     /**
-     * boolean: When true an indicator will be shown on the action
+     * string[]: Configured/all layers id from current map which can be used for reporting
      */
-    _filterActive: boolean;
+    protected _editableLayerIds: string[];
     /**
-     * IMapChange: The current map change details
+     * HTMLCreateFeatureElement: features details component instance
      */
-    protected _mapChange: IMapChange;
+    protected _featureDetails: HTMLFeatureDetailsElement;
     /**
-     * number[]: X,Y pair used to center the map
+     * HTMLFeatureListElement: Create feature list component instance
      */
-    protected _defaultCenter: number[];
+    protected _featureList: HTMLFeatureListElement;
     /**
-     * number: zoom level the map should go to
+     * __esri.Graphic: The current selected feature
      */
-    protected _defaultLevel: number;
+    protected _currentFeature: __esri.Graphic;
     /**
-     * string[]: list of configured reporting layer ids
+     * __esri.Graphic: The selected related feature from layer table
      */
-    protected layers: string[];
+    protected _selectedRelatedFeature: __esri.Graphic[];
     /**
-     * __esri.FeatureLayer[]: Valid layers from the current map
+     * __esri.FeatureLayer: The related table from map
      */
-    protected _validLayers: __esri.FeatureLayer[];
+    protected _relatedTable: __esri.FeatureLayer;
     /**
-     * string[]: Configured/all layers id from current map which can be used for reporting
+     * HTMLInstantAppsFilterListElement: Component from Instant Apps that supports interacting with the current filter config
      */
-    protected _editableLayerIds: string[];
+    protected _filterList: HTMLInstantAppsFilterListElement;
     /**
-     * string: The selected feature layer's id from the layer's list
+     * __esri.Handle: Highlight handles of the selections
      */
-    protected _selectedLayerId: string;
+    protected _highlightHandle: __esri.Handle;
     /**
-     * __esri.Graphic: The selected feature
+     * HTMLLayerListElement: Create Layer list component instance
      */
-    protected _selectedFeature: __esri.Graphic[];
+    protected _layerList: HTMLLayerListElement;
     /**
-     * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
+     * HTMLCreateFeatureElement: Create Feature component instance
      */
-    protected reactiveUtils: typeof import("esri/core/reactiveUtils");
+    protected _createRelatedFeature: HTMLCreateRelatedFeatureElement;
+    /**
+     * string[]: list of configured reporting layer ids
+     */
+    protected _layers: string[];
+    /**
+     * IMapChange: The current map change details
+     */
+    protected _mapChange: IMapChange;
     /**
      * IHandle: The map click handle
      */
     protected _mapClickHandle: IHandle;
     /**
-     * HTMLCreateFeatureElement: Create Feature component instance
+     * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
      */
-    protected _createFeature: HTMLCreateFeatureElement;
+    protected reactiveUtils: typeof import("esri/core/reactiveUtils");
     /**
-     * HTMLCreateFeatureElement: features details component instance
+     * __esri.Graphic: The selected feature
      */
-    protected _featureDetails: HTMLFeatureDetailsElement;
+    protected _selectedFeature: __esri.Graphic[];
     /**
-     * HTMLLayerListElement: Create Layer list component instance
+     * number: selected feature index
      */
-    protected _layerList: HTMLLayerListElement;
+    protected _selectedFeatureIndex: number;
     /**
-     * HTMLFeatureListElement: Create feature list component instance
+     * string: The selected feature layer's id from the layer's list
      */
-    protected _featureList: HTMLFeatureListElement;
+    protected _selectedLayerId: string;
     /**
      * HTMLInstantAppsSocialShareElement: Share element
      */
     protected _shareNode: HTMLInstantAppsSocialShareElement;
-    /**
-     * ObjectId of the feature currently shown in the details
-     */
-    protected _currentFeatureId: string;
     /**
      * boolean: Maintains a flag to know if urls params are loaded or not
      */
     protected _urlParamsLoaded: boolean;
     /**
-     * __esri.Handle: Highlight handles of the selections
-     */
-    protected _highlightHandle: __esri.Handle;
-    protected _noLayerToDisplayErrorMsg: string;
-    /**
-     * HTMLInstantAppsFilterListElement: Component from Instant Apps that supports interacting with the current filter config
+     * __esri.FeatureLayer[]: Valid layers from the current map
      */
-    protected _filterList: HTMLInstantAppsFilterListElement;
+    protected _validLayers: __esri.FeatureLayer[];
     /**
-     * number: selected feature index
+     * __esri.FeatureLayer: Selected feature layer from the layer list
      */
-    protected selectedFeatureIndex: number;
+    protected _selectedLayer: __esri.FeatureLayer;
     /**
      * Called each time the mapView prop is changed.
      */
@@ -302,7 +347,7 @@ export declare class CrowdsourceReporter {
      * @param layerId string layerId of the selected layer
      * @param layerName string layerName of the selected layer
      */
-    protected setSelectedLayer(layerId: string, layerName: string): void;
+    protected setSelectedLayer(layerId: string, layerName: string): Promise<void>;
     /**
      * Get the reporter app functionality
      * @protected
@@ -323,13 +368,24 @@ export declare class CrowdsourceReporter {
      * @protected
      */
     protected _toggleFilter(): void;
+    /**
+     * On sort option click update the sort field and sort order
+     * @param sortField sort field
+     * @param sortOrder sort order
+     */
+    protected sortOptionClick(sortField: string, sortOrder: "asc" | "desc", sortOption: string): Promise<void>;
+    /**
+     * On sort button click, display the sorting options
+     * @returns Sort options list
+     */
+    protected _toggleSort(): Node;
     /**
      * Reset the filter active prop
      * @protected
      */
     protected _handleFilterListReset(): void;
     /**
-     * Check if the layers definitionExpression has been modified
+     * Check if the layers definitionExpression has been modified and update the feature list depending on the applied filters
      * @protected
      */
     protected _handleFilterUpdate(): void;
@@ -371,12 +427,22 @@ export declare class CrowdsourceReporter {
      * On back from create feature, call submit editor to destroy the Editor widget instance
      * @protected
      */
-    protected onSubmitButtonClick(): void;
+    protected onCreateFeatureSubmitButtonClick(): void;
     /**
      * On back from create feature, call close editor to destroy the Editor widget instance
      * @protected
      */
     protected backFromCreateFeaturePanel(): void;
+    /**
+     * On back from create realated feature, call submit editor to destroy the Editor widget instance
+     * @protected
+     */
+    protected onCreateRelatedFeatureSubmitButtonClick(): void;
+    /**
+     * On back from create related feature, call close editor to destroy the Editor widget instance
+     * @protected
+     */
+    protected backFromCreateRelatedFeaturePanel(): void;
     /**
      * On creating the feature is failed, show the error message
      * @param evt Event which has feature failed message
@@ -388,6 +454,17 @@ export declare class CrowdsourceReporter {
      * @protected
      */
     protected onReportSubmitted(): void;
+    /**
+     * On adding the is failed, show the error message
+     * @param evt Event which has comment failed message
+     * @protected
+     */
+    protected addCommentFailed(evt: CustomEvent): void;
+    /**
+     * On submit comment navigate to the feature list and refresh the feature details
+     * @protected
+     */
+    protected onCommentSubmitted(): Promise<void>;
     /**
      * Navigates to layer-list
      * @protected
@@ -430,11 +507,22 @@ export declare class CrowdsourceReporter {
      * @param evt Event which has details of selected feature
      */
     protected onFeatureSelectFromList(evt: CustomEvent): Promise<void>;
+    /**
+     * Gets related table id of the selected feature's layer
+     * @protected
+     */
+    protected getRelatedTable(): Promise<void>;
     /**
      * Show loading indicator while updating the feature details component
      * @param isLoading is feature detail component loading
      */
     protected updatingFeatureDetails(isLoading: boolean): Promise<void>;
+    /**
+     * When comment is selected from list store that and show comment details
+     * @param evt Event which has details of selected feature
+     * @protected
+     */
+    protected onCommentSelectFromList(evt: CustomEvent): Promise<void>;
     /**
      * Get feature list of the selected feature layer
      * @param layerId Layer id
@@ -454,16 +542,26 @@ export declare class CrowdsourceReporter {
      * @returns Node
      */
     protected getFeaturesPagination(): Node;
+    /**
+     * Returns the calcite-flow item for comment details
+     * @returns Node
+     */
+    protected getCommentDetailsFlowItem(): Node;
+    /**
+     * Returns the calcite-flow item for add comment
+     * @returns Node
+     */
+    protected getAddCommentFlowItem(): Node;
     /**
      * Sets the selected features and updates the first feature as the current selected feature
      * @param features Graphics array of the features selected
      */
-    protected setSelectedFeatures(features: __esri.Graphic[]): void;
+    protected setSelectedFeatures(features: __esri.Graphic[]): Promise<void>;
     /**
      * Set the object id of the current selected feature, and also updates the current selected layer details
      * @param selectedFeature Graphic currently shown in feature details
      */
-    protected setCurrentFeature(selectedFeature?: __esri.Graphic): void;
+    protected setCurrentFeature(selectedFeature?: __esri.Graphic): Promise<void>;
     /**
      * Highlights the feature on map
      * @param selectedFeature Graphic currently shown in feature details

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

@@ -31,6 +31,10 @@ export declare class FeatureDetails {
      * boolean: When true configured dislike field is available in selected layer
      */
     _dislikeFieldAvailable: boolean;
+    /**
+     * boolean: When true comments are configured and its table is available in selected layer
+     */
+    _commentsAvailable: boolean;
     /**
      * boolean: When true button will get brand color
      */
@@ -39,10 +43,18 @@ export declare class FeatureDetails {
      * boolean: When true button will get brand color
      */
     _isDislikeBtnClicked: boolean;
+    /**
+     * string[]: objects ids of the related features (comments)
+     */
+    _relatedFeaturesOIDs: string[];
     /**
      * HTMLCreateFeatureElement: info card component instance
      */
     protected _infoCard: HTMLInfoCardElement;
+    /**
+     * HTMLFeatureListElement: Feature list component's instance to show the comments
+     */
+    protected _commentsList: HTMLFeatureListElement;
     /**
      * __esri.Graphic: The current selected feature graphic
      */
@@ -59,10 +71,19 @@ export declare class FeatureDetails {
      * esri/Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
      */
     protected Graphic: typeof import("esri/Graphic");
+    /**
+     * https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html
+     * used for module import
+     */
+    protected RelationshipQuery: typeof import("esri/rest/support/RelationshipQuery");
     /**
      * string[]: Valid field types for like and dislike
      */
     protected _validFieldTypes: string[];
+    /**
+     *string: related table id of selected feature
+     */
+    protected relatedTableId: string;
     /**
      * Called each time the graphics prop is changed
      */
@@ -88,6 +109,10 @@ export declare class FeatureDetails {
      * Emitted on demand when like or dislike button is clicked
      */
     loadingStatus: EventEmitter<boolean>;
+    /**
+     * 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.
      *
@@ -109,6 +134,12 @@ export declare class FeatureDetails {
      * @protected
      */
     protected getCompleteGraphic(graphic: __esri.Graphic): Promise<void>;
+    /**
+     * Process the comments functionality.
+     * If comments are configured, fetches the related comments ans creates the input for comments list
+     * @protected
+     */
+    protected processComments(): Promise<void>;
     /**
      * Checks if the layers is configured for like dislike or not
      * @param selectedLayer Feature layer

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

@@ -15,7 +15,7 @@
  */
 /// <reference types="arcgis-js-api" />
 import { VNode, EventEmitter } from "../../stencil-public-runtime";
-import { IPopupUtils } from "../../utils/interfaces";
+import { IPopupUtils, ISortingInfo } from "../../utils/interfaces";
 import FeatureList_T9n from "../../assets/t9n/feature-list/resources.json";
 export declare class FeatureList {
     el: HTMLFeatureListElement;
@@ -43,6 +43,22 @@ export declare class FeatureList {
      * boolean: Highlight feature on map optional (default false) boolean to indicate if we should highlight when hover on Feature in list
      */
     highlightOnHover?: boolean;
+    /**
+     * ISortingInfo: Sorting field and order using which features list will be sorted
+     */
+    sortingInfo?: ISortingInfo;
+    /**
+     * string: where clause to filter the features list
+     */
+    whereClause?: string;
+    /**
+     * string(small/large): Controls the font size of the title
+     */
+    textSize?: "small" | "large";
+    /**
+     * boolean: Show initial loading indicator when creating list
+     */
+    showInitialLoading?: boolean;
     /**
      * calcite-list-item list of features with popup titles
      */
@@ -81,6 +97,14 @@ export declare class FeatureList {
      * Watch for selectedLayerId change and update layer instance and features list for new layerId
      */
     selectedLayerWatchHandler(): Promise<void>;
+    /**
+     * Watch for sorting field or order change and update the features list
+     */
+    sortingInfoWatchHandler(): Promise<void>;
+    /**
+     * Watch for whereclause change and update the features list
+     */
+    whereClauseHandler(): Promise<void>;
     /**
      * Refresh the feature list which will fetch the latest features and update the features list
      * @returns Promise that resolves when the operation is complete
@@ -109,6 +133,11 @@ export declare class FeatureList {
    * @protected
    */
     protected initModules(): Promise<void>;
+    /**
+     * Return the where condition string considering the defined where clause and layer's definition expression
+     * @protected
+     */
+    protected getWhereCondition(): string;
     /**
      * Initialize the features list using the selected layer
      * @protected
@@ -135,7 +164,7 @@ export declare class FeatureList {
     protected emitSelectedFeature(graphic: __esri.Graphic): Promise<void>;
     /**
      * On feature hover in feature list highlight the feature on the map
-     * @param selectedFeature mouseovered feature graphic
+     * @param selectedFeature mouse hovered feature graphic
      * @protected
      */
     protected onFeatureHover(selectedFeature: __esri.Graphic): Promise<void>;

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

@@ -104,6 +104,10 @@ export declare class InfoCard {
      * IPopupUtils: When false alerts will be shown to indicate that the layer must have editing enabled for edit actions
      */
     protected _popupUtils: IPopupUtils;
+    /**
+     * string: unique id for the features node
+     */
+    protected _featuresNodeId: string;
     /**
      * esri/core/reactiveUtils: https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html
      */
@@ -129,8 +133,8 @@ export declare class InfoCard {
      */
     getSelectedFeature(): Promise<any>;
     /**
-     * Get the current selected feature from the Features widget
-     * @returns Promise resolving with the current feature
+     * Refresh the feature info
+     * @returns Promise when complete
      */
     refresh(): Promise<any>;
     /**