@rooted-adapters/express 1.0.0-alpha.0 → 1.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/express.d.mts +81 -0
  2. package/dist/express.mjs +109 -0
  3. package/dist/middleware-BkXcT-qH.d.mts +31 -0
  4. package/dist/middleware.d.mts +2 -0
  5. package/dist/middleware.mjs +28 -0
  6. package/package.json +71 -63
  7. package/readme.md +24 -0
  8. package/LICENSE +0 -21
  9. package/dist/index.d.mts +0 -46
  10. package/dist/index.mjs +0 -75
package/dist/express.d.mts ADDED
@@ -0,0 +1,81 @@
1
+ import { t as ExpressMiddleware } from "./middleware-BkXcT-qH.mjs";
2
+ import { AdapterRoutes } from "@rooted/adapter";
3
+ import { Plugin } from "vite";
4
+ //#region src/adapter.d.mts
5
+ /**
6
+ * Options for {@link expressAdapter}.
7
+ */
8
+ export type ExpressAdapterOptions = {
9
+ /**
10
+ * Manual route list for projects that don't use `generateRouteManifest`.
11
+ * See {@link AdapterRoutes}.
12
+ */
13
+ routes?: AdapterRoutes;
14
+ /**
15
+ * Path to a folder of middleware files, relative to the Vite project root.
16
+ * Files can be `.mts`, `.ts`, `.mjs`, or `.js` -- TypeScript is transpiled with
17
+ * rolldown at build time. Each file must export a default `function(app)` that
18
+ * registers middleware on the Express instance. Files are loaded in lexicographic
19
+ * order, so numeric prefixes (`01-auth.mts`, `02-proxy.mts`) control load order.
20
+ * Middleware runs before the rooted static-file and route handlers.
21
+ *
22
+ * The same files also run during `vite dev` and `vite preview`, on Vite's own
23
+ * port, so you don't need a second process to reach them. Dev loads the
24
+ * sources through Vite, preview runs the built `dist/middleware/*.mjs`.
25
+ * See the [server middleware guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/advanced/server-middleware.md).
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * expressAdapter({ middlewarePath: './src/server-middleware' })
30
+ * ```
31
+ *
32
+ * ```ts
33
+ * // src/server-middleware/01-api-proxy.mts
34
+ * import { createMiddleware } from '@rooted-adapters/express/middleware'
35
+ * import { createProxyMiddleware } from 'http-proxy-middleware'
36
+ *
37
+ * export default createMiddleware((app) => {
38
+ * app.use('/api', createProxyMiddleware({ target: process.env.API_URL }))
39
+ * })
40
+ * ```
41
+ */
42
+ middlewarePath?: string;
43
+ };
44
+ /**
45
+ * Adapter for server-side hosting with Express.
46
+ *
47
+ * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
48
+ * The server uses `express.static` to serve pre-rendered HTML files and registers
49
+ * explicit handlers for parameterized routes (which serve the `404.html` SPA shell
50
+ * so the browser-side router renders the correct content). Express uses the same
51
+ * `:param` syntax as the rooted router, so patterns map directly.
52
+ *
53
+ * Users start the server with `node dist/server.mjs`. The `PORT` environment variable
54
+ * controls the port (default: 3000).
55
+ *
56
+ * Returns several plugins: the build-time adapter, the not-found handler that
57
+ * gives `vite dev` and `vite preview` the same 404s and redirects as the
58
+ * generated server, and one that runs `middlewarePath` on Vite's own port. Vite
59
+ * flattens nested plugin arrays, so it still goes straight into `plugins` as
60
+ * one entry.
61
+ *
62
+ * Requires `express >= 5.0.0` in the project.
63
+ *
64
+ * @example `vite.config.ts`
65
+ * ```ts
66
+ * import { rootedManifest } from '@rooted/application'
67
+ * import { generateRouteManifest } from '@rooted/router/manifest'
68
+ * import { expressAdapter } from '@rooted-adapters/express/middleware'
69
+ *
70
+ * export default rootedManifest({
71
+ * plugins: [
72
+ * generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
73
+ * expressAdapter(),
74
+ * ],
75
+ * })
76
+ * ```
77
+ */
78
+ export declare function expressAdapter(options?: ExpressAdapterOptions): Plugin[];
79
+ //#endregion
80
+ export type { ExpressMiddleware };
81
+ //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXhwcmVzcy5kLm10cyIsIm5hbWVzIjpbXSwic291cmNlcyI6WyIuLi9zcmMvYWRhcHRlci5tdHMiXSwibWFwcGluZ3MiOiI7Ozs7Ozs7WUFlWTs7Ozs7RUFLWCxTQUFTOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztFQTZCVDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O3dCQXFDZSxlQUFlLFVBQVUsd0JBQXdCIn0=
package/dist/express.mjs ADDED
@@ -0,0 +1,109 @@
1
+ import { writeFile } from "node:fs/promises";
2
+ import path from "node:path";
3
+ import { buildMiddlewareBlock, buildServerPreamble, routedAdapter } from "@rooted/adapter";
4
+ //#region src/development-server.mts
5
+ /**
6
+ * Builds the Express instance that runs the `middlewarePath` files during
7
+ * `vite dev` and `vite preview`. Anything Express has no route for falls back
8
+ * to Vite.
9
+ */
10
+ async function createExpressServer(middleware) {
11
+ const { default: express } = await import("express");
12
+ const app = express();
13
+ for (const register of middleware) await register(app);
14
+ return { handle: app };
15
+ }
16
+ //#endregion
17
+ //#region src/server-template.mts
18
+ /**
19
+ * Builds the `server.mjs` that ships in the output directory. Everything up to
20
+ * the Express instance is shared with the other node adapters; what follows is
21
+ * the part only Express does.
22
+ */
23
+ function buildExpressTemplate(hasMiddleware) {
24
+ return `${buildServerPreamble({
25
+ frameworkImports: `import express from 'express'`,
26
+ hasMiddleware
27
+ })}const app = express()
28
+ ${buildMiddlewareBlock(hasMiddleware)}
29
+ // Canonical slash, after your middleware so an API route it owns is never
30
+ // redirected out from under it.
31
+ app.use((req, res, next) => {
32
+ const target = (req.method === 'GET' || req.method === 'HEAD') ? canonicalRedirect(req.url) : undefined
33
+ if (target) return res.redirect(301, target)
34
+ next()
35
+ })
36
+
37
+ // Serves all pre-rendered HTML files and static assets automatically
38
+ app.use(base, express.static(__dirname))
39
+
40
+ // Parameterized routes: Express uses the same :param syntax as the rooted router
41
+ for (const route of dynamicRoutes) {
42
+ app.get(prefix + route, (_req, res) =>
43
+ res.status(200).type('html').send(fallbackHtml)
44
+ )
45
+ }
46
+
47
+ // Anything else is a real 404. Navigations still get the SPA shell so the
48
+ // browser-side router can render a 404 page; everything else gets an empty
49
+ // body, because answering an image request with HTML only confuses things.
50
+ app.use((req, res) => {
51
+ if (!(req.headers.accept ?? '').includes('text/html')) return res.status(404).end()
52
+ res.status(404).type('html').send(fallbackHtml)
53
+ })
54
+
55
+ const port = Number(process.env.PORT ?? 3000)
56
+ app.listen(port, '0.0.0.0', () => console.log(\`Listening on http://0.0.0.0:\${port}\`))
57
+ `;
58
+ }
59
+ //#endregion
60
+ //#region src/adapter.mts
61
+ /**
62
+ * Adapter for server-side hosting with Express.
63
+ *
64
+ * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
65
+ * The server uses `express.static` to serve pre-rendered HTML files and registers
66
+ * explicit handlers for parameterized routes (which serve the `404.html` SPA shell
67
+ * so the browser-side router renders the correct content). Express uses the same
68
+ * `:param` syntax as the rooted router, so patterns map directly.
69
+ *
70
+ * Users start the server with `node dist/server.mjs`. The `PORT` environment variable
71
+ * controls the port (default: 3000).
72
+ *
73
+ * Returns several plugins: the build-time adapter, the not-found handler that
74
+ * gives `vite dev` and `vite preview` the same 404s and redirects as the
75
+ * generated server, and one that runs `middlewarePath` on Vite's own port. Vite
76
+ * flattens nested plugin arrays, so it still goes straight into `plugins` as
77
+ * one entry.
78
+ *
79
+ * Requires `express >= 5.0.0` in the project.
80
+ *
81
+ * @example `vite.config.ts`
82
+ * ```ts
83
+ * import { rootedManifest } from '@rooted/application'
84
+ * import { generateRouteManifest } from '@rooted/router/manifest'
85
+ * import { expressAdapter } from '@rooted-adapters/express/middleware'
86
+ *
87
+ * export default rootedManifest({
88
+ * plugins: [
89
+ * generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
90
+ * expressAdapter(),
91
+ * ],
92
+ * })
93
+ * ```
94
+ */
95
+ function expressAdapter(options) {
96
+ return routedAdapter({
97
+ name: "rooted:express",
98
+ routes: options?.routes,
99
+ middlewarePath: options?.middlewarePath,
100
+ createServer: createExpressServer,
101
+ async setup({ outputDirectory }) {
102
+ await writeFile(path.join(outputDirectory, "server.mjs"), buildExpressTemplate(!!options?.middlewarePath), "utf8");
103
+ }
104
+ });
105
+ }
106
+ //#endregion
107
+ export { expressAdapter };
108
+
109
+ //# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"file":"express.mjs","names":[],"sources":["../src/development-server.mts","../src/server-template.mts","../src/adapter.mts"],"sourcesContent":["import type { NodeMiddlewareHandler } from '@rooted/adapter'\nimport type { Express } from 'express'\nimport type { Connect } from 'vite'\n\n/**\n * Builds the Express instance that runs the `middlewarePath` files during\n * `vite dev` and `vite preview`. Anything Express has no route for falls back\n * to Vite.\n */\nexport async function createExpressServer(\n\tmiddleware: ReadonlyArray<(app: Express) => Promise<void>>,\n): Promise<NodeMiddlewareHandler> {\n\tconst { default: express } = await import('express')\n\tconst app = express()\n\n\tfor (const register of middleware) await register(app)\n\n\t// An Express app is already a connect handler. Handed a third\n\t// argument its router calls that instead of sending its own 404, so\n\t// unmatched paths fall through. The cast is because the types only\n\t// declare the two-argument form.\n\treturn { handle: app as unknown as Connect.NextHandleFunction }\n}\n","import { buildMiddlewareBlock, buildServerPreamble } from '@rooted/adapter'\n\n/**\n * Builds the `server.mjs` that ships in the output directory. Everything up to\n * the Express instance is shared with the other node adapters; what follows is\n * the part only Express does.\n */\nexport function buildExpressTemplate(hasMiddleware: boolean): string {\n\tconst preamble = buildServerPreamble({\n\t\tframeworkImports: `import express from 'express'`,\n\t\thasMiddleware,\n\t})\n\n\treturn `${preamble}const app = express()\n${buildMiddlewareBlock(hasMiddleware)}\n// Canonical slash, after your middleware so an API route it owns is never\n// redirected out from under it.\napp.use((req, res, next) => {\n  const target = (req.method === 'GET' || req.method === 'HEAD') ? canonicalRedirect(req.url) : undefined\n  if (target) return res.redirect(301, target)\n  next()\n})\n\n// Serves all pre-rendered HTML files and static assets automatically\napp.use(base, express.static(__dirname))\n\n// Parameterized routes: Express uses the same :param syntax as the rooted router\nfor (const route of dynamicRoutes) {\n  app.get(prefix + route, (_req, res) =>\n    res.status(200).type('html').send(fallbackHtml)\n  )\n}\n\n// Anything else is a real 404. Navigations still get the SPA shell so the\n// browser-side router can render a 404 page; everything else gets an empty\n// body, because answering an image request with HTML only confuses things.\napp.use((req, res) => {\n  if (!(req.headers.accept ?? '').includes('text/html')) return res.status(404).end()\n  res.status(404).type('html').send(fallbackHtml)\n})\n\nconst port = Number(process.env.PORT ?? 3000)\napp.listen(port, '0.0.0.0', () => console.log(\\`Listening on http://0.0.0.0:\\${port}\\`))\n`\n}\n","import { writeFile } from 'node:fs/promises'\nimport path from 'node:path'\n\nimport { routedAdapter } from '@rooted/adapter'\n\nimport { createExpressServer } from './development-server.mts'\nimport { buildExpressTemplate } from './server-template.mts'\n\nimport type { AdapterRoutes } from '@rooted/adapter'\nimport type { Express } from 'express'\nimport type { Plugin } from 'vite'\n\n/**\n * Options for {@link expressAdapter}.\n */\nexport type ExpressAdapterOptions = {\n\t/**\n\t * Manual route list for projects that don't use `generateRouteManifest`.\n\t * See {@link AdapterRoutes}.\n\t */\n\troutes?: AdapterRoutes\n\t/**\n\t * Path to a folder of middleware files, relative to the Vite project root.\n\t * Files can be `.mts`, `.ts`, `.mjs`, or `.js` -- TypeScript is transpiled with\n\t * rolldown at build time. Each file must export a default `function(app)` that\n\t * registers middleware on the Express instance. Files are loaded in lexicographic\n\t * order, so numeric prefixes (`01-auth.mts`, `02-proxy.mts`) control load order.\n\t * Middleware runs before the rooted static-file and route handlers.\n\t *\n\t * The same files also run during `vite dev` and `vite preview`, on Vite's own\n\t * port, so you don't need a second process to reach them. Dev loads the\n\t * sources through Vite, preview runs the built `dist/middleware/*.mjs`.\n\t * See the [server middleware guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/advanced/server-middleware.md).\n\t *\n\t * @example\n\t * ```ts\n\t * expressAdapter({ middlewarePath: './src/server-middleware' })\n\t * ```\n\t *\n\t * ```ts\n\t * // src/server-middleware/01-api-proxy.mts\n\t * import { createMiddleware } from '@rooted-adapters/express/middleware'\n\t * import { createProxyMiddleware } from 'http-proxy-middleware'\n\t *\n\t * export default createMiddleware((app) => {\n\t *   app.use('/api', createProxyMiddleware({ target: process.env.API_URL }))\n\t * })\n\t * ```\n\t */\n\tmiddlewarePath?: string\n}\n\n/**\n * Adapter for server-side hosting with Express.\n *\n * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.\n * The server uses `express.static` to serve pre-rendered HTML files and registers\n * explicit handlers for parameterized routes (which serve the `404.html` SPA shell\n * so the browser-side router renders the correct content). Express uses the same\n * `:param` syntax as the rooted router, so patterns map directly.\n *\n * Users start the server with `node dist/server.mjs`. The `PORT` environment variable\n * controls the port (default: 3000).\n *\n * Returns several plugins: the build-time adapter, the not-found handler that\n * gives `vite dev` and `vite preview` the same 404s and redirects as the\n * generated server, and one that runs `middlewarePath` on Vite's own port. Vite\n * flattens nested plugin arrays, so it still goes straight into `plugins` as\n * one entry.\n *\n * Requires `express >= 5.0.0` in the project.\n *\n * @example `vite.config.ts`\n * ```ts\n * import { rootedManifest } from '@rooted/application'\n * import { generateRouteManifest } from '@rooted/router/manifest'\n * import { expressAdapter } from '@rooted-adapters/express/middleware'\n *\n * export default rootedManifest({\n *   plugins: [\n *     generateRouteManifest({ glob: './src/**\\/_routes.mts', root: './src/_routes.g.mts' }),\n *     expressAdapter(),\n *   ],\n * })\n * ```\n */\nexport function expressAdapter(options?: ExpressAdapterOptions): Plugin[] {\n\treturn routedAdapter<Express>({\n\t\tname: 'rooted:express',\n\t\troutes: options?.routes,\n\t\tmiddlewarePath: options?.middlewarePath,\n\t\tcreateServer: createExpressServer,\n\t\tasync setup({ outputDirectory }) {\n\t\t\tawait writeFile(\n\t\t\t\tpath.join(outputDirectory, 'server.mjs'),\n\t\t\t\tbuildExpressTemplate(!!options?.middlewarePath),\n\t\t\t\t'utf8',\n\t\t\t)\n\t\t},\n\t})\n}\n"],"mappings":";;;;;;;;;AASA,eAAsB,oBACrB,YACiC;CACjC,MAAM,EAAE,SAAS,YAAY,MAAM,OAAO;CAC1C,MAAM,MAAM,QAAQ;CAEpB,KAAK,MAAM,YAAY,YAAY,MAAM,SAAS,GAAG;CAMrD,OAAO,EAAE,QAAQ,IAA6C;AAC/D;;;;;;;;ACfA,SAAgB,qBAAqB,eAAgC;CAMpE,OAAO,GALU,oBAAoB;EACpC,kBAAkB;EAClB;CACD,CAEiB,EAAE;EAClB,qBAAqB,aAAa,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC0CA,SAAgB,eAAe,SAA2C;CACzE,OAAO,cAAuB;EAC7B,MAAM;EACN,QAAQ,SAAS;EACjB,gBAAgB,SAAS;EACzB,cAAc;EACd,MAAM,MAAM,EAAE,mBAAmB;GAChC,MAAM,UACL,KAAK,KAAK,iBAAiB,YAAY,GACvC,qBAAqB,CAAC,CAAC,SAAS,cAAc,GAC9C,MACD;EACD;CACD,CAAC;AACF"}
package/dist/middleware-BkXcT-qH.d.mts ADDED
@@ -0,0 +1,31 @@
1
+ import { Express } from "express";
2
+ //#region src/middleware.d.mts
3
+ /**
4
+ * An Express middleware function for use with the adapter's `middlewarePath`.
5
+ * Receives the Express instance and may register middleware or routes on it.
6
+ */
7
+ type ExpressMiddleware = (app: Express) => Promise<void> | void;
8
+ /**
9
+ * Identity helper that types a middleware function for the express adapter.
10
+ * Use it as the default export of a file under your `middlewarePath` folder so
11
+ * editors pick up the Express instance type without extra annotations.
12
+ *
13
+ * It's imported from `@rooted-adapters/express/middleware` rather than the
14
+ * package root on purpose: the root is the Vite plugin, and your middleware
15
+ * files get run by the server, not by Vite.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * // src/server-middleware/01-api-proxy.mts
20
+ * import { createMiddleware } from '@rooted-adapters/express/middleware'
21
+ * import { createProxyMiddleware } from 'http-proxy-middleware'
22
+ *
23
+ * export default createMiddleware((app) => {
24
+ * app.use('/api', createProxyMiddleware({ target: process.env.API_URL }))
25
+ * })
26
+ * ```
27
+ */
28
+ declare function createMiddleware(handler: ExpressMiddleware): ExpressMiddleware;
29
+ //#endregion
30
+ export { createMiddleware as n, ExpressMiddleware as t };
31
+ //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS1Ca1hjVC1xSC5kLm10cyIsIm5hbWVzIjpbXSwic291cmNlcyI6WyIuLi9zcmMvbWlkZGxld2FyZS5tdHMiXSwibWFwcGluZ3MiOiI7Ozs7OztLQVVZLHFCQUFxQixLQUFLLFlBQVk7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztpQkFzQmxDLGlCQUFpQixTQUFTLG9CQUFvQiJ9
package/dist/middleware.d.mts ADDED
@@ -0,0 +1,2 @@
1
+ import { n as createMiddleware, t as ExpressMiddleware } from "./middleware-BkXcT-qH.mjs";
2
+ export { ExpressMiddleware, createMiddleware };
package/dist/middleware.mjs ADDED
@@ -0,0 +1,28 @@
1
+ //#region src/middleware.mts
2
+ /**
3
+ * Identity helper that types a middleware function for the express adapter.
4
+ * Use it as the default export of a file under your `middlewarePath` folder so
5
+ * editors pick up the Express instance type without extra annotations.
6
+ *
7
+ * It's imported from `@rooted-adapters/express/middleware` rather than the
8
+ * package root on purpose: the root is the Vite plugin, and your middleware
9
+ * files get run by the server, not by Vite.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * // src/server-middleware/01-api-proxy.mts
14
+ * import { createMiddleware } from '@rooted-adapters/express/middleware'
15
+ * import { createProxyMiddleware } from 'http-proxy-middleware'
16
+ *
17
+ * export default createMiddleware((app) => {
18
+ * app.use('/api', createProxyMiddleware({ target: process.env.API_URL }))
19
+ * })
20
+ * ```
21
+ */
22
+ function createMiddleware(handler) {
23
+ return handler;
24
+ }
25
+ //#endregion
26
+ export { createMiddleware };
27
+
28
+ //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5tanMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL21pZGRsZXdhcmUubXRzIl0sInNvdXJjZXNDb250ZW50IjpbIi8vIERlbGliZXJhdGVseSBmcmVlIG9mIHJ1bnRpbWUgaW1wb3J0cy4gVGhpcyBtb2R1bGUgaXMgbG9hZGVkIGJ5IHRoZSBidWlsdFxuLy8gc2VydmVyIGFuZCBieSBhbnl0aGluZyBlbHNlIHRoYXQgcnVucyBhIG1pZGRsZXdhcmUgZmlsZSwgc28gcHVsbGluZyBpbiB0aGVcbi8vIFZpdGUgcGx1Z2luIChhbmQgdGhyb3VnaCBpdCBAcm9vdGVkL2FkYXB0ZXIgYW5kIGhhcHB5LWRvbSkgd291bGQgYmUgZGVhZFxuLy8gd2VpZ2h0IGF0IHN0YXJ0dXAuIEtlZXAgZXZlcnkgaW1wb3J0IGluIGhlcmUgdHlwZS1vbmx5LlxuaW1wb3J0IHR5cGUgeyBFeHByZXNzIH0gZnJvbSAnZXhwcmVzcydcblxuLyoqXG4gKiBBbiBFeHByZXNzIG1pZGRsZXdhcmUgZnVuY3Rpb24gZm9yIHVzZSB3aXRoIHRoZSBhZGFwdGVyJ3MgYG1pZGRsZXdhcmVQYXRoYC5cbiAqIFJlY2VpdmVzIHRoZSBFeHByZXNzIGluc3RhbmNlIGFuZCBtYXkgcmVnaXN0ZXIgbWlkZGxld2FyZSBvciByb3V0ZXMgb24gaXQuXG4gKi9cbmV4cG9ydCB0eXBlIEV4cHJlc3NNaWRkbGV3YXJlID0gKGFwcDogRXhwcmVzcykgPT4gUHJvbWlzZTx2b2lkPiB8IHZvaWRcblxuLyoqXG4gKiBJZGVudGl0eSBoZWxwZXIgdGhhdCB0eXBlcyBhIG1pZGRsZXdhcmUgZnVuY3Rpb24gZm9yIHRoZSBleHByZXNzIGFkYXB0ZXIuXG4gKiBVc2UgaXQgYXMgdGhlIGRlZmF1bHQgZXhwb3J0IG9mIGEgZmlsZSB1bmRlciB5b3VyIGBtaWRkbGV3YXJlUGF0aGAgZm9sZGVyIHNvXG4gKiBlZGl0b3JzIHBpY2sgdXAgdGhlIEV4cHJlc3MgaW5zdGFuY2UgdHlwZSB3aXRob3V0IGV4dHJhIGFubm90YXRpb25zLlxuICpcbiAqIEl0J3MgaW1wb3J0ZWQgZnJvbSBgQHJvb3RlZC1hZGFwdGVycy9leHByZXNzL21pZGRsZXdhcmVgIHJhdGhlciB0aGFuIHRoZVxuICogcGFja2FnZSByb290IG9uIHB1cnBvc2U6IHRoZSByb290IGlzIHRoZSBWaXRlIHBsdWdpbiwgYW5kIHlvdXIgbWlkZGxld2FyZVxuICogZmlsZXMgZ2V0IHJ1biBieSB0aGUgc2VydmVyLCBub3QgYnkgVml0ZS5cbiAqXG4gKiBAZXhhbXBsZVxuICogYGBgdHNcbiAqIC8vIHNyYy9zZXJ2ZXItbWlkZGxld2FyZS8wMS1hcGktcHJveHkubXRzXG4gKiBpbXBvcnQgeyBjcmVhdGVNaWRkbGV3YXJlIH0gZnJvbSAnQHJvb3RlZC1hZGFwdGVycy9leHByZXNzL21pZGRsZXdhcmUnXG4gKiBpbXBvcnQgeyBjcmVhdGVQcm94eU1pZGRsZXdhcmUgfSBmcm9tICdodHRwLXByb3h5LW1pZGRsZXdhcmUnXG4gKlxuICogZXhwb3J0IGRlZmF1bHQgY3JlYXRlTWlkZGxld2FyZSgoYXBwKSA9PiB7XG4gKiAgIGFwcC51c2UoJy9hcGknLCBjcmVhdGVQcm94eU1pZGRsZXdhcmUoeyB0YXJnZXQ6IHByb2Nlc3MuZW52LkFQSV9VUkwgfSkpXG4gKiB9KVxuICogYGBgXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBjcmVhdGVNaWRkbGV3YXJlKGhhbmRsZXI6IEV4cHJlc3NNaWRkbGV3YXJlKTogRXhwcmVzc01pZGRsZXdhcmUge1xuXHRyZXR1cm4gaGFuZGxlclxufVxuIl0sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFnQ0EsU0FBZ0IsaUJBQWlCLFNBQStDO0NBQy9FLE9BQU87QUFDUiJ9
package/package.json CHANGED
@@ -1,64 +1,72 @@
1
1
  {
2
- "name": "@rooted-adapters/express",
3
- "version": "1.0.0-alpha.0",
4
- "description": "Adapter for server-side hosting with Express",
5
- "keywords": [
6
- "web-components",
7
- "typescript",
8
- "rooted"
9
- ],
10
- "license": "MIT",
11
- "repository": {
12
- "type": "git",
13
- "url": "git+https://github.com/Marvin-Brouwer/rooted.git",
14
- "directory": "packages/adapters/express"
15
- },
16
- "homepage": "https://github.com/Marvin-Brouwer/rooted#readme",
17
- "bugs": "https://github.com/Marvin-Brouwer/rooted/issues",
18
- "sideEffects": false,
19
- "publishConfig": {
20
- "registry": "https://registry.npmjs.org/",
21
- "access": "public",
22
- "provenance": true
23
- },
24
- "files": [
25
- "dist",
26
- "readme.md"
27
- ],
28
- "engines": {
29
- "node": ">=22.0.0",
30
- "pnpm": ">=10.0.0"
31
- },
32
- "exports": {
33
- ".": {
34
- "import": "./dist/index.mjs",
35
- "types": "./dist/index.d.mts"
36
- }
37
- },
38
- "peerDependencies": {
39
- "express": ">= 5.0.0",
40
- "vite": ">= 8.0.1",
41
- "@rooted/adapter": "^1.0.0-alpha.0"
42
- },
43
- "peerDependenciesMeta": {
44
- "express": {
45
- "optional": false
46
- }
47
- },
48
- "devDependencies": {
49
- "@types/node": "^25.6.2",
50
- "tsx": "^4.21.0",
51
- "typescript": "^6.0.3",
52
- "vite": "^8.0.12",
53
- "@rooted/adapter": "^1.0.0-alpha.0",
54
- "@rooted/tsdown": "^0.1.0",
55
- "@rooted/development": "0.1.0"
56
- },
57
- "scripts": {
58
- "build": "pnpm build:ci",
59
- "build:dev": "pnpm build:ci",
60
- "build:ci": "tsdown",
61
- "watch": "tsdown --watch --no-clean",
62
- "clean": "rm -rf dist"
63
- }
64
- }
2
+ "name": "@rooted-adapters/express",
3
+ "version": "1.0.0-alpha.10",
4
+ "description": "Adapter for server-side hosting with Express",
5
+ "keywords": [
6
+ "web-components",
7
+ "typescript",
8
+ "rooted"
9
+ ],
10
+ "license": "MIT",
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/Marvin-Brouwer/rooted.git",
14
+ "directory": "packages/adapters/express"
15
+ },
16
+ "homepage": "https://github.com/Marvin-Brouwer/rooted#readme",
17
+ "bugs": "https://github.com/Marvin-Brouwer/rooted/issues",
18
+ "sideEffects": false,
19
+ "publishConfig": {
20
+ "registry": "https://registry.npmjs.org/",
21
+ "access": "public",
22
+ "provenance": true
23
+ },
24
+ "files": [
25
+ "dist",
26
+ "readme.md"
27
+ ],
28
+ "engines": {
29
+ "node": ">=22.0.0",
30
+ "pnpm": ">=10.0.0"
31
+ },
32
+ "exports": {
33
+ ".": {
34
+ "source": "./src/_module/express.mts",
35
+ "import": "./dist/express.mjs",
36
+ "types": "./dist/express.d.mts"
37
+ },
38
+ "./middleware": {
39
+ "source": "./src/_module/middleware.mts",
40
+ "import": "./dist/middleware.mjs",
41
+ "types": "./dist/middleware.d.mts"
42
+ }
43
+ },
44
+ "peerDependencies": {
45
+ "@rooted/adapter": "1.0.0-alpha.10",
46
+ "express": ">= 5.0.0",
47
+ "rolldown": ">= 1.0.0",
48
+ "vite": ">= 8.0.1"
49
+ },
50
+ "peerDependenciesMeta": {
51
+ "express": {
52
+ "optional": false
53
+ }
54
+ },
55
+ "devDependencies": {
56
+ "@rooted/adapter": "1.0.0-alpha.10",
57
+ "@rooted/development": "workspace:*",
58
+ "@rooted/tsdown": "workspace:^",
59
+ "@types/express": "^5.0.6",
60
+ "@types/node": "^26.4.1",
61
+ "tsx": "^4.23.13",
62
+ "typescript": "^6.0.3",
63
+ "vite": "^8.2.2"
64
+ },
65
+ "scripts": {
66
+ "build": "pnpm build:ci",
67
+ "build:dev": "pnpm build:ci",
68
+ "build:ci": "tsdown",
69
+ "watch": "tsdown --watch --no-clean",
70
+ "clean": "rm -rf dist"
71
+ }
72
+ }
package/readme.md CHANGED
@@ -27,4 +27,28 @@ export default rootedManifest({
27
27
  })
28
28
  ```
29
29
 
30
+ ## Adding middleware
31
+
32
+ If you need to register Express middleware (proxies, auth, rate-limiting), point `middlewarePath` at a folder of `.mjs` files. Use the `createMiddleware` helper so editors pick up the Express instance type. It comes from the `/middleware` subpath, which carries no dependencies, so your middleware files don't load the Vite plugin at runtime:
33
+
34
+ ```ts
35
+ expressAdapter({ middlewarePath: './src/server-middleware' })
36
+ ```
37
+
38
+ ```ts
39
+ // src/server-middleware/01-api-proxy.mts
40
+ import { createMiddleware } from '@rooted-adapters/express/middleware'
41
+ import { createProxyMiddleware } from 'http-proxy-middleware'
42
+
43
+ export default createMiddleware((app) => {
44
+ app.use('/api', createProxyMiddleware({ target: process.env.API_URL }))
45
+ })
46
+ ```
47
+
48
+ Files can be `.mts`, `.ts`, `.mjs`, or `.js` -- TypeScript is transpiled with rolldown at build time.
49
+
50
+ The same files run during `vite dev` and `vite preview` too, inside Vite's own process and on Vite's own port. No second entry point and no `server.proxy` entry. Anything the framework has no route for falls through to Vite.
51
+
52
+ Full details in [advanced/server-middleware](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/advanced/server-middleware.md).
53
+
30
54
  More in the [adapters guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/guide/adapters.md).
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 Marvin Brouwer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
package/dist/index.d.mts DELETED
@@ -1,46 +0,0 @@
1
- import { AdapterRoutes } from "@rooted/adapter";
2
- import { Plugin } from "vite";
3
-
4
- //#region src/index.d.mts
5
- /**
6
- * Options for {@link expressAdapter}.
7
- */
8
- type ExpressAdapterOptions = {
9
- /**
10
- * Manual route list for projects that don't use `generateRouteManifest`.
11
- * See {@link AdapterRoutes}.
12
- */
13
- routes?: AdapterRoutes;
14
- };
15
- /**
16
- * Adapter for server-side hosting with Express.
17
- *
18
- * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
19
- * The server uses `express.static` to serve pre-rendered HTML files and registers
20
- * explicit handlers for parameterized routes (which serve the `404.html` SPA shell
21
- * so the browser-side router renders the correct content). Express uses the same
22
- * `:param` syntax as the rooted router, so patterns map directly.
23
- *
24
- * Users start the server with `node dist/server.mjs`. The `PORT` environment variable
25
- * controls the port (default: 3000).
26
- *
27
- * Requires `express >= 5.0.0` in the project.
28
- *
29
- * @example `vite.config.ts`
30
- * ```ts
31
- * import { rootedManifest } from '@rooted/application'
32
- * import { generateRouteManifest } from '@rooted/router/manifest'
33
- * import { expressAdapter } from '@rooted-adapters/express'
34
- *
35
- * export default rootedManifest({
36
- * plugins: [
37
- * generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
38
- * expressAdapter(),
39
- * ],
40
- * })
41
- * ```
42
- */
43
- declare function expressAdapter(options?: ExpressAdapterOptions): Plugin;
44
- //#endregion
45
- export { ExpressAdapterOptions, expressAdapter };
46
- //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC5tdHMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL2luZGV4Lm10cyJdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBV0E7S0FBWSxxQkFBQTs7OztBQW9DWjtFQS9CQyxNQUFBLEdBQVMsYUFBQTtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztpQkErQk0sY0FBQSxDQUFlLE9BQUEsR0FBVSxxQkFBQSxHQUF3QixNQUFBIn0=
package/dist/index.mjs DELETED
@@ -1,75 +0,0 @@
1
- import { writeFile } from "node:fs/promises";
2
- import path from "node:path";
3
- import { routedAdapter } from "@rooted/adapter";
4
- //#region src/index.mts
5
- /**
6
- * Adapter for server-side hosting with Express.
7
- *
8
- * Writes `routes.json` and a ready-to-run `server.mjs` to the output directory.
9
- * The server uses `express.static` to serve pre-rendered HTML files and registers
10
- * explicit handlers for parameterized routes (which serve the `404.html` SPA shell
11
- * so the browser-side router renders the correct content). Express uses the same
12
- * `:param` syntax as the rooted router, so patterns map directly.
13
- *
14
- * Users start the server with `node dist/server.mjs`. The `PORT` environment variable
15
- * controls the port (default: 3000).
16
- *
17
- * Requires `express >= 5.0.0` in the project.
18
- *
19
- * @example `vite.config.ts`
20
- * ```ts
21
- * import { rootedManifest } from '@rooted/application'
22
- * import { generateRouteManifest } from '@rooted/router/manifest'
23
- * import { expressAdapter } from '@rooted-adapters/express'
24
- *
25
- * export default rootedManifest({
26
- * plugins: [
27
- * generateRouteManifest({ glob: './src/**\/_routes.mts', root: './src/_routes.g.mts' }),
28
- * expressAdapter(),
29
- * ],
30
- * })
31
- * ```
32
- */
33
- function expressAdapter(options) {
34
- return routedAdapter({
35
- name: "rooted:express",
36
- routes: options?.routes,
37
- async setup({ outputDirectory }) {
38
- await writeFile(path.join(outputDirectory, "server.mjs"), EXPRESS_SERVER_TEMPLATE, "utf8");
39
- }
40
- });
41
- }
42
- const EXPRESS_SERVER_TEMPLATE = `\
43
- import express from 'express'
44
- import { readFileSync } from 'node:fs'
45
- import { fileURLToPath } from 'node:url'
46
- import path from 'node:path'
47
-
48
- const __dirname = path.dirname(fileURLToPath(import.meta.url))
49
- const { base, dynamicRoutes, fallback } = JSON.parse(
50
- readFileSync(path.join(__dirname, 'routes.json'), 'utf8')
51
- )
52
-
53
- const prefix = base.replace(/\\/$/, '')
54
- const app = express()
55
-
56
- // Serves all pre-rendered HTML files and static assets automatically
57
- app.use(base, express.static(__dirname))
58
-
59
- // Parameterized routes: Express uses the same :param syntax as the rooted router
60
- for (const route of dynamicRoutes) {
61
- app.get(prefix + route, (_req, res) =>
62
- res.sendFile(path.join(__dirname, fallback))
63
- )
64
- }
65
-
66
- // Anything else: SPA shell (browser-side router shows the correct content or 404)
67
- app.use((_req, res) => res.sendFile(path.join(__dirname, fallback)))
68
-
69
- const port = Number(process.env.PORT ?? 3000)
70
- app.listen(port, '0.0.0.0', () => console.log(\`Listening on http://0.0.0.0:\${port}\`))
71
- `;
72
- //#endregion
73
- export { expressAdapter };
74
-
75
- //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgubWpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC5tdHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgd3JpdGVGaWxlIH0gZnJvbSAnbm9kZTpmcy9wcm9taXNlcydcbmltcG9ydCBwYXRoIGZyb20gJ25vZGU6cGF0aCdcblxuaW1wb3J0IHsgcm91dGVkQWRhcHRlciB9IGZyb20gJ0Byb290ZWQvYWRhcHRlcidcblxuaW1wb3J0IHR5cGUgeyBBZGFwdGVyUm91dGVzIH0gZnJvbSAnQHJvb3RlZC9hZGFwdGVyJ1xuaW1wb3J0IHR5cGUgeyBQbHVnaW4gfSBmcm9tICd2aXRlJ1xuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHtAbGluayBleHByZXNzQWRhcHRlcn0uXG4gKi9cbmV4cG9ydCB0eXBlIEV4cHJlc3NBZGFwdGVyT3B0aW9ucyA9IHtcblx0LyoqXG5cdCAqIE1hbnVhbCByb3V0ZSBsaXN0IGZvciBwcm9qZWN0cyB0aGF0IGRvbid0IHVzZSBgZ2VuZXJhdGVSb3V0ZU1hbmlmZXN0YC5cblx0ICogU2VlIHtAbGluayBBZGFwdGVyUm91dGVzfS5cblx0ICovXG5cdHJvdXRlcz86IEFkYXB0ZXJSb3V0ZXNcbn1cblxuLyoqXG4gKiBBZGFwdGVyIGZvciBzZXJ2ZXItc2lkZSBob3N0aW5nIHdpdGggRXhwcmVzcy5cbiAqXG4gKiBXcml0ZXMgYHJvdXRlcy5qc29uYCBhbmQgYSByZWFkeS10by1ydW4gYHNlcnZlci5tanNgIHRvIHRoZSBvdXRwdXQgZGlyZWN0b3J5LlxuICogVGhlIHNlcnZlciB1c2VzIGBleHByZXNzLnN0YXRpY2AgdG8gc2VydmUgcHJlLXJlbmRlcmVkIEhUTUwgZmlsZXMgYW5kIHJlZ2lzdGVyc1xuICogZXhwbGljaXQgaGFuZGxlcnMgZm9yIHBhcmFtZXRlcml6ZWQgcm91dGVzICh3aGljaCBzZXJ2ZSB0aGUgYDQwNC5odG1sYCBTUEEgc2hlbGxcbiAqIHNvIHRoZSBicm93c2VyLXNpZGUgcm91dGVyIHJlbmRlcnMgdGhlIGNvcnJlY3QgY29udGVudCkuIEV4cHJlc3MgdXNlcyB0aGUgc2FtZVxuICogYDpwYXJhbWAgc3ludGF4IGFzIHRoZSByb290ZWQgcm91dGVyLCBzbyBwYXR0ZXJucyBtYXAgZGlyZWN0bHkuXG4gKlxuICogVXNlcnMgc3RhcnQgdGhlIHNlcnZlciB3aXRoIGBub2RlIGRpc3Qvc2VydmVyLm1qc2AuIFRoZSBgUE9SVGAgZW52aXJvbm1lbnQgdmFyaWFibGVcbiAqIGNvbnRyb2xzIHRoZSBwb3J0IChkZWZhdWx0OiAzMDAwKS5cbiAqXG4gKiBSZXF1aXJlcyBgZXhwcmVzcyA+PSA1LjAuMGAgaW4gdGhlIHByb2plY3QuXG4gKlxuICogQGV4YW1wbGUgYHZpdGUuY29uZmlnLnRzYFxuICogYGBgdHNcbiAqIGltcG9ydCB7IHJvb3RlZE1hbmlmZXN0IH0gZnJvbSAnQHJvb3RlZC9hcHBsaWNhdGlvbidcbiAqIGltcG9ydCB7IGdlbmVyYXRlUm91dGVNYW5pZmVzdCB9IGZyb20gJ0Byb290ZWQvcm91dGVyL21hbmlmZXN0J1xuICogaW1wb3J0IHsgZXhwcmVzc0FkYXB0ZXIgfSBmcm9tICdAcm9vdGVkLWFkYXB0ZXJzL2V4cHJlc3MnXG4gKlxuICogZXhwb3J0IGRlZmF1bHQgcm9vdGVkTWFuaWZlc3Qoe1xuICogICBwbHVnaW5zOiBbXG4gKiAgICAgZ2VuZXJhdGVSb3V0ZU1hbmlmZXN0KHsgZ2xvYjogJy4vc3JjLyoqXFwvX3JvdXRlcy5tdHMnLCByb290OiAnLi9zcmMvX3JvdXRlcy5nLm10cycgfSksXG4gKiAgICAgZXhwcmVzc0FkYXB0ZXIoKSxcbiAqICAgXSxcbiAqIH0pXG4gKiBgYGBcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGV4cHJlc3NBZGFwdGVyKG9wdGlvbnM/OiBFeHByZXNzQWRhcHRlck9wdGlvbnMpOiBQbHVnaW4ge1xuXHRyZXR1cm4gcm91dGVkQWRhcHRlcih7XG5cdFx0bmFtZTogJ3Jvb3RlZDpleHByZXNzJyxcblx0XHRyb3V0ZXM6IG9wdGlvbnM/LnJvdXRlcyxcblx0XHRhc3luYyBzZXR1cCh7IG91dHB1dERpcmVjdG9yeSB9KSB7XG5cdFx0XHRhd2FpdCB3cml0ZUZpbGUoXG5cdFx0XHRcdHBhdGguam9pbihvdXRwdXREaXJlY3RvcnksICdzZXJ2ZXIubWpzJyksXG5cdFx0XHRcdEVYUFJFU1NfU0VSVkVSX1RFTVBMQVRFLFxuXHRcdFx0XHQndXRmOCcsXG5cdFx0XHQpXG5cdFx0fSxcblx0fSlcbn1cblxuY29uc3QgRVhQUkVTU19TRVJWRVJfVEVNUExBVEUgPSBgXFxcbmltcG9ydCBleHByZXNzIGZyb20gJ2V4cHJlc3MnXG5pbXBvcnQgeyByZWFkRmlsZVN5bmMgfSBmcm9tICdub2RlOmZzJ1xuaW1wb3J0IHsgZmlsZVVSTFRvUGF0aCB9IGZyb20gJ25vZGU6dXJsJ1xuaW1wb3J0IHBhdGggZnJvbSAnbm9kZTpwYXRoJ1xuXG5jb25zdCBfX2Rpcm5hbWUgPSBwYXRoLmRpcm5hbWUoZmlsZVVSTFRvUGF0aChpbXBvcnQubWV0YS51cmwpKVxuY29uc3QgeyBiYXNlLCBkeW5hbWljUm91dGVzLCBmYWxsYmFjayB9ID0gSlNPTi5wYXJzZShcbiAgcmVhZEZpbGVTeW5jKHBhdGguam9pbihfX2Rpcm5hbWUsICdyb3V0ZXMuanNvbicpLCAndXRmOCcpXG4pXG5cbmNvbnN0IHByZWZpeCA9IGJhc2UucmVwbGFjZSgvXFxcXC8kLywgJycpXG5jb25zdCBhcHAgPSBleHByZXNzKClcblxuLy8gU2VydmVzIGFsbCBwcmUtcmVuZGVyZWQgSFRNTCBmaWxlcyBhbmQgc3RhdGljIGFzc2V0cyBhdXRvbWF0aWNhbGx5XG5hcHAudXNlKGJhc2UsIGV4cHJlc3Muc3RhdGljKF9fZGlybmFtZSkpXG5cbi8vIFBhcmFtZXRlcml6ZWQgcm91dGVzOiBFeHByZXNzIHVzZXMgdGhlIHNhbWUgOnBhcmFtIHN5bnRheCBhcyB0aGUgcm9vdGVkIHJvdXRlclxuZm9yIChjb25zdCByb3V0ZSBvZiBkeW5hbWljUm91dGVzKSB7XG4gIGFwcC5nZXQocHJlZml4ICsgcm91dGUsIChfcmVxLCByZXMpID0+XG4gICAgcmVzLnNlbmRGaWxlKHBhdGguam9pbihfX2Rpcm5hbWUsIGZhbGxiYWNrKSlcbiAgKVxufVxuXG4vLyBBbnl0aGluZyBlbHNlOiBTUEEgc2hlbGwgKGJyb3dzZXItc2lkZSByb3V0ZXIgc2hvd3MgdGhlIGNvcnJlY3QgY29udGVudCBvciA0MDQpXG5hcHAudXNlKChfcmVxLCByZXMpID0+IHJlcy5zZW5kRmlsZShwYXRoLmpvaW4oX19kaXJuYW1lLCBmYWxsYmFjaykpKVxuXG5jb25zdCBwb3J0ID0gTnVtYmVyKHByb2Nlc3MuZW52LlBPUlQgPz8gMzAwMClcbmFwcC5saXN0ZW4ocG9ydCwgJzAuMC4wLjAnLCAoKSA9PiBjb25zb2xlLmxvZyhcXGBMaXN0ZW5pbmcgb24gaHR0cDovLzAuMC4wLjA6XFwke3BvcnR9XFxgKSlcbmBcbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUErQ0EsU0FBZ0IsZUFBZSxTQUF5QztDQUN2RSxPQUFPLGNBQWM7RUFDcEIsTUFBTTtFQUNOLFFBQVEsU0FBUztFQUNqQixNQUFNLE1BQU0sRUFBRSxtQkFBbUI7R0FDaEMsTUFBTSxVQUNMLEtBQUssS0FBSyxpQkFBaUIsYUFBYSxFQUN4Qyx5QkFDQSxPQUNBOztFQUVGLENBQUM7O0FBR0gsTUFBTSwwQkFBMEIifQ==