Merge pull request #18 from kingsmendv/middy-as-peer-dep

Middy as peer dep

Author: kernwig

docs/source/lambda_utils.rst

@@ -39,17 +39,23 @@ Not all Middy middlewares are in this implementation, only common ones that are
 APIs. You may extend LambdaUtils's ``wrapApiHandler()`` function in your projects,
 or use it as an example to write your own, to add more middleware!
 
+**WARNING**: Middy has, historically, introduced some `breaking changes <https://github.com/onicagroup/sailplane/issues/16>`_
+in previous minor version bumps. LambdaUtils has been built and tested with Middy
+0.29.0, and should continue to work with future versions, but bumping your
+Middy version beyond 0.29.0 may produce some weird errors.
 
-``LambdaUtils`` depends on one other utility to work:
+
+``LambdaUtils`` depends on two other utilities to work:
 
 - :doc:`logger`
+- `Middy <https://middy.js.org>`_
 
 Install
 ^^^^^^^
 
 .. code-block:: shell
 
-    npm install @sailplane/lambda-utils @sailplane/logger
+    npm install @sailplane/lambda-utils @sailplane/logger middy
 
 Examples
 ^^^^^^^^

lambda-utils/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailplane/lambda-utils",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Use middleware to remove redundancy in AWS Lambda handlers.",
   "keywords": [
     "aws",
@@ -31,18 +31,17 @@
     "@types/node": "^8.10.10",
     "aws-sdk": "^2.358.0",
     "http-errors": "^1.7.1",
+    "middy": "0.29.x",
     "jest": "^23.6.0",
     "ts-jest": "^23.10.2",
     "ts-loader": "^2.3.7",
     "ts-node": "^5.0.1",
     "typescript": "^2.9.2"
   },
-  "dependencies": {
-    "middy": "^0.29.0"
-  },
   "peerDependencies": {
     "@sailplane/logger": "2.x.x",
-    "aws-sdk": "2.x.x"
+    "aws-sdk": "2.x.x",
+    "middy": "0.x.x"
   },
   "main": "dist/lambda-utils.js",
   "files": [