koa-files 2.3.7 → 2.3.8

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.7
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -18,122 +18,117 @@ import { relative, isAbsolute } from 'path';
 const CHARS = Array.from('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 function isOutRoot(path, root) {
-    path = relative(root, path);
-    return /\.\.(?:[\\/]|$)/.test(path) || isAbsolute(path);
+  path = relative(root, path);
+  return /\.\.(?:[\\/]|$)/.test(path) || isAbsolute(path);
 }
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 function unixify(path) {
-    return path.replace(/\\/g, '/');
+  return path.replace(/\\/g, '/');
 }
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 function decodeURI(URI) {
-    try {
-        return decodeURIComponent(URI);
-    }
-    catch (error) {
-        return -1;
-    }
+  try {
+    return decodeURIComponent(URI);
+  } catch (error) {
+    return -1;
+  }
 }
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 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
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 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
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 function hasTrailingSlash(path) {
-    return /\/$/.test(path);
+  return /\/$/.test(path);
 }
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 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;
-                }
-                break;
-            case 0x2c:
-                // ','
-                tokens.push(value.substring(start, end));
-                start = end = i + 1;
-                break;
-            default:
-                end = i + 1;
-                break;
+  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;
     }
-    // final token
-    tokens.push(value.substring(start, end));
-    return tokens;
+  }
+  // final token
+  tokens.push(value.substring(start, end));
+  return tokens;
 }
 /**
- * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
  */
-function isETagFresh(match, etag) {
-    return parseTokens(match).some(match => {
-        return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-    });
+function isETag(value) {
+  return /^(?:W\/)?"[\s\S]+"$/.test(value);
 }
 /**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
+ * @function isETagFresh
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
-function isETag(etag) {
-    return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
+function isETagFresh(match, etag) {
+  return parseTokens(match).some(match => {
+    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
+  });
 }
 
 export { boundaryGenerator, decodeURI, fstat, hasTrailingSlash, isETag, isETagFresh, isOutRoot, parseTokens, unixify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "2.3.7",
+  "version": "2.3.8",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -45,10 +45,10 @@
     "test": "node tests",
     "lint": "tsc --noEmit",
     "clean": "node tools/clean.js",
-    "format": "prettier --write .",
     "prepublishOnly": "npm run build",
     "build:cjs": "rollup -c tools/rollup.cjs.js",
     "build:esm": "rollup -c tools/rollup.esm.js",
+    "format": "prettier --write . --ignore-path .prettierignore",
     "build": "npm run clean && npm run build:main && npm run format",
     "build:main": "npm run build:cjs && npm run build:esm && npm run build:types",
     "build:types": "tsc --declaration --emitDeclarationOnly --declarationDir types"
@@ -65,12 +65,12 @@
     "@types/etag": "^1.8.3",
     "@types/koa": "^2.15.0",
     "@types/range-parser": "^1.2.7",
-    "koa": "^2.15.0",
+    "koa": "^2.15.1",
     "magic-string": "^0.30.8",
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
-    "rollup": "^4.12.0",
-    "typescript": "^5.3.3"
+    "rollup": "^4.13.0",
+    "typescript": "^5.4.2"
   },
   "peerDependencies": {
     "koa": "^2.0.0"

package/types/Files.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @module Files
+ * @license MIT
+ * @author nuintun
+ */
+import { Context } from 'koa';
+export interface Options {
+  etag?: boolean;
+  cacheControl?: string;
+  acceptRanges?: boolean;
+  lastModified?: boolean;
+  ignore?: (path: string) => boolean;
+}
+/**
+ * @class Files
+ */
+export default class Files {
+  private root;
+  private options;
+  /**
+   * @constructor
+   * @description Create files service
+   * @param root Files service root
+   * @param options Files service options
+   */
+  constructor(root: string, options?: Options);
+  /**
+   * @private
+   * @method isConditionalGET
+   * @description Check if request is conditional GET
+   * @param context Koa context
+   */
+  private isConditionalGET;
+  /**
+   * @private
+   * @method isPreconditionFailure
+   * @description Check if request precondition failure
+   * @param context Koa context
+   */
+  private isPreconditionFailure;
+  /**
+   * @private
+   * @method isRangeFresh
+   * @description Check if request range fresh
+   * @param context Koa context
+   */
+  private isRangeFresh;
+  /**
+   * @private
+   * @method isIgnore
+   * @description Check if path is ignore
+   * @param path File path
+   */
+  private isIgnore;
+  /**
+   * @private
+   * @method parseRange
+   * @description Parse range
+   * @param context Koa context
+   * @param stats File stats
+   */
+  private parseRange;
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
+   */
+  private setupHeaders;
+  /**
+   * @private
+   * @method read
+   * @description Read file
+   * @param path File path
+   * @param range Read range
+   * @param buffer Destination stream
+   * @param end Is destory destination stream after read
+   */
+  private read;
+  /**
+   * @private
+   * @method send
+   * @description Send file
+   * @param context Koa context
+   * @param path File path
+   * @param ranges Read ranges
+   */
+  private send;
+  /**
+   * @public
+   * @method response
+   * @description Response to koa context
+   * @param context Koa context
+   */
+  response(context: Context): Promise<boolean>;
+}

package/types/index.d.ts

@@ -4,9 +4,9 @@
  * @author nuintun
  */
 import { Middleware } from 'koa';
-import { Options as SendOptions } from './Send';
-export interface Options extends SendOptions {
-    defer?: boolean;
+import { Options as FilesOptions } from './Files';
+export interface Options extends FilesOptions {
+  defer?: boolean;
 }
 /**
  * @function server

package/types/utils.d.ts

@@ -7,60 +7,56 @@
 import { Stats } from 'fs';
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 export declare function isOutRoot(path: string, root: string): boolean;
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 export declare function unixify(path: string): string;
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 export declare function decodeURI(URI: string): string | -1;
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 export declare function boundaryGenerator(): string;
 /**
  * @function fstat
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 export declare function fstat(path: string): Promise<Stats>;
 /**
  * @function hasTrailingSlash
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 export declare function hasTrailingSlash(path: string): boolean;
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 export declare function parseTokens(value: string): string[];
 /**
- * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
  */
-export declare function isETagFresh(match: string, etag: string): boolean;
+export declare function isETag(value: string): boolean;
 /**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
+ * @function isETagFresh
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
-export declare function isETag(etag: string): boolean;
+export declare function isETagFresh(match: string, etag: string): boolean;