feat: expose function to get type of ofx transactions

README.md

@@ -22,6 +22,7 @@ yarn add ofx-data-extractor
 ### Methods
 The `Ofx` class provides the following methods:
 
+- `getType(): Types`: Used to get type of transactions from ofx (BANK or CREDIT_CARD)
 - `fromBuffer(data: Buffer)`: Used to read files on the node. Returns the methods
 - `fromBlob(data: Blob)`: Used to read files in the browser. Returns the methods below.
 - `config(options: OfxConfig)`: Used for formatting the generated json.`

src/@types/common.ts

@@ -51,3 +51,8 @@ export type TransactionsSummary = {
   dateStart: string
   dateEnd: string
 }
+
+export enum Types {
+  'BANK' = 'BANK',
+  'CREDIT_CARD' = 'CREDIT_CARD',
+}

src/common/helpers.ts

@@ -0,0 +1,9 @@
+import { Types } from '../@types/common'
+import { BANK_SERVICE_START } from './constants'
+
+export const extractType = (content: string) => {
+  if (content.includes(BANK_SERVICE_START)) {
+    return Types.BANK
+  }
+  return Types.CREDIT_CARD
+}

src/implementations/extractor.ts

@@ -10,6 +10,7 @@ import { Config } from '../common/config'
 import { Reader } from './reader'
 import { OfxExtractor } from './ofx-extractor'
 import { OfxResponse, OfxStructure, STRTTRN } from '../@types/ofx'
+import { extractType } from '../common/helpers'
 
 export class Extractor<T = any> implements IExtractor<T> {
   private customExtractorInstance: CustomExtractor
@@ -30,6 +31,10 @@ export class Extractor<T = any> implements IExtractor<T> {
     return this
   }
 
+  getType() {
+    return extractType(this.dataReaderInstance.getData())
+  }
+
   getHeaders(): MetaData {
     const [metaDataString] = this.dataReaderInstance.getData().split('<OFX>')
     return convertMetaDataToObject(

src/interfaces/extractor.interface.ts

@@ -3,9 +3,12 @@ import {
   ExtractorConfig,
   MetaData,
   TransactionsSummary,
+  Types,
 } from '../@types/common'
 
 export interface IExtractor<T> {
+  getType(): Types
+
   config(config: ExtractorConfig): this
 
   getHeaders(): MetaData

src/older-implementation/main.ts

@@ -13,6 +13,10 @@ export class Ofx {
     this.extractor.config(config || {})
   }
 
+  getType() {
+    return this.extractor.getType()
+  }
+
   static fromBuffer(data: Buffer) {
     return new Ofx(Reader.fromBuffer(data).getData())
   }

tests/file-reader-unavailable.web.spec.ts

@@ -1,12 +1,7 @@
-import path from 'path'
 import { Ofx } from '../src/index'
-import fs from 'fs'
-
-const file = fs.readFileSync(path.resolve(__dirname, 'example.ofx'))
 
 describe('Tests for Web/Browser environment with feature not available ', () => {
   test.concurrent('Should throw error for FileReader undefined', () => {
-    const blob = new Blob([file.toString()], { type: 'text/plain' })
     jest.mock('../src/common/reader', () => ({
       window: null,
     }))

tests/new-ofx.spec.ts

@@ -3,6 +3,7 @@ import fs, { readFileSync } from 'fs'
 import { Extractor } from '../src/implementations/extractor'
 import { OfxExtractor } from '../src/implementations/ofx-extractor'
 import { Reader } from '../src/implementations/reader'
+import { Types } from '../src/@types/common'
 
 const ofxExtractor = new OfxExtractor()
 const reader = new Reader()
@@ -104,4 +105,18 @@ describe('Tests in the Node.js environment', () => {
     const extractorInstance = extractor.data(Reader.fromBuffer(file))
     expect(extractorInstance.getBankTransferList()).toHaveLength(0)
   })
+
+  test.concurrent('Should correctly return ofx type (bank)', () => {
+    const data = Reader.fromString(file.toString())
+    expect(extractor.data(data).getType()).toBe(Types.BANK)
+  })
+
+  test.concurrent(
+    'Should correctly return ofx type (credit card)',
+    async () => {
+      const file = readFileSync(path.resolve(__dirname, 'example3.ofx'))
+      const extractorInstance = extractor.data(Reader.fromBuffer(file))
+      expect(extractorInstance.getType()).toBe(Types.CREDIT_CARD)
+    },
+  )
 })

tests/ofx.spec.ts

@@ -1,6 +1,7 @@
 import { Ofx } from '../src/index'
 import path from 'path'
 import fs from 'fs'
+import { Types } from '../src/@types/common'
 
 describe('Tests in the Node.js environment', () => {
   const file = fs.readFileSync(path.resolve(__dirname, 'example.ofx'))
@@ -75,4 +76,8 @@ describe('Tests in the Node.js environment', () => {
     expect(summary.dateStart).toBe('2018-01-30')
     expect(summary.dateEnd).toBe('2018-04-29')
   })
+
+  test.concurrent('Should correctly return ofx type (bank)', () => {
+    expect(ofx.getType()).toBe(Types.BANK)
+  })
 })