Skip to content

Make passing parameters to generateEncodedPath() type-safe #25944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonkoops merged 1 commit into from
Jan 5, 2024
Merged

Make passing parameters to generateEncodedPath() type-safe #25944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions js/apps/admin-ui/src/utils/generateEncodedPath.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,39 @@
import { generatePath } from "react-router-dom";
import { generatePath, type PathParam } from "react-router-dom";

export type PathParam = { [key: string]: string };
/**
* Represents an object that contains the parameters to be included in a path.
*
* @example
* const params: PathParams<"/user/:id"> = { id: "123" };
*/
export type PathParams<Path extends string> = {
[key in PathParam<Path>]: string;
};

/**
* Generates a path that represents the given path template with parameters interpolated and encoded in it, so that it can safely used in a URL.
*
* @param originalPath - The path template to use to generate the path.
* @param params - An object that contains the parameters to be included in the path.
*
* @example
* const path = "/user/:id";
* const params = { id: "123" };
* const encodedPath = generateEncodedPath(path, params);
* // encodedPath will be "/user/123"
*/
export function generateEncodedPath<Path extends string>(
originalPath: Path,
params: PathParam,
params: PathParams<Path>,
): string {
const encodedParams: PathParam = {};
// Clone the params object so we don't mutate the original.
const encodedParams = structuredClone(params);

Object.entries(params).forEach(
([k, v]) => (encodedParams[k] = encodeURIComponent(v)),
);
// Encode each param in the path so that it can be used in a URL.
for (const key in encodedParams) {
const pathKey = key as PathParam<Path>;
encodedParams[pathKey] = encodeURIComponent(encodedParams[pathKey]);
}

//TODO: Fix type once https://github.com/remix-run/react-router/pull/10719 is merged.
return generatePath(originalPath, encodedParams as any);
return generatePath(originalPath, encodedParams);
}