floppy-disk 2.1.0-beta.2 → 2.1.0

package/README.md

@@ -18,13 +18,13 @@ import {
   useInfiniteQuery,
   useMutation,
 } from '@tanstack/react-query'; // 41 kB (gzipped: 11 kB)
-import { createQuery, createMutation } from 'floppy-disk'; // 8.2 kB (gzipped: 2.8 kB) 🎉
+import { createQuery, createMutation } from 'floppy-disk'; // 8.4 kB (gzipped: 2.8 kB) 🎉
 ```
 
 - Using Zustand & React-Query: https://demo-zustand-react-query.vercel.app/  
   👉 Total: **309.21 kB**
 - Using Floppy Disk: https://demo-floppy-disk.vercel.app/  
-  👉 Total: **270.87 kB** 🎉
+  👉 Total: **271.15 kB** 🎉
 
 ## Key Features
 
@@ -51,7 +51,17 @@ import { createQuery, createMutation } from 'floppy-disk'; // 8.2 kB (gzipped: 2
     - Can be used with literally any asynchronous data fetching client, including GraphQL ✅
 - Create mutation ✅
 
-**View official documentation on [floppy-disk.vercel.app](https://floppy-disk.vercel.app/)**
+<br>
+
+---
+
+<p align="center">
+  View official documentation on <a href="https://floppy-disk.vercel.app/">floppy-disk.vercel.app</a>
+</p>
+
+---
+
+<br>
 
 ## Table of Contents
 

package/esm/preact/create-query.d.ts

@@ -103,7 +103,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isError: false;
     data: TData;
     response: TResponse;
-    responseUpdatedAt: number;
+    responseUpdatedAt: number | null;
 } | {
     status: 'error';
     isLoading: false;
@@ -186,6 +186,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
     setInitialResponse: (options: {
         key?: TKey;
         response: TResponse;
+        skipRevalidation?: boolean;
     }) => void;
     /**
      * Set query state (data, error, etc) to initial state.

package/esm/preact/create-query.js

@@ -166,6 +166,9 @@ export const createQuery = (queryFn, options = {}) => {
             forceFetch();
         };
         const fetchNextPage = () => {
+            if (typeof options.getNextPageParam !== 'function') {
+                return console.warn('fetchNextPage with invalid getNextPageParam option');
+            }
             const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
@@ -271,7 +274,7 @@ export const createQuery = (queryFn, options = {}) => {
             },
         };
     })());
-    useQuery.setInitialResponse = ({ key, response }) => {
+    useQuery.setInitialResponse = ({ key, response, skipRevalidation }) => {
         // eslint-disable-next-line react-hooks/rules-of-hooks
         useState(() => {
             if (response === undefined || useQuery.get(key).data)
@@ -283,7 +286,7 @@ export const createQuery = (queryFn, options = {}) => {
                 isSuccess: true,
                 isError: false,
                 response,
-                responseUpdatedAt: Date.now(),
+                responseUpdatedAt: skipRevalidation ? Date.now() : null,
                 data: select(response, { key: key, data: null }),
                 pageParam: newPageParam,
                 pageParams: [undefined, newPageParam],
@@ -302,17 +305,17 @@ export const createQuery = (queryFn, options = {}) => {
     };
     useQuery.invalidate = () => {
         useQuery.getStores().forEach((store) => {
-            const { set, getSubscribers } = store;
+            const { get, set, getSubscribers } = store;
             set({ responseUpdatedAt: null });
             if (getSubscribers().size > 0)
-                store.get().forceFetch();
+                get().forceFetch();
         });
     };
     useQuery.invalidateSpecificKey = (key) => {
-        const { set, getSubscribers } = useQuery.getStore(key);
+        const { get, set, getSubscribers } = useQuery.getStore(key);
         set({ responseUpdatedAt: null });
         if (getSubscribers().size > 0)
-            useQuery.get(key).forceFetch();
+            get().forceFetch();
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);

package/esm/react/create-query.d.ts

@@ -103,7 +103,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isError: false;
     data: TData;
     response: TResponse;
-    responseUpdatedAt: number;
+    responseUpdatedAt: number | null;
 } | {
     status: 'error';
     isLoading: false;
@@ -186,6 +186,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
     setInitialResponse: (options: {
         key?: TKey;
         response: TResponse;
+        skipRevalidation?: boolean;
     }) => void;
     /**
      * Set query state (data, error, etc) to initial state.

package/esm/react/create-query.js

@@ -166,6 +166,9 @@ export const createQuery = (queryFn, options = {}) => {
             forceFetch();
         };
         const fetchNextPage = () => {
+            if (typeof options.getNextPageParam !== 'function') {
+                return console.warn('fetchNextPage with invalid getNextPageParam option');
+            }
             const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
@@ -271,7 +274,7 @@ export const createQuery = (queryFn, options = {}) => {
             },
         };
     })());
-    useQuery.setInitialResponse = ({ key, response }) => {
+    useQuery.setInitialResponse = ({ key, response, skipRevalidation }) => {
         // eslint-disable-next-line react-hooks/rules-of-hooks
         useState(() => {
             if (response === undefined || useQuery.get(key).data)
@@ -283,7 +286,7 @@ export const createQuery = (queryFn, options = {}) => {
                 isSuccess: true,
                 isError: false,
                 response,
-                responseUpdatedAt: Date.now(),
+                responseUpdatedAt: skipRevalidation ? Date.now() : null,
                 data: select(response, { key: key, data: null }),
                 pageParam: newPageParam,
                 pageParams: [undefined, newPageParam],
@@ -302,17 +305,17 @@ export const createQuery = (queryFn, options = {}) => {
     };
     useQuery.invalidate = () => {
         useQuery.getStores().forEach((store) => {
-            const { set, getSubscribers } = store;
+            const { get, set, getSubscribers } = store;
             set({ responseUpdatedAt: null });
             if (getSubscribers().size > 0)
-                store.get().forceFetch();
+                get().forceFetch();
         });
     };
     useQuery.invalidateSpecificKey = (key) => {
-        const { set, getSubscribers } = useQuery.getStore(key);
+        const { get, set, getSubscribers } = useQuery.getStore(key);
         set({ responseUpdatedAt: null });
         if (getSubscribers().size > 0)
-            useQuery.get(key).forceFetch();
+            get().forceFetch();
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);

package/lib/preact/create-query.d.ts

@@ -103,7 +103,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isError: false;
     data: TData;
     response: TResponse;
-    responseUpdatedAt: number;
+    responseUpdatedAt: number | null;
 } | {
     status: 'error';
     isLoading: false;
@@ -186,6 +186,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
     setInitialResponse: (options: {
         key?: TKey;
         response: TResponse;
+        skipRevalidation?: boolean;
     }) => void;
     /**
      * Set query state (data, error, etc) to initial state.

package/lib/preact/create-query.js

@@ -169,6 +169,9 @@ const createQuery = (queryFn, options = {}) => {
             forceFetch();
         };
         const fetchNextPage = () => {
+            if (typeof options.getNextPageParam !== 'function') {
+                return console.warn('fetchNextPage with invalid getNextPageParam option');
+            }
             const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
@@ -274,7 +277,7 @@ const createQuery = (queryFn, options = {}) => {
             },
         };
     })());
-    useQuery.setInitialResponse = ({ key, response }) => {
+    useQuery.setInitialResponse = ({ key, response, skipRevalidation }) => {
         // eslint-disable-next-line react-hooks/rules-of-hooks
         (0, hooks_1.useState)(() => {
             if (response === undefined || useQuery.get(key).data)
@@ -286,7 +289,7 @@ const createQuery = (queryFn, options = {}) => {
                 isSuccess: true,
                 isError: false,
                 response,
-                responseUpdatedAt: Date.now(),
+                responseUpdatedAt: skipRevalidation ? Date.now() : null,
                 data: select(response, { key: key, data: null }),
                 pageParam: newPageParam,
                 pageParams: [undefined, newPageParam],
@@ -305,17 +308,17 @@ const createQuery = (queryFn, options = {}) => {
     };
     useQuery.invalidate = () => {
         useQuery.getStores().forEach((store) => {
-            const { set, getSubscribers } = store;
+            const { get, set, getSubscribers } = store;
             set({ responseUpdatedAt: null });
             if (getSubscribers().size > 0)
-                store.get().forceFetch();
+                get().forceFetch();
         });
     };
     useQuery.invalidateSpecificKey = (key) => {
-        const { set, getSubscribers } = useQuery.getStore(key);
+        const { get, set, getSubscribers } = useQuery.getStore(key);
         set({ responseUpdatedAt: null });
         if (getSubscribers().size > 0)
-            useQuery.get(key).forceFetch();
+            get().forceFetch();
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);

package/lib/react/create-query.d.ts

@@ -103,7 +103,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isError: false;
     data: TData;
     response: TResponse;
-    responseUpdatedAt: number;
+    responseUpdatedAt: number | null;
 } | {
     status: 'error';
     isLoading: false;
@@ -186,6 +186,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
     setInitialResponse: (options: {
         key?: TKey;
         response: TResponse;
+        skipRevalidation?: boolean;
     }) => void;
     /**
      * Set query state (data, error, etc) to initial state.

package/lib/react/create-query.js

@@ -169,6 +169,9 @@ const createQuery = (queryFn, options = {}) => {
             forceFetch();
         };
         const fetchNextPage = () => {
+            if (typeof options.getNextPageParam !== 'function') {
+                return console.warn('fetchNextPage with invalid getNextPageParam option');
+            }
             const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
@@ -274,7 +277,7 @@ const createQuery = (queryFn, options = {}) => {
             },
         };
     })());
-    useQuery.setInitialResponse = ({ key, response }) => {
+    useQuery.setInitialResponse = ({ key, response, skipRevalidation }) => {
         // eslint-disable-next-line react-hooks/rules-of-hooks
         (0, react_1.useState)(() => {
             if (response === undefined || useQuery.get(key).data)
@@ -286,7 +289,7 @@ const createQuery = (queryFn, options = {}) => {
                 isSuccess: true,
                 isError: false,
                 response,
-                responseUpdatedAt: Date.now(),
+                responseUpdatedAt: skipRevalidation ? Date.now() : null,
                 data: select(response, { key: key, data: null }),
                 pageParam: newPageParam,
                 pageParams: [undefined, newPageParam],
@@ -305,17 +308,17 @@ const createQuery = (queryFn, options = {}) => {
     };
     useQuery.invalidate = () => {
         useQuery.getStores().forEach((store) => {
-            const { set, getSubscribers } = store;
+            const { get, set, getSubscribers } = store;
             set({ responseUpdatedAt: null });
             if (getSubscribers().size > 0)
-                store.get().forceFetch();
+                get().forceFetch();
         });
     };
     useQuery.invalidateSpecificKey = (key) => {
-        const { set, getSubscribers } = useQuery.getStore(key);
+        const { get, set, getSubscribers } = useQuery.getStore(key);
         set({ responseUpdatedAt: null });
         if (getSubscribers().size > 0)
-            useQuery.get(key).forceFetch();
+            get().forceFetch();
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.1.0-beta.2",
+  "version": "2.1.0",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",