Skip to content
This repository was archived by the owner on Aug 19, 2025. It is now read-only.

Commit b945789

Browse files
charliecooper45charliecooper45
authored
Merge pull request #3 from Altroleum/codegen-join-tables
create hooks for join tables
2 parents fdbdcf8 + b94e553 commit b945789

File tree

6 files changed

+201
-84
lines changed

6 files changed

+201
-84
lines changed

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@backengine/codegen",
3-
"version": "1.0.15",
3+
"version": "1.0.16",
44
"description": "Generate code for Backengine projects.",
55
"bin": "build/index.js",
66
"files": [

‎src/hooks/index.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
import { fetchTables } from "../pgMeta/fetchTables";
12
import type { HookFile } from "../types";
23
import { parseTableFiles } from "./table";
4+
import { parseJoinTableFiles } from "./joinTable";
35
import { parseViewFiles } from "./view";
46

57
export const parseHookFiles = async (): Promise<HookFile[]> => {
6-
const tableFiles = await parseTableFiles();
8+
const { tables, joinTables } = await fetchTables();
9+
10+
const tableFiles = await parseTableFiles(tables);
11+
const joinTableFiles = await parseJoinTableFiles(joinTables);
712
const viewFiles = await parseViewFiles();
8-
return [...tableFiles, ...viewFiles];
13+
return [...tableFiles, ...joinTableFiles, ...viewFiles];
914
};

‎src/hooks/joinTable.ts‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
import prettier from "prettier";
2+
import comment from "../comment";
3+
import { TableResponse, TablesResponse } from "../pgMeta/fetchTables";
4+
import type { File, HookFile } from "../types";
5+
import { DIRECTORY, parseNameFormats } from "../utils";
6+
7+
const mapJoinTableToFile = async (
8+
joinTable: TableResponse
9+
): Promise<HookFile> => {
10+
const joinTableFormats = parseNameFormats(joinTable.name);
11+
12+
const tableOneFormats = parseNameFormats(
13+
joinTable.relationships.at(0)!.targetTableName
14+
);
15+
const tableTwoFormats = parseNameFormats(
16+
joinTable.relationships.at(1)!.targetTableName
17+
);
18+
19+
const tableOneFetchFunctionName = `fetch${tableTwoFormats.pascalCasePlural}For${tableOneFormats.pascalCase}`;
20+
const tableTwoFetchFunctionName = `fetch${tableOneFormats.pascalCasePlural}For${tableTwoFormats.pascalCase}`;
21+
22+
const content = `
23+
${comment}
24+
25+
import { supabase } from "../supabase";
26+
import { Database } from "../types";
27+
28+
type ${tableOneFormats.pascalCase}Row = Database["public"]["Tables"]["${tableOneFormats.name}"]["Row"]
29+
type ${tableTwoFormats.pascalCase}Row = Database["public"]["Tables"]["${tableTwoFormats.name}"]["Row"]
30+
31+
const use${joinTableFormats.pascalCasePlural} = () => {
32+
const ${tableOneFetchFunctionName} = async(id: ${tableOneFormats.pascalCase}Row["id"]) => {
33+
try {
34+
const { data, error } = await supabase
35+
.from("${tableOneFormats.name}")
36+
.select("*, ${tableTwoFormats.name}(*)")
37+
.eq("id", id);
38+
if (error) {
39+
throw error;
40+
}
41+
return data
42+
} catch (error) {
43+
console.error("Error fetching", error);
44+
}
45+
};
46+
47+
const ${tableTwoFetchFunctionName} = async(id: ${tableTwoFormats.pascalCase}Row["id"]) => {
48+
try {
49+
const { data, error } = await supabase
50+
.from("${tableTwoFormats.name}")
51+
.select("*, ${tableOneFormats.name}(*)")
52+
.eq("id", id);
53+
if (error) {
54+
throw error;
55+
}
56+
return data
57+
} catch (error) {
58+
console.error("Error fetching", error);
59+
}
60+
};
61+
62+
return { ${tableOneFetchFunctionName}, ${tableTwoFetchFunctionName} };
63+
};
64+
65+
export default use${joinTableFormats.pascalCasePlural};
66+
`;
67+
68+
const formattedContent = await prettier.format(content, {
69+
parser: "typescript",
70+
});
71+
72+
const file: File = {
73+
fileName: `use${joinTableFormats.pascalCasePlural}`,
74+
content: formattedContent,
75+
};
76+
const usage = `const { ${tableOneFetchFunctionName} } = use${joinTableFormats.pascalCasePlural}();`;
77+
78+
return {
79+
file,
80+
location: `${DIRECTORY}/hooks/${file.fileName}.ts`,
81+
type: "HOOK",
82+
entity: "TABLE",
83+
usage,
84+
};
85+
};
86+
87+
export const parseJoinTableFiles = async (
88+
joinTables: TablesResponse
89+
): Promise<HookFile[]> => {
90+
const joinTableHookPromises =
91+
joinTables.map<Promise<HookFile>>(mapJoinTableToFile);
92+
const joinTableFiles = await Promise.all(joinTableHookPromises);
93+
94+
return joinTableFiles;
95+
};

‎src/hooks/table.ts‎

Lines changed: 11 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,11 @@
1-
import axios from "axios";
21
import prettier from "prettier";
32
import comment from "../comment";
43
import type { File, HookFile } from "../types";
5-
import { DIRECTORY, log, parseNameFormats } from "../utils";
6-
7-
export type ColumnResponse = {
8-
tableId: number;
9-
schema: string;
10-
table: string;
11-
id: string;
12-
ordinalPosition: number;
13-
name: string;
14-
defaultValue: unknown;
15-
dataType: string;
16-
format: string;
17-
isIdentity: boolean;
18-
identityGeneration: "ALWAYS" | "BY DEFAULT" | null;
19-
isGenerated: boolean;
20-
isNullable: boolean;
21-
isUpdatable: boolean;
22-
isUnique: boolean;
23-
enums: string[];
24-
check: string | null;
25-
comment: string | null;
26-
};
27-
28-
export type TableResponse = {
29-
id: number;
30-
schema: string;
31-
name: string;
32-
rlsEnabled: boolean;
33-
rlsForced: boolean;
34-
replicaIdentity: "DEFAULT" | "INDEX" | "FULL" | "NOTHING";
35-
bytes: number;
36-
size: string;
37-
liveRowsEstimate: number;
38-
deadRowsEstimate: number;
39-
comment: string | null;
40-
columns?: ColumnResponse[];
41-
primaryKeys: {
42-
schema: string;
43-
tableName: string;
44-
name: string;
45-
tableId: number;
46-
}[];
47-
relationships: {
48-
id: number;
49-
constraintName: string;
50-
sourceSchema: string;
51-
sourceTableName: string;
52-
sourceColumnName: string;
53-
targetTableSchema: string;
54-
targetTableName: string;
55-
targetColumnName: string;
56-
}[];
57-
};
4+
import { DIRECTORY, parseNameFormats } from "../utils";
5+
import { TableResponse, TablesResponse } from "../pgMeta/fetchTables";
586

59-
export type TablesResponse = TableResponse[];
60-
61-
const parseTableNames = async (): Promise<string[]> => {
62-
const tablesResponse = await axios.get<TablesResponse>(
63-
`${process.env.BACKENGINE_BASE_URL}/api/v1/projects/${process.env.BACKENGINE_PROJECT_ID}/pg-meta/tables`,
64-
{
65-
headers: {
66-
Authorization: `Bearer ${process.env.BACKENGINE_API_KEY}`,
67-
Accept: "application/json",
68-
},
69-
}
70-
);
71-
log("Fetched table metadata");
72-
73-
const publicTables = tablesResponse.data
74-
.filter((table) => table.schema === "public")
75-
.filter(({ primaryKeys }) => primaryKeys.some(({ name }) => name === "id"));
76-
77-
return publicTables.map((table) => table.name);
78-
};
79-
80-
const mapTableToFile = async (tableName: string): Promise<HookFile> => {
7+
const mapTableToFile = async (table: TableResponse): Promise<HookFile> => {
8+
const { name: tableName } = table;
819
const { pascalCase, pascalCasePlural, camelCase, camelCasePlural } =
8210
parseNameFormats(tableName);
8311

@@ -190,9 +118,11 @@ const mapTableToFile = async (tableName: string): Promise<HookFile> => {
190118
};
191119
};
192120

193-
export const parseTableFiles = async (): Promise<HookFile[]> => {
194-
const tableNames = await parseTableNames();
195-
const hookPromises = tableNames.map<Promise<HookFile>>(mapTableToFile);
196-
const files = await Promise.all(hookPromises);
197-
return files;
121+
export const parseTableFiles = async (
122+
tables: TablesResponse
123+
): Promise<HookFile[]> => {
124+
const tableHookPromises = tables.map<Promise<HookFile>>(mapTableToFile);
125+
const tableFiles = await Promise.all(tableHookPromises);
126+
127+
return tableFiles;
198128
};

‎src/pgMeta/fetchTables.ts‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
import axios from "axios";
2+
import { log } from "../utils";
3+
4+
export type ColumnResponse = {
5+
tableId: number;
6+
schema: string;
7+
table: string;
8+
id: string;
9+
ordinalPosition: number;
10+
name: string;
11+
defaultValue: unknown;
12+
dataType: string;
13+
format: string;
14+
isIdentity: boolean;
15+
identityGeneration: "ALWAYS" | "BY DEFAULT" | null;
16+
isGenerated: boolean;
17+
isNullable: boolean;
18+
isUpdatable: boolean;
19+
isUnique: boolean;
20+
enums: string[];
21+
check: string | null;
22+
comment: string | null;
23+
};
24+
25+
export type TableResponse = {
26+
id: number;
27+
schema: string;
28+
name: string;
29+
rlsEnabled: boolean;
30+
rlsForced: boolean;
31+
replicaIdentity: "DEFAULT" | "INDEX" | "FULL" | "NOTHING";
32+
bytes: number;
33+
size: string;
34+
liveRowsEstimate: number;
35+
deadRowsEstimate: number;
36+
comment: string | null;
37+
columns?: ColumnResponse[];
38+
primaryKeys: {
39+
schema: string;
40+
tableName: string;
41+
name: string;
42+
tableId: number;
43+
}[];
44+
relationships: {
45+
id: number;
46+
constraintName: string;
47+
sourceSchema: string;
48+
sourceTableName: string;
49+
sourceColumnName: string;
50+
targetTableSchema: string;
51+
targetTableName: string;
52+
targetColumnName: string;
53+
}[];
54+
};
55+
56+
export type TablesResponse = TableResponse[];
57+
58+
export async function fetchTables(): Promise<{
59+
tables: TablesResponse;
60+
joinTables: TablesResponse;
61+
}> {
62+
const tablesResponse = await axios.get<TablesResponse>(
63+
`${process.env.BACKENGINE_BASE_URL}/api/v1/projects/${process.env.BACKENGINE_PROJECT_ID}/pg-meta/tables`,
64+
{
65+
headers: {
66+
Authorization: `Bearer ${process.env.BACKENGINE_API_KEY}`,
67+
Accept: "application/json",
68+
},
69+
}
70+
);
71+
log("Fetched table metadata");
72+
73+
const publicTables = tablesResponse.data.filter(
74+
(table) => table.schema === "public"
75+
);
76+
77+
const tables = publicTables.filter(({ primaryKeys }) =>
78+
primaryKeys.some(({ name }) => name === "id")
79+
);
80+
const joinTables = publicTables.filter(
81+
({ primaryKeys, relationships }) =>
82+
primaryKeys.length === 2 && relationships.length === 2
83+
);
84+
return { tables, joinTables };
85+
}

‎src/utils/index.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,14 @@ const sanitiseFormat = (format: string): string => {
3636
export const parseNameFormats = (
3737
name: string
3838
): {
39+
name: string;
3940
pascalCase: string;
4041
pascalCasePlural: string;
4142
camelCase: string;
4243
camelCasePlural: string;
4344
} => {
4445
return {
46+
name,
4547
pascalCase: sanitiseFormat(singular(toPascalCase(name))),
4648
pascalCasePlural: sanitiseFormat(plural(toPascalCase(name))),
4749
camelCase: sanitiseFormat(singular(toCamelCase(name))),

0 commit comments

Comments
 (0)