@trpc/tanstack-react-query 11.3.1 → 11.3.2-canary.2

package/dist/internals/subscriptionOptions.mjs

@@ -1,159 +0,0 @@
-import { hashKey, skipToken } from '@tanstack/react-query';
-import * as React from 'react';
-import { createTRPCOptionsResult } from './utils.mjs';
-
-/**
- * @internal
- */ const trpcSubscriptionOptions = (args)=>{
-    const { subscribe, path, queryKey, opts = {} } = args;
-    const input = queryKey[1]?.input;
-    const enabled = 'enabled' in opts ? !!opts.enabled : input !== skipToken;
-    const _subscribe = (innerOpts)=>{
-        return subscribe(path.join('.'), input ?? undefined, innerOpts);
-    };
-    return {
-        ...opts,
-        enabled,
-        subscribe: _subscribe,
-        queryKey,
-        trpc: createTRPCOptionsResult({
-            path
-        })
-    };
-};
-function useSubscription(opts) {
-    const optsRef = React.useRef(opts);
-    optsRef.current = opts;
-    const trackedProps = React.useRef(new Set([]));
-    const addTrackedProp = React.useCallback((key)=>{
-        trackedProps.current.add(key);
-    }, []);
-    const currentSubscriptionRef = React.useRef(()=>{
-    // noop
-    });
-    const reset = React.useCallback(()=>{
-        // unsubscribe from the previous subscription
-        currentSubscriptionRef.current?.();
-        updateState(getInitialState);
-        if (!opts.enabled) {
-            return;
-        }
-        const subscription = opts.subscribe({
-            onStarted: ()=>{
-                optsRef.current.onStarted?.();
-                updateState((prev)=>({
-                        ...prev,
-                        status: 'pending',
-                        error: null
-                    }));
-            },
-            onData: (data)=>{
-                optsRef.current.onData?.(data);
-                updateState((prev)=>({
-                        ...prev,
-                        status: 'pending',
-                        data,
-                        error: null
-                    }));
-            },
-            onError: (error)=>{
-                optsRef.current.onError?.(error);
-                updateState((prev)=>({
-                        ...prev,
-                        status: 'error',
-                        error
-                    }));
-            },
-            onConnectionStateChange: (result)=>{
-                optsRef.current.onConnectionStateChange?.(result);
-                updateState((prev)=>{
-                    switch(result.state){
-                        case 'connecting':
-                            return {
-                                ...prev,
-                                status: 'connecting',
-                                error: result.error
-                            };
-                        case 'pending':
-                            // handled in onStarted
-                            return prev;
-                        case 'idle':
-                            return {
-                                ...prev,
-                                status: 'idle',
-                                data: undefined,
-                                error: null
-                            };
-                    }
-                });
-            }
-        });
-        currentSubscriptionRef.current = ()=>{
-            subscription.unsubscribe();
-        };
-    // eslint-disable-next-line react-hooks/react-compiler
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [
-        hashKey(opts.queryKey),
-        opts.enabled
-    ]);
-    const getInitialState = React.useCallback(()=>{
-        return opts.enabled ? {
-            data: undefined,
-            error: null,
-            status: 'connecting',
-            reset
-        } : {
-            data: undefined,
-            error: null,
-            status: 'idle',
-            reset
-        };
-    }, [
-        opts.enabled,
-        reset
-    ]);
-    const resultRef = React.useRef(getInitialState());
-    const [state, setState] = React.useState(trackResult(resultRef.current, addTrackedProp));
-    state.reset = reset;
-    const updateState = React.useCallback((callback)=>{
-        const prev = resultRef.current;
-        const next = resultRef.current = callback(prev);
-        let shouldUpdate = false;
-        for (const key of trackedProps.current){
-            if (prev[key] !== next[key]) {
-                shouldUpdate = true;
-                break;
-            }
-        }
-        if (shouldUpdate) {
-            setState(trackResult(next, addTrackedProp));
-        }
-    }, [
-        addTrackedProp
-    ]);
-    React.useEffect(()=>{
-        if (!opts.enabled) {
-            return;
-        }
-        reset();
-        return ()=>{
-            currentSubscriptionRef.current?.();
-        };
-    }, [
-        reset,
-        opts.enabled
-    ]);
-    return state;
-}
-function trackResult(result, onTrackResult) {
-    const trackedResult = new Proxy(result, {
-        get (target, prop) {
-            onTrackResult(prop);
-            return target[prop];
-        }
-    });
-    return trackedResult;
-}
-
-export { trpcSubscriptionOptions, useSubscription };

package/dist/internals/types.d.ts

@@ -1,83 +0,0 @@
-import type { InfiniteData } from '@tanstack/react-query';
-import type { TRPCRequestOptions } from '@trpc/client';
-/**
- * Turn a set of optional properties into required
- * @internal
- */
-export type WithRequired<TObj, TKey extends keyof TObj> = TObj & {
-    [P in TKey]-?: TObj[P];
-};
-/**
- * @internal
- */
-export type ResolverDef = {
-    input: any;
-    output: any;
-    transformer: boolean;
-    errorShape: any;
-};
-/**
- * @remark `void` is here due to https://github.com/trpc/trpc/pull/4374
- */
-type CursorInput = {
-    cursor?: any;
-};
-export type OptionalCursorInput = CursorInput | void;
-/**
- * @internal
- */
-export type ExtractCursorType<TInput> = TInput extends CursorInput ? TInput['cursor'] : unknown;
-/**
- * @internal
- */
-export type TRPCInfiniteData<TInput, TOutput> = InfiniteData<TOutput, NonNullable<ExtractCursorType<TInput>> | null>;
-/**
- * @public
- */
-export interface TRPCReactRequestOptions extends Omit<TRPCRequestOptions, 'signal'> {
-    /**
-     * Opt out of SSR for this query by passing `ssr: false`
-     */
-    ssr?: boolean;
-    /**
-     * Opt out or into aborting request on unmount
-     */
-    abortOnUnmount?: boolean;
-}
-/**
- * @public
- */
-export interface TRPCQueryBaseOptions {
-    /**
-     * tRPC-related options
-     */
-    trpc?: TRPCReactRequestOptions;
-}
-/**
- * @public
- */
-export interface TRPCQueryOptionsResult {
-    trpc: {
-        path: string;
-    };
-}
-/**
- * @public
- */
-export type QueryType = 'any' | 'infinite' | 'query';
-/**
- * @public
- */
-export type TRPCQueryKey = [
-    readonly string[],
-    {
-        input?: unknown;
-        type?: Exclude<QueryType, 'any'>;
-    }?
-];
-/**
- * @public
- */
-export type TRPCMutationKey = [readonly string[]];
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/internals/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/internals/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,EAAE,IAAI,SAAS,MAAM,IAAI,IAAI,IAAI,GAAG;KAC9D,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,GAAG,CAAC;IACZ,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,KAAK,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AACpC,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,IAAI,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,IAAI,MAAM,SAAS,WAAW,GAC9D,MAAM,CAAC,QAAQ,CAAC,GAChB,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,EAAE,OAAO,IAAI,YAAY,CAC1D,OAAO,EACP,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,uBAEf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,MAAM,EAAE;IACjB;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;KAAE,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC"}

package/dist/internals/utils.d.ts

@@ -1,36 +0,0 @@
-import { type QueryClient } from '@tanstack/react-query';
-import type { QueryType, TRPCMutationKey, TRPCQueryKey, TRPCQueryOptionsResult } from './types';
-/**
- * @internal
- */
-export declare function createTRPCOptionsResult(value: {
-    path: readonly string[];
-}): TRPCQueryOptionsResult['trpc'];
-/**
- * @internal
- */
-export declare function getClientArgs<TOptions>(queryKey: TRPCQueryKey, opts: TOptions, infiniteParams?: {
-    pageParam: any;
-    direction: 'forward' | 'backward';
-}): readonly [string, unknown, any];
-/**
- * @internal
- */
-export declare function buildQueryFromAsyncIterable(asyncIterable: AsyncIterable<unknown>, queryClient: QueryClient, queryKey: TRPCQueryKey): Promise<unknown[]>;
-/**
- * To allow easy interactions with groups of related queries, such as
- * invalidating all queries of a router, we use an array as the path when
- * storing in tanstack query.
- *
- * @internal
- */
-export declare function getQueryKeyInternal(path: readonly string[], input?: unknown, type?: QueryType): TRPCQueryKey;
-/**
- * @internal
- */
-export declare function getMutationKeyInternal(path: readonly string[]): TRPCMutationKey;
-/**
- * @internal
- */
-export declare function unwrapLazyArg<T>(valueOrLazy: T | (() => T)): T;
-//# sourceMappingURL=utils.d.ts.map

package/dist/internals/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/internals/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,YAAY,EACZ,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAMjC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EACpC,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,QAAQ,EACd,cAAc,CAAC,EAAE;IACf,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;CACnC,mCAcF;AAED;;GAEG;AACH,wBAAsB,2BAA2B,CAC/C,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,EACrC,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,YAAY,sBAsBvB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,KAAK,CAAC,EAAE,OAAO,EACf,IAAI,CAAC,EAAE,SAAS,GACf,YAAY,CA2Cd;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,SAAS,MAAM,EAAE,GACtB,eAAe,CAKjB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAE9D"}

package/dist/internals/utils.js

@@ -1,118 +0,0 @@
-'use strict';
-
-var reactQuery = require('@tanstack/react-query');
-var unstableCoreDoNotImport = require('@trpc/server/unstable-core-do-not-import');
-
-/**
- * @internal
- */ function createTRPCOptionsResult(value) {
-    const path = value.path.join('.');
-    return {
-        path
-    };
-}
-/**
- * @internal
- */ function getClientArgs(queryKey, opts, infiniteParams) {
-    const path = queryKey[0];
-    let input = queryKey[1]?.input;
-    if (infiniteParams) {
-        input = {
-            ...input ?? {},
-            ...infiniteParams.pageParam !== undefined ? {
-                cursor: infiniteParams.pageParam
-            } : {},
-            direction: infiniteParams.direction
-        };
-    }
-    return [
-        path.join('.'),
-        input,
-        opts?.trpc
-    ];
-}
-/**
- * @internal
- */ async function buildQueryFromAsyncIterable(asyncIterable, queryClient, queryKey) {
-    const queryCache = queryClient.getQueryCache();
-    const query = queryCache.build(queryClient, {
-        queryKey
-    });
-    query.setState({
-        data: [],
-        status: 'success'
-    });
-    const aggregate = [];
-    for await (const value of asyncIterable){
-        aggregate.push(value);
-        query.setState({
-            data: [
-                ...aggregate
-            ]
-        });
-    }
-    return aggregate;
-}
-/**
- * To allow easy interactions with groups of related queries, such as
- * invalidating all queries of a router, we use an array as the path when
- * storing in tanstack query.
- *
- * @internal
- */ function getQueryKeyInternal(path, input, type) {
-    // Construct a query key that is easy to destructure and flexible for
-    // partial selecting etc.
-    // https://github.com/trpc/trpc/issues/3128
-    // some parts of the path may be dot-separated, split them up
-    const splitPath = path.flatMap((part)=>part.split('.'));
-    if (!input && (!type || type === 'any')) {
-        // this matches also all mutations (see `getMutationKeyInternal`)
-        // for `utils.invalidate()` to match all queries (including vanilla react-query)
-        // we don't want nested array if path is empty, i.e. `[]` instead of `[[]]`
-        return splitPath.length ? [
-            splitPath
-        ] : [];
-    }
-    if (type === 'infinite' && unstableCoreDoNotImport.isObject(input) && ('direction' in input || 'cursor' in input)) {
-        const { cursor: _, direction: __, ...inputWithoutCursorAndDirection } = input;
-        return [
-            splitPath,
-            {
-                input: inputWithoutCursorAndDirection,
-                type: 'infinite'
-            }
-        ];
-    }
-    return [
-        splitPath,
-        {
-            ...typeof input !== 'undefined' && input !== reactQuery.skipToken && {
-                input: input
-            },
-            ...type && type !== 'any' && {
-                type: type
-            }
-        }
-    ];
-}
-/**
- * @internal
- */ function getMutationKeyInternal(path) {
-    // some parts of the path may be dot-separated, split them up
-    const splitPath = path.flatMap((part)=>part.split('.'));
-    return splitPath.length ? [
-        splitPath
-    ] : [];
-}
-/**
- * @internal
- */ function unwrapLazyArg(valueOrLazy) {
-    return unstableCoreDoNotImport.isFunction(valueOrLazy) ? valueOrLazy() : valueOrLazy;
-}
-
-exports.buildQueryFromAsyncIterable = buildQueryFromAsyncIterable;
-exports.createTRPCOptionsResult = createTRPCOptionsResult;
-exports.getClientArgs = getClientArgs;
-exports.getMutationKeyInternal = getMutationKeyInternal;
-exports.getQueryKeyInternal = getQueryKeyInternal;
-exports.unwrapLazyArg = unwrapLazyArg;

package/dist/internals/utils.mjs

@@ -1,111 +0,0 @@
-import { skipToken } from '@tanstack/react-query';
-import { isObject, isFunction } from '@trpc/server/unstable-core-do-not-import';
-
-/**
- * @internal
- */ function createTRPCOptionsResult(value) {
-    const path = value.path.join('.');
-    return {
-        path
-    };
-}
-/**
- * @internal
- */ function getClientArgs(queryKey, opts, infiniteParams) {
-    const path = queryKey[0];
-    let input = queryKey[1]?.input;
-    if (infiniteParams) {
-        input = {
-            ...input ?? {},
-            ...infiniteParams.pageParam !== undefined ? {
-                cursor: infiniteParams.pageParam
-            } : {},
-            direction: infiniteParams.direction
-        };
-    }
-    return [
-        path.join('.'),
-        input,
-        opts?.trpc
-    ];
-}
-/**
- * @internal
- */ async function buildQueryFromAsyncIterable(asyncIterable, queryClient, queryKey) {
-    const queryCache = queryClient.getQueryCache();
-    const query = queryCache.build(queryClient, {
-        queryKey
-    });
-    query.setState({
-        data: [],
-        status: 'success'
-    });
-    const aggregate = [];
-    for await (const value of asyncIterable){
-        aggregate.push(value);
-        query.setState({
-            data: [
-                ...aggregate
-            ]
-        });
-    }
-    return aggregate;
-}
-/**
- * To allow easy interactions with groups of related queries, such as
- * invalidating all queries of a router, we use an array as the path when
- * storing in tanstack query.
- *
- * @internal
- */ function getQueryKeyInternal(path, input, type) {
-    // Construct a query key that is easy to destructure and flexible for
-    // partial selecting etc.
-    // https://github.com/trpc/trpc/issues/3128
-    // some parts of the path may be dot-separated, split them up
-    const splitPath = path.flatMap((part)=>part.split('.'));
-    if (!input && (!type || type === 'any')) {
-        // this matches also all mutations (see `getMutationKeyInternal`)
-        // for `utils.invalidate()` to match all queries (including vanilla react-query)
-        // we don't want nested array if path is empty, i.e. `[]` instead of `[[]]`
-        return splitPath.length ? [
-            splitPath
-        ] : [];
-    }
-    if (type === 'infinite' && isObject(input) && ('direction' in input || 'cursor' in input)) {
-        const { cursor: _, direction: __, ...inputWithoutCursorAndDirection } = input;
-        return [
-            splitPath,
-            {
-                input: inputWithoutCursorAndDirection,
-                type: 'infinite'
-            }
-        ];
-    }
-    return [
-        splitPath,
-        {
-            ...typeof input !== 'undefined' && input !== skipToken && {
-                input: input
-            },
-            ...type && type !== 'any' && {
-                type: type
-            }
-        }
-    ];
-}
-/**
- * @internal
- */ function getMutationKeyInternal(path) {
-    // some parts of the path may be dot-separated, split them up
-    const splitPath = path.flatMap((part)=>part.split('.'));
-    return splitPath.length ? [
-        splitPath
-    ] : [];
-}
-/**
- * @internal
- */ function unwrapLazyArg(valueOrLazy) {
-    return isFunction(valueOrLazy) ? valueOrLazy() : valueOrLazy;
-}
-
-export { buildQueryFromAsyncIterable, createTRPCOptionsResult, getClientArgs, getMutationKeyInternal, getQueryKeyInternal, unwrapLazyArg };