import type Input from "./Input.js";
import type { InputMethod } from "../../../../portal/jsonTypes.js";

/** @experimental */
export interface SignatureInputProperties extends Partial<Pick<SignatureInput, "inputMethod">> {}

/**
 * The `SignatureInput` class defines a user interface for an input to which a signature can be attached. This [AttachmentElement#input](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-AttachmentElement.html#input) is used in [attachment elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-AttachmentElement.html) that are set within a [feature layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or [FeatureForm's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) `formTemplate`. This is displayed within the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget.
 *
 * > [!CAUTION]
 * >
 * > This class is not yet fully supported within the SDK and is not intended for use in development. Support will be added in an upcoming release.
 *
 * @experimental
 * @since 4.31
 * @see [SignatureInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-attachments-SignatureInput.html)
 * @example
 * // Creates a new SignatureInput for an attachment element within a form
 * const signatureInput = new SignatureInput({
 *   inputMethod: "capture",
 * });
 */
export default class SignatureInput extends Input {
  /** @experimental */
  constructor(properties?: SignatureInputProperties);
  /**
   * The supported input methods used to attach a signature.
   *
   * @default "any"
   * @experimental
   */
  accessor inputMethod: InputMethod;
  /**
   * The input type identifier. Valid value of this property is "signature"
   *
   * @default "signature"
   * @experimental
   */
  get type(): "signature";
}