aiwf 0.3.7 → 0.3.8

package/src/lib/resources/templates/api-server/template/.aiwf/config.json

@@ -0,0 +1,56 @@
+{
+  "project_name": "{{projectName}}",
+  "project_type": "api-server",
+  "framework": "express",
+  "language": "typescript",
+  "created_at": "{{createdAt}}",
+  "version": "0.0.1",
+  "features": {
+    "feature_ledger": {
+      "enabled": true,
+      "auto_track": true,
+      "git_integration": true,
+      "api_endpoints": true
+    },
+    "ai_persona": {
+      "enabled": true,
+      "default": "backend-engineer",
+      "available": [
+        "backend-engineer",
+        "api-architect",
+        "database-specialist",
+        "security-auditor",
+        "performance-optimizer"
+      ]
+    },
+    "context_compression": {
+      "enabled": true,
+      "level": "balanced",
+      "token_limit": 100000,
+      "cache_enabled": true
+    },
+    "api_documentation": {
+      "enabled": true,
+      "swagger": true,
+      "postman_sync": false
+    }
+  },
+  "structure": {
+    "src_dir": "src",
+    "test_dir": "tests",
+    "build_dir": "dist",
+    "docs_dir": "docs"
+  },
+  "conventions": {
+    "routing": "restful",
+    "authentication": "jwt",
+    "validation": "express-validator",
+    "testing": "jest",
+    "linting": "eslint",
+    "database": "prepared"
+  },
+  "scripts": {
+    "pre_commit": "npm run lint && npm test",
+    "post_feature": "npm run aiwf:feature update && npm run aiwf:api docs"
+  }
+}

package/src/lib/resources/templates/api-server/template/.aiwf/feature-ledger.json

@@ -0,0 +1,42 @@
+{
+  "version": "1.0.0",
+  "project": "{{projectName}}",
+  "created": "{{createdAt}}",
+  "features": [
+    {
+      "id": "F001",
+      "name": "API 서버 초기 설정",
+      "description": "Express + TypeScript 기반 RESTful API 서버 초기 설정",
+      "type": "setup",
+      "status": "completed",
+      "created_at": "{{createdAt}}",
+      "completed_at": "{{createdAt}}",
+      "components": [
+        "Express 서버 설정",
+        "TypeScript 설정",
+        "미들웨어 구성",
+        "에러 핸들링",
+        "API 문서화 (Swagger)"
+      ],
+      "endpoints": [
+        "GET /api/health",
+        "GET /api/v1/status",
+        "GET /docs"
+      ],
+      "files": [
+        "src/index.ts",
+        "src/app.ts",
+        "src/middleware/*",
+        "src/config/*"
+      ],
+      "tags": ["초기설정", "인프라", "API"]
+    }
+  ],
+  "statistics": {
+    "total_features": 1,
+    "completed": 1,
+    "in_progress": 0,
+    "planned": 0,
+    "total_endpoints": 3
+  }
+}

package/src/lib/resources/templates/api-server/template/.aiwf/personas/backend-engineer.json

@@ -0,0 +1,40 @@
+{
+  "id": "backend-engineer",
+  "name": "백엔드 엔지니어",
+  "description": "Express API 서버 개발 전문가",
+  "expertise": [
+    "RESTful API 설계",
+    "Express.js 최적화",
+    "데이터베이스 설계 및 쿼리 최적화",
+    "인증/인가 시스템",
+    "API 보안",
+    "성능 튜닝"
+  ],
+  "context": {
+    "focus_areas": [
+      "API 설계 패턴",
+      "에러 핸들링",
+      "입력 검증",
+      "미들웨어 아키텍처",
+      "데이터베이스 트랜잭션"
+    ],
+    "code_style": {
+      "naming": "camelCase (변수/함수), PascalCase (클래스/인터페이스)",
+      "structure": "계층형 아키텍처 (Controller-Service-Repository)",
+      "error_handling": "중앙집중식 에러 핸들러",
+      "validation": "DTO와 validation 미들웨어 사용"
+    },
+    "best_practices": [
+      "RESTful 원칙 준수",
+      "적절한 HTTP 상태 코드 사용",
+      "요청/응답 DTO 정의",
+      "비즈니스 로직과 컨트롤러 분리",
+      "트랜잭션 관리"
+    ]
+  },
+  "prompts": {
+    "api_design": "RESTful 원칙을 따르며 확장 가능하고 유지보수가 쉬운 API를 설계해주세요.",
+    "security": "OWASP Top 10을 고려하여 보안이 강화된 API를 구현해주세요.",
+    "performance": "캐싱, 쿼리 최적화, 비동기 처리를 활용하여 고성능 API를 만들어주세요."
+  }
+}

package/src/lib/resources/templates/api-server/template/.aiwf/scripts/cli.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const args = process.argv.slice(2);
+const command = args[0];
+const subcommand = args[1];
+
+const projectRoot = path.resolve(__dirname, '../..');
+const aiwfDir = path.join(projectRoot, '.aiwf');
+const featureLedgerPath = path.join(aiwfDir, 'feature-ledger.json');
+const configPath = path.join(aiwfDir, 'config.json');
+
+// Feature Ledger 관련 명령어
+if (command === 'feature') {
+  const ledger = JSON.parse(fs.readFileSync(featureLedgerPath, 'utf8'));
+
+  switch (subcommand) {
+    case 'list':
+      console.log('\n📋 Feature Ledger\n');
+      ledger.features.forEach(feature => {
+        const status = {
+          completed: '✅',
+          in_progress: '🔄',
+          planned: '📝'
+        }[feature.status];
+        console.log(`${status} [${feature.id}] ${feature.name}`);
+        console.log(`   ${feature.description}`);
+        if (feature.endpoints && feature.endpoints.length > 0) {
+          console.log(`   Endpoints: ${feature.endpoints.join(', ')}`);
+        }
+        console.log(`   Tags: ${feature.tags.join(', ')}`);
+        console.log();
+      });
+      console.log(`총 ${ledger.features.length}개 기능`);
+      break;
+
+    case 'stats':
+      console.log('\n📊 Feature 통계\n');
+      console.log(`총 기능: ${ledger.statistics.total_features}`);
+      console.log(`완료: ${ledger.statistics.completed}`);
+      console.log(`진행중: ${ledger.statistics.in_progress}`);
+      console.log(`계획됨: ${ledger.statistics.planned}`);
+      console.log(`총 엔드포인트: ${ledger.statistics.total_endpoints || 0}`);
+      break;
+
+    default:
+      console.log('사용법: npm run aiwf feature [list|stats]');
+  }
+}
+
+// API 관련 명령어
+else if (command === 'api') {
+  switch (subcommand) {
+    case 'docs':
+      console.log('API 문서 업데이트 중...');
+      console.log('Swagger 문서가 /docs 경로에서 제공됩니다.');
+      break;
+
+    case 'validate':
+      console.log('API 스펙 검증 중...');
+      // 실제 구현에서는 OpenAPI 스펙 검증 로직
+      console.log('✅ API 스펙이 유효합니다.');
+      break;
+
+    default:
+      console.log('사용법: npm run aiwf api [docs|validate]');
+  }
+}
+
+// 상태 명령어
+else if (command === 'status') {
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+  const ledger = JSON.parse(fs.readFileSync(featureLedgerPath, 'utf8'));
+
+  console.log('\n🚀 AIWF API 서버 상태\n');
+  console.log(`프로젝트: ${config.project_name}`);
+  console.log(`타입: ${config.project_type}`);
+  console.log(`프레임워크: ${config.framework}`);
+  console.log(`버전: ${config.version}`);
+  console.log();
+  console.log('📊 통계:');
+  console.log(`- 총 기능: ${ledger.statistics.total_features}`);
+  console.log(`- 총 엔드포인트: ${ledger.statistics.total_endpoints || 0}`);
+  console.log();
+  console.log('🤖 AI 페르소나:', config.features.ai_persona.default);
+  console.log('📦 Context 압축:', config.features.context_compression.level);
+  console.log('📚 API 문서화:', config.features.api_documentation.swagger ? 'Swagger 활성화' : '비활성화');
+}
+
+// 도움말
+else {
+  console.log(`
+AIWF CLI - AI Workflow Framework (API Server)
+
+사용법: npm run aiwf [command] [subcommand]
+
+명령어:
+  status              프로젝트 상태 보기
+  feature list        기능 목록 보기
+  feature stats       기능 통계 보기
+  api docs           API 문서 업데이트
+  api validate       API 스펙 검증
+
+예시:
+  npm run aiwf status
+  npm run aiwf feature list
+  npm run aiwf api docs
+`);
+}

package/src/lib/resources/templates/api-server/template/.env.example

@@ -0,0 +1,29 @@
+# Application
+NODE_ENV=development
+PORT=3000
+HOST=localhost
+
+# Security
+JWT_SECRET=your-super-secret-jwt-key-change-this
+JWT_EXPIRES_IN=7d
+BCRYPT_ROUNDS=10
+
+# Database (uncomment and configure as needed)
+# DB_HOST=localhost
+# DB_PORT=5432
+# DB_NAME=myapp
+# DB_USER=myuser
+# DB_PASSWORD=mypassword
+
+# AIWF Settings
+AIWF_ENABLED=true
+AIWF_TOKEN_LIMIT=100000
+AIWF_COMPRESSION_LEVEL=balanced
+
+# API Rate Limiting
+RATE_LIMIT_WINDOW_MS=900000
+RATE_LIMIT_MAX_REQUESTS=100
+
+# Logging
+LOG_LEVEL=info
+LOG_FORMAT=json

package/src/lib/resources/templates/api-server/template/.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
+    "no-console": ["warn", { "allow": ["warn", "error"] }]
+  },
+  "env": {
+    "node": true,
+    "es2022": true,
+    "jest": true
+  }
+}

package/src/lib/resources/templates/api-server/template/README.md

@@ -0,0 +1,171 @@
+# {{projectName}}
+
+AIWF가 통합된 Express + TypeScript RESTful API 서버입니다.
+
+## 시작하기
+
+### 개발 서버 실행
+
+```bash
+npm install
+cp .env.example .env
+npm run dev
+```
+
+서버가 [http://localhost:3000](http://localhost:3000)에서 실행됩니다.
+
+### API 문서
+
+Swagger UI: [http://localhost:3000/docs](http://localhost:3000/docs)
+
+### 빌드
+
+```bash
+npm run build
+npm start
+```
+
+## 기술 스택
+
+- **Express 4** - 웹 프레임워크
+- **TypeScript** - 타입 안정성
+- **JWT** - 인증
+- **Swagger** - API 문서화
+- **Winston** - 로깅
+- **Jest** - 테스팅
+- **AIWF** - AI 지원 개발 워크플로우
+
+## 프로젝트 구조
+
+```
+src/
+├── config/         # 설정 파일
+├── controllers/    # 요청 핸들러
+├── middleware/     # Express 미들웨어
+├── models/         # 데이터 모델
+├── routes/         # API 라우트 정의
+├── services/       # 비즈니스 로직
+├── utils/          # 유틸리티 함수
+└── types/          # TypeScript 타입 정의
+```
+
+## API 엔드포인트
+
+### 인증
+
+- `POST /api/v1/auth/register` - 회원가입
+- `POST /api/v1/auth/login` - 로그인
+
+### 상태
+
+- `GET /health` - 헬스체크
+- `GET /api/v1/status` - API 상태
+
+### AIWF
+
+- `GET /api/aiwf/features` - Feature Ledger 조회
+- `GET /api/aiwf/token-usage` - 토큰 사용량 조회
+- `GET /api/aiwf/context` - Context 상태 조회
+
+## AIWF 기능
+
+### Feature Ledger
+
+API 엔드포인트 개발을 자동으로 추적합니다.
+
+```bash
+npm run aiwf:feature list    # 기능 목록 보기
+npm run aiwf:feature stats   # 통계 보기
+```
+
+### API 문서 자동화
+
+```bash
+npm run aiwf:api docs        # API 문서 업데이트
+npm run aiwf:api validate    # API 스펙 검증
+```
+
+### AI 페르소나
+
+- `backend-engineer` - 백엔드 개발 (기본값)
+- `api-architect` - API 설계
+- `database-specialist` - 데이터베이스
+- `security-auditor` - 보안 감사
+- `performance-optimizer` - 성능 최적화
+
+## 개발 가이드
+
+### 새 API 엔드포인트 추가
+
+1. 라우트 정의 (`src/routes/`)
+2. 컨트롤러 구현 (`src/controllers/`)
+3. 서비스 로직 작성 (`src/services/`)
+4. 입력 검증 추가
+5. Swagger 문서 작성
+
+### 미들웨어 추가
+
+```typescript
+// src/middleware/myMiddleware.ts
+export const myMiddleware = (req: Request, res: Response, next: NextFunction) => {
+  // 미들웨어 로직
+  next();
+};
+```
+
+### 환경 변수
+
+`.env` 파일 설정:
+
+```env
+NODE_ENV=development
+PORT=3000
+JWT_SECRET=your-secret-key
+```
+
+## 테스트
+
+```bash
+# 전체 테스트 실행
+npm test
+
+# 감시 모드
+npm run test:watch
+
+# 커버리지 리포트
+npm test -- --coverage
+```
+
+## 보안
+
+- Helmet.js로 보안 헤더 설정
+- Rate limiting 적용
+- JWT 토큰 인증
+- 입력 검증 (express-validator)
+- CORS 설정
+
+## 배포
+
+### Docker
+
+```dockerfile
+FROM node:18-alpine
+WORKDIR /app
+COPY package*.json ./
+RUN npm ci --only=production
+COPY . .
+RUN npm run build
+EXPOSE 3000
+CMD ["npm", "start"]
+```
+
+### PM2
+
+```bash
+npm run build
+pm2 start dist/index.js --name {{projectName}}
+```
+
+## 라이선스
+
+MIT

package/src/lib/resources/templates/api-server/template/jest.config.js

@@ -0,0 +1,26 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/**/*.interface.ts',
+    '!src/index.ts',
+  ],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+    '^@config/(.*)$': '<rootDir>/src/config/$1',
+    '^@controllers/(.*)$': '<rootDir>/src/controllers/$1',
+    '^@middleware/(.*)$': '<rootDir>/src/middleware/$1',
+    '^@models/(.*)$': '<rootDir>/src/models/$1',
+    '^@routes/(.*)$': '<rootDir>/src/routes/$1',
+    '^@services/(.*)$': '<rootDir>/src/services/$1',
+    '^@utils/(.*)$': '<rootDir>/src/utils/$1',
+    '^@types/(.*)$': '<rootDir>/src/types/$1',
+  },
+};

package/src/lib/resources/templates/api-server/template/nodemon.json

@@ -0,0 +1,9 @@
+{
+  "watch": ["src"],
+  "ext": "ts",
+  "ignore": ["src/**/*.spec.ts", "src/**/*.test.ts"],
+  "exec": "ts-node -r tsconfig-paths/register ./src/index.ts",
+  "env": {
+    "NODE_ENV": "development"
+  }
+}

package/src/lib/resources/templates/api-server/template/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.1",
+  "description": "AIWF 통합 Express API 서버",
+  "main": "dist/index.js",
+  "scripts": {
+    "dev": "nodemon",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "lint": "eslint . --ext .ts",
+    "aiwf": "node .aiwf/scripts/cli.js",
+    "aiwf:status": "npm run aiwf status",
+    "aiwf:feature": "npm run aiwf feature",
+    "aiwf:api": "npm run aiwf api"
+  },
+  "keywords": [
+    "api",
+    "express",
+    "typescript",
+    "aiwf"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.18.2",
+    "cors": "^2.8.5",
+    "helmet": "^7.0.0",
+    "compression": "^1.7.4",
+    "dotenv": "^16.3.1",
+    "jsonwebtoken": "^9.0.1",
+    "bcryptjs": "^2.4.3",
+    "express-validator": "^7.0.1",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.0",
+    "winston": "^3.9.0",
+    "express-rate-limit": "^6.8.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/node": "^20.0.0",
+    "@types/cors": "^2.8.13",
+    "@types/compression": "^1.7.2",
+    "@types/jsonwebtoken": "^9.0.2",
+    "@types/bcryptjs": "^2.4.2",
+    "@types/swagger-jsdoc": "^6.0.1",
+    "@types/swagger-ui-express": "^4.1.3",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "typescript": "^5.1.0",
+    "ts-node": "^10.9.0",
+    "nodemon": "^3.0.0",
+    "eslint": "^8.43.0",
+    "jest": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "supertest": "^6.3.0",
+    "@types/supertest": "^2.0.12"
+  }
+}

package/src/lib/resources/templates/api-server/template/src/app.ts

@@ -0,0 +1,60 @@
+import express, { Application } from 'express';
+import cors from 'cors';
+import helmet from 'helmet';
+import compression from 'compression';
+import rateLimit from 'express-rate-limit';
+import swaggerUi from 'swagger-ui-express';
+import { swaggerSpec } from '@config/swagger';
+import { errorHandler } from '@middleware/errorHandler';
+import { notFoundHandler } from '@middleware/notFoundHandler';
+import { requestLogger } from '@middleware/requestLogger';
+import { aiwfMiddleware } from '@middleware/aiwfMiddleware';
+import routes from '@routes/index';
+
+const app: Application = express();
+
+// Security middleware
+app.use(helmet());
+app.use(cors());
+
+// Rate limiting
+const limiter = rateLimit({
+  windowMs: parseInt(process.env.RATE_LIMIT_WINDOW_MS || '900000'),
+  max: parseInt(process.env.RATE_LIMIT_MAX_REQUESTS || '100'),
+  message: 'Too many requests from this IP, please try again later.',
+});
+app.use('/api', limiter);
+
+// Body parsing middleware
+app.use(express.json({ limit: '10mb' }));
+app.use(express.urlencoded({ extended: true, limit: '10mb' }));
+
+// Compression middleware
+app.use(compression());
+
+// Request logging
+app.use(requestLogger);
+
+// AIWF integration
+app.use(aiwfMiddleware);
+
+// API Documentation
+app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+
+// Health check
+app.get('/health', (req, res) => {
+  res.status(200).json({
+    status: 'healthy',
+    timestamp: new Date().toISOString(),
+    uptime: process.uptime(),
+  });
+});
+
+// API routes
+app.use('/api', routes);
+
+// Error handlers
+app.use(notFoundHandler);
+app.use(errorHandler);
+
+export default app;

package/src/lib/resources/templates/api-server/template/src/config/swagger.ts

@@ -0,0 +1,38 @@
+import swaggerJsdoc from 'swagger-jsdoc';
+import { version } from '../../package.json';
+
+const options: swaggerJsdoc.Options = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: '{{projectName}} API',
+      version,
+      description: 'AIWF 통합 Express API 서버',
+      contact: {
+        name: 'API Support',
+        email: 'support@example.com',
+      },
+    },
+    servers: [
+      {
+        url: `http://localhost:${process.env.PORT || 3000}`,
+        description: 'Development server',
+      },
+    ],
+    components: {
+      securitySchemes: {
+        bearerAuth: {
+          type: 'http',
+          scheme: 'bearer',
+          bearerFormat: 'JWT',
+        },
+      },
+    },
+    security: [{
+      bearerAuth: [],
+    }],
+  },
+  apis: ['./src/routes/**/*.ts', './src/models/**/*.ts'],
+};
+
+export const swaggerSpec = swaggerJsdoc(options);