@fastify/compress 6.1.0 → 6.2.0

package/.github/workflows/ci.yml

@@ -14,4 +14,5 @@ jobs:
   test:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
     with:
+      license-check: true
       lint: true

package/README.md

@@ -85,7 +85,7 @@ app.get('/', (req, reply) => {
     .compress(fs.createReadStream('./package.json'))
 })
 
-await app.listen(3000)
+await app.listen({ port: 3000 })
 ```
 
 ## Compress Options
@@ -163,7 +163,7 @@ You can tune compression by setting the `brotliOptions` and `zlibOptions` proper
       },
     },
     zlibOptions: {
-      level: 9, // default is 9, max is 9, min is 0
+      level: 6, // default is typically 6, max is 9, min is 0
     }
   });
 ```

package/index.js

@@ -8,7 +8,7 @@ const intoStream = require('into-stream')
 const peek = require('peek-stream')
 const Minipass = require('minipass')
 const pumpify = require('pumpify')
-const encodingNegotiator = require('encoding-negotiator')
+const encodingNegotiator = require('@fastify/accept-negotiator')
 const { inherits, format } = require('util')
 
 const { isStream, isGzip, isDeflate } = require('./lib/utils')
@@ -16,7 +16,7 @@ const { isStream, isGzip, isDeflate } = require('./lib/utils')
 const InvalidRequestEncodingError = createError('FST_CP_ERR_INVALID_CONTENT_ENCODING', 'Unsupported Content-Encoding: %s', 415)
 const InvalidRequestCompressedPayloadError = createError('FST_CP_ERR_INVALID_CONTENT', 'Could not decompress the request payload using the provided encoding', 400)
 
-function compressPlugin (fastify, opts, next) {
+function fastifyCompress (fastify, opts, next) {
   const globalCompressParams = processCompressParams(opts)
   const globalDecompressParams = processDecompressParams(opts)
 
@@ -548,7 +548,9 @@ function createError (code, message, statusCode) {
   return FastifyCompressError
 }
 
-module.exports = fp(compressPlugin, {
+module.exports = fp(fastifyCompress, {
   fastify: '4.x',
   name: '@fastify/compress'
 })
+module.exports.default = fastifyCompress
+module.exports.fastifyCompress = fastifyCompress

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fastify/compress",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Fastify compression utils",
   "main": "index.js",
-  "types": "index.d.ts",
+  "types": "types/index.d.ts",
   "dependencies": {
-    "encoding-negotiator": "^2.0.1",
-    "fastify-plugin": "^3.0.0",
+    "@fastify/accept-negotiator": "^1.0.0",
+    "fastify-plugin": "^4.0.0",
     "into-stream": "^6.0.0",
     "mime-db": "^1.51.0",
     "minipass": "^3.1.6",
@@ -15,16 +15,16 @@
     "pumpify": "^2.0.1"
   },
   "devDependencies": {
-    "@types/node": "^17.0.8",
+    "@fastify/pre-commit": "^2.0.2",
+    "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^5.9.0",
     "@typescript-eslint/parser": "^5.9.0",
     "adm-zip": "^0.5.9",
     "fastify": "^4.0.0-rc.2",
     "jsonstream": "^1.0.3",
-    "pre-commit": "^1.2.2",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.21.0",
+    "tsd": "^0.24.1",
     "typescript": "^4.5.4"
   },
   "scripts": {

package/types/index.d.ts

@@ -0,0 +1,100 @@
+import {
+  FastifyPluginCallback,
+  FastifyReply,
+  FastifyRequest,
+  RawServerBase,
+  RawServerDefault,
+  RouteOptions as FastifyRouteOptions
+} from 'fastify'
+import { Input, InputObject } from 'into-stream'
+import { Stream } from 'stream'
+import { BrotliOptions, ZlibOptions } from 'zlib'
+
+declare module 'fastify' {
+  export interface FastifyContextConfig {
+    /** @deprecated `config.compress` is deprecated, use `compress` shorthand option instead */
+    compress?: RouteCompressOptions | false;
+    /** @deprecated `config.decompress` is deprecated, use `decompress` shorthand option instead */
+    decompress?: RouteDecompressOptions | false;
+  }
+
+  export interface RouteShorthandOptions<
+    RawServer extends RawServerBase = RawServerDefault
+  > {
+    compress?: RouteCompressOptions | false;
+    decompress?: RouteDecompressOptions | false;
+  }
+
+  interface FastifyReply {
+    compress(input: Stream | Input | InputObject): void;
+  }
+
+  export interface RouteOptions {
+    compress?: RouteCompressOptions | false;
+    decompress?: RouteDecompressOptions | false;
+  }
+}
+
+type FastifyCompress = FastifyPluginCallback<fastifyCompress.FastifyCompressOptions>
+
+type RouteCompressOptions = Pick<fastifyCompress.FastifyCompressOptions,
+  | 'brotliOptions'
+  | 'customTypes'
+  | 'encodings'
+  | 'inflateIfDeflated'
+  | 'onUnsupportedEncoding'
+  | 'removeContentLengthHeader'
+  | 'threshold'
+  | 'zlib'
+  | 'zlibOptions'
+>
+
+type RouteDecompressOptions = Pick<fastifyCompress.FastifyCompressOptions,
+  | 'forceRequestEncoding'
+  | 'onInvalidRequestPayload'
+  | 'onUnsupportedRequestEncoding'
+  | 'requestEncodings'
+  | 'zlib'
+>
+
+type EncodingToken = 'br' | 'deflate' | 'gzip' | 'identity';
+
+declare namespace fastifyCompress {
+
+  export interface FastifyCompressOptions {
+    brotliOptions?: BrotliOptions;
+    customTypes?: RegExp;
+    encodings?: EncodingToken[];
+    forceRequestEncoding?: EncodingToken;
+    global?: boolean;
+    inflateIfDeflated?: boolean;
+    onInvalidRequestPayload?: (encoding: string, request: FastifyRequest, error: Error) => Error | undefined | null;
+    onUnsupportedEncoding?: (encoding: string, request: FastifyRequest, reply: FastifyReply) => string | Buffer | Stream;
+    onUnsupportedRequestEncoding?: (encoding: string, request: FastifyRequest, reply: FastifyReply) => Error | undefined | null;
+    removeContentLengthHeader?: boolean;
+    requestEncodings?: EncodingToken[];
+    threshold?: number;
+    zlib?: unknown;
+    zlibOptions?: ZlibOptions;
+  }
+
+  export interface FastifyCompressRouteOptions {
+    compress?: RouteCompressOptions | false;
+    decompress?: RouteDecompressOptions | false;
+  }
+
+  export interface RouteOptions extends FastifyRouteOptions, FastifyCompressRouteOptions { }
+
+  export interface RoutesConfigCompressOptions {
+    /** @deprecated `config.compress` is deprecated, use `compress` shorthand option instead */
+    compress?: RouteCompressOptions | false;
+    /** @deprecated `config.decompress` is deprecated, use `decompress` shorthand option instead */
+    decompress?: RouteDecompressOptions | false;
+  }
+
+  export const fastifyCompress: FastifyCompress
+  export { fastifyCompress as default }
+}
+
+declare function fastifyCompress(...params: Parameters<FastifyCompress>): ReturnType<FastifyCompress>
+export = fastifyCompress

package/{test/types → types}/index.test-d.ts

@@ -2,7 +2,7 @@ import fastify, { FastifyInstance } from 'fastify'
 import { createReadStream } from 'fs'
 import { expectError, expectType } from 'tsd'
 import * as zlib from 'zlib'
-import fastifyCompress, { FastifyCompressOptions } from '../..'
+import fastifyCompress, { FastifyCompressOptions } from '..'
 
 const stream = createReadStream('./package.json')
 

package/index.d.ts

@@ -1,81 +0,0 @@
-import {
-  FastifyPluginCallback,
-  FastifyReply,
-  FastifyRequest,
-  RawServerBase,
-  RawServerDefault
-} from 'fastify'
-import * as fastify from 'fastify'
-import { Input, InputObject } from 'into-stream'
-import { Stream } from 'stream'
-import { BrotliOptions, ZlibOptions } from 'zlib'
-
-type EncodingToken = 'br' | 'deflate' | 'gzip' | 'identity';
-
-export interface FastifyCompressOptions {
-  brotliOptions?: BrotliOptions;
-  customTypes?: RegExp;
-  encodings?: EncodingToken[];
-  forceRequestEncoding?: EncodingToken;
-  global?: boolean;
-  inflateIfDeflated?: boolean;
-  onInvalidRequestPayload?: (encoding: string, request: FastifyRequest, error: Error) => Error | undefined | null;
-  onUnsupportedEncoding?: (encoding: string, request: FastifyRequest, reply: FastifyReply) => string | Buffer | Stream;
-  onUnsupportedRequestEncoding?: (encoding: string, request: FastifyRequest, reply: FastifyReply) => Error | undefined | null;
-  removeContentLengthHeader?: boolean;
-  requestEncodings?: EncodingToken[];
-  threshold?: number;
-  zlib?: unknown;
-  zlibOptions?: ZlibOptions;
-}
-
-interface RouteCompressOptions extends Pick<FastifyCompressOptions,
-  | 'brotliOptions'
-  | 'customTypes'
-  | 'encodings'
-  | 'inflateIfDeflated'
-  | 'onUnsupportedEncoding'
-  | 'removeContentLengthHeader'
-  | 'threshold'
-  | 'zlib'
-  | 'zlibOptions'
-> {}
-
-interface RouteDecompressOptions extends Pick<FastifyCompressOptions,
-  | 'forceRequestEncoding'
-  | 'onInvalidRequestPayload'
-  | 'onUnsupportedRequestEncoding'
-  | 'requestEncodings'
-  | 'zlib'
-> {}
-
-interface FastifyCompressRouteOptions {
-  compress?: RouteCompressOptions | false;
-  decompress?: RouteDecompressOptions | false;
-}
-
-export interface RouteOptions extends fastify.RouteOptions, FastifyCompressRouteOptions {}
-
-export interface RoutesConfigCompressOptions {
-  /** @deprecated `config.compress` is deprecated, use `compress` shorthand option instead */
-  compress?: RouteCompressOptions | false;
-  /** @deprecated `config.decompress` is deprecated, use `decompress` shorthand option instead */
-  decompress?: RouteDecompressOptions | false;
-}
-
-declare module 'fastify' {
-  export interface FastifyContextConfig extends RoutesConfigCompressOptions {}
-
-  export interface RouteShorthandOptions<
-    RawServer extends RawServerBase = RawServerDefault
-  > extends FastifyCompressRouteOptions {}
-
-  interface FastifyReply {
-    compress(input: Stream | Input | InputObject): void;
-  }
-
-  export interface RouteOptions extends FastifyCompressRouteOptions {}
-}
-
-declare const fastifyCompress: FastifyPluginCallback<FastifyCompressOptions>
-export default fastifyCompress