@remix-run/router 1.5.0 → 1.6.0

package/dist/utils.d.ts

@@ -101,17 +101,23 @@ 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
+ */
+declare 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;
 }
 /**
  * Route shouldRevalidate function signature.  This runs after any submission
@@ -137,10 +143,21 @@ 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
@@ -243,7 +260,7 @@ export interface AgnosticRouteMatch<ParamKey extends string = string, RouteObjec
 }
 export interface AgnosticDataRouteMatch extends AgnosticRouteMatch<string, AgnosticDataRouteObject> {
 }
-export declare function convertRoutesToDataRoutes(routes: AgnosticRouteObject[], detectErrorBoundary: DetectErrorBoundaryFunction, parentPath?: number[], manifest?: RouteManifest): AgnosticDataRouteObject[];
+export declare function convertRoutesToDataRoutes(routes: AgnosticRouteObject[], mapRouteProperties: MapRoutePropertiesFunction, parentPath?: number[], manifest?: RouteManifest): AgnosticDataRouteObject[];
 /**
  * Matches the given routes to a location and returns the match data.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/router",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Nested/Data-driven/Framework-agnostic Routing",
   "keywords": [
     "remix",