lambda-compression 0.1.1

package/README.md

@@ -0,0 +1,39 @@
+# Lambda HTTP Payload Compression
+
+This library provides a wrapper that can be used to compress content in responses when using the [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html).
+
+The library supports compression with `br`, `gzip` and `deflate`. It will return responses with compressed data matching the supported `accept-encoding` header provided by the client.
+
+## Usage
+
+This library provides only one method `compress` that accepts two parameters with the respective types of `APIGatewayProxyEventV2` and `APIGatewayProxyStructuredResultV2` (for more details on these types, see [TypeScript Types for AWS Lambda](https://maxrohde.com/2022/01/02/typescript-types-for-aws-lambda/)).
+
+Simply call the `compress` method as follows before returning the result of your Lambda.
+
+```typescript
+import { compress } from 'lambda-compression';
+
+import {
+  Handler,
+  APIGatewayProxyEventV2,
+  APIGatewayProxyResultV2,
+} from 'aws-lambda';
+
+type ProxyHandler = Handler<APIGatewayProxyEventV2, APIGatewayProxyResultV2>;
+
+export const handler: ProxyHandler = async (event, context) => {
+  return compress(event, {
+    statusCode: 201,
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: '{"data":"hello"}',
+  });
+};
+```
+
+## Also See
+
+- [compression.js in lambda-api project](https://github.com/jeremydaly/lambda-api/blob/main/lib/compression.js)
+- [Serverless Content Encoding for Serverless](https://www.npmjs.com/package/serverless-content-encoding)
+- [serverless-content-encoding](https://github.com/dong-dohai/serverless-content-encoding) - no longer maintained

package/dist/src/lambdaCompression.d.ts

@@ -0,0 +1,3 @@
+import type { APIGatewayProxyEventV2, APIGatewayProxyStructuredResultV2 } from 'aws-lambda';
+export declare const compress: (event: APIGatewayProxyEventV2, result: APIGatewayProxyStructuredResultV2) => APIGatewayProxyStructuredResultV2;
+//# sourceMappingURL=lambdaCompression.d.ts.map

package/dist/src/lambdaCompression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lambdaCompression.d.ts","sourceRoot":"","sources":["../../src/lambdaCompression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,iCAAiC,EAClC,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,QAAQ,UACZ,sBAAsB,UACrB,iCAAiC,KACxC,iCAyCF,CAAC"}

package/dist/src/lambdaCompression.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compress = void 0;
+const zlib_1 = __importDefault(require("zlib"));
+const compress = (event, result) => {
+    // when there is no body, there is nothing to compress
+    if (!result.body) {
+        return result;
+    }
+    const acceptEncodingHeader = event.headers['accept-encoding'];
+    // determine accepted encodings
+    const encodings = new Set();
+    if (acceptEncodingHeader) {
+        acceptEncodingHeader.split(',').forEach((encoding) => {
+            encodings.add(encoding.toLowerCase().trim());
+        });
+    }
+    if (!result.headers) {
+        result.headers = {};
+    }
+    if (encodings.has('br')) {
+        result.headers['content-encoding'] = 'br';
+        result.isBase64Encoded = true;
+        result.body = zlib_1.default.brotliCompressSync(result.body).toString('base64');
+        return result;
+    }
+    if (encodings.has('gzip')) {
+        result.headers['content-encoding'] = 'gzip';
+        result.isBase64Encoded = true;
+        result.body = zlib_1.default.gzipSync(result.body).toString('base64');
+        return result;
+    }
+    if (encodings.has('deflate')) {
+        result.headers['content-encoding'] = 'deflate ';
+        result.isBase64Encoded = true;
+        result.body = zlib_1.default.deflateSync(result.body).toString('base64');
+        return result;
+    }
+    throw new Error(`Encodings not supported ${encodings}`);
+};
+exports.compress = compress;
+//# sourceMappingURL=lambdaCompression.js.map

package/dist/src/lambdaCompression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lambdaCompression.js","sourceRoot":"","sources":["../../src/lambdaCompression.ts"],"names":[],"mappings":";;;;;;AAKA,gDAAwB;AAEjB,MAAM,QAAQ,GAAG,CACtB,KAA6B,EAC7B,MAAyC,EACN,EAAE;IACrC,sDAAsD;IACtD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;QAChB,OAAO,MAAM,CAAC;KACf;IAED,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE9D,+BAA+B;IAC/B,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,IAAI,oBAAoB,EAAE;QACxB,oBAAoB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnD,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IACD,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACvB,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;QAC1C,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,cAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC;KACf;IAED,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAC;QAC5C,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,cAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC;KACf;IAED,IAAI,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAC5B,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC;QAChD,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,cAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;KACf;IAED,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AA5CW,QAAA,QAAQ,YA4CnB"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "lambda-compression",
+  "version": "0.1.1",
+  "description": "HTTP payload compression for AWS Lambda functions",
+  "keywords": [
+    "lambda",
+    "api-gateway",
+    "node",
+    "javascript",
+    "aws"
+  ],
+  "homepage": "https://github.com/goldstack/goldstack/tree/master/workspaces/utils/packages/lambda-compression#readme",
+  "bugs": {
+    "url": "https://github.com/goldstack/goldstack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goldstack/goldstack.git"
+  },
+  "license": "MIT",
+  "author": "Max Rohde",
+  "sideEffects": false,
+  "main": "dist/src/lambdaCompression.js",
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "build:watch": "yarn clean && yarn compile-watch",
+    "clean": "rimraf ./dist",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json --watch",
+    "compile-watch:light": "nodemon --watch ./src/ -e '*' --exec 'yarn compile'",
+    "coverage": "jest --collect-coverage --passWithNoTests --config=./jest.config.js --runInBand",
+    "prepublishOnly": "yarn run build",
+    "publish": "utils-git changed --exec \"yarn npm publish $@\"",
+    "test-ci": "jest --passWithNoTests --config=./jest.config.js --runInBand",
+    "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\""
+  },
+  "devDependencies": {
+    "@goldstack/utils-git": "0.1.36",
+    "@types/aws-lambda": "^8.10.88",
+    "@types/jest": "^27.5.1",
+    "@types/node": "^17.0.33",
+    "jest": "^28.1.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.7.4"
+  },
+  "publishConfig": {
+    "main": "dist/src/lambdaCompression.js"
+  }
+}