@rooted-adapters/express 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marvin Brouwer
+
+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.

package/dist/index.d.mts

@@ -0,0 +1,46 @@
+import { AdapterRoutes } from "@rooted/adapter";
+import { Plugin } from "vite";
+
+//#region src/index.d.mts
+/**
+ * Options for {@link expressAdapter}.
+ */
+type ExpressAdapterOptions = {
+  /**
+   * Manual route list for projects that don't use `generateRouteManifest`.
+   * See {@link AdapterRoutes}.
+   */
+  routes?: AdapterRoutes;
+};
+/**
+ * Adapter for server-side hosting with Express.
+ *
+ * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
+ * The server uses `express.static` to serve pre-rendered HTML files and registers
+ * explicit handlers for parameterized routes (which serve the `404.html` SPA shell
+ * so the browser-side router renders the correct content). Express uses the same
+ * `:param` syntax as the rooted router, so patterns map directly.
+ *
+ * Users start the server with `node dist/server.mjs`. The `PORT` environment variable
+ * controls the port (default: 3000).
+ *
+ * Requires `express >= 5.0.0` in the project.
+ *
+ * @example `vite.config.ts`
+ * ```ts
+ * import { rootedManifest } from '@rooted/application'
+ * import { generateRouteManifest } from '@rooted/router/manifest'
+ * import { expressAdapter } from '@rooted-adapters/express'
+ *
+ * export default rootedManifest({
+ *   plugins: [
+ *     generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
+ *     expressAdapter(),
+ *   ],
+ * })
+ * ```
+ */
+declare function expressAdapter(options?: ExpressAdapterOptions): Plugin;
+//#endregion
+export { ExpressAdapterOptions, expressAdapter };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC5tdHMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL2luZGV4Lm10cyJdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBV0E7S0FBWSxxQkFBQTs7OztBQW9DWjtFQS9CQyxNQUFBLEdBQVMsYUFBQTtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztpQkErQk0sY0FBQSxDQUFlLE9BQUEsR0FBVSxxQkFBQSxHQUF3QixNQUFBIn0=

package/dist/index.mjs

@@ -0,0 +1,75 @@
+import { writeFile } from "node:fs/promises";
+import path from "node:path";
+import { routedAdapter } from "@rooted/adapter";
+//#region src/index.mts
+/**
+* Adapter for server-side hosting with Express.
+*
+* Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
+* The server uses `express.static` to serve pre-rendered HTML files and registers
+* explicit handlers for parameterized routes (which serve the `404.html` SPA shell
+* so the browser-side router renders the correct content). Express uses the same
+* `:param` syntax as the rooted router, so patterns map directly.
+*
+* Users start the server with `node dist/server.mjs`. The `PORT` environment variable
+* controls the port (default: 3000).
+*
+* Requires `express >= 5.0.0` in the project.
+*
+* @example `vite.config.ts`
+* ```ts
+* import { rootedManifest } from '@rooted/application'
+* import { generateRouteManifest } from '@rooted/router/manifest'
+* import { expressAdapter } from '@rooted-adapters/express'
+*
+* export default rootedManifest({
+*   plugins: [
+*     generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
+*     expressAdapter(),
+*   ],
+* })
+* ```
+*/
+function expressAdapter(options) {
+	return routedAdapter({
+		name: "rooted:express",
+		routes: options?.routes,
+		async setup({ outputDirectory }) {
+			await writeFile(path.join(outputDirectory, "server.mjs"), EXPRESS_SERVER_TEMPLATE, "utf8");
+		}
+	});
+}
+const EXPRESS_SERVER_TEMPLATE = `\
+import express from 'express'
+import { readFileSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const { base, dynamicRoutes, fallback } = JSON.parse(
+  readFileSync(path.join(__dirname, 'routes.json'), 'utf8')
+)
+
+const prefix = base.replace(/\\/$/, '')
+const app = express()
+
+// Serves all pre-rendered HTML files and static assets automatically
+app.use(base, express.static(__dirname))
+
+// Parameterized routes: Express uses the same :param syntax as the rooted router
+for (const route of dynamicRoutes) {
+  app.get(prefix + route, (_req, res) =>
+    res.sendFile(path.join(__dirname, fallback))
+  )
+}
+
+// Anything else: SPA shell (browser-side router shows the correct content or 404)
+app.use((_req, res) => res.sendFile(path.join(__dirname, fallback)))
+
+const port = Number(process.env.PORT ?? 3000)
+app.listen(port, '0.0.0.0', () => console.log(\`Listening on http://0.0.0.0:\${port}\`))
+`;
+//#endregion
+export { expressAdapter };
+
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgubWpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC5tdHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgd3JpdGVGaWxlIH0gZnJvbSAnbm9kZTpmcy9wcm9taXNlcydcbmltcG9ydCBwYXRoIGZyb20gJ25vZGU6cGF0aCdcblxuaW1wb3J0IHsgcm91dGVkQWRhcHRlciB9IGZyb20gJ0Byb290ZWQvYWRhcHRlcidcblxuaW1wb3J0IHR5cGUgeyBBZGFwdGVyUm91dGVzIH0gZnJvbSAnQHJvb3RlZC9hZGFwdGVyJ1xuaW1wb3J0IHR5cGUgeyBQbHVnaW4gfSBmcm9tICd2aXRlJ1xuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHtAbGluayBleHByZXNzQWRhcHRlcn0uXG4gKi9cbmV4cG9ydCB0eXBlIEV4cHJlc3NBZGFwdGVyT3B0aW9ucyA9IHtcblx0LyoqXG5cdCAqIE1hbnVhbCByb3V0ZSBsaXN0IGZvciBwcm9qZWN0cyB0aGF0IGRvbid0IHVzZSBgZ2VuZXJhdGVSb3V0ZU1hbmlmZXN0YC5cblx0ICogU2VlIHtAbGluayBBZGFwdGVyUm91dGVzfS5cblx0ICovXG5cdHJvdXRlcz86IEFkYXB0ZXJSb3V0ZXNcbn1cblxuLyoqXG4gKiBBZGFwdGVyIGZvciBzZXJ2ZXItc2lkZSBob3N0aW5nIHdpdGggRXhwcmVzcy5cbiAqXG4gKiBXcml0ZXMgYHJvdXRlcy5qc29uYCBhbmQgYSByZWFkeS10by1ydW4gYHNlcnZlci5tanNgIHRvIHRoZSBvdXRwdXQgZGlyZWN0b3J5LlxuICogVGhlIHNlcnZlciB1c2VzIGBleHByZXNzLnN0YXRpY2AgdG8gc2VydmUgcHJlLXJlbmRlcmVkIEhUTUwgZmlsZXMgYW5kIHJlZ2lzdGVyc1xuICogZXhwbGljaXQgaGFuZGxlcnMgZm9yIHBhcmFtZXRlcml6ZWQgcm91dGVzICh3aGljaCBzZXJ2ZSB0aGUgYDQwNC5odG1sYCBTUEEgc2hlbGxcbiAqIHNvIHRoZSBicm93c2VyLXNpZGUgcm91dGVyIHJlbmRlcnMgdGhlIGNvcnJlY3QgY29udGVudCkuIEV4cHJlc3MgdXNlcyB0aGUgc2FtZVxuICogYDpwYXJhbWAgc3ludGF4IGFzIHRoZSByb290ZWQgcm91dGVyLCBzbyBwYXR0ZXJucyBtYXAgZGlyZWN0bHkuXG4gKlxuICogVXNlcnMgc3RhcnQgdGhlIHNlcnZlciB3aXRoIGBub2RlIGRpc3Qvc2VydmVyLm1qc2AuIFRoZSBgUE9SVGAgZW52aXJvbm1lbnQgdmFyaWFibGVcbiAqIGNvbnRyb2xzIHRoZSBwb3J0IChkZWZhdWx0OiAzMDAwKS5cbiAqXG4gKiBSZXF1aXJlcyBgZXhwcmVzcyA+PSA1LjAuMGAgaW4gdGhlIHByb2plY3QuXG4gKlxuICogQGV4YW1wbGUgYHZpdGUuY29uZmlnLnRzYFxuICogYGBgdHNcbiAqIGltcG9ydCB7IHJvb3RlZE1hbmlmZXN0IH0gZnJvbSAnQHJvb3RlZC9hcHBsaWNhdGlvbidcbiAqIGltcG9ydCB7IGdlbmVyYXRlUm91dGVNYW5pZmVzdCB9IGZyb20gJ0Byb290ZWQvcm91dGVyL21hbmlmZXN0J1xuICogaW1wb3J0IHsgZXhwcmVzc0FkYXB0ZXIgfSBmcm9tICdAcm9vdGVkLWFkYXB0ZXJzL2V4cHJlc3MnXG4gKlxuICogZXhwb3J0IGRlZmF1bHQgcm9vdGVkTWFuaWZlc3Qoe1xuICogICBwbHVnaW5zOiBbXG4gKiAgICAgZ2VuZXJhdGVSb3V0ZU1hbmlmZXN0KHsgZ2xvYjogJy4vc3JjLyoqXFwvX3JvdXRlcy5tdHMnLCByb290OiAnLi9zcmMvX3JvdXRlcy5nLm10cycgfSksXG4gKiAgICAgZXhwcmVzc0FkYXB0ZXIoKSxcbiAqICAgXSxcbiAqIH0pXG4gKiBgYGBcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGV4cHJlc3NBZGFwdGVyKG9wdGlvbnM/OiBFeHByZXNzQWRhcHRlck9wdGlvbnMpOiBQbHVnaW4ge1xuXHRyZXR1cm4gcm91dGVkQWRhcHRlcih7XG5cdFx0bmFtZTogJ3Jvb3RlZDpleHByZXNzJyxcblx0XHRyb3V0ZXM6IG9wdGlvbnM/LnJvdXRlcyxcblx0XHRhc3luYyBzZXR1cCh7IG91dHB1dERpcmVjdG9yeSB9KSB7XG5cdFx0XHRhd2FpdCB3cml0ZUZpbGUoXG5cdFx0XHRcdHBhdGguam9pbihvdXRwdXREaXJlY3RvcnksICdzZXJ2ZXIubWpzJyksXG5cdFx0XHRcdEVYUFJFU1NfU0VSVkVSX1RFTVBMQVRFLFxuXHRcdFx0XHQndXRmOCcsXG5cdFx0XHQpXG5cdFx0fSxcblx0fSlcbn1cblxuY29uc3QgRVhQUkVTU19TRVJWRVJfVEVNUExBVEUgPSBgXFxcbmltcG9ydCBleHByZXNzIGZyb20gJ2V4cHJlc3MnXG5pbXBvcnQgeyByZWFkRmlsZVN5bmMgfSBmcm9tICdub2RlOmZzJ1xuaW1wb3J0IHsgZmlsZVVSTFRvUGF0aCB9IGZyb20gJ25vZGU6dXJsJ1xuaW1wb3J0IHBhdGggZnJvbSAnbm9kZTpwYXRoJ1xuXG5jb25zdCBfX2Rpcm5hbWUgPSBwYXRoLmRpcm5hbWUoZmlsZVVSTFRvUGF0aChpbXBvcnQubWV0YS51cmwpKVxuY29uc3QgeyBiYXNlLCBkeW5hbWljUm91dGVzLCBmYWxsYmFjayB9ID0gSlNPTi5wYXJzZShcbiAgcmVhZEZpbGVTeW5jKHBhdGguam9pbihfX2Rpcm5hbWUsICdyb3V0ZXMuanNvbicpLCAndXRmOCcpXG4pXG5cbmNvbnN0IHByZWZpeCA9IGJhc2UucmVwbGFjZSgvXFxcXC8kLywgJycpXG5jb25zdCBhcHAgPSBleHByZXNzKClcblxuLy8gU2VydmVzIGFsbCBwcmUtcmVuZGVyZWQgSFRNTCBmaWxlcyBhbmQgc3RhdGljIGFzc2V0cyBhdXRvbWF0aWNhbGx5XG5hcHAudXNlKGJhc2UsIGV4cHJlc3Muc3RhdGljKF9fZGlybmFtZSkpXG5cbi8vIFBhcmFtZXRlcml6ZWQgcm91dGVzOiBFeHByZXNzIHVzZXMgdGhlIHNhbWUgOnBhcmFtIHN5bnRheCBhcyB0aGUgcm9vdGVkIHJvdXRlclxuZm9yIChjb25zdCByb3V0ZSBvZiBkeW5hbWljUm91dGVzKSB7XG4gIGFwcC5nZXQocHJlZml4ICsgcm91dGUsIChfcmVxLCByZXMpID0+XG4gICAgcmVzLnNlbmRGaWxlKHBhdGguam9pbihfX2Rpcm5hbWUsIGZhbGxiYWNrKSlcbiAgKVxufVxuXG4vLyBBbnl0aGluZyBlbHNlOiBTUEEgc2hlbGwgKGJyb3dzZXItc2lkZSByb3V0ZXIgc2hvd3MgdGhlIGNvcnJlY3QgY29udGVudCBvciA0MDQpXG5hcHAudXNlKChfcmVxLCByZXMpID0+IHJlcy5zZW5kRmlsZShwYXRoLmpvaW4oX19kaXJuYW1lLCBmYWxsYmFjaykpKVxuXG5jb25zdCBwb3J0ID0gTnVtYmVyKHByb2Nlc3MuZW52LlBPUlQgPz8gMzAwMClcbmFwcC5saXN0ZW4ocG9ydCwgJzAuMC4wLjAnLCAoKSA9PiBjb25zb2xlLmxvZyhcXGBMaXN0ZW5pbmcgb24gaHR0cDovLzAuMC4wLjA6XFwke3BvcnR9XFxgKSlcbmBcbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUErQ0EsU0FBZ0IsZUFBZSxTQUF5QztDQUN2RSxPQUFPLGNBQWM7RUFDcEIsTUFBTTtFQUNOLFFBQVEsU0FBUztFQUNqQixNQUFNLE1BQU0sRUFBRSxtQkFBbUI7R0FDaEMsTUFBTSxVQUNMLEtBQUssS0FBSyxpQkFBaUIsYUFBYSxFQUN4Qyx5QkFDQSxPQUNBOztFQUVGLENBQUM7O0FBR0gsTUFBTSwwQkFBMEIifQ==

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@rooted-adapters/express",
+  "version": "1.0.0-alpha.0",
+  "description": "Adapter for server-side hosting with Express",
+  "keywords": [
+    "web-components",
+    "typescript",
+    "rooted"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Marvin-Brouwer/rooted.git",
+    "directory": "packages/adapters/express"
+  },
+  "homepage": "https://github.com/Marvin-Brouwer/rooted#readme",
+  "bugs": "https://github.com/Marvin-Brouwer/rooted/issues",
+  "sideEffects": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    }
+  },
+  "peerDependencies": {
+    "express": ">= 5.0.0",
+    "vite": ">= 8.0.1",
+    "@rooted/adapter": "^1.0.0-alpha.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.2",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.12",
+    "@rooted/adapter": "^1.0.0-alpha.0",
+    "@rooted/tsdown": "^0.1.0",
+    "@rooted/development": "0.1.0"
+  },
+  "scripts": {
+    "build": "pnpm build:ci",
+    "build:dev": "pnpm build:ci",
+    "build:ci": "tsdown",
+    "watch": "tsdown --watch --no-clean",
+    "clean": "rm -rf dist"
+  }
+}

package/readme.md

@@ -0,0 +1,30 @@
+# [`@rooted-adapters/express`](https://www.npmjs.com/package/@rooted-adapters/express)
+
+Deployment adapter for server-side hosting with Express. Part of the [`@rooted/*`](https://github.com/Marvin-Brouwer/rooted#rooted) framework.
+
+Writes `routes.json` and a ready-to-run `server.mjs` to the output directory. Start the server with `node dist/server.mjs`. The `PORT` environment variable controls the port (default: 3000).
+
+Requires `express >= 5.0.0`.
+
+> [!IMPORTANT]
+> This package is still in alpha.
+
+```sh
+pnpm add -D @rooted-adapters/express
+```
+
+```ts
+// vite.config.mts
+import { rootedManifest } from '@rooted/application'
+import { generateRouteManifest } from '@rooted/router/manifest'
+import { expressAdapter } from '@rooted-adapters/express'
+
+export default rootedManifest({
+  plugins: [
+    generateRouteManifest({ glob: './src/**/_routes.mts', routeManifestPath: './src/_routes.g.mts' }),
+    expressAdapter(),
+  ],
+})
+```
+
+More in the [adapters guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/guide/adapters.md).