@remix-run/router 1.5.0 → 1.6.0

package/utils.ts

@@ -123,18 +123,25 @@ export interface LoaderFunctionArgs extends DataFunctionArgs {}
  */
 export interface ActionFunctionArgs extends DataFunctionArgs {}
 
+/**
+ * Loaders and actions can return anything except `undefined` (`null` is a
+ * valid return value if there is no data to return).  Responses are preferred
+ * and will ease any future migration to Remix
+ */
+type DataFunctionValue = Response | NonNullable<unknown> | null;
+
 /**
  * Route loader function signature
  */
 export interface LoaderFunction {
-  (args: LoaderFunctionArgs): Promise<Response> | Response | Promise<any> | any;
+  (args: LoaderFunctionArgs): Promise<DataFunctionValue> | DataFunctionValue;
 }
 
 /**
  * Route action function signature
  */
 export interface ActionFunction {
-  (args: ActionFunctionArgs): Promise<Response> | Response | Promise<any> | any;
+  (args: ActionFunctionArgs): Promise<DataFunctionValue> | DataFunctionValue;
 }
 
 /**
@@ -162,11 +169,23 @@ export interface ShouldRevalidateFunction {
 /**
  * Function provided by the framework-aware layers to set `hasErrorBoundary`
  * from the framework-aware `errorElement` prop
+ *
+ * @deprecated Use `mapRouteProperties` instead
  */
 export interface DetectErrorBoundaryFunction {
   (route: AgnosticRouteObject): boolean;
 }
 
+/**
+ * Function provided by the framework-aware layers to set any framework-specific
+ * properties from framework-agnostic properties
+ */
+export interface MapRoutePropertiesFunction {
+  (route: AgnosticRouteObject): {
+    hasErrorBoundary: boolean;
+  } & Record<string, any>;
+}
+
 /**
  * Keys we cannot change from within a lazy() function. We spread all other keys
  * onto the route. Either they're meaningful to the router, or they'll get
@@ -338,7 +357,7 @@ function isIndexRoute(
 // solely with AgnosticDataRouteObject's within the Router
 export function convertRoutesToDataRoutes(
   routes: AgnosticRouteObject[],
-  detectErrorBoundary: DetectErrorBoundaryFunction,
+  mapRouteProperties: MapRoutePropertiesFunction,
   parentPath: number[] = [],
   manifest: RouteManifest = {}
 ): AgnosticDataRouteObject[] {
@@ -358,7 +377,7 @@ export function convertRoutesToDataRoutes(
     if (isIndexRoute(route)) {
       let indexRoute: AgnosticDataIndexRouteObject = {
         ...route,
-        hasErrorBoundary: detectErrorBoundary(route),
+        ...mapRouteProperties(route),
         id,
       };
       manifest[id] = indexRoute;
@@ -366,8 +385,8 @@ export function convertRoutesToDataRoutes(
     } else {
       let pathOrLayoutRoute: AgnosticDataNonIndexRouteObject = {
         ...route,
+        ...mapRouteProperties(route),
         id,
-        hasErrorBoundary: detectErrorBoundary(route),
         children: undefined,
       };
       manifest[id] = pathOrLayoutRoute;
@@ -375,7 +394,7 @@ export function convertRoutesToDataRoutes(
       if (route.children) {
         pathOrLayoutRoute.children = convertRoutesToDataRoutes(
           route.children,
-          detectErrorBoundary,
+          mapRouteProperties,
           treePath,
           manifest
         );