@seniorsistemas/angular-components 19.0.5 → 19.0.6

package/dynamic-form/dynamic-form/form-field/configurations/fields/chips-field.d.ts

@@ -1,14 +1,44 @@
 import { FieldConfig } from './field';
+/**
+ * Configuração para campo de entrada de múltiplas tags (chips).
+ *
+ * Permite que o usuário insira vários valores de texto livres, visualizados como chips/tags.
+ * Cada valor é adicionado ao pressionar Enter (ou o separador configurado).
+ * O valor do campo é um array de strings.
+ *
+ * Use para e-mails, palavras-chave, códigos ou qualquer lista de valores livres.
+ */
 export interface ChipsFieldConfig extends FieldConfig {
+    /** Tipo do campo: sempre `'chips'`. */
     type: 'chips';
+    /**
+     * Expressão regular que filtra os caracteres aceitos em cada chip.
+     * @example /[a-zA-Z0-9]/ para aceitar apenas alfanuméricos
+     */
     keyFilter?: RegExp;
+    /**
+     * Caractere separador para adicionar novos chips além do Enter.
+     * @example ',' para adicionar chip ao digitar vírgula
+     */
     separator?: string;
+    /**
+     * Quando `true`, exibe um botão de copiar todos os chips para a área de transferência.
+     */
     showCopyButton?: boolean;
+    /** Callback chamado quando um novo chip é adicionado. */
     onAdd?: (event: any) => void;
+    /** Callback chamado quando um chip é removido. */
     onRemove?: (event: any) => void;
+    /** Callback chamado quando o usuário clica em um chip existente. */
     onChipClick?: (event: any) => void;
+    /** Callback chamado quando o campo recebe foco. */
     onFocus?: (event: any) => void;
+    /** Callback chamado quando o campo perde o foco. */
     onBlur?: (event: any) => void;
+    /**
+     * Callback chamado quando o usuário copia o conteúdo dos chips.
+     * Recebe o texto combinado de todos os chips.
+     */
     onCopy?: (content: string) => void;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/content-generator-field.d.ts

@@ -1,19 +1,64 @@
 import { FieldConfig } from './field';
+/**
+ * Configuração para campo de área de texto com geração de conteúdo via IA.
+ *
+ * Combina um textarea completo com recursos de:
+ * - Geração automática de texto por IA via prompt
+ * - Reconhecimento de voz (speech-to-text)
+ * - Contexto persistente entre gerações (`keepContext`)
+ *
+ * Use `type: 'contentGenerator'` para novas implementações.
+ * O tipo `'textAreaIA'` está depreciado e será removido na v20.
+ */
 export interface ContentGeneratorFieldConfig extends FieldConfig {
     /**
-     * @deprecated O tipo 'textAreaIA' será removido na versão v20.
-     * Utilize 'contentGenerator' em seu lugar.
+     * `'contentGenerator'` — tipo atual recomendado.
+     * `'textAreaIA'` — **@deprecated** Será removido na v20, use `'contentGenerator'`.
      */
     type: 'contentGenerator' | 'textAreaIA';
+    /**
+     * Número de colunas de texto do textarea.
+     */
     cols?: number;
+    /**
+     * Número de linhas visíveis do textarea.
+     */
     rows?: number;
+    /**
+     * Filtro de teclas aceitas. Aceita regex ou string.
+     */
     keyFilter?: any;
+    /**
+     * Estilos CSS inline aplicados diretamente no elemento textarea.
+     */
     style?: Partial<CSSStyleDeclaration>;
+    /**
+     * Prompt inicial enviado à IA para gerar conteúdo.
+     * Define a instrução base para o assistente de geração de texto.
+     * @example 'Gere um e-mail formal de boas-vindas para o cliente'
+     */
     prompt?: string;
+    /**
+     * Função que retorna `true` quando o campo deve estar em modo somente-leitura.
+     */
     readonly?: () => boolean;
+    /**
+     * Quando `true`, ativa o botão de reconhecimento de voz (speech-to-text).
+     * O conteúdo falado é convertido em texto e inserido no campo.
+     */
     speechRecognition?: boolean;
+    /**
+     * Quando `true`, o contexto das gerações anteriores é mantido ao gerar novo conteúdo.
+     * Permite que a IA considere o histórico da conversa na próxima geração.
+     */
     keepContext: boolean;
+    /**
+     * Texto de placeholder exibido na área de reconhecimento de voz enquanto o microfone está ativo.
+     */
     speechRecognitionPlaceholder: string;
+    /**
+     * Número máximo de caracteres permitidos no campo.
+     */
     maxLength?: number;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/country-phone-picker-field.d.ts

@@ -1,10 +1,36 @@
 import { CountryPhoneData, Ordination, PhoneSelectionData } from '@seniorsistemas/angular-components/country-phone-picker';
 import { FieldConfig } from './field';
+/**
+ * Configuração para campo de seleção de país com entrada de número de telefone.
+ *
+ * Combina um dropdown de seleção de país (com bandeira e código DDI) com um campo de telefone
+ * que aplica automaticamente a máscara de cada país selecionado.
+ *
+ * O valor do campo é do tipo `PhoneSelectionData`, contendo o país e o número.
+ */
 export interface CountryPhonePickerConfig extends FieldConfig {
+    /** Tipo do campo: sempre `'countryPhonePicker'`. */
     type: 'countryPhonePicker';
+    /**
+     * Lista de códigos de países disponíveis no dropdown.
+     * Use códigos ISO 3166-1 alpha-2 em maiúsculas.
+     * @example ['BR', 'US', 'AR', 'DE']
+     */
     countries: string[];
+    /**
+     * Critério de ordenação dos países no dropdown.
+     * Importado de `@seniorsistemas/angular-components/country-phone-picker`.
+     */
     ordination: Ordination;
+    /**
+     * Callback obrigatório chamado quando o país é selecionado.
+     * Recebe os dados do país escolhido (nome, DDI, código).
+     */
     onSelected: (data: CountryPhoneData) => void;
+    /**
+     * Callback chamado quando o campo de telefone perde o foco.
+     * Recebe os dados completos da seleção (país + número), ou `null` se vazio.
+     */
     onFocusLost?: (data: PhoneSelectionData | null) => void;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/currency-field.d.ts

@@ -1,11 +1,28 @@
 import { Currency } from '@seniorsistemas/angular-components/currency';
 import { NumberFieldConfig } from './number-field';
 /**
- * @deprecated should use BigNumberField instead
+ * Configuração para campo monetário com símbolo de moeda.
+ *
+ * @deprecated Use `BignumberFieldConfig` com `type: 'number'` ou `'double'` em combinação com
+ * `leftAddon` ou `rightAddon` para exibir o símbolo monetário. Esta interface será removida
+ * em versão futura.
+ *
+ * Estende `NumberFieldConfig` omitindo `alignTo`, `leftAddon` e `rightAddon`.
  */
 export interface CurrencyFieldConfig extends Omit<NumberFieldConfig, 'type' | 'alignTo' | 'leftAddon' | 'rightAddon'> {
+    /** Tipo do campo: sempre `'money'`. */
     type: 'money';
+    /**
+     * Alinhamento do texto dentro do campo.
+     * `'left'` — alinhado à esquerda.
+     * `'right'` — alinhado à direita (comum em campos monetários).
+     */
     alignTo?: 'left' | 'right';
+    /**
+     * Função que retorna o objeto de moeda a ser exibido junto ao valor.
+     * Inclui símbolo, código e formatação.
+     * @example () => ({ symbol: 'R$', code: 'BRL' })
+     */
     currency?: () => Currency;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/field.d.ts

@@ -1,13 +1,57 @@
+/**
+ * Configuração base compartilhada por **todos** os tipos de campo do DynamicForm.
+ *
+ * Toda interface específica de campo (ex: TextFieldConfig, SelectFieldConfig) estende esta interface.
+ * As propriedades aqui definidas estão disponíveis em qualquer campo do formulário.
+ */
 export interface FieldConfig {
+    /**
+     * Tipo do campo. Deve ser um dos valores registrados em `FieldTypeMap`.
+     * Exemplos: `'string'`, `'enum'`, `'date'`, `'lookup'`, `'boolean'`, etc.
+     * Para tipos opcionais (ex: `'editor'`), o provider correspondente deve ser registrado no `AppConfig` ou `AppModule`.
+     */
     type: FieldType;
+    /**
+     * Função que retorna se o campo é obrigatório dinamicamente.
+     * Use uma função para que a obrigatoriedade possa mudar em resposta ao estado do formulário.
+     * @example () => this.model.ativo === true
+     */
     required?: () => boolean;
+    /**
+     * ID HTML do elemento de input gerado. Útil para testes automatizados e acessibilidade.
+     */
     id?: string;
+    /**
+     * Nome do campo no modelo de dados. Deve corresponder à chave da propriedade no objeto de dados do formulário.
+     * @example 'nomeCompleto'
+     */
     name: string;
+    /**
+     * Rótulo exibido acima ou ao lado do campo no formulário.
+     * Se omitido, o campo é exibido sem label.
+     */
     label?: string;
+    /**
+     * Ícone de informação exibido ao lado do campo. Aceita classes de ícone (ex: `'ph ph-info'`).
+     */
     infoSign?: string;
+    /**
+     * Texto do tooltip exibido ao passar o mouse sobre o campo ou sobre o infoSign.
+     */
     tooltip?: string;
+    /**
+     * Texto de placeholder exibido enquanto o campo estiver vazio.
+     */
     placeholder?: string;
+    /**
+     * Tempo em milissegundos para exibir automaticamente o infoSign quando o campo está focado.
+     * Útil para orientar o usuário após um curto intervalo de inatividade.
+     */
     displayTimeInfoSign?: number;
+    /**
+     * Quando `true`, o infoSign usa a referência do input focado como âncora do tooltip.
+     * Útil para garantir que o tooltip apareça próximo ao campo correto em layouts complexos.
+     */
     useInfoSignFocusedInputRef?: boolean;
 }
 export interface FieldTypeMap {

package/dynamic-form/dynamic-form/form-field/configurations/fields/lookup-field.d.ts

@@ -1,53 +1,161 @@
 import { Observable } from 'rxjs';
-import { FieldConfig } from './field';
+import { LookupSearchRequest } from '../../../components/lookup/models/lookup-api.model';
+import { DynamicType, FieldConfig } from './field';
+/**
+ * Dados retornados pelo Observable de pesquisa avançada do Lookup.
+ */
 export interface SearchObservable {
+    /** Array de registros retornados da pesquisa. */
     gridData: any[];
+    /** Número total de registros encontrados (para paginação). */
     totalRecords: number;
+    /** Label customizada para exibir o total de registros encontrados. */
     searchTotalRecordsLabel?: string;
 }
+/**
+ * Configuração para campo de pesquisa avançada (Lookup).
+ *
+ * Exibe um input com autocompletar e botão de pesquisa que abre um diálogo com grid de resultados.
+ * Suporta seleção simples ou múltipla, filtros padrão, ações CRUD na seleção e configuração
+ * dinâmica das colunas da grade.
+ *
+ * Requer dois Observables:
+ * - `suggestionsObservable`: para sugestões no autocompletar
+ * - `searchObservable`: para a grade de resultados do diálogo
+ */
 export interface LookupFieldConfig extends FieldConfig {
+    /** Tipo do campo: sempre `'lookup'`. */
     type: 'lookup';
+    /**
+     * Valor padrão pré-selecionado ao inicializar o formulário.
+     */
     defaultValue?: any;
+    /**
+     * Quando `true`, permite selecionar múltiplos registros exibidos como tags.
+     */
     multiple?: boolean;
+    /**
+     * Quando `true`, exibe o botão de pesquisa avançada que abre o diálogo com a grade.
+     */
     showSearch?: boolean;
-    searchFields: any[];
-    searchGridFields: any[];
+    /**
+     * Colunas de filtro exibidas no diálogo de pesquisa avançada.
+     * Cada item define o campo de filtro disponível para o usuário.
+     */
+    searchFields: DynamicType[];
+    /**
+     * Colunas exibidas na grade de resultados do diálogo de pesquisa.
+     * Cada item define uma coluna com header e campo de dados.
+     */
+    searchGridFields: DynamicType[];
+    /**
+     * Observable que emite sugestões para o autocompletar do input do lookup.
+     * Deve emitir um array de objetos com a propriedade `lookupDisplayField`.
+     */
     suggestionsObservable: Observable<any[]>;
+    /**
+     * Observable que emite os dados da grade do diálogo de pesquisa avançada.
+     * Deve emitir um objeto `SearchObservable` com `gridData` e `totalRecords`.
+     *
+     * Estrutura de `SearchObservable`: `{ gridData: any[]; totalRecords: number; searchTotalRecordsLabel?: string; }`
+     * @typeImport import { SearchObservable } from '@seniorsistemas/angular-components/dynamic-form';
+     */
     searchObservable: Observable<SearchObservable>;
+    /**
+     * Nome da propriedade única do objeto que identifica cada registro.
+     * @example 'id'
+     */
     dataKey: string;
+    /**
+     * Nome da propriedade do objeto de resultado a ser exibida no input e nas tags.
+     * @example 'nome'
+     */
     lookupDisplayField: string;
+    /** Título do diálogo de pesquisa avançada. */
     searchTitle?: string;
+    /** Mensagem exibida quando a pesquisa não retorna resultados. */
     searchEmptyTitle?: string;
+    /** Label do campo de filtro no diálogo. */
     filterLabel?: string;
+    /** Título do campo de filtro no diálogo. */
     filterTitle?: string;
+    /** Label do botão de limpar filtros. */
     clearLabel?: string;
+    /** Label do botão de cancelar e fechar o diálogo. */
     cancelLabel?: string;
+    /** Label do botão de confirmar a seleção no diálogo. */
     selectLabel?: string;
+    /** Mensagem exibida quando nenhum registro é encontrado na grade. */
     emptyMessage?: string;
+    /** Label para um registro (singular). @example 'registro' */
     recordLabel?: string;
+    /** Label para múltiplos registros (plural). @example 'registros' */
     recordsLabel?: string;
+    /** Label exibida quando o campo está vazio e sem seleção. */
     emptyFieldLabel?: string;
+    /**
+     * Elemento DOM ao qual o painel de sugestões será anexado.
+     * Use `'body'` para evitar problemas com `overflow: hidden`.
+     */
     appendTo?: string;
+    /**
+     * Quando `true`, o usuário só pode selecionar valores da lista de sugestões;
+     * texto livre é descartado ao perder o foco.
+     */
     autocompleteForceSelection?: boolean;
     maxlength?: number | null;
     showAddOption?: boolean;
+    /** Quando `true`, exibe o botão de editar o registro selecionado. */
     showEditOption?: boolean;
+    /** Quando `true`, exibe o botão de remover registros selecionados. */
     showRemoveOption?: boolean;
+    /**
+     * Lista de colunas que não podem ser ordenadas na grade do diálogo.
+     * @example ['descricao', 'createdAt']
+     */
     sortableColumnsDisabled?: string[];
+    /**
+     * Filtros padrão aplicados automaticamente à pesquisa.
+     * Cada item define um campo e um valor fixo ou dinâmico (função).
+     *
+     * Estrutura de `DefaultFilter`: `{ field: string; value: string | (() => string); }`
+     * @typeImport import { DefaultFilter } from '@seniorsistemas/angular-components/dynamic-form';
+     */
     defaultFilter?: DefaultFilter[];
+    /**
+     * Callback chamado quando o usuário digita para buscar sugestões.
+     * Deve atualizar o `suggestionsObservable` com os resultados da busca.
+     */
     onLookupRequest: (query: string) => void;
-    onSearchRequest: (event: any) => void;
+    /**
+     * Callback chamado quando o usuário realiza uma pesquisa no diálogo avançado.
+     * Deve atualizar o `searchObservable` com os resultados paginados.
+     *
+     * Estrutura de `LookupSearchRequest`: `{ filterData: Record<string, any>; first: number; rows: number; }`
+     * @typeImport import { LookupSearchRequest } from '@seniorsistemas/angular-components/dynamic-form';
+     */
+    onSearchRequest: (event: LookupSearchRequest) => void;
+    /** Callback chamado quando o usuário seleciona um registro. */
     onSelect?: (event: any) => void;
+    /** Callback chamado quando o usuário remove um registro selecionado (modo múltiplo). */
     onUnselect?: (event: any) => void;
+    /** Callback chamado quando o usuário limpa todos os registros selecionados. */
     onClear?: (event: any) => void;
+    /** Callback chamado quando o campo perde o foco. */
     onBlur?: (event: FocusEvent) => void;
+    /** Callback chamado quando o usuário clica no botão de adicionar novo registro. */
     onAdd?: () => void;
+    /** Callback chamado quando o usuário clica no botão de editar. Recebe o item selecionado. */
     onEdit?: (selectedItem: unknown) => void;
+    /** Callback chamado quando o usuário clica no botão de remover. Recebe os itens selecionados. */
     onRemove?: (selectedItems: unknown[]) => void;
+    /** Callback chamado quando o usuário clica no botão de limpar do campo (X). */
     onClearButtonClick?: () => void;
 }
 export type DefaultFilter = {
+    /** Nome do campo a ser filtrado. */
     field: string;
+    /** Valor do filtro. Pode ser uma string estática ou função que retorna o valor dinamicamente. */
     value: string | (() => string);
 };
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/number-field.d.ts

@@ -4,25 +4,64 @@ import { AddonConfig } from '../../addon-config';
 import { FieldConfig } from './field';
 type stringFn = () => string | string;
 /**
- * @deprecated Should use BignumberFieldConfig instead
+ * Configuração para campos numéricos inteiros ou de número legado.
+ *
+ * @deprecated Use `BignumberFieldConfig` com `type: 'number'` ou `'double'` para novas
+ * implementações. Esta interface está mantida por compatibilidade retro-ativa.
+ *
+ * - `'integer'` — campo de número inteiro.
+ * - `'legacyNumber'` — campo numérico legado (comportamento antigo).
  */
 export interface NumberFieldConfig extends FieldConfig {
+    /**
+     * `'integer'` — campo numérico inteiro.
+     * `'legacyNumber'` — campo numérico legado.
+     */
     type: 'integer' | 'legacyNumber';
     /**
-     * @deprecated `numberLocaleOptions` should not be used. It is not needed anymore and should be removed if possible.
+     * Opções de localização numérica.
+     * @deprecated Não é mais necessário. Remova se presente.
      */
     numberLocaleOptions?: NumberLocaleOptions;
+    /**
+     * Controla o autocomplete nativo do browser.
+     */
     browserAutocomplete?: boolean;
+    /**
+     * Número total de dígitos aceitos. Pode ser função para controle dinâmico.
+     */
     precision?: Function | number;
+    /**
+     * Número de casas decimais. Pode ser função para controle dinâmico.
+     */
     scale?: (() => number) | number;
+    /**
+     * Alinhamento do texto no campo.
+     */
     alignTo?: NumberAlignmentOption;
+    /**
+     * Máscara de entrada. Pode ser string estática ou função.
+     */
     mask?: stringFn | string;
+    /**
+     * Addon exibido à esquerda do campo.
+     */
     leftAddon?: AddonConfig;
+    /**
+     * Addon exibido à direita do campo.
+     */
     rightAddon?: AddonConfig;
+    /**
+     * Quando `true`, usa o componente de número localizado.
+     */
     localizedNumber?: boolean;
+    /** Callback chamado quando o campo perde o foco. */
     onBlur?: (event: Event) => void;
+    /** Callback chamado quando o campo recebe foco. */
     onFocus?: (event: Event) => void;
-    onComplete?: (event: FocusEvent) => void;
+    /** Callback chamado quando a máscara é completamente preenchida. */
+    onComplete?: (event: Event) => void;
+    /** Callback chamado a cada alteração no valor do input. */
     onInput?: (event: Event) => void;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/password-field.d.ts

@@ -1,26 +1,74 @@
 import { PasswordStrengths } from '@seniorsistemas/angular-components/password-strength';
 import { FieldConfig } from './field';
+/**
+ * Configuração para campo de senha com indicador de força.
+ *
+ * Renderiza um input de senha com:
+ * - Togglear a visibilidade da senha (mostrar/ocultar)
+ * - Indicador visual de força da senha (fraca/média/forte)
+ * - Configuração customizada das regras de validação da força
+ */
 export interface PasswordFieldConfig extends FieldConfig {
+    /** Tipo do campo: sempre `'password'`. */
     type: 'password';
+    /**
+     * Tipo HTML do input. @default 'password'
+     */
     inputType?: string;
+    /**
+     * Filtro de teclas aceitas. Aceita regex, string ou qualquer valor aceito pelo componente.
+     */
     keyFilter?: any;
+    /**
+     * Número máximo de caracteres permitidos.
+     */
     maxLength?: string | number;
+    /**
+     * Quando `true`, exibe a barra de força da senha abaixo do campo.
+     * Requer `passwordStrengthOptions` para personalizar as regras de avaliação.
+     */
     passwordStrength: boolean;
+    /**
+     * Opções de configuração da barra de força da senha.
+     * Obrigatório quando `passwordStrength: true`.
+     */
     passwordStrengthOptions?: PasswordStrengthOptions;
+    /**
+     * Quando `true`, exibe o botão de alternar visibilidade da senha (olho/olho fechado).
+     */
     showToggle: boolean;
+    /**
+     * Estilos CSS inline aplicados ao elemento de input.
+     */
     style?: {
         [klass: string]: any;
     };
+    /** Callback chamado quando o campo perde o foco. */
     onBlur?: (event: FocusEvent) => void;
+    /** Callback chamado quando o campo recebe foco. */
     onFocus?: (event: FocusEvent) => void;
+    /** Callback chamado quando a máscara é completamente preenchida. */
     onComplete?: (event: FocusEvent) => void;
+    /** Callback chamado a cada alteração no valor do input. */
     onInput?: (event: Event) => void;
 }
+/**
+ * Opções de configuração do indicador de força de senha.
+ */
 export interface PasswordStrengthOptions {
+    /** Descrição exibida abaixo da barra de força. Ex: 'Use pelo menos 8 caracteres'. */
     description: string;
+    /** Título exibido quando a senha é classificada como fraca. */
     weakTitle?: string;
+    /** Título exibido quando a senha é classificada como média. */
     mediumTitle?: string;
+    /** Título exibido quando a senha é classificada como forte. */
     strongTitle?: string;
+    /**
+     * Função customizada de validação da força da senha.
+     * Recebe o valor atual do campo e deve retornar `PasswordStrengths`.
+     * Se omitida, usa a validação padrão do componente.
+     */
     validation?: (content: string) => PasswordStrengths;
 }
 declare module './field' {

package/dynamic-form/dynamic-form/form-field/configurations/fields/profile-picture.d.ts

@@ -1,20 +1,82 @@
 import { ConfirmationTexts, CropperLabelsConfig, FileValidationErrors, ProfilePicturePickerData } from '@seniorsistemas/angular-components/profile-picture-picker';
 import { FieldConfig } from './field';
+/**
+ * Configuração para campo de foto de perfil com recorte.
+ *
+ * Exibe uma área para upload e recorte de imagem de perfil.
+ * Suporta pré-visualização, recorte interativo (cropper), validação de tipo e tamanho,
+ * confirmação de remoção e labels customizadas para todas as ações.
+ */
 export interface ProfilePictureConfig extends FieldConfig {
+    /** Tipo do campo: sempre `'profilePicture'`. */
     type: 'profilePicture';
+    /**
+     * Título exibido no modo simples (sem imagem carregada).
+     * @example 'Foto de perfil'
+     */
     simpleTitle: string;
+    /**
+     * Título exibido quando o painel de ações está ativo (com imagem carregada).
+     * @example 'Alterar foto'
+     */
     actionTitle: string;
+    /**
+     * Subtexto descritivo exibido abaixo do título.
+     * @example 'Formato JPG ou PNG, máx 5MB'
+     */
     subtitle: string;
+    /**
+     * Proporção de aspecto da área de recorte (largura / altura).
+     * @example 1 para quadrado (1:1), 16/9 para paisagem
+     */
     aspectRatio: number;
+    /**
+     * Labels dos botões exibidos no diálogo do cropper.
+     * Importado de `@seniorsistemas/angular-components/profile-picture-picker`.
+     */
     cropperLabelsConfig?: CropperLabelsConfig;
+    /**
+     * Label do botão de remover a imagem atual.
+     * @example 'Remover foto'
+     */
     removeButtonLabel?: string;
+    /**
+     * Label do botão de alterar a imagem atual.
+     * @example 'Alterar foto'
+     */
     changeButtonLabel?: string;
+    /**
+     * Textos de confirmação exibidos no diálogo de remoção da imagem.
+     */
     confirmationTexts?: ConfirmationTexts;
+    /**
+     * Tamanho máximo do arquivo aceito em bytes.
+     * @example 5242880 para 5MB
+     */
     maxFileSize?: number;
+    /**
+     * Tipos MIME aceitos.
+     * @example 'image/jpeg,image/png'
+     */
     accept?: string;
+    /**
+     * Extensões de arquivo aceitas (com ponto).
+     * @example ['.jpg', '.png', '.webp']
+     */
     supportedExtensions?: string[];
+    /**
+     * Callback chamado quando a imagem é alterada após o recorte.
+     * Recebe a imagem em base64 ou objeto `ProfilePicturePickerData`.
+     */
     onChangeImage?: (event: string | ProfilePicturePickerData) => void;
+    /**
+     * Callback chamado quando a imagem é removida pelo usuário.
+     */
     onRemovedImage?: () => void;
+    /**
+     * Callback chamado quando o arquivo selecionado não passa na validação.
+     * Recebe os erros de validação ocorridos (ex: tamanho, extensão).
+     */
     onInvalidFile?: (event: FileValidationErrors) => void;
 }
 declare module './field' {