fix: make virtual columns nullable (#480)

TomasHubelbauer · web-flow · commit f4a11e414697 · 2023-01-28T20:26:00.000+08:00
psteinroe contributed a change which adds schema functions which take only the table name as columns on the tables when generating TypeScript types.

This commit extends that to treat function return types as nullable.

The function used in `oo-init.sql` could be changed like so:

```sql
create function public.blurb(public.todos) returns text as
$$
select null;
$$ language sql stable;
```

It would still compile and be a valid function despite the unchanged return type, which means any function must be treated as potentially returning `null` in the types.

I have also updated instructions for building and testing the TypeScript type generation.
diff --git a/README.md b/README.md
@@ -100,6 +100,8 @@ To start developing, run `npm run dev`. It will set up the database with Docker
 
 If you are fixing a bug, you should create a new test case. To test your changes, add the `-u/--updateSnapshot` flag to `jest` on the `test:run` script, run `npm run test`, and then review the git diff of the snapshots. Depending on your change, you may see `id` fields being changed - this is expected and you are free to commit it, as long as it passes the CI. Don't forget to remove the `-u/--updateSnapshot` flag when committing.
 
+To make changes to the TypeScript type generation, run `npm run gen:types:typescript` while you have `npm run dev` running.
+
 ## Licence
 
 Apache 2.0
diff --git a/src/server/templates/typescript.ts b/src/server/templates/typescript.ts
@@ -90,7 +90,7 @@ export interface Database {
                               fn.return_type,
                               types,
                               schemas
-                            )}`
+                            )} | null`
                         ),
                     ]}
                   }

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ export interface Database {`
`90`	`90`	`fn.return_type,`
`91`	`91`	`types,`
`92`	`92`	`schemas`
`93`		- )}`
	`93`	+ )} \| null`
`94`	`94`	`),`
`95`	`95`	`]}`
`96`	`96`	`}`