floppy-disk 2.4.0 → 2.5.0-beta.1

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

@@ -26,8 +26,10 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * If the data is empty, it will just fetch the first page.
      *
      * You can ignore this if your query is not paginated.
+     *
+     * @returns Promise that will always get resolved.
      */
-    fetchNextPage: () => void;
+    fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError>>;
     /**
      * Set query state (data, error, etc) to initial state.
      */

package/esm/preact/create-query.js

@@ -87,7 +87,7 @@ export const createQuery = (queryFn, options = {}) => {
                     .then((response) => {
                     if (preventReplaceResponse.get(keyHash)) {
                         set({ isWaiting: false });
-                        return;
+                        return resolve(get());
                     }
                     responseAllPages.push(response);
                     const newPageParam = getNextPageParam(response, responseAllPages.length);
@@ -184,18 +184,27 @@ export const createQuery = (queryFn, options = {}) => {
                 return;
             forceFetch();
         };
-        const fetchNextPage = () => {
+        const fetchNextPage = () => new Promise((resolve) => {
+            const state = get();
             if (typeof options.getNextPageParam !== 'function') {
-                return console.warn('fetchNextPage with invalid getNextPageParam option');
+                console.warn('fetchNextPage with invalid getNextPageParam option');
+                return resolve(state);
             }
-            const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
-                return forceFetch();
+                return resolve(forceFetch());
             if (isWaitingNextPage || !hasNextPage)
-                return;
+                return resolve(state);
+            let shouldcancel = false;
+            const cancel = () => {
+                shouldcancel = true;
+            };
+            onBeforeFetch(cancel, state);
+            if (shouldcancel)
+                return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
+            const stateBeforeCallQuery = get();
             queryFn(key, { ...state, pageParam })
                 .then((response) => {
                 const newPageParam = getNextPageParam(response, pageParams.length);
@@ -208,6 +217,8 @@ export const createQuery = (queryFn, options = {}) => {
                     pageParams: pageParams.concat(newPageParam),
                     hasNextPage: hasValue(newPageParam),
                 });
+                onSuccess(response, stateBeforeCallQuery);
+                resolve(get());
             })
                 .catch((error) => {
                 const prevState = get();
@@ -225,8 +236,13 @@ export const createQuery = (queryFn, options = {}) => {
                         fetchNextPage();
                     }, delay));
                 }
+                onError(error, stateBeforeCallQuery);
+                resolve(get());
+            })
+                .finally(() => {
+                onSettled(stateBeforeCallQuery);
             });
-        };
+        });
         return {
             ...INITIAL_QUERY_STATE,
             key,

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

@@ -25,8 +25,10 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * If the data is empty, it will just fetch the first page.
      *
      * You can ignore this if your query is not paginated.
+     *
+     * @returns Promise that will always get resolved.
      */
-    fetchNextPage: () => void;
+    fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError>>;
     /**
      * Set query state (data, error, etc) to initial state.
      */

package/esm/react/create-query.js

@@ -86,7 +86,7 @@ export const createQuery = (queryFn, options = {}) => {
                     .then((response) => {
                     if (preventReplaceResponse.get(keyHash)) {
                         set({ isWaiting: false });
-                        return;
+                        return resolve(get());
                     }
                     responseAllPages.push(response);
                     const newPageParam = getNextPageParam(response, responseAllPages.length);
@@ -183,18 +183,27 @@ export const createQuery = (queryFn, options = {}) => {
                 return;
             forceFetch();
         };
-        const fetchNextPage = () => {
+        const fetchNextPage = () => new Promise((resolve) => {
+            const state = get();
             if (typeof options.getNextPageParam !== 'function') {
-                return console.warn('fetchNextPage with invalid getNextPageParam option');
+                console.warn('fetchNextPage with invalid getNextPageParam option');
+                return resolve(state);
             }
-            const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
-                return forceFetch();
+                return resolve(forceFetch());
             if (isWaitingNextPage || !hasNextPage)
-                return;
+                return resolve(state);
+            let shouldcancel = false;
+            const cancel = () => {
+                shouldcancel = true;
+            };
+            onBeforeFetch(cancel, state);
+            if (shouldcancel)
+                return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
+            const stateBeforeCallQuery = get();
             queryFn(key, { ...state, pageParam })
                 .then((response) => {
                 const newPageParam = getNextPageParam(response, pageParams.length);
@@ -207,6 +216,8 @@ export const createQuery = (queryFn, options = {}) => {
                     pageParams: pageParams.concat(newPageParam),
                     hasNextPage: hasValue(newPageParam),
                 });
+                onSuccess(response, stateBeforeCallQuery);
+                resolve(get());
             })
                 .catch((error) => {
                 const prevState = get();
@@ -224,8 +235,13 @@ export const createQuery = (queryFn, options = {}) => {
                         fetchNextPage();
                     }, delay));
                 }
+                onError(error, stateBeforeCallQuery);
+                resolve(get());
+            })
+                .finally(() => {
+                onSettled(stateBeforeCallQuery);
             });
-        };
+        });
         return {
             ...INITIAL_QUERY_STATE,
             key,

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

@@ -26,8 +26,10 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * If the data is empty, it will just fetch the first page.
      *
      * You can ignore this if your query is not paginated.
+     *
+     * @returns Promise that will always get resolved.
      */
-    fetchNextPage: () => void;
+    fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError>>;
     /**
      * Set query state (data, error, etc) to initial state.
      */

package/lib/preact/create-query.js

@@ -90,7 +90,7 @@ const createQuery = (queryFn, options = {}) => {
                     .then((response) => {
                     if (preventReplaceResponse.get(keyHash)) {
                         set({ isWaiting: false });
-                        return;
+                        return resolve(get());
                     }
                     responseAllPages.push(response);
                     const newPageParam = getNextPageParam(response, responseAllPages.length);
@@ -187,18 +187,27 @@ const createQuery = (queryFn, options = {}) => {
                 return;
             forceFetch();
         };
-        const fetchNextPage = () => {
+        const fetchNextPage = () => new Promise((resolve) => {
+            const state = get();
             if (typeof options.getNextPageParam !== 'function') {
-                return console.warn('fetchNextPage with invalid getNextPageParam option');
+                console.warn('fetchNextPage with invalid getNextPageParam option');
+                return resolve(state);
             }
-            const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
-                return forceFetch();
+                return resolve(forceFetch());
             if (isWaitingNextPage || !hasNextPage)
-                return;
+                return resolve(state);
+            let shouldcancel = false;
+            const cancel = () => {
+                shouldcancel = true;
+            };
+            onBeforeFetch(cancel, state);
+            if (shouldcancel)
+                return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
+            const stateBeforeCallQuery = get();
             queryFn(key, { ...state, pageParam })
                 .then((response) => {
                 const newPageParam = getNextPageParam(response, pageParams.length);
@@ -211,6 +220,8 @@ const createQuery = (queryFn, options = {}) => {
                     pageParams: pageParams.concat(newPageParam),
                     hasNextPage: (0, utils_1.hasValue)(newPageParam),
                 });
+                onSuccess(response, stateBeforeCallQuery);
+                resolve(get());
             })
                 .catch((error) => {
                 const prevState = get();
@@ -228,8 +239,13 @@ const createQuery = (queryFn, options = {}) => {
                         fetchNextPage();
                     }, delay));
                 }
+                onError(error, stateBeforeCallQuery);
+                resolve(get());
+            })
+                .finally(() => {
+                onSettled(stateBeforeCallQuery);
             });
-        };
+        });
         return {
             ...INITIAL_QUERY_STATE,
             key,

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

@@ -25,8 +25,10 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * If the data is empty, it will just fetch the first page.
      *
      * You can ignore this if your query is not paginated.
+     *
+     * @returns Promise that will always get resolved.
      */
-    fetchNextPage: () => void;
+    fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError>>;
     /**
      * Set query state (data, error, etc) to initial state.
      */

package/lib/react/create-query.js

@@ -89,7 +89,7 @@ const createQuery = (queryFn, options = {}) => {
                     .then((response) => {
                     if (preventReplaceResponse.get(keyHash)) {
                         set({ isWaiting: false });
-                        return;
+                        return resolve(get());
                     }
                     responseAllPages.push(response);
                     const newPageParam = getNextPageParam(response, responseAllPages.length);
@@ -186,18 +186,27 @@ const createQuery = (queryFn, options = {}) => {
                 return;
             forceFetch();
         };
-        const fetchNextPage = () => {
+        const fetchNextPage = () => new Promise((resolve) => {
+            const state = get();
             if (typeof options.getNextPageParam !== 'function') {
-                return console.warn('fetchNextPage with invalid getNextPageParam option');
+                console.warn('fetchNextPage with invalid getNextPageParam option');
+                return resolve(state);
             }
-            const state = get();
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
-                return forceFetch();
+                return resolve(forceFetch());
             if (isWaitingNextPage || !hasNextPage)
-                return;
+                return resolve(state);
+            let shouldcancel = false;
+            const cancel = () => {
+                shouldcancel = true;
+            };
+            onBeforeFetch(cancel, state);
+            if (shouldcancel)
+                return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
+            const stateBeforeCallQuery = get();
             queryFn(key, { ...state, pageParam })
                 .then((response) => {
                 const newPageParam = getNextPageParam(response, pageParams.length);
@@ -210,6 +219,8 @@ const createQuery = (queryFn, options = {}) => {
                     pageParams: pageParams.concat(newPageParam),
                     hasNextPage: (0, utils_1.hasValue)(newPageParam),
                 });
+                onSuccess(response, stateBeforeCallQuery);
+                resolve(get());
             })
                 .catch((error) => {
                 const prevState = get();
@@ -227,8 +238,13 @@ const createQuery = (queryFn, options = {}) => {
                         fetchNextPage();
                     }, delay));
                 }
+                onError(error, stateBeforeCallQuery);
+                resolve(get());
+            })
+                .finally(() => {
+                onSettled(stateBeforeCallQuery);
             });
-        };
+        });
         return {
             ...INITIAL_QUERY_STATE,
             key,

package/package.json

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