Release/1.4.1 (#10)

Author: Thesephi

CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.4.1] - 2023-08-18
+
+### Fixed
+- fixed `req.url` in Dev Mode, so requests like `/foo?bar=baz` are properly parsed
+
+### Added
+- webpack aliases for modules in `client/` and `server/`
+- 2 more endpoints to demonstrate the boilerplate's ability to handle various flavours of standard REST endpoints
+
+### Removed
+- declaration of the plugin `bodyParser` as it's already bundled within (the opinionated) `somnus`
+
 ## [1.4.0] - 2022-07-13
 
 ### Changed

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "fullstack-typescript-webapp-starter",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "A db-agnostic, React-based web application starter boilerplate",
   "scripts": {
     "build-prod": "scripts/build-prod.sh",

package.json

@@ -74,6 +74,23 @@ export async function submitEntry(req: Request, res: Response): Promise<void> {
 
 }
 
+export async function getEntry(req: Request, res: Response): Promise<void> {
+    const meta = {
+        reqUrl: req.url,
+        reqPath: req.getPath(),
+        reqQuery: req.query,
+        reqParams: req.params,
+    }
+    const id = req.params?.id;
+    if (!id) return res.send(400, { message: `missing request query 'id'`, meta });
+    const col = await getDbCollection(COLLECTION_NAME);
+    const allEntries = await col.find().toArray();
+    return res.send({
+        data: allEntries[id],
+        meta
+    });
+}
+
 export async function getEntries(req: Request, res: Response): Promise<void> {
 
     const col = await getDbCollection(COLLECTION_NAME);

src/server/helper.ts

@@ -1,20 +1,23 @@
 import { Request, Response } from "restify";
-import { outputView, submitEntry, getEntries } from "./helper";
+import { outputView, submitEntry, getEntry, getEntries } from "./helper";
 import somnus, { IRouteConfig } from "somnus";
 import { join } from "path";
 
 async function main(): Promise<void> {
 
     process.chdir(__dirname);
 
-    somnus.server.use(somnus.restify.plugins.bodyParser());
+    // @NOTE if we use `somnus`, there's no need to declare bodyParser & queryParser
+    // as they're already bundled into somnus server object
 
     let routeConfig: IRouteConfig = {
 
         "get /": (req: Request, res: Response) => outputView(req, res, "./view-templates/index.html"),
 
         "post /entry": submitEntry,
         "get /entries": getEntries,
+        "get /entry": getEntry,
+        "get /entry/:id": getEntry,
 
         // in real production, these should be intercepted & handled by a reverse proxy / CDN instead
         "get /js/*": somnus.restify.plugins.serveStatic({ directory: "../public" }),

src/server/main.ts

@@ -30,9 +30,12 @@ async function initWebpackDevMiddleware(app: restify.Server) {
   app.pre(
     (req, res, next) => {
       const thePath = req.getPath();
-      console.log("somnus: custom whm handling", thePath);
+      const theBareQuery = req.getQuery();
+      const theQuery = theBareQuery ? `?${theBareQuery}` : "";
+      const theUrl = thePath + theQuery;
+      console.log("somnus wdmwhm: handling", theUrl);
       // fix a webpack-hot-middleware - restify incompatibility
-      req.url = thePath;
+      req.url = theUrl;
       return next();
     },
     require("webpack-hot-middleware")(compiler, {

src/server/webpack-dev-middleware-connector.ts

@@ -27,7 +27,9 @@ module.exports = {
     // Add '.node' so native modules can be compiled (e.g. `unit-http`).
     extensions: [".ts", ".tsx", ".js", ".node"],
     alias: {
-      shared: path.resolve(__dirname, "shared/")
+      shared: path.resolve(__dirname, "shared/"),
+      client: path.resolve(__dirname, "client/"),
+      server: path.resolve(__dirname, "server/"),
     }
   },