create-pardx-scaffold 0.1.0

package/template/apps/api/libs/infra/clients/internal/file-storage/file-us3.client.ts

@@ -0,0 +1,176 @@
+import {
+  Injectable,
+  OnModuleInit,
+  OnModuleDestroy,
+  Inject,
+} from '@nestjs/common';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+import { HttpService } from '@nestjs/axios';
+
+import {
+  PardxUploader,
+  GetObjectOptions,
+  PresignedPutUrlObject,
+  PutObjectOptions,
+} from './dto/file.dto';
+
+import { PardxApp } from '@/config/dto/config.dto';
+import { StorageCredentialsConfig, AppConfig } from '@/config/validation';
+import { FileS3Client } from './file-s3.client';
+import { RedisService } from '@app/redis';
+import { createHmac } from 'crypto';
+import { GetObjectCommand, S3Client, S3ClientConfig } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+
+/**
+ * UCloud US3 Storage Client
+ *
+ * 职责：仅负责与 UCloud US3 API 通信
+ * - 不访问数据库
+ * - 不包含业务逻辑
+ */
+export class FileUs3Client extends FileS3Client {
+  protected urlRedisKey = 'privateDownloadUrl';
+  constructor(
+    config: PardxUploader.Config,
+    storageConfig: StorageCredentialsConfig,
+    appConfig: AppConfig,
+    redis: RedisService,
+    httpService: HttpService,
+    logger: Logger,
+  ) {
+    super(config, storageConfig, appConfig, redis, httpService, logger);
+  }
+
+  setClient() {
+    const credentials = {
+      // 访问密钥ID
+      accessKeyId: this.storageConfig.accessKey,
+      // 访问密钥
+      secretAccessKey: this.storageConfig.secretKey,
+    };
+    const clientConfig: S3ClientConfig = {
+      // 设置凭证
+      credentials: credentials,
+      // 设置端点
+      // endpoint: this.config.endpoint,
+      // 设置区域
+      region: this.config.region,
+    };
+    this.externalClient = new S3Client({
+      ...clientConfig,
+      endpoint: this.config.endpoint,
+      // endpoint: this.config.domain,
+    });
+    // if (enviromentUtil.isProduction()) {
+    //     // 创建内部客户端对象
+    //     this.internalClient = new S3Client({
+    //         ...clientConfig,
+    //         endpoint: this.config.internalEndpoint,
+    //     })
+    // } else {
+    this.internalClient = this.externalClient;
+    // }
+  }
+
+  /**
+   * 获取私有文件的下载链接
+   *
+   * @param fileKey 文件键名
+   * @param expire 链接过期时间，单位为秒，默认为3600秒
+   * @param internal 是否使用内部客户端，默认为false
+   * @returns 返回一个Promise，解析后得到私有文件的下载链接
+   */
+  async getPrivateDownloadUrl(
+    fileKey: string,
+    expire: number = 30,
+    internal: boolean = false,
+    bucket?: string,
+  ): Promise<string> {
+    if (this.config.isPublic) {
+      return `${this.config.domain}/${fileKey}`;
+    }
+    const url = await this.getPrivateDownloadUrlWithoutCdnEncrypt(
+      fileKey,
+      expire,
+      internal,
+      bucket,
+    );
+    // if (this.config?.cdnKeyName && this.config?.cdnPrivateKey) {
+    //     const expires = Math.floor(Date.now() / 1000) + 30
+    //     const urlToSign = `${url}&Expires=${expires}&KeyName=${this.config.cdnKeyName}`
+    //     const signature = createHmac(
+    //         'sha1',
+    //         Buffer.from(this.config.cdnPrivateKey, 'base64'),
+    //     )
+    //         .update(urlToSign)
+    //         .digest('base64')
+    // }
+    return url;
+  }
+
+  async getPrivateDownloadUrlWithoutCdnEncrypt(
+    fileKey: string,
+    expiresIn: number = 30,
+    internal: boolean = false,
+    bucket?: string,
+  ): Promise<string> {
+    const finalBucket = bucket || this.getBucketString();
+    const cacheKey = `${finalBucket}:${fileKey}`;
+    // const redisUrl = await this.redis.getData(this.urlRedisKey, cacheKey)
+    // if (redisUrl) {
+    //     return redisUrl
+    // }
+    if (internal) {
+      const getObjectCommand = new GetObjectCommand({
+        Bucket: finalBucket,
+        Key: fileKey,
+      });
+      const client = internal ? this.internalClient : this.externalClient;
+      const signedUrl = await getSignedUrl(client, getObjectCommand, {
+        expiresIn: expiresIn,
+      }); // expiresIn 是预签名 URL 的有效期，单位是秒
+      this.logger.info('Presigned URL:', {
+        signedUrl,
+        bucket: finalBucket,
+      });
+      await this.redis.saveData(this.urlRedisKey, cacheKey, signedUrl);
+      return this.replaceUrlToOwnDoamin(signedUrl);
+    } else {
+      const signedUrl = this.getSignedUrl(fileKey, expiresIn, finalBucket); // expiresIn 是预签名 URL 的有效期，单位是秒
+      this.logger.info('Presigned URL:', {
+        signedUrl,
+        bucket: finalBucket,
+      });
+      // await this.redis.saveData(
+      //     this.urlRedisKey,
+      //     cacheKey,
+      //     signedUrl,
+      //     expiresIn,
+      // )
+      return signedUrl;
+    }
+  }
+
+  getSignedUrl(
+    fileKey: string,
+    expiresIn: number = 3600,
+    bucket?: string,
+  ): string {
+    const httpMethod = 'GET';
+    const publicKey = this.storageConfig.accessKey;
+    const privateKey = this.storageConfig.secretKey;
+    const finalBucket = bucket || this.config.bucket;
+    const baseUrl = `${this.config.domain}/${fileKey}`;
+    const expires = Math.floor(Date.now() / 1000) + expiresIn;
+
+    const stringToSign = `${httpMethod}\n\n\n${expires}\n/${finalBucket}/${fileKey}`;
+    const signature = createHmac('sha1', privateKey)
+      .update(stringToSign)
+      .digest('base64');
+    const signedUrl = `${baseUrl}?UCloudPublicKey=${publicKey}&Signature=${encodeURIComponent(signature)}&Expires=${expires}`;
+
+    return signedUrl;
+  }
+}

package/template/apps/api/libs/infra/clients/internal/file-storage/index.ts

@@ -0,0 +1,16 @@
+/**
+ * File Storage Clients
+ *
+ * 纯文件存储 API 客户端集合
+ * - 不访问数据库
+ * - 不包含业务逻辑
+ */
+export { FileS3Client } from './file-s3.client';
+export { FileQiniuClient } from './file-qiniu.client';
+export { FileGcsClient } from './file-gcs.client';
+export { FileTosClient } from './file-tos.client';
+export { FileUs3Client } from './file-us3.client';
+export { FileStorageInterface } from './file-storage.interface';
+
+// Re-export DTO types
+export * from './dto/file.dto';

package/template/apps/api/libs/infra/clients/internal/ocr/dto/ocr.dto.ts

@@ -0,0 +1,61 @@
+/**
+ * OCR 服务 DTO 定义
+ */
+
+import { z } from 'zod';
+
+// OCR Block Schema
+export const OcrBlockSchema = z.object({
+  text: z.string(),
+  confidence: z.number(),
+  boundingBox: z.array(z.number()).optional(),
+});
+
+// OCR Page Schema
+export const OcrPageSchema = z.object({
+  pageNumber: z.number(),
+  text: z.string(),
+  blocks: z.array(OcrBlockSchema).optional(),
+});
+
+// OCR Result Schema
+export const OcrResultSchema = z.object({
+  text: z.string(),
+  confidence: z.number(),
+  pages: z.array(OcrPageSchema).optional(),
+  fileType: z.string().optional(),
+  processingTime: z.number().optional(),
+});
+
+// OCR Request Schema
+export const OcrRequestSchema = z.object({
+  fileUrl: z.string(),
+  fileType: z.string(),
+  extractPages: z.boolean().optional(),
+  language: z.string().optional(),
+});
+
+// OCR Batch Request Schema
+export const OcrBatchRequestSchema = z.object({
+  files: z.array(OcrRequestSchema),
+});
+
+// OCR Batch Result Schema
+export const OcrBatchResultSchema = z.object({
+  results: z.array(
+    z.union([
+      OcrResultSchema,
+      z.object({ error: z.string(), fileUrl: z.string() }),
+    ]),
+  ),
+  successCount: z.number(),
+  failCount: z.number(),
+});
+
+// Type exports
+export type OcrBlock = z.infer<typeof OcrBlockSchema>;
+export type OcrPage = z.infer<typeof OcrPageSchema>;
+export type OcrResult = z.infer<typeof OcrResultSchema>;
+export type OcrRequest = z.infer<typeof OcrRequestSchema>;
+export type OcrBatchRequest = z.infer<typeof OcrBatchRequestSchema>;
+export type OcrBatchResult = z.infer<typeof OcrBatchResultSchema>;

package/template/apps/api/libs/infra/clients/internal/ocr/index.ts

@@ -0,0 +1,3 @@
+export * from './ocr.module';
+export * from './ocr.client';
+export * from './dto/ocr.dto';

package/template/apps/api/libs/infra/clients/internal/ocr/ocr.client.ts

@@ -0,0 +1,123 @@
+/**
+ * OCR Internal Client
+ *
+ * 职责：仅负责与本地 OCR 服务通信
+ * - 调用 127.0.0.1:8004/api/ocr 提取文本
+ * - 不访问数据库
+ * - 不包含业务逻辑
+ */
+import { Injectable, Inject } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+import { firstValueFrom } from 'rxjs';
+import { OcrRequest, OcrResult } from './dto/ocr.dto';
+
+export interface OcrClientConfig {
+  baseUrl: string;
+  timeout: number;
+}
+
+@Injectable()
+export class OcrClient {
+  private readonly config: OcrClientConfig;
+
+  constructor(
+    private readonly httpService: HttpService,
+    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
+  ) {
+    this.config = {
+      baseUrl: process.env.OCR_SERVICE_URL || 'http://127.0.0.1:8004',
+      timeout: parseInt(process.env.OCR_TIMEOUT || '60000', 10),
+    };
+
+    this.logger.info(
+      `OcrClient initialized with base URL: ${this.config.baseUrl}`,
+    );
+  }
+
+  /**
+   * 提取文件文本内容
+   * @param fileUrl 文件 URL
+   * @param fileType 文件类型 (pdf, docx, doc, png, jpg, jpeg, etc.)
+   * @param options 可选参数
+   */
+  async extractText(
+    fileUrl: string,
+    fileType: string,
+    options?: { extractPages?: boolean; language?: string },
+  ): Promise<OcrResult> {
+    const request: OcrRequest = {
+      fileUrl,
+      fileType,
+      extractPages: options?.extractPages ?? false,
+      language: options?.language ?? 'auto',
+    };
+
+    try {
+      const response = await firstValueFrom(
+        this.httpService.post<OcrResult>(
+          `${this.config.baseUrl}/api/ocr`,
+          request,
+          {
+            timeout: this.config.timeout,
+            headers: {
+              'Content-Type': 'application/json',
+            },
+          },
+        ),
+      );
+
+      this.logger.debug(
+        `OCR extraction completed for ${fileUrl}, confidence: ${response.data.confidence}`,
+      );
+
+      return response.data;
+    } catch (error) {
+      this.logger.error(
+        `OCR extraction failed for ${fileUrl}: ${(error as Error).message}`,
+      );
+      throw new Error(`OCR extraction failed: ${(error as Error).message}`);
+    }
+  }
+
+  /**
+   * 批量提取文件文本
+   * @param files 文件列表
+   */
+  async extractTextBatch(
+    files: Array<{ fileUrl: string; fileType: string }>,
+  ): Promise<Array<OcrResult | { error: string; fileUrl: string }>> {
+    const results: Array<OcrResult | { error: string; fileUrl: string }> = [];
+
+    for (const file of files) {
+      try {
+        const result = await this.extractText(file.fileUrl, file.fileType);
+        results.push(result);
+      } catch (error) {
+        results.push({
+          error: (error as Error).message,
+          fileUrl: file.fileUrl,
+        });
+      }
+    }
+
+    return results;
+  }
+
+  /**
+   * 检查 OCR 服务健康状态
+   */
+  async healthCheck(): Promise<boolean> {
+    try {
+      const response = await firstValueFrom(
+        this.httpService.get(`${this.config.baseUrl}/health`, {
+          timeout: 5000,
+        }),
+      );
+      return response.status === 200;
+    } catch {
+      return false;
+    }
+  }
+}

package/template/apps/api/libs/infra/clients/internal/ocr/ocr.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { HttpModule } from '@nestjs/axios';
+import { OcrClient } from './ocr.client';
+
+@Module({
+  imports: [
+    HttpModule.register({
+      timeout: 60000,
+      maxRedirects: 5,
+    }),
+  ],
+  providers: [OcrClient],
+  exports: [OcrClient],
+})
+export class OcrModule {}

package/template/apps/api/libs/infra/clients/internal/openai/index.ts

@@ -0,0 +1,2 @@
+export * from './openai.client';
+export * from './openai.module';

package/template/apps/api/libs/infra/clients/internal/openai/openai.client.ts

@@ -0,0 +1,135 @@
+import { Injectable, Inject, OnModuleInit } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+import { firstValueFrom } from 'rxjs';
+import type { AxiosError } from 'axios';
+import { getKeysConfig } from '@/config/configuration';
+import type { OpenAIConfig } from '@/config/validation';
+
+export interface ChatMessage {
+  role: 'system' | 'user' | 'assistant';
+  content: string;
+}
+
+export interface ChatCompletionRequest {
+  model: string;
+  messages: ChatMessage[];
+  max_tokens?: number;
+  temperature?: number;
+}
+
+export interface ChatCompletionResponse {
+  id: string;
+  choices: Array<{
+    message: {
+      role: string;
+      content: string;
+    };
+  }>;
+}
+
+@Injectable()
+export class OpenAIClient implements OnModuleInit {
+  private baseUrl: string = '';
+  private apiKey: string = '';
+  private openaiConfig: OpenAIConfig | undefined;
+
+  constructor(
+    private readonly httpService: HttpService,
+    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
+  ) {}
+
+  onModuleInit() {
+    const keysConfig = getKeysConfig();
+    this.openaiConfig = keysConfig?.openai;
+
+    this.apiKey = this.openaiConfig?.apiKey || '';
+    this.baseUrl = this.openaiConfig?.baseUrl || 'https://api.openai.com/v1';
+
+    if (!this.apiKey) {
+      this.logger.warn('OpenAI API Key not configured');
+    }
+
+    this.logger.info(`OpenAI Client initialized with baseUrl: ${this.baseUrl}`);
+  }
+
+  private getAuthHeaders() {
+    return {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${this.apiKey}`,
+    };
+  }
+
+  async chatCompletion(
+    request: ChatCompletionRequest,
+  ): Promise<ChatCompletionResponse> {
+    try {
+      this.logger.info('[OpenAI] Calling chat completion', {
+        model: request.model,
+        messageCount: request.messages.length,
+      });
+
+      const response = await firstValueFrom(
+        this.httpService.post<ChatCompletionResponse>(
+          `${this.baseUrl}/chat/completions`,
+          request,
+          {
+            headers: this.getAuthHeaders(),
+            timeout: 120000,
+          },
+        ),
+      );
+
+      this.logger.info('[OpenAI] Chat completion successful', {
+        model: request.model,
+        responseId: response.data.id,
+      });
+
+      return response.data;
+    } catch (error) {
+      this.handleError('chatCompletion', error as AxiosError, {
+        model: request.model,
+      });
+    }
+  }
+
+  private handleError(
+    operation: string,
+    error: AxiosError,
+    context?: Record<string, any>,
+  ): never {
+    const errorMessage = this.extractErrorMessage(error);
+    const statusCode = error.response?.status;
+
+    this.logger.error(`OpenAI API Error [${operation}]: ${errorMessage}`, {
+      statusCode,
+      context,
+      responseData: error.response?.data,
+    });
+
+    if (statusCode === 401) {
+      throw new Error('OpenAI API authentication failed');
+    } else if (statusCode === 429) {
+      throw new Error('OpenAI API rate limit exceeded');
+    } else if (statusCode === 500) {
+      throw new Error(`OpenAI server error: ${errorMessage}`);
+    } else if (error.code === 'ECONNREFUSED') {
+      throw new Error(`Cannot connect to OpenAI server: ${this.baseUrl}`);
+    } else if (error.code === 'ETIMEDOUT') {
+      throw new Error(`OpenAI request timeout: ${operation}`);
+    } else {
+      throw new Error(`OpenAI API error: ${errorMessage}`);
+    }
+  }
+
+  private extractErrorMessage(error: AxiosError): string {
+    if (error.response?.data) {
+      const data = error.response.data as any;
+      return (
+        data.error?.message || data.message || data.error || 'Unknown error'
+      );
+    }
+    return error.message || 'Unknown error';
+  }
+}

package/template/apps/api/libs/infra/clients/internal/openai/openai.module.ts

@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { HttpModule } from '@nestjs/axios';
+import { ConfigModule } from '@nestjs/config';
+import { OpenAIClient } from './openai.client';
+
+@Module({
+  imports: [
+    HttpModule.register({
+      timeout: 120000,
+      maxRedirects: 5,
+    }),
+    ConfigModule,
+  ],
+  providers: [OpenAIClient],
+  exports: [OpenAIClient],
+})
+export class OpenAIClientModule {}