feat: Added h3 package, changed useQuery typing

Author: coderhammer

.changeset/witty-emus-thank.md

@@ -0,0 +1,6 @@
+---
+"@backhooks/hooks": minor
+"@backhooks/h3": patch
+---
+
+Added h3 package, changed useQuery typing

package-lock.json

@@ -14,6 +14,7 @@
     "packages/hooks",
     "packages/express",
     "packages/fastify",
+    "packages/h3",
     "packages/examples"
   ],
   "devDependencies": {

package.json

@@ -0,0 +1,2 @@
+dist
+node_modules

packages/h3/.gitignore

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

packages/h3/jest.config.js

@@ -0,0 +1,19 @@
+{
+  "name": "@backhooks/h3",
+  "version": "0.0.1",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "h3": "^1.0.0"
+  },
+  "dependencies": {
+    "@backhooks/core": "^0.3.0",
+    "@backhooks/hooks": "^0.2.0"
+  },
+  "devDependencies": {
+    "supertest": "^6.3.3"
+  }
+}

packages/h3/package.json

@@ -0,0 +1,46 @@
+import {
+  getHeaders,
+  readBody,
+  H3Event,
+  App,
+  getRouterParams,
+  getQuery,
+} from "h3";
+import { setBody, setHeaders, setParams, setQuery } from "@backhooks/hooks";
+import { runHookContext } from "@backhooks/core";
+
+export const makeHookableApp = (h3App: App) => {
+  const originalHandler = h3App.handler;
+  h3App.handler = async (event: H3Event) => {
+    return runHookContext(() => {
+      const headers = getHeaders(event);
+      setHeaders(() => {
+        return {
+          headers,
+        };
+      });
+      setBody(() => {
+        return {
+          fetch() {
+            return readBody(event);
+          },
+        };
+      });
+      setParams(() => {
+        return {
+          fetch() {
+            const params = getRouterParams(event);
+            console.log(params);
+            return params;
+          },
+        };
+      });
+      setQuery(() => {
+        return {
+          query: getQuery(event),
+        };
+      });
+      return originalHandler(event);
+    });
+  };
+};

packages/h3/src/index.ts

@@ -0,0 +1,70 @@
+import { useBody, useHeaders, useParams, useQuery } from "@backhooks/hooks";
+import * as supertest from "supertest";
+import { SuperTest, Test } from "supertest";
+import { App, toNodeListener, createApp, eventHandler, createRouter } from "h3";
+import { makeHookableApp } from "../src";
+
+let app: App;
+let request: SuperTest<Test>;
+
+beforeEach(() => {
+  app = createApp({ debug: true });
+  makeHookableApp(app);
+  request = supertest(toNodeListener(app));
+});
+
+test("useBody", async () => {
+  app.use(
+    "/body",
+    eventHandler(() => {
+      const body = useBody();
+      return body;
+    })
+  );
+
+  const res = await request.post("/body").send({
+    foo: "bar",
+  });
+
+  expect(res.body.foo).toBe("bar");
+});
+
+test("useHeaders", async () => {
+  app.use(
+    "/headers",
+    eventHandler(() => {
+      const headers = useHeaders();
+      return headers;
+    })
+  );
+  const res = await request.get("/headers").send().set({
+    foo: "bar",
+  });
+  expect(res.body.foo).toBe("bar");
+});
+
+test("useParams", async () => {
+  const router = createRouter();
+  router.get(
+    "/:foo",
+    eventHandler(() => {
+      const params = useParams();
+      return params;
+    })
+  );
+  app.use(router);
+  const res = await request.get("/bar").send();
+  expect(res.body.foo).toBe("bar");
+});
+
+test("useQuery", async () => {
+  app.use(
+    "/",
+    eventHandler(() => {
+      const query = useQuery();
+      return query;
+    })
+  );
+  const res = await request.get("/?foo=bar").send();
+  expect(res.body.foo).toBe("bar");
+});

packages/h3/tests/index.spec.ts

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "outDir": "dist",
+    "declaration": true,
+    "lib": ["WebWorker"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}

packages/h3/tsconfig.json

@@ -1,7 +1,8 @@
 import { createHook } from "@backhooks/core";
 
+type QueryValue = string | undefined | null;
 interface ParsedQs {
-  [key: string]: undefined | string | string[] | ParsedQs | ParsedQs[];
+  [key: string]: ParsedQs | ParsedQs[] | QueryValue | QueryValue[];
 }
 
 export interface QueryHookState {