feat(helper): add additonal types

goparrot · Feb 2, 2022 · b9c1b30 · b9c1b30
1 parent fee007e
commit b9c1b30
Show file tree

Hide file tree

Showing 11 changed files with 95 additions and 19 deletions.
diff --git a/bin/prepublish.ts b/bin/prepublish.ts
@@ -1,4 +1,5 @@
 import { writeFileSync, copyFileSync } from 'fs';
+import { EOL } from 'os';
 import originPackage from '../package.json';
 
 const distPackage: Record<string, any> = originPackage;
@@ -14,7 +15,7 @@ delete distPackage.files;
 delete distPackage.directories;
 delete distPackage['lint-staged'];
 
-writeFileSync('./dist/package.json', JSON.stringify(distPackage, null, '  '));
+writeFileSync('./dist/package.json', JSON.stringify(distPackage, null, 4) + EOL);
 
 const copyFiles = ['README.md'];
 for (const file of copyFiles) {

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@goparrot/square-connect-plus",
     "description": "Extends the official Square Node.js SDK library with additional functionality",
-    "version": "0.5.0-dev-6619.1",
+    "version": "0.5.0-dev-6619.8",
     "author": "Coroliov Oleg",
     "license": "MIT",
     "private": false,

diff --git a/src/client/SquareClient.ts b/src/client/SquareClient.ts
@@ -27,9 +27,9 @@ import { exponentialDelay, mergeDeepProps, sleep } from '../utils';
 import { CustomerClientApi } from './CustomerClientApi';
 
 export class SquareClient {
-    private client: Client;
-    private readonly mergedConfig: ISquareClientMergedConfig;
-    private readonly defaultConfig: ISquareClientDefaultConfig = {
+    #client: Client;
+    readonly #mergedConfig: ISquareClientMergedConfig;
+    readonly #defaultConfig: ISquareClientDefaultConfig = {
         retry: {
             maxRetries: 6,
             retryDelay: exponentialDelay,
@@ -38,8 +38,8 @@ export class SquareClient {
     };
 
     constructor(private readonly accessToken: string, config: ISquareClientConfig = {}) {
-        this.mergedConfig = mergeDeepProps(this.defaultConfig, config);
-        this.mergedConfig.logger = config.logger;
+        this.#mergedConfig = mergeDeepProps(this.#defaultConfig, config);
+        this.#mergedConfig.logger = config.logger;
     }
 
     /**
@@ -53,13 +53,13 @@ export class SquareClient {
     }
 
     getConfig(): ISquareClientMergedConfig {
-        return this.mergedConfig;
+        return this.#mergedConfig;
     }
 
     getOriginClient(): Client {
-        this.client = this.client ?? this.createOriginClient(this.accessToken, this.mergedConfig);
+        this.#client = this.#client ?? this.createOriginClient(this.accessToken, this.#mergedConfig);
 
-        return this.client;
+        return this.#client;
     }
 
     getApplePayApi(retryableMethods: string[] = []): ApplePayApi {
@@ -148,7 +148,7 @@ export class SquareClient {
     }
 
     private getLogger(): ILogger {
-        return this.mergedConfig.logger ?? (this.mergedConfig.logger = new NullLogger());
+        return this.#mergedConfig.logger ?? (this.#mergedConfig.logger = new NullLogger());
     }
 
     /**
@@ -162,7 +162,11 @@ export class SquareClient {
                 return async (...args: unknown[]): Promise<ApiResponse<T>> => {
                     const requestFn: (...arg: unknown[]) => Promise<ApiResponse<T>> = target[apiMethodName].bind(target, ...args);
 
-                    this.getLogger().debug(`Square api request: ${JSON.stringify({ apiMethodName, args })}`);
+                    this.getLogger().debug(
+                        `Square api request: ${JSON.stringify({ apiMethodName, args }, (_, value) =>
+                            typeof value === 'bigint' ? value.toString() + 'n' : value,
+                        )}`,
+                    );
 
                     try {
                         const response = await this.makeRetryable<ApiResponse<T>>(requestFn, apiMethodName, retryableMethods);
@@ -184,7 +188,7 @@ export class SquareClient {
 
     private async makeRetryable<T>(promiseFn: (...arg: unknown[]) => Promise<T>, apiMethodName: string, retryableMethods: string[]): Promise<T> {
         let retries: number = 0;
-        const { maxRetries, retryCondition = this.retryCondition } = this.mergedConfig.retry;
+        const { maxRetries, retryCondition = this.retryCondition } = this.#mergedConfig.retry;
 
         async function retry(): Promise<T> {
             try {

diff --git a/src/exception/SquareApiException.ts b/src/exception/SquareApiException.ts
@@ -10,7 +10,7 @@ export class SquareApiException extends Error implements ISquareApiException {
     readonly url?: string;
     readonly method?: string;
 
-    constructor(error: unknown, retries: number) {
+    constructor(error: unknown, retries: number = 0) {
         super();
         this.message = 'Square API error';
         this.name = this.constructor.name;

diff --git a/src/utils/SquareDataMapper.ts b/src/utils/SquareDataMapper.ts
@@ -7,6 +7,12 @@ import { recursiveBigIntToNumber, recursiveNumberToBigInt } from './helper';
 export type IdempotencyFree<T> = Omit<T, 'idempotency_key' | 'idempotencyKey'>;
 
 export class SquareDataMapper {
+    /**
+     *
+     * @param data
+     * @param recursiveReplaceBigInToNumber @default true
+     * @returns {T}
+     */
     static toOldFormat = <T extends ObjectLikeType>(data: ObjectLikeType, recursiveReplaceBigInToNumber: boolean = true): T => {
         const object: T = SquareDataMapper.convert(data, snakeCase);
 
@@ -17,7 +23,11 @@ export class SquareDataMapper {
         return object;
     };
 
-    static toNewFormat = <T extends ObjectLikeType>(data: ObjectLikeType, recursiveReplaceNumberToBigInt: boolean = false): T => {
+    /**
+     * @param recursiveReplaceNumberToBigInt @default false
+     * @returns {T}
+     */
+    static toNewFormat = <T extends ObjectLikeType>(data: ObjectLikeType, recursiveReplaceNumberToBigInt: boolean = true): T => {
         const object: T = SquareDataMapper.convert(data, camelCase);
 
         if (recursiveReplaceNumberToBigInt) {

diff --git a/src/utils/helper.ts b/src/utils/helper.ts
@@ -7,7 +7,7 @@ export type ReturnRecursiveBigIntToNumberType<T> = T extends bigint
     : T;
 
 export function recursiveBigIntToNumber<T>(body: T): ReturnRecursiveBigIntToNumberType<T> {
-    if (!body || !['object', 'bigint'].includes(typeof body)) {
+    if (body === undefined || body === null || !['object', 'bigint'].includes(typeof body)) {
         return body as ReturnRecursiveBigIntToNumberType<T>;
     }
 
@@ -37,7 +37,7 @@ export type ReturnRecursiveNumberToBigIntType<T> = T extends number
 
 /* global BigInt */
 export function recursiveNumberToBigInt<T>(body: T): ReturnRecursiveNumberToBigIntType<T> {
-    if (!body || !['object', 'number'].includes(typeof body)) {
+    if (body === undefined || body === null || !['object', 'number'].includes(typeof body)) {
         return body as ReturnRecursiveNumberToBigIntType<T>;
     }
 

diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -2,3 +2,4 @@ export * from './common.utils';
 export * from './retry.utils';
 export * from './SquareDataMapper';
 export * from './helper';
+export * from './isSquareApiException';
diff --git a/src/utils/isSquareApiException.ts b/src/utils/isSquareApiException.ts
@@ -0,0 +1,5 @@
+import { SquareApiException } from '../exception';
+
+export function isSquareApiException(error: Error | unknown): error is SquareApiException {
+    return error instanceof SquareApiException;
+}
diff --git a/test/unit/utils/SquareDataMapper.spec.ts b/test/unit/utils/SquareDataMapper.spec.ts
@@ -92,7 +92,7 @@ describe('SquareDataMapper', () => {
                 ],
             };
 
-            SquareDataMapper.toNewFormat<SquareConnectOrder>(orderWithOldFormat).should.deep.equals({
+            SquareDataMapper.toNewFormat<SquareConnectOrder>(orderWithOldFormat, false).should.deep.equals({
                 ...order,
                 lineItems: [{ ...order.lineItems![0], basePriceMoney: { ...order.lineItems![0].basePriceMoney, amount: 100 } }],
             });
@@ -113,7 +113,7 @@ describe('SquareDataMapper', () => {
                 ],
             };
 
-            const { lineItems, locationId } = SquareDataMapper.toNewFormat<Order>(orderWithOldFormat, true);
+            const { lineItems, locationId } = SquareDataMapper.toNewFormat<Order>(orderWithOldFormat);
             locationId.should.equal(orderWithOldFormat.location_id);
             const { basePriceMoney, name, quantity }: OrderLineItem = lineItems![0];
             name!.should.be.equal(orderWithOldFormat.line_items?.[0]?.name);

diff --git a/test/unit/utils/helper.spec.ts b/test/unit/utils/helper.spec.ts
@@ -67,6 +67,10 @@ describe('helper', () => {
             };
             recursiveBigIntToNumber(order).should.deep.equals(order);
         });
+
+        it('should be ok 0 bigint', () => {
+            recursiveBigIntToNumber(0n).should.be.equal(0);
+        });
     });
 
     describe('#recursiveNumberToBigInt', () => {
@@ -105,6 +109,10 @@ describe('helper', () => {
             expect(recursiveNumberToBigInt(null)).to.be.null;
         });
 
+        it('should be ok with 0', () => {
+            assert.strictEqual(recursiveNumberToBigInt(0), 0n);
+        });
+
         it('should be ok of object include null property', () => {
             const order: ObjectLikeType = {
                 locationId: null,

diff --git a/test/unit/utils/isSquareApiException.spec.ts b/test/unit/utils/isSquareApiException.spec.ts
@@ -0,0 +1,47 @@
+import { ApiError } from 'square';
+import { isSquareApiException, SquareApiException } from '../../../src';
+
+describe('isSquareApiException', () => {
+    it('should return true', () => {
+        const errors = [
+            {
+                category: 'RATE_LIMIT_ERROR',
+                code: 'RATE_LIMITED',
+                detail: 'fake 429 error',
+            },
+        ];
+        const response = {
+            statusCode: 400,
+            headers: {
+                'user-agent': 'Square-TypeScript-SDK/17.0.0',
+                'Content-Type': 'application/json',
+                'Square-Version': '2021-12-15',
+                authorization: 'Bearer EAAAEDFfyeoo0XgXi-Dd7ofp_3W6eAcjHMClC3GlQR61xATqdVixe6v4kq21KgnL',
+                accept: 'application/json',
+            },
+            body: JSON.stringify({ errors }),
+        };
+
+        const apiError: ApiError = new ApiError(
+            {
+                response,
+                request: {
+                    method: 'POST',
+                    url: 'https://connect.squareupsandbox.com/v2/customers/search',
+                },
+            },
+            '',
+        );
+        isSquareApiException(new SquareApiException(apiError, 0)).should.equal(true);
+    });
+
+    it('should return false', () => {
+        // @ts-ignore
+        isSquareApiException(new ApiError({ request: {}, response: {} })).should.equal(false);
+    });
+
+    it('should return false (unknown)', () => {
+        const error: unknown = undefined;
+        isSquareApiException(error).should.equal(false);
+    });
+});