all-in one pgkit ui (updated 22:08)

packages/admin/src/server/index.ts

@@ -1,3 +1,4 @@
+import {Transactable} from '@pgkit/client'
 import express from 'express'
 import * as path from 'path'
 import {fileURLToPath} from 'url'
@@ -13,10 +14,10 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url))
  * If you need to add more functionality, such as auth, or CORS, create your own express application
  * and add the router before (or after) your middleware.
  */
-export const getExpressRouter = (): express.RequestHandler => {
+export const getExpressRouter = (client?: Transactable | string): express.RequestHandler => {
   const router = express.Router()
   router.use(clientMiddleware)
-  router.use(apiMiddleware)
+  router.use(apiMiddleware(client))
   return router
 }
 

packages/admin/src/server/middleware.ts

@@ -1,5 +1,5 @@
 // import {createHTTPServer} from '@trpc/server'
-import {createClient} from '@pgkit/client'
+import {createClient, Transactable} from '@pgkit/client'
 import {createExpressMiddleware} from '@trpc/server/adapters/express'
 import pMemoize from 'p-memoize'
 import {appRouter} from './router.js'
@@ -8,25 +8,32 @@ const createClientMemoized = pMemoize(async (connectionString: string) => {
   return createClient(connectionString)
 })
 
-export const apiMiddleware = createExpressMiddleware({
-  router: appRouter,
-  onError: props => {
-    let error: Error = props.error
-    const loggable: unknown[] = []
-    while (error?.cause) {
-      loggable.push(`${error.stack?.split('\n')[1]} caused by 👇`)
-      error = error.cause as Error
-    }
-    loggable.push(error)
-    console.error('trpc error', loggable)
-  },
-  createContext: async ({req}) => {
-    const connectionString =
-      req.headers['connection-string']?.toString() ||
-      process.env.PG_CONNECTION_STRING ||
-      'postgres://postgres:postgres@localhost:5432/postgres'
-    return {
-      connection: await createClientMemoized(connectionString),
-    }
-  },
-})
+export const apiMiddleware = (client?: Transactable | string) => {
+  return createExpressMiddleware({
+    router: appRouter,
+    onError: props => {
+      let error: Error = props.error
+      const loggable: unknown[] = []
+      while (error?.cause) {
+        loggable.push(`${error.stack?.split('\n')[1]} caused by 👇`)
+        error = error.cause as Error
+      }
+      loggable.push(error)
+      console.error('trpc error', loggable)
+    },
+    createContext: async ({req}) => {
+      if (typeof client === 'object') {
+        return {connection: client}
+      }
+
+      const connectionString =
+        req.headers['connection-string']?.toString() ||
+        process.env.PGKIT_CONNECTION_STRING ||
+        'postgres://postgres:postgres@localhost:5432/postgres'
+
+      return {
+        connection: await createClientMemoized(connectionString),
+      }
+    },
+  })
+}

packages/migrator/src/router.ts

@@ -271,27 +271,28 @@ export const createMigratorRouter = (procedure: TRPCProcedureLike<MigratorRouter
           'Query the database. Not strictly related to migrations, but can be used for debugging. Use with caution!',
       })
       .input(
-        z.object({
-          query: z.string(),
-          singlequote: z
-            .string()
-            .describe("Character to use in place of ' - use to avoid having to do bash quote-escaping")
-            .optional(),
-          doublequote: z
-            .string()
-            .describe('Character to use in place of " - use to avoid having to do bash quote-escaping')
-            .optional(),
-          method: z
-            .enum(['any', 'many', 'one', 'maybeOne', 'query', 'anyFirst', 'oneFirst', 'maybeOneFirst'])
-            .default('any'),
-        }),
+        z.tuple([
+          z.string(),
+          z.object({
+            singlequote: z
+              .string()
+              .describe("Character to use in place of ' - use to avoid having to do bash quote-escaping")
+              .optional(),
+            doublequote: z
+              .string()
+              .describe('Character to use in place of " - use to avoid having to do bash quote-escaping')
+              .optional(),
+            method: z
+              .enum(['any', 'many', 'one', 'maybeOne', 'query', 'anyFirst', 'oneFirst', 'maybeOneFirst'])
+              .default('any'),
+          }),
+        ]),
       )
-      .mutation(async ({input, ctx}) => {
-        let query = input.query
-        if (input.singlequote) query = query.replaceAll(input.singlequote, `'`)
-        if (input.doublequote) query = query.replaceAll(input.doublequote, `"`)
+      .mutation(async ({input: [query, options], ctx}) => {
+        if (options.singlequote) query = query.replaceAll(options.singlequote, `'`)
+        if (options.doublequote) query = query.replaceAll(options.doublequote, `"`)
 
-        return ctx.migrator.client[input.method](sql.raw(query))
+        return ctx.migrator.client[options.method](sql.raw(query))
       }),
   })
 

packages/pgkit/package.json

@@ -14,25 +14,35 @@
       "types": "./dist/client.d.ts"
     }
   },
+  "bin": {
+    "pgkit": "./dist/cli.js"
+  },
   "author": "mmkal",
   "repository": {
     "type": "git",
     "url": "https://github.com/mmkal/pgkit",
     "directory": "packages/pgkit"
   },
   "scripts": {
+    "dogfood": "tsx src/cli.ts",
     "prepack": "pnpm build",
     "build": "tsc --sourceMap -p tsconfig.lib.json",
     "test": "vitest run"
   },
   "devDependencies": {
+    "@types/express": "^4.17.21",
     "@types/node": "^20.11.20",
     "eslint": "^8.57.0",
     "eslint-plugin-mmkal": "0.10.1",
     "vitest": "^1.2.2"
   },
   "dependencies": {
+    "@pgkit/admin": "workspace:^",
     "@pgkit/client": "workspace:^",
-    "importx": "^0.4.4"
+    "@pgkit/migrator": "workspace:^",
+    "@pgkit/typegen": "workspace:^",
+    "express": "^4.18.2",
+    "importx": "^0.4.4",
+    "trpc-cli": "https://pkg.pr.new/mmkal/trpc-cli@38"
   }
 }

packages/pgkit/src/cli.ts

@@ -0,0 +1,6 @@
+import * as trpcCli from 'trpc-cli'
+import {router} from './router'
+
+export const cli = trpcCli.createCli({router})
+
+void cli.run()

packages/pgkit/src/config.ts

@@ -11,7 +11,7 @@ export type Config = {
   migrator?: {
     connectionString?: string
     /** @default '${cwd}/migrations' */
-    migrationsTableName?: string
+    migrationTableName?: string
     /** @default 'migrations' */
     migrationsPath?: string
   }

packages/pgkit/src/router.ts

@@ -0,0 +1,53 @@
+import {Client, createClient} from '@pgkit/client'
+import {Migrator, createMigratorRouter} from '@pgkit/migrator'
+import {confirm} from '@pgkit/migrator/dist/cli'
+import {router as typegenRouter} from '@pgkit/typegen'
+import express from 'express'
+import * as trpcCli from 'trpc-cli'
+import {z} from 'trpc-cli'
+import {loadConfig} from './config'
+
+const t = trpcCli.trpcServer.initTRPC.meta<trpcCli.TrpcCliMeta>().create()
+
+const procedureWithClient = t.procedure.use(async ({ctx, next}) => {
+  const config = await loadConfig()
+  const client = (clientSingleton.client ||= createClient(config.client.connectionString))
+  const migrator = (clientSingleton.migrator ||= new Migrator({
+    client,
+    migrationsPath: config.migrator?.migrationsPath,
+    migrationTableName: config.migrator?.migrationTableName,
+  }))
+  return next({
+    ctx: {...ctx, client, migrator},
+  })
+})
+
+const clientSingleton = {
+  client: null as null | Client,
+  migrator: null as null | Migrator,
+}
+
+export const router = t.router({
+  migrate: createMigratorRouter(
+    procedureWithClient.use(async ({ctx, next}) => {
+      return next({ctx: {...ctx, confirm}})
+    }),
+  ),
+  ...typegenRouter._def.procedures,
+  admin: procedureWithClient
+    .input(
+      z.object({
+        port: z.number().default(7002),
+      }),
+    )
+    .mutation(async ({input, ctx}) => {
+      const {getExpressRouter} = await import('@pgkit/admin')
+      const app = express()
+      app.use(getExpressRouter(ctx.client))
+      app.listen(input.port, () => {
+        // eslint-disable-next-line no-console
+        console.log(`Admin UI listening on http://localhost:${input.port}`)
+      })
+      return new Promise(_r => {})
+    }),
+})

packages/pgkit/tsconfig.lib.json

@@ -1,15 +1,13 @@
 {
-  "extends": [
-    "./tsconfig.json"
-  ],
-  "include": [
-    "src"
-  ],
-  "compilerOptions": {
-    "outDir": "dist",
-    "declaration": true,
-    "sourceMap": true,
-    "noEmit": false,
-    "module": "Node16"
-  }
+    "extends": ["./tsconfig.json"],
+    "include": ["src"],
+    "compilerOptions": {
+        "outDir": "dist",
+        "declaration": true,
+        "declarationMap": true,
+        "sourceMap": true,
+        "noEmit": false,
+        "skipLibCheck": true,
+        "module": "Node16"
+    }
 }