nsgm-cli 2.1.10 → 2.1.12

package/README.md

@@ -16,26 +16,29 @@ A full-stack development framework with code template generation capabilities, h
 - Rapid development workflow
 - Integrated GraphQL API
 - MySQL database support
+- Secure login system with bcrypt encryption
 
 ## Command Line Tools
 
 ### Basic Commands
 
-| Command | Description |
-|------|------|
-| `nsgm init` | Initialize project |
-| `nsgm upgrade` | Upgrade project base files |
-| `nsgm create` | Create template page |
-| `nsgm delete` | Delete template page |
-| `nsgm deletedb` | Delete template page and database table |
-| `nsgm dev` | Development mode |
-| `nsgm start` | Production mode |
-| `nsgm build` | Build project |
-| `nsgm export` | Export static pages |
+| Command              | Description                             |
+| -------------------- | --------------------------------------- |
+| `nsgm init`          | Initialize project                      |
+| `nsgm upgrade`       | Upgrade project base files              |
+| `nsgm create`        | Create template page                    |
+| `nsgm delete`        | Delete template page                    |
+| `nsgm deletedb`      | Delete template page and database table |
+| `nsgm password`      | Generate password hash                  |
+| `nsgm dev`           | Development mode                        |
+| `nsgm start`         | Production mode                         |
+| `nsgm build`         | Build project                           |
+| `nsgm export`        | Export static pages                     |
 
 ### Parameter Description
 
 - **dictionary**: Used with `export`/`init` commands, default value is `webapp`
+
   ```
   nsgm init dictionary=webapp
   # or simplified as
@@ -43,6 +46,7 @@ A full-stack development framework with code template generation capabilities, h
   ```
 
 - **controller**: Used with `create`/`delete` commands, required parameter
+
   ```
   nsgm create math
   ```
@@ -52,6 +56,38 @@ A full-stack development framework with code template generation capabilities, h
   nsgm create math test
   ```
 
+- **password**: Used with `password` command, optional parameter
+  ```
+  nsgm password yourSecurePassword
+  ```
+
+## Security Configuration
+
+For security setup and login configuration, please refer to [SECURITY.md](./SECURITY.md).
+
+### Quick Setup
+
+1. Generate password hash:
+
+   ```bash
+   # Using npm script
+   npm run generate-password yourSecurePassword
+   
+   # Or using nsgm directly
+   nsgm password yourSecurePassword
+   ```
+
+2. Create `.env` file:
+
+   ```bash
+   LOGIN_USERNAME=admin
+   LOGIN_PASSWORD_HASH=your_generated_hash_here
+   ```
+
+3. Make sure `.env` is in your `.gitignore` file.
+
+**⚠️ Important:** Never commit passwords or `.env` files to version control.
+
 ## Project Configuration
 
 ### next.config.js
@@ -60,14 +96,17 @@ A full-stack development framework with code template generation capabilities, h
 const { nextConfig } = require('nsgm-cli')
 const projectConfig = require('./project.config')
 
-const { version, prefix, protocol, host } = projectConfig 
+const { version, prefix, protocol, host } = projectConfig
 
 module.exports = (phase, defaultConfig) => {
-    let configObj = nextConfig(phase, defaultConfig, { 
-        version, prefix, protocol, host
-    })
+  let configObj = nextConfig(phase, defaultConfig, {
+    version,
+    prefix,
+    protocol,
+    host
+  })
 
-    return configObj
+  return configObj
 }
 ```
 
@@ -79,13 +118,13 @@ const { mysqlOptions } = mysqlConfig
 const { user, password, host, port, database } = mysqlOptions
 
 module.exports = {
-    mysqlOptions: {
-        user,
-        password,
-        host,
-        port,
-        database
-    }
+  mysqlOptions: {
+    user,
+    password,
+    host,
+    port,
+    database
+  }
 }
 ```
 
@@ -99,11 +138,11 @@ const { prefix, protocol, host, port } = projectConfig
 const { version } = pkg
 
 module.exports = {
-    version,
-    prefix,
-    protocol,
-    host,
-    port
+  version,
+  prefix,
+  protocol,
+  host,
+  port
 }
 ```
 
@@ -116,11 +155,11 @@ The `server` folder in the project root contains the following:
 - `apis/` - Stores REST API interfaces
 - `modules/` - Stores GraphQL resolvers and schemas
 - `plugins/` - Stores GraphQL plugins
-- `*.js` - Route files, e.g., `test.js` handles requests to `/test/*` and `${prefix}/test/*`
+- `*.js` - Route files
 
 ### Example Code
 
-#### Route File Example (server/test.js)
+#### Route File Example (server/csrf-test.js)
 
 ```javascript
 const express = require('express')
@@ -129,14 +168,14 @@ const moment = require('moment')
 const router = express.Router()
 
 router.use((req, res, next) => {
-    const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl
-    console.log(moment().format('YYYY-MM-DD HH:mm:ss') + ' ' + fullUrl)
-    next()
+  const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl
+  console.log(moment().format('YYYY-MM-DD HH:mm:ss') + ' ' + fullUrl)
+  next()
 })
 
 router.get('/*', (req, res) => {
-    res.statusCode = 200
-    res.json({ name: 'TEST' })
+  res.statusCode = 200
+  res.json({ name: 'TEST' })
 })
 
 module.exports = router
@@ -149,8 +188,8 @@ const express = require('express')
 const router = express.Router()
 
 router.get('/*', (req, res) => {
-    res.statusCode = 200
-    res.json({ name: 'Hello' })
+  res.statusCode = 200
+  res.json({ name: 'Hello' })
 })
 
 module.exports = router
@@ -160,15 +199,15 @@ module.exports = router
 
 ```javascript
 module.exports = {
-    query: `
+  query: `
         link: String
     `,
-    mutation: `
+  mutation: `
         linkUpdate(link: Date): String
     `,
-    subscription: ``,
-    type: ``
-} 
+  subscription: ``,
+  type: ``
+}
 ```
 
 #### GraphQL Resolver Example (server/modules/link/resolver.js)
@@ -177,14 +216,14 @@ module.exports = {
 let localLink = ''
 
 module.exports = {
-    link: () => {
-        return localLink
-    },
-    linkUpdate: ({ link }) => {
-        console.log('link', link)
-        localLink = link
-        return localLink
-    }
+  link: () => {
+    return localLink
+  },
+  linkUpdate: ({ link }) => {
+    console.log('link', link)
+    localLink = link
+    return localLink
+  }
 }
 ```
 
@@ -196,14 +235,12 @@ const { Kind } = require('graphql/language')
 const { GraphQLScalarType } = require('graphql')
 
 const customScalarDate = new GraphQLScalarType({
-    name: 'Date',
-    description: 'Date custom scalar type',
-    parseValue: value => moment(value).valueOf(),
-    serialize: value => moment(value).format('YYYY-MM-DD HH:mm:ss:SSS'),
-    parseLiteral: ast => (ast.kind === Kind.INT)
-        ? parseInt(ast.value, 10)
-        : null
+  name: 'Date',
+  description: 'Date custom scalar type',
+  parseValue: (value) => moment(value).valueOf(),
+  serialize: (value) => moment(value).format('YYYY-MM-DD HH:mm:ss:SSS'),
+  parseLiteral: (ast) => (ast.kind === Kind.INT ? parseInt(ast.value, 10) : null)
 })
 
 module.exports = { Date: customScalarDate }
-```
+```

package/client/redux/store.ts

@@ -15,6 +15,19 @@ if (reducersKeysLen > 0) {
 
 export type RootState = ReturnType<typeof combineReducer>
 
+// 创建一个临时 store 实例来获取正确的 dispatch 类型
+const tempStore = configureStore({
+  reducer: combineReducer,
+  middleware: (getDefaultMiddleware) =>
+    getDefaultMiddleware({
+      serializableCheck: {
+        ignoredActions: ['persist/PERSIST', 'persist/REHYDRATE'],
+      },
+    }),
+})
+
+export type AppDispatch = typeof tempStore.dispatch
+
 function initStore(initialState?: any): EnhancedStore {
   return configureStore({
     reducer: combineReducer,

package/client/redux/template/manage/actions.ts

@@ -1,11 +1,9 @@
 import * as types from './types'
 import { getTemplateService, addTemplateService, updateTemplateService, deleteTemplateService, searchTemplateService, batchDeleteTemplateService } from '@/service/template/manage'
+import { AppDispatch } from '@/redux/store'
 
 export const getTemplate = (page=0, pageSize=10) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { template: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.GET_TEMPLATE
@@ -30,10 +28,7 @@ export const getTemplate = (page=0, pageSize=10) => (
 }
 
 export const searchTemplate = (page=0, pageSize=10, data: any) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { template: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.SEARCH_TEMPLATE
@@ -58,10 +53,7 @@ export const searchTemplate = (page=0, pageSize=10, data: any) => (
 }
 
 export const updateSSRTemplate = (template: any) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { template: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.UPDATE_SSR_TEMPLATE,
@@ -72,10 +64,7 @@ export const updateSSRTemplate = (template: any) => (
 }
 
 export const addTemplate = (obj:any) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { template: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.ADD_TEMPLATE
@@ -104,10 +93,7 @@ export const addTemplate = (obj:any) => (
 }
 
 export const modTemplate = (id: number, obj: any) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { template: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.MOD_TEMPLATE
@@ -135,10 +121,7 @@ export const modTemplate = (id: number, obj: any) => (
 }
 
 export const delTemplate = (id: number) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { id: number }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.DEL_TEMPLATE
@@ -163,10 +146,7 @@ export const delTemplate = (id: number) => (
 }
 
 export const batchDelTemplate = (ids:any) => (
-  dispatch: (arg0: {
-    type: string
-    payload?: { ids: any }
-  }) => void
+  dispatch: AppDispatch
 ) => {
   dispatch({
     type: types.BATCH_DEL_TEMPLATE

package/client/service/template/manage.ts

@@ -12,7 +12,7 @@ export const getTemplateService = (page = 0, pageSize = 10) => {
   return getLocalGraphql(getTemplateQuery, {
     page,
     pageSize
-  })
+  }, true) // 启用缓存，因为这是查询操作
 }
 
 export const searchTemplateByIdService = (id: number) => {
@@ -24,7 +24,7 @@ export const searchTemplateByIdService = (id: number) => {
 
   return getLocalGraphql(searchTemplateByIdQuery, {
     id
-  })
+  }, true) // 启用缓存，因为这是查询操作
 }
 
 export const searchTemplateService = (page = 0, pageSize = 10, data: any) => {
@@ -44,7 +44,7 @@ export const searchTemplateService = (page = 0, pageSize = 10, data: any) => {
     data: {
       name
     }
-  })
+  }, true) // 启用缓存，因为这是查询操作
 }
 
 export const addTemplateService = (data: any) => {
@@ -56,7 +56,7 @@ export const addTemplateService = (data: any) => {
     data: {
       name
     }
-  })
+  }, false) // 不使用缓存，因为这是变更操作，会自动添加 CSRF token
 }
 
 export const updateTemplateService = (id: number, data: any) => {
@@ -69,7 +69,7 @@ export const updateTemplateService = (id: number, data: any) => {
     data: {
       name
     }
-  })
+  }, false) // 不使用缓存，因为这是变更操作，会自动添加 CSRF token
 }
 
 export const deleteTemplateService = (id: number) => {
@@ -77,7 +77,7 @@ export const deleteTemplateService = (id: number) => {
 
   return getLocalGraphql(deleteTemplateQuery, {
     id
-  })
+  }, false) // 不使用缓存，因为这是变更操作，会自动添加 CSRF token
 }
 
 export const batchAddTemplateService = (datas: any) => {
@@ -85,7 +85,7 @@ export const batchAddTemplateService = (datas: any) => {
 
   return getLocalGraphql(batchAddTemplateQuery, {
     datas
-  })
+  }, false) // 不使用缓存，因为这是变更操作，会自动添加 CSRF token
 }
 
 export const batchDeleteTemplateService = (ids: any) => {
@@ -93,5 +93,5 @@ export const batchDeleteTemplateService = (ids: any) => {
 
   return getLocalGraphql(batchDeleteTemplateQuery, {
     ids
-  })
+  }, false) // 不使用缓存，因为这是变更操作，会自动添加 CSRF token
 }

package/client/utils/common.ts

@@ -18,8 +18,8 @@ export const getLocalApiPrefix = () => {
   
   if(!isExport){
     if (typeof window !== 'undefined') { 
+      // 客户端：使用当前页面的 location
       const location = window.location
-      // console.log('location', location)
 
       protocol = location.protocol
       if (protocol.indexOf(':') != -1) { 
@@ -28,10 +28,10 @@ export const getLocalApiPrefix = () => {
       host = location.hostname
       port = location.port || (protocol.indexOf('https') !== -1 ? "443" : "80")
     }
+    // 服务器端：直接使用配置中的值，无需额外处理
   } 
 
   localApiPrefix = protocol + '://' + host + ':' + port + prefix
-  // console.log('localApiPrefix', localApiPrefix)
   return localApiPrefix
 }