@remix-run/router 1.15.3 → 1.16.0-pre.1

package/dist/utils.d.ts

@@ -16,7 +16,7 @@ export declare enum ResultType {
  */
 export interface SuccessResult {
     type: ResultType.data;
-    data: any;
+    data: unknown;
     statusCode?: number;
     headers?: Headers;
 }
@@ -34,23 +34,29 @@ export interface DeferredResult {
  */
 export interface RedirectResult {
     type: ResultType.redirect;
-    status: number;
-    location: string;
-    revalidate: boolean;
-    reloadDocument?: boolean;
+    response: Response;
 }
 /**
  * Unsuccessful result from a loader or action
  */
 export interface ErrorResult {
     type: ResultType.error;
-    error: any;
+    error: unknown;
+    statusCode?: number;
     headers?: Headers;
 }
 /**
  * Result from a loader or action - potentially successful or unsuccessful
  */
 export type DataResult = SuccessResult | DeferredResult | RedirectResult | ErrorResult;
+/**
+ * Result from a loader or action called via dataStrategy
+ */
+export interface HandlerResult {
+    type: "data" | "error";
+    result: unknown;
+    status?: number;
+}
 type LowerCaseFormMethod = "get" | "post" | "put" | "patch" | "delete";
 type UpperCaseFormMethod = Uppercase<LowerCaseFormMethod>;
 /**
@@ -132,11 +138,12 @@ export interface ActionFunctionArgs<Context = any> extends DataFunctionArgs<Cont
  * and will ease any future migration to Remix
  */
 type DataFunctionValue = Response | NonNullable<unknown> | null;
+type DataFunctionReturnValue = Promise<DataFunctionValue> | DataFunctionValue;
 /**
  * Route loader function signature
  */
 export type LoaderFunction<Context = any> = {
-    (args: LoaderFunctionArgs<Context>): Promise<DataFunctionValue> | DataFunctionValue;
+    (args: LoaderFunctionArgs<Context>, handlerCtx?: unknown): DataFunctionReturnValue;
 } & {
     hydrate?: boolean;
 };
@@ -144,7 +151,7 @@ export type LoaderFunction<Context = any> = {
  * Route action function signature
  */
 export interface ActionFunction<Context = any> {
-    (args: ActionFunctionArgs<Context>): Promise<DataFunctionValue> | DataFunctionValue;
+    (args: ActionFunctionArgs<Context>, handlerCtx?: unknown): DataFunctionReturnValue;
 }
 /**
  * Arguments passed to shouldRevalidate function
@@ -160,6 +167,7 @@ export interface ShouldRevalidateFunctionArgs {
     text?: Submission["text"];
     formData?: Submission["formData"];
     json?: Submission["json"];
+    unstable_actionStatus?: number;
     actionResult?: any;
     defaultShouldRevalidate: boolean;
 }
@@ -182,6 +190,16 @@ export interface ShouldRevalidateFunction {
 export interface DetectErrorBoundaryFunction {
     (route: AgnosticRouteObject): boolean;
 }
+export interface DataStrategyMatch extends AgnosticRouteMatch<string, AgnosticDataRouteObject> {
+    shouldLoad: boolean;
+    resolve: (handlerOverride?: (handler: (ctx?: unknown) => DataFunctionReturnValue) => Promise<HandlerResult>) => Promise<HandlerResult>;
+}
+export interface DataStrategyFunctionArgs<Context = any> extends DataFunctionArgs<Context> {
+    matches: DataStrategyMatch[];
+}
+export interface DataStrategyFunction {
+    (args: DataStrategyFunctionArgs): Promise<HandlerResult[]>;
+}
 /**
  * Function provided by the framework-aware layers to set any framework-specific
  * properties from framework-agnostic properties
@@ -215,8 +233,8 @@ type AgnosticBaseRouteObject = {
     caseSensitive?: boolean;
     path?: string;
     id?: string;
-    loader?: LoaderFunction;
-    action?: ActionFunction;
+    loader?: LoaderFunction | boolean;
+    action?: ActionFunction | boolean;
     hasErrorBoundary?: boolean;
     shouldRevalidate?: ShouldRevalidateFunction;
     handle?: any;

package/index.ts

@@ -9,9 +9,13 @@ export type {
   AgnosticNonIndexRouteObject,
   AgnosticRouteMatch,
   AgnosticRouteObject,
+  DataStrategyFunction as unstable_DataStrategyFunction,
+  DataStrategyFunctionArgs as unstable_DataStrategyFunctionArgs,
+  DataStrategyMatch as unstable_DataStrategyMatch,
   ErrorResponse,
   FormEncType,
   FormMethod,
+  HandlerResult as unstable_HandlerResult,
   HTMLFormMethod,
   JsonFunction,
   LazyRouteFunction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/router",
-  "version": "1.15.3",
+  "version": "1.16.0-pre.1",
   "description": "Nested/Data-driven/Framework-agnostic Routing",
   "keywords": [
     "remix",
@@ -30,4 +30,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}