@xfilecom/xframe 0.1.13 → 0.1.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xfilecom/xframe",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Scaffold full-stack app: Nest + @xfilecom/backend-core, Vite/React + @xfilecom/front-core",
   "license": "UNLICENSED",
   "bin": {

package/template/README.md

@@ -16,7 +16,7 @@ Nest API (`@xfilecom/backend-core`) + Vite/React client·admin (`@xfilecom/front
 
 ## URLs
 
-- API: `http://localhost:3000` — `GET /health` (`AppService`: Drizzle 직접 카운트; `DatabaseQuery` 는 `docs/DATABASE.md`)
+- API: `http://localhost:3000` — `GET /health` (`AppService`: DB 로드·연결 여부만; 쿼리 패턴은 `docs/DATABASE.md`)
 - Client: `http://localhost:3001` — `CommonResponse` 형태로 `/health` 표시
 - Admin: `http://localhost:3002`
 

package/template/apps/api/src/app.controller.ts

@@ -1,14 +1,17 @@
 import { Controller, Get } from '@nestjs/common';
-import { Public } from '@xfilecom/backend-core';
+import { ControllerHelpers, Public } from '@xfilecom/backend-core';
 import { AppService } from './app.service';
 
 @Controller()
 export class AppController {
-  constructor(private readonly appService: AppService) {}
+  constructor(
+    private readonly appService: AppService,
+    private readonly controllerHelpers: ControllerHelpers,
+  ) {}
 
   @Public()
   @Get('health')
   health() {
-    return this.appService.getHealth();
+    return this.controllerHelpers.success(this.appService.getHealth());
   }
 }

package/template/apps/api/src/app.service.ts

@@ -1,15 +1,14 @@
 import { Injectable, Optional } from '@nestjs/common';
-import { sql } from 'drizzle-orm';
 import { DatabaseService } from '@xfilecom/backend-core';
-import { appMeta } from '../../../shared/schema';
 
 /**
  * DB 사용은 backend-core 에서 두 가지가 있습니다.
  *
- * 1. **DatabaseService** — `this.database.db` 로 Drizzle API 직접 (아래 `getHealth` 가 이 방식).
- * 2. **DatabaseQuery** — `findOne` / `count` / `select` 등 헬퍼. 예: `await dbQuery.count('appMeta')`.
+ * 1. **DatabaseService** — `this.database.db` 로 Drizzle API 직접.
+ * 2. **DatabaseQuery** — `findOne` / `count` / `select` 등 헬퍼.
  *
- * `docs/DATABASE.md` §3 참고.
+ * `GET /health` 는 특정 테이블을 가정하지 않음 (`db:pull` 등으로 스키마가 바뀌어도 깨지지 않게).
+ * 도메인 쿼리는 별도 서비스에서 스키마 심볼·`DatabaseQuery` 로 작성하면 됨. → `docs/DATABASE.md` §3.
  */
 @Injectable()
 export class AppService {
@@ -20,48 +19,20 @@ export class AppService {
   }
 
   /**
-   * `GET /health` 용. `core.database.auto: false` 이면 DB 프로바이더가 없고 optional 로 비어 있음.
+   * `GET /health`. `core.database.auto: false` 이면 DB 모듈 미로드 → optional 미주입.
    */
-  async getHealth(): Promise<{
+  getHealth(): {
     ok: true;
     service: string;
-    database: {
-      moduleLoaded: boolean;
-      connected: boolean;
-      /** Drizzle 직접 `count(*)` — 동일 결과: `DatabaseQuery.count('appMeta')` */
-      rowCount?: number;
-      sampleTable?: string;
-    };
-  }> {
-    const sampleTable = 'appMeta';
+    database: { moduleLoaded: boolean; connected: boolean };
+  } {
     const service = this.serviceLabel();
     const moduleLoaded = this.database !== undefined;
-    if (!moduleLoaded || !this.database.isConnected()) {
-      return {
-        ok: true,
-        service,
-        database: { moduleLoaded, connected: false, sampleTable },
-      };
-    }
-    let rowCount: number | undefined;
-    try {
-      const db = this.database.db;
-      const [row] = await db
-        .select({ c: sql<number>`count(*)` })
-        .from(appMeta);
-      rowCount = Number(row?.c ?? 0);
-    } catch {
-      rowCount = undefined;
-    }
+    const connected = moduleLoaded && this.database.isConnected();
     return {
       ok: true,
       service,
-      database: {
-        moduleLoaded,
-        connected: true,
-        rowCount,
-        sampleTable,
-      },
+      database: { moduleLoaded, connected },
     };
   }
 }

package/template/docs/DATABASE.md

@@ -32,7 +32,7 @@ xframe 프로젝트는 **`@xfilecom/backend-core`** 가 MySQL 풀과 Drizzle 인
 | **타입** | 스키마 심볼 import (`appMeta` 등) — 권장 | 테이블 키는 문자열 (`'appMeta'`) |
 | **언제** | 복잡한 조인·raw·Drizzle 문서 그대로 | 단순 CRUD·페이지네이션·object `where` |
 
-스캐폴드 **`apps/api/src/app.service.ts`** 는 `GET /health` 에 **`DatabaseService.db` + Drizzle** 로 `app_meta` 행 수를 구합니다. 같은 값은 **`DatabaseQuery.count('appMeta')`** 로도 얻을 수 있습니다 (`@Optional()` 로 DB 꺼짐 대응은 동일).
+스캐폴드 **`apps/api/src/app.service.ts`** 의 `GET /health` 는 **DB 모듈 로드 여부·연결 여부**만 돌려주며, 어떤 테이블도 가정하지 않습니다. 실제 쿼리는 아래 패턴으로 별도 서비스를 두면 됩니다.
 
 ### A. Drizzle API 직접 (`DatabaseService.db`)
 
@@ -98,6 +98,11 @@ export class AppModule {}
 
 `DatabaseModule` 을 다시 import 할 필요는 없습니다.
 
+## 공통 응답 (`CommonResponseDto`)
+
+`CoreModule.forHttpApi` 는 기본으로 **`ResponseTransformInterceptor`** 를 켜서, 컨트롤러가 객체만 반환해도 `{ code, data, meta?, error }` 형태로 감쌉니다.  
+그래도 **`ControllerHelpers.success(payload)`** 로 `CommonResponseDto` 를 직접 반환하는 편이 의도가 분명합니다. `CoreModule` 이 `@Global()` 이라 **`ControllerHelpers` 는 주입만 하면 됩니다** — `apps/api/src/app.controller.ts` 의 `GET /health` 가 그 패턴입니다.
+
 ## 5. Drizzle Kit (루트에서 실행)
 
 프로젝트 **루트**에서 스크립트를 실행합니다 (`process.cwd()` 가 루트여야 `drizzle.env.ts` 가 YAML 을 찾습니다).

package/template/web/shared/src/types/api.ts

@@ -12,7 +12,5 @@ export type HealthData = {
   database?: {
     moduleLoaded: boolean;
     connected: boolean;
-    rowCount?: number;
-    sampleTable?: string;
   };
 };

package/template/.env.example

@@ -1,6 +0,0 @@
-# Nest API·Drizzle 부트스트랩은 루트 .env 를 읽지 않음. DB 등은 `shared/config/api/application*.yml` 기준.
-# 기본 CONFIG_SOURCE=yaml → 셸에서 export 한 DB_* 로 YAML 이 바뀌지 않음. 덮어쓰기: CONFIG_SOURCE=yamlWithEnvOverrides
-#
-# (선택) 로컬 도구용으로만 .env 를 쓸 경우 — 앱/ drizzle-kit 은 자동 로드하지 않음.
-#
-# 접속 오류 시: GUI 와 동일한 host·user·password·database 이름을 YAML 에 맞출 것.