chore: adding infinite query hook and query client options

Author: vmarcosp

README.md

@@ -1,14 +1,10 @@
-## useQuery(...) ✅
-
-## useQueries(...) ✅
-
 ## Features
 
 - useQuery ✅
 - useQueries ✅
 - useMutation ✅
-- useInfiniteQuery
-- useQueryClient
+- useInfiniteQuery ✅
+- useQueryClient ✅
 - useQueryErrorResetBoundary ✅
 - useIsFetching ✅
 - useIsMutating ✅

examples/src/bindings/ReactQuery.res

@@ -1,3 +1,4 @@
+module InfiniteQuery = ReactQuery_InfiniteQuery
 include ReactQuery_Query
 include ReactQuery_Mutation
 include ReactQuery_Hooks

examples/src/bindings/ReactQuery_Client.res

@@ -1,6 +1,30 @@
 type queryClientValue
 type fetchMeta
 
+type invalidateQueryFilter = {
+  refetchActive: option<bool>,
+  refetchInactive: option<bool>,
+}
+
+type clientRefetchOptions = {throwOnError: option<bool>}
+
+type invalidateQueryOptions<'queryKey> = {
+  queryKey: option<'queryKey>,
+  filters: option<invalidateQueryFilter>,
+  refetchOptions: option<clientRefetchOptions>,
+}
+
+type refetchQueriesOptions<'queryKey> = {
+  queryKey: option<'queryKey>,
+  filters: option<ReactQuery_Types.queryFilter<'queryKey>>,
+  refetchOptions: option<clientRefetchOptions>,
+}
+
+type cancelQueriesOptions<'queryKey> = {
+  queryKey: option<'queryKey>,
+  filters: option<ReactQuery_Types.queryFilter<'queryKey>>,
+}
+
 type queryState<'queryData, 'queryError> = {
   data: option<'queryData>,
   dataUpdateCount: int,
@@ -50,6 +74,31 @@ type queryClient<'queryKey, 'queryData, 'queryError, 'pageParams> = {
     ReactQuery_Types.queryDataKeyOrFilterValue<'queryKey>,
     option<'queryData> => 'queryData,
   ) => unit,
+  invalidateQueries: (
+    option<ReactQuery_Types.queryFilter<'queryKey>>,
+    option<clientRefetchOptions>,
+  ) => Js.Promise.t<unit>,
+  refetchQueries: (
+    option<ReactQuery_Types.queryFilter<'queryKey>>,
+    option<clientRefetchOptions>,
+  ) => Js.Promise.t<unit>,
+  cancelQueries: option<ReactQuery_Types.queryFilter<'queryKey>> => Js.Promise.t<unit>,
+  removeQueries: option<ReactQuery_Types.queryFilter<'queryKey>> => Js.Promise.t<unit>,
+  resetQueries: (
+    option<ReactQuery_Types.queryFilter<'queryKey>>,
+    option<clientRefetchOptions>,
+  ) => Js.Promise.t<unit>,
+  isFetching: option<ReactQuery_Types.queryFilter<'queryKey>> => bool,
+  isMutating: option<ReactQuery_Types.queryFilter<'queryKey>> => bool,
+  // setDefaultOptions
+  // getDefaultOptions
+  // setQueryDefaults
+  // getQueryDefaults
+  // getQueryCache
+  // setQueryCache
+  // getMutationCache
+  // setMutationCache
+  clear: unit => unit,
 }
 
 @module("react-query")

examples/src/bindings/ReactQuery_InfiniteQuery.res

@@ -0,0 +1,76 @@
+type inifiniteQueryFunctionContext<'queryKey, 'pageParam> = {
+  queryKey: array<'queryKey>,
+  pageParam: option<'pageParam>,
+}
+
+@deriving(abstract)
+type infiniteQueryOptions<'queryKey, 'queryData, 'queryError, 'pageParam> = {
+  @optional queryKey: 'queryKey,
+  @optional
+  queryFn: inifiniteQueryFunctionContext<'queryKey, 'pageParam> => Js.Promise.t<'queryData>,
+  @optional enabled: bool,
+  @optional retry: ReactQuery_Types.retryValue<'queryError>,
+  @optional retryOnMount: bool,
+  @optional retryDelay: ReactQuery_Types.retryDelayValue<'queryError>,
+  @optional staleTime: ReactQuery_Types.timeValue,
+  @optional queryKeyHashFn: 'queryKey => string,
+  @optional refetchInterval: ReactQuery_Types.refetchIntervalValue,
+  @optional refetchIntervalInBackground: bool,
+  @optional refetchOnMount: ReactQuery_Types.boolOrAlwaysValue,
+  @optional refetchOnWindowFocus: ReactQuery_Types.boolOrAlwaysValue,
+  @optional refetchOnReconnect: ReactQuery_Types.boolOrAlwaysValue,
+  @optional notifyOnChangeProps: ReactQuery_Types.notifyOnChangePropsValue,
+  @optional notifyOnChangePropsExclusions: array<string>,
+  @optional onSuccess: 'queryData => unit,
+  @optional onError: 'queryError => unit,
+  @optional onSettled: ('queryData, 'queryError) => unit,
+  @optional select: 'queryData => 'queryData,
+  @optional suspense: bool,
+  @optional keepPreviousData: bool,
+  @optional structuralSharing: bool,
+  @optional useErrorBoundary: bool,
+  @optional initialData: 'queryData => 'queryData,
+  @optional initialDataUpdatedAt: unit => int,
+  @optional placeholderData: unit => 'queryData,
+  @optional getNextPageParam: ('pageParam, array<'pageParam>) => option<'pageParam>,
+  @optional getPreviousPageParam: ('pageParam, array<'pageParam>) => option<'pageParam>,
+}
+
+type rec infiniteQueryResult<'queryError, 'queryData, 'pageParam> = {
+  status: ReactQuery_Types.queryStatus,
+  isIdle: bool,
+  isError: bool,
+  isFetched: bool,
+  isFetchedAfterMount: bool,
+  isFetching: bool,
+  isLoading: bool,
+  isLoadingError: bool,
+  isPlaceholderData: bool,
+  isPreviousData: bool,
+  isRefetchError: bool,
+  isStale: bool,
+  isSuccess: bool,
+  dataUpdatedAt: int,
+  error: Js.Nullable.t<'queryError>,
+  errorUpdatedAt: int,
+  failureCount: int,
+  refetch: ReactQuery_Types.refetchOptions => Js.Promise.t<
+    infiniteQueryResult<'queryError, 'queryData, 'pageParam>,
+  >,
+  remove: unit => unit,
+  data: ReactQuery_Types.infiniteData<'queryData, 'pageParam>,
+  isFetchingNextPage: bool,
+  isFetchingPreviousPage: bool,
+  //fetchNextPage: (options?: FetchNextPageOptions) => Promise<UseInfiniteQueryResult>
+  //fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<UseInfiniteQueryResult>
+  hasNextPage: bool,
+  hasPreviousPage: bool,
+}
+
+@module("react-query")
+external useQuery: infiniteQueryOptions<
+  'queryKey,
+  'queryData,
+  'queryError,
+  'pageParam,
+> => infiniteQueryResult<'queryError, 'queryData, 'pageParam> = "useInfiniteQuery"

examples/src/bindings/ReactQuery_Query.res

@@ -1,8 +1,3 @@
-type refetchOptions = {
-  throwOnError: bool,
-  cancelRefetch: bool,
-}
-
 @deriving(abstract)
 type queryOptions<'queryKey, 'queryData, 'queryError> = {
   @optional queryKey: 'queryKey,
@@ -52,7 +47,7 @@ type rec queryResult<'queryError, 'queryData> = {
   error: Js.Nullable.t<'queryError>,
   errorUpdatedAt: int,
   failureCount: int,
-  refetch: refetchOptions => Js.Promise.t<queryResult<'queryError, 'queryData>>,
+  refetch: ReactQuery_Types.refetchOptions => Js.Promise.t<queryResult<'queryError, 'queryData>>,
   remove: unit => unit,
 }
 

examples/src/bindings/ReactQuery_Types.res

@@ -14,9 +14,9 @@ type time = [#number(int) | #infinity]
 type refetchInterval = [#bool(bool) | #number(int)]
 type boolOrAlways = [#bool(bool) | #always]
 type notifyOnChangeProps = [#array(array<string>) | #tracked]
-type infiniteData<'queryData, 'params> = {
+type infiniteData<'queryData, 'pageParam> = {
   pages: array<'queryData>,
-  pageParams: array<'params>,
+  pageParams: array<'pageParam>,
 }
 type queryStatus = [#loading | #success | #idle | #error | #initialData]
 
@@ -32,3 +32,8 @@ type queryFilter<'queryKey> = {
 }
 
 type queryDataKeyOrFilter<'queryKey> = [#keys('queryKey) | #filters(queryFilter<'queryKey>)]
+
+type refetchOptions = {
+  throwOnError: bool,
+  cancelRefetch: bool,
+}