floppy-disk 2.11.1-experimental.2 → 2.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.11.1-experimental.2",
+  "version": "2.11.1",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",
@@ -41,15 +41,6 @@
       },
       "module": "./esm/index.js",
       "default": "./lib/index.js"
-    },
-    "./preact": {
-      "types": "./lib/preact/index.d.ts",
-      "import": {
-        "types": "./esm/preact/index.d.ts",
-        "default": "./esm/preact/index.js"
-      },
-      "module": "./esm/preact/index.js",
-      "default": "./lib/preact/index.js"
     }
   },
   "scripts": {

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

@@ -1,167 +0,0 @@
-import { Maybe } from '../utils';
-import { SelectDeps } from '../vanilla';
-import { CreateQueryOptions, QueryState } from './create-query';
-import { StoreKey } from './create-stores';
-export declare const createBiDirectionQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData extends any[] = any[], TError = unknown, TPageParam = any>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError, TPageParam>, direction: 'prev' | 'next') => Promise<TResponse>, options: Omit<CreateQueryOptions<TKey, TResponse, TData, TError, TPageParam>, "select" | "getNextPageParam"> & {
-    getPrevPageParam: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    getNextPageParam: (lastPage: TResponse, index: number, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Maybe<TPageParam>;
-    select: (response: TResponse, state: Pick<QueryState<TKey, TResponse, TData, TError, TPageParam>, "data" | "key">, direction: 'prev' | 'next') => TData;
-}) => {
-    (...args: [Maybe<TKey>, SelectDeps<QueryState<TKey, TResponse, TData, TError, TPageParam>>?] | [SelectDeps<QueryState<TKey, TResponse, TData, TError, TPageParam>>?]): {
-        data: (never[] | TData)[number][];
-        fetchPrevPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        hasPrevPage: boolean;
-        isWaitingPrevPage: boolean;
-        key: TKey;
-        keyHash: string;
-        fetch: () => void;
-        forceFetch: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        reset: () => void;
-        optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
-            revert: () => void;
-            invalidate: () => void;
-        };
-        isWaiting: boolean;
-        isWaitingNextPage: boolean;
-        isRefetching: boolean;
-        isRefetchError: boolean;
-        isPreviousData: boolean;
-        isOptimisticData: boolean;
-        error: TError | undefined;
-        errorUpdatedAt: number | undefined;
-        retryCount: number;
-        isGoingToRetry: boolean;
-        pageParam: Maybe<TPageParam>;
-        pageParams: Maybe<TPageParam>[];
-        hasNextPage: boolean;
-        retryNextPageCount: number;
-        isGoingToRetryNextPage: boolean;
-        status: "loading";
-        isLoading: true;
-        isSuccess: false;
-        isError: false;
-        response: undefined;
-        responseUpdatedAt: undefined;
-    } | {
-        data: (never[] | TData)[number][];
-        fetchPrevPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        hasPrevPage: boolean;
-        isWaitingPrevPage: boolean;
-        key: TKey;
-        keyHash: string;
-        fetch: () => void;
-        forceFetch: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        reset: () => void;
-        optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
-            revert: () => void;
-            invalidate: () => void;
-        };
-        isWaiting: boolean;
-        isWaitingNextPage: boolean;
-        isRefetching: boolean;
-        isRefetchError: boolean;
-        isPreviousData: boolean;
-        isOptimisticData: boolean;
-        error: TError | undefined;
-        errorUpdatedAt: number | undefined;
-        retryCount: number;
-        isGoingToRetry: boolean;
-        pageParam: Maybe<TPageParam>;
-        pageParams: Maybe<TPageParam>[];
-        hasNextPage: boolean;
-        retryNextPageCount: number;
-        isGoingToRetryNextPage: boolean;
-        status: "error";
-        isLoading: false;
-        isSuccess: false;
-        isError: true;
-        response: undefined;
-        responseUpdatedAt: undefined;
-    } | {
-        data: (never[] | TData)[number][];
-        fetchPrevPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        hasPrevPage: boolean;
-        isWaitingPrevPage: boolean;
-        key: TKey;
-        keyHash: string;
-        fetch: () => void;
-        forceFetch: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        reset: () => void;
-        optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
-            revert: () => void;
-            invalidate: () => void;
-        };
-        isWaiting: boolean;
-        isWaitingNextPage: boolean;
-        isRefetching: boolean;
-        isRefetchError: boolean;
-        isPreviousData: boolean;
-        isOptimisticData: boolean;
-        error: TError | undefined;
-        errorUpdatedAt: number | undefined;
-        retryCount: number;
-        isGoingToRetry: boolean;
-        pageParam: Maybe<TPageParam>;
-        pageParams: Maybe<TPageParam>[];
-        hasNextPage: boolean;
-        retryNextPageCount: number;
-        isGoingToRetryNextPage: boolean;
-        status: "success";
-        isLoading: false;
-        isSuccess: true;
-        isError: false;
-        response: TResponse;
-        responseUpdatedAt: number | undefined;
-    };
-    get(): {
-        prev: QueryState<TKey, TResponse, TData, TError, TPageParam>;
-        next: QueryState<TKey, TResponse, TData, TError, TPageParam>;
-    };
-    setInitialResponse: (options: {
-        key?: Maybe<TKey>;
-        response: TResponse;
-        skipRevalidation?: boolean | undefined;
-    }) => void;
-    reset(): void;
-    resetSpecificKey(key: Maybe<TKey>): void;
-    invalidate: () => void;
-    invalidateSpecificKey: (key?: Maybe<TKey>) => void;
-    suspend: (key?: Maybe<TKey>) => {
-        key: TKey;
-        keyHash: string;
-        fetch: () => void;
-        forceFetch: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-        reset: () => void;
-        optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
-            revert: () => void;
-            invalidate: () => void;
-        };
-        isWaiting: boolean;
-        isWaitingNextPage: boolean;
-        isRefetching: boolean;
-        isRefetchError: boolean;
-        isPreviousData: boolean;
-        isOptimisticData: boolean;
-        error: TError | undefined;
-        errorUpdatedAt: number | undefined;
-        retryCount: number;
-        isGoingToRetry: boolean;
-        pageParam: Maybe<TPageParam>;
-        pageParams: Maybe<TPageParam>[];
-        hasNextPage: boolean;
-        retryNextPageCount: number;
-        isGoingToRetryNextPage: boolean;
-    } & {
-        status: "success";
-        isLoading: false;
-        isSuccess: true;
-        isError: false;
-        data: TData;
-        response: TResponse;
-        responseUpdatedAt: number | undefined;
-    };
-};

package/esm/preact/create-bi-direction-query.js

@@ -1,74 +0,0 @@
-import { hasValue } from '../utils';
-import { createQuery } from './create-query';
-export const createBiDirectionQuery = (queryFn, options) => {
-    const { getPrevPageParam, getNextPageParam, select, ...restOptions } = options;
-    const usePrevPagesQuery = createQuery((key, state) => queryFn(key, state, 'prev'), {
-        defaultDeps: (state) => [
-            state.isWaiting,
-            state.data,
-            state.error,
-            state.isWaitingNextPage,
-            state.hasNextPage,
-        ],
-        fetchOnMount: false,
-        getNextPageParam: getPrevPageParam,
-        select: (response, state) => select(response, state, 'prev'),
-        ...restOptions,
-    });
-    const useNextPagesQuery = createQuery(async (key, state) => {
-        const isInitialPage = state.pageParam === undefined;
-        const pQuery = usePrevPagesQuery.get(key);
-        try {
-            const response = await queryFn(key, state, 'next');
-            if (isInitialPage) {
-                const prevPageParam = getPrevPageParam(response, 1, pQuery);
-                usePrevPagesQuery.set(key, (prev) => ({
-                    pageParams: [prevPageParam, ...prev.pageParams.slice(1)],
-                    hasNextPage: prev.isLoading ? hasValue(prevPageParam) : prev.hasNextPage,
-                }));
-                if (!pQuery.isLoading)
-                    pQuery.forceFetch();
-            }
-            return response;
-        }
-        catch (error) {
-            if (isInitialPage && !pQuery.isLoading)
-                pQuery.reset();
-            throw error;
-        }
-    }, {
-        getNextPageParam: getNextPageParam,
-        select: (response, state) => select(response, state, 'next'),
-        ...restOptions,
-    });
-    const useBiDirectionQuery = (...args) => {
-        const pQuery = usePrevPagesQuery(...args);
-        const nQuery = useNextPagesQuery(...args);
-        return {
-            ...nQuery,
-            data: [...(pQuery.data || []), ...(nQuery.data || [])],
-            fetchPrevPage: pQuery.fetchNextPage,
-            hasPrevPage: pQuery.hasNextPage,
-            isWaitingPrevPage: pQuery.isWaitingNextPage || (pQuery.isLoading && pQuery.isWaiting),
-        };
-    };
-    useBiDirectionQuery.get = () => {
-        return {
-            prev: usePrevPagesQuery.get(),
-            next: useNextPagesQuery.get(),
-        };
-    };
-    useBiDirectionQuery.setInitialResponse = useNextPagesQuery.setInitialResponse;
-    useBiDirectionQuery.reset = () => {
-        usePrevPagesQuery.reset();
-        useNextPagesQuery.reset();
-    };
-    useBiDirectionQuery.resetSpecificKey = (key) => {
-        usePrevPagesQuery.resetSpecificKey(key);
-        useNextPagesQuery.resetSpecificKey(key);
-    };
-    useBiDirectionQuery.invalidate = useNextPagesQuery.invalidate;
-    useBiDirectionQuery.invalidateSpecificKey = useNextPagesQuery.invalidateSpecificKey;
-    useBiDirectionQuery.suspend = useNextPagesQuery.suspend;
-    return useBiDirectionQuery;
-};

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

@@ -1,39 +0,0 @@
-import { InitStoreOptions } from '../vanilla';
-import { UseStore } from './create-store';
-export type MutationState<TVar, TResponse = any, TError = unknown> = {
-    /**
-     * Network fetching status.
-     */
-    isWaiting: boolean;
-    isSuccess: boolean;
-    isError: boolean;
-    response: TResponse | undefined;
-    responseUpdatedAt: number | undefined;
-    error: TError | undefined;
-    errorUpdatedAt: number | undefined;
-    /**
-     * Mutate function.
-     *
-     * @returns Promise that will always get resolved.
-     */
-    mutate: TVar extends undefined ? () => Promise<{
-        response?: TResponse;
-        error?: TError;
-        variables?: TVar;
-    }> : (variables: TVar) => Promise<{
-        response?: TResponse;
-        error?: TError;
-        variables?: TVar;
-    }>;
-};
-export type UseMutation<TVar, TResponse = any, TError = unknown> = UseStore<MutationState<TVar, TResponse, TError>>;
-export type CreateMutationOptions<TVar, TResponse = any, TError = unknown> = InitStoreOptions<MutationState<TVar, TResponse, TError>> & {
-    onMutate?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
-    onSuccess?: (response: TResponse, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
-    onError?: (error: TError, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
-    onSettled?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
-};
-/**
- * @see https://floppy-disk.vercel.app/docs/api#createmutation
- */
-export declare const createMutation: <TVar, TResponse = any, TError = unknown>(mutationFn: (variables: TVar, state: MutationState<TVar, TResponse, TError>) => Promise<TResponse>, options?: CreateMutationOptions<TVar, TResponse, TError>) => UseMutation<TVar, TResponse, TError>;

package/esm/preact/create-mutation.js

@@ -1,53 +0,0 @@
-import { noop } from '../utils';
-import { createStore } from './create-store';
-/**
- * @see https://floppy-disk.vercel.app/docs/api#createmutation
- */
-export const createMutation = (mutationFn, options = {}) => {
-    const { onMutate = noop, onSuccess = noop, onError = noop, onSettled = noop, ...createStoreOptions } = options;
-    const useMutation = createStore(({ set, get }) => ({
-        isWaiting: false,
-        isSuccess: false,
-        isError: false,
-        response: undefined,
-        responseUpdatedAt: undefined,
-        error: undefined,
-        errorUpdatedAt: undefined,
-        mutate: ((variables) => {
-            set({ isWaiting: true });
-            const stateBeforeMutate = get();
-            onMutate(variables, stateBeforeMutate);
-            return new Promise((resolve) => {
-                mutationFn(variables, stateBeforeMutate)
-                    .then((response) => {
-                    set({
-                        isWaiting: false,
-                        isSuccess: true,
-                        isError: false,
-                        response,
-                        responseUpdatedAt: Date.now(),
-                        error: undefined,
-                        errorUpdatedAt: undefined,
-                    });
-                    onSuccess(response, variables, stateBeforeMutate);
-                    resolve({ response, variables });
-                })
-                    .catch((error) => {
-                    set({
-                        isWaiting: false,
-                        isSuccess: false,
-                        isError: true,
-                        error,
-                        errorUpdatedAt: Date.now(),
-                    });
-                    onError(error, variables, stateBeforeMutate);
-                    resolve({ error, variables });
-                })
-                    .finally(() => {
-                    onSettled(variables, stateBeforeMutate);
-                });
-            });
-        }),
-    }), createStoreOptions);
-    return useMutation;
-};

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

@@ -1,300 +0,0 @@
-/// <reference types="react" />
-import { FunctionComponent } from 'preact';
-import { Maybe } from '../utils';
-import { CreateStoresOptions, StoreKey, UseStores } from './create-stores';
-export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any> = {
-    /**
-     * Query store key, an object that will be hashed into a string as a query store identifier.
-     */
-    key: TKey;
-    /**
-     * Query store key hash, a string used as a query store identifier.
-     */
-    keyHash: string;
-    /**
-     * Will only be called if the data is stale or empty.
-     */
-    fetch: () => void;
-    /**
-     * Will be called even if the data is still fresh (not stale).
-     *
-     * @returns Promise that will always get resolved.
-     */
-    forceFetch: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-    /**
-     * Fetch next page if has next page.
-     *
-     * If the data is empty, it will just fetch the first page.
-     *
-     * You can ignore this if your query is not an infinite query.
-     *
-     * @returns Promise that will always get resolved.
-     */
-    fetchNextPage: () => Promise<QueryState<TKey, TResponse, TData, TError, TPageParam>>;
-    /**
-     * Set query state (data, error, etc) to initial state.
-     */
-    reset: () => void;
-    /**
-     * Optimistic update.
-     *
-     * @returns function to revert the changes & function to invalidate the query
-     *
-     * IMPORTANT NOTE: This won't work well on infinite query.
-     */
-    optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
-        revert: () => void;
-        invalidate: () => void;
-    };
-    /**
-     * Network fetching status.
-     */
-    isWaiting: boolean;
-    /**
-     * Network fetching status for fetching next page.
-     */
-    isWaitingNextPage: boolean;
-    isRefetching: boolean;
-    isRefetchError: boolean;
-    /**
-     * Will be `true` if the response/data comes from the previous query key.
-     *
-     * @see `keepPreviousData` option
-     */
-    isPreviousData: boolean;
-    isOptimisticData: boolean;
-    error: TError | undefined;
-    errorUpdatedAt: number | undefined;
-    retryCount: number;
-    isGoingToRetry: boolean;
-    pageParam: Maybe<TPageParam>;
-    pageParams: Maybe<TPageParam>[];
-    hasNextPage: boolean;
-    retryNextPageCount: number;
-    isGoingToRetryNextPage: boolean;
-} & ({
-    /**
-     * Status of the data.
-     *
-     * `"loading"` = no data.
-     *
-     * `"success"` = has data.
-     *
-     * `"error"` = has error and no data.
-     *
-     * It has no relation with network fetching state.
-     * If you're looking for network fetching state, use `isWaiting` instead.
-     *
-     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
-     */
-    status: 'loading';
-    /**
-     * Data state, will be `true` if the query has no data.
-     *
-     * It has no relation with network fetching state.
-     * If you're looking for network fetching state, use `isWaiting` instead.
-     *
-     * @see https://floppy-disk.vercel.app/docs/query/introduction#query-state--network-fetching-state
-     */
-    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;
-    /**
-     * Error state, will be `true` if the query has no data but has an error.
-     *
-     * 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;
-    response: undefined;
-    responseUpdatedAt: undefined;
-} | {
-    status: 'success';
-    isLoading: false;
-    isSuccess: true;
-    isError: false;
-    data: TData;
-    response: TResponse;
-    responseUpdatedAt: number | undefined;
-} | {
-    status: 'error';
-    isLoading: false;
-    isSuccess: false;
-    isError: true;
-    data: undefined;
-    response: undefined;
-    responseUpdatedAt: undefined;
-});
-export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any> = CreateStoresOptions<TKey, QueryState<TKey, TResponse, TData, TError, TPageParam>> & {
-    select?: (response: TResponse, state: Pick<QueryState<TKey, TResponse, TData, TError, TPageParam>, 'data' | 'key'>) => TData;
-    /**
-     * Stale time in miliseconds.
-     *
-     * Defaults to `3000` (3 seconds).
-     */
-    staleTime?: number;
-    /**
-     * Auto call the query when the component is mounted.
-     *
-     * Defaults to `true`.
-     *
-     * - If set to `true`, the query will be called on mount focus **if the data is stale**.
-     * - If set to `false`, the query won't be called on mount focus.
-     * - If set to `"always"`, the query will be called on mount focus.
-     */
-    fetchOnMount?: boolean | 'always' | ((key: TKey) => boolean | 'always');
-    /**
-     * Defaults to follow the value of `fetchOnMount`.
-     *
-     * `fetchOnMount` and `fetchOnWindowFocus` can be set to different values.
-     * However, if `fetchOnWindowFocus` is not explicitly set, it will mimic the value of `fetchOnMount`.
-     *
-     * - If set to `true`, the query will be called on window focus **if the data is stale**.
-     * - If set to `false`, the query won't be called on window focus.
-     * - If set to `"always"`, the query will be called on window focus.
-     */
-    fetchOnWindowFocus?: boolean | 'always' | ((key: TKey) => boolean | 'always');
-    /**
-     * Defaults to follow the value of `fetchOnMount`.
-     *
-     * `fetchOnMount` and `fetchOnReconnect` can be set to different values.
-     * However, if `fetchOnReconnect` is not explicitly set, it will mimic the value of `fetchOnMount`.
-     *
-     * - If set to `true`, the query will be called on window focus **if the data is stale**.
-     * - If set to `false`, the query won't be called on window focus.
-     * - If set to `"always"`, the query will be called on window focus.
-     */
-    fetchOnReconnect?: boolean | 'always' | ((key: TKey) => boolean | 'always');
-    /**
-     * If set to `false` or return `false`, the query won't be called in any condition.
-     * Auto fetch on mount will be disabled.
-     * Manually trigger `fetch` method (returned from `createQuery`) won't work too.
-     *
-     * Defaults to `true`.
-     */
-    enabled?: boolean | ((key: TKey) => boolean);
-    /**
-     * Number of maximum error retries.
-     *
-     * Defaults to `1`.
-     */
-    retry?: number | ((error: TError, prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => number);
-    /**
-     * Error retry delay in miliseconds.
-     *
-     * Defaults to `2000` (2 seconds).
-     */
-    retryDelay?: number | ((error: TError, prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => number);
-    /**
-     * Used for lagged query.
-     *
-     * If set to `true`, then:
-     * when the query key changed and there is no `data` in the next query key cache,
-     * the previous query key cache `data` will be used while fetching new data.
-     */
-    keepPreviousData?: boolean;
-    /**
-     * Only set this if you have an infinite query.
-     *
-     * 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>;
-    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;
-    /**
-     * Cache time in miliseconds.
-     *
-     * When a query becomes inactive (no longer have subscribers), it will be reset after this duration,
-     * and the cache data will be garbage collected.
-     *
-     * Set it to `Infinity` to disable garbage collection.
-     *
-     * Defaults to `5 * 60 * 1000` (5 minutes).
-     */
-    cacheTime?: number;
-    /**
-     * Polling interval in milliseconds.
-     *
-     * Disabled by default.
-     *
-     * If last data fetching is failed, the polling interval will be disabled, and it will use `retry` mechanism instead.
-     *
-     * @see https://floppy-disk.vercel.app/docs/query/polling
-     */
-    refetchInterval?: number | false | ((state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => number | false);
-};
-export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError, TPageParam>> & {
-    /**
-     * Set query's initial response.
-     *
-     * This is used for server-side rendered page or static page.
-     *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
-     */
-    setInitialResponse: (options: {
-        key?: Maybe<TKey>;
-        response: TResponse;
-        skipRevalidation?: boolean;
-    }) => void;
-    /**
-     * Set query state (data, error, etc) to initial state.
-     */
-    reset: () => void;
-    /**
-     * Set query state (data, error, etc) to initial state.
-     */
-    resetSpecificKey: (key?: Maybe<TKey>) => void;
-    /**
-     * Invalidate query means marking a query as stale, and will refetch only if the query is active (has subscriber)
-     */
-    invalidate: () => void;
-    /**
-     * Invalidate query means marking a query as stale, and will refetch only if the query is active (has subscriber)
-     */
-    invalidateSpecificKey: (key?: Maybe<TKey>) => void;
-    /**
-     * Optimistic update.
-     *
-     * @returns function to revert the changes & function to invalidate the query
-     *
-     * IMPORTANT NOTE: This won't work well on infinite query.
-     */
-    optimisticUpdate: (options: {
-        key?: Maybe<TKey>;
-        response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse);
-    }) => {
-        revert: () => void;
-        invalidate: () => void;
-    };
-    /**
-     * Use query with suspense mode.
-     */
-    suspend: (key?: Maybe<TKey>) => Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
-        status: 'success';
-    }>;
-    Render: (props: {
-        queryKey?: Maybe<TKey>;
-        loading?: FunctionComponent<Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
-            status: 'loading';
-        }>>;
-        success?: FunctionComponent<Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
-            status: 'success';
-        }>>;
-        error?: FunctionComponent<Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
-            status: 'error';
-        }>>;
-    }) => JSX.Element;
-};
-/**
- * @see https://floppy-disk.vercel.app/docs/api#createquery
- */
-export declare const createQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError, TPageParam>) => Promise<TResponse>, options?: CreateQueryOptions<TKey, TResponse, TData, TError, TPageParam>) => UseQuery<TKey, TResponse, TData, TError, TPageParam>;