Merge pull request #1 from idapgroup/feature/keys-to-snake-case

add keys to snake case fn

Author: oleg-yasenytsky

README.md

@@ -24,7 +24,7 @@ import { isObject } from '@idapgroup/js-object-utils';
 
 const object = {
   /**
-   * key-value mapping
+   * key: value
    * values can be primitives or objects
    */
 };
@@ -81,7 +81,7 @@ import { createFormData } from '@idapgroup/js-object-utils';
 
 const object = {
   /**
-   * key-value mapping
+   * key: value
    * values can be primitives or objects
    */
 };
@@ -131,7 +131,7 @@ import { createURLParams } from '@idapgroup/js-object-utils';
 
 const object = {
   /**
-   * key-value mapping
+   * key: value
    * values can be primitives or objects
    */
 };
@@ -168,7 +168,7 @@ import { cleanObject } from '@idapgroup/js-object-utils';
 
 const object = {
   /**
-   * key-value mapping
+   * key: value
    * values can be primitives or objects
    */
 };
@@ -178,3 +178,22 @@ const obj = cleanObject(
   options, // optional
 );
 ```
+
+### keysToSnakeCase
+
+Transform object keys to snake case
+
+```js
+import { cleanObject } from '@idapgroup/keysToSnakeCase';
+
+const object = {
+  /**
+   * key: value
+   * values can be primitives or objects
+   */
+};
+
+const obj = keysToSnakeCase(
+  object
+);
+```

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@idapgroup/js-object-utils",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Javascript functions for transform or mutate object",
   "main": "build/main/index.js",
   "module": "build/module/index.js",
   "typings": "build/main/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/idapgroup/js-object-utils.git"
+    "url": "git+https://github.com/idapgroup/js-object-utils.git"
   },
   "license": "MIT",
   "scripts": {

register.js

@@ -1,5 +1,4 @@
 const tsNode = require('ts-node');
-const testTSConfig = require('./test/tsconfig.spec.json');
 
 tsNode.register({
   files: true,

src/index.ts

@@ -2,6 +2,7 @@ export { createURLParams } from './lib/create-url-params';
 export { createFormData } from './lib/create-form-data';
 export { cleanObject } from './lib/clean-object';
 export { isObject } from './lib/is-object';
+export { keysToSnakeCase } from './lib/keys-to-snake-case';
 export * from './types/create-url-params';
 export * from './types/create-form-data';
 export * from './types/clean-object';

src/lib/keys-to-snake-case.ts

@@ -0,0 +1,18 @@
+export const keysToSnakeCase = <T extends Record<string, any>>(
+  obj: T
+): Record<string, any> => {
+  if (obj === null || obj === undefined) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((v) => keysToSnakeCase(v));
+  }
+  if (typeof obj === 'object') {
+    return Object.entries(obj).reduce((acc, [k, v]) => {
+      return Object.assign(Object.assign({}, acc), {
+        [k.replace(/([A-Z])/g, '_$1').toLowerCase()]: keysToSnakeCase(v),
+      });
+    }, {});
+  }
+  return obj;
+};

test/keys-to-snake-case.spec.ts

@@ -0,0 +1,78 @@
+import {describe, it} from "mocha";
+import {expect, use} from "chai";
+import {keysToSnakeCase} from "../src";
+import deepEqualInAnyOrder from 'deep-equal-in-any-order';
+
+use(deepEqualInAnyOrder);
+describe('keysToSnakeCase function', () => {
+  it('should be object with snake keys', () => {
+    const obj = {
+      name: 'test',
+      address: { 'street': '123 Street' },
+      additionalEmails: ['[email protected]', '[email protected]', null],
+      phones: [
+        {
+          countryCode: '123',
+          phoneNumber: '2345435'
+        },
+        {
+          countryCode: '545',
+          phoneNumber: '55555',
+          isConnectable: 1,
+          hasSocial: true,
+          socials: ['viber', 'telegram']
+        }
+      ],
+      products: [],
+      hasSubscription: false,
+      test: [true],
+    };
+    expect(keysToSnakeCase(obj)).to.deep.equal({
+      name: 'test',
+      address: { 'street': '123 Street' },
+      additional_emails: ['[email protected]', '[email protected]', null],
+      phones: [
+        {
+          country_code: '123',
+          phone_number: '2345435'
+        },
+        {
+          country_code: '545',
+          phone_number: '55555',
+          is_connectable: 1,
+          has_social: true,
+          socials: ['viber', 'telegram']
+        }
+      ],
+      products: [],
+      has_subscription: false,
+      test: [true],
+    })
+  });
+  it('should be object array with snake keys', () => {
+    const arr = [
+      {
+        countryCode: '123',
+        phoneNumber: '2345435'
+      },
+      {
+        code: '545',
+        phoneNumber: '55555',
+        isConnectable: 1,
+        socials: ['viber', 'telegram']
+      }
+    ];
+    expect(keysToSnakeCase(arr)).to.deep.equal([
+      {
+        country_code: '123',
+        phone_number: '2345435'
+      },
+      {
+        code: '545',
+        phone_number: '55555',
+        is_connectable: 1,
+        socials: ['viber', 'telegram']
+      }
+    ])
+  })
+})

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "incremental": true,
-    "target": "ES2015",
+    "target": "ES2017",
     "outDir": "build/main",
     "rootDir": "src",
     "moduleResolution": "node",
@@ -19,7 +19,7 @@
     "listEmittedFiles": false ,
     "listFiles": false,
     "pretty": true,
-    "lib": ["ES2015", "dom"],
+    "lib": ["ES2017", "dom"],
     "types": [],
     "typeRoots": ["node_modules/@types", "src/types"]
   },

tsconfig.module.json

@@ -4,7 +4,7 @@
     "baseUrl": "./",
     "target": "ESNext",
     "module": "ESNext",
-    "lib": ["ES2015", "dom"],
+    "lib": ["ES2017", "dom"],
     "outDir": "./build/module",
   }
 }