export easy-to-use abbreviations

index.d.ts

@@ -1 +1,2 @@
 export default function getCanadianBankName(institutionNumber: string | number, transitNumber?: string | number): string | undefined;
+export { institutionCommonNames } from './institutions.js';

index.js

@@ -31,3 +31,4 @@ export default function getCanadianBankName(institutionNumber, transitNumber = '
     }
     return bankName;
 }
+export { institutionCommonNames } from './institutions.js';

index.ts

@@ -63,3 +63,5 @@ export default function getCanadianBankName(
 
   return bankName
 }
+
+export { institutionCommonNames } from './institutions.js'

institutions.d.ts

@@ -1,3 +1,11 @@
 type InstitutionKey = `${number}-${number}`;
 export declare const institutions: Record<InstitutionKey, string>;
-export default institutions;
+export declare const institutionCommonNames: {
+    readonly BMO: "001";
+    readonly ScotiaBank: "002";
+    readonly RBC: "003";
+    readonly TD: "004";
+    readonly CIBC: "010";
+    readonly HSBC: "016";
+};
+export {};

institutions.js

@@ -63,4 +63,11 @@ export const institutions = {
     '00000-890': 'Caisse Populaire Alliance Limitee',
     '00000-899': 'Central 1 Credit Union - Alberta'
 };
-export default institutions;
+export const institutionCommonNames = {
+    BMO: '001',
+    ScotiaBank: '002',
+    RBC: '003',
+    TD: '004',
+    CIBC: '010',
+    HSBC: '016'
+};

institutions.ts

@@ -92,4 +92,11 @@ export const institutions: Record<InstitutionKey, string> = {
   '00000-899': 'Central 1 Credit Union - Alberta'
 }
 
-export default institutions
+export const institutionCommonNames = {
+  BMO: '001',
+  ScotiaBank: '002',
+  RBC: '003',
+  TD: '004',
+  CIBC: '010',
+  HSBC: '016'
+} as const

test/institutions.js

@@ -1,10 +1,18 @@
 import assert from 'node:assert';
 import { describe, it } from 'node:test';
-import { institutions } from '../institutions.js';
+import getCanadianBankName from '../index.js';
+import { institutionCommonNames, institutions } from '../institutions.js';
 await describe('institutions', async () => {
-    await it('Only includes valid institution codes', () => {
+    await it('Only includes valid transit-institution codes', () => {
         for (const institutionKey of Object.keys(institutions)) {
             assert(/^\d{5}-\d{3}$/.test(institutionKey));
         }
     });
 });
+await describe('institutionCommonNames', async () => {
+    await it('Contains valid institution codes', () => {
+        for (const commonName of Object.keys(institutionCommonNames)) {
+            assert(getCanadianBankName(institutionCommonNames[commonName]) !== undefined);
+        }
+    });
+});

test/institutions.ts

@@ -1,13 +1,23 @@
 import assert from 'node:assert'
 import { describe, it } from 'node:test'
 
-import { institutions } from '../institutions.js'
+import getCanadianBankName from '../index.js'
+import { institutionCommonNames, institutions } from '../institutions.js'
 
 await describe('institutions', async () => {
-  await it('Only includes valid institution codes', () => {
+  await it('Only includes valid transit-institution codes', () => {
     for (const institutionKey of Object.keys(institutions)) {
       // eslint-disable-next-line security/detect-unsafe-regex
       assert(/^\d{5}-\d{3}$/.test(institutionKey))
     }
   })
 })
+
+await describe('institutionCommonNames', async() => {
+  await it('Contains valid institution codes', () => {
+    for (const commonName of Object.keys(institutionCommonNames)) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, security/detect-object-injection
+      assert(getCanadianBankName(institutionCommonNames[commonName]) !== undefined)
+    }
+  })
+})