wurzel 0.0.9 → 0.0.11

package/dist/bin/wurzel.js

@@ -12,6 +12,12 @@ app.use("/", wurzel({ express, baseFolder: rootFolder }));
 
 const port = 8080;
 
-app.listen(port, () => {
+// @ts-expect-error wrong type definition for listen callback
+app.listen(port, (err/*: Error*/) => {
+  if (err) {
+    console.error("Error starting server:", err);
+    return;
+  }
+
   console.log(`listening on :${port}`);
 });

package/dist/lib/index.d.ts

@@ -1,13 +1,16 @@
 import type { TResolveImportPathFunc } from "es6-debug-server";
 import type Express from "express";
+type TFileType = "script" | "script-resource" | "other";
 declare const defaultResolveImportPath: TResolveImportPathFunc;
-declare const expressRouter: ({ express, baseFolder, fileEndings, maxAnalyzeCacheSize, maxTranspileCacheSize, resolveImportPath }: {
+declare const expressRouter: ({ express, baseFolder, maxAnalyzeCacheSize, maxTranspileCacheSize, determineFileTypeByPath, resolveImportPath }: {
     express: typeof Express;
     baseFolder: string;
-    fileEndings?: string[];
     maxAnalyzeCacheSize?: number;
     maxTranspileCacheSize?: number;
+    determineFileTypeByPath?: (args: {
+        filePath: string;
+    }) => TFileType;
     resolveImportPath?: TResolveImportPathFunc;
 }) => any;
 export { expressRouter, defaultResolveImportPath };
-export type { TResolveImportPathFunc };
+export type { TResolveImportPathFunc, TFileType };

package/dist/lib/index.js

@@ -33,15 +33,18 @@ const md5 = ({ content }/*: { content: string }*/) => {
 
 /*type TTranspileResult = ITranspileErrorResult | ITranspileSuccessResult;*/
 
+/*type TFileType = "script" | "script-resource" | "other";*/
+
 const defaultResolveImportPath/*: TResolveImportPathFunc*/ = async ({ importer, specifier }) => {
   const parentUrl = pathToFileURL(importer);
+  // eslint-disable-next-line no-useless-assignment
   let resolvedUrl/*: string | undefined*/ = undefined;
 
   try {
     resolvedUrl = resolveImport(specifier, parentUrl.toString());
   } catch (error) {
     return {
-      error: error/* as Error*/
+      error: error /*as Error*/
     };
   }
 
@@ -64,24 +67,40 @@ const defaultResolveImportPath/*: TResolveImportPathFunc*/ = async ({ importer,
   };
 };
 
+const defaultScriptFileEndings = [".js", ".ts", ".cjs", ".mjs", ".cts", ".mts"];
+
+const defaultDetermineFileTypeByPath = ({ filePath }/*: { filePath: string }*/)/*: TFileType*/ => {
+  const isScript = defaultScriptFileEndings.some((ending) => {
+    return filePath.endsWith(ending);
+  });
+
+  if (isScript) {
+    return "script";
+  }
+
+  return "other";
+};
+
 const expressRouter = ({
   express,
   baseFolder,
-  fileEndings = [".js", ".ts"],
 
   maxAnalyzeCacheSize = 1 * 1024 * 1024,
   maxTranspileCacheSize = 64 * 1024 * 1024,
 
+  determineFileTypeByPath = defaultDetermineFileTypeByPath,
   resolveImportPath = defaultResolveImportPath
 }/*: {
   express: typeof Express,
   baseFolder: string,
-  fileEndings?: string[],
 
   maxAnalyzeCacheSize?: number,
   maxTranspileCacheSize?: number,
 
+  // eslint-disable-next-line no-unused-vars
+  determineFileTypeByPath?: (args: { filePath: string }) => TFileType,
   resolveImportPath?: TResolveImportPathFunc
+// eslint-disable-next-line complexity
 }*/) => {
 
   const router = express.Router();
@@ -119,6 +138,7 @@ const expressRouter = ({
       };
     }
 
+    // eslint-disable-next-line no-useless-assignment
     let transpiled/*: string | undefined*/ = undefined;
 
     try {
@@ -126,7 +146,7 @@ const expressRouter = ({
       transpiled = result.transpiledCode;
     } catch (ex) {
       return {
-        error: ex/* as Error*/,
+        error: ex /*as Error*/,
       };
     }
 
@@ -228,8 +248,13 @@ const expressRouter = ({
       throw Error("HEAD not supported yet");
     }
 
-    const isScript = fileEndings.some((ending) => req.url.endsWith(ending));
-    if (isScript) {
+    const fileType = determineFileTypeByPath({ filePath: req.url });
+
+    if (fileType === "script-resource") {
+      throw Error(`file type ${fileType} is not supported yet`);
+    }
+
+    if (fileType === "script") {
 
       server.handleRequest({
         uri: req.url,
@@ -274,5 +299,6 @@ export {
 };
 
 /*export type {
-  TResolveImportPathFunc
+  TResolveImportPathFunc,
+  TFileType
 };*/

package/dist/samples/express/frontend/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Hello World</title>
+    <script src="index.ts" type="module"></script>
+</head>
+<body>
+    <h1>Hello World!</h1>
+</body>
+</html>

package/dist/samples/express/frontend/index.ts

@@ -0,0 +1,5 @@
+type TMyType = "a" | "b" | "c";
+
+const x: TMyType = "a";
+
+console.log("Hello from TypeScript!", { x });

package/dist/samples/express/main.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/samples/express/main.js

@@ -0,0 +1,40 @@
+import {
+  expressRouter as wurzelExpressRouter,
+  defaultResolveImportPath,
+  /*type TResolveImportPathFunc
+*/} from "../../lib/index.js";
+import nodePath from "node:path";
+import { resolve } from "esm-resource";
+import express from "express";
+
+const relativePath = ({ filepath }/*: { filepath: string }*/) => {
+  return nodePath.resolve(resolve({ importMeta: import.meta, filepath }));
+};
+
+const baseFolder = relativePath({ filepath: "./frontend" });
+
+const resolveImportPath/*: TResolveImportPathFunc*/ = async ({ importer, specifier }) => {
+  if (specifier === "vue") {
+    return {
+      error: undefined,
+      // this is only an example, it is neither installed nor used in this sample
+      filePath: relativePath({ filepath: "../node_modules/vue/dist/vue.esm-browser.js" })
+    };
+  }
+
+  return defaultResolveImportPath({ importer, specifier });
+};
+
+const app = express();
+
+app.use("/", wurzelExpressRouter({
+  express,
+  baseFolder,
+  resolveImportPath
+}));
+
+const port = 8080;
+
+app.listen(port, () => {
+  console.log(`listening on :${port}`);
+});

package/package.json

@@ -1,7 +1,8 @@
 {
+  "version": "0.0.11",
   "name": "wurzel",
-  "version": "0.0.9",
   "type": "module",
+  "description": "A tool to serve script files from different directories",
   "files": [
     "dist"
   ],
@@ -9,34 +10,41 @@
   "dependencies": {
     "commentscript": "^0.0.10",
     "es6-debug-server": "^0.0.9",
-    "esm-resource": "^0.0.1",
-    "express": "^4.19.2",
+    "esm-resource": "^0.0.3",
     "import-meta-resolve": "^4.0.0",
     "lru-cache": "^10.2.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.7.0",
+    "@eslint/js": "^10.0.1",
+    "@k13engineering/releasetool": "^0.0.5",
     "@types/express": "^4.17.21",
     "@types/node": "^20.12.7",
-    "deno-node": "^0.0.5",
-    "typescript-eslint": "^7.16.1"
+    "deno-node": "^0.0.12",
+    "express": "^5.2.1",
+    "npm-check-updates": "^20.0.2",
+    "typescript-eslint": "^8.58.2"
   },
   "bin": {
     "wurzel": "dist/bin/wurzel.js"
   },
   "scripts": {
-    "build": "rm -rf dist/ && deno-node-build --root . --out dist/ --entry lib/index.ts --entry bin/wurzel.ts",
+    "build": "rm -rf dist/ && deno-node-build --root . --out dist/ --entry lib/index.ts --entry bin/wurzel.ts --entry samples/express/main.ts && cp -r samples/express/frontend dist/samples/express/",
     "lint": "eslint .",
-    "test": "true"
+    "test": "true",
+    "type-check": "tsc --noEmit",
+    "update-deps": "npm-check-updates -u"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "author": "Simon Kadisch",
-    "license": "LGPL-2.1",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/k13-engineering/wurzel.git"
-    },
-    "bugs": {
-        "url": "https://github.com/k13-engineering/wurzel/issues"
-    },
-    "homepage": "https://github.com/k13-engineering/wurzel#readme"
+  "license": "LGPL-2.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/k13-engineering/wurzel.git"
+  },
+  "bugs": {
+    "url": "https://github.com/k13-engineering/wurzel/issues"
+  },
+  "homepage": "https://github.com/k13-engineering/wurzel#readme"
 }