@jayfong/x-server 2.16.4 → 2.17.0

package/lib/_cjs/services/cache.js

@@ -11,7 +11,9 @@ class CacheService {
     this.options = options;
     this.serviceName = 'cache';
     this.prefix = void 0;
+    this.memoryCache = void 0;
     this.prefix = `${_x.x.appId}:`;
+    this.memoryCache = !options.memory ? undefined : new Map();
   }
   toRedisKey(key) {
     return `${this.prefix}${Array.isArray(key) ? key.join('_') : String(key)}`;
@@ -22,10 +24,11 @@ class CacheService {
    *
    * @param key 键
    * @param value 值
-   * @param ttl 缓存时间
+   * @param ttlOrOptions 缓存时间或选项
    * @returns 返回设置的缓存内容
    */
-  async set(key, value, ttl = this.options.ttl) {
+  async set(key, value, ttlOrOptions) {
+    const ttl = ttlOrOptions == null ? this.options.ttl : typeof ttlOrOptions === 'object' ? ttlOrOptions.ttl : ttlOrOptions;
     const redisTtl = typeof ttl === 'function' ? ttl(value, this.options.ttl) : ttl;
     if (redisTtl) {
       const redisKey = this.toRedisKey(key);
@@ -33,6 +36,9 @@ class CacheService {
       await _x.x.redis.set(redisKey, redisValue,
       // 毫秒
       'PX', (0, _vtils.ms)(redisTtl));
+      if (this.options.memory) {
+        this.memoryCache.set(redisKey, value);
+      }
     }
     return value;
   }
@@ -53,10 +59,14 @@ class CacheService {
    * 获取缓存内容。
    *
    * @param key 键
+   * @param options 选项
    * @returns 返回获取到的缓存内容
    */
   async get(key) {
     const redisKey = this.toRedisKey(key);
+    if (this.options.memory && this.memoryCache.has(redisKey)) {
+      return this.memoryCache.get(redisKey);
+    }
     const gotValue = await _x.x.redis.get(redisKey);
     if (gotValue) {
       try {
@@ -102,18 +112,18 @@ class CacheService {
    *
    * @param key 键
    * @param action 获取缓存内容的操作
-   * @param ttl 缓存时间
+   * @param ttlOrOptions 缓存时间或选项
    * @returns 返回获取到的内容
    */
-  async remember(key, action, ttl = this.options.ttl) {
+  async remember(key, action, ttlOrOptions) {
     let value = await this.get(key);
     if (value === null) {
       value = await action();
-      await this.set(key, value, ttl);
+      await this.set(key, value, ttlOrOptions);
     }
     return value;
   }
-  async rememberMany(raws, key, action, ttl = this.options.ttl) {
+  async rememberMany(raws, key, action, ttlOrOptions) {
     const keys = raws.map(key);
     const values = await this.getMany(...keys);
     const shouldUpdateIndexes = [];
@@ -126,7 +136,7 @@ class CacheService {
       const nextValues = await action(shouldUpdateIndexes.map(i => raws[i]));
       await Promise.all(nextValues.map(async (nextValue, index) => {
         values[shouldUpdateIndexes[index]] = nextValue;
-        await this.set(keys[shouldUpdateIndexes[index]], nextValue, ttl);
+        await this.set(keys[shouldUpdateIndexes[index]], nextValue, ttlOrOptions);
       }));
     }
     return values;
@@ -193,7 +203,13 @@ class CacheService {
     if (!keys.length) {
       return 0;
     }
-    return _x.x.redis.del(...keys.map(key => this.toRedisKey(key)));
+    const redisKeys = keys.map(key => this.toRedisKey(key));
+    if (this.options.memory) {
+      redisKeys.forEach(redisKey => {
+        this.memoryCache.delete(redisKey);
+      });
+    }
+    return _x.x.redis.del(...redisKeys);
   }
 
   /**

package/lib/_cjs/services/captcha.js

@@ -3,36 +3,51 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.CaptchaService = void 0;
-var _svgCaptcha = _interopRequireDefault(require("svg-captcha"));
 var _miniSvgDataUri = _interopRequireDefault(require("mini-svg-data-uri"));
+var _svgCaptcha = _interopRequireDefault(require("svg-captcha"));
+var _vtils = require("vtils");
 var _x = require("../x");
 class CaptchaService {
-  constructor(options) {
-    this.options = options;
+  constructor() {
     this.serviceName = 'captcha';
+    this.charsetMap = {
+      '09': '0123456789'.split(''),
+      '19': '123456789'.split(''),
+      'az': 'abcdefghijklmnopqrstuvwxyz'.split(''),
+      'AZ': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      'aZ': 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      '0z': '0123456789abcdefghijklmnopqrstuvwxyz'.split(''),
+      '0Z': '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      '1z': '123456789abcdefghijklmnopqrstuvwxyz'.split(''),
+      '1Z': '123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split('')
+    };
   }
-  async generate(scene) {
-    const code = Math.random().toString().slice(0 - this.options.size);
+  async generate(payload) {
+    const chars = this.charsetMap[payload.charset];
+    let code = '';
+    for (let i = 0; i < payload.size; i++) {
+      code += (0, _vtils.sample)(chars);
+    }
     const token = await _x.x.cache.save({
-      code,
-      scene
-    }, this.options.ttl);
+      code: code,
+      scene: payload.scene
+    }, payload.ttl);
     return {
       token: token,
       code: code
     };
   }
-  async generateDataUrl(scene) {
+  async generateDataUrl(payload) {
     const {
       text: code,
       data: svg
     } = _svgCaptcha.default.create({
-      size: this.options.size
+      size: payload.size
     });
     const token = await _x.x.cache.save({
       code,
-      scene
-    }, this.options.ttl);
+      scene: payload.scene
+    }, payload.ttl);
     const dataUrl = (0, _miniSvgDataUri.default)(svg);
     return {
       token: token,
@@ -41,9 +56,6 @@ class CaptchaService {
     };
   }
   async verify(options) {
-    if (options.code.length !== this.options.size) {
-      return false;
-    }
     const expected = await _x.x.cache.get(options.token);
     if (expected == null) {
       return false;

package/lib/services/cache.d.ts

@@ -1,9 +1,11 @@
+import { MsValue } from 'vtils';
 import { AsyncOrSync, IsEmptyArray } from 'vtils/types';
 import { BaseService } from './base';
-import { MsValue } from 'vtils';
 export interface CacheServiceOptions {
     /** 默认过期时间 */
     ttl: MsValue;
+    /** 启用内存缓存，仅 get, set, remove, remember 支持 */
+    memory?: boolean;
 }
 type Data = {
     [K in string]: (...args: any[]) => any;
@@ -16,10 +18,15 @@ type KeyPathForNumberValue<T extends Data> = {
     [K in keyof T]: T[K] extends (...args: infer X) => number ? IsEmptyArray<X> extends true ? K : [K, ...X] : never;
 }[keyof T];
 type Value<T extends Data, P extends KeyPath<T>> = ReturnType<T[P extends any[] ? P[0] : P]>;
+type CacheSetTTL<V> = MsValue | ((data: V, defaultTTL: MsValue) => MsValue);
+type CacheSetOptions<V> = CacheSetTTL<V> | {
+    ttl?: CacheSetTTL<V>;
+};
 export declare class CacheService<TData extends Data = Data, TKey extends Key<TData> = any, TKeyPath extends KeyPath<TData> = any, TKeyPathForNumberValue extends KeyPathForNumberValue<TData> = any> implements BaseService {
     options: CacheServiceOptions;
     serviceName: string;
     private prefix;
+    private memoryCache;
     constructor(options: CacheServiceOptions);
     private toRedisKey;
     /**
@@ -27,10 +34,10 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
      *
      * @param key 键
      * @param value 值
-     * @param ttl 缓存时间
+     * @param ttlOrOptions 缓存时间或选项
      * @returns 返回设置的缓存内容
      */
-    set<K extends TKeyPath, V extends Value<TData, K>>(key: K, value: V, ttl?: MsValue | ((data: V, defaultTTL: MsValue) => MsValue)): Promise<V>;
+    set<K extends TKeyPath, V extends Value<TData, K>>(key: K, value: V, ttlOrOptions?: CacheSetOptions<V>): Promise<V>;
     /**
      * 存储值然后返回其对应的键，该键 URL 友好。
      *
@@ -42,6 +49,7 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
      * 获取缓存内容。
      *
      * @param key 键
+     * @param options 选项
      * @returns 返回获取到的缓存内容
      */
     get<K extends TKeyPath, V extends Value<TData, K>>(key: K): Promise<V | null>;
@@ -64,11 +72,11 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
      *
      * @param key 键
      * @param action 获取缓存内容的操作
-     * @param ttl 缓存时间
+     * @param ttlOrOptions 缓存时间或选项
      * @returns 返回获取到的内容
      */
-    remember<K extends TKeyPath, V extends Value<TData, K>>(key: K, action: () => V | Promise<V>, ttl?: MsValue | ((data: V, defaultTTL: MsValue) => MsValue)): Promise<V>;
-    rememberMany<T, K extends TKeyPath, V extends Value<TData, K>>(raws: T[], key: (raw: T) => K, action: (raws: T[]) => V[] | Promise<V[]>, ttl?: MsValue | ((data: V, defaultTTL: MsValue) => MsValue)): Promise<V[]>;
+    remember<K extends TKeyPath, V extends Value<TData, K>>(key: K, action: () => V | Promise<V>, ttlOrOptions?: CacheSetOptions<V>): Promise<V>;
+    rememberMany<T, K extends TKeyPath, V extends Value<TData, K>>(raws: T[], key: (raw: T) => K, action: (raws: T[]) => V[] | Promise<V[]>, ttlOrOptions?: CacheSetOptions<V>): Promise<V[]>;
     /**
      * 自增。
      *

package/lib/services/cache.js

@@ -6,7 +6,9 @@ export class CacheService {
     this.options = options;
     this.serviceName = 'cache';
     this.prefix = void 0;
+    this.memoryCache = void 0;
     this.prefix = `${x.appId}:`;
+    this.memoryCache = !options.memory ? undefined : new Map();
   }
   toRedisKey(key) {
     return `${this.prefix}${Array.isArray(key) ? key.join('_') : String(key)}`;
@@ -17,10 +19,11 @@ export class CacheService {
    *
    * @param key 键
    * @param value 值
-   * @param ttl 缓存时间
+   * @param ttlOrOptions 缓存时间或选项
    * @returns 返回设置的缓存内容
    */
-  async set(key, value, ttl = this.options.ttl) {
+  async set(key, value, ttlOrOptions) {
+    const ttl = ttlOrOptions == null ? this.options.ttl : typeof ttlOrOptions === 'object' ? ttlOrOptions.ttl : ttlOrOptions;
     const redisTtl = typeof ttl === 'function' ? ttl(value, this.options.ttl) : ttl;
     if (redisTtl) {
       const redisKey = this.toRedisKey(key);
@@ -28,6 +31,9 @@ export class CacheService {
       await x.redis.set(redisKey, redisValue,
       // 毫秒
       'PX', ms(redisTtl));
+      if (this.options.memory) {
+        this.memoryCache.set(redisKey, value);
+      }
     }
     return value;
   }
@@ -48,10 +54,14 @@ export class CacheService {
    * 获取缓存内容。
    *
    * @param key 键
+   * @param options 选项
    * @returns 返回获取到的缓存内容
    */
   async get(key) {
     const redisKey = this.toRedisKey(key);
+    if (this.options.memory && this.memoryCache.has(redisKey)) {
+      return this.memoryCache.get(redisKey);
+    }
     const gotValue = await x.redis.get(redisKey);
     if (gotValue) {
       try {
@@ -97,18 +107,18 @@ export class CacheService {
    *
    * @param key 键
    * @param action 获取缓存内容的操作
-   * @param ttl 缓存时间
+   * @param ttlOrOptions 缓存时间或选项
    * @returns 返回获取到的内容
    */
-  async remember(key, action, ttl = this.options.ttl) {
+  async remember(key, action, ttlOrOptions) {
     let value = await this.get(key);
     if (value === null) {
       value = await action();
-      await this.set(key, value, ttl);
+      await this.set(key, value, ttlOrOptions);
     }
     return value;
   }
-  async rememberMany(raws, key, action, ttl = this.options.ttl) {
+  async rememberMany(raws, key, action, ttlOrOptions) {
     const keys = raws.map(key);
     const values = await this.getMany(...keys);
     const shouldUpdateIndexes = [];
@@ -121,7 +131,7 @@ export class CacheService {
       const nextValues = await action(shouldUpdateIndexes.map(i => raws[i]));
       await Promise.all(nextValues.map(async (nextValue, index) => {
         values[shouldUpdateIndexes[index]] = nextValue;
-        await this.set(keys[shouldUpdateIndexes[index]], nextValue, ttl);
+        await this.set(keys[shouldUpdateIndexes[index]], nextValue, ttlOrOptions);
       }));
     }
     return values;
@@ -188,7 +198,13 @@ export class CacheService {
     if (!keys.length) {
       return 0;
     }
-    return x.redis.del(...keys.map(key => this.toRedisKey(key)));
+    const redisKeys = keys.map(key => this.toRedisKey(key));
+    if (this.options.memory) {
+      redisKeys.forEach(redisKey => {
+        this.memoryCache.delete(redisKey);
+      });
+    }
+    return x.redis.del(...redisKeys);
   }
 
   /**

package/lib/services/captcha.d.ts

@@ -1,6 +1,11 @@
+import { type MsValue } from 'vtils';
 import { BaseService } from './base';
-import type { MsValue } from 'vtils';
-export interface CaptchaServiceOptions {
+export type CaptchaServiceGenerateCharset = '09' | '19' | 'az' | 'AZ' | 'aZ' | '0z' | '0Z' | '1z' | '1Z';
+export interface CaptchaServiceGeneratePayload {
+    /**
+     * 场景值
+     */
+    scene: string;
     /**
      * 验证码长度
      */
@@ -9,6 +14,10 @@ export interface CaptchaServiceOptions {
      * 验证码存活时长
      */
     ttl: MsValue;
+    /**
+     * 字符集
+     */
+    charset: CaptchaServiceGenerateCharset;
 }
 export interface CaptchaServiceGenerateResult {
     token: string;
@@ -30,11 +39,10 @@ export interface CaptchaServiceVerifyOptions {
     scene: string;
 }
 export declare class CaptchaService implements BaseService {
-    private options;
     serviceName: string;
-    constructor(options: CaptchaServiceOptions);
-    generate(scene: string): Promise<CaptchaServiceGenerateResult>;
-    generateDataUrl(scene: string): Promise<CaptchaServiceGenerateDataUrlResult>;
+    private charsetMap;
+    generate(payload: CaptchaServiceGeneratePayload): Promise<CaptchaServiceGenerateResult>;
+    generateDataUrl(payload: CaptchaServiceGeneratePayload): Promise<CaptchaServiceGenerateDataUrlResult>;
     verify(options: CaptchaServiceVerifyOptions): Promise<boolean>;
 }
 declare module '../x' {

package/lib/services/captcha.js

@@ -1,33 +1,48 @@
-import svgCaptcha from 'svg-captcha';
 import svgToDataUrl from 'mini-svg-data-uri';
+import svgCaptcha from 'svg-captcha';
+import { sample } from 'vtils';
 import { x } from "../x";
 export class CaptchaService {
-  constructor(options) {
-    this.options = options;
+  constructor() {
     this.serviceName = 'captcha';
+    this.charsetMap = {
+      '09': '0123456789'.split(''),
+      '19': '123456789'.split(''),
+      'az': 'abcdefghijklmnopqrstuvwxyz'.split(''),
+      'AZ': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      'aZ': 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      '0z': '0123456789abcdefghijklmnopqrstuvwxyz'.split(''),
+      '0Z': '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split(''),
+      '1z': '123456789abcdefghijklmnopqrstuvwxyz'.split(''),
+      '1Z': '123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.split('')
+    };
   }
-  async generate(scene) {
-    const code = Math.random().toString().slice(0 - this.options.size);
+  async generate(payload) {
+    const chars = this.charsetMap[payload.charset];
+    let code = '';
+    for (let i = 0; i < payload.size; i++) {
+      code += sample(chars);
+    }
     const token = await x.cache.save({
-      code,
-      scene
-    }, this.options.ttl);
+      code: code,
+      scene: payload.scene
+    }, payload.ttl);
     return {
       token: token,
       code: code
     };
   }
-  async generateDataUrl(scene) {
+  async generateDataUrl(payload) {
     const {
       text: code,
       data: svg
     } = svgCaptcha.create({
-      size: this.options.size
+      size: payload.size
     });
     const token = await x.cache.save({
       code,
-      scene
-    }, this.options.ttl);
+      scene: payload.scene
+    }, payload.ttl);
     const dataUrl = svgToDataUrl(svg);
     return {
       token: token,
@@ -36,9 +51,6 @@ export class CaptchaService {
     };
   }
   async verify(options) {
-    if (options.code.length !== this.options.size) {
-      return false;
-    }
     const expected = await x.cache.get(options.token);
     if (expected == null) {
       return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.16.4",
+  "version": "2.17.0",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",