Merge pull request #1365 from maxmind/greg/no-snakecase

Replace snakecase-keys

Author: oschwald

package-lock.json

@@ -68,7 +68,6 @@
     "@maxmind/geoip2-node": "^5.0.0",
     "maxmind": "^4.1.0",
     "punycode": "^2.1.1",
-    "snakecase-keys": "^6.0.0",
     "validator": "^13.0.0"
   }
 }

package.json

@@ -1,7 +1,7 @@
 import { isIP } from 'net';
-import snakecaseKeys from 'snakecase-keys';
 import { Tag } from '../constants';
 import { ArgumentError } from '../errors';
+import { snakecaseKeys } from '../utils';
 
 interface TransactionReportProps {
   /**

src/request/transaction-report.ts

@@ -1,4 +1,3 @@
-import snakecaseKeys from 'snakecase-keys';
 import { ArgumentError } from '../errors';
 import Account from './account';
 import Billing from './billing';
@@ -11,6 +10,7 @@ import Order from './order';
 import Payment from './payment';
 import Shipping from './shipping';
 import ShoppingCartItem from './shopping-cart-item';
+import { snakecaseKeys } from '../utils';
 
 export interface TransactionProps {
   /**

src/request/transaction.ts

@@ -1,4 +1,4 @@
-import { snakeToCamelCase, camelizeResponse } from './utils';
+import { snakecaseKeys, snakeToCamelCase, camelizeResponse } from './utils';
 
 describe('src/Utils', () => {
   describe('snakeToCamelCase()', () => {
@@ -146,4 +146,95 @@ describe('src/Utils', () => {
       });
     });
   });
+  describe('snakecaseKeys()', () => {
+    it("converts an object's keys from camelCase to snake_case", () => {
+      const cases = [
+        {
+          input: { snakeCase: 1 },
+          expected: { snake_case: 1 },
+        },
+        {
+          input: { snakeCase: 1, anotherSnakeCase: 2 },
+          expected: { snake_case: 1, another_snake_case: 2 },
+        },
+      ];
+      cases.forEach((testCase) => {
+        expect(snakecaseKeys(testCase.input)).toEqual(testCase.expected);
+      });
+    });
+
+    it("converts a nested object's keys from camelCase to snake_case", () => {
+      const cases = [
+        {
+          input: { snakeCase: { abCd: 1 } },
+          expected: { snake_case: { ab_cd: 1 } },
+        },
+        {
+          input: { snakeCase: { enGb: 1 } },
+          expected: { snake_case: { en_gb: 1 } },
+        },
+        {
+          input: { enGb: { snakeCasePlus: { anotherOne: 1 } } },
+          expected: { en_gb: { snake_case_plus: { another_one: 1 } } },
+        },
+        {
+          input: {
+            enGb: { snakeCasePlus: { anotherOne: { yetAnother: 1 } } },
+          },
+          expected: {
+            en_gb: { snake_case_plus: { another_one: { yet_another: 1 } } },
+          },
+        },
+      ];
+      cases.forEach((testCase) => {
+        expect(snakecaseKeys(testCase.input)).toEqual(testCase.expected);
+      });
+    });
+
+    it('converts keys of objects contained in an array', () => {
+      const cases = [
+        {
+          input: { snakeCase: { abCd: [{ qwertyDvorak: 1 }] } },
+          expected: { snake_case: { ab_cd: [{ qwerty_dvorak: 1 }] } },
+        },
+        {
+          input: {
+            snakeCase: [
+              { abCd: [{ qwertyDvorak: 1 }] },
+              'dont_change_me',
+              { zxyWt: [7, { pp: 42, llllMmm: 'aa_aa' }] },
+            ],
+            caseSnake: {
+              snakeCamel: [
+                { mnOpQrSt: [[{ objKey: ['a', 7, { keyObj: 99 }] }]] },
+              ],
+            },
+          },
+          expected: {
+            snake_case: [
+              { ab_cd: [{ qwerty_dvorak: 1 }] },
+              'dont_change_me',
+              { zxy_wt: [7, { pp: 42, llll_mmm: 'aa_aa' }] },
+            ],
+            case_snake: {
+              snake_camel: [
+                { mn_op_qr_st: [[{ obj_key: ['a', 7, { key_obj: 99 }] }]] },
+              ],
+            },
+          },
+        },
+        {
+          input: [42, { snakeCase: { abCd: [{ qwertyDvorak: 1 }] } }, '180'],
+          expected: [
+            42,
+            { snake_case: { ab_cd: [{ qwerty_dvorak: 1 }] } },
+            '180',
+          ],
+        },
+      ];
+      cases.forEach((testCase) => {
+        expect(snakecaseKeys(testCase.input)).toEqual(testCase.expected);
+      });
+    });
+  });
 });