@jayfong/x-server 2.119.0 → 3.0.0

package/lib/services/file_store.d.ts

@@ -1,49 +0,0 @@
-import type { BaseService } from './base';
-export type FileStoreServiceOptions = {
-    accessKey: string;
-    secretKey: string;
-    /** 如: cos.ap-guangzhou.myqcloud.com */
-    endpoint: string;
-    /** 如: image-311111 */
-    bucket: string;
-    /** 如: x */
-    dir: string;
-    /** 如: cdn.com */
-    cdnUrl: string;
-};
-export type FileStoreServiceGetUploadUrlPayload = {
-    fileName: string;
-    ttl: number;
-    keepName?: boolean;
-};
-export type FileStoreServiceGetUploadUrlResult = {
-    /** 文件类型 */
-    contentType: string;
-    /** 文件上传地址 */
-    uploadUrl: string;
-    /** 文件公开访问地址 */
-    publicUrl: string;
-};
-export type FileStoreServiceUploadPayload = {
-    /** 文件名 */
-    fileName: string;
-    /** 文件内容 */
-    content: Buffer;
-    keepName?: boolean;
-};
-export type FileStoreServiceUploadResult = FileStoreServiceGetUploadUrlResult;
-export declare class FileStoreService implements BaseService {
-    private options;
-    serviceName: string;
-    private endpoint;
-    private dir;
-    private cdnUrl;
-    constructor(options: FileStoreServiceOptions);
-    getUploadUrl(payload: FileStoreServiceGetUploadUrlPayload): Promise<FileStoreServiceGetUploadUrlResult>;
-    upload(payload: FileStoreServiceUploadPayload): Promise<FileStoreServiceUploadResult>;
-}
-declare module '../x' {
-    interface X {
-        fileStore: FileStoreService;
-    }
-}

package/lib/services/file_store.js

@@ -1,61 +0,0 @@
-import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
-import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { xr } from '@jayfong/x-request';
-import mime from 'mime';
-import { isUrl, ms } from 'vtils';
-import { x } from "../x";
-export class FileStoreService {
-  constructor(options) {
-    this.options = options;
-    this.serviceName = 'fileStore';
-    this.endpoint = '';
-    this.dir = '';
-    this.cdnUrl = '';
-    this.endpoint = isUrl(this.options.endpoint) ? this.options.endpoint : `https://${this.options.endpoint}`;
-    this.dir = this.options.dir ? `${this.options.dir.replace(/^\/+/, '').replace(/\/+$/, '')}` : '';
-    this.cdnUrl = (isUrl(this.options.cdnUrl) ? this.options.cdnUrl : `https://${this.options.cdnUrl}`).replace(/\/+$/, '');
-  }
-  async getUploadUrl(payload) {
-    const s3Client = new S3Client({
-      credentials: {
-        accessKeyId: this.options.accessKey,
-        secretAccessKey: this.options.secretKey
-      },
-      endpoint: this.endpoint,
-      region: 'x'
-    });
-    const contentType = mime.getType(payload.fileName) || 'application/octet-stream';
-    const fileName = payload.keepName ? payload.fileName : `${x.random.cuid2()}.${mime.getExtension(contentType)}`;
-    const dir = this.dir ? `${this.dir}/` : '';
-    const command = new PutObjectCommand({
-      Bucket: this.options.bucket,
-      Key: `${dir}${fileName}`,
-      ContentType: contentType
-    });
-    const uploadUrl = await getSignedUrl(s3Client, command, {
-      expiresIn: ms(payload.ttl, true)
-    });
-    const publicUrl = `${this.cdnUrl}/${dir}${fileName}`;
-    return {
-      contentType,
-      uploadUrl,
-      publicUrl
-    };
-  }
-  async upload(payload) {
-    const res = await this.getUploadUrl({
-      fileName: payload.fileName,
-      ttl: ms('1m'),
-      keepName: payload.keepName
-    });
-    await xr.post({
-      url: res.uploadUrl,
-      method: 'PUT',
-      headers: {
-        'Content-Type': res.contentType
-      },
-      data: payload.content
-    });
-    return res;
-  }
-}

package/lib/services/html.d.ts

@@ -1,11 +0,0 @@
-import type { BaseService } from './base';
-export declare class HtmlService implements BaseService {
-    serviceName: string;
-    escape(html: string): string;
-    unescape(html: string): string;
-}
-declare module '../x' {
-    interface X {
-        html: HtmlService;
-    }
-}

package/lib/services/html.js

@@ -1,12 +0,0 @@
-import { escapeHTML, unescapeHTML } from 'fast-escape-html';
-export class HtmlService {
-  constructor() {
-    this.serviceName = 'html';
-  }
-  escape(html) {
-    return escapeHTML(html);
-  }
-  unescape(html) {
-    return unescapeHTML(html);
-  }
-}

package/lib/services/jwt.d.ts

@@ -1,34 +0,0 @@
-import type { IncomingHttpHeaders } from 'node:http';
-import jwt from 'jsonwebtoken';
-import { LRUCache } from 'lru-cache';
-import { type MsValue } from 'vtils';
-import type { RequiredBy } from 'vtils/types';
-import type { BaseService } from './base';
-export interface JwtServiceJwtPayload extends Record<string, any> {
-}
-export interface JwtServiceOptions {
-    secret: string;
-    ttl: MsValue;
-    cache?: LRUCache.Options<string, JwtServiceJwtPayload, any>;
-    onVerify?: (payload: JwtServiceJwtPayload & RequiredBy<jwt.JwtPayload, 'iat' | 'exp'> & {
-        token: string;
-    }) => any;
-}
-export declare class JwtService implements BaseService {
-    private options;
-    serviceName: string;
-    private cache;
-    constructor(options: JwtServiceOptions);
-    sign<T extends JwtServiceJwtPayload>(payload: T, ttl?: MsValue): string;
-    verify<T extends JwtServiceJwtPayload>(token: string): Promise<T & {
-        token: string;
-    }>;
-    verifyFromHttpHeaders<T extends JwtServiceJwtPayload>(headers: IncomingHttpHeaders): Promise<T & {
-        token: string;
-    }>;
-}
-declare module '../x' {
-    interface X {
-        jwt: JwtService;
-    }
-}

package/lib/services/jwt.js

@@ -1,59 +0,0 @@
-import jwt from 'jsonwebtoken';
-import { LRUCache } from 'lru-cache';
-import { ms } from 'vtils';
-import { differenceInMilliseconds, fromUnixTime } from 'vtils/date';
-import { HttpError } from "../core/http_error";
-export class JwtService {
-  constructor(options) {
-    this.options = options;
-    this.serviceName = 'jwt';
-    this.cache = void 0;
-    if (options.cache) {
-      this.cache = new LRUCache(options.cache);
-    }
-  }
-  sign(payload, ttl = this.options.ttl) {
-    const token = jwt.sign(payload, this.options.secret, {
-      expiresIn: ms(ttl, true)
-    });
-    if (this.cache) {
-      this.cache.set(token, payload, {
-        ttl: ms(ttl)
-      });
-    }
-    return token;
-  }
-  async verify(token) {
-    const data = await new Promise((resolve, reject) => {
-      if (this.cache && this.cache.has(token)) {
-        resolve(this.cache.get(token));
-      } else {
-        jwt.verify(token, this.options.secret, {
-          ignoreExpiration: false
-        }, (err, data) => {
-          if (err || !data || typeof data === 'string' || !data.iat || !data.exp) {
-            reject(new HttpError.Unauthorized('data'));
-          } else {
-            data.token = token;
-            if (this.cache) {
-              this.cache.set(token, data, {
-                ttl: differenceInMilliseconds(fromUnixTime(data.exp), new Date())
-              });
-            }
-            resolve(data);
-          }
-        });
-      }
-    });
-    await this.options.onVerify?.(data);
-    return data;
-  }
-  async verifyFromHttpHeaders(headers) {
-    const authorization = headers.authorization || headers['sec-websocket-protocol'] && `Bearer ${headers['sec-websocket-protocol']}` || '';
-    if (!authorization) {
-      throw new HttpError.Unauthorized('header');
-    }
-    const [scheme, token = scheme] = authorization.split(' ');
-    return this.verify(token);
-  }
-}

package/lib/services/log.d.ts

@@ -1,37 +0,0 @@
-import type { Merge } from 'vtils/types';
-import type { BaseService } from './base';
-export type LogServiceLevel = 'error' | 'info' | 'success';
-export type LogServiceDesc = Record<string, any> | any[];
-export type LogServiceWriter = 'file' | 'console';
-export type LogServicePayload = {
-    writer?: LogServiceWriter;
-    level: LogServiceLevel;
-    title: string;
-    desc?: LogServiceDesc;
-};
-export type LogServiceLogItem<K extends string = string> = Merge<LogServicePayload, {
-    traceId: string;
-    time: string;
-    desc: Record<K, any>;
-}>;
-export declare class LogService implements BaseService {
-    serviceName: string;
-    getLogFile(date: Date): string;
-    private get logFile();
-    private getLogWriter;
-    parseLogLineText<K extends string = string>(text: string, keysMap?: Record<string, string[]>): LogServiceLogItem<K>;
-    private log;
-    info: (title: string, desc?: LogServiceDesc) => void;
-    success: (title: string, desc?: LogServiceDesc) => void;
-    error: (title: string, desc?: LogServiceDesc) => void;
-    console: {
-        info: (title: string, desc?: LogServiceDesc) => void;
-        success: (title: string, desc?: LogServiceDesc) => void;
-        error: (title: string, desc?: LogServiceDesc) => void;
-    };
-}
-declare module '../x' {
-    interface X {
-        log: LogService;
-    }
-}

package/lib/services/log.js

@@ -1,102 +0,0 @@
-import path from 'node:path';
-import fs from 'fs-extra';
-import { memoize } from 'vtils';
-import { formatDate } from 'vtils/date';
-import { x } from "../x";
-export class LogService {
-  constructor() {
-    this.serviceName = 'log';
-    this.getLogWriter = memoize(logFile => {
-      fs.ensureFileSync(logFile);
-      return fs.createWriteStream(logFile, {
-        flags: 'a'
-      });
-    }, logFile => logFile);
-    this.info = (title, desc) => {
-      this.log({
-        level: 'info',
-        title,
-        desc
-      });
-    };
-    this.success = (title, desc) => {
-      this.log({
-        level: 'success',
-        title,
-        desc
-      });
-    };
-    this.error = (title, desc) => {
-      this.log({
-        level: 'error',
-        title,
-        desc
-      });
-    };
-    this.console = {
-      info: (title, desc) => {
-        this.log({
-          writer: 'console',
-          level: 'info',
-          title,
-          desc
-        });
-      },
-      success: (title, desc) => {
-        this.log({
-          writer: 'console',
-          level: 'success',
-          title,
-          desc
-        });
-      },
-      error: (title, desc) => {
-        this.log({
-          writer: 'console',
-          level: 'error',
-          title,
-          desc
-        });
-      }
-    };
-  }
-  getLogFile(date) {
-    const year = date.getFullYear();
-    const month = date.getMonth() + 1;
-    return path.join(x.dataDir, `log/${year}/${month < 10 ? `0${month}` : month}.log`);
-  }
-  get logFile() {
-    return this.getLogFile(new Date());
-  }
-  parseLogLineText(text, keysMap = {}) {
-    const segments = text.split(/\t+/);
-    // 没有 traceId 的注入一下
-    if (segments[1].length < 10) {
-      segments.splice(1, 0, '');
-    }
-    const [time, traceId, level, title, ...desc] = segments;
-    return {
-      time: time,
-      traceId: traceId,
-      level: level,
-      title: title,
-      desc: desc.reduce((res, item, index) => {
-        if (keysMap[title]) {
-          res[keysMap[title][index]] = item;
-        } else {
-          const i = item.indexOf(':');
-          res[item.substring(0, i)] = item.substring(i + 1);
-        }
-        return res;
-      }, {})
-    };
-  }
-  log(payload) {
-    const getContent = () => `${[formatDate(new Date(), 'yyyy-mm-dd hh:ii:ss'), ...(!x.ctx ? [] : [x.ctx.traceId]), payload.level, payload.title, ...(!payload.desc ? [] : Array.isArray(payload.desc) ? payload.desc : Object.keys(payload.desc).map(key => `${key}:${payload.desc[key]}`))].map(item => String(item).replace(/[\r\n\t]+/g, ' ')).join('\t')}`;
-    if (payload.writer === 'console') {
-      console[payload.level === 'error' ? 'error' : 'log'](getContent());
-    } else {
-      this.getLogWriter(this.logFile).write(`${getContent()}\n`);
-    }
-  }
-}

package/lib/services/mail.d.ts

@@ -1,23 +0,0 @@
-import nodemailer from 'nodemailer';
-import type { BaseService } from './base';
-export interface MailServiceOptions {
-    host: string;
-    port: number;
-    secure: boolean;
-    user: string;
-    pass: string;
-}
-export interface MailServiceSendOptions extends nodemailer.SendMailOptions {
-}
-export declare class MailService implements BaseService {
-    private options;
-    serviceName: string;
-    private transporter;
-    constructor(options: MailServiceOptions);
-    send(options: MailServiceSendOptions): Promise<any>;
-}
-declare module '../x' {
-    interface X {
-        mail: MailService;
-    }
-}

package/lib/services/mail.js

@@ -1,25 +0,0 @@
-import nodemailer from 'nodemailer';
-import { x } from "../x";
-export class MailService {
-  constructor(options) {
-    this.options = options;
-    this.serviceName = 'mail';
-    this.transporter = void 0;
-  }
-  async send(options) {
-    if (!this.transporter) {
-      this.transporter = nodemailer.createTransport({
-        host: this.options.host,
-        port: this.options.port,
-        secure: this.options.secure,
-        auth: {
-          user: this.options.user,
-          pass: this.options.pass
-        }
-      });
-      await this.transporter.verify();
-      x.dispose.add(() => this.transporter.close());
-    }
-    return this.transporter.sendMail(options);
-  }
-}

package/lib/services/pay.d.ts

@@ -1,123 +0,0 @@
-import type { BaseService } from './base';
-export interface PayServiceOptions {
-    /** 支付宝 */
-    alipay?: {
-        /** 应用 ID */
-        appId: string;
-        /** 商户应用私钥 */
-        privateKey: string;
-        /** 支付宝公钥，用于对返回结果验签 */
-        publicKey: string;
-    };
-    /** 微信支付(APIv3)，未实现回调验签，因此验证微信支付身份块不需要关心 */
-    wepay?: {
-        /** 公众号 APPID */
-        appId: string;
-        /** 商户 ID */
-        merchantId: string;
-        /** 商户API证书私钥 */
-        privateKey: string;
-        /** 商户API证书序列号 */
-        certificateSerialNumber: string;
-        /** 密钥，用于解密回调数据 */
-        secretKey: string;
-    };
-}
-export interface PayServicePrepareAlipayOptions {
-    /** 商品名称 */
-    goodsName: string;
-    /** 交易单号 */
-    tradeNumber: string;
-    /** 总金额 */
-    totalMoney: number;
-    /** 通知地址(POST) */
-    notifyUrl: string;
-    /** 返回地址 */
-    returnUrl?: string;
-}
-export interface PayServicePrepareAlipayResult {
-    /** 支付地址，需跳转过去 */
-    payUrl: string;
-}
-export interface PayServicePrepareWepayOptions {
-    /** 商品名称 */
-    goodsName: string;
-    /** 交易单号 */
-    tradeNumber: string;
-    /** 总金额 */
-    totalMoney: number;
-    /** 通知地址(POST) */
-    notifyUrl: string;
-    /** 公众号用户的 openid */
-    openid: string;
-}
-export interface PayServicePrepareWepayResult {
-    /** 支付参数，可直接传给 JSSDK 调用 */
-    payParams: {
-        appId: string;
-        timestamp: string;
-        nonceStr: string;
-        package: string;
-        signType: string;
-        paySign: string;
-    };
-}
-export interface PayServiceVerifyNotifyDataResult {
-    /**
-     * 渠道订单号。
-     *
-     * - 支付宝最长 `64` 位；
-     * - 微信支付最长 `32` 位。
-     */
-    channelOrderNo: string;
-}
-export interface PayServiceGetOrderInfoPayload {
-    /**
-     * 渠道。
-     */
-    channel: 'alipay' | 'wepay';
-    /**
-     * 商家订单号。
-     */
-    orderNo?: string;
-    /**
-     * 渠道订单号。
-     */
-    channelOrderNo?: string;
-}
-export interface PayServiceGetOrderInfoResult {
-    /**
-     * 商家订单号。
-     */
-    orderNo: string;
-    /**
-     * 渠道订单号。
-     *
-     * - 支付宝最长 `64` 位；
-     * - 微信支付最长 `32` 位。
-     */
-    channelOrderNo: string;
-    /**
-     * 订单状态。
-     */
-    status: 'success' | 'fail';
-}
-export declare class PayService implements BaseService {
-    private options;
-    serviceName: string;
-    private alipaySdk;
-    constructor(options: PayServiceOptions);
-    prepareAlipay(options: PayServicePrepareAlipayOptions): Promise<PayServicePrepareAlipayResult>;
-    prepareWepay(options: PayServicePrepareWepayOptions): Promise<PayServicePrepareWepayResult>;
-    verifyNotifyData(data: any): false | PayServiceVerifyNotifyDataResult;
-    verifyNotifyDataOrFail(data: any, message?: string): PayServiceVerifyNotifyDataResult;
-    getOrderInfo(payload: PayServiceGetOrderInfoPayload): Promise<PayServiceGetOrderInfoResult>;
-    private wepaySign;
-    private wepayDecrypt;
-    private wepayRequest;
-}
-declare module '../x' {
-    interface X {
-        pay: PayService;
-    }
-}