@govbr-ds/webcomponents 2.3.0 → 2.4.0

package/dist/types/components/datetime-picker/datetime-picker-form-associated.d.ts

@@ -1,9 +1,36 @@
 import type { DatetimePickerDateRange, DatetimePickerFormContext, DatetimePickerMissingValueContext, DatetimePickerMode } from './datetime-picker.types';
-/** Serializa o valor atual para envio em FormData conforme o modo ativo. */
+/**
+ * Serializa o valor atual para envio em FormData conforme o modo ativo.
+ *
+ * @param {Date | null} value - Valor selecionado a ser serializado para submissão.
+ * @param {DatetimePickerFormContext} context - Contexto com `mode`, `selectionMode` e limites (rangeStart/rangeEnd).
+ * @returns {string | null} Representação serializada pronta para `FormData`, ou `null` quando não houver valor.
+ */
 export declare function serializeDatetimePickerFormValue(value: Date | null, context: DatetimePickerFormContext): string | null;
-/** Analisa um valor serializado de formulário para Date respeitando o modo atual. */
+/**
+ * Analisa um valor serializado de formulário para `Date` respeitando o modo atual.
+ *
+ * @param {string} value - String serializada vinda do formulário.
+ * @param {DatetimePickerMode} mode - Modo (`date` | `time` | `datetime`) que dita o parser a ser usado.
+ * @param {Date} referenceDate - Data de referência usada ao analisar valores de hora.
+ * @returns {Date | null} Objeto Date quando a análise for bem-sucedida, ou `null` quando inválido.
+ */
 export declare function parseDatetimePickerSerializedValue(value: string, mode: DatetimePickerMode, referenceDate: Date): Date | null;
-/** Analisa intervalo serializado no formato YYYY-MM-DD/YYYY-MM-DD. */
-export declare function parseDatetimePickerSerializedRange(value: string): DatetimePickerDateRange | null;
-/** Informa se o componente deve sinalizar valueMissing na validação nativa. */
+/**
+ * Analisa um intervalo serializado no formato `start/end` conforme o modo ativo.
+ *
+ * @param {string} value - String no formato `start/end` contendo os dois lados do intervalo.
+ * @param {DatetimePickerMode} mode - Modo a ser usado para análise (padrão: `date`).
+ * @param {Date} referenceDate - Data de referência para análise de horários.
+ * @returns {DatetimePickerDateRange | null} `{ start, end }` quando válido, ou `null` quando inválido.
+ */
+export declare function parseDatetimePickerSerializedRange(value: string, mode?: DatetimePickerMode, referenceDate?: Date): DatetimePickerDateRange | null;
+/**
+ * Indica se o componente deve sinalizar `valueMissing` na validação nativa.
+ *
+ * A função considera `required`, `disabled` e se o valor (ou intervalo) está incompleto.
+ *
+ * @param {DatetimePickerMissingValueContext} context - Contexto contendo `required`, `disabled`, `value` e, quando aplicável, `rangeStart`/`rangeEnd`.
+ * @returns {boolean} `true` quando o controle deve reportar `valueMissing`.
+ */
 export declare function hasDatetimePickerMissingValue(context: DatetimePickerMissingValueContext): boolean;

package/dist/types/components/datetime-picker/datetime-picker-props-validation.d.ts

@@ -1,73 +1,71 @@
-import type { DatetimePickerDateRange, DatetimePickerDisabledDates, DatetimePickerInitialMoment, DatetimePickerMode, DatetimePickerSelectionMode, DatetimePickerWeekDayIndex } from './datetime-picker.types';
-/** Verifica se um intervalo público contém datas válidas ou `null` em ambos os lados. */
-export declare function isValidDatetimePickerDateRange(value: unknown): value is DatetimePickerDateRange;
+import type { DatetimePickerDisabledDates, DatetimePickerInitialMoment, DatetimePickerMode, DatetimePickerSelectionMode, DatetimePickerWeekDayIndex } from './datetime-picker.types';
 /**
  * Verifica se o valor informado corresponde a um modo suportado pelo componente.
  *
- * @param value - Valor recebido via prop ou atributo.
- * @returns `true` quando o valor pertence ao conjunto aceito de modos.
+ * @param {string} value - Valor recebido via prop ou atributo.
+ * @returns {boolean} `true` quando o valor pertence ao conjunto aceito de modos.
  */
 export declare function isValidDatetimePickerMode(value: string): value is DatetimePickerMode;
 /**
  * Normaliza o modo informado e aplica o valor padrão quando necessário.
  *
- * @param value - Valor bruto recebido do consumidor do componente.
- * @returns O modo válido correspondente, ou o valor padrão quando o input for inválido.
+ * @param {string} value - Valor bruto recebido do consumidor do componente.
+ * @returns {DatetimePickerMode} O modo válido correspondente, ou o valor padrão quando o input for inválido.
  */
 export declare function normalizeDatetimePickerMode(value: string): DatetimePickerMode;
 /**
  * Verifica se o valor representa um modo de seleção suportado.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns `true` quando o valor é `'single'` ou `'range'`.
+ * @param {string} value - Valor bruto recebido via prop.
+ * @returns {boolean} `true` quando o valor é `'single'` ou `'range'`.
  */
 export declare function isValidDatetimePickerSelectionMode(value: string): value is DatetimePickerSelectionMode;
 /**
  * Normaliza o modo de seleção informado e aplica o valor padrão quando necessário.
  *
- * @param value - Valor bruto recebido do consumidor do componente.
- * @returns O modo de seleção válido correspondente, ou `'single'` quando o input for inválido.
+ * @param {string} value - Valor bruto recebido do consumidor do componente.
+ * @returns {DatetimePickerSelectionMode} O modo de seleção válido correspondente, ou `'single'` quando o input for inválido.
  */
 export declare function normalizeDatetimePickerSelectionMode(value: string): DatetimePickerSelectionMode;
 /**
  * Verifica se o valor representa uma seleção inicial suportada.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns `true` quando o valor é `'now'`, `null`, `Date` válida ou string de data válida.
+ * @param {unknown} value - Valor bruto recebido via prop.
+ * @returns {boolean} `true` quando o valor é `'now'`, `null`, `Date` válida ou string de data válida.
  */
 export declare function isValidDatetimePickerInitialMoment(value: unknown): value is DatetimePickerInitialMoment;
 /**
  * Normaliza a seleção inicial para um valor aplicável pelo componente.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns `'now'`, `Date` normalizada ou `null` quando inválido.
+ * @param {unknown} value - Valor bruto recebido via prop.
+ * @returns {'now' | Date | null} `'now'`, `Date` normalizada ou `null` quando inválido.
  */
 export declare function normalizeDatetimePickerInitialMoment(value: unknown): 'now' | Date | null;
 /**
  * Verifica se o valor representa uma lista de datas desabilitadas válida.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns `true` quando o valor é `null` ou uma lista composta apenas por `Date`/`string` válidas.
+ * @param {unknown} value - Valor bruto recebido via prop.
+ * @returns {boolean} `true` quando o valor é `null` ou uma lista composta apenas por `Date`/`string` válidas.
  */
 export declare function isValidDatetimePickerDisabledDates(value: unknown): value is DatetimePickerDisabledDates;
 /**
  * Normaliza a lista de datas desabilitadas para uma coleção de `Date` válidas.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns Lista normalizada de datas; retorna array vazio quando inválido.
+ * @param {unknown} value - Valor bruto recebido via prop.
+ * @returns {Date[]} Lista normalizada de datas; retorna array vazio quando inválido.
  */
-export declare function normalizeDatetimePickerDisabledDates(value: unknown, componentTag?: string): Date[];
+export declare function normalizeDatetimePickerDisabledDates(value: unknown): Date[];
 /**
  * Verifica se o valor informado representa um índice válido de início da semana.
  *
- * @param value - Valor bruto recebido via prop.
- * @returns `true` quando o valor está entre `0` e `6`.
+ * @param {number} value - Valor bruto recebido via prop.
+ * @returns {boolean} `true` quando o valor está entre `0` e `6`.
  */
 export declare function isValidDatetimePickerWeekStartsOn(value: number): value is DatetimePickerWeekDayIndex;
 /**
  * Normaliza o índice de início da semana e aplica `0` quando o valor é inválido.
  *
- * @param value - Valor bruto recebido do consumidor do componente.
- * @returns Índice normalizado para o primeiro dia da semana.
+ * @param {unknown} value - Valor bruto recebido do consumidor do componente.
+ * @returns {DatetimePickerWeekDayIndex} Índice normalizado para o primeiro dia da semana.
  */
 export declare function normalizeDatetimePickerWeekStartsOn(value: unknown): DatetimePickerWeekDayIndex;