v0feat: added ability to type return of useClientDb based on db name

Author: alanscodelog

README.md

@@ -89,8 +89,6 @@ export {}
 
 
 export default defineNitroPlugin((nitroApp) => {
-
-	// the module auto types the $postgres key (you can change the key name with the eventContextKeyName option)
 	nitroApp.hooks.hook("request", event => {
 		event.context.$postgres = postgres
 	})
@@ -195,6 +193,22 @@ if (import.meta.client) {
 const db = useClientDb("client")
 ```
 
+The local database is not completely typed (with a schema). To properly type it you will need to add in some global type file:
+
+```ts
+import * as schema from "~~/db/client-schema.ts"
+declare module "#witchcraft/nuxt-postgres/types.js" {
+	export interface Register {
+		ExtendedLocalPgDbTypes: {
+			"client": typeof schema
+		}
+	}
+}
+export {}
+
+
+```
+
 There are several things to keep in mind when using the client side db:
 
 - While the resolved migrationJson location is added to the public runtime config, it cannot be used to import it dynamically since dynamic imports don't work with variables.

src/module.ts

@@ -3,7 +3,6 @@ import type { PGliteOptions } from "@electric-sql/pglite"
 import {
 	addImportsDir,
 	addServerScanDir,
-	addTypeTemplate,
 	createResolver,
 	defineNuxtModule,
 	resolveAlias,
@@ -302,6 +301,7 @@ export default defineNuxtModule<ModuleOptions>({
 		if (options.aliasServerImport) {
 			nuxt.options.alias["#postgres"] = resolveAlias(options.aliasServerImport, nuxt.options.alias)
 		}
+		nuxt.options.alias["#witchcraft-nuxt-postgres"] = resolve("runtime")
 
 		nuxt.hook("vite:extendConfig", config => {
 			// https:// pglite.dev/docs/bundler-support#vite

src/runtime/composables/useClientDb.ts

@@ -3,8 +3,18 @@ import type { PgliteDatabase } from "drizzle-orm/pglite"
 
 import { useGlobalClientDatabaseManager } from "./useGlobalClientDatabaseManager.js"
 
-import type { ClientDatabaseManager } from "../utils/clientDatabaseManager.js"
+import type { LocalPgDbTypes } from "../types.js"
+import type { AllOptions, InitOptions } from "../utils/clientDatabaseManager.js"
 
-export async function useClientDb(...args: Parameters<ClientDatabaseManager["useClientDb"]>): Promise<PgliteDatabase | PgRemoteDatabase> {
-	return useGlobalClientDatabaseManager().useClientDb(...args)
+export async function useClientDb<
+	TName extends keyof LocalPgDbTypes | string,
+	TDb extends TName extends keyof LocalPgDbTypes ? LocalPgDbTypes[TName] : (PgliteDatabase | PgRemoteDatabase)
+>(
+	name: TName | undefined,
+	opts?: AllOptions, // do not define this or init will break
+	initOpts: InitOptions = {}
+):
+Promise<TDb> {
+	return useGlobalClientDatabaseManager().useClientDb(name, opts, initOpts) as any
 }
+

src/runtime/types.ts

@@ -0,0 +1,8 @@
+export interface Register {
+}
+
+export type LocalPgDbTypes = Register extends {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	ExtendedLocalPgDbTypes: infer T extends Record<string, Record<string, any>>
+} ? T : unknown
+

src/runtime/utils/clientDatabaseManager.ts

@@ -11,6 +11,8 @@ import localStorageDriver from "unstorage/drivers/localstorage"
 import { z } from "zod"
 
 import type { ClientPostgresOptions } from "../../module.js"
+import type { LocalPgDbTypes } from "../types.js"
+
 
 export const zMigrationJson = z.array(z.object({
 	sql: z.array(z.string()),
@@ -56,7 +58,7 @@ export type ClientMigrationState = {
 	skip: boolean
 	storage?: Storage<any>
 }
-type AllOptions = Partial<Omit<ClientPostgresOptions, "clientMigrationConfig"> & {
+export type AllOptions = Partial<Omit<ClientPostgresOptions, "clientMigrationConfig"> & {
 	clientMigrationOptions: MigrationOptions
 	clientPgliteOptions: ClientPostgresOptions["clientPgliteOptions"] & {
 		extensions?: PGliteOptions["extensions"]
@@ -72,7 +74,7 @@ type AllOptions = Partial<Omit<ClientPostgresOptions, "clientMigrationConfig"> &
 	/** The schema to use for the client side database. This must be defined unless a proxy is being used. */
 	schema?: any
 }>
-type InitOptions = {
+export type InitOptions = {
 	bypassEnvCheck?: boolean
 	addToWindowInDev?: boolean
 	logger?: BaseLogger
@@ -213,15 +215,19 @@ export class ClientDatabaseManager {
 		await this.useClientDb(name, entry.options, entry.initOptions)
 	}
 
-	async useClientDb(
-		name: string = this.defaultDatabaseName,
+	async useClientDb<
+		TName extends keyof LocalPgDbTypes | string,
+		TDb extends TName extends keyof LocalPgDbTypes ? LocalPgDbTypes[TName] : (PgliteDatabase | PgRemoteDatabase)
+	>(
+		name: TName = this.defaultDatabaseName as TName,
 		opts?: AllOptions, // do not define this or init will break
 		{
 			bypassEnvCheck = false,
 			addToWindowInDev = true,
 			logger = typeof console !== "undefined" ? console as any : {}
 		}: InitOptions = {}
-	): Promise<PgliteDatabase | PgRemoteDatabase> {
+	):
+	Promise<TDb> {
 		if (!bypassEnvCheck && !import.meta.client) {
 			return {} as any
 		}
@@ -255,7 +261,7 @@ export class ClientDatabaseManager {
 			})
 			entry.migrationState.skip = true
 		}
-		return entry.db
+		return entry.db as any
 	}
 
 	static useDefaultStorage(): Storage<any> | undefined {