@arcgis/core 5.0.0-next.57 → 5.0.0-next.59

package/views/types.d.ts

@@ -1,18 +1,26 @@
 import type Camera from "../Camera.js";
 import type Graphic from "../Graphic.js";
+import type Ground from "../Ground.js";
 import type Viewpoint from "../Viewpoint.js";
+import type Analysis from "../analysis/Analysis.js";
 import type Collection from "../core/Collection.js";
 import type Point from "../geometry/Point.js";
 import type Layer from "../layers/Layer.js";
 import type MediaLayer from "../layers/MediaLayer.js";
 import type RouteLayer from "../layers/RouteLayer.js";
+import type BuildingSublayer from "../layers/buildingSublayers/BuildingSublayer.js";
+import type SubtypeSublayer from "../layers/support/SubtypeSublayer.js";
 import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
 import type { AbortOptions } from "../core/promiseUtils.js";
 import type { ScreenPoint } from "../core/types.js";
-import type { GeometryUnion } from "../geometry/support/typeUtils.js";
+import type { GeometryUnion } from "../geometry/types.js";
 import type { MediaElement } from "../layers/support/media.js";
 import type { NetworkFeature } from "../rest/support/interfaces.js";
+import type { AnalysisViewUnion } from "./analysis/types.js";
 import type { EasingName } from "./animation/types.js";
+import type { ViewEventTypes } from "./input/types.js";
+
+export type ObjectId = number | string;
 
 export type HighlightTarget = Graphic | Graphic[] | Collection<Graphic>;
 
@@ -425,4 +433,142 @@ export interface SceneViewHitTestResultGround {
    *   hitTest. This may be `null` when the ground was not hit at all (for example by clicking on the sky).
    */
   mapPoint: Point;
-}
+}
+
+/**
+ * A layer, graphic, or collection of layers or graphics to be used in the [MapView#hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) filter options.
+ *
+ * @see [MapView#hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest)
+ */
+export type HitTestItem = Layer | SubtypeSublayer | Graphic;
+
+export type HitTestOptionsItem = HitTestItem | Iterable<HitTestItem | Iterable<HitTestItem>>;
+
+export interface HitTestOptions {
+  /**
+   * A list of layers and graphics to exclude from the hitTest. No layers or graphics will be
+   *   excluded if exclude is not specified.
+   */
+  exclude?: HitTestOptionsItem | null;
+  /**
+   * A list of layers and graphics to include in the hitTest. All layers and graphics will be
+   *   included if include is not specified.
+   */
+  include?: HitTestOptionsItem | null;
+}
+
+export type HitTestItem3D = HitTestItem | Ground | BuildingSublayer;
+
+export type HitTestOptions3DItem = HitTestItem3D | Iterable<HitTestItem3D | Iterable<HitTestItem3D>>;
+
+export interface HitTestOptions3D {
+  /**
+   * A list of layers and graphics to exclude for intersection testing. No layers or graphics
+   *   will be excluded if exclude is not specified.
+   */
+  exclude?: HitTestOptions3DItem | null;
+  /**
+   * A list of layers and graphics to include for intersection testing. All layers and graphics
+   *   will be included if include is not specified.
+   */
+  include?: HitTestOptions3DItem | null;
+}
+
+export interface Breakpoints {
+  /**
+   * Sets the `large` breakpoint in pixels used by
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the
+   * view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#width) is between this value and the value
+   * of the `medium` property, then the value of
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will
+   * be `large`.
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the
+   * view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#width) is greater than the value
+   * of the `large` property, then the value of
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will
+   * be `xlarge`.
+   *
+   * @default 1200
+   */
+  large: number;
+  /**
+   * Sets the `medium` breakpoint in pixels used by
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the
+   * view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#width) is between this value and the value
+   * of the `small` property, then the value of
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will
+   * be `medium`.
+   *
+   * @default 992
+   */
+  medium: number;
+  /**
+   * Sets the `small` breakpoint in pixels used by
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the
+   * view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#width) is between this value and the value
+   * of the `xsmall` property, then the value of
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will
+   * be `small`.
+   *
+   * @default 768
+   */
+  small: number;
+  /**
+   * Sets the `xsmall` breakpoint in pixels used by
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the
+   * view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#width) is smaller than this value, then the value of
+   * [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will
+   * be `xsmall`.
+   *
+   * @default 544
+   */
+  xsmall: number;
+}
+
+export type BreakpointOrientation = "landscape" | "portrait";
+
+export type BreakpointSize = "xsmall" | "small" | "medium" | "large" | "xlarge";
+
+export interface AnalysisViewCreateEvent {
+  /** The analysis for which the `analysisView` was created. */
+  analysis: Analysis;
+  /** The analysis view that was created. */
+  analysisView: AnalysisViewUnion;
+}
+
+export interface AnalysisViewCreateErrorEvent {
+  /** The analysis for which the `analysisView` was created. */
+  analysis: Analysis;
+  /** An error object describing why the analysis view could not be created. */
+  error: Error;
+}
+
+export interface AnalysisViewDestroyEvent {
+  /** The analysis whose analysis view was destroyed. */
+  analysis: Analysis;
+  /** The analysis view that was destroyed. */
+  analysisView: AnalysisViewUnion;
+}
+
+export interface AnalysisViewEvents {
+  /**
+   * Fires when the view for an [Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-Analysis.html) is created.
+   *
+   * @see [MapView#whenAnalysisView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)
+   * @see [SceneView#whenAnalysisView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)
+   */
+  "analysis-view-create": AnalysisViewCreateEvent;
+  /**
+   * Fires when an error occurs during the creation of an [Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-Analysis.html) after an analysis
+   * is added to the view.
+   *
+   * @see [MapView#whenAnalysisView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)
+   * @see [SceneView#whenAnalysisView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)
+   */
+  "analysis-view-create-error": AnalysisViewCreateErrorEvent;
+  /** Fires after an [analysis view](https://developers.arcgis.com/javascript/latest/api-reference/esri-unionTypes.html#AnalysisViewUnion) is destroyed. */
+  "analysis-view-destroy": AnalysisViewDestroyEvent;
+}
+
+export type SceneViewEventTypes = ViewEventTypes
+  & AnalysisViewEvents;

package/webdoc/geotriggersInfo/FeatureFilter.d.ts

@@ -1,6 +1,6 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
-import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
+import type { GeometryUnion } from "../../geometry/types.js";
 import type { MeshProperties } from "../../geometry/Mesh.js";
 import type { PolylineProperties } from "../../geometry/Polyline.js";
 import type { PolygonProperties } from "../../geometry/Polygon.js";

package/webscene/support/FeatureReferenceObjectId.d.ts

@@ -1,5 +1,5 @@
 import type FeatureReferenceId from "./FeatureReferenceId.js";
-import type { ObjectId } from "../../views/IObjectId.js";
+import type { ObjectId } from "../../views/types.js";
 import type { FeatureReferenceIdProperties } from "./FeatureReferenceId.js";
 
 export interface FeatureReferenceObjectIdProperties extends FeatureReferenceIdProperties, Partial<Pick<FeatureReferenceObjectId, "value">> {}

package/widgets/BasemapLayerList/BasemapLayerListViewModel.d.ts

@@ -26,8 +26,7 @@ export default class BasemapLayerListViewModel extends EventedAccessor {
    * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
    * Each list item can be modified
    * according to its modifiable properties. Actions can be added to list items
-   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections)
-   * property of the ListItem.
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections).
    */
   accessor baseListItemCreatedFunction: ListItemModifier | null | undefined;
   /** The current basemap's title. */

package/widgets/BasemapLayerList.d.ts

@@ -196,7 +196,7 @@ export default class BasemapLayerList extends BasemapLayerListSuperclass {
   get catalogLayerList(): CatalogLayerList | null | undefined;
   /**
    * [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.
-   * Catalog layers will display their [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList) in the BasemapLayerList widget.
+   * Catalog layers will display their [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList) in the BasemapLayerList widget.
    * This list item will only be displayed when catalog layers with dynamic group layers are loaded in the map.
    * These are the properties that are used to configure the [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogLayerList).
    *
@@ -239,7 +239,7 @@ export default class BasemapLayerList extends BasemapLayerListSuperclass {
   accessor collapsed: boolean;
   /**
    * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.
-   * MapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.
+   * MapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.
    *
    * @default false
    * @since 4.29
@@ -334,8 +334,7 @@ export default class BasemapLayerList extends BasemapLayerListSuperclass {
   /**
    * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer.
    * Each list item's modifiable properties can be updated within. Actions can be added to list items
-   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections)
-   * property of the ListItem.
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections).
    *
    * @example
    * let bmLayerList = new BasemapLayerList({

package/widgets/CatalogLayerList/CatalogLayerListViewModel.d.ts

@@ -99,7 +99,7 @@ export default class CatalogLayerListViewModel extends EventedAccessor {
    */
   accessor listItemCreatedFunction: ListItemModifier | null | undefined;
   /**
-   * Specifies whether to ignore the [Layer#listMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) property of the layers to display all layers.
+   * Specifies whether to ignore the [Layer#listMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) property to display all layers.
    *
    * @default false
    * @since 4.32

package/widgets/CatalogLayerList.d.ts

@@ -107,8 +107,7 @@ export default class CatalogLayerList extends CatalogLayerListSuperclass {
    */
   constructor(properties?: CatalogLayerListProperties);
   /**
-   * The collection of [ListItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing the [catalogLayer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#catalogLayer)
-   * [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer).
+   * The collection of [ListItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing the [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer).
    *
    * @see [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#selectedItems)
    */
@@ -188,8 +187,7 @@ export default class CatalogLayerList extends CatalogLayerListSuperclass {
    * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.
    * Use this function to add actions and panels to list items, and to override
    * the default settings of a list item. Actions can be added to list items
-   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections)
-   * property of the ListItem.
+   * using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections).
    *
    * @example
    * // Create a new CatalogLayerList with a listItemCreatedFunction

package/widgets/Directions/DirectionsViewModel.d.ts

@@ -13,7 +13,7 @@ import type RouteParameters from "../../rest/support/RouteParameters.js";
 import type Stop from "../../rest/support/Stop.js";
 import type TravelMode from "../../rest/support/TravelMode.js";
 import type { EventedAccessor, EventedMixinProperties } from "../../core/Evented.js";
-import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
+import type { GeometryUnion } from "../../geometry/types.js";
 import type { RouteLayerSolveResult } from "../../layers/types.js";
 import type { SaveAsOptions } from "../../layers/mixins/properties/ILayerWithSave.js";
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";

package/widgets/Editor/types.d.ts

@@ -15,7 +15,7 @@ import type FeatureTemplates from "../FeatureTemplates.js";
 import type SketchViewModel from "../Sketch/SketchViewModel.js";
 import type { AnyEditingTemplateInfo } from "../../editing/types.js";
 import type { EditableLayerUnion } from "../../layers/support/editableLayers.js";
-import type { ObjectId } from "../../views/IObjectId.js";
+import type { ObjectId } from "../../views/types.js";
 import type { SketchViewModelEvents } from "../Sketch/SketchViewModel.js";
 
 /** Configurations used for setting the layer's editable preferences within the Editor. */

package/widgets/Feature/support/arcadeFeatureUtils.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{__addDisposableResource as e,__disposeResources as r}from"tslib";import{isSupportedLayer as t}from"../../../arcade/featureset/support/shared.js";import a from"../../../core/Logger.js";import{sqlAnd as i}from"../../../core/sql.js";import{isImageryGraphicOrigin as n}from"../../../graphic/isImageryGraphicOrigin.js";import{isImageryTileGraphicOrigin as o}from"../../../graphic/isImageryTileGraphicOrigin.js";import s from"../../../layers/FeatureLayer.js";import{internalTimeReceivedField as c}from"../../../layers/support/streamLayerUtils.js";import{isDate as l}from"../../../support/guards.js";import{applyTextFormattingHTML as u,htmlEntities as p}from"./featureUtils.js";const d="esri.widgets.Feature.support.arcadeFeatureUtils",f=()=>a.getLogger(d);function y(e){return u(p(e))}function m(e){return"createQuery"in e&&"queryFeatures"in e}async function g({graphic:e,view:r,options:t}){const{isAggregate:a}=e,i=e.layer??e.sourceLayer;if(!a||!i||"2d"!==r?.type)return[];const n=await r.whenLayerView(i);if(!m(n))return[];const o=n.createQuery(),s=e.getObjectId();o.aggregateIds=null!=s?[s]:[];const{features:c}=await n.queryFeatures(o,t);return c}function w({layer:e,aggregatedFeatures:r,interceptor:t}){const{fields:a,objectIdField:i,geometryType:n,spatialReference:o}=e,c="displayField"in e?e.displayField:void 0;return new s({fields:a,objectIdField:i,geometryType:n,spatialReference:o,displayField:c,interceptor:t,..."feature"===e.type?{templates:e.templates,typeIdField:e.typeIdField,types:e.types}:null,source:r})}function h(e){return e.isAggregate?"popup-feature-reduction":"esri.views.3d.layers.VoxelGraphic"===e.declaredClass?"popup-voxel":n(e.origin)||o(e.origin)?"popup-imagery":"popup"}function v(e){return{scale:e?.scale,timeProperties:{currentStart:e?.timeExtent?.start,currentEnd:e?.timeExtent?.end,startIncluded:!0,endIncluded:!0}}}function x(e){return{$voxel:e}}function b(e){let r=null;if(e.origin.layer.fields?.length>0){r=e.cloneShallow();const t=e.origin.layer.fieldsIndex;r.attributes=Object.fromEntries(Object.entries(r.attributes??{}).filter(([e])=>t.has(e)))}return{$pixel:e,$imageCollectionItem:r}}async function F(e,r,t,a,i,n,o){let s=null;if(n.has("$aggregatedfeatures")){const e=await g({graphic:r,view:t,options:a}),n=r.sourceLayer||r.layer;s=w({layer:n,aggregatedFeatures:e,interceptor:i})}return{vars:{$feature:r,$aggregatedFeatures:s,$view:v(t)},track:o?await $(e,r,t):null,[Symbol.dispose]:()=>s?.[Symbol.dispose]()}}function I(e){if(l(e))return e.getTime();if("number"==typeof e)return e;if("string"==typeof e)return new Date(e).getTime();throw new Error(`Unexpected time value: ${e}`)}async function $(e,r,t){const a=r.sourceLayer||r.layer;if(null==a||!("timeInfo"in a))return null;const n=a.timeInfo?.trackIdField;if(null==n)return null;const o=r.getAttribute(n);if(null==o)return null;let s,l;if("string"==typeof o)s=`"${n.replaceAll('"','""')}" = '${o.replaceAll("'","''")}'`;else{if("number"!=typeof o)return f().warn("Expected track id to be a string or number"),null;s=`"${n.replaceAll('"','""')}" = ${o}`}if("stream"===a.type&&null!=t){const e=await t.whenLayerView(a),r=e.createQuery();r.returnGeometry=!0,r.where=i(r.where,s),l=(await e.queryFeatures(r)).features}else{if(!("queryFeatures"in a))return null;{const e=a.createQuery();e.returnGeometry=!0,e.where=i(e.where,s),l=(await a.queryFeatures(e)).features}}const u=a.fieldsIndex.normalizeFieldName(a.timeInfo.startField)??c,p=a.timeInfo.endField?a.fieldsIndex.normalizeFieldName(a.timeInfo.endField):null,d=l.map(r=>{const a=r.getObjectId();if(null==a)throw new Error("Cannot identify observation");const i=e.ArcadeFeature.createFromGraphic(r,t?.timeZone),n=I(r.getAttribute(u));return{id:a,feature:i,startTime:n,endTime:null!=p?I(r.getAttribute(p)):n,stats:{totalDistance:void 0,distance:void 0,speed:void 0,acceleration:void 0}}}).sort((e,r)=>e.startTime-r.startTime),y="esri.TrackGraphic"===r.declaredClass?d.length-1:d.findIndex(e=>r.getObjectId()===e.id);if(y<0)throw new Error("Couldn't locate feature in observations");return{observations:d,currentObservationIndex:y}}async function j(e,r,a,i,n,o){const s=(r.sourceLayer||r.layer)??void 0;return{vars:{$feature:r,$layer:null!=s&&t(s)?s:"scene"===s?.type&&null!=s.associatedLayer?s.associatedLayer:void 0,$map:a,$datastore:s&&"url"in s?s.url:void 0,$userInput:i,$graph:"knowledge-graph-sublayer"===s?.type?s.parentCompositeLayer?.knowledgeGraph:void 0,$view:v(n)},track:o?await $(e,r,n):null}}async function T(e,{arcade:r,graphic:t,map:a,location:i,view:n,options:o,interceptor:s,arcadeExecutor:c,usesTrack:l}){switch(e){case"popup":return{...await j(r,t,a,i,n,l),[Symbol.dispose](){}};case"popup-feature-reduction":{const e=new Set(c.variablesUsed);return await F(r,t,n,o,s,e,l)}case"popup-voxel":return{vars:x(t),track:null,[Symbol.dispose](){}};case"popup-imagery":return{vars:b(t),track:null,[Symbol.dispose](){}};default:throw new Error(`Unexpected profile name ${e}`)}}async function k(){const[e,r,{Feature:t}]=await Promise.all([import("../../../arcade.js"),import("../../../arcade/arcade.js"),import("../../../arcade/Feature.js")]);return{executor:e,syntaxUtils:r,ArcadeFeature:t}}async function E(t,a,i){const{executor:{createArcadeProfile:n,createArcadeExecutor:o},syntaxUtils:s}=i,c=h(a),l=n(c);let u;try{u=await o(t,l)}catch(y){return f().error("arcade-executor-error",{error:y,expression:t}),null}const p=new Set;u.variablesUsed.includes("$view")&&(s.scriptUsesViewProperties(u.syntaxTree,["scale"])&&p.add("view-scale"),s.scriptUsesViewProperties(u.syntaxTree,["timeProperties"])&&p.add("view-time-extent"));const d=s.scriptUsesTrack(u.syntaxTree);return{dependencies:p,async evaluate({graphic:a,interceptor:n,location:o,map:s,options:l,spatialReference:p,view:m}){const g={stack:[],error:void 0,hasError:!1};try{const r=e(g,await T(c,{arcade:i,graphic:a,map:s,location:o,view:m,options:l,interceptor:n,arcadeExecutor:u,usesTrack:d}),!1),w={abortSignal:l?.signal??void 0,interceptor:n??void 0,rawOutput:!0,spatialReference:p??void 0,timeZone:m?.timeZone,track:r.track,console(...e){f().info(...e)}};try{return await u.executeAsync(r.vars,w)}catch(y){if(l?.signal?.aborted)return;return void f().error("arcade-execution-error",{error:y,graphic:a,expression:t})}}catch(w){g.error=w,g.hasError=!0}finally{r(g)}}}}async function A({expression:e,graphic:r}){return e?E(e,r,await k()):null}async function L(e,r){if(!e?.length)return{dependencies:new Set,expressions:new Map};const t=await k(),a=new Set,i=new Map;for(const n of e){const e=await E(n.expression,r,t);i.set(`expression/${n.name}`,e),e?.dependencies.forEach(e=>a.add(e))}return{dependencies:a,expressions:i}}export{A as compileExpression,L as compileExpressionInfos,y as formatArcadeValue};
+import{__addDisposableResource as e,__disposeResources as r}from"tslib";import{isSupportedLayer as t}from"../../../arcade/featureset/support/shared.js";import a from"../../../core/Logger.js";import{sqlAnd as i}from"../../../core/sql.js";import{isImageryGraphicOrigin as n}from"../../../graphic/isImageryGraphicOrigin.js";import{isImageryTileGraphicOrigin as o}from"../../../graphic/isImageryTileGraphicOrigin.js";import s from"../../../layers/FeatureLayer.js";import{internalTimeReceivedField as c}from"../../../layers/support/streamLayerUtils.js";import{isDate as u}from"../../../support/guards.js";import{applyTextFormattingHTML as l,htmlEntities as p}from"./featureUtils.js";const d="esri.widgets.Feature.support.arcadeFeatureUtils",f=()=>a.getLogger(d);function y(e){return l(p(e))}function m(e){return"createQuery"in e&&"queryFeatures"in e}async function g({graphic:e,view:r,options:t}){const{isAggregate:a}=e,i=e.layer??e.sourceLayer;if(!a||!i||"2d"!==r?.type)return[];const n=await r.whenLayerView(i);if(!m(n))return[];const o=n.createQuery(),s=e.getObjectId();o.aggregateIds=null!=s?[s]:[];const{features:c}=await n.queryFeatures(o,t);return c}function w({layer:e,aggregatedFeatures:r,interceptor:t}){const{fields:a,objectIdField:i,geometryType:n,spatialReference:o}=e,c="displayField"in e?e.displayField:void 0;return new s({fields:a,objectIdField:i,geometryType:n,spatialReference:o,displayField:c,interceptor:t,..."feature"===e.type?{templates:e.templates,typeIdField:e.typeIdField,types:e.types}:null,source:r})}function v(e){return e.isAggregate?"popup-feature-reduction":"esri.views.3d.layers.VoxelGraphic"===e.declaredClass?"popup-voxel":n(e.origin)||o(e.origin)?"popup-imagery":"popup"}function h(e){return{scale:e?.scale,timeProperties:{currentStart:e?.timeExtent?.start,currentEnd:e?.timeExtent?.end,startIncluded:!0,endIncluded:!0}}}function x(e){return{$voxel:e}}function b(e,r,t){let a=null;if(e.origin.layer.fields?.length>0){a=e.cloneShallow();const r=e.origin.layer.fieldsIndex;a.attributes=Object.fromEntries(Object.entries(a.attributes??{}).filter(([e])=>r.has(e)))}return{$pixel:e,$imageCollectionItem:a,$userInput:r,$view:h(t)}}async function F(e,r,t,a,i,n,o){let s=null;if(n.has("$aggregatedfeatures")){const e=await g({graphic:r,view:t,options:a}),n=r.sourceLayer||r.layer;s=w({layer:n,aggregatedFeatures:e,interceptor:i})}return{vars:{$feature:r,$aggregatedFeatures:s,$view:h(t)},track:o?await $(e,r,t):null,[Symbol.dispose]:()=>s?.[Symbol.dispose]()}}function I(e){if(u(e))return e.getTime();if("number"==typeof e)return e;if("string"==typeof e)return new Date(e).getTime();throw new Error(`Unexpected time value: ${e}`)}async function $(e,r,t){const a=r.sourceLayer||r.layer;if(null==a||!("timeInfo"in a))return null;const n=a.timeInfo?.trackIdField;if(null==n)return null;const o=r.getAttribute(n);if(null==o)return null;let s,u;if("string"==typeof o)s=`"${n.replaceAll('"','""')}" = '${o.replaceAll("'","''")}'`;else{if("number"!=typeof o)return f().warn("Expected track id to be a string or number"),null;s=`"${n.replaceAll('"','""')}" = ${o}`}if("stream"===a.type&&null!=t){const e=await t.whenLayerView(a),r=e.createQuery();r.returnGeometry=!0,r.where=i(r.where,s),u=(await e.queryFeatures(r)).features}else{if(!("queryFeatures"in a))return null;{const e=a.createQuery();e.returnGeometry=!0,e.where=i(e.where,s),u=(await a.queryFeatures(e)).features}}const l=a.fieldsIndex.normalizeFieldName(a.timeInfo.startField)??c,p=a.timeInfo.endField?a.fieldsIndex.normalizeFieldName(a.timeInfo.endField):null,d=u.map(r=>{const a=r.getObjectId();if(null==a)throw new Error("Cannot identify observation");const i=e.ArcadeFeature.createFromGraphic(r,t?.timeZone),n=I(r.getAttribute(l));return{id:a,feature:i,startTime:n,endTime:null!=p?I(r.getAttribute(p)):n,stats:{totalDistance:void 0,distance:void 0,speed:void 0,acceleration:void 0}}}).sort((e,r)=>e.startTime-r.startTime),y="esri.TrackGraphic"===r.declaredClass?d.length-1:d.findIndex(e=>r.getObjectId()===e.id);if(y<0)throw new Error("Couldn't locate feature in observations");return{observations:d,currentObservationIndex:y}}async function j(e,r,a,i,n,o){const s=(r.sourceLayer||r.layer)??void 0;return{vars:{$feature:r,$layer:null!=s&&t(s)?s:"scene"===s?.type&&null!=s.associatedLayer?s.associatedLayer:void 0,$map:a,$datastore:s&&"url"in s?s.url:void 0,$userInput:i,$graph:"knowledge-graph-sublayer"===s?.type?s.parentCompositeLayer?.knowledgeGraph:void 0,$view:h(n)},track:o?await $(e,r,n):null}}async function T(e,{arcade:r,graphic:t,map:a,location:i,view:n,options:o,interceptor:s,arcadeExecutor:c,usesTrack:u}){switch(e){case"popup":return{...await j(r,t,a,i,n,u),[Symbol.dispose](){}};case"popup-feature-reduction":{const e=new Set(c.variablesUsed);return await F(r,t,n,o,s,e,u)}case"popup-voxel":return{vars:x(t),track:null,[Symbol.dispose](){}};case"popup-imagery":return{vars:b(t,i,n),track:null,[Symbol.dispose](){}};default:throw new Error(`Unexpected profile name ${e}`)}}async function k(){const[e,r,{Feature:t}]=await Promise.all([import("../../../arcade.js"),import("../../../arcade/arcade.js"),import("../../../arcade/Feature.js")]);return{executor:e,syntaxUtils:r,ArcadeFeature:t}}async function E(t,a,i){const{executor:{createArcadeProfile:n,createArcadeExecutor:o},syntaxUtils:s}=i,c=v(a),u=n(c);let l;try{l=await o(t,u)}catch(y){return f().error("arcade-executor-error",{error:y,expression:t}),null}const p=new Set;l.variablesUsed.includes("$view")&&(s.scriptUsesViewProperties(l.syntaxTree,["scale"])&&p.add("view-scale"),s.scriptUsesViewProperties(l.syntaxTree,["timeProperties"])&&p.add("view-time-extent"));const d=s.scriptUsesTrack(l.syntaxTree);return{dependencies:p,async evaluate({graphic:a,interceptor:n,location:o,map:s,options:u,spatialReference:p,view:m}){const g={stack:[],error:void 0,hasError:!1};try{const r=e(g,await T(c,{arcade:i,graphic:a,map:s,location:o,view:m,options:u,interceptor:n,arcadeExecutor:l,usesTrack:d}),!1),w={abortSignal:u?.signal??void 0,interceptor:n??void 0,rawOutput:!0,spatialReference:p??void 0,timeZone:m?.timeZone,track:r.track,console(...e){f().info(...e)}};try{return await l.executeAsync(r.vars,w)}catch(y){if(u?.signal?.aborted)return;return void f().error("arcade-execution-error",{error:y,graphic:a,expression:t})}}catch(w){g.error=w,g.hasError=!0}finally{r(g)}}}}async function A({expression:e,graphic:r}){return e?E(e,r,await k()):null}async function L(e,r){if(!e?.length)return{dependencies:new Set,expressions:new Map};const t=await k(),a=new Set,i=new Map;for(const n of e){const e=await E(n.expression,r,t);i.set(`expression/${n.name}`,e),e?.dependencies.forEach(e=>a.add(e))}return{dependencies:a,expressions:i}}export{A as compileExpression,L as compileExpressionInfos,y as formatArcadeValue,b as prepareImageryPopupArgs};

package/widgets/FeatureTable/FeatureTableViewModel.d.ts

@@ -14,11 +14,11 @@ import type GroupColumn from "./Grid/GroupColumn.js";
 import type AttachmentsViewOptions from "./support/AttachmentsViewOptions.js";
 import type TableTemplate from "./support/TableTemplate.js";
 import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
-import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
+import type { GeometryUnion } from "../../geometry/types.js";
 import type { FieldValue } from "../../layers/support/fieldUtils.js";
 import type { TimeZone } from "../../time/types.js";
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
-import type { ObjectId } from "../../views/IObjectId.js";
+import type { ObjectId } from "../../views/types.js";
 import type { GridViewModelProperties } from "./Grid/GridViewModel.js";
 import type { GridMultiSortPriority, GridSupportedColumns, FeatureTableState, TableInteractionCellClickEvent, TableInteractionCellDblclickEvent, TableInteractionCellKeydownEvent, TableInteractionCellPointeroverEvent, TableInteractionColumnReorderEvent, TableInteractionCellPointeroutEvent, TableMenuConfig } from "./Grid/types.js";
 import type { ColumnSortOrder, FeatureTableSupportedColumn as SupportedColumn, FeatureTableSupportedFilters as SupportedFilters, FeatureTableSupportedLayer, ActionColumnConfig } from "./support/interfaces.js";
@@ -32,7 +32,7 @@ import type { ExtentProperties } from "../../geometry/Extent.js";
 import type { TableTemplateProperties } from "./support/TableTemplate.js";
 import type { TimeExtentProperties } from "../../time/TimeExtent.js";
 
-export interface FeatureTableViewModelProperties extends GridViewModelProperties, Partial<Pick<FeatureTableViewModel, "actionColumnConfig" | "attachmentsEnabled" | "autoRefreshEnabled" | "columnPerformanceModeEnabled" | "columnReorderingEnabled" | "definitionExpression" | "editingEnabled" | "filterBySelectionEnabled" | "highlightEnabled" | "initialSize" | "layer" | "maxSize" | "menuConfig" | "multipleSelectionEnabled" | "multipleSortPriority" | "multiSortEnabled" | "outFields" | "pageIndex" | "pageSize" | "paginationEnabled" | "relatedRecordsEnabled" | "relatedTables" | "returnGeometryEnabled" | "returnMEnabled" | "returnZEnabled" | "syncTemplateOnChangesEnabled" | "timeZone" | "view">> {
+export interface FeatureTableViewModelProperties extends GridViewModelProperties, Partial<Pick<FeatureTableViewModel, "actionColumnConfig" | "attachmentsEnabled" | "autoRefreshEnabled" | "autoSaveEnabled" | "columnPerformanceModeEnabled" | "columnReorderingEnabled" | "definitionExpression" | "editingEnabled" | "filterBySelectionEnabled" | "highlightEnabled" | "initialSize" | "layer" | "maxSize" | "menuConfig" | "multipleSelectionEnabled" | "multipleSortPriority" | "multiSortEnabled" | "outFields" | "pageIndex" | "pageSize" | "paginationEnabled" | "relatedRecordsEnabled" | "relatedTables" | "returnGeometryEnabled" | "returnMEnabled" | "returnZEnabled" | "syncTemplateOnChangesEnabled" | "timeZone" | "view">> {
   /**
    * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting.
    *
@@ -382,6 +382,13 @@ export default class FeatureTableViewModel extends GridViewModel {
    * @since 4.23
    */
   accessor autoRefreshEnabled: boolean;
+  /**
+   * Indicates whether the table should automatically save edits, or cache all edits until the 'savePendingEdits' or 'cancelPendingEdits' methods are called.
+   *
+   * @default true
+   * @since 5.0
+   */
+  accessor autoSaveEnabled: boolean;
   /**
    * Indicates whether to enable the table's column performance mode. This mode is designed to improve the performance of the table when working with a large number of columns.
    *
@@ -488,6 +495,27 @@ export default class FeatureTableViewModel extends GridViewModel {
    * @since 4.33
    */
   get groupColumns(): GroupColumn[];
+  /**
+   * A collection of string {@link module:esri/layers/support/Field field.names} that are to remain hidden within the table. By default fields such as `CreationDate`, `Creator`, `EditDate`, `Editor`, and `GlobalID` do not show. If these fields are needed, set them via {@link module:esri/widgets/FeatureTable/support/TableTemplate#columnTemplates TableTemplate.columnTemplates}. In this case, it is also required that the column template's {@link module:esri/widgets/FeatureTable/support/FieldColumnTemplate#visible visible} property is set to `true`.
+   *
+   * @default false
+   * @since 5.0
+   */
+  get hasContingentValues(): boolean;
+  /**
+   * Indicates there are unsaved edits and that they are invalid.
+   *
+   * @default false
+   * @since 5.0
+   */
+  get hasInvalidPendingEdits(): boolean;
+  /**
+   * Indicates there are unsaved edits. This does not account for whether the edits are valid or not.
+   *
+   * @default false
+   * @since 5.0
+   */
+  get hasPendingEdits(): boolean;
   /**
    * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. By default fields such as `CreationDate`, `Creator`, `EditDate`, `Editor`, and `GlobalID` do not show. If these fields are needed, set them via [TableTemplate#columnTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates). In this case, it is also required that the column template's [FieldColumnTemplate#visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#visible) property is set to `true`.
    *
@@ -573,7 +601,7 @@ export default class FeatureTableViewModel extends GridViewModel {
    */
   get isQuerying(): boolean;
   /**
-   * Indicates if the table is querying or syncing data. This is useful when determining if the table is busy. This can be especially helpful when the table is querying a large amount of features.
+   * Indicates the table is querying or syncing data. This is useful when determining if the table is busy. This can be especially helpful when the table is querying a large amount of features.
    *
    * @since 4.31
    */
@@ -585,7 +613,7 @@ export default class FeatureTableViewModel extends GridViewModel {
    */
   get isSyncing(): boolean;
   /**
-   * Indicates if the table is syncing attachment edits.
+   * Indicates the table is syncing attachment edits.
    *
    * @since 4.31
    */
@@ -931,6 +959,12 @@ export default class FeatureTableViewModel extends GridViewModel {
    * @since 4.33
    */
   get visibleColumns(): GridSupportedColumns[];
+  /**
+   * Cancels any unsaved edits.
+   *
+   * @since 5.0
+   */
+  cancelPendingEdits(): void;
   /**
    * Clears the current [filterBySelection()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection) so that the table displays all of the table rows.
    *
@@ -1039,6 +1073,13 @@ export default class FeatureTableViewModel extends GridViewModel {
    * @since 4.23
    */
   reset(): Promise<void>;
+  /**
+   * Attempts to save any pending edits. If any edits are invalid, the save will be rejected until the edits are in a valid state.
+   *
+   * @returns Resolves when the edits are saved or rejected.
+   * @since 5.0
+   */
+  savePendingEdits(): Promise<void>;
   /**
    * Resets the horizontal scroll position of the table to the default view.
    *