@remix-run/static-middleware 0.3.0 → 0.4.0

package/dist/lib/directory-listing.js

@@ -2,7 +2,7 @@ import * as path from 'node:path';
 import * as fsp from 'node:fs/promises';
 import { html } from '@remix-run/html-template';
 import { createHtmlResponse } from '@remix-run/response/html';
-import { lookup } from 'mrmime';
+import { detectMimeType } from '@remix-run/mime';
 export async function generateDirectoryListing(dirPath, pathname) {
     let entries = [];
     try {
@@ -19,7 +19,7 @@ export async function generateDirectoryListing(dirPath, pathname) {
                 try {
                     let stats = await fsp.stat(fullPath);
                     size = stats.size;
-                    let mimeType = lookup(dirent.name);
+                    let mimeType = detectMimeType(dirent.name);
                     type = mimeType || 'application/octet-stream';
                 }
                 catch {

package/dist/lib/static.d.ts

@@ -1,51 +1,74 @@
 import type { Middleware } from '@remix-run/fetch-router';
 import { type FileResponseOptions } from '@remix-run/response/file';
-export interface StaticFilesOptions extends FileResponseOptions {
+/**
+ * Function that determines if HTTP Range requests should be supported for a given file.
+ *
+ * @param file - The File object being served
+ * @returns true if range requests should be supported
+ */
+export type AcceptRangesFunction = (file: File) => boolean;
+/**
+ * Options for the `staticFiles` middleware.
+ */
+export interface StaticFilesOptions extends Omit<FileResponseOptions, 'acceptRanges'> {
     /**
      * Filter function to determine which files should be served.
      *
      * @param path The relative path being requested
-     * @returns Whether to serve the file
+     * @return Whether to serve the file
      */
     filter?: (path: string) => boolean;
+    /**
+     * Whether to support HTTP Range requests for partial content.
+     *
+     * Can be a boolean or a function that receives the file.
+     * When enabled, includes Accept-Ranges header and handles Range requests
+     * with 206 Partial Content responses.
+     *
+     * Defaults to enabling ranges only for non-compressible MIME types,
+     * as defined by `isCompressibleMimeType()` from `@remix-run/mime`.
+     *
+     * Note: Range requests and compression are mutually exclusive. When
+     * `Accept-Ranges: bytes` is present in the response headers, the compression
+     * middleware will not compress the response. This is why the default behavior
+     * enables ranges only for non-compressible types.
+     *
+     * @example
+     * // Force range request support for all files
+     * acceptRanges: true
+     *
+     * @example
+     * // Enable ranges for videos only
+     * acceptRanges: (file) => file.type.startsWith('video/')
+     */
+    acceptRanges?: boolean | AcceptRangesFunction;
     /**
      * 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']`
+     * - `true`: Use default index files `['index.html', 'index.htm']`
      * - `false`: Disable index file serving
      * - `string[]`: Custom list of index files to try in order
+     *
+     * @default true
      */
     index?: boolean | string[];
     /**
      * Whether to return an HTML page listing the files in a directory when the request path
      * targets a directory. If both this and `index` are set, `index` takes precedence.
+     *
+     * @default false
      */
     listFiles?: boolean;
 }
 /**
  * Creates a middleware that serves static files from the filesystem.
  *
- * Uses the URL pathname to resolve files, removing the leading slash to make it
- * a relative path. The middleware always falls through to the handler if the file
- * is not found or an error occurs.
+ * Uses the URL pathname to resolve files, removing the leading slash to make it a relative path.
+ * The middleware always falls through to the handler if the file is not found or an error occurs.
  *
  * @param root The root directory to serve files from (absolute or relative to cwd)
- * @param options (optional) configuration for file responses
- *
- * @example
- * let router = createRouter({
- *   middleware: [staticFiles('./public')],
- * })
- *
- * @example
- * // With cache control
- * let router = createRouter({
- *   middleware: [
- *     staticFiles('./public', {
- *       cacheControl: 'public, max-age=3600',
- *     }),
- *   ],
- * })
+ * @param options Configuration for file responses
+ * @return The static files middleware
  */
 export declare function staticFiles(root: string, options?: StaticFilesOptions): Middleware;
 //# sourceMappingURL=static.d.ts.map

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

@@ -1 +1 @@
-{"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,EAAkC,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAInG,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;IAC1B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,UAAU,CAiEtF"}
+{"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,EAAkC,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAInG;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAA;AAE1D;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC;IACnF;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,oBAAoB,CAAA;IAE7C;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;IAC1B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,UAAU,CA8EtF"}

package/dist/lib/static.js

@@ -6,32 +6,17 @@ import { generateDirectoryListing } from "./directory-listing.js";
 /**
  * Creates a middleware that serves static files from the filesystem.
  *
- * Uses the URL pathname to resolve files, removing the leading slash to make it
- * a relative path. The middleware always falls through to the handler if the file
- * is not found or an error occurs.
+ * Uses the URL pathname to resolve files, removing the leading slash to make it a relative path.
+ * The middleware always falls through to the handler if the file is not found or an error occurs.
  *
  * @param root The root directory to serve files from (absolute or relative to cwd)
- * @param options (optional) configuration for file responses
- *
- * @example
- * let router = createRouter({
- *   middleware: [staticFiles('./public')],
- * })
- *
- * @example
- * // With cache control
- * let router = createRouter({
- *   middleware: [
- *     staticFiles('./public', {
- *       cacheControl: 'public, max-age=3600',
- *     }),
- *   ],
- * })
+ * @param options Configuration for file responses
+ * @return The static files middleware
  */
 export function staticFiles(root, options = {}) {
     // Ensure root is an absolute path
     root = path.resolve(root);
-    let { filter, index: indexOption, listFiles, ...fileOptions } = options;
+    let { acceptRanges, filter, index: indexOption, listFiles, ...fileOptions } = options;
     // Normalize index option
     let index;
     if (indexOption === false) {
@@ -85,7 +70,17 @@ export function staticFiles(root, options = {}) {
         if (filePath) {
             let fileName = path.relative(root, filePath);
             let file = openFile(filePath, { name: fileName });
-            return sendFile(file, context.request, fileOptions);
+            let finalFileOptions = { ...fileOptions };
+            // If acceptRanges is a function, evaluate it with the file
+            // Otherwise, pass it directly to sendFile
+            if (typeof acceptRanges === 'function') {
+                finalFileOptions.acceptRanges = acceptRanges(file);
+            }
+            else if (acceptRanges !== undefined) {
+                finalFileOptions.acceptRanges = acceptRanges;
+            }
+            return sendFile(file, context.request, finalFileOptions);
         }
+        return next();
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/static-middleware",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Middleware for serving static files from the filesystem",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -29,13 +29,16 @@
     "@types/node": "^24.6.0",
     "typescript": "^5.9.3",
     "@remix-run/fetch-router": "0.12.0",
-    "@remix-run/method-override-middleware": "0.1.0",
-    "@remix-run/form-data-middleware": "0.1.0"
+    "@remix-run/form-data-middleware": "0.1.0",
+    "@remix-run/method-override-middleware": "0.1.1",
+    "@remix-run/response": "^0.2.0",
+    "@remix-run/mime": "^0.1.0"
   },
   "peerDependencies": {
     "@remix-run/fetch-router": "^0.12.0",
-    "@remix-run/fs": "^0.1.0",
-    "@remix-run/response": "^0.1.0",
+    "@remix-run/fs": "^0.2.0",
+    "@remix-run/mime": "^0.1.0",
+    "@remix-run/response": "^0.2.0",
     "@remix-run/html-template": "^0.3.0"
   },
   "keywords": [
@@ -45,9 +48,6 @@
     "static-files",
     "file-server"
   ],
-  "dependencies": {
-    "mrmime": "^2.0.0"
-  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "clean": "git clean -fdX",

package/src/lib/directory-listing.ts

@@ -2,7 +2,7 @@ import * as path from 'node:path'
 import * as fsp from 'node:fs/promises'
 import { html } from '@remix-run/html-template'
 import { createHtmlResponse } from '@remix-run/response/html'
-import { lookup } from 'mrmime'
+import { detectMimeType } from '@remix-run/mime'
 
 interface DirectoryEntry {
   name: string
@@ -32,7 +32,7 @@ export async function generateDirectoryListing(
         try {
           let stats = await fsp.stat(fullPath)
           size = stats.size
-          let mimeType = lookup(dirent.name)
+          let mimeType = detectMimeType(dirent.name)
           type = mimeType || 'application/octet-stream'
         } catch {
           // Unable to stat file, use defaults

package/src/lib/static.ts

@@ -6,25 +6,66 @@ import { createFileResponse as sendFile, type FileResponseOptions } from '@remix
 
 import { generateDirectoryListing } from './directory-listing.ts'
 
-export interface StaticFilesOptions extends FileResponseOptions {
+/**
+ * Function that determines if HTTP Range requests should be supported for a given file.
+ *
+ * @param file - The File object being served
+ * @returns true if range requests should be supported
+ */
+export type AcceptRangesFunction = (file: File) => boolean
+
+/**
+ * Options for the `staticFiles` middleware.
+ */
+export interface StaticFilesOptions extends Omit<FileResponseOptions, 'acceptRanges'> {
   /**
    * Filter function to determine which files should be served.
    *
    * @param path The relative path being requested
-   * @returns Whether to serve the file
+   * @return Whether to serve the file
    */
   filter?: (path: string) => boolean
+
+  /**
+   * Whether to support HTTP Range requests for partial content.
+   *
+   * Can be a boolean or a function that receives the file.
+   * When enabled, includes Accept-Ranges header and handles Range requests
+   * with 206 Partial Content responses.
+   *
+   * Defaults to enabling ranges only for non-compressible MIME types,
+   * as defined by `isCompressibleMimeType()` from `@remix-run/mime`.
+   *
+   * Note: Range requests and compression are mutually exclusive. When
+   * `Accept-Ranges: bytes` is present in the response headers, the compression
+   * middleware will not compress the response. This is why the default behavior
+   * enables ranges only for non-compressible types.
+   *
+   * @example
+   * // Force range request support for all files
+   * acceptRanges: true
+   *
+   * @example
+   * // Enable ranges for videos only
+   * acceptRanges: (file) => file.type.startsWith('video/')
+   */
+  acceptRanges?: boolean | AcceptRangesFunction
+
   /**
    * 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']`
+   * - `true`: Use default index files `['index.html', 'index.htm']`
    * - `false`: Disable index file serving
    * - `string[]`: Custom list of index files to try in order
+   *
+   * @default true
    */
   index?: boolean | string[]
   /**
    * Whether to return an HTML page listing the files in a directory when the request path
    * targets a directory. If both this and `index` are set, `index` takes precedence.
+   *
+   * @default false
    */
   listFiles?: boolean
 }
@@ -32,33 +73,18 @@ export interface StaticFilesOptions extends FileResponseOptions {
 /**
  * Creates a middleware that serves static files from the filesystem.
  *
- * Uses the URL pathname to resolve files, removing the leading slash to make it
- * a relative path. The middleware always falls through to the handler if the file
- * is not found or an error occurs.
+ * Uses the URL pathname to resolve files, removing the leading slash to make it a relative path.
+ * The middleware always falls through to the handler if the file is not found or an error occurs.
  *
  * @param root The root directory to serve files from (absolute or relative to cwd)
- * @param options (optional) configuration for file responses
- *
- * @example
- * let router = createRouter({
- *   middleware: [staticFiles('./public')],
- * })
- *
- * @example
- * // With cache control
- * let router = createRouter({
- *   middleware: [
- *     staticFiles('./public', {
- *       cacheControl: 'public, max-age=3600',
- *     }),
- *   ],
- * })
+ * @param options Configuration for file responses
+ * @return The static files middleware
  */
 export function staticFiles(root: string, options: StaticFilesOptions = {}): Middleware {
   // Ensure root is an absolute path
   root = path.resolve(root)
 
-  let { filter, index: indexOption, listFiles, ...fileOptions } = options
+  let { acceptRanges, filter, index: indexOption, listFiles, ...fileOptions } = options
 
   // Normalize index option
   let index: string[]
@@ -116,7 +142,20 @@ export function staticFiles(root: string, options: StaticFilesOptions = {}): Mid
     if (filePath) {
       let fileName = path.relative(root, filePath)
       let file = openFile(filePath, { name: fileName })
-      return sendFile(file, context.request, fileOptions)
+
+      let finalFileOptions: FileResponseOptions = { ...fileOptions }
+
+      // If acceptRanges is a function, evaluate it with the file
+      // Otherwise, pass it directly to sendFile
+      if (typeof acceptRanges === 'function') {
+        finalFileOptions.acceptRanges = acceptRanges(file)
+      } else if (acceptRanges !== undefined) {
+        finalFileOptions.acceptRanges = acceptRanges
+      }
+
+      return sendFile(file, context.request, finalFileOptions)
     }
+
+    return next()
   }
 }