allow passing generics onto Hono (#262)

Author: deckchairlabs

lib/deps.ts

@@ -21,7 +21,7 @@ export { StringReader } from "https://deno.land/std@0.176.0/io/string_reader.ts"
 
 export { wait } from "https://deno.land/x/wait@0.1.12/mod.ts";
 
-export { type Context, Hono } from "https://deno.land/x/hono@v3.2.7/mod.ts";
+export { Hono } from "https://deno.land/x/hono@v3.2.7/mod.ts";
 export { getFilePath } from "https://deno.land/x/hono@v3.2.7/utils/filepath.ts";
 export { getMimeType } from "https://deno.land/x/hono@v3.2.7/utils/mime.ts";
 export { logger } from "https://deno.land/x/hono@v3.2.7/middleware/logger/index.ts";

lib/server.ts

@@ -3,10 +3,9 @@ import { assert, dotenv, Hono, resolve, toFileUrl } from "./deps.ts";
 import { ensureMinDenoVersion } from "./dev/ensureMinDenoVersion.ts";
 import { log } from "./logger.ts";
 import { serveStatic } from "./middleware/serveStatic.ts";
-import { CreateServerOptions, Mode } from "./types.ts";
+import { CreateServerOptions, Env, Mode } from "./types.ts";
 import { UltraServer } from "./ultra.ts";
 import { resolveImportMapPath } from "./utils/import-map.ts";
-import type { Context, Next } from "./types.ts";
 
 /**
  * Dotenv
@@ -27,9 +26,15 @@ const defaultOptions = {
     "https://ga.jspm.io/npm:es-module-shims@1.6.2/dist/es-module-shims.js",
 };
 
-export async function createServer(
+export async function createServer<
+  // deno-lint-ignore no-explicit-any
+  E extends Env = any,
+  // deno-lint-ignore ban-types
+  S = {},
+  BasePath extends string = "/",
+>(
   options: CreateServerOptions = {},
-): Promise<UltraServer> {
+) {
   const resolvedOptions = {
     ...defaultOptions,
     ...options,
@@ -47,7 +52,7 @@ export async function createServer(
   const root = Deno.cwd();
   const assetManifestPath = toFileUrl(resolve(root, "asset-manifest.json"));
 
-  const server = new UltraServer(root, {
+  const server = new UltraServer<E, S, BasePath>(root, {
     mode,
     entrypoint: browserEntrypoint,
     importMapPath: options.importMapPath
@@ -69,16 +74,13 @@ export async function createServer(
 
   // Serve anything else static at "/"
   // deno-fmt-ignore
-  server.get("/ultra/*", (
-    context: Context,
-    next: Next,
-  ): Promise<Response | undefined> => {
+  server.get("/ultra/*", (context, next) => {
     const path = new URL(context.req.url).pathname.slice(`/ultra`.length)
     return serveStatic({
       root: server.ultraDir,
       path: path,
       cache: mode !== "development",
-    })(context,next);
+    })(context, next);
   });
 
   // Serve anything else static at "/"
@@ -102,8 +104,14 @@ export async function createServer(
   return server;
 }
 
-export function createRouter() {
-  return new Hono();
+export function createRouter<
+  // deno-lint-ignore no-explicit-any
+  E extends Env = any,
+  // deno-lint-ignore ban-types
+  S = {},
+  BasePath extends string = "/",
+>() {
+  return new Hono<E, S, BasePath>();
 }
 
 export function assertServerOptions(

lib/types.ts

@@ -1,4 +1,4 @@
-export type { Context } from "https://deno.land/x/hono@v3.2.7/mod.ts";
+export type { Context, Env } from "https://deno.land/x/hono@v3.2.7/mod.ts";
 export type { Next } from "https://deno.land/x/hono@v3.2.7/types.ts";
 export type { StatusCode } from "https://deno.land/x/hono@v3.2.7/utils/http-status.ts";
 

lib/ultra.ts

@@ -10,7 +10,7 @@ import {
 } from "./deps.ts";
 import { log } from "./logger.ts";
 import { renderToStream } from "./render.ts";
-import { Context, ImportMap, Mode } from "./types.ts";
+import { Context, Env, ImportMap, Mode } from "./types.ts";
 import { toUltraUrl } from "./utils/url.ts";
 
 type UltraServerRenderOptions = {
@@ -29,7 +29,12 @@ type UltraServerOptions = {
   entrypoint?: string;
 };
 
-export class UltraServer extends Hono {
+export class UltraServer<
+  E extends Env = Env,
+  // deno-lint-ignore ban-types
+  S = {},
+  BasePath extends string = "/",
+> extends Hono<E, S, BasePath> {
   public importMap: ImportMap | undefined;
   public assetManifest: Map<string, string> | undefined;
 

server.ts

@@ -1,3 +1,2 @@
-export { type Context } from "./lib/deps.ts";
 export { createRouter, createServer } from "./lib/server.ts";
-export type { StatusCode } from "./lib/types.ts";
+export type { Context, StatusCode } from "./lib/types.ts";

test/fixture.ts

@@ -16,6 +16,7 @@ serve((request) => {
       args: [
         "test",
         "-A",
+        "--reload",
       ],
       cwd: join(Deno.cwd(), "test", "fixture"),
     }).spawn();

test/fixture/server.tsx

@@ -8,13 +8,21 @@ import { TRPCServerProvider } from "./src/trpc/server.tsx";
 import { serverSheet, TWProvider } from "./src/context/twind.tsx";
 import { theme } from "./theme.ts";
 
-const server = await createServer({
+type Environment = {
+  Variables: {
+    foo?: string;
+  };
+};
+
+const server = await createServer<Environment, { foo: boolean }>({
   importMapPath: import.meta.resolve("./importMap.json"),
   browserEntrypoint: import.meta.resolve("./client.tsx"),
 });
 
 server.use("*", async (context, next) => {
   context.header("x-foo", "bar");
+  context.set("foo", "bar");
+
   await next();
 });