-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
getQueryKey.ts
99 lines (92 loc) · 2.83 KB
/
getQueryKey.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
import {
AnyMutationProcedure,
AnyQueryProcedure,
AnyRouter,
DeepPartial,
inferProcedureInput,
} from '@trpc/server';
import { getArrayQueryKey, QueryType } from '../internals/getArrayQueryKey';
import { DecoratedProcedureRecord, DecorateProcedure } from '../shared';
/**
* We treat `undefined` as an input the same as omitting an `input`
* https://github.com/trpc/trpc/issues/2290
*/
export function getQueryKeyInternal(
path: string,
input: unknown,
): [string, unknown] | [string] {
if (path.length) return input === undefined ? [path] : [path, input];
return [] as unknown as [string];
}
type GetInfiniteQueryInput<
TProcedureInput,
TInputWithoutCursor = Omit<TProcedureInput, 'cursor'>,
> = keyof TInputWithoutCursor extends never
? undefined
: DeepPartial<TInputWithoutCursor> | undefined;
/** @internal */
export type GetQueryProcedureInput<TProcedureInput> = TProcedureInput extends {
cursor?: any;
}
? GetInfiniteQueryInput<TProcedureInput>
: DeepPartial<TProcedureInput> | undefined;
type GetQueryParams<
TProcedureOrRouter extends AnyQueryProcedure,
TProcedureInput = inferProcedureInput<TProcedureOrRouter>,
> = TProcedureInput extends undefined
? []
: [input?: GetQueryProcedureInput<TProcedureInput>, type?: QueryType];
type GetParams<
TProcedureOrRouter extends
| AnyMutationProcedure
| AnyQueryProcedure
| AnyRouter,
TPath extends string,
TFlags,
> = TProcedureOrRouter extends AnyQueryProcedure
? [
procedureOrRouter: DecorateProcedure<TProcedureOrRouter, TFlags, TPath>,
..._params: GetQueryParams<TProcedureOrRouter>,
]
: TProcedureOrRouter extends AnyMutationProcedure
? [procedureOrRouter: DecorateProcedure<TProcedureOrRouter, TFlags, TPath>]
: [
procedureOrRouter: DecoratedProcedureRecord<
TProcedureOrRouter['_def']['record'],
TFlags,
any
>,
];
type GetQueryKeyParams<
TProcedureOrRouter extends
| AnyMutationProcedure
| AnyQueryProcedure
| AnyRouter,
TPath extends string,
TFlags,
> = GetParams<TProcedureOrRouter, TPath, TFlags>;
/**
* Method to extract the query key for a procedure
* @param procedureOrRouter - procedure or AnyRouter
* @param input - input to procedureOrRouter
* @param type - defaults to `any`
* @link https://trpc.io/docs/getQueryKey
*/
export function getQueryKey<
TProcedureOrRouter extends
| AnyMutationProcedure
| AnyQueryProcedure
| AnyRouter,
TPath extends string,
TFlags,
>(..._params: GetQueryKeyParams<TProcedureOrRouter, TPath, TFlags>) {
const [procedureOrRouter, input, type] = _params;
// @ts-expect-error - we don't expose _def on the type layer
const path = procedureOrRouter._def().path as string[];
const dotPath = path.join('.');
const queryKey = getArrayQueryKey(
getQueryKeyInternal(dotPath, input),
type ?? 'any',
);
return queryKey;
}