huxy-node-server 1.0.2 → 1.0.4

package/README.md

@@ -56,7 +56,7 @@ import { startServer } from 'huxy-node-server';
 const { app, config, httpServer } = await startServer({
   port: 3000,
   host: '0.0.0.0',
-  basepath: '/api',
+  basepath: '/webui',
   // 其他配置...
 }, (config, app, httpServer) => {
   // 可以在这里添加自定义路由
@@ -66,6 +66,20 @@ const { app, config, httpServer } = await startServer({
 });
 ```
 
+### 启用 SSL
+
+```javascript
+const options = {
+  key: '/path/to/name.key',
+  cert: '/path/to/name.pem',
+};
+startServer({
+  port: 3000,
+  host: '0.0.0.0',
+  ssl: options,
+});
+```
+
 ### 静态文件服务
 
 ```javascript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "huxy-node-server",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "一个精炼、高性能的 Express.js 服务器模板，为现代 Node.js 应用程序设计，提供灵活的功能和最佳实践。",
   "type": "module",
   "module": "./src/index.js",

package/src/index.js

@@ -1,32 +1,34 @@
-import P from 'express';
-import K from 'helmet';
-import z from 'cors';
-import {rateLimit as B, ipKeyGenerator as X} from 'express-rate-limit';
-import Q from 'compression';
-import J from 'pino-http';
-import {createServer as Y} from 'node:http';
-import L from 'pino';
-import k from 'node:os';
-import C from 'node:net';
+import y from 'express';
+import X from 'helmet';
+import Q from 'cors';
+import {rateLimit as J, ipKeyGenerator as Y} from 'express-rate-limit';
+import Z from 'compression';
+import q from 'pino-http';
+import {createServer as M} from 'node:http';
+import ee from 'node:https';
+import R from 'pino';
+import j from 'node:os';
+import G from 'node:net';
 var c = (e = new Date()) => e.toLocaleString('zh-CN', {timeZone: 'Asia/Shanghai', hour12: !1}),
+  w = e => Object.prototype.toString.call(e).slice(8, -1).toLowerCase(),
   f = e => {
-    let o = e ? 'https' : 'http',
-      t = k.networkInterfaces(),
-      s = [];
-    return (Object.keys(t).map(n => s.push(...t[n])), s.filter(n => n.family === 'IPv4').map(n => `${o}://${n.address}`));
+    let r = e ? 'https' : 'http',
+      t = j.networkInterfaces(),
+      o = [];
+    return (Object.keys(t).map(i => o.push(...t[i])), o.filter(i => i.family === 'IPv4').map(i => i.address));
   },
-  S = e => {
-    let o = e ?? process.argv.slice(2) ?? [],
+  E = e => {
+    let r = e ?? process.argv.slice(2) ?? [],
       t = {};
     return (
-      o.map(s => {
-        let [r, i] = s.split('=');
-        t[r] = i;
+      r.map(o => {
+        let [s, i] = o.split('=');
+        t[s] = i;
       }),
       t
     );
   },
-  U = {
+  V = {
     NODE_ENV: 'nodeEnv',
     PORT: 'port',
     STATIC_PORT: 'staticPort',
@@ -40,65 +42,71 @@ var c = (e = new Date()) => e.toLocaleString('zh-CN', {timeZone: 'Asia/Shanghai'
     JWT_SECRET: 'secret',
     AUTH_TOKEN: 'authToken',
   },
-  G = (e, o, t) => {
-    let [s, r] = e.split('.');
-    s && r ? (t[s] || (t[s] = {}), (t[s][r] = o)) : (t[s] = o);
+  F = (e, r, t) => {
+    let [o, s] = e.split('.');
+    o && s ? (t[o] || (t[o] = {}), (t[o][s] = r)) : (t[o] = r);
   },
-  j = e => (e ? (e.endsWith('/') ? e : `${e}/`) : '/'),
-  h = (e = {}, o = U) => {
+  W = e => (e ? (e.endsWith('/') ? e : `${e}/`) : '/'),
+  h = (e = {}, r = V) => {
     let {env: t} = process;
-    Object.keys(o).map(r => {
-      let i = t[r] ?? e[r];
-      i && G(o[r], i, e);
+    Object.keys(r).map(s => {
+      let i = t[s] ?? e[s];
+      i && F(r[s], i, e);
     });
-    let s = {...e, ...S()};
-    return ((s.port = s.staticPort || s.port), (s.isDev = s.NODE_ENV === 'development'), (s.basepath = j(s.basepath)), s);
+    let o = {...e, ...E()};
+    return ((o.port = o.staticPort || o.port), (o.isDev = o.NODE_ENV === 'development'), (o.basepath = W(o.basepath)), (o.protocol = 'http'), o);
   },
-  g = (e, o = '127.0.0.1') =>
+  g = (e, r = '127.0.0.1') =>
     new Promise(t => {
-      let s = C.createServer();
-      (s.once('error', r => {
-        (s.close(), t((r.code === 'EADDRINUSE', !1)));
+      let o = G.createServer();
+      (o.once('error', s => {
+        (o.close(), t((s.code === 'EADDRINUSE', !1)));
       }),
-        s.once('listening', () => {
-          (s.close(), t(!0));
+        o.once('listening', () => {
+          (o.close(), t(!0));
         }),
-        s.listen(Number(e), o));
+        o.listen(Number(e), r));
     }),
-  w = (e, o = {}, t) => {
-    let s = r => {
-      (t.warn(`\u6536\u5230 ${r} \u4FE1\u53F7, \u{1F6D1} \u6B63\u5728\u5173\u95ED\u670D\u52A1\u5668...`),
+  b = (e, r = {}, t) => {
+    let o = s => {
+      (t.warn(`\u6536\u5230 ${s} \u4FE1\u53F7, \u{1F6D1} \u6B63\u5728\u5173\u95ED\u670D\u52A1\u5668...`),
         e.close(async () => {
-          (t.info('\u{1F44B} \u670D\u52A1\u5668\u5DF2\u5173\u95ED'), await o.shutdown?.(), process.exit(0));
+          (t.info('\u{1F44B} \u670D\u52A1\u5668\u5DF2\u5173\u95ED'), await r.shutdown?.(), process.exit(0));
         }),
         setTimeout(() => {
           (t.error('\u274C \u5F3A\u5236\u5173\u95ED\u670D\u52A1\u5668'), process.exit(1));
         }, 5e3));
     };
-    (process.on('SIGTERM', () => s('SIGTERM')),
-      process.on('SIGINT', () => s('SIGINT')),
-      process.on('uncaughtException', r => {
-        (t.fatal(r, `\u{1F4A5} \u672A\u6355\u83B7\u7684\u5F02\u5E38: ${r.message}`), process.exit(1));
+    (process.on('SIGTERM', () => o('SIGTERM')),
+      process.on('SIGINT', () => o('SIGINT')),
+      process.on('uncaughtException', s => {
+        (t.fatal(s, `\u{1F4A5} \u672A\u6355\u83B7\u7684\u5F02\u5E38: ${s.message}`), process.exit(1));
       }),
-      process.on('unhandledRejection', (r, i) => {
-        (t.fatal({reason: r, promise: i}, '\u26A0\uFE0F \u672A\u5904\u7406\u7684 Promise \u62D2\u7EDD'), process.exit(1));
+      process.on('unhandledRejection', (s, i) => {
+        (t.fatal({reason: s, promise: i}, '\u26A0\uFE0F \u672A\u5904\u7406\u7684 Promise \u62D2\u7EDD'), process.exit(1));
       }));
   },
-  A = (e, {port: o, host: t = '0.0.0.0'} = {}) =>
-    new Promise((s, r) => {
+  A = (e, {port: r, host: t = '0.0.0.0'} = {}) =>
+    new Promise((o, s) => {
       let i = p => {
-          (a(), r(p));
+          (a(), s(p));
         },
         n = () => {
-          (a(), s(e));
+          (a(), o(e));
         },
         a = () => {
           (e.off('error', i), e.off('listening', n));
         };
-      (e.once('error', i), e.once('listening', n), e.listen(o, t));
-    });
+      (e.once('error', i), e.once('listening', n), e.listen(r, t));
+    }),
+  $ = (e, r = 56) => {
+    let t = e.length,
+      o = r - t,
+      s = ~~(o / 2);
+    return `${'-'.repeat(s)}${e}${'-'.repeat(o - s)}`;
+  };
 import 'dotenv';
-var F = {
+var K = {
     nodeEnv: process.env.NODE_ENV || 'development',
     isDev: process.env.NODE_ENV === 'development',
     port: parseInt(process.env.PORT || '3000', 10),
@@ -117,136 +125,137 @@ var F = {
     },
     logLevel: process.env.LOG_LEVEL || 30,
   },
-  v = F;
-var d = (e, o) =>
-  L({
+  v = K;
+var u = (e, r) =>
+  R({
     name: e,
     level: v.logLevel,
     formatters: {level: t => ({level: t})},
-    timestamp: L.stdTimeFunctions.isoTime,
+    timestamp: R.stdTimeFunctions.isoTime,
     base: null,
     transport: {target: 'pino-pretty', options: {colorize: !0, sync: !0, levelFirst: !0}, ignore: 'pid,hostname,level,time', translateTime: 'SYS:yyyy-mm-dd HH:MM:ss'},
-    ...o,
+    ...r,
   });
-var m = d('huxy');
-var R = d('error-handler'),
-  $ = e => (o, t, s) => {
-    (R.error({message: 'Not Found', timestamp: c(), url: o.originalUrl, method: o.method, ip: o.ip, userAgent: o.get('User-Agent')}, '\u627E\u4E0D\u5230\u8DEF\u5F84'),
-      t.status(404).json({success: !1, status: 404, url: o.originalUrl, message: `\u8DEF\u7531 [${o.method} ${o.originalUrl}] \u4E0D\u5B58\u5728`, timestamp: c()}));
+var m = u('huxy');
+var O = u('error-handler'),
+  N = e => (r, t, o) => {
+    (O.error({message: 'Not Found', timestamp: c(), url: r.originalUrl, method: r.method, ip: r.ip, userAgent: r.get('User-Agent')}, '\u627E\u4E0D\u5230\u8DEF\u5F84'),
+      t.status(404).json({success: !1, status: 404, url: r.originalUrl, message: `\u8DEF\u7531 [${r.method} ${r.originalUrl}] \u4E0D\u5B58\u5728`, timestamp: c()}));
   },
-  b = e => (o, t, s, r) => {
-    let i = o.status || 500,
-      n = o.message;
-    (R.error({message: n, timestamp: c(), stack: o.stack, url: t.originalUrl, method: t.method, ip: t.ip, userAgent: t.get('User-Agent')}, '\u670D\u52A1\u5668\u5185\u90E8\u9519\u8BEF'),
-      s.status(i).json({success: !1, message: (e.isDev, n), stack: e.isDev ? o.stack : void 0, timestamp: c()}));
+  _ = e => (r, t, o, s) => {
+    let i = r.status || 500,
+      n = r.message;
+    (O.error({message: n, timestamp: c(), stack: r.stack, url: t.originalUrl, method: t.method, ip: t.ip, userAgent: t.get('User-Agent')}, '\u670D\u52A1\u5668\u5185\u90E8\u9519\u8BEF'),
+      o.status(i).json({success: !1, message: (e.isDev, n), stack: e.isDev ? r.stack : void 0, timestamp: c()}));
   };
-var N = e => (o, t, s) => {
-  (t.set('Cache-Control', `public, max-age=${e.cacheMaxAge ?? 300}, stale-while-revalidate=60`), s());
-};
-import {Router as V} from 'express';
-var W = e => {
-    let o = V();
+import {Router as z} from 'express';
+var B = e => {
+    let r = z();
     return (
-      o.use('/health', (t, s) => {
-        s.status(200).json({status: 'OK', timestamp: c(), environment: e.nodeEnv, uptime: process.uptime(), memoryUsage: process.memoryUsage(), pid: process.pid});
+      r.use('/health', (t, o) => {
+        o.status(200).json({status: 'OK', timestamp: c(), environment: e.nodeEnv, uptime: process.uptime(), memoryUsage: process.memoryUsage(), pid: process.pid});
       }),
-      o.get('/', (t, s) => {
-        s.status(200).json({message: 'Node.js \u670D\u52A1\u5668\u8FD0\u884C\u4E2D', timestamp: c(), environment: e.nodeEnv});
+      r.get('/', (t, o) => {
+        o.status(200).json({message: 'Node.js \u670D\u52A1\u5668\u8FD0\u884C\u4E2D', timestamp: c(), environment: e.nodeEnv});
       }),
-      o
+      r
     );
   },
-  _ = W;
-var Z = (e, o = {}) => {
+  D = B;
+var te = (e, r = {}) => {
     (e.disable('x-powered-by'),
       e.set('trust proxy', 1),
-      e.use(J({logger: m, quietReqLogger: !0, autoLogging: !1, genReqId: !1})),
-      e.use(Q()),
-      e.use(K(o.helmet)),
-      e.use(z(o.cors)),
-      e.use(o.apiPrefix, B({keyGenerator: t => X(t.ip) || t.headers['x-huxy-auth'] || t.headers['x-api-key'] || t.headers.authorization, ...o.rateLimit})),
-      e.use(P.json({limit: '20mb'})),
-      e.use(P.urlencoded({extended: !0, limit: '20mb'})),
-      e.use(o.apiPrefix, N(o)));
+      e.use(q({logger: m, quietReqLogger: !0, autoLogging: !1, genReqId: !1})),
+      e.use(Z()),
+      e.use(X(r.helmet)),
+      e.use(Q(r.cors)),
+      e.use(r.apiPrefix, J({keyGenerator: t => Y(t.ip) || t.headers['x-huxy-auth'] || t.headers['x-api-key'] || t.headers.authorization, ...r.rateLimit})),
+      e.use(y.json({limit: '20mb'})),
+      e.use(y.urlencoded({extended: !0, limit: '20mb'})));
   },
-  q = (e, o = {}) => {
-    (e.use(_(o)), e.use($(o)), e.use(b(o)));
+  oe = (e, r = {}) => {
+    (e.use(D(r)), e.use(N(r)), e.use(_(r)));
   },
-  ee = async (e, o) => {
+  re = async (e, r) => {
     let t = h(e),
-      {port: s} = t;
-    (await g(s, t.host)) || ((t.port = Number(s) + 1), m.warn(`\u7AEF\u53E3 ${s} \u5DF2\u88AB\u5360\u7528\uFF0C\u73B0\u5728\u4F7F\u7528\u7AEF\u53E3 ${t.port}`));
-    let i = P();
-    Z(i, t);
-    let n = Y(i);
-    w(n, t, m);
+      {port: o, ssl: s} = t;
+    (await g(o, t.host)) || ((t.port = Number(o) + 1), m.warn(`\u7AEF\u53E3 ${o} \u5DF2\u88AB\u5360\u7528\uFF0C\u73B0\u5728\u4F7F\u7528\u7AEF\u53E3 ${t.port}`));
+    let n = y();
+    te(n, t);
+    let a;
+    (s
+      ? (w(s) === 'object' ||
+          (m.error({ssl: {key: '/path/to/name.key', cert: '/path/to/name.pem'}}, '\u26A0\uFE0F \u8BF7\u8BBE\u7F6E\u6709\u6548 SSL \u6216\u8BBE\u7F6E {ssl: false}'), process.exit(1)),
+        (t.protocol = 'https'),
+        (a = ee.createServer(s, n)),
+        M((d, l) => {
+          (l.writeHead(301, {Location: `${t.protocol}://${d.headers.host}${d.url}`}), l.end());
+        }).listen(80))
+      : (a = M(n)),
+      b(a, t, m));
     try {
-      await A(n, t);
-    } catch (a) {
-      (m.error({err: a}, '\u26A0\uFE0F \u670D\u52A1\u5668\u542F\u52A8\u5931\u8D25'), process.exit(1));
+      await A(a, t);
+    } catch (p) {
+      (m.error({err: p}, '\u26A0\uFE0F \u670D\u52A1\u5668\u542F\u52A8\u5931\u8D25'), process.exit(1));
     }
     try {
-      await o?.(t, i, n, m);
-    } catch (a) {
-      (m.error({err: a}, `\u56DE\u8C03\u51FD\u6570\u9519\u8BEF\uFF1A${a.message}`), process.exit(1));
+      await r?.(t, n, a, m);
+    } catch (p) {
+      (m.error({err: p}, `\u274C \u56DE\u8C03\u51FD\u6570\u9519\u8BEF\uFF1A${p.message}`), process.exit(1));
     }
-    return (q(i, t), {app: i, httpServer: n, config: t, logger: m});
+    return (oe(n, t), {app: n, httpServer: a, config: t, logger: m});
   },
-  O = ee;
-var te = (e, o = 56) => {
-    let t = e.length,
-      s = o - t,
-      r = ~~(s / 2);
-    return `${'-'.repeat(r)}${e}${'-'.repeat(s - r)}`;
-  },
-  oe = (e, o, t) =>
-    O({...v, ...e}, async (s, r, i, n) => {
-      let {port: a, host: p, nodeEnv: u, basepath: l, appName: E = 'HuxyServer'} = s;
+  H = re;
+var se = (e, r, t) =>
+    H({...v, ...e}, async (o, s, i, n) => {
+      let {port: a, host: p, nodeEnv: d, basepath: l, appName: S = 'HuxyServer', protocol: L} = o;
       if (!t) {
-        let H = f()
-          .filter(T => T !== `http://${p}`)
-          .map(T => `http://${T}:${a}${l}`);
-        (n.info(te(E)),
-          n.info(`\u{1F680} \u670D\u52A1\u8FD0\u884C\u5728\u3010${u}\u3011\u73AF\u5883: http://${p}:${a}${l}`),
+        let U = f()
+          .filter(T => T !== p)
+          .map(T => `${L}://${T}:${a}${l}`);
+        (n.info($(S)),
+          n.info(`\u{1F680} \u670D\u52A1\u8FD0\u884C\u5728\u3010${d}\u3011\u73AF\u5883: ${L}://${p}:${a}${l}`),
           n.info(`-----------------[${c()}]------------------`),
-          n.info({ips: H}, '\u672C\u5730\u5730\u5740\uFF1A'));
+          n.info({ips: U}, '\u672C\u5730\u5730\u5740\uFF1A'));
       }
-      await o?.(s, r, i, n);
+      await r?.(o, s, i, n);
     }),
-  x = oe;
-import ie from 'express';
-import {fileURLToPath as se} from 'node:url';
-import {dirname as re, resolve as ne} from 'node:path';
-var I = (e = import.meta.url) => re(se(e)),
-  y = (...e) => ne(I(), ...e),
-  M = y;
-var ae = {port: 9e3, host: 'localhost', basepath: '/', buildPath: './build'},
-  ce = (e, o) =>
-    x({...ae, ...e}, async (t, s, r, i) => {
-      await o?.(t, s, r, i);
+  x = se;
+import ce from 'express';
+import {fileURLToPath as ne} from 'node:url';
+import {dirname as ie, resolve as ae} from 'node:path';
+var I = (e = import.meta.url) => ie(ne(e)),
+  P = (...e) => ae(I(), ...e),
+  k = P;
+var pe = {port: 9e3, host: 'localhost', basepath: '/', buildPath: './build'},
+  me = (e, r) =>
+    x({...pe, ...e}, async (t, o, s, i) => {
+      await r?.(t, o, s, i);
       let {basepath: n, buildPath: a} = t;
-      (s.get('/', (u, l, E) => {
-        ((u.path === '/' || u.path === n.slice(0, -1)) && l.redirect(n), E());
-      }),
-        s.use(n, ie.static(a, {})));
+      (n !== '/' &&
+        o.get('/', (d, l, S) => {
+          if (d.path === '/' || d.path === n.slice(0, -1)) return l.redirect(n);
+          S();
+        }),
+        o.use(n, ce.static(a, {...t.staticCache})));
       let p = new RegExp(`^${n.replace(/\//g, '\\/')}(.*)$`);
-      s.get(p, (u, l) => {
-        l.sendFile(M(a, 'index.html'));
+      o.get(p, (d, l) => {
+        l.sendFile(k(a, 'index.html'));
       });
     }),
-  D = ce;
-var qe = {startServer: x, startStatic: D, logger: m, createLogger: d, dateTime: c, localIPs: f, nodeArgs: S, getEnvConfig: h, checkPort: g, getDirName: I, resolvePath: y};
+  C = me;
+var ot = {startServer: x, startStatic: C, logger: m, createLogger: u, dateTime: c, localIPs: f, nodeArgs: E, getEnvConfig: h, checkPort: g, getDirName: I, resolvePath: P};
 export {
   g as checkPort,
-  d as createLogger,
+  u as createLogger,
   c as dateTime,
-  qe as default,
+  ot as default,
   I as getDirName,
   h as getEnvConfig,
   f as localIPs,
   m as logger,
-  S as nodeArgs,
-  y as resolvePath,
+  E as nodeArgs,
+  P as resolvePath,
   x as startServer,
-  D as startStatic,
+  C as startStatic,
 };