@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/widgets/Editor/VisibleElements.d.ts

@@ -2,8 +2,13 @@ import type Accessor from "../../core/Accessor.js";
 import type SnappingControlsVisibleElements from "../support/SnappingControls/VisibleElements.js";
 import type { SnappingControlsVisibleElementsProperties } from "../support/SnappingControls/VisibleElements.js";
 
+/** @since 5.0 */
 export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "createFeaturesSection" | "editFeaturesSection" | "flow" | "labelsToggle" | "mergeButton" | "settingsMenu" | "sketch" | "snappingControls" | "splitButton" | "tooltipsToggle" | "undoRedoButtons" | "zoomToButton">> {
-  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  /**
+   * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget.
+   *
+   * @since 5.0
+   */
   snappingControlsElements?: SnappingControlsVisibleElementsProperties;
 }
 
@@ -11,6 +16,7 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
  * The visible elements that are displayed within the widget.
  * This provides the ability to turn individual elements of the widget's display on/off.
  *
+ * @since 5.0
  * @example
  * // This removes the feature enabled snapping toggle and the layerlist.
  * editor.visibleElements = {
@@ -22,78 +28,105 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
  */
 export default abstract class VisibleElements extends Accessor {
   /**
-   * _Since 4.28_. Indicates whether to display the "create features" section of the widget in the default view.
+   * Indicates whether to display the "create features" section of the widget in the default view.
    *
    * @default true
+   * @since 4.28
+   * @since 5.0
    */
   accessor createFeaturesSection: boolean;
   /**
-   * _Since 4.28_. Indicates whether to display the "edit features" section of the widget in the default view.
+   * Indicates whether to display the "edit features" section of the widget in the default view.
    *
    * @default true
+   * @since 4.28
+   * @since 5.0
    */
   accessor editFeaturesSection: boolean;
   /**
-   * _Since 4.32_. Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The widget will be displayed within its original flow component if set to `true`. The flow component will be omitted from the widget if set to `false`. To place the widget into an existing Calcite flow component, set this property to `false`.
+   * Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The widget will be displayed within its original flow component if set to `true`. The flow component will be omitted from the widget if set to `false`. To place the widget into an existing Calcite flow component, set this property to `false`.
    *
    * @default true
+   * @since 4.32
+   * @since 5.0
    */
   accessor flow: boolean;
   /**
-   * _Since 4.29_. Indicates whether to display the sketch labels toggle. Default value is `true`.
+   * Indicates whether to display the sketch labels toggle. Default value is `true`.
    *
    * @default true
+   * @since 4.29
+   * @since 5.0
    */
   accessor labelsToggle: boolean;
   /**
-   * _Since 4.34_. Indicates whether to display the "Merge features" button in contexts where that command is available. Default value is `true`.
+   * Indicates whether to display the "Merge features" button in contexts where that command is available. Default value is `true`.
    *
    * @default true
+   * @since 4.34
+   * @since 5.0
    */
   accessor mergeButton: boolean;
   /**
-   * _Since 4.30_. Indicates whether to display the settings menu. This menu contains the snapping and tooltips settings.
+   * Indicates whether to display the settings menu. This menu contains the snapping and tooltips settings.
    *
    * @default true
+   * @since 4.30
+   * @since 5.0
    */
   accessor settingsMenu: boolean;
   /**
-   * _Since 4.32_. Determines whether the widget should display an embedded Sketch widget to provide graphical controls for choosing drawing tools.
+   * Determines whether the widget should display an embedded Sketch widget to provide graphical controls for choosing drawing tools.
    *
    * @default true
+   * @since 4.32
+   * @since 5.0
    */
   accessor sketch: boolean;
   /**
    * Indicates whether to display the `SnappingControls` widget. Default is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor snappingControls: boolean;
-  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  /**
+   * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget.
+   *
+   * @since 5.0
+   */
   get snappingControlsElements(): SnappingControlsVisibleElements;
   set snappingControlsElements(value: SnappingControlsVisibleElementsProperties);
   /**
-   * _Since 4.34_. Indicates whether to display the "Split" button in contexts where that command is available. Default value is `true`.
+   * Indicates whether to display the "Split" button in contexts where that command is available. Default value is `true`.
    *
    * @default true
+   * @since 4.34
+   * @since 5.0
    */
   accessor splitButton: boolean;
   /**
-   * _Since 4.29_. Indicates whether to display the tooltips toggle. Default value is `true`.
+   * Indicates whether to display the tooltips toggle. Default value is `true`.
    *
    * @default true
+   * @since 4.29
+   * @since 5.0
    */
   accessor tooltipsToggle: boolean;
   /**
-   * _Since 4.32_. Indicates whether to display undo/redo buttons in the embedded Sketch toolbar. Default value is `true`.
+   * Indicates whether to display undo/redo buttons in the embedded Sketch toolbar. Default value is `true`.
    *
    * @default true
+   * @since 4.32
+   * @since 5.0
    */
   accessor undoRedoButtons: boolean;
   /**
-   * _Since 4.32_. Indicates whether to display the "Zoom to" button when creating and editing features. Default value is `true`.
+   * Indicates whether to display the "Zoom to" button when creating and editing features. Default value is `true`.
    *
    * @default true
+   * @since 4.32
+   * @since 5.0
    */
   accessor zoomToButton: boolean;
 }

package/widgets/Editor/support/EditorEditingCapabilities.d.ts

@@ -4,24 +4,61 @@ import type { EditingCapabilitiesProperties } from "../../../layers/support/Edit
 import type { AttachmentCapabilities, CreateCapabilities, DeleteCapabilities, RelationshipCapabilities, UpdateCapabilities } from "../../../layers/support/types.js";
 import type { LayerInfo } from "../types.js";
 
+/** @since 5.0 */
 export interface EditorEditingCapabilitiesProperties extends EditingCapabilitiesProperties, Partial<Pick<EditorEditingCapabilities, "layerInfo">> {}
 
-/** The current editing capabilities for the provided layer and read by the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html). This takes into account what is set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo) */
+/**
+ * The current editing capabilities for the provided layer and read by the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html). This takes into account what is set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo)
+ *
+ * @since 5.0
+ */
 export default abstract class EditorEditingCapabilities extends EditingCapabilities {
-  /** Specific permissions for attachment operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+  /**
+   * Specific permissions for attachment operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+   *
+   * @since 5.0
+   */
   get attachments(): AttachmentCapabilities;
-  /** Specific permissions for create operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+  /**
+   * Specific permissions for create operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+   *
+   * @since 5.0
+   */
   get create(): CreateCapabilities;
-  /** The default editing capabilities for the provided layer. This does not take into account what may be set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo) settings. */
+  /**
+   * The default editing capabilities for the provided layer. This does not take into account what may be set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo) settings.
+   *
+   * @since 5.0
+   */
   get defaults(): EditingCapabilities;
-  /** Specific permissions for delete operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+  /**
+   * Specific permissions for delete operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+   *
+   * @since 5.0
+   */
   get delete(): DeleteCapabilities;
-  /** The primary form template in use. It takes into account the Editor's [layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) and whether a form template is set on a `layerInfo` within it. If so, the form template set on a [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) within the Editor takes precedence over a form template set directly on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html). A form template set within the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget's [layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) takes priority over a form template set directly on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html). */
+  /**
+   * The primary form template in use. It takes into account the Editor's [layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) and whether a form template is set on a `layerInfo` within it. If so, the form template set on a [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) within the Editor takes precedence over a form template set directly on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html). A form template set within the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget's [layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) takes priority over a form template set directly on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html).
+   *
+   * @since 5.0
+   */
   get formTemplate(): FormTemplate | null | undefined;
-  /** The layer's associated [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) . */
+  /**
+   * The layer's associated [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) .
+   *
+   * @since 5.0
+   */
   accessor layerInfo: LayerInfo | null | undefined;
-  /** Indicates if the layer contains at least one relationship in addition to child [Workflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) permissions. It takes into account what is set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo). It does not take into account whether a parent or related layer has the ability to edit. A collection of all [EditorItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html) that represent potential related layers should be referenced if accessing editing permissions per related layer. */
+  /**
+   * Indicates if the layer contains at least one relationship in addition to child [Workflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) permissions. It takes into account what is set on the [EditorItem#layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html#layerInfo). It does not take into account whether a parent or related layer has the ability to edit. A collection of all [EditorItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html) that represent potential related layers should be referenced if accessing editing permissions per related layer.
+   *
+   * @since 5.0
+   */
   get relationship(): RelationshipCapabilities;
-  /** Specific permissions for update operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+  /**
+   * Specific permissions for update operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+   *
+   * @since 5.0
+   */
   get update(): UpdateCapabilities;
 }

package/widgets/Editor/types.d.ts

@@ -18,18 +18,24 @@ import type { EditableLayerUnion } from "../../layers/types.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. */
+/**
+ * Configurations used for setting the layer's editable preferences within the Editor.
+ *
+ * @since 5.0
+ */
 export interface LayerInfo {
   /**
    * Indicates whether to enable the ability to create new features.
    *
    * @default true
+   * @since 5.0
    */
   addEnabled?: boolean;
   /**
    * _(Since 4.26)_ Indicates whether to enable or disable attachments while creating features. Support for this is dependent upon whether this operation is supported on the [FeatureLayer.capabilities.operations](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities).
    *
    * @default true
+   * @since 5.0
    */
   attachmentsOnCreateEnabled?: boolean;
   /**
@@ -40,133 +46,252 @@ export interface LayerInfo {
    * > The Editor will not display attachment file names if it is displaying image types. These images must have resize support within its corresponding [FeatureLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities), ie. `FeatureLayer.capabilities.attachment.supportsResize` is `true`. Attachment types, other than images, will display an icon and its corresponding file name.
    *
    * @default true
+   * @since 5.0
    */
   attachmentsOnUpdateEnabled?: boolean;
   /**
    * Indicates whether to enable or disable attribute updates from the feature's form.
    *
    * @default true
+   * @since 5.0
    */
   attributeUpdatesEnabled?: boolean;
   /**
    * Indicates whether to enable the ability to delete features.
    *
    * @default true
+   * @since 5.0
    */
   deleteEnabled?: boolean;
   /**
    * Indicates whether to enable editing on the layer.
    *
    * @default true
+   * @since 5.0
    */
   enabled?: boolean;
-  /** A template that defines the feature's form content. Use this when setting the fields for editing. */
+  /**
+   * A template that defines the feature's form content. Use this when setting the fields for editing.
+   *
+   * @since 5.0
+   */
   formTemplate?: FormTemplate;
   /**
    * Indicates whether to enable or disable geometry updates.
    *
    * @default true
+   * @since 5.0
    */
   geometryUpdatesEnabled?: boolean;
-  /** The associated layer containing the fields to edit. */
+  /**
+   * The associated layer containing the fields to edit.
+   *
+   * @since 5.0
+   */
   layer: EditorLayerUnion;
   /**
    * Indicates whether to enable the ability to update existing features.
    *
    * @default true
+   * @since 5.0
    */
   updateEnabled?: boolean;
 }
 
-/** This object provides required and optional properties needed when creating a new feature. */
+/**
+ * This object provides required and optional properties needed when creating a new feature.
+ *
+ * @since 5.0
+ */
 export interface CreationInfo {
-  /** The associated [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry for the newly-created feature. This property is only applicable when editing [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html). */
+  /**
+   * The associated [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry for the newly-created feature. This property is only applicable when editing [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html).
+   *
+   * @since 5.0
+   */
   geometryToPlace?: Mesh | null;
-  /** The initial feature used when you begin creating features. */
+  /**
+   * The initial feature used when you begin creating features.
+   *
+   * @since 5.0
+   */
   initialFeature?: Graphic;
-  /** The associated layer for newly-created feature. */
+  /**
+   * The associated layer for newly-created feature.
+   *
+   * @since 5.0
+   */
   layer: EditorLayerUnion;
-  /** The maximum amount of feature to create in one batch editing operation. */
+  /**
+   * The maximum amount of feature to create in one batch editing operation.
+   *
+   * @since 5.0
+   */
   maxFeatures?: number;
-  /** The associated feature template used to create new features. */
+  /**
+   * The associated feature template used to create new features.
+   *
+   * @since 5.0
+   */
   template?: AnyEditingTemplateInfo;
 }
 
+/** @since 5.0 */
 export type EditorLayerUnion = Exclude<EditableLayerUnion, SubtypeGroupLayer | CatalogFootprintLayer> | SubtypeSublayer | KnowledgeGraphSublayer;
 
+/** @since 5.0 */
 export type State = "add-association-select-layer" | "add-association-select-feature" | "add-association-create-association" | "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "choosing-key-feature" | "creating-features" | "disabled" | "drawing-splitter-geometry" | "editing-attributes" | "editing-attachment" | "editing-existing-feature" | "editing-features" | "ready" | "reviewing-features" | "viewing-selection-list";
 
+/** @since 5.0 */
 export type AttachmentsProperties = Partial<Pick<Attachments, "displayType" | "capabilities">>;
 
+/** @since 5.0 */
 export type FeatureFormProperties = Partial<Pick<FeatureForm, "groupDisplay">>;
 
+/** @since 5.0 */
 export type FeatureTemplatesProperties = Partial<Pick<FeatureTemplates, "groupBy" | "visibleElements" | "enableListScroll">>;
 
+/** @since 5.0 */
 export type SketchProperties = Partial<Pick<SketchViewModel, "defaultUpdateOptions" | "pointSymbol" | "polygonSymbol" | "polylineSymbol" | "updateOnGraphicClick">>;
 
-/** Set this to customize any supporting Editor widget's default behavior. Specific properties can be adjusted in the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html), [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html), and [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widgets. In addition, it is possible to update specific properties within the [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html). */
+/**
+ * Set this to customize any supporting Editor widget's default behavior. Specific properties can be adjusted in the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html), [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html), and [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widgets. In addition, it is possible to update specific properties within the [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html).
+ *
+ * @since 5.0
+ */
 export interface SupportingWidgetDefaults {
-  /** An object containing properties specific for customizing the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html) widget. */
+  /**
+   * An object containing properties specific for customizing the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html) widget.
+   *
+   * @since 5.0
+   */
   attachments?: AttachmentsProperties;
-  /** An object containing properties specific for customizing the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. */
+  /**
+   * An object containing properties specific for customizing the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget.
+   *
+   * @since 5.0
+   */
   featureForm?: FeatureFormProperties;
-  /** An object containing properties specific for customizing the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. */
+  /**
+   * An object containing properties specific for customizing the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget.
+   *
+   * @since 5.0
+   */
   featureTemplates?: FeatureTemplatesProperties;
-  /** An object containing properties specific for customizing the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) widget. */
+  /**
+   * An object containing properties specific for customizing the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) widget.
+   *
+   * @since 5.0
+   */
   sketch?: SketchProperties;
 }
 
+/** @since 5.0 */
 export interface FailedOperation {
-  /** The read-only error message. */
+  /**
+   * The read-only error message.
+   *
+   * @since 5.0
+   */
   readonly error: EsriError;
 }
 
+/** @since 5.0 */
 export type CreateFeaturesWorkflowStep = Extract<State, "awaiting-feature-creation-info" | "creating-features" | "adding-attachment" | "editing-attachment">;
 
+/** @since 5.0 */
 export type CreateFeatureState = "create-new" | "update-pending";
 
+/** @since 5.0 */
 export type MergeFeaturesWorkflowStep = "choosing-key-feature";
 
+/** @since 5.0 */
 export type UpdateFeaturesWorkflowStep = "editing-features";
 
+/** @since 5.0 */
 export type SplitFeatureWorkflowStep = "drawing-splitter-geometry" | "reviewing-features";
 
+/** @since 5.0 */
 export type UpdateWorkflowStep = Extract<State, "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "editing-existing-feature" | "adding-attachment" | "editing-attachment">;
 
+/** @since 5.0 */
 export interface CancelWorkflowOptions {
-  /** Indicates whether to display a prompt indicating canceling the active workflow. */
+  /**
+   * Indicates whether to display a prompt indicating canceling the active workflow.
+   *
+   * @since 5.0
+   */
   emitCancelEvent?: boolean;
-  /** The returned Error object. */
+  /**
+   * The returned Error object.
+   *
+   * @since 5.0
+   */
   error?: EsriError;
-  /** Indicates whether to force cancel the active workflow. */
+  /**
+   * Indicates whether to force cancel the active workflow.
+   *
+   * @since 5.0
+   */
   force?: boolean;
 }
 
-/** This object provides information required when updating a set of features. */
+/**
+ * This object provides information required when updating a set of features.
+ *
+ * @since 5.0
+ */
 export interface FeatureInfo {
-  /** The layer containing features. */
+  /**
+   * The layer containing features.
+   *
+   * @since 5.0
+   */
   layer: EditorLayerUnion;
-  /** The object identifiers for features being edited */
+  /**
+   * The object identifiers for features being edited
+   *
+   * @since 5.0
+   */
   objectIds: ObjectId[];
 }
 
+/** @since 5.0 */
 export interface EditorSketchEventBase {
-  /** The layer currently being edited. */
+  /**
+   * The layer currently being edited.
+   *
+   * @since 5.0
+   */
   layer: EditorLayerUnion;
 }
 
+/** @since 5.0 */
 export interface EditorSketchCreateEvent extends EditorSketchEventBase {
-  /** Detailed information returned within the "sketch-create" event. */
+  /**
+   * Detailed information returned within the "sketch-create" event.
+   *
+   * @since 5.0
+   */
   detail: SketchViewModelEvents["create"];
+  /** @since 5.0 */
   type: "sketch-create";
 }
 
+/** @since 5.0 */
 export interface EditorSketchUpdateEvent extends EditorSketchEventBase {
-  /** Detailed information returned within the "sketch-update" event. */
+  /**
+   * Detailed information returned within the "sketch-update" event.
+   *
+   * @since 5.0
+   */
   detail: SketchViewModelEvents["update"];
+  /** @since 5.0 */
   type: "sketch-update";
 }
 
+/** @since 5.0 */
 export type SplitterGeometry = Point | Polyline | Polygon;
 
+/** @since 5.0 */
 export type SplitterGeometryType = "point" | "polyline" | "polygon";

package/widgets/ElevationProfile/ElevationProfileVisibleElements.d.ts

@@ -1,6 +1,9 @@
 import type Accessor from "../../core/Accessor.js";
 
-/** @deprecated since version 5.0. Use the [Elevation Profile component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/). */
+/**
+ * @deprecated since version 5.0. Use the [Elevation Profile component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
+ */
 export interface ElevationProfileVisibleElementsProperties extends Partial<Pick<ElevationProfileVisibleElements, "chart" | "clearButton" | "legend" | "selectButton" | "settingsButton" | "sketchButton" | "uniformChartScalingToggle" | "unitSelector">> {}
 
 /**
@@ -10,54 +13,63 @@ export interface ElevationProfileVisibleElementsProperties extends Partial<Pick<
  * These are all set to true by default.
  *
  * @deprecated since version 5.0. Use the [Elevation Profile component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/) instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
+ * @since 5.0
  */
 export default abstract class ElevationProfileVisibleElements extends Accessor {
   /**
    * When set to `false`, the chart is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor chart: boolean;
   /**
    * When set to `false` the button used to clear the current elevation profile is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor clearButton: boolean;
   /**
    * When set to `false`, the legend (which includes statistics) is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor legend: boolean;
   /**
    * When set to `false`, the button used to select a path is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor selectButton: boolean;
   /**
    * When set to `false`, the button used to open the settings popup is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor settingsButton: boolean;
   /**
    * When set to `false`, the button used to start drawing/sketching is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor sketchButton: boolean;
   /**
    * When set to `false`, the element used to toggle uniform chart scaling on or off is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor uniformChartScalingToggle: boolean;
   /**
    * When set to `false`, the dropdown used to select the units is not displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor unitSelector: boolean;
 }