vite-plugin-react-server/plugin/helpers/inputNormalizer.ts

Vite plugin for React Server Components (RSC)

import { normalizePath } from "vite";
import type { InputNormalizer, NormalizerInput } from "../types.js";
import { join } from "path";
import { DEFAULT_CONFIG } from "../config/defaults.js";

type CreateInputNormalizerProps = {
  root: string;
  preserveModulesRoot?: string | undefined;
  removeExtension?: boolean | RegExp | string | ((path: string) => boolean);
};

const resolveExtensionOptions = (
  removeExtension: CreateInputNormalizerProps["removeExtension"]
) => {
  if (typeof removeExtension === "boolean") {
    if (removeExtension) {
      return (path: string) => {
        const extensionIndex = path.lastIndexOf(".");
        return extensionIndex !== -1 ? path.slice(0, extensionIndex) : path;
      };
    }
    return (path: string) => path;
  }
  if (typeof removeExtension === "string") {
    return (path: string) => path.replace(removeExtension, "");
  }
  if (removeExtension instanceof RegExp) {
    return (path: string) =>
      removeExtension.test(path) ? path.replace(removeExtension, "") : path;
  }
  if (typeof removeExtension === "function") {
    return (path: string) => {
      const extIndex = path.lastIndexOf(".");
      if (extIndex !== -1) {
        const extension = path.slice(extIndex);
        if (removeExtension(extension)) {
          return path.slice(0, extIndex);
        }
      }
      return path;
    };
  }
  return (path: string) => path;
};

const resolveRootOption = (
  root: CreateInputNormalizerProps["root"],
  preserveModulesRoot: CreateInputNormalizerProps["preserveModulesRoot"]
) => {
  if (typeof preserveModulesRoot === "string" && typeof root === "string") {
    const normalizedPreserveModulesRoot = normalizePath(preserveModulesRoot);
    if (normalizedPreserveModulesRoot.startsWith(root)) {
      return normalizedPreserveModulesRoot.slice(root.length + 1);
    }
    return "";
  } else if (typeof preserveModulesRoot === "string" && typeof root !== "string") {
    return normalizePath(preserveModulesRoot);
  }
  return "";
};
const createKeyNormalizer =
  ({
    root: normalizedRoot,
    preserveModulesRoot,
    handleExtension,
  }: {
    root: string;
    preserveModulesRoot: string | undefined;
    handleExtension: (path: string) => string;
  }) =>
  (key: string) => {
    // Handle virtual modules first
    const virtualPrefix = key.match(/^\0+/)?.[0] || '';
    const actualKey = key.slice(virtualPrefix.length);
    
    let moduleId = normalizePath(actualKey);
    
    if (moduleId.startsWith(normalizedRoot)) {
      moduleId = moduleId.slice(normalizedRoot.length);
    }

    moduleId = handleExtension(moduleId);
    while (moduleId.startsWith("/") || moduleId.startsWith(".")) {
      moduleId = moduleId.slice(1);
    }
    while (moduleId.endsWith("/")) {
      moduleId = moduleId.slice(0, -1);
    }
    if (typeof preserveModulesRoot === "string" && preserveModulesRoot !== "") {
      moduleId = moduleId.startsWith(preserveModulesRoot)
        ? moduleId.slice(preserveModulesRoot.length)
        : moduleId;
    }
    
    // Add virtual prefix back
    return virtualPrefix + moduleId;
  };

const createPathNormalizer =
  ({
    root,
    preserveModulesRoot,
  }: {
    root: string;
    preserveModulesRoot: string | undefined;
  }) =>
  (path: string) => {
    if (typeof path !== "string") {
      throw new Error(`Invalid path: ${JSON.stringify(path)}`);
    }
    let normalPath = normalizePath(path);
    if(normalPath.startsWith(root)) {
      normalPath = normalPath.slice(root.length);
    }
    if (typeof preserveModulesRoot === "string" && preserveModulesRoot !== "") {
      normalPath = normalPath.startsWith(preserveModulesRoot)
        ? normalPath.slice(preserveModulesRoot.length)
        : normalPath;
    }
    while (normalPath.endsWith("/")) {
      normalPath = normalPath.slice(0, -1);
    }
    return normalPath;
  };
/**
 * @description Create a function that normalizes the input
 * @param root - The root of the project
 * @param preserveModulesRoot - The root of the preserve modules
 * @param removeExtension - Whether to remove the extension of the file
 * @returns A function that normalizes the input
 */
export function createInputNormalizer({
  root,
  preserveModulesRoot = undefined,
  removeExtension = DEFAULT_CONFIG.FILE_REGEX,
}: CreateInputNormalizerProps): InputNormalizer {
  const relativeRoot = resolveRootOption(root, preserveModulesRoot);
  const handleExtension = resolveExtensionOptions(removeExtension);

  const normalizeEntryKey = createKeyNormalizer({
    root: root,
    preserveModulesRoot: relativeRoot,
    handleExtension,
  });

  const normalizeEntryPath = createPathNormalizer({
    root: root,
    preserveModulesRoot: relativeRoot,
  });
  function normalizeInput(id: NormalizerInput): [string, string] {
    // Normalize both paths to use POSIX separators
    if (Array.isArray(id)) {
      const [key, path] = id;
      if (typeof key === "string" && Array.isArray(path) && path.length === 2) {
        const isNumber = !isNaN(Number(key));
        if (isNumber) {
          // ignore it
          return normalizeInput([path[0], path[1]]);
        }
        return normalizeInput([join(key, path[0]), path[1]]);
      }
      if (typeof key !== "string" || typeof path !== "string") {
        throw new Error(`Invalid input: ${JSON.stringify(id)}`);
      }
      return [normalizeEntryKey(key), normalizeEntryPath(path)];
    } else if (typeof id === "string") {
      // Return both the normalized ID and original normalized path
      return [normalizeEntryKey(id), normalizeEntryPath(id)];
    } else if (
      typeof id === "object" &&
      id !== null &&
      "$$typeof" in id &&
      "$$id" in id &&
      typeof id.$$id === "string"
    ) {
      const normalized: [string, string] = [
        normalizeEntryKey(id.$$id),
        normalizeEntryPath(id.$$id),
      ];
      return normalized;
    }
    throw new Error(`Invalid input type: ${typeof id}`);
  };

  return (input: NormalizerInput): [string, string] => {
    const [key, path] = normalizeInput(input);
    // Apply the same normalization to both key and path
    const normalizedPath = path.startsWith('/') ? path.slice(1) : path;
    const virtualPrefix = key.match(/^\0+/)?.[0] || '';
    
    // If key has virtual prefix, ensure path has it too
    const finalPath = virtualPrefix ? 
      (normalizedPath.startsWith(virtualPrefix) ? normalizedPath : virtualPrefix + normalizedPath) : 
      normalizedPath;
    
    return [key, finalPath];
  };
}