create-skweb 3.2.0 → 3.3.1

package/templates/cjs/src/app.auth-static.js

@@ -1,129 +0,0 @@
-require('dotenv/config')
-
-const path = require('path')
-const express = require('skweb-express').default
-const expressLogger = require('skweb-express-logger').default
-const expressErrorHandler = require('skweb-express-logger').errorHandler
-const swaggerUi = require('swagger-ui-express')
-const { WebFramework } = require('skweb-framework')
-const { logger } = require('./utils/logger.js')
-const { checkRequiredEnv, checkJwtSecret } = require('./utils/config.js')
-const { buildOpenApiSpec } = require('./swagger.js')
-
-/**
- * JWT 配置（static 模式，HS256 共享密钥）。
- */
-function buildJwtOptions() {
-  return {
-    provider: 'static',
-    secret: process.env.JWT_SECRET || 'please-change-this-in-production',
-    algorithms: ['HS256'],
-    sign: { expiresIn: process.env.JWT_EXPIRES_IN || '7d' },
-    requestProperty: 'resolvedToken'
-  }
-}
-
-/**
- * Swagger UI 仅在 NODE_ENV 为 development / test，且 SWAGGER_ENABLED !== 'false' 时启用。
- * 生产环境（production / unset）默认禁用，避免暴露内部 API 细节。
- */
-function shouldEnableSwagger() {
-  const env = (process.env.NODE_ENV || '').toLowerCase()
-  if (env !== 'development' && env !== 'test') return false
-  if ((process.env.SWAGGER_ENABLED || '').toLowerCase() === 'false') return false
-  return true
-}
-
-async function bootstrap() {
-  logger.info('[app] Initializing web process...')
-
-  if (!checkRequiredEnv()) {
-    logger.error('[app] Configuration validation failed, exiting...')
-    process.exit(1)
-  }
-  if (!checkJwtSecret()) {
-    logger.error('[app] JWT configuration validation failed, exiting...')
-    process.exit(1)
-  }
-
-  const framework = new WebFramework({
-    db: {
-      host: process.env.DB_HOST || '127.0.0.1',
-      port: Number(process.env.DB_PORT) || 3306,
-      username: process.env.DB_USER || 'root',
-      password: process.env.DB_PASS || '',
-      database: process.env.DB_NAME || 'test-project',
-      dialect: process.env.DB_DIALECT || 'mysql',
-      charset: process.env.DB_CHARSET || 'utf8mb4',
-      underscored: true,
-      logging: process.env.DEBUG_DB === 'true' ? (msg) => logger.debug(msg) : false
-    },
-    redis: {
-      host: process.env.REDIS_HOST || '127.0.0.1',
-      port: Number(process.env.REDIS_PORT) || 6379,
-      password: process.env.REDIS_PASSWORD || undefined
-    }
-  })
-  const app = framework.createApp()
-
-  await framework.setup({
-    modelsDir: path.join(__dirname, './models'),
-    controllersDir: path.join(__dirname, './controllers')
-  })
-
-  app.disable('x-powered-by')
-  app.disable('etag')
-
-  app.set('trust proxy', true)
-
-  app.set('wrap response', true)
-  app.setOkCode(0)
-  app.setOkMessage('success')
-
-  const jwtOptions = buildJwtOptions()
-  app.setJWT('default', jwtOptions)
-  app.setJwtHintHeader('JwtHint')
-
-  logger.info('[app] JWT auth provider: static (HS256)')
-
-  app.use(expressLogger())
-  app.use(express.static(path.join(__dirname, '..', 'public')))
-
-  if (shouldEnableSwagger()) {
-    const openapiSpec = buildOpenApiSpec()
-    app.get('/api-docs.json', (_req, res) => res.json(openapiSpec))
-    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(openapiSpec, {
-      customSiteTitle: `${process.env.APP_NAME || 'SKWeb'} API Docs`,
-      swaggerOptions: { persistAuthorization: true }
-    }))
-    logger.info(`[app] Swagger UI mounted at http://localhost:${process.env.PORT || 3000}/api-docs (env: ${process.env.NODE_ENV})`)
-  } else {
-    logger.info(`[app] Swagger UI disabled (env: ${process.env.NODE_ENV || 'unset'})`)
-  }
-
-  await framework.loadControllers()
-
-  app.use(expressErrorHandler())
-
-  framework.start(Number(process.env.PORT) || 3000)
-
-  logger.info('[app] Initialization complete (web process)')
-
-  process.on('uncaughtException', (err) => {
-    logger.error(`[app] uncaughtException: ${err.stack || err.message}`)
-    process.exit(1)
-  })
-  process.on('unhandledRejection', (reason) => {
-    logger.error(`[app] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
-    process.exit(1)
-  })
-}
-
-if (require.main === module) {
-  bootstrap().catch((err) => {
-    logger.error('[app] Fatal error:', err)
-    process.exit(1)
-  })
-}
-
-module.exports = { bootstrap }

package/templates/cjs/src/cronWorker.js

@@ -1,80 +0,0 @@
-require('dotenv/config')
-
-const path = require('path')
-const { CronFramework } = require('skweb-framework')
-const { logger } = require('./utils/logger.js')
-const { checkRequiredEnv } = require('./utils/config.js')
-
-async function startCronWorker() {
-  logger.info('[cron-worker] Starting cron worker process...')
-
-  if (!checkRequiredEnv()) {
-    logger.error('[cron-worker] Configuration validation failed, exiting...')
-    process.exit(1)
-  }
-
-  const framework = new CronFramework({
-    db: {
-      host: process.env.DB_HOST || '127.0.0.1',
-      port: Number(process.env.DB_PORT) || 3306,
-      username: process.env.DB_USER || 'root',
-      password: process.env.DB_PASS || '',
-      database: process.env.DB_NAME || 'test-project',
-      dialect: process.env.DB_DIALECT || 'mysql',
-      charset: process.env.DB_CHARSET || 'utf8mb4',
-      underscored: true,
-      logging: process.env.DEBUG_DB === 'true' ? (msg) => logger.debug(msg) : false
-    },
-    redis: {
-      host: process.env.REDIS_HOST || '127.0.0.1',
-      port: Number(process.env.REDIS_PORT) || 6379,
-      password: process.env.REDIS_PASSWORD || undefined
-    },
-    channel: 'cron:task:cmd',
-    logger,
-    onSaveTask: async (taskData) => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask
-      if (SysCronTask) {
-        await SysCronTask.update(
-          { cache: taskData.cache, data: taskData.data },
-          { where: { id: taskData.taskId } }
-        )
-      }
-    },
-    loadTasks: async () => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask
-      if (!SysCronTask) return []
-      return (await SysCronTask.findAll()).map((t) => ({
-        id: String(t.id),
-        cronTime: t.cronTime,
-        method: t.method
-      }))
-    }
-  })
-
-  await framework.setup({
-    modelsDir: path.join(__dirname, './models'),
-    cronActionsDir: path.join(__dirname, './cronActions')
-  })
-  await framework.start()
-  logger.info('[cron-worker] Cron worker started')
-
-  // 未捕获异常：打印堆栈后直接退出。OS / 进程管理器负责回收资源。
-  process.on('uncaughtException', (err) => {
-    logger.error(`[cron-worker] uncaughtException: ${err.stack || err.message}`)
-    process.exit(1)
-  })
-  process.on('unhandledRejection', (reason) => {
-    logger.error(`[cron-worker] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
-    process.exit(1)
-  })
-}
-
-if (require.main === module) {
-  startCronWorker().catch((err) => {
-    logger.error('[cron-worker] Fatal error:', err)
-    process.exit(1)
-  })
-}
-
-module.exports = { startCronWorker }

package/templates/cjs/src/index.js

@@ -1,7 +0,0 @@
-require('dotenv/config')
-
-const { bootstrap } = require('./app.js')
-
-if (require.main === module) {
-  bootstrap()
-}

package/templates/cjs/src/services/database.js

@@ -1,15 +0,0 @@
-const { Database } = require('skweb-sequelize')
-
-const db = new Database({
-  host: process.env.DB_HOST || '127.0.0.1',
-  port: Number(process.env.DB_PORT) || 3306,
-  username: process.env.DB_USER || 'root',
-  password: process.env.DB_PASS || '',
-  database: process.env.DB_NAME || '{{name}}',
-  dialect: process.env.DB_DIALECT || 'mysql',
-  charset: process.env.DB_CHARSET || 'utf8mb4',
-  underscored: true,
-  logging: process.env.DEBUG_DB === 'true'
-})
-
-module.exports = { db }

package/templates/cjs/src/swagger.auth-static.js

@@ -1,35 +0,0 @@
-'use strict'
-
-const path = require('path')
-const swaggerJSDoc = require('swagger-jsdoc')
-
-function buildOpenApiSpec() {
-  return swaggerJSDoc({
-    definition: {
-      openapi: '3.0.3',
-      info: {
-        title: process.env.APP_NAME || 'SKWeb API',
-        version: process.env.API_VERSION || '1.0.0',
-        description: process.env.APP_DESCRIPTION || 'SKWeb project API documentation',
-        contact: { name: 'API Support' }
-      },
-      servers: [
-        { url: `http://localhost:${process.env.PORT || 3000}`, description: 'Local development' }
-      ],
-      components: {
-        securitySchemes: {
-          bearerAuth: {
-            type: 'http',
-            scheme: 'bearer',
-            bearerFormat: 'JWT'
-          }
-        }
-      }
-    },
-    apis: [
-      path.join(__dirname, 'controllers', '*.js')
-    ]
-  })
-}
-
-module.exports = { buildOpenApiSpec }

package/templates/cjs/src/utils/config.auth-static.js

@@ -1,65 +0,0 @@
-const { logger } = require('./logger.js')
-
-function validateConfig() {
-  const errors = []
-
-  if (!process.env.DB_HOST) {
-    logger.warn('[config] DB_HOST not set, using default: 127.0.0.1')
-  }
-  if (!process.env.DB_NAME) {
-    logger.warn('[config] DB_NAME not set, using default: test-project')
-  }
-  if (!process.env.DB_USER) {
-    logger.warn('[config] DB_USER not set, using default: root')
-  }
-
-  if (!process.env.REDIS_HOST) {
-    logger.warn('[config] REDIS_HOST not set, using default: 127.0.0.1')
-  }
-
-  const port = Number(process.env.PORT)
-  if (port && (port < 1 || port > 65535)) {
-    errors.push('PORT must be between 1 and 65535')
-  }
-
-  const dbPort = Number(process.env.DB_PORT)
-  if (dbPort && (dbPort < 1 || dbPort > 65535)) {
-    errors.push('DB_PORT must be between 1 and 65535')
-  }
-
-  const redisPort = Number(process.env.REDIS_PORT)
-  if (redisPort && (redisPort < 1 || redisPort > 65535)) {
-    errors.push('REDIS_PORT must be between 1 and 65535')
-  }
-
-  return {
-    isValid: errors.length === 0,
-    errors
-  }
-}
-
-function checkJwtSecret() {
-  if (process.env.JWT_SECRET === 'please-change-this-in-production' || !process.env.JWT_SECRET) {
-    if (process.env.NODE_ENV === 'production') {
-      logger.error('[config] JWT_SECRET must be set in production!')
-      return false
-    }
-    logger.warn('[config] WARNING: JWT_SECRET is using default value, please change in production!')
-  }
-  return true
-}
-
-function checkRequiredEnv() {
-  const result = validateConfig()
-
-  if (result.errors.length > 0) {
-    logger.error('[config] Configuration validation failed:')
-    result.errors.forEach((err) => logger.error(`  - ${err}`))
-    return false
-  }
-
-  logger.info('[config] Configuration validation passed')
-  return true
-}
-
-module.exports = { validateConfig, checkJwtSecret, checkRequiredEnv }

package/templates/mjs/.env.example.auth-static

@@ -1,54 +0,0 @@
-# ============================================
-# SKWeb Environment Variables Template
-# ============================================
-# Copy this file to .env and fill in your values:
-#   cp .env.example .env
-#
-# Variables with default values can be omitted.
-# Variables marked [REQUIRED] must be set in production.
-
-# ---------- Node Environment ----------
-# Development | Production | Test
-NODE_ENV=development
-
-# ---------- Server ----------
-PORT=3000
-HOST=0.0.0.0
-
-# ---------- Database (MySQL / MariaDB) ----------
-DB_HOST=127.0.0.1
-DB_PORT=3306
-DB_USER=root
-DB_PASS=
-DB_NAME={{name}}
-DB_DIALECT=mysql
-DB_CHARSET=utf8mb4
-DEBUG_DB=false
-
-# ---------- Redis ----------
-REDIS_HOST=127.0.0.1
-REDIS_PORT=6379
-REDIS_PASSWORD=
-REDIS_DB=0
-
-# ---------- Swagger / OpenAPI ----------
-# Mounts Swagger UI at /api-docs and exposes raw spec at /api-docs.json.
-# Only enabled when NODE_ENV is 'development' or 'test'.
-# Set SWAGGER_ENABLED=false to force-disable in dev/test as well.
-# (Production is always disabled to avoid exposing internal API details.)
-SWAGGER_ENABLED=true
-
-# ---------- Auth: static (HS256 shared secret) ----------
-# [REQUIRED in production] Use a strong random string, e.g. `openssl rand -hex 32`
-JWT_SECRET=please-change-this-in-production
-JWT_EXPIRES_IN=7d
-
-# ---------- Logging ----------
-# error | warn | info | http | verbose | debug | silly
-LOG_LEVEL=info
-LOG_DIR=./logs
-LOG_CONSOLE=true
-
-# ---------- CORS ----------
-# Comma-separated origins, or * for all
-CORS_ORIGIN=*

package/templates/mjs/src/app.auth-static.js

@@ -1,131 +0,0 @@
-import 'dotenv/config'
-
-import path from 'path'
-import { fileURLToPath } from 'url'
-import express from 'skweb-express'
-import expressLogger, { errorHandler as expressErrorHandler } from 'skweb-express-logger'
-import swaggerUi from 'swagger-ui-express'
-import logger from './utils/logger.js'
-import { checkRequiredEnv, checkJwtSecret } from './utils/config.js'
-import { buildOpenApiSpec } from './swagger.js'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-/**
- * JWT 配置（static 模式，HS256 共享密钥）。
- */
-function buildJwtOptions() {
-  return {
-    provider: 'static',
-    secret: process.env.JWT_SECRET || 'please-change-this-in-production',
-    algorithms: ['HS256'],
-    sign: { expiresIn: process.env.JWT_EXPIRES_IN || '7d' },
-    requestProperty: 'resolvedToken'
-  }
-}
-
-function shouldEnableSwagger() {
-  const env = (process.env.NODE_ENV || '').toLowerCase()
-  if (env !== 'development' && env !== 'test') return false
-  if ((process.env.SWAGGER_ENABLED || '').toLowerCase() === 'false') return false
-  return true
-}
-
-async function bootstrap() {
-  logger.info('[app] Initializing web process...')
-
-  if (!checkRequiredEnv()) {
-    logger.error('[app] Configuration validation failed, exiting...')
-    process.exit(1)
-  }
-  if (!checkJwtSecret()) {
-    logger.error('[app] JWT configuration validation failed, exiting...')
-    process.exit(1)
-  }
-
-  const { WebFramework } = await import('skweb-framework')
-
-  const framework = new WebFramework({
-    db: {
-      host: process.env.DB_HOST || '127.0.0.1',
-      port: Number(process.env.DB_PORT) || 3306,
-      username: process.env.DB_USER || 'root',
-      password: process.env.DB_PASS || '',
-      database: process.env.DB_NAME || 'test-project',
-      dialect: process.env.DB_DIALECT || 'mysql',
-      charset: process.env.DB_CHARSET || 'utf8mb4',
-      underscored: true,
-      logging: process.env.DEBUG_DB === 'true' ? (msg) => logger.debug(msg) : false
-    },
-    redis: {
-      host: process.env.REDIS_HOST || '127.0.0.1',
-      port: Number(process.env.REDIS_PORT) || 6379,
-      password: process.env.REDIS_PASSWORD || undefined
-    }
-  })
-
-  const app = framework.createApp()
-
-  await framework.setup({
-    modelsDir: path.join(__dirname, './models'),
-    controllersDir: path.join(__dirname, './controllers')
-  })
-
-  app.disable('x-powered-by')
-  app.disable('etag')
-
-  app.set('trust proxy', true)
-
-  app.set('wrap response', true)
-  app.setOkCode(0)
-  app.setOkMessage('success')
-
-  const jwtOptions = buildJwtOptions()
-  app.setJWT('default', jwtOptions)
-  app.setJwtHintHeader('JwtHint')
-
-  logger.info('[app] JWT auth provider: static (HS256)')
-
-  app.use(expressLogger())
-  app.use(express.static(path.join(__dirname, '..', 'public')))
-
-  if (shouldEnableSwagger()) {
-    const openapiSpec = buildOpenApiSpec()
-    app.get('/api-docs.json', (_req, res) => res.json(openapiSpec))
-    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(openapiSpec, {
-      customSiteTitle: `${process.env.APP_NAME || 'SKWeb'} API Docs`,
-      swaggerOptions: { persistAuthorization: true }
-    }))
-    logger.info(`[app] Swagger UI mounted at http://localhost:${process.env.PORT || 3000}/api-docs (env: ${process.env.NODE_ENV})`)
-  } else {
-    logger.info(`[app] Swagger UI disabled (env: ${process.env.NODE_ENV || 'unset'})`)
-  }
-
-  await framework.loadControllers()
-
-  app.use(expressErrorHandler())
-
-  framework.start(Number(process.env.PORT) || 3000)
-
-  logger.info('[app] Initialization complete (web process)')
-
-  process.on('uncaughtException', (err) => {
-    logger.error(`[app] uncaughtException: ${err.stack || err.message}`)
-    process.exit(1)
-  })
-  process.on('unhandledRejection', (reason) => {
-    logger.error(`[app] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
-    process.exit(1)
-  })
-}
-
-const isMainModule = import.meta.url === `file://${process.argv[1]}`
-if (isMainModule) {
-  bootstrap().catch((err) => {
-    logger.error('[app] Fatal error:', err)
-    process.exit(1)
-  })
-}
-
-export { bootstrap }

package/templates/mjs/src/cronWorker.js

@@ -1,86 +0,0 @@
-import 'dotenv/config'
-
-import path from 'path'
-import { fileURLToPath } from 'url'
-import logger from './utils/logger.js'
-import { checkRequiredEnv } from './utils/config.js'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-async function startCronWorker() {
-  logger.info('[cron-worker] Starting cron worker process...')
-
-  if (!checkRequiredEnv()) {
-    logger.error('[cron-worker] Configuration validation failed, exiting...')
-    process.exit(1)
-  }
-
-  const { CronFramework } = await import('skweb-framework')
-
-  const framework = new CronFramework({
-    db: {
-      host: process.env.DB_HOST || '127.0.0.1',
-      port: Number(process.env.DB_PORT) || 3306,
-      username: process.env.DB_USER || 'root',
-      password: process.env.DB_PASS || '',
-      database: process.env.DB_NAME || 'test-project',
-      dialect: process.env.DB_DIALECT || 'mysql',
-      charset: process.env.DB_CHARSET || 'utf8mb4',
-      underscored: true,
-      logging: process.env.DEBUG_DB === 'true' ? (msg) => logger.debug(msg) : false
-    },
-    redis: {
-      host: process.env.REDIS_HOST || '127.0.0.1',
-      port: Number(process.env.REDIS_PORT) || 6379,
-      password: process.env.REDIS_PASSWORD || undefined
-    },
-    channel: 'cron:task:cmd',
-    logger,
-    onSaveTask: async (taskData) => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask
-      if (SysCronTask) {
-        await SysCronTask.update(
-          { cache: taskData.cache, data: taskData.data },
-          { where: { id: taskData.taskId } }
-        )
-      }
-    },
-    loadTasks: async () => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask
-      if (!SysCronTask) return []
-      return (await SysCronTask.findAll()).map((t) => ({
-        id: String(t.id),
-        cronTime: t.cronTime,
-        method: t.method
-      }))
-    }
-  })
-
-  await framework.setup({
-    modelsDir: path.join(__dirname, './models'),
-    cronActionsDir: path.join(__dirname, './cronActions')
-  })
-  await framework.start()
-  logger.info('[cron-worker] Cron worker started')
-
-  // 未捕获异常：打印堆栈后直接退出。OS / 进程管理器负责回收资源。
-  process.on('uncaughtException', (err) => {
-    logger.error(`[cron-worker] uncaughtException: ${err.stack || err.message}`)
-    process.exit(1)
-  })
-  process.on('unhandledRejection', (reason) => {
-    logger.error(`[cron-worker] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
-    process.exit(1)
-  })
-}
-
-const isMainModule = import.meta.url === `file://${process.argv[1]}`
-if (isMainModule) {
-  startCronWorker().catch((err) => {
-    logger.error('[cron-worker] Fatal error:', err)
-    process.exit(1)
-  })
-}
-
-export { startCronWorker }

package/templates/mjs/src/index.js

@@ -1,8 +0,0 @@
-import 'dotenv/config'
-
-import { bootstrap } from './app.js'
-
-const isMainModule = import.meta.url === `file://${process.argv[1]}`
-if (isMainModule) {
-  bootstrap()
-}

package/templates/mjs/src/services/database.js

@@ -1,16 +0,0 @@
-import { Database } from 'skweb-sequelize'
-
-const db = new Database({
-  host: process.env.DB_HOST || '127.0.0.1',
-  port: Number(process.env.DB_PORT) || 3306,
-  username: process.env.DB_USER || 'root',
-  password: process.env.DB_PASS || '',
-  database: process.env.DB_NAME || '{{name}}',
-  dialect: process.env.DB_DIALECT || 'mysql',
-  charset: process.env.DB_CHARSET || 'utf8mb4',
-  underscored: true,
-  logging: process.env.DEBUG_DB === 'true'
-})
-
-export { db }
-export default db

package/templates/mjs/src/swagger.auth-static.js

@@ -1,35 +0,0 @@
-import path from 'path'
-import { fileURLToPath } from 'url'
-import swaggerJSDoc from 'swagger-jsdoc'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-export function buildOpenApiSpec() {
-  return swaggerJSDoc({
-    definition: {
-      openapi: '3.0.3',
-      info: {
-        title: process.env.APP_NAME || 'SKWeb API',
-        version: process.env.API_VERSION || '1.0.0',
-        description: process.env.APP_DESCRIPTION || 'SKWeb project API documentation',
-        contact: { name: 'API Support' }
-      },
-      servers: [
-        { url: `http://localhost:${process.env.PORT || 3000}`, description: 'Local development' }
-      ],
-      components: {
-        securitySchemes: {
-          bearerAuth: {
-            type: 'http',
-            scheme: 'bearer',
-            bearerFormat: 'JWT'
-          }
-        }
-      }
-    },
-    apis: [
-      path.join(__dirname, 'controllers', '*.js')
-    ]
-  })
-}