-
-
Notifications
You must be signed in to change notification settings - Fork 852
/
draft.ts
335 lines (289 loc) · 6.62 KB
/
draft.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
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
import {assert, _} from "spec.ts"
import produce, {
Draft,
castDraft,
original,
enableAllPlugins
} from "../src/immer"
enableAllPlugins()
// For checking if a type is assignable to its draft type (and vice versa)
const toDraft: <T>(value: T) => Draft<T> = x => x as any
const fromDraft: <T>(draft: Draft<T>) => T = x => x as any
test("draft.ts", () => {
// Tuple
{
let val: [1, 2] = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Tuple (nested in a tuple)
{
let val: [[1, 2]] = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Tuple (nested in two mutable arrays)
{
let val: [1, 2][][] = _
let draft: typeof val = _
val = assert(toDraft(val), draft)
assert(fromDraft(draft), val)
}
// Tuple (nested in two readonly arrays)
{
let val: ReadonlyArray<ReadonlyArray<[1, 2]>> = _
let draft: [1, 2][][] = _
val = assert(toDraft(val), draft)
}
// Readonly tuple
{
// TODO: Uncomment this when readonly tuples are supported.
// More info: https://stackoverflow.com/a/53822074/2228559
// let val: Readonly<[1, 2]> = _
// let draft: [1, 2] = _
// draft = assert(toDraft(val), draft)
// val = fromDraft(draft)
}
// Mutable array
{
let val: string[] = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Mutable array (nested in tuple)
{
let val: [string[]] = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Readonly array
{
let val: ReadonlyArray<string> = _
let draft: string[] = _
val = assert(toDraft(val), draft)
fromDraft(draft)
}
// Readonly array (nested in readonly object)
{
let val: {readonly a: ReadonlyArray<string>} = _
let draft: {a: string[]} = _
val = assert(toDraft(val), draft)
fromDraft(draft)
}
// Mutable object
{
let val: {a: 1} = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Mutable object (nested in mutable object)
{
let val: {a: {b: 1}} = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Interface
{
interface Foo {
a: {b: number}
}
let val: Foo = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Interface (nested in interface)
{
interface Foo {
a: {b: number}
}
interface Bar {
foo: Foo
}
let val: Bar = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Readonly object
{
let val: {readonly a: 1} = _
let draft: {a: 1} = _
val = assert(toDraft(val), draft)
}
// Readonly object (nested in tuple)
{
let val: [{readonly a: 1}] = _
let draft: [{a: 1}] = _
val = assert(toDraft(val), draft)
}
// Loose function
{
let val: Function = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Strict function
{
let val: () => void = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Class type (mutable)
{
class Foo {
private test: any
constructor(public bar: string) {}
}
let val: Foo = _
// TODO: Uncomment this when plain object types can be distinguished from class types.
// More info here: https://github.com/Microsoft/TypeScript/issues/29063
// assert(toDraft(val), val)
// assert(fromDraft(toDraft(val)), val)
}
// Class type (readonly)
{
class Foo {
private test: any
constructor(readonly bar: string) {}
}
let val: Foo = _
// TODO: Uncomment this when plain object types can be distinguished from class types.
// More info here: https://github.com/Microsoft/TypeScript/issues/29063
// assert(toDraft(val), val)
// assert(fromDraft(toDraft(val)), val)
}
// Map instance
{
let val: Map<any, any> = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
// Weak maps
let weak: WeakMap<any, any> = _
assert(toDraft(weak), weak)
assert(fromDraft(toDraft(weak)), weak)
}
// ReadonlyMap instance
{
let val: ReadonlyMap<any, any> = _
let draft: Map<any, any> = _
assert(toDraft(val), draft)
}
// Set instance
{
let val: Set<any> = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
// Weak sets
let weak: WeakSet<any> = _
assert(toDraft(weak), weak)
assert(fromDraft(toDraft(weak)), weak)
}
// ReadonlySet instance
{
let val: ReadonlySet<any> = _
let draft: Set<any> = _
assert(toDraft(val), draft)
}
// Promise object
{
let val: Promise<any> = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Date instance
{
let val: Date = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// RegExp instance
{
let val: RegExp = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Boxed primitive
{
let val: Boolean = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// String literal
{
let val: string = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Any
{
let val: any = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Never
{
let val: never = _ as never
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Unknown
{
let val: unknown = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Numeral
{
let val: 1 = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Union of numerals
{
let val: 1 | 2 | 3 = _
assert(toDraft(val), val)
assert(fromDraft(toDraft(val)), val)
}
// Union of tuple, array, object
{
let val: [0] | ReadonlyArray<string> | Readonly<{a: 1}> = _
let draft: [0] | string[] | {a: 1} = _
val = assert(toDraft(val), draft)
}
// Generic type
{
// NOTE: "extends any" only helps a little.
const $ = <T extends any>(val: ReadonlyArray<T>) => {
let draft: Draft<typeof val> = _
assert(toDraft(val), draft)
// $ExpectError: [ts] Argument of type 'DraftArray<T>' is not assignable to parameter of type 'Draft<T>'. [2345]
// assert(fromDraft(draft), draft)
}
}
expect(true).toBe(true)
})
test("castDraft", () => {
type Todo = {readonly done: boolean}
type State = {
readonly finishedTodos: ReadonlyArray<Todo>
readonly unfinishedTodos: ReadonlyArray<Todo>
}
function markAllFinished(state: State) {
produce(state, draft => {
draft.finishedTodos = castDraft(state.unfinishedTodos)
})
}
})
test("#505 original", () => {
const baseState = {users: [{name: "Richie"}] as const}
const nextState = produce(baseState, draftState => {
original(draftState.users) === baseState.users
})
})
test("castDraft preserves a value", () => {
const x = {}
expect(castDraft(x)).toBe(x)
})
test("#512 createDraft creates a draft", () => {
const x = {y: 1}
assert(x, _ as Draft<{y: number}>)
})