Adding TS types (#32)

* Adding TS types

Co-authored-by: RyanWright <[email protected]>

Author: jkyberneees

common.d.ts

@@ -0,0 +1,55 @@
+import { type Server as HTTPServer, IncomingMessage, ServerResponse } from "http";
+import { type Server as HTTPSServer } from "https";
+import { Pattern, Methods } from "trouter";
+
+import {
+  Http2SecureServer,
+  Http2ServerRequest,
+  Http2ServerResponse
+} from 'http2'
+
+export enum Protocol {
+  HTTP = 'http',
+  HTTPS = 'https',
+  HTTP2 = 'http2'
+}
+
+export type Server<P extends Protocol> = P extends Protocol.HTTP2 ? Http2SecureServer : P extends Protocol.HTTPS ? HTTPSServer : HTTPServer
+
+export type StepFunction = (error?: unknown) => void
+
+export type Request<P extends Protocol> = P extends Protocol.HTTP2
+  ? Http2ServerRequest
+  : IncomingMessage
+
+export type Response<P extends Protocol> = P extends Protocol.HTTP2
+  ? Http2ServerResponse : ServerResponse
+
+export type RequestHandler<P extends Protocol> = (
+  req: Request<P>,
+  res: Response<P>,
+  next: (error?: unknown) => void
+) => void | Promise<unknown>
+
+export interface IRouter<P extends Protocol> {
+  lookup: RequestHandler<P>
+
+  use(...handlers: RequestHandler<P>[]): this;
+  use(router: IRouter<P>): this;
+  use(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+  use(prefix: Pattern, router: IRouter<P>): this;
+
+	all(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	get(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	head(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	patch(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	options(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	connect(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	delete(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	trace(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	post(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+	put(pattern: Pattern, ...handlers: RequestHandler<P>[]): this;
+
+  on(method: Methods, pattern: Pattern, ...middlewares: RequestHandler<P>[]): this;
+}
+

demos/basic.ts

@@ -0,0 +1,19 @@
+import zero from '../index'
+import { createServer } from 'node:http'
+import createRouter from '../lib/router/sequential'
+import { Protocol } from '../common'
+
+const { router, server } = zero<Protocol.HTTP>({
+  router: createRouter<Protocol.HTTP>(),
+  server: createServer()
+})
+
+router.use((req, res, next) => {
+  return next()
+})
+
+router.get('/hi', (req, res) => {
+  res.end(`Hello World from TS!`)
+})
+
+server.listen(3000)

index.d.ts

@@ -0,0 +1,13 @@
+import { Protocol, IRouter, Server } from './common'
+
+interface IBuildServerAndRouterConfig<P extends Protocol, S extends Server<P>, R extends IRouter<P>> {
+  router?: R;
+  server?: S;
+  prioRequestsProcessing?: boolean;
+}
+
+export default function zero<P extends Protocol>(config?: IBuildServerAndRouterConfig<P, Server<P>, IRouter<P>>): {
+  server: Server<P>,
+  router: IRouter<P>
+};
+

lib/router/sequential.d.ts

@@ -0,0 +1,3 @@
+import { Protocol, IRouter, RequestHandler } from './../../common'
+
+export default function createSequentialRouter<P extends Protocol>(config?: object): IRouter<P>

package.json

@@ -28,6 +28,7 @@
   },
   "homepage": "https://github.com/BackendStack21/0http#readme",
   "devDependencies": {
+    "@types/node": "^18.14.4",
     "body-parser": "^1.20.1",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
@@ -46,5 +47,6 @@
     "lru-cache": "^7.14.1",
     "regexparam": "^2.0.1",
     "trouter": "^3.2.0"
-  }
-}
+  },
+  "types": "./index.d.ts"
+}