@danielarndt0/brutils-cli 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,442 @@
+interface ValidationResult {
+    isValid: boolean;
+    value: string;
+    formatted?: string | undefined;
+}
+
+type CPFStateCode = "AC" | "AL" | "AM" | "AP" | "BA" | "CE" | "DF" | "ES" | "GO" | "MA" | "MG" | "MS" | "MT" | "PA" | "PB" | "PE" | "PI" | "PR" | "RJ" | "RN" | "RO" | "RR" | "RS" | "SC" | "SE" | "SP" | "TO";
+interface CPFGenerateOptions {
+    formatted?: boolean | undefined;
+    state?: CPFStateCode | undefined;
+}
+interface CPFGenerateBatchOptions extends CPFGenerateOptions {
+    count: number;
+    unique?: boolean | undefined;
+}
+interface CPFValidateOptions {
+    strict?: boolean | undefined;
+}
+interface CPFValidationResult extends ValidationResult {
+    state?: CPFStateCode | undefined;
+}
+interface CPFMaskOptions {
+    pattern?: string | undefined;
+}
+
+declare function normalizeCPF(value: string): string;
+declare function stripCPF(value: string): string;
+declare function ensureCPFLength(value: string): string;
+declare function calculateCPFCheckDigit(digits: number[]): number;
+declare function resolveCPFRegionDigit(state?: CPFStateCode): number | undefined;
+declare function resolveCPFStateFromDigits(value: string): CPFStateCode | undefined;
+
+declare function formatCPFValue(value: string): string;
+
+declare function maskCPF(value: string, options?: CPFMaskOptions): string;
+
+declare function generateCPF(options?: CPFGenerateOptions): string;
+declare function generateCPFBatch(options: CPFGenerateBatchOptions): string[];
+
+declare function validateCPF(value: string, options?: CPFValidateOptions): CPFValidationResult;
+
+interface CNPJGenerateOptions {
+    formatted?: boolean | undefined;
+    branch?: string | undefined;
+}
+interface CNPJGenerateBatchOptions extends CNPJGenerateOptions {
+    count: number;
+    unique?: boolean | undefined;
+}
+interface CNPJValidateOptions {
+    strict?: boolean | undefined;
+}
+interface CNPJValidationResult extends ValidationResult {
+    branch?: string | undefined;
+}
+interface CNPJMaskOptions {
+    pattern?: string | undefined;
+}
+
+declare function normalizeCNPJ(value: string): string;
+declare function stripCNPJ(value: string): string;
+declare function ensureCNPJLength(value: string): string;
+declare function normalizeCNPJBranch(value?: string): string;
+declare function calculateCNPJCheckDigit(digits: number[]): number;
+declare function resolveCNPJBranch(value: string): string | undefined;
+
+declare function formatCNPJValue(value: string): string;
+
+declare function maskCNPJ(value: string, options?: CNPJMaskOptions): string;
+
+declare function generateCNPJ(options?: CNPJGenerateOptions): string;
+declare function generateCNPJBatch(options: CNPJGenerateBatchOptions): string[];
+
+declare function validateCNPJ(value: string, options?: CNPJValidateOptions): CNPJValidationResult;
+
+type CEPStateCode = "AC" | "AL" | "AM" | "AP" | "BA" | "CE" | "DF" | "ES" | "GO" | "MA" | "MG" | "MS" | "MT" | "PA" | "PB" | "PE" | "PI" | "PR" | "RJ" | "RN" | "RO" | "RR" | "RS" | "SC" | "SE" | "SP" | "TO";
+interface CEPGenerateOptions {
+    formatted?: boolean | undefined;
+    state?: CEPStateCode | undefined;
+}
+interface CEPGenerateBatchOptions extends CEPGenerateOptions {
+    count: number;
+}
+interface CEPValidateOptions {
+    strict?: boolean | undefined;
+}
+interface CEPValidationResult extends ValidationResult {
+    stateBias?: CEPStateCode | undefined;
+}
+interface CEPMaskOptions {
+    pattern?: string | undefined;
+}
+
+declare function normalizeCEP(value: string): string;
+declare function stripCEP(value: string): string;
+declare function ensureCEPLength(value: string): string;
+declare function resolveCEPLeadingDigits(state?: CEPStateCode): number[] | undefined;
+
+declare function formatCEPValue(value: string): string;
+
+declare function maskCEP(value: string, options?: CEPMaskOptions): string;
+
+declare function generateCEP(options?: CEPGenerateOptions): string;
+declare function generateCEPBatch(options: CEPGenerateBatchOptions): string[];
+
+declare function validateCEP(value: string, options?: CEPValidateOptions): CEPValidationResult;
+
+type CreditCardBrand = "visa" | "mastercard" | "amex" | "elo";
+interface CreditCardGenerateOptions {
+    brand?: CreditCardBrand;
+    formatted?: boolean;
+    expiryYearsAhead?: number;
+}
+interface CreditCardData {
+    brand: CreditCardBrand;
+    number: string;
+    expiryMonth: string;
+    expiryYear: string;
+    expiry: string;
+    cvv: string;
+}
+interface CreditCardValidationInput {
+    number: string;
+    expiryMonth?: string;
+    expiryYear?: string;
+    expiry?: string;
+    cvv?: string;
+}
+interface CreditCardValidationResult {
+    isValid: boolean;
+    brand: CreditCardBrand | "unknown";
+    number: string;
+    numberValid: boolean;
+    expiryValid: boolean;
+    cvvValid: boolean;
+}
+
+declare const CREDIT_CARD_BRAND_PREFIXES: Record<CreditCardBrand, string[]>;
+declare const CREDIT_CARD_BRAND_LENGTHS: Record<CreditCardBrand, number[]>;
+declare const CREDIT_CARD_BRAND_CVV_LENGTH: Record<CreditCardBrand, number>;
+
+declare function detectCreditCardBrand(number: string): CreditCardBrand | "unknown";
+
+declare function generateCreditCard(options?: CreditCardGenerateOptions): CreditCardData;
+
+declare function validateCreditCard(input: CreditCardValidationInput): CreditCardValidationResult;
+
+type RandomNumberOutputFormat = "plain" | "json" | "csv";
+interface RandomBaseOptions {
+    seed?: number;
+    format?: RandomNumberOutputFormat;
+}
+interface RandomIntegerGenerateOptions extends RandomBaseOptions {
+    min?: number;
+    max?: number;
+    count?: number;
+    sorted?: boolean;
+    unique?: boolean;
+}
+interface RandomFloatGenerateOptions extends RandomBaseOptions {
+    min?: number;
+    max?: number;
+    count?: number;
+    sorted?: boolean;
+    precision?: number;
+}
+interface RandomPickOptions extends RandomBaseOptions {
+    items: string[];
+    count?: number;
+    unique?: boolean;
+}
+interface RandomShuffleOptions extends RandomBaseOptions {
+    items: string[];
+}
+interface DiceRollOptions extends RandomBaseOptions {
+    faces?: number;
+    count?: number;
+}
+interface CoinFlipOptions extends RandomBaseOptions {
+    seed?: number;
+}
+type RandomNumberGenerateOptions = RandomIntegerGenerateOptions;
+type RandomNumberGenerateResult = number[];
+
+declare function generateRandomIntegers(options?: RandomIntegerGenerateOptions): number[];
+declare function generateRandomNumbers(options?: RandomNumberGenerateOptions): number[];
+declare function generateRandomFloats(options?: RandomFloatGenerateOptions): number[];
+declare function pickRandomItems(options: RandomPickOptions): string[];
+declare function shuffleRandomItems(options: RandomShuffleOptions): string[];
+declare function rollDice(options?: DiceRollOptions): number[];
+declare function flipCoin(options?: CoinFlipOptions): "heads" | "tails";
+
+interface NumberPickerOptions {
+    min?: number;
+    max?: number;
+    seed?: number;
+}
+
+declare function pickRandomNumber(options?: NumberPickerOptions): number;
+
+interface ZipArchiveEntryInfo {
+    path: string;
+    type: "file" | "directory";
+    compressedSize: number;
+    uncompressedSize: number;
+}
+interface ZipTestResult {
+    sourcePath: string;
+    testedEntries: number;
+    ok: boolean;
+}
+
+interface ZipCommandOptions {
+    out?: string;
+    level?: number;
+    force?: boolean;
+    exclude?: string[];
+    contentsOnly?: boolean;
+    dryRun?: boolean;
+    verbose?: boolean;
+    quiet?: boolean;
+    followSymlinks?: boolean;
+    store?: boolean;
+}
+interface ZipExecutionPlan {
+    sourcePath: string;
+    outputPath: string;
+    sourceType: "file" | "directory";
+    exclude: string[];
+    contentsOnly: boolean;
+    level: number;
+    followSymlinks: boolean;
+    store: boolean;
+}
+interface ZipInputEntry {
+    type: "file" | "directory";
+    sourcePath: string;
+    entryName: string;
+}
+type ZipListResult = ZipArchiveEntryInfo[];
+type ZipTestExecutionResult = ZipTestResult;
+
+declare function resolveZipOutputPath(sourcePath: string, explicitOut?: string): string;
+
+declare function collectZipInputs(sourcePath: string, outputPath: string, options?: ZipCommandOptions): ZipInputEntry[];
+
+declare function createZipExecutionPlan(sourcePath: string, positionalOut?: string, options?: ZipCommandOptions): ZipExecutionPlan;
+declare function createZip(sourcePath: string, positionalOut?: string, options?: ZipCommandOptions): Promise<ZipExecutionPlan>;
+
+declare function listZip(sourcePath: string, match?: string): Promise<ZipListResult>;
+
+declare function testZip(sourcePath: string, match?: string): Promise<ZipTestExecutionResult>;
+
+interface UnzipCommandOptions {
+    out?: string;
+    force?: boolean;
+    dryRun?: boolean;
+    verbose?: boolean;
+    quiet?: boolean;
+    flat?: boolean;
+    match?: string;
+}
+interface UnzipExecutionPlan {
+    sourcePath: string;
+    outputDir: string;
+    flat: boolean;
+    match?: string;
+}
+type UnzipListResult = ZipArchiveEntryInfo[];
+type UnzipTestResult = ZipTestResult;
+
+declare function resolveUnzipOutputPath(sourcePath: string, explicitOut?: string): string;
+
+declare function createUnzipExecutionPlan(sourcePath: string, positionalOut?: string, options?: UnzipCommandOptions): UnzipExecutionPlan;
+declare function extractZipFile(sourcePath: string, positionalOut?: string, options?: UnzipCommandOptions): Promise<UnzipExecutionPlan>;
+
+declare function listUnzip(sourcePath: string, match?: string): Promise<UnzipListResult>;
+
+declare function testUnzip(sourcePath: string, match?: string): Promise<UnzipTestResult>;
+
+type StringCaseStyle = "camel" | "snake" | "kebab" | "pascal" | "constant" | "title";
+type StringCodecMode = "encode" | "decode";
+type StringPadSide = "left" | "right" | "both";
+interface TruncateTextOptions {
+    max: number;
+    suffix?: string;
+}
+interface ReplaceTextOptions {
+    from: string;
+    with: string;
+    regex?: boolean;
+}
+interface PadTextOptions {
+    length: number;
+    side?: StringPadSide;
+}
+interface ExtractTextOptions {
+    regex?: boolean;
+}
+
+declare function slugifyText(value: string): string;
+declare function convertStringCase(value: string, style: StringCaseStyle): string;
+declare function trimText(value: string): string;
+declare function truncateText(value: string, options: TruncateTextOptions): string;
+declare function replaceText(value: string, options: ReplaceTextOptions): string;
+declare function normalizeText(value: string): string;
+declare function removeAccents(value: string): string;
+declare function padText(value: string, options: PadTextOptions): string;
+declare function extractText(value: string, query: string, options?: ExtractTextOptions): string[];
+declare function transformBase64(value: string, mode?: StringCodecMode): string;
+declare function transformUrlEncoding(value: string, mode?: StringCodecMode): string;
+declare function transformHtmlEntities(value: string, mode?: StringCodecMode): string;
+declare function getLevenshteinDistance(a: string, b: string): number;
+
+interface JsonValidationResult {
+    isValid: boolean;
+    error?: string;
+}
+interface JsonDiffEntry {
+    path: string;
+    type: "added" | "removed" | "changed";
+    left?: unknown;
+    right?: unknown;
+}
+interface JsonDiffResult {
+    isEqual: boolean;
+    changes: JsonDiffEntry[];
+}
+
+declare function parseJsonInput(value: string): unknown;
+declare function validateJsonInput(value: string): JsonValidationResult;
+declare function formatJsonValue(value: unknown, indent?: number, sortKeys?: boolean): string;
+declare function minifyJsonValue(value: unknown): string;
+declare function getJsonPathValue(value: unknown, path: string): unknown;
+declare function setJsonPathValue(value: unknown, path: string, newValue: unknown): unknown;
+declare function deleteJsonPathValue(value: unknown, path: string): unknown;
+declare function diffJsonValues(left: unknown, right: unknown): JsonDiffResult;
+declare function mergeJsonValues(values: unknown[]): unknown;
+declare function convertJsonToYaml(value: unknown): string;
+
+type FixedHashAlgorithm = "md5" | "sha1" | "sha256" | "sha512";
+interface HashSourceOptions {
+    text?: string;
+    file?: string;
+}
+interface HmacOptions extends HashSourceOptions {
+    algo: string;
+    key: string;
+}
+interface ChecksumOptions {
+    file: string;
+    algo?: string;
+}
+interface CompareHashOptions extends HashSourceOptions {
+    algo?: string;
+    expected: string;
+}
+interface CompareHashResult {
+    algorithm: string;
+    actual: string;
+    expected: string;
+    matches: boolean;
+    source: "text" | "file";
+}
+
+declare function computeHash(options: HashSourceOptions, algorithm: string): string;
+declare function computeMd5(options: HashSourceOptions): string;
+declare function computeSha1(options: HashSourceOptions): string;
+declare function computeSha256(options: HashSourceOptions): string;
+declare function computeSha512(options: HashSourceOptions): string;
+declare function computeHmac(options: HmacOptions): string;
+declare function computeChecksum(options: ChecksumOptions): string;
+declare function compareHash(options: CompareHashOptions): CompareHashResult;
+declare const FIXED_HASH_ALGORITHMS: FixedHashAlgorithm[];
+
+type CharsetName = "alnum" | "alpha" | "numeric" | "hex" | "base64url" | "lower" | "upper";
+interface UuidGenerateOptions {
+    count?: number;
+}
+interface TokenGenerateOptions {
+    count?: number;
+    length?: number;
+    charset?: CharsetName;
+}
+interface PasswordGenerateOptions {
+    count?: number;
+    length?: number;
+    charset?: CharsetName;
+    noSymbols?: boolean;
+    noNumbers?: boolean;
+    uppercase?: boolean;
+}
+
+declare function generateUuidValues(options?: UuidGenerateOptions): string[];
+declare function generateTokenValues(options?: TokenGenerateOptions): string[];
+declare function generatePasswordValues(options?: PasswordGenerateOptions): string[];
+declare const CHARSET_NAMES: CharsetName[];
+
+type DateDiffUnit = "seconds" | "minutes" | "hours" | "days";
+interface DateAdjustOptions {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+}
+interface DateSnapshot {
+    iso: string;
+    unix: number;
+    unixMs: number;
+}
+interface ParsedDateResult extends DateSnapshot {
+    input: string;
+}
+interface DateDiffResult {
+    from: string;
+    to: string;
+    unit: DateDiffUnit;
+    value: number;
+}
+interface UnixConversionResult extends DateSnapshot {
+    input: string | number;
+    sourceUnit: "seconds" | "milliseconds";
+}
+interface TimeZoneConversionResult {
+    input: string;
+    timeZone: string;
+    formatted: string;
+    iso: string;
+}
+
+declare function currentDateTime(): DateSnapshot;
+declare function formatDateValue(value: string, pattern: string): string;
+declare function parseDateValue(value: string): ParsedDateResult;
+declare function addToDate(value: string, options: DateAdjustOptions): string;
+declare function subtractFromDate(value: string, options: DateAdjustOptions): string;
+declare function diffDates(from: string, to: string, unit?: DateDiffUnit): DateDiffResult;
+declare function convertDateToUnix(value: string): UnixConversionResult;
+declare function convertUnixValue(value: string | number): UnixConversionResult;
+declare function convertDateToTimeZone(value: string, timeZone: string): TimeZoneConversionResult;
+declare const DATE_DIFF_UNITS: DateDiffUnit[];
+
+export { type CEPGenerateBatchOptions, type CEPGenerateOptions, type CEPMaskOptions, type CEPStateCode, type CEPValidateOptions, type CEPValidationResult, CHARSET_NAMES, type CNPJGenerateBatchOptions, type CNPJGenerateOptions, type CNPJMaskOptions, type CNPJValidateOptions, type CNPJValidationResult, type CPFGenerateBatchOptions, type CPFGenerateOptions, type CPFMaskOptions, type CPFStateCode, type CPFValidateOptions, type CPFValidationResult, CREDIT_CARD_BRAND_CVV_LENGTH, CREDIT_CARD_BRAND_LENGTHS, CREDIT_CARD_BRAND_PREFIXES, type CharsetName, type ChecksumOptions, type CoinFlipOptions, type CompareHashOptions, type CompareHashResult, type CreditCardBrand, type CreditCardData, type CreditCardGenerateOptions, type CreditCardValidationInput, type CreditCardValidationResult, DATE_DIFF_UNITS, type DateAdjustOptions, type DateDiffResult, type DateDiffUnit, type DateSnapshot, type DiceRollOptions, type ExtractTextOptions, FIXED_HASH_ALGORITHMS, type FixedHashAlgorithm, type HashSourceOptions, type HmacOptions, type JsonDiffEntry, type JsonDiffResult, type JsonValidationResult, type NumberPickerOptions, type PadTextOptions, type ParsedDateResult, type PasswordGenerateOptions, type RandomBaseOptions, type RandomFloatGenerateOptions, type RandomIntegerGenerateOptions, type RandomNumberGenerateOptions, type RandomNumberGenerateResult, type RandomNumberOutputFormat, type RandomPickOptions, type RandomShuffleOptions, type ReplaceTextOptions, type StringCaseStyle, type StringCodecMode, type StringPadSide, type TimeZoneConversionResult, type TokenGenerateOptions, type TruncateTextOptions, type UnixConversionResult, type UnzipCommandOptions, type UnzipExecutionPlan, type UnzipListResult, type UnzipTestResult, type UuidGenerateOptions, type ZipCommandOptions, type ZipExecutionPlan, type ZipInputEntry, type ZipListResult, type ZipTestExecutionResult, addToDate, calculateCNPJCheckDigit, calculateCPFCheckDigit, collectZipInputs, compareHash, computeChecksum, computeHash, computeHmac, computeMd5, computeSha1, computeSha256, computeSha512, convertDateToTimeZone, convertDateToUnix, convertJsonToYaml, convertStringCase, convertUnixValue, createUnzipExecutionPlan, createZip, createZipExecutionPlan, currentDateTime, deleteJsonPathValue, detectCreditCardBrand, diffDates, diffJsonValues, ensureCEPLength, ensureCNPJLength, ensureCPFLength, extractText, extractZipFile, flipCoin, formatCEPValue, formatCNPJValue, formatCPFValue, formatDateValue, formatJsonValue, generateCEP, generateCEPBatch, generateCNPJ, generateCNPJBatch, generateCPF, generateCPFBatch, generateCreditCard, generatePasswordValues, generateRandomFloats, generateRandomIntegers, generateRandomNumbers, generateTokenValues, generateUuidValues, getJsonPathValue, getLevenshteinDistance, listUnzip, listZip, maskCEP, maskCNPJ, maskCPF, mergeJsonValues, minifyJsonValue, normalizeCEP, normalizeCNPJ, normalizeCNPJBranch, normalizeCPF, normalizeText, padText, parseDateValue, parseJsonInput, pickRandomItems, pickRandomNumber, removeAccents, replaceText, resolveCEPLeadingDigits, resolveCNPJBranch, resolveCPFRegionDigit, resolveCPFStateFromDigits, resolveUnzipOutputPath, resolveZipOutputPath, rollDice, setJsonPathValue, shuffleRandomItems, slugifyText, stripCEP, stripCNPJ, stripCPF, subtractFromDate, testUnzip, testZip, transformBase64, transformHtmlEntities, transformUrlEncoding, trimText, truncateText, validateCEP, validateCNPJ, validateCPF, validateCreditCard, validateJsonInput };