feat: add TypeScript declarations (#26)

* feat: add TypeScript declarations

* feat: add HandlerResponse export

Author: eduardoboucas

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@netlify/functions",
   "main": "./src/main.js",
+  "types": "./src/main.d.ts",
   "version": "0.3.1",
   "description": "JavaScript utilities for Netlify Functions",
   "files": [

src/function/context.ts

@@ -0,0 +1,24 @@
+// From https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html.
+export interface Context {
+  callbackWaitsForEmptyEventLoop: boolean
+  functionName: string
+  functionVersion: string
+  invokedFunctionArn: string
+  memoryLimitInMB: string
+  awsRequestId: string
+  logGroupName: string
+  logStreamName: string
+  identity?: { [key: string]: any }
+  clientContext?: { [key: string]: any }
+
+  getRemainingTimeInMillis(): number
+
+  /** @deprecated Use handler callback or promise result */
+  done(error?: Error, result?: any): void
+  /** @deprecated Use handler callback with first argument or reject a promise result */
+  fail(error: Error | string): void
+  /** @deprecated Use handler callback with second argument or resolve a promise result */
+  succeed(messageOrObject: any): void
+  /** @deprecated Use handler callback or promise result */
+  succeed(message: string, object: any): void
+}

src/function/event.ts

@@ -0,0 +1,32 @@
+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
+}
+
+interface EventMultiValueHeaders {
+  [name: string]: string[] | undefined
+}
+
+interface EventPathParameters {
+  [name: string]: string | undefined
+}
+
+interface EventQueryStringParameters {
+  [name: string]: string | undefined
+}
+
+interface EventMultiValueQueryStringParameters {
+  [name: string]: string[] | undefined
+}

src/function/handler.ts

@@ -0,0 +1,11 @@
+import type { Context } from './context'
+import type { Event } from './event'
+import type { Response } from './response'
+
+export interface HandlerCallback {
+  (error: any, response: Response): void
+}
+
+export interface Handler {
+  (event: Event, context: Context, callback: HandlerCallback): void | Response | Promise<Response>
+}

src/function/index.ts

@@ -0,0 +1,6 @@
+import type { Context } from './context'
+import type { Event } from './event'
+import type { Handler, HandlerCallback } from './handler'
+import { Response } from './response'
+
+export type { Context as HandlerContext, Event as HandlerEvent, Handler, HandlerCallback, Response as HandlerResponse }

src/function/response.ts

@@ -0,0 +1,11 @@
+export interface Response {
+  statusCode: number
+  headers?: {
+    [header: string]: boolean | number | string
+  }
+  multiValueHeaders?: {
+    [header: string]: Array<boolean | number | string>
+  }
+  body: string
+  isBase64Encoded?: boolean
+}

src/main.d.ts

@@ -0,0 +1 @@
+export * from './function'