//#region src/get-boleto-info/get-boleto-info.d.ts
/** The fields `getBoletoInfo` reads out of a bank slip (boleto). */
export type BoletoInfo = {
  /** Amount in cents. */
  amount: number;
  /** Due date read from the "fator de vencimento", or `null` when the bank slip carries none. */
  expirationDate: Date | null;
  /** Three digit bank code (COMPE), empty for an arrecadação bank slip. */
  bankCode: string;
  /** Present and set to "arrecadacao" only for convênio/tributos bank slips. */
  type?: "arrecadacao";
  /** Arrecadação segment (1 to 7, or 9 for the bank's own use), the kind of biller the bank slip belongs to. */
  segment?: number;
  /** Arrecadação amount in reais (`amount` divided by 100). */
  value?: number;
  /** Whether the arrecadação amount is an effective value (`true`) or a reference quantity (`false`). */
  hasEffectiveValue?: boolean;
};
/** Options of `getBoletoInfo`. */
export type GetBoletoInfoOptions = {
  /** Date used to resolve the 9000 day "fator de vencimento" cycle (default: now). */
  referenceDate?: Date;
};
/**
 * Extracts information from a Brazilian bank slip (boleto).
 *
 * The value is checked with `isValidBoleto` first, so an invalid bank slip gives `null` rather
 * than a partial result, the way every other getter of this package answers a lookup it cannot
 * resolve (`getFormatLicensePlate`, `getMunicipality`).
 *
 * Supports the 47 digit "cobrança bancária" linha digitável and, additionally, the
 * "arrecadação" (convênio/tributos) bank slip: 48 digit linha digitável or 44 digit
 * barcode, both starting with `8`. Arrecadação bank slips also return `type`, `segment`,
 * `value` and `hasEffectiveValue`, and, carrying neither a bank code nor a fator de vencimento,
 * come back with `bankCode` set to `""` and `expirationDate` set to `null` rather than with those
 * two keys missing.
 *
 * Neither FEBRABAN nor the Banco Central publishes a way of telling an old cycle fator de
 * vencimento from a new cycle one, so every factor resolves to either of two dates 9000 days
 * apart. `referenceDate` (now by default) picks between them through the library's own safety
 * windows, which means the same slip can resolve to the other candidate as time passes: pass
 * `referenceDate` explicitly whenever the answer has to stay stable. The search never goes below
 * the first cycle, so a `referenceDate` older than the scheme itself still resolves a factor to
 * the oldest date that factor can denote rather than to one before the 07/10/1997 base date.
 *
 * @param {string} value - The boleto digitable line (can be with or without mask).
 * @param {GetBoletoInfoOptions} [options] - Optional options.
 * @param {Date} options.referenceDate - Date used to resolve the "fator de vencimento" cycle. Defaults to now.
 * @returns {BoletoInfo | null} An object containing amount (in cents), expirationDate, and bankCode, or null if the boleto is invalid.
 *
 * @example
 * ```typescript
 * getBoletoInfo('00190000090114971860168524522114675860000102656', {
 *   referenceDate: new Date(2025, 5, 15),
 * });
 * // { amount: 102656, expirationDate: new Date(2018, 6, 15), bankCode: '001' }
 *
 * getBoletoInfo('846100000005246100291102005460339004695895061080');
 * // { amount: 2461, expirationDate: null, bankCode: '', type: 'arrecadacao', segment: 4, value: 24.61, hasEffectiveValue: true }
 *
 * getBoletoInfo('invalid'); // null
 * ```
 *
 * Carta-Circular BCB nº 2.926/2000 specifies the linha digitável fields and the módulo 11
 * check digit (using 1 for remainders 0, 10 and 1) of the 47 digit cobrança bancária slip,
 * including the position of the fator de vencimento field. The FEBRABAN "Layout Padrão de
 * Arrecadação/Recebimento com Utilização do Código de Barras" and the FEBRABAN layout index
 * cover the arrecadação slip. The 22/02/2025 reset of the fator de vencimento is in neither:
 * the Bradesco cobrança layout manual below reproduces the FEBRABAN rule. See
 * `src/get-boleto-info/constants.ts` for the fator de vencimento cycle base date and reset.
 *
 * @see Official: https://www.bcb.gov.br/pre/normativos/c_circ/2000/pdf/c_circ_2926_v1_O.pdf
 * @see Official: https://cmsarquivos.febraban.org.br/Arquivos/documentos/PDF/Layout%20-%20C%C3%B3digo%20de%20Barras%20-%20Vers%C3%A3o%208%20-%2011_05_2026.pdf
 * @see Official: https://portal.febraban.org.br/pagina/3425/33/pt-br/layout-febraban
 * @see Based on: https://banco.bradesco/assets/pessoajuridica/pdf/4008-524-0121-layout-cobranca-versao-portugues.pdf
 * Bradesco "Layout da Cobrança" manual: base date 07/10/1997, 03/07/2000 = 1000, 21/02/2025 = 9999
 * and a restart at 1000 on 22/02/2025.
 */
export declare const getBoletoInfo: (value: string, options?: GetBoletoInfoOptions) => BoletoInfo | null;
//#endregion