wok-server 0.5.0 → 0.7.0

package/src/validation/validator/length.ts

@@ -0,0 +1,42 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * length 校验，可用于字符串或数组.
+ * @returns
+ */
+export function length<T>(opts: {
+  min?: number
+  max?: number
+  message?: string
+}): PropValidator<T> {
+  const validator = 'length'
+  return val => {
+    // 不校验空
+    if (!val) {
+      return { ok: true }
+    }
+    if (typeof (val as any).length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-no-length') }
+    }
+    const { length } = val as any
+    if (typeof length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-length-not-number') }
+    }
+    if (typeof opts.min === 'number' && length < opts.min) {
+      return {
+        ok: false,
+        validator,
+        message: opts.message || getI18n().buildMsg('validate-err-min-length', `${opts.min}`)
+      }
+    }
+    if (typeof opts.max === 'number' && length > opts.max) {
+      return {
+        ok: false,
+        validator,
+        message: opts.message || getI18n().buildMsg('validate-err-max-length', `${opts.max}`)
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/max-length.ts

@@ -0,0 +1,33 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * 最大长度校验，可用于字符串或数组.
+ * @param maxLength
+ * @param message
+ * @returns
+ */
+export function maxLength<T>(maxLength: number, message?: string): PropValidator<T> {
+  const validator = 'maxLength'
+  return val => {
+    // 不校验空
+    if (!val) {
+      return { ok: true }
+    }
+    if (typeof (val as any).length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-no-length') }
+    }
+    const { length } = val as any
+    if (typeof length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-length-not-number') }
+    }
+    if (length > maxLength) {
+      return {
+        ok: false,
+        validator,
+        message: message || getI18n().buildMsg('validate-err-max-length', `${maxLength}`)
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/max.ts

@@ -0,0 +1,26 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+/**
+ * 最大值校验.
+ * @param max 最大值
+ * @param msg 错误消息
+ */
+export function max<T>(max: number, msg?: string): PropValidator<T> {
+  const validator = 'max'
+  return val => {
+    if (val == undefined || val === null) {
+      return { ok: true }
+    }
+    if (typeof val !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-numer') }
+    }
+    if (val > max) {
+      return {
+        ok: false,
+        validator,
+        message: msg || getI18n().buildMsg('validate-err-max', `${max}`)
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/min-length.ts

@@ -0,0 +1,31 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * 最小长度校验，可用于字符串或数组.
+ * @returns
+ */
+export function minLength<T>(minLength: number, message?: string): PropValidator<T> {
+  const validator = 'minLength'
+  return val => {
+    // 不校验空
+    if (!val) {
+      return { ok: true }
+    }
+    if (typeof (val as any).length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-no-length') }
+    }
+    const { length } = val as any
+    if (typeof length !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-length-not-number') }
+    }
+    if (length < minLength) {
+      return {
+        ok: false,
+        validator,
+        message: message || getI18n().buildMsg('validate-err-min-length', `${minLength}`)
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/min.ts

@@ -0,0 +1,26 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+/**
+ * 最小值校验.
+ * @param min 最小值
+ * @param msg 错误消息
+ */
+export function min<T>(min: number, msg?: string): PropValidator<T> {
+  const validator = 'min'
+  return val => {
+    if (val == undefined || val === null) {
+      return { ok: true }
+    }
+    if (typeof val !== 'number') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-numer') }
+    }
+    if (val < min) {
+      return {
+        ok: false,
+        validator,
+        message: msg || getI18n().buildMsg('validate-err-min', `${min}`)
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/not-blank.ts

@@ -0,0 +1,31 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * 字符串非空校验，以下的情况不会通过校验：undefined，null，非 string 类型，空白字符串.
+ * @param message
+ * @returns
+ */
+export function notBlank<T>(message?: string): PropValidator<T> {
+  const validator = 'notBlank'
+  return val => {
+    if (val === undefined || val === null) {
+      return {
+        ok: false,
+        validator,
+        message: message || getI18n().buildMsg('validate-err-empty')
+      }
+    }
+    if (typeof val !== 'string') {
+      return { ok: false, validator, message: getI18n().buildMsg('validate-err-string') }
+    }
+    if (!val.trim()) {
+      return {
+        ok: false,
+        validator,
+        message: message || getI18n().buildMsg('validate-err-empty')
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/not-null.ts

@@ -0,0 +1,19 @@
+import { PropValidator } from '..'
+import { getI18n } from '../../i18n'
+
+/**
+ * 非空校验.
+ * @param message
+ */
+export function notNull<T>(message?: string): PropValidator<T> {
+  return val => {
+    if (val === null || val === undefined) {
+      return {
+        ok: false,
+        message: message || getI18n().buildMsg('validate-err-empty'),
+        validator: 'notNull'
+      }
+    }
+    return { ok: true }
+  }
+}

package/src/validation/validator/plain-obj.ts

@@ -0,0 +1,30 @@
+import { PropValidator, ValidationOpts } from '..'
+
+/**
+ * 普通对象校验.
+ * @param opts
+ * @returns
+ */
+export function plainObject<T>(opts: ValidationOpts<Exclude<T, undefined>>): PropValidator<T> {
+  const validator = 'plainObject'
+  return val => {
+    if (!val) {
+      return { ok: true }
+    }
+    for (const entry of Object.entries(opts)) {
+      const [prop, validators] = entry
+      const v = val[prop as keyof T]
+      for (const validate of validators as PropValidator<any>[]) {
+        const result = validate(v)
+        if (!result.ok) {
+          const propPath = [prop]
+          if (result.propPath) {
+            propPath.push(...result.propPath)
+          }
+          return { ok: false, validator, message: result.message, propPath }
+        }
+      }
+    }
+    return { ok: true }
+  }
+}

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';