@ahhaohho/response-dto 1.1.0 → 1.2.0

package/ResponseDTO.js

@@ -1,136 +1,136 @@
-/**
+/** 
  * ResponseDTO 클래스
  * API 응답을 표준화하기 위한 클래스입니다.
  * 성공 응답, 클라이언트 오류, 시스템 오류 등 모든 API 응답에 대해 일관된 구조를 제공합니다.
  */
 class ResponseDTO {
-  /**
-   * 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;
+    /**
+     * 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;
+        this.message = message;
+    }
+  
+    /** 
+     * 상태 코드 200의 성공 응답을 생성합니다.
+     * @param {object|null} data - 응답에 포함될 데이터
+     * @param {string|null} message - 성공 메시지
+     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+     */
+    static success(data = null, message = null) {
+        return new ResponseDTO('success', 200, data, message);
+    }
+  
+    /** 
+     * 리소스 생성 성공을 나타내는 상태 코드 201의 응답을 생성합니다.
+     * @param {object|null} data - 생성된 리소스의 데이터
+     * @param {string|null} message - 생성 성공 메시지
+     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+     */
+    static created(data = null, message = null) {
+        return new ResponseDTO('success', 201, data, message);
+    }
+  
+    /** 
+     * 콘텐츠가 없는 성공 응답 (상태 코드 204)을 생성합니다.
+     * @param {string|null} message - 성공 메시지
+     * @returns {ResponseDTO} 새로운 ResponseDTO 인스턴스
+     */
+    static noContent(message = null) {
+        return new ResponseDTO('success', 204, null, message);
+    }
+  
+    /** 
+     * 잘못된 요청에 대한 클라이언트 오류 응답 (상태 코드 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,
+            data: this.data,
+            message: this.message
+        };
     }
-    return json;
   }
-}
-
-module.exports = ResponseDTO;
+  
+  module.exports = ResponseDTO;

package/package.json

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