feat: shoehorn CLI-mode

Used for docs export & typegen.

Probably need to move it to `src/cli` in the future, but works well
enough for now.

Author: soedirgo

package.json

@@ -19,7 +19,8 @@
     "build:main": "tsc -p tsconfig.json && cpy 'src/lib/sql/*.sql' dist/main/sql",
     "build:module": "tsc -p tsconfig.module.json && cpy 'src/lib/sql/*.sql' dist/module/sql",
     "build:server": "tsc -p tsconfig.server.json && cpy 'src/lib/sql/*.sql' bin/src/lib/sql",
-    "docs:export": "PG_META_EXPORT_DOCS=true ts-node-dev src/server/app.ts",
+    "docs:export": "ts-node-dev --quiet src/server/app.ts docs export > openapi.json",
+    "gen:types:typescript": "ts-node-dev --quiet src/server/app.ts gen types typescript",
     "start": "NODE_ENV=production node bin/src/server/app.js",
     "dev": "trap 'npm run db:clean' INT && run-s db:clean db:run && NODE_ENV=development ts-node-dev src/server/app.ts | pino-pretty --colorize",
     "pkg": "run-s clean build:server && pkg --out-path bin .pkg.config.json",

src/server/app.ts

@@ -1,6 +1,16 @@
 import fastify from 'fastify'
-import { PG_META_EXPORT_DOCS, PG_META_PORT, PG_META_REQ_HEADER } from './constants'
+import { PostgresMeta } from '../lib'
+import {
+  DEFAULT_POOL_CONFIG,
+  EXPORT_DOCS,
+  GENERATE_TYPES,
+  GENERATE_TYPES_EXCLUDED_SCHEMAS,
+  PG_CONNECTION,
+  PG_META_PORT,
+  PG_META_REQ_HEADER,
+} from './constants'
 import routes from './routes'
+import { apply as applyTypescriptTemplate } from './templates/typescript'
 import { extractRequestForLogging } from './utils'
 import pino from 'pino'
 import pkg from '../../package.json'
@@ -31,7 +41,7 @@ app.setNotFoundHandler((request, reply) => {
   reply.code(404).send({ error: 'Not found' })
 })
 
-if (PG_META_EXPORT_DOCS) {
+if (EXPORT_DOCS) {
   app.register(require('fastify-swagger'), {
     openapi: {
       servers: [],
@@ -44,16 +54,45 @@ if (PG_META_EXPORT_DOCS) {
   })
 
   app.ready(() => {
-    require('fs').writeFileSync(
-      'openapi.json',
-      JSON.stringify(
-        // @ts-ignore: app.swagger() is a Fastify decorator, so doesn't show up in the types
-        app.swagger(),
-        null,
-        2
-      ) + '\n'
-    )
+    // @ts-ignore: app.swagger() is a Fastify decorator, so doesn't show up in the types
+    console.log(JSON.stringify(app.swagger(), null, 2))
   })
+} else if (GENERATE_TYPES === 'typescript') {
+  ;(async () => {
+    const pgMeta: PostgresMeta = new PostgresMeta({
+      ...DEFAULT_POOL_CONFIG,
+      connectionString: PG_CONNECTION,
+    })
+    const { data: schemas, error: schemasError } = await pgMeta.schemas.list()
+    const { data: tables, error: tablesError } = await pgMeta.tables.list()
+    const { data: functions, error: functionsError } = await pgMeta.functions.list()
+    const { data: types, error: typesError } = await pgMeta.types.list({
+      includeSystemSchemas: true,
+    })
+    await pgMeta.end()
+
+    if (schemasError) {
+      throw schemasError
+    }
+    if (tablesError) {
+      throw schemasError
+    }
+    if (functionsError) {
+      throw schemasError
+    }
+    if (typesError) {
+      throw typesError
+    }
+
+    console.log(
+      applyTypescriptTemplate({
+        schemas: schemas.filter(({ name }) => !GENERATE_TYPES_EXCLUDED_SCHEMAS.includes(name)),
+        tables,
+        functions,
+        types,
+      })
+    )
+  })()
 } else {
   app.ready(() => {
     app.listen(PG_META_PORT, '0.0.0.0', () => {

src/server/constants.ts

@@ -12,7 +12,11 @@ const PG_CONN_TIMEOUT_SECS = Number(process.env.PG_CONN_TIMEOUT_SECS || 15)
 
 export const PG_CONNECTION = `postgres://${PG_META_DB_USER}:${PG_META_DB_PASSWORD}@${PG_META_DB_HOST}:${PG_META_DB_PORT}/${PG_META_DB_NAME}?sslmode=${PG_META_DB_SSL_MODE}`
 
-export const PG_META_EXPORT_DOCS = process.env.PG_META_EXPORT_DOCS === 'true' || false
+export const EXPORT_DOCS = process.argv[2] === 'docs' && process.argv[3] === 'export'
+export const GENERATE_TYPES =
+  process.argv[2] === 'gen' && process.argv[3] === 'types' ? process.argv[4] : undefined
+export const GENERATE_TYPES_EXCLUDED_SCHEMAS =
+  GENERATE_TYPES && process.argv[5] === '--exclude-schemas' ? process.argv[6]?.split(',') ?? [] : []
 
 export const DEFAULT_POOL_CONFIG = { max: 1, connectionTimeoutMillis: PG_CONN_TIMEOUT_SECS * 1000 }
 export const PG_META_REQ_HEADER = process.env.PG_META_REQ_HEADER || 'request-id'