wok-server 0.4.13 → 0.6.0

package/src/validation/validator/regexp.ts

@@ -0,0 +1,32 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * 正则校验
+ * @param pattern 正则表达式
+ * @param msg 错误消息
+ * @returns
+ */
+export function regexp<T>(pattern: RegExp, msg?: string): PropValidator<T> {
+  const validator = 'regexp'
+  return val => {
+    if (val === undefined || val === null) {
+      return { ok: true }
+    }
+    if (typeof val !== 'string') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-string') }
+    }
+    // 跳过空串
+    if (!val) {
+      return { ok: true }
+    }
+    if (!pattern.test(val)) {
+      return {
+        ok: false,
+        validator,
+        message: msg || getI18n().buildMsg('validate-err-incorrect-format')
+      }
+    }
+    return { ok: true }
+  }
+}

package/types/cache/cache.d.ts

@@ -1,52 +1,52 @@
-import { CacheStat } from './stat';
-/**
- * 缓存内容
- */
-export interface CacheContent {
-    /**
-     * 保存的值
-     */
-    val: any;
-    /**
-     * 过期时间
-     */
-    expireAt: number;
-}
-export declare class Cache {
-    private readonly valueMap;
-    private readonly stat?;
-    /**
-     * promise 表，作用是处理异步并发问题，如果有相同的 key 同时请求，保证异步的 provider 只执行一次
-     */
-    private promiseMap;
-    constructor(valueMap: Map<string, CacheContent>, stat?: CacheStat | undefined);
-    /**
-     * 放入缓存
-     * @param key
-     * @param val
-     * @param expiresInSeconds
-     */
-    put(key: string, val: any, expiresInSeconds?: number): void;
-    /**
-     * 获取缓存值
-     * @param key
-     * @returns
-     */
-    get<T>(key: string): T | undefined;
-    /**
-     * 清除所有缓存
-     */
-    clear(): void;
-    /**
-     * 删除.
-     * @param key
-     */
-    remove(key: string): void;
-    /**
-     * 在缓存值不存在时计算缓存的值，然后放入并返回.
-     * @param key
-     * @param provider
-     * @param expiresInSeconds
-     */
-    computeIfAbsent<T>(key: string, provider: () => Promise<T> | T, expiresInSeconds?: number): Promise<T>;
-}
+import { CacheStat } from './stat';
+/**
+ * 缓存内容
+ */
+export interface CacheContent {
+    /**
+     * 保存的值
+     */
+    val: any;
+    /**
+     * 过期时间
+     */
+    expireAt: number;
+}
+export declare class Cache {
+    private readonly valueMap;
+    private readonly stat?;
+    /**
+     * promise 表，作用是处理异步并发问题，如果有相同的 key 同时请求，保证异步的 provider 只执行一次
+     */
+    private promiseMap;
+    constructor(valueMap: Map<string, CacheContent>, stat?: CacheStat | undefined);
+    /**
+     * 放入缓存
+     * @param key
+     * @param val
+     * @param expiresInSeconds
+     */
+    put(key: string, val: any, expiresInSeconds?: number): void;
+    /**
+     * 获取缓存值
+     * @param key
+     * @returns
+     */
+    get<T>(key: string): T | undefined;
+    /**
+     * 清除所有缓存
+     */
+    clear(): void;
+    /**
+     * 删除.
+     * @param key
+     */
+    remove(key: string): void;
+    /**
+     * 在缓存值不存在时计算缓存的值，然后放入并返回.
+     * @param key
+     * @param provider
+     * @param expiresInSeconds
+     */
+    computeIfAbsent<T>(key: string, provider: () => Promise<T> | T, expiresInSeconds?: number): Promise<T>;
+}

package/types/cache/config.d.ts

@@ -1,32 +1,32 @@
-/**
- * 缓存的配置
- */
-interface CacheConfig {
-    /**
-     * 默认的存活时长，取值：1-3600，默认 60。存活时间应该尽可能的短，尤其是当缓存的内容比较大时，
-     * 否则缓存的内容长时间占用内存，会对 gc 造成影响。
-     */
-    defaultExpireInSeconds: number;
-    /**
-     * 是否启用统计任务，启用后每隔指定的时间打印一次缓存统计信息，用于了解缓存的情况.
-     */
-    statTaskEnabled: boolean;
-    /**
-     * 统计任务执行的周期,单位秒，取值 60-3600。统计周期也即是时间窗口，
-     * 每个周期都是独立的，只统计这个周期内的缓存使用情况。
-     */
-    statInterval: number;
-    /**
-     * 最大元素数量，为了控制缓存占用的内存空间，可以将 maxElements 设置的低一些。
-     */
-    maxElements: number;
-    /**
-     * 数据清理任务执行周期，单位秒.取值 1-3600，清理任务完成两件事：删除过期数据和驱逐多余记录。
-     * 如果项目规模小，缓存的内容非常少，可以将间隔设置长一些，降低频率.
-     * 如果缓存的内容很多，频率需要高一些，及时将无效数据清理掉。
-     * 否则缓存会长时间占用很高的内存无法被回收，回收器完成检查却需要很长时间，影响gc效率.
-     */
-    cleaningInterval: number;
-}
-export declare const config: CacheConfig;
-export {};
+/**
+ * 缓存的配置
+ */
+interface CacheConfig {
+    /**
+     * 默认的存活时长，取值：1-3600，默认 60。存活时间应该尽可能的短，尤其是当缓存的内容比较大时，
+     * 否则缓存的内容长时间占用内存，会对 gc 造成影响。
+     */
+    defaultExpireInSeconds: number;
+    /**
+     * 是否启用统计任务，启用后每隔指定的时间打印一次缓存统计信息，用于了解缓存的情况.
+     */
+    statTaskEnabled: boolean;
+    /**
+     * 统计任务执行的周期,单位秒，取值 60-3600。统计周期也即是时间窗口，
+     * 每个周期都是独立的，只统计这个周期内的缓存使用情况。
+     */
+    statInterval: number;
+    /**
+     * 最大元素数量，为了控制缓存占用的内存空间，可以将 maxElements 设置的低一些。
+     */
+    maxElements: number;
+    /**
+     * 数据清理任务执行周期，单位秒.取值 1-3600，清理任务完成两件事：删除过期数据和驱逐多余记录。
+     * 如果项目规模小，缓存的内容非常少，可以将间隔设置长一些，降低频率.
+     * 如果缓存的内容很多，频率需要高一些，及时将无效数据清理掉。
+     * 否则缓存会长时间占用很高的内存无法被回收，回收器完成检查却需要很长时间，影响gc效率.
+     */
+    cleaningInterval: number;
+}
+export declare const config: CacheConfig;
+export {};

package/types/cache/index.d.ts

@@ -1,2 +1,2 @@
-import { Cache } from './cache';
-export declare function getCache(): Cache;
+import { Cache } from './cache';
+export declare function getCache(): Cache;

package/types/cache/purge-task.d.ts

@@ -1,11 +1,11 @@
-import { Task } from '../task';
-import { CacheContent } from './cache';
-/**
- * 缓存清理任务
- */
-export declare class PurgeTask implements Task {
-    private readonly valueMap;
-    readonly name = "Cache purge";
-    constructor(valueMap: Map<string, CacheContent>);
-    run(): Promise<void>;
-}
+import { Task } from '../task';
+import { CacheContent } from './cache';
+/**
+ * 缓存清理任务
+ */
+export declare class PurgeTask implements Task {
+    private readonly valueMap;
+    readonly name = "Cache purge";
+    constructor(valueMap: Map<string, CacheContent>);
+    run(): Promise<void>;
+}

package/types/cache/stat.d.ts

@@ -1,26 +1,26 @@
-/**
- * 缓存统计.
- */
-export declare class CacheStat {
-    private readonly valueMap;
-    /**
-     * 开始统计时间
-     */
-    private start;
-    private totalGet;
-    private totalHit;
-    constructor(valueMap: Map<string, any>);
-    /**
-     * 添加 get 次数
-     * @param hit 是否命中
-     */
-    addGet(hit: boolean): void;
-    /**
-     * 清空统计信息，重新开始统计.
-     */
-    clear(): void;
-    /**
-     * 输出日志
-     */
-    log(): void;
-}
+/**
+ * 缓存统计.
+ */
+export declare class CacheStat {
+    private readonly valueMap;
+    /**
+     * 开始统计时间
+     */
+    private start;
+    private totalGet;
+    private totalHit;
+    constructor(valueMap: Map<string, any>);
+    /**
+     * 添加 get 次数
+     * @param hit 是否命中
+     */
+    addGet(hit: boolean): void;
+    /**
+     * 清空统计信息，重新开始统计.
+     */
+    clear(): void;
+    /**
+     * 输出日志
+     */
+    log(): void;
+}

package/types/config/convert.d.ts

@@ -1,6 +1,6 @@
-/**
- * 转换值.
- * @param val
- * @param defaultVal
- */
-export declare function convert(val: string, defaultVal: any): string | number | boolean;
+/**
+ * 转换值.
+ * @param val
+ * @param defaultVal
+ */
+export declare function convert(val: string, defaultVal: any): string | number | boolean;

package/types/config/exception.d.ts

@@ -1,7 +1,7 @@
-/**
- * 配置异常.
- */
-export declare class ConfigException extends Error {
-    readonly message: string;
-    constructor(message: string);
-}
+/**
+ * 配置异常.
+ */
+export declare class ConfigException extends Error {
+    readonly message: string;
+    constructor(message: string);
+}

package/types/config/index.d.ts

@@ -1,25 +1,25 @@
-import { ValidationOpts } from '../validation';
-/**
- * 获取配置
- * @param envPrefix
- */
-export declare function getConfig<T>(envPrefix: string): T | undefined;
-/**
- * 注册配置信息.
- * @param defaultConfig 默认值, 模块会根据默认值来映射环境变量，默认值所有的属性都不能是 undefined，否则无法映射.
- * @param envPrefix 环境变量前缀.
- * @param validation 校验规则，如果有值，初始化的时候会对配置进行校验
- * @returns 映射了环境变量后的配置
- */
-export declare function registerConfig<T extends {}>(defaultConfig: T, envPrefix: string, validation?: ValidationOpts<T>): T;
-/**
- * 根据环境变量来生成配置对象，与 registerConfig 的参数是一致的，和 registerConfig 不同的是
- * generateConfig 可以多次重复使用，方便在运行时更改环境变量后再生成配置，而调用 registerConfig
- * 一旦注册后不能再被更改。之所以这样设计是为了方便程序的测试，模拟不同的环境来运行程序，和其它的
- * 一些特殊需求。
- * @param defaultConfig
- * @param envPrefix
- * @param validation
- */
-export declare function generateConfig<T extends {}>(defaultConfig: T, envPrefix: string, validation?: ValidationOpts<T>): T;
-export * from './exception';
+import { ValidationOpts } from '../validation';
+/**
+ * 获取配置
+ * @param envPrefix
+ */
+export declare function getConfig<T>(envPrefix: string): T | undefined;
+/**
+ * 注册配置信息.
+ * @param defaultConfig 默认值, 模块会根据默认值来映射环境变量，默认值所有的属性都不能是 undefined，否则无法映射.
+ * @param envPrefix 环境变量前缀.
+ * @param validation 校验规则，如果有值，初始化的时候会对配置进行校验
+ * @returns 映射了环境变量后的配置
+ */
+export declare function registerConfig<T extends {}>(defaultConfig: T, envPrefix: string, validation?: ValidationOpts<T>): T;
+/**
+ * 根据环境变量来生成配置对象，与 registerConfig 的参数是一致的，和 registerConfig 不同的是
+ * generateConfig 可以多次重复使用，方便在运行时更改环境变量后再生成配置，而调用 registerConfig
+ * 一旦注册后不能再被更改。之所以这样设计是为了方便程序的测试，模拟不同的环境来运行程序，和其它的
+ * 一些特殊需求。
+ * @param defaultConfig
+ * @param envPrefix
+ * @param validation
+ */
+export declare function generateConfig<T extends {}>(defaultConfig: T, envPrefix: string, validation?: ValidationOpts<T>): T;
+export * from './exception';

package/types/http-client/index.d.ts

@@ -1,71 +1,71 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingHttpHeaders } from 'http';
-/**
- * 请求选项.
- */
-export interface HttpRequestOpts {
-    /**
-     * 链接地址.
-     */
-    url: string;
-    /**
-     * 查询参数，附加在链接地址上
-     */
-    query?: Record<string, string[] | string>;
-    /**
-     * 正文，可以是序列化好的字符串或二进制内容.
-     */
-    body?: string | Buffer;
-    /**
-     * 消息头
-     */
-    headers?: IncomingHttpHeaders;
-    /**
-     * 请求方法
-     */
-    method: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
-    /**
-     * 超时时间，单位毫秒，默认 5000
-     */
-    timeout?: number;
-    /**
-     * 是否跟随重定向
-     */
-    followRedirect?: boolean;
-}
-/**
- * 响应信息.
- */
-export interface HttpResponseInfo {
-    /**
-     * 状态码
-     */
-    status: number;
-    /**
-     * 消息头.
-     */
-    headers: IncomingHttpHeaders;
-    /**
-     * 响应正文
-     */
-    body: Buffer;
-}
-/**
- * 发送 http 请求.
- * @param opts
- * @returns
- */
-export declare function doRequest(opts: HttpRequestOpts): Promise<HttpResponseInfo>;
-/**
- * 发送 json 格式的 post 请求，body 是未序列化的普通对象，表示要发送的请求数据.
- * @param opts
- */
-export declare function postJson<T>(opts: Pick<HttpRequestOpts, 'url' | 'query' | 'headers' | 'timeout'> & {
-    body: any;
-}): Promise<T>;
-/**
- * get 请求获取 json 格式数据.
- * @param opts
- */
-export declare function getJson<T>(opts: Pick<HttpRequestOpts, 'url' | 'query' | 'headers' | 'timeout'>): Promise<T>;
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingHttpHeaders } from 'http';
+/**
+ * 请求选项.
+ */
+export interface HttpRequestOpts {
+    /**
+     * 链接地址.
+     */
+    url: string;
+    /**
+     * 查询参数，附加在链接地址上
+     */
+    query?: Record<string, string[] | string>;
+    /**
+     * 正文，可以是序列化好的字符串或二进制内容.
+     */
+    body?: string | Buffer;
+    /**
+     * 消息头
+     */
+    headers?: IncomingHttpHeaders;
+    /**
+     * 请求方法
+     */
+    method: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+    /**
+     * 超时时间，单位毫秒，默认 5000
+     */
+    timeout?: number;
+    /**
+     * 是否跟随重定向
+     */
+    followRedirect?: boolean;
+}
+/**
+ * 响应信息.
+ */
+export interface HttpResponseInfo {
+    /**
+     * 状态码
+     */
+    status: number;
+    /**
+     * 消息头.
+     */
+    headers: IncomingHttpHeaders;
+    /**
+     * 响应正文
+     */
+    body: Buffer;
+}
+/**
+ * 发送 http 请求.
+ * @param opts
+ * @returns
+ */
+export declare function doRequest(opts: HttpRequestOpts): Promise<HttpResponseInfo>;
+/**
+ * 发送 json 格式的 post 请求，body 是未序列化的普通对象，表示要发送的请求数据.
+ * @param opts
+ */
+export declare function postJson<T>(opts: Pick<HttpRequestOpts, 'url' | 'query' | 'headers' | 'timeout'> & {
+    body: any;
+}): Promise<T>;
+/**
+ * get 请求获取 json 格式数据.
+ * @param opts
+ */
+export declare function getJson<T>(opts: Pick<HttpRequestOpts, 'url' | 'query' | 'headers' | 'timeout'>): Promise<T>;

package/types/i18n/ar.d.ts

@@ -1,2 +1,2 @@
-import { I18nMsgs } from './msg';
-export declare const ar: I18nMsgs;
+import { I18nMsgs } from './msg';
+export declare const ar: I18nMsgs;

package/types/i18n/de.d.ts

@@ -1,2 +1,2 @@
-import { I18nMsgs } from './msg';
-export declare const de: I18nMsgs;
+import { I18nMsgs } from './msg';
+export declare const de: I18nMsgs;

package/types/i18n/en-us.d.ts

@@ -1,2 +1,2 @@
-import { I18nMsgs } from './msg';
-export declare const enUS: I18nMsgs;
+import { I18nMsgs } from './msg';
+export declare const enUS: I18nMsgs;

package/types/i18n/es.d.ts

@@ -1,2 +1,2 @@
-import { I18nMsgs } from './msg';
-export declare const es: I18nMsgs;
+import { I18nMsgs } from './msg';
+export declare const es: I18nMsgs;

package/types/i18n/fr.d.ts

@@ -1,2 +1,2 @@
-import { I18nMsgs } from './msg';
-export declare const fr: I18nMsgs;
+import { I18nMsgs } from './msg';
+export declare const fr: I18nMsgs;