koa-files 3.1.10 → 3.2.0

package/README.md

@@ -28,8 +28,8 @@ interface Headers {
   [key: string]: string | string[];
 }
 
-interface HeaderFunction {
-  (path: string, stats: Stats): Headers | void;
+interface HeadersFunction {
+  (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
 
 export interface FileSystem {
@@ -47,7 +47,7 @@ export interface Options {
   lastModified?: boolean;
   highWaterMark?: number;
   ignore?: IgnoreFunction;
-  headers?: Headers | HeaderFunction;
+  headers?: Headers | HeadersFunction;
 }
 
 export default function server(root: string, options?: Options): Middleware;

package/cjs/{utils/stream.cjs → ReadStream.cjs}

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -13,10 +13,10 @@ const buffer = require('buffer');
 const stream = require('stream');
 
 /**
- * @module stream
+ * @module ReadStream
  */
 const DISPOSE_EVENT = Symbol('dispose');
-class FileReadStream extends stream.Readable {
+class ReadStream extends stream.Readable {
   /**
    * @constructor
    * @param path The file path.
@@ -24,8 +24,8 @@ class FileReadStream extends stream.Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark } = options;
-    super({ encoding, highWaterMark });
+    const { fs, highWaterMark } = options;
+    super({ highWaterMark });
     this.bytesRead = 0;
     this.fd = null;
     this.reading = false;
@@ -218,4 +218,4 @@ class FileReadStream extends stream.Readable {
   }
 }
 
-exports.FileReadStream = FileReadStream;
+exports.ReadStream = ReadStream;

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -11,9 +11,9 @@
 
 const createETag = require('etag');
 const fs = require('fs');
+const ReadStream = require('./ReadStream.cjs');
 const fs$1 = require('./utils/fs.cjs');
 const path$1 = require('path');
-const stream = require('./utils/stream.cjs');
 const path = require('./utils/path.cjs');
 const http = require('./utils/http.cjs');
 
@@ -67,46 +67,47 @@ class Service {
    * @param path The file path.
    * @param stats The file stats.
    */
-  setupHeaders(context, path, stats) {
+  async setupHeaders({ response }, path, stats) {
     const { options } = this;
-    const { headers, etag } = options;
+    const { headers } = options;
     // Set status.
-    context.status = 200;
+    response.status = 200;
     // Set Content-Type.
-    context.type = path$1.extname(path);
+    response.type = path$1.extname(path);
+    // Set headers.
+    if (headers) {
+      if (isFunction(headers)) {
+        const fields = await headers(path, stats);
+        if (fields) {
+          response.set(fields);
+        }
+      } else {
+        response.set(headers);
+      }
+    }
     // Accept-Ranges.
     if (options.acceptRanges === false) {
       // Set Accept-Ranges to none tell client not support.
-      context.set('Accept-Ranges', 'none');
+      response.set('Accept-Ranges', 'none');
     } else {
       // Set Accept-Ranges.
-      context.set('Accept-Ranges', 'bytes');
+      response.set('Accept-Ranges', 'bytes');
     }
     // ETag.
-    if (etag === false) {
+    if (options.etag === false) {
       // Remove ETag.
-      context.remove('ETag');
-    } else {
-      context.set('ETag', createETag__default.default(stats));
+      response.remove('ETag');
+    } else if (!response.get('ETag')) {
+      // Set weak ETag.
+      response.set('ETag', createETag__default.default(stats));
     }
     // Last-Modified.
     if (options.lastModified === false) {
       // Remove Last-Modified.
-      context.remove('Last-Modified');
-    } else {
-      // Set mtime utc string.
-      context.set('Last-Modified', stats.mtime.toUTCString());
-    }
-    // Set headers.
-    if (headers) {
-      if (isFunction(headers)) {
-        const fields = headers(path, stats);
-        if (fields) {
-          context.set(fields);
-        }
-      } else {
-        context.set(headers);
-      }
+      response.remove('Last-Modified');
+    } else if (!response.get('Last-Modified')) {
+      // Set last modified from mtime.
+      response.set('Last-Modified', stats.mtime.toUTCString());
     }
   }
   /**
@@ -116,17 +117,21 @@ class Service {
    * @param context The koa context.
    */
   async respond(context) {
-    const { root } = this;
+    const { request } = context;
+    const { method } = request;
     // Only support GET and HEAD (405).
-    if (context.method !== 'GET' && context.method !== 'HEAD') {
+    if (method !== 'GET' && method !== 'HEAD') {
       return false;
     }
     // Get pathname of file.
-    const pathname = http.decodeURI(context.path);
+    const pathname = http.decodeURI(request.path);
     // Pathname decode failed or includes null byte(s).
     if (pathname === -1 || pathname.includes('\0')) {
       return context.throw(400);
     }
+    // Get service root.
+    const { root } = this;
+    // Get file path.
     const path$2 = path.unixify(path$1.join(root, pathname));
     // Malicious path (403).
     if (path.isOutRoot(path$2, root)) {
@@ -138,10 +143,8 @@ class Service {
     }
     // Get options.
     const { options } = this;
-    // Get file system.
-    const { fs } = options;
     // File stats.
-    const stats = await fs$1.stat(fs, path$2);
+    const stats = await fs$1.stat(options.fs, path$2);
     // Check file stats.
     if (
       // File not exist (404 | 500).
@@ -153,30 +156,32 @@ class Service {
     ) {
       return false;
     }
+    // Koa response.
+    const { response } = context;
     // Setup headers.
-    this.setupHeaders(context, path$2, stats);
+    await this.setupHeaders(context, path$2, stats);
     // Conditional get support.
     if (http.isConditionalGET(context)) {
-      // Request precondition failure.
-      if (http.isPreconditionFailure(context)) {
+      // Request precondition failed.
+      if (http.isPreconditionFailed(context)) {
         return context.throw(412);
       }
       // Request fresh (304).
-      if (context.fresh) {
+      if (request.fresh) {
         // Set status.
-        context.status = 304;
+        response.status = 304;
         // Set body null.
-        context.body = null;
+        response.body = null;
         // File found.
         return true;
       }
     }
     // Head request.
-    if (context.method === 'HEAD') {
+    if (method === 'HEAD') {
       // Set Content-Length.
-      context.length = stats.size;
+      response.length = stats.size;
       // Set body null
-      context.body = null;
+      response.body = null;
       // File found.
       return true;
     }
@@ -185,7 +190,7 @@ class Service {
     // 416
     if (ranges === -1) {
       // Set Content-Range.
-      context.set('Content-Range', `bytes */${stats.size}`);
+      response.set('Content-Range', `bytes */${stats.size}`);
       // Unsatisfiable 416.
       return context.throw(416);
     }
@@ -193,10 +198,8 @@ class Service {
     if (ranges === -2) {
       return context.throw(400);
     }
-    // Get stream options.
-    const { highWaterMark } = options;
     // Set response body.
-    context.body = new stream.FileReadStream(path$2, ranges, { fs, highWaterMark });
+    response.body = new ReadStream.ReadStream(path$2, ranges, options);
     // File found.
     return true;
   }

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/hash.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/http.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -22,23 +22,8 @@ const parseRange__default = /*#__PURE__*/ _interopDefault(parseRange);
 /**
  * @module http
  */
-const TOKEN_SPLIT_REGEX = /\s*,\s*/;
-/**
- * @function isETag
- * @description Check if etag is valid.
- * @param value The value to check.
- */
-function isETag(value) {
-  return /^(?:W\/)?"[\s\S]+"$/.test(value);
-}
-/**
- * @function parseTokens
- * @description Parse HTTP tokens.
- * @param value The tokens value string.
- */
-function parseTokens(value) {
-  return value.trim().split(TOKEN_SPLIT_REGEX);
-}
+const SPLIT_ETAG_RE = /\s*,\s*/;
+const SINGLE_ETAG_RE = /^(?:W\/)?"[ !#-\x7E\x80-\xFF]+"$/;
 /**
  * @function decodeURI
  * @description Decode URI component.
@@ -51,45 +36,12 @@ function decodeURI(URI) {
     return -1;
   }
 }
-/**
- * @function isRangeFresh
- * @description Check if request range fresh.
- * @param context Koa context.
- */
-function isRangeFresh(context) {
-  const { request, response } = context;
-  const ifRange = request.get('If-Range');
-  // No If-Range.
-  if (!ifRange) {
-    return true;
-  }
-  // If-Range as etag.
-  if (isETag(ifRange)) {
-    const etag = response.get('ETag');
-    return !!(etag && isETagFresh(ifRange, etag));
-  }
-  // If-Range as modified date.
-  const lastModified = response.get('Last-Modified');
-  return Date.parse(lastModified) <= Date.parse(ifRange);
-}
-/**
- * @function isETagFresh
- * @description Check if etag is fresh.
- * @param match The match value.
- * @param etag The etag value.
- */
-function isETagFresh(match, etag) {
-  return parseTokens(match).some(match => {
-    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-  });
-}
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
  * @param context The koa context.
  */
-function isConditionalGET(context) {
-  const { request } = context;
+function isConditionalGET({ request }) {
   return !!(
     request.get('If-Match') ||
     request.get('If-None-Match') ||
@@ -98,30 +50,72 @@ function isConditionalGET(context) {
   );
 }
 /**
- * @function isPreconditionFailure
- * @description Check if request precondition failure.
+ * @function isETagMatch
+ * @see https://httpwg.org/specs/rfc9110.html
+ * @param match The match value.
+ * @param etag The etag value.
+ * @param isIfMatch The flag of if-match.
+ */
+function isETagMatch(match, etag, isIfMatch) {
+  // Trim etag.
+  etag = etag.trim();
+  // Weak tags cannot be matched and return false.
+  if (!etag || etag.startsWith('W/')) {
+    return false;
+  }
+  // Trim match.
+  match = match.trim();
+  // Check If-Match.
+  if (isIfMatch) {
+    if (match === '*') {
+      return true;
+    }
+    // If-Match maybe a list of etag.
+    return match.split(SPLIT_ETAG_RE).includes(etag);
+  }
+  // Check If-Range.
+  return match === etag;
+}
+/**
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
  * @param context The koa context.
  */
-function isPreconditionFailure({ request, response }) {
+function isPreconditionFailed({ request, response }) {
   // If-Match.
-  const match = request.get('If-Match');
-  // Check if request match.
-  if (match) {
-    // Etag.
-    const etag = response.get('ETag');
-    return !etag || match === '*' || !isETagFresh(match, etag);
+  const ifMatch = request.get('If-Match');
+  // Check If-Match.
+  if (ifMatch) {
+    return !isETagMatch(ifMatch, response.get('ETag'), true);
   }
   // If-Unmodified-Since.
   const unmodifiedSince = Date.parse(request.get('If-Unmodified-Since'));
-  // Check if request unmodified.
+  // Check If-Unmodified-Since.
   if (!Number.isNaN(unmodifiedSince)) {
-    // Last-Modified.
     const lastModified = Date.parse(response.get('Last-Modified'));
     return Number.isNaN(lastModified) || lastModified > unmodifiedSince;
   }
   // Check precondition passed.
   return false;
 }
+/**
+ * @function isRangeFresh
+ * @description Check if request range fresh.
+ * @param context Koa context.
+ */
+function isRangeFresh({ request, response }) {
+  const ifRange = request.get('If-Range');
+  // No If-Range.
+  if (!ifRange) {
+    return true;
+  }
+  // If-Range as modified date failed.
+  if (SINGLE_ETAG_RE.test(ifRange)) {
+    return isETagMatch(ifRange, response.get('ETag'));
+  }
+  // Check if Last-Modified is valid and equal to If-Range date
+  return Date.parse(response.get('Last-Modified')) <= Date.parse(ifRange);
+}
 /**
  * @function parseRanges
  * @description Parse ranges.
@@ -130,9 +124,10 @@ function isPreconditionFailure({ request, response }) {
  */
 function parseRanges(context, stats) {
   const { size } = stats;
+  const { request, response } = context;
   // Range support.
-  if (/^bytes$/i.test(context.response.get('Accept-Ranges'))) {
-    const range = context.request.get('Range');
+  if (/^bytes$/i.test(response.get('Accept-Ranges'))) {
+    const range = request.get('Range');
     // Range fresh.
     if (range && isRangeFresh(context)) {
       // Parse range -1 -2 or [].
@@ -145,7 +140,7 @@ function parseRanges(context, stats) {
       // Ranges ok, support multiple ranges.
       if (parsed.type === 'bytes') {
         // Set 206 status.
-        context.status = 206;
+        response.status = 206;
         const { length } = parsed;
         // Multiple ranges.
         if (length > 1) {
@@ -158,11 +153,11 @@ function parseRanges(context, stats) {
           // Range boundary.
           const boundary = `${hash.generate(32)}`;
           // Multipart Content-Type.
-          const contentType = `Content-Type: ${context.type}`;
+          const contentType = `Content-Type: ${response.type}`;
           // Range suffix.
           const suffix = buffer.Buffer.from(`\r\n--${boundary}--\r\n`);
           // Override Content-Type.
-          context.type = `multipart/byteranges; boundary="${boundary}"`;
+          response.type = `multipart/byteranges; boundary="${boundary}"`;
           // Map ranges.
           for (const [index, { start, end }] of entries) {
             const length = end - start + 1;
@@ -177,7 +172,7 @@ function parseRanges(context, stats) {
           // Compute Content-Length.
           contentLength += suffix.length;
           // Set Content-Length.
-          context.length = contentLength;
+          response.length = contentLength;
           // The last add suffix boundary.
           ranges[length - 1].suffix = suffix;
           // Return ranges.
@@ -186,9 +181,9 @@ function parseRanges(context, stats) {
           const [{ start, end }] = parsed;
           const length = end - start + 1;
           // Set Content-Length.
-          context.length = length;
+          response.length = length;
           // Set Content-Range.
-          context.set('Content-Range', `bytes ${start}-${end}/${size}`);
+          response.set('Content-Range', `bytes ${start}-${end}/${size}`);
           // Return ranges.
           return [{ offset: start, length }];
         }
@@ -196,12 +191,12 @@ function parseRanges(context, stats) {
     }
   }
   // Set Content-Length.
-  context.length = size;
+  response.length = size;
   // Return ranges.
   return [{ offset: 0, length: size }];
 }
 
 exports.decodeURI = decodeURI;
 exports.isConditionalGET = isConditionalGET;
-exports.isPreconditionFailure = isPreconditionFailure;
+exports.isPreconditionFailed = isPreconditionFailed;
 exports.parseRanges = parseRanges;

package/cjs/utils/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/{utils/stream.js → ReadStream.js}

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -11,10 +11,10 @@ import { Buffer } from 'buffer';
 import { Readable } from 'stream';
 
 /**
- * @module stream
+ * @module ReadStream
  */
 const DISPOSE_EVENT = Symbol('dispose');
-class FileReadStream extends Readable {
+class ReadStream extends Readable {
   /**
    * @constructor
    * @param path The file path.
@@ -22,8 +22,8 @@ class FileReadStream extends Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark } = options;
-    super({ encoding, highWaterMark });
+    const { fs, highWaterMark } = options;
+    super({ highWaterMark });
     this.bytesRead = 0;
     this.fd = null;
     this.reading = false;
@@ -216,4 +216,4 @@ class FileReadStream extends Readable {
   }
 }
 
-export { FileReadStream };
+export { ReadStream };

package/esm/Service.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -9,11 +9,11 @@
 
 import createETag from 'etag';
 import fs from 'fs';
+import { ReadStream } from './ReadStream.js';
 import { stat } from './utils/fs.js';
 import { resolve, extname, join } from 'path';
-import { FileReadStream } from './utils/stream.js';
 import { unixify, isOutRoot, hasTrailingSlash } from './utils/path.js';
-import { decodeURI, isConditionalGET, isPreconditionFailure, parseRanges } from './utils/http.js';
+import { decodeURI, isConditionalGET, isPreconditionFailed, parseRanges } from './utils/http.js';
 
 /**
  * @module Service
@@ -58,46 +58,47 @@ class Service {
    * @param path The file path.
    * @param stats The file stats.
    */
-  setupHeaders(context, path, stats) {
+  async setupHeaders({ response }, path, stats) {
     const { options } = this;
-    const { headers, etag } = options;
+    const { headers } = options;
     // Set status.
-    context.status = 200;
+    response.status = 200;
     // Set Content-Type.
-    context.type = extname(path);
+    response.type = extname(path);
+    // Set headers.
+    if (headers) {
+      if (isFunction(headers)) {
+        const fields = await headers(path, stats);
+        if (fields) {
+          response.set(fields);
+        }
+      } else {
+        response.set(headers);
+      }
+    }
     // Accept-Ranges.
     if (options.acceptRanges === false) {
       // Set Accept-Ranges to none tell client not support.
-      context.set('Accept-Ranges', 'none');
+      response.set('Accept-Ranges', 'none');
     } else {
       // Set Accept-Ranges.
-      context.set('Accept-Ranges', 'bytes');
+      response.set('Accept-Ranges', 'bytes');
     }
     // ETag.
-    if (etag === false) {
+    if (options.etag === false) {
       // Remove ETag.
-      context.remove('ETag');
-    } else {
-      context.set('ETag', createETag(stats));
+      response.remove('ETag');
+    } else if (!response.get('ETag')) {
+      // Set weak ETag.
+      response.set('ETag', createETag(stats));
     }
     // Last-Modified.
     if (options.lastModified === false) {
       // Remove Last-Modified.
-      context.remove('Last-Modified');
-    } else {
-      // Set mtime utc string.
-      context.set('Last-Modified', stats.mtime.toUTCString());
-    }
-    // Set headers.
-    if (headers) {
-      if (isFunction(headers)) {
-        const fields = headers(path, stats);
-        if (fields) {
-          context.set(fields);
-        }
-      } else {
-        context.set(headers);
-      }
+      response.remove('Last-Modified');
+    } else if (!response.get('Last-Modified')) {
+      // Set last modified from mtime.
+      response.set('Last-Modified', stats.mtime.toUTCString());
     }
   }
   /**
@@ -107,17 +108,21 @@ class Service {
    * @param context The koa context.
    */
   async respond(context) {
-    const { root } = this;
+    const { request } = context;
+    const { method } = request;
     // Only support GET and HEAD (405).
-    if (context.method !== 'GET' && context.method !== 'HEAD') {
+    if (method !== 'GET' && method !== 'HEAD') {
       return false;
     }
     // Get pathname of file.
-    const pathname = decodeURI(context.path);
+    const pathname = decodeURI(request.path);
     // Pathname decode failed or includes null byte(s).
     if (pathname === -1 || pathname.includes('\0')) {
       return context.throw(400);
     }
+    // Get service root.
+    const { root } = this;
+    // Get file path.
     const path = unixify(join(root, pathname));
     // Malicious path (403).
     if (isOutRoot(path, root)) {
@@ -129,10 +134,8 @@ class Service {
     }
     // Get options.
     const { options } = this;
-    // Get file system.
-    const { fs } = options;
     // File stats.
-    const stats = await stat(fs, path);
+    const stats = await stat(options.fs, path);
     // Check file stats.
     if (
       // File not exist (404 | 500).
@@ -144,30 +147,32 @@ class Service {
     ) {
       return false;
     }
+    // Koa response.
+    const { response } = context;
     // Setup headers.
-    this.setupHeaders(context, path, stats);
+    await this.setupHeaders(context, path, stats);
     // Conditional get support.
     if (isConditionalGET(context)) {
-      // Request precondition failure.
-      if (isPreconditionFailure(context)) {
+      // Request precondition failed.
+      if (isPreconditionFailed(context)) {
         return context.throw(412);
       }
       // Request fresh (304).
-      if (context.fresh) {
+      if (request.fresh) {
         // Set status.
-        context.status = 304;
+        response.status = 304;
         // Set body null.
-        context.body = null;
+        response.body = null;
         // File found.
         return true;
       }
     }
     // Head request.
-    if (context.method === 'HEAD') {
+    if (method === 'HEAD') {
       // Set Content-Length.
-      context.length = stats.size;
+      response.length = stats.size;
       // Set body null
-      context.body = null;
+      response.body = null;
       // File found.
       return true;
     }
@@ -176,7 +181,7 @@ class Service {
     // 416
     if (ranges === -1) {
       // Set Content-Range.
-      context.set('Content-Range', `bytes */${stats.size}`);
+      response.set('Content-Range', `bytes */${stats.size}`);
       // Unsatisfiable 416.
       return context.throw(416);
     }
@@ -184,10 +189,8 @@ class Service {
     if (ranges === -2) {
       return context.throw(400);
     }
-    // Get stream options.
-    const { highWaterMark } = options;
     // Set response body.
-    context.body = new FileReadStream(path, ranges, { fs, highWaterMark });
+    response.body = new ReadStream(path, ranges, options);
     // File found.
     return true;
   }

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/hash.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -14,23 +14,8 @@ import parseRange from 'range-parser';
 /**
  * @module http
  */
-const TOKEN_SPLIT_REGEX = /\s*,\s*/;
-/**
- * @function isETag
- * @description Check if etag is valid.
- * @param value The value to check.
- */
-function isETag(value) {
-  return /^(?:W\/)?"[\s\S]+"$/.test(value);
-}
-/**
- * @function parseTokens
- * @description Parse HTTP tokens.
- * @param value The tokens value string.
- */
-function parseTokens(value) {
-  return value.trim().split(TOKEN_SPLIT_REGEX);
-}
+const SPLIT_ETAG_RE = /\s*,\s*/;
+const SINGLE_ETAG_RE = /^(?:W\/)?"[ !#-\x7E\x80-\xFF]+"$/;
 /**
  * @function decodeURI
  * @description Decode URI component.
@@ -43,45 +28,12 @@ function decodeURI(URI) {
     return -1;
   }
 }
-/**
- * @function isRangeFresh
- * @description Check if request range fresh.
- * @param context Koa context.
- */
-function isRangeFresh(context) {
-  const { request, response } = context;
-  const ifRange = request.get('If-Range');
-  // No If-Range.
-  if (!ifRange) {
-    return true;
-  }
-  // If-Range as etag.
-  if (isETag(ifRange)) {
-    const etag = response.get('ETag');
-    return !!(etag && isETagFresh(ifRange, etag));
-  }
-  // If-Range as modified date.
-  const lastModified = response.get('Last-Modified');
-  return Date.parse(lastModified) <= Date.parse(ifRange);
-}
-/**
- * @function isETagFresh
- * @description Check if etag is fresh.
- * @param match The match value.
- * @param etag The etag value.
- */
-function isETagFresh(match, etag) {
-  return parseTokens(match).some(match => {
-    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-  });
-}
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
  * @param context The koa context.
  */
-function isConditionalGET(context) {
-  const { request } = context;
+function isConditionalGET({ request }) {
   return !!(
     request.get('If-Match') ||
     request.get('If-None-Match') ||
@@ -90,30 +42,72 @@ function isConditionalGET(context) {
   );
 }
 /**
- * @function isPreconditionFailure
- * @description Check if request precondition failure.
+ * @function isETagMatch
+ * @see https://httpwg.org/specs/rfc9110.html
+ * @param match The match value.
+ * @param etag The etag value.
+ * @param isIfMatch The flag of if-match.
+ */
+function isETagMatch(match, etag, isIfMatch) {
+  // Trim etag.
+  etag = etag.trim();
+  // Weak tags cannot be matched and return false.
+  if (!etag || etag.startsWith('W/')) {
+    return false;
+  }
+  // Trim match.
+  match = match.trim();
+  // Check If-Match.
+  if (isIfMatch) {
+    if (match === '*') {
+      return true;
+    }
+    // If-Match maybe a list of etag.
+    return match.split(SPLIT_ETAG_RE).includes(etag);
+  }
+  // Check If-Range.
+  return match === etag;
+}
+/**
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
  * @param context The koa context.
  */
-function isPreconditionFailure({ request, response }) {
+function isPreconditionFailed({ request, response }) {
   // If-Match.
-  const match = request.get('If-Match');
-  // Check if request match.
-  if (match) {
-    // Etag.
-    const etag = response.get('ETag');
-    return !etag || match === '*' || !isETagFresh(match, etag);
+  const ifMatch = request.get('If-Match');
+  // Check If-Match.
+  if (ifMatch) {
+    return !isETagMatch(ifMatch, response.get('ETag'), true);
   }
   // If-Unmodified-Since.
   const unmodifiedSince = Date.parse(request.get('If-Unmodified-Since'));
-  // Check if request unmodified.
+  // Check If-Unmodified-Since.
   if (!Number.isNaN(unmodifiedSince)) {
-    // Last-Modified.
     const lastModified = Date.parse(response.get('Last-Modified'));
     return Number.isNaN(lastModified) || lastModified > unmodifiedSince;
   }
   // Check precondition passed.
   return false;
 }
+/**
+ * @function isRangeFresh
+ * @description Check if request range fresh.
+ * @param context Koa context.
+ */
+function isRangeFresh({ request, response }) {
+  const ifRange = request.get('If-Range');
+  // No If-Range.
+  if (!ifRange) {
+    return true;
+  }
+  // If-Range as modified date failed.
+  if (SINGLE_ETAG_RE.test(ifRange)) {
+    return isETagMatch(ifRange, response.get('ETag'));
+  }
+  // Check if Last-Modified is valid and equal to If-Range date
+  return Date.parse(response.get('Last-Modified')) <= Date.parse(ifRange);
+}
 /**
  * @function parseRanges
  * @description Parse ranges.
@@ -122,9 +116,10 @@ function isPreconditionFailure({ request, response }) {
  */
 function parseRanges(context, stats) {
   const { size } = stats;
+  const { request, response } = context;
   // Range support.
-  if (/^bytes$/i.test(context.response.get('Accept-Ranges'))) {
-    const range = context.request.get('Range');
+  if (/^bytes$/i.test(response.get('Accept-Ranges'))) {
+    const range = request.get('Range');
     // Range fresh.
     if (range && isRangeFresh(context)) {
       // Parse range -1 -2 or [].
@@ -137,7 +132,7 @@ function parseRanges(context, stats) {
       // Ranges ok, support multiple ranges.
       if (parsed.type === 'bytes') {
         // Set 206 status.
-        context.status = 206;
+        response.status = 206;
         const { length } = parsed;
         // Multiple ranges.
         if (length > 1) {
@@ -150,11 +145,11 @@ function parseRanges(context, stats) {
           // Range boundary.
           const boundary = `${generate(32)}`;
           // Multipart Content-Type.
-          const contentType = `Content-Type: ${context.type}`;
+          const contentType = `Content-Type: ${response.type}`;
           // Range suffix.
           const suffix = Buffer.from(`\r\n--${boundary}--\r\n`);
           // Override Content-Type.
-          context.type = `multipart/byteranges; boundary="${boundary}"`;
+          response.type = `multipart/byteranges; boundary="${boundary}"`;
           // Map ranges.
           for (const [index, { start, end }] of entries) {
             const length = end - start + 1;
@@ -169,7 +164,7 @@ function parseRanges(context, stats) {
           // Compute Content-Length.
           contentLength += suffix.length;
           // Set Content-Length.
-          context.length = contentLength;
+          response.length = contentLength;
           // The last add suffix boundary.
           ranges[length - 1].suffix = suffix;
           // Return ranges.
@@ -178,9 +173,9 @@ function parseRanges(context, stats) {
           const [{ start, end }] = parsed;
           const length = end - start + 1;
           // Set Content-Length.
-          context.length = length;
+          response.length = length;
           // Set Content-Range.
-          context.set('Content-Range', `bytes ${start}-${end}/${size}`);
+          response.set('Content-Range', `bytes ${start}-${end}/${size}`);
           // Return ranges.
           return [{ offset: start, length }];
         }
@@ -188,9 +183,9 @@ function parseRanges(context, stats) {
     }
   }
   // Set Content-Length.
-  context.length = size;
+  response.length = size;
   // Return ranges.
   return [{ offset: 0, length: size }];
 }
 
-export { decodeURI, isConditionalGET, isPreconditionFailure, parseRanges };
+export { decodeURI, isConditionalGET, isPreconditionFailed, parseRanges };

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.10
+ * @version 3.2.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "3.1.10",
+  "version": "3.2.0",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",

package/types/{utils/stream.d.ts → ReadStream.d.ts}

@@ -1,23 +1,17 @@
 /**
- * @module stream
+ * @module ReadStream
  */
 import { PathLike } from 'fs';
-import { Buffer } from 'buffer';
-import { FileSystem } from './fs';
+import { Range } from './utils/http';
+import { FileSystem } from './utils/fs';
 import { Readable, ReadableOptions } from 'stream';
-export interface Options extends Pick<ReadableOptions, 'encoding' | 'highWaterMark'> {
+export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
   fs: FileSystem;
 }
-export interface Range {
-  offset: number;
-  length: number;
-  prefix?: Buffer;
-  suffix?: Buffer;
-}
 interface Callback {
   (error?: Error | null): void;
 }
-export declare class FileReadStream extends Readable {
+export declare class ReadStream extends Readable {
   private readonly fs;
   private readonly path;
   private readonly ranges;

package/types/Service.d.ts

@@ -10,8 +10,8 @@ interface IgnoreFunction {
 interface Headers {
   [key: string]: string | string[];
 }
-interface HeaderFunction {
-  (path: string, stats: Stats): Headers | void;
+interface HeadersFunction {
+  (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
 export interface Options {
   fs?: FileSystem;
@@ -20,7 +20,7 @@ export interface Options {
   lastModified?: boolean;
   highWaterMark?: number;
   ignore?: IgnoreFunction;
-  headers?: Headers | HeaderFunction;
+  headers?: Headers | HeadersFunction;
 }
 /**
  * @class Service

package/types/utils/http.d.ts

@@ -3,8 +3,13 @@
  */
 import { Stats } from 'fs';
 import { Context } from 'koa';
-import { Range } from './stream';
-type Ranges = Range[] | -1 | -2;
+import { Buffer } from 'buffer';
+export interface Range {
+  offset: number;
+  length: number;
+  prefix?: Buffer;
+  suffix?: Buffer;
+}
 /**
  * @function decodeURI
  * @description Decode URI component.
@@ -16,18 +21,17 @@ export declare function decodeURI(URI: string): string | -1;
  * @description Check if request is conditional GET.
  * @param context The koa context.
  */
-export declare function isConditionalGET(context: Context): boolean;
+export declare function isConditionalGET({ request }: Context): boolean;
 /**
- * @function isPreconditionFailure
- * @description Check if request precondition failure.
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
  * @param context The koa context.
  */
-export declare function isPreconditionFailure({ request, response }: Context): boolean;
+export declare function isPreconditionFailed({ request, response }: Context): boolean;
 /**
  * @function parseRanges
  * @description Parse ranges.
  * @param context The koa context.
  * @param stats The file stats.
  */
-export declare function parseRanges(context: Context, stats: Stats): Ranges;
-export {};
+export declare function parseRanges(context: Context, stats: Stats): Range[] | -1 | -2;