feat: migrate to TypeScript (#150)

* feat: setup typescript

* chore: make typescript files out of declaration files

* chore: please linter by ordering right

* chore: remove unused type

* chore: migrate builder to typescript

* chore: migrate consts to typescript

* chore: migrate main to typescript

* chore: extend eslint to typescript

* chore: extend prettier to typescript files

* chore: fix tests

* Update package.json

Co-authored-by: Eduardo Bouças <[email protected]>

* chore: add missing npm-run-all dependency

Co-authored-by: Netlify Team Account 1 <[email protected]>
Co-authored-by: Eduardo Bouças <[email protected]>

Author: netlify-team-account-1

.gitignore

@@ -10,3 +10,4 @@ node_modules
 /coverage
 /build
 .vscode
+dist

package-lock.json

@@ -1,15 +1,16 @@
 {
   "name": "@netlify/functions",
-  "main": "./src/main.js",
-  "types": "./src/main.d.ts",
+  "main": "./dist/main.js",
+  "types": "./dist/main.d.ts",
   "version": "0.7.2",
   "description": "JavaScript utilities for Netlify Functions",
   "files": [
-    "src/**/*.js",
-    "src/**/*.ts",
-    "!src/**/*.test.js"
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
   ],
   "scripts": {
+    "build": "tsc",
+    "prepack": "npm run build",
     "prepublishOnly": "npm ci && npm test",
     "test": "run-s format test:dev",
     "format": "run-s format:check-fix:*",
@@ -20,14 +21,14 @@
     "format:check-fix:prettier": "run-e format:check:prettier format:fix:prettier",
     "format:check:prettier": "cross-env-shell prettier --check $npm_package_config_prettier",
     "format:fix:prettier": "cross-env-shell prettier --write $npm_package_config_prettier",
-    "test:dev": "run-s test:dev:*",
-    "test:ci": "run-s test:ci:*",
+    "test:dev": "run-s build test:dev:*",
+    "test:ci": "run-s build test:ci:*",
     "test:dev:ava": "ava",
     "test:ci:ava": "nyc -r lcovonly -r text -r json ava"
   },
   "config": {
-    "eslint": "--ignore-pattern README.md --ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
+    "eslint": "--ignore-pattern README.md --ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{ts,js,md,html}\" \"*.{ts,js,md,html}\" \".*.{ts,js,md,html}\"",
+    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{ts,js,md,yml,json,html}\" \"*.{ts,js,yml,json,html}\" \".*.{ts,js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
   },
   "ava": {
     "files": [
@@ -60,7 +61,9 @@
     "@netlify/eslint-config-node": "^3.3.4",
     "ava": "^2.4.0",
     "husky": "^4.3.8",
-    "nyc": "^15.0.0"
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.0.0",
+    "typescript": "^4.4.4"
   },
   "engines": {
     "node": ">=8.3.0"

package.json

@@ -1,3 +1,6 @@
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 // From https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html.
 export interface Context {
   callbackWaitsForEmptyEventLoop: boolean

src/function/context.d.ts renamed to src/function/context.ts

@@ -1,16 +1,3 @@
-export interface Event {
-  rawUrl: string
-  rawQuery: string
-  path: string
-  httpMethod: string
-  headers: EventHeaders
-  multiValueHeaders: EventMultiValueHeaders
-  queryStringParameters: EventQueryStringParameters | null
-  multiValueQueryStringParameters: EventMultiValueQueryStringParameters | null
-  body: string | null
-  isBase64Encoded: boolean
-}
-
 interface EventHeaders {
   [name: string]: string | undefined
 }
@@ -19,14 +6,23 @@ interface EventMultiValueHeaders {
   [name: string]: string[] | undefined
 }
 
-interface EventPathParameters {
-  [name: string]: string | undefined
-}
-
 interface EventQueryStringParameters {
   [name: string]: string | undefined
 }
 
 interface EventMultiValueQueryStringParameters {
   [name: string]: string[] | undefined
 }
+
+export interface Event {
+  rawUrl: string
+  rawQuery: string
+  path: string
+  httpMethod: string
+  headers: EventHeaders
+  multiValueHeaders: EventMultiValueHeaders
+  queryStringParameters: EventQueryStringParameters | null
+  multiValueQueryStringParameters: EventMultiValueQueryStringParameters | null
+  body: string | null
+  isBase64Encoded: boolean
+}

src/function/event.d.ts renamed to src/function/event.ts

@@ -3,6 +3,7 @@ import type { Event } from './event'
 import type { Response } from './response'
 
 export interface HandlerCallback {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   (error: any, response: Response): void
 }