Merge pull request #2 from bennu/feat/publish-npm

Feat/publish npm

Author: fernandoAlfaro00

.github/workflows/publish-npm.yml

@@ -22,12 +22,8 @@ jobs:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
 
-      - name: Install dependencies and generate package-lock.json
-        run: |
-          npm install
-          npm install --package-lock-only
-          git add package-lock.json
-          git commit -m "chore: update package-lock.json" || echo "No changes to commit"
+      - name: Install dependencies
+        run: npm ci
 
       - name: Update package.json with release tag
         run: |
@@ -46,6 +42,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Build TypeScript
+        run: |
+          npx tsc --target es2018 --module commonjs --declaration --outDir ./dist --strict --esModuleInterop --skipLibCheck --forceConsistentCasingInFileNames src/**/*.ts
+          ls -la dist/
+
       - name: Publish to npm
         run: npm publish --access public
         env:

dist/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Chilean RUT Validator
+ * A TypeScript package to validate Chilean RUT (Rol Único Tributario) numbers.
+ */
+export { isValidRut, cleanRut, calculateVerificationDigit, RutValidationResult } from './validate-chilean-rut';

dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Chilean RUT Validator
+ * A TypeScript package to validate Chilean RUT (Rol Único Tributario) numbers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateVerificationDigit = exports.cleanRut = exports.isValidRut = void 0;
+var validate_chilean_rut_1 = require("./validate-chilean-rut");
+Object.defineProperty(exports, "isValidRut", { enumerable: true, get: function () { return validate_chilean_rut_1.isValidRut; } });
+Object.defineProperty(exports, "cleanRut", { enumerable: true, get: function () { return validate_chilean_rut_1.cleanRut; } });
+Object.defineProperty(exports, "calculateVerificationDigit", { enumerable: true, get: function () { return validate_chilean_rut_1.calculateVerificationDigit; } });

dist/validate-chilean-rut.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Chilean RUT Validator
+ *
+ * A TypeScript implementation to validate Chilean RUT numbers.
+ *
+ * @author Created by Bennu
+ * @license MIT
+ */
+/**
+ * Interface for validation result returned by validateRut
+ */
+export interface RutValidationResult {
+    isValid: boolean;
+    formatted: string | null;
+    raw: string;
+    rutNumber?: string;
+    verificationDigit?: string;
+}
+/**
+ * Safely converts input to string and cleans a RUT by removing formatting characters
+ *
+ * @param rut - RUT input to clean
+ * @returns Cleaned RUT string
+ */
+export declare function cleanRut(rut: unknown): string;
+/**
+ * Calculates the verification digit for a given RUT
+ *
+ * @param rutNumber - RUT number without verification digit
+ * @returns Calculated verification digit
+ */
+export declare function calculateVerificationDigit(rutNumber: string | number): string;
+/**
+ * Validates if a given string is a valid Chilean RUT
+ *
+ * @param rut - RUT to validate
+ * @returns True if the RUT is valid, false otherwise
+ */
+export declare function isValidRut(rut: unknown): boolean;

dist/validate-chilean-rut.js

@@ -0,0 +1,93 @@
+"use strict";
+/**
+ * Chilean RUT Validator
+ *
+ * A TypeScript implementation to validate Chilean RUT numbers.
+ *
+ * @author Created by Bennu
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanRut = cleanRut;
+exports.calculateVerificationDigit = calculateVerificationDigit;
+exports.isValidRut = isValidRut;
+/**
+ * Safely converts input to string and cleans a RUT by removing formatting characters
+ *
+ * @param rut - RUT input to clean
+ * @returns Cleaned RUT string
+ */
+function cleanRut(rut) {
+    if (rut === null || rut === undefined) {
+        return '';
+    }
+    let rutString;
+    try {
+        rutString = String(rut);
+    }
+    catch (e) {
+        return '';
+    }
+    return rutString.replace(/[.-\s]/g, '').toUpperCase();
+}
+/**
+ * Calculates the verification digit for a given RUT
+ *
+ * @param rutNumber - RUT number without verification digit
+ * @returns Calculated verification digit
+ */
+function calculateVerificationDigit(rutNumber) {
+    // Convert to string safely
+    const rutString = String(rutNumber);
+    if (!/^\d+$/.test(rutString)) {
+        return '';
+    }
+    if (rutString.length > 20) {
+        return '';
+    }
+    const rutDigits = rutString.split('').reverse();
+    const multipliers = [2, 3, 4, 5, 6, 7, 2, 3, 4, 5, 6, 7];
+    let sum = 0;
+    for (let i = 0; i < rutDigits.length; i++) {
+        sum += parseInt(rutDigits[i], 10) * multipliers[i % multipliers.length];
+    }
+    const remainder = sum % 11;
+    const verificationDigit = 11 - remainder;
+    if (verificationDigit === 11)
+        return '0';
+    if (verificationDigit === 10)
+        return 'K';
+    return String(verificationDigit);
+}
+/**
+ * Validates if a given string is a valid Chilean RUT
+ *
+ * @param rut - RUT to validate
+ * @returns True if the RUT is valid, false otherwise
+ */
+function isValidRut(rut) {
+    try {
+        const cleanedRut = cleanRut(rut);
+        if (cleanedRut.length < 2)
+            return false;
+        if (cleanedRut.length > 20)
+            return false;
+        const rutRegex = /^(\d+)([K\d])$/;
+        if (!rutRegex.test(cleanedRut))
+            return false;
+        const match = cleanedRut.match(rutRegex);
+        if (!match || match.length !== 3)
+            return false;
+        const rutNumber = match[1];
+        const providedVerificationDigit = match[2];
+        if (rutNumber.length > 20)
+            return false;
+        const calculatedVerificationDigit = calculateVerificationDigit(rutNumber);
+        if (!calculatedVerificationDigit)
+            return false;
+        return calculatedVerificationDigit === providedVerificationDigit;
+    }
+    catch (e) {
+        return false;
+    }
+}