validation-br 1.4.4 → 1.5.1

package/dist/postalCode.js

@@ -1,131 +1,136 @@
-"use strict";
-/**
- * isPostalCode()
- * Calcula se um código de rastreamento postal no formato JT194690698BR é válido.
- *
- * @doc
- * - O número de registro postal deve possuir 13 caracters no formato JT194690698BR.
- *
- * - Os caracteres 1 e 2 informam o tipo do objeto. Ex.: SX é Sedex, RC é carta registrada etc.
- *
- * - Os caracteres de 3 a 10 são a numeração sequencial do tipo do objeto.
- *
- * - O caractere 11 é o dígito verificador.
- *
- * - Os caracteres 12 e 13 representa o código do País de onde a postagem partiu.
- *
- * 1) Partes do número
- *  ______ ___________________________ ______ _______
- * | Tipo | Número                    |  DV  |  País |
- * | J T    1  9  4  6  9  0  6  9       8      B R  |
- * |______|___________________________|______|_______|
- *
- * 2) Cálculo do DV.
- *
- *  - Soma-se o produto das algarismos 3 a 10 pelos números 8, 6, 4, 2, 3, 5, 9, 7
- *
- *    1   9   4   6   9   0   6   9
- *    x   x   x   x   x   x   x   x
- *    8   6   4   2   3   5   9   7
- * =  8 +54 +16 +12 +18  +0 +54 +63 = 234
- *
- *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
- *    234 / 11 tem resto 3. 11 - 3 = 8. DV1 é 8.
- *    Obs.: Caso o cálculo de DV1 retorne 0, o resultado será 5.
- *          Caso retorne 1, o resto será 0
- *
- *
- *
- *
- * Fonte:
- *
- * @param {String} value Objeto postal no formato JT194690698BR
- * @returns {Boolean}
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.validateOrFail = exports.fake = exports.mask = exports.dv = void 0;
-const ValidationBRError_1 = __importDefault(require("./data/ValidationBRError"));
-const utils_1 = require("./utils");
-/**
- * dv()
- * Calcula o dígito verificador
- *
- * @param {Number|String} value
- * @returns {String}
- */
-exports.dv = (value) => {
-    if (!value)
-        throw ValidationBRError_1.default.EMPTY_VALUE;
-    const postalCode = String(value)
-        .replace(/[^0-9]+/gi, '')
-        .padStart(8, '0')
-        .substring(0, 8);
-    const sum = utils_1.sumElementsByMultipliers(postalCode, [8, 6, 4, 2, 3, 5, 9, 7]);
-    const rest = sum % 11;
-    // const specificities = { 0: { dv: 5 }, 1: { dv: 0 } }
-    const specificities = [
-        { rest: 0, dv: 5 },
-        { rest: 1, dv: 0 },
-    ];
-    const specifity = specificities.find((item) => item.rest === rest);
-    const DV = specifity ? specifity.dv : 11 - rest;
-    return String(DV);
-};
-/**
- * Aplica uma máscara ao número informado
- *
- * @param {String} value Número de Processo
- * @returns {String} Valor com a máscara
- */
-exports.mask = (value) => String(value).toLocaleUpperCase();
-/**
- * fake()
- * Gera um número válido
- *
- * @returns {String}
- */
-exports.fake = (withMask = false) => {
-    const num = utils_1.fakeNumber(8, true);
-    const postalCode = `${utils_1.randomLetter()}${utils_1.randomLetter()}${num}${exports.dv(num)}BR`;
-    if (withMask)
-        return exports.mask(postalCode);
-    return postalCode;
-};
-/**
- * validateOrFail()
- * Valida se um número é válido e
- * retorna uma exceção se não estiver
- *
- * @param {String} value Número a ser validado
- * @returns {Boolean}
- */
-exports.validateOrFail = (value) => {
-    if (!/^[a-z]{2}([\d]{9})[a-z]{2}$/gi.test(String(value))) {
-        throw new Error('O número não está no formato "XX000000000XX"');
-    }
-    const postalCode = utils_1.clearValue(value.substring(2, 11), 9);
-    if (exports.dv(value.substring(2, 11)) !== postalCode.substring(8, 9)) {
-        throw ValidationBRError_1.default.INVALID_DV;
-    }
-    return true;
-};
-/**
- * validate()
- * Valida se um número é válido
- *
- * @param {String} value Número a ser validado
- * @returns {Boolean}
- */
-exports.validate = (value) => {
-    try {
-        return exports.validateOrFail(value);
-    }
-    catch (error) {
-        return false;
-    }
-};
-exports.default = exports.validate;
+"use strict";
+/**
+ * isPostalCode()
+ * Calcula se um código de rastreamento postal no formato JT194690698BR é válido.
+ *
+ * @doc
+ * - O número de registro postal deve possuir 13 caracters no formato JT194690698BR.
+ *
+ * - Os caracteres 1 e 2 informam o tipo do objeto. Ex.: SX é Sedex, RC é carta registrada etc.
+ *
+ * - Os caracteres de 3 a 10 são a numeração sequencial do tipo do objeto.
+ *
+ * - O caractere 11 é o dígito verificador.
+ *
+ * - Os caracteres 12 e 13 representa o código do País de onde a postagem partiu.
+ *
+ * 1) Partes do número
+ *  ______ ___________________________ ______ _______
+ * | Tipo | Número                    |  DV  |  País |
+ * | J T    1  9  4  6  9  0  6  9       8      B R  |
+ * |______|___________________________|______|_______|
+ *
+ * 2) Cálculo do DV.
+ *
+ *  - Soma-se o produto das algarismos 3 a 10 pelos números 8, 6, 4, 2, 3, 5, 9, 7
+ *
+ *    1   9   4   6   9   0   6   9
+ *    x   x   x   x   x   x   x   x
+ *    8   6   4   2   3   5   9   7
+ * =  8 +54 +16 +12 +18  +0 +54 +63 = 234
+ *
+ *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
+ *    234 / 11 tem resto 3. 11 - 3 = 8. DV1 é 8.
+ *    Obs.: Caso o cálculo de DV1 retorne 0, o resultado será 5.
+ *          Caso retorne 1, o resto será 0
+ *
+ *
+ *
+ *
+ * Fonte:
+ *
+ * @param {String} value Objeto postal no formato JT194690698BR
+ * @returns {Boolean}
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.validateOrFail = exports.fake = exports.mask = exports.dv = void 0;
+const ValidationBRError_1 = __importDefault(require("./data/ValidationBRError"));
+const utils_1 = require("./utils");
+/**
+ * dv()
+ * Calcula o dígito verificador
+ *
+ * @param {Number|String} value
+ * @returns {String}
+ */
+const dv = (value) => {
+    if (!value)
+        throw ValidationBRError_1.default.EMPTY_VALUE;
+    const postalCode = String(value)
+        .replace(/[^0-9]+/gi, '')
+        .padStart(8, '0')
+        .substring(0, 8);
+    const sum = (0, utils_1.sumElementsByMultipliers)(postalCode, [8, 6, 4, 2, 3, 5, 9, 7]);
+    const rest = sum % 11;
+    // const specificities = { 0: { dv: 5 }, 1: { dv: 0 } }
+    const specificities = [
+        { rest: 0, dv: 5 },
+        { rest: 1, dv: 0 },
+    ];
+    const specifity = specificities.find((item) => item.rest === rest);
+    const DV = specifity ? specifity.dv : 11 - rest;
+    return String(DV);
+};
+exports.dv = dv;
+/**
+ * Aplica uma máscara ao número informado
+ *
+ * @param {String} value Número de Processo
+ * @returns {String} Valor com a máscara
+ */
+const mask = (value) => String(value).toLocaleUpperCase();
+exports.mask = mask;
+/**
+ * fake()
+ * Gera um número válido
+ *
+ * @returns {String}
+ */
+const fake = (withMask = false) => {
+    const num = (0, utils_1.fakeNumber)(8, true);
+    const postalCode = `${(0, utils_1.randomLetter)()}${(0, utils_1.randomLetter)()}${num}${(0, exports.dv)(num)}BR`;
+    if (withMask)
+        return (0, exports.mask)(postalCode);
+    return postalCode;
+};
+exports.fake = fake;
+/**
+ * validateOrFail()
+ * Valida se um número é válido e
+ * retorna uma exceção se não estiver
+ *
+ * @param {String} value Número a ser validado
+ * @returns {Boolean}
+ */
+const validateOrFail = (value) => {
+    if (!/^[a-z]{2}([\d]{9})[a-z]{2}$/gi.test(String(value))) {
+        throw new Error('O número não está no formato "XX000000000XX"');
+    }
+    const postalCode = (0, utils_1.clearValue)(value.substring(2, 11), 9);
+    if ((0, exports.dv)(value.substring(2, 11)) !== postalCode.substring(8, 9)) {
+        throw ValidationBRError_1.default.INVALID_DV;
+    }
+    return true;
+};
+exports.validateOrFail = validateOrFail;
+/**
+ * validate()
+ * Valida se um número é válido
+ *
+ * @param {String} value Número a ser validado
+ * @returns {Boolean}
+ */
+const validate = (value) => {
+    try {
+        return (0, exports.validateOrFail)(value);
+    }
+    catch (error) {
+        return false;
+    }
+};
+exports.validate = validate;
+exports.default = exports.validate;
 //# sourceMappingURL=postalCode.js.map

package/dist/postalCode.js.map

@@ -1 +1 @@
-{"version":3,"file":"postalCode.js","sourceRoot":"","sources":["../src/postalCode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;;;;;;AAEH,iFAAwD;AACxD,mCAAwF;AAExF;;;;;;GAMG;AACU,QAAA,EAAE,GAAG,CAAC,KAAsB,EAAU,EAAE;IACnD,IAAI,CAAC,KAAK;QAAE,MAAM,2BAAiB,CAAC,WAAW,CAAA;IAE/C,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;SAC7B,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;SAChB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAElB,MAAM,GAAG,GAAG,gCAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAE1E,MAAM,IAAI,GAAG,GAAG,GAAG,EAAE,CAAA;IACrB,uDAAuD;IAEvD,MAAM,aAAa,GAAG;QACpB,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QAClB,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;KACnB,CAAA;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IAElE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAA;IAE/C,OAAO,MAAM,CAAC,EAAE,CAAC,CAAA;AACnB,CAAC,CAAA;AAED;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,KAAsB,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,CAAA;AAEzF;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,WAAoB,KAAK,EAAU,EAAE;IACxD,MAAM,GAAG,GAAG,kBAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAE/B,MAAM,UAAU,GAAG,GAAG,oBAAY,EAAE,GAAG,oBAAY,EAAE,GAAG,GAAG,GAAG,UAAE,CAAC,GAAG,CAAC,IAAI,CAAA;IAEzE,IAAI,QAAQ;QAAE,OAAO,YAAI,CAAC,UAAU,CAAC,CAAA;IACrC,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AAED;;;;;;;GAOG;AACU,QAAA,cAAc,GAAG,CAAC,KAAa,EAAW,EAAE;IACvD,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;QACxD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IAED,MAAM,UAAU,GAAG,kBAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAExD,IAAI,UAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QAC7D,MAAM,2BAAiB,CAAC,UAAU,CAAA;KACnC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;;GAMG;AACU,QAAA,QAAQ,GAAG,CAAC,KAAa,EAAW,EAAE;IACjD,IAAI;QACF,OAAO,sBAAc,CAAC,KAAK,CAAC,CAAA;KAC7B;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,kBAAe,gBAAQ,CAAA"}
+{"version":3,"file":"postalCode.js","sourceRoot":"","sources":["../src/postalCode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;;;;;;AAEH,iFAAwD;AACxD,mCAAwF;AAExF;;;;;;GAMG;AACI,MAAM,EAAE,GAAG,CAAC,KAAsB,EAAU,EAAE;IACnD,IAAI,CAAC,KAAK;QAAE,MAAM,2BAAiB,CAAC,WAAW,CAAA;IAE/C,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;SAC7B,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;SAChB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAElB,MAAM,GAAG,GAAG,IAAA,gCAAwB,EAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAE1E,MAAM,IAAI,GAAG,GAAG,GAAG,EAAE,CAAA;IACrB,uDAAuD;IAEvD,MAAM,aAAa,GAAG;QACpB,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QAClB,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;KACnB,CAAA;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IAElE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAA;IAE/C,OAAO,MAAM,CAAC,EAAE,CAAC,CAAA;AACnB,CAAC,CAAA;AAvBY,QAAA,EAAE,MAuBd;AAED;;;;;GAKG;AACI,MAAM,IAAI,GAAG,CAAC,KAAsB,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,CAAA;AAA5E,QAAA,IAAI,QAAwE;AAEzF;;;;;GAKG;AACI,MAAM,IAAI,GAAG,CAAC,WAAoB,KAAK,EAAU,EAAE;IACxD,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAE/B,MAAM,UAAU,GAAG,GAAG,IAAA,oBAAY,GAAE,GAAG,IAAA,oBAAY,GAAE,GAAG,GAAG,GAAG,IAAA,UAAE,EAAC,GAAG,CAAC,IAAI,CAAA;IAEzE,IAAI,QAAQ;QAAE,OAAO,IAAA,YAAI,EAAC,UAAU,CAAC,CAAA;IACrC,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AAPY,QAAA,IAAI,QAOhB;AAED;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAC,KAAa,EAAW,EAAE;IACvD,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,UAAU,GAAG,IAAA,kBAAU,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAExD,IAAI,IAAA,UAAE,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAC9D,MAAM,2BAAiB,CAAC,UAAU,CAAA;IACpC,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAZY,QAAA,cAAc,kBAY1B;AAED;;;;;;GAMG;AACI,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAW,EAAE;IACjD,IAAI,CAAC;QACH,OAAO,IAAA,sBAAc,EAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AANY,QAAA,QAAQ,YAMpB;AAED,kBAAe,gBAAQ,CAAA"}

package/dist/postalCode.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/renavam.d.ts

@@ -1,75 +1,75 @@
-/**
- * RENAVAM
- * Funções auxiliares para cálculo de máscaras, validação, dígito verificador e criaçãode
- * números fake.
- *
- * @doc
- * - O número de RENAVAM deve possuir 11 caracteres
- *
- * - Os caracteres de 1 a 10 são a numeração documento
- *
- * - O caractere 11 é o dígito verificador.
- *
- * 1) Partes do número
- *  _______________________________________________
- * |  Número                                 | D V |
- * |  2   6   8   2   7   6   4   9   9   6  -  0  |
- * |_________________________________________|_____|
- *
- * 2) Cálculo do DV.
- *
- *  - Soma-se o produto das algarismos 3 a 10 pelos números 3, 2, 9, 8, 7, 6, 5, 4, 3, 2
- *
- *    2   6   8   2   7   6   4   9   9   6
- *    x   x   x   x   x   x   x   x   x   x
- *    3   2   9   8   7   6   5   4   3   2
- * =  6 +12 +72 +16 +49 +12 +20 +36 +27 +12  =  234
- *
- *  - O somatório encontrado é multiplicado por 10 e ao resultado
- *    é aplicado o cálculo do MOD 11.
- *
- *    ( 234 * 10 ) / 11 tem resto 8. DV = 8. Caso o resto seja maior ou igual a
- *    10, DV será 0.
- *
- *
- */
-/**
- * dv()
- * Calcula o dígito verificador
- *
- * @param {Number|String} value
- * @returns {String}
- */
-export declare const dv: (value: string | number) => string;
-/**
- * Aplica uma máscara ao número informado
- *
- * @param {String} value Número de Processo
- * @returns {String} Valor com a máscara
- */
-export declare const mask: (value: string | number) => string;
-/**
- * fake()
- * Gera um número válido
- *
- * @returns {String}
- */
-export declare const fake: (withMask?: boolean) => string;
-/**
- * validateOrFail()
- * Valida se um número é válido e
- * retorna uma exceção se não estiver
- *
- * @param {String|Number} value Número a ser validado
- * @returns {Boolean}
- */
-export declare const validateOrFail: (value: string | number) => boolean;
-/**
- * validate()
- * Valida se um número é válido
- *
- * @param {String|Number} value Número a ser validado
- * @returns {Boolean}
- */
-export declare const validate: (value: string | number) => boolean;
-export default validate;
+/**
+ * RENAVAM
+ * Funções auxiliares para cálculo de máscaras, validação, dígito verificador e criaçãode
+ * números fake.
+ *
+ * @doc
+ * - O número de RENAVAM deve possuir 11 caracteres
+ *
+ * - Os caracteres de 1 a 10 são a numeração documento
+ *
+ * - O caractere 11 é o dígito verificador.
+ *
+ * 1) Partes do número
+ *  _______________________________________________
+ * |  Número                                 | D V |
+ * |  2   6   8   2   7   6   4   9   9   6  -  0  |
+ * |_________________________________________|_____|
+ *
+ * 2) Cálculo do DV.
+ *
+ *  - Soma-se o produto das algarismos 3 a 10 pelos números 3, 2, 9, 8, 7, 6, 5, 4, 3, 2
+ *
+ *    2   6   8   2   7   6   4   9   9   6
+ *    x   x   x   x   x   x   x   x   x   x
+ *    3   2   9   8   7   6   5   4   3   2
+ * =  6 +12 +72 +16 +49 +12 +20 +36 +27 +12  =  234
+ *
+ *  - O somatório encontrado é multiplicado por 10 e ao resultado
+ *    é aplicado o cálculo do MOD 11.
+ *
+ *    ( 234 * 10 ) / 11 tem resto 8. DV = 8. Caso o resto seja maior ou igual a
+ *    10, DV será 0.
+ *
+ *
+ */
+/**
+ * dv()
+ * Calcula o dígito verificador
+ *
+ * @param {Number|String} value
+ * @returns {String}
+ */
+export declare const dv: (value: string | number) => string;
+/**
+ * Aplica uma máscara ao número informado
+ *
+ * @param {String} value Número de Processo
+ * @returns {String} Valor com a máscara
+ */
+export declare const mask: (value: string | number) => string;
+/**
+ * fake()
+ * Gera um número válido
+ *
+ * @returns {String}
+ */
+export declare const fake: (withMask?: boolean) => string;
+/**
+ * validateOrFail()
+ * Valida se um número é válido e
+ * retorna uma exceção se não estiver
+ *
+ * @param {String|Number} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validateOrFail: (value: string | number) => boolean;
+/**
+ * validate()
+ * Valida se um número é válido
+ *
+ * @param {String|Number} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validate: (value: string | number) => boolean;
+export default validate;