create-pardx-scaffold 0.1.0

package/template/apps/api/libs/infra/shared-services/streaming-asr/types.ts

@@ -0,0 +1,208 @@
+/**
+ * @fileoverview 流式语音识别服务类型定义
+ *
+ * @module streaming-asr/types
+ */
+
+import { StreamingAsrStatus as ProviderStatus } from '@app/clients/internal/openspeech';
+
+/**
+ * 流式识别会话状态
+ */
+export type StreamingSessionStatus = ProviderStatus;
+
+/**
+ * 创建流式识别会话参数
+ */
+export interface CreateStreamingSessionDto {
+  /** 关联的会议记录 ID（可选） */
+  meetingRecordId?: string;
+  /** 创建人 ID */
+  userId: string;
+  /** 音频格式（默认 pcm） */
+  audioFormat?: 'pcm' | 'wav' | 'ogg' | 'opus';
+  /** 采样率（默认 16000） */
+  sampleRate?: number;
+  /** 声道数（默认 1） */
+  channels?: number;
+  /** 是否启用说话人分离（默认 true） */
+  enableSpeakerInfo?: boolean;
+  /** 是否保存音频数据（默认 false） */
+  saveAudio?: boolean;
+  /** 热词配置 */
+  corpus?: {
+    hotwords?: Array<{ word: string; factor: number }>;
+  };
+}
+
+/**
+ * 流式识别会话创建结果
+ */
+export interface StreamingSessionResult {
+  /** 会话 ID */
+  sessionId: string;
+  /** 连接 ID（用于发送音频） */
+  connectionId: string;
+  /** 会话状态 */
+  status: StreamingSessionStatus;
+  /** 关联的会议记录 ID */
+  meetingRecordId?: string;
+  /**  */
+  sessionToken?: string;
+}
+
+/**
+ * 流式识别实时结果
+ */
+export interface StreamingTranscriptUpdate {
+  /** 会话 ID */
+  sessionId: string;
+  /** 连接 ID */
+  connectionId: string;
+  /** 识别文本 */
+  text: string;
+  /** 是否为最终结果 */
+  isFinal: boolean;
+  /** 说话人分离数据 */
+  utterances?: StreamingUtterance[];
+  /** 序列号 */
+  sequence?: number;
+  /** 错误信息 */
+  error?: string;
+}
+
+/**
+ * 说话人分离片段
+ */
+export interface StreamingUtterance {
+  /** 说话人 ID */
+  speakerId: string;
+  /** 识别文本 */
+  text: string;
+  /** 开始时间（毫秒） */
+  startTime: number;
+  /** 结束时间（毫秒） */
+  endTime: number;
+  /** 是否确定（非中间结果） */
+  definite?: boolean;
+  /** 语速 */
+  speechRate?: number;
+  /** 音量 */
+  volume?: number;
+  /** 情绪 */
+  emotion?: string;
+  /** 性别 */
+  gender?: string;
+}
+
+/**
+ * 完成流式识别会话参数
+ */
+export interface CompleteStreamingSessionDto {
+  /** 会话 ID */
+  sessionId: string;
+  /** 是否保存到会议记录（如果有关联） */
+  saveToMeeting?: boolean;
+}
+
+/**
+ * 完成流式识别会话结果
+ */
+export interface CompleteStreamingSessionResult {
+  /** 会话 ID */
+  sessionId: string;
+  /** 最终转写文本 */
+  finalTranscript: string;
+  /** 说话人分离数据 */
+  finalUtterances: StreamingUtterance[];
+  /** 音频时长（秒） */
+  audioDuration: number;
+  /** 关联的会议记录 ID */
+  meetingRecordId?: string;
+  /** 音频数据（如果启用了保存） */
+  audioBuffer?: Buffer;
+  /** 音频格式信息 */
+  audioFormat?: {
+    format: string;
+    sampleRate: number;
+    channels: number;
+  };
+}
+
+/**
+ * 会话状态查询结果
+ */
+export interface SessionStatusResult {
+  /** 会话 ID */
+  sessionId: string;
+  /** 连接 ID */
+  connectionId: string;
+  /** 会话状态 */
+  status: StreamingSessionStatus;
+  /** 当前转写文本 */
+  transcript: string;
+  /** 当前说话人分离数据 */
+  utterances: StreamingUtterance[];
+  /** 已识别音频时长（秒） */
+  recognizedDuration: number;
+  /** 关联的会议记录 ID */
+  meetingRecordId?: string;
+  /** 错误信息 */
+  error?: string;
+}
+
+/**
+ * SSE 事件类型
+ */
+export type StreamingAsrEventType =
+  | 'connected'
+  | 'transcript'
+  | 'error'
+  | 'completed'
+  | 'disconnected'
+  | 'duration-exceeded';
+
+/**
+ * SSE 事件数据
+ */
+export interface StreamingAsrEvent {
+  /** 事件类型 */
+  type: StreamingAsrEventType;
+  /** 会话 ID */
+  sessionId: string;
+  /** 事件数据 */
+  data?:
+    | StreamingTranscriptUpdate
+    | { error: string }
+    | (StreamingTranscriptUpdate & { message?: string });
+  /** 时间戳 */
+  timestamp: number;
+}
+
+/**
+ * 音频缓冲区配置
+ */
+export interface AudioBufferConfig {
+  /** 是否启用音频保存 */
+  enabled: boolean;
+  /** 音频格式 */
+  format: string;
+  /** 采样率 */
+  sampleRate: number;
+  /** 声道数 */
+  channels: number;
+}
+
+/**
+ * 音频缓冲区数据
+ */
+export interface AudioBufferData {
+  /** 音频块列表 */
+  chunks: Buffer[];
+  /** 总大小（字节） */
+  totalSize: number;
+  /** 开始时间 */
+  startTime: Date;
+  /** 配置信息 */
+  config: AudioBufferConfig;
+}

package/template/apps/api/libs/infra/shared-services/system-health/index.ts

@@ -0,0 +1,3 @@
+export * from './system-health.module';
+export * from './system-health.service';
+export * from './system-health.controller';

package/template/apps/api/libs/infra/shared-services/system-health/system-health.controller.ts

@@ -0,0 +1,61 @@
+import { Get } from '@nestjs/common';
+import { SystemHealthService } from './system-health.service';
+import { TsRestController } from '@/decorators/ts-rest-controller.decorator';
+
+/**
+ * Health Check Controller
+ * 健康检查控制器
+ *
+ * Exposes /health endpoint for monitoring and load balancer health checks.
+ * This endpoint is excluded from the global '/api' prefix.
+ *
+ * 暴露 /health 端点用于监控和负载均衡器健康检查。
+ * 此端点已从全局 '/api' 前缀中排除。
+ */
+@TsRestController({ path: 'health' })
+export class SystemHealthController {
+  constructor(private readonly healthService: SystemHealthService) {}
+
+  /**
+   * Basic health check
+   * 基础健康检查
+   *
+   * Returns 200 if the service is running.
+   * Used by load balancers and Kubernetes liveness probes.
+   */
+  @Get()
+  async check() {
+    return {
+      status: 'ok',
+      timestamp: new Date().toISOString(),
+    };
+  }
+
+  /**
+   * Detailed health check
+   * 详细健康检查
+   *
+   * Checks all dependencies (database, Redis, RabbitMQ).
+   * Used by Kubernetes readiness probes.
+   */
+  @Get('ready')
+  async ready() {
+    const [database, redis, rabbitmq] = await Promise.all([
+      this.healthService.checkDatabaseConnection(),
+      this.healthService.checkRedisConnection(),
+      this.healthService.checkRabbitMQConnection(),
+    ]);
+
+    const isHealthy = database && redis && rabbitmq;
+
+    return {
+      status: isHealthy ? 'ok' : 'degraded',
+      timestamp: new Date().toISOString(),
+      checks: {
+        database: database ? 'ok' : 'fail',
+        redis: redis ? 'ok' : 'fail',
+        rabbitmq: rabbitmq ? 'ok' : 'fail',
+      },
+    };
+  }
+}

package/template/apps/api/libs/infra/shared-services/system-health/system-health.module.ts

@@ -0,0 +1,16 @@
+import { Module } from '@nestjs/common';
+import { SystemHealthService } from './system-health.service';
+import { SystemHealthController } from './system-health.controller';
+import { ConfigModule } from '@nestjs/config';
+// eslint-disable-next-line import/no-restricted-paths -- 健康检查服务需要直接访问 Prisma 检查数据库连接状态
+import { PrismaModule } from '@app/prisma';
+import { RedisModule } from '@app/redis';
+import { RabbitmqModule } from '@app/rabbitmq';
+
+@Module({
+  imports: [ConfigModule, PrismaModule, RedisModule, RabbitmqModule],
+  controllers: [SystemHealthController],
+  providers: [SystemHealthService],
+  exports: [SystemHealthService],
+})
+export class SystemHealthModule {}

package/template/apps/api/libs/infra/shared-services/system-health/system-health.service.ts

@@ -0,0 +1,69 @@
+import { Injectable, Inject } from '@nestjs/common';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+import { RedisService } from '@app/redis';
+import { RabbitmqService } from '@app/rabbitmq';
+// eslint-disable-next-line import/no-restricted-paths -- 健康检查服务需要直接访问 Prisma 检查数据库连接状态
+import { PrismaService } from '@app/prisma';
+
+@Injectable()
+export class SystemHealthService {
+  constructor(
+    private readonly redis: RedisService,
+    private readonly rabbitmq: RabbitmqService,
+    private readonly prisma: PrismaService,
+    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
+  ) {}
+
+  async checkDiskSpace(): Promise<boolean> {
+    const { exec } = require('child_process');
+    return new Promise((resolve, reject) => {
+      exec('df -h | grep /dev/sda1', (error, stdout, stderr) => {
+        if (error) {
+          console.error(`exec error: ${error}`);
+          return reject(false);
+        }
+        const regex = /(\d+)%/;
+        const matches = stdout.match(regex);
+        if (matches && matches.length > 1) {
+          const usage = parseInt(matches[1], 10);
+          resolve(usage < 90); // Assuming less than 90% usage is acceptable
+        } else {
+          reject(false);
+        }
+      });
+    });
+  }
+
+  async checkDatabaseConnection(): Promise<boolean> {
+    try {
+      // eslint-disable-next-line no-restricted-syntax -- 健康检查需要直接检查数据库连接状态
+      if (!this.prisma.write) {
+        return false;
+      }
+      return true;
+    } catch (e) {
+      return false;
+    }
+  }
+
+  async checkRabbitMQConnection(): Promise<boolean> {
+    try {
+      if (!this.rabbitmq.connection) {
+        return false;
+      }
+      return true;
+    } catch (error) {
+      return false;
+    }
+  }
+
+  async checkRedisConnection(): Promise<boolean> {
+    try {
+      const result = await this.redis.redis.ping();
+      return result === 'PONG';
+    } catch (error) {
+      return false;
+    }
+  }
+}

package/template/apps/api/libs/infra/shared-services/uploader/index.ts

@@ -0,0 +1,2 @@
+export { UploaderModule } from './uploader.module';
+export { UploaderService } from './uploader.service';

package/template/apps/api/libs/infra/shared-services/uploader/uploader.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { FileStorageServiceModule } from '@app/shared-services/file-storage';
+import { UploaderService } from './uploader.service';
+import { RedisModule } from '@app/redis';
+@Module({
+  imports: [ConfigModule, RedisModule, FileStorageServiceModule],
+  providers: [UploaderService],
+  exports: [UploaderService],
+})
+export class UploaderModule {}

package/template/apps/api/libs/infra/shared-services/uploader/uploader.service.ts

@@ -0,0 +1,265 @@
+import { Injectable, Inject } from '@nestjs/common';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+import { CommonErrorCode } from '@repo/contracts/errors';
+import { ApiException, apiError } from '@/filter/exception/api.exception';
+import { RedisService } from '@app/redis';
+import { FileStorageService } from '@app/shared-services/file-storage';
+import { ConfigService } from '@nestjs/config';
+import { rsaDecrypt } from '@/utils/crypto.util';
+
+import timer from '@/utils/timer.util';
+import { PardxApp, Locale, LocaleString } from '@/config/dto/config.dto';
+import { AppConfig } from '@/config/validation';
+import stringUtil from '@/utils/string.util';
+import enviromentUtil from '@/utils/enviroment.util';
+import fileUtil from '@/utils/file.util';
+import { FileBucketVendor } from '@prisma/client';
+
+interface SignatureData {
+  timestamp?: number;
+  filename?: string;
+  fileId?: string;
+  platform?: string;
+  userId?: string;
+  sha256?: string;
+}
+
+interface TokenRequest {
+  signature?: string;
+  filename?: string;
+  vendor?: FileBucketVendor;
+  bucket?: string;
+  locale?: string;
+  key?: string;
+  uploadId?: string;
+  partNumber?: number;
+}
+
+@Injectable()
+export class UploaderService {
+  private appConfig: AppConfig;
+  constructor(
+    private readonly configService: ConfigService,
+    private readonly redis: RedisService,
+    private readonly fileApi: FileStorageService,
+    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
+  ) {
+    this.appConfig = configService.get<AppConfig>('app');
+  }
+  /**
+   * 校验验证信息并返回签名数据
+   *
+   * @param userId 用户ID
+   * @param cmd 上传器公共令牌获取命令
+   * @returns 返回签名数据
+   * @throws 当签名验证失败时，抛出 ApiException 异常，错误信息为 'signatureError'
+   * @throws 当参数无效时，抛出 ApiException 异常，错误信息为 'invalidParameters'
+   */
+  checkValidateAndReturnSignatureData(
+    userId: string,
+    cmd: TokenRequest,
+  ): SignatureData {
+    let signatureData: SignatureData = {};
+    try {
+      const jsonString = rsaDecrypt(cmd.signature);
+      if (!jsonString || jsonString.trim() === '') {
+        console.error(
+          '[Signature Validation] Decryption failed: empty result',
+          {
+            signature: cmd.signature?.substring(0, 50) + '...',
+            userId,
+          },
+        );
+        throw apiError(CommonErrorCode.SignatureError);
+      }
+      signatureData = JSON.parse(jsonString);
+    } catch (e) {
+      console.error('[Signature Validation] Decryption or parsing failed:', {
+        error: e.message || e,
+        signature: cmd.signature?.substring(0, 50) + '...',
+        userId,
+      });
+      throw apiError(CommonErrorCode.SignatureError);
+    }
+    const uploaderUserId = !signatureData?.userId
+      ? undefined
+      : signatureData.userId;
+    if (userId != uploaderUserId) {
+      console.error('[Signature Validation] UserId mismatch:', {
+        expectedUserId: userId,
+        signatureUserId: uploaderUserId,
+        signatureData,
+      });
+      throw apiError(CommonErrorCode.SignatureError);
+    }
+    //时间戳距离当前时间超过15秒，则无效
+    const now = new Date().getTime();
+    if (
+      enviromentUtil.isProduction() &&
+      now - signatureData.timestamp > 15 * 1000
+    ) {
+      console.error('[Signature Validation] Timestamp expired:', {
+        now,
+        signatureTimestamp: signatureData.timestamp,
+        diff: now - signatureData.timestamp,
+      });
+      throw apiError(CommonErrorCode.InvalidParameters, {
+        field: 'signature',
+        message: 'signatureIsExpired',
+      });
+    }
+
+    return signatureData;
+  }
+
+  async getUploaderPresignedUrl(cmd: TokenRequest, ip?: string) {
+    const bucket = await this.fileApi.getBucketString(
+      cmd?.bucket,
+      ip,
+      false,
+      cmd?.locale,
+    );
+    const vendor = cmd?.vendor ?? this.appConfig.defaultVendor;
+    const token = await this.fileApi.getPresignedUrl(vendor, bucket, {
+      uploadId: cmd?.uploadId,
+      key: cmd?.key,
+      partNumber: cmd?.partNumber,
+    });
+
+    return {
+      token,
+      fileKey: cmd?.key,
+    };
+  }
+
+  /**
+   * 使用回调方式上传文件的token
+   *
+   * @param key 文件唯一标识
+   * @returns 返回包含token、fileKey的对象
+   */
+  async uploadTokenWithCallback(
+    vendor: FileBucketVendor,
+    bucket: string,
+    key: string,
+    ip?: string,
+    locale?: string,
+  ): Promise<{
+    token: string;
+    fileKey: string;
+  }> {
+    const callbackAuthKey = await this.redis.saveQiniuUploadAuthKey(key);
+    vendor = vendor ?? (this.appConfig.defaultVendor as FileBucketVendor);
+    bucket = await this.fileApi.getBucketString(bucket, ip, false, locale);
+    const token = await this.fileApi.uploadTokenWithCallback(
+      vendor,
+      bucket,
+      callbackAuthKey,
+      {
+        saveKey: key,
+        forceSaveKey: true,
+      },
+    );
+
+    return {
+      token,
+      fileKey: key,
+    };
+  }
+
+  /**
+   * 无回调地上传token
+   *
+   * @param userId 用户ID
+   * @param filename 文件名
+   * @param bucket 存储桶名称，默认为环境变量this.appConfig.defaultBucket指定的值
+   * @returns 返回一个Promise，resolve后的对象包含以下字段：
+   *  - token: 上传token
+   *  - fileKey: 文件key
+   */
+  async getPublicUploadToken(
+    userId: string,
+    cmd: TokenRequest,
+    ip?: string,
+  ): Promise<{
+    token: string;
+    fileKey: string;
+    domain: string;
+    vendor: FileBucketVendor;
+    bucket: string;
+  }> {
+    const bucket = await this.fileApi.getBucketString(
+      cmd?.bucket,
+      ip,
+      true,
+      cmd?.locale,
+    );
+    const vendor =
+      cmd?.vendor ?? (this.appConfig.defaultVendor as FileBucketVendor);
+    const fileApiConfig = await this.fileApi.getFileServiceConfig(
+      vendor,
+      bucket,
+      ip,
+    );
+    const ext = fileUtil.getFileExtension(cmd.filename);
+    const fileKey = await this.fileApi.formatNewKeyString(
+      `public`,
+      ext,
+      bucket,
+    );
+    const token = await this.fileApi.uploadToken(vendor, bucket, {
+      saveKey: fileKey,
+      forceSaveKey: true,
+    });
+    const domain = fileApiConfig.domain;
+    return {
+      token,
+      fileKey,
+      domain,
+      vendor,
+      bucket,
+    };
+  }
+
+  async uploadThumbToken(
+    userId: string,
+    cmd: TokenRequest,
+    ip?: string,
+  ): Promise<{
+    token: string;
+    key: string;
+    domain: string;
+    bucket: string;
+  }> {
+    const vendor =
+      cmd?.vendor ?? (this.appConfig.defaultVendor as FileBucketVendor);
+    const bucket = await this.fileApi.getBucketString(
+      cmd?.bucket,
+      ip,
+      false,
+      cmd?.locale,
+      vendor,
+    );
+
+    const fileApiConfig = await this.fileApi.getFileServiceConfig(
+      vendor,
+      bucket,
+      ip,
+    );
+    const ext = fileUtil.getFileExtension(cmd.filename);
+    const key = await this.fileApi.formatNewKeyString(`thumbimg`, ext, bucket);
+    const token = await this.fileApi.uploadToken(undefined, bucket, {
+      saveKey: key,
+      forceSaveKey: true,
+    });
+    const domain = fileApiConfig.domain;
+
+    return {
+      token,
+      key,
+      domain,
+      bucket,
+    };
+  }
+}

package/template/apps/api/libs/infra/utils/array-buffer.util.ts

@@ -0,0 +1,8 @@
+export default {
+  toString(arr: ArrayBuffer | string): string | undefined {
+    if (typeof arr === 'string') {
+      return arr;
+    }
+    return new TextDecoder().decode(arr) as string;
+  },
+};

package/template/apps/api/libs/infra/utils/array.util.ts

@@ -0,0 +1,3 @@
+// Re-export from shared package
+export { default } from '@repo/utils/array';
+export * from '@repo/utils/array';

package/template/apps/api/libs/infra/utils/bcrypt.util.ts

@@ -0,0 +1,3 @@
+// Re-export from shared package
+export { default } from '@repo/utils/bcrypt';
+export * from '@repo/utils/bcrypt';

package/template/apps/api/libs/infra/utils/bigint.util.ts

@@ -0,0 +1,3 @@
+// Re-export from shared package
+export { default } from '@repo/utils/bigint';
+export * from '@repo/utils/bigint';

package/template/apps/api/libs/infra/utils/bytes.convert.util.ts

@@ -0,0 +1,13 @@
+export default {
+  formatByteSize(bytes: number, decimals = 2): string {
+    if (bytes === 0) return '0 Bytes';
+
+    const k = 1024;
+    const dm = decimals < 0 ? 0 : decimals;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB'];
+
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
+  },
+};