Set Session type via module augmentation

Author: emmatown

.changeset/old-buttons-wave.md

@@ -0,0 +1,5 @@
+---
+"@keystone-6/core": major
+---
+
+The `Session` type is now set by augmenting the `Session` interface in `.keystone/types` instead of being a generic on various types exported by `.keystone/types`

examples/auth-magic-link/keystone.ts

@@ -1,7 +1,7 @@
 import { config } from '@keystone-6/core'
 import { statelessSessions } from '@keystone-6/core/session'
 import { createAuth } from '@keystone-6/auth'
-import { type Session, lists, extendGraphqlSchema } from './schema'
+import { lists, extendGraphqlSchema } from './schema'
 import type { TypeInfo } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
@@ -38,7 +38,7 @@ const { withAuth } = createAuth({
   },
 })
 
-export default withAuth<TypeInfo<Session>>(
+export default withAuth<TypeInfo>(
   config<TypeInfo>({
     db: {
       provider: 'sqlite',

examples/auth-magic-link/schema.ts

@@ -1,15 +1,18 @@
 import { gWithContext, list } from '@keystone-6/core'
 import { allowAll, denyAll } from '@keystone-6/core/access'
 import { password, text, timestamp } from '@keystone-6/core/fields'
-import type { Lists, Context } from '.keystone/types'
+import type { Lists, Context, Session } from '.keystone/types'
 
 import { randomBytes } from 'node:crypto'
 
 const g = gWithContext<Context>()
 type g<T> = gWithContext.infer<T>
 
-export type Session = {
-  itemId: string
+declare module '.keystone/types' {
+  interface Session {
+    itemId: string
+    listKey: string
+  }
 }
 
 function hasSession({ session }: { session?: Session }) {
@@ -83,7 +86,7 @@ export const lists = {
       oneTimeTokenCreatedAt: timestamp({ ...hiddenField }),
     },
   }),
-} satisfies Lists<Session>
+} satisfies Lists
 
 // WARNING: this example is for demonstration purposes only
 //   as with each of our examples, it has not been vetted
@@ -176,7 +179,7 @@ export const extendGraphqlSchema = g.extend(base => {
             await context.sessionStrategy.start({
               context,
               data: {
-                listkey: 'User',
+                listKey: 'User',
                 itemId: userId,
               },
             })

examples/auth/keystone.ts

@@ -1,7 +1,7 @@
 import { config } from '@keystone-6/core'
 import { statelessSessions } from '@keystone-6/core/session'
 import { createAuth } from '@keystone-6/auth'
-import { type Session, lists } from './schema'
+import { lists } from './schema'
 import type { TypeInfo } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
@@ -47,7 +47,7 @@ const { withAuth } = createAuth({
   sessionData: 'isAdmin',
 })
 
-export default withAuth<TypeInfo<Session>>(
+export default withAuth<TypeInfo>(
   config<TypeInfo>({
     db: {
       provider: 'sqlite',

examples/auth/schema.ts

@@ -1,16 +1,17 @@
 import { list } from '@keystone-6/core'
 import { allowAll, denyAll } from '@keystone-6/core/access'
 import { text, checkbox, password } from '@keystone-6/core/fields'
-import type { Lists } from '.keystone/types'
+import type { Lists, Session } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
 //   as with each of our examples, it has not been vetted
 //   or tested for any particular usage
-
-export type Session = {
-  itemId: string
-  data: {
-    isAdmin: boolean
+declare module '.keystone/types' {
+  interface Session {
+    itemId: string
+    data: {
+      isAdmin: boolean
+    }
   }
 }
 
@@ -156,4 +157,4 @@ export const lists = {
       }),
     },
   }),
-} satisfies Lists<Session>
+} satisfies Lists

examples/custom-output-paths/my-types.ts

@@ -135,11 +135,13 @@ type ResolvedPostUpdateInput = {
   publishDate?: import('./node_modules/myprisma').Prisma.PostUpdateInput['publishDate']
 }
 
+export interface Session {}
+
 export declare namespace Lists {
-  export type Post<Session = any> = import('@keystone-6/core/types').ListConfig<Lists.Post.TypeInfo<Session>>
+  export type Post = import('@keystone-6/core/types').ListConfig<Lists.Post.TypeInfo>
   namespace Post {
     export type Item = import('./node_modules/myprisma').Post
-    export type TypeInfo<Session = any> = {
+    export type TypeInfo = {
       key: 'Post'
       isSingleton: false
       fields: 'id' | 'title' | 'content' | 'publishDate'
@@ -156,25 +158,25 @@ export declare namespace Lists {
         create: ResolvedPostCreateInput
         update: ResolvedPostUpdateInput
       }
-      all: __TypeInfo<Session>
+      all: __TypeInfo
     }
   }
 }
-export type Context<Session = any> = import('@keystone-6/core/types').KeystoneContext<TypeInfo<Session>>
-export type Config<Session = any> = import('@keystone-6/core/types').KeystoneConfig<TypeInfo<Session>>
+export type Context = import('@keystone-6/core/types').KeystoneContext<TypeInfo>
+export type Config = import('@keystone-6/core/types').KeystoneConfig<TypeInfo>
 
-export type TypeInfo<Session = any> = {
+export type TypeInfo = {
   lists: {
-    readonly Post: Lists.Post.TypeInfo<Session>
+    readonly Post: Lists.Post.TypeInfo
   }
   prisma: import('./node_modules/myprisma').PrismaClient
   session: Session
 }
 
-type __TypeInfo<Session = any> = TypeInfo<Session>
+type __TypeInfo = TypeInfo
 
-export type Lists<Session = any> = {
-  [Key in keyof TypeInfo['lists']]?: import('@keystone-6/core/types').ListConfig<TypeInfo<Session>['lists'][Key]>
+export type Lists = {
+  [Key in keyof TypeInfo['lists']]?: import('@keystone-6/core/types').ListConfig<TypeInfo['lists'][Key]>
 } & Record<string, import('@keystone-6/core/types').ListConfig<any>>
 
 export {}

examples/custom-session-invalidation/keystone.ts

@@ -1,8 +1,8 @@
 import { config } from '@keystone-6/core'
 import { statelessSessions } from '@keystone-6/core/session'
 import { createAuth } from '@keystone-6/auth'
-import { type Session, lists } from './schema'
-import type { Config, Context, TypeInfo } from '.keystone/types'
+import { lists } from './schema'
+import type { Config, Context, TypeInfo, Session } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
 //   as with each of our examples, it has not been vetted
@@ -32,7 +32,7 @@ const { withAuth } = createAuth({
   sessionData: 'passwordChangedAt',
 })
 
-function withSessionInvalidation(config: Config<Session>): Config<Session> {
+function withSessionInvalidation(config: Config): Config {
   const existingSessionStrategy = config.session!
 
   return {

examples/custom-session-invalidation/schema.ts

@@ -1,20 +1,22 @@
 import { list } from '@keystone-6/core'
 import { denyAll, unfiltered } from '@keystone-6/core/access'
 import { text, password, timestamp } from '@keystone-6/core/fields'
-import type { Lists } from '.keystone/types'
+import type { Lists, Session } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
 //   as with each of our examples, it has not been vetted
 //   or tested for any particular usage
 
 // needs to be compatible with withAuth
-export type Session = {
-  listKey: string
-  itemId: string
-  data: {
-    passwordChangedAt: string
+declare module '.keystone/types' {
+  interface Session {
+    listKey: string
+    itemId: string
+    data: {
+      passwordChangedAt: string
+    }
+    startedAt: number
   }
-  startedAt: number
 }
 
 function hasSession({ session }: { session?: Session }) {
@@ -85,4 +87,4 @@ export const lists = {
       },
     },
   }),
-} satisfies Lists<Session>
+} satisfies Lists

examples/custom-session-jwt/keystone.ts

@@ -1,7 +1,7 @@
 import jwt from 'jsonwebtoken'
 import { config } from '@keystone-6/core'
-import { lists, type Session } from './schema'
-import type { Context, TypeInfo } from '.keystone/types'
+import { lists } from './schema'
+import type { Context, TypeInfo, Session } from '.keystone/types'
 
 // WARNING: this example is for demonstration purposes only
 //   as with each of our examples, it has not been vetted

examples/custom-session-jwt/schema.ts

@@ -1,11 +1,13 @@
 import { list } from '@keystone-6/core'
 import { allowAll, unfiltered, allOperations } from '@keystone-6/core/access'
 import { checkbox, text } from '@keystone-6/core/fields'
-import type { Lists } from '.keystone/types'
+import type { Lists, Session } from '.keystone/types'
 
-export type Session = {
-  id: string
-  admin: boolean
+declare module '.keystone/types' {
+  interface Session {
+    id: string
+    admin: boolean
+  }
 }
 
 function hasSession({ session }: { session?: Session }) {
@@ -61,4 +63,4 @@ export const lists = {
       admin: checkbox(),
     },
   }),
-} satisfies Lists<Session>
+} satisfies Lists