create-pardx-scaffold 0.1.1 → 0.1.3

package/template/apps/api/src/modules/uploader/uploader.controller.ts

@@ -0,0 +1,305 @@
+import { Controller, Req, VERSION_NEUTRAL } from '@nestjs/common';
+import { TsRestHandler, tsRestHandler } from '@ts-rest/nest';
+import { uploaderContract as c } from '@repo/contracts/api';
+import { success } from '@/common/ts-rest/response.helper';
+import { UploaderService } from '@app/shared-services/uploader';
+import { FileSourceService } from '@app/db';
+import { FileStorageService } from '@app/shared-services/file-storage';
+import { ConfigService } from '@nestjs/config';
+import { AppConfig } from '@/config/validation';
+import fileUtil from '@/utils/file.util';
+import ipUtil from '@/utils/ip.util';
+import { FileBucketVendor } from '@prisma/client';
+import { AuthenticatedRequest } from '@app/auth';
+
+/**
+ * 文件上传控制器
+ *
+ * 提供文件上传相关的 API 端点，包括：
+ * - 获取上传凭证（私有/公开/缩略图）
+ * - 分片上传初始化和凭证获取
+ * - 上传完成确认
+ * - 上传取消
+ *
+ * @version VERSION_NEUTRAL
+ *
+ * 版本控制说明：
+ * - VERSION_NEUTRAL 表示该控制器为"版本中立"
+ * - 接受任何版本的请求，或者没有版本头的请求
+ * - 客户端调用时无需提供 `x-api-version` 请求头
+ * - 适用于上传接口这类稳定、不需要版本迭代的基础设施接口
+ *
+ * 如需版本控制，可改为：
+ * @example
+ * ```typescript
+ * // 指定版本（需要 x-api-version: 1 请求头）
+ * @Controller({ version: '1' })
+ *
+ * // 支持多版本
+ * @Controller({ version: ['1', '2'] })
+ * ```
+ */
+@Controller({
+  /**
+   * VERSION_NEUTRAL: 版本中立模式
+   *
+   * 在 Header 版本控制模式下（x-api-version）：
+   * - 接受任何版本号的请求
+   * - 接受没有版本头的请求
+   * - 不会因版本不匹配而拒绝请求
+   *
+   * 适用场景：
+   * - 基础设施接口（上传、健康检查等）
+   * - 不需要版本迭代的稳定接口
+   * - 需要向后兼容的公共接口
+   */
+  version: VERSION_NEUTRAL,
+})
+export class UploaderController {
+  private appConfig: AppConfig;
+
+  constructor(
+    private readonly uploaderService: UploaderService,
+    private readonly fileSourceDb: FileSourceService,
+    private readonly fileStorageService: FileStorageService,
+    private readonly configService: ConfigService,
+  ) {
+    this.appConfig = configService.get<AppConfig>('app');
+  }
+
+  @TsRestHandler(c.getPrivateThumbToken)
+  async getPrivateThumbToken(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.getPrivateThumbToken, async ({ body }) => {
+      const userId = req.userId;
+      const ip = ipUtil.extractIp(req);
+
+      this.uploaderService.checkValidateAndReturnSignatureData(
+        userId,
+        body as any,
+      );
+
+      const result = await this.uploaderService.uploadThumbToken(
+        userId,
+        body as any,
+        ip,
+      );
+
+      return success({
+        token: result.token,
+        key: result.key,
+        fileId: result.key,
+        bucket: result.bucket,
+        url: `${result.domain}/${result.key}`,
+      });
+    });
+  }
+
+  @TsRestHandler(c.initMultipart)
+  async initMultipart(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.initMultipart, async ({ body }) => {
+      const userId = req.userId;
+      const ip = ipUtil.extractIp(req);
+
+      const signatureData =
+        this.uploaderService.checkValidateAndReturnSignatureData(
+          userId,
+          body as any,
+        );
+
+      const vendor =
+        body.vendor ?? (this.appConfig.defaultVendor as FileBucketVendor);
+      const bucket = await this.fileStorageService.getBucketString(
+        body.bucket,
+        ip,
+        false,
+        body.locale,
+        vendor,
+      );
+
+      const ext = fileUtil.getFileExtension(body.filename);
+      const key = await this.fileStorageService.formatNewKeyString(
+        'private',
+        ext,
+        bucket,
+      );
+
+      // Create file source record
+      const fileSource = await this.fileSourceDb.create({
+        key,
+        bucket,
+        vendor,
+        fsize: body.fsize,
+        mimeType: fileUtil.getMimeType(body.filename),
+        ext,
+        sha256: body.sha256 || signatureData.sha256,
+        isUploaded: false,
+      });
+
+      // Get multipart upload ID
+      const uploadId = await this.fileStorageService.getMultipartUploadId(
+        vendor,
+        bucket,
+        key,
+        ip,
+      );
+
+      // Get presigned URL for first part
+      const token = await this.fileStorageService.getPresignedUrl(
+        vendor,
+        bucket,
+        { uploadId, key, partNumber: 1 },
+      );
+
+      return success({
+        token,
+        key,
+        fileId: fileSource.id,
+        bucket,
+        url: uploadId,
+      });
+    });
+  }
+
+  @TsRestHandler(c.getMultipartToken)
+  async getMultipartToken(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.getMultipartToken, async ({ body }) => {
+      const userId = req.userId;
+      const ip = ipUtil.extractIp(req);
+
+      this.uploaderService.checkValidateAndReturnSignatureData(
+        userId,
+        body as any,
+      );
+
+      const result = await this.uploaderService.getUploaderPresignedUrl(
+        body as any,
+        ip,
+      );
+
+      const defaultBucket = await this.fileStorageService.getDefaultBucket();
+
+      return success({
+        token: result.token,
+        key: result.fileKey,
+        fileId: body.key || result.fileKey,
+        bucket: body.bucket || defaultBucket,
+      });
+    });
+  }
+
+  @TsRestHandler(c.getPrivateToken)
+  async getPrivateToken(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.getPrivateToken, async ({ body }) => {
+      const userId = req.userId;
+      const ip = ipUtil.extractIp(req);
+
+      const signatureData =
+        this.uploaderService.checkValidateAndReturnSignatureData(
+          userId,
+          body as any,
+        );
+
+      const vendor =
+        body.vendor ?? (this.appConfig.defaultVendor as FileBucketVendor);
+      const bucket = await this.fileStorageService.getBucketString(
+        body.bucket,
+        ip,
+        false,
+        body.locale,
+        vendor,
+      );
+
+      const ext = fileUtil.getFileExtension(body.filename);
+      const key = await this.fileStorageService.formatNewKeyString(
+        'private',
+        ext,
+        bucket,
+      );
+
+      // Create file source record
+      const fileSource = await this.fileSourceDb.create({
+        key,
+        bucket,
+        vendor,
+        fsize: body.fsize,
+        mimeType: fileUtil.getMimeType(body.filename),
+        ext,
+        sha256: body.sha256 || signatureData.sha256,
+        isUploaded: false,
+      });
+
+      // Get upload token with callback
+      const result = await this.uploaderService.uploadTokenWithCallback(
+        vendor,
+        bucket,
+        key,
+        ip,
+        body.locale,
+      );
+
+      const config = await this.fileStorageService.getFileServiceConfig(
+        vendor,
+        bucket,
+        ip,
+      );
+
+      return success({
+        token: result.token,
+        key: result.fileKey,
+        fileId: fileSource.id,
+        bucket,
+        url: `${config.domain}/${result.fileKey}`,
+      });
+    });
+  }
+
+  @TsRestHandler(c.abort)
+  async abort(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.abort, async ({ body }) => {
+      const userId = req.userId;
+
+      this.uploaderService.checkValidateAndReturnSignatureData(userId, {
+        signature: body.signature,
+      });
+
+      // Mark file as deleted
+      await this.fileSourceDb.update({ id: body.fileId }, { isDeleted: true });
+
+      return success({ success: true });
+    });
+  }
+
+  @TsRestHandler(c.complete)
+  async complete(@Req() req: AuthenticatedRequest) {
+    return tsRestHandler(c.complete, async ({ body }) => {
+      const userId = req.userId;
+
+      this.uploaderService.checkValidateAndReturnSignatureData(userId, {
+        signature: body.signature,
+      });
+
+      // Get file source and mark as uploaded
+      const fileSource = await this.fileSourceDb.update(
+        { id: body.fileId },
+        { isUploaded: true },
+      );
+
+      const config = await this.fileStorageService.getFileServiceConfig(
+        fileSource.vendor,
+        fileSource.bucket,
+      );
+
+      return success({
+        id: fileSource.id,
+        key: fileSource.key,
+        bucket: fileSource.bucket,
+        fsize: fileSource.fsize,
+        mimeType: fileSource.mimeType,
+        ext: fileSource.ext,
+        sha256: fileSource.sha256,
+        isUploaded: fileSource.isUploaded,
+        url: `${config.domain}/${fileSource.key}`,
+      });
+    });
+  }
+}

package/template/apps/api/src/modules/uploader/uploader.module.ts

@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { UploaderController } from './uploader.controller';
+import { UploaderModule as UploaderServiceModule } from '@app/shared-services/uploader';
+import { FileStorageServiceModule } from '@app/shared-services/file-storage';
+import { FileSourceModule } from '@app/db';
+
+@Module({
+  imports: [
+    ConfigModule,
+    UploaderServiceModule,
+    FileStorageServiceModule,
+    FileSourceModule,
+  ],
+  controllers: [UploaderController],
+})
+export class UploaderModule {}

package/template/apps/web/.env.example

@@ -1,5 +1,7 @@
-# API Configuration
-NEXT_PUBLIC_API_BASE_URL=http://localhost:3100/api
+# API 配置
+NEXT_PUBLIC_API_BASE_URL=http://localhost:13100/api
 
-# Feature Flags
-NEXT_PUBLIC_ENABLE_ANALYTICS=false
+NEXT_PUBLIC_BRAND_NAME='Pardx.ai'
+NEXT_PUBLIC_BRAND_LOGO='/logo.svg'
+NEXT_PUBLIC_BRAND_TITLE=PardxAI - Multi-Agent Content Creation & Knowledge Management Platform
+NEXT_PUBLIC_BRAND_DESCRIPTION=PardxAI is an AI-powered multi-agent platform for content creation, knowledge management, and intelligent operations. Features include AI writing, evolutionary knowledge base, smart recommendations, AI recruitment agents, and meeting intelligence.

package/template/apps/web/components/error-boundary.tsx

@@ -0,0 +1,166 @@
+'use client';
+
+import { Component, type ReactNode, type ErrorInfo } from 'react';
+
+/**
+ * Error Boundary Props
+ */
+interface ErrorBoundaryProps {
+  children: ReactNode;
+  /** 自定义错误回退 UI */
+  fallback?: ReactNode;
+  /** 错误回调函数 */
+  onError?: (error: Error, errorInfo: ErrorInfo) => void;
+  /** 是否显示重试按钮 */
+  showRetry?: boolean;
+}
+
+/**
+ * Error Boundary State
+ */
+interface ErrorBoundaryState {
+  hasError: boolean;
+  error?: Error;
+  errorInfo?: ErrorInfo;
+}
+
+/**
+ * 默认错误回退 UI
+ */
+function DefaultErrorFallback({
+  error,
+  onRetry,
+  showRetry = true,
+}: {
+  error?: Error;
+  onRetry?: () => void;
+  showRetry?: boolean;
+}) {
+  return (
+    <div className="flex min-h-[200px] flex-col items-center justify-center p-8 text-center">
+      <div className="mb-4 text-6xl">😵</div>
+      <h2 className="mb-2 text-xl font-semibold text-gray-900 dark:text-gray-100">
+        出错了
+      </h2>
+      <p className="mb-4 text-gray-600 dark:text-gray-400">
+        {error?.message || '页面发生了意外错误'}
+      </p>
+      {showRetry && onRetry && (
+        <button
+          onClick={onRetry}
+          className="rounded-md bg-blue-600 px-4 py-2 text-white transition-colors hover:bg-blue-700"
+        >
+          重试
+        </button>
+      )}
+    </div>
+  );
+}
+
+/**
+ * React Error Boundary 组件
+ *
+ * 用于捕获子组件树中的 JavaScript 错误，记录错误并显示回退 UI
+ *
+ * @example
+ * ```tsx
+ * <ErrorBoundary fallback={<CustomError />}>
+ *   <MyComponent />
+ * </ErrorBoundary>
+ * ```
+ */
+export class ErrorBoundary extends Component<
+  ErrorBoundaryProps,
+  ErrorBoundaryState
+> {
+  constructor(props: ErrorBoundaryProps) {
+    super(props);
+    this.state = { hasError: false };
+  }
+
+  static getDerivedStateFromError(error: Error): ErrorBoundaryState {
+    return { hasError: true, error };
+  }
+
+  componentDidCatch(error: Error, errorInfo: ErrorInfo) {
+    // 记录错误信息
+    console.error('ErrorBoundary caught an error:', error, errorInfo);
+
+    // 更新状态以包含错误信息
+    this.setState({ errorInfo });
+
+    // 调用错误回调
+    this.props.onError?.(error, errorInfo);
+
+    // 在生产环境中，可以发送到错误追踪服务
+    if (process.env.NODE_ENV === 'production') {
+      // TODO: 发送到错误追踪服务 (如 Sentry)
+    }
+  }
+
+  handleRetry = () => {
+    this.setState({ hasError: false, error: undefined, errorInfo: undefined });
+  };
+
+  render() {
+    if (this.state.hasError) {
+      // 如果提供了自定义 fallback，使用它
+      if (this.props.fallback) {
+        return this.props.fallback;
+      }
+
+      // 否则使用默认错误 UI
+      return (
+        <DefaultErrorFallback
+          error={this.state.error}
+          onRetry={this.handleRetry}
+          showRetry={this.props.showRetry}
+        />
+      );
+    }
+
+    return this.props.children;
+  }
+}
+
+/**
+ * 页面级 Error Boundary
+ * 用于包裹整个页面，提供更友好的错误提示
+ */
+export function PageErrorBoundary({ children }: { children: ReactNode }) {
+  return (
+    <ErrorBoundary
+      showRetry
+      onError={(error, errorInfo) => {
+        // 页面级错误可以记录更多上下文
+        console.error('Page error:', {
+          error: error.message,
+          stack: error.stack,
+          componentStack: errorInfo.componentStack,
+        });
+      }}
+    >
+      {children}
+    </ErrorBoundary>
+  );
+}
+
+/**
+ * 组件级 Error Boundary
+ * 用于包裹单个组件，错误不会影响其他组件
+ */
+export function ComponentErrorBoundary({
+  children,
+  fallback,
+}: {
+  children: ReactNode;
+  fallback?: ReactNode;
+}) {
+  return (
+    <ErrorBoundary fallback={fallback} showRetry={false}>
+      {children}
+    </ErrorBoundary>
+  );
+}
+
+export default ErrorBoundary;

package/template/apps/web/components/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Shared Components
+ *
+ * 通用组件导出
+ */
+export {
+  ErrorBoundary,
+  PageErrorBoundary,
+  ComponentErrorBoundary,
+} from './error-boundary';

package/template/apps/web/components.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "../../packages/ui/src/styles/globals.css",
+    "baseColor": "neutral",
+    "cssVariables": true
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@/components",
+    "hooks": "@/hooks",
+    "lib": "@/lib",
+    "utils": "@repo/ui/lib/utils",
+    "ui": "@repo/ui/components"
+  }
+}

package/template/apps/web/config.ts

@@ -0,0 +1,115 @@
+// API 配置
+// API 基础地址从环境变量读取
+// 在 .env.local 文件中设置以下环境变量：
+// - NEXT_PUBLIC_API_BASE_URL: 登录、上传文件、测评等接口的基础地址
+
+/**
+ * 获取 API 基础地址（用于登录、上传文件、测评等）
+ */
+const getApiBaseUrl = (): string => {
+  const baseUrl = process.env.NEXT_PUBLIC_API_BASE_URL;
+
+  if (!baseUrl) {
+    // Use default value during build time or development
+    const defaultUrl = 'http://localhost:3100/api';
+    if (
+      process.env.NODE_ENV === 'development' ||
+      process.env.NEXT_PHASE === 'phase-production-build'
+    ) {
+      return defaultUrl;
+    }
+    // At runtime in production, use default if not set
+    console.warn('NEXT_PUBLIC_API_BASE_URL 未设置，使用默认值', defaultUrl);
+    return defaultUrl;
+  }
+
+  return baseUrl;
+};
+
+/**
+ * 获取品牌名称
+ */
+const getBrandName = (): string => {
+  const brandName = process.env.NEXT_PUBLIC_BRAND_NAME;
+  return brandName || 'Pardx.AI';
+};
+
+/**
+ * 获取品牌 Logo 路径
+ */
+const getBrandLogo = (): string => {
+  const brandLogo = process.env.NEXT_PUBLIC_BRAND_LOGO;
+  return brandLogo || '/logo.svg';
+};
+
+/**
+ * 获取品牌完整标题（用于页面标题）
+ *
+ * 产品定位：多智能体驱动的内容创作与运营平台
+ * 核心能力：
+ * - AI 内容创作（智能写作、创意生成）
+ * - 知识库管理（进化型知识库、智能提取、质量评估）
+ * - 智能推荐（向量检索、协同过滤）
+ * - 招聘面试（AI 招聘 Agent、简历解析、智能匹配）
+ * - 会议管理（实时转写、知识提取、纪要生成）
+ * - 多智能体协作（AG-UI/Agno）
+ */
+const getBrandTitle = (): string => {
+  const brandTitle = process.env.NEXT_PUBLIC_BRAND_TITLE;
+  return brandTitle || 'PardxAI - Multi-Agent Content Creation ';
+};
+
+/**
+ * 获取品牌描述（用于页面描述）
+ *
+ * 描述应包含：
+ * - 产品定位（多智能体平台）
+ * - 核心功能（内容创作、知识管理、智能推荐、招聘面试）
+ * - 技术优势（AI 驱动、多智能体协作）
+ * - 目标用户（企业团队、内容创作者、HR 团队）
+ */
+const getBrandDescription = (): string => {
+  const brandDescription = process.env.NEXT_PUBLIC_BRAND_DESCRIPTION;
+  return (
+    brandDescription ||
+    'PardxAI is an AI-powered multi-agent platform for content creation.'
+  );
+};
+
+export const API_CONFIG = {
+  // API 基础地址（用于登录、上传文件、测评等）
+  baseUrl: getApiBaseUrl(),
+
+  // API 端点路径 这些断点是不适用ts-rest-api的，用于登录和校验权限的断点，如果未来需要使用ts-rest-api，则将这些断点迁移到ts-rest-api中
+  endpoints: {
+    // 登录端点
+    login: '/sign/in/mobile/password',
+
+    // Token 刷新端点
+    refreshToken: '/sign/refresh/token',
+  },
+};
+
+/**
+ * 品牌配置
+ * 可通过环境变量覆盖：
+ * - NEXT_PUBLIC_BRAND_NAME: 品牌名称（默认: "Pardx.AI"）
+ * - NEXT_PUBLIC_BRAND_LOGO: Logo 路径（默认: "/logo.svg"）
+ * - NEXT_PUBLIC_BRAND_TITLE: 页面标题（默认: "PardxAI - Multi-Agent Content Creation"）
+ * - NEXT_PUBLIC_BRAND_DESCRIPTION: 页面描述（默认: "PardxAI is an AI-powered multi-agent platform for content creation."）
+ *
+ * 产品定位说明：
+ * PardxAI 是一个多智能体驱动的内容创作与运营平台，提供以下核心能力：
+ * 1. AI 内容创作：智能写作、创意生成、多模态内容创作
+ * 2. 知识库管理：进化型知识库系统、智能知识提取、质量评估、版本控制、相似度检测与合并
+ * 3. 智能推荐：基于向量检索和协同过滤的知识推荐系统
+ * 4. 招聘面试：AI 招聘 Agent、简历解析、JD 分析、人才匹配、智能面试
+ * 5. 会议管理：实时转写、知识提取、智能纪要生成
+ * 6. 多智能体协作：AG-UI/Agno 集成，支持多智能体协同工作
+ */
+export const BRAND_CONFIG = {
+  name: getBrandName(),
+  logo: getBrandLogo(),
+  title: getBrandTitle(),
+  description: getBrandDescription(),
+};

package/template/apps/web/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { nextJsConfig } from '@repo/config/eslint/next-js';
+
+/** @type {import("eslint").Linter.Config} */
+export default nextJsConfig;

package/template/apps/web/lib/api/avatar-upload.ts

@@ -32,6 +32,7 @@ export async function uploadAvatar(
     body: {
       signature,
       filename,
+      fsize: file.size,
       bucket: 'pardx-image',
       vendor: 'oss',
     },