rut.ts 2.0.0 → 3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 @hansfpc.
+Copyright (c) 2026 Arrow Software.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,17 +3,42 @@
   <h1>Rut.ts: Handle chilean RUT values with ease using TypeScript.</h1>
 </div>
 
+## What is a RUT?
+
+The **RUT** (Rol Único Tributario) is the unique Chilean identification number used for:
+- Tax purposes
+- Legal identification
+- Government services
+- Banking and financial transactions
+
+**Format**: `XX.XXX.XXX-Y` where:
+- `X` = Body (7-8 digits)
+- `Y` = Verifier digit (0-9 or K)
+
+**Example**: `12.345.678-5`
+
+The verifier digit is calculated using the [Modulo 11 algorithm](https://en.wikipedia.org/wiki/Rol_%C3%9Anico_Tributario) to validate the RUT's authenticity.
+
+---
+
 ## Features
 
 - **Validation**: Check if a RUT is valid, with optional strict mode to detect suspicious patterns.
 - **Cleaning**: Remove extraneous characters and leading zeros from RUT strings.
 - **Formatting**: Convert RUTs into a standardized format, with or without dots.
+- **Incremental Formatting**: Format RUTs progressively as the user types (ideal for form inputs).
 - **Decomposition**: Split a RUT into its body and verifier digit.
 - **Generation**: Generate valid random RUT numbers.
 - **Calculate Verifier**: Calculate the verifier digit for a given RUT body.
+- **Format Detection**: Check if a string looks like a RUT format with `isRutLike`.
+- **Safe Mode**: All functions support `throwOnError: false` to return `null` instead of throwing errors.
 
 ## Installation
 
+Using [bun](https://bun.sh/):
+
+    $ bun add rut.ts
+
 Using [npm](https://www.npmjs.com/):
 
     $ npm install rut.ts
@@ -23,9 +48,86 @@ Using [pnpm](https://pnpm.io/):
     $ pnpm install rut.ts
 
 
+## Quick Examples
+
+```typescript
+import { validate, format, clean, isRutLike, decompose } from 'rut.ts'
+
+// Validation
+validate('12.345.678-5')                      // true
+validate('12.345.678-0')                      // false (wrong verifier)
+validate('11.111.111-1', { strict: true })    // false (strict mode rejects suspicious RUTs)
+
+// Formatting
+format('123456785')                // '12.345.678-5'
+format('123456785', { dots: false }) // '12345678-5'
+
+// Incremental formatting (for form inputs)
+format('1234', { incremental: true })     // '1.234'
+format('12345678', { incremental: true }) // '1.234.567-8' (8 chars = complete)
+format('123456785', { incremental: true }) // '12.345.678-5' (9 chars = complete)
+
+// Cleaning
+clean('12.345.678-5')              // '123456785'
+
+// Decomposition
+const { body, verifier } = decompose('12.345.678-5')
+console.log(body)      // '12345678'
+console.log(verifier)  // '5'
+
+// Format detection (without full validation)
+isRutLike('12.345.678-5')          // true
+isRutLike('not-a-rut')             // false
+
+// Safe mode (returns null instead of throwing)
+clean('invalid', { throwOnError: false })  // null
+format('abc', { throwOnError: false })     // null
+```
+
+## Incremental Formatting
+
+The `incremental` option in `format()` allows you to format RUTs progressively as the user types. This is useful for real-time formatting in form inputs.
+
+```typescript
+// Example: React input handler
+const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+  const formatted = format(e.target.value, { incremental: true })
+  setRut(formatted)
+}
+```
+
+> **Note**: Incremental formatting will format the input progressively even for incomplete RUTs. The formatted output may not represent a valid RUT until the input is complete. Always use `validate()` to verify the final RUT before processing.
+
+### When to use incremental mode
+
+**✅ Use incremental when:**
+- Formatting user input in real-time as they type
+- Providing immediate visual feedback in form fields
+- Improving UX with progressive formatting
+
+**❌ Don't use incremental when:**
+- Formatting already complete/stored RUTs (use default `format()`)
+- Validating RUTs (use `validate()` instead)
+- Processing final form submission values
+
 ## Usage
 
-Please refer to [the documentation](https://rutts-arrowsw.vercel.app/) for examples on how to use this library.
+Please refer to [the documentation](https://rutts-arrowsw.vercel.app/) for more detailed examples.
+
+
+## TypeScript Types
+
+The library exports the following types:
+
+```typescript
+import type { DecomposedRut, FormatOptions, SafeOptions, ValidateOptions, VerifierDigit } from 'rut.ts'
+
+// VerifierDigit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'K'
+// DecomposedRut: { body: string; verifier: string }
+// FormatOptions: { incremental?: boolean; dots?: boolean; throwOnError?: boolean }
+// ValidateOptions: { strict?: boolean }
+// SafeOptions: { throwOnError?: boolean }
+```
 
 
 ## Contributing

package/dist/cjs/index.d.ts

@@ -2,61 +2,144 @@ type DecomposedRut = {
     body: string;
     verifier: string;
 };
+type FormatOptions = {
+    incremental?: boolean;
+    dots?: boolean;
+    throwOnError?: boolean;
+};
+type SafeOptions = {
+    throwOnError?: boolean;
+};
+type ValidateOptions = {
+    strict?: boolean;
+};
+type VerifierDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'K';
 export declare const getInvalidRutError: (rut: string) => string;
 /**
- * Cleans the input string by removing leading zeros, non-numeric characters, and ensures the RUT is uppercased. Throws an error if the cleaned RUT is not within the valid length range or if 'K' is not in the correct position.
+ * Cleans the input string by removing leading zeros, non-numeric characters, and ensures the RUT is uppercased.
  * @param {string} rut - The RUT string to clean.
- * @returns {string} The cleaned RUT string.
- * @throws {Error} If the RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The cleaned RUT string, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is not valid and throwOnError is true.
  */
-declare const clean: (rut: string) => string;
+declare function clean(rut: string): string;
+declare function clean(rut: string, options: {
+    throwOnError: false;
+}): string | null;
+declare function clean(rut: string, options: {
+    throwOnError: true;
+}): string;
+declare function clean(rut: string, options?: SafeOptions): string | null;
 /**
  * Extracts the body (part before the verifier digit) from a given RUT string.
  * This function first cleans the input RUT string to ensure it is in a valid format before slicing.
  * @param {string} rut - The RUT string from which to extract the body.
- * @returns {string} The body of the RUT.
- * @throws {Error} If the cleaned RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The body of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the cleaned RUT is not valid and throwOnError is true.
  */
-declare const getBody: (rut: string) => string;
+declare function getBody(rut: string): string;
+declare function getBody(rut: string, options: {
+    throwOnError: false;
+}): string | null;
+declare function getBody(rut: string, options: {
+    throwOnError: true;
+}): string;
+declare function getBody(rut: string, options?: SafeOptions): string | null;
 /**
  * Extracts the verifier digit (the last character) from a given RUT string.
  * This function cleans the input RUT string to ensure it is in a valid format before extracting the verifier digit.
  * @param {string} rut - The RUT string from which to extract the verifier digit.
- * @returns {string} The verifier digit of the RUT.
- * @throws {Error} If the cleaned RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The verifier digit of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the cleaned RUT is not valid and throwOnError is true.
  */
-declare const getVerifier: (rut: string) => string;
+declare function getVerifier(rut: string): VerifierDigit;
+declare function getVerifier(rut: string, options: {
+    throwOnError: false;
+}): VerifierDigit | null;
+declare function getVerifier(rut: string, options: {
+    throwOnError: true;
+}): VerifierDigit;
+declare function getVerifier(rut: string, options?: SafeOptions): VerifierDigit | null;
 /**
  * Decomposes the given RUT into its body and verifier parts.
  * @param {string} rut - The RUT string to decompose.
- * @returns {DecomposedRut} An object containing the body and verifier of the RUT.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {DecomposedRut | null} An object containing the body and verifier of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is not valid and throwOnError is true.
+ */
+declare function decompose(rut: string): DecomposedRut;
+declare function decompose(rut: string, options: {
+    throwOnError: false;
+}): DecomposedRut | null;
+declare function decompose(rut: string, options: {
+    throwOnError: true;
+}): DecomposedRut;
+declare function decompose(rut: string, options?: SafeOptions): DecomposedRut | null;
+/**
+ * Checks if a string has a valid RUT format (without validating the verifier digit).
+ * Useful for quick format validation in UI before full validation.
+ * @param {string} rut - The string to check.
+ * @returns {boolean} True if the string looks like a RUT format, false otherwise.
  */
-declare const decompose: (rut: string) => DecomposedRut;
+declare const isRutLike: (rut: string) => boolean;
 /**
  * Calculates the verifier digit for a given RUT body.
  * @param {string} rutBody - The body of the RUT for which to calculate the verifier.
- * @returns {string} The calculated verifier digit.
- * @throws {Error} If the RUT body, after being cleaned, is empty.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The calculated verifier digit, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT body is invalid and throwOnError is true.
  */
-declare const calculateVerifier: (rutBody: string) => string;
+declare function calculateVerifier(rutBody: string): VerifierDigit;
+declare function calculateVerifier(rutBody: string, options: {
+    throwOnError: false;
+}): VerifierDigit | null;
+declare function calculateVerifier(rutBody: string, options: {
+    throwOnError: true;
+}): VerifierDigit;
+declare function calculateVerifier(rutBody: string, options?: SafeOptions): VerifierDigit | null;
 /**
  * Validates a given RUT string, optionally with strict mode to also check for suspicious patterns.
- * @param {string} rut - The RUT string to validate.
- * @param {boolean} [strict=false] - Whether to use strict mode for validation.
+ * @param {unknown} rut - The RUT string to validate.
+ * @param {ValidateOptions} [options] - Validation options.
+ * @param {boolean} [options.strict=false] - If true, rejects suspicious RUTs (e.g., 11.111.111-1).
  * @returns {boolean} True if the RUT is valid, false otherwise.
  */
-declare const validate: (rut: string, strict?: boolean) => boolean;
+declare const validate: (rut: unknown, options?: ValidateOptions) => boolean;
 /**
  * Formats a given RUT string, with options for incremental formatting and dot separators.
+ *
+ * **Note on incremental mode**: When `incremental: true`, the function formats the RUT progressively
+ * as the user types, even for incomplete RUTs. This is useful for real-time formatting in form inputs,
+ * but the formatted output may not represent a valid RUT until the input is complete.
+ * Always use `validate()` to verify the final RUT.
+ *
  * @param {string} rut - The RUT string to format.
- * @param {boolean} [incremental=false] - Whether to format the RUT incrementally.
- * @param {boolean} [dots=true] - Whether to include dot separators in the formatted RUT.
- * @returns {string} The formatted RUT string.
+ * @param {FormatOptions} [options] - The formatting options.
+ * @param {boolean} [options.incremental=false] - Whether to format the RUT incrementally (for real-time input formatting).
+ * @param {boolean} [options.dots=true] - Whether to include dot separators in the formatted RUT.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null. Ignored in incremental mode.
+ * @returns {string | null} The formatted RUT string, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is invalid and throwOnError is true (only in non-incremental mode).
  */
-declare const format: (rut: string, incremental?: boolean, dots?: boolean) => string;
+declare function format(rut: string, options?: Omit<FormatOptions, 'throwOnError'>): string;
+declare function format(rut: string, options: FormatOptions & {
+    throwOnError: false;
+}): string | null;
+declare function format(rut: string, options: FormatOptions & {
+    throwOnError: true;
+}): string;
+declare function format(rut: string, options?: FormatOptions): string | null;
 /**
  * Generates a random valid RUT string.
  * @returns {string} A randomly generated, valid RUT string.
  */
 declare const generate: () => string;
-export { validate, clean, format, calculateVerifier, getBody, getVerifier, decompose, generate };
+export { validate, clean, format, calculateVerifier, getBody, getVerifier, decompose, generate, isRutLike };
+export type { DecomposedRut, FormatOptions, SafeOptions, ValidateOptions, VerifierDigit };

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAGO,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,WAAW,GAAG,+BAA+B,CAAA;AAA3F,QAAA,kBAAkB,sBAAyE;AAExG,MAAM,cAAc,GAAG,CAAC,CAAA;AACxB,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB,MAAM,QAAQ,GAAuB;IACnC,QAAQ,EAAE,gBAAgB;IAC1B,OAAO,EAAE,oCAAoC;IAC7C,UAAU,EAAE,wCAAwC;CACrD,CAAA;AAED;;;;;GAKG;AACH,MAAM,KAAK,GAAG,CAAC,GAAW,EAAU,EAAE;IACpC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IACjE,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc;QAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;IAClH,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;IACrH,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAoHkB,sBAAK;AAlHxB;;;;;;GAMG;AACH,MAAM,OAAO,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AA2GX,0BAAO;AAzG5D;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAkGH,kCAAW;AAhGzE;;;;GAIG;AACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAiB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AA2F3B,8BAAS;AAzFpF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAEtE,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAU,EAAE;IACpD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACjC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;IAEzE,MAAM,GAAG,GAAG,UAAU;SACnB,KAAK,CAAC,EAAE,CAAC;SACT,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE5E,MAAM,UAAU,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;IAClC,OAAO,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA;AAClF,CAAC,CAAA;AAoEiC,8CAAiB;AAlEnD;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,MAAgB,EAAW,EAAE;IAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAE7C,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;IACzC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAElD,OAAO,kBAAkB,KAAK,QAAQ,CAAA;AACxC,CAAC,CAAA;AAoDQ,4BAAQ;AAlDjB;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,cAAuB,KAAK,EAAE,OAAgB,IAAI,EAAU,EAAE;IACzF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAC/B,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,GAAG,CAAA;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;IAE3B,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,2BAA2B;QAC3D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,6BAA6B;QAC9E,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;YACvE,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,wBAAwB;YAC7F,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAA,CAAC,uBAAuB;YACtF,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;QACpD,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC9E,CAAC,CAAA;AAYyB,wBAAM;AAVhC;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAW,EAAE;IAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACxC,OAAO,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;AAChC,CAAC,CAAA;AAEqF,4BAAQ"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAOO,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,WAAW,GAAG,+BAA+B,CAAA;AAA3F,QAAA,kBAAkB,sBAAyE;AAExG,sEAAsE;AACtE,MAAM,eAAe,GAAG,CAAC,YAAsB,EAA6B,EAAE,CAAC,CAAC;IAC9E,YAAY,EAAE,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI;CACnC,CAAC,CAAA;AAEF,MAAM,cAAc,GAAG,CAAC,CAAA;AACxB,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB,+FAA+F;AAC/F,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;AAEzF,MAAM,QAAQ,GAAuB;IACnC,QAAQ,EAAE,gBAAgB;IAC1B,OAAO,EAAE,oCAAoC;IAC7C,UAAU,EAAE,wCAAwC;CACrD,CAAA;AAcD,SAAS,KAAK,CAAC,GAAW,EAAE,OAAqB;;IAC/C,MAAM,WAAW,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,IAAI,CAAA;IACjD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAEjE,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;QACzE,IAAI,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,IAAI,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AA8NkB,sBAAK;AA/MxB,SAAS,OAAO,CAAC,GAAW,EAAE,OAAqB;;IACjD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAC,CAAA;IAClE,OAAO,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAA;AACtC,CAAC;AA4MoD,0BAAO;AA7L5D,SAAS,WAAW,CAAC,GAAW,EAAE,OAAqB;;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAC,CAAA;IAClE,OAAO,MAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,CAAC,CAAC,CAAmB,mCAAI,IAAI,CAAA;AACtD,CAAC;AA0L6D,kCAAW;AA5KzE,SAAS,SAAS,CAAC,GAAW,EAAE,OAAqB;IACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IACnC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAE3C,IAAI,IAAI,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IACnD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAqK0E,8BAAS;AAnKpF;;;;;GAKG;AACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AA6J0B,8BAAS;AA3JzG;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAc5E,SAAS,iBAAiB,CAAC,OAAe,EAAE,OAAqB;IAC/D,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAA;IAEvD,0FAA0F;IAC1F,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAA;IAEpC,wDAAwD;IACxD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,IAAI,QAAQ,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,yDAAyD;IACzD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,IAAI,QAAQ,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,GAAG,GAAG,UAAU;SACnB,KAAK,CAAC,EAAE,CAAC;SACT,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE5E,MAAM,UAAU,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;IAClC,OAAO,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAkB,CAAA;AACrG,CAAC;AA8GiC,8CAAiB;AA5GnD;;;;;;GAMG;AACH,MAAM,QAAQ,GAAG,CAAC,GAAY,EAAE,OAAyB,EAAW,EAAE;IACpE,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAEtD,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1D,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAA;IACtF,IAAI,CAAC,kBAAkB;QAAE,OAAO,KAAK,CAAA;IAErC,OAAO,kBAAkB,KAAK,UAAU,CAAC,QAAQ,CAAA;AACnD,CAAC,CAAA;AAyFQ,4BAAQ;AAnEjB,SAAS,MAAM,CAAC,GAAW,EAAE,OAAuB;;IAClD,MAAM,IAAI,GAAG;QACX,WAAW,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,KAAK;QAC1C,IAAI,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,IAAI;QAC3B,YAAY,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,IAAI;KAC5C,CAAA;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAE/B,mEAAmE;IACnE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAEpC,yDAAyD;QACzD,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC;gBAAE,OAAO,QAAQ,CAAA;YAEvD,qCAAqC;YACrC,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;gBACvE,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;YACpE,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,oEAAoE;QACpE,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,iBAAiB;QACjD,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,+BAA+B;QAE9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;YACvE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAA;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,wCAAwC;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAA;IAC/D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAElC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;QACpD,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC9E,CAAC;AAYyB,wBAAM;AAVhC;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAW,EAAE;IAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACxC,OAAO,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;AAChC,CAAC,CAAA;AAEqF,4BAAQ"}

package/dist/cjs/index.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.generate=exports.decompose=exports.getVerifier=exports.getBody=exports.calculateVerifier=exports.format=exports.clean=exports.validate=exports.getInvalidRutError=void 0;const getInvalidRutError=e=>`String "${e}" is not valid as a RUT input`;exports.getInvalidRutError=getInvalidRutError;const MIN_RUT_LENGTH=8,MAX_RUT_LENGTH=9,patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|k)?$/},clean=e=>{const t=e.replace(patterns.cleaning,"").toUpperCase();if(t.length<8||t.length>9)throw new Error((0,exports.getInvalidRutError)(e));if(t.includes("K")&&t.indexOf("K")!==t.length-1)throw new Error((0,exports.getInvalidRutError)(e));return t};exports.clean=clean;const getBody=e=>clean(e).slice(0,-1);exports.getBody=getBody;const getVerifier=e=>clean(e).slice(-1);exports.getVerifier=getVerifier;const decompose=e=>({body:getBody(e),verifier:getVerifier(e)});exports.decompose=decompose;const isRutLike=e=>patterns.rutLike.test(e),isSuspicious=e=>patterns.suspicious.test(e),calculateVerifier=e=>{const t=clean(e);if(0===t.length)throw new Error((0,exports.getInvalidRutError)(e));const r=11-t.split("").reverse().reduce(((e,t,r)=>e+Number(t)*(r%6+2)),0)%11;return 11===r?"0":10===r?"K":r.toString()};exports.calculateVerifier=calculateVerifier;const validate=(e,t)=>{if(!isRutLike(e))return!1;if(t&&isSuspicious(e))return!1;const{body:r,verifier:o}=decompose(e);return calculateVerifier(r)===o};exports.validate=validate;const format=(e,t=!1,r=!0)=>{if(0===e.length)return"";if(e.length<=6&&!r)return e;const o=clean(e);if(t){let e=o.slice(-1);o.length>1&&(e=o.slice(-4,-1)+"-"+e);for(let t=4;t<o.length;t+=3){const i=o.length-3-t<0?0:o.length-3-t;e=r?o.slice(i,o.length-t)+"."+e:o.slice(i,o.length-t)+e}return e}if(r){let e=o.slice(-4,-1)+"-"+o.substring(o.length-1);for(let t=4;t<o.length;t+=3)e=o.slice(-3-t,-t)+"."+e;return e}return o.slice(0,-1)+"-"+o.substring(o.length-1)};exports.format=format;const generate=()=>{const e=Math.floor(10000003+9e7*Math.random()).toString(),t=calculateVerifier(e);return format(e+t)};exports.generate=generate;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.isRutLike=exports.generate=exports.decompose=exports.getVerifier=exports.getBody=exports.calculateVerifier=exports.format=exports.clean=exports.validate=exports.getInvalidRutError=void 0;const getInvalidRutError=r=>`String "${r}" is not valid as a RUT input`;exports.getInvalidRutError=getInvalidRutError;const withThrowOption=r=>({throwOnError:null==r||r}),MIN_RUT_LENGTH=8,MAX_RUT_LENGTH=9,cleanRaw=r=>r.replace(/^0+|[^0-9kK]+/g,"").toUpperCase(),patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|k)?$/};function clean(r,t){var e;const n=null===(e=null==t?void 0:t.throwOnError)||void 0===e||e,o=r.replace(patterns.cleaning,"").toUpperCase();if(o.length<MIN_RUT_LENGTH||o.length>MAX_RUT_LENGTH){if(n)throw new Error((0,exports.getInvalidRutError)(r));return null}if(o.includes("K")&&o.indexOf("K")!==o.length-1){if(n)throw new Error((0,exports.getInvalidRutError)(r));return null}return o}function getBody(r,t){var e;const n=clean(r,withThrowOption(null==t?void 0:t.throwOnError));return null!==(e=null==n?void 0:n.slice(0,-1))&&void 0!==e?e:null}function getVerifier(r,t){var e;const n=clean(r,withThrowOption(null==t?void 0:t.throwOnError));return null!==(e=null==n?void 0:n.slice(-1))&&void 0!==e?e:null}function decompose(r,t){const e=withThrowOption(null==t?void 0:t.throwOnError),n=getBody(r,e),o=getVerifier(r,e);return null===n||null===o?null:{body:n,verifier:o}}exports.clean=clean,exports.getBody=getBody,exports.getVerifier=getVerifier,exports.decompose=decompose;const isRutLike=r=>patterns.rutLike.test(r);exports.isRutLike=isRutLike;const isSuspicious=r=>patterns.suspicious.test(r);function calculateVerifier(r,t){const e=withThrowOption(null==t?void 0:t.throwOnError),n=cleanRaw(r);if(n.length<7||n.length>8){if(e.throwOnError)throw new Error((0,exports.getInvalidRutError)(r));return null}if(!/^\d+$/.test(n)){if(e.throwOnError)throw new Error((0,exports.getInvalidRutError)(r));return null}const o=11-n.split("").reverse().reduce(((r,t,e)=>r+Number(t)*(e%6+2)),0)%11;return 11===o?"0":10===o?"K":o.toString()}exports.calculateVerifier=calculateVerifier;const validate=(r,t)=>{if("string"!=typeof r||0===r.length)return!1;if(!isRutLike(r))return!1;if((null==t?void 0:t.strict)&&isSuspicious(r))return!1;const e=decompose(r,{throwOnError:!1});if(!e)return!1;const n=calculateVerifier(e.body,{throwOnError:!1});return!!n&&n===e.verifier};function format(r,t){var e,n,o;const i={incremental:null!==(e=null==t?void 0:t.incremental)&&void 0!==e&&e,dots:null===(n=null==t?void 0:t.dots)||void 0===n||n,throwOnError:null===(o=null==t?void 0:t.throwOnError)||void 0===o||o};if(0===r.length)return"";if(i.incremental){const t=cleanRaw(r);if(0===t.length)return"";if(t.length<MIN_RUT_LENGTH){if(!i.dots||t.length<=3)return t;let r=t.slice(-3);for(let e=3;e<t.length;e+=3){const n=t.length-3-e<0?0:t.length-3-e;r=t.slice(n,t.length-e)+"."+r}return r}let e=t.slice(-1);e=t.slice(-4,-1)+"-"+e;for(let r=4;r<t.length;r+=3){const n=t.length-3-r<0?0:t.length-3-r;e=i.dots?t.slice(n,t.length-r)+"."+e:t.slice(n,t.length-r)+e}return e}const l=clean(r,withThrowOption(i.throwOnError));if(null===l)return null;if(i.dots){let r=l.slice(-4,-1)+"-"+l.substring(l.length-1);for(let t=4;t<l.length;t+=3)r=l.slice(-3-t,-t)+"."+r;return r}return l.slice(0,-1)+"-"+l.substring(l.length-1)}exports.validate=validate,exports.format=format;const generate=()=>{const r=Math.floor(10000003+9e7*Math.random()).toString();return format(r+calculateVerifier(r))};exports.generate=generate;

package/dist/esm/index.d.ts

@@ -2,61 +2,144 @@ type DecomposedRut = {
     body: string;
     verifier: string;
 };
+type FormatOptions = {
+    incremental?: boolean;
+    dots?: boolean;
+    throwOnError?: boolean;
+};
+type SafeOptions = {
+    throwOnError?: boolean;
+};
+type ValidateOptions = {
+    strict?: boolean;
+};
+type VerifierDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'K';
 export declare const getInvalidRutError: (rut: string) => string;
 /**
- * Cleans the input string by removing leading zeros, non-numeric characters, and ensures the RUT is uppercased. Throws an error if the cleaned RUT is not within the valid length range or if 'K' is not in the correct position.
+ * Cleans the input string by removing leading zeros, non-numeric characters, and ensures the RUT is uppercased.
  * @param {string} rut - The RUT string to clean.
- * @returns {string} The cleaned RUT string.
- * @throws {Error} If the RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The cleaned RUT string, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is not valid and throwOnError is true.
  */
-declare const clean: (rut: string) => string;
+declare function clean(rut: string): string;
+declare function clean(rut: string, options: {
+    throwOnError: false;
+}): string | null;
+declare function clean(rut: string, options: {
+    throwOnError: true;
+}): string;
+declare function clean(rut: string, options?: SafeOptions): string | null;
 /**
  * Extracts the body (part before the verifier digit) from a given RUT string.
  * This function first cleans the input RUT string to ensure it is in a valid format before slicing.
  * @param {string} rut - The RUT string from which to extract the body.
- * @returns {string} The body of the RUT.
- * @throws {Error} If the cleaned RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The body of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the cleaned RUT is not valid and throwOnError is true.
  */
-declare const getBody: (rut: string) => string;
+declare function getBody(rut: string): string;
+declare function getBody(rut: string, options: {
+    throwOnError: false;
+}): string | null;
+declare function getBody(rut: string, options: {
+    throwOnError: true;
+}): string;
+declare function getBody(rut: string, options?: SafeOptions): string | null;
 /**
  * Extracts the verifier digit (the last character) from a given RUT string.
  * This function cleans the input RUT string to ensure it is in a valid format before extracting the verifier digit.
  * @param {string} rut - The RUT string from which to extract the verifier digit.
- * @returns {string} The verifier digit of the RUT.
- * @throws {Error} If the cleaned RUT is not valid.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The verifier digit of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the cleaned RUT is not valid and throwOnError is true.
  */
-declare const getVerifier: (rut: string) => string;
+declare function getVerifier(rut: string): VerifierDigit;
+declare function getVerifier(rut: string, options: {
+    throwOnError: false;
+}): VerifierDigit | null;
+declare function getVerifier(rut: string, options: {
+    throwOnError: true;
+}): VerifierDigit;
+declare function getVerifier(rut: string, options?: SafeOptions): VerifierDigit | null;
 /**
  * Decomposes the given RUT into its body and verifier parts.
  * @param {string} rut - The RUT string to decompose.
- * @returns {DecomposedRut} An object containing the body and verifier of the RUT.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {DecomposedRut | null} An object containing the body and verifier of the RUT, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is not valid and throwOnError is true.
+ */
+declare function decompose(rut: string): DecomposedRut;
+declare function decompose(rut: string, options: {
+    throwOnError: false;
+}): DecomposedRut | null;
+declare function decompose(rut: string, options: {
+    throwOnError: true;
+}): DecomposedRut;
+declare function decompose(rut: string, options?: SafeOptions): DecomposedRut | null;
+/**
+ * Checks if a string has a valid RUT format (without validating the verifier digit).
+ * Useful for quick format validation in UI before full validation.
+ * @param {string} rut - The string to check.
+ * @returns {boolean} True if the string looks like a RUT format, false otherwise.
  */
-declare const decompose: (rut: string) => DecomposedRut;
+declare const isRutLike: (rut: string) => boolean;
 /**
  * Calculates the verifier digit for a given RUT body.
  * @param {string} rutBody - The body of the RUT for which to calculate the verifier.
- * @returns {string} The calculated verifier digit.
- * @throws {Error} If the RUT body, after being cleaned, is empty.
+ * @param {SafeOptions} [options] - Configuration options.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null.
+ * @returns {string | null} The calculated verifier digit, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT body is invalid and throwOnError is true.
  */
-declare const calculateVerifier: (rutBody: string) => string;
+declare function calculateVerifier(rutBody: string): VerifierDigit;
+declare function calculateVerifier(rutBody: string, options: {
+    throwOnError: false;
+}): VerifierDigit | null;
+declare function calculateVerifier(rutBody: string, options: {
+    throwOnError: true;
+}): VerifierDigit;
+declare function calculateVerifier(rutBody: string, options?: SafeOptions): VerifierDigit | null;
 /**
  * Validates a given RUT string, optionally with strict mode to also check for suspicious patterns.
- * @param {string} rut - The RUT string to validate.
- * @param {boolean} [strict=false] - Whether to use strict mode for validation.
+ * @param {unknown} rut - The RUT string to validate.
+ * @param {ValidateOptions} [options] - Validation options.
+ * @param {boolean} [options.strict=false] - If true, rejects suspicious RUTs (e.g., 11.111.111-1).
  * @returns {boolean} True if the RUT is valid, false otherwise.
  */
-declare const validate: (rut: string, strict?: boolean) => boolean;
+declare const validate: (rut: unknown, options?: ValidateOptions) => boolean;
 /**
  * Formats a given RUT string, with options for incremental formatting and dot separators.
+ *
+ * **Note on incremental mode**: When `incremental: true`, the function formats the RUT progressively
+ * as the user types, even for incomplete RUTs. This is useful for real-time formatting in form inputs,
+ * but the formatted output may not represent a valid RUT until the input is complete.
+ * Always use `validate()` to verify the final RUT.
+ *
  * @param {string} rut - The RUT string to format.
- * @param {boolean} [incremental=false] - Whether to format the RUT incrementally.
- * @param {boolean} [dots=true] - Whether to include dot separators in the formatted RUT.
- * @returns {string} The formatted RUT string.
+ * @param {FormatOptions} [options] - The formatting options.
+ * @param {boolean} [options.incremental=false] - Whether to format the RUT incrementally (for real-time input formatting).
+ * @param {boolean} [options.dots=true] - Whether to include dot separators in the formatted RUT.
+ * @param {boolean} [options.throwOnError=true] - If true (default), throws an error for invalid RUTs. If false, returns null. Ignored in incremental mode.
+ * @returns {string | null} The formatted RUT string, or null if invalid and throwOnError is false.
+ * @throws {Error} If the RUT is invalid and throwOnError is true (only in non-incremental mode).
  */
-declare const format: (rut: string, incremental?: boolean, dots?: boolean) => string;
+declare function format(rut: string, options?: Omit<FormatOptions, 'throwOnError'>): string;
+declare function format(rut: string, options: FormatOptions & {
+    throwOnError: false;
+}): string | null;
+declare function format(rut: string, options: FormatOptions & {
+    throwOnError: true;
+}): string;
+declare function format(rut: string, options?: FormatOptions): string | null;
 /**
  * Generates a random valid RUT string.
  * @returns {string} A randomly generated, valid RUT string.
  */
 declare const generate: () => string;
-export { validate, clean, format, calculateVerifier, getBody, getVerifier, decompose, generate };
+export { validate, clean, format, calculateVerifier, getBody, getVerifier, decompose, generate, isRutLike };
+export type { DecomposedRut, FormatOptions, SafeOptions, ValidateOptions, VerifierDigit };

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,WAAW,GAAG,+BAA+B,CAAA;AAExG,MAAM,cAAc,GAAG,CAAC,CAAA;AACxB,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB,MAAM,QAAQ,GAAuB;IACnC,QAAQ,EAAE,gBAAgB;IAC1B,OAAO,EAAE,oCAAoC;IAC7C,UAAU,EAAE,wCAAwC;CACrD,CAAA;AAED;;;;;GAKG;AACH,MAAM,KAAK,GAAG,CAAC,GAAW,EAAU,EAAE;IACpC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IACjE,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;IAClH,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;IACrH,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,OAAO,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAEhE;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE;;;;GAIG;AACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAiB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AAEtG,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAEtE,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAU,EAAE;IACpD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACjC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;IAEzE,MAAM,GAAG,GAAG,UAAU;SACnB,KAAK,CAAC,EAAE,CAAC;SACT,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE5E,MAAM,UAAU,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;IAClC,OAAO,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA;AAClF,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,MAAgB,EAAW,EAAE;IAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAE7C,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;IACzC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAElD,OAAO,kBAAkB,KAAK,QAAQ,CAAA;AACxC,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,cAAuB,KAAK,EAAE,OAAgB,IAAI,EAAU,EAAE;IACzF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAC/B,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,GAAG,CAAA;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;IAE3B,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,2BAA2B;QAC3D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,6BAA6B;QAC9E,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;YACvE,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,wBAAwB;YAC7F,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAA,CAAC,uBAAuB;YACtF,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;QACpD,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC9E,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAW,EAAE;IAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACxC,OAAO,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;AAChC,CAAC,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,WAAW,GAAG,+BAA+B,CAAA;AAExG,sEAAsE;AACtE,MAAM,eAAe,GAAG,CAAC,YAAsB,EAA6B,EAAE,CAAC,CAAC;IAC9E,YAAY,EAAE,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI;CACnC,CAAC,CAAA;AAEF,MAAM,cAAc,GAAG,CAAC,CAAA;AACxB,MAAM,cAAc,GAAG,CAAC,CAAA;AAExB,+FAA+F;AAC/F,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;AAEzF,MAAM,QAAQ,GAAuB;IACnC,QAAQ,EAAE,gBAAgB;IAC1B,OAAO,EAAE,oCAAoC;IAC7C,UAAU,EAAE,wCAAwC;CACrD,CAAA;AAcD,SAAS,KAAK,CAAC,GAAW,EAAE,OAAqB;;IAC/C,MAAM,WAAW,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,IAAI,CAAA;IACjD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAEjE,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;QACzE,IAAI,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,IAAI,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAeD,SAAS,OAAO,CAAC,GAAW,EAAE,OAAqB;;IACjD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAC,CAAA;IAClE,OAAO,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAA;AACtC,CAAC;AAeD,SAAS,WAAW,CAAC,GAAW,EAAE,OAAqB;;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAC,CAAA;IAClE,OAAO,MAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,CAAC,CAAC,CAAmB,mCAAI,IAAI,CAAA;AACtD,CAAC;AAcD,SAAS,SAAS,CAAC,GAAW,EAAE,OAAqB;IACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IACnC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAE3C,IAAI,IAAI,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IACnD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAEtE;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAc5E,SAAS,iBAAiB,CAAC,OAAe,EAAE,OAAqB;IAC/D,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC,CAAA;IAEvD,0FAA0F;IAC1F,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAA;IAEpC,wDAAwD;IACxD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,IAAI,QAAQ,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,yDAAyD;IACzD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,IAAI,QAAQ,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,GAAG,GAAG,UAAU;SACnB,KAAK,CAAC,EAAE,CAAC;SACT,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE5E,MAAM,UAAU,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;IAClC,OAAO,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAkB,CAAA;AACrG,CAAC;AAED;;;;;;GAMG;AACH,MAAM,QAAQ,GAAG,CAAC,GAAY,EAAE,OAAyB,EAAW,EAAE;IACpE,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,YAAY,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAEtD,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1D,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAA;IACtF,IAAI,CAAC,kBAAkB;QAAE,OAAO,KAAK,CAAA;IAErC,OAAO,kBAAkB,KAAK,UAAU,CAAC,QAAQ,CAAA;AACnD,CAAC,CAAA;AAsBD,SAAS,MAAM,CAAC,GAAW,EAAE,OAAuB;;IAClD,MAAM,IAAI,GAAG;QACX,WAAW,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,KAAK;QAC1C,IAAI,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,IAAI;QAC3B,YAAY,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,IAAI;KAC5C,CAAA;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAE/B,mEAAmE;IACnE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAEpC,yDAAyD;QACzD,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC;gBAAE,OAAO,QAAQ,CAAA;YAEvD,qCAAqC;YACrC,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;gBACvE,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;YACpE,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,oEAAoE;QACpE,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,iBAAiB;QACjD,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA,CAAC,+BAA+B;QAE9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA;YACvE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAA;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,wCAAwC;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAA;IAC/D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAElC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAA;QACpD,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC9E,CAAC;AAED;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAW,EAAE;IAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACxC,OAAO,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;AAChC,CAAC,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAA"}

package/dist/esm/index.min.js

@@ -1 +1 @@
-export const getInvalidRutError=e=>`String "${e}" is not valid as a RUT input`;const MIN_RUT_LENGTH=8,MAX_RUT_LENGTH=9,patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|k)?$/},clean=e=>{const t=e.replace(patterns.cleaning,"").toUpperCase();if(t.length<8||t.length>9)throw new Error(getInvalidRutError(e));if(t.includes("K")&&t.indexOf("K")!==t.length-1)throw new Error(getInvalidRutError(e));return t},getBody=e=>clean(e).slice(0,-1),getVerifier=e=>clean(e).slice(-1),decompose=e=>({body:getBody(e),verifier:getVerifier(e)}),isRutLike=e=>patterns.rutLike.test(e),isSuspicious=e=>patterns.suspicious.test(e),calculateVerifier=e=>{const t=clean(e);if(0===t.length)throw new Error(getInvalidRutError(e));const r=11-t.split("").reverse().reduce(((e,t,r)=>e+Number(t)*(r%6+2)),0)%11;return 11===r?"0":10===r?"K":r.toString()},validate=(e,t)=>{if(!isRutLike(e))return!1;if(t&&isSuspicious(e))return!1;const{body:r,verifier:i}=decompose(e);return calculateVerifier(r)===i},format=(e,t=!1,r=!0)=>{if(0===e.length)return"";if(e.length<=6&&!r)return e;const i=clean(e);if(t){let e=i.slice(-1);i.length>1&&(e=i.slice(-4,-1)+"-"+e);for(let t=4;t<i.length;t+=3){const n=i.length-3-t<0?0:i.length-3-t;e=r?i.slice(n,i.length-t)+"."+e:i.slice(n,i.length-t)+e}return e}if(r){let e=i.slice(-4,-1)+"-"+i.substring(i.length-1);for(let t=4;t<i.length;t+=3)e=i.slice(-3-t,-t)+"."+e;return e}return i.slice(0,-1)+"-"+i.substring(i.length-1)},generate=()=>{const e=Math.floor(10000003+9e7*Math.random()).toString(),t=calculateVerifier(e);return format(e+t)};export{validate,clean,format,calculateVerifier,getBody,getVerifier,decompose,generate};
+export const getInvalidRutError=r=>`String "${r}" is not valid as a RUT input`;const withThrowOption=r=>({throwOnError:null==r||r}),MIN_RUT_LENGTH=8,MAX_RUT_LENGTH=9,cleanRaw=r=>r.replace(/^0+|[^0-9kK]+/g,"").toUpperCase(),patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|k)?$/};function clean(r,t){var n;const e=null===(n=null==t?void 0:t.throwOnError)||void 0===n||n,l=r.replace(patterns.cleaning,"").toUpperCase();if(l.length<MIN_RUT_LENGTH||l.length>MAX_RUT_LENGTH){if(e)throw new Error(getInvalidRutError(r));return null}if(l.includes("K")&&l.indexOf("K")!==l.length-1){if(e)throw new Error(getInvalidRutError(r));return null}return l}function getBody(r,t){var n;const e=clean(r,withThrowOption(null==t?void 0:t.throwOnError));return null!==(n=null==e?void 0:e.slice(0,-1))&&void 0!==n?n:null}function getVerifier(r,t){var n;const e=clean(r,withThrowOption(null==t?void 0:t.throwOnError));return null!==(n=null==e?void 0:e.slice(-1))&&void 0!==n?n:null}function decompose(r,t){const n=withThrowOption(null==t?void 0:t.throwOnError),e=getBody(r,n),l=getVerifier(r,n);return null===e||null===l?null:{body:e,verifier:l}}const isRutLike=r=>patterns.rutLike.test(r),isSuspicious=r=>patterns.suspicious.test(r);function calculateVerifier(r,t){const n=withThrowOption(null==t?void 0:t.throwOnError),e=cleanRaw(r);if(e.length<7||e.length>8){if(n.throwOnError)throw new Error(getInvalidRutError(r));return null}if(!/^\d+$/.test(e)){if(n.throwOnError)throw new Error(getInvalidRutError(r));return null}const l=11-e.split("").reverse().reduce(((r,t,n)=>r+Number(t)*(n%6+2)),0)%11;return 11===l?"0":10===l?"K":l.toString()}const validate=(r,t)=>{if("string"!=typeof r||0===r.length)return!1;if(!isRutLike(r))return!1;if((null==t?void 0:t.strict)&&isSuspicious(r))return!1;const n=decompose(r,{throwOnError:!1});if(!n)return!1;const e=calculateVerifier(n.body,{throwOnError:!1});return!!e&&e===n.verifier};function format(r,t){var n,e,l;const o={incremental:null!==(n=null==t?void 0:t.incremental)&&void 0!==n&&n,dots:null===(e=null==t?void 0:t.dots)||void 0===e||e,throwOnError:null===(l=null==t?void 0:t.throwOnError)||void 0===l||l};if(0===r.length)return"";if(o.incremental){const t=cleanRaw(r);if(0===t.length)return"";if(t.length<MIN_RUT_LENGTH){if(!o.dots||t.length<=3)return t;let r=t.slice(-3);for(let n=3;n<t.length;n+=3){const e=t.length-3-n<0?0:t.length-3-n;r=t.slice(e,t.length-n)+"."+r}return r}let n=t.slice(-1);n=t.slice(-4,-1)+"-"+n;for(let r=4;r<t.length;r+=3){const e=t.length-3-r<0?0:t.length-3-r;n=o.dots?t.slice(e,t.length-r)+"."+n:t.slice(e,t.length-r)+n}return n}const i=clean(r,withThrowOption(o.throwOnError));if(null===i)return null;if(o.dots){let r=i.slice(-4,-1)+"-"+i.substring(i.length-1);for(let t=4;t<i.length;t+=3)r=i.slice(-3-t,-t)+"."+r;return r}return i.slice(0,-1)+"-"+i.substring(i.length-1)}const generate=()=>{const r=Math.floor(10000003+9e7*Math.random()).toString();return format(r+calculateVerifier(r))};export{validate,clean,format,calculateVerifier,getBody,getVerifier,decompose,generate,isRutLike};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "rut.ts",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Handle chilean RUT values with ease.",
-  "author": "hansfpc",
+  "author": "arrowsw",
   "main": "./dist/cjs/index.min.js",
   "module": "./dist/esm/index.min.js",
   "types": "./dist/esm/index.d.ts",
@@ -22,20 +22,20 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@next/eslint-plugin-next": "14.2.3",
-    "@types/jest": "29.5.12",
-    "@typescript-eslint/eslint-plugin": "7.7.1",
-    "@typescript-eslint/parser": "7.7.1",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-react": "7.34.1",
-    "eslint-plugin-react-hooks": "4.6.0",
-    "jest": "29.7.0",
-    "prettier": "3.2.5",
-    "terser": "5.31.0",
-    "ts-jest": "29.1.2",
-    "typescript": "5.4.5"
+    "@next/eslint-plugin-next": "16.1.4",
+    "@types/jest": "30.0.0",
+    "@typescript-eslint/eslint-plugin": "8.53.1",
+    "@typescript-eslint/parser": "8.53.1",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-prettier": "5.5.5",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "7.0.1",
+    "jest": "30.2.0",
+    "prettier": "3.8.1",
+    "terser": "5.46.0",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3"
   },
   "keywords": [
     "validation",
@@ -58,4 +58,4 @@
     "LICENSE",
     "README.md"
   ]
-}
+}