added clean object fn

Author: oleg-yasenytsky

src/index.ts

@@ -1,4 +1,6 @@
 export { createURLParams } from './lib/create-url-params';
 export { createFormData } from './lib/create-form-data';
+export { cleanObject } from './lib/clean-object';
 export * from './types/create-url-params';
 export * from './types/create-form-data';
+export * from './types/clean-object';

src/lib/clean-object.ts

@@ -0,0 +1,78 @@
+import { CleanObjectConfig, Record } from '../types/clean-object';
+
+const defaultConfig: CleanObjectConfig = {
+  removeEmptyValues: false,
+};
+
+const needSkipValue = (
+  value: unknown,
+  { removeEmptyValues }: CleanObjectConfig
+): boolean => {
+  if (value === null || value === undefined) {
+    return true;
+  }
+  if (typeof value !== 'string') {
+    return false;
+  }
+  return value === '' && removeEmptyValues;
+};
+
+export const cleanObject = (
+  obj: Record,
+  config?: Partial<CleanObjectConfig>
+): Record => {
+  const cfg = Object.assign({ ...defaultConfig }, config || {});
+
+  if (obj === null || obj === undefined) {
+    return {};
+  }
+
+  if (obj instanceof Blob || obj instanceof File || obj instanceof Date) {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.reduce((acc, curr) => {
+      return [...acc, cleanObject(curr)];
+    }, []);
+  }
+
+  const keys = Object.keys(obj);
+  if (!keys.length) {
+    return {};
+  }
+
+  return keys.reduce((acc: Record, key) => {
+    const item = obj[key];
+    if (needSkipValue(item, cfg)) {
+      return acc;
+    }
+    if (Array.isArray(item)) {
+      if (!item.length && cfg.removeEmptyValues) {
+        return acc;
+      }
+      const mapped = item.reduce((arr: Record[], curr) => {
+        if (typeof curr === 'object' && curr) {
+          const cleared = cleanObject(curr, cfg);
+          if (!Object.keys(cleared).length && cfg.removeEmptyValues) {
+            return arr;
+          }
+          return [...arr, cleared];
+        }
+        const skip = needSkipValue(curr, cfg);
+        return skip ? arr : [...arr, curr];
+      }, []);
+      return { ...acc, [`${key}`]: mapped };
+    }
+
+    if (typeof item === 'object' && item) {
+      const mapped = cleanObject(item as Record, cfg);
+      if (!Object.keys(mapped).length && cfg.removeEmptyValues) {
+        return acc;
+      }
+      return { ...acc, [`${key}`]: mapped };
+    }
+
+    return { ...acc, [`${key}`]: item };
+  }, {});
+};

src/lib/create-form-data.ts

@@ -44,21 +44,17 @@ const fillFormData = <T extends object>(
     }
   } else if (typeof value === 'object') {
     if (value instanceof File) {
-      formData.append(
-        keyPrefix,
-        value,
-        value.name
-      );
-    }
-    else if(value instanceof Blob){
-      formData.append(
-        keyPrefix,
-        value,
-      );
+      formData.append(keyPrefix, value, value.name);
+    } else if (value instanceof Blob) {
+      formData.append(keyPrefix, value);
     } else {
       Object.keys(value).forEach((key) => {
         const keyString = getKeyString(keyPrefix, key, index);
-        fillFormData(value[key as keyof object], { ...config, keyPrefix: keyString }, formData);
+        fillFormData(
+          value[key as keyof object],
+          { ...config, keyPrefix: keyString },
+          formData
+        );
       });
     }
   } else {
@@ -76,7 +72,7 @@ const defaultConfig = {
   booleanMapper: (val: boolean) => (val ? '1' : '0'),
   allowNullableValues: false,
   allowEmptyValues: false,
-}
+};
 /**
  *  fill form data recursive function
  * @param value - form value
@@ -89,7 +85,7 @@ export const createFormData = <T extends object>(
   existingFormData?: FormData
 ): FormData => {
   // create config from default and argument options
-  const config = Object.assign({...defaultConfig},options || {});
+  const config = Object.assign({ ...defaultConfig }, options || {});
 
   // return form data if value instanceof FormData
   if (value instanceof FormData) {
@@ -102,6 +98,6 @@ export const createFormData = <T extends object>(
   }
   // fill form data by form value and return
   const formData = existingFormData || new FormData();
-  fillFormData({...value}, config, formData);
+  fillFormData({ ...value }, config, formData);
   return formData;
 };

src/lib/create-url-params.ts

@@ -1,14 +1,12 @@
-import {
-  CreateURLParamsConfig
-} from '../types/create-url-params';
+import { CreateURLParamsConfig } from '../types/create-url-params';
 
 import { getKeyString } from './utils/get-key-string';
 
 const defaultConfig: CreateURLParamsConfig = {
   keyPrefix: '',
   toString: false,
   index: null,
-  booleanMapper: (val: boolean) => (val ? '1' : '0')
+  booleanMapper: (val: boolean) => (val ? '1' : '0'),
 };
 
 export const createURLParams = <T extends object>(
@@ -24,14 +22,14 @@ export const createURLParams = <T extends object>(
 
   if (Array.isArray(value)) {
     return value.reduce((acc: object, curr, i) => {
-      if (typeof curr === 'object') {
+      if (typeof curr === 'object' && curr) {
         return {
           ...acc,
           ...createURLParams(curr, {
             ...config,
             keyPrefix,
-            index: i
-          })
+            index: i,
+          }),
         };
       }
       if (!keyPrefix || curr === null || curr === undefined) {
@@ -41,44 +39,41 @@ export const createURLParams = <T extends object>(
         typeof curr === 'boolean'
           ? booleanMapper(curr)
           : toString
-            ? String(curr)
-            : curr;
+          ? String(curr)
+          : curr;
       return { ...acc, [`${keyPrefix}[${i}]`]: value };
     }, {});
   }
 
-  return Object.keys(value).reduce(
-    (acc: object, key: string) => {
-      const keyString = getKeyString(keyPrefix, key, index);
-      const item = value[key as keyof object];
+  return Object.keys(value).reduce((acc: object, key: string) => {
+    const keyString = getKeyString(keyPrefix, key, index);
+    const item = value[key as keyof object];
 
-      if (Array.isArray(item)) {
-        return {
-          ...acc,
-          ...createURLParams(item, {
-            ...config,
-            keyPrefix: keyString
-          })
-        };
-      }
+    if (Array.isArray(item)) {
+      return {
+        ...acc,
+        ...createURLParams(item, {
+          ...config,
+          keyPrefix: keyString,
+        }),
+      };
+    }
 
-      if (typeof item === 'boolean') {
-        return { ...acc, [`${keyString}`]: booleanMapper(item) };
-      }
+    if (typeof item === 'boolean') {
+      return { ...acc, [`${keyString}`]: booleanMapper(item) };
+    }
 
-      if (item && typeof item === 'object') {
-        return {
-          ...acc,
-          ...createURLParams(item, { ...config, keyPrefix: keyString })
-        };
-      }
+    if (item && typeof item === 'object') {
+      return {
+        ...acc,
+        ...createURLParams(item, { ...config, keyPrefix: keyString }),
+      };
+    }
 
-      if (item !== null && item !== undefined) {
-        const val = toString ? String(item) : item;
-        return { ...acc, [`${keyString}`]: val };
-      }
-      return acc;
-    },
-    {}
-  );
+    if (item !== null && item !== undefined) {
+      const val = toString ? String(item) : item;
+      return { ...acc, [`${keyString}`]: val };
+    }
+    return acc;
+  }, {});
 };

src/types/clean-object.ts

@@ -0,0 +1,7 @@
+export interface Record {
+  [key: string]: unknown;
+}
+
+export interface CleanObjectConfig {
+  removeEmptyValues: boolean;
+}

test/clean-object.spec.ts

@@ -0,0 +1,81 @@
+import { expect, use } from 'chai';
+import { describe, it } from 'mocha';
+import deepEqualInAnyOrder from 'deep-equal-in-any-order';
+
+import { cleanObject } from '../src';
+
+use(deepEqualInAnyOrder);
+
+describe('cleanObject function', () => {
+  it('should be success for simple values', () => {
+    expect(cleanObject({})).to.deep.equal({});
+    expect(cleanObject(null)).to.deep.equal({});
+    const date = new Date();
+    expect(cleanObject(date)).to.deep.equal(date);
+    expect(cleanObject([])).to.deep.equal([]);
+  });
+
+  it('should be success for nullable values obj', () => {
+    const file = new File([], 'test');
+    const obj = {
+      id: 1,
+      name: 'test',
+      surName: '',
+      email: undefined,
+      address: null,
+      subscription: {
+        active: false,
+        status: null,
+        file,
+        previous: [],
+        obj: {},
+      },
+      file,
+      simpleArray: ['', 'test', null],
+      arr: [{ id: 1, name: '', active: null }, null, { id: 3 }, {}, [], file]
+    };
+    const expectedResult = {
+      id: 1,
+      name: 'test',
+      surName: '',
+      subscription: {
+        active: false,
+        file,
+        previous: [],
+        obj: {},
+      },
+      file,
+      simpleArray: ['', 'test'],
+      arr: [{ id: 1, name: '' }, { id: 3 }, {}, [], file]
+    };
+    expect(cleanObject(obj)).to.deep.equal(expectedResult);
+  });
+  it('should be success for empty string and array in obj', () => {
+    const obj = {
+      id: 1,
+      name: 'test',
+      surName: '',
+      address: null,
+      subscription: {
+        active: false,
+        status: '',
+        previous: [{ id: 1, status: null }],
+        emptyArr: [],
+        obj: {},
+      },
+      simpleArray: ['', 'test', null],
+      arr: [{ id: 1, name: '' }, null, {}, []]
+    };
+    const expectedResult = {
+      id: 1,
+      name: 'test',
+      subscription: {
+        active: false,
+        previous: [{ id: 1 }]
+      },
+      simpleArray: ['test'],
+      arr: [{ id: 1 }]
+    };
+    expect(cleanObject(obj, { removeEmptyValues: true })).to.deep.equal(expectedResult);
+  });
+});