@remix-run/router 1.6.3 → 1.7.0

package/dist/router.d.ts

@@ -1,6 +1,6 @@
 import type { History, Location, Path, To } from "./history";
 import { Action as HistoryAction } from "./history";
-import type { DeferredData, AgnosticDataRouteMatch, AgnosticDataRouteObject, FormEncType, FormMethod, DetectErrorBoundaryFunction, RouteData, AgnosticRouteObject, AgnosticRouteMatch, V7_FormMethod, HTMLFormMethod, MapRoutePropertiesFunction } from "./utils";
+import type { DeferredData, AgnosticDataRouteMatch, AgnosticDataRouteObject, FormEncType, DetectErrorBoundaryFunction, RouteData, AgnosticRouteObject, Submission, AgnosticRouteMatch, HTMLFormMethod, MapRoutePropertiesFunction } from "./utils";
 /**
  * A Router instance manages all navigation and data loading/mutations
  */
@@ -81,7 +81,7 @@ export interface Router {
      * @param href    href to fetch
      * @param opts    Fetcher options, (method, submission, etc.)
      */
-    fetch(key: string, routeId: string, href: string | null, opts?: RouterNavigateOptions): void;
+    fetch(key: string, routeId: string, href: string | null, opts?: RouterFetchOptions): void;
     /**
      * @internal
      * PRIVATE - DO NOT USE
@@ -234,7 +234,7 @@ export interface RouterState {
 /**
  * Data that can be passed into hydrate a Router from SSR
  */
-export declare type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
+export type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
 /**
  * Future flags to toggle new feature behavior
  */
@@ -313,38 +313,54 @@ export interface GetScrollRestorationKeyFunction {
 export interface GetScrollPositionFunction {
     (): number;
 }
-export declare type RelativeRoutingType = "route" | "path";
-declare type BaseNavigateOptions = {
-    replace?: boolean;
-    state?: any;
+export type RelativeRoutingType = "route" | "path";
+type BaseNavigateOrFetchOptions = {
     preventScrollReset?: boolean;
     relative?: RelativeRoutingType;
+};
+type BaseNavigateOptions = BaseNavigateOrFetchOptions & {
+    replace?: boolean;
+    state?: any;
     fromRouteId?: string;
 };
+type BaseSubmissionOptions = {
+    formMethod?: HTMLFormMethod;
+    formEncType?: FormEncType;
+} & ({
+    formData: FormData;
+    body?: undefined;
+} | {
+    formData?: undefined;
+    body: any;
+});
 /**
- * Options for a navigate() call for a Link navigation
+ * Options for a navigate() call for a normal (non-submission) navigation
  */
-declare type LinkNavigateOptions = BaseNavigateOptions;
+type LinkNavigateOptions = BaseNavigateOptions;
 /**
- * Options for a navigate() call for a Form navigation
+ * Options for a navigate() call for a submission navigation
  */
-declare type SubmissionNavigateOptions = BaseNavigateOptions & {
-    formMethod?: HTMLFormMethod;
-    formEncType?: FormEncType;
-    formData: FormData;
-};
+type SubmissionNavigateOptions = BaseNavigateOptions & BaseSubmissionOptions;
+/**
+ * Options to pass to navigate() for a navigation
+ */
+export type RouterNavigateOptions = LinkNavigateOptions | SubmissionNavigateOptions;
+/**
+ * Options for a fetch() load
+ */
+type LoadFetchOptions = BaseNavigateOrFetchOptions;
 /**
- * Options to pass to navigate() for either a Link or Form navigation
+ * Options for a fetch() submission
  */
-export declare type RouterNavigateOptions = LinkNavigateOptions | SubmissionNavigateOptions;
+type SubmitFetchOptions = BaseNavigateOrFetchOptions & BaseSubmissionOptions;
 /**
  * Options to pass to fetch()
  */
-export declare type RouterFetchOptions = Omit<LinkNavigateOptions, "replace"> | Omit<SubmissionNavigateOptions, "replace">;
+export type RouterFetchOptions = LoadFetchOptions | SubmitFetchOptions;
 /**
  * Potential states for state.navigation
  */
-export declare type NavigationStates = {
+export type NavigationStates = {
     Idle: {
         state: "idle";
         location: undefined;
@@ -352,59 +368,71 @@ export declare type NavigationStates = {
         formAction: undefined;
         formEncType: undefined;
         formData: undefined;
+        json: undefined;
+        text: undefined;
     };
     Loading: {
         state: "loading";
         location: Location;
-        formMethod: FormMethod | V7_FormMethod | undefined;
-        formAction: string | undefined;
-        formEncType: FormEncType | undefined;
-        formData: FormData | undefined;
+        formMethod: Submission["formMethod"] | undefined;
+        formAction: Submission["formAction"] | undefined;
+        formEncType: Submission["formEncType"] | undefined;
+        formData: Submission["formData"] | undefined;
+        json: Submission["json"] | undefined;
+        text: Submission["text"] | undefined;
     };
     Submitting: {
         state: "submitting";
         location: Location;
-        formMethod: FormMethod | V7_FormMethod;
-        formAction: string;
-        formEncType: FormEncType;
-        formData: FormData;
+        formMethod: Submission["formMethod"];
+        formAction: Submission["formAction"];
+        formEncType: Submission["formEncType"];
+        formData: Submission["formData"];
+        json: Submission["json"];
+        text: Submission["text"];
     };
 };
-export declare type Navigation = NavigationStates[keyof NavigationStates];
-export declare type RevalidationState = "idle" | "loading";
+export type Navigation = NavigationStates[keyof NavigationStates];
+export type RevalidationState = "idle" | "loading";
 /**
  * Potential states for fetchers
  */
-declare type FetcherStates<TData = any> = {
+type FetcherStates<TData = any> = {
     Idle: {
         state: "idle";
         formMethod: undefined;
         formAction: undefined;
         formEncType: undefined;
+        text: undefined;
         formData: undefined;
+        json: undefined;
         data: TData | undefined;
         " _hasFetcherDoneAnything "?: boolean;
     };
     Loading: {
         state: "loading";
-        formMethod: FormMethod | V7_FormMethod | undefined;
-        formAction: string | undefined;
-        formEncType: FormEncType | undefined;
-        formData: FormData | undefined;
+        formMethod: Submission["formMethod"] | undefined;
+        formAction: Submission["formAction"] | undefined;
+        formEncType: Submission["formEncType"] | undefined;
+        text: Submission["text"] | undefined;
+        formData: Submission["formData"] | undefined;
+        json: Submission["json"] | undefined;
         data: TData | undefined;
         " _hasFetcherDoneAnything "?: boolean;
     };
     Submitting: {
         state: "submitting";
-        formMethod: FormMethod | V7_FormMethod;
-        formAction: string;
-        formEncType: FormEncType;
-        formData: FormData;
+        formMethod: Submission["formMethod"];
+        formAction: Submission["formAction"];
+        formEncType: Submission["formEncType"];
+        text: Submission["text"];
+        formData: Submission["formData"];
+        json: Submission["json"];
         data: TData | undefined;
         " _hasFetcherDoneAnything "?: boolean;
     };
 };
-export declare type Fetcher<TData = any> = FetcherStates<TData>[keyof FetcherStates<TData>];
+export type Fetcher<TData = any> = FetcherStates<TData>[keyof FetcherStates<TData>];
 interface BlockerBlocked {
     state: "blocked";
     reset(): void;
@@ -423,8 +451,8 @@ interface BlockerProceeding {
     proceed: undefined;
     location: Location;
 }
-export declare type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
-export declare type BlockerFunction = (args: {
+export type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
+export type BlockerFunction = (args: {
     currentLocation: Location;
     nextLocation: Location;
     historyAction: HistoryAction;