validation-br 1.6.2-e → 1.6.3

package/.publish/dist/utils.d.ts

@@ -0,0 +1,131 @@
+/**
+ * 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}
+ */
+export declare function sumToDV(sum: number): number;
+/**
+ * Checa se o número repassado possui todos os digitos iguais
+ *
+ * @example
+ * checkRepeatedSequence(12345678)
+ * // -> false
+ * checkRepeatedSequence(11111111)
+ * // -> true
+ *
+ */
+export declare function checkRepeatedSequence(value: string): boolean;
+/**
+ * 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
+ */
+export declare function sumElementsByMultipliers(value: string, multiplier: number[]): number;
+/**
+ * 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}
+ */
+export declare function fakeNumber(length: number, forceLength?: boolean, isAlpha?: boolean): string;
+/**
+ * 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
+ */
+export declare function clearValue(value: string | number, length?: number | null, options?: ClearValueOptions): string;
+/**
+ * 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}
+ *
+ */
+export declare function insertAtPosition(value: string, insertValue: string, position: number): string;
+/**
+ * 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}
+ *
+ */
+export declare function removeFromPosition(value: string, startPosition: number, endPosition: number): string;
+/**
+ * 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}
+ *
+ */
+export declare function applyMask(value: string | number, mask: string): string;
+/**
+ * randomLetter()
+ * Pega uma letra maiúscula aleatoriamente
+ *
+ * @example
+ * randomLetter() // -> A
+ * randomLetter() // -> S
+ *
+ * @returns {String}
+ */
+export declare function randomLetter(): string;
+/**
+ * Opções do clearValue
+ */
+interface ClearValueOptions {
+    fillZerosAtLeft?: boolean;
+    trimAtRight?: boolean;
+    rejectEmpty?: boolean;
+    rejectHigherLength?: boolean;
+    rejectEqualSequence?: boolean;
+}
+export {};

package/.publish/dist/utils.js

@@ -0,0 +1,190 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sumToDV = sumToDV;
+exports.checkRepeatedSequence = checkRepeatedSequence;
+exports.sumElementsByMultipliers = sumElementsByMultipliers;
+exports.fakeNumber = fakeNumber;
+exports.clearValue = clearValue;
+exports.insertAtPosition = insertAtPosition;
+exports.removeFromPosition = removeFromPosition;
+exports.applyMask = applyMask;
+exports.randomLetter = randomLetter;
+const ValidationBRError_1 = __importDefault(require("./_exceptions/ValidationBRError"));
+/**
+ * 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);
+}
+/**
+ * Checa se o número repassado possui todos os digitos iguais
+ *
+ * @example
+ * checkRepeatedSequence(12345678)
+ * // -> false
+ * checkRepeatedSequence(11111111)
+ * // -> true
+ *
+ */
+function checkRepeatedSequence(value) {
+    return [...value].every(digit => digit === value[0]);
+}
+/**
+ * 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) {
+    return multiplier.reduce((accu, curr, i) => accu + curr * Number(value[i]), 0);
+}
+/**
+ * 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, isAlpha = false) {
+    let value;
+    if (isAlpha)
+        value = Math.round(Math.random() * 36 ** length).toString(36).toLocaleUpperCase();
+    else
+        value = Math.floor(Math.random() * 10 ** length).toString();
+    if (forceLength)
+        return String(value).padStart(length, '0');
+    return String(value);
+}
+/**
+ * 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, options) {
+    let clearedValue = String(value).replace(/([/.-\s]+)/gi, '');
+    if (options) {
+        const shouldRejectEmpty = options.rejectEmpty === true && clearedValue.length === 0;
+        if (shouldRejectEmpty) {
+            throw ValidationBRError_1.default.EMPTY_VALUE;
+        }
+        const shouldRejectHigherLength = options.rejectHigherLength === true && length && clearedValue.length > length;
+        if (shouldRejectHigherLength) {
+            throw ValidationBRError_1.default.MAX_LEN_EXCEDEED;
+        }
+        const shouldRejectEqualSequence = options.rejectEqualSequence === true && length;
+        if (shouldRejectEqualSequence) {
+            if (checkRepeatedSequence(clearedValue))
+                throw ValidationBRError_1.default.REPEATED_SEQUENCE;
+        }
+        if (length && options.fillZerosAtLeft)
+            clearedValue = clearedValue.padStart(length, '0');
+        if (length && options.trimAtRight)
+            clearedValue = clearedValue.substring(0, length);
+    }
+    return clearedValue;
+}
+/**
+ * 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)}`;
+}
+/**
+ * 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('');
+}
+/**
+ * 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, { fillZerosAtLeft: true, trimAtRight: true });
+    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;
+}
+/**
+ * randomLetter()
+ * Pega uma letra maiúscula aleatoriamente
+ *
+ * @example
+ * randomLetter() // -> A
+ * randomLetter() // -> S
+ *
+ * @returns {String}
+ */
+function randomLetter() {
+    const idx = Math.floor(1 + Math.random() * 26);
+    return String.fromCharCode(idx + 64);
+}
+//# sourceMappingURL=utils.js.map

package/.publish/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;;;AAUA,0BAEC;AAYD,sDAEC;AAcD,4DAKC;AAcD,gCASC;AAoBD,gCA4BC;AAgBD,4CAEC;AAgBD,gDAMC;AAeD,8BAWC;AAYD,oCAGC;AArMD,wFAAgE;AAEhE;;;;;;;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,CAAC;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CAAC,KAAa,EAAE,UAAoB;IAC1E,OAAO,UAAU,CAAC,MAAM,CACtB,CAAC,IAAY,EAAE,IAAS,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,MAAc,EAAE,WAAW,GAAG,KAAK,EAAE,OAAO,GAAG,KAAK;IAC7E,IAAI,KAAa,CAAC;IAElB,IAAI,OAAO;QAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,iBAAiB,EAAE,CAAC;;QAC1F,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;IAEjE,IAAI,WAAW;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,UAAU,CACxB,KAAsB,EACtB,SAAwB,IAAI,EAC5B,OAA2B;IAE3B,IAAI,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAE7D,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC;QACpF,IAAI,iBAAiB,EAAE,CAAC;YACtB,MAAM,2BAAiB,CAAC,WAAW,CAAC;QACtC,CAAC;QAED,MAAM,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,KAAK,IAAI,IAAI,MAAM,IAAI,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;QAC/G,IAAI,wBAAwB,EAAE,CAAC;YAC7B,MAAM,2BAAiB,CAAC,gBAAgB,CAAC;QAC3C,CAAC;QAED,MAAM,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,KAAK,IAAI,IAAI,MAAM,CAAC;QACjF,IAAI,yBAAyB,EAAE,CAAC;YAC9B,IAAI,qBAAqB,CAAC,YAAY,CAAC;gBAAE,MAAM,2BAAiB,CAAC,iBAAiB,CAAC;QACrF,CAAC;QAED,IAAI,MAAM,IAAI,OAAO,CAAC,eAAe;YAAE,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzF,IAAI,MAAM,IAAI,OAAO,CAAC,WAAW;YAAE,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACtF,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;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,CAAC;AACrF,CAAC;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,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAC,KAAsB,EAAE,IAAY;IAC5D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACtF,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAEpD,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,EAAE,CAAC;QAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3F,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,YAAY;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;AACvC,CAAC"}