@transomjs/transom-scaffold 5.0.0 → 7.0.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @transomjs/transom-scaffold change log
 
+## 7.0.1
+- Fixed: the `@transomjs/transom-core` peer dependency was still `^5.0.1`, so npm refused to
+  install transom-scaffold 7 alongside transom-core 7. It's now `^7.0.0`.
+
+## 7.0.0
+- Dev tools: mocha 12, chai 6, c8 12, sinon 22, cross-env 10, open-cli 9; tests run against
+  transom-core 7. The unused shelljs is removed. Express (and `@types/express`) stay on 4 to
+  match transom-core, which provides the Express app.
+- **Requires Node.js 22 or newer** (`engines.node` is `>=22`). The compiled code targets ES2023,
+  and CI runs on Node 22 and 24.
+- Rewritten in TypeScript, with type definitions. The compiled code is in `dist/`;
+  `require("@transomjs/transom-scaffold")` and `.../lib/scaffoldHandler` return the same
+  things as before, and static folders are still resolved from the application's root.
+- Types: `Definition` (the `definition.scaffold` section), `StaticRoute`, `RedirectRoute`,
+  `TemplateRoute`, `Options` and `Handler`. `@types/express` is now a dependency, since the
+  types build on it.
+
 ## 2.0.0
 - **BREAKING CHANGE**: Updated for Transom Core v5+ Express compatibility
 - Replaced Restify dependencies with Express static middleware

package/README.md

@@ -3,8 +3,7 @@ Add routes for static assets, redirects and template based content to your Trans
 
 **Version 2.0+ is compatible with Transom Core v5+ (Express-based) while maintaining backward compatibility.**
 
-[![Build Status](https://travis-ci.org/transomjs/transom-scaffold.svg?branch=master)](https://travis-ci.org/transomjs/transom-scaffold)
-[![Coverage Status](https://coveralls.io/repos/github/transomjs/transom-scaffold/badge.svg?branch=master)](https://coveralls.io/github/transomjs/transom-scaffold?branch=master)
+[![CI](https://github.com/transomjs/transom-scaffold/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/transomjs/transom-scaffold/actions/workflows/ci.yml)
 
 ## Installation
 

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import ScaffoldHandler = require("./lib/scaffoldHandler");
+/** The parts of the transom-core server this plugin uses. Any transom-core server fits. */
+interface ScaffoldPluginServer extends ScaffoldHandler.RouteServer {
+    registry: ScaffoldHandler.RouteServer["registry"] & {
+        get(key: string, defaultValue: object): unknown;
+        set(key: string, value: unknown): void;
+    };
+}
+/** Plugin options, from transom.configure(). */
+interface ScaffoldOptions {
+    /** The registry key for the route helpers. Defaults to "transomScaffold". */
+    registryKey?: string;
+    /** The registry key of the template renderer. Defaults to "transomTemplate". */
+    templateHandler?: string;
+    /** Set by the plugin: a copy of the API definition's scaffold section. */
+    scaffold?: ScaffoldDefinition;
+}
+/**
+ * The API definition's `definition.scaffold` section. `staticRoutes` and `redirectRoutes`
+ * take one route or a list; every other entry is a template route named by its key.
+ */
+interface ScaffoldDefinition {
+    staticRoutes?: ScaffoldHandler.StaticRoute | ScaffoldHandler.StaticRoute[];
+    redirectRoutes?: ScaffoldHandler.RedirectRoute | ScaffoldHandler.RedirectRoute[];
+    [templateRoute: string]: ScaffoldHandler.TemplateRouteDefinition | ScaffoldHandler.StaticRoute | ScaffoldHandler.StaticRoute[] | ScaffoldHandler.RedirectRoute | ScaffoldHandler.RedirectRoute[] | undefined;
+}
+/**
+ * Adds static asset, redirect and template routes from the API definition's
+ * `definition.scaffold` section, and registers the route helpers.
+ */
+declare class TransomScaffold {
+    initialize: (server: ScaffoldPluginServer, options: ScaffoldOptions) => Promise<void>;
+}
+/** The plugin instance, as `require("@transomjs/transom-scaffold")` has always returned. */
+declare const transomScaffold: TransomScaffold;
+declare namespace transomScaffold {
+    type Options = ScaffoldOptions;
+    type Definition = ScaffoldDefinition;
+    type StaticRoute = ScaffoldHandler.StaticRoute;
+    type RedirectRoute = ScaffoldHandler.RedirectRoute;
+    type TemplateRoute = ScaffoldHandler.TemplateRouteDefinition;
+    type RestifyServeStatic = ScaffoldHandler.RestifyServeStatic;
+    type Handler = ScaffoldHandler.Handler;
+    type PluginServer = ScaffoldPluginServer;
+}
+export = transomScaffold;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,GAAG,QAAQ,uBAAuB,CAAC,CAAC;AAI1D,2FAA2F;AAC3F,UAAU,oBAAqB,SAAQ,eAAe,CAAC,WAAW;IAChE,QAAQ,EAAE,eAAe,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG;QAClD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QAChD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;KACxC,CAAC;CACH;AAED,gDAAgD;AAChD,UAAU,eAAe;IACvB,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED;;;GAGG;AACH,UAAU,kBAAkB;IAC1B,YAAY,CAAC,EAAE,eAAe,CAAC,WAAW,GAAG,eAAe,CAAC,WAAW,EAAE,CAAC;IAC3E,cAAc,CAAC,EAAE,eAAe,CAAC,aAAa,GAAG,eAAe,CAAC,aAAa,EAAE,CAAC;IACjF,CAAC,aAAa,EAAE,MAAM,GAClB,eAAe,CAAC,uBAAuB,GACvC,eAAe,CAAC,WAAW,GAC3B,eAAe,CAAC,WAAW,EAAE,GAC7B,eAAe,CAAC,aAAa,GAC7B,eAAe,CAAC,aAAa,EAAE,GAC/B,SAAS,CAAC;CACf;AAMD;;;GAGG;AACH,cAAM,eAAe;IACnB,UAAU,WAAY,oBAAoB,WAAW,eAAe,KAAG,OAAO,CAAC,IAAI,CAAC,CA2ClF;CACH;AAED,4FAA4F;AAC5F,QAAA,MAAM,eAAe,iBAAwB,CAAC;AAE9C,OAAO,WAAW,eAAe,CAAC;IAChC,KAAK,OAAO,GAAG,eAAe,CAAC;IAC/B,KAAK,UAAU,GAAG,kBAAkB,CAAC;IACrC,KAAK,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC;IAC/C,KAAK,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;IACnD,KAAK,aAAa,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAC7D,KAAK,kBAAkB,GAAG,eAAe,CAAC,kBAAkB,CAAC;IAC7D,KAAK,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;IACvC,KAAK,YAAY,GAAG,oBAAoB,CAAC;CAC1C;SAEQ,eAAe"}

package/dist/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const debug_1 = __importDefault(require("debug"));
+const ScaffoldHandler = require("./lib/scaffoldHandler");
+const debug = (0, debug_1.default)("transom:scaffold");
+function asList(value) {
+    return Array.isArray(value) ? value : [value];
+}
+/**
+ * Adds static asset, redirect and template routes from the API definition's
+ * `definition.scaffold` section, and registers the route helpers.
+ */
+class TransomScaffold {
+    initialize = (server, options) => {
+        return new Promise(function (resolve) {
+            // Boundary: the API definition's scaffold section.
+            const scaffoldDefn = server.registry.get("transom-config.definition.scaffold", {});
+            const scaffolds = Object.assign({}, scaffoldDefn);
+            options.scaffold = scaffolds;
+            const scaffoldHandler = ScaffoldHandler(server);
+            server.registry.set(options.registryKey || "transomScaffold", scaffoldHandler);
+            // Add simple get routes to fetch scaffolded content.
+            Object.keys(scaffolds).map(function (key) {
+                if (key === "staticRoutes") {
+                    const staticRoutes = scaffolds.staticRoutes;
+                    if (staticRoutes === undefined) {
+                        return;
+                    }
+                    asList(staticRoutes).map(function (route) {
+                        debug(`Setting up '${route.path}' as a static asset route`);
+                        scaffoldHandler.addStaticAssetRoute(server, route);
+                    });
+                }
+                else if (key === "redirectRoutes") {
+                    const redirectRoutes = scaffolds.redirectRoutes;
+                    if (redirectRoutes === undefined) {
+                        return;
+                    }
+                    asList(redirectRoutes).map(function (route) {
+                        debug(`Setting up '${route.path}' as a redirect route`);
+                        scaffoldHandler.addRedirectRoute(server, route);
+                    });
+                }
+                else {
+                    // Boundary: every other key is a template route. Its defaults are filled in
+                    // place, on the definition's own object, as before.
+                    const scaffold = scaffolds[key];
+                    scaffold.path = scaffold.path || `/${key.toLowerCase()}`;
+                    scaffold.templateName = scaffold.templateName || key;
+                    scaffold.templateHandler = options.templateHandler || "transomTemplate";
+                    debug(`Setting up '${scaffold.path}' as a template route to ${scaffold.templateName}`);
+                    scaffoldHandler.addTemplateRoute(server, scaffold);
+                }
+            });
+            resolve();
+        });
+    };
+}
+/** The plugin instance, as `require("@transomjs/transom-scaffold")` has always returned. */
+const transomScaffold = new TransomScaffold();
+module.exports = transomScaffold;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,kDAAgC;AAChC,MAAO,eAAe,oCAAoC;AAE1D,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,kBAAkB,CAAC,CAAC;AAoC9C,SAAS,MAAM,CAAI,KAAc;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,MAAM,eAAe;IACnB,UAAU,GAAG,CAAC,MAA4B,EAAE,OAAwB,EAAiB,EAAE;QACrF,OAAO,IAAI,OAAO,CAAO,UAAU,OAAO;YACxC,mDAAmD;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,CAAuB,CAAC;YACzG,MAAM,SAAS,GAAuB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;YACtE,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;YAE7B,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,iBAAiB,EAAE,eAAe,CAAC,CAAC;YAE/E,qDAAqD;YACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,UAAU,GAAG;gBACtC,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;oBAC3B,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;oBAC5C,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;wBAC/B,OAAO;oBACT,CAAC;oBACD,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK;wBACtC,KAAK,CAAC,eAAe,KAAK,CAAC,IAAI,2BAA2B,CAAC,CAAC;wBAC5D,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBACrD,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,GAAG,KAAK,gBAAgB,EAAE,CAAC;oBACpC,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;oBAChD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;wBACjC,OAAO;oBACT,CAAC;oBACD,MAAM,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK;wBACxC,KAAK,CAAC,eAAe,KAAK,CAAC,IAAI,uBAAuB,CAAC,CAAC;wBACxD,eAAe,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBAClD,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACN,4EAA4E;oBAC5E,oDAAoD;oBACpD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAkC,CAAC;oBACjE,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;oBACzD,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,IAAI,GAAG,CAAC;oBACrD,QAAQ,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,iBAAiB,CAAC;oBACxE,KAAK,CAAC,eAAe,QAAQ,CAAC,IAAI,4BAA4B,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC;oBACvF,eAAe,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;CACH;AAED,4FAA4F;AAC5F,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAa9C,iBAAS,eAAe,CAAC"}

package/dist/lib/scaffoldHandler.d.ts

@@ -0,0 +1,76 @@
+import express from "express";
+import type { RequestHandler } from "express";
+/**
+ * Builds the route helpers that transom-scaffold registers (as "transomScaffold" by default).
+ * A plain function, so existing `new ScaffoldHandler(...)` calls keep working.
+ */
+declare function ScaffoldHandler(_server?: unknown, _options?: unknown): ScaffoldHandler.Handler;
+declare namespace ScaffoldHandler {
+    /** The parts of the transom-core server the route helpers use. Any transom-core server fits. */
+    interface RouteServer {
+        registry: {
+            get(key: string): unknown;
+        };
+        get(path: string, ...handlers: RequestHandler[]): unknown;
+        use?(path: string, ...handlers: RequestHandler[]): unknown;
+    }
+    /** The options a custom (Restify-style) serveStatic receives. */
+    interface RestifyStaticOptions {
+        directory: string;
+        appendRequestPath: boolean;
+        default: string;
+    }
+    type RestifyServeStatic = (options: RestifyStaticOptions) => RequestHandler;
+    /** An entry in `staticRoutes`. */
+    interface StaticRoute {
+        /** The URL path to mount, e.g. "/html". */
+        path: string;
+        /** Folder under the application root. Defaults to the root itself. */
+        folder?: string;
+        /** Defaults to "index.html". */
+        defaultAsset?: string;
+        /** When false, folders don't serve the default asset. Defaults to true. */
+        appendRequestPath?: boolean;
+        /** Replace express.static, e.g. with a Restify-style serveStatic. */
+        serveStatic?: typeof express.static | RestifyServeStatic;
+    }
+    /** An entry in `redirectRoutes`. */
+    interface RedirectRoute {
+        path: string;
+        /** A URL (302), or a pathname with `permanent: true` for a 301. */
+        target: string | {
+            pathname: string;
+            permanent?: boolean;
+        };
+    }
+    /** A named entry in the scaffold definition, rendered with an HTML template. */
+    interface TemplateRouteDefinition {
+        /** Defaults to "/<name in lower case>". */
+        path?: string;
+        /** Defaults to the entry's name. */
+        templateName?: string;
+        /** Defaults to "text/html". */
+        contentType?: string;
+        /** Passed to the template, with the request's `headers` and `params` added. */
+        data?: Record<string, unknown>;
+    }
+    /** A template route once the plugin has filled in its defaults. */
+    interface TemplateRoute extends TemplateRouteDefinition {
+        path: string;
+        templateName: string;
+        /** The registry key of the template renderer. */
+        templateHandler: string;
+    }
+    /** The registered template renderer, as transom-ejs-template provides it. */
+    interface TemplateRenderer {
+        renderHtmlTemplate(templateName: string, data: object): string;
+    }
+    /** The registered helpers. */
+    interface Handler {
+        addStaticAssetRoute(server: RouteServer, scaffold: StaticRoute): void;
+        addRedirectRoute(server: RouteServer, scaffold: RedirectRoute): void;
+        addTemplateRoute(server: RouteServer, scaffold: TemplateRoute): void;
+    }
+}
+export = ScaffoldHandler;
+//# sourceMappingURL=scaffoldHandler.d.ts.map

package/dist/lib/scaffoldHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffoldHandler.d.ts","sourceRoot":"","sources":["../../src/lib/scaffoldHandler.ts"],"names":[],"mappings":"AAGA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAyB,cAAc,EAAY,MAAM,SAAS,CAAC;AAkB/E;;;GAGG;AACH,iBAAS,eAAe,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,eAAe,CAAC,OAAO,CAyGvF;AAED,OAAO,WAAW,eAAe,CAAC;IAChC,gGAAgG;IAChG,UAAU,WAAW;QACnB,QAAQ,EAAE;YACR,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SAC3B,CAAC;QACF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAC1D,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;KAC5D;IAED,iEAAiE;IACjE,UAAU,oBAAoB;QAC5B,SAAS,EAAE,MAAM,CAAC;QAClB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,KAAK,kBAAkB,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,cAAc,CAAC;IAE5E,kCAAkC;IAClC,UAAU,WAAW;QACnB,2CAA2C;QAC3C,IAAI,EAAE,MAAM,CAAC;QACb,sEAAsE;QACtE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,gCAAgC;QAChC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,2EAA2E;QAC3E,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,qEAAqE;QACrE,WAAW,CAAC,EAAE,OAAO,OAAO,CAAC,MAAM,GAAG,kBAAkB,CAAC;KAC1D;IAED,oCAAoC;IACpC,UAAU,aAAa;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,mEAAmE;QACnE,MAAM,EAAE,MAAM,GAAG;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KAC5D;IAED,gFAAgF;IAChF,UAAU,uBAAuB;QAC/B,2CAA2C;QAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,oCAAoC;QACpC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,+BAA+B;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,+EAA+E;QAC/E,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC;IAED,mEAAmE;IACnE,UAAU,aAAc,SAAQ,uBAAuB;QACrD,IAAI,EAAE,MAAM,CAAC;QACb,YAAY,EAAE,MAAM,CAAC;QACrB,iDAAiD;QACjD,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,6EAA6E;IAC7E,UAAU,gBAAgB;QACxB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KAChE;IAED,8BAA8B;IAC9B,UAAU,OAAO;QACf,mBAAmB,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC;QACtE,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;QACrE,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;KACtE;CACF;SAEQ,eAAe"}

package/dist/lib/scaffoldHandler.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const assert_1 = __importDefault(require("assert"));
+const path_1 = __importDefault(require("path"));
+const debug_1 = __importDefault(require("debug"));
+const express_1 = __importDefault(require("express"));
+const debug = (0, debug_1.default)("transom:scaffold");
+// This file runs from <package>/dist/lib.
+const PACKAGE_ROOT = path_1.default.join(__dirname, "..", "..");
+/**
+ * Where static folders are resolved from: the application's root, found by walking up
+ * out of node_modules/@transomjs/transom-scaffold. When NODE_ENV is "testing", the
+ * package root.
+ */
+function assetRoot() {
+    return `${process.env.NODE_ENV}`.toUpperCase() === "TESTING"
+        ? PACKAGE_ROOT
+        : path_1.default.join(PACKAGE_ROOT, "..", "..", "..");
+}
+/**
+ * Builds the route helpers that transom-scaffold registers (as "transomScaffold" by default).
+ * A plain function, so existing `new ScaffoldHandler(...)` calls keep working.
+ */
+function ScaffoldHandler(_server, _options) {
+    /**
+     * Serves static assets from a folder under the application root.
+     *
+     * @param server - The transom server.
+     * @param scaffold - An entry from `staticRoutes`.
+     */
+    function addStaticAssetRoute(server, scaffold) {
+        (0, assert_1.default)(scaffold.path, `TransomScaffold staticRoute requires "path" to be specified.`);
+        const contentFolder = scaffold.folder || path_1.default.sep;
+        const defaultAsset = scaffold.defaultAsset || "index.html";
+        const appendRequestPath = scaffold.appendRequestPath === false ? false : true; // default true
+        const directory = path_1.default.join(assetRoot(), contentFolder);
+        debug(`Path ${scaffold.path} is serving static assets from ${directory}`);
+        let staticMiddleware;
+        if (scaffold.serveStatic && scaffold.serveStatic !== express_1.default.static) {
+            // A custom serveStatic function (Restify style) gets Restify-style options.
+            // Boundary: it's documented as taking a single options object.
+            const restifyServeStatic = scaffold.serveStatic;
+            staticMiddleware = restifyServeStatic({
+                directory,
+                appendRequestPath,
+                default: defaultAsset,
+            });
+        }
+        else {
+            // Express static, with Express-style options.
+            staticMiddleware = express_1.default.static(directory, {
+                index: appendRequestPath ? defaultAsset : false,
+            });
+        }
+        // Use server.use if available (Express), otherwise fall back to server.get.
+        if (typeof server.use === "function") {
+            server.use(scaffold.path, staticMiddleware);
+        }
+        else {
+            server.get(scaffold.path, staticMiddleware);
+        }
+    }
+    /**
+     * Adds a GET route that redirects to another URI.
+     *
+     * @param server - The transom server.
+     * @param scaffold - An entry from `redirectRoutes`.
+     */
+    function addRedirectRoute(server, scaffold) {
+        (0, assert_1.default)(scaffold.path && scaffold.target, `TransomScaffold redirectRoute requires 'path' and 'target' to be specified.`);
+        server.get(scaffold.path, function (_req, res) {
+            // An object target can choose a permanent (301) redirect.
+            if (typeof scaffold.target === "object") {
+                const statusCode = scaffold.target.permanent ? 301 : 302;
+                res.redirect(statusCode, scaffold.target.pathname);
+            }
+            else {
+                res.redirect(scaffold.target);
+            }
+        });
+    }
+    /**
+     * Adds a GET route rendered with an HTML template from the registered template handler.
+     *
+     * @param server - The transom server.
+     * @param scaffold - A named entry from the scaffold definition, with its defaults applied.
+     */
+    function addTemplateRoute(server, scaffold) {
+        server.get(scaffold.path, function (req, res, next) {
+            // Boundary: the template handler registered under this key (transom-ejs-template's renderer).
+            const transomTemplate = server.registry.get(scaffold.templateHandler);
+            const contentType = scaffold.contentType || "text/html";
+            new Promise(function (resolve) {
+                // Push request headers and params into the data going to the template.
+                const data = scaffold.data || {};
+                data.headers = req.headers;
+                data.params = req.params;
+                resolve(transomTemplate.renderHtmlTemplate(scaffold.templateName, data));
+            })
+                .then(function (pageData) {
+                res.setHeader("content-type", contentType);
+                res.end(pageData);
+                // Call next() for test compatibility (tests expect it to be called).
+                if (typeof next === "function") {
+                    // Use setTimeout to ensure the response is sent first.
+                    setTimeout(() => next(), 0);
+                }
+            })
+                .catch(function (err) {
+                next(err);
+            });
+        });
+    }
+    return {
+        addStaticAssetRoute,
+        addRedirectRoute,
+        addTemplateRoute,
+    };
+}
+module.exports = ScaffoldHandler;
+//# sourceMappingURL=scaffoldHandler.js.map

package/dist/lib/scaffoldHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffoldHandler.js","sourceRoot":"","sources":["../../src/lib/scaffoldHandler.ts"],"names":[],"mappings":";;;;AAAA,oDAA4B;AAC5B,gDAAwB;AACxB,kDAAgC;AAChC,sDAA8B;AAG9B,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,kBAAkB,CAAC,CAAC;AAE9C,0CAA0C;AAC1C,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEtD;;;;GAIG;AACH,SAAS,SAAS;IAChB,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,KAAK,SAAS;QAC1D,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,OAAiB,EAAE,QAAkB;IAC5D;;;;;OAKG;IACH,SAAS,mBAAmB,CAAC,MAAmC,EAAE,QAAqC;QACrG,IAAA,gBAAM,EAAC,QAAQ,CAAC,IAAI,EAAE,8DAA8D,CAAC,CAAC;QAEtF,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,IAAI,cAAI,CAAC,GAAG,CAAC;QAClD,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,IAAI,YAAY,CAAC;QAC3D,MAAM,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe;QAE9F,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;QACxD,KAAK,CAAC,QAAQ,QAAQ,CAAC,IAAI,kCAAkC,SAAS,EAAE,CAAC,CAAC;QAE1E,IAAI,gBAAgC,CAAC;QACrC,IAAI,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,KAAK,iBAAO,CAAC,MAAM,EAAE,CAAC;YACpE,4EAA4E;YAC5E,+DAA+D;YAC/D,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAiD,CAAC;YACtF,gBAAgB,GAAG,kBAAkB,CAAC;gBACpC,SAAS;gBACT,iBAAiB;gBACjB,OAAO,EAAE,YAAY;aACtB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,8CAA8C;YAC9C,gBAAgB,GAAG,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE;gBAC3C,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK;aAChD,CAAC,CAAC;QACL,CAAC;QAED,4EAA4E;QAC5E,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,SAAS,gBAAgB,CAAC,MAAmC,EAAE,QAAuC;QACpG,IAAA,gBAAM,EACJ,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,EAChC,6EAA6E,CAC9E,CAAC;QAEF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,IAAa,EAAE,GAAa;YAC9D,0DAA0D;YAC1D,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACxC,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;gBACzD,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,SAAS,gBAAgB,CAAC,MAAmC,EAAE,QAAuC;QACpG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAY,EAAE,GAAa,EAAE,IAAkB;YACjF,8FAA8F;YAC9F,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAqC,CAAC;YAC1G,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,IAAI,WAAW,CAAC;YAExD,IAAI,OAAO,CAAS,UAAU,OAAO;gBACnC,uEAAuE;gBACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;gBACjC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;gBAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;gBAEzB,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;YAC3E,CAAC,CAAC;iBACC,IAAI,CAAC,UAAU,QAAQ;gBACtB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;gBAC3C,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAClB,qEAAqE;gBACrE,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;oBAC/B,uDAAuD;oBACvD,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,UAAU,GAAY;gBAC3B,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,mBAAmB;QACnB,gBAAgB;QAChB,gBAAgB;KACjB,CAAC;AACJ,CAAC;AA2ED,iBAAS,eAAe,CAAC"}

package/lib/scaffoldHandler.d.ts

@@ -0,0 +1,2 @@
+import ScaffoldHandler = require("../dist/lib/scaffoldHandler");
+export = ScaffoldHandler;

package/lib/scaffoldHandler.js

@@ -1,116 +1,3 @@
-'use strict';
-const debug = require('debug')('transom:scaffold');
-const express = require('express');
-const path = require('path');
-const assert = require('assert');
-
-module.exports = function ScaffoldHandler(server) {
-
-    /**
-     * Add a GET route to the server to handle static assets.
-     * 
-     * @param {*} server  - Express server instance
-     * @param {*} scaffold - Object from the staticRoutes array.
-     */
-    function addStaticAssetRoute(server, scaffold) {
-        assert(scaffold.path, `TransomScaffold staticRoute requires "path" to be specified.`);
-
-        const contentFolder = scaffold.folder || path.sep;
-        const serveStatic = scaffold.serveStatic || express.static;
-        const defaultAsset = scaffold.defaultAsset || 'index.html';
-        const appendRequestPath = (scaffold.appendRequestPath  === false ? false : true); // default true
-
-        // When we are running tests, the path to our assets will be different. 
-        // We create the path using NODE_ENV which should be set to TESTING.
-        let directory = path.join(__dirname, '..', '..', '..', '..', contentFolder);
-        if ((`${process.env.NODE_ENV}`).toUpperCase() === 'TESTING') {
-            directory = path.join(__dirname, "..", contentFolder);
-        }
-        debug(`Path ${scaffold.path} is serving static assets from ${directory}`);
-
-        // Create middleware function based on server type and static function
-        let staticMiddleware;
-        
-        if (scaffold.serveStatic && scaffold.serveStatic !== express.static) {
-            // Custom serveStatic function provided (like in tests)
-            // Use Restify-style options for backward compatibility
-            const restifyOptions = {
-                directory,
-                appendRequestPath,
-                default: defaultAsset
-            };
-            staticMiddleware = serveStatic(restifyOptions);
-        } else {
-            // Use Express static with Express-style options
-            const expressOptions = {
-                index: appendRequestPath ? defaultAsset : false
-            };
-            staticMiddleware = serveStatic(directory, expressOptions);
-        }
-        
-        // Use server.use if available (Express), otherwise fall back to server.get for compatibility
-        if (typeof server.use === 'function') {
-            server.use(scaffold.path, staticMiddleware);
-        } else {
-            server.get(scaffold.path, staticMiddleware);
-        }
-    }
-
-    /**
-     * Add a GET route that redirects to another URI.
-     * 
-     * @param {*} server - Express server instance 
-     * @param {*} scaffold  - Object from the redirectRoutes array.
-     */
-    function addRedirectRoute(server, scaffold) {
-        assert(scaffold.path && scaffold.target, `TransomScaffold redirectRoute requires 'path' and 'target' to be specified.`);
-
-        server.get(scaffold.path, function (req, res, next) {
-            // Handle Express redirect - if target is object with pathname and permanent
-            if (typeof scaffold.target === 'object') {
-                const statusCode = scaffold.target.permanent ? 301 : 302;
-                res.redirect(statusCode, scaffold.target.pathname);
-            } else {
-                res.redirect(scaffold.target);
-            }
-        });
-    }
-
-    /**
-     * Add a GET route that is handled with a template.
-     * 
-     * @param {*} server - Express server instance
-     * @param {*} scaffold 
-     */
-    function addTemplateRoute(server, scaffold) {
-        server.get(scaffold.path, function (req, res, next) {
-            const transomTemplate = server.registry.get(scaffold.templateHandler);
-            const contentType = scaffold.contentType || 'text/html';
-
-            const p = new Promise(function (resolve, reject) {
-                // Push request headers and params into the data going to the template.
-                const data = scaffold.data || {};
-                data.headers = req.headers;
-                data.params = req.params;
-
-                resolve(transomTemplate.renderHtmlTemplate(scaffold.templateName, data));
-            }).then(function (pageData) {
-                res.setHeader('content-type', contentType);
-                res.end(pageData);
-                // Call next() for test compatibility (tests expect it to be called)
-                if (typeof next === 'function') {
-                    // Use setTimeout to ensure response is sent first
-                    setTimeout(() => next(), 0);
-                }
-            }).catch(function (err) {
-                next(err);
-            });
-        });
-    }
-
-    return {
-        addStaticAssetRoute,
-        addRedirectRoute,
-        addTemplateRoute
-    };
-};
+"use strict";
+// Kept so require("@transomjs/transom-scaffold/lib/scaffoldHandler") still works; the code is in dist/.
+module.exports = require("../dist/lib/scaffoldHandler");

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@transomjs/transom-scaffold",
-  "version": "5.0.0",
+  "version": "7.0.1",
   "description": "Serve static assets and add redirect routes to a Transom REST API (Express compatible).",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "npm run build && tsc -p tsconfig.json",
+    "pretest": "npm run build",
     "deploy": "np",
-    "test": "cross-env NODE_ENV=testing nyc mocha",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls",
-    "cover": "nyc report --reporter=html && open-cli ./coverage/index.html"
+    "test": "cross-env NODE_ENV=testing c8 mocha",
+    "cover": "c8 report --reporter=html && open-cli ./coverage/index.html",
+    "prepublishOnly": "npm run typecheck && npm test"
   },
   "repository": {
     "type": "git",
@@ -26,24 +29,34 @@
   },
   "homepage": "https://github.com/transomjs/transom-scaffold#readme",
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "devDependencies": {
-    "@transomjs/transom-core": "^5.0.1",
-    "chai": "^5.1.2",
-    "coveralls": "^3.1.1",
-    "cross-env": "^7.0.3",
+    "@transomjs/transom-core": "^7.0.0",
+    "@types/debug": "^4.1.13",
+    "@types/node": "^22.20.5",
+    "c8": "^12.0.0",
+    "chai": "^6.3.0",
+    "cross-env": "^10.1.0",
     "express": "^4.21.1",
-    "mocha": "^10.8.2",
-    "mocha-lcov-reporter": "^1.3.0",
-    "open-cli": "^8.0.0",
-    "np": "^10.0.10",
-    "nyc": "^17.1.0",
-    "shelljs": "^0.8.5",
-    "sinon": "^19.0.2"
+    "mocha": "^12.0.3",
+    "np": "^12.1.1",
+    "open-cli": "^9.0.0",
+    "pocket-registry": "^3.0.0",
+    "sinon": "^22.1.0",
+    "typescript": "^7.0.2"
   },
   "peerDependencies": {
-    "@transomjs/transom-core": "^5.0.1"
+    "@transomjs/transom-core": "^7.0.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@types/express": "^4.17.25"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "lib",
+    "CHANGELOG.md"
+  ]
 }

package/src/index.ts

@@ -0,0 +1,109 @@
+import createDebug from "debug";
+import ScaffoldHandler = require("./lib/scaffoldHandler");
+
+const debug = createDebug("transom:scaffold");
+
+/** The parts of the transom-core server this plugin uses. Any transom-core server fits. */
+interface ScaffoldPluginServer extends ScaffoldHandler.RouteServer {
+  registry: ScaffoldHandler.RouteServer["registry"] & {
+    get(key: string, defaultValue: object): unknown;
+    set(key: string, value: unknown): void;
+  };
+}
+
+/** Plugin options, from transom.configure(). */
+interface ScaffoldOptions {
+  /** The registry key for the route helpers. Defaults to "transomScaffold". */
+  registryKey?: string;
+  /** The registry key of the template renderer. Defaults to "transomTemplate". */
+  templateHandler?: string;
+  /** Set by the plugin: a copy of the API definition's scaffold section. */
+  scaffold?: ScaffoldDefinition;
+}
+
+/**
+ * The API definition's `definition.scaffold` section. `staticRoutes` and `redirectRoutes`
+ * take one route or a list; every other entry is a template route named by its key.
+ */
+interface ScaffoldDefinition {
+  staticRoutes?: ScaffoldHandler.StaticRoute | ScaffoldHandler.StaticRoute[];
+  redirectRoutes?: ScaffoldHandler.RedirectRoute | ScaffoldHandler.RedirectRoute[];
+  [templateRoute: string]:
+    | ScaffoldHandler.TemplateRouteDefinition
+    | ScaffoldHandler.StaticRoute
+    | ScaffoldHandler.StaticRoute[]
+    | ScaffoldHandler.RedirectRoute
+    | ScaffoldHandler.RedirectRoute[]
+    | undefined;
+}
+
+function asList<T>(value: T | T[]): T[] {
+  return Array.isArray(value) ? value : [value];
+}
+
+/**
+ * Adds static asset, redirect and template routes from the API definition's
+ * `definition.scaffold` section, and registers the route helpers.
+ */
+class TransomScaffold {
+  initialize = (server: ScaffoldPluginServer, options: ScaffoldOptions): Promise<void> => {
+    return new Promise<void>(function (resolve) {
+      // Boundary: the API definition's scaffold section.
+      const scaffoldDefn = server.registry.get("transom-config.definition.scaffold", {}) as ScaffoldDefinition;
+      const scaffolds: ScaffoldDefinition = Object.assign({}, scaffoldDefn);
+      options.scaffold = scaffolds;
+
+      const scaffoldHandler = ScaffoldHandler(server);
+      server.registry.set(options.registryKey || "transomScaffold", scaffoldHandler);
+
+      // Add simple get routes to fetch scaffolded content.
+      Object.keys(scaffolds).map(function (key) {
+        if (key === "staticRoutes") {
+          const staticRoutes = scaffolds.staticRoutes;
+          if (staticRoutes === undefined) {
+            return;
+          }
+          asList(staticRoutes).map(function (route) {
+            debug(`Setting up '${route.path}' as a static asset route`);
+            scaffoldHandler.addStaticAssetRoute(server, route);
+          });
+        } else if (key === "redirectRoutes") {
+          const redirectRoutes = scaffolds.redirectRoutes;
+          if (redirectRoutes === undefined) {
+            return;
+          }
+          asList(redirectRoutes).map(function (route) {
+            debug(`Setting up '${route.path}' as a redirect route`);
+            scaffoldHandler.addRedirectRoute(server, route);
+          });
+        } else {
+          // Boundary: every other key is a template route. Its defaults are filled in
+          // place, on the definition's own object, as before.
+          const scaffold = scaffolds[key] as ScaffoldHandler.TemplateRoute;
+          scaffold.path = scaffold.path || `/${key.toLowerCase()}`;
+          scaffold.templateName = scaffold.templateName || key;
+          scaffold.templateHandler = options.templateHandler || "transomTemplate";
+          debug(`Setting up '${scaffold.path}' as a template route to ${scaffold.templateName}`);
+          scaffoldHandler.addTemplateRoute(server, scaffold);
+        }
+      });
+      resolve();
+    });
+  };
+}
+
+/** The plugin instance, as `require("@transomjs/transom-scaffold")` has always returned. */
+const transomScaffold = new TransomScaffold();
+
+declare namespace transomScaffold {
+  type Options = ScaffoldOptions;
+  type Definition = ScaffoldDefinition;
+  type StaticRoute = ScaffoldHandler.StaticRoute;
+  type RedirectRoute = ScaffoldHandler.RedirectRoute;
+  type TemplateRoute = ScaffoldHandler.TemplateRouteDefinition;
+  type RestifyServeStatic = ScaffoldHandler.RestifyServeStatic;
+  type Handler = ScaffoldHandler.Handler;
+  type PluginServer = ScaffoldPluginServer;
+}
+
+export = transomScaffold;

package/src/lib/scaffoldHandler.ts

@@ -0,0 +1,207 @@
+import assert from "assert";
+import path from "path";
+import createDebug from "debug";
+import express from "express";
+import type { NextFunction, Request, RequestHandler, Response } from "express";
+
+const debug = createDebug("transom:scaffold");
+
+// This file runs from <package>/dist/lib.
+const PACKAGE_ROOT = path.join(__dirname, "..", "..");
+
+/**
+ * Where static folders are resolved from: the application's root, found by walking up
+ * out of node_modules/@transomjs/transom-scaffold. When NODE_ENV is "testing", the
+ * package root.
+ */
+function assetRoot(): string {
+  return `${process.env.NODE_ENV}`.toUpperCase() === "TESTING"
+    ? PACKAGE_ROOT
+    : path.join(PACKAGE_ROOT, "..", "..", "..");
+}
+
+/**
+ * Builds the route helpers that transom-scaffold registers (as "transomScaffold" by default).
+ * A plain function, so existing `new ScaffoldHandler(...)` calls keep working.
+ */
+function ScaffoldHandler(_server?: unknown, _options?: unknown): ScaffoldHandler.Handler {
+  /**
+   * Serves static assets from a folder under the application root.
+   *
+   * @param server - The transom server.
+   * @param scaffold - An entry from `staticRoutes`.
+   */
+  function addStaticAssetRoute(server: ScaffoldHandler.RouteServer, scaffold: ScaffoldHandler.StaticRoute): void {
+    assert(scaffold.path, `TransomScaffold staticRoute requires "path" to be specified.`);
+
+    const contentFolder = scaffold.folder || path.sep;
+    const defaultAsset = scaffold.defaultAsset || "index.html";
+    const appendRequestPath = scaffold.appendRequestPath === false ? false : true; // default true
+
+    const directory = path.join(assetRoot(), contentFolder);
+    debug(`Path ${scaffold.path} is serving static assets from ${directory}`);
+
+    let staticMiddleware: RequestHandler;
+    if (scaffold.serveStatic && scaffold.serveStatic !== express.static) {
+      // A custom serveStatic function (Restify style) gets Restify-style options.
+      // Boundary: it's documented as taking a single options object.
+      const restifyServeStatic = scaffold.serveStatic as ScaffoldHandler.RestifyServeStatic;
+      staticMiddleware = restifyServeStatic({
+        directory,
+        appendRequestPath,
+        default: defaultAsset,
+      });
+    } else {
+      // Express static, with Express-style options.
+      staticMiddleware = express.static(directory, {
+        index: appendRequestPath ? defaultAsset : false,
+      });
+    }
+
+    // Use server.use if available (Express), otherwise fall back to server.get.
+    if (typeof server.use === "function") {
+      server.use(scaffold.path, staticMiddleware);
+    } else {
+      server.get(scaffold.path, staticMiddleware);
+    }
+  }
+
+  /**
+   * Adds a GET route that redirects to another URI.
+   *
+   * @param server - The transom server.
+   * @param scaffold - An entry from `redirectRoutes`.
+   */
+  function addRedirectRoute(server: ScaffoldHandler.RouteServer, scaffold: ScaffoldHandler.RedirectRoute): void {
+    assert(
+      scaffold.path && scaffold.target,
+      `TransomScaffold redirectRoute requires 'path' and 'target' to be specified.`,
+    );
+
+    server.get(scaffold.path, function (_req: Request, res: Response) {
+      // An object target can choose a permanent (301) redirect.
+      if (typeof scaffold.target === "object") {
+        const statusCode = scaffold.target.permanent ? 301 : 302;
+        res.redirect(statusCode, scaffold.target.pathname);
+      } else {
+        res.redirect(scaffold.target);
+      }
+    });
+  }
+
+  /**
+   * Adds a GET route rendered with an HTML template from the registered template handler.
+   *
+   * @param server - The transom server.
+   * @param scaffold - A named entry from the scaffold definition, with its defaults applied.
+   */
+  function addTemplateRoute(server: ScaffoldHandler.RouteServer, scaffold: ScaffoldHandler.TemplateRoute): void {
+    server.get(scaffold.path, function (req: Request, res: Response, next: NextFunction) {
+      // Boundary: the template handler registered under this key (transom-ejs-template's renderer).
+      const transomTemplate = server.registry.get(scaffold.templateHandler) as ScaffoldHandler.TemplateRenderer;
+      const contentType = scaffold.contentType || "text/html";
+
+      new Promise<string>(function (resolve) {
+        // Push request headers and params into the data going to the template.
+        const data = scaffold.data || {};
+        data.headers = req.headers;
+        data.params = req.params;
+
+        resolve(transomTemplate.renderHtmlTemplate(scaffold.templateName, data));
+      })
+        .then(function (pageData) {
+          res.setHeader("content-type", contentType);
+          res.end(pageData);
+          // Call next() for test compatibility (tests expect it to be called).
+          if (typeof next === "function") {
+            // Use setTimeout to ensure the response is sent first.
+            setTimeout(() => next(), 0);
+          }
+        })
+        .catch(function (err: unknown) {
+          next(err);
+        });
+    });
+  }
+
+  return {
+    addStaticAssetRoute,
+    addRedirectRoute,
+    addTemplateRoute,
+  };
+}
+
+declare namespace ScaffoldHandler {
+  /** The parts of the transom-core server the route helpers use. Any transom-core server fits. */
+  interface RouteServer {
+    registry: {
+      get(key: string): unknown;
+    };
+    get(path: string, ...handlers: RequestHandler[]): unknown;
+    use?(path: string, ...handlers: RequestHandler[]): unknown;
+  }
+
+  /** The options a custom (Restify-style) serveStatic receives. */
+  interface RestifyStaticOptions {
+    directory: string;
+    appendRequestPath: boolean;
+    default: string;
+  }
+
+  type RestifyServeStatic = (options: RestifyStaticOptions) => RequestHandler;
+
+  /** An entry in `staticRoutes`. */
+  interface StaticRoute {
+    /** The URL path to mount, e.g. "/html". */
+    path: string;
+    /** Folder under the application root. Defaults to the root itself. */
+    folder?: string;
+    /** Defaults to "index.html". */
+    defaultAsset?: string;
+    /** When false, folders don't serve the default asset. Defaults to true. */
+    appendRequestPath?: boolean;
+    /** Replace express.static, e.g. with a Restify-style serveStatic. */
+    serveStatic?: typeof express.static | RestifyServeStatic;
+  }
+
+  /** An entry in `redirectRoutes`. */
+  interface RedirectRoute {
+    path: string;
+    /** A URL (302), or a pathname with `permanent: true` for a 301. */
+    target: string | { pathname: string; permanent?: boolean };
+  }
+
+  /** A named entry in the scaffold definition, rendered with an HTML template. */
+  interface TemplateRouteDefinition {
+    /** Defaults to "/<name in lower case>". */
+    path?: string;
+    /** Defaults to the entry's name. */
+    templateName?: string;
+    /** Defaults to "text/html". */
+    contentType?: string;
+    /** Passed to the template, with the request's `headers` and `params` added. */
+    data?: Record<string, unknown>;
+  }
+
+  /** A template route once the plugin has filled in its defaults. */
+  interface TemplateRoute extends TemplateRouteDefinition {
+    path: string;
+    templateName: string;
+    /** The registry key of the template renderer. */
+    templateHandler: string;
+  }
+
+  /** The registered template renderer, as transom-ejs-template provides it. */
+  interface TemplateRenderer {
+    renderHtmlTemplate(templateName: string, data: object): string;
+  }
+
+  /** The registered helpers. */
+  interface Handler {
+    addStaticAssetRoute(server: RouteServer, scaffold: StaticRoute): void;
+    addRedirectRoute(server: RouteServer, scaffold: RedirectRoute): void;
+    addTemplateRoute(server: RouteServer, scaffold: TemplateRoute): void;
+  }
+}
+
+export = ScaffoldHandler;

package/index.js

@@ -1,43 +0,0 @@
-'use strict';
-const debug = require('debug')('transom:scaffold');
-const ScaffoldHandler = require('./lib/scaffoldHandler');
-
-function TransomScaffold() {
-	this.initialize = function (server, options) {
-		return new Promise(function(resolve, reject){
-			const scaffoldDefn = server.registry.get('transom-config.definition.scaffold', {});
-			options.scaffold = Object.assign({}, scaffoldDefn);
-			
-			const scaffoldHandler = new ScaffoldHandler(server);
-			server.registry.set(options.registryKey || 'transomScaffold', scaffoldHandler);
-	
-			// Add simple get routes to fetch scaffolded content.
-			Object.keys(options.scaffold).map(function (key) {
-				const scaffold = options.scaffold[key];
-
-				if (key === 'staticRoutes') {
-					const staticRoutes = Array.isArray(scaffold) ? scaffold : [scaffold];
-					staticRoutes.map(function (route) {
-						debug(`Setting up '${route.path}' as a static asset route`);
-						scaffoldHandler.addStaticAssetRoute(server, route);
-					});
-				} else if (key === 'redirectRoutes') {
-					const redirectRoutes = Array.isArray(scaffold) ? scaffold : [scaffold];
-					redirectRoutes.map(function (route) {
-						debug(`Setting up '${route.path}' as a redirect route`);
-						scaffoldHandler.addRedirectRoute(server, route);
-					});
-				} else {
-					scaffold.path = scaffold.path || `/${key.toLowerCase()}`;
-					scaffold.templateName = scaffold.templateName || key;
-					scaffold.templateHandler = options.templateHandler || 'transomTemplate';
-					debug(`Setting up '${scaffold.path}' as a template route to ${scaffold.templateName}`);
-					scaffoldHandler.addTemplateRoute(server, scaffold);
-				}
-			});
-			resolve();
-		});
-	}
-}
-
-module.exports = new TransomScaffold();