@codeleap/mobile 3.22.1 → 3.22.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codeleap/mobile",
-  "version": "3.22.1",
+  "version": "3.22.2",
   "main": "src/index.ts",
   "license": "UNLICENSED",
   "repository": {

package/src/utils/index.ts

@@ -11,3 +11,4 @@ export * from './input'
 export * from './theme'
 export * from './locale'
 export * from './Subscription'
+export * from './useQueryListRefresh'

package/src/utils/useQueryListRefresh.ts

@@ -0,0 +1,60 @@
+import React from 'react'
+import { useFocusEffect } from '@react-navigation/native'
+import { AnyFunction, TypeGuards, UseListEffect } from '@codeleap/common'
+
+type useQueryListRefresh = (
+  listQuery: Parameters<UseListEffect>[0],
+  options?: {
+    staleTime?: number
+    silentRefresh?: boolean
+    initialStale?: boolean
+    cancelQueryEnabled?: boolean
+    refreshQueryEnabled?: boolean
+    onFocus?: AnyFunction
+    onBlur?: AnyFunction
+  }
+) => void
+
+export const useQueryListRefresh: useQueryListRefresh = (listQuery, options = {}) => {
+  const {
+    staleTime = 5000,
+    initialStale = listQuery?.query?.isStale,
+    cancelQueryEnabled = true,
+    refreshQueryEnabled = true,
+    silentRefresh = false,
+    onFocus,
+    onBlur,
+  } = options
+
+  const staleRefetch = React.useRef(initialStale)
+  const staleTimeout = React.useRef(null)
+
+  useFocusEffect(
+    React.useCallback(() => {
+      if (staleRefetch.current && refreshQueryEnabled) {
+        listQuery?.refreshQuery(silentRefresh)
+      }
+
+      if (TypeGuards.isFunction(onFocus)) {
+        onFocus?.()
+      }
+
+      return () => {
+        if (cancelQueryEnabled) listQuery?.cancelQuery?.()
+        staleRefetch.current = false
+
+        if (staleTimeout.current == null) {
+          staleTimeout.current = setTimeout(() => {
+            staleRefetch.current = true
+            clearTimeout(staleTimeout.current)
+            staleTimeout.current = null
+          }, staleTime)
+        }
+
+        if (TypeGuards.isFunction(onBlur)) {
+          onBlur?.()
+        }
+      }
+    }, [])
+  )
+}