create-entity-server 0.0.25 → 0.0.27

package/template/entities/System/Notification/friendtalk_log.json

@@ -0,0 +1,48 @@
+{
+    "name": "friendtalk_log",
+    "description": "친구톡(브랜드메시지) 발송 로그 — 워커가 소비하는 DB 큐 역할을 합니다. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "history": false,
+    "read_only": true,
+    "compress": true,
+    "index": {
+        "status": {
+            "type": ["pending", "processing", "sent", "failed", "expired"],
+            "default": "pending",
+            "comment": "발송 상태"
+        },
+        "msg_type": {
+            "type": [
+                "text",
+                "image",
+                "wide_image",
+                "wide_item_list",
+                "carousel"
+            ],
+            "default": "text"
+        },
+        "receiver": { "comment": "수신자 전화번호", "required": true },
+        "friendtalk_msg_seq": { "comment": "friendtalk_msg 참조 seq" }
+    },
+    "fields": {
+        "content": { "type": "text", "comment": "메시지 본문" },
+        "image_url": { "comment": "이미지 URL" },
+        "image_link": { "comment": "이미지 클릭 시 이동 URL" },
+        "is_ad": {
+            "type": "bool",
+            "default": true,
+            "comment": "광고성 메시지 여부"
+        },
+        "buttons_json": { "type": "text", "comment": "버튼 목록 JSON" },
+        "carousel_json": { "type": "text", "comment": "캐러셀 데이터 JSON" },
+        "items_json": {
+            "type": "text",
+            "comment": "와이드 아이템 리스트 JSON"
+        },
+        "header": { "comment": "와이드 아이템 리스트 헤더" },
+        "provider": { "comment": "사용 프로바이더" },
+        "provider_msg_id": { "comment": "프로바이더 메시지 ID" },
+        "error_message": { "type": "text", "comment": "오류 메시지" },
+        "retry_count": { "type": "uint", "default": 0 },
+        "sent_at": { "type": "string" }
+    }
+}

package/template/entities/System/Notification/friendtalk_msg.json

@@ -0,0 +1,63 @@
+{
+    "name": "friendtalk_msg",
+    "description": "친구톡(브랜드메시지) 발송 트리거 엔티티 — Hook 또는 API를 통해 생성되면 친구톡 발송이 시작됩니다. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "history": false,
+    "index": {
+        "receiver": { "comment": "수신자 전화번호", "required": true },
+        "msg_type": {
+            "type": [
+                "text",
+                "image",
+                "wide_image",
+                "wide_item_list",
+                "carousel"
+            ],
+            "default": "text"
+        },
+        "status": {
+            "type": ["pending", "processing", "sent", "failed"],
+            "default": "pending"
+        }
+    },
+    "fields": {
+        "content": {
+            "type": "text",
+            "required": true,
+            "comment": "메시지 본문"
+        },
+        "image_url": { "comment": "이미지 URL" },
+        "image_link": { "comment": "이미지 클릭 시 이동 URL" },
+        "is_ad": {
+            "type": "bool",
+            "default": true,
+            "comment": "광고성 메시지 여부"
+        },
+        "buttons_json": { "type": "text", "comment": "버튼 목록 JSON" },
+        "carousel_json": { "type": "text", "comment": "캐러셀 데이터 JSON" },
+        "items_json": {
+            "type": "text",
+            "comment": "와이드 아이템 리스트 JSON"
+        },
+        "header": { "comment": "와이드 아이템 리스트 헤더" },
+        "provider": { "comment": "프로바이더 키 (빈 값이면 default)" },
+        "ref_entity": { "comment": "참조 엔티티 이름" },
+        "ref_seq": { "type": "int" }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "type": "friendtalk",
+                "friendtalk_receiver": "${new.receiver}",
+                "friendtalk_content": "${new.content}",
+                "friendtalk_msg_type": "${new.msg_type}",
+                "friendtalk_image_url": "${new.image_url}",
+                "friendtalk_image_link": "${new.image_link}",
+                "friendtalk_is_ad": "${new.is_ad}",
+                "friendtalk_buttons_json": "${new.buttons_json}",
+                "friendtalk_carousel_json": "${new.carousel_json}",
+                "friendtalk_items_json": "${new.items_json}",
+                "friendtalk_header": "${new.header}"
+            }
+        ]
+    }
+}

package/template/entities/System/Notification/sms_log.json

@@ -0,0 +1,26 @@
+{
+    "name": "sms_log",
+    "description": "SMS/LMS/MMS 발송 이력 로그. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "license_scope": false,
+    "hard_delete": true,
+    "history": false,
+    "read_only": true,
+    "compress": true,
+    "index": {
+        "status": { "type": ["pending", "processing", "sent", "failed"] },
+        "msg_type": { "type": ["sms", "lms", "mms"] },
+        "receiver": { "type": "string" },
+        "sms_msg_seq": { "comment": "sms_msg 참조 seq" }
+    },
+    "fields": {
+        "sender": { "type": "string" },
+        "subject": { "type": "string" },
+        "content": { "type": "string" },
+        "image_url": { "type": "string", "comment": "MMS 이미지 URL" },
+        "provider": { "type": "string" },
+        "provider_msg_id": { "type": "string" },
+        "error_message": { "type": "string" },
+        "retry_count": { "type": "uint" },
+        "sent_at": { "type": "string" }
+    }
+}

package/template/entities/System/Notification/sms_msg.json

@@ -0,0 +1,52 @@
+{
+    "name": "sms_msg",
+    "description": "SMS/LMS/MMS 발송 트리거 엔티티. insert 시 sms hook으로 비동기 발송. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "license_scope": false,
+    "hard_delete": true,
+    "history": false,
+    "read_only": true,
+    "index": {
+        "status": {
+            "type": ["queued", "sent", "failed"],
+            "default": "queued"
+        },
+        "msg_type": {
+            "type": ["sms", "lms", "mms"],
+            "default": "sms"
+        },
+        "receiver": {
+            "type": "string",
+            "required": true,
+            "comment": "수신 전화번호"
+        }
+    },
+    "fields": {
+        "sender": { "type": "string", "comment": "발신번호" },
+        "subject": {
+            "type": "string",
+            "comment": "LMS/MMS 제목 (SMS는 미사용)"
+        },
+        "content": { "type": "string", "comment": "메시지 본문" },
+        "image_url": { "type": "string", "comment": "MMS 이미지 URL" },
+        "provider": { "type": "string", "comment": "발송 프로바이더 키" },
+        "provider_msg_id": {
+            "type": "string",
+            "comment": "프로바이더 메시지 ID"
+        },
+        "ref_entity": { "type": "string" },
+        "ref_seq": { "type": "int" },
+        "error_message": { "type": "string" },
+        "sent_at": { "type": "string" }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "type": "sms",
+                "enabled": true,
+                "sms_receiver": "${new.receiver}",
+                "sms_content": "${new.content}",
+                "sms_subject": "${new.subject}"
+            }
+        ]
+    }
+}

package/template/entities/System/Notification/sms_verification.json

@@ -0,0 +1,40 @@
+{
+    "name": "sms_verification",
+    "description": "SMS 인증번호 검증 엔티티. 인증번호 SHA-256 해시 저장, 시도 횟수 관리. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "license_scope": false,
+    "hard_delete": true,
+    "history": false,
+    "index": {
+        "phone": {
+            "comment": "수신 전화번호",
+            "type": "varchar(20)",
+            "required": true
+        },
+        "purpose": {
+            "comment": "인증 목적",
+            "type": ["signup", "password_reset", "identity"],
+            "required": true
+        },
+        "status": {
+            "type": ["pending", "verified", "expired"],
+            "default": "pending",
+            "required": true
+        }
+    },
+    "fields": {
+        "code_hash": {
+            "type": "varchar(64)",
+            "required": true,
+            "comment": "인증번호 SHA-256 해시"
+        },
+        "expires_at": {
+            "required": true,
+            "comment": "만료 시각"
+        },
+        "attempts": {
+            "type": "uint",
+            "default": 0,
+            "comment": "검증 시도 횟수"
+        }
+    }
+}

package/template/entities/System/Payment/pg_cancel.json

@@ -0,0 +1,45 @@
+{
+    "name": "pg_cancel",
+    "description": "PG 결제 취소 이력 엔티티. 부분/전액 취소를 기록합니다. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "read_only": true,
+    "index": {
+        "order_seq": {
+            "type": "integer",
+            "required": true,
+            "comment": "pg_order.seq 참조"
+        },
+        "order_id": {
+            "type": "string",
+            "required": true,
+            "comment": "주문번호 (조회 편의)"
+        },
+        "cancel_amount": {
+            "type": "integer",
+            "required": true,
+            "comment": "취소 금액"
+        },
+        "cancel_reason": {
+            "type": "string",
+            "required": true,
+            "comment": "취소 사유 (최대 200자)"
+        },
+        "cancel_status": {
+            "type": ["done", "failed"],
+            "default": "done",
+            "comment": "취소 처리 상태"
+        },
+        "transaction_key": {
+            "type": "string",
+            "comment": "PG사 취소 거래 키"
+        }
+    },
+    "fields": {
+        "canceled_time": { "comment": "취소 시각 (ISO 8601)" },
+        "refundable_amount": { "comment": "취소 후 환불 가능 잔액" },
+        "tax_free_amount": { "comment": "취소된 금액 중 면세 금액" },
+        "receipt_key": { "comment": "현금영수증 키 (해당 시)" },
+        "refund_account": {
+            "comment": "환불 계좌 정보 JSON (가상계좌 취소 시)"
+        }
+    }
+}

package/template/entities/System/Payment/pg_order.json

@@ -0,0 +1,88 @@
+{
+    "name": "pg_order",
+    "description": "PG 결제 주문 엔티티. 결제 요청/승인/취소 상태를 추적합니다. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "index": {
+        "order_id": {
+            "type": "string",
+            "required": true,
+            "unique": true,
+            "comment": "고유 주문번호 (6~64자, [a-zA-Z0-9_-])"
+        },
+        "status": {
+            "type": [
+                "created",
+                "ready",
+                "in_progress",
+                "waiting",
+                "done",
+                "canceled",
+                "partial_canceled",
+                "aborted",
+                "expired"
+            ],
+            "default": "created",
+            "comment": "결제 상태"
+        },
+        "payment_key": {
+            "type": "string",
+            "comment": "PG사 결제 키 (승인 후 할당)"
+        },
+        "provider": {
+            "type": "string",
+            "required": true,
+            "comment": "PG 프로바이더 키 (toss_payments, kcp, inicis 등)"
+        },
+        "method": {
+            "type": "string",
+            "comment": "결제수단 (card, virtual_account, transfer, phone, easy_pay)"
+        },
+        "amount": {
+            "type": "integer",
+            "required": true,
+            "comment": "총 결제 금액 (원)"
+        },
+        "balance_amount": {
+            "type": "integer",
+            "comment": "취소 가능 잔액"
+        },
+        "currency": {
+            "type": "string",
+            "default": "KRW",
+            "comment": "통화 코드 (ISO 4217)"
+        },
+        "account_seq": {
+            "type": "integer",
+            "comment": "구매자 계정 seq (로그인 사용자)"
+        },
+        "customer_name": {
+            "type": "string",
+            "comment": "구매자명"
+        },
+        "customer_email": {
+            "type": "string",
+            "comment": "구매자 이메일"
+        }
+    },
+    "fields": {
+        "order_name": { "comment": "주문 상품명 (예: '토스 티셔츠 외 2건')" },
+        "requested_time": { "comment": "결제 요청 시각 (ISO 8601)" },
+        "approved_time": { "comment": "결제 승인 시각 (ISO 8601)" },
+        "card_info": {
+            "comment": "카드 결제 정보 JSON (마스킹된 카드번호, 카드타입 등)"
+        },
+        "virtual_account_info": {
+            "comment": "가상계좌 정보 JSON (계좌번호, 은행, 입금기한)"
+        },
+        "easy_pay_info": {
+            "comment": "간편결제 정보 JSON (provider, amount, discountAmount)"
+        },
+        "receipt_url": { "comment": "영수증 URL" },
+        "checkout_url": { "comment": "결제창 URL" },
+        "failure_code": { "comment": "실패 에러 코드" },
+        "failure_message": { "comment": "실패 에러 메시지" },
+        "metadata": {
+            "comment": "상점 커스텀 데이터 JSON (최대 5개 key-value)"
+        },
+        "pg_raw_response": { "comment": "PG사 원본 응답 JSON (디버깅용)" }
+    }
+}

package/template/entities/System/Payment/pg_webhook_log.json

@@ -0,0 +1,37 @@
+{
+    "name": "pg_webhook_log",
+    "description": "PG 웹훅 수신 이력. 모든 수신 이벤트를 기록합니다. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "hard_delete": true,
+    "read_only": true,
+    "compress": true,
+    "index": {
+        "event_type": {
+            "type": "string",
+            "required": true,
+            "comment": "웹훅 이벤트 타입 (payment.done, payment.canceled 등)"
+        },
+        "order_id": {
+            "type": "string",
+            "comment": "관련 주문번호"
+        },
+        "payment_key": {
+            "type": "string",
+            "comment": "관련 결제 키"
+        },
+        "status": {
+            "type": ["received", "processed", "failed"],
+            "default": "received",
+            "comment": "웹훅 처리 상태"
+        },
+        "provider": {
+            "type": "string",
+            "comment": "PG 프로바이더 키"
+        }
+    },
+    "fields": {
+        "payload": { "comment": "수신한 웹훅 원본 JSON" },
+        "processed_time": { "comment": "처리 완료 시각" },
+        "error_message": { "comment": "처리 실패 시 에러 메시지" },
+        "signature": { "comment": "웹훅 서명값 (검증용)" }
+    }
+}

package/template/entities/System/Push/push_log.json

@@ -0,0 +1,71 @@
+{
+    "name": "push_log",
+    "description": "푸시 알림 발송 이력. 발송 결과 추적 및 재시도 관리용. account_seq(JWT) 또는 device_id(HMAC) 중 하나 존재. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "license_scope": false,
+    "hard_delete": true,
+    "history_ttl": 30,
+    "compress": true,
+    "index": {
+        "account_seq": {
+            "comment": "수신자 account seq (JWT 인증 시. nullable)"
+        },
+        "attempt_time": {
+            "comment": "처리 시작(claim) 시각 — 비정상 종료 감지용"
+        },
+        "body": {
+            "comment": "알림 본문"
+        },
+        "device_id": {
+            "comment": "대상 디바이스 ID (HMAC 인증 시. nullable)",
+            "type": "varchar(255)"
+        },
+        "device_seq": {
+            "comment": "대상 디바이스 seq (account_device.seq)"
+        },
+        "device_token": {
+            "comment": "발송 시점 디바이스 토큰 스냅샷 (FCM registration token 또는 APNs device token)"
+        },
+        "error_message": {
+            "comment": "실패 시 오류 메시지",
+            "type": "varchar(500)"
+        },
+        "platform": {
+            "comment": "발송 채널",
+            "type": ["fcm", "apns", "web"]
+        },
+        "push_data": {
+            "comment": "커스텀 페이로드 JSON 문자열",
+            "type": "varchar(2000)"
+        },
+        "ref_entity": {
+            "comment": "트리거 엔티티명"
+        },
+        "ref_seq": {
+            "comment": "트리거 레코드 seq"
+        },
+        "retry_count": {
+            "comment": "재시도 횟수",
+            "type": "uint",
+            "default": 0
+        },
+        "sent_time": {
+            "comment": "발송 완료 시각"
+        },
+        "status": {
+            "comment": "발송 상태",
+            "type": [
+                "pending",
+                "processing",
+                "sent",
+                "delivered",
+                "failed",
+                "expired"
+            ],
+            "default": "pending",
+            "required": true
+        },
+        "title": {
+            "comment": "알림 제목"
+        }
+    }
+}

package/template/entities/System/Push/push_msg.json

@@ -0,0 +1,55 @@
+{
+    "name": "push_msg",
+    "description": "시스템 푸시 트리거 엔티티. insert 시 push hook로 비동기 발송. account_seq(JWT) 또는 device_id(HMAC) 중 하나 필수. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "index": {
+        "account_seq": {
+            "comment": "수신자 account seq (JWT 인증 시 필수. HMAC 인증은 device_id 사용)",
+            "required": true
+        },
+        "device_id": {
+            "comment": "대상 디바이스 ID (HMAC 인증 시. 기기단위로 account 없이 푸시 발송)",
+            "type": "varchar(255)"
+        },
+        "title": {
+            "comment": "푸시 제목",
+            "required": true
+        }
+    },
+    "fields": {
+        "message": {
+            "comment": "푸시 본문",
+            "nullable": true
+        },
+        "ref_entity": {
+            "comment": "참조 엔티티명",
+            "nullable": true
+        },
+        "ref_seq": {
+            "comment": "참조 레코드 seq",
+            "nullable": true
+        },
+        "msg_data": {
+            "comment": "추가 데이터(JSON 문자열)",
+            "type": "varchar(2000)",
+            "nullable": true
+        }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "type": "push",
+                "target_account_seq": "account_seq",
+                "target_device_id": "device_id",
+                "comment": "account_seq 있으면 계정 기반 발송, 없으면 device_id 기반 발송",
+                "title": "${new.title}",
+                "push_body": "${new.message}",
+                "push_data": {
+                    "push_msg_seq": "${new.seq}",
+                    "ref_entity": "${new.ref_entity}",
+                    "ref_seq": "${new.ref_seq}",
+                    "msg_data": "${new.msg_data}"
+                }
+            }
+        ]
+    }
+}

package/template/entities/System/Storage/file_backup_log.json

@@ -0,0 +1,46 @@
+{
+    "name": "file_backup_log",
+    "description": "파일 백업 작업 로그. 스토리지 간 백업 동기화 이력을 기록합니다. 서버 내부 백업 고루틴이 자동 기록. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "license_scope": false,
+    "history": false,
+    "hard_delete": true,
+    "read_only": true,
+    "compress": true,
+    "index": {
+        "started_time": {
+            "comment": "백업 작업 시작 시각"
+        },
+        "status": {
+            "comment": "작업 상태",
+            "type": ["running", "completed", "partial", "failed"],
+            "default": "running",
+            "required": true
+        }
+    },
+    "fields": {
+        "error_count": {
+            "comment": "실패 파일 수"
+        },
+        "error_message": {
+            "comment": "실패 시 오류 메시지 요약"
+        },
+        "exec_instance": {
+            "comment": "작업을 실행한 서버 인스턴스 식별자 (hostname 등)"
+        },
+        "file_count": {
+            "comment": "처리된 파일 수"
+        },
+        "finished_time": {
+            "comment": "백업 작업 완료 시각"
+        },
+        "source_key": {
+            "comment": "원본 스토리지 키 (storage.json storages 맵의 키)"
+        },
+        "target_key": {
+            "comment": "백업 대상 스토리지 키"
+        },
+        "total_bytes": {
+            "comment": "전송된 총 바이트 수"
+        }
+    }
+}

package/template/entities/System/Storage/file_download_log.json

@@ -0,0 +1,41 @@
+{
+    "name": "file_download_log",
+    "description": "파일 다운로드 이력. 누가 어떤 파일을 언제 다운로드했는지 기록합니다. 감사(audit) 및 통계 목적. 사용자 환경에 맞게 index·fields를 자유롭게 확장할 수 있습니다.",
+    "hard_delete": true,
+    "history": false,
+    "compress": true,
+    "index": {
+        "account_seq": {
+            "comment": "다운로드한 계정 seq. JWT 인증 시 기록, 비인증은 NULL"
+        },
+        "downloaded_time": {
+            "comment": "다운로드 시각"
+        },
+        "entity_name": {
+            "comment": "파일이 속한 엔티티 이름"
+        },
+        "file_seq": {
+            "comment": "다운로드한 file_meta seq",
+            "required": true
+        }
+    },
+    "fields": {
+        "ip": {
+            "comment": "요청 IP 주소 (IPv4/IPv6)",
+            "type": "varchar(45)"
+        },
+        "thumb": {
+            "comment": "썸네일 요청 시 사이즈 (sm, md, lg). 원본 다운로드는 NULL",
+            "type": "varchar(10)"
+        },
+        "user_agent": {
+            "comment": "요청 User-Agent 헤더",
+            "type": "varchar(500)"
+        }
+    },
+    "fk": {
+        "account_seq": false,
+        "file_seq": false
+    },
+    "read_only": true
+}