@fastify/static 6.0.0 → 6.3.0

package/README.md

@@ -2,7 +2,6 @@
 
 ![CI](https://github.com/fastify/fastify-static/workflows/CI/badge.svg)
 [![NPM version](https://img.shields.io/npm/v/@fastify/static.svg?style=flat)](https://www.npmjs.com/package/@fastify/static)
-[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fastify-static/badge.svg)](https://snyk.io/test/github/fastify/fastify-static)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
 Plugin for serving static files as fast as possible. Supports Fastify version `3.x`.
@@ -191,7 +190,9 @@ If set, it provide the directory list calling the directory path.
 
 Default response is json.
 
-Note: Multi-root is not supported within the `list` option.
+Note:
+- Multi-root is not supported within the `list` option.
+- If `dotfiles` option value is `deny` or `ignore`, dotfiles will be excluded.
 
 **Example:**
 

package/index.d.ts

@@ -43,13 +43,20 @@ interface ListRender {
 }
 
 interface ListOptions {
-  format: 'json' | 'html';
-  names: string[];
-  render: ListRender;
+  names?: string[];
   extendedFolderInfo?: boolean;
+}
+
+interface ListOptionsJsonFormat extends ListOptions {
+  format: 'json';
   jsonFormat?: 'names' | 'extended';
 }
 
+interface ListOptionsHtmlFormat extends ListOptions {
+  format: 'html';
+  render: ListRender;
+}
+
 // Passed on to `send`
 interface SendOptions {
   acceptRanges?: boolean;
@@ -73,7 +80,7 @@ export interface FastifyStaticOptions extends SendOptions {
   setHeaders?: (...args: any[]) => void;
   redirect?: boolean;
   wildcard?: boolean;
-  list?: boolean | ListOptions;
+  list?: boolean | ListOptionsJsonFormat | ListOptionsHtmlFormat;
   allowedPath?: (pathName: string, root?: string) => boolean;
   /**
    * @description

package/index.js

@@ -161,7 +161,8 @@ async function fastifyStatic (fastify, opts) {
           dir: path,
           options: opts.list,
           route: pathname,
-          prefix
+          prefix,
+          dotfiles: opts.dotfiles
         }).catch((err) => reply.send(err))
         return
       }
@@ -217,7 +218,8 @@ async function fastifyStatic (fastify, opts) {
             dir: dirList.path(opts.root, pathname),
             options: opts.list,
             route: pathname,
-            prefix
+            prefix,
+            dotfiles: opts.dotfiles
           }).catch((err) => reply.send(err))
           return
         }
@@ -331,8 +333,10 @@ async function fastifyStatic (fastify, opts) {
       const indexDirs = new Map()
       const routes = new Set()
 
+      const winSeparatorRegex = new RegExp(`\\${path.win32.sep}`, 'g')
+
       for (const rootPath of Array.isArray(sendOptions.root) ? sendOptions.root : [sendOptions.root]) {
-        const files = await globPromise(path.join(rootPath, globPattern), { nodir: true })
+        const files = await globPromise(path.join(rootPath, globPattern).replace(winSeparatorRegex, path.posix.sep), { nodir: true })
         const indexes = typeof opts.index === 'undefined' ? ['index.html'] : [].concat(opts.index)
 
         for (let file of files) {

package/lib/dirList.js

@@ -8,12 +8,16 @@ const dirList = {
   /**
    * get files and dirs from dir, or error
    * @param {string} dir full path fs dir
-   * @param {function(error, entries)} callback
+   * @param {(boolean | ListOptionsJsonFormat | ListOptionsHtmlFormat)} options
+   * @param {string} dotfiles
    * note: can't use glob because don't get error on non existing dir
    */
-  list: async function (dir, options) {
+  list: async function (dir, options, dotfiles) {
     const entries = { dirs: [], files: [] }
-    const files = await fs.readdir(dir)
+    let files = await fs.readdir(dir)
+    if (dotfiles === 'deny' || dotfiles === 'ignore') {
+      files = files.filter(f => f.charAt(0) !== '.')
+    }
     if (files.length < 1) {
       return entries
     }
@@ -95,13 +99,14 @@ const dirList = {
    * send dir list content, or 404 on error
    * @param {Fastify.Reply} reply
    * @param {string} dir full path fs dir
-   * @param {ListOptions} options
+   * @param {(boolean | ListOptionsJsonFormat | ListOptionsHtmlFormat)} options
    * @param {string} route request route
+   * @param {string} dotfiles
    */
-  send: async function ({ reply, dir, options, route, prefix }) {
+  send: async function ({ reply, dir, options, route, prefix, dotfiles }) {
     let entries
     try {
-      entries = await dirList.list(dir, options)
+      entries = await dirList.list(dir, options, dotfiles)
     } catch (error) {
       return reply.callNotFound()
     }
@@ -146,7 +151,7 @@ const dirList = {
   /**
    * say if the route can be handled by dir list or not
    * @param {string} route request route
-   * @param {ListOptions} options
+   * @param {(boolean | ListOptionsJsonFormat | ListOptionsHtmlFormat)} options
    * @return {boolean}
    */
   handle: function (route, options) {
@@ -189,9 +194,15 @@ const dirList = {
     if (options.list.names && !Array.isArray(options.list.names)) {
       return new TypeError('The `list.names` option must be an array')
     }
+    if (options.list.jsonFormat != null && options.list.jsonFormat !== 'names' && options.list.jsonFormat !== 'extended') {
+      return new TypeError('The `list.jsonFormat` option must be name or extended')
+    }
     if (options.list.format === 'html' && typeof options.list.render !== 'function') {
       return new TypeError('The `list.render` option must be a function and is required with html format')
     }
+    if (options.list.format === 'html' && options.list.jsonFormat != null) {
+      return new TypeError('The `list.jsonFormat` option must be with json format')
+    }
   }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "6.0.0",
+  "version": "6.3.0",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -32,7 +32,7 @@
     "content-disposition": "^0.5.3",
     "encoding-negotiator": "^2.0.1",
     "fastify-plugin": "^3.0.0",
-    "glob": "^7.1.4",
+    "glob": "^8.0.1",
     "p-limit": "^3.1.0",
     "readable-stream": "^3.4.0",
     "send": "^0.18.0"

package/test/dir-list.test.js

@@ -40,7 +40,7 @@ t.test('throws when `root` is an array', t => {
   t.equal(err.message, 'multi-root with list option is not supported')
 })
 
-t.test('throws when `list.format option` is invalid', t => {
+t.test('throws when `list.format` option is invalid', t => {
   t.plan(2)
 
   const err = dirList.validateOptions({ list: { format: 'hello' } })
@@ -56,6 +56,14 @@ t.test('throws when `list.names option` is not an array', t => {
   t.equal(err.message, 'The `list.names` option must be an array')
 })
 
+t.test('throws when `list.jsonFormat` option is invalid', t => {
+  t.plan(2)
+
+  const err = dirList.validateOptions({ list: { jsonFormat: 'hello' } })
+  t.type(err, TypeError)
+  t.equal(err.message, 'The `list.jsonFormat` option must be name or extended')
+})
+
 t.test('throws when `list.format` is html and `list render` is not a function', t => {
   t.plan(2)
 
@@ -64,6 +72,14 @@ t.test('throws when `list.format` is html and `list render` is not a function',
   t.equal(err.message, 'The `list.render` option must be a function and is required with html format')
 })
 
+t.test('throws when `list.format` is html and `list.jsonFormat` is given', t => {
+  t.plan(2)
+
+  const err = dirList.validateOptions({ list: { format: 'html', render: () => '', jsonFormat: 'extended' } })
+  t.type(err, TypeError)
+  t.equal(err.message, 'The `list.jsonFormat` option must be with json format')
+})
+
 t.test('dir list wrong options', t => {
   t.plan(3)
 
@@ -636,6 +652,90 @@ t.test('serve a non existent dir and get error', t => {
   })
 })
 
+t.test('dir list with dotfiles allow option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'allow',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['.aaa', 'test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
+t.test('dir list with dotfiles deny option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'deny',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
+t.test('dir list with dotfiles ignore option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'ignore',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
 t.test('dir list error', t => {
   t.plan(7)
 

package/test/types/index.ts

@@ -1,5 +1,5 @@
 import fastify from 'fastify'
-import { expectError } from 'tsd'
+import { expectAssignable, expectError } from 'tsd'
 import fastifyStatic, { FastifyStaticOptions } from '../..'
 
 const appWithImplicitHttp = fastify()
@@ -32,6 +32,36 @@ expectError<FastifyStaticOptions>({
   wildcard: '**/**'
 })
 
+expectAssignable<FastifyStaticOptions>({
+  root: '',
+  list: {
+    format: 'json',
+  }
+})
+
+expectError<FastifyStaticOptions>({
+  root: '',
+  list: {
+    format: 'json',
+    render: () => ''
+  }
+})
+
+expectAssignable<FastifyStaticOptions>({
+  root: '',
+  list: {
+    format: 'html',
+    render: () => ''
+  }
+})
+
+expectError<FastifyStaticOptions>({
+  root: '',
+  list: {
+    format: 'html',
+  }
+})
+
 appWithImplicitHttp
   .register(fastifyStatic, options)
   .after(() => {