koa-files 3.0.5 → 3.0.7

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -42,8 +42,8 @@ class Service {
   /**
    * @constructor
    * @description Create file service.
-   * @param root File service root.
-   * @param options File service options.
+   * @param root The file service root.
+   * @param options The file service options.
    */
   constructor(root, options) {
     this.options = options;
@@ -53,7 +53,7 @@ class Service {
    * @private
    * @method isIgnore
    * @description Check if path is ignore.
-   * @param path File path.
+   * @param path The path to check.
    */
   isIgnore(path) {
     const { ignore } = this.options;
@@ -62,10 +62,10 @@ class Service {
   /**
    * @private
    * @method setupHeaders
-   * @description Setup headers
-   * @param context Koa context
-   * @param path File path
-   * @param stats File stats
+   * @description Setup headers.
+   * @param context The koa context.
+   * @param path The file path.
+   * @param stats The file stats.
    */
   setupHeaders(context, path, stats) {
     const { options } = this;
@@ -111,14 +111,14 @@ class Service {
   }
   /**
    * @private
-   * @method write
-   * @description Write file to stream.
-   * @param stream Destination stream.
+   * @method read
+   * @description Read file with range.
    * @param path The file path to read.
    * @param range The range to read.
-   * @param end Is destory destination stream after read complete.
+   * @param stream The destination stream.
+   * @param end The end flag after pipe to stream.
    */
-  write(stream, path, range, end) {
+  read(path, range, stream, end) {
     const { fs } = this.options;
     return new Promise(resolve => {
       // Range prefix and suffix.
@@ -166,24 +166,18 @@ class Service {
   /**
    * @private
    * @method send
-   * @description Send file.
-   * @param context Koa context.
-   * @param path File path.
-   * @param ranges Read ranges.
+   * @description Send file with ranges.
+   * @param path The file path to send.
+   * @param ranges The ranges to send.
+   * @param stream The destination stream.
    */
-  async send(context, path, ranges) {
-    // Set stream body, highWaterMark 64kb.
-    const stream$1 = new stream.PassThrough({
-      highWaterMark: 65536
-    });
-    // Set response body.
-    context.body = stream$1;
+  async send(path, ranges, stream) {
     // Ranges length.
     let { length } = ranges;
     // Write ranges to stream.
     for (const range of ranges) {
       // Write range.
-      const passed = await this.write(stream$1, path, range, --length === 0);
+      const passed = await this.read(path, range, stream, --length === 0);
       // If not passed, break.
       if (!passed) {
         break;
@@ -192,23 +186,23 @@ class Service {
   }
   /**
    * @public
-   * @method response
-   * @description Response to koa context.
-   * @param context Koa context.
+   * @method respond
+   * @description Respond file.
+   * @param context The koa context.
    */
-  async response(context) {
+  async respond(context) {
     const { root } = this;
     // Only support GET and HEAD (405).
     if (context.method !== 'GET' && context.method !== 'HEAD') {
       return false;
     }
-    // Get path of file
+    // Get pathname of file.
     const pathname = http.decodeURI(context.path);
-    const path$2 = pathname === -1 ? pathname : path.unixify(path$1.join(root, pathname));
-    // Path -1 or null byte(s)
-    if (path$2 === -1 || path$2.includes('\0')) {
+    // Pathname decode failed or includes null byte(s).
+    if (pathname === -1 || pathname.includes('\0')) {
       return context.throw(400);
     }
+    const path$2 = path.unixify(path$1.join(root, pathname));
     // Malicious path (403).
     if (path.isOutRoot(path$2, root)) {
       return false;
@@ -270,8 +264,14 @@ class Service {
     if (ranges === -2) {
       return context.throw(400);
     }
-    // Send file.
-    this.send(context, path$2, ranges);
+    // Set stream body, highWaterMark 64kb.
+    const stream$1 = new stream.PassThrough({
+      highWaterMark: 65536
+    });
+    // Send file with ranges.
+    this.send(path$2, ranges, stream$1);
+    // Set response body.
+    context.body = stream$1;
     // File found.
     return true;
   }

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -32,11 +32,11 @@ function server(root, options) {
   if (config.defer) {
     return async (context, next) => {
       await next();
-      await service.response(context);
+      await service.respond(context);
     };
   }
   return async (context, next) => {
-    if (!(await service.response(context))) {
+    if (!(await service.respond(context))) {
       await next();
     }
   };

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @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.0.5
+ * @version 3.0.7
  * @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.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -108,7 +108,7 @@ function decodeURI(URI) {
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
- * @param context Koa context.
+ * @param context The koa context.
  */
 function isConditionalGET(context) {
   const { request } = context;
@@ -122,7 +122,7 @@ function isConditionalGET(context) {
 /**
  * @function isPreconditionFailure
  * @description Check if request precondition failure.
- * @param context Koa context.
+ * @param context The koa context.
  */
 function isPreconditionFailure({ request, response }) {
   // If-Match.
@@ -147,8 +147,8 @@ function isPreconditionFailure({ request, response }) {
 /**
  * @function parseRanges
  * @description Parse ranges.
- * @param context Koa context.
- * @param stats File stats.
+ * @param context The koa context.
+ * @param stats The file stats.
  */
 function parseRanges(context, stats) {
   const { size } = stats;

package/cjs/utils/path.cjs

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

package/esm/Service.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -33,8 +33,8 @@ class Service {
   /**
    * @constructor
    * @description Create file service.
-   * @param root File service root.
-   * @param options File service options.
+   * @param root The file service root.
+   * @param options The file service options.
    */
   constructor(root, options) {
     this.options = options;
@@ -44,7 +44,7 @@ class Service {
    * @private
    * @method isIgnore
    * @description Check if path is ignore.
-   * @param path File path.
+   * @param path The path to check.
    */
   isIgnore(path) {
     const { ignore } = this.options;
@@ -53,10 +53,10 @@ class Service {
   /**
    * @private
    * @method setupHeaders
-   * @description Setup headers
-   * @param context Koa context
-   * @param path File path
-   * @param stats File stats
+   * @description Setup headers.
+   * @param context The koa context.
+   * @param path The file path.
+   * @param stats The file stats.
    */
   setupHeaders(context, path, stats) {
     const { options } = this;
@@ -102,14 +102,14 @@ class Service {
   }
   /**
    * @private
-   * @method write
-   * @description Write file to stream.
-   * @param stream Destination stream.
+   * @method read
+   * @description Read file with range.
    * @param path The file path to read.
    * @param range The range to read.
-   * @param end Is destory destination stream after read complete.
+   * @param stream The destination stream.
+   * @param end The end flag after pipe to stream.
    */
-  write(stream, path, range, end) {
+  read(path, range, stream, end) {
     const { fs } = this.options;
     return new Promise(resolve => {
       // Range prefix and suffix.
@@ -157,24 +157,18 @@ class Service {
   /**
    * @private
    * @method send
-   * @description Send file.
-   * @param context Koa context.
-   * @param path File path.
-   * @param ranges Read ranges.
+   * @description Send file with ranges.
+   * @param path The file path to send.
+   * @param ranges The ranges to send.
+   * @param stream The destination stream.
    */
-  async send(context, path, ranges) {
-    // Set stream body, highWaterMark 64kb.
-    const stream = new PassThrough({
-      highWaterMark: 65536
-    });
-    // Set response body.
-    context.body = stream;
+  async send(path, ranges, stream) {
     // Ranges length.
     let { length } = ranges;
     // Write ranges to stream.
     for (const range of ranges) {
       // Write range.
-      const passed = await this.write(stream, path, range, --length === 0);
+      const passed = await this.read(path, range, stream, --length === 0);
       // If not passed, break.
       if (!passed) {
         break;
@@ -183,23 +177,23 @@ class Service {
   }
   /**
    * @public
-   * @method response
-   * @description Response to koa context.
-   * @param context Koa context.
+   * @method respond
+   * @description Respond file.
+   * @param context The koa context.
    */
-  async response(context) {
+  async respond(context) {
     const { root } = this;
     // Only support GET and HEAD (405).
     if (context.method !== 'GET' && context.method !== 'HEAD') {
       return false;
     }
-    // Get path of file
+    // Get pathname of file.
     const pathname = decodeURI(context.path);
-    const path = pathname === -1 ? pathname : unixify(join(root, pathname));
-    // Path -1 or null byte(s)
-    if (path === -1 || path.includes('\0')) {
+    // Pathname decode failed or includes null byte(s).
+    if (pathname === -1 || pathname.includes('\0')) {
       return context.throw(400);
     }
+    const path = unixify(join(root, pathname));
     // Malicious path (403).
     if (isOutRoot(path, root)) {
       return false;
@@ -261,8 +255,14 @@ class Service {
     if (ranges === -2) {
       return context.throw(400);
     }
-    // Send file.
-    this.send(context, path, ranges);
+    // Set stream body, highWaterMark 64kb.
+    const stream = new PassThrough({
+      highWaterMark: 65536
+    });
+    // Send file with ranges.
+    this.send(path, ranges, stream);
+    // Set response body.
+    context.body = stream;
     // File found.
     return true;
   }

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -24,11 +24,11 @@ function server(root, options) {
   if (config.defer) {
     return async (context, next) => {
       await next();
-      await service.response(context);
+      await service.respond(context);
     };
   }
   return async (context, next) => {
-    if (!(await service.response(context))) {
+    if (!(await service.respond(context))) {
       await next();
     }
   };

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @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.0.5
+ * @version 3.0.7
  * @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.0.5
+ * @version 3.0.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -100,7 +100,7 @@ function decodeURI(URI) {
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
- * @param context Koa context.
+ * @param context The koa context.
  */
 function isConditionalGET(context) {
   const { request } = context;
@@ -114,7 +114,7 @@ function isConditionalGET(context) {
 /**
  * @function isPreconditionFailure
  * @description Check if request precondition failure.
- * @param context Koa context.
+ * @param context The koa context.
  */
 function isPreconditionFailure({ request, response }) {
   // If-Match.
@@ -139,8 +139,8 @@ function isPreconditionFailure({ request, response }) {
 /**
  * @function parseRanges
  * @description Parse ranges.
- * @param context Koa context.
- * @param stats File stats.
+ * @param context The koa context.
+ * @param stats The file stats.
  */
 function parseRanges(context, stats) {
   const { size } = stats;

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.0.5
+ * @version 3.0.7
  * @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.0.5",
+  "version": "3.0.7",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -60,18 +60,18 @@
     "tslib": "^2.7.0"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^11.1.6",
+    "@rollup/plugin-typescript": "^12.1.0",
     "@types/destroy": "^1.0.3",
     "@types/etag": "^1.8.3",
     "@types/koa": "^2.15.0",
     "@types/range-parser": "^1.2.7",
     "koa": "^2.15.3",
-    "magic-string": "^0.30.11",
+    "magic-string": "^0.30.12",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
-    "rollup": "^4.21.2",
+    "rollup": "^4.24.0",
     "tsc-alias": "^1.8.10",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   },
   "peerDependencies": {
     "koa": "^2.0.0"

package/types/Service.d.ts

@@ -30,51 +30,51 @@ export default class Service {
   /**
    * @constructor
    * @description Create file service.
-   * @param root File service root.
-   * @param options File service options.
+   * @param root The file service root.
+   * @param options The file service options.
    */
   constructor(root: string, options: Options);
   /**
    * @private
    * @method isIgnore
    * @description Check if path is ignore.
-   * @param path File path.
+   * @param path The path to check.
    */
   private isIgnore;
   /**
    * @private
    * @method setupHeaders
-   * @description Setup headers
-   * @param context Koa context
-   * @param path File path
-   * @param stats File stats
+   * @description Setup headers.
+   * @param context The koa context.
+   * @param path The file path.
+   * @param stats The file stats.
    */
   private setupHeaders;
   /**
    * @private
-   * @method write
-   * @description Write file to stream.
-   * @param stream Destination stream.
+   * @method read
+   * @description Read file with range.
    * @param path The file path to read.
    * @param range The range to read.
-   * @param end Is destory destination stream after read complete.
+   * @param stream The destination stream.
+   * @param end The end flag after pipe to stream.
    */
-  private write;
+  private read;
   /**
    * @private
    * @method send
-   * @description Send file.
-   * @param context Koa context.
-   * @param path File path.
-   * @param ranges Read ranges.
+   * @description Send file with ranges.
+   * @param path The file path to send.
+   * @param ranges The ranges to send.
+   * @param stream The destination stream.
    */
   private send;
   /**
    * @public
-   * @method response
-   * @description Response to koa context.
-   * @param context Koa context.
+   * @method respond
+   * @description Respond file.
+   * @param context The koa context.
    */
-  response(context: Context): Promise<boolean>;
+  respond(context: Context): Promise<boolean>;
 }
 export {};

package/types/utils/http.d.ts

@@ -19,20 +19,20 @@ export declare function decodeURI(URI: string): string | -1;
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
- * @param context Koa context.
+ * @param context The koa context.
  */
 export declare function isConditionalGET(context: Context): boolean;
 /**
  * @function isPreconditionFailure
  * @description Check if request precondition failure.
- * @param context Koa context.
+ * @param context The koa context.
  */
 export declare function isPreconditionFailure({ request, response }: Context): boolean;
 /**
  * @function parseRanges
  * @description Parse ranges.
- * @param context Koa context.
- * @param stats File stats.
+ * @param context The koa context.
+ * @param stats The file stats.
  */
 export declare function parseRanges(context: Context, stats: Stats): Ranges;
 export {};