@remix-run/router 1.6.3 → 1.7.0

package/utils.ts

@@ -88,19 +88,48 @@ export type V7_MutationFormMethod = Exclude<V7_FormMethod, "GET">;
 
 export type FormEncType =
   | "application/x-www-form-urlencoded"
-  | "multipart/form-data";
+  | "multipart/form-data"
+  | "application/json"
+  | "text/plain";
+
+// Thanks https://github.com/sindresorhus/type-fest!
+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 {
-  formMethod: FormMethod | V7_FormMethod;
-  formAction: string;
-  formEncType: FormEncType;
-  formData: FormData;
-}
+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
@@ -160,7 +189,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;
@@ -731,6 +762,9 @@ export function generatePath<Path extends string>(
   // ensure `/` is added at the beginning if the path is absolute
   const prefix = path.startsWith("/") ? "/" : "";
 
+  const stringify = (p: any) =>
+    p == null ? "" : typeof p === "string" ? p : String(p);
+
   const segments = path
     .split(/\/+/)
     .map((segment, index, array) => {
@@ -739,26 +773,16 @@ export function generatePath<Path extends string>(
       // only apply the splat if it's the last segment
       if (isLastSegment && segment === "*") {
         const star = "*" as PathParam<Path>;
-        const starParam = params[star];
-
         // Apply the splat
-        return starParam;
+        return stringify(params[star]);
       }
 
       const keyMatch = segment.match(/^:(\w+)(\??)$/);
       if (keyMatch) {
         const [, key, optional] = keyMatch;
         let param = params[key as PathParam<Path>];
-
-        if (optional === "?") {
-          return param == null ? "" : param;
-        }
-
-        if (param == null) {
-          invariant(false, `Missing ":${key}" param`);
-        }
-
-        return param;
+        invariant(optional === "?" || param != null, `Missing ":${key}" param`);
+        return stringify(param);
       }
 
       // Remove any optional markers from optional static segments