@remix-run/router 1.6.3 → 1.7.0

package/dist/utils.d.ts

@@ -49,38 +49,62 @@ export interface ErrorResult {
 /**
  * Result from a loader or action - potentially successful or unsuccessful
  */
-export declare type DataResult = SuccessResult | DeferredResult | RedirectResult | ErrorResult;
-declare type LowerCaseFormMethod = "get" | "post" | "put" | "patch" | "delete";
-declare type UpperCaseFormMethod = Uppercase<LowerCaseFormMethod>;
+export type DataResult = SuccessResult | DeferredResult | RedirectResult | ErrorResult;
+type LowerCaseFormMethod = "get" | "post" | "put" | "patch" | "delete";
+type UpperCaseFormMethod = Uppercase<LowerCaseFormMethod>;
 /**
  * Users can specify either lowercase or uppercase form methods on <Form>,
  * useSubmit(), <fetcher.Form>, etc.
  */
-export declare type HTMLFormMethod = LowerCaseFormMethod | UpperCaseFormMethod;
+export type HTMLFormMethod = LowerCaseFormMethod | UpperCaseFormMethod;
 /**
  * Active navigation/fetcher form methods are exposed in lowercase on the
  * RouterState
  */
-export declare type FormMethod = LowerCaseFormMethod;
-export declare type MutationFormMethod = Exclude<FormMethod, "get">;
+export type FormMethod = LowerCaseFormMethod;
+export type MutationFormMethod = Exclude<FormMethod, "get">;
 /**
  * In v7, active navigation/fetcher form methods are exposed in uppercase on the
  * RouterState.  This is to align with the normalization done via fetch().
  */
-export declare type V7_FormMethod = UpperCaseFormMethod;
-export declare type V7_MutationFormMethod = Exclude<V7_FormMethod, "GET">;
-export declare type FormEncType = "application/x-www-form-urlencoded" | "multipart/form-data";
+export type V7_FormMethod = UpperCaseFormMethod;
+export type V7_MutationFormMethod = Exclude<V7_FormMethod, "GET">;
+export type FormEncType = "application/x-www-form-urlencoded" | "multipart/form-data" | "application/json" | "text/plain";
+type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+type JsonArray = JsonValue[] | readonly JsonValue[];
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
 /**
  * @private
  * Internal interface to pass around for action submissions, not intended for
  * external consumption
  */
-export interface Submission {
+export type Submission = {
     formMethod: FormMethod | V7_FormMethod;
     formAction: string;
     formEncType: FormEncType;
     formData: FormData;
-}
+    json: undefined;
+    text: undefined;
+} | {
+    formMethod: FormMethod | V7_FormMethod;
+    formAction: string;
+    formEncType: FormEncType;
+    formData: undefined;
+    json: JsonValue;
+    text: undefined;
+} | {
+    formMethod: FormMethod | V7_FormMethod;
+    formAction: string;
+    formEncType: FormEncType;
+    formData: undefined;
+    json: undefined;
+    text: string;
+};
 /**
  * @private
  * Arguments passed to route loader/action functions.  Same for now but we keep
@@ -106,7 +130,7 @@ export interface ActionFunctionArgs extends DataFunctionArgs {
  * 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;
+type DataFunctionValue = Response | NonNullable<unknown> | null;
 /**
  * Route loader function signature
  */
@@ -135,7 +159,9 @@ export interface ShouldRevalidateFunction {
         formMethod?: Submission["formMethod"];
         formAction?: Submission["formAction"];
         formEncType?: Submission["formEncType"];
+        text?: Submission["text"];
         formData?: Submission["formData"];
+        json?: Submission["json"];
         actionResult?: DataResult;
         defaultShouldRevalidate: boolean;
     }): boolean;
@@ -163,7 +189,7 @@ export interface MapRoutePropertiesFunction {
  * onto the route. Either they're meaningful to the router, or they'll get
  * ignored.
  */
-export declare type ImmutableRouteKey = "lazy" | "caseSensitive" | "path" | "id" | "index" | "children";
+export type ImmutableRouteKey = "lazy" | "caseSensitive" | "path" | "id" | "index" | "children";
 export declare const immutableRouteKeys: Set<ImmutableRouteKey>;
 /**
  * lazy() function to load a route definition, which can add non-matching
@@ -175,7 +201,7 @@ export interface LazyRouteFunction<R extends AgnosticRouteObject> {
 /**
  * Base RouteObject with common props shared by all types of routes
  */
-declare type AgnosticBaseRouteObject = {
+type AgnosticBaseRouteObject = {
     caseSensitive?: boolean;
     path?: string;
     id?: string;
@@ -189,14 +215,14 @@ declare type AgnosticBaseRouteObject = {
 /**
  * Index routes must not have children
  */
-export declare type AgnosticIndexRouteObject = AgnosticBaseRouteObject & {
+export type AgnosticIndexRouteObject = AgnosticBaseRouteObject & {
     children?: undefined;
     index: true;
 };
 /**
  * Non-index routes may have children, but cannot have index
  */
-export declare type AgnosticNonIndexRouteObject = AgnosticBaseRouteObject & {
+export type AgnosticNonIndexRouteObject = AgnosticBaseRouteObject & {
     children?: AgnosticRouteObject[];
     index?: false;
 };
@@ -204,20 +230,20 @@ export declare type AgnosticNonIndexRouteObject = AgnosticBaseRouteObject & {
  * A route object represents a logical route, with (optionally) its child
  * routes organized in a tree-like structure.
  */
-export declare type AgnosticRouteObject = AgnosticIndexRouteObject | AgnosticNonIndexRouteObject;
-export declare type AgnosticDataIndexRouteObject = AgnosticIndexRouteObject & {
+export type AgnosticRouteObject = AgnosticIndexRouteObject | AgnosticNonIndexRouteObject;
+export type AgnosticDataIndexRouteObject = AgnosticIndexRouteObject & {
     id: string;
 };
-export declare type AgnosticDataNonIndexRouteObject = AgnosticNonIndexRouteObject & {
+export type AgnosticDataNonIndexRouteObject = AgnosticNonIndexRouteObject & {
     children?: AgnosticDataRouteObject[];
     id: string;
 };
 /**
  * A data route object, which is just a RouteObject with a required unique ID
  */
-export declare type AgnosticDataRouteObject = AgnosticDataIndexRouteObject | AgnosticDataNonIndexRouteObject;
-export declare type RouteManifest = Record<string, AgnosticDataRouteObject | undefined>;
-declare type _PathParam<Path extends string> = Path extends `${infer L}/${infer R}` ? _PathParam<L> | _PathParam<R> : Path extends `:${infer Param}` ? Param extends `${infer Optional}?` ? Optional : Param : never;
+export type AgnosticDataRouteObject = AgnosticDataIndexRouteObject | AgnosticDataNonIndexRouteObject;
+export type RouteManifest = Record<string, AgnosticDataRouteObject | undefined>;
+type _PathParam<Path extends string> = Path extends `${infer L}/${infer R}` ? _PathParam<L> | _PathParam<R> : Path extends `:${infer Param}` ? Param extends `${infer Optional}?` ? Optional : Param : never;
 /**
  * Examples:
  * "/a/b/*" -> "*"
@@ -227,14 +253,14 @@ declare type _PathParam<Path extends string> = Path extends `${infer L}/${infer
  * "/:a/:b" -> "a" | "b"
  * "/:a/b/:c/*" -> "a" | "c" | "*"
  */
-declare type PathParam<Path extends string> = Path extends "*" | "/*" ? "*" : Path extends `${infer Rest}/*` ? "*" | _PathParam<Rest> : _PathParam<Path>;
-export declare type ParamParseKey<Segment extends string> = [
+type PathParam<Path extends string> = Path extends "*" | "/*" ? "*" : Path extends `${infer Rest}/*` ? "*" | _PathParam<Rest> : _PathParam<Path>;
+export type ParamParseKey<Segment extends string> = [
     PathParam<Segment>
 ] extends [never] ? string : PathParam<Segment>;
 /**
  * The parameters that were parsed from the URL path.
  */
-export declare type Params<Key extends string = string> = {
+export type Params<Key extends string = string> = {
     readonly [key in Key]: string | undefined;
 };
 /**
@@ -381,7 +407,7 @@ export declare const normalizeSearch: (search: string) => string;
  * @private
  */
 export declare const normalizeHash: (hash: string) => string;
-export declare type JsonFunction = <Data>(data: Data, init?: number | ResponseInit) => Response;
+export type JsonFunction = <Data>(data: Data, init?: number | ResponseInit) => Response;
 /**
  * This is a shortcut for creating `application/json` responses. Converts `data`
  * to JSON and sets the `Content-Type` header.
@@ -414,9 +440,9 @@ export declare class DeferredData {
     get unwrappedData(): {};
     get pendingKeys(): string[];
 }
-export declare type DeferFunction = (data: Record<string, unknown>, init?: number | ResponseInit) => DeferredData;
+export type DeferFunction = (data: Record<string, unknown>, init?: number | ResponseInit) => DeferredData;
 export declare const defer: DeferFunction;
-export declare type RedirectFunction = (url: string, init?: number | ResponseInit) => Response;
+export type RedirectFunction = (url: string, init?: number | ResponseInit) => Response;
 /**
  * A redirect response. Sets the status code and the `Location` header.
  * Defaults to "302 Found".

package/package.json

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