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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
import { TestParams } from '../framework/fixture.js';
import { ResolveType, UnionToIntersection } from '../util/types.js';
import { assert } from '../util/util.js';
import { comparePublicParamsPaths, Ordering } from './query/compare.js';
import { kWildcard, kParamSeparator, kParamKVSeparator } from './query/separators.js';
export type JSONWithUndefined =
| undefined
| null
| number
| string
| boolean
| readonly JSONWithUndefined[]
// Ideally this would recurse into JSONWithUndefined, but it breaks code.
| { readonly [k: string]: unknown };
export interface TestParamsRW {
[k: string]: JSONWithUndefined;
}
export type TestParamsIterable = Iterable<TestParams>;
export function paramKeyIsPublic(key: string): boolean {
return !key.startsWith('_');
}
export function extractPublicParams(params: TestParams): TestParams {
const publicParams: TestParamsRW = {};
for (const k of Object.keys(params)) {
if (paramKeyIsPublic(k)) {
publicParams[k] = params[k];
}
}
return publicParams;
}
/** Used to escape reserved characters in URIs */
const kPercent = '%';
export const badParamValueChars = new RegExp(
'[' + kParamKVSeparator + kParamSeparator + kWildcard + kPercent + ']'
);
export function publicParamsEquals(x: TestParams, y: TestParams): boolean {
return comparePublicParamsPaths(x, y) === Ordering.Equal;
}
export type KeyOfNeverable<T> = T extends never ? never : keyof T;
export type AllKeysFromUnion<T> = keyof T | KeyOfNeverable<UnionToIntersection<T>>;
export type KeyOfOr<T, K, Default> = K extends keyof T ? T[K] : Default;
/**
* Flatten a union of interfaces into a single interface encoding the same type.
*
* Flattens a union in such a way that:
* `{ a: number, b?: undefined } | { b: string, a?: undefined }`
* (which is the value type of `[{ a: 1 }, { b: 1 }]`)
* becomes `{ a: number | undefined, b: string | undefined }`.
*
* And also works for `{ a: number } | { b: string }` which maps to the same.
*/
export type FlattenUnionOfInterfaces<T> = {
[K in AllKeysFromUnion<T>]: KeyOfOr<
T,
// If T always has K, just take T[K] (union of C[K] for each component C of T):
K,
// Otherwise, take the union of C[K] for each component C of T, PLUS undefined:
undefined | KeyOfOr<UnionToIntersection<T>, K, void>
>;
};
/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
function typeAssert<_ extends 'pass'>() {}
{
type Test<T, U> = [T] extends [U]
? [U] extends [T]
? 'pass'
: { actual: ResolveType<T>; expected: U }
: { actual: ResolveType<T>; expected: U };
type T01 = { a: number } | { b: string };
type T02 = { a: number } | { b?: string };
type T03 = { a: number } | { a?: number };
type T04 = { a: number } | { a: string };
type T05 = { a: number } | { a?: string };
type T11 = { a: number; b?: undefined } | { a?: undefined; b: string };
type T21 = { a: number; b?: undefined } | { b: string };
type T22 = { a: number; b?: undefined } | { b?: string };
type T23 = { a: number; b?: undefined } | { a?: number };
type T24 = { a: number; b?: undefined } | { a: string };
type T25 = { a: number; b?: undefined } | { a?: string };
type T26 = { a: number; b?: undefined } | { a: undefined };
type T27 = { a: number; b?: undefined } | { a: undefined; b: undefined };
/* prettier-ignore */ {
typeAssert<Test<FlattenUnionOfInterfaces<T01>, { a: number | undefined; b: string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T02>, { a: number | undefined; b: string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T03>, { a: number | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T04>, { a: number | string }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T05>, { a: number | string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T11>, { a: number | undefined; b: string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T22>, { a: number | undefined; b: string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T23>, { a: number | undefined; b: undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T24>, { a: number | string; b: undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T25>, { a: number | string | undefined; b: undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T27>, { a: number | undefined; b: undefined }>>();
// Unexpected test results - hopefully okay to ignore these
typeAssert<Test<FlattenUnionOfInterfaces<T21>, { b: string | undefined }>>();
typeAssert<Test<FlattenUnionOfInterfaces<T26>, { a: number | undefined }>>();
}
}
export type Merged<A, B> = MergedFromFlat<A, FlattenUnionOfInterfaces<B>>;
export type MergedFromFlat<A, B> = {
[K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never;
};
/** Merges two objects into one `{ ...a, ...b }` and return it with a flattened type. */
export function mergeParams<A extends {}, B extends {}>(a: A, b: B): Merged<A, B> {
return { ...a, ...b } as Merged<A, B>;
}
/**
* Merges two objects into one `{ ...a, ...b }` and asserts they had no overlapping keys.
* This is slower than {@link mergeParams}.
*/
export function mergeParamsChecked<A extends {}, B extends {}>(a: A, b: B): Merged<A, B> {
const merged = mergeParams(a, b);
assert(
Object.keys(merged).length === Object.keys(a).length + Object.keys(b).length,
() => `Duplicate key between ${JSON.stringify(a)} and ${JSON.stringify(b)}`
);
return merged;
}
|
