Merge pull request #1 from Eliav2/ft/better-demo

.stackblitzrc

@@ -0,0 +1,3 @@
+{
+  "startCommand": "pnpm start-demo"
+}

demo/express-typed-demo/src/app.ts → examples/fullstack_react_express-typed/express-typed-demo/src/app.ts

@@ -1,5 +1,4 @@
-import {TypedRouter} from "express-typed"
-import express, { Request, Response } from "express";
+import express from "express";
 import logger from "morgan";
 import typedRouter from "./routes/index.routes";
 
@@ -12,12 +11,6 @@ app.use(logger("dev"));
 app.use(express.urlencoded({ extended: true }));
 app.use(express.json());
 
-// const router = express.Router();
-
-// router.get("/", async (req: Request, res: Response) => {
-//   res.send("Hello World!").status(200);
-// });
-
 app.use("/", typedRouter.router);
 
 const server = app.listen(4000, () => {

demo/express-typed-demo/src/routes/index.routes.ts → examples/fullstack_react_express-typed/express-typed-demo/src/routes/index.routes.ts

@@ -60,8 +60,8 @@ export type RoutesWithMethod<Method extends HandlerMethods> = {
 // usage
 // get all routes that have a "get" method, and their response types
 type GetRoutes = RoutesWithMethod<"get">;
-//   ^?
+//   ^? type GetRoutes = { "/": "Hello world"}; 
 // get all routes that have a "post" method, and their response types
 type PostRoutes = RoutesWithMethod<"post">;
 //   ^?
-////
+////

examples/fullstack_react_express-typed/frontend-demo/src/App.tsx

@@ -0,0 +1,14 @@
+import "./App.css";
+import { useAppQuery } from "./queries";
+
+function App() {
+  const query = useAppQuery("/", "get");
+  const data = query.data;
+  //    ^? const query: UseQueryResult<"Hello world", Error>
+
+  console.log("data", data);
+
+  return <>{JSON.stringify(data)}</>;
+}
+
+export default App;

demo/express-demo/package.json → examples/regular-express/backend/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "express-demo",
+  "name": "regular-express",
   "version": "1.0.0",
   "type": "module",
   "scripts": {

demo/express-demo/tsconfig.json → examples/regular-express/backend/tsconfig.json

@@ -11,6 +11,6 @@
     "skipLibCheck": true,
     "strict": true
   },
-  "include": ["src/**/*.ts"],
+  "include": ["backend/src/**/*.ts"],
   "exclude": ["node_modules"]
 }

package.json

@@ -5,7 +5,8 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "vitest --typecheck"
+    "test": "vitest --typecheck",
+    "start-demo": "pnpm --parallel --filter express-typed --filter \"./examples/fullstack_react_express-typed/*\" dev"
   },
   "dependencies": {
     "express-typed": "workspace:*"
@@ -18,8 +19,13 @@
   },
   "devDependencies": {
     "@vitest/ui": "^1.5.2",
+    "concurrently": "^8.2.2",
     "typescript": "^5.4.5",
     "vite": "^5.2.0",
     "vitest": "^1.5.2"
+  },
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=9"
   }
 }

packages/express-typed/package.json

@@ -8,7 +8,7 @@
   "types": "dist/express-typed.d.ts",
   "scripts": {
     "build": "tsc",
-    "build:watch": "tsc -w",
+    "dev": "tsc -w",
     "prepublish": "pnpm build",
     "test": "vitest"
   },