Merge pull request #22 from web-tech-tw/refactor-node-24-ts-9728651109116575249

Refactor to Node.js 24 erasableSyntaxOnly TypeScript

Author: supersonictw

app.js app.tsapp.js renamed to app.ts

@@ -1,30 +1,28 @@
-"use strict";
-
 // Import config
-const {
+import {
     runLoader,
     getEnvironmentOverview,
-} = require("./src/config");
+} from "./src/config.ts";
 
 // Load config
 runLoader();
 
 // Import constants
-const constant = require("./src/init/const");
+import * as constant from "./src/init/const.ts";
 
 // Import useApp
-const {useApp} = require("./src/init/express");
+import {useApp} from "./src/init/express.ts";
 
 // Initialize application
 const app = useApp();
 
 // Initialize prepare handlers
-const {
-    prepare: prepareDatabase,
-} = require("./src/init/database");
-const {
-    prepare: prepareListener,
-} = require("./src/init/listener");
+import {
+    prepare as prepareDatabase,
+} from "./src/init/database.ts";
+import {
+    prepare as prepareListener,
+} from "./src/init/listener.ts";
 
 const prepareHandlers = [
     prepareDatabase,
@@ -42,7 +40,7 @@ app.get("/robots.txt", (_, res) => {
 });
 
 // Load router dispatcher
-const routerDispatcher = require("./src/routes");
+import * as routerDispatcher from "./src/routes/index.ts";
 routerDispatcher.load();
 
 // Show banner message
@@ -54,7 +52,8 @@ routerDispatcher.load();
 })();
 
 // Mount application and execute it
-require("./src/execute")(app, prepareHandlers,
+import execute from "./src/execute.ts";
+execute(app, prepareHandlers,
     ({protocol, hostname, port}) => {
         console.info(`Protocol "${protocol}" is listening at`);
         console.info(`${protocol}://${hostname}:${port}`);

package.json

@@ -5,18 +5,18 @@
   "author": "Taiwan Web Technology Promotion Organization",
   "homepage": "https://web-tech.tw",
   "license": "MIT",
-  "main": "app.js",
+  "type": "module",
+  "main": "app.ts",
   "scripts": {
-    "export-openapi": "node export_openapi.js",
-    "dev": "nodemon app.js",
-    "start": "node app.js",
-    "lint": "npx lint-staged",
-    "lint:es": "eslint \"*.js\" \"src/**/*.js\"",
-    "lint:es:fix": "eslint \"*.js\" \"src/**/*.js\" --fix",
+    "export-openapi": "node export_openapi.ts",
+    "dev": "node --watch app.ts",
+    "start": "node app.ts",
+    "lint": "eslint .",
+    "type-check": "npx tsc --noEmit",
     "prepare": "husky install"
   },
   "lint-staged": {
-    "*.js": "eslint"
+    "*.ts": "eslint"
   },
   "dependencies": {
     "@discordjs/rest": "^2.4.0",
@@ -54,13 +54,27 @@
   "devDependencies": {
     "@commitlint/cli": "^17.4.4",
     "@commitlint/config-conventional": "^17.4.4",
+    "@eslint/js": "^9.21.0",
+    "@types/cors": "^2.8.17",
+    "@types/ejs": "^3.1.5",
+    "@types/express": "^5.0.0",
+    "@types/jsonwebtoken": "^9.0.8",
+    "@types/mongoose": "^5.11.97",
+    "@types/node": "^22.13.5",
+    "@types/node-cache": "^4.2.5",
+    "@types/request-ip": "^0.0.41",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.7",
+    "@types/ua-parser-js": "^0.7.39",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.17.0",
+    "eslint": "^9.21.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-jsdoc": "^50.6.3",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.0",
-    "nodemon": "^2.0.13"
+    "nodemon": "^2.0.13",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.1"
   },
   "config": {
     "commitizen": {

src/config.js src/config.tssrc/config.js renamed to src/config.ts

@@ -1,14 +1,18 @@
-"use strict";
 
 // Import modules
-const {join: pathJoin} = require("node:path");
-const {existsSync} = require("node:fs");
+import {join as pathJoin} from "node:path";
+import {existsSync} from "node:fs";
+import { fileURLToPath } from 'node:url';
+import dotenv from "dotenv";
 
 /**
  * Load configs from system environment variables.
  */
-function runLoader() {
-    const dotenvPath = pathJoin(__dirname, "..", ".env");
+export function runLoader(): void {
+    // ESM doesn't have __dirname, need to construct it
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = pathJoin(__filename, ".."); // src/config.ts -> src/
+    const dotenvPath = pathJoin(__dirname, "..", ".env"); // src/../.env -> .env
 
     const isDotEnvFileExists = existsSync(dotenvPath);
     const isCustomDefined = get("APP_CONFIGURED") === "1";
@@ -23,7 +27,7 @@ function runLoader() {
         throw new Error(".env not exists");
     }
 
-    require("dotenv").config();
+    dotenv.config();
 }
 
 /**
@@ -32,7 +36,7 @@ function runLoader() {
  * @function
  * @return {boolean} true if production
  */
-function isProduction() {
+export function isProduction(): boolean {
     return getMust("NODE_ENV") === "production";
 }
 
@@ -42,7 +46,7 @@ function isProduction() {
  * @function
  * @return {object}
  */
-function getEnvironmentOverview() {
+export function getEnvironmentOverview(): {node: string, runtime: string} {
     return {
         node: getFallback("NODE_ENV", "development"),
         runtime: getFallback("RUNTIME_ENV", "native"),
@@ -56,7 +60,7 @@ function getEnvironmentOverview() {
  * @param {string} key the key
  * @return {string} the value
  */
-function get(key) {
+export function get(key: string): string | undefined {
     return process.env[key];
 }
 
@@ -67,7 +71,7 @@ function get(key) {
  * @param {string} key the key
  * @return {bool} the bool value
  */
-function getEnabled(key) {
+export function getEnabled(key: string): boolean {
     return getMust(key) === "yes";
 }
 
@@ -79,7 +83,7 @@ function getEnabled(key) {
  * @param {string} [separator=,] the separator.
  * @return {array} the array value
  */
-function getSplited(key, separator=",") {
+export function getSplited(key: string, separator: string = ","): string[] {
     return getMust(key).
         split(separator).
         filter((s) => s).
@@ -94,7 +98,7 @@ function getSplited(key, separator=",") {
  * @return {string} the expected value
  * @throws {Error} if value is undefined, throw an error
  */
-function getMust(key) {
+export function getMust(key: string): string {
     const value = get(key);
     if (value === undefined) {
         throw new Error(`config key ${key} is undefined`);
@@ -110,17 +114,6 @@ function getMust(key) {
  * @param {string} fallback the fallback value
  * @return {string} the expected value
  */
-function getFallback(key, fallback) {
+export function getFallback(key: string, fallback: string): string {
     return get(key) || fallback;
 }
-
-module.exports = {
-    runLoader,
-    isProduction,
-    getEnvironmentOverview,
-    get,
-    getEnabled,
-    getSplited,
-    getMust,
-    getFallback,
-};

src/execute.js src/execute.tssrc/execute.js renamed to src/execute.ts

@@ -1,24 +1,29 @@
-"use strict";
-
 // Import config
-const {getMust, getSplited} = require("./config");
+import {getMust, getSplited} from "./config.ts";
 
 // Import modules
-const fs = require("node:fs");
-const http = require("node:http");
-const https = require("node:https");
+import fs from "node:fs";
+import http from "node:http";
+import https from "node:https";
+import type { Express } from "express";
 
 // Import event listener
-const {
-    listen: startListenEvents,
-} = require("./init/listener");
+import {
+    listen as startListenEvents,
+} from "./init/listener.ts";
+
+interface ProtocolInfo {
+    protocol: string;
+    hostname: string;
+    port: number;
+}
 
 /**
  * Setup protocol - http
  * @param {object} app
  * @param {function} callback
  */
-function setupHttpProtocol(app, callback) {
+function setupHttpProtocol(app: Express, callback: (info: ProtocolInfo) => void) {
     const options = {};
     const httpServer = http.createServer(options, app);
     const port = parseInt(getMust("HTTP_PORT"));
@@ -31,7 +36,7 @@ function setupHttpProtocol(app, callback) {
  * @param {object} app
  * @param {function} callback
  */
-function setupHttpsProtocol(app, callback) {
+function setupHttpsProtocol(app: Express, callback: (info: ProtocolInfo) => void) {
     const options = {
         key: fs.readFileSync(getMust("HTTPS_KEY_PATH")),
         cert: fs.readFileSync(getMust("HTTPS_CERT_PATH")),
@@ -43,7 +48,7 @@ function setupHttpsProtocol(app, callback) {
 }
 
 // Prepare application and detect protocols automatically
-module.exports = async function(app, prepareHandlers, callback) {
+export default async function(app: Express, prepareHandlers: (() => Promise<void>)[], callback: (info: ProtocolInfo) => void) {
     // Waiting for prepare handlers
     if (prepareHandlers.length > 0) {
         const preparingPromises = prepareHandlers.map((c) => c());
@@ -65,4 +70,4 @@ module.exports = async function(app, prepareHandlers, callback) {
 
     // Start event listener
     startListenEvents();
-};
+}

src/init/const.js

@@ -0,0 +1,16 @@
+// Constants
+
+export const APP_NAME = "Nymph";
+export const APP_DESCRIPTION = "The artificial intelligence powered by opensource.";
+
+export const APP_VERSION = "latest";
+
+export const APP_AUTHOR_NAME = "Taiwan Web Technology Promotion Organization";
+export const APP_AUTHOR_URL = "https://web-tech.tw";
+
+export const OPENAPI_EXPORTED_FILENAME = "openapi_exported.json";
+export const PUBLIC_KEY_FILENAME = "keypair_public.pem";
+
+export const PLATFORM_LINE = "LINE";
+export const PLATFORM_MATRIX = "Matrix";
+export const PLATFORM_DISCORD = "Discord";

src/init/const.ts

@@ -1,18 +1,17 @@
-"use strict";
 // mongoose is an ODM library for MongoDB.
 
 // Import config
-const {getMust} = require("../config");
+import {getMust} from "../config.ts";
 
 // Import mongoose
-const database = require("mongoose");
+import database, { Mongoose } from "mongoose";
 
 // Configure mongose
 database.set("strictQuery", true);
 
 // Connect to MongoDB
-exports.prepare = () =>
+export const prepare = () =>
     database.connect(getMust("MONGODB_URI"));
 
 // Export as useFunction
-exports.useDatabase = () => database;
+export const useDatabase = (): Mongoose => database;