@jayfong/x-server 2.16.3 → 2.16.5

package/lib/_cjs/index.js

@@ -193,6 +193,12 @@ Object.keys(_sensitive_words).forEach(function (key) {
   if (key in exports && exports[key] === _sensitive_words[key]) return;
   exports[key] = _sensitive_words[key];
 });
+var _sms = require("./services/sms");
+Object.keys(_sms).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _sms[key]) return;
+  exports[key] = _sms[key];
+});
 var _index = require("./types/index");
 Object.keys(_index).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

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/_cjs/services/rate_limit.js

@@ -2,6 +2,7 @@
 
 exports.__esModule = true;
 exports.RateLimitService = void 0;
+var _vtils = require("vtils");
 var _http_error = require("../core/http_error");
 var _x = require("../x");
 class RateLimitService {
@@ -28,5 +29,27 @@ class RateLimitService {
     }
     return count;
   }
+  async limitByManyCount(options) {
+    for (let i = 0; i < options.limits.length; i++) {
+      const item = options.limits[i];
+      const ttl = (0, _vtils.ms)(item.ttl);
+      const remainingCount = await this.limitByCount({
+        key: `${options.key}_${ttl}`,
+        ttl: ttl,
+        count: item.count
+      });
+      if (remainingCount === 0) {
+        return i;
+      }
+    }
+    return true;
+  }
+  async limitByManyCountOrFail(options) {
+    const pass = await this.limitByManyCount(options);
+    if (pass !== true) {
+      var _options$limits$pass$;
+      throw new _http_error.HttpError.Forbidden((_options$limits$pass$ = options.limits[pass].message) != null ? _options$limits$pass$ : options.message);
+    }
+  }
 }
 exports.RateLimitService = RateLimitService;

package/lib/_cjs/services/sms.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.SmsService = void 0;
+var _tencentcloudSdkNodejsSms = _interopRequireDefault(require("tencentcloud-sdk-nodejs-sms"));
+var _http_error = require("../core/http_error");
+class SmsService {
+  constructor(options) {
+    this.options = options;
+    this.serviceName = 'sms';
+  }
+  async send(payload) {
+    if (payload.provider === 'tencentCloud') {
+      const SmsClient = _tencentcloudSdkNodejsSms.default.sms.v20210111.Client;
+      const smsClient = new SmsClient({
+        credential: {
+          secretId: this.options.providerOptions.secretId,
+          secretKey: this.options.providerOptions.secretKey
+        }
+      });
+      const res = await smsClient.SendSms({
+        SmsSdkAppId: this.options.providerOptions.appId,
+        SignName: payload.signature,
+        TemplateId: payload.templateId,
+        TemplateParamSet: payload.templateParamValues,
+        PhoneNumberSet: [payload.phoneNumber[0] === '+' ? payload.phoneNumber : `+86${payload.phoneNumber}`]
+      });
+      return {
+        success: res.SendStatusSet[0].Code === 'Ok',
+        message: res.SendStatusSet[0].Message,
+        smsId: res.SendStatusSet[0].SerialNo
+      };
+    }
+    throw new _http_error.HttpError.BadRequest(`no sms provider: ${payload.provider}`);
+  }
+}
+exports.SmsService = SmsService;

package/lib/index.d.ts

@@ -30,6 +30,7 @@ export * from './services/pay';
 export * from './services/rate_limit';
 export * from './services/redis';
 export * from './services/sensitive_words';
+export * from './services/sms';
 export * from './types/index';
 export * from './x';
 export * from '.x/models';

package/lib/index.js

@@ -31,6 +31,7 @@ export * from "./services/pay";
 export * from "./services/rate_limit";
 export * from "./services/redis";
 export * from "./services/sensitive_words";
+export * from "./services/sms";
 export * from "./types/index";
 export * from "./x";
 // @endindex

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/lib/services/rate_limit.d.ts

@@ -1,17 +1,34 @@
-import { BaseService } from './base';
 import { MsValue } from 'vtils';
+import { BaseService } from './base';
 export interface RateLimitServiceLimitByCountOptions {
     key: string;
-    count: number;
     ttl: MsValue;
+    count: number;
 }
 export interface RateLimitServiceLimitByCountOrFailOptions extends RateLimitServiceLimitByCountOptions {
     message?: string;
 }
+export interface RateLimitServiceLimitByManyCountOptions {
+    key: string;
+    limits: Array<{
+        ttl: MsValue;
+        count: number;
+    }>;
+}
+export interface RateLimitServiceLimitByManyCountOrFailOptions extends RateLimitServiceLimitByManyCountOptions {
+    message?: string;
+    limits: Array<{
+        ttl: MsValue;
+        count: number;
+        message?: string;
+    }>;
+}
 export declare class RateLimitService implements BaseService {
     serviceName: string;
     limitByCount(options: RateLimitServiceLimitByCountOptions): Promise<number>;
     limitByCountOrFail(options: RateLimitServiceLimitByCountOrFailOptions): Promise<number>;
+    limitByManyCount(options: RateLimitServiceLimitByManyCountOptions): Promise<true | number>;
+    limitByManyCountOrFail(options: RateLimitServiceLimitByManyCountOrFailOptions): Promise<void>;
 }
 declare module '../x' {
     interface X {

package/lib/services/rate_limit.js

@@ -1,3 +1,4 @@
+import { ms } from 'vtils';
 import { HttpError } from "../core/http_error";
 import { x } from "../x";
 export class RateLimitService {
@@ -24,4 +25,26 @@ export class RateLimitService {
     }
     return count;
   }
+  async limitByManyCount(options) {
+    for (let i = 0; i < options.limits.length; i++) {
+      const item = options.limits[i];
+      const ttl = ms(item.ttl);
+      const remainingCount = await this.limitByCount({
+        key: `${options.key}_${ttl}`,
+        ttl: ttl,
+        count: item.count
+      });
+      if (remainingCount === 0) {
+        return i;
+      }
+    }
+    return true;
+  }
+  async limitByManyCountOrFail(options) {
+    const pass = await this.limitByManyCount(options);
+    if (pass !== true) {
+      var _options$limits$pass$;
+      throw new HttpError.Forbidden((_options$limits$pass$ = options.limits[pass].message) != null ? _options$limits$pass$ : options.message);
+    }
+  }
 }

package/lib/services/sms.d.ts

@@ -0,0 +1,33 @@
+import { BaseService } from './base';
+export type SmsServiceProvider = 'tencentCloud';
+export type SmsServiceOptions = {
+    provider: 'tencentCloud';
+    providerOptions: {
+        appId: string;
+        secretId: string;
+        secretKey: string;
+    };
+};
+export type SmsServiceSendPayload = {
+    provider: SmsServiceProvider;
+    signature: string;
+    templateId: string;
+    templateParamValues: string[];
+    phoneNumber: string;
+};
+export type SmsServiceSendResult = {
+    success: boolean;
+    message: string;
+    smsId: string;
+};
+export declare class SmsService implements BaseService {
+    private options;
+    serviceName: string;
+    constructor(options: SmsServiceOptions);
+    send(payload: SmsServiceSendPayload): Promise<SmsServiceSendResult>;
+}
+declare module '../x' {
+    interface X {
+        sms: SmsService;
+    }
+}

package/lib/services/sms.js

@@ -0,0 +1,32 @@
+import TencentCloud from 'tencentcloud-sdk-nodejs-sms';
+import { HttpError } from "../core/http_error";
+export class SmsService {
+  constructor(options) {
+    this.options = options;
+    this.serviceName = 'sms';
+  }
+  async send(payload) {
+    if (payload.provider === 'tencentCloud') {
+      const SmsClient = TencentCloud.sms.v20210111.Client;
+      const smsClient = new SmsClient({
+        credential: {
+          secretId: this.options.providerOptions.secretId,
+          secretKey: this.options.providerOptions.secretKey
+        }
+      });
+      const res = await smsClient.SendSms({
+        SmsSdkAppId: this.options.providerOptions.appId,
+        SignName: payload.signature,
+        TemplateId: payload.templateId,
+        TemplateParamSet: payload.templateParamValues,
+        PhoneNumberSet: [payload.phoneNumber[0] === '+' ? payload.phoneNumber : `+86${payload.phoneNumber}`]
+      });
+      return {
+        success: res.SendStatusSet[0].Code === 'Ok',
+        message: res.SendStatusSet[0].Message,
+        smsId: res.SendStatusSet[0].SerialNo
+      };
+    }
+    throw new HttpError.BadRequest(`no sms provider: ${payload.provider}`);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.16.3",
+  "version": "2.16.5",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",
@@ -62,6 +62,7 @@
     "select-run": "^1.1.2",
     "supports-color": "^8",
     "svg-captcha": "^1.4.0",
+    "tencentcloud-sdk-nodejs-sms": "^4.0.649",
     "ts-morph": "^12.2.0",
     "tsx": "^3.12.7",
     "utf-8-validate": "^5.0.9",