[feat] Add generic type for session (#1791)

sveltejs · Jul 1, 2021 · 0d69e55 · 0d69e55
1 parent 325c223
commit 0d69e55
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 10 deletions.
diff --git a/.changeset/sharp-geckos-beam.md b/.changeset/sharp-geckos-beam.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+Add generic type for session
diff --git a/packages/kit/types/ambient-modules.d.ts b/packages/kit/types/ambient-modules.d.ts
@@ -81,10 +81,10 @@ declare module '$app/stores' {
 	 * A convenience function around `getContext` that returns `{ navigating, page, session }`.
 	 * Most of the time, you won't need to use it.
 	 */
-	export function getStores(): {
+	export function getStores<Session = any>(): {
 		navigating: Readable<Navigating | null>;
 		page: Readable<Page>;
-		session: Writable<any>;
+		session: Writable<Session>;
 	};
 	/**
 	 * A readable store whose value reflects the object passed to load functions.

diff --git a/packages/kit/types/page.d.ts b/packages/kit/types/page.d.ts
@@ -2,18 +2,20 @@ import { Location as Page, MaybePromise, InferValue } from './helper';
 
 export type LoadInput<
 	PageParams extends Record<string, string> = Record<string, string>,
-	Context extends Record<string, any> = Record<string, any>
+	Context extends Record<string, any> = Record<string, any>,
+	Session = any
 > = {
 	page: Page<PageParams>;
 	fetch: (info: RequestInfo, init?: RequestInit) => Promise<Response>;
-	session: any;
+	session: Session;
 	context: Context;
 };
 
 export type ErrorLoadInput<
 	PageParams extends Record<string, string> = Record<string, string>,
-	Context extends Record<string, any> = Record<string, any>
-> = LoadInput<PageParams, Context> & {
+	Context extends Record<string, any> = Record<string, any>,
+	Session = any
+> = LoadInput<PageParams, Context, Session> & {
 	status: number;
 	error: Error;
 };
@@ -32,25 +34,35 @@ export type LoadOutput<
 
 // Publicized Types
 export type Load<
-	Input extends { context?: Record<string, any>; pageParams?: Record<string, string> } = {},
+	Input extends {
+		context?: Record<string, any>;
+		pageParams?: Record<string, string>;
+		session?: any;
+	} = {},
 	Output extends { context?: Record<string, any>; props?: Record<string, any> } = {}
 > = (
 	input: LoadInput<
 		InferValue<Input, 'pageParams', Record<string, string>>,
-		InferValue<Input, 'context', Record<string, any>>
+		InferValue<Input, 'context', Record<string, any>>,
+		InferValue<Input, 'session', any>
 	>
 ) => MaybePromise<void | LoadOutput<
 	InferValue<Output, 'props', Record<string, any>>,
 	InferValue<Output, 'context', Record<string, any>>
 >>;
 
 export type ErrorLoad<
-	Input extends { context?: Record<string, any>; pageParams?: Record<string, string> } = {},
+	Input extends {
+		context?: Record<string, any>;
+		pageParams?: Record<string, string>;
+		session?: any;
+	} = {},
 	Output extends { context?: Record<string, any>; props?: Record<string, any> } = {}
 > = (
 	input: ErrorLoadInput<
 		InferValue<Input, 'pageParams', Record<string, string>>,
-		InferValue<Input, 'context', Record<string, any>>
+		InferValue<Input, 'context', Record<string, any>>,
+		InferValue<Input, 'session', any>
 	>
 ) => MaybePromise<
 	LoadOutput<