validation-br 0.8.3 → 1.0.0-b

package/dist/utils.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyMask = exports.removeFromPosition = exports.insertAtPosition = exports.clearValue = exports.fakeNumber = exports.sumElementsByMultipliers = exports.invalidListGenerator = exports.sumToDV = void 0;
+/**
+ * Calcula o DV verificador a partir das regras do MOD11:
+ * O valor da soma é dividido por 11. O resultado é o resto da divisão. Caso o resto seja
+ * menor que 2, ou seja, o valor da divisão seja 10 ou 11, o resultado é 0.
+ *
+ * @param {Integer} sum Soma
+ * @returns {Integer}
+ */
+function sumToDV(sum) {
+    return sum % 11 < 2 ? 0 : 11 - (sum % 11);
+}
+exports.sumToDV = sumToDV;
+/**
+ * Cria uma lista de valores repetidos no tamanho do documento para eliminar
+ * valores que já conhecemos como inválidos
+ *
+ * @example
+ * invalidListGenerator(10, 11)
+ * //-> [00000000000, 11111111111, ....., 99999999999]
+ *
+ * @param {Integer} length Número de itens do array
+ * @param {Integer} size Tamanho da string gerada
+ * @returns {Array} Lista de valores
+ */
+function invalidListGenerator(size) {
+    return [...Array(10).keys()].map((f) => String(f).repeat(size));
+}
+exports.invalidListGenerator = invalidListGenerator;
+/**
+ * Multiplica os elementos de uma string com os elementos de outra, ou de um array
+ * e soma o resultado ao final
+ *
+ * @example
+ *   sumElementsByMultipliers('123', '987')      //-> 46
+ *   sumElementsByMultipliers('123', [9, 8, 7])  //-> 46
+ *
+ * @param {String} value
+ * @param {String|Array} multiplier
+ * @returns {Integer} Somatório
+ */
+function sumElementsByMultipliers(value, multiplier) {
+    if (typeof multiplier === 'string')
+        multiplier = multiplier.split('').map((n) => Number(n));
+    return multiplier.reduce((accu, curr, i) => accu + curr * Number(value.charAt(i)), 0);
+}
+exports.sumElementsByMultipliers = sumElementsByMultipliers;
+/**
+ * fakeNumber()
+ * Cria um número aleatório com o número de caracteres
+ *
+ * @example
+ * fakeNumber(8, true) // -> 00083159
+ * fakeNumber(4) // -> 831
+ *
+ * @param {Integer} length
+ * @param {Boolean} forceLength Adiciona zeros à esquerda para ter os números de caractes exatos
+ * @returns {String}
+ */
+function fakeNumber(length, forceLength = false) {
+    const value = (Math.random() * Math.pow(10, length)).toFixed(0);
+    if (forceLength)
+        return value.padStart(length, '0');
+    return +value;
+}
+exports.fakeNumber = fakeNumber;
+/**
+ * Limpa um número informado, retirando caracteres diferentes de números,
+ * preenchendo com zeros à esquerda se for menor que o tamanho exato e
+ * removendo uma parte do número se for maior que tamanho definido.
+ *
+ * 1) Retira caracteres não-numéricos
+ * 2) Preenche com zeros à esquerda se 'value' for menor que 'length'
+ * 3) Remove caracteres à direita se 'value' for maior que 'length'
+ *
+ * @example
+ *  clearValue(12345-6, 6) // -> 123456
+ *  clearValue(12345678, 3) // -> 123
+ *  clearValue(12345, 10) // -> 0000001234
+ *
+ * @param {Number|String} value
+ * @param {Number} length Tamanho exato. Se for null, só retira os caracteres não-numéricos
+ * @returns {String} Número com o tamanho exato
+ */
+function clearValue(value, length = null) {
+    const clearedValue = String(value).replace(/([^\d]+)/gi, '');
+    if (!length || clearedValue.length === length)
+        return clearedValue;
+    if (clearedValue.length > length)
+        return clearedValue.substring(0, length);
+    return clearedValue.padStart(length, '0');
+}
+exports.clearValue = clearValue;
+/**
+ * insertAtPosition()
+ * Insere um conjunto de caracteres em um local específico de uma string
+ *
+ * @example
+ * insertAtPosition('AAABBB', 'C', 3) // -> AAACBBB
+ * insertAtPosition('000011122223445555', 99, 7) // -> 00001119922223445555
+ *
+ * @param {String|Number} value Valor original
+ * @param {String|Number} insertValue Valor que será inserido
+ * @param {String|Number} position Posição que receberá o novo valor
+ * @returns {String}
+ *
+ */
+function insertAtPosition(value, insertValue, position) {
+    return `${value.substring(0, position)}${insertValue}${value.substring(position)}`;
+}
+exports.insertAtPosition = insertAtPosition;
+/**
+ * removeFromPosition()
+ * Retira um conjunto de caracteres de um local específico de uma string
+ *
+ * @example
+ * removeFromPosition('00001119922223445555', 7,9) // -> 000011122223445555
+ * removeFromPosition('AAACBBB', 3,4) // -> AAABBB
+ *
+ * @param {String|Number} value Valor original
+ * @param {String|Number} startPosition
+ * @param {String|Number} endPosition
+ * @returns {String}
+ *
+ */
+function removeFromPosition(value, startPosition, endPosition) {
+    return [value.slice(0, startPosition), value.slice(endPosition)].join('');
+}
+exports.removeFromPosition = removeFromPosition;
+/**
+ * applyMask()
+ * Aplica uma máscara a uma string
+ *
+ * @example
+ * applyMask('59650000', '00.000-000') // -> 59.650-000
+ * applyMask('99877665544', '(00) 0 0000-0000') // -> (99) 8 7766-5544
+ *
+ * @param {String|Number} value Valor original
+ * @param {String} mask
+ * @returns {String}
+ *
+ */
+function applyMask(value, mask) {
+    const maskLen = clearValue(mask).length;
+    let masked = clearValue(value, maskLen);
+    const specialChars = ['/', '-', '.', '(', ')', ' '];
+    for (let position = 0; position < mask.length; position += 1) {
+        const current = mask[position];
+        if (specialChars.includes(current))
+            masked = insertAtPosition(masked, current, position);
+    }
+    return masked;
+}
+exports.applyMask = applyMask;
+// module.exports = {
+//   sumToDV,
+//   invalidListGenerator,
+//   sumElementsByMultipliers,
+//   fakeNumber,
+//   applyMask,
+//   clearValue,
+//   insertAtPosition,
+//   removeFromPosition,
+// }
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AAC3C,CAAC;AAFD,0BAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,oDAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CAAC,KAAa,EAAE,UAA6B;IACnF,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3F,OAAO,UAAU,CAAC,MAAM,CACtB,CAAC,IAAY,EAAE,IAAS,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAC7E,CAAC,CACF,CAAA;AACH,CAAC;AAPD,4DAOC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,MAAc,EAAE,cAAuB,KAAK;IACrE,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAA,EAAE,EAAI,MAAM,CAAA,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAEvD,IAAI,WAAW;QAAE,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAEnD,OAAO,CAAC,KAAK,CAAA;AACf,CAAC;AAND,gCAMC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,UAAU,CAAC,KAAsB,EAAE,SAAwB,IAAI;IAC7E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;IAE5D,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,KAAK,MAAM;QAAE,OAAO,YAAY,CAAA;IAElE,IAAI,YAAY,CAAC,MAAM,GAAG,MAAM;QAAE,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;IAC1E,OAAO,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAC3C,CAAC;AAPD,gCAOC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,gBAAgB,CAAC,KAAa,EAAE,WAAmB,EAAE,QAAgB;IACnF,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAA;AACpF,CAAC;AAFD,4CAEC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAChC,KAAa,EACb,aAAqB,EACrB,WAAmB;IAEnB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAC3E,CAAC;AAND,gDAMC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAC,KAAsB,EAAE,IAAY;IAC5D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;IACvC,IAAI,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACvC,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAEnD,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,EAAE;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9B,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;KACzF;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAXD,8BAWC;AAED,qBAAqB;AACrB,aAAa;AACb,0BAA0B;AAC1B,8BAA8B;AAC9B,gBAAgB;AAChB,eAAe;AACf,gBAAgB;AAChB,sBAAsB;AACtB,wBAAwB;AACxB,IAAI"}

package/jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.json',
+    },
+  },
+  moduleFileExtensions: ['ts', 'js'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest',
+  },
+  testRegex: '(/src/.*\\.(test|spec))\\.(jsx?|tsx?)$',
+  testEnvironment: 'node',
+  coverageDirectory: './coverage/',
+}

package/package.json

@@ -1,56 +1,48 @@
 {
   "name": "validation-br",
-  "description": "Brazilian personal documents validation - cpf, cnpj, titulo, pis/pasep, cnh",
-  "version": "0.8.3",
+  "version": "1.0.0-b",
+  "main": "dist/index.js",
+  "types": "./dist/types.d.ts",
+  "author": "Cláudio Medeiros <klawdyo@gmail.com>",
+  "license": "MIT",
   "scripts": {
-    "test": "yarn build && cls && node tests | tap-spec",
-    "build": "babel src --source-maps -d dist",
-    "lint": "eslint src/** --ignore-path .gitignore .",
-    "lint:fix": "eslint src/** --ignore-path .gitignore . --fix",
-    "prepublish": "yarn build"
+    "build": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --collectCoverageFrom=src/**/*.ts --coverage",
+    "lint:list": "eslint */**/*.js --fix",
+    "format": "prettier --write \"./**/*.{js,ts,json}\""
   },
-  "eslintConfig": {
-    "extends": "airbnb"
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsc --noEmit && lint-staged"
+    }
   },
-  "dependencies": {
-    "@babel/runtime": "^7.15.3",
-    "qrcode": "^1.4.4"
+  "lint-staged": {
+    "*.{js,ts}": [
+      "prettier --write",
+      "eslint --cache --fix"
+    ]
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
-    "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.0",
-    "babel-preset-minify": "^0.5.1",
-    "core-js": "^3.16.2",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.24.1",
-    "regenerator-runtime": "^0.13.9",
-    "tap-spec": "^2.2.2",
-    "tape": "^4.13.0"
-  },
-  "main": "index.js",
-  "author": "Cláudio Medeiros",
-  "repository": {
-    "url": "https://github.com/klawdyo/validation-br"
-  },
-  "bugs": {
-    "url": "https://github.com/klawdyo/validation-br/issues"
-  },
-  "homepage": "https://github.com/klawdyo/validation-br#readme",
-  "keywords": [
-    "validation-br",
-    "brazilian",
-    "validation",
-    "personal documents",
-    "cpf",
-    "cnpj",
-    "pis",
-    "pasep",
-    "cnh",
-    "titulo eleitor"
-  ],
-  "license": "MIT",
-  "private": false
+    "@types/jest": "^27.4.0",
+    "@types/node": "^14.14.2",
+    "@typescript-eslint/eslint-plugin": "^4.0.0",
+    "@typescript-eslint/parser": "^3.10.1",
+    "eslint": "^7.11.0",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-config-prettier": "^6.14.0",
+    "eslint-import-resolver-node": "^0.3.4",
+    "eslint-import-resolver-typescript": "^2.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-no-only-tests": "^2.4.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "husky": "^4.3.0",
+    "jest": "^27.4.7",
+    "lint-staged": "^10.4.2",
+    "prettier": "^2.1.2",
+    "ts-jest": "^27.1.2",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.3"
+  }
 }