wok-server 0.3.1 → 0.3.3

package/dist/mvc/config.js

@@ -16,7 +16,7 @@ function getConfig() {
         tlsCert: ''
     }, 'SERVER', {
         port: [(0, validation_1.notNull)(), (0, validation_1.min)(80), (0, validation_1.max)(65535)],
-        timeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(60000)],
+        timeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(600000)],
         accessLog: [(0, validation_1.notNull)()],
         corsAllowOrigin: [(0, validation_1.notBlank)()],
         corsAllowHeaders: [(0, validation_1.notBlank)()],

package/dist/mvc/index.js

@@ -1,12 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopWebServer = exports.startWebServer = void 0;
+exports.stopWebServer = exports.startWebServer = exports.removeServerStaticCache = void 0;
 const tslib_1 = require("tslib");
 const server_1 = require("./server");
 /**
  * 服务实例.
  */
 let SERVER;
+/**
+ * 删除服务器静态缓存
+ * @param path 路径，必须以斜杠开头，如：/assets/index.js
+ */
+async function removeServerStaticCache(path) {
+    if (SERVER) {
+        SERVER.removeServerStaticCache(path);
+    }
+}
+exports.removeServerStaticCache = removeServerStaticCache;
 /**
  * 启动 web服务
  * @param opts

package/dist/mvc/server.js

@@ -241,6 +241,15 @@ class WokServer {
         }
         return res;
     }
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerStaticCache(path) {
+        if (this.staticHandler) {
+            this.staticHandler.removeServerCache(path);
+        }
+    }
     /**
      * 停止
      */

package/dist/mvc/static/static-handler.js

@@ -351,5 +351,15 @@ class StaticHandler {
         }
         return { filePath, stats: fileStat, maxAge: matchedRule.cacheAge };
     }
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerCache(path) {
+        if (this.cache) {
+            this.cache.remove(path);
+            this.cache.remove(`gzip-${path}`);
+        }
+    }
 }
 exports.StaticHandler = StaticHandler;

package/documentation/zh-cn/config.md

@@ -9,7 +9,7 @@
 | :------------- | :--------------------------------------------------------------- |
 | registerConfig | 注册配置信息，注册会立即匹配环境变量并返回映射了属性后的配置对象 |
 | getConfig      | 获取配置信息                                                     |
-| registerConfig | 根据环境变量生成配置信息，但是不注册                             |
+| generateConfig | 根据环境变量生成配置信息，但是不注册                             |
 
 ## 配置类型和实例对象
 

package/documentation/zh-cn/engineering.md

@@ -17,7 +17,7 @@
   ├──db-migration 数据库迁移文件，使用 mysql 时才有
   ├──src 源码目录
   │   ├──auth 授权
-  │   │   ├──auth.ts 授权信实体配置
+  │   │   ├──auth.ts 授权实体配置
   │   │   ├──auth-interceptor.ts 授权拦截器
   │   │   ├──create-auth.ts 创建授权接口（/auth/create）
   │   │   ├──ccu-task.ts 在线人数统计任务

package/documentation/zh-cn/i18n.md

@@ -5,7 +5,7 @@ i18n 对象是全局的，在处理请求时如有异步操作，可通过绑定
 
 ## 无国际化处理
 
-默认情况下国际化组件会根据环境来自动更新语言，但是如果是在容器和虚拟中使用，
+默认情况下国际化组件会根据环境来自动更新语言，但是如果是在容器和虚拟机中使用，
 那么很可能镜像默认使用的是英文。
 
 如果项目无做国际化的需要，并且要保证框架中的提示信息必须是中文，可以在程序中指定环境变量 LANG。

package/documentation/zh-cn/mvc.md

@@ -306,7 +306,7 @@ export const userUpdateHandler = createJsonHandler<Form>({
 })
 ```
 
-但是不要使用缓存组件来获取缓存内容，因为为了提升性能，缓存的内容是 Bufer，
+但是不要使用缓存组件来获取缓存内容，因为为了提升性能，缓存的内容是 Buffer，
 当使用缓存时避免再次执行对象序列化，并不是 handle 方法返回的对象。
 
 ### 二进制（Binary）上传
@@ -577,10 +577,15 @@ dir 参数是映射文件目录的地址，可以是绝对路径，也可以是
 | SERVER_STATIC_CACHE_ENABLE        | 是否启用服务器缓存，默认 false                                    |
 | SERVER_STATIC_CACHE_MAX_AGE       | 服务器缓存时间，单位秒，默认 600                                  |
 | SERVER_STATIC_CACHE_MAX_FILE_SIZE | 最大可缓存的文件大小，支持语义化格式，如 10m 和 100k 等，默认 10m |
-| SERVER_STATIC_CACHE_MAX_SIZE      | 缓存最大空间，一旦超出将执行清理，同上支持语义化格式，默认 100,   |
+| SERVER_STATIC_CACHE_MAX_SIZE      | 缓存最大空间，一旦超出将执行清理，同上支持语义化格式，默认 100m   |
 
-静态文件的服务器缓存不支持清除，只能等待过期，或者空间满被清理掉。所以，只适合缓存长期不需要改变的文件，
-目前还没有支持按规则来缓存，后续的版本有可能会考虑。
+0.3.2 版本新增加了 removeServerStaticCache 函数，可以主动删除指定的服务器端静态缓存。
+
+```ts
+import {removeServerStaticCache} from 'wok-server'
+
+removeServerStaticCache('/assets/index.js')
+```
 
 ### 请求日志
 

package/documentation/zh-cn/mysql.md

@@ -148,7 +148,7 @@ export const tableUser: Table<User> = {
 
 ### 类型映射
 
-实体类字段和查询方法的返回对象的字段有一套类型映射规则，这个需要写的时间注意，**数据库里是什么类型，就必须写对应的 js 原生类型**。
+实体类字段和查询方法的返回对象的字段有一套类型映射规则，这个需要写的时候注意，**数据库里是什么类型，就必须写对应的 js 原生类型**。
 类型映射逻辑不支持修改，下面是对照表：
 
 | js 原生类型     | mysql 字段类型                                                       |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wok-server",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "packageManager": "pnpm@8.9.0",
   "description": "一个基于 NodeJs 和 TypeScript 的后端框架，轻量级、克制、简洁。A lightweight, restrained, and concise backend framework based on Node.js and TypeScript.",
   "scripts": {

package/types/mvc/index.d.ts

@@ -1,4 +1,9 @@
 import { WokServerOpts } from './server';
+/**
+ * 删除服务器静态缓存
+ * @param path 路径，必须以斜杠开头，如：/assets/index.js
+ */
+export declare function removeServerStaticCache(path: string): Promise<void>;
 /**
  * 启动 web服务
  * @param opts

package/types/mvc/server.d.ts

@@ -78,6 +78,11 @@ export declare class WokServer {
      * @returns
      */
     private getIpv4List;
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerStaticCache(path: string): void;
     /**
      * 停止
      */

package/types/mvc/static/static-handler.d.ts

@@ -69,4 +69,9 @@ export declare class StaticHandler {
      * @returns 返回被查询到的文件信息，如果找不到则返回 null
      */
     private findFile;
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerCache(path: string): void;
 }