effect-start 0.23.1 → 0.25.0

package/dist/FileRouter.js

@@ -1,148 +1,204 @@
-import * as FileSystem from "./FileSystem.js";
-import * as Data from "effect/Data";
-import * as Effect from "effect/Effect";
-import * as Either from "effect/Either";
-import * as Function from "effect/Function";
-import * as Layer from "effect/Layer";
-import * as Stream from "effect/Stream";
-import * as NPath from "node:path";
-import * as NUrl from "node:url";
-import * as Development from "./Development.js";
-import * as FilePathPattern from "./FilePathPattern.js";
-import * as FileRouterCodegen from "./FileRouterCodegen.js";
-import * as NodeUtils from "./node/NodeUtils.js";
-import * as Route from "./Route.js";
-import * as RouteTree from "./RouteTree.js";
-export class FileRouterError extends Data.TaggedError("FileRouterError") {
-}
-const ROUTE_PATH_REGEX = /^\/?(.*\/?)(?:route|layer)\.(jsx?|tsx?)$/;
+import * as FileSystem from "./FileSystem.js"
+import * as Data from "effect/Data"
+import * as Effect from "effect/Effect"
+import * as Either from "effect/Either"
+import * as Function from "effect/Function"
+import * as Layer from "effect/Layer"
+import * as Stream from "effect/Stream"
+import * as NPath from "node:path"
+import * as NUrl from "node:url"
+import * as Development from "./Development.js"
+import * as FilePathPattern from "./FilePathPattern.js"
+import * as FileRouterCodegen from "./FileRouterCodegen.js"
+import * as NodeUtils from "./node/NodeUtils.js"
+import * as Route from "./Route.js"
+import * as RouteTree from "./RouteTree.js"
+
+export class FileRouterError extends Data.TaggedError("FileRouterError") {}
+
+/**
+ * Routes sorted by depth, with rest parameters at the end.
+ * - layer.tsx
+ * - users/route.tsx
+ * - users/[userId]/route.tsx
+ * - [[rest]]/route.tsx
+ */
+
+const ROUTE_PATH_REGEX = /^\/?(.*\/?)(?:route|layer)\.(jsx?|tsx?)$/
+
 export function parseRoute(path) {
-    const segs = FilePathPattern.segments(path);
-    const lastSeg = segs.at(-1);
-    const handleMatch = lastSeg?._tag === "LiteralSegment" && lastSeg.value.match(/^(route|layer)\.(tsx?|jsx?)$/);
-    const handle = handleMatch ? handleMatch[1] : null;
-    if (!handle) {
-        return null;
-    }
-    const pathSegments = segs.slice(0, -1);
-    const validated = FilePathPattern.validate(FilePathPattern.format(pathSegments));
-    if (Either.isLeft(validated)) {
-        return null;
-    }
-    const restIndex = pathSegments.findIndex((seg) => seg._tag === "RestSegment");
-    if (restIndex !== -1 && restIndex !== pathSegments.length - 1) {
-        return null;
-    }
-    const routePathSegments = pathSegments.filter((seg) => seg._tag !== "GroupSegment");
-    const routePath = FilePathPattern.format(routePathSegments);
-    return {
-        handle,
-        modulePath: `/${path}`,
-        routePath,
-        segments: pathSegments,
-    };
+  const segs = FilePathPattern.segments(path)
+
+  const lastSeg = segs.at(-1)
+  const handleMatch =
+    lastSeg?._tag === "LiteralSegment" && lastSeg.value.match(/^(route|layer)\.(tsx?|jsx?)$/)
+  const handle = handleMatch ? (handleMatch[1]) : null
+
+  if (!handle) {
+    return null
+  }
+
+  const pathSegments = segs.slice(0, -1)
+
+  const validated = FilePathPattern.validate(FilePathPattern.format(pathSegments))
+  if (Either.isLeft(validated)) {
+    return null
+  }
+
+  const restIndex = pathSegments.findIndex((seg) => seg._tag === "RestSegment")
+  if (restIndex !== -1 && restIndex !== pathSegments.length - 1) {
+    return null
+  }
+
+  const routePathSegments = pathSegments.filter((seg) => seg._tag !== "GroupSegment")
+  const routePath = FilePathPattern.format(routePathSegments)
+
+  return {
+    handle,
+    modulePath: `/${path}`,
+    routePath,
+    segments: pathSegments,
+  }
 }
+
 function importModule(load) {
-    return Effect.tryPromise({
-        try: () => load(),
-        catch: (cause) => new FileRouterError({ reason: "Import", cause }),
-    });
+  return Effect.tryPromise({
+    try: () => load(),
+    catch: (cause) => new FileRouterError({ reason: "Import", cause }),
+  })
 }
-export function layer(loadOrOptions) {
-    const options = typeof loadOrOptions === "function"
-        ? {
-            load: loadOrOptions,
-            path: NPath.join(NodeUtils.getEntrypoint(), "routes"),
+
+/**
+ * Generates a tree file that references all routes.
+ */
+export function layer(
+  loadOrOptions,
+) {
+  const options =
+    typeof loadOrOptions === "function"
+      ? {
+          load: loadOrOptions,
+          path: NPath.join(NodeUtils.getEntrypoint(), "routes"),
         }
-        : loadOrOptions;
-    let treePath = options.path;
-    if (treePath.startsWith("file://")) {
-        treePath = NUrl.fileURLToPath(treePath);
-    }
-    if (NPath.extname(treePath) === "") {
-        treePath = NPath.join(treePath, "server.gen.ts");
-    }
-    const routesPath = NPath.dirname(treePath);
-    const treeFilename = NPath.basename(treePath);
-    const relativeRoutesPath = NPath.relative(process.cwd(), routesPath);
-    return Layer.scoped(Route.Routes, Effect.gen(function* () {
-        // Generate routes file before loading
-        yield* FileRouterCodegen.update(routesPath, treeFilename);
-        // Load and build route tree
-        const m = yield* importModule(options.load);
-        const routeTree = yield* fromFileRoutes(m.default);
-        // Watch for changes (only when Development service is available)
-        yield* Function.pipe(Development.stream(), Stream.filter((e) => e._tag !== "Reload" && e.path.startsWith(relativeRoutesPath)), Stream.runForEach(() => FileRouterCodegen.update(routesPath, treeFilename)), Effect.fork);
-        return routeTree;
-    }));
+      : loadOrOptions
+  let treePath = options.path
+  if (treePath.startsWith("file://")) {
+    treePath = NUrl.fileURLToPath(treePath)
+  }
+  if (NPath.extname(treePath) === "") {
+    treePath = NPath.join(treePath, "server.gen.ts")
+  }
+
+  const routesPath = NPath.dirname(treePath)
+  const treeFilename = NPath.basename(treePath)
+  const relativeRoutesPath = NPath.relative(process.cwd(), routesPath)
+
+  return Layer.scoped(
+    Route.Routes,
+    Effect.gen(function* () {
+      // Generate routes file before loading
+      yield* FileRouterCodegen.update(routesPath, treeFilename)
+
+      // Load and build route tree
+      const m = yield* importModule(options.load)
+      const routeTree = yield* fromFileRoutes(m.default)
+
+      // Watch for changes (only when Development service is available)
+      yield* Function.pipe(
+        Development.stream(),
+        Stream.filter((e) => e._tag !== "Reload" && e.path.startsWith(relativeRoutesPath)),
+        Stream.runForEach(() => FileRouterCodegen.update(routesPath, treeFilename)),
+        Effect.fork,
+      )
+
+      return routeTree
+    }),
+  )
 }
+
 export function fromFileRoutes(fileRoutes) {
-    return Effect.gen(function* () {
-        const mounts = {};
-        for (const [path, loaders] of Object.entries(fileRoutes)) {
-            const modules = yield* Effect.forEach(loaders, (loader) => Effect.promise(() => loader()));
-            const allRoutes = [];
-            for (const m of modules) {
-                if (Route.isRouteSet(m.default)) {
-                    for (const route of m.default) {
-                        ;
-                        allRoutes.push(route);
-                    }
-                }
-            }
-            mounts[path] = allRoutes;
+  return Effect.gen(function* () {
+    const mounts = {}
+
+    for (const [path, loaders] of Object.entries(fileRoutes)) {
+      const modules = yield* Effect.forEach(loaders, (loader) => Effect.promise(() => loader()))
+
+      const allRoutes = []
+
+      for (const m of modules) {
+        if (Route.isRouteSet(m.default)) {
+          for (const route of m.default) {
+            ;(allRoutes).push(route)
+          }
         }
-        return RouteTree.make(mounts);
-    });
+      }
+
+      mounts[path] = allRoutes
+    }
+
+    return RouteTree.make(mounts)
+  })
 }
-export function walkRoutesDirectory(dir) {
-    return Effect.gen(function* () {
-        const fs = yield* FileSystem.FileSystem;
-        const files = yield* fs.readDirectory(dir, { recursive: true });
-        return yield* getFileRoutes(files);
-    });
+
+export function walkRoutesDirectory(
+  dir,
+) {
+  return Effect.gen(function* () {
+    const fs = yield* FileSystem.FileSystem
+    const files = yield* fs.readDirectory(dir, { recursive: true })
+
+    return yield* getFileRoutes(files)
+  })
 }
-export function getFileRoutes(paths) {
-    return Effect.gen(function* () {
-        const routes = paths
-            .map((f) => f.match(ROUTE_PATH_REGEX))
-            .filter(Boolean)
-            .map((v) => {
-            const path = v[0];
-            try {
-                return parseRoute(path);
-            }
-            catch {
-                return null;
-            }
-        })
-            .filter((route) => route !== null)
-            .toSorted((a, b) => {
-            const aDepth = a.segments.length;
-            const bDepth = b.segments.length;
-            const aHasRest = a.segments.some((seg) => seg._tag === "RestSegment");
-            const bHasRest = b.segments.some((seg) => seg._tag === "RestSegment");
-            return (
-            // rest is a dominant factor (routes with rest come last)
-            (+aHasRest - +bHasRest) * 1000 +
-                // depth is reversed for rest
-                (aDepth - bDepth) * (1 - 2 * +aHasRest) +
-                // lexicographic comparison as tiebreaker
-                a.modulePath.localeCompare(b.modulePath) * 0.001);
-        });
-        // Detect conflicting routes at the same path
-        const routesByPath = new Map();
-        for (const route of routes) {
-            const existing = routesByPath.get(route.routePath) || [];
-            existing.push(route);
-            routesByPath.set(route.routePath, existing);
-        }
-        for (const [path, pathRoutes] of routesByPath) {
-            const routeHandles = pathRoutes.filter((h) => h.handle === "route");
-            if (routeHandles.length > 1) {
-                yield* new FileRouterError({ reason: "Conflict", path });
-            }
+
+export function getFileRoutes(
+  paths,
+) {
+  return Effect.gen(function* () {
+    const routes = paths
+      .map((f) => f.match(ROUTE_PATH_REGEX))
+      .filter(Boolean)
+      .map((v) => {
+        const path = v[0]
+        try {
+          return parseRoute(path)
+        } catch {
+          return null
         }
-        return routes;
-    });
+      })
+      .filter((route) => route !== null)
+      .toSorted((a, b) => {
+        const aDepth = a.segments.length
+        const bDepth = b.segments.length
+        const aHasRest = a.segments.some((seg) => seg._tag === "RestSegment")
+        const bHasRest = b.segments.some((seg) => seg._tag === "RestSegment")
+
+        return (
+          // rest is a dominant factor (routes with rest come last)
+          (+aHasRest - +bHasRest) * 1000 +
+          // depth is reversed for rest
+          (aDepth - bDepth) * (1 - 2 * +aHasRest) +
+          // lexicographic comparison as tiebreaker
+          a.modulePath.localeCompare(b.modulePath) * 0.001
+        )
+      })
+
+    // Detect conflicting routes at the same path
+    const routesByPath = new Map()
+    for (const route of routes) {
+      const existing = routesByPath.get(route.routePath) || []
+      existing.push(route)
+      routesByPath.set(route.routePath, existing)
+    }
+
+    for (const [path, pathRoutes] of routesByPath) {
+      const routeHandles = pathRoutes.filter((h) => h.handle === "route")
+
+      if (routeHandles.length > 1) {
+        yield* new FileRouterError({ reason: "Conflict", path })
+      }
+    }
+
+    return routes
+  })
 }