api-machine 1.0.0

package/server/server.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestServer = void 0;
+const tslib_1 = require("tslib");
+const express_1 = tslib_1.__importDefault(require("express"));
+const cors_1 = tslib_1.__importDefault(require("cors"));
+const server_options_1 = require("./server-options");
+const error_1 = require("../error");
+const routes_1 = require("../oas/routes");
+class RestServer {
+    name = 'RestServer';
+    description = 'REST API Server';
+    version = '';
+    router;
+    routerInstance;
+    port;
+    maxPayloadSizeMB;
+    maxUrlEncodedSizeMB;
+    securityHeaders;
+    swaggerEnabled = false;
+    authentication;
+    app;
+    listener;
+    log;
+    constructor(options) {
+        options = { ...server_options_1.defaultRestServerOptions, ...options };
+        this.port = options.port;
+        this.maxPayloadSizeMB = options.maxPayloadSizeMB;
+        this.maxUrlEncodedSizeMB = options.maxUrlEncodedSizeMB;
+        this.log = options.log;
+        this.securityHeaders = {
+            ...server_options_1.defaultRestServerOptions.securityHeaders,
+            ...options.securityHeaders,
+        };
+        this.swaggerEnabled = options.swaggerEnabled ?? false;
+        this.authentication = options.authentication;
+    }
+    async start() {
+        await this.setupExpress();
+        await this.createRouter();
+        await this.registerAuthentication();
+        await this.registerRoutes();
+        await this.registerSwagger();
+        await this.setup404Handler();
+        await this.setupErrorHandler();
+        await this.startListening();
+    }
+    async stop() {
+        if (this.listener) {
+            this.listener.close();
+        }
+    }
+    async createRouter() {
+        this.routerInstance = new this.router();
+    }
+    async registerAuthentication() {
+        // Set server authentication on router instance if not already set
+        if (this.authentication &&
+            this.routerInstance.authentication === undefined) {
+            this.routerInstance.authentication = this.authentication;
+        }
+    }
+    async registerRoutes() {
+        await this.routerInstance.register(this.app, '');
+    }
+    async registerSwagger() {
+        if (this.swaggerEnabled) {
+            await (0, routes_1.oasRoutes)({
+                router: this.app,
+                server: this,
+            });
+        }
+    }
+    async setupExpress() {
+        this.app = (0, express_1.default)();
+        await this.setupSecurityHeaders();
+        await this.setupExpressCors();
+        await this.setupExpressJson();
+        await this.setupExpressUrlEncoded();
+    }
+    async setupSecurityHeaders() {
+        // Disable X-Powered-By header to prevent server fingerprinting
+        if (this.securityHeaders.disableXPoweredBy) {
+            this.app.disable('x-powered-by');
+        }
+        // Add security headers middleware
+        this.app.use((request, response, next) => {
+            // X-Content-Type-Options: nosniff
+            if (this.securityHeaders.noSniff) {
+                response.setHeader('X-Content-Type-Options', 'nosniff');
+            }
+            // X-Frame-Options
+            if (this.securityHeaders.frameOptions) {
+                response.setHeader('X-Frame-Options', this.securityHeaders.frameOptions);
+            }
+            // X-XSS-Protection
+            if (this.securityHeaders.xssProtection) {
+                response.setHeader('X-XSS-Protection', '1; mode=block');
+            }
+            // Strict-Transport-Security (HSTS)
+            if (this.securityHeaders.hsts) {
+                const hstsValue = `max-age=${this.securityHeaders.hsts}; ` +
+                    'includeSubDomains';
+                response.setHeader('Strict-Transport-Security', hstsValue);
+            }
+            next();
+        });
+    }
+    async setupExpressCors() {
+        this.app.use((0, cors_1.default)());
+    }
+    async setupExpressJson() {
+        this.app.use(express_1.default.json({ limit: `${this.maxPayloadSizeMB}mb` }));
+    }
+    async setupExpressUrlEncoded() {
+        this.app.use(express_1.default.urlencoded({
+            extended: true,
+            limit: `${this.maxUrlEncodedSizeMB}mb`,
+        }));
+    }
+    async setup404Handler() {
+        this.app.use(() => {
+            throw new error_1.NotFoundError('The requested endpoint does not exist.');
+        });
+    }
+    async setupErrorHandler() {
+        this.app.use((error, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        request, response, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        next) => {
+            // Handle HTTPError instances
+            if (error instanceof error_1.HTTPError) {
+                // Set custom headers if provided
+                Object.entries(error.headers).forEach(([key, value]) => {
+                    response.setHeader(key, value);
+                });
+                return response
+                    .status(error.getStatusCode())
+                    .json(error.getResponseJson());
+            }
+            if (error instanceof Error &&
+                'expose' in error &&
+                error.expose === true) {
+                let statusCode = 500;
+                if ('statusCode' in error) {
+                    statusCode = error
+                        .statusCode;
+                }
+                return response.status(statusCode).json({
+                    error: error.name,
+                    message: error.message,
+                });
+            }
+            // Handle generic errors
+            this.log?.error('Unhandled error:', error);
+            return response.status(500).json({
+                error: 'InternalServerError',
+                message: 'Internal server error',
+                timestamp: new Date().toISOString(),
+                options: {},
+            });
+        });
+    }
+    async startListening() {
+        await new Promise((accept, reject) => {
+            this.listener = this.app.listen(this.port, (error) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                accept();
+            });
+        });
+    }
+}
+exports.RestServer = RestServer;
+//# sourceMappingURL=server.js.map

package/server/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":";;;;AAAA,8DAA8B;AAC9B,wDAAwB;AAGxB,qDAA+E;AAE/E,oCAAmE;AAInE,0CAA0C;AAE1C,MAAsB,UAAU;IACxB,IAAI,GAAG,YAAY,CAAC;IACpB,WAAW,GAAG,iBAAiB,CAAC;IAChC,OAAO,GAAG,EAAE,CAAC;IAEb,MAAM,CAAY;IAClB,cAAc,CAAgB;IAErB,IAAI,CAAS;IACb,gBAAgB,CAAS;IACzB,mBAAmB,CAAS;IAC5B,eAAe,CAAuC;IAC/D,cAAc,GAAG,KAAK,CAAC;IACvB,cAAc,CAAwB;IAEnC,GAAG,CAAkB;IACrB,QAAQ,CAAc;IACtB,GAAG,CAAe;IAE5B,YAAY,OAAmC;QAC9C,OAAO,GAAG,EAAE,GAAG,yCAAwB,EAAE,GAAG,OAAO,EAAE,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAK,CAAC;QAC1B,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAiB,CAAC;QAClD,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAoB,CAAC;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAI,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG;YACtB,GAAG,yCAAwB,CAAC,eAAe;YAC3C,GAAG,OAAO,CAAC,eAAe;SAC1B,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;QACtD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACpC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,IAAI;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC;IACF,CAAC;IAES,KAAK,CAAC,YAAY;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IAES,KAAK,CAAC,sBAAsB;QACrC,kEAAkE;QAClE,IACC,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,cAAc,CAAC,cAAc,KAAK,SAAS,EAC/C,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1D,CAAC;IACF,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAClD,CAAC;IAES,KAAK,CAAC,eAAe;QAC9B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAA,kBAAS,EAAC;gBACf,MAAM,EAAE,IAAI,CAAC,GAAG;gBAChB,MAAM,EAAE,IAAI;aACZ,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAES,KAAK,CAAC,YAAY;QAC3B,IAAI,CAAC,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;QACrB,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9B,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9B,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,oBAAoB;QACnC,+DAA+D;QAC/D,IAAI,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,kCAAkC;QAClC,IAAI,CAAC,GAAG,CAAC,GAAG,CACX,CACC,OAAwB,EACxB,QAA0B,EAC1B,IAA0B,EACzB,EAAE;YACH,kCAAkC;YAClC,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;gBAClC,QAAQ,CAAC,SAAS,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;YACzD,CAAC;YAED,kBAAkB;YAClB,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,CAAC;gBACvC,QAAQ,CAAC,SAAS,CACjB,iBAAiB,EACjB,IAAI,CAAC,eAAe,CAAC,YAAY,CACjC,CAAC;YACH,CAAC;YAED,mBAAmB;YACnB,IAAI,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,CAAC;gBACxC,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;YACzD,CAAC;YAED,mCAAmC;YACnC,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;gBAC/B,MAAM,SAAS,GACd,WAAW,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI;oBACxC,mBAAmB,CAAC;gBACrB,QAAQ,CAAC,SAAS,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAC;YAC5D,CAAC;YAED,IAAI,EAAE,CAAC;QACR,CAAC,CACD,CAAC;IACH,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,GAAE,CAAC,CAAC;IACtB,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IAES,KAAK,CAAC,sBAAsB;QACrC,IAAI,CAAC,GAAG,CAAC,GAAG,CACX,iBAAO,CAAC,UAAU,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,GAAG,IAAI,CAAC,mBAAmB,IAAI;SACtC,CAAC,CACF,CAAC;IACH,CAAC;IAES,KAAK,CAAC,eAAe;QAC9B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;YACjB,MAAM,IAAI,qBAAa,CAAC,wCAAwC,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,iBAAiB;QAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CACX,CACC,KAAqB;QACrB,6DAA6D;QAC7D,OAAwB,EACxB,QAA0B;QAC1B,6DAA6D;QAC7D,IAA0B,EACzB,EAAE;YACH,6BAA6B;YAC7B,IAAI,KAAK,YAAY,iBAAS,EAAE,CAAC;gBAChC,iCAAiC;gBACjC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBACtD,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;gBAEH,OAAO,QAAQ;qBACb,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;qBAC7B,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC;YACjC,CAAC;YAED,IACC,KAAK,YAAY,KAAK;gBACtB,QAAQ,IAAI,KAAK;gBAChB,KAA6B,CAAC,MAAM,KAAK,IAAI,EAC7C,CAAC;gBACF,IAAI,UAAU,GAAG,GAAG,CAAC;gBAErB,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;oBAC3B,UAAU,GAAI,KAAgC;yBAC5C,UAAU,CAAC;gBACd,CAAC;gBAED,OAAO,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAgB;oBACtD,KAAK,EAAE,KAAK,CAAC,IAAI;oBACjB,OAAO,EAAE,KAAK,CAAC,OAAO;iBACtB,CAAC,CAAC;YACJ,CAAC;YAED,wBAAwB;YACxB,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;YAE3C,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAgB;gBAC/C,KAAK,EAAE,qBAAqB;gBAC5B,OAAO,EAAE,uBAAuB;gBAChC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,OAAO,EAAE,EAAE;aACX,CAAC,CAAC;QACJ,CAAC,CACD,CAAC;IACH,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,IAAI,OAAO,CAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAa,EAAE,EAAE;gBAC5D,IAAI,KAAK,EAAE,CAAC;oBACX,MAAM,CAAC,KAAK,CAAC,CAAC;oBACd,OAAO;gBACR,CAAC;gBAED,MAAM,EAAE,CAAC;YACV,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AA1ND,gCA0NC"}