@haibun/web-server-express 1.28.19 → 1.29.0

package/build/defs.d.ts

@@ -0,0 +1,20 @@
+export declare const WEBSERVER = "webserver";
+export declare const CHECK_LISTENER = "CHECK_LISTENER";
+import * as express from 'express';
+export interface IWebServer {
+    checkAddStaticFolder(subdir: string, loc: string): undefined | string;
+    checkAddIndexFolder(subdir: string, loc: string): undefined | string;
+    addKnownStaticFolder(subdir: string, mountAt?: string): undefined | string;
+    listen(): Promise<unknown>;
+    close(): Promise<void>;
+    mounted: {
+        get: object;
+        post: object;
+    };
+    addRoute(type: TRouteTypes, path: string, route: TRequestHandler): void;
+    use(middleware: express.RequestHandler): void;
+}
+export type TRouteTypes = 'get' | 'post';
+export type IRequest = typeof express.request;
+export type IResponse = typeof express.response;
+export type TRequestHandler = (req: IRequest, res: IResponse) => void;

package/build/defs.js

@@ -0,0 +1,3 @@
+export const WEBSERVER = 'webserver';
+export const CHECK_LISTENER = 'CHECK_LISTENER';
+//# sourceMappingURL=defs.js.map

package/build/defs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defs.js","sourceRoot":"","sources":["../src/defs.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC"}

package/build/server-express.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" resolution-mode="require"/>
+import http from 'http';
+import { RequestHandler } from 'express';
+import { IWebServer, TRouteTypes } from './defs.js';
+import { ILogger } from '@haibun/core/build/lib/interfaces/logger.js';
+export declare const DEFAULT_PORT = 8123;
+export declare class ServerExpress implements IWebServer {
+    logger: ILogger;
+    static listening: boolean;
+    listener?: http.Server;
+    app: import("express-serve-static-core").Express;
+    mounted: {
+        get: {};
+        post: {};
+    };
+    base: string;
+    port: number;
+    constructor(logger: ILogger, base: string, port?: number);
+    use(middleware: RequestHandler): void;
+    listen(): Promise<unknown>;
+    addRoute(type: TRouteTypes, path: string, route: RequestHandler): void;
+    private addMounted;
+    checkAddStaticFolder(relativeFolder: string, mountAt?: string): string;
+    checkAddIndexFolder(relativeFolder: string, mountAt?: string): string;
+    addKnownStaticFolder(folder: string, mountAt?: string): string;
+    private doAddStaticFolder;
+    checkMountBadOrMounted(type: string, loc: string, what: string): string;
+    close(): Promise<void>;
+}

package/build/server-express.js

@@ -0,0 +1,114 @@
+import { statSync, existsSync } from 'fs';
+import express from 'express';
+import serveIndex from 'serve-index';
+import cookieParser from 'cookie-parser';
+export const DEFAULT_PORT = 8123;
+export class ServerExpress {
+    logger;
+    static listening = false;
+    listener;
+    app = express();
+    mounted = { get: {}, post: {} };
+    base;
+    port;
+    constructor(logger, base, port = DEFAULT_PORT) {
+        this.logger = logger;
+        this.base = base;
+        this.port = port;
+        this.app.use(cookieParser());
+        this.app.use(express.json({ limit: '50mb' }));
+    }
+    use(middleware) {
+        this.app.use(middleware);
+    }
+    listen() {
+        return new Promise((resolve, reject) => {
+            if (!ServerExpress.listening) {
+                try {
+                    this.listener = this.app.listen(this.port, () => {
+                        this.logger.log(`Server listening on port: ${this.port}`);
+                        ServerExpress.listening = true;
+                        this.logger.log('express listening');
+                        resolve('started');
+                    });
+                }
+                catch (e) {
+                    reject(e);
+                }
+            }
+            else {
+                this.logger.log('express already listening');
+                resolve('already listening');
+            }
+        });
+    }
+    addRoute(type, path, route) {
+        if (type !== 'get' && type !== 'post') {
+            throw Error(`invalid route type ${type}`);
+        }
+        const bad = this.checkMountBadOrMounted('get', path, route.toString());
+        if (bad) {
+            throw Error(bad);
+        }
+        this.logger.log(`adding ${type} route from ${path}`);
+        this.app[type](path, route);
+        this.addMounted(type, path, route.toString());
+    }
+    addMounted(type, path, what) {
+        this.mounted[type][path] = what;
+    }
+    // add a static folder restricted to relative paths from files
+    checkAddStaticFolder(relativeFolder, mountAt = '/') {
+        const folder = [this.base, relativeFolder].join('/');
+        return this.doAddStaticFolder(folder, mountAt);
+    }
+    // add a index folder restricted to relative paths from files
+    checkAddIndexFolder(relativeFolder, mountAt = '/') {
+        const folder = [this.base, relativeFolder].join('/');
+        const bad = this.checkMountBadOrMounted('get', folder, mountAt);
+        if (bad) {
+            return bad;
+        }
+        this.logger.info(`serving index from ${folder} at ${mountAt}`);
+        this.app.use(mountAt, serveIndex(folder), express.static(folder));
+        return;
+    }
+    // add a static folder at any path
+    addKnownStaticFolder(folder, mountAt = '/') {
+        return this.doAddStaticFolder(folder, mountAt);
+    }
+    doAddStaticFolder(folder, mountAt = '/') {
+        const bad = this.checkMountBadOrMounted('get', mountAt, folder);
+        if (bad) {
+            return bad;
+        }
+        if (!existsSync(folder)) {
+            return `"${folder}" doesn't exist`;
+        }
+        const stat = statSync(folder);
+        if (!stat.isDirectory()) {
+            return `"${folder}" is not a directory`;
+        }
+        this.app.use(mountAt, express.static(folder));
+        this.addMounted('get', mountAt, folder);
+        this.logger.info(`serving files from ${folder} at ${mountAt}`);
+        return;
+    }
+    checkMountBadOrMounted(type, loc, what) {
+        if (loc !== loc.replace(/[^a-zA-Z-0-9/\-_]/g, '')) {
+            return `mount folder ${loc} has illegal characters`;
+        }
+        const alreadyMounted = this.mounted[type][loc] || Object.keys(this.mounted[type]).find((m) => m.startsWith(`${loc}/`));
+        if (alreadyMounted) {
+            return `cannot mount ${type} ${what} at ${loc}, ${alreadyMounted} is already mounted}`;
+        }
+        return undefined;
+    }
+    async close() {
+        this.logger.info(`closing server ${this.port}`);
+        await this.listener?.close();
+        this.mounted = { get: {}, post: {} };
+        ServerExpress.listening = false;
+    }
+}
+//# sourceMappingURL=server-express.js.map

package/build/server-express.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-express.js","sourceRoot":"","sources":["../src/server-express.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAG1C,OAAO,OAA2B,MAAM,SAAS,CAAC;AAClD,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,YAAY,MAAM,eAAe,CAAC;AAKzC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AAEjC,MAAM,OAAO,aAAa;IACxB,MAAM,CAAU;IAChB,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,QAAQ,CAAe;IACvB,GAAG,GAAG,OAAO,EAAE,CAAC;IAChB,OAAO,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAChC,IAAI,CAAS;IACb,IAAI,CAAS;IACb,YAAY,MAAe,EAAE,IAAY,EAAE,OAAe,YAAY;QACpE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,GAAG,CAAC,UAA0B;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;gBAC5B,IAAI;oBACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE;wBAC9C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;wBACzD,aAAa,CAAC,SAAS,GAAG,IAAI,CAAA;wBAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;wBACrC,OAAO,CAAC,SAAS,CAAC,CAAC;oBACrB,CAAC,CAAC,CAAC;iBACJ;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,CAAC,CAAC,CAAC,CAAC;iBACX;aACF;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;gBAC7C,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAC9B;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,IAAiB,EAAE,IAAY,EAAE,KAAqB;QAC7D,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,EAAE;YACrC,MAAM,KAAK,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;SAC3C;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,GAAG,EAAE;YACP,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;SAClB;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,IAAI,eAAe,IAAI,EAAE,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAE5B,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAEO,UAAU,CAAC,IAAY,EAAE,IAAY,EAAE,IAAY;QACzD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAClC,CAAC;IAED,8DAA8D;IAC9D,oBAAoB,CAAC,cAAsB,EAAE,OAAO,GAAG,GAAG;QACxD,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,6DAA6D;IAC7D,mBAAmB,CAAC,cAAsB,EAAE,OAAO,GAAG,GAAG;QACvD,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,OAAO,OAAO,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAClE,OAAO;IACT,CAAC;IAED,kCAAkC;IAClC,oBAAoB,CAAC,MAAc,EAAE,OAAO,GAAG,GAAG;QAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAEO,iBAAiB,CAAC,MAAc,EAAE,OAAO,GAAG,GAAG;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAChE,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YACvB,OAAO,IAAI,MAAM,iBAAiB,CAAC;SACpC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;YACvB,OAAO,IAAI,MAAM,sBAAsB,CAAC;SACzC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,OAAO,OAAO,EAAE,CAAC,CAAC;QAC/D,OAAO;IACT,CAAC;IAED,sBAAsB,CAAC,IAAY,EAAE,GAAW,EAAE,IAAY;QAC5D,IAAI,GAAG,KAAK,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,EAAE;YACjD,OAAO,gBAAgB,GAAG,yBAAyB,CAAC;SACrD;QACD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;QAC/H,IAAI,cAAc,EAAE;YAClB,OAAO,gBAAgB,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,cAAc,sBAAsB,CAAC;SACxF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACrC,aAAa,CAAC,SAAS,GAAG,KAAK,CAAC;IAClC,CAAC"}

package/build/server-express.test.d.ts

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

package/build/server-express.test.js

@@ -0,0 +1,17 @@
+import { ServerExpress } from "./server-express.js";
+import TestLogger from '@haibun/core/build/lib/TestLogger.js';
+describe('mounts', () => {
+    it('mounts a route', () => {
+        const tl = new TestLogger();
+        const se = new ServerExpress(tl, '/', 8999);
+        se.listen = async () => 'started';
+        expect(() => se.addRoute('get', '/', () => undefined)).not.toThrow();
+    });
+    it.skip('throws instead of double mounting a route', () => {
+        const tl = new TestLogger();
+        const se = new ServerExpress(tl, '/', 8999);
+        se.listen = async () => 'started';
+        expect(async () => await se.addRoute('get', '/', () => undefined)).rejects.toThrow();
+    });
+});
+//# sourceMappingURL=server-express.test.js.map

package/build/server-express.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-express.test.js","sourceRoot":"","sources":["../src/server-express.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,UAAU,MAAM,sCAAsC,CAAC;AAE9D,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACtB,MAAM,EAAE,GAAG,IAAI,UAAU,EAAE,CAAC;QAC5B,MAAM,EAAE,GAAG,IAAI,aAAa,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,EAAE,CAAC,MAAM,GAAG,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACtD,MAAM,EAAE,GAAG,IAAI,UAAU,EAAE,CAAC;QAC5B,MAAM,EAAE,GAAG,IAAI,aAAa,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,EAAE,CAAC,MAAM,GAAG,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACzF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/build/web-server-stepper-route.test.d.ts

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

package/build/web-server-stepper-route.test.js

@@ -0,0 +1,35 @@
+import WebHttp from '@haibun/web-http/build/web-http.js';
+import { actionOK, getFromRuntime, getStepperOptionName } from '@haibun/core/build/lib/util/index.js';
+import { DEFAULT_DEST } from '@haibun/core/build/lib/defs.js';
+import { WEBSERVER } from './defs.js';
+import Server from './web-server-stepper.js';
+import { AStepper } from '@haibun/core/build/lib/defs.js';
+import { testWithDefaults } from '@haibun/core/build/lib/test/lib.js';
+import WebServerStepper from './web-server-stepper.js';
+describe('route mount', () => {
+    it.skip('mounts a route', async () => {
+        const TestRoute = class TestRoute extends AStepper {
+            steps = {
+                addRoute: {
+                    gwta: 'serve test route to {loc}',
+                    action: async ({ loc }) => {
+                        const route = (req, res) => res.status(200).send('ok');
+                        const webserver = await getFromRuntime(this.getWorld().runtime, WEBSERVER);
+                        await webserver.addRoute('get', loc, route);
+                        return actionOK();
+                    },
+                },
+            };
+        };
+        const wss = new WebServerStepper();
+        const feature = { path: '/features/test.feature', content: `serve test route to /test\nwebserver is listening\nfetch from http://localhost:8124/test is "ok"` };
+        const result = await testWithDefaults([feature], [Server, TestRoute, WebHttp], {
+            options: { DEST: DEFAULT_DEST, },
+            extraOptions: {
+                [getStepperOptionName(wss, 'PORT')]: '8124',
+            },
+        });
+        expect(result.ok).toBe(true);
+    });
+});
+//# sourceMappingURL=web-server-stepper-route.test.js.map

package/build/web-server-stepper-route.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-server-stepper-route.test.js","sourceRoot":"","sources":["../src/web-server-stepper-route.test.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,oCAAoC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AACtG,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAmC,SAAS,EAAE,MAAM,WAAW,CAAC;AAEvE,OAAO,MAAM,MAAM,yBAAyB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAU,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAEvD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,SAAS,GAAG,MAAM,SAAU,SAAQ,QAAQ;YAChD,KAAK,GAAG;gBACN,QAAQ,EAAE;oBACR,IAAI,EAAE,2BAA2B;oBACjC,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAU,EAAE,EAAE;wBAChC,MAAM,KAAK,GAAG,CAAC,GAAa,EAAE,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC5E,MAAM,SAAS,GAAe,MAAM,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;wBACvF,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;wBAC5C,OAAO,QAAQ,EAAE,CAAC;oBACpB,CAAC;iBACF;aACF,CAAC;SACH,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,kGAAkG,EAAE,CAAC;QAChK,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE;YAC7E,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,GAAG;YAChC,YAAY,EAAE;gBACZ,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM;aAC5C;SACF,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/web-server-stepper.d.ts

@@ -0,0 +1,65 @@
+import { TWorld, TNamed, TOptions, AStepper, TVStep } from '@haibun/core/build/lib/defs.js';
+import { IWebServer } from './defs.js';
+import { ServerExpress } from './server-express.js';
+declare const WebServerStepper: {
+    new (): {
+        webserver: ServerExpress | undefined;
+        options: {
+            PORT: {
+                desc: string;
+                parse: (port: string) => {
+                    error: string;
+                    result?: undefined;
+                } | {
+                    result: number;
+                    error?: undefined;
+                };
+            };
+        };
+        setWorld(world: TWorld, steppers: AStepper[]): void;
+        close(): Promise<void>;
+        steps: {
+            thisURI: {
+                gwta: string;
+                action: ({ where }: TNamed, vstep: TVStep) => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+            };
+            isListening: {
+                gwta: string;
+                action: () => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+            };
+            showMounts: {
+                gwta: string;
+                action: () => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+            };
+            serveFilesAt: {
+                gwta: string;
+                action: ({ where, loc }: TNamed) => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+            };
+            serveFiles: {
+                gwta: string;
+                action: ({ loc }: TNamed) => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult | import("@haibun/core/build/lib/defs.js").TNotOKActionResult>;
+            };
+            indexFiles: {
+                gwta: string;
+                action: ({ loc }: TNamed) => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult | import("@haibun/core/build/lib/defs.js").TNotOKActionResult>;
+            };
+            indexFilesAt: {
+                gwta: string;
+                action: ({ where, loc }: TNamed) => Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult | import("@haibun/core/build/lib/defs.js").TNotOKActionResult>;
+            };
+        };
+        doServeIndex(where: any, loc: any): Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+        doServeFiles(where: any, loc: any): Promise<import("@haibun/core/build/lib/defs.js").TOKActionResult>;
+        listen(): Promise<void>;
+        world?: TWorld;
+        endFeature?(): void;
+        onFailure?(result: import("@haibun/core/build/lib/defs.js").TStepResult): void;
+        getWorld(): TWorld;
+    };
+};
+export default WebServerStepper;
+export type ICheckListener = (options: TOptions, webserver: IWebServer) => void;
+export interface IWebServerStepper {
+    webserver: IWebServer;
+    close: () => void;
+}

package/build/web-server-stepper.js

@@ -0,0 +1,103 @@
+import { OK, AStepper, } from '@haibun/core/build/lib/defs.js';
+import { actionNotOK, getFromRuntime, getStepperOption, intOrError } from '@haibun/core/build/lib/util/index.js';
+import { WEBSERVER, } from './defs.js';
+import { ServerExpress, DEFAULT_PORT } from './server-express.js';
+import { WEB_PAGE } from '@haibun/domain-webpage/build/domain-webpage.js';
+const WebServerStepper = class WebServerStepper extends AStepper {
+    webserver;
+    options = {
+        PORT: {
+            desc: `change web server port from ${DEFAULT_PORT}`,
+            parse: (port) => intOrError(port)
+        },
+    };
+    setWorld(world, steppers) {
+        super.setWorld(world, steppers);
+        // this.world.runtime[CHECK_LISTENER] = WebServerStepper.checkListener;
+        const port = parseInt(getStepperOption(this, 'PORT', world.extraOptions)) || DEFAULT_PORT;
+        this.webserver = new ServerExpress(world.logger, [process.cwd(), 'files'].join('/'), port);
+        world.runtime[WEBSERVER] = this.webserver;
+    }
+    async close() {
+        await this.webserver?.close();
+    }
+    steps = {
+        thisURI: {
+            gwta: `a ${WEB_PAGE} at {where}`,
+            action: async ({ where }, vstep) => {
+                const page = vstep.source.name;
+                const webserver = getFromRuntime(this.getWorld().runtime, WEBSERVER);
+                await webserver.checkAddStaticFolder(page, where);
+                return OK;
+            },
+        },
+        /// generator
+        isListening: {
+            gwta: 'webserver is listening',
+            action: async () => {
+                await this.listen();
+                return OK;
+            },
+        },
+        showMounts: {
+            gwta: 'show mounts',
+            action: async () => {
+                const webserver = getFromRuntime(this.getWorld().runtime, WEBSERVER);
+                const mounts = webserver.mounted;
+                this.getWorld().logger.info(`mounts: ${JSON.stringify(mounts)}`);
+                return OK;
+            },
+        },
+        serveFilesAt: {
+            gwta: 'serve files at {where} from {loc}',
+            action: async ({ where, loc }) => {
+                await this.doServeFiles(where, loc).catch((e) => actionNotOK(e));
+                return OK;
+            },
+        },
+        serveFiles: {
+            gwta: 'serve files from {loc}',
+            action: async ({ loc }) => {
+                const r = await this.doServeFiles('/', loc).catch((e) => actionNotOK(e));
+                return r;
+            }
+        },
+        indexFiles: {
+            gwta: 'index files from {loc}',
+            action: async ({ loc }) => {
+                const r = await this.doServeIndex('/', loc).catch((e) => actionNotOK(e));
+                return r;
+            }
+        },
+        indexFilesAt: {
+            gwta: 'index files at {where} from {loc}',
+            action: async ({ where, loc }) => {
+                const r = await this.doServeIndex(where, loc).catch((e) => actionNotOK(e));
+                return r;
+            }
+        }
+    };
+    async doServeIndex(where, loc) {
+        const ws = getFromRuntime(this.getWorld().runtime, WEBSERVER);
+        const res = ws.checkAddIndexFolder(loc, where);
+        if (res) {
+            throw Error(`failed to add index folder ${loc} at ${where}`);
+        }
+        await this.listen();
+        return OK;
+    }
+    async doServeFiles(where, loc) {
+        const ws = getFromRuntime(this.getWorld().runtime, WEBSERVER);
+        const res = ws.checkAddStaticFolder(loc, where);
+        if (res) {
+            throw Error(`failed to add static folder ${loc} at ${where}`);
+        }
+        await this.listen();
+        return OK;
+    }
+    async listen() {
+        await this.webserver.listen();
+    }
+};
+export default WebServerStepper;
+//# sourceMappingURL=web-server-stepper.js.map

package/build/web-server-stepper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-server-stepper.js","sourceRoot":"","sources":["../src/web-server-stepper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,EAAE,EAA4B,QAAQ,GAAW,MAAM,gCAAgC,CAAC;AAC9G,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACjH,OAAO,EAAc,SAAS,GAAG,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,gDAAgD,CAAC;AAE1E,MAAM,gBAAgB,GAAG,MAAM,gBAAiB,SAAQ,QAAQ;IAC9D,SAAS,CAA4B;IAErC,OAAO,GAAG;QACR,IAAI,EAAE;YACJ,IAAI,EAAE,+BAA+B,YAAY,EAAE;YACnD,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;SAC1C;KACF,CAAC;IAEF,QAAQ,CAAC,KAAa,EAAE,QAAoB;QAC1C,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChC,uEAAuE;QACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,YAAY,CAAC;QAC1F,IAAI,CAAC,SAAS,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;QAC3F,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,GAAG;QACN,OAAO,EAAE;YACP,IAAI,EAAE,KAAK,QAAQ,aAAa;YAChC,MAAM,EAAE,KAAK,EAAE,EAAE,KAAK,EAAU,EAAE,KAAa,EAAE,EAAE;gBACjD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;gBAE/B,MAAM,SAAS,GAAe,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACjF,MAAM,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAClD,OAAO,EAAE,CAAC;YACZ,CAAC;SACF;QACD,aAAa;QACb,WAAW,EAAE;YACX,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;YACZ,CAAC;SACF;QACD,UAAU,EAAE;YACV,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,MAAM,SAAS,GAAe,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACjF,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;gBACjC,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACjE,OAAO,EAAE,CAAC;YACZ,CAAC;SACF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAU,EAAE,EAAE;gBACvC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjE,OAAO,EAAE,CAAC;YACZ,CAAC;SACF;QACD,UAAU,EAAE;YACV,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAU,EAAE,EAAE;gBAChC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzE,OAAO,CAAC,CAAC;YACX,CAAC;SACF;QACD,UAAU,EAAE;YACV,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAU,EAAE,EAAE;gBAChC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzE,OAAO,CAAC,CAAC;YACX,CAAC;SACF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAU,EAAE,EAAE;gBACvC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3E,OAAO,CAAC,CAAC;YACX,CAAC;SACF;KACF,CAAA;IACD,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG;QAC3B,MAAM,EAAE,GAAe,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/C,IAAI,GAAG,EAAE;YACP,MAAM,KAAK,CAAC,8BAA8B,GAAG,OAAO,KAAK,EAAE,CAAC,CAAC;SAC9D;QACD,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG;QAC3B,MAAM,EAAE,GAAe,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,EAAE,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChD,IAAI,GAAG,EAAE;YACP,MAAM,KAAK,CAAC,+BAA+B,GAAG,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/D;QACD,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;CACF,CAAC;AACF,eAAe,gBAAgB,CAAC"}

package/build/web-server-stepper.test.d.ts

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

package/build/web-server-stepper.test.js

@@ -0,0 +1,39 @@
+import { testWithDefaults } from '@haibun/core/build/lib/test/lib.js';
+import WebHttp from '@haibun/web-http/build/web-http.js';
+import server from './web-server-stepper.js';
+describe('static mount', () => {
+    it('serves files', async () => {
+        const feature = { path: '/features/test.feature', content: `serve files from test\nfetch from http://localhost:8123/testfile matches "content"` };
+        const result = await testWithDefaults([feature], [server, WebHttp]);
+        expect(result.ok).toBe(true);
+    });
+    it('restricts characters used in static mount folder name', async () => {
+        const feature = { path: '/features/test.feature', content: `serve files from l*(*$\n` };
+        const result = await testWithDefaults([feature], [server]);
+        expect(result.ok).toBe(false);
+    });
+    it("doesn't re-mount same static mount", async () => {
+        const feature = { path: '/features/test.feature', content: `serve files from test\nserve files from test\n` };
+        const result = await testWithDefaults([feature], [server]);
+        expect(result.ok).toBe(false);
+    });
+    it("doesn't permit different static mount", async () => {
+        const feature = { path: '/features/test.feature', content: `serve files from test\nserve files from fails\n` };
+        const result = await testWithDefaults([feature], [server]);
+        expect(result.ok).toBe(false);
+    });
+});
+describe.skip('index mount', () => {
+    // FIXME: This fails when both tests are run
+    it('index files at', async () => {
+        const feature = { path: '/features/test.feature', content: `index files at /test from test\nfetch from http://localhost:8123/test/ contains href="/test/testfile"\nfetch from http://localhost:8123/test/testfile matches "content"` };
+        const result = await testWithDefaults([feature], [server, WebHttp]);
+        expect(result.ok).toBe(true);
+    });
+    it('index files', async () => {
+        const feature = { path: '/features/test.feature', content: `index files from test\nfetch from http://localhost:8123/ contains href="/testfile"\nfetch from http://localhost:8123/testfile matches "content"` };
+        const result = await testWithDefaults([feature], [server, WebHttp]);
+        expect(result.ok).toBe(true);
+    });
+});
+//# sourceMappingURL=web-server-stepper.test.js.map

package/build/web-server-stepper.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-server-stepper.test.js","sourceRoot":"","sources":["../src/web-server-stepper.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,OAAO,MAAM,oCAAoC,CAAC;AAEzD,OAAO,MAAM,MAAM,yBAAyB,CAAC;AAE7C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QAC5B,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,oFAAoF,EAAE,CAAC;QAClJ,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAA;QACvF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,gDAAgD,EAAE,CAAA;QAC7G,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,iDAAiD,EAAE,CAAA;QAC9G,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE;IAChC,4CAA4C;IAC5C,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAC9B,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,yKAAyK,EAAE,CAAC;QACvO,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QAC3B,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,iJAAiJ,EAAE,CAAC;QAC/M,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@haibun/web-server-express",
   "type": "module",
-  "version": "1.28.19",
+  "version": "1.29.0",
   "description": "",
   "main": "build/web-server-stepper.js",
   "files": [
@@ -20,14 +20,14 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@haibun/core": "1.28.19",
-    "@haibun/domain-webpage": "1.28.19",
+    "@haibun/core": "1.29.0",
+    "@haibun/domain-webpage": "1.29.0",
     "cookie-parser": "^1.4.5",
     "express": "^4.17.1",
     "serve-index": "^1.9.1"
   },
   "devDependencies": {
-    "@haibun/web-http": "1.28.19",
+    "@haibun/web-http": "1.29.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express": "^4.17.15"
   },