Skip to content

Commit e961e94

Browse files
avalleteavallete
committed
fix(types): handle many-to-many join tables references
1 parent e31b1ff commit e961e94

File tree

7 files changed

+265
-5
lines changed

7 files changed

+265
-5
lines changed

‎src/select-query-parser/utils.ts

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import {
1212

1313
export type SelectQueryError<Message extends string> = { error: true } & Message
1414

15+
type AsString<T> = T extends string ? T : ''
16+
1517
type RequireHintingSelectQueryError<
1618
DistantName extends string,
1719
RelationName extends string
@@ -413,9 +415,58 @@ type ResolveForwardRelationship<
413415
relation: FoundByMatch
414416
direction: 'forward'
415417
from: CurrentTableOrView
416-
type: 'found-my-match'
418+
type: 'found-by-match'
419+
}
420+
: // Forward relations can also alias other tables via tables joins relationships
421+
// in such cases we crawl all the tables looking for a join table between our current table
422+
// and the Field['name'] desired desitnation
423+
FindJoinTableRelationship<
424+
Schema,
425+
CurrentTableOrView,
426+
Field['name']
427+
> extends infer FoundByJoinTable extends GenericRelationship
428+
? {
429+
referencedTable: TablesAndViews<Schema>[FoundByJoinTable['referencedRelation']]
430+
relation: FoundByJoinTable & { match: 'refrel' }
431+
direction: 'forward'
432+
from: CurrentTableOrView
433+
type: 'found-by-join-table'
417434
}
418-
: SelectQueryError<'could not find the relation'>
435+
: SelectQueryError<`could not find the relation between ${AsString<CurrentTableOrView>} and ${Field['name']}`>
436+
437+
/**
438+
* Given a CurrentTableOrView, finds all join tables to this relation.
439+
* For example, if products and categories are linked via product_categories table:
440+
*
441+
* @example
442+
* Given:
443+
* - CurrentTableView = 'products'
444+
* - FieldName = "categories"
445+
*
446+
* It should return this relationship from product_categories:
447+
* {
448+
* foreignKeyName: "product_categories_category_id_fkey",
449+
* columns: ["category_id"],
450+
* isOneToOne: false,
451+
* referencedRelation: "categories",
452+
* referencedColumns: ["id"]
453+
* }
454+
*/
455+
export type FindJoinTableRelationship<
456+
Schema extends GenericSchema,
457+
CurrentTableOrView extends keyof TablesAndViews<Schema>,
458+
FieldName extends string
459+
> = {
460+
[TableName in keyof TablesAndViews<Schema>]: TablesAndViews<Schema>[TableName]['Relationships'] extends readonly (infer Rel)[]
461+
? Rel extends { referencedRelation: CurrentTableOrView }
462+
? TablesAndViews<Schema>[TableName]['Relationships'] extends readonly (infer OtherRel)[]
463+
? OtherRel extends { referencedRelation: FieldName }
464+
? OtherRel
465+
: never
466+
: never
467+
: never
468+
: never
469+
}[keyof TablesAndViews<Schema>]
419470

420471
/**
421472
* Finds a matching relationship based on the FieldNode's name and optional hint.

‎test/db/00-schema.sql

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,31 @@ FOREIGN KEY (parent_id)
7373
REFERENCES public.collections(id);
7474
COMMENT ON COLUMN public.messages.data IS 'For unstructured data and prototyping.';
7575

76+
-- MANY-TO-MANY RELATIONSHIP USING A JOIN TABLE
77+
78+
-- Create a table for products
79+
CREATE TABLE public.products (
80+
id bigint GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
81+
name text NOT NULL,
82+
description text,
83+
price decimal(10, 2) NOT NULL
84+
);
85+
86+
-- Create a table for categories
87+
CREATE TABLE public.categories (
88+
id bigint GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
89+
name text NOT NULL,
90+
description text
91+
);
92+
93+
-- Create a join table for the many-to-many relationship between products and categories
94+
CREATE TABLE public.product_categories (
95+
product_id bigint REFERENCES public.products(id) ON DELETE CASCADE,
96+
category_id bigint REFERENCES public.categories(id) ON DELETE CASCADE,
97+
PRIMARY KEY (product_id, category_id)
98+
);
99+
100+
76101
-- STORED FUNCTION
77102
CREATE FUNCTION public.get_status(name_param text)
78103
RETURNS user_status AS $$

‎test/db/01-dummy-data.sql

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,26 @@ VALUES
5858
(4, 'Grandchild', 2),
5959
(5, 'Sibling of Grandchild', 2),
6060
(6, 'Child of Another Root', 3);
61+
62+
-- Insert sample products
63+
INSERT INTO public.products (id, name, description, price)
64+
VALUES
65+
(1, 'Laptop', 'High-performance laptop', 999.99),
66+
(2, 'Smartphone', 'Latest model smartphone', 699.99),
67+
(3, 'Headphones', 'Noise-cancelling headphones', 199.99);
68+
69+
-- Insert sample categories
70+
INSERT INTO public.categories (id, name, description)
71+
VALUES
72+
(1, 'Electronics', 'Electronic devices and gadgets'),
73+
(2, 'Computers', 'Computer and computer accessories'),
74+
(3, 'Audio', 'Audio equipment');
75+
76+
-- Insert product-category relationships
77+
INSERT INTO public.product_categories (product_id, category_id)
78+
VALUES
79+
(1, 1), -- Laptop is in Electronics
80+
(1, 2), -- Laptop is also in Computers
81+
(2, 1), -- Smartphone is in Electronics
82+
(3, 1), -- Headphones are in Electronics
83+
(3, 3); -- Headphones are also in Audio

‎test/relationships.ts

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,10 @@ export const selectParams = {
181181
from: 'users',
182182
select: 'alias:missing_column.count()',
183183
},
184+
manyToManyWithJoinTable: {
185+
from: 'products',
186+
select: '*, categories(*)',
187+
},
184188
} as const
185189

186190
export const selectQueries = {
@@ -356,6 +360,9 @@ export const selectQueries = {
356360
aggregateOnMissingColumnWithAlias: postgrest
357361
.from(selectParams.aggregateOnMissingColumnWithAlias.from)
358362
.select(selectParams.aggregateOnMissingColumnWithAlias.select),
363+
manyToManyWithJoinTable: postgrest
364+
.from(selectParams.manyToManyWithJoinTable.from)
365+
.select(selectParams.manyToManyWithJoinTable.select),
359366
} as const
360367

361368
test('nested query with selective fields', async () => {
@@ -1831,3 +1838,33 @@ test('aggregate on missing column with alias', async () => {
18311838
}
18321839
`)
18331840
})
1841+
1842+
test('many-to-many with join table', async () => {
1843+
const res = await selectQueries.manyToManyWithJoinTable.eq('id', 1).single()
1844+
expect(res).toMatchInlineSnapshot(`
1845+
Object {
1846+
"count": null,
1847+
"data": Object {
1848+
"categories": Array [
1849+
Object {
1850+
"description": "Electronic devices and gadgets",
1851+
"id": 1,
1852+
"name": "Electronics",
1853+
},
1854+
Object {
1855+
"description": "Computer and computer accessories",
1856+
"id": 2,
1857+
"name": "Computers",
1858+
},
1859+
],
1860+
"description": "High-performance laptop",
1861+
"id": 1,
1862+
"name": "Laptop",
1863+
"price": 999.99,
1864+
},
1865+
"error": null,
1866+
"status": 200,
1867+
"statusText": "OK",
1868+
}
1869+
`)
1870+
})

‎test/select-query-parser/select.test-d.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -742,3 +742,21 @@ type Schema = Database['public']
742742
if (error) throw error
743743
expectType<`column 'missing_column' does not exist on 'users'.`>(data)
744744
}
745+
746+
// many-to-many with join table
747+
{
748+
const { data } = await selectQueries.manyToManyWithJoinTable.limit(1).single()
749+
let result: Exclude<typeof data, null>
750+
let expected: {
751+
id: number
752+
name: string
753+
description: string | null
754+
price: number
755+
categories: {
756+
id: number
757+
name: string
758+
description: string | null
759+
}[]
760+
}
761+
expectType<TypeEqual<typeof result, typeof expected>>(true)
762+
}

‎test/select-query-parser/types.test-d.ts

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { TypeEqual } from 'ts-expect'
1010
import {
1111
FindMatchingTableRelationships,
1212
IsRelationNullable,
13+
FindJoinTableRelationship,
1314
} from '../../src/select-query-parser/utils'
1415
import { Json } from '../../src/select-query-parser/types'
1516
import { ParseQuery } from '../../src/select-query-parser/parser'
@@ -124,11 +125,8 @@ import { ParseQuery } from '../../src/select-query-parser/parser'
124125
type Row = Schema['Tables'][RelationName]['Row']
125126
type Relationships = Schema['Tables'][RelationName]['Relationships']
126127
type ParsedQuery = ParseQuery<typeof select>
127-
// First field of the query is username and is properly parsed
128-
type f1 = ParsedQuery[0]
129128
type r1 = ProcessNode<Schema, Row, RelationName, Relationships, ParsedQuery[0]>
130129
expectType<TypeEqual<r1, { username: string }>>(true)
131-
type f2 = ParsedQuery[1]
132130
type r2 = ProcessNodes<Schema, Row, RelationName, Relationships, ParsedQuery>
133131
// fail because result for messages is ({id: string} | {message: string | null })[]
134132
expectType<
@@ -160,3 +158,42 @@ import { ParseQuery } from '../../src/select-query-parser/parser'
160158
type r2 = ProcessNodes<Schema, Row, RelationName, Relationships, ParsedQuery>
161159
expectType<r2>(expected!)
162160
}
161+
162+
{
163+
type Schema = Database['public']
164+
type CurrentTableOrView = 'products'
165+
type FieldName = 'categories'
166+
type R = FindJoinTableRelationship<Schema, CurrentTableOrView, FieldName>
167+
let expected: {
168+
foreignKeyName: 'product_categories_category_id_fkey'
169+
columns: ['category_id']
170+
isOneToOne: false
171+
referencedRelation: 'categories'
172+
referencedColumns: ['id']
173+
}
174+
expectType<R>(expected!)
175+
}
176+
177+
{
178+
type Schema = Database['public']
179+
type CurrentTableOrView = 'categories'
180+
type FieldName = 'products'
181+
type R = FindJoinTableRelationship<Schema, CurrentTableOrView, FieldName>
182+
let expected: {
183+
foreignKeyName: 'product_categories_product_id_fkey'
184+
columns: ['product_id']
185+
isOneToOne: false
186+
referencedRelation: 'products'
187+
referencedColumns: ['id']
188+
}
189+
expectType<R>(expected!)
190+
}
191+
192+
{
193+
type Schema = Database['public']
194+
type CurrentTableOrView = 'categories'
195+
type FieldName = 'missing'
196+
type R = FindJoinTableRelationship<Schema, CurrentTableOrView, FieldName>
197+
let expected: never
198+
expectType<R>(expected!)
199+
}

‎test/types.ts

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,75 @@ export type Database = {
250250
}
251251
]
252252
}
253+
product_categories: {
254+
Row: {
255+
category_id: number
256+
product_id: number
257+
}
258+
Insert: {
259+
category_id: number
260+
product_id: number
261+
}
262+
Update: {
263+
category_id?: number
264+
product_id?: number
265+
}
266+
Relationships: [
267+
{
268+
foreignKeyName: 'product_categories_category_id_fkey'
269+
columns: ['category_id']
270+
isOneToOne: false
271+
referencedRelation: 'categories'
272+
referencedColumns: ['id']
273+
},
274+
{
275+
foreignKeyName: 'product_categories_product_id_fkey'
276+
columns: ['product_id']
277+
isOneToOne: false
278+
referencedRelation: 'products'
279+
referencedColumns: ['id']
280+
}
281+
]
282+
}
283+
products: {
284+
Row: {
285+
description: string | null
286+
id: number
287+
name: string
288+
price: number
289+
}
290+
Insert: {
291+
description?: string | null
292+
id?: number
293+
name: string
294+
price: number
295+
}
296+
Update: {
297+
description?: string | null
298+
id?: number
299+
name?: string
300+
price?: number
301+
}
302+
Relationships: []
303+
}
304+
categories: {
305+
Row: {
306+
description: string | null
307+
id: number
308+
name: string
309+
}
310+
Insert: {
311+
description?: string | null
312+
id?: number
313+
name: string
314+
}
315+
Update: {
316+
description?: string | null
317+
id?: number
318+
name?: string
319+
}
320+
Relationships: []
321+
}
253322
shops: {
254323
Row: {
255324
address: string | null

0 commit comments

Comments
 (0)