@ahhaohho/response-dto 1.0.0

package/README.md

@@ -0,0 +1,76 @@
+# ResponseDTO
+
+AhhaOhho API 응답을 위한 DTO(Data Transfer Object) 클래스입니다.
+
+## 소개
+
+이 패키지는 AhhaOhho API 응답을 표준화하고 일관성 있게 만들기 위한 ResponseDTO 클래스를 제공합니다. 성공 응답, 클라이언트 오류, 시스템 오류 등 다양한 API 응답 상황을 처리할 수 있습니다.
+
+## 설치
+
+npm을 사용하여 패키지를 설치할 수 있습니다:
+
+```bash
+npm install @ahhaohho/response-dto
+```
+
+## 사용 방법
+
+ResponseDTO 클래스를 import하여 사용할 수 있습니다:
+
+```javascript
+const ResponseDTO = require('@ahhaohho/response-dto');
+
+// 성공 응답 예시
+const successResponse = ResponseDTO.success({ user: { id: 1, name: '아하오호' } });
+
+// 클라이언트 오류 응답 예시
+const clientErrorResponse = ResponseDTO.badRequest('잘못된 요청입니다.');
+
+// 시스템 오류 응답 예시
+const systemErrorResponse = ResponseDTO.systemError('서버 오류가 발생했습니다.');
+```
+
+## 주요 기능
+
+- `success(data)`: 성공 응답 (상태 코드 200)
+- `created(data)`: 리소스 생성 성공 응답 (상태 코드 201)
+- `noContent()`: 콘텐츠 없는 성공 응답 (상태 코드 204)
+- `badRequest(message)`: 잘못된 요청 오류 (상태 코드 400)
+- `unauthorized(message)`: 인증 실패 오류 (상태 코드 401)
+- `forbidden(message)`: 접근 권한 없음 오류 (상태 코드 403)
+- `notFound(message)`: 리소스를 찾을 수 없음 오류 (상태 코드 404)
+- `conflict(message)`: 충돌 오류 (상태 코드 409)
+- `validationError(message)`: 유효성 검사 오류 (상태 코드 422)
+- `systemError(message)`: 시스템 오류 (상태 코드 500)
+- `serviceUnavailable(message)`: 서비스 사용 불가 오류 (상태 코드 503)
+
+## 예제
+
+Express.js와 함께 사용하는 예제:
+
+```javascript
+const express = require('express');
+const ResponseDTO = require('@ahhaohho/response-dto');
+
+const app = express();
+
+app.get('/api/users/:id', (req, res) => {
+  try {
+    const user = { id: req.params.id, name: '홍길동' };
+    res.json(ResponseDTO.success(user));
+  } catch (error) {
+    res.status(500).json(ResponseDTO.systemError('사용자 정보를 가져오는 데 실패했습니다.'));
+  }
+});
+
+app.listen(3000, () => console.log('서버가 3000번 포트에서 실행 중입니다.'));
+```
+
+## 작성자
+
+정두수 (dsoojung@smilegate.com)
+
+---
+
+이 README는 프로젝트의 기본적인 정보를 제공합니다. 필요에 따라 내용을 수정하거나 확장할 수 있습니다.

package/ResponseDTO.js

@@ -0,0 +1,133 @@
+/**
+ * ResponseDTO 클래스
+ * API 응답을 표준화하기 위한 클래스입니다.
+ * 성공 응답, 클라이언트 오류, 시스템 오류 등 모든 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 })
+      };
+    }
+  }
+  
+  module.exports = ResponseDTO;

package/index.js

@@ -0,0 +1,3 @@
+const ResponseDTO = require('./ResponseDTO');
+
+module.exports = ResponseDTO;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@ahhaohho/response-dto",
+  "version": "1.0.0",
+  "description":  "한국어 주석이 포함된 API 응답을 위한 DTO 클래스",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["api", "response", "dto"],
+  "author": "doooosoooo",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Future-Lab-META/npm-responseDto.git"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Future-Lab-META/npm-responseDto/issues"
+  },
+  "homepage": "https://github.com/Future-Lab-META/npm-responseDto#readme"
+}
+