@orpc/react 0.27.0 → 1.0.0-beta.5

package/dist/src/general-utils.d.ts

@@ -1,40 +0,0 @@
-import type { PartialDeep, SetOptional } from '@orpc/shared';
-import type { CancelOptions, DefaultError, InfiniteData, InvalidateOptions, MutationFilters, MutationObserverOptions, OmitKeyof, QueryClient, QueryKey, QueryObserverOptions, RefetchOptions, ResetOptions, SetDataOptions, Updater } from '@tanstack/react-query';
-import type { ORPCInvalidateQueryFilters, ORPCQueryFilters } from './tanstack-query';
-import type { InferCursor, SchemaInputForInfiniteQuery } from './types';
-export interface GeneralUtils<TInput, TOutput> {
-    getQueriesData: (filters?: OmitKeyof<ORPCQueryFilters<PartialDeep<TInput>>, 'queryType'>) => [QueryKey, TOutput | undefined][];
-    getInfiniteQueriesData: (filters?: OmitKeyof<ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInput>>>, 'queryType'>) => [
-        QueryKey,
-        undefined | InfiniteData<TOutput, InferCursor<TInput>>
-    ][];
-    setQueriesData: (filters: OmitKeyof<ORPCQueryFilters<PartialDeep<TInput>>, 'queryType'>, updater: Updater<TOutput | undefined, TOutput | undefined>, options?: SetDataOptions) => [QueryKey, TOutput | undefined][];
-    setInfiniteQueriesData: (filters: OmitKeyof<ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInput>>>, 'queryType'>, updater: Updater<InfiniteData<TOutput, InferCursor<TInput>> | undefined, InfiniteData<TOutput, InferCursor<TInput>> | undefined>, options?: SetDataOptions) => [
-        QueryKey,
-        undefined | InfiniteData<TOutput, InferCursor<TInput>>
-    ][];
-    invalidate: (filters?: ORPCInvalidateQueryFilters<PartialDeep<TInput>>, options?: InvalidateOptions) => Promise<void>;
-    refetch: (filters?: ORPCQueryFilters<PartialDeep<TInput>>, options?: RefetchOptions) => Promise<void>;
-    cancel: (filters?: ORPCQueryFilters<PartialDeep<TInput>>, options?: CancelOptions) => Promise<void>;
-    remove: (filters?: ORPCQueryFilters<PartialDeep<TInput>>) => void;
-    reset: (filters?: ORPCQueryFilters<PartialDeep<TInput>>, options?: ResetOptions) => Promise<void>;
-    isFetching: (filters?: ORPCQueryFilters<PartialDeep<TInput>>) => number;
-    isMutating: (filters?: SetOptional<MutationFilters, 'mutationKey'>) => number;
-    getQueryDefaults: (filters?: Pick<ORPCQueryFilters<PartialDeep<TInput>>, 'input' | 'queryKey'>) => OmitKeyof<QueryObserverOptions<TOutput>, 'queryKey'>;
-    getInfiniteQueryDefaults: (filters?: Pick<ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInput>>>, 'input' | 'queryKey'>) => OmitKeyof<QueryObserverOptions<TOutput, DefaultError, TOutput, InfiniteData<TOutput>, QueryKey, InferCursor<TInput>>, 'queryKey'>;
-    setQueryDefaults: (options: Partial<OmitKeyof<QueryObserverOptions<TOutput>, 'queryKey'>>, filters?: Pick<ORPCQueryFilters<PartialDeep<TInput>>, 'input' | 'queryKey'>) => void;
-    setInfiniteQueryDefaults: (options: Partial<OmitKeyof<QueryObserverOptions<TOutput, DefaultError, TOutput, InfiniteData<TOutput>, QueryKey, InferCursor<TInput>>, 'queryKey'>>, filters?: Pick<ORPCQueryFilters<PartialDeep<TInput>>, 'input' | 'queryKey'>) => void;
-    getMutationDefaults: (filters?: Pick<MutationFilters, 'mutationKey'>) => MutationObserverOptions<TOutput, DefaultError, TInput>;
-    setMutationDefaults: (options: OmitKeyof<MutationObserverOptions<TOutput, DefaultError, TInput>, 'mutationKey'>, filters?: Pick<MutationFilters, 'mutationKey'>) => void;
-}
-export interface CreateGeneralUtilsOptions {
-    queryClient: QueryClient;
-    /**
-     * The path of the router or procedure on server.
-     *
-     * @internal
-     */
-    path: string[];
-}
-export declare function createGeneralUtils<TInput, TOutput>(options: CreateGeneralUtilsOptions): GeneralUtils<TInput, TOutput>;
-//# sourceMappingURL=general-utils.d.ts.map

package/dist/src/index.d.ts

@@ -1,9 +0,0 @@
-export * from './general-hooks';
-export * from './general-utils';
-export * from './procedure-hooks';
-export * from './procedure-utils';
-export * from './react';
-export * from './react-context';
-export * from './react-hooks';
-export * from './react-utils';
-//# sourceMappingURL=index.d.ts.map

package/dist/src/orpc-path.d.ts

@@ -1,5 +0,0 @@
-import type { ProcedureHooks } from './procedure-hooks';
-import type { ORPCHooks } from './react-hooks';
-export declare const orpcPathSymbol: unique symbol;
-export declare function getORPCPath(orpc: ORPCHooks<any> | ProcedureHooks<any, any>): string[];
-//# sourceMappingURL=orpc-path.d.ts.map

package/dist/src/procedure-hooks.d.ts

@@ -1,30 +0,0 @@
-import type { InferCursor, SchemaInputForInfiniteQuery } from './types';
-import { type PartialOnUndefinedDeep, type SetOptional } from '@orpc/shared';
-import { type DefaultError, type FetchInfiniteQueryOptions, type FetchQueryOptions, type InfiniteData, type QueryKey, type UseInfiniteQueryOptions, type UseInfiniteQueryResult, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, type UseSuspenseInfiniteQueryOptions, type UseSuspenseInfiniteQueryResult, type UseSuspenseQueryOptions, type UseSuspenseQueryResult } from '@tanstack/react-query';
-import { type ORPCContext } from './react-context';
-export interface ProcedureHooks<TInput, TOutput> {
-    useQuery: <USelectData = TOutput>(input: TInput, options?: SetOptional<UseQueryOptions<TOutput, DefaultError, USelectData>, 'queryFn' | 'queryKey'>) => UseQueryResult<USelectData>;
-    useInfiniteQuery: <USelectData = InfiniteData<TOutput, InferCursor<TInput>>>(options: PartialOnUndefinedDeep<SetOptional<UseInfiniteQueryOptions<TOutput, DefaultError, USelectData, TOutput, QueryKey, InferCursor<TInput>>, 'queryFn' | 'queryKey'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => UseInfiniteQueryResult<USelectData>;
-    useSuspenseQuery: <USelectData = TOutput>(input: TInput, options?: SetOptional<UseSuspenseQueryOptions<TOutput, DefaultError, USelectData>, 'queryFn' | 'queryKey'>) => UseSuspenseQueryResult<USelectData>;
-    useSuspenseInfiniteQuery: <USelectData = InfiniteData<TOutput, InferCursor<TInput>>>(options: PartialOnUndefinedDeep<SetOptional<UseSuspenseInfiniteQueryOptions<TOutput, DefaultError, USelectData, TOutput, QueryKey, InferCursor<TInput>>, 'queryFn' | 'queryKey'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => UseSuspenseInfiniteQueryResult<USelectData>;
-    usePrefetchQuery: (input: TInput, options?: FetchQueryOptions<TOutput>) => void;
-    usePrefetchInfiniteQuery: (options: PartialOnUndefinedDeep<SetOptional<FetchInfiniteQueryOptions<TOutput, DefaultError, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | 'queryFn'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => void;
-    useMutation: (options?: SetOptional<UseMutationOptions<TOutput, DefaultError, TInput>, 'mutationFn' | 'mutationKey'>) => UseMutationResult<TOutput, DefaultError, TInput>;
-}
-export interface CreateProcedureHooksOptions {
-    context: ORPCContext<any>;
-    /**
-     * The path of the procedure on server.
-     *
-     * @internal
-     */
-    path: string[];
-}
-export declare function createProcedureHooks<TInput, TOutput>(options: CreateProcedureHooksOptions): ProcedureHooks<TInput, TOutput>;
-//# sourceMappingURL=procedure-hooks.d.ts.map

package/dist/src/procedure-utils.d.ts

@@ -1,34 +0,0 @@
-import type { ProcedureClient } from '@orpc/server';
-import type { PartialOnUndefinedDeep, SetOptional } from '@orpc/shared';
-import type { DefaultError, EnsureInfiniteQueryDataOptions, EnsureQueryDataOptions, FetchInfiniteQueryOptions, FetchQueryOptions, InfiniteData, QueryClient, QueryKey, QueryState, SetDataOptions, Updater } from '@tanstack/react-query';
-import type { InferCursor, SchemaInputForInfiniteQuery } from './types';
-export interface ProcedureUtils<TInput, TOutput> {
-    fetchQuery: (input: TInput, options?: SetOptional<FetchQueryOptions<TOutput>, 'queryKey' | 'queryFn'>) => Promise<TOutput>;
-    fetchInfiniteQuery: (options: PartialOnUndefinedDeep<SetOptional<FetchInfiniteQueryOptions<TOutput, DefaultError, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | 'queryFn'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => Promise<InfiniteData<TOutput, InferCursor<TInput>>>;
-    prefetchQuery: (input: TInput, options?: SetOptional<FetchQueryOptions<TOutput>, 'queryKey' | 'queryFn'>) => Promise<void>;
-    prefetchInfiniteQuery: (options: PartialOnUndefinedDeep<SetOptional<FetchInfiniteQueryOptions<TOutput, DefaultError, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | 'queryFn'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => Promise<void>;
-    getQueryData: (input: TInput) => TOutput | undefined;
-    getInfiniteQueryData: (input: SchemaInputForInfiniteQuery<TInput>) => InfiniteData<TOutput, InferCursor<TInput>> | undefined;
-    ensureQueryData: (input: TInput, options?: SetOptional<EnsureQueryDataOptions<TOutput>, 'queryFn' | 'queryKey'>) => Promise<TOutput>;
-    ensureInfiniteQueryData: (options: PartialOnUndefinedDeep<SetOptional<EnsureInfiniteQueryDataOptions<TOutput, DefaultError, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | 'queryFn'> & {
-        input: SchemaInputForInfiniteQuery<TInput>;
-    }>) => Promise<InfiniteData<TOutput, InferCursor<TInput>>>;
-    getQueryState: (input: TInput) => QueryState<TOutput> | undefined;
-    getInfiniteQueryState: (input: SchemaInputForInfiniteQuery<TInput>) => QueryState<InfiniteData<TOutput, InferCursor<TInput>>> | undefined;
-    setQueryData: (input: TInput, updater: Updater<TOutput | undefined, TOutput | undefined>, options?: SetDataOptions) => TOutput | undefined;
-    setInfiniteQueryData: (input: SchemaInputForInfiniteQuery<TInput>, updater: Updater<InfiniteData<TOutput, InferCursor<TInput>> | undefined, InfiniteData<TOutput, InferCursor<TInput>> | undefined>, options?: SetDataOptions) => InfiniteData<TOutput, InferCursor<TInput>> | undefined;
-}
-export interface CreateProcedureUtilsOptions<TInput, TOutput> {
-    client: ProcedureClient<TInput, TOutput, any>;
-    queryClient: QueryClient;
-    /**
-     * The path of procedure on sever
-     */
-    path: string[];
-}
-export declare function createProcedureUtils<TInput, TOutput>(options: CreateProcedureUtilsOptions<TInput, TOutput>): ProcedureUtils<TInput, TOutput>;
-//# sourceMappingURL=procedure-utils.d.ts.map

package/dist/src/react-context.d.ts

@@ -1,11 +0,0 @@
-import type { RouterClient } from '@orpc/server';
-import type { QueryClient } from '@tanstack/react-query';
-import { type Context } from 'react';
-export interface ORPCContextValue<T extends RouterClient<any, any>> {
-    client: T;
-    queryClient: QueryClient;
-}
-export type ORPCContext<T extends RouterClient<any, any>> = Context<ORPCContextValue<T> | undefined>;
-export declare function createORPCContext<T extends RouterClient<any, any>>(): ORPCContext<T>;
-export declare function useORPCContext<T extends RouterClient<any, any>>(context: ORPCContext<T>): ORPCContextValue<T>;
-//# sourceMappingURL=react-context.d.ts.map

package/dist/src/react-hooks.d.ts

@@ -1,18 +0,0 @@
-import type { ProcedureClient, RouterClient } from '@orpc/server';
-import type { ORPCContext } from './react-context';
-import { type GeneralHooks } from './general-hooks';
-import { type ProcedureHooks } from './procedure-hooks';
-export type ORPCHooks<T extends RouterClient<any, any>> = T extends ProcedureClient<infer TInput, infer TOutput, any> ? ProcedureHooks<TInput, TOutput> & GeneralHooks<TInput, TOutput> : {
-    [K in keyof T]: T[K] extends RouterClient<any, any> ? ORPCHooks<T[K]> : never;
-} & GeneralHooks<unknown, unknown>;
-export interface CreateORPCHooksOptions<T extends RouterClient<any, any>> {
-    context: ORPCContext<T>;
-    /**
-     * The path of the router.
-     *
-     * @internal
-     */
-    path?: string[];
-}
-export declare function createORPCHooks<T extends RouterClient<any, any>>(options: CreateORPCHooksOptions<T>): ORPCHooks<T>;
-//# sourceMappingURL=react-hooks.d.ts.map

package/dist/src/react-utils.d.ts

@@ -1,18 +0,0 @@
-import type { ProcedureClient, RouterClient } from '@orpc/server';
-import type { ORPCContextValue } from './react-context';
-import { type GeneralUtils } from './general-utils';
-import { type ProcedureUtils } from './procedure-utils';
-export type ORPCUtils<T extends RouterClient<any, any>> = T extends ProcedureClient<infer TInput, infer TOutput, any> ? ProcedureUtils<TInput, TOutput> & GeneralUtils<TInput, TOutput> : {
-    [K in keyof T]: T[K] extends RouterClient<any, any> ? ORPCUtils<T[K]> : never;
-} & GeneralUtils<unknown, unknown>;
-export interface CreateORPCUtilsOptions<T extends RouterClient<any, any>> {
-    contextValue: ORPCContextValue<T>;
-    /**
-     * The path of the router.
-     *
-     * @internal
-     */
-    path?: string[];
-}
-export declare function createORPCUtils<T extends RouterClient<any, any>>(options: CreateORPCUtilsOptions<T>): ORPCUtils<T>;
-//# sourceMappingURL=react-utils.d.ts.map

package/dist/src/react.d.ts

@@ -1,15 +0,0 @@
-import type { RouterClient } from '@orpc/server';
-import type { ORPCContext, ORPCContextValue } from './react-context';
-import type { ORPCHooks } from './react-hooks';
-import type { ORPCUtils } from './react-utils';
-import type { UseQueries } from './use-queries/hook';
-export type ORPCReact<T extends RouterClient<any, any>> = ORPCHooks<T> & {
-    useContext: () => ORPCContextValue<T>;
-    useUtils: () => ORPCUtils<T>;
-    useQueries: UseQueries<T>;
-};
-export declare function createORPCReact<T extends RouterClient<any, any>>(): {
-    orpc: ORPCReact<T>;
-    ORPCContext: ORPCContext<T>;
-};
-//# sourceMappingURL=react.d.ts.map

package/dist/src/tanstack-key.d.ts

@@ -1,14 +0,0 @@
-import type { PartialDeep } from '@orpc/shared';
-import type { MutationKey, QueryKey } from '@tanstack/react-query';
-import type { ProcedureHooks } from './procedure-hooks';
-import type { ORPCHooks } from './react-hooks';
-export type QueryType = 'query' | 'infinite' | undefined;
-export interface GetQueryKeyOptions<TInput> {
-    input?: TInput;
-    type?: QueryType;
-}
-export declare function getQueryKey<T extends ORPCHooks<any> | ProcedureHooks<any, any>>(orpc: T, options?: GetQueryKeyOptions<T extends ProcedureHooks<infer UInput, any> ? PartialDeep<UInput> : unknown>): QueryKey;
-export declare function getQueryKeyFromPath(path: string[], options?: GetQueryKeyOptions<unknown>): QueryKey;
-export declare function getMutationKey<T extends ORPCHooks<any> | ProcedureHooks<any, any>>(orpc: T): MutationKey;
-export declare function getMutationKeyFromPath(path: string[]): MutationKey;
-//# sourceMappingURL=tanstack-key.d.ts.map

package/dist/src/tanstack-query.d.ts

@@ -1,19 +0,0 @@
-import type { SetOptional } from '@orpc/shared';
-import type { InvalidateQueryFilters, QueryFilters } from '@tanstack/react-query';
-import type { QueryType } from './tanstack-key';
-export interface ORPCAdditionalQueryFilters<TFilterInput> {
-    /**
-     * The type of the query. useQuery=query, useInfiniteQuery=infinite
-     * If not specified, it will match all types.
-     */
-    queryType?: QueryType;
-    /**
-     * The input of the query. If not specified, it will match all inputs.
-     */
-    input?: TFilterInput;
-}
-export interface ORPCQueryFilters<TFilterInput> extends SetOptional<QueryFilters, 'queryKey'>, ORPCAdditionalQueryFilters<TFilterInput> {
-}
-export interface ORPCInvalidateQueryFilters<TFilterInput> extends SetOptional<InvalidateQueryFilters, 'queryKey'>, ORPCAdditionalQueryFilters<TFilterInput> {
-}
-//# sourceMappingURL=tanstack-query.d.ts.map

package/dist/src/types.d.ts

@@ -1,5 +0,0 @@
-export type SchemaInputForInfiniteQuery<TInput> = Omit<TInput, 'cursor'>;
-export type InferCursor<TInput> = TInput extends {
-    cursor?: any;
-} ? TInput['cursor'] : never;
-//# sourceMappingURL=types.d.ts.map

package/dist/src/use-queries/builder.d.ts

@@ -1,19 +0,0 @@
-import type { ProcedureClient } from '@orpc/server';
-import type { SetOptional } from '@orpc/shared';
-import type { DefaultError, OmitKeyof, QueriesPlaceholderDataFunction, QueryKey, UseQueryOptions } from '@tanstack/react-query';
-type UseQueryOptionsForUseQueries<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData'> & {
-    placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
-};
-export interface UseQueriesBuilder<TInput, TOutput> {
-    (input: TInput, options?: SetOptional<UseQueryOptionsForUseQueries<TOutput>, 'queryFn' | 'queryKey'>): UseQueryOptionsForUseQueries<TOutput>;
-}
-export interface CreateUseQueriesBuilderOptions<TInput, TOutput> {
-    client: ProcedureClient<TInput, TOutput, any>;
-    /**
-     * The path of procedure on server
-     */
-    path: string[];
-}
-export declare function createUseQueriesBuilder<TInput, TOutput>(options: CreateUseQueriesBuilderOptions<TInput, TOutput>): UseQueriesBuilder<TInput, TOutput>;
-export {};
-//# sourceMappingURL=builder.d.ts.map

package/dist/src/use-queries/builders.d.ts

@@ -1,14 +0,0 @@
-import type { ProcedureClient, RouterClient } from '@orpc/server';
-import { type UseQueriesBuilder } from './builder';
-export type UseQueriesBuilders<T extends RouterClient<any, any>> = T extends ProcedureClient<infer UInput, infer UOutput, any> ? UseQueriesBuilder<UInput, UOutput> : {
-    [K in keyof T]: T[K] extends RouterClient<any, any> ? UseQueriesBuilders<T[K]> : never;
-};
-export interface CreateUseQueriesBuildersOptions<T extends RouterClient<any, any>> {
-    client: T;
-    /**
-     * The path of router on server
-     */
-    path?: string[];
-}
-export declare function createUseQueriesBuilders<T extends RouterClient<any, any>>(options: CreateUseQueriesBuildersOptions<T>): UseQueriesBuilders<T>;
-//# sourceMappingURL=builders.d.ts.map

package/dist/src/use-queries/hook.d.ts

@@ -1,12 +0,0 @@
-import type { RouterClient } from '@orpc/server';
-import type { QueriesOptions, QueriesResults } from '@tanstack/react-query';
-import type { ORPCContext } from '../react-context';
-import type { UseQueriesBuilders } from './builders';
-export interface UseQueries<T extends RouterClient<any, any>> {
-    <U extends Array<any> = [], UCombinedResult = QueriesResults<U>>(build: (builders: UseQueriesBuilders<T>) => [...QueriesOptions<U>], combine?: (result: QueriesResults<U>) => UCombinedResult): UCombinedResult;
-}
-export interface UseQueriesFactoryOptions<T extends RouterClient<any, any>> {
-    context: ORPCContext<T>;
-}
-export declare function useQueriesFactory<T extends RouterClient<any, any>>(options: UseQueriesFactoryOptions<T>): UseQueries<T>;
-//# sourceMappingURL=hook.d.ts.map