@esri/solutions-components 0.8.7 → 0.8.9

package/dist/types/components.d.ts

@@ -5,9 +5,11 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, IReportingOptions, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+import { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, ILayerExpression, IMapChange, IMapInfo, IReportingOptions, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+import { IReportingOptions as IReportingOptions1 } from "./components";
 import { UserSession } from "@esri/solution-common";
-export { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, IReportingOptions, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+export { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, ILayerExpression, IMapChange, IMapInfo, IReportingOptions, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+export { IReportingOptions as IReportingOptions1 } from "./components";
 export { UserSession } from "@esri/solution-common";
 export namespace Components {
     interface ArcgisLogin {
@@ -223,6 +225,22 @@ export namespace Components {
           * boolean: When true only editable layers that support the update capability will be available
          */
         "onlyShowUpdatableLayers": boolean;
+        /**
+          * string: The background color to apply to the popup header
+         */
+        "popupHeaderColor": string;
+        /**
+          * string: The color that will be displayed on hover when expanding the popup header
+         */
+        "popupHeaderHoverColor": string;
+        /**
+          * string: The font color that will be displayed on hover when expanding the popup header
+         */
+        "popupHeaderHoverTextColor": string;
+        /**
+          * string: The font color to apply to the popup header
+         */
+        "popupHeaderTextColor": string;
         /**
           * ISearchConfiguration: Configuration details for the Search widget
          */
@@ -302,13 +320,13 @@ export namespace Components {
          */
         "isMobile": boolean;
         /**
-          * string: Layer id of the feature from URL params
+          * ILayerExpression[]: Array of layer expressions for layers (filter configuration)
          */
-        "layerId": string;
+        "layerExpressions": ILayerExpression[];
         /**
-          * string[]: list of layer ids
+          * string: Layer id of the feature from URL params
          */
-        "layers": string[];
+        "layerId": string;
         /**
           * string: Id of the zoom level from URL params
          */
@@ -329,14 +347,6 @@ export namespace Components {
           * string: Object id of the feature from URL params
          */
         "objectId": string;
-        /**
-          * string: The background color to apply to the popup header
-         */
-        "popupHeaderColor": string;
-        /**
-          * string: The color that will be displayed on hover when expanding the popup header
-         */
-        "popupHeaderHoverColor": string;
         /**
           * string: The word(s) to display in the reports submit button
          */
@@ -414,6 +424,37 @@ export namespace Components {
     }
     interface FeatureComments {
     }
+    interface FeatureDetails {
+        /**
+          * Go to the previous feature in the features widget
+         */
+        "back": () => Promise<void>;
+        /**
+          * esri/Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
+         */
+        "graphics": __esri.Graphic[];
+        /**
+          * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView": __esri.MapView;
+        /**
+          * Go to the next feature in the features widget
+         */
+        "next": () => Promise<void>;
+        /**
+          * Refresh the features comments which will fetch like, dislike and update the component
+          * @returns Promise that resolves when the operation is complete
+         */
+        "refresh": (graphic?: __esri.Graphic) => Promise<void>;
+        /**
+          * IReportingOptions: Key options for reporting
+         */
+        "reportingOptions": IReportingOptions1;
+        /**
+          * Toggle the visibility of the features list view
+         */
+        "toggleListView": () => Promise<void>;
+    }
     interface FeatureFormFlowItem {
     }
     interface FeatureList {
@@ -468,6 +509,10 @@ export namespace Components {
           * boolean: If true will show edit button
          */
         "allowEditing"?: boolean;
+        /**
+          * Go to the previous feature in the features widget
+         */
+        "back": () => Promise<void>;
         /**
           * Get the current selected feature from the Features widget
           * @returns Promise resolving with the current feature
@@ -493,6 +538,31 @@ export namespace Components {
           * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
          */
         "mapView": __esri.MapView;
+        /**
+          * Go to the next feature in the features widget
+         */
+        "next": () => Promise<void>;
+        /**
+          * boolean: If true will show the pagination for multiple features
+         */
+        "paginationEnabled"?: boolean;
+        /**
+          * string: Set the position of the feature info
+         */
+        "position"?: string;
+        /**
+          * Get the current selected feature from the Features widget
+          * @returns Promise resolving with the current feature
+         */
+        "refresh": () => Promise<any>;
+        /**
+          * Toggle the visibility of the features list view
+         */
+        "toggleListView": () => Promise<void>;
+        /**
+          * update the current graphics to the features widget
+         */
+        "updateCurrentGraphic": (selectedGraphic: __esri.Graphic) => Promise<void>;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -1394,6 +1464,10 @@ export interface EditCardCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLEditCardElement;
 }
+export interface FeatureDetailsCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLFeatureDetailsElement;
+}
 export interface FeatureListCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLFeatureListElement;
@@ -1534,6 +1608,7 @@ declare global {
         "fail": Error;
         "drawComplete": void;
         "editingAttachment": boolean;
+        "progressStatus": number;
     }
     interface HTMLCreateFeatureElement extends Components.CreateFeature, HTMLStencilElement {
         addEventListener<K extends keyof HTMLCreateFeatureElementEventMap>(type: K, listener: (this: HTMLCreateFeatureElement, ev: CreateFeatureCustomEvent<HTMLCreateFeatureElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1631,6 +1706,23 @@ declare global {
         prototype: HTMLFeatureCommentsElement;
         new (): HTMLFeatureCommentsElement;
     };
+    interface HTMLFeatureDetailsElementEventMap {
+        "loadingStatus": boolean;
+    }
+    interface HTMLFeatureDetailsElement extends Components.FeatureDetails, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLFeatureDetailsElementEventMap>(type: K, listener: (this: HTMLFeatureDetailsElement, ev: FeatureDetailsCustomEvent<HTMLFeatureDetailsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLFeatureDetailsElementEventMap>(type: K, listener: (this: HTMLFeatureDetailsElement, ev: FeatureDetailsCustomEvent<HTMLFeatureDetailsElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLFeatureDetailsElement: {
+        prototype: HTMLFeatureDetailsElement;
+        new (): HTMLFeatureDetailsElement;
+    };
     interface HTMLFeatureFormFlowItemElement extends Components.FeatureFormFlowItem, HTMLStencilElement {
     }
     var HTMLFeatureFormFlowItemElement: {
@@ -1681,7 +1773,7 @@ declare global {
     };
     interface HTMLInfoCardElementEventMap {
         "popupClosed": void;
-        "selectionChanged": __esri.Graphic[];
+        "selectionChanged": { selectedFeature: __esri.Graphic[], selectedFeatureIndex: number };
     }
     interface HTMLInfoCardElement extends Components.InfoCard, HTMLStencilElement {
         addEventListener<K extends keyof HTMLInfoCardElementEventMap>(type: K, listener: (this: HTMLInfoCardElement, ev: InfoCardCustomEvent<HTMLInfoCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2110,6 +2202,7 @@ declare global {
         "delete-button": HTMLDeleteButtonElement;
         "edit-card": HTMLEditCardElement;
         "feature-comments": HTMLFeatureCommentsElement;
+        "feature-details": HTMLFeatureDetailsElement;
         "feature-form-flow-item": HTMLFeatureFormFlowItemElement;
         "feature-list": HTMLFeatureListElement;
         "features-flow-item": HTMLFeaturesFlowItemElement;
@@ -2272,6 +2365,10 @@ declare namespace LocalJSX {
           * Emitted on demand when the feature creation is failed
          */
         "onFail"?: (event: CreateFeatureCustomEvent<Error>) => void;
+        /**
+          * Emitted on demand when editor panel changes
+         */
+        "onProgressStatus"?: (event: CreateFeatureCustomEvent<number>) => void;
         /**
           * Emitted on demand when the feature is created successfully
          */
@@ -2378,6 +2475,22 @@ declare namespace LocalJSX {
           * boolean: When true only editable layers that support the update capability will be available
          */
         "onlyShowUpdatableLayers"?: boolean;
+        /**
+          * string: The background color to apply to the popup header
+         */
+        "popupHeaderColor"?: string;
+        /**
+          * string: The color that will be displayed on hover when expanding the popup header
+         */
+        "popupHeaderHoverColor"?: string;
+        /**
+          * string: The font color that will be displayed on hover when expanding the popup header
+         */
+        "popupHeaderHoverTextColor"?: string;
+        /**
+          * string: The font color to apply to the popup header
+         */
+        "popupHeaderTextColor"?: string;
         /**
           * ISearchConfiguration: Configuration details for the Search widget
          */
@@ -2457,13 +2570,13 @@ declare namespace LocalJSX {
          */
         "isMobile"?: boolean;
         /**
-          * string: Layer id of the feature from URL params
+          * ILayerExpression[]: Array of layer expressions for layers (filter configuration)
          */
-        "layerId"?: string;
+        "layerExpressions"?: ILayerExpression[];
         /**
-          * string[]: list of layer ids
+          * string: Layer id of the feature from URL params
          */
-        "layers"?: string[];
+        "layerId"?: string;
         /**
           * string: Id of the zoom level from URL params
          */
@@ -2488,14 +2601,6 @@ declare namespace LocalJSX {
           * Emitted when toggle panel button is clicked in reporter
          */
         "onTogglePanel"?: (event: CrowdsourceReporterCustomEvent<boolean>) => void;
-        /**
-          * string: The background color to apply to the popup header
-         */
-        "popupHeaderColor"?: string;
-        /**
-          * string: The color that will be displayed on hover when expanding the popup header
-         */
-        "popupHeaderHoverColor"?: string;
         /**
           * string: The word(s) to display in the reports submit button
          */
@@ -2593,6 +2698,24 @@ declare namespace LocalJSX {
     }
     interface FeatureComments {
     }
+    interface FeatureDetails {
+        /**
+          * esri/Graphic: https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html
+         */
+        "graphics"?: __esri.Graphic[];
+        /**
+          * esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html
+         */
+        "mapView"?: __esri.MapView;
+        /**
+          * Emitted on demand when like or dislike button is clicked
+         */
+        "onLoadingStatus"?: (event: FeatureDetailsCustomEvent<boolean>) => void;
+        /**
+          * IReportingOptions: Key options for reporting
+         */
+        "reportingOptions"?: IReportingOptions1;
+    }
     interface FeatureFormFlowItem {
     }
     interface FeatureList {
@@ -2685,7 +2808,15 @@ declare namespace LocalJSX {
         /**
           * Emitted on demand when the selected index changes
          */
-        "onSelectionChanged"?: (event: InfoCardCustomEvent<__esri.Graphic[]>) => void;
+        "onSelectionChanged"?: (event: InfoCardCustomEvent<{ selectedFeature: __esri.Graphic[], selectedFeatureIndex: number }>) => void;
+        /**
+          * boolean: If true will show the pagination for multiple features
+         */
+        "paginationEnabled"?: boolean;
+        /**
+          * string: Set the position of the feature info
+         */
+        "position"?: string;
         /**
           * boolean: When true the selected feature will zoomed to in the map and the row will be scrolled to within the table
          */
@@ -3569,6 +3700,7 @@ declare namespace LocalJSX {
         "delete-button": DeleteButton;
         "edit-card": EditCard;
         "feature-comments": FeatureComments;
+        "feature-details": FeatureDetails;
         "feature-form-flow-item": FeatureFormFlowItem;
         "feature-list": FeatureList;
         "features-flow-item": FeaturesFlowItem;
@@ -3626,6 +3758,7 @@ declare module "@stencil/core" {
             "delete-button": LocalJSX.DeleteButton & JSXBase.HTMLAttributes<HTMLDeleteButtonElement>;
             "edit-card": LocalJSX.EditCard & JSXBase.HTMLAttributes<HTMLEditCardElement>;
             "feature-comments": LocalJSX.FeatureComments & JSXBase.HTMLAttributes<HTMLFeatureCommentsElement>;
+            "feature-details": LocalJSX.FeatureDetails & JSXBase.HTMLAttributes<HTMLFeatureDetailsElement>;
             "feature-form-flow-item": LocalJSX.FeatureFormFlowItem & JSXBase.HTMLAttributes<HTMLFeatureFormFlowItemElement>;
             "feature-list": LocalJSX.FeatureList & JSXBase.HTMLAttributes<HTMLFeatureListElement>;
             "features-flow-item": LocalJSX.FeaturesFlowItem & JSXBase.HTMLAttributes<HTMLFeaturesFlowItemElement>;

package/dist/types/preact.d.ts

@@ -514,11 +514,12 @@ declare module "preact/src/jsx" {
         "onconsentGranted"?: (event: CustomEvent<any>) => void;
       }
 
-      "create-feature": Omit<JSX.SolutionsCreateFeature, "onSuccess" | "onFail" | "onDrawComplete" | "onEditingAttachment"> & JSXInternal.HTMLAttributes<HTMLSolutionsCreateFeatureElement> & {
+      "create-feature": Omit<JSX.SolutionsCreateFeature, "onSuccess" | "onFail" | "onDrawComplete" | "onEditingAttachment" | "onProgressStatus"> & JSXInternal.HTMLAttributes<HTMLSolutionsCreateFeatureElement> & {
         "onsuccess"?: (event: CustomEvent<any>) => void;
         "onfail"?: (event: CustomEvent<any>) => void;
         "ondrawComplete"?: (event: CustomEvent<any>) => void;
         "oneditingAttachment"?: (event: CustomEvent<any>) => void;
+        "onprogressStatus"?: (event: CustomEvent<any>) => void;
       }
 
       "crowdsource-manager": JSX.SolutionsCrowdsourceManager & JSXInternal.HTMLAttributes<HTMLSolutionsCrowdsourceManagerElement>
@@ -543,6 +544,10 @@ declare module "preact/src/jsx" {
 
       "feature-comments": JSX.SolutionsFeatureComments & JSXInternal.HTMLAttributes<HTMLSolutionsFeatureCommentsElement>
 
+      "feature-details": Omit<JSX.SolutionsFeatureDetails, "onLoadingStatus"> & JSXInternal.HTMLAttributes<HTMLSolutionsFeatureDetailsElement> & {
+        "onloadingStatus"?: (event: CustomEvent<any>) => void;
+      }
+
       "feature-form-flow-item": JSX.SolutionsFeatureFormFlowItem & JSXInternal.HTMLAttributes<HTMLSolutionsFeatureFormFlowItemElement>
 
       "feature-list": Omit<JSX.SolutionsFeatureList, "onFeatureSelect"> & JSXInternal.HTMLAttributes<HTMLSolutionsFeatureListElement> & {

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

@@ -497,13 +497,13 @@ export interface IManagedLayers {
  * Key is the layers guid
  */
 export interface IReportingOptions {
-    [key: string]: IReportOption;
+    [key: string]: IReportingOption;
 }
-export interface IReportOption {
+export interface IReportingOption {
     reporting: boolean;
     comment: boolean;
     like: boolean;
+    likeField?: string;
     dislike: boolean;
-    likeField: string;
-    dislikeField: string;
+    dislikeField?: string;
 }

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

@@ -71,10 +71,11 @@ export declare function getAllLayers(mapView: __esri.MapView): Promise<__esri.La
  * @param layerView the layer view to highlight
  * @param mapView the map view used if updateExtent is true
  * @param updateExtent optional (default false) boolean to indicate if we should zoom to the extent
+ * @param zoomToScale optional (default 0) zoomScale that individual points will use when zoomed to
  *
  * @returns Promise resolving with the highlight handle
  */
-export declare function highlightFeatures(ids: number[], layerView: __esri.FeatureLayerView, mapView: __esri.MapView, updateExtent?: boolean): Promise<__esri.Handle>;
+export declare function highlightFeatures(ids: number[], layerView: __esri.FeatureLayerView, mapView: __esri.MapView, updateExtent?: boolean, zoomToScale?: number): Promise<__esri.Handle>;
 /**
  * Highlights features from all sets including the refine set
  *
@@ -110,8 +111,9 @@ export declare function flashSelection(ids: number[], layerView: __esri.FeatureL
  * @param layerView the layer view that contains the OIDs
  * @param mapView the map view to show the extent change
  * @param flashFeatures optional (default true) boolean to indicate if we should flash the features
- *
+ * @param featureEffect optional (default undefined) feature effect when flashing the features
+ * @param zoomToScale optional (default to 0) zoomScale that individual points will use when zoomed to
  * @returns Promise resolving when the operation is complete
  *
  */
-export declare function goToSelection(ids: number[], layerView: __esri.FeatureLayerView, mapView: __esri.MapView, flashFeatures?: boolean, featureEffect?: __esri.FeatureEffect): Promise<void>;
+export declare function goToSelection(ids: number[], layerView: __esri.FeatureLayerView, mapView: __esri.MapView, flashFeatures?: boolean, featureEffect?: __esri.FeatureEffect, zoomToScale?: number): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solutions-components",
-  "version": "0.8.7",
+  "version": "0.8.9",
   "description": "Web Components for Esri's Solutions Applications",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",