add sendFile and append, improve send

Author: v1rtl

app.ts

@@ -7,7 +7,7 @@ import { Request } from './request.ts'
 import { Response } from './response.ts'
 import { getURLParams, getPathname } from './parseUrl.ts'
 import { extendMiddleware } from './extend.ts'
-import { serve, Server } from 'https://deno.land/std@0.87.0/http/server.ts'
+import { serve, Server } from 'https://deno.land/std/http/server.ts'
 
 const lead = (x: string) => (x.charCodeAt(0) === 47 ? x : '/' + x)
 

egg.json

@@ -4,7 +4,7 @@
   "entry": "./app.ts",
   "description": "0-legacy, tiny & fast web framework as a replacement of Express",
   "homepage": "https://github.com/talentlessguy/tinyhttp-deno",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "ignore": [
     "./example/mod.ts"
   ],

example/mod.ts

@@ -1,17 +1,13 @@
 import { App } from '../app.ts'
 
-const app = new App()
-
-app.use('/', (req, res, next) => {
-  console.log(`${req.method} ${req.url}`)
+const __dirname = new URL('.', import.meta.url).pathname
 
-  res.set('Test-Header', 'Value')
+const app = new App()
 
-  next()
-})
+app.get('/', (_, res) => {
+  const path = __dirname + 'mod.ts'
 
-app.get('/:name/', (req, res) => {
-  res.send(`Hello on ${req.url} from Deno and tinyhttp! 🦕`)
+  res.sendFile(path)
 })
 
 app.listen(3000, () => console.log(`Started on :3000`))

extend.ts

@@ -2,12 +2,19 @@ import { NextFunction } from 'https://esm.sh/@tinyhttp/router'
 import { App } from './app.ts'
 import { Request } from './request.ts'
 import { getRequestHeader, getFreshOrStale } from './extensions/req/headers.ts'
-import { send } from './extensions/res/send.ts'
-import { json } from './extensions/res/json.ts'
-import { end } from './extensions/res/end.ts'
-import { sendStatus } from './extensions/res/sendStatus.ts'
+import {
+  send,
+  json,
+  sendStatus,
+  setHeader,
+  setLocationHeader,
+  end,
+  sendFile,
+  getResponseHeader,
+  append
+} from './extensions/res/mod.ts'
+
 import { Response } from './response.ts'
-import { setHeader, setLocationHeader } from './extensions/res/headers.ts'
 
 export const extendMiddleware = <
   RenderOptions = unknown,
@@ -32,6 +39,7 @@ export const extendMiddleware = <
 
   res.end = end(req, res)
   res.send = send<Req, Res>(req, res)
+  res.sendFile = sendFile<Res>(res)
   res.sendStatus = sendStatus(req, res)
   res.json = json<Res>(res)
 
@@ -40,5 +48,9 @@ export const extendMiddleware = <
 
   res.location = setLocationHeader<Req, Res>(req, res)
 
+  res.get = getResponseHeader<Res>(res)
+
+  res.append = append<Res>(res)
+
   next?.()
 }

extensions/res/append.ts

@@ -0,0 +1,20 @@
+import { Response as Res } from '../../response.ts'
+import { setHeader, getResponseHeader } from './headers.ts'
+
+export const append = <Response extends Res = Res>(res: Response) => (
+  field: string,
+  value: string | number | string[]
+): Response => {
+  const prevVal = getResponseHeader<Res>(res)(field)
+  let newVal = value
+
+  if (prevVal && typeof newVal !== 'number' && typeof prevVal !== 'number') {
+    newVal = Array.isArray(prevVal)
+      ? prevVal.concat(newVal)
+      : Array.isArray(newVal)
+      ? [prevVal].concat(newVal)
+      : [prevVal, newVal]
+  }
+  setHeader(res)(field, newVal)
+  return res
+}

extensions/res/headers.ts

@@ -35,6 +35,12 @@ export const setHeader = <Response extends Res = Res>(res: Response) => (
   return res
 }
 
+export const getResponseHeader = <Response extends Res = Res>(res: Response) => (
+  field: string
+): string | number | string[] | null => {
+  return res.headers.get(field)
+}
+
 export const setLocationHeader = <Request extends Req = Req, Response extends Res = Res>(
   req: Request,
   res: Response

extensions/res/mod.ts

@@ -0,0 +1,7 @@
+export * from './end.ts'
+export * from './json.ts'
+export * from './send.ts'
+export * from './sendStatus.ts'
+export * from './headers.ts'
+export * from './sendFile.ts'
+export * from './append.ts'

extensions/res/send.ts

@@ -5,7 +5,7 @@ import { createETag, setCharset } from './utils.ts'
 import { end } from './end.ts'
 
 export const send = <Request extends Req = Req, Response extends Res = Res>(req: Request, res: Response) => (
-  body: unknown
+  body: any
 ) => {
   let bodyToSend = body
 
@@ -38,22 +38,27 @@ export const send = <Request extends Req = Req, Response extends Res = Res>(req:
   }
 
   if (req.method === 'HEAD') {
-    end(req, res)('')
+    end(req, res)(body)
     return res
   }
 
   if (typeof body === 'object') {
     if (body == null) {
       end(req, res)('')
       return res
-    } /* else if (Buffer.isBuffer(body)) {
-      if (!res.headers.get('Content-Type')) res.headers.set('content-type', 'application/octet-stream')
-    } */ else
+    } else if (typeof body?.read !== 'undefined') {
+      console.log('here')
+
+      if (!res.headers.get('Content-Type')) req.headers.set('content-type', 'application/octet-stream')
+
+      end(req, res)(body)
+    } else {
       json(res)(bodyToSend)
+    }
   } else {
     if (typeof bodyToSend !== 'string') bodyToSend = (bodyToSend as string).toString()
 
-    end(req, res)(bodyToSend)
+    end(req, res)(body)
   }
 
   return res

extensions/res/sendFile.ts

@@ -0,0 +1,43 @@
+import { Response as Res } from '../../response.ts'
+import { isAbsolute, join } from 'https://deno.land/std/path/mod.ts'
+
+export type SendFileOptions = Partial<{
+  root: string
+  headers: Record<string, any>
+}> &
+  Deno.OpenOptions
+
+/**
+ * Sends a file by piping a stream to response.
+ *
+ * It also checks for extension to set a proper `Content-Type` header.
+ *
+ * Path argument must be absolute. To use a relative path, specify the `root` option first.
+ *
+ * @param res Response
+ */
+export const sendFile = <Response extends Res = Res>(res: Response) => (
+  path: string,
+  opts: SendFileOptions = {},
+  cb?: (err?: unknown) => void
+) => {
+  const { root, headers, ...options } = opts
+
+  if (!path || typeof path !== 'string') throw new TypeError('path must be a string to res.sendFile')
+
+  if (headers) for (const [k, v] of Object.entries(headers)) res.setHeader(k, v)
+
+  if (!isAbsolute(path) && !root) throw new TypeError('path must be absolute')
+
+  const filePath = root ? join(root, path) : path
+
+  res.set('Content-Type', 'text/html; charset=UTF-8')
+  res.set('Content-Security-Policy', "default-src 'none'")
+  res.set('X-Content-Type-Options', 'nosniff')
+
+  const file = Deno.openSync(filePath, { read: true, ...options })
+
+  res.send(file)
+
+  return res
+}

response.ts

@@ -1,8 +1,9 @@
 import { Response as ServerResponse } from 'https://deno.land/std@0.87.0/http/server.ts'
-
+import type { SendFileOptions } from './extensions/res/sendFile.ts'
 export interface Response extends ServerResponse {
   headers: Headers
   send(body: unknown): Response
+  sendFile(path: string, options?: SendFileOptions, cb?: (err?: any) => void): Response
   end(body: unknown): Response
   json(body: unknown): Response
   sendStatus(status: number): Response
@@ -12,4 +13,7 @@ export interface Response extends ServerResponse {
   ): Response
   set(field: string | Record<string, string | number | string[]>, val?: string | number | readonly string[]): Response
   location(url: string): Response
+  status: number
+  get(field: string): string | number | string[] | null
+  append(field: string, value: any): Response
 }