@cley_faye/boilerplate 3.14.0 → 3.16.0

package/README.md

@@ -29,8 +29,6 @@ required, and for what. It's up to the calling project to have the proper depend
 
 For webapp building:
 
-- resolve-typescript-plugin (due to the way webpack plugins are handled, this is mandatory for dev
-  install)
 - babel-loader
 - eslint-webpack-plugin
 - @babel/core
@@ -464,6 +462,30 @@ It is also possible to trigger a stop by calling the `closeServer()` function on
 `@cley_faye/boilerplate/lib/express/autoclose.js`.
 This feature only supports one server at a time.
 
+Extra middleware
+----------------
+
+### singlepageapp
+If you want to serve a statically built webapp based on a single html entrypoint, you can use the
+middleware provided in `/lib/express/middlewares/singlepageapp.js`.
+
+Basic usage:
+
+```JavaScript
+import express from "express";
+import {singlePageApp} from "@cley_faye/boilerplate/lib/express/middlewares/singlepageapp.js";
+
+const someRouter = express.Router();
+someRouter.use("/app", singlePageApp({rootDir: "dist/webapp"});
+```
+
+Available config options are:
+
+- `rootDir`: mandatory, root directory containing the SPA
+- `htmlFile`: optional, name of the HTML file to serve (defaults to "index.html")
+- `staticRootDirectories`: optional, name of directories (in the above root directory) to serve as
+  static files. Defaults to `["js", "css", "img"]`.
+
 Console logging
 ---------------
 For convenience, a winston logger using console as output is provided:

package/lib/express/middlewares/singlepageapp.d.ts

@@ -0,0 +1,41 @@
+import { RequestHandler } from "express";
+interface SinglePageAppConfig {
+    /** Path to the file to serve for the whole application
+     *
+     * Any request coming for a directory not listed in the static list will reply with index.html
+     * from this directory.
+     */
+    rootDir: string;
+    /** Name of the app html file
+     *
+     * Defaults to "index.html"
+     */
+    htmlFile?: string;
+    /** Directories to serve as-is
+     *
+     * These are served by a static middleware.
+     * It is advised, if possible, to serve these from outside of node.
+     *
+     * Defaults to `["js", "css", "img"]`.
+     */
+    staticRootDirectories?: Array<string>;
+}
+/** Serve a single page webapp using a modern browser URL router
+ *
+ * This will serve all requests from the router using the provided index.html file, except for files
+ * in the listed static directories.
+ *
+ * Note that it is advised to serve these static directories from outside of node (ideally from a
+ * frontend server upper in the request handling).
+ *
+ * Basic usage:
+ * ```JavaScript
+ * import express from "express";
+ * import {singlePageApp} from "@cley_faye/boilerplate/lib/express/middlewares/singlepageapp.js";
+ *
+ * const someRouter = express.Router();
+ * someRouter.use("/app", singlePageApp({rootDir: "dist/webapp"});
+ * ```
+ */
+export declare const singlePageApp: (config: SinglePageAppConfig) => Array<RequestHandler>;
+export {};

package/lib/express/middlewares/singlepageapp.js

@@ -0,0 +1,88 @@
+/**
+ * @license
+ * @preserve
+ * MIT License
+ *
+ * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.singlePageApp = void 0;
+const path = __importStar(require("node:path"));
+const express_1 = __importDefault(require("express"));
+/** Serve a single page webapp using a modern browser URL router
+ *
+ * This will serve all requests from the router using the provided index.html file, except for files
+ * in the listed static directories.
+ *
+ * Note that it is advised to serve these static directories from outside of node (ideally from a
+ * frontend server upper in the request handling).
+ *
+ * Basic usage:
+ * ```JavaScript
+ * import express from "express";
+ * import {singlePageApp} from "@cley_faye/boilerplate/lib/express/middlewares/singlepageapp.js";
+ *
+ * const someRouter = express.Router();
+ * someRouter.use("/app", singlePageApp({rootDir: "dist/webapp"});
+ * ```
+ */
+const singlePageApp = (config) => {
+    const rootDir = path.resolve(config.rootDir);
+    const htmlFile = config.htmlFile ?? "index.html";
+    const staticDirs = (config.staticRootDirectories ?? ["js", "css", "img"]).map(c => `/${c}`);
+    const appRoute = (req, res, next) => {
+        for (const candidates of staticDirs)
+            if (req.url.startsWith(candidates))
+                return next();
+        res.sendFile(htmlFile, { root: rootDir }, (err) => next(err));
+    };
+    const staticRoute = express_1.default.static(rootDir);
+    return [appRoute, staticRoute];
+};
+exports.singlePageApp = singlePageApp;

package/lib/grunt/reactapp/webpack.d.ts

@@ -1,3 +1,4 @@
+import { ResolveOptions } from "webpack";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
 import { GruntConfig } from "./util.js";
@@ -27,7 +28,8 @@ export interface WebpackLoadersOptions {
  * Version of core-js to use (default to 3)
  *
  * @param [options.babel.targets]
- * Browser targets (default to " > 1%, last 1 safari version")
+ * Browser targets (default to "> 2% and not dead, last 2 safari version, last 2 firefox version,
+ * last 2 chrome version, last 2 edge version, Firefox ESR")
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel
@@ -49,7 +51,7 @@ export interface WebpackOptions extends BaseOptions {
     plugins?: Array<Record<string, unknown>>;
     babelPlugins?: Array<Record<string, unknown>>;
     defines?: Record<string, string>;
-    resolve?: Record<string, unknown>;
+    resolve?: ResolveOptions;
     typescript?: boolean;
 }
 /** Add a webpack task for the reactApp recipe

package/lib/grunt/reactapp/webpack.js

@@ -33,7 +33,6 @@ exports.handle = exports.webpackLoadersDefault = void 0;
 const path_1 = require("path");
 const node_fs_1 = require("node:fs");
 const eslint_webpack_plugin_1 = __importDefault(require("eslint-webpack-plugin"));
-const resolve_typescript_plugin_1 = __importDefault(require("resolve-typescript-plugin"));
 const util_js_1 = require("./util.js");
 const defaultCoreJS = 3;
 const eslintPlugin = () => new eslint_webpack_plugin_1.default({ cache: true });
@@ -50,7 +49,7 @@ const defaultLoadersDefine = (options) => [
 const defaultLoadersPresetEnv = (options) => [
     "@babel/preset-env",
     {
-        targets: (options.babel?.targets) ?? "> 1%, last 1 safari version",
+        targets: (options.babel?.targets) ?? "> 2% and not dead, last 2 safari version, last 2 firefox version, last 2 chrome version, last 2 edge version, Firefox ESR",
         useBuiltIns: "usage",
         corejs: (options.babel?.corejs) ?? defaultCoreJS,
         modules: false,
@@ -76,7 +75,8 @@ const defaultLoadersReact = (options) => [
  * Version of core-js to use (default to 3)
  *
  * @param [options.babel.targets]
- * Browser targets (default to " > 1%, last 1 safari version")
+ * Browser targets (default to "> 2% and not dead, last 2 safari version, last 2 firefox version,
+ * last 2 chrome version, last 2 edge version, Firefox ESR")
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel
@@ -170,10 +170,11 @@ const registerTasks = (gruntConfig, targetName, webpackConfig) => {
 const computeWebpackResolve = (webpackOptions) => {
     const res = { ...webpackOptions.resolve };
     if (webpackOptions.typescript) {
-        if (res.plugins === undefined) {
-            res.plugins = [];
+        if (res.extensionAlias === undefined) {
+            res.extensionAlias = {};
         }
-        res.plugins.push(new resolve_typescript_plugin_1.default());
+        res.extensionAlias[".js"] = [".ts", ".tsx", ".js", ".jsx"];
+        res.extensionAlias[".mjs"] = [".mts", ".mtsx", ".mjs", ".mjsx"];
     }
     return res;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.14.0",
+  "version": "3.16.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -18,14 +18,14 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.9.2",
+    "@keeex/eslint-config": "^1.9.3",
     "@types/express": "^4.17.17",
     "@types/grunt": "^0.4.27",
     "@types/http-errors": "^2.0.1",
-    "@types/node": "^18.11.19",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
-    "eslint": "^8.33.0",
+    "@types/node": "^18.14.2",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "eslint": "^8.35.0",
     "eslint-plugin-deprecation": "^1.3.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-promise": "^6.1.1",
@@ -36,8 +36,9 @@
     "grunt-contrib-clean": "^2.0.1",
     "grunt-run": "^0.8.1",
     "load-grunt-tasks": "^5.1.0",
-    "logform": "^2.4.2",
+    "logform": "^2.5.1",
     "typescript": "^4.9.5",
+    "webpack": "^5.75.0",
     "winston": "^3.8.2"
   },
   "peerDependencies": {
@@ -57,7 +58,6 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
-    "resolve-typescript-plugin": "^2.0.0",
     "sass": "1.x",
     "ts-loader": "^9.4.1",
     "winston": "3.x"
@@ -111,9 +111,6 @@
     "grunt-webpack": {
       "optional": true
     },
-    "resolve-typescript-plugin": {
-      "optional": false
-    },
     "sass": {
       "optional": true
     },