Add support for typed sessions

Author: Josh Calder

examples/roles/keystone.ts

@@ -2,9 +2,11 @@ import { config } from '@keystone-6/core';
 import { statelessSessions } from '@keystone-6/auth/session';
 import { createAuth } from '@keystone-6/auth';
 import { lists } from './schema';
-
 import { isSignedIn } from './access';
 
+import { Session } from './types';
+import { TypeInfo } from '.keystone/types';
+
 const sessionSecret = '-- DEV COOKIE SECRET; CHANGE ME --';
 const sessionMaxAge = 60 * 60 * 24 * 30; // 30 days
 const sessionConfig = {
@@ -51,7 +53,7 @@ const { withAuth } = createAuth({
   sessionStrategy: statelessSessions(sessionConfig),
 });
 
-export default withAuth(
+export default withAuth<TypeInfo<Session>>(
   config({
     db: {
       provider: 'sqlite',

packages/core/src/lib/schema-type-printer.tsx

@@ -228,11 +228,12 @@ export function printGeneratedTypes(
     '}',
     `export type Context = import('@keystone-6/core/types').KeystoneContext<TypeInfo>;`,
     '',
-    'export type TypeInfo = {',
+    'export type TypeInfo<Session = any> = {',
     `  lists: {`,
     ...listsTypeInfo,
     `  };`,
     `  prisma: import('.prisma/client').PrismaClient;`,
+    `  session: Session;`,
     `};`,
     ``,
     // we need to reference the `TypeInfo` above in another type that is also called `TypeInfo`

packages/core/src/types/context.ts

@@ -14,7 +14,7 @@ export type KeystoneContext<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystone
   graphql: KeystoneGraphQLAPI;
   sudo: () => KeystoneContext<TypeInfo>;
   exitSudo: () => KeystoneContext<TypeInfo>;
-  withSession: (session: any) => KeystoneContext<TypeInfo>;
+  withSession: (session: TypeInfo['session']) => KeystoneContext<TypeInfo>;
   withRequest: (req: IncomingMessage, res?: ServerResponse) => Promise<KeystoneContext<TypeInfo>>;
   prisma: TypeInfo['prisma'];
   files: FilesContext;
@@ -27,8 +27,8 @@ export type KeystoneContext<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystone
      */
     initialisedLists: Record<string, InitialisedList>;
   };
-  getSession?: (args: { context: KeystoneContext }) => Promise<unknown | undefined>;
-  session?: any;
+  getSession?: (args: { context: KeystoneContext }) => Promise<TypeInfo['session'] | undefined>;
+  session?: TypeInfo['session'];
 };
 
 // List item API

packages/core/src/types/type-info.ts

@@ -28,4 +28,8 @@ export type BaseListTypeInfo = {
 export type KeystoneContextFromListTypeInfo<ListTypeInfo extends BaseListTypeInfo> =
   KeystoneContext<ListTypeInfo['all']>;
 
-export type BaseKeystoneTypeInfo = { lists: Record<string, BaseListTypeInfo>; prisma: any };
+export type BaseKeystoneTypeInfo = {
+  lists: Record<string, BaseListTypeInfo>;
+  prisma: any;
+  session: any;
+};

packages/core/src/types/type-tests.ts

@@ -8,6 +8,7 @@ const someContext: KeystoneContext<{
     ListOrSingleton: BaseListTypeInfo;
   };
   prisma: any;
+  session: any;
 }> = undefined!;
 
 someContext.query.Singleton.findOne({});