feat: throw if error fn (#5)

package.json

@@ -34,9 +34,8 @@
     "build:module": "tsc -p tsconfig.module.json",
     "lint": "eslint --ignore-path .gitignore \"src/**/*.ts\"",
     "format": "prettier --ignore-path .gitignore \"src/**/*.ts\" --write",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest --coverage",
+    "test": "vitest",
+    "coverage": "vitest --coverage",
     "reset-hard": "git clean -dfx && git reset --hard && yarn install",
     "prepare-release": "run-s reset-hard test",
     "prepare": "husky install",

src/create.ts

@@ -1,8 +1,9 @@
 import { generatePixObject } from './assembler';
 import {
   DynamicPixEmvElements,
+  PixDynamicObject,
   PixElementType,
-  PixObject,
+  PixStaticObject,
   StaticPixEmvElements,
 } from './types/pixElements';
 import { PixError } from './types/pixError';
@@ -41,23 +42,32 @@ const defaultStaticFields = {
 
 export function createStaticPix(
   params: CreateStaticPixParams
-): PixObject | PixError {
+): PixStaticObject | PixError {
   if (params.merchantName.length > 25)
     return {
       error: true,
       message: 'merchantName character limit exceeded (> 25)',
+      throwIfError: () => {
+        throw new Error('merchantName character limit exceeded (> 25)');
+      },
     };
 
   if (params.merchantCity.length > 15)
     return {
       error: true,
       message: 'merchantCity character limit exceeded (> 15)',
+      throwIfError: () => {
+        throw new Error('merchantCity character limit exceeded (> 15)');
+      },
     };
 
   if (params.txid.length > 25)
     return {
       error: true,
       message: 'txid character limit exceeded (> 25)',
+      throwIfError: () => {
+        throw new Error('txid character limit exceeded (> 25)');
+      },
     };
 
   const elements = {
@@ -66,22 +76,28 @@ export function createStaticPix(
     ...params,
   } as StaticPixEmvElements;
 
-  return generatePixObject(elements);
+  return generatePixObject(elements) as PixStaticObject;
 }
 
 export function createDynamicPix(
   params: CreateDynamicPixParams
-): PixObject | PixError {
+): PixDynamicObject | PixError {
   if (params.merchantName.length > 25)
     return {
       error: true,
       message: 'merchantName character limit exceeded (> 25)',
+      throwIfError: () => {
+        throw new Error('merchantName character limit exceeded (> 25)');
+      },
     };
 
   if (params.merchantCity.length > 15)
     return {
       error: true,
       message: 'merchantCity character limit exceeded (> 15)',
+      throwIfError: () => {
+        throw new Error('merchantCity character limit exceeded (> 15)');
+      },
     };
 
   const elements = {
@@ -91,5 +107,5 @@ export function createDynamicPix(
     merchantCity: params.merchantCity.substr(0, 15).toUpperCase(),
   } as DynamicPixEmvElements;
 
-  return generatePixObject(elements);
+  return generatePixObject(elements) as PixDynamicObject;
 }

src/dynamicPayload.ts

@@ -1,9 +1,8 @@
-import { Buffer } from 'buffer';
-
 import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-
+import { Buffer } from 'buffer';
 import { PIXPayload } from './types/pixDynamicPayload';
 import { PixError } from './types/pixError';
+import { generateErrorObject } from './utils/generateErrorObject';
 import zeroPad from './utils/zeroPad';
 
 export type PIXFetchResults = {
@@ -37,7 +36,7 @@ export default async function fetchPayload({
   return axios
     .get('https://' + url, axiosOptions)
     .then(({ data, status }: AxiosResponse) => {
-      if (status !== 200) return { error: true, message: 'Status != 200' };
+      if (status !== 200) return generateErrorObject('Status != 200');
       return data;
     })
     .then((jws: string) => {
@@ -55,7 +54,6 @@ export default async function fetchPayload({
       return pixFetch;
     })
     .catch((error) => {
-      console.error(error);
-      return { error: true, message: error.message };
+      return generateErrorObject(error.message);
     });
 }

src/parser.ts

@@ -14,23 +14,23 @@ import {
   ValidTags,
 } from './types/pixEmvSchema';
 import { PixError } from './types/pixError';
+import { generateErrorObject } from './utils/generateErrorObject';
 import { hasElementError, isPix } from './validate';
 
 export function parsePix(brCode: string): PixObject | PixError {
   // Parse EMV Code
   const emvElements = parseEmv({ emvCode: brCode });
-  if (!emvElements.isValid) return { error: true, message: 'invalid emv code' };
+  if (!emvElements.isValid) return generateErrorObject('invalid emv code');
 
   // Validate CRC16
   const crc = computeCRC(brCode);
   if (crc !== emvElements.getTag(EmvSchema.TAG_CRC))
-    return { error: true, message: 'invalid crc' };
+    return generateErrorObject('invalid crc');
 
   // Extract Elements
   const elements = extractElements(emvElements);
 
-  if (hasElementError(elements))
-    return { error: true, message: 'invalid emv code' };
+  if (hasElementError(elements)) return generateErrorObject(elements.message);
 
   return generatePixObject(elements);
 }
@@ -80,7 +80,7 @@ export function extractElements(
     };
   }
   if (!isPix(emvElements, 'pix') || !isPix(emvElements, 'valid'))
-    return { error: true, message: 'invalid pix' };
+    return generateErrorObject('invalid pix');
 
-  return { error: true, message: 'error' };
+  return generateErrorObject('error');
 }

src/types/pixError.ts

@@ -1,4 +1,5 @@
 export type PixError = {
   readonly error: boolean;
   readonly message: string;
+  readonly throwIfError: () => never;
 };

src/types/pixFunctions.ts

@@ -1,20 +1,24 @@
 import { PIXFetchResults } from '../dynamicPayload';
-
+import { PixDynamicObject, PixStaticObject } from './pixElements';
 import { PixError } from './pixError';
 
-export type PixFnDefault = {
+export interface PixFnDefault {
   readonly toBRCode: () => string;
   readonly toImage: () => Promise<string>;
-};
+}
 
-export type PixStaticFn = PixFnDefault;
+export interface PixStaticFn extends PixFnDefault {
+  readonly throwIfError: () => PixStaticObject;
+}
 
-export type PixDynamicFn = PixFnDefault & {
-  readonly fetchPayload: ({
-    DPP,
-    codMun,
-  }: {
-    readonly DPP: string;
-    readonly codMun: number;
-  }) => Promise<PIXFetchResults | PixError>;
+type FetchPayloadParams = {
+  DPP: string;
+  codMun: number;
 };
+
+export interface PixDynamicFn extends PixFnDefault {
+  readonly fetchPayload: (
+    params: FetchPayloadParams
+  ) => Promise<PIXFetchResults | PixError>;
+  readonly throwIfError: () => PixDynamicObject;
+}

src/utils/generateErrorObject.ts

@@ -0,0 +1,11 @@
+import { PixError } from '../types/pixError';
+
+export function generateErrorObject(message: string): PixError {
+  return {
+    error: true,
+    message,
+    throwIfError: () => {
+      throw new Error(message);
+    },
+  };
+}

tests/throwIfError.test.ts

@@ -0,0 +1,49 @@
+import { describe, expect, it } from 'vitest';
+import { createStaticPix } from '../src';
+
+describe('throwIfError', () => {
+  it('should throw if merchant city is longer than 15 characters', () => {
+    const staticPixFn = createStaticPix({
+      merchantName: 'Thales Ogliari',
+      merchantCity: 'SAO MIGUEL DO OESTE',
+      pixKey: '[email protected]',
+      infoAdicional: 'Pedido 123',
+      txid: '',
+      transactionAmount: 10,
+    });
+
+    expect(staticPixFn.throwIfError).toThrow(
+      'merchantCity character limit exceeded (> 15)'
+    );
+  });
+
+  it('should throw if merchant name is longer than 25 characters', () => {
+    const staticPixFn = createStaticPix({
+      merchantName: 'Thales Ogliari Thales Ogliari Thales Ogliari',
+      merchantCity: 'SAO MIGUEL',
+      pixKey: '[email protected]',
+      infoAdicional: 'Pedido 123',
+      txid: '',
+      transactionAmount: 10,
+    });
+
+    expect(staticPixFn.throwIfError).toThrow(
+      'merchantName character limit exceeded (> 25)'
+    );
+  });
+
+  it('should throw if txid is longer than 25 characters', () => {
+    const staticPixFn = createStaticPix({
+      merchantName: 'Thales Ogliari',
+      merchantCity: 'SAO MIGUEL',
+      pixKey: '[email protected]',
+      infoAdicional: 'Pedido 123',
+      txid: 'F2B8073B0A52461997F53FB2A85FE7E8',
+      transactionAmount: 10,
+    });
+
+    expect(staticPixFn.throwIfError).toThrow(
+      'txid character limit exceeded (> 25)'
+    );
+  });
+});