Merge pull request #569 from szegheo/fix-node22-compatibility-remove-esm

fix: v2 remove unmaintained esm dependency to fix Node22 compatibility

Author: jakobrosenberg

lib/middleware/createTemplate.js

@@ -1,4 +1,4 @@
-const { stripDefaultsAndDevProps } = require("esm")(module)('../../runtime/utils/normalizeNode')
+const { stripDefaultsAndDevProps } = require('../utils/normalizeNode')
 
 const { name, version } = require('../../package.json')
 

lib/utils/middleware.js

@@ -1,2 +1,108 @@
-require = require("esm")(module/*, options*/)
-module.exports = require("../../runtime/middleware")
+/**
+ * CommonJS implementation of the node middleware helpers.
+ *
+ * This used to proxy the ESM implementation in `runtime/middleware.js` via the
+ * unmaintained `esm` package. Keeping a CJS copy here avoids loaders and works
+ * on Node 22+, while still supporting older Node versions.
+ */
+
+/**
+ * Node middleware
+ * @description Walks through the nodes of a tree
+ * @example middleware = createNodeMiddleware(payload => {payload.file.name = 'hello'})(treePayload))
+ * @param {(payload: any) => any} fn
+ */
+function createNodeMiddleware(fn) {
+	/**
+	 * NodeMiddleware payload receiver
+	 * @param {TreePayload} payload
+	 */
+	const inner = async function execute(payload) {
+		return await nodeMiddleware(fn, {
+			file: payload.tree,
+			state: { treePayload: payload },
+			scope: {},
+		})
+	}
+
+	/**
+	 * NodeMiddleware sync payload receiver
+	 * @param {TreePayload} payload
+	 */
+	inner.sync = function executeSync(payload) {
+		return nodeMiddlewareSync(fn, {
+			file: payload.tree,
+			state: { treePayload: payload },
+			scope: {},
+		})
+	}
+
+	return inner
+}
+
+/**
+ * Node walker
+ * @param {(payload: any) => any} fn function to be called for each file
+ * @param {any=} payload
+ */
+async function nodeMiddleware(fn, payload) {
+	const _file = await fn(payload)
+	if (_file === false) return false
+	const file = _file || payload.file
+
+	if (file.children) {
+		const children = await Promise.all(
+			file.children.map(async _child =>
+				nodeMiddleware(fn, {
+					state: payload.state,
+					scope: clone(payload.scope || {}),
+					parent: payload.file,
+					file: await _child,
+				})
+			)
+		)
+		file.children = children.filter(Boolean)
+	}
+
+	return file
+}
+
+/**
+ * Node walker (sync version)
+ * @param {(payload: any) => any} fn function to be called for each file
+ * @param {any=} payload
+ */
+function nodeMiddlewareSync(fn, payload) {
+	const _file = fn(payload)
+	if (_file === false) return false
+
+	const file = _file || payload.file
+
+	if (file.children) {
+		const children = file.children.map(_child =>
+			nodeMiddlewareSync(fn, {
+				state: payload.state,
+				scope: clone(payload.scope || {}),
+				parent: payload.file,
+				file: _child,
+			})
+		)
+		file.children = children.filter(Boolean)
+	}
+
+	return file
+}
+
+/**
+ * Clone with JSON
+ * @param {any} obj
+ */
+function clone(obj) {
+	return JSON.parse(JSON.stringify(obj))
+}
+
+module.exports = {
+	nodeMiddleware,
+	nodeMiddlewareSync,
+	createNodeMiddleware,
+}

lib/utils/normalizeNode.js

@@ -0,0 +1,61 @@
+const defaultNode = {
+    isDir: false,
+    ext: 'svelte',
+    isLayout: false,
+    isReset: false,
+    isIndex: false,
+    isFallback: false,
+    isPage: false,
+    ownMeta: {},
+    meta: {
+        recursive: true,
+        preload: false,
+        prerender: true,
+    },
+    id: '__fallback',
+}
+
+const devProps = [
+    'file',
+    'filepath',
+    'name',
+    'badExt',
+    'relativeDir',
+    'absolutePath',
+    'importPath',
+    'isFile',
+]
+
+/** @param {TreePayload} node */
+function stripDefaultsAndDevProps(node) {
+    const strippedNode = {}
+
+    Object.entries(node)
+        .filter(([key]) => !devProps.includes(key))
+        .filter(
+            ([key, value]) =>
+                JSON.stringify(defaultNode[key]) !== JSON.stringify(value)
+        )
+        .forEach(([key, value]) => (strippedNode[key] = value))
+
+    if (node.children)
+        strippedNode.children = [...node.children.map(stripDefaultsAndDevProps)]
+
+    return strippedNode
+}
+
+function restoreDefaults(node) {
+    Object.entries(defaultNode).forEach(([key, value]) => {
+        if (typeof node[key] === 'undefined') node[key] = value
+    })
+
+    if (node.children) node.children = node.children.map(restoreDefaults)
+
+    return node
+}
+
+module.exports = {
+    defaultNode,
+    stripDefaultsAndDevProps,
+    restoreDefaults,
+}

package-lock.json

@@ -33,7 +33,6 @@
     "./plugins/*": "./plugins/*",
     "./hmr": "./hmr.js",
     "./lib/utils/config": "./lib/utils/config.js"
-
   },
   "dependencies": {
     "@roxi/ssr": "^0.2.1",
@@ -42,7 +41,6 @@
     "cheap-watch": "^1.0.4",
     "commander": "^7.2.0",
     "configent": "^2.2.0",
-    "esm": "^3.2.25",
     "fs-extra": "^9.1.0",
     "log-symbols": "^3.0.0",
     "picomatch": "^2.3.1",

package.json

@@ -1,2 +1,2 @@
-declare const _exports: typeof import("../middleware");
+declare const _exports: typeof import("../../runtime/middleware");
 export = _exports;