@remix-run/static-middleware 0.0.0 → 0.2.0

package/dist/lib/static.d.ts

@@ -1,6 +1,6 @@
-import { type FileResponseOptions } from '@remix-run/fetch-router/response-helpers';
 import type { Middleware } from '@remix-run/fetch-router';
-export type StaticFilesOptions = FileResponseOptions & {
+import { type FileResponseOptions } from '@remix-run/fetch-router/response-helpers';
+export interface StaticFilesOptions extends FileResponseOptions {
     /**
      * Filter function to determine which files should be served.
      *
@@ -8,7 +8,15 @@ export type StaticFilesOptions = FileResponseOptions & {
      * @returns Whether to serve the file
      */
     filter?: (path: string) => boolean;
-};
+    /**
+     * Files to try and serve as the index file when the request path targets a directory.
+     *
+     * - `true` (default): Use default index files `['index.html', 'index.htm']`
+     * - `false`: Disable index file serving
+     * - `string[]`: Custom list of index files to try in order
+     */
+    index?: boolean | string[];
+}
 /**
  * Creates a middleware that serves static files from the filesystem.
  *

package/dist/lib/static.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"static.d.ts","sourceRoot":"","sources":["../../src/lib/static.ts"],"names":[],"mappings":"AAEA,OAAO,EAAQ,KAAK,mBAAmB,EAAE,MAAM,0CAA0C,CAAA;AACzF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEzD,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACrD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;CACnC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,UAAU,CAsBtF"}
+{"version":3,"file":"static.d.ts","sourceRoot":"","sources":["../../src/lib/static.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,0CAA0C,CAAA;AAEjD,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;IAClC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,UAAU,CA4DtF"}

package/dist/lib/static.js

@@ -1,5 +1,7 @@
-import { findFile } from '@remix-run/lazy-file/fs';
-import { file } from '@remix-run/fetch-router/response-helpers';
+import * as path from 'node:path';
+import * as fsp from 'node:fs/promises';
+import { openFile } from '@remix-run/fs';
+import { file as sendFile, } from '@remix-run/fetch-router/response-helpers';
 /**
  * Creates a middleware that serves static files from the filesystem.
  *
@@ -26,19 +28,59 @@ import { file } from '@remix-run/fetch-router/response-helpers';
  * })
  */
 export function staticFiles(root, options = {}) {
-    let { filter, ...fileOptions } = options;
+    // Ensure root is an absolute path
+    root = path.resolve(root);
+    let { filter, index: indexOption, ...fileOptions } = options;
+    // Normalize index option
+    let index;
+    if (indexOption === false) {
+        index = [];
+    }
+    else if (indexOption === true || indexOption === undefined) {
+        index = ['index.html', 'index.htm'];
+    }
+    else {
+        index = indexOption;
+    }
     return async (context, next) => {
-        if (context.request.method !== 'GET' && context.request.method !== 'HEAD') {
+        if (context.method !== 'GET' && context.method !== 'HEAD') {
             return next();
         }
         let relativePath = context.url.pathname.replace(/^\/+/, '');
         if (filter && !filter(relativePath)) {
             return next();
         }
-        let fileToServe = await findFile(root, relativePath);
-        if (!fileToServe) {
-            return next();
+        let targetPath = path.join(root, relativePath);
+        let filePath;
+        try {
+            let stats = await fsp.stat(targetPath);
+            if (stats.isFile()) {
+                filePath = targetPath;
+            }
+            else if (stats.isDirectory()) {
+                // Try each index file in turn
+                for (let indexFile of index) {
+                    let indexPath = path.join(targetPath, indexFile);
+                    try {
+                        let indexStats = await fsp.stat(indexPath);
+                        if (indexStats.isFile()) {
+                            filePath = indexPath;
+                            break;
+                        }
+                    }
+                    catch {
+                        // Index file doesn't exist, continue to next
+                    }
+                }
+            }
+        }
+        catch {
+            // Path doesn't exist or isn't accessible, fall through
+        }
+        if (filePath) {
+            let fileName = path.relative(root, filePath);
+            let file = openFile(filePath, { name: fileName });
+            return sendFile(file, context.request, fileOptions);
         }
-        return file(fileToServe, context.request, fileOptions);
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/static-middleware",
-  "version": "0.0.0",
+  "version": "0.2.0",
   "description": "Middleware for serving static files from the filesystem",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -28,12 +28,16 @@
   "devDependencies": {
     "@types/node": "^24.6.0",
     "typescript": "^5.9.3",
-    "@remix-run/fetch-router": "0.9.0",
-    "@remix-run/lazy-file": "3.8.0"
+    "@remix-run/fetch-router": "0.10.0",
+    "@remix-run/form-data-middleware": "0.1.0",
+    "@remix-run/lazy-file": "4.0.0",
+    "@remix-run/fs": "0.1.0",
+    "@remix-run/method-override-middleware": "0.1.0"
   },
   "peerDependencies": {
-    "@remix-run/fetch-router": "^0.9.0",
-    "@remix-run/lazy-file": "^3.8.0"
+    "@remix-run/fetch-router": "^0.10.0",
+    "@remix-run/fs": "^0.1.0",
+    "@remix-run/lazy-file": "^4.0.0"
   },
   "keywords": [
     "fetch",

package/src/lib/static.ts

@@ -1,9 +1,13 @@
-import { findFile } from '@remix-run/lazy-file/fs'
-
-import { file, type FileResponseOptions } from '@remix-run/fetch-router/response-helpers'
+import * as path from 'node:path'
+import * as fsp from 'node:fs/promises'
+import { openFile } from '@remix-run/fs'
 import type { Middleware } from '@remix-run/fetch-router'
+import {
+  file as sendFile,
+  type FileResponseOptions,
+} from '@remix-run/fetch-router/response-helpers'
 
-export type StaticFilesOptions = FileResponseOptions & {
+export interface StaticFilesOptions extends FileResponseOptions {
   /**
    * Filter function to determine which files should be served.
    *
@@ -11,6 +15,14 @@ export type StaticFilesOptions = FileResponseOptions & {
    * @returns Whether to serve the file
    */
   filter?: (path: string) => boolean
+  /**
+   * Files to try and serve as the index file when the request path targets a directory.
+   *
+   * - `true` (default): Use default index files `['index.html', 'index.htm']`
+   * - `false`: Disable index file serving
+   * - `string[]`: Custom list of index files to try in order
+   */
+  index?: boolean | string[]
 }
 
 /**
@@ -39,10 +51,23 @@ export type StaticFilesOptions = FileResponseOptions & {
  * })
  */
 export function staticFiles(root: string, options: StaticFilesOptions = {}): Middleware {
-  let { filter, ...fileOptions } = options
+  // Ensure root is an absolute path
+  root = path.resolve(root)
+
+  let { filter, index: indexOption, ...fileOptions } = options
+
+  // Normalize index option
+  let index: string[]
+  if (indexOption === false) {
+    index = []
+  } else if (indexOption === true || indexOption === undefined) {
+    index = ['index.html', 'index.htm']
+  } else {
+    index = indexOption
+  }
 
   return async (context, next) => {
-    if (context.request.method !== 'GET' && context.request.method !== 'HEAD') {
+    if (context.method !== 'GET' && context.method !== 'HEAD') {
       return next()
     }
 
@@ -52,12 +77,37 @@ export function staticFiles(root: string, options: StaticFilesOptions = {}): Mid
       return next()
     }
 
-    let fileToServe = await findFile(root, relativePath)
+    let targetPath = path.join(root, relativePath)
+    let filePath: string | undefined
 
-    if (!fileToServe) {
-      return next()
+    try {
+      let stats = await fsp.stat(targetPath)
+
+      if (stats.isFile()) {
+        filePath = targetPath
+      } else if (stats.isDirectory()) {
+        // Try each index file in turn
+        for (let indexFile of index) {
+          let indexPath = path.join(targetPath, indexFile)
+          try {
+            let indexStats = await fsp.stat(indexPath)
+            if (indexStats.isFile()) {
+              filePath = indexPath
+              break
+            }
+          } catch {
+            // Index file doesn't exist, continue to next
+          }
+        }
+      }
+    } catch {
+      // Path doesn't exist or isn't accessible, fall through
     }
 
-    return file(fileToServe, context.request, fileOptions)
+    if (filePath) {
+      let fileName = path.relative(root, filePath)
+      let file = openFile(filePath, { name: fileName })
+      return sendFile(file, context.request, fileOptions)
+    }
   }
 }