Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

deep-keys.public.ts

231 lines6.5 KB

1import type { BuiltInType } from './utils.public'
2​
3interface AnyDeepKeyAndValue<
4 in out TKey extends string = string,
5 in out TValue extends any = any,
6> {
7 key: TKey
8 value: TValue
9}
10​
11type ObjectPart<T> = T extends object
12 ? T extends ReadonlyArray<any>
13 ? never
14 : T
15 : never
16​
17type ArrayPart<T> = T extends ReadonlyArray<any> ? T : never
18​
19type NullishPart<T> = Extract<T, null | undefined>
20​
21type UndefinedIfNullish<T> = [NullishPart<T>] extends [never]
22 ? never
23 : undefined
24​
25type NonNullish<T> = Exclude<T, null | undefined>
26​
27type ValueForKey<T, TKey extends string | number> =
28 NonNullish<T> extends infer TNonNullish
29 ? TNonNullish extends any
30 ? TKey extends keyof TNonNullish
31 ? TNonNullish[TKey]
32 : never
33 : never
34 : never
35​
36type UndefinedForMissingKey<T, TKey extends string | number> =
37 NonNullish<T> extends infer TNonNullish
38 ? TNonNullish extends any
39 ? TKey extends keyof TNonNullish
40 ? never
41 : undefined
42 : never
43 : never
44​
45type ValueForKeyOrUndefined<T, TKey extends string | number> =
46 ValueForKey<T, TKey> | UndefinedForMissingKey<T, TKey> | UndefinedIfNullish<T>
47​
48type ArrayAccessor<TParent extends AnyDeepKeyAndValue> =
49 `${TParent['key'] extends never ? '' : TParent['key']}[${number}]`
50​
51interface ArrayDeepKeyAndValue<
52 in out TParent extends AnyDeepKeyAndValue,
53 in out T extends ReadonlyArray<any>,
54> extends AnyDeepKeyAndValue {
55 key: ArrayAccessor<TParent>
56 value: T[number] | UndefinedIfNullish<TParent['value']>
58​
59type DeepKeyAndValueArray<
60 TParent extends AnyDeepKeyAndValue,
61 T extends ReadonlyArray<any>,
62 TAcc,
63> = DeepKeysAndValuesImpl<
64 NonNullable<T[number]>,
65 ArrayDeepKeyAndValue<TParent, T>,
66 TAcc | ArrayDeepKeyAndValue<TParent, T>
68​
69type TupleAccessor<
70 TParent extends AnyDeepKeyAndValue,
71 TKey extends string,
72> = `${TParent['key'] extends never ? '' : TParent['key']}[${TKey}]`
73​
74interface TupleDeepKeyAndValue<
75 in out TParent extends AnyDeepKeyAndValue,
76 in out T,
77 in out TKey extends AllTupleKeys<T>,
78> extends AnyDeepKeyAndValue {
79 key: TupleAccessor<TParent, TKey>
80 value: T[TKey] | UndefinedIfNullish<TParent['value']>
82​
83type AllTupleKeys<T> = T extends any ? keyof T & `${number}` : never
84​
85type DeepKeyAndValueTuple<
86 TParent extends AnyDeepKeyAndValue,
87 T extends ReadonlyArray<any>,
88 TAcc,
89 TAllKeys extends AllTupleKeys<T> = AllTupleKeys<T>,
90> = TAllKeys extends any
91 ? DeepKeysAndValuesImpl<
92 NonNullable<T[TAllKeys]>,
93 TupleDeepKeyAndValue<TParent, T, TAllKeys>,
94 TAcc | TupleDeepKeyAndValue<TParent, T, TAllKeys>
95 >
96 : never
97​
98type AllObjectKeys<T> = T extends any ? keyof T & (string | number) : never
99​
100type ObjectAccessor<
101 TParent extends AnyDeepKeyAndValue,
102 TKey extends string | number,
103> = TParent['key'] extends never ? `${TKey}` : `${TParent['key']}.${TKey}`
104​
105type ObjectValue<
106 TParent extends AnyDeepKeyAndValue,
107 T,
108 TKey extends AllObjectKeys<ObjectPart<T>>,
109> = ValueForKeyOrUndefined<T, TKey> | UndefinedIfNullish<TParent['value']>
110​
111interface ObjectDeepKeyAndValue<
112 in out TParent extends AnyDeepKeyAndValue,
113 in out T,
114 in out TKey extends AllObjectKeys<ObjectPart<T>>,
115> extends AnyDeepKeyAndValue {
116 key: ObjectAccessor<TParent, TKey>
117 value: ObjectValue<TParent, T, TKey>
119​
120type DeepKeyAndValueObject<
121 TParent extends AnyDeepKeyAndValue,
122 T,
123 TAcc,
124 TAllKeys extends AllObjectKeys<ObjectPart<T>> = AllObjectKeys<ObjectPart<T>>,
125> = [TAllKeys] extends [never]
126 ? TAcc | UnknownDeepKeyAndValue<TParent>
127 : TAllKeys extends any
128 ? DeepKeysAndValuesImpl<
129 NonNullable<ValueForKey<T, TAllKeys>>,
130 ObjectDeepKeyAndValue<TParent, T, TAllKeys>,
131 TAcc | ObjectDeepKeyAndValue<TParent, T, TAllKeys>
132 >
133 : never
134​
135type UnknownAccessor<TParent extends AnyDeepKeyAndValue> =
136 TParent['key'] extends never ? string : `${TParent['key']}.${string}`
137​
138interface UnknownDeepKeyAndValue<
139 in out TParent extends AnyDeepKeyAndValue,
140> extends AnyDeepKeyAndValue {
141 key: UnknownAccessor<TParent>
142 value: unknown
144​
145type DeepKeysAndValues<T> =
146 DeepKeysAndValuesImpl<T> extends AnyDeepKeyAndValue
147 ? DeepKeysAndValuesImpl<T>
148 : never
149​
150type DeepKeysAndValuesImpl<
151 T,
152 TParent extends AnyDeepKeyAndValue = never,
153 TAcc = never,
154> = [T] extends [never]
155 ? TAcc
156 : unknown extends T
157 ? TAcc | UnknownDeepKeyAndValue<TParent>
158 : // If omitted, DeepKeys has an excessive stack when comparing keyof. Likely because of trying to check
159 // unknown or any, but I don't know for sure.
160 unknown extends T
161 ? T
162 : [T] extends [BuiltInType]
163 ? TAcc
164 : [ArrayPart<T>] extends [never]
165 ? [ObjectPart<T>] extends [never]
166 ? TAcc
167 : DeepKeyAndValueObject<TParent, T, TAcc>
168 : number extends ArrayPart<T>['length']
169 ? DeepKeyAndValueArray<TParent, ArrayPart<T>, TAcc>
170 : DeepKeyAndValueTuple<TParent, ArrayPart<T>, TAcc>
171​
172type ValueMatchingAccessor<
173 TValue extends AnyDeepKeyAndValue,
174 TAccessor extends string,
175> = TValue extends TValue
176 ? TAccessor extends TValue['key']
177 ? TValue
178 : never
179 : never
180​
181type MostSpecificKey<TValue extends AnyDeepKeyAndValue> = MostSpecificKeyImpl<
182 TValue,
183 TValue
185​
186type LongerPrefix<TPrefix extends string> =
187 `${TPrefix}.${string}` | `${TPrefix}[${string}`
188​
189type HasLonger<TAll extends AnyDeepKeyAndValue, TName extends string> =
190 Extract<TAll, { key: LongerPrefix<TName> }> extends never ? false : true
191​
192type MostSpecificKeyImpl<
193 TValue extends AnyDeepKeyAndValue,
194 TAll extends AnyDeepKeyAndValue,
195> = TValue extends TValue
196 ? HasLonger<TAll, TValue['key']> extends true
197 ? never
198 : TValue['value']
199 : never
200​
201type DeepValueImpl<TValue, TAccessor extends string> = MostSpecificKey<
202 ValueMatchingAccessor<DeepKeysAndValues<TValue>, TAccessor>
204​
205/**
206 * The keys of an object or array, deeply nested.
207 */
208export type DeepKeys<T> = unknown extends T
209 ? string
210 : DeepKeysAndValues<T>['key']
211​
212/**
213 * Infer the type of a deeply nested property within an object or an array.
214 */
215export type DeepValue<TValue, TAccessor extends string> = unknown extends TValue
216 ? TValue
217 : TAccessor extends DeepKeys<TValue>
218 ? DeepValueImpl<TValue, TAccessor>
219 : never
220​
221export type DeepKeysWhereValueIncludes<TData, TValue> =
222 DeepKeysAndValues<TData> extends infer TDeepKeyAndValue
223 ? TDeepKeyAndValue extends AnyDeepKeyAndValue
224 ? Extract<NonNullable<TDeepKeyAndValue['value']>, TValue> extends never
225 ? never
226 : TDeepKeyAndValue['key']
227 : never
228 : never
229​
230export type TryGetArrayElementType<TValue> =
231 TValue extends ReadonlyArray<infer TElement> ? TElement : never