import type Graphic from "../Graphic.js";
import type Collection from "../core/Collection.js";
import type SketchLabelOptions from "../views/interactive/sketch/SketchLabelOptions.js";
import type SketchTooltipOptions from "../views/interactive/sketch/SketchTooltipOptions.js";
import type SketchValueOptions from "../views/interactive/sketch/SketchValueOptions.js";
import type SnappingOptions from "../views/interactive/snapping/SnappingOptions.js";
import type Widget from "./Widget.js";
import type EditorViewModel from "./Editor/EditorViewModel.js";
import type VisibleElements from "./Editor/VisibleElements.js";
import type EditorItem from "./Editor/support/EditorItem.js";
import type { Icon } from "@esri/calcite-components/components/calcite-icon";
import type { MapViewOrSceneView } from "../views/MapViewOrSceneView.js";
import type { WidgetProperties } from "./Widget.js";
import type { EditorViewModelEvents, EditorViewModelProperties } from "./Editor/EditorViewModel.js";
import type { CreationInfo, FeatureInfo, LayerInfo, SplitFeatureWorkflowStep, SupportingWidgetDefaults, SplitterGeometryType, SplitterGeometry } from "./Editor/types.js";
import type { HeadingLevel } from "./support/types.js";
import type { SketchLabelOptionsProperties } from "../views/interactive/sketch/SketchLabelOptions.js";
import type { SnappingOptionsProperties } from "../views/interactive/snapping/SnappingOptions.js";
import type { SketchTooltipOptionsProperties } from "../views/interactive/sketch/SketchTooltipOptions.js";
import type { SketchValueOptionsProperties } from "../views/interactive/sketch/SketchValueOptions.js";
import type { VisibleElementsProperties } from "./Editor/VisibleElements.js";

export interface EditorProperties extends WidgetProperties, Partial<Pick<Editor, "headingLevel" | "layerInfos" | "supportingWidgetDefaults" | "syncViewSelection" | "syncWithViewSelectionManager" | "view">> {
  /**
   * Icon which represents the widget. It is typically used when the widget is controlled by another
   * one (e.g. in the Expand widget).
   *
   * @default "pencil"
   * @since 4.27
   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  icon?: Icon["icon"] | null;
  /**
   * The widget's default label.
   *
   * @since 4.11
   */
  label?: string | null;
  /**
   * Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
   *
   * > [!WARNING]
   * >
   * > **Known Limitation**
   * >
   * > Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
   *
   * @since 4.24
   */
  labelOptions?: SketchLabelOptionsProperties;
  /**
   * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing. Supports self snapping and feature snapping. Starting with version 4.23, the [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) UI is automatically integrated into the Editor widget.
   * Modify the `snappingOptions` if modifications are needed from what is provided in the default UI.
   *
   * @since 4.19
   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
   * @example
   * // Creates the Editor with SnappingOptions with no snapping UI
   * const editor = new Editor({
   *   view: view,
   *   snappingOptions: { // autocasts to SnappingOptions()
   *     enabled: true,
   *     featureSources: [{layer: streetsLayer}] // autocasts to FeatureSnappingLayerSource()
   *   }
   * });
   *
   * // Add the widgets to the view
   * view.ui.add(editor, "top-right");
   */
  snappingOptions?: SnappingOptionsProperties;
  /**
   * Options to configure the tooltip shown next to the cursor when creating or updating graphics.
   *
   * @since 4.24
   */
  tooltipOptions?: SketchTooltipOptionsProperties;
  /**
   * Options to configure how values are displayed and input when creating or updating graphics.
   *
   * @since 4.29
   */
  valueOptions?: SketchValueOptionsProperties;
  /**
   * The view model for this widget. This is a class that contains all the logic
   * (properties and methods) that controls this widget's behavior. See the
   * [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) class to access
   * all properties and methods on the widget.
   */
  viewModel?: EditorViewModelProperties;
  /**
   * The visible elements that are displayed within the widget.
   * This property provides the ability to turn individual elements of the widget's display on/off.
   *
   * @since 4.25
   * @example
   * editor.visibleElements = {
   *   snappingControls: true,
   *   snappingControlsElements: {
   *     featureEnabledToggle: false, // removes "Feature to feature" toggle
   *     layerList: false // removes Snapping layers list
   *   }
   * };
   */
  visibleElements?: VisibleElementsProperties;
}

export interface EditorEvents extends EditorViewModelEvents {}

/**
 * * [Overview](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#overview)
 * * [Editor workflows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#editor-workflows)
 * * [SceneLayer editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#scenelayer-editing)
 * * [Snapping in the Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snapping)
 * * [Tooltips and editing constraints](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltips-editing-constraints)
 * * [Relationship editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#relationship-editing)
 * * [Association editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#association-editing)
 * * [Editing date and time](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#date-time)
 * * [Editing big integer data](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#big-int)
 * * [Elevated user privileges](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#elevated-privs)
 * * [Suggestions and known limitations](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#limits)
 *
 * <span id="overview"></span>
 * ## Overview
 * This widget provides an out-of-the-box editing experience to help streamline editing within a web application. It automatically recognizes if there are editable feature layers within the map. The layers that are editable will automatically be used by the widget. It is possible to configure how the `Editor` behaves by setting its
 * [layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos) property.
 * This property takes an array of objects which allows configuring the the editing experience for these layers.
 *
 * ![editor](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/editor/editor-in-action2.gif)
 *
 * Note that the update operations (such as rotate, move, and transform) happen in the map space.
 * This means that, for example in 3D, if a graphic is rotated in a global WGS84 view, its shape and segment lengths change.
 *
 * <span id="editor-workflows"></span>
 * ## Editor workflows
 *
 * The widget has different [workflows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) based on the functionality needed. These workflows are dependent upon permissions set on the service or within the client application.
 *
 * * [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) -  This workflow allows both individual and continuous feature creation at once. It is possible to continuously create multiple features of the same type at once. After the initial sketch is created, the attribute form will display with the set field elements. These fields can be updated as the user creates new features.
 * * [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) - This workflow allows you to update and/or delete existing features within an editable feature layer.
 *
 * <span id="scenelayer-editing"></span>
 * ## SceneLayer editing
 *
 * Since 4.27, it is possible to upload 3D models of various formats to an editable [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html).
 *
 * The following model formats are currently supported. For additional information, please refer to the [ArcGIS Pro documentation](https://pro.arcgis.com/en/pro-app/latest/help/data/3d-objects/what-is-a-3d-object-feature-class-.htm).
 * Please note that only one model can be uploaded at a time and zip files should be used for a model with additional texture files.
 *
 *  * COLLADA (.dae)
 *  * Autodesk Filmbox (.fbx)
 *  * Autodesk Drawing (.dwg)
 *  * Industry Foundation Classes (.ifc)
 *  * Universal Scene Description (.usdc, .usdz)
 *  * Wavefront (.obj)
 *  * GL Transmission Format (.glTF)
 *  * Binary GL Transmission Format (.glb)
 *
 * <span id="snapping"></span>
 * ## Snapping in the Editor
 *
 * Snapping can be configured using the controls in the Editor widget's "Settings" menu. By default,
 * snapping is disabled. Toggle "Enable snapping" to enable it. By default, both geometry guides
 * and feature-to-feature snapping are enabled.
 *
 * Geometry guides allow the editor to specify how
 * they want their geometries to be drawn. For example, when the segment being drawn is nearly
 * perpendicular to another segment, the cursor may snap to form a precise right angle.
 *
 * Feature-to-feature snapping allows new or existing geometries to be snapped to other geometries,
 * including those in other layers, as shown within the "Snapping layer" list. By default, all layers
 * that can be configured for snapping are shown in this list. The available layers can be restricted
 * by updating the Editor's [snappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions) by
 * setting the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) directly.
 *
 * <span id="tooltips-editing-constraints"></span>
 * ## Tooltips and editing constraints
 *
 * The tooltips provide useful information about a feature or its components (vertices and segments) that
 * are being drawn or edited. For example, they show the position of vertices, the direction and distance
 * of segments, as well as orientation and scale of meshes.
 *
 * The [tooltips](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltipOptions) can be enabled in the Editor widget's "Settings" menu.
 *
 * Coordinate inputs and editing constraints are helpful to achieve greater control while drawing features.
 * Press `Tab` to activate the input mode while drawing a new feature, or when editing a point, mesh, or a selected vertex.
 *
 * See more about the available tooltip inputs and constraints under the [tooltip options](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html) class.
 *
 * ![editing constraints](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/editor/editing-constraints.gif)
 *
 * <span id="relationship-editing"></span>
 * ## Relationship editing
 *
 * It is possible to edit related data via the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. The [relationship element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) provides the functionality needed to configure the relationship within the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). These elements must be saved within the form for the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) to support editing related data. This can be accomplished via the Map Viewer's [authoring experience](https://doc.arcgis.com/en/arcgis-online/create-maps/create-form-mv.htm) or programmatically using the SDK.
 *
 * Once the form is authored, the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) automatically checks if there is a [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) set on the editable [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate), or the widget's corresponding [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo). If the form's template is not set or is not configured to contain [relationship elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html), the Editor will not display the option to edit the relationship data. Additional considerations when using the Editor to edit related data are provided below.
 *
 * ![editing related records with the Editor widget](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/428/ff-related-features.gif)
 *
 * <details>
 * <summary>Read More</summary>
 *
 * **Considerations when editing related data in the Editor**
 *
 * * Support is limited to 1:1 and 1:M cardinality.
 * * Support is limited to feature-to-table and feature-to-feature relationships, ie. origin-to-destination. The origin's entry point must be a feature with geometry.
 * * Relationship editing is only supported using ArcGIS Online and ArcGIS Enterprise version 11.2 or higher feature services.
 * * The layer and associated [relationship elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) must be editable in order for the relationship to display.
 * * The origin (parent) feature must be editable in order to edit the related destination (child) feature/row.
 * * Data containing related records will display the relationship in the associated form as long as there is a [relationship element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) configured in the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) formTemplate. This can be accomplished via the Map Viewer's [authoring experience](https://doc.arcgis.com/en/arcgis-online/create-maps/create-form-mv.htm), [Field Maps Designer](https://learn.arcgis.com/en/projects/build-a-form-with-field-maps-designer), or programmatically using the API.
 * * The related layer or table must also be added to the map to be able to configure [relationship elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html).
 * * Editing relationships on layers with preset and group templates are not yet supported.
 *
 * </details>
 *
 * <span id="association-editing"></span>
 * ## Association editing
 *
 * To enable support for editing associated features in Editor, the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) must include one or more [association elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html). This can be achieved through the Map Viewer's authoring experience or programmatically via the SDK. Editing associated features is exclusively supported within [UtilityNetworks](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html).
 *
 * Once the form is created, the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) checks if a [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) is assigned to the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or the widget's [LayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo). If the form's template lacks the necessary [association elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html), the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) will not display associated features or options to edit them. Also, if an associated feature exists on a layer and that layer is not included in the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) being used, the associated feature will not be shown in Editor.
 *
 * ![editing associated features with the Editor widget](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/432/ff-associated-features.gif)
 *
 * <span id="adding-associations"></span>
 * ### Creating associations
 *
 * If the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) includes one or more [association elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html),
 * [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) will provide the option to create new associations between the
 * selected feature and another feature on the map. Only types specified in the `formTemplate` association
 * elements can be used for new associations.
 *
 * To create an association involving the selected feature, navigate to the association type desired
 * for the new association and click "Add" below the list of associated layers.
 * Select the layer containing the feature to form an association with, then select a feature within that layer.
 *
 * The layers and features shown in the list are those that are compatible with the selected feature and
 * association type based on [utility network rules](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/network-rules.htm).
 *
 * After choosing a feature to form the association with, settings specific to the association type can be
 * configured, e.g., midspan location for [connectivity associations](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/connectivity.htm).
 *
 * Click "Add" to create the association.
 *
 * ![creating a new association with the Editor widget](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/432/ff-add-association.gif)
 *
 * Alternatively, if compatible layers are visible on the map, a feature can be selected on the map using a spatial selection toolbar.
 * Features can be selected at a single point or within a region. Any compatible features at the selected point or within the defined region are displayed in a list.
 * Hover over a feature in the list to highlight it on the map; click a feature in the list to choose the feature to form the association with.
 *
 * ![spatially selecting a feature to form an association with](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/433/spatial-selection-demo-small.gif)
 *
 * While viewing compatible features on a layer, filters can optionally be used to find a specific feature to form an association with.
 *
 * ![creating a new association with attribute filter with the Editor widget](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/432/ff-add-association-filter.gif)
 *
 * <span id="deleting-associations"></span>
 * ### Deleting associations
 *
 * When viewing an associated feature, the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget provides a dropdown next to "Delete".
 * Click the dropdown, then choose "Delete association". Confirm your choice to delete the association between the feature
 * you initially selected and the feature you are now viewing.
 *
 * <details>
 * <summary>Read More</summary>
 *
 * **Considerations when deleting associations in the Editor**
 *
 * * For the option to delete an association to display, the feature's layer must support deletions.
 * * Support is limited to feature-to-table and feature-to-feature associations, ie. origin-to-destination. The origin's entry point must be a feature with geometry.
 * * To delete a [containment association](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/containment.htm): Select the container feature, navigate to the content feature, then delete the association. Alternatively, select the content feature, navigate to the container feature, then delete the association.
 * * To delete a [connectivity association](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/connectivity.htm): Select one of the connected features, navigate to the other connected feature, then delete the association.
 * * To delete a [structural attachment association](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/structural-attachments.htm): Select the structure feature, navigate to the attached feature, then delete the association. Alternatively, select the attached feature, navigate to the structure feature, then delete the association.
 *
 * </details>
 *
 * If the deletion was successful, the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget will return to the list of associated
 * features for the chosen layer. If no associated features remain on that layer, the widget will return to the list of layers.
 * If the selected feature is no longer involved in any associations, the widget returns to the selected feature.
 *
 * While viewing associated features on a layer, a search bar can optionally be used to filter by the title of the
 * feature shown in the list.
 *
 * ![deleting an association with the Editor widget](https://developers.arcgis.com/javascript/latest/assets/img/guide/whats-new/432/ff-delete-association.gif)
 *
 * <span id="date-time"></span>
 * ## Editing date and time
 *
 * The Editor displays the `date` field [Field.type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) in
 * the MapView's [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) by default.
 * However, when working with the `timestamp-offset` type, the data is displayed using the stored date
 * values from the service. For example, if the stored value is `2023-09-11T22:39:05.242-0400`, then
 * the Editor will present three inputs to edit the date (`9/11/2023`), time (`10:39:05 PM`), and time
 * zone offset (`GMT-4`) regardless of the MapView time zone.
 *
 * Here are a few points to consider if using an `unknown` timezone:
 * * The layer's setting takes priority over the view. For example, if a layer's timezone is `unknown`,
 * both `date` and `timestamp-offset` field types are shown in UTC.
 * * If a view's timezone is set to to `unknown`, but a layer has a [FeatureLayer.preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone), `date` field types will display values with the preferred time zone that is set within the layer.
 * *  If a view **and layer's** timezone are set to `unknown`, `date` field types will display values using UTC.
 * If a view's timezone is set to to `unknown` and working with `timestamp-offset` field types, date is
 * shown as-is, ie. as it's stored within the raw data.
 *
 * <span id="big-int"></span>
 * ## Editing big integer data
 *
 * The `big-integer` data type is a 64-bit signed integer that can store very large whole number
 * integer values with the range of `-9007199254740991` and `9007199254740991`.
 * Web applications can only edit whole numbers between `-9007199254740991` and `9007199254740991`.  Any
 * attempts to edit a number value higher or lower than these thresholds will not work and those edits
 * will not be saved.
 *
 * <span id="elevated-privs"></span>
 * ## Elevated user privileges
 *
 * Authenticated users that are layer owners, administrators or users with full editing privileges will have their elevated user privileges applied in regards to editing behavior and data access. This mimics the behavior available in [Map Viewer](https://www.arcgis.com/apps/mapviewer/index.html). To opt out, set [esriConfig.userPrivilegesApplied](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#ConfigWithUserPrivilegesApplied) to `false`.
 *
 * <span id="limits"></span>
 * ## Suggestions and known limitations
 *
 * * It is not recommended to set a very small [FeatureLayer.refreshInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#refreshInterval) on an editable layer as this can potentially degrade performance within the application.
 * * Editor [workflows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) are only enabled if the feature service allows these operations. In addition, if wanting to completely remove the ability to select and update, it is necessary to also set `attachmentsOnUpdateEnabled: false` in `layerInfo.attachmentsOnUpdateEnabled`.
 * * If a layer's feature template is not enabled within the Editor, check that the layer's permissions are enabled for editing. In addition, make sure that the layer is visible. If the feature template does not display, make sure that the layer is fully loaded in the map and that the Editor has access to edit it.
 * * Batch attribute editing is limited to single layers.
 * * Support for batch attribute editing is not yet supported for relationship and association data.
 * * Configuring form templates for batch attribute editing is not yet supported.
 * * Text elements are not recognized within batch attribute forms.
 * * No support for contingent attribute values.
 * * There is a limit of 500 features if a layer does not have a corresponding [form template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html).
 * * There is a limit of 500 features for layers that do have a corresponding [form template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) but contains no complex asynchronous Arcade expressions.
 * * There is a limit of 50 features for layers that have a corresponding [form template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) containing complex asynchronous Arcade expressions.
 *
 * @deprecated since version 5.0. Use the [Editor](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/) component instead. For information on widget deprecation, read about [Esri's move to web components](https://developers.arcgis.com/javascript/latest/components-transition-plan/).
 * @since 4.11
 * @see [Sample - Edit features with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-basic/)
 * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-3d/)
 * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
 * @see [Sample - Popup with edit action](https://developers.arcgis.com/javascript/latest/sample-code/popup-editaction/)
 * @see [Sample - Editing with calculated field expressions](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featureform-async/)
 * @see [Sample - SceneLayer upload 3D models and applyEdits](https://developers.arcgis.com/javascript/latest/sample-code/editing-scenelayer-applyedits/)
 * @see [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html)
 * @see [Workflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html)
 * @see [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html)
 * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
 * @see [CreateFeaturesWorkflowData](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html)
 * @see [UpdateWorkflowData](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html)
 * @see [DefaultUI](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html)
 * @see [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
 * @see [SketchLabelOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchLabelOptions.html)
 * @see [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html)
 * @see [SketchValueOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchValueOptions.html)
 * @see [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html)
 * @see [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html)
 * @example
 * // At the very minimum, set the Editor's view
 * const editor = new Editor({
 *   view: view
 * });
 *
 * view.ui.add(editor, "top-right");
 */
export default class Editor extends Widget {
  /**
   * @deprecated
   * Do not directly reference this property.
   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
   */
  "@eventTypes": EditorEvents;
  /**
   * @example
   * // Typical usage for Editor widget. By default, this will recognize all editable layers in the map if no specific layers are set. It is also possible to iterate through the map's editableLayers and load any layers needed for editing.
   *
   * const editor = new Editor({
   *   view: view
   * });
   */
  constructor(properties?: EditorProperties);
  /**
   * A property indicating the current active workflow. This is either
   * [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) or [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html).
   */
  get activeWorkflow(): EditorViewModel["activeWorkflow"] | null | undefined;
  /**
   * A predominantly read-only collection of [editor items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-support-EditorItem.html) that corresponds to the feature being updated.
   *
   * @since 5.0
   */
  get editorItems(): Collection<EditorItem>;
  /**
   * Indicates the heading level to use for title of the widget. By default, the title (i.e. "Editor") is rendered
   * as a level 4 heading (e.g. `<h4>Editor</h4>`). Depending on the widget's placement
   * in your app, you may need to adjust this heading for proper semantics. This is
   * important for meeting accessibility standards.
   *
   * @default 4
   * @since 4.20
   * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
   * @example
   * // "Editor" will render as an <h3>
   * editor.headingLevel = 3;
   */
  accessor headingLevel: HeadingLevel;
  /**
   * Icon which represents the widget. It is typically used when the widget is controlled by another
   * one (e.g. in the Expand widget).
   *
   * @default "pencil"
   * @since 4.27
   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  get icon(): Icon["icon"];
  set icon(value: Icon["icon"] | null | undefined);
  /**
   * The widget's default label.
   *
   * @since 4.11
   */
  get label(): string;
  set label(value: string | null | undefined);
  /**
   * Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
   *
   * > [!WARNING]
   * >
   * > **Known Limitation**
   * >
   * > Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
   *
   * @since 4.24
   */
  get labelOptions(): SketchLabelOptions;
  set labelOptions(value: SketchLabelOptionsProperties);
  /**
   * An array of editing configurations for individual layers. It is possible to iterate through the map's [Map.editableLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#editableLayers) and configure these individual layers as needed.
   *
   * If you have an editable feature layer but do not want
   * the end user to do any type of editing, you can limit this by
   * setting the `enabled` property to `false`.
   *
   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
   * @see [Map.editableLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#editableLayers)
   * @example
   * const editor = new Editor({
   *   view: view,
   *   layerInfos: [{
   *     layer: featureLayer, // pass in the feature layer,
   *     formTemplate:  { // autocastable to FormTemplate
   *       elements: [
   *         { // autocastable to FieldElement
   *           type: "field",
   *           fieldName: "fulladdr",
   *           label: "Full Address"
   *         }
   *       ]
   *     },
   *     enabled: true, // Default is true, set to false to disable editing functionality.
   *     addEnabled: true, // Default is true, set to false to disable the ability to add a new feature.
   *     updateEnabled: false, // Default is true, set to false to disable the ability to edit an existing feature.
   *     deleteEnabled: false, // Default is true, set to false to disable the ability to delete features.
   *     attributeUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit attributes in the update workflow.
   *     geometryUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit feature geometries in the update workflow.
   *     attachmentsOnCreateEnabled: true, //Default is true, set to false to disable the ability to work with attachments while creating features.
   *     attachmentsOnUpdateEnabled: true //Default is true, set to false to disable the ability to work with attachments while updating/deleting features.
   *   }]
   * });
   */
  accessor layerInfos: LayerInfo[] | null | undefined;
  /**
   * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing. Supports self snapping and feature snapping. Starting with version 4.23, the [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) UI is automatically integrated into the Editor widget.
   * Modify the `snappingOptions` if modifications are needed from what is provided in the default UI.
   *
   * @since 4.19
   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
   * @example
   * // Creates the Editor with SnappingOptions with no snapping UI
   * const editor = new Editor({
   *   view: view,
   *   snappingOptions: { // autocasts to SnappingOptions()
   *     enabled: true,
   *     featureSources: [{layer: streetsLayer}] // autocasts to FeatureSnappingLayerSource()
   *   }
   * });
   *
   * // Add the widgets to the view
   * view.ui.add(editor, "top-right");
   */
  get snappingOptions(): SnappingOptions;
  set snappingOptions(value: SnappingOptionsProperties);
  /**
   * This property allows customization of supporting Editor widgets and their default behavior.
   * These widgets include [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html), [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html), and the
   * [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html).
   *
   * > [!WARNING]
   * >
   * > This property is useful for basic overrides of the default widgets. There may be some limitations
   * > to what the Editor can do with these overridden properties. For example, the Editor will disable the `multipleSelectionEnabled` property in [Sketch.defaultUpdateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions)
   * > no matter what is set within this property.
   *
   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
   * @see [Sample - Editing with calculated field expressions](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featureform-async/)
   */
  accessor supportingWidgetDefaults: SupportingWidgetDefaults | null | undefined;
  /**
   * Controls whether the Editor should sync with the view's selection manager.
   * This does not include selection sources, which must be configured independently.
   * This property takes precedence over the 'selectionManager' property.
   *
   * @since 5.0
   */
  accessor syncViewSelection: boolean;
  /**
   * Controls whether the table should sync with the view's selection manager.
   * This does not include syncing selection sources, which must be configured independently.
   *
   * @internal
   */
  accessor syncWithViewSelectionManager: boolean;
  /**
   * Options to configure the tooltip shown next to the cursor when creating or updating graphics.
   *
   * @since 4.24
   */
  get tooltipOptions(): SketchTooltipOptions;
  set tooltipOptions(value: SketchTooltipOptionsProperties);
  /**
   * Options to configure how values are displayed and input when creating or updating graphics.
   *
   * @since 4.29
   */
  get valueOptions(): SketchValueOptions;
  set valueOptions(value: SketchValueOptionsProperties);
  /** A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This view provides the editable layers for the Editor widget. */
  accessor view: MapViewOrSceneView | null | undefined;
  /**
   * The view model for this widget. This is a class that contains all the logic
   * (properties and methods) that controls this widget's behavior. See the
   * [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) class to access
   * all properties and methods on the widget.
   */
  get viewModel(): EditorViewModel;
  set viewModel(value: EditorViewModelProperties);
  /**
   * The visible elements that are displayed within the widget.
   * This property provides the ability to turn individual elements of the widget's display on/off.
   *
   * @since 4.25
   * @example
   * editor.visibleElements = {
   *   snappingControls: true,
   *   snappingControlsElements: {
   *     featureEnabledToggle: false, // removes "Feature to feature" toggle
   *     layerList: false // removes Snapping layers list
   *   }
   * };
   */
  get visibleElements(): VisibleElements;
  set visibleElements(value: VisibleElementsProperties);
  /**
   * Cancels any active selection operation.
   *
   * @since 5.0
   */
  cancelSelectionTool(): void;
  /**
   * Cancels any active workflow.
   *
   * @returns Resolves once the workflow is canceled.
   */
  cancelWorkflow(): Promise<void>;
  /**
   * This is applicable if there is an active [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html). If so, this method
   * deletes the association involved with the workflow feature.
   *
   * @returns Resolves once the active [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) is deleted.
   * @since 4.32
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   */
  deleteAssociationFromWorkflow(): Promise<void>;
  /**
   * This is applicable if there is an active [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html). If so, this method
   * deletes the workflow feature.
   *
   * @deprecated since version 4.33. Use [deleteFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#deleteFeatures) instead.
   * @returns Resolves once the active [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) is deleted.
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   */
  deleteFeatureFromWorkflow(): Promise<void>;
  /**
   * If the active workflow is an
   * [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) or
   * [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateFeaturesWorkflow.html), this method
   * deletes the feature(s) associated with the workflow.
   *
   * @returns Resolves once the features have been deleted.
   * @since 4.33
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   * @see [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateFeaturesWorkflow.html)
   */
  deleteFeatures(): Promise<void>;
  /**
   * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the panel where feature(s) creation begins. This method
   * takes a [CreateFeaturesCreationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreateFeaturesCreationInfo) object containing the layer(s) and template(s) to use.
   *
   * @param creationInfo - An object containing information needed to create a new feature using the Editor widget. This object provides the feature template and layer for creating a new feature or features.
   * @returns Resolves when the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) initiates and displays the panel where feature(s) creation begins.
   * @since 4.23
   * @see [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html)
   */
  startCreateFeaturesWorkflowAtFeatureCreation(creationInfo: CreateFeaturesCreationInfo): Promise<void>;
  /**
   * This method starts the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) at the "creating-features" step with the provided feature.
   *
   * > [!WARNING]
   * >
   * > Any CreateFeaturesWorkflow instance generated by this method will only support creating a single feature per operation, (ie. batch creation is disabled).
   *
   * @param params - Parameters object containing an `initialFeature` to use in the associated CreateFeaturesWorkflow.
   * @returns Resolves once the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) initiates and displays the panel where additional edits can be made to the provided feature.
   * @since 4.29
   * @see [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html)
   */
  startCreateFeaturesWorkflowAtFeatureEdit(params: EditorStartCreateFeaturesWorkflowAtFeatureEditParameters): Promise<void>;
  /**
   * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) panel.
   *
   * @returns Resolves when the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) is initiated
   * and displays the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) panel.
   * @since 4.23
   */
  startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>;
  /**
   * Starts a [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-MergeFeaturesWorkflow.html) for the
   * specified features. All features must belong to the same layer.
   *
   * @param features - The features to be merged. These can be supplied
   * either as an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) instances or as a single
   * [FeatureInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#FeatureInfo) object specifying a layer
   * and the object IDs of the features.
   * @param options - Options for the merge features workflow.
   * @since 4.34
   * @see [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-MergeFeaturesWorkflow.html)
   */
  startMergeFeaturesWorkflow(features: Graphic[] | FeatureInfo, options?: EditorStartMergeFeaturesWorkflowOptions): Promise<void>;
  /**
   * Starts a split feature workflow for the given feature.
   *
   * @param feature - The feature to be split.
   * @param options - Options for the split feature workflow.
   * @returns Resolves once the [SplitFeatureWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-SplitFeatureWorkflow.html) has been initialized and is active.
   * @since 4.34
   */
  startSplitFeatureWorkflow(feature: Graphic, options?: EditorStartSplitFeatureWorkflowOptions): Promise<void>;
  /**
   * Starts an [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateFeaturesWorkflow.html) using
   * the provided features.
   *
   * @param features - The features to be updated. These can be supplied
   * either as an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) instances or as a single
   * [FeatureInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#FeatureInfo) object specifying a layer
   * and the object IDs of the features.
   * @returns Resolves once the
   * [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateFeaturesWorkflow.html) is initiated.
   * @since 4.33
   * @see [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateFeaturesWorkflow.html)
   */
  startUpdateFeaturesWorkflow(features: Graphic[] | FeatureInfo): Promise<void>;
  /**
   * Starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) at the attribute editing panel.
   *
   * @param feature - The feature to be updated.
   * @returns Resolves once the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) initiates the attribute editing panel.
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   * @see [Sample - Popup with edit action](https://developers.arcgis.com/javascript/latest/sample-code/popup-editaction/)
   */
  startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>;
  /**
   * Starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) using the current selected feature.
   *
   * @returns Resolves once the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) is initiated
   * using the current selected feature.
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   */
  startUpdateWorkflowAtFeatureSelection(): Promise<void>;
  /**
   * This method starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) where it waits for multiple features
   * to be selected.
   *
   * @param candidates - An array of features to be updated.
   * This is only relevant when there are multiple candidates to update.
   * @returns Resolves once the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) is initiated
   * as it waits for multiple features to be selected.
   * @see [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html)
   */
  startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): Promise<void>;
}

export interface EditorStartCreateFeaturesWorkflowAtFeatureEditParameters {
  /** The initial feature used when you begin creating features. */
  initialFeature: Graphic;
}

export interface EditorStartMergeFeaturesWorkflowOptions {
  /**
   * The feature that the other
   * features will be merged into. This feature will have its geometry updated
   * with the merged geometry. The other features will be deleted.
   */
  keyFeature?: Graphic;
}

export interface EditorStartSplitFeatureWorkflowOptions {
  /** The step to start the workflow at. */
  startAt?: SplitFeatureWorkflowStep;
  /** The preferred Sketch tool to use for drawing the splitter geometry. */
  defaultSplitterGeometryType?: SplitterGeometryType;
  /** The geometry with which to split the input geometry. This is required in order to start the workflow at the "reviewing-features" step. Otherwise, it is ignored. */
  splitterGeometry?: SplitterGeometry;
}

/** This object provides required properties needed when creating a new feature. */
export type CreateFeaturesCreationInfo = Required<Pick<CreationInfo, "layer" | "template">>;