react-redux-cache 0.5.0 → 0.5.1

package/README.md

@@ -122,7 +122,7 @@ Examples of states, generated by cache reducer from `/example` project:
    - [api.ts](https://github.com/gentlee/react-redux-cache#apits) 
  - [Usage](https://github.com/gentlee/react-redux-cache#usage)
  - [Advanced](https://github.com/gentlee/react-redux-cache#advanced)
-   - [resultSelector](https://github.com/gentlee/react-redux-cache#resultselector)
+   - [Advanced cache policy](https://github.com/gentlee/react-redux-cache#advanced-cache-policy)
    - [Infinite scroll pagination](https://github.com/gentlee/react-redux-cache#infinite-scroll-pagination)
    - [redux-persist](https://github.com/gentlee/react-redux-cache#redux-persist)
  - [FAQ](https://github.com/gentlee/react-redux-cache#faq)
@@ -248,7 +248,7 @@ export const UserScreen = () => {
 
 ### Advanced
 
-#### Advanced cache policy & skip / fetch usage
+#### Advanced cache policy
 
 `cache-first` cache policy skips fetching if result is already cached, but sometimes it can't determine that we already have result in some other's query result or in normalized entities cache. In that case we can use `skip` parameter of a query:
 
@@ -327,9 +327,7 @@ Here is an example of `getUsers` query configuration with pagination support. Yo
 // Component
 
 export const GetUsersScreen = () => {
-  const {query} = useClient()
-
-  const [{result: usersResult, loading, error, params}, refetch] = useQuery({
+  const [{result: usersResult, loading, error, params}, fetchUsers] = useQuery({
     query: 'getUsers',
     params: 1 // page
   })
@@ -339,7 +337,7 @@ export const GetUsersScreen = () => {
 
   const onLoadNextPage = () => {
     const lastLoadedPage = usersResult?.page ?? 0
-    query({
+    fetchUsers({
       query: 'getUsers',
       params: lastLoadedPage + 1,
     })
@@ -355,7 +353,7 @@ export const GetUsersScreen = () => {
     <div>
       {refreshing && <div className="spinner" />}
       {usersResult?.items.map(renderUser)}
-      <button onClick={refetch}>Refresh</button>
+      <button onClick={() => fetchUsers()}>Refresh</button>
       {loadingNextPage ? (
         <div className="spinner" />
       ) : (

package/dist/createCache.d.ts

@@ -127,7 +127,9 @@ export declare const createCache: <N extends string, T extends Typenames, QP, QR
             }) => Promise<MutationResult<MK_6 extends keyof MP & keyof MR ? MR[MK_6] : never>>;
         };
         /** Fetches query when params change and subscribes to query state. */
-        useQuery: <QK_7 extends keyof QP | keyof QR>(options: import("./types").UseQueryOptions<T, QP, QR, QK_7>) => readonly [QueryMutationState<QK_7 extends keyof QP & keyof QR ? QP[QK_7] : never, QK_7 extends keyof QP & keyof QR ? QR[QK_7] : never>, () => Promise<QueryResult<QK_7 extends infer T_5 ? T_5 extends QK_7 ? T_5 extends keyof QP & keyof QR ? QR[T_5] : never : never : never>>];
+        useQuery: <QK_7 extends keyof QP | keyof QR>(options: import("./types").UseQueryOptions<T, QP, QR, QK_7>) => readonly [QueryMutationState<QK_7 extends keyof QP & keyof QR ? QP[QK_7] : never, QK_7 extends keyof QP & keyof QR ? QR[QK_7] : never>, (options?: {
+            params: QK_7 extends keyof QP & keyof QR ? QP[QK_7] : never;
+        } | undefined) => Promise<QueryResult<QK_7 extends infer T_5 ? T_5 extends QK_7 ? T_5 extends keyof QP & keyof QR ? QR[T_5] : never : never : never>>];
         /** Subscribes to provided mutation state and provides mutate function. */
         useMutation: <MK_7 extends keyof MP | keyof MR>(options: {
             mutation: MK_7;

package/dist/index.js

@@ -23,7 +23,7 @@ Object.defineProperty(exports, "defaultGetCacheKey", { enumerable: true, get: fu
 Object.defineProperty(exports, "defaultQueryMutationState", { enumerable: true, get: function () { return utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE; } });
 // Backlog
 // ! high
-// useQuery refresh with params use as client.query?
+// add full api docs
 // update readme with how to use mergeResults for invalidating / updating caches?
 // optimistic response
 // make query key / cache key difference more clear in the docs, and/or rename queryKey -> query

package/dist/useQuery.d.ts

@@ -1,3 +1,5 @@
 import { ActionMap } from './createActions';
 import { Cache, QueryMutationState, Typenames, UseQueryOptions } from './types';
-export declare const useQuery: <N extends string, T extends Typenames, QP, QR, MP, MR, QK extends keyof QP | keyof QR>(cache: Cache<N, T, QP, QR, MP, MR>, actions: Pick<ActionMap<N, T, QP, QR, MP, MR>, "updateQueryStateAndEntities">, options: UseQueryOptions<T, QP, QR, QK>) => readonly [QueryMutationState<QK extends keyof QP & keyof QR ? QP[QK] : never, QK extends keyof QP & keyof QR ? QR[QK] : never>, () => Promise<import("./types").QueryResult<QK extends infer T_1 ? T_1 extends QK ? T_1 extends keyof QP & keyof QR ? QR[T_1] : never : never : never>>];
+export declare const useQuery: <N extends string, T extends Typenames, QP, QR, MP, MR, QK extends keyof QP | keyof QR>(cache: Cache<N, T, QP, QR, MP, MR>, actions: Pick<ActionMap<N, T, QP, QR, MP, MR>, "updateQueryStateAndEntities">, options: UseQueryOptions<T, QP, QR, QK>) => readonly [QueryMutationState<QK extends keyof QP & keyof QR ? QP[QK] : never, QK extends keyof QP & keyof QR ? QR[QK] : never>, (options?: {
+    params: QK extends keyof QP & keyof QR ? QP[QK] : never;
+} | undefined) => Promise<import("./types").QueryResult<QK extends infer T_1 ? T_1 extends QK ? T_1 extends keyof QP & keyof QR ? QR[T_1] : never : never : never>>];

package/dist/useQuery.js

@@ -23,10 +23,13 @@ const useQuery = (cache, actions, options) => {
     const store = (0, react_redux_1.useStore)();
     // @ts-expect-error fix types later
     const cacheKey = getCacheKey(params);
-    const fetch = (0, react_1.useCallback)(() => __awaiter(void 0, void 0, void 0, function* () {
-        return yield (0, query_1.query)('useQuery.fetch', store, cache, actions, queryKey, cacheKey, params);
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }), [store, queryKey, cacheKey]);
+    const fetch = (0, react_1.useCallback)((options) => __awaiter(void 0, void 0, void 0, function* () {
+        return yield (0, query_1.query)('useQuery.fetch', store, cache, actions, queryKey, 
+        // @ts-expect-error fix later
+        options ? getCacheKey(options.params) : cacheKey, options ? options.params : params);
+    }), 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [store, queryKey, cacheKey]);
     const queryState = (_c = (0, react_redux_1.useSelector)((state) => {
         const queryState = cacheStateSelector(state).queries[queryKey][cacheKey];
         return queryState; // TODO proper type

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Powerful data fetching and caching library that supports normalization, built on top of redux",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",