Simplify react query state

src/_internal/isClientSide.ts

@@ -0,0 +1 @@
+export const isClientSide: boolean = typeof document === 'object'

src/_internal/parseQueryString.ts

@@ -0,0 +1,45 @@
+import { isEmpty, mapValues, pickBy, isNil } from 'lodash'
+
+export const parseUrlString = (filter: any): any => {
+  if (filter instanceof Date) {
+    return filter.toISOString()
+  }
+  if (Array.isArray(filter)) {
+    if (filter.length === 0) {
+      return undefined
+    }
+    return filter.map(parseUrlString)
+  }
+  if (typeof filter === 'object') {
+    if (isEmpty(filter)) {
+      return undefined
+    }
+    if (filter['0']) {
+      return Object.values(filter)
+    }
+    return parseQueryString(filter)
+  }
+  if (filter === 'true') {
+    return true
+  }
+  if (filter === 'false') {
+    return false
+  }
+  try {
+    const numberInput = Number(filter.trim())
+    if (!isNaN(numberInput)) {
+      return Math.round(numberInput)
+    }
+  } catch (e) {
+    //
+  }
+  return filter
+}
+
+export const parseQueryString = <FiltersType>(filters: any) => {
+  const state = pickBy(mapValues(filters, parseUrlString), (el) => !isNil(el))
+  if (isEmpty(state)) {
+    return undefined
+  }
+  return state
+}

src/index.ts

@@ -1,4 +1,2 @@
-export { default as useQueryState } from './useQueryState'
-export { default as cleanQueryState } from './cleanQueryState'
-export { default as QueryStateProvider } from './QueryStateProvider'
-export { UseQueryStateOptions, UrlOptions } from './types'
+export { useQueryState } from './useQueryState'
+export { UseQueryStateOptions } from './types'

src/types.ts

@@ -1,15 +1,21 @@
-export type UrlOptions = {
-  shouldUseGetRoot?: boolean
-  persist?: boolean
-  persistInitial?: boolean
-}
-
-export type UseQueryStateOptions<FiltersType> = {
+export type UseQueryStateOptions<FiltersType extends object> = {
+  /**
+   * Default value used in state
+   * @default {}
+   */
   defaultValue?: FiltersType
-  customClean?: (filter: any, key?: string | number) => any | void
-  url?: UrlOptions
-  value?: FiltersType
-  onChange?: (groupName: string, value: FiltersType) => void
-  persistValue?: (groupName: string, value: FiltersType) => void
-  groupName?: string
+  /**
+   * Persist state in query url
+   * @default true
+   */
+  persist?: boolean
+  /**
+   * If provided, state is persisted in session storage with the key provided
+   */
+  cacheKey?: string
+  /**
+   * Overwrites default parse url function
+   * @param url
+   */
+  parseSearch?: (search: string) => object | undefined
 }