floppy-disk 2.7.0 → 2.7.1

package/README.md

@@ -9,7 +9,7 @@ Both are awesome state manager. That's why this Floppy Disk library behaves like
 
 ```js
 import { create } from 'zustand'; // 3.3 kB (gzipped: 1.5 kB)
-import { createStore } from 'floppy-disk'; // 1.3 kB (gzipped: 702 B) 🎉
+import { createStore } from 'floppy-disk'; // 1.4 kB (gzipped: 714 B) 🎉
 
 import {
   QueryClient,
@@ -18,13 +18,13 @@ import {
   useInfiniteQuery,
   useMutation,
 } from '@tanstack/react-query'; // 41 kB (gzipped: 11 kB)
-import { createQuery, createMutation } from 'floppy-disk'; // 9.2 kB (gzipped: 3.1 kB) 🎉
+import { createQuery, createMutation } from 'floppy-disk'; // 9.5 kB (gzipped: 3.2 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: **271.15 kB** 🎉
+  👉 Total: **272.63 kB** 🎉
 
 ## Key Features
 
@@ -122,7 +122,7 @@ function Control() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/basic](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/basic)
+> Example: [https://codesandbox.io/.../examples/react/basic](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/basic)
 
 Control the reactivity. The concept is same as useEffect dependency array.
 
@@ -153,7 +153,7 @@ function Cat() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/custom-reactivity](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/custom-reactivity)
+> Example: [https://codesandbox.io/.../examples/react/custom-reactivity](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/custom-reactivity)
 
 Reading/writing state and reacting to changes outside of components.
 
@@ -227,8 +227,8 @@ const useCatStore = createStore(
 ```
 
 > Example:  
-> [https://codesandbox.io/.../examples/react/store-event](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/store-event)  
-> [https://codesandbox.io/.../examples/react/intercept](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/intercept)
+> [https://codesandbox.io/.../examples/react/store-event](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/store-event)  
+> [https://codesandbox.io/.../examples/react/intercept](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/intercept)
 
 Let's go wild using IIFE.
 
@@ -287,7 +287,7 @@ function CatPageOptimized() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/watch-component](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/watch-component)
+> Example: [https://codesandbox.io/.../examples/react/watch-component](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/watch-component)
 
 Want a local state instead of global state?  
 Or, want to set the initial state inside component?
@@ -342,7 +342,7 @@ function CatIsSleeping() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/local-state](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/local-state)
+> Example: [https://codesandbox.io/.../examples/react/local-state](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/local-state)
 
 Set default reactivity.
 
@@ -417,7 +417,7 @@ function Control({ catId }) {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/stores](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/stores)
+> Example: [https://codesandbox.io/.../examples/react/stores](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/stores)
 
 <br><br>
 
@@ -510,7 +510,7 @@ function SingleQuery() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/query](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/query)
+> Example: [https://codesandbox.io/.../examples/react/query](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/query)
 
 Actions:
 
@@ -608,7 +608,7 @@ function PokemonPage() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/query-with-param](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/query-with-param)
+> Example: [https://codesandbox.io/.../examples/react/query-with-param](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/query-with-param)
 
 Get data or do something outside component:
 
@@ -667,7 +667,7 @@ function PokemonListPage() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/infinite-query](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/infinite-query)
+> Example: [https://codesandbox.io/.../examples/react/infinite-query](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/infinite-query)
 
 **Note:**
 
@@ -753,7 +753,7 @@ function SaveProduct() {
 }
 ```
 
-> Example: [https://codesandbox.io/.../examples/react/mutation](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk/tree/main/examples/react/mutation)
+> Example: [https://codesandbox.io/.../examples/react/mutation](https://codesandbox.io/p/sandbox/github/afiiif/floppy-disk-site/tree/main/examples/react/mutation)
 
 <br><br>
 

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

@@ -99,6 +99,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isLoading: true;
     /**
      * Data state, will be `true` if the query has a data.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isSuccess: false;
     /**
@@ -107,6 +109,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * This will only happened if an error occured after first fetch.
      *
      * If data fetched successfully but then an error occured, `isError` will be `false` but `isRefetchError` will be `true`.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isError: false;
     data: undefined;
@@ -203,7 +207,6 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      * This function should return a variable that will be stored as `pageParam` that can be used when fetching next page.
      */
     getNextPageParam?: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    onBeforeFetch?: (cancel: () => void, state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;

package/esm/preact/create-query.js

@@ -40,7 +40,7 @@ export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnReconnect = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, fetchOnReconnect = defaultFetchOnReconnect, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onBeforeFetch = noop, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
     const resetTimeoutId = new Map();
@@ -63,13 +63,6 @@ export const createQuery = (queryFn, options = {}) => {
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
             if (isWaiting || !getValueOrComputedValue(enabled, key))
                 return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
-                return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
             else
@@ -192,14 +185,7 @@ export const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage)
-                return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
+            if (isWaitingNextPage || !hasNextPage || !getValueOrComputedValue(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));

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

@@ -98,6 +98,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isLoading: true;
     /**
      * Data state, will be `true` if the query has a data.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isSuccess: false;
     /**
@@ -106,6 +108,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * This will only happened if an error occured after first fetch.
      *
      * If data fetched successfully but then an error occured, `isError` will be `false` but `isRefetchError` will be `true`.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isError: false;
     data: undefined;
@@ -202,7 +206,6 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      * This function should return a variable that will be stored as `pageParam` that can be used when fetching next page.
      */
     getNextPageParam?: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    onBeforeFetch?: (cancel: () => void, state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;

package/esm/react/create-query.js

@@ -39,7 +39,7 @@ export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnReconnect = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, fetchOnReconnect = defaultFetchOnReconnect, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onBeforeFetch = noop, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
     const resetTimeoutId = new Map();
@@ -62,13 +62,6 @@ export const createQuery = (queryFn, options = {}) => {
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
             if (isWaiting || !getValueOrComputedValue(enabled, key))
                 return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
-                return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
             else
@@ -191,14 +184,7 @@ export const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage)
-                return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
+            if (isWaitingNextPage || !hasNextPage || !getValueOrComputedValue(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));

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

@@ -99,6 +99,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isLoading: true;
     /**
      * Data state, will be `true` if the query has a data.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isSuccess: false;
     /**
@@ -107,6 +109,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * This will only happened if an error occured after first fetch.
      *
      * If data fetched successfully but then an error occured, `isError` will be `false` but `isRefetchError` will be `true`.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isError: false;
     data: undefined;
@@ -203,7 +207,6 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      * This function should return a variable that will be stored as `pageParam` that can be used when fetching next page.
      */
     getNextPageParam?: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    onBeforeFetch?: (cancel: () => void, state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;

package/lib/preact/create-query.js

@@ -43,7 +43,7 @@ const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnReconnect = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, fetchOnReconnect = defaultFetchOnReconnect, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onBeforeFetch = utils_1.noop, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
     const resetTimeoutId = new Map();
@@ -66,13 +66,6 @@ const createQuery = (queryFn, options = {}) => {
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
             if (isWaiting || !(0, utils_1.getValueOrComputedValue)(enabled, key))
                 return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
-                return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
             else
@@ -195,14 +188,7 @@ const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage)
-                return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
+            if (isWaitingNextPage || !hasNextPage || !(0, utils_1.getValueOrComputedValue)(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));

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

@@ -98,6 +98,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
     isLoading: true;
     /**
      * Data state, will be `true` if the query has a data.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isSuccess: false;
     /**
@@ -106,6 +108,8 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      * This will only happened if an error occured after first fetch.
      *
      * If data fetched successfully but then an error occured, `isError` will be `false` but `isRefetchError` will be `true`.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
      */
     isError: false;
     data: undefined;
@@ -202,7 +206,6 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      * This function should return a variable that will be stored as `pageParam` that can be used when fetching next page.
      */
     getNextPageParam?: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    onBeforeFetch?: (cancel: () => void, state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => void;

package/lib/react/create-query.js

@@ -42,7 +42,7 @@ const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnReconnect = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, fetchOnReconnect = defaultFetchOnReconnect, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onBeforeFetch = utils_1.noop, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, refetchInterval = false, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
     const resetTimeoutId = new Map();
@@ -65,13 +65,6 @@ const createQuery = (queryFn, options = {}) => {
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
             if (isWaiting || !(0, utils_1.getValueOrComputedValue)(enabled, key))
                 return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
-                return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
             else
@@ -194,14 +187,7 @@ const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage)
-                return resolve(state);
-            let shouldcancel = false;
-            const cancel = () => {
-                shouldcancel = true;
-            };
-            onBeforeFetch(cancel, state);
-            if (shouldcancel)
+            if (isWaitingNextPage || !hasNextPage || !(0, utils_1.getValueOrComputedValue)(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));

package/package.json

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