@fastify/static 6.11.2 → 7.0.0

package/.eslintrc.json

@@ -1,51 +1,31 @@
 {
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended",
-      "standard"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "plugins": ["@typescript-eslint"],
-    "env": { "node": true },
-    "parserOptions": {
-      "ecmaVersion": 6,
-      "sourceType": "module",
-      "project": "./tsconfig.eslint.json",
-      "createDefaultProgram": true
-    },
-    "rules": {
-      "no-console": "off",
-      "@typescript-eslint/indent": ["error", 2],
-      "semi": ["error", "never"],
-      "import/export": "off" // this errors on multiple exports (overload interfaces)
-    },
-    "overrides": [
-      {
-        "files": ["*.d.ts","*.test-d.ts"],
-        "rules": {
-          "no-use-before-define": "off",
-          "no-redeclare": "off",
-          "@typescript-eslint/no-explicit-any": "off"
-        }
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "standard"],
+  "overrides": [
+    {
+      "files": ["types/*.test-d.ts", "types/*.d.ts"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": ["./tsconfig.eslint.json"]
       },
-      {
-        "files": ["*.test-d.ts"],
-        "rules": {
-          "@typescript-eslint/no-var-requires": "off",
-          "no-unused-vars": "off",
-          "n/handle-callback-err": "off",
-          "@typescript-eslint/no-empty-function": "off",
-          "@typescript-eslint/explicit-function-return-type": "off",
-          "@typescript-eslint/no-unused-vars": "off",
-          "@typescript-eslint/no-non-null-assertion": "off",
-          "@typescript-eslint/no-misused-promises": ["error", {
-            "checksVoidReturn": false
-          }]
-        },
-        "globals": {
-          "NodeJS": "readonly"
-        }
+      "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking"
+      ],
+      "rules": {
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-floating-promises": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-misused-promises": ["error", {
+          "checksVoidReturn": false
+        }]
       }
-    ]
-  }
+    }
+  ]
+}

package/README.md

@@ -124,7 +124,7 @@ A URL path prefix used to create a virtual mount path for the static directory.
 Default: `{}`
 
 Constraints that will be added to registered routes. See Fastify's documentation for
-[route constraints](https://www.fastify.io/docs/latest/Reference/Routes/#constraints).
+[route constraints](https://fastify.dev/docs/latest/Reference/Routes/#constraints).
 
 #### `prefixAvoidTrailingSlash`
 
@@ -450,7 +450,7 @@ decorators.
 
 If a request matches the URL `prefix` but a file cannot be found for the
 request, Fastify's 404 handler will be called. You can set a custom 404
-handler with [`fastify.setNotFoundHandler()`](https://www.fastify.io/docs/latest/Reference/Server/#setnotfoundhandler).
+handler with [`fastify.setNotFoundHandler()`](https://fastify.dev/docs/latest/Reference/Server/#setnotfoundhandler).
 
 When registering `@fastify/static` within an encapsulated context, the `wildcard` option may need to be set to `false` in order to support index resolution and nested not-found-handler:
 
@@ -475,7 +475,7 @@ This code will send the `index.html` for the paths `docs`, `docs/`, and `docs/in
 
 If an error occurs while trying to send a file, the error will be passed
 to Fastify's error handler. You can set a custom error handler with
-[`fastify.setErrorHandler()`](https://www.fastify.io/docs/latest/Reference/Server/#seterrorhandler).
+[`fastify.setErrorHandler()`](https://fastify.dev/docs/latest/Reference/Server/#seterrorhandler).
 
 ### Payload `stream.filename`
 

package/index.js

@@ -4,9 +4,7 @@ const { PassThrough } = require('node:stream')
 const path = require('node:path')
 const { fileURLToPath } = require('node:url')
 const { statSync } = require('node:fs')
-const { promisify } = require('node:util')
-const glob = require('glob')
-const globPromise = promisify(glob)
+const { glob } = require('glob')
 const fp = require('fastify-plugin')
 const send = require('@fastify/send')
 const encodingNegotiator = require('@fastify/accept-negotiator')
@@ -14,12 +12,9 @@ const contentDisposition = require('content-disposition')
 
 const dirList = require('./lib/dirList')
 
-const winSeparatorRegex = new RegExp(`\\${path.win32.sep}`, 'g')
-const backslashRegex = /\\/g
-const startForwardSlashRegex = /^\//
-const endForwardSlashRegex = /\/$/
-const doubleForwardSlashRegex = /\/\//g
-const asteriskRegex = /\*/g
+const endForwardSlashRegex = /\/$/u
+const doubleForwardSlashRegex = /\/\//gu
+const asteriskRegex = /\*/gu
 
 const supportedEncodings = ['br', 'gzip', 'deflate']
 send.mime.default_type = 'application/octet-stream'
@@ -129,19 +124,20 @@ async function fastifyStatic (fastify, opts) {
         })
       }
     } else {
-      const globPattern = '**/**'
+      const indexes = opts.index === undefined ? ['index.html'] : [].concat(opts.index)
       const indexDirs = new Map()
       const routes = new Set()
+      const globPattern = '**/**'
 
       const roots = Array.isArray(sendOptions.root) ? sendOptions.root : [sendOptions.root]
       for (let i = 0; i < roots.length; ++i) {
         const rootPath = roots[i]
-        const files = await globPromise(path.join(rootPath, globPattern).replace(winSeparatorRegex, path.posix.sep), { nodir: true, dot: opts.serveDotFiles })
-        const indexes = opts.index === undefined ? ['index.html'] : [].concat(opts.index)
+        const posixRootPath = rootPath.split(path.win32.sep).join(path.posix.sep)
+        const files = await glob(`${posixRootPath}/${globPattern}`, { follow: true, nodir: true, dot: opts.serveDotFiles })
 
         for (let i = 0; i < files.length; ++i) {
-          const file = files[i].replace(rootPath.replace(backslashRegex, '/'), '')
-            .replace(startForwardSlashRegex, '')
+          const file = files[i].split(path.win32.sep).join(path.posix.sep)
+            .replace(`${posixRootPath}/`, '')
           const route = (prefix + file).replace(doubleForwardSlashRegex, '/')
 
           if (routes.has(route)) {
@@ -150,7 +146,7 @@ async function fastifyStatic (fastify, opts) {
 
           routes.add(route)
 
-          setUpHeadAndGet(routeOpts, route, '/' + file, rootPath)
+          setUpHeadAndGet(routeOpts, route, `/${file}`, rootPath)
 
           const key = path.posix.basename(route)
           if (indexes.includes(key) && !indexDirs.has(key)) {
@@ -436,7 +432,7 @@ function checkRootPathForErrors (fastify, rootPath) {
       throw new Error('"root" option array requires one or more paths')
     }
 
-    if ([...new Set(rootPath)].length !== rootPath.length) {
+    if (new Set(rootPath).size !== rootPath.length) {
       throw new Error(
         '"root" option array contains one or more duplicate paths'
       )
@@ -498,7 +494,7 @@ function findIndexFile (pathname, root, indexFiles = ['index.html']) {
       try {
         const stats = statSync(p)
         return !stats.isDirectory()
-      } catch (e) {
+      } catch {
         return false
       }
     })
@@ -542,7 +538,7 @@ function getRedirectUrl (url) {
     const parsed = new URL(url, 'http://localhost.com/')
     const parsedPathname = parsed.pathname
     return parsedPathname + (parsedPathname[parsedPathname.length - 1] !== '/' ? '/' : '') + (parsed.search || '')
-  } catch (error) {
+  } catch {
     // the try-catch here is actually unreachable, but we keep it for safety and prevent DoS attack
     /* istanbul ignore next */
     const err = new Error(`Invalid redirect URL: ${url}`)

package/lib/dirList.js

@@ -27,7 +27,7 @@ const dirList = {
       let stats
       try {
         stats = await fs.stat(path.join(dir, filename))
-      } catch (error) {
+      } catch {
         return
       }
       const entry = { name: filename, stats }
@@ -58,7 +58,7 @@ const dirList = {
           let stats
           try {
             stats = await fs.stat(filePath)
-          } catch (error) {
+          } catch {
             return
           }
 
@@ -112,7 +112,7 @@ const dirList = {
     let entries
     try {
       entries = await dirList.list(dir, options, dotfiles)
-    } catch (error) {
+    } catch {
       return reply.callNotFound()
     }
     const format = reply.request.query.format || options.format
@@ -146,7 +146,7 @@ const dirList = {
       route = path.normalize(path.join(route, '..'))
     }
     return {
-      href: path.join(prefix, route, entry.name).replace(/\\/g, '/'),
+      href: path.join(prefix, route, entry.name).replace(/\\/gu, '/'),
       name: entry.name,
       stats: entry.stats,
       extendedInfo: entry.extendedInfo

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@fastify/static",
-  "version": "6.11.2",
+  "version": "7.0.0",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
+  "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
     "coverage": "npm run test:unit -- --coverage-report=html",
@@ -17,7 +18,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/fastify/fastify-static.git"
+    "url": "git+https://github.com/fastify/fastify-static.git"
   },
   "keywords": [
     "fastify",
@@ -34,7 +35,7 @@
     "@fastify/send": "^2.0.0",
     "content-disposition": "^0.5.3",
     "fastify-plugin": "^4.0.0",
-    "glob": "^8.0.1",
+    "glob": "^10.3.4",
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
@@ -54,7 +55,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.29.0",
+    "tsd": "^0.30.0",
     "typescript": "^5.1.6"
   },
   "tsd": {

package/test/static.test.js

@@ -1000,7 +1000,7 @@ t.test('sendFile disabled', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', function (req, reply) {
-    if (typeof reply.sendFile === 'undefined') {
+    if (reply.sendFile === undefined) {
       reply.send('pass')
     } else {
       reply.send('fail')
@@ -1277,7 +1277,7 @@ t.test('sendFile disabled', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', function (req, reply) {
-    if (typeof reply.sendFile === 'undefined') {
+    if (reply.sendFile === undefined) {
       reply.send('pass')
     } else {
       reply.send('fail')
@@ -1316,7 +1316,7 @@ t.test('download disabled', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', function (req, reply) {
-    if (typeof reply.download === 'undefined') {
+    if (reply.download === undefined) {
       t.equal(reply.download, undefined)
       reply.send('pass')
     } else {

package/tsconfig.eslint.json

@@ -1,13 +1,10 @@
 {
-    "compilerOptions": {
-      "target": "es6",
-      "lib": [ "es2015" ],
-      "module": "commonjs",
-      "noEmit": true,
-      "strict": true
-    },
-    "include": [
-      "types/*.test-d.ts",
-      "types/*.d.ts"
-    ]
-  }
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["ES2018"],
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true
+  },
+  "include": ["types/*.test-d.ts", "types/*.d.ts"]
+}

package/types/index.d.ts

@@ -2,7 +2,7 @@
 //                 Leo <https://github.com/leomelzer>
 /// <reference types="node" />
 
-import { FastifyPluginAsync, FastifyRequest, RouteOptions } from 'fastify'
+import { FastifyPluginAsync, FastifyReply, FastifyRequest, RouteOptions } from 'fastify'
 import { Stats } from 'fs'
 
 declare module 'fastify' {
@@ -19,6 +19,13 @@ declare module 'fastify' {
 type FastifyStaticPlugin = FastifyPluginAsync<NonNullable<fastifyStatic.FastifyStaticOptions>>;
 
 declare namespace fastifyStatic {
+  export interface SetHeadersResponse {
+    getHeader: FastifyReply['getHeader'];
+    setHeader: FastifyReply['header'];
+    readonly filename: string;
+    statusCode: number;
+  }
+
   export interface ExtendedInformation {
     fileCount: number;
     totalFileCount: number;
@@ -83,7 +90,7 @@ declare namespace fastifyStatic {
     serve?: boolean;
     decorateReply?: boolean;
     schemaHide?: boolean;
-    setHeaders?: (...args: any[]) => void;
+    setHeaders?: (res: SetHeadersResponse, path: string, stat: Stats) => void;
     redirect?: boolean;
     wildcard?: boolean;
     list?: boolean | ListOptionsJsonFormat | ListOptionsHtmlFormat;

package/types/index.test-d.ts

@@ -1,5 +1,6 @@
-import fastify, { FastifyInstance, FastifyPluginAsync, FastifyRequest } from 'fastify'
+import fastify, { FastifyInstance, FastifyPluginAsync, FastifyRequest, FastifyReply } from 'fastify'
 import { Server } from 'http'
+import { Stats } from 'fs'
 import { expectAssignable, expectError, expectType } from 'tsd'
 import * as fastifyStaticStar from '..'
 import fastifyStatic, {
@@ -49,8 +50,15 @@ const options: FastifyStaticOptions = {
   serve: true,
   wildcard: true,
   list: false,
-  setHeaders: (res: any, pathName: any) => {
-    res.setHeader('test', pathName)
+  setHeaders: (res, path, stat) => {
+    expectType<string>(res.filename)
+    expectType<number>(res.statusCode)
+    expectType<ReturnType<FastifyReply['getHeader']>>(res.getHeader('X-Test'))
+    res.setHeader('X-Test', 'string')
+
+    expectType<string>(path)
+
+    expectType<Stats>(stat)
   },
   preCompressed: false,
   allowedPath: (pathName: string, root: string, request: FastifyRequest) => {