koa-files 2.3.6 → 2.3.7

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -20,18 +20,18 @@ import Send from './Send.js';
  * @param {Options} options
  */
 function server(root, options) {
-  const send = new Send(root, options);
-  if (options && options.defer) {
+    const send = new Send(root, options);
+    if (options && options.defer) {
+        return async (context, next) => {
+            await next();
+            await send.response(context);
+        };
+    }
     return async (context, next) => {
-      await next();
-      await send.response(context);
+        if (!(await send.response(context))) {
+            await next();
+        }
     };
-  }
-  return async (context, next) => {
-    if (!(await send.response(context))) {
-      await next();
-    }
-  };
 }
 
 export { server as default };

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.7
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -24,8 +24,8 @@ const CHARS = Array.from('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqr
  * @returns {boolean}
  */
 function isOutRoot(path, root) {
-  path = relative(root, path);
-  return /\.\.(?:[\\/]|$)/.test(path) || isAbsolute(path);
+    path = relative(root, path);
+    return /\.\.(?:[\\/]|$)/.test(path) || isAbsolute(path);
 }
 /**
  * @function unixify
@@ -34,7 +34,7 @@ function isOutRoot(path, root) {
  * @returns {string}
  */
 function unixify(path) {
-  return path.replace(/\\/g, '/');
+    return path.replace(/\\/g, '/');
 }
 /**
  * @function decodeURI
@@ -43,11 +43,12 @@ function unixify(path) {
  * @returns {string|-1}
  */
 function decodeURI(URI) {
-  try {
-    return decodeURIComponent(URI);
-  } catch (error) {
-    return -1;
-  }
+    try {
+        return decodeURIComponent(URI);
+    }
+    catch (error) {
+        return -1;
+    }
 }
 /**
  * @function boundaryGenerator
@@ -55,13 +56,13 @@ function decodeURI(URI) {
  * @returns {string}
  */
 function boundaryGenerator() {
-  let boundary = '';
-  // Create boundary
-  for (let i = 0; i < 38; i++) {
-    boundary += CHARS[Math.floor(Math.random() * 62)];
-  }
-  // Return boundary
-  return boundary;
+    let boundary = '';
+    // Create boundary
+    for (let i = 0; i < 38; i++) {
+        boundary += CHARS[Math.floor(Math.random() * 62)];
+    }
+    // Return boundary
+    return boundary;
 }
 /**
  * @function fstat
@@ -69,11 +70,11 @@ function boundaryGenerator() {
  * @returns {Promise<Stats>}
  */
 function fstat(path) {
-  return new Promise((resolve, reject) => {
-    fs.stat(path, (error, stats) => {
-      error ? reject(error) : resolve(stats);
+    return new Promise((resolve, reject) => {
+        fs.stat(path, (error, stats) => {
+            error ? reject(error) : resolve(stats);
+        });
     });
-  });
 }
 /**
  * @function hasTrailingSlash
@@ -81,7 +82,7 @@ function fstat(path) {
  * @returns {boolean}
  */
 function hasTrailingSlash(path) {
-  return /\/$/.test(path);
+    return /\/$/.test(path);
 }
 /**
  * @function parseTokens
@@ -89,31 +90,31 @@ function hasTrailingSlash(path) {
  * @param {string[]} value
  */
 function parseTokens(value) {
-  let end = 0;
-  let start = 0;
-  let tokens = [];
-  // gather tokens
-  for (let i = 0, length = value.length; i < length; i++) {
-    switch (value.charCodeAt(i)) {
-      case 0x20:
-        // ' '
-        if (start === end) {
-          start = end = i + 1;
+    let end = 0;
+    let start = 0;
+    let tokens = [];
+    // gather tokens
+    for (let i = 0, length = value.length; i < length; i++) {
+        switch (value.charCodeAt(i)) {
+            case 0x20:
+                // ' '
+                if (start === end) {
+                    start = end = i + 1;
+                }
+                break;
+            case 0x2c:
+                // ','
+                tokens.push(value.substring(start, end));
+                start = end = i + 1;
+                break;
+            default:
+                end = i + 1;
+                break;
         }
-        break;
-      case 0x2c:
-        // ','
-        tokens.push(value.substring(start, end));
-        start = end = i + 1;
-        break;
-      default:
-        end = i + 1;
-        break;
     }
-  }
-  // final token
-  tokens.push(value.substring(start, end));
-  return tokens;
+    // final token
+    tokens.push(value.substring(start, end));
+    return tokens;
 }
 /**
  * @function isETagFresh
@@ -122,9 +123,9 @@ function parseTokens(value) {
  * @returns {boolean}
  */
 function isETagFresh(match, etag) {
-  return parseTokens(match).some(match => {
-    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-  });
+    return parseTokens(match).some(match => {
+        return match === etag || match === 'W/' + etag || 'W/' + match === etag;
+    });
 }
 /**
  * @function isETag
@@ -132,7 +133,7 @@ function isETagFresh(match, etag) {
  * @returns {boolean}
  */
 function isETag(etag) {
-  return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
+    return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
 }
 
 export { boundaryGenerator, decodeURI, fstat, hasTrailingSlash, isETag, isETagFresh, isOutRoot, parseTokens, unixify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -8,7 +8,8 @@
   "types": "types/index.d.ts",
   "exports": {
     "import": "./esm/index.js",
-    "require": "./cjs/index.cjs"
+    "require": "./cjs/index.cjs",
+    "types": "./types/index.d.ts"
   },
   "files": [
     "cjs",
@@ -56,20 +57,20 @@
     "destroy": "^1.2.0",
     "etag": "^1.8.1",
     "range-parser": "^1.2.1",
-    "tslib": "^2.5.0"
+    "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^11.0.0",
-    "@types/destroy": "^1.0.0",
-    "@types/etag": "^1.8.1",
-    "@types/koa": "^2.13.5",
-    "@types/range-parser": "^1.2.4",
-    "koa": "^2.14.1",
-    "magic-string": "^0.30.0",
-    "prettier": "^2.8.6",
-    "rimraf": "^4.4.0",
-    "rollup": "^3.20.0",
-    "typescript": "^5.0.2"
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/destroy": "^1.0.3",
+    "@types/etag": "^1.8.3",
+    "@types/koa": "^2.15.0",
+    "@types/range-parser": "^1.2.7",
+    "koa": "^2.15.0",
+    "magic-string": "^0.30.8",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.12.0",
+    "typescript": "^5.3.3"
   },
   "peerDependencies": {
     "koa": "^2.0.0"

package/types/Send.d.ts

@@ -5,82 +5,82 @@
  */
 import { Context } from 'koa';
 export interface Options {
-  etag?: boolean;
-  cacheControl?: string;
-  acceptRanges?: boolean;
-  lastModified?: boolean;
-  ignore?: (path: string) => boolean;
+    etag?: boolean;
+    cacheControl?: string;
+    acceptRanges?: boolean;
+    lastModified?: boolean;
+    ignore?: (path: string) => boolean;
 }
 /**
  * @class Send
  */
 export default class Send {
-  private root;
-  private options;
-  /**
-   * @constructor
-   * @param {string} root
-   * @param {Options} options
-   */
-  constructor(root: string, options?: Options);
-  /**
-   * @method isConditionalGET
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isConditionalGET;
-  /**
-   * @method isPreconditionFailure
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isPreconditionFailure;
-  /**
-   * @method isRangeFresh
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isRangeFresh;
-  /**
-   * @method isIgnore
-   * @param {string} path
-   * @returns {boolean}
-   */
-  private isIgnore;
-  /**
-   * @method parseRange
-   * @param {Context} context
-   * @param {Stats} stats
-   * @returns {Ranges}
-   */
-  private parseRange;
-  /**
-   * @method setupHeaders
-   * @param {Context} context
-   * @param {string} path
-   * @param {Stats} stats
-   */
-  private setupHeaders;
-  /**
-   * @method read
-   * @param {string} path
-   * @param {Range} range
-   * @param {PassThrough} buffer
-   * @param {boolean} end
-   * @returns {Promise<true>}
-   */
-  private read;
-  /**
-   * @method send
-   * @param {Context} context
-   * @param {string} path
-   * @param {Range[]} ranges
-   */
-  private send;
-  /**
-   * @method response
-   * @param {Context} context
-   * @returns {Promise<boolean>}
-   */
-  response(context: Context): Promise<boolean>;
+    private root;
+    private options;
+    /**
+     * @constructor
+     * @param {string} root
+     * @param {Options} options
+     */
+    constructor(root: string, options?: Options);
+    /**
+     * @method isConditionalGET
+     * @param {Context} context
+     * @returns {boolean}
+     */
+    private isConditionalGET;
+    /**
+     * @method isPreconditionFailure
+     * @param {Context} context
+     * @returns {boolean}
+     */
+    private isPreconditionFailure;
+    /**
+     * @method isRangeFresh
+     * @param {Context} context
+     * @returns {boolean}
+     */
+    private isRangeFresh;
+    /**
+     * @method isIgnore
+     * @param {string} path
+     * @returns {boolean}
+     */
+    private isIgnore;
+    /**
+     * @method parseRange
+     * @param {Context} context
+     * @param {Stats} stats
+     * @returns {Ranges}
+     */
+    private parseRange;
+    /**
+     * @method setupHeaders
+     * @param {Context} context
+     * @param {string} path
+     * @param {Stats} stats
+     */
+    private setupHeaders;
+    /**
+     * @method read
+     * @param {string} path
+     * @param {Range} range
+     * @param {PassThrough} buffer
+     * @param {boolean} end
+     * @returns {Promise<true>}
+     */
+    private read;
+    /**
+     * @method send
+     * @param {Context} context
+     * @param {string} path
+     * @param {Range[]} ranges
+     */
+    private send;
+    /**
+     * @method response
+     * @param {Context} context
+     * @returns {Promise<boolean>}
+     */
+    response(context: Context): Promise<boolean>;
 }

package/types/index.d.ts

@@ -6,7 +6,7 @@
 import { Middleware } from 'koa';
 import { Options as SendOptions } from './Send';
 export interface Options extends SendOptions {
-  defer?: boolean;
+    defer?: boolean;
 }
 /**
  * @function server