Merge branch 'simplify-types'

Author: oleg-yasenytsky

.eslintrc.json

@@ -16,6 +16,7 @@
   "globals": { "BigInt": true, "console": true, "WebAssembly": true },
   "rules": {
     "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
     "eslint-comments/disable-enable-pair": [
       "error",
       { "allowWholeFile": true }

src/lib/clean-object.ts

@@ -1,12 +1,12 @@
-import { CleanObjectConfig } from '../types/clean-object';
+import {CleanObjectConfig, NonNullableFields} from '../types/clean-object';
 
 import { isObject } from './is-object';
 
 const defaultConfig: CleanObjectConfig = {
   removeEmptyValues: false,
 };
 
-const isEmptyObject = (o: object) => Object.keys(o).length === 0;
+const isEmptyObject = (o: Record<string, any>) => Object.keys(o).length === 0;
 
 const needSkipValue = (
   value: unknown,
@@ -29,10 +29,10 @@ const needSkipValue = (
   return false;
 };
 
-export const cleanObject = <T extends object>(
+export const cleanObject = <T extends Record<string, any>>(
   obj: T,
   config?: Partial<CleanObjectConfig>
-): object => {
+): NonNullableFields<T> => {
   const cfg = Object.assign({ ...defaultConfig }, config || {});
 
   if (!isObject(obj)) {
@@ -50,7 +50,7 @@ export const cleanObject = <T extends object>(
     return obj;
   }
 
-  return keys.reduce((acc: object, key) => {
+  return keys.reduce((acc: Record<string, any>, key) => {
     const item = obj[key as keyof T];
     if (needSkipValue(item, cfg)) {
       return acc;
@@ -59,7 +59,7 @@ export const cleanObject = <T extends object>(
       if (!item.length && cfg.removeEmptyValues) {
         return acc;
       }
-      const mapped = item.reduce((arr: object[], curr) => {
+      const mapped = item.reduce((arr: Record<string, any>[], curr: any) => {
         if (isObject(curr)) {
           const cleared = cleanObject(curr, cfg);
           if (isEmptyObject(cleared) && cfg.removeEmptyValues) {
@@ -82,5 +82,5 @@ export const cleanObject = <T extends object>(
     }
 
     return { ...acc, [`${key}`]: item };
-  }, {});
+  }, {}) as NonNullableFields<T>;
 };

src/lib/create-form-data.ts

@@ -9,7 +9,7 @@ import { getKeyString } from './utils/get-key-string';
  * @param config - configuration object
  * @param formData - form data instance
  */
-const fillFormData = <T extends object>(
+const fillFormData = <T extends Record<string, any>>(
   value: T | T[] | PrimitiveTypes,
   config: CreateFormDataConfig,
   formData: FormData
@@ -51,7 +51,7 @@ const fillFormData = <T extends object>(
       Object.keys(value).forEach((key) => {
         const keyString = getKeyString(keyPrefix, key, index);
         fillFormData(
-          value[key as keyof object],
+          value[key as keyof Record<string, any>],
           { ...config, keyPrefix: keyString },
           formData
         );
@@ -79,7 +79,7 @@ const defaultConfig = {
  * @param options - configuration object
  * @param existingFormData - optional existing form data instance
  */
-export const createFormData = <T extends object>(
+export const createFormData = <T extends Record<string, any>>(
   value: T | FormData,
   options?: Partial<CreateFormDataConfig>,
   existingFormData?: FormData

src/lib/create-url-params.ts

@@ -4,24 +4,23 @@ import { getKeyString } from './utils/get-key-string';
 
 const defaultConfig: CreateURLParamsConfig = {
   keyPrefix: '',
-  toString: false,
   index: null,
   booleanMapper: (val: boolean) => (val ? '1' : '0'),
 };
 
-export const createURLParams = <T extends object>(
+export const createURLParams = <T extends Record<string, any>>(
   value: T | T[] | null | undefined,
   config?: Partial<CreateURLParamsConfig>
-): object => {
-  const { keyPrefix, toString, index, booleanMapper }: CreateURLParamsConfig =
+): Record<string, string> => {
+  const { keyPrefix, index, booleanMapper }: CreateURLParamsConfig =
     Object.assign({ ...defaultConfig }, config || {});
 
   if (value === undefined || value === null) {
     return {};
   }
 
   if (Array.isArray(value)) {
-    return value.reduce((acc: object, curr, i) => {
+    return value.reduce((acc: Record<string, any>, curr, i) => {
       if (typeof curr === 'object' && curr) {
         return {
           ...acc,
@@ -38,16 +37,14 @@ export const createURLParams = <T extends object>(
       const value =
         typeof curr === 'boolean'
           ? booleanMapper(curr)
-          : toString
-          ? String(curr)
-          : curr;
+          : String(curr);
       return { ...acc, [`${keyPrefix}[${i}]`]: value };
     }, {});
   }
 
-  return Object.keys(value).reduce((acc: object, key: string) => {
+  return Object.keys(value).reduce((acc: Record<string, string>, key: string) => {
     const keyString = getKeyString(keyPrefix, key, index);
-    const item = value[key as keyof object];
+    const item = value[key as keyof Record<string, string>];
 
     if (Array.isArray(item)) {
       return {
@@ -59,21 +56,20 @@ export const createURLParams = <T extends object>(
       };
     }
 
+    if(item === null || item === undefined){
+      return acc;
+    }
+
     if (typeof item === 'boolean') {
       return { ...acc, [`${keyString}`]: booleanMapper(item) };
     }
 
-    if (item && typeof item === 'object') {
+    if (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;
+    return { ...acc, [`${keyString}`]: String(item) };
   }, {});
 };

src/types/clean-object.ts

@@ -1,3 +1,11 @@
 export interface CleanObjectConfig {
   removeEmptyValues: boolean;
 }
+
+export type NonNullableFields<T extends Record<string, any>> = {
+  [Key in keyof T]: T[Key] extends infer U
+    ? U extends null
+      ? never
+      : U
+    : never;
+};

src/types/create-url-params.ts

@@ -1,6 +1,5 @@
 export interface CreateURLParamsConfig {
   keyPrefix: string;
-  toString: boolean;
   index: number | null;
   booleanMapper: (value: boolean) => string;
 }

test/create-url-params.spec.ts

@@ -45,7 +45,7 @@ describe('createURLParams function', () => {
       hasSubscription: false,
       test: [true],
     };
-    expect(createURLParams(obj, {toString: true})).to.deep.equal({
+    expect(createURLParams(obj)).to.deep.equal({
       name: 'test',
       email: '[email protected]',
       'additionalEmails[0]': '[email protected]',
@@ -66,7 +66,7 @@ describe('createURLParams function', () => {
 
   it('should be success with to string arg', () => {
     const obj = { name: 'test', email: '[email protected]', age: 1 };
-    expect(createURLParams(obj, {toString: true})).to.deep.equal({
+    expect(createURLParams(obj)).to.deep.equal({
       name: 'test',
       email: '[email protected]',
       age: '1'
@@ -75,7 +75,7 @@ describe('createURLParams function', () => {
 
   it('should be success with default parent arg', () => {
     const obj = { name: 'test', email: '[email protected]', age: 1 };
-    expect(createURLParams(obj, {toString: true})).to.deep.equal({
+    expect(createURLParams(obj)).to.deep.equal({
       name: 'test',
       email: '[email protected]',
       age: '1'
@@ -84,15 +84,15 @@ describe('createURLParams function', () => {
 
   it('should be success with default parent arg', () => {
     const obj = { name: 'test', email: '[email protected]' };
-    expect(createURLParams(obj, {keyPrefix: 'parent', toString: true})).to.deep.equal({
+    expect(createURLParams(obj, {keyPrefix: 'parent'})).to.deep.equal({
       'parent[name]': 'test',
       'parent[email]': '[email protected]'
     });
   });
 
   it('should be success with default index arg', () => {
     const obj = { name: 'test', email: '[email protected]' };
-    expect(createURLParams(obj, {keyPrefix: 'parent', toString: false, index:3})).to.deep.equal({
+    expect(createURLParams(obj, {keyPrefix: 'parent', index:3})).to.deep.equal({
       'parent[3][name]': 'test',
       'parent[3][email]': '[email protected]'
     });
@@ -125,7 +125,7 @@ describe('createURLParams function', () => {
     expect(createURLParams(arr)).to.deep.equal({
       "code": "545",
       "phone": "55555",
-      "isConnectable": 1,
+      "isConnectable": "1",
       "socials[0]": "viber",
       "socials[1]": "telegram"
     });