koa-files 3.1.7 → 3.1.9

package/README.md

@@ -18,7 +18,7 @@ $ npm install koa-files
 
 ```ts
 import { Middleware } from 'koa';
-import { createReadStream, stat, Stats } from 'fs';
+import fs, { Stats } from 'node:fs';
 
 interface IgnoreFunction {
   (path: string): boolean;
@@ -32,17 +32,20 @@ interface HeaderFunction {
   (path: string, stats: Stats): Headers | void;
 }
 
-interface FileSystem {
-  readonly stat: typeof stat;
-  readonly createReadStream: typeof createReadStream;
+export interface FileSystem {
+  stat: typeof fs.stat;
+  open: typeof fs.open;
+  read: typeof fs.read;
+  close: typeof fs.close;
 }
 
 export interface Options {
-  etag?: boolean;
   fs?: FileSystem;
   defer?: boolean;
+  etag?: boolean;
   acceptRanges?: boolean;
   lastModified?: boolean;
+  highWaterMark?: number;
   ignore?: IgnoreFunction;
   headers?: Headers | HeaderFunction;
 }
@@ -62,24 +65,24 @@ export default function server(root: string, options?: Options): Middleware;
 - Defaults to `node:fs`.
 - The file system to used.
 
-##### `headers`
+##### `defer`
 
-- Defaults to `undefined`.
-- Set headers to be sent.
-- See docs: [Headers in MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
+- Defaults to `false`.
+- If true, serves after `await next()`.
+- Allowing any downstream middleware to respond first.
 
-##### `acceptRanges`
+##### `etag`
 
 - Defaults to `true`.
-- Enable or disable accepting ranged requests.
-- Disabling this will not send Accept-Ranges and ignore the contents of the Range request header.
+- Enable or disable etag generation.
+- Use weak etag internally.
 - Can be overridden by the `headers`.
 
-##### `etag`
+##### `acceptRanges`
 
 - Defaults to `true`.
-- Enable or disable etag generation.
-- Use weak etag internally.
+- Enable or disable accepting ranged requests.
+- Disabling this will not send Accept-Ranges and ignore the contents of the Range request header.
 - Can be overridden by the `headers`.
 
 ##### `lastModified`
@@ -99,11 +102,11 @@ export default function server(root: string, options?: Options): Middleware;
 - Defaults to `undefined`.
 - Function that determines if a file should be ignored.
 
-##### `defer`
+##### `headers`
 
-- Defaults to `false`.
-- If true, serves after `await next()`.
-- Allowing any downstream middleware to respond first.
+- Defaults to `undefined`.
+- Set headers to be sent.
+- See docs: [Headers in MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
 
 ## Example
 

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -10,7 +10,8 @@
 'use strict';
 
 const createETag = require('etag');
-const fs = require('./utils/fs.cjs');
+const fs = require('fs');
+const fs$1 = require('./utils/fs.cjs');
 const path$1 = require('path');
 const stream = require('./utils/stream.cjs');
 const path = require('./utils/path.cjs');
@@ -21,6 +22,7 @@ function _interopDefault(e) {
 }
 
 const createETag__default = /*#__PURE__*/ _interopDefault(createETag);
+const fs__default = /*#__PURE__*/ _interopDefault(fs);
 
 /**
  * @module Service
@@ -44,8 +46,8 @@ class Service {
    * @param options The file service options.
    */
   constructor(root, options) {
-    this.options = options;
     this.root = path.unixify(path$1.resolve(root));
+    this.options = Object.assign({ fs: fs__default.default, highWaterMark: 65536 }, options);
   }
   /**
    * @private
@@ -135,7 +137,7 @@ class Service {
       return false;
     }
     // File stats.
-    const stats = await fs.stat(this.options.fs, path$2);
+    const stats = await fs$1.stat(this.options.fs, path$2);
     // Check file stats.
     if (
       // File not exist (404 | 500).
@@ -188,9 +190,9 @@ class Service {
       return context.throw(400);
     }
     // Get stream options.
-    const { fs: fs$1, highWaterMark } = this.options;
+    const { fs, highWaterMark } = this.options;
     // Set response body.
-    context.body = new stream.FileReadStream(path$2, ranges, { fs: fs$1, highWaterMark });
+    context.body = new stream.FileReadStream(path$2, ranges, { fs, highWaterMark });
     // File found.
     return true;
   }

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -9,15 +9,8 @@
 
 'use strict';
 
-const fs = require('fs');
 const Service = require('./Service.cjs');
 
-function _interopDefault(e) {
-  return e && e.__esModule ? e : { default: e };
-}
-
-const fs__default = /*#__PURE__*/ _interopDefault(fs);
-
 /**
  * @module index
  */
@@ -27,9 +20,8 @@ const fs__default = /*#__PURE__*/ _interopDefault(fs);
  * @param {Options} options
  */
 function server(root, options) {
-  const config = Object.assign({ fs: fs__default.default }, options);
-  const service = new Service(root, config);
-  if (config.defer) {
+  const service = new Service(root, options);
+  if (options === null || options === void 0 ? void 0 : options.defer) {
     return async (context, next) => {
       await next();
       await service.respond(context);

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @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.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -32,7 +32,7 @@ const CHARS = [
  * @description Generate a hash.
  * @param length The length of hash.
  */
-function generate(length = 32) {
+function generate(length) {
   let hash = '';
   const randomValues = crypto.getRandomValues(new Uint8Array(length));
   // Create hash.

package/cjs/utils/http.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -156,13 +156,13 @@ function parseRanges(context, stats) {
           // Parsed entries.
           const entries = parsed.entries();
           // Range boundary.
-          const boundary = `<${hash.generate()}>`;
+          const boundary = `${hash.generate(32)}`;
           // Multipart Content-Type.
           const contentType = `Content-Type: ${context.type}`;
           // Range suffix.
           const suffix = buffer.Buffer.from(`\r\n--${boundary}--\r\n`);
           // Override Content-Type.
-          context.type = `multipart/byteranges; boundary=${boundary}`;
+          context.type = `multipart/byteranges; boundary="${boundary}"`;
           // Map ranges.
           for (const [index, { start, end }] of entries) {
             const length = end - start + 1;

package/cjs/utils/path.cjs

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

package/cjs/utils/stream.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -24,7 +24,7 @@ class FileReadStream extends stream.Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark = 65536 } = options;
+    const { fs, encoding, highWaterMark } = options;
     super({ encoding, highWaterMark });
     this.bytesRead = 0;
     this.fd = null;

package/esm/Service.js

@@ -1,13 +1,14 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
  */
 
 import createETag from 'etag';
+import fs from 'fs';
 import { stat } from './utils/fs.js';
 import { resolve, extname, join } from 'path';
 import { FileReadStream } from './utils/stream.js';
@@ -36,8 +37,8 @@ class Service {
    * @param options The file service options.
    */
   constructor(root, options) {
-    this.options = options;
     this.root = unixify(resolve(root));
+    this.options = Object.assign({ fs, highWaterMark: 65536 }, options);
   }
   /**
    * @private

package/esm/index.js

@@ -1,13 +1,12 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
  */
 
-import fs from 'fs';
 import Service from './Service.js';
 
 /**
@@ -19,9 +18,8 @@ import Service from './Service.js';
  * @param {Options} options
  */
 function server(root, options) {
-  const config = Object.assign({ fs }, options);
-  const service = new Service(root, config);
-  if (config.defer) {
+  const service = new Service(root, options);
+  if (options === null || options === void 0 ? void 0 : options.defer) {
     return async (context, next) => {
       await next();
       await service.respond(context);

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @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.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -30,7 +30,7 @@ const CHARS = [
  * @description Generate a hash.
  * @param length The length of hash.
  */
-function generate(length = 32) {
+function generate(length) {
   let hash = '';
   const randomValues = getRandomValues(new Uint8Array(length));
   // Create hash.

package/esm/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -148,13 +148,13 @@ function parseRanges(context, stats) {
           // Parsed entries.
           const entries = parsed.entries();
           // Range boundary.
-          const boundary = `<${generate()}>`;
+          const boundary = `${generate(32)}`;
           // Multipart Content-Type.
           const contentType = `Content-Type: ${context.type}`;
           // Range suffix.
           const suffix = Buffer.from(`\r\n--${boundary}--\r\n`);
           // Override Content-Type.
-          context.type = `multipart/byteranges; boundary=${boundary}`;
+          context.type = `multipart/byteranges; boundary="${boundary}"`;
           // Map ranges.
           for (const [index, { start, end }] of entries) {
             const length = end - start + 1;

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @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

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.7
+ * @version 3.1.9
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -22,7 +22,7 @@ class FileReadStream extends Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark = 65536 } = options;
+    const { fs, encoding, highWaterMark } = options;
     super({ encoding, highWaterMark });
     this.bytesRead = 0;
     this.fd = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "3.1.7",
+  "version": "3.1.9",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -27,6 +27,7 @@
     "server",
     "static",
     "service",
+    "multipart",
     "middleware"
   ],
   "engines": {

package/types/Service.d.ts

@@ -1,8 +1,8 @@
 /**
  * @module Service
  */
-import { Stats } from 'fs';
 import { Context } from 'koa';
+import { Stats } from 'fs';
 import { FileSystem } from './utils/fs';
 interface IgnoreFunction {
   (path: string): boolean;
@@ -14,7 +14,7 @@ interface HeaderFunction {
   (path: string, stats: Stats): Headers | void;
 }
 export interface Options {
-  fs: FileSystem;
+  fs?: FileSystem;
   etag?: boolean;
   acceptRanges?: boolean;
   lastModified?: boolean;
@@ -34,7 +34,7 @@ export default class Service {
    * @param root The file service root.
    * @param options The file service options.
    */
-  constructor(root: string, options: Options);
+  constructor(root: string, options?: Options);
   /**
    * @private
    * @method isIgnore

package/types/index.d.ts

@@ -2,10 +2,8 @@
  * @module index
  */
 import { Middleware } from 'koa';
-import { FileSystem } from './utils/fs';
 import { Options as ServiceOptions } from './Service';
-export interface Options extends Omit<ServiceOptions, 'fs'> {
-  fs?: FileSystem;
+export interface Options extends ServiceOptions {
   defer?: boolean;
 }
 /**

package/types/utils/hash.d.ts

@@ -6,4 +6,4 @@
  * @description Generate a hash.
  * @param length The length of hash.
  */
-export declare function generate(length?: number): string;
+export declare function generate(length: number): string;