Server/scripts/util/getRouteDescriptions.js

/*
	ValkyrieChat: A re-implementation and extension of the Discord.com backend.
	Copyright (C) 2024 ValkyrieChat
	
	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at
	
	http://www.apache.org/licenses/LICENSE-2.0
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

const express = require("express");
const path = require("path");
const { traverseDirectory } = require("lambert-server");
const RouteUtility = require("../../dist/api/util/handlers/route.js");

const methods = ["get", "post", "put", "delete", "patch"];
const routes = new Map();
let currentFile = "";
let currentPath = "";

/*
	For some reason, if a route exports multiple functions, it won't be registered here!
	If someone could fix that I'd really appreciate it, but for now just, don't do that :p
*/

const proxy = (file, method, prefix, path, ...args) => {
	const opts = args.find((x) => x?.prototype?.OPTS_MARKER == true);
	if (!opts)
		return console.error(
			`${file} has route without route() description middleware`,
		);

	console.log(prefix + path + " - " + method);
	opts.file = file.replace("/dist/", "/src/").replace(".js", ".ts");
	routes.set(prefix + path + "|" + method, opts());
};

express.Router = () => {
	return Object.fromEntries(
		methods.map((method) => [
			method,
			proxy.bind(null, currentFile, method, currentPath),
		]),
	);
};

RouteUtility.route = (opts) => {
	const func = function () {
		return opts;
	};
	func.prototype.OPTS_MARKER = true;
	return func;
};

module.exports = function getRouteDescriptions() {
	const root = path.join(__dirname, "..", "..", "dist", "api", "routes", "/");
	traverseDirectory({ dirname: root, recursive: true }, (file) => {
		currentFile = file;

		currentPath = file.replace(root.slice(0, -1), "");
		currentPath = currentPath.split(".").slice(0, -1).join("."); // trancate .js/.ts file extension of path
		currentPath = currentPath.replaceAll("#", ":").replaceAll("\\", "/"); // replace # with : for path parameters and windows paths with slashes
		if (currentPath.endsWith("/index"))
			currentPath = currentPath.slice(0, "/index".length * -1); // delete index from path

		try {
			require(file);
		} catch (e) {
			console.error(e);
		}
	});

	return routes;
};