@ahhaohho/response-dto 1.0.1 → 1.1.0

package/README.md

@@ -4,7 +4,7 @@ AhhaOhho API 응답을 위한 DTO(Data Transfer Object) 클래스입니다.
 
 ## 소개
 
-이 패키지는 AhhaOhho API 응답을 표준화하고 일관성 있게 만들기 위한 ResponseDTO 클래스를 제공합니다. 성공 응답, 클라이언트 오류, 시스템 오류 등 다양한 API 응답 상황을 처리할 수 있습니다.
+이 패키지는 AhhaOhho API 응답을 표준화하고 일관성 있게 만들기 위한 ResponseDTO 클래스를 제공합니다. 성공 응답, 클라이언트 오류, 시스템 오류 등 다양한 API 응답 상황을 처리할 수 있습니다. 모든 응답은 일관된 구조를 가지며, 데이터가 없는 경우에도 `null`을 명시적으로 포함하여 타입 안전성을 보장합니다.
 
 ## 설치
 
@@ -21,9 +21,12 @@ ResponseDTO 클래스를 import하여 사용할 수 있습니다:
 ```javascript
 const ResponseDTO = require('@ahhaohho/response-dto');
 
-// 성공 응답 예시
+// 성공 응답 예시 (데이터 있음)
 const successResponse = ResponseDTO.success({ user: { id: 1, name: '아하오호' } });
 
+// 성공 응답 예시 (데이터 없음)
+const noDataResponse = ResponseDTO.success();
+
 // 클라이언트 오류 응답 예시
 const clientErrorResponse = ResponseDTO.badRequest('잘못된 요청입니다.');
 
@@ -45,6 +48,21 @@ const systemErrorResponse = ResponseDTO.systemError('서버 오류가 발생했
 - `systemError(message)`: 시스템 오류 (상태 코드 500)
 - `serviceUnavailable(message)`: 서비스 사용 불가 오류 (상태 코드 503)
 
+모든 메서드는 일관된 구조의 ResponseDTO 객체를 반환합니다. 데이터가 없는 경우에도 `data` 필드는 `null`로 명시적으로 포함됩니다.
+
+## 응답 구조
+
+모든 ResponseDTO 객체는 다음과 같은 구조를 가집니다:
+
+```javascript
+{
+  type: string,    // 'success', 'client', 또는 'system'
+  status: number,  // HTTP 상태 코드
+  data: any,       // 응답 데이터 (없는 경우 null)
+  message?: string // 추가 메시지 (주로 오류에 사용, 옵션)
+}
+```
+
 ## 예제
 
 Express.js와 함께 사용하는 예제:
@@ -64,9 +82,24 @@ app.get('/api/users/:id', (req, res) => {
   }
 });
 
+app.post('/api/users', (req, res) => {
+  // 새 사용자 생성 로직
+  const newUser = { id: 123, name: '새로운 사용자' };
+  res.status(201).json(ResponseDTO.created(newUser));
+});
+
+app.delete('/api/users/:id', (req, res) => {
+  // 사용자 삭제 로직
+  res.json(ResponseDTO.noContent());
+});
+
 app.listen(3000, () => console.log('서버가 3000번 포트에서 실행 중입니다.'));
 ```
 
+## 타입 안전성
+
+ResponseDTO는 모든 응답에 `data` 필드를 포함하며, 데이터가 없는 경우에도 `null`을 명시적으로 설정합니다. 이는 타입스크립트나 다른 정적 타입 언어를 사용하는 클라이언트에서 타입 안전성을 보장하는 데 도움이 됩니다.
+
 ## 작성자
 
 정두수 (dsoojung@smilegate.com)

package/ResponseDTO.js

@@ -4,130 +4,133 @@
  * 성공 응답, 클라이언트 오류, 시스템 오류 등 모든 API 응답에 대해 일관된 구조를 제공합니다.
  */
 class ResponseDTO {
-    /**
-     * ResponseDTO 생성자
-     * @param {string} type - 응답 유형 ('success', 'client', 또는 'system')
-     * @param {number} status - HTTP 상태 코드
-     * @param {object|null} data - 응답 데이터 (선택적)
-     * @param {string|null} message - 추가 메시지 (주로 오류에 사용)
-     */
-    constructor(type, status, data = null, message = null) {
-      this.type = type;
-      this.status = status;
-      if (data) this.data = data;
-      if (message) this.message = message;
-    }
-  
-    /**
-     * 상태 코드 200의 성공 응답을 생성합니다.
-     * @param {object} data - 응답에 포함될 데이터
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static success(data) {
-      return new ResponseDTO('success', 200, data);
-    }
-  
-    /**
-     * 리소스 생성 성공을 나타내는 상태 코드 201의 응답을 생성합니다.
-     * @param {object} data - 생성된 리소스의 데이터
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static created(data) {
-      return new ResponseDTO('success', 201, data);
-    }
-  
-    /**
-     * 콘텐츠가 없는 성공 응답 (상태 코드 204)을 생성합니다.
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static noContent() {
-      return new ResponseDTO('success', 204);
-    }
-  
-    /**
-     * 잘못된 요청에 대한 클라이언트 오류 응답 (상태 코드 400)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static badRequest(message) {
-      return new ResponseDTO('client', 400, null, message);
-    }
-  
-    /**
-     * 인증되지 않은 접근에 대한 클라이언트 오류 응답 (상태 코드 401)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static unauthorized(message) {
-      return new ResponseDTO('client', 401, null, message);
-    }
-  
-    /**
-     * 금지된 접근에 대한 클라이언트 오류 응답 (상태 코드 403)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static forbidden(message) {
-      return new ResponseDTO('client', 403, null, message);
-    }
-  
-    /**
-     * 리소스를 찾을 수 없는 경우의 클라이언트 오류 응답 (상태 코드 404)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static notFound(message) {
-      return new ResponseDTO('client', 404, null, message);
-    }
-  
-    /**
-     * 충돌 상황에 대한 클라이언트 오류 응답 (상태 코드 409)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static conflict(message) {
-      return new ResponseDTO('client', 409, null, message);
-    }
-  
-    /**
-     * 유효성 검사 오류에 대한 클라이언트 오류 응답 (상태 코드 422)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static validationError(message) {
-      return new ResponseDTO('client', 422, null, message);
-    }
-  
-    /**
-     * 시스템 오류 응답 (상태 코드 500)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static systemError(message) {
-      return new ResponseDTO('system', 500, null, message);
-    }
-  
-    /**
-     * 서비스 이용 불가 상황에 대한 시스템 오류 응답 (상태 코드 503)을 생성합니다.
-     * @param {string} message - 오류 메시지
-     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
-     */
-    static serviceUnavailable(message) {
-      return new ResponseDTO('system', 503, null, message);
-    }
-  
-    /**
-     * ResponseDTO 인스턴스를 일반 JavaScript 객체로 변환합니다.
-     * @returns {object} ResponseDTO의 일반 JavaScript 객체 표현
-     */
-    toJSON() {
-      return {
-        type: this.type,
-        status: this.status,
-        ...(this.data && { data: this.data }),
-        ...(this.message && { message: this.message })
-      };
+  /**
+   * ResponseDTO 생성자
+   * @param {string} type - 응답 유형 ('success', 'client', 또는 'system')
+   * @param {number} status - HTTP 상태 코드
+   * @param {object|null} data - 응답 데이터 (항상 포함, 없을 경우 null)
+   * @param {string|null} message - 추가 메시지 (주로 오류에 사용)
+   */
+  constructor(type, status, data = null, message = null) {
+    this.type = type;
+    this.status = status;
+    this.data = data;  // 항상 data 필드를 포함, 값이 없으면 null
+    if (message !== null) this.message = message;
+  }
+
+  /**
+   * 상태 코드 200의 성공 응답을 생성합니다.
+   * @param {object|null} data - 응답에 포함될 데이터
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static success(data = null) {
+    return new ResponseDTO('success', 200, data);
+  }
+
+  /**
+   * 리소스 생성 성공을 나타내는 상태 코드 201의 응답을 생성합니다.
+   * @param {object|null} data - 생성된 리소스의 데이터
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static created(data = null) {
+    return new ResponseDTO('success', 201, data);
+  }
+
+  /**
+   * 콘텐츠가 없는 성공 응답 (상태 코드 204)을 생성합니다.
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static noContent() {
+    return new ResponseDTO('success', 204, null);
+  }
+
+  /**
+   * 잘못된 요청에 대한 클라이언트 오류 응답 (상태 코드 400)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static badRequest(message) {
+    return new ResponseDTO('client', 400, null, message);
+  }
+
+  /**
+   * 인증되지 않은 접근에 대한 클라이언트 오류 응답 (상태 코드 401)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static unauthorized(message) {
+    return new ResponseDTO('client', 401, null, message);
+  }
+
+  /**
+   * 금지된 접근에 대한 클라이언트 오류 응답 (상태 코드 403)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static forbidden(message) {
+    return new ResponseDTO('client', 403, null, message);
+  }
+
+  /**
+   * 리소스를 찾을 수 없는 경우의 클라이언트 오류 응답 (상태 코드 404)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static notFound(message) {
+    return new ResponseDTO('client', 404, null, message);
+  }
+
+  /**
+   * 충돌 상황에 대한 클라이언트 오류 응답 (상태 코드 409)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static conflict(message) {
+    return new ResponseDTO('client', 409, null, message);
+  }
+
+  /**
+   * 유효성 검사 오류에 대한 클라이언트 오류 응답 (상태 코드 422)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static validationError(message) {
+    return new ResponseDTO('client', 422, null, message);
+  }
+
+  /**
+   * 시스템 오류 응답 (상태 코드 500)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static systemError(message) {
+    return new ResponseDTO('system', 500, null, message);
+  }
+
+  /**
+   * 서비스 이용 불가 상황에 대한 시스템 오류 응답 (상태 코드 503)을 생성합니다.
+   * @param {string} message - 오류 메시지
+   * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+   */
+  static serviceUnavailable(message) {
+    return new ResponseDTO('system', 503, null, message);
+  }
+
+  /**
+   * ResponseDTO 인스턴스를 일반 JavaScript 객체로 변환합니다.
+   * @returns {object} ResponseDTO의 일반 JavaScript 객체 표현
+   */
+  toJSON() {
+    const json = {
+      type: this.type,
+      status: this.status,
+      data: this.data
+    };
+    if (this.message !== undefined) {
+      json.message = this.message;
     }
+    return json;
   }
-  
-  module.exports = ResponseDTO;
+}
+
+module.exports = ResponseDTO;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahhaohho/response-dto",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "AhhaOhho API 응답을 위한 DTO 클래스",
   "main": "index.js",
   "scripts": {