koa-files 3.2.1 → 4.0.0

package/README.md

@@ -20,14 +20,14 @@ $ npm install koa-files
 import { Middleware } from 'koa';
 import fs, { Stats } from 'node:fs';
 
-interface IgnoreFunction {
-  (path: string): boolean;
-}
-
 interface Headers {
   [key: string]: string | string[];
 }
 
+interface IgnoreFunction {
+  (path: string): boolean | Promise<boolean>;
+}
+
 interface HeadersFunction {
   (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
@@ -50,7 +50,7 @@ export interface Options {
   headers?: Headers | HeadersFunction;
 }
 
-export default function server(root: string, options?: Options): Middleware;
+export function server(root: string, options?: Options): Middleware;
 ```
 
 ### root
@@ -118,14 +118,14 @@ export default function server(root: string, options?: Options): Middleware;
  */
 
 import Koa from 'koa';
-import files from 'koa-files';
+import { server } from 'koa-files';
 
 const app = new Koa();
 const port = process.env.PORT || 80;
 
 // Static files server
 app.use(
-  files('tests', {
+  server('tests', {
     headers: {
       'Cache-Control': 'public, max-age=31557600'
     }

package/cjs/ReadStream.cjs

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

package/cjs/ReadStream.d.cts

@@ -0,0 +1,84 @@
+/**
+ * @module ReadStream
+ */
+import { PathLike } from 'fs';
+import { Range } from './utils/http.cjs';
+import { FileSystem } from './utils/fs.cjs';
+import { Readable, ReadableOptions } from 'stream';
+export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
+  fs: FileSystem;
+}
+interface Callback {
+  (error?: Error | null): void;
+}
+export declare class ReadStream extends Readable {
+  private readonly fs;
+  private readonly path;
+  private readonly ranges;
+  private bytesRead;
+  private fd;
+  private reading;
+  private currentRangeIndex;
+  private readState;
+  /**
+   * @constructor
+   * @param path The file path.
+   * @param ranges The ranges to read.
+   * @param options The stream options.
+   */
+  constructor(path: PathLike, ranges: Range[], options: Options);
+  /**
+   * @override
+   * @method _construct
+   * @param callback The callback.
+   */
+  _construct(callback: Callback): void;
+  /**
+   * @private
+   * @method getRange
+   */
+  private getRange;
+  /**
+   * @private
+   * @method getPadding
+   * @param range The current range.
+   */
+  private getPadding;
+  /**
+   * @private
+   * @method readFilePadding
+   * @param fd The file descriptor.
+   * @param range The current range.
+   * @param size The number of bytes to read.
+   */
+  private readFilePadding;
+  /**
+   * @private
+   * @method readFileRange
+   * @param fd The file descriptor.
+   * @param range The current range.
+   * @param size The number of bytes to read.
+   */
+  private readFileRange;
+  /**
+   * @override
+   * @method _read
+   * @param size The number of bytes to read.
+   */
+  _read(size: number): void;
+  /**
+   * @private
+   * @method dispose
+   * @param error The error.
+   * @param callback The callback.
+   */
+  private dispose;
+  /**
+   * @override
+   * @method _destroy
+   * @param error The error.
+   * @param callback The callback.
+   */
+  _destroy(error: Error | null, callback: Callback): void;
+}
+export {};

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -12,6 +12,7 @@
 const createETag = require('etag');
 const fs = require('fs');
 const ReadStream = require('./ReadStream.cjs');
+const type = require('./utils/type.cjs');
 const fs$1 = require('./utils/fs.cjs');
 const path$1 = require('path');
 const path = require('./utils/path.cjs');
@@ -27,14 +28,6 @@ const fs__default = /*#__PURE__*/ _interopDefault(fs);
 /**
  * @module Service
  */
-/**
- * @function isFunction
- * @description Check if value is function.
- * @param value The value to check.
- */
-function isFunction(value) {
-  return typeof value === 'function';
-}
 /**
  * @class Service
  */
@@ -55,9 +48,10 @@ class Service {
    * @description Check if path is ignore.
    * @param path The path to check.
    */
-  isIgnore(path) {
+  async isIgnore(path) {
     const { ignore } = this.options;
-    return (isFunction(ignore) ? ignore(path) : false) === true;
+    const isIgnored = type.isFunction(ignore) ? await ignore(path) : false;
+    return isIgnored === true;
   }
   /**
    * @private
@@ -76,7 +70,7 @@ class Service {
     response.type = path$1.extname(path);
     // Set headers.
     if (headers) {
-      if (isFunction(headers)) {
+      if (type.isFunction(headers)) {
         const fields = await headers(path, stats);
         if (fields) {
           response.set(fields);
@@ -138,7 +132,7 @@ class Service {
       return false;
     }
     // Is ignore path or file (403).
-    if (this.isIgnore(path$2)) {
+    if (await this.isIgnore(path$2)) {
       return false;
     }
     // Get options.
@@ -205,4 +199,4 @@ class Service {
   }
 }
 
-module.exports = Service;
+exports.Service = Service;

package/cjs/Service.d.cts

@@ -0,0 +1,62 @@
+/**
+ * @module Service
+ */
+import { Context } from 'koa';
+import { Stats } from 'fs';
+import { FileSystem } from './utils/fs.cjs';
+interface Headers {
+  [key: string]: string | string[];
+}
+interface IgnoreFunction {
+  (path: string): boolean | Promise<boolean>;
+}
+interface HeadersFunction {
+  (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
+}
+export interface Options {
+  fs?: FileSystem;
+  etag?: boolean;
+  acceptRanges?: boolean;
+  lastModified?: boolean;
+  highWaterMark?: number;
+  ignore?: IgnoreFunction;
+  headers?: Headers | HeadersFunction;
+}
+/**
+ * @class Service
+ */
+export declare class Service {
+  private readonly root;
+  private readonly options;
+  /**
+   * @constructor
+   * @description Create file service.
+   * @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 The path to check.
+   */
+  private isIgnore;
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers.
+   * @param context The koa context.
+   * @param path The file path.
+   * @param stats The file stats.
+   */
+  private setupHeaders;
+  /**
+   * @public
+   * @method respond
+   * @description Respond file.
+   * @param context The koa context.
+   */
+  respond(context: Context): Promise<boolean>;
+}
+export {};

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -16,11 +16,12 @@ const Service = require('./Service.cjs');
  */
 /**
  * @function server
- * @param {string} root
- * @param {Options} options
+ * @description Create files server.
+ * @param {string} root The files server root.
+ * @param {Options} options The files server options.
  */
 function server(root, options) {
-  const service = new Service(root, options);
+  const service = new Service.Service(root, options);
   if (options === null || options === void 0 ? void 0 : options.defer) {
     return async (context, next) => {
       await next();
@@ -34,4 +35,4 @@ function server(root, options) {
   };
 }
 
-module.exports = server;
+exports.server = server;

package/cjs/index.d.cts

@@ -0,0 +1,15 @@
+/**
+ * @module index
+ */
+import { Middleware } from 'koa';
+import { Options as ServiceOptions } from './Service.cjs';
+export interface Options extends ServiceOptions {
+  defer?: boolean;
+}
+/**
+ * @function server
+ * @description Create files server.
+ * @param {string} root The files server root.
+ * @param {Options} options The files server options.
+ */
+export declare function server(root: string, options?: Options): Middleware;

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.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.2.1
+ * @version 4.0.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.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -166,7 +166,7 @@ function parseRanges(context, stats) {
             const contentRange = `Content-Range: bytes ${start}-${end}/${size}`;
             const prefix = buffer.Buffer.from(`${head}--${boundary}\r\n${contentType}\r\n${contentRange}\r\n\r\n`);
             // Compute Content-Length
-            contentLength += length + prefix.length;
+            contentLength += prefix.length + length;
             // Cache range.
             ranges.push({ offset: start, length, prefix });
           }

package/cjs/utils/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.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/type.cjs

@@ -0,0 +1,24 @@
+/**
+ * @package koa-files
+ * @license MIT
+ * @version 4.0.0
+ * @author nuintun <nuintun@qq.com>
+ * @description A static files serving middleware for koa.
+ * @see https://github.com/nuintun/koa-files#readme
+ */
+
+'use strict';
+
+/**
+ * @module type
+ */
+/**
+ * @function isFunction
+ * @description Check if value is function.
+ * @param value The value to check.
+ */
+function isFunction(value) {
+  return typeof value === 'function';
+}
+
+exports.isFunction = isFunction;

package/cjs/utils/type.d.cts

@@ -0,0 +1,9 @@
+/**
+ * @module type
+ */
+/**
+ * @function isFunction
+ * @description Check if value is function.
+ * @param value The value to check.
+ */
+export declare function isFunction(value: unknown): value is Function;

package/{types → esm}/ReadStream.d.ts

@@ -2,8 +2,8 @@
  * @module ReadStream
  */
 import { PathLike } from 'fs';
-import { Range } from './utils/http';
-import { FileSystem } from './utils/fs';
+import { Range } from './utils/http.js';
+import { FileSystem } from './utils/fs.js';
 import { Readable, ReadableOptions } from 'stream';
 export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
   fs: FileSystem;

package/esm/ReadStream.js

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

package/{types → esm}/Service.d.ts

@@ -3,13 +3,13 @@
  */
 import { Context } from 'koa';
 import { Stats } from 'fs';
-import { FileSystem } from './utils/fs';
-interface IgnoreFunction {
-  (path: string): boolean;
-}
+import { FileSystem } from './utils/fs.js';
 interface Headers {
   [key: string]: string | string[];
 }
+interface IgnoreFunction {
+  (path: string): boolean | Promise<boolean>;
+}
 interface HeadersFunction {
   (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
@@ -25,7 +25,7 @@ export interface Options {
 /**
  * @class Service
  */
-export default class Service {
+export declare class Service {
   private readonly root;
   private readonly options;
   /**

package/esm/Service.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -10,6 +10,7 @@
 import createETag from 'etag';
 import fs from 'fs';
 import { ReadStream } from './ReadStream.js';
+import { isFunction } from './utils/type.js';
 import { stat } from './utils/fs.js';
 import { resolve, extname, join } from 'path';
 import { unixify, isOutRoot, hasTrailingSlash } from './utils/path.js';
@@ -18,14 +19,6 @@ import { decodeURI, isConditionalGET, isPreconditionFailed, parseRanges } from '
 /**
  * @module Service
  */
-/**
- * @function isFunction
- * @description Check if value is function.
- * @param value The value to check.
- */
-function isFunction(value) {
-  return typeof value === 'function';
-}
 /**
  * @class Service
  */
@@ -46,9 +39,10 @@ class Service {
    * @description Check if path is ignore.
    * @param path The path to check.
    */
-  isIgnore(path) {
+  async isIgnore(path) {
     const { ignore } = this.options;
-    return (isFunction(ignore) ? ignore(path) : false) === true;
+    const isIgnored = isFunction(ignore) ? await ignore(path) : false;
+    return isIgnored === true;
   }
   /**
    * @private
@@ -129,7 +123,7 @@ class Service {
       return false;
     }
     // Is ignore path or file (403).
-    if (this.isIgnore(path)) {
+    if (await this.isIgnore(path)) {
       return false;
     }
     // Get options.
@@ -196,4 +190,4 @@ class Service {
   }
 }
 
-export { Service as default };
+export { Service };

package/esm/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @module index
+ */
+import { Middleware } from 'koa';
+import { Options as ServiceOptions } from './Service.js';
+export interface Options extends ServiceOptions {
+  defer?: boolean;
+}
+/**
+ * @function server
+ * @description Create files server.
+ * @param {string} root The files server root.
+ * @param {Options} options The files server options.
+ */
+export declare function server(root: string, options?: Options): Middleware;

package/esm/index.js

@@ -1,21 +1,22 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
  */
 
-import Service from './Service.js';
+import { Service } from './Service.js';
 
 /**
  * @module index
  */
 /**
  * @function server
- * @param {string} root
- * @param {Options} options
+ * @description Create files server.
+ * @param {string} root The files server root.
+ * @param {Options} options The files server options.
  */
 function server(root, options) {
   const service = new Service(root, options);
@@ -32,4 +33,4 @@ function server(root, options) {
   };
 }
 
-export { server as default };
+export { server };

package/esm/utils/fs.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @module fs
+ */
+import fs, { Stats } from 'fs';
+export interface FileSystem {
+  stat: typeof fs.stat;
+  open: typeof fs.open;
+  read: typeof fs.read;
+  close: typeof fs.close;
+}
+/**
+ * @function stat
+ * @description Get file stats.
+ * @param fs The file system to used.
+ * @param path The file path.
+ */
+export declare function stat(fs: FileSystem, path: string): Promise<Stats | null>;

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.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.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @module hash
+ */
+/**
+ * @function generate
+ * @description Generate a hash.
+ * @param length The length of hash.
+ */
+export declare function generate(length: number): string;

package/esm/utils/hash.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.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.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @module http
+ */
+import { Stats } from 'fs';
+import { Context } from 'koa';
+import { Buffer } from 'buffer';
+export interface Range {
+  offset: number;
+  length: number;
+  prefix?: Buffer;
+  suffix?: Buffer;
+}
+/**
+ * @function decodeURI
+ * @description Decode URI component.
+ * @param URI The URI to decode.
+ */
+export declare function decodeURI(URI: string): string | -1;
+/**
+ * @function isConditionalGET
+ * @description Check if request is conditional GET.
+ * @param context The koa context.
+ */
+export declare function isConditionalGET({ request }: Context): boolean;
+/**
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
+ * @param context The koa context.
+ */
+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): Range[] | -1 | -2;

package/esm/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -158,7 +158,7 @@ function parseRanges(context, stats) {
             const contentRange = `Content-Range: bytes ${start}-${end}/${size}`;
             const prefix = Buffer.from(`${head}--${boundary}\r\n${contentType}\r\n${contentRange}\r\n\r\n`);
             // Compute Content-Length
-            contentLength += length + prefix.length;
+            contentLength += prefix.length + length;
             // Cache range.
             ranges.push({ offset: start, length, prefix });
           }

package/esm/utils/path.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module path
+ */
+/**
+ * @function unixify
+ * @description Convert path to unix style.
+ * @param path The path to convert.
+ */
+export declare function unixify(path: string): string;
+/**
+ * @function hasTrailingSlash
+ * @description Check if path has trailing slash.
+ * @param path The path to check.
+ */
+export declare function hasTrailingSlash(path: string): boolean;
+/**
+ * @function isOutRoot
+ * @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;

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.2.1
+ * @version 4.0.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/type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @module type
+ */
+/**
+ * @function isFunction
+ * @description Check if value is function.
+ * @param value The value to check.
+ */
+export declare function isFunction(value: unknown): value is Function;

package/esm/utils/type.js

@@ -0,0 +1,22 @@
+/**
+ * @package koa-files
+ * @license MIT
+ * @version 4.0.0
+ * @author nuintun <nuintun@qq.com>
+ * @description A static files serving middleware for koa.
+ * @see https://github.com/nuintun/koa-files#readme
+ */
+
+/**
+ * @module type
+ */
+/**
+ * @function isFunction
+ * @description Check if value is function.
+ * @param value The value to check.
+ */
+function isFunction(value) {
+  return typeof value === 'function';
+}
+
+export { isFunction };

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "koa-files",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
   "module": "esm/index.js",
-  "types": "types/index.d.ts",
   "exports": {
-    "import": "./esm/index.js",
-    "require": "./cjs/index.cjs",
-    "types": "./types/index.d.ts"
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.cjs"
+    }
   },
   "files": [
     "cjs",
-    "esm",
-    "types"
+    "esm"
   ],
   "repository": {
     "type": "git",
@@ -43,34 +42,35 @@
   },
   "homepage": "https://github.com/nuintun/koa-files#readme",
   "scripts": {
-    "test": "node tests",
     "lint": "tsc --noEmit",
+    "test": "node tests/index.js",
     "clean": "node tools/clean.js",
     "prepublishOnly": "npm run build",
     "build:cjs": "rollup -c tools/rollup.cjs.js",
     "build:esm": "rollup -c tools/rollup.esm.js",
+    "build:fix-types": "node tools/fix-types.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 && node tools/fix-types.js"
+    "build:main": "npm run build:cjs && npm run build:esm && npm run build:fix-types"
   },
   "dependencies": {
     "etag": "^1.8.1",
     "range-parser": "^1.2.1",
-    "tslib": "^2.8.0"
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^12.1.1",
+    "@rollup/plugin-typescript": "^12.1.2",
     "@types/etag": "^1.8.3",
     "@types/koa": "^2.15.0",
+    "@types/node": "^22.10.2",
     "@types/range-parser": "^1.2.7",
+    "dts-paths": "^1.0.1",
     "koa": "^2.15.3",
-    "magic-string": "^0.30.12",
-    "prettier": "^3.3.3",
+    "magic-string": "^0.30.17",
+    "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
-    "rollup": "^4.24.0",
-    "tsc-alias": "^1.8.10",
-    "typescript": "^5.6.3"
+    "rollup": "^4.28.1",
+    "typescript": "^5.7.2"
   },
   "peerDependencies": {
     "koa": "^2.0.0"

package/types/index.d.ts

@@ -1,14 +0,0 @@
-/**
- * @module index
- */
-import { Middleware } from 'koa';
-import { Options as ServiceOptions } from './Service';
-export interface Options extends ServiceOptions {
-  defer?: boolean;
-}
-/**
- * @function server
- * @param {string} root
- * @param {Options} options
- */
-export default function server(root: string, options?: Options): Middleware;