@middy/http-content-encoding 3.0.0-alpha.3 → 3.0.0-alpha.7

package/README.md

@@ -1,26 +1,36 @@
-# Middy http-content-encoding middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy http-content-encoding middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>HTTP content encoding middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fhttp-content-encoding">
+  <a href="https://www.npmjs.com/package/@middy/http-content-encoding?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fhttp-content-encoding.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/http-content-encoding">
+    <img src="https://packagephobia.com/badge?p=@middy/http-content-encoding" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
+    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  </a>
+  <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
+    <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">
   </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
@@ -36,9 +46,9 @@ npm install --save @middy/http-content-encoding
 ```
 
 ## Options
-- `br` (object) (optional): `zlib.createBrotliCompress` [brotliOptions](https://nodejs.org/api/zlib.html#zlib_class_brotlioptions)
-- `gzip` (object) (optional): `zlib.createGzip` [gzipOptions](https://nodejs.org/api/zlib.html#zlib_class_options)
-- `deflate` (object) (optional): `zlib.createDeflate` [deflateOptions](https://nodejs.org/api/zlib.html#zlib_class_options)
+- `br` (object) (default `{}`): `zlib.createBrotliCompress` [brotliOptions](https://nodejs.org/api/zlib.html#zlib_class_brotlioptions)
+- `gzip` (object) (default `{}`): `zlib.createGzip` [gzipOptions](https://nodejs.org/api/zlib.html#zlib_class_options)
+- `deflate` (object) (default `{}`): `zlib.createDeflate` [deflateOptions](https://nodejs.org/api/zlib.html#zlib_class_options)
 - `overridePreferredEncoding` (array[string]) (optional): Override the preferred encoding order, most browsers prefer `gzip` over `br`, even though `br` has higher compression. Default: `[]`
 
 NOTES:

package/index.js

@@ -1,119 +1,3 @@
-/*
- * `zstd` disabled due to lack of support in browsers
- * https://github.com/Fyrd/caniuse/issues/4065
- * https://github.com/andrew-aladev/brotli-vs-zstd
- */
+import stream,{Readable,Writable}from'stream';import eventEmitter from'events';import{promisify}from'util';import{createBrotliCompress,createGzip,createDeflate}from'zlib';import{normalizeHttpResponse}from'@middy/util';const contentEncodingStreams={br:(opts={})=>createBrotliCompress(opts),gzip:(opts={})=>createGzip(opts),deflate:(opts={})=>createDeflate(opts)};const defaults={br:undefined,gzip:undefined,deflate:undefined,overridePreferredEncoding:[]};const httpContentEncodingMiddleware=opts=>{const options={...defaults,...opts};const supportedContentEncodings=Object.keys(contentEncodingStreams);const httpContentEncodingMiddlewareAfter=async request=>{normalizeHttpResponse(request);const{event:{preferredEncoding,preferredEncodings},response}=request;if(response.isBase64Encoded||!preferredEncoding||!supportedContentEncodings.includes(preferredEncoding)){return}const bodyIsString=typeof response.body==='string';let contentEncodingStream=contentEncodingStreams[preferredEncoding](options[preferredEncoding]);let contentEncoding=preferredEncoding;for(const encoding of options.overridePreferredEncoding){if(!preferredEncodings.includes(encoding))continue;contentEncodingStream=contentEncodingStreams[encoding](options[encoding]);contentEncoding=encoding;break}if(bodyIsString){const readStream=Readable.from(response.body,{objectMode:false});const chunks=[];const writeStream=new Writable({write(chunk,encoding,callback){chunks.push(chunk);callback()}});await pipeline(readStream,contentEncodingStream,writeStream);const body=Buffer.concat(chunks).toString('base64');if(body.length<response.body.length){response.headers['Content-Encoding']=contentEncoding;response.body=body;response.isBase64Encoded=true}}else if(isReadableStream(response.body)){response.headers['Content-Encoding']=contentEncoding;response.body=response.body.pipe(contentEncodingStream);response.isBase64Encoded=true}request.response=response};const httpContentEncodingMiddlewareOnError=async request=>{if(request.response===undefined)return;return httpContentEncodingMiddlewareAfter(request)};return{after:httpContentEncodingMiddlewareAfter,onError:httpContentEncodingMiddlewareOnError}};const isReadableStream=stream1=>{return stream1 instanceof eventEmitter&&stream1.readable!==false};const polyfillPipelinePromise=()=>{if(process.version<'v15.0.0'){return promisify(stream.pipeline)}else{return stream.promises.pipeline}};const pipeline=polyfillPipelinePromise();export default httpContentEncodingMiddleware
 
-import { Readable, Writable, pipeline as pipelineCallback } from 'stream'
-// import {pipeline} from 'stream/promises'  // available in node >=15
-import { promisify } from 'util'
-
-import { createBrotliCompress, createGzip, createDeflate } from 'zlib'
-// import {ZSTDCompress as createZstdCompress} from 'simple-zstd'
-
-import { normalizeHttpResponse } from '@middy/util'
-const pipeline = promisify(pipelineCallback)
-
-const contentEncodingStreams = {
-  br: (opts = {}) => createBrotliCompress(opts),
-  // zstd: (opt = {}) => createZstdCompress(opts),
-  gzip: (opts = {}) => createGzip(opts),
-  deflate: (opts = {}) => createDeflate(opts)
-}
-
-const defaults = {
-  br: undefined,
-  // zstd: undefined,
-  gzip: undefined,
-  deflate: undefined,
-  overridePreferredEncoding: []
-}
-
-const httpContentEncodingMiddleware = (opts) => {
-  const options = { ...defaults, ...opts }
-
-  const supportedContentEncodings = Object.keys(contentEncodingStreams)
-
-  const httpContentEncodingMiddlewareAfter = async (request) => {
-    normalizeHttpResponse(request)
-    const { event: { preferredEncoding, preferredEncodings }, response } = request
-
-    // Encoding not supported OR already encoded
-    if (response.isBase64Encoded || !preferredEncoding || !supportedContentEncodings.includes(preferredEncoding)) { return }
-
-    const bodyIsString = typeof response.body === 'string'
-
-    let contentEncodingStream = contentEncodingStreams[preferredEncoding](options[preferredEncoding])
-    let contentEncoding = preferredEncoding
-    for (const encoding of options.overridePreferredEncoding) {
-      if (!preferredEncodings.includes(encoding)) continue
-      contentEncodingStream = contentEncodingStreams[encoding](options[encoding])
-      contentEncoding = encoding
-      break
-    }
-
-    if (bodyIsString) {
-      const readStream = Readable.from(response.body, { objectMode: false })
-
-      const chunks = []
-      const writeStream = new Writable({
-        write (chunk, encoding, callback) {
-          chunks.push(chunk)
-          callback()
-        }
-      })
-
-      await pipeline(
-        readStream,
-        contentEncodingStream,
-        writeStream
-      )
-
-      const body = Buffer.concat(chunks).toString('base64')
-
-      // Only apply encoding if it's smaller
-      if (body.length < response.body.length) {
-        response.headers['Content-Encoding'] = contentEncoding
-        response.body = body
-        response.isBase64Encoded = true
-      }
-    } else if (isReadableStream(response.body)) {
-      // Note: body to not cast to string to allow stream chaining
-      response.headers['Content-Encoding'] = contentEncoding
-      response.body = response.body.pipe(contentEncodingStream)
-      response.isBase64Encoded = true
-    }
-    request.response = response
-  }
-
-  const httpContentEncodingMiddlewareOnError = async (request) => {
-    if (request.response === undefined) return
-    return httpContentEncodingMiddlewareAfter(request)
-  }
-
-  return {
-    after: httpContentEncodingMiddlewareAfter,
-    onError: httpContentEncodingMiddlewareOnError
-  }
-}
-
-const isReadableStream = (stream) =>
-  typeof stream?.pipe === 'function' &&
-  stream?.readable !== false &&
-  typeof stream?._read === 'function' &&
-  typeof stream?._readableState === 'object'
-
-const polyfillPipelinePromise = async () => {
-  if (process.version < 'v15.0.0') {
-    const stream = await import('stream');
-    const util = await import('util');
-    return util.promisify(stream.pipeline);
-  } else {
-    const stream = await import('stream/promises')
-    return stream.pipeline
-  }
-}
-global.pipeline = await polyfillPipelinePromise()
-// import {pipeline} from 'stream/promises'
-
-export default httpContentEncodingMiddleware
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-content-encoding",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.7",
   "description": "Http content encoding middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -51,10 +51,10 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.3"
+    "@middy/util": "^3.0.0-alpha.7"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.3"
+    "@middy/core": "^3.0.0-alpha.7"
   },
-  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
+  "gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
 }