Add types definition for TS integration (#55)

Author: mbalabash

.gitignore

@@ -64,3 +64,6 @@ typings/
 # lock files
 
 package-lock.json
+
+# misc
+.DS_Store

index.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="node" />
+import {
+  FastifyRequest,
+  Plugin,
+  DefaultQuery,
+  DefaultParams,
+  DefaultHeaders,
+  FastifyError,
+  FastifyReply
+} from "fastify";
+import { Server, IncomingMessage, ServerResponse } from "http";
+import { Http2ServerRequest, Http2ServerResponse } from "http2";
+
+type HttpRequest = IncomingMessage | Http2ServerRequest;
+type HttpResponse = ServerResponse | Http2ServerResponse;
+
+declare const fastifyHttpProxy: Plugin<
+  Server,
+  IncomingMessage,
+  ServerResponse,
+  {
+    upstream: string;
+    prefix?: string;
+    rewritePrefix?: string;
+    http2?: boolean;
+    preHandler?: (
+      request: FastifyRequest<
+        HttpRequest,
+        DefaultQuery,
+        DefaultParams,
+        DefaultHeaders,
+        any
+      >,
+      reply: FastifyReply<HttpResponse>,
+      next: (err?: FastifyError | undefined) => void
+    ) => void;
+    beforeHandler?: (
+      request: FastifyRequest<
+        HttpRequest,
+        DefaultQuery,
+        DefaultParams,
+        DefaultHeaders,
+        any
+      >,
+      reply: FastifyReply<HttpResponse>,
+      next: (err?: FastifyError | undefined) => void
+    ) => void;
+    config?: Object;
+    replyOptions?: Object;
+  }
+>;
+
+export = fastifyHttpProxy;

package.json

@@ -4,7 +4,9 @@
   "description": "proxy http requests, for Fastify",
   "main": "index.js",
   "scripts": {
-    "test": "standard | snazzy && tap test.js"
+    "test": "standard | snazzy && tap test/test.js",
+    "lint:typescript": "standard --fix --parser @typescript-eslint/parser --plugin typescript test/types/*.ts",
+    "typescript": "tsc --project ./test/types/tsconfig.json"
   },
   "repository": {
     "type": "git",
@@ -22,6 +24,9 @@
   },
   "homepage": "https://github.com/fastify/fastify-http-proxy#readme",
   "devDependencies": {
+    "@types/node": "^11.13.9",
+    "@typescript-eslint/parser": "^1.7.0",
+    "eslint-plugin-typescript": "^0.14.0",
     "express": "^4.16.4",
     "express-http-proxy": "^1.5.0",
     "fastify": "^2.0.0",
@@ -33,7 +38,8 @@
     "simple-get": "^3.0.3",
     "snazzy": "^8.0.0",
     "standard": "^12.0.1",
-    "tap": "^12.5.2"
+    "tap": "^12.5.2",
+    "typescript": "^3.4.5"
   },
   "peerDependencies": {
     "fastify": "2.x"

test.js renamed to test/test.js

@@ -2,7 +2,7 @@
 
 const { tearDown, test } = require('tap')
 const Fastify = require('fastify')
-const proxy = require('.')
+const proxy = require('../')
 const got = require('got')
 const { Unauthorized } = require('http-errors')
 const Transform = require('stream').Transform

test/types/index.ts

@@ -0,0 +1,51 @@
+import * as fastify from "fastify";
+import * as fastifyHttpProxy from "../..";
+
+/* eslint-disable */
+import { IncomingMessage, ServerResponse } from "http";
+import { Http2ServerRequest, Http2ServerResponse } from "http2";
+
+type HttpRequest = IncomingMessage | Http2ServerRequest;
+type HttpResponse = ServerResponse | Http2ServerResponse;
+/* eslint-enable */
+
+const app = fastify();
+
+app.register(fastifyHttpProxy, {
+  upstream: "http://origin.asd"
+});
+
+app.register(fastifyHttpProxy, {
+  upstream: "http://origin.asd",
+  prefix: "/auth",
+  rewritePrefix: "/u",
+  http2: false,
+  config: { key: 1 },
+  replyOptions: { opt: "a" },
+  preHandler: (
+    request: fastify.FastifyRequest<
+      HttpRequest,
+      fastify.DefaultQuery,
+      fastify.DefaultParams,
+      fastify.DefaultHeaders,
+      any
+    >,
+    reply: fastify.FastifyReply<HttpResponse>
+  ) => {
+    console.log(request.query);
+    console.log(reply.context.config);
+  },
+  beforeHandler: (
+    request: fastify.FastifyRequest<
+      HttpRequest,
+      fastify.DefaultQuery,
+      fastify.DefaultParams,
+      fastify.DefaultHeaders,
+      any
+    >,
+    reply: fastify.FastifyReply<HttpResponse>
+  ) => {
+    console.log(request.query);
+    console.log(reply.context.config);
+  }
+});

test/types/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true
+  },
+  "files": ["./index.ts"]
+}