Support for TypeScript by providing typings files

.github/workflows/release.yml

@@ -10,29 +10,26 @@ jobs:
     name: release
     runs-on: ubuntu-latest
     steps:
-    -
-      name: Checkout repository
-      uses: actions/checkout@master
-    -
-      name: Set up Node.js
-      uses: actions/setup-node@master
-      with:
-        node-version: 14.0.0
-    -
-      name: Create .npmrc
-      run: |
-        echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
-      env:
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    -
-      name: Install dependencies
-      run: |
-        npm install
-    -
-      name: Build as Commonjs for Node.js v12
-      run: |
-        ./node_modules/.bin/lerna exec --bail --concurrency 2 -- babel --root-mode upward index.js --out-file index.js
-    -
-      name: Release
-      run: |
-        npm run lerna:publish
+      - name: Checkout repository
+        uses: actions/checkout@master
+      - name: Set up Node.js
+        uses: actions/setup-node@2
+        with:
+          node-version: 14.0.0
+      - name: Use npm 7.5
+        run: |
+          npm install -g npm@7.5
+      - name: Create .npmrc
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Install dependencies
+        run: |
+          npm install
+      - name: Build as Commonjs for Node.js v12
+        run: |
+          ./node_modules/.bin/lerna exec --bail --concurrency 2 -- babel --root-mode upward index.js --out-file index.js
+      - name: Release
+        run: |
+          npm run lerna:publish

.github/workflows/tests.yml

@@ -1,19 +1,13 @@
 name: Tests
 
 on:
-  pull_request:
-    branches:
-      - "**"
-    tags-ignore:
-      - '*.*.*'
   push:
     branches:
       - "**"
     tags-ignore:
-      - '*.*.*'
+      - "*.*.*"
 
 jobs:
-
   tests:
     runs-on: ubuntu-latest
 
@@ -22,37 +16,32 @@ jobs:
         node-version: [12.x, 14.x]
 
     steps:
-    -
-      name: Checkout repository
-      uses: actions/checkout@v2
-    -
-      name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    -
-      name: Install dependencies
-      run: |
-        npm install
-      env:
-        CI: true
-    -
-      name: Linting
-      run: npm run test:lint:ci
-      env:
-        CI: true
-    -
-      name: Build as Commonjs for Node.js v12
-      run: |
-        ./node_modules/.bin/lerna exec --bail --concurrency 2 -- babel --root-mode upward index.js --out-file index.js
-    -
-      name: Unit tests
-      run: npm run test:packages:unit
-      env:
-        CI: true
-# Disabled until TS support has been updated.
-#    -
-#      name: Check typings
-#      run: npm run test:packages:typings
-#      env:
-#        CI: true
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Use npm 7.5
+        run: |
+          npm install -g npm@7.5
+      - name: Install dependencies
+        run: |
+          npm install
+        env:
+          CI: true
+      - name: Linting
+        run: npm run test:lint:ci
+        env:
+          CI: true
+      - name: Build as Commonjs for Node.js v12
+        run: |
+          ./node_modules/.bin/lerna exec --bail --concurrency 2 -- babel --root-mode upward index.js --out-file index.js
+      - name: Unit tests
+        run: npm run test:packages:unit
+        env:
+          CI: true
+      - name: Check typings
+        run: npm run test:packages:typings
+        env:
+          CI: true

docs/README.md

@@ -504,8 +504,35 @@ module.exports = (opts = {}) => {
 
 Check the [code for existing middlewares](/packages) to see more examples on how to write a middleware.
 
+
 ## TypeScript
-See [#589 TypeScript Support](https://github.com/middyjs/middy/issues/589)
+
+Middy can be used with TypeScript with typings built in in every official package.
+
+Here's an example of how you might be using Middy with TypeScript for a Lambda receiving events from API Gateway:
+
+```typescript
+import middy from '@middy/core'
+import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda'
+
+async function baseHandler (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> {
+  // the returned response will be checked against the type `APIGatewayProxyResult`
+  return {
+    statusCode: 200,
+    body: `Hello from ${event.path}`
+  }
+}
+
+let handler = middy(baseHandler)
+handler
+  .use(someMiddleware)
+  .use(someOtherMiddleware)
+
+export default handler
+```
+
+**Note**: the Middy core team does not use TypeScript often and we can't certainly claim that we are TypeScript experts. We tried our best to come up
+with type definitions that should give TypeScript users a good experience. There is certainly room for improvement, so we would be more than happy to receive contributions 😊
 
 
 ## Common Patterns and Best Practice