types(remix-server-runtime): make AppLoadContext an empty interface…

… instead of `any` (#1876)

* make AppLoadContext an empty interface

* Update contributors.yml

* AppLoadContext interface uses unknown for missing values

* update types for AppLoadContext

* fix: make `AppLoadContext` parameter optional

parameter used to be implicitly optional as it used to be typed as `any`. it _is_ intended to be
optional, so this restores it as an optional param

Co-authored-by: Pedro Cattori <pcattori@gmail.com>

.changeset/great-pumas-act.md

@@ -0,0 +1,18 @@
+---
+"@remix-run/netlify": minor
+"@remix-run/server-runtime": minor
+---
+
+Type safety for load context.
+
+Change `AppLoadContext` to be an interface mapping `string` to `unknown`, allowing users to extend it via:
+
+```ts
+
+
+declare module "@remix-run/server-runtime" {
+  interface AppLoadContext {
+    // add custom properties here!
+  }
+}
+```

contributors.yml

@@ -80,6 +80,7 @@
 - cysp
 - damiensedgwick
 - dan-gamble
+- danielfgray
 - danielweinmann
 - davecalnan
 - davecranwell-vocovo

packages/remix-netlify/server.ts

@@ -39,7 +39,7 @@ export function createRequestHandler({
   mode = process.env.NODE_ENV,
 }: {
   build: ServerBuild;
-  getLoadContext?: AppLoadContext;
+  getLoadContext?: GetLoadContextFunction;
   mode?: string;
 }): RequestHandler {
   let handleRequest = createRemixRequestHandler(build, mode);

packages/remix-server-runtime/data.ts

@@ -3,10 +3,12 @@ import type { ServerRoute } from "./routes";
 import { json, isResponse, isRedirectResponse } from "./responses";
 
 /**
- * An object of arbitrary for route loaders and actions provided by the
+ * An object of unknown type for route loaders and actions provided by the
  * server's `getLoadContext()` function.
  */
-export type AppLoadContext = any;
+export interface AppLoadContext {
+  [key: string]: unknown;
+}
 
 /**
  * Data for a route that was returned from a `loader()`.
@@ -18,7 +20,7 @@ export async function callRouteAction({
   match,
   request,
 }: {
-  loadContext: unknown;
+  loadContext?: AppLoadContext;
   match: RouteMatch<ServerRoute>;
   request: Request;
 }) {
@@ -65,7 +67,7 @@ export async function callRouteLoader({
 }: {
   request: Request;
   match: RouteMatch<ServerRoute>;
-  loadContext: unknown;
+  loadContext?: AppLoadContext;
 }) {
   let loader = match.route.module.loader;
 

packages/remix-server-runtime/routeModules.ts

@@ -15,7 +15,7 @@ export interface RouteModules<RouteModule> {
  */
 export interface DataFunctionArgs {
   request: Request;
-  context: AppLoadContext;
+  context?: AppLoadContext;
   params: Params;
 }
 

packages/remix-server-runtime/server.ts

@@ -82,7 +82,7 @@ async function handleDataRequest({
   serverMode,
 }: {
   handleDataRequest?: HandleDataRequestFunction;
-  loadContext: unknown;
+  loadContext?: AppLoadContext;
   matches: RouteMatch<ServerRoute>[];
   request: Request;
   serverMode: ServerMode;
@@ -180,7 +180,7 @@ async function handleDocumentRequest({
   serverMode,
 }: {
   build: ServerBuild;
-  loadContext: unknown;
+  loadContext?: AppLoadContext;
   matches: RouteMatch<ServerRoute>[] | null;
   request: Request;
   routes: ServerRoute[];
@@ -516,7 +516,7 @@ async function handleResourceRequest({
   serverMode,
 }: {
   request: Request;
-  loadContext: unknown;
+  loadContext?: AppLoadContext;
   matches: RouteMatch<ServerRoute>[];
   serverMode: ServerMode;
 }): Promise<Response> {