fix(types): include auth augmentations in shared context (#310)

Author: onmax

src/module/type-templates.ts

@@ -111,7 +111,7 @@ declare module '@onmax/nuxt-better-auth/config' {
   export function defineServerAuth<const R>(config: R & ServerAuthConfig): (ctx: _AugmentedServerAuthContext) => R
 }
 `,
-  }, { nuxt: true, nitro: true, node: true })
+  }, { nuxt: true, nitro: true, node: true, shared: true })
 
   addTypeTemplate({
     filename: 'types/nuxt-better-auth-social-providers.d.ts',
@@ -128,7 +128,7 @@ declare module '#nuxt-better-auth' {
   }
 }
 `,
-  }, { nuxt: true, nitro: true, node: true })
+  }, { nuxt: true, nitro: true, node: true, shared: true })
 
   addTypeTemplate({
     filename: 'types/nuxt-better-auth-nitro.d.ts',

test/cases/plugins-type-inference/.nuxtrc

@@ -1 +1 @@
-setups.@onmax/nuxt-better-auth="0.0.2-alpha.30"
+setups.@onmax/nuxt-better-auth="0.0.2-alpha.31"

test/cases/plugins-type-inference/server/auth.config.ts

@@ -11,6 +11,15 @@ function customAdminLikePlugin() {
       },
     },
     schema: {
+      session: {
+        fields: {
+          workspaceId: {
+            type: 'string',
+            required: false,
+            input: false,
+          },
+        },
+      },
       user: {
         fields: {
           role: {
@@ -27,6 +36,12 @@ function customAdminLikePlugin() {
 export default defineServerAuth(() => ({
   emailAndPassword: { enabled: true },
   plugins: [customAdminLikePlugin(), username()] as const,
+  socialProviders: {
+    github: {
+      clientId: 'test-client-id',
+      clientSecret: 'test-client-secret',
+    },
+  },
   user: {
     additionalFields: {
       internalCode: {

test/cases/plugins-type-inference/shared/auth-types.ts

@@ -0,0 +1,16 @@
+import type { AuthSession, AuthUser } from '#nuxt-better-auth'
+import type { AuthSocialProviderId } from '../../../../src/runtime/types'
+
+export function assertSharedAuthTypes(user: AuthUser, session: AuthSession) {
+  const role: string | null | undefined = user.role
+  const internalCode: string | null | undefined = user.internalCode
+  const workspaceId: string | null | undefined = session.workspaceId
+  const provider: AuthSocialProviderId = 'github'
+
+  return {
+    internalCode,
+    provider,
+    role,
+    workspaceId,
+  }
+}

test/cases/plugins-type-inference/tsconfig.type-check.json

@@ -20,6 +20,7 @@
   },
   "files": [
     "./.nuxt/types/nuxt-better-auth-infer.d.ts",
+    "./.nuxt/types/nuxt-better-auth-social-providers.d.ts",
     "./.nuxt/types/nuxt-better-auth-nitro.d.ts",
     "./typecheck-target.ts"
   ]

test/cases/plugins-type-inference/typecheck-target.ts

@@ -1,5 +1,6 @@
-import type { AuthUser } from '#nuxt-better-auth'
+import type { AuthSession, AuthUser } from '#nuxt-better-auth'
 import type { NitroRouteRules } from 'nitropack/types'
+import type { AuthSocialProviderId } from '../../../src/runtime/types'
 
 declare const serverAuth: typeof import('../../../src/runtime/server/utils/auth').serverAuth
 
@@ -21,6 +22,18 @@ const user: AuthUser = {
   foo: 'bar',
 }
 
+const session: AuthSession = {
+  id: 'session-1',
+  createdAt: new Date(),
+  updatedAt: new Date(),
+  userId: '1',
+  expiresAt: new Date(),
+  token: 'token',
+  workspaceId: 'workspace-1',
+}
+
+const provider: AuthSocialProviderId = 'github'
+
 const rules: NitroRouteRules = {
   auth: {
     user: { role: 'admin', internalCode: 'x', foo: 'bar' },
@@ -34,3 +47,5 @@ void user
 void rules
 void auth
 void signInUsername
+void session
+void provider

test/infer-plugins-types.test.ts

@@ -30,5 +30,12 @@ describe('type inference regressions #107 and #192', () => {
     expect(output).not.toContain(`'internalCode' does not exist in type`)
     expect(output).not.toContain(`Property 'signInUsername' does not exist on type`)
     expect(output).not.toContain(`'signInUsername' does not exist on type`)
+
+    const sharedTypecheck = spawnSync('npx', ['vue-tsc', '--noEmit', '--pretty', 'false', '-p', '.nuxt/tsconfig.shared.json'], {
+      cwd: fixtureDir,
+      env,
+      encoding: 'utf8',
+    })
+    expect(sharedTypecheck.status, `shared vue-tsc failed:\n${sharedTypecheck.stdout}\n${sharedTypecheck.stderr}`).toBe(0)
   }, 60_000)
 })