rut.ts 1.2.0 → 1.3.0

package/README.md

@@ -1,23 +1,32 @@
 <div align="center">
   <img src="https://user-images.githubusercontent.com/12705403/158434864-7f13401a-b973-4267-b035-d9882cf6c545.png" alt="Rut.ts logo" width="100%">
-  <h1>Rut.ts: Handle chilean RUT values with ease</h1>
+  <h1>Rut.ts: Handle chilean RUT values with ease using TypeScript.</h1>
 </div>
 
+## Features
 
-This is an isomorphic TypeScript library. Just ~5kb.
+- **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.
+- **Decomposition**: Split a RUT into its body and verifier digit.
+- **Generation**: Generate valid random RUT numbers.
 
-### Installation
+## Installation
 
 Using [npm](https://www.npmjs.com/):
 
-    $ npm i rut.ts
+    $ npm install rut.ts
 
+Using [pnpm](https://pnpm.io/):
 
-Using [yarn](https://yarnpkg.com/):
+    $ pnpm install rut.ts
 
-    $ yarn add rut.ts
 
+## Usage
 
-### Basic Usage
+Please refer to [the documentation](https://rutts-arrowsw.vercel.app/) for examples on how to use this library.
 
-Description is pending...
+
+## Contributing
+
+Contributions to this library are welcome. Please feel free to submit pull requests or create issues for bugs and feature requests.

package/dist/cjs/index.min.js

@@ -0,0 +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=void 0;const getInvalidRutError=e=>`String "${e}" is not valid as a RUT input`,patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|kK)?$/gi},clean=e=>{const t=e.toUpperCase().replace(patterns.cleaning,"");if(t.length<8||t.length>9)throw new Error(getInvalidRutError(e));return t};exports.clean=clean;const isRutLike=e=>patterns.rutLike.test(e),isSuspicious=e=>patterns.suspicious.test(e),validate=(e,t)=>{if(!isRutLike(e))return!1;if(t&&isSuspicious(e))return!1;const r=clean(e);let o=parseInt(r.slice(0,-1),10),s=0,i=1;for(;o>0;)i=(i+o%10*(9-s++%6))%11,o=Math.floor(o/10);return(i>0?""+(i-1):"K")===r.slice(-1)};exports.validate=validate;const format=(e,t=!0)=>{if(0===e.length)return"";const r=clean(e);if(t){let e=r.slice(-4,-1)+"-"+r.substring(r.length-1);for(let t=4;t<r.length;t+=3)e=r.slice(-3-t,-t)+"."+e;return e}return r.slice(0,-1)+"-"+r.substring(r.length-1)};exports.format=format;const calculateVerifier=e=>{const t=Array.from(clean(e),Number);if(0===t.length||t.includes(NaN))throw new Error(getInvalidRutError(e));const r=11-t.reverse().reduce(((e,t,r)=>e+t*(r%6+2)),0)%11;return 10===r?"K":11===r?"0":`${r}`};exports.calculateVerifier=calculateVerifier;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 generate=()=>{const e=Math.floor(24e6*Math.random()+1e6).toString(),t=calculateVerifier(e);return format(e+t)};exports.generate=generate;

package/dist/esm/index.min.js

@@ -0,0 +1 @@
+const getInvalidRutError=e=>`String "${e}" is not valid as a RUT input`,patterns={cleaning:/^0+|[^0-9kK]+/g,rutLike:/^0*(\d{1,3}(\.?\d{3})*)-?([\dkK])$/,suspicious:/^(\d)\1?\.?(\1{3})\.?(\1{3})-?(\d|kK)?$/gi},clean=e=>{const r=e.toUpperCase().replace(patterns.cleaning,"");if(r.length<8||r.length>9)throw new Error(getInvalidRutError(e));return r},isRutLike=e=>patterns.rutLike.test(e),isSuspicious=e=>patterns.suspicious.test(e),validate=(e,r)=>{if(!isRutLike(e))return!1;if(r&&isSuspicious(e))return!1;const t=clean(e);let i=parseInt(t.slice(0,-1),10),n=0,s=1;for(;i>0;)s=(s+i%10*(9-n++%6))%11,i=Math.floor(i/10);return(s>0?""+(s-1):"K")===t.slice(-1)},format=(e,r=!0)=>{if(0===e.length)return"";const t=clean(e);if(r){let e=t.slice(-4,-1)+"-"+t.substring(t.length-1);for(let r=4;r<t.length;r+=3)e=t.slice(-3-r,-r)+"."+e;return e}return t.slice(0,-1)+"-"+t.substring(t.length-1)},calculateVerifier=e=>{const r=Array.from(clean(e),Number);if(0===r.length||r.includes(NaN))throw new Error(getInvalidRutError(e));const t=11-r.reverse().reduce(((e,r,t)=>e+r*(t%6+2)),0)%11;return 10===t?"K":11===t?"0":`${t}`},getBody=e=>clean(e).slice(0,-1),getVerifier=e=>clean(e).slice(-1),decompose=e=>({body:getBody(e),verifier:getVerifier(e)}),generate=()=>{const e=Math.floor(24e6*Math.random()+1e6).toString(),r=calculateVerifier(e);return format(e+r)};export{validate,clean,format,calculateVerifier,getBody,getVerifier,decompose,generate};

package/package.json

@@ -1,23 +1,27 @@
 {
   "name": "rut.ts",
-  "version": "1.2.0",
-  "description": "The ultimate tool for handling Chilean RUT values in both Node.js and the browser.",
+  "version": "1.3.0",
+  "description": "Handle chilean RUT values with ease.",
   "author": "hansfpc",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.min.js",
+  "module": "./dist/esm/index.min.js",
   "types": "./dist/esm/index.d.ts",
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
+    "build": "npm run build:esm && npm run build:cjs && npm run minify",
     "build:esm": "tsc",
     "build:cjs": "tsc --module commonjs --outDir dist/cjs",
     "lint": "eslint \"{**/*,*}.{js,ts,jsx,tsx}\"",
     "prettier": "prettier --write \"{src,tests,example/src}/**/*.{js,ts,jsx,tsx}\"",
     "test": "jest --config jestconfig.json",
     "prepare": "npm run build",
-    "prepublishOnly": "npm run test && npm run prettier && npm run lint"
+    "prepublishOnly": "npm run test && npm run prettier && npm run lint",
+    "minify:esm": "terser dist/esm/index.js -o dist/esm/index.min.js -c -m",
+    "minify:cjs": "terser dist/cjs/index.js -o dist/cjs/index.min.js -c -m",
+    "minify": "npm run minify:esm && npm run minify:cjs"
   },
   "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",
@@ -28,6 +32,7 @@
     "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"
   },