@zenstackhq/tanstack-query 2.21.0 → 3.0.0-beta.17

package/runtime-v5/react.d.ts

@@ -1,474 +0,0 @@
-import * as _tanstack_react_query_v5 from '@tanstack/react-query';
-import { UseQueryOptions, UseSuspenseQueryOptions, UseInfiniteQueryOptions, InfiniteData, UseSuspenseInfiniteQueryOptions, UseMutationOptions } from '@tanstack/react-query';
-import * as react from 'react';
-import { ModelMeta } from '@zenstackhq/runtime/cross';
-import { A as APIContext, F as FetchFn, a as ExtraQueryOptions, E as ExtraMutationOptions } from './common-CXlL7vTW.js';
-
-/**
- * Context for configuring react hooks.
- */
-declare const RequestHandlerContext: react.Context<APIContext>;
-/**
- * Hooks context.
- */
-declare function getHooksContext(): {
-    fetch?: FetchFn;
-    logging?: boolean;
-    endpoint: string;
-};
-/**
- * Context provider.
- */
-declare const Provider: react.Provider<APIContext>;
-/**
- * Creates a react-query query.
- *
- * @param model The name of the model under query.
- * @param url The request URL.
- * @param args The request args object, URL-encoded and appended as "?q=" parameter
- * @param options The react-query options object
- * @param fetch The fetch function to use for sending the HTTP request
- * @returns useQuery hook
- */
-declare function useModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: unknown, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions, fetch?: FetchFn): {
-    data: TData;
-    error: TError;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    status: "error";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: TData;
-    error: null;
-    isError: false;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: true;
-    status: "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: TError;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: true;
-    isRefetchError: false;
-    isSuccess: false;
-    status: "error";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: null;
-    isError: false;
-    isPending: true;
-    isLoading: true;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: false;
-    status: "pending";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: null;
-    isError: false;
-    isPending: true;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: false;
-    status: "pending";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isLoading: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-};
-/**
- * Creates a react-query suspense query.
- *
- * @param model The name of the model under query.
- * @param url The request URL.
- * @param args The request args object, URL-encoded and appended as "?q=" parameter
- * @param options The react-query options object
- * @param fetch The fetch function to use for sending the HTTP request
- * @returns useSuspenseQuery hook
- */
-declare function useSuspenseModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args?: unknown, options?: Omit<UseSuspenseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'> & ExtraQueryOptions, fetch?: FetchFn): {
-    data: TData;
-    error: TError | null;
-    isError: boolean;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: boolean;
-    isSuccess: boolean;
-    status: "error" | "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<TData, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-};
-/**
- * Creates a react-query infinite query.
- *
- * @param model The name of the model under query.
- * @param url The request URL.
- * @param args The initial request args object, URL-encoded and appended as "?q=" parameter
- * @param options The react-query infinite query options object
- * @param fetch The fetch function to use for sending the HTTP request
- * @returns useInfiniteQuery hook
- */
-declare function useInfiniteModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args: unknown, options: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>, fetch?: FetchFn): {
-    data: InfiniteData<TData, unknown>;
-    error: TError;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    status: "error";
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchNextPageError: boolean;
-    isFetchingNextPage: boolean;
-    isFetchPreviousPageError: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: InfiniteData<TData, unknown>;
-    error: null;
-    isError: false;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    isSuccess: true;
-    status: "success";
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: TError;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: true;
-    isRefetchError: false;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    isSuccess: false;
-    status: "error";
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: null;
-    isError: false;
-    isPending: true;
-    isLoading: true;
-    isLoadingError: false;
-    isRefetchError: false;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    isSuccess: false;
-    status: "pending";
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: null;
-    isError: false;
-    isPending: true;
-    isLoadingError: false;
-    isRefetchError: false;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    isSuccess: false;
-    status: "pending";
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isLoading: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isPlaceholderData: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-};
-/**
- * Creates a react-query infinite suspense query.
- *
- * @param model The name of the model under query.
- * @param url The request URL.
- * @param args The initial request args object, URL-encoded and appended as "?q=" parameter
- * @param options The react-query infinite query options object
- * @param fetch The fetch function to use for sending the HTTP request
- * @returns useSuspenseInfiniteQuery hook
- */
-declare function useSuspenseInfiniteModelQuery<TQueryFnData, TData, TError>(model: string, url: string, args: unknown, options: Omit<UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>, fetch?: FetchFn): {
-    data: InfiniteData<TData, unknown>;
-    error: TError | null;
-    isError: boolean;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: boolean;
-    isSuccess: boolean;
-    status: "error" | "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: TError | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    refetch: (options?: _tanstack_react_query_v5.RefetchOptions) => Promise<_tanstack_react_query_v5.QueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchStatus: _tanstack_react_query_v5.FetchStatus;
-    fetchNextPage: (options?: _tanstack_react_query_v5.FetchNextPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    fetchPreviousPage: (options?: _tanstack_react_query_v5.FetchPreviousPageOptions) => Promise<_tanstack_react_query_v5.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, TError>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchNextPageError: boolean;
-    isFetchingNextPage: boolean;
-    isFetchPreviousPageError: boolean;
-    isFetchingPreviousPage: boolean;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-};
-/**
- * Creates a react-query mutation
- *
- * @param model The name of the model under mutation.
- * @param method The HTTP method.
- * @param url The request URL.
- * @param modelMeta The model metadata.
- * @param options The react-query options.
- * @param fetch The fetch function to use for sending the HTTP request
- * @param checkReadBack Whether to check for read back errors and return undefined if found.
- */
-declare function useModelMutation<TArgs, TError, R = any, C extends boolean = boolean, Result = C extends true ? R | undefined : R>(model: string, method: 'POST' | 'PUT' | 'DELETE', url: string, modelMeta: ModelMeta, options?: Omit<UseMutationOptions<Result, TError, TArgs>, 'mutationFn'> & ExtraMutationOptions, fetch?: FetchFn, checkReadBack?: C): _tanstack_react_query_v5.UseMutationResult<Result, TError, TArgs, unknown>;
-
-export { Provider, RequestHandlerContext, getHooksContext, useInfiniteModelQuery, useModelMutation, useModelQuery, useSuspenseInfiniteModelQuery, useSuspenseModelQuery };