feat: serving files from 'public' folder (#23)

* feat: setup create route for each static file

* feat: add mime detection

* test: add sample image

* feat: add file paths

* fix: removed unused file

* feat: add cli option for public folder

* feat: add static files path cli option

* Revert "feat: add static files path cli option"

This reverts commit 88306ce.

* fix: remove leftover

package.json

@@ -46,6 +46,7 @@
 		"dotenv": "^16.3.1",
 		"live-directory": "^3.0.3",
 		"lodash": "^4.17.21",
+		"mime": "^4.0.0",
 		"pino": "^8.16.2",
 		"uWebSockets.js": "github:uNetworking/uWebSockets.js#semver:^20",
 		"zenroom": "^4.2.2"

public/test.txt

@@ -0,0 +1 @@
+helo

src/cli.ts

@@ -32,6 +32,18 @@ program
 				}
 			})
 	)
+	.addOption(
+		new Option('--public-directory <directory>', 'specify the static files directory')
+			.env('PUBLIC_DIR')
+			.argParser((d) => {
+				try {
+					if (statSync(d).isDirectory()) return d;
+				} catch (e) {
+					L.error(`${bad} ${d} is not a valid directory`);
+					process.exit(0);
+				}
+			})
+	)
 	.addOption(
 		new Option(
 			'-p, --port <number>',

src/index.ts

@@ -23,9 +23,13 @@ import {
 	openapiTemplate
 } from './openapi.js';
 import { getSchema, handleArrayBuffer, validateData } from './utils.js';
+import mime from 'mime';
+import path from 'path';
+import fs from 'fs';
 
 const L = config.logger;
 const Dir = Directory.getInstance();
+
 Dir.ready(async () => {
 	let listen_socket: us_listen_socket;
 
@@ -59,6 +63,20 @@ Dir.ready(async () => {
 
 	generateRoutes(app);
 
+	const { publicDirectory } = config;
+	if (publicDirectory) {
+		app.get('/*', (res, req) => {
+			let file = path.join(publicDirectory, req.getUrl());
+			if (fs.existsSync(file)) {
+				const contentType = mime.getType(file) || 'application/octet-stream';
+				res.writeHeader('Content-Type', contentType);
+				res.end(fs.readFileSync(file));
+			} else {
+				res.writeStatus('404 Not Found').end('Not found');
+			}
+		});
+	}
+
 	app.listen(config.port, (socket) => {
 		const port = us_socket_local_port(socket);
 		listen_socket = socket;
@@ -71,6 +89,7 @@ Dir.ready(async () => {
 			us_listen_socket_close(listen_socket);
 			const app = App();
 			generateRoutes(app);
+			// generatePublicFilesRoutes(app);
 			app.listen(port, (socket) => {
 				listen_socket = socket;
 				L.info(`Swagger UI is running on http://${config.hostname}:${port}/docs`);

src/types.ts

@@ -18,6 +18,7 @@ export interface Config {
 	openapiPath: string;
 	template: string;
 	logger: Logger;
+	publicDirectory: string | undefined;
 }
 
 export interface Endpoints {