Move RequestEventLocals type definition into a namespace to make the retyping easier for users (#1469)

* refactor RequestEventLocals into its own namespace for user retyping

* adding change set

* add placeholder for generic key value to RequestEventLocals

* adding example declaration to the todommvc example

* Update changeset to minor

---------

Co-authored-by: Ryan Carniato <ryansolid@gmail.com>
Co-authored-by: Atila Fassina <atila@fassina.eu>

Author: 3 people

.changeset/twenty-singers-fetch.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/start": minor
+---
+
+move the RequestEventLocals definition into the App namespace for easier end user retyping

examples/todomvc/src/global.d.ts

@@ -1 +1,7 @@
-/// <reference types="@solidjs/start/env" />
+declare module App {
+  interface RequestEventLocals {
+    /**
+     * Declare your getRequestEvent().locals here
+     */
+  }
+}

packages/start/env.d.ts

@@ -4,6 +4,12 @@
 
 /* eslint-disable @typescript-eslint/consistent-type-imports */
 
+declare namespace App {
+  export interface RequestEventLocals {
+    [key: string | symbol]: any;
+  }
+}
+
 interface ImportMetaEnv extends Record<`VITE_${string}`, any>, SolidStartMetaEnv {
   BASE_URL: string;
   MODE: string;

packages/start/src/server/index.tsx

@@ -3,16 +3,7 @@ export { StartServer } from "./StartServer";
 export { createHandler } from "./handler";
 export { getServerFunctionMeta } from "./serverFunction";
 export type {
-  DocumentComponentProps,
-  Asset,
-  HandlerOptions,
-  ContextMatches,
-  ResponseStub,
-  FetchEvent,
-  RequestEventLocals,
-  PageEvent,
   APIEvent,
-  APIHandler,
-  ServerFunctionMeta
+  APIHandler, Asset, ContextMatches, DocumentComponentProps, FetchEvent, HandlerOptions, PageEvent, ResponseStub, ServerFunctionMeta
 } from "./types";
 

packages/start/src/server/types.ts

@@ -42,16 +42,15 @@ export interface ResponseStub {
   statusText?: string;
   headers: Headers;
 }
+
 export interface FetchEvent {
   request: Request;
   response: ResponseStub;
   clientAddress?: string;
-  locals: RequestEventLocals;
+  locals: App.RequestEventLocals;
   nativeEvent: HTTPEvent;
 }
-export interface RequestEventLocals {
-  [key: string | symbol]: any;
-}
+
 export interface PageEvent extends RequestEvent {
   manifest: any;
   assets: any;