getQueryKey.ts

type Endpoint =
  | "/users/:userId"
  | "/users/:userId/photos/:photoId"
  | "/reviews";

type ParseUrlParams<url> = url extends `${infer path}(${infer optionalPath})`
  ? ParseUrlParams<path> & Partial<ParseUrlParams<optionalPath>>
  : url extends `${infer start}/${infer rest}`
  ? ParseUrlParams<start> & ParseUrlParams<rest>
  : url extends `:${infer param}`
  ? { [k in param]: string }
  : {};

export function getQueryKey<
  T extends Endpoint extends `/${string}` ? Endpoint : never
>(path: T, params: ParseUrlParams<T> = {}): [string] {
  if (path.includes(":") && !params) {
    throw new Error("Missing params");
  }

  // Replace all params with their values
  let url = Object.entries<string>(params).reduce<string>(
    (path, [key, value]) => path.replace(`:${key}`, value),
    path
  );

  // Clean up the url
  url = url.replace(/(\(|\)|\/?:[^\/]+)/g, "");

  return [url];
}