clabe-validator 1.7.2 → 2.0.0

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 individual contributors to CLABE Validator
+Copyright (c) 2017-2022 individual contributors to CLABE Validator
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,7 +7,7 @@ _JavaScript library to analyze or create a CLABE number for a Mexican bank accou
 [![npm](https://img.shields.io/npm/v/clabe-validator.svg)](https://www.npmjs.com/package/clabe-validator)
 [![Vulnerabilities](https://snyk.io/test/github/center-key/clabe-validator/badge.svg)](https://snyk.io/test/github/center-key/clabe-validator)
 [![Hits](https://data.jsdelivr.com/v1/package/npm/clabe-validator/badge?style=rounded)](https://www.jsdelivr.com/package/npm/clabe-validator)
-[![Build](https://github.com/center-key/clabe-validator/workflows/build/badge.svg)](https://github.com/center-key/clabe-validator/actions?query=workflow%3Abuild)
+[![Build](https://github.com/center-key/clabe-validator/workflows/build/badge.svg)](https://github.com/center-key/clabe-validator/actions/workflows/run-spec-on-push.yaml)
 
 CLABE (Clave Bancaria Estandarizada — Spanish for "standardized banking code") is a banking
 standard from the Mexican Bank Association (Asociación de Bancos de México — ABM) for
@@ -42,15 +42,12 @@ Or for older CommonJS/UMD environments:
 const { clabe } = require('clabe-validator');  //deprecated
 ```
 
-**Note:** _Release v1.4.0 contains a significant number of bank and city code additions plus
-updates to reflect financial institution mergers and name changes._
-
 ## C) Validator Usage
 Pass the CLABE number as an 18-character string into `clabe.validate(clabeNum)`.
 
 ### 1. Example JavaScript code
 ```javascript
-const clabeNum = '002010077777777771';
+const clabeNum =   '002010077777777771';
 const clabeCheck = clabe.validate(clabeNum);
 console.log(clabeCheck.ok ? '¡Que bueno!' : '¡Muy mal!');
 console.log('Your bank: ' + clabeCheck.bank);
@@ -65,8 +62,10 @@ console.log('Your bank: ' + clabeCheck.bank);
    message:  'Valid',
    clabe:    '002010077777777771',
    tag:      'BANAMEX',
-   bank:     'Banco Nacional de México, S.A.',
+   bank:     'Banco Nacional de México',
    city:     'Aguascalientes MX-AGU',
+   multiple: false,
+   total:    1,
    account:  '07777777777',
    code:     { bank: '002', city: '010' },
    checksum: 1,
@@ -110,17 +109,19 @@ The **TypeScript Declaration File** file is [clabe.d.ts](dist/clabe.d.ts) in the
 The `clabe.validate(clabeNum: string)` function returns a `ClabeCheck` object:
 ```typescript
 type ClabeCheck = {
-   ok:       boolean,
-   formatOk: boolean,
-   error:    string | null,
-   message:  string,
-   clabe:    string | null,
-   tag:      string | null,
-   bank:     string | null,
-   city:     string | null,
-   account:  string,
-   code:     { bank: string, city: string },
-   checksum: number | null,
+   ok:       boolean,        //todo está bien
+   formatOk: boolean,        //valid length and checksum
+   error:    string | null,  //failure code, example: 'invalid-city'
+   message:  string,         //displayable status information
+   clabe:    string | null,  //full 18-digit number
+   tag:      string | null,  //bank short name, example: 'BANAMEX'
+   bank:     string | null,  //bank long name, example: 'Banco Nacional'
+   city:     string | null,  //branch or plaza name
+   multiple: boolean,        //more than one city share the same code
+   total:    number,         //number of cities
+   account:  string,         //11-digit zero-padded bank account number
+   code:     { bank: string, city: string },  //3-digit codes
+   checksum: number | null,  //control digit (0 to 9)
    };
 ```
 
@@ -128,9 +129,9 @@ Example TypeScript usage with explicit types:
 ```typescript
 import { clabe, ClabeCheck } from 'clabe-validator';
 
-const clabeNum: string =       '002010077777777771';
+const clabeNum:   string =     '002010077777777771';
 const clabeCheck: ClabeCheck = clabe.validate(clabeNum);  //{ ok: true, error: null, ... }
-const bankCode: string =       clabeCheck.code.bank;      //'002'
+const bankCode:   string =     clabeCheck.code.bank;      //'002'
 ```
 
 ## F) Contributor Notes
@@ -144,10 +145,12 @@ I was initially unable to transfer funds because the money transfer service repo
 number I supplied was invalid. 
 Through a little sleuthing and a lot of luck, I discovered that a financial services company had
 accidentally omitted the very last modulo operation in their CLABE checksum calculation. 
-The result was that Mexican bank account numbers ending in a zero were rejected.
+The result was that Mexican bank account numbers with certain combinations of digits were
+erroneously rejected.
 
 This project was created to fix the checksum bug. 
 It is an open source community project and is not supported by any company.
+
 <br>
 
 ---

package/dist/clabe.d.ts

@@ -1,4 +1,4 @@
-//! clabe-validator v1.7.2 ~~ https://github.com/center-key/clabe-validator ~~ MIT License
+//! clabe-validator v2.0.0 ~~ https://github.com/center-key/clabe-validator ~~ MIT License
 
 export declare type ClabeBank = {
     tag?: string;
@@ -7,9 +7,9 @@ export declare type ClabeBank = {
 export declare type ClabeBanksMap = {
     [bankCode: number]: ClabeBank;
 };
-export declare type ClabeCity = [number, string];
+export declare type ClabeCityInfo = [number, string, ClabeMxState?];
 export declare type ClabeCitiesMap = {
-    [cityCode: number]: string;
+    [cityCode: number]: ClabeCityInfo[];
 };
 export declare type ClabeCheck = {
     ok: boolean;
@@ -20,6 +20,8 @@ export declare type ClabeCheck = {
     tag: string | null;
     bank: string | null;
     city: string | null;
+    multiple: boolean;
+    total: number;
     account: string;
     code: {
         bank: string;
@@ -27,13 +29,14 @@ export declare type ClabeCheck = {
     };
     checksum: number | null;
 };
+export declare type ClabeMxState = 'MX-AGU' | 'MX-BCN' | 'MX-BCS' | 'MX-CAM' | 'MX-CHH' | 'MX-CHP' | 'MX-CMX' | 'MX-COA' | 'MX-COL' | 'MX-DUR' | 'MX-GRO' | 'MX-GUA' | 'MX-HID' | 'MX-JAL' | 'MX-MEX' | 'MX-MIC' | 'MX-MOR' | 'MX-NAY' | 'MX-NLE' | 'MX-OAX' | 'MX-PUE' | 'MX-QUE' | 'MX-ROO' | 'MX-SIN' | 'MX-SLP' | 'MX-SON' | 'MX-TAB' | 'MX-TAM' | 'MX-TLA' | 'MX-VER' | 'MX-YUC' | 'MX-ZAC';
 declare const clabe: {
     version: string;
     computeChecksum(clabeNum17: string): number | null;
     validate(clabeNum: string): ClabeCheck;
     calculate(bankCode: number, cityCode: number, accountNumber: number): string;
     banksMap: ClabeBanksMap;
-    cities: ClabeCity[];
+    cities: ClabeCityInfo[];
     citiesMap: ClabeCitiesMap;
 };
 export { clabe };