-
-
Notifications
You must be signed in to change notification settings - Fork 127
/
select-query-parser.ts
694 lines (652 loc) · 23.7 KB
/
select-query-parser.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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
// Credits to @bnjmnt4n (https://www.npmjs.com/package/postgrest-query)
// See https://github.com/PostgREST/postgrest/blob/2f91853cb1de18944a4556df09e52450b881cfb3/src/PostgREST/ApiRequest/QueryParams.hs#L282-L284
import { GenericSchema, Prettify } from './types'
type Whitespace = ' ' | '\n' | '\t'
type LowerAlphabet =
| 'a'
| 'b'
| 'c'
| 'd'
| 'e'
| 'f'
| 'g'
| 'h'
| 'i'
| 'j'
| 'k'
| 'l'
| 'm'
| 'n'
| 'o'
| 'p'
| 'q'
| 'r'
| 's'
| 't'
| 'u'
| 'v'
| 'w'
| 'x'
| 'y'
| 'z'
type Alphabet = LowerAlphabet | Uppercase<LowerAlphabet>
type Digit = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '0'
type Letter = Alphabet | Digit | '_'
type Json = string | number | boolean | null | { [key: string]: Json } | Json[]
type SingleValuePostgreSQLTypes =
| 'bool'
| 'int2'
| 'int4'
| 'int8'
| 'float4'
| 'float8'
| 'numeric'
| 'bytea'
| 'bpchar'
| 'varchar'
| 'date'
| 'text'
| 'citext'
| 'time'
| 'timetz'
| 'timestamp'
| 'timestamptz'
| 'uuid'
| 'vector'
| 'json'
| 'jsonb'
| 'void'
| 'record'
| string
type ArrayPostgreSQLTypes = `_${SingleValuePostgreSQLTypes}`
type PostgreSQLTypes = SingleValuePostgreSQLTypes | ArrayPostgreSQLTypes
type TypeScriptSingleValueTypes<T extends SingleValuePostgreSQLTypes> = T extends 'bool'
? boolean
: T extends 'int2' | 'int4' | 'int8' | 'float4' | 'float8' | 'numeric'
? number
: T extends
| 'bytea'
| 'bpchar'
| 'varchar'
| 'date'
| 'text'
| 'citext'
| 'time'
| 'timetz'
| 'timestamp'
| 'timestamptz'
| 'uuid'
| 'vector'
? string
: T extends 'json' | 'jsonb'
? Json
: T extends 'void'
? undefined
: T extends 'record'
? Record<string, unknown>
: unknown
type AggregateFunctions = 'count' | 'sum' | 'avg' | 'min' | 'max'
type StripUnderscore<T extends string> = T extends `_${infer U}` ? U : T
type TypeScriptTypes<T extends PostgreSQLTypes> = T extends ArrayPostgreSQLTypes
? TypeScriptSingleValueTypes<StripUnderscore<Extract<T, SingleValuePostgreSQLTypes>>>[]
: TypeScriptSingleValueTypes<T>
/**
* Parser errors.
*/
type ParserError<Message extends string> = { error: true } & Message
type GenericStringError = ParserError<'Received a generic string'>
export type SelectQueryError<Message extends string> = { error: true } & Message
/**
* Creates a new {@link ParserError} if the given input is not already a parser error.
*/
type CreateParserErrorIfRequired<Input, Message extends string> = Input extends ParserError<string>
? Input
: ParserError<Message>
/**
* Trims whitespace from the left of the input.
*/
type EatWhitespace<Input extends string> = string extends Input
? GenericStringError
: Input extends `${Whitespace}${infer Remainder}`
? EatWhitespace<Remainder>
: Input
/**
* Returns a boolean representing whether there is a foreign key with the given name.
*/
type HasFKey<FKeyName, Relationships> = Relationships extends [infer R]
? R extends { foreignKeyName: FKeyName }
? true
: false
: Relationships extends [infer R, ...infer Rest]
? HasFKey<FKeyName, [R]> extends true
? true
: HasFKey<FKeyName, Rest>
: false
/**
* Returns a boolean representing whether there the foreign key has a unique constraint.
*/
type HasUniqueFKey<FKeyName, Relationships> = Relationships extends [infer R]
? R extends { foreignKeyName: FKeyName; isOneToOne: true }
? true
: false
: Relationships extends [infer R, ...infer Rest]
? HasUniqueFKey<FKeyName, [R]> extends true
? true
: HasUniqueFKey<FKeyName, Rest>
: false
/**
* Returns a boolean representing whether there is a foreign key referencing
* a given relation.
*/
type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
? R extends { referencedRelation: FRelName }
? true
: false
: Relationships extends [infer R, ...infer Rest]
? HasFKeyToFRel<FRelName, [R]> extends true
? true
: HasFKeyToFRel<FRelName, Rest>
: false
type HasUniqueFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
? R extends { referencedRelation: FRelName; isOneToOne: true }
? true
: false
: Relationships extends [infer R, ...infer Rest]
? HasUniqueFKeyToFRel<FRelName, [R]> extends true
? true
: HasUniqueFKeyToFRel<FRelName, Rest>
: false
/**
* Constructs a type definition for a single field of an object.
*
* @param Schema Database schema.
* @param Row Type of a row in the given table.
* @param Relationships Relationships between different tables in the database.
* @param Field Single field parsed by `ParseQuery`.
*/
type ConstructFieldDefinition<
Schema extends GenericSchema,
Row extends Record<string, unknown>,
RelationName,
Relationships,
Field
> = Field extends { star: true }
? Row
: Field extends { spread: true; original: string; children: unknown[] }
? GetResultHelper<
Schema,
(Schema['Tables'] & Schema['Views'])[Field['original']]['Row'],
Field['original'],
(Schema['Tables'] & Schema['Views'])[Field['original']] extends { Relationships: infer R }
? R
: unknown,
Field['children'],
unknown
>
: Field extends { children: [] }
? {}
: Field extends { name: string; original: string; hint: string; children: unknown[] }
? {
[_ in Field['name']]: GetResultHelper<
Schema,
(Schema['Tables'] & Schema['Views'])[Field['original']]['Row'],
Field['original'],
(Schema['Tables'] & Schema['Views'])[Field['original']] extends { Relationships: infer R }
? R
: unknown,
Field['children'],
unknown
> extends infer Child
? // One-to-one relationship - referencing column(s) has unique/pkey constraint.
HasUniqueFKey<
Field['hint'],
(Schema['Tables'] & Schema['Views'])[Field['original']] extends {
Relationships: infer R
}
? R
: unknown
> extends true
? Field extends { inner: true }
? Child
: Child | null
: Relationships extends unknown[]
? HasFKey<Field['hint'], Relationships> extends true
? Field extends { inner: true }
? Child
: Child | null
: Child[]
: Child[]
: never
}
: Field extends { name: string; original: string; children: unknown[] }
? {
[_ in Field['name']]: GetResultHelper<
Schema,
(Schema['Tables'] & Schema['Views'])[Field['original']]['Row'],
Field['original'],
(Schema['Tables'] & Schema['Views'])[Field['original']] extends { Relationships: infer R }
? R
: unknown,
Field['children'],
unknown
> extends infer Child
? // One-to-one relationship - referencing column(s) has unique/pkey constraint.
HasUniqueFKeyToFRel<
RelationName,
(Schema['Tables'] & Schema['Views'])[Field['original']] extends {
Relationships: infer R
}
? R
: unknown
> extends true
? Field extends { inner: true }
? Child
: Child | null
: Relationships extends unknown[]
? HasFKeyToFRel<Field['original'], Relationships> extends true
? Field extends { inner: true }
? Child
: Child | null
: Child[]
: Child[]
: never
}
: Field extends { name: string; type: infer T }
? { [K in Field['name']]: T }
: Field extends { name: string; original: string }
? Field['original'] extends keyof Row
? { [K in Field['name']]: Row[Field['original']] }
: Field['original'] extends 'count'
? { count: number }
: SelectQueryError<`Referencing missing column \`${Field['original']}\``>
: Record<string, unknown>
/**
* Notes: all `Parse*` types assume that their input strings have their whitespace
* removed. They return tuples of ["Return Value", "Remainder of text"] or
* a `ParserError`.
*/
/**
* Reads a consecutive sequence of 1 or more letter, where letters are `[0-9a-zA-Z_]`.
*/
type ReadLetters<Input extends string> = string extends Input
? GenericStringError
: ReadLettersHelper<Input, ''> extends [`${infer Letters}`, `${infer Remainder}`]
? Letters extends ''
? ParserError<`Expected letter at \`${Input}\``>
: [Letters, Remainder]
: ReadLettersHelper<Input, ''>
type ReadLettersHelper<Input extends string, Acc extends string> = string extends Input
? GenericStringError
: Input extends `${infer L}${infer Remainder}`
? L extends Letter
? ReadLettersHelper<Remainder, `${Acc}${L}`>
: [Acc, Input]
: [Acc, '']
/**
* Reads a consecutive sequence of 1 or more double-quoted letters,
* where letters are `[^"]`.
*/
type ReadQuotedLetters<Input extends string> = string extends Input
? GenericStringError
: Input extends `"${infer Remainder}`
? ReadQuotedLettersHelper<Remainder, ''> extends [`${infer Letters}`, `${infer Remainder}`]
? Letters extends ''
? ParserError<`Expected string at \`${Remainder}\``>
: [Letters, Remainder]
: ReadQuotedLettersHelper<Remainder, ''>
: ParserError<`Not a double-quoted string at \`${Input}\``>
type ReadQuotedLettersHelper<Input extends string, Acc extends string> = string extends Input
? GenericStringError
: Input extends `${infer L}${infer Remainder}`
? L extends '"'
? [Acc, Remainder]
: ReadQuotedLettersHelper<Remainder, `${Acc}${L}`>
: ParserError<`Missing closing double-quote in \`"${Acc}${Input}\``>
/**
* Parses a (possibly double-quoted) identifier.
* Identifiers are sequences of 1 or more letters.
*/
type ParseIdentifier<Input extends string> = ReadLetters<Input> extends [
infer Name,
`${infer Remainder}`
]
? [Name, `${Remainder}`]
: ReadQuotedLetters<Input> extends [infer Name, `${infer Remainder}`]
? [Name, `${Remainder}`]
: ParserError<`No (possibly double-quoted) identifier at \`${Input}\``>
/**
* Parses a field without preceding field renaming.
* A field is one of the following:
* - a field with an embedded resource
* - `field(nodes)`
* - `field!hint(nodes)`
* - `field!inner(nodes)`
* - `field!hint!inner(nodes)`
* - a field without an embedded resource (see {@link ParseFieldWithoutEmbeddedResource})
*/
type ParseField<Input extends string> = Input extends ''
? ParserError<'Empty string'>
: ParseIdentifier<Input> extends [infer Name, `${infer Remainder}`]
? EatWhitespace<Remainder> extends `!inner${infer Remainder}`
? ParseEmbeddedResource<EatWhitespace<Remainder>> extends [infer Fields, `${infer Remainder}`]
? // `field!inner(nodes)`
[{ name: Name; original: Name; children: Fields; inner: true }, EatWhitespace<Remainder>]
: CreateParserErrorIfRequired<
ParseEmbeddedResource<EatWhitespace<Remainder>>,
'Expected embedded resource after `!inner`'
>
: EatWhitespace<Remainder> extends `!${infer Remainder}`
? ParseIdentifier<EatWhitespace<Remainder>> extends [infer Hint, `${infer Remainder}`]
? EatWhitespace<Remainder> extends `!inner${infer Remainder}`
? ParseEmbeddedResource<EatWhitespace<Remainder>> extends [
infer Fields,
`${infer Remainder}`
]
? // `field!hint!inner(nodes)`
[
{ name: Name; original: Name; hint: Hint; children: Fields; inner: true },
EatWhitespace<Remainder>
]
: CreateParserErrorIfRequired<
ParseEmbeddedResource<EatWhitespace<Remainder>>,
'Expected embedded resource after `!inner`'
>
: ParseEmbeddedResource<EatWhitespace<Remainder>> extends [
infer Fields,
`${infer Remainder}`
]
? // `field!hint(nodes)`
[{ name: Name; original: Name; hint: Hint; children: Fields }, EatWhitespace<Remainder>]
: CreateParserErrorIfRequired<
ParseEmbeddedResource<EatWhitespace<Remainder>>,
'Expected embedded resource after `!hint`'
>
: ParserError<'Expected identifier after `!`'>
: ParseEmbeddedResource<EatWhitespace<Remainder>> extends [infer Fields, `${infer Remainder}`]
? // `field(nodes)`
[{ name: Name; original: Name; children: Fields }, EatWhitespace<Remainder>]
: ParseEmbeddedResource<EatWhitespace<Remainder>> extends ParserError<string>
? // Return error if start of embedded resource was detected but not found.
ParseEmbeddedResource<EatWhitespace<Remainder>>
: // Otherwise try to match a field without embedded resource.
ParseFieldWithoutEmbeddedResource<Input>
: ParserError<`Expected identifier at \`${Input}\``>
/**
* Parses a field excluding embedded resources, without preceding field renaming.
* This is one of the following:
* - `field`
* - `field.aggregate()`
* - `field.aggregate()::type`
* - `field::type`
* - `field::type.aggregate()`
* - `field::type.aggregate()::type`
* - `field->json...`
* - `field->json.aggregate()`
* - `field->json.aggregate()::type`
* - `field->json::type`
* - `field->json::type.aggregate()`
* - `field->json::type.aggregate()::type`
*/
type ParseFieldWithoutEmbeddedResource<Input extends string> =
ParseFieldWithoutEmbeddedResourceAndAggregation<Input> extends [infer Field, `${infer Remainder}`]
? ParseFieldAggregation<EatWhitespace<Remainder>> extends [
`${infer AggregateFunction}`,
`${infer Remainder}`
]
? ParseFieldTypeCast<EatWhitespace<Remainder>> extends [infer Type, `${infer Remainder}`]
? // `field.aggregate()::type`
[
Omit<Field, 'name' | 'original' | 'type'> & {
name: AggregateFunction
original: AggregateFunction
type: Type
},
EatWhitespace<Remainder>
]
: ParseFieldTypeCast<EatWhitespace<Remainder>> extends ParserError<string>
? ParseFieldTypeCast<EatWhitespace<Remainder>>
: // `field.aggregate()`
[
Omit<Field, 'name' | 'original'> & {
name: AggregateFunction
original: AggregateFunction
},
EatWhitespace<Remainder>
]
: ParseFieldAggregation<EatWhitespace<Remainder>> extends ParserError<string>
? ParseFieldAggregation<EatWhitespace<Remainder>>
: // `field`
[Field, EatWhitespace<Remainder>]
: CreateParserErrorIfRequired<
ParseFieldWithoutEmbeddedResourceAndAggregation<Input>,
`Expected field at \`${Input}\``
>
/**
* Parses a field excluding embedded resources or aggregation, without preceding field renaming.
* This is one of the following:
* - `field`
* - `field::type`
* - `field->json...`
* - `field->json...::type`
*/
type ParseFieldWithoutEmbeddedResourceAndAggregation<Input extends string> =
ParseFieldWithoutEmbeddedResourceAndTypeCast<Input> extends [infer Field, `${infer Remainder}`]
? ParseFieldTypeCast<EatWhitespace<Remainder>> extends [infer Type, `${infer Remainder}`]
? // `field::type` or `field->json...::type`
[Omit<Field, 'type'> & { type: Type }, EatWhitespace<Remainder>]
: ParseFieldTypeCast<EatWhitespace<Remainder>> extends ParserError<string>
? ParseFieldTypeCast<EatWhitespace<Remainder>>
: // `field` or `field->json...`
[Field, EatWhitespace<Remainder>]
: CreateParserErrorIfRequired<
ParseFieldWithoutEmbeddedResourceAndTypeCast<Input>,
`Expected field at \`${Input}\``
>
/**
* Parses a field excluding embedded resources or typecasting, without preceding field renaming.
* This is one of the following:
* - `field`
* - `field->json...`
*/
type ParseFieldWithoutEmbeddedResourceAndTypeCast<Input extends string> =
ParseIdentifier<Input> extends [infer Name, `${infer Remainder}`]
? ParseJsonAccessor<EatWhitespace<Remainder>> extends [
infer PropertyName,
infer PropertyType,
`${infer Remainder}`
]
? // `field->json...`
[
{ name: PropertyName; original: PropertyName; type: PropertyType },
EatWhitespace<Remainder>
]
: // `field`
[{ name: Name; original: Name }, EatWhitespace<Remainder>]
: ParserError<`Expected field at \`${Input}\``>
/**
* Parses a field typecast (`::type`), returning a tuple of ["Type", "Remainder of text"]
* or the original string input indicating that no typecast was found.
*/
type ParseFieldTypeCast<Input extends string> = EatWhitespace<Input> extends `::${infer Remainder}`
? ParseIdentifier<EatWhitespace<Remainder>> extends [`${infer CastType}`, `${infer Remainder}`]
? // Ensure that `CastType` is a valid type.
CastType extends PostgreSQLTypes
? [TypeScriptTypes<CastType>, EatWhitespace<Remainder>]
: ParserError<`Invalid type for \`::\` operator \`${CastType}\``>
: ParserError<`Invalid type for \`::\` operator at \`${Remainder}\``>
: Input
/**
* Parses a field aggregation (`.max()`), returning a tuple of ["Aggregate function", "Remainder of text"]
* or the original string input indicating that no aggregation was found.
*/
type ParseFieldAggregation<Input extends string> =
EatWhitespace<Input> extends `.${infer Remainder}`
? ParseIdentifier<EatWhitespace<Remainder>> extends [
`${infer FunctionName}`,
`${infer Remainder}`
]
? // Ensure that aggregation function is valid.
FunctionName extends AggregateFunctions
? EatWhitespace<Remainder> extends `()${infer Remainder}`
? [FunctionName, EatWhitespace<Remainder>]
: ParserError<`Expected \`()\` after \`.\` operator \`${FunctionName}\``>
: ParserError<`Invalid type for \`.\` operator \`${FunctionName}\``>
: ParserError<`Invalid type for \`.\` operator at \`${Remainder}\``>
: Input
/**
* Parses a node.
* A node is one of the following:
* - `*`
* - a field, as defined above
* - a renamed field, `renamed_field:field`
* - a spread field, `...field`
*/
type ParseNode<Input extends string> = Input extends ''
? ParserError<'Empty string'>
: // `*`
Input extends `*${infer Remainder}`
? [{ star: true }, EatWhitespace<Remainder>]
: // `...field`
Input extends `...${infer Remainder}`
? ParseField<EatWhitespace<Remainder>> extends [infer Field, `${infer Remainder}`]
? Field extends { children: unknown[] }
? [Prettify<{ spread: true } & Field>, EatWhitespace<Remainder>]
: ParserError<'Unable to parse spread resource'>
: ParserError<'Unable to parse spread resource'>
: ParseIdentifier<Input> extends [infer Name, `${infer Remainder}`]
? EatWhitespace<Remainder> extends `::${infer _Remainder}`
? // `field::`
// Special case to detect type-casting before renaming.
ParseField<Input>
: EatWhitespace<Remainder> extends `:${infer Remainder}`
? // `renamed_field:`
ParseField<EatWhitespace<Remainder>> extends [infer Field, `${infer Remainder}`]
? Field extends { name: string }
? [Prettify<Omit<Field, 'name'> & { name: Name }>, EatWhitespace<Remainder>]
: ParserError<`Unable to parse renamed field`>
: ParserError<`Unable to parse renamed field`>
: // Otherwise, just parse it as a field without renaming.
ParseField<Input>
: ParserError<`Expected identifier at \`${Input}\``>
/**
* Parses a JSON property accessor of the shape `->a->b->c`. The last accessor in
* the series may convert to text by using the ->> operator instead of ->.
*
* Returns a tuple of ["Last property name", "Last property type", "Remainder of text"]
* or the original string input indicating that no opening `->` was found.
*/
type ParseJsonAccessor<Input extends string> = Input extends `->${infer Remainder}`
? Remainder extends `>${infer Remainder}`
? ParseIdentifier<Remainder> extends [infer Name, `${infer Remainder}`]
? [Name, string, EatWhitespace<Remainder>]
: ParserError<'Expected property name after `->>`'>
: ParseIdentifier<Remainder> extends [infer Name, `${infer Remainder}`]
? ParseJsonAccessor<Remainder> extends [
infer PropertyName,
infer PropertyType,
`${infer Remainder}`
]
? [PropertyName, PropertyType, EatWhitespace<Remainder>]
: [Name, Json, EatWhitespace<Remainder>]
: ParserError<'Expected property name after `->`'>
: Input
/**
* Parses an embedded resource, which is an opening `(`, followed by a sequence of
* 0 or more nodes separated by `,`, then a closing `)`.
*
* Returns a tuple of ["Parsed fields", "Remainder of text"], an error,
* or the original string input indicating that no opening `(` was found.
*/
type ParseEmbeddedResource<Input extends string> = Input extends `(${infer Remainder}`
? ParseNodes<EatWhitespace<Remainder>> extends [infer Fields, `${infer Remainder}`]
? EatWhitespace<Remainder> extends `)${infer Remainder}`
? [Fields, EatWhitespace<Remainder>]
: ParserError<`Expected ")"`>
: // If no nodes were detected, check for `)` for empty embedded resources `()`.
ParseNodes<EatWhitespace<Remainder>> extends ParserError<string>
? EatWhitespace<Remainder> extends `)${infer Remainder}`
? [[], EatWhitespace<Remainder>]
: ParseNodes<EatWhitespace<Remainder>>
: ParserError<'Expected embedded resource fields or `)`'>
: Input
/**
* Parses a sequence of nodes, separated by `,`.
*
* Returns a tuple of ["Parsed fields", "Remainder of text"] or an error.
*/
type ParseNodes<Input extends string> = string extends Input
? GenericStringError
: ParseNodesHelper<Input, []>
type ParseNodesHelper<Input extends string, Fields extends unknown[]> = ParseNode<Input> extends [
infer Field,
`${infer Remainder}`
]
? EatWhitespace<Remainder> extends `,${infer Remainder}`
? ParseNodesHelper<EatWhitespace<Remainder>, [Field, ...Fields]>
: [[Field, ...Fields], EatWhitespace<Remainder>]
: ParseNode<Input>
/**
* Parses a query.
* A query is a sequence of nodes, separated by `,`, ensuring that there is
* no remaining input after all nodes have been parsed.
*
* Returns an array of parsed nodes, or an error.
*/
type ParseQuery<Query extends string> = string extends Query
? GenericStringError
: ParseNodes<EatWhitespace<Query>> extends [infer Fields, `${infer Remainder}`]
? EatWhitespace<Remainder> extends ''
? Fields
: ParserError<`Unexpected input: ${Remainder}`>
: ParseNodes<EatWhitespace<Query>>
type GetResultHelper<
Schema extends GenericSchema,
Row extends Record<string, unknown>,
RelationName,
Relationships,
Fields extends unknown[],
Acc
> = Fields extends [infer R]
? ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> extends SelectQueryError<
infer E
>
? SelectQueryError<E>
: GetResultHelper<
Schema,
Row,
RelationName,
Relationships,
[],
ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> & Acc
>
: Fields extends [infer R, ...infer Rest]
? ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> extends SelectQueryError<
infer E
>
? SelectQueryError<E>
: GetResultHelper<
Schema,
Row,
RelationName,
Relationships,
Rest,
ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> & Acc
>
: Prettify<Acc>
/**
* Constructs a type definition for an object based on a given PostgREST query.
*
* @param Schema Database schema.
* @param Row Type of a row in the given table.
* @param Relationships Relationships between different tables in the database.
* @param Query Select query string literal to parse.
*/
export type GetResult<
Schema extends GenericSchema,
Row extends Record<string, unknown>,
RelationName,
Relationships,
Query extends string
> = ParseQuery<Query> extends unknown[]
? GetResultHelper<Schema, Row, RelationName, Relationships, ParseQuery<Query>, unknown>
: ParseQuery<Query>