@zenstackhq/tanstack-query 3.0.0 → 3.1.0

package/dist/svelte.d.ts

@@ -1,381 +0,0 @@
-import * as _tanstack_svelte_query from '@tanstack/svelte-query';
-import { CreateQueryOptions, DefaultError, CreateQueryResult, QueryKey, CreateInfiniteQueryOptions, InfiniteData, CreateInfiniteQueryResult, CreateMutationOptions, CreateMutationResult, StoreOrVal } from '@tanstack/svelte-query';
-import { QueryOptions, SimplifiedResult, FindUniqueArgs, SelectSubset, SimplifiedPlainResult, FindFirstArgs, FindManyArgs, CreateArgs, CreateManyArgs, BatchResult, CreateManyAndReturnArgs, UpdateArgs, UpdateManyArgs, UpdateManyAndReturnArgs, UpsertArgs, DeleteArgs, DeleteManyArgs, CountArgs, Subset, CountResult, AggregateArgs, AggregateResult, GroupByArgs, GroupByResult } from '@zenstackhq/orm';
-import { SchemaDef, GetModels } from '@zenstackhq/schema';
-import { Readable } from 'svelte/store';
-import { A as APIContext, E as ExtraQueryOptions, W as WithOptimistic, a as ExtraMutationOptions, T as TrimDelegateModelOperations } from './types-C8iIZD-7.js';
-export { F as FetchFn } from './types-C8iIZD-7.js';
-
-/**
- * The default query endpoint.
- */
-declare const DEFAULT_QUERY_ENDPOINT = "/api/model";
-/**
- * Key for setting and getting the global query context.
- */
-declare const SvelteQueryContextKey = "zenstack-svelte-query-context";
-/**
- * Set context for query settings.
- *
- * @deprecated use {@link setQuerySettingsContext} instead.
- */
-declare function setHooksContext(context: APIContext): void;
-/**
- * Set context for query settings.
- */
-declare function setQuerySettingsContext(context: APIContext): void;
-type ModelQueryOptions<T> = Omit<CreateQueryOptions<T, DefaultError>, 'queryKey'> & ExtraQueryOptions;
-type ModelQueryResult<T> = Readable<UnwrapStore<CreateQueryResult<WithOptimistic<T>, DefaultError>> & {
-    queryKey: QueryKey;
-}>;
-type ModelInfiniteQueryOptions<T> = Omit<CreateInfiniteQueryOptions<T, DefaultError, InfiniteData<T>>, 'queryKey' | 'initialPageParam'>;
-type ModelInfiniteQueryResult<T> = Readable<UnwrapStore<CreateInfiniteQueryResult<T, DefaultError>> & {
-    queryKey: QueryKey;
-}>;
-type ModelMutationOptions<T, TArgs> = Omit<CreateMutationOptions<T, DefaultError, TArgs>, 'mutationFn'> & ExtraMutationOptions;
-type ModelMutationResult<T, TArgs> = CreateMutationResult<T, DefaultError, TArgs>;
-type ModelMutationModelResult<Schema extends SchemaDef, Model extends GetModels<Schema>, TArgs, Array extends boolean = false, Options extends QueryOptions<Schema> = QueryOptions<Schema>> = Readable<Omit<UnwrapStore<ModelMutationResult<SimplifiedResult<Schema, Model, TArgs, Options, false, Array>, TArgs>>, 'mutateAsync'> & {
-    mutateAsync<T extends TArgs>(args: T, options?: ModelMutationOptions<SimplifiedResult<Schema, Model, T, Options, false, Array>, T>): Promise<SimplifiedResult<Schema, Model, T, Options, false, Array>>;
-}>;
-type ClientHooks<Schema extends SchemaDef, Options extends QueryOptions<Schema> = QueryOptions<Schema>> = {
-    [Model in GetModels<Schema> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model, Options>;
-};
-type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Schema>, Options extends QueryOptions<Schema> = QueryOptions<Schema>> = TrimDelegateModelOperations<Schema, Model, {
-    useFindUnique<T extends FindUniqueArgs<Schema, Model>>(args: SelectSubset<T, FindUniqueArgs<Schema, Model>>, options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options> | null>): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options> | null>;
-    useFindFirst<T extends FindFirstArgs<Schema, Model>>(args?: SelectSubset<T, FindFirstArgs<Schema, Model>>, options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options> | null>): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options> | null>;
-    useFindMany<T extends FindManyArgs<Schema, Model>>(args?: SelectSubset<T, FindManyArgs<Schema, Model>>, options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options>[]>;
-    useInfiniteFindMany<T extends FindManyArgs<Schema, Model>>(args?: SelectSubset<T, FindManyArgs<Schema, Model>>, options?: ModelInfiniteQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>): ModelInfiniteQueryResult<InfiniteData<SimplifiedPlainResult<Schema, Model, T, Options>[]>>;
-    useCreate<T extends CreateArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>): ModelMutationModelResult<Schema, Model, T, false, Options>;
-    useCreateMany<T extends CreateManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
-    useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>[], T>): ModelMutationModelResult<Schema, Model, T, true, Options>;
-    useUpdate<T extends UpdateArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>): ModelMutationModelResult<Schema, Model, T, false, Options>;
-    useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
-    useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>[], T>): ModelMutationModelResult<Schema, Model, T, true, Options>;
-    useUpsert<T extends UpsertArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>): ModelMutationModelResult<Schema, Model, T, false, Options>;
-    useDelete<T extends DeleteArgs<Schema, Model>>(options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>): ModelMutationModelResult<Schema, Model, T, false, Options>;
-    useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(options?: ModelMutationOptions<BatchResult, T>): ModelMutationResult<BatchResult, T>;
-    useCount<T extends CountArgs<Schema, Model>>(args?: Subset<T, CountArgs<Schema, Model>>, options?: ModelQueryOptions<CountResult<Schema, Model, T>>): ModelQueryResult<CountResult<Schema, Model, T>>;
-    useAggregate<T extends AggregateArgs<Schema, Model>>(args: Subset<T, AggregateArgs<Schema, Model>>, options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>): ModelQueryResult<AggregateResult<Schema, Model, T>>;
-    useGroupBy<T extends GroupByArgs<Schema, Model>>(args: Subset<T, GroupByArgs<Schema, Model>>, options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>): ModelQueryResult<GroupByResult<Schema, Model, T>>;
-}>;
-/**
- * Gets data query hooks for all models in the schema.
- */
-declare function useClientQueries<Schema extends SchemaDef, Options extends QueryOptions<Schema> = QueryOptions<Schema>>(schema: Schema): ClientHooks<Schema, Options>;
-/**
- * Gets data query hooks for a specific model in the schema.
- */
-declare function useModelQueries<Schema extends SchemaDef, Model extends GetModels<Schema>, Options extends QueryOptions<Schema>>(schema: Schema, model: Model): ModelQueryHooks<Schema, Model, Options>;
-declare function useInternalQuery<TQueryFnData, TData>(_schema: SchemaDef, model: string, operation: string, args?: StoreOrVal<unknown>, options?: StoreOrVal<Omit<CreateQueryOptions<TQueryFnData, DefaultError, TData>, 'queryKey'> & ExtraQueryOptions>): Readable<{
-    data: TData;
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    isPlaceholderData: false;
-    status: "error";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<TData, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<TData>;
-    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;
-    isPlaceholderData: false;
-    status: "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<TData, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<TData>;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-}>;
-declare function useInternalInfiniteQuery<TQueryFnData, TData>(_schema: SchemaDef, model: string, operation: string, args: StoreOrVal<unknown>, options: StoreOrVal<Omit<CreateInfiniteQueryOptions<TQueryFnData, DefaultError, InfiniteData<TData>>, 'queryKey' | 'initialPageParam'>> | undefined): Readable<{
-    data: InfiniteData<TData, unknown>;
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    isPlaceholderData: false;
-    status: "error";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchNextPageError: boolean;
-    isFetchingNextPage: boolean;
-    isFetchPreviousPageError: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    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;
-    isPlaceholderData: false;
-    status: "success";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: undefined;
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: true;
-    isRefetchError: false;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    isSuccess: false;
-    isPlaceholderData: false;
-    status: "error";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    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;
-    isPlaceholderData: false;
-    status: "pending";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    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;
-    isPlaceholderData: false;
-    status: "pending";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isLoading: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-} | {
-    data: InfiniteData<TData, unknown>;
-    isError: false;
-    error: null;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: true;
-    isPlaceholderData: true;
-    isFetchNextPageError: false;
-    isFetchPreviousPageError: false;
-    status: "success";
-    fetchNextPage: (options?: _tanstack_svelte_query.FetchNextPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchPreviousPage: (options?: _tanstack_svelte_query.FetchPreviousPageOptions) => Promise<_tanstack_svelte_query.InfiniteQueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    isFetchingNextPage: boolean;
-    isFetchingPreviousPage: boolean;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error | null;
-    errorUpdateCount: number;
-    isFetched: boolean;
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isRefetching: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    refetch: (options?: _tanstack_svelte_query.RefetchOptions) => Promise<_tanstack_svelte_query.QueryObserverResult<InfiniteData<TData, unknown>, Error>>;
-    fetchStatus: _tanstack_svelte_query.FetchStatus;
-    promise: Promise<InfiniteData<TData, unknown>>;
-    queryKey: [string, string, string, unknown, {
-        infinite: boolean;
-        optimisticUpdate: boolean;
-    }];
-}>;
-/**
- * Creates a svelte-query mutation
- *
- * @private
- *
- * @param model The name of the model under mutation.
- * @param method The HTTP method.
- * @param operation The mutation operation (e.g. `create`).
- * @param options The svelte-query options.
- * @param checkReadBack Whether to check for read back errors and return undefined if found.
- */
-declare function useInternalMutation<TArgs, R = any>(schema: SchemaDef, model: string, method: 'POST' | 'PUT' | 'DELETE', operation: string, options?: StoreOrVal<Omit<CreateMutationOptions<R, DefaultError, TArgs>, 'mutationFn'> & ExtraMutationOptions>): CreateMutationResult<R, Error, TArgs, unknown>;
-type UnwrapStore<T> = T extends Readable<infer U> ? U : T;
-
-export { type ClientHooks, DEFAULT_QUERY_ENDPOINT, type ModelInfiniteQueryOptions, type ModelInfiniteQueryResult, type ModelMutationModelResult, type ModelMutationOptions, type ModelMutationResult, type ModelQueryHooks, type ModelQueryOptions, type ModelQueryResult, SvelteQueryContextKey, setHooksContext, setQuerySettingsContext, useClientQueries, useInternalInfiniteQuery, useInternalMutation, useInternalQuery, useModelQueries };