create-entity-server 0.0.9 → 0.0.23

package/template/samples/entities/05_cache.json

@@ -0,0 +1,55 @@
+{
+    "name": "config_item",
+    "description": "캐시 예제 — 자주 읽히고 드물게 변경되는 설정값에 엔티티 레벨 캐시 활성화",
+    "index": {
+        "key": {
+            "comment": "설정 키 (고유)",
+            "required": true,
+            "unique": true
+        },
+        "category": {
+            "comment": "설정 카테고리",
+            "type": ["system", "ui", "feature_flag", "notification"],
+            "default": "system"
+        },
+        "is_public": {
+            "comment": "공개 여부 (is_* → TINYINT(1) 자동 추론)"
+        }
+    },
+    "cache": {
+        "enabled": true,
+        "ttl_seconds": 600
+    },
+    "fields": {
+        "value": {
+            "comment": "설정 값 (문자열 저장, 타입은 애플리케이션에서 해석)",
+            "required": true
+        },
+        "description": {
+            "comment": "설정 항목 설명"
+        }
+    },
+    "reset_defaults": [
+        {
+            "key": "site.name",
+            "category": "system",
+            "value": "My Service",
+            "is_public": true,
+            "description": "서비스명"
+        },
+        {
+            "key": "feature.dark_mode",
+            "category": "feature_flag",
+            "value": "true",
+            "is_public": true,
+            "description": "다크모드 기능 활성화"
+        },
+        {
+            "key": "notification.email_enabled",
+            "category": "notification",
+            "value": "true",
+            "is_public": false,
+            "description": "이메일 알림 활성화"
+        }
+    ]
+}

package/template/samples/entities/06_history_and_hard_delete.json

@@ -0,0 +1,60 @@
+{
+    "name": "article",
+    "description": "이력 보존(history_ttl) & 완전삭제(hard_delete) 예제 — 게시글 수정 이력 3년 보관",
+    "index": {
+        "author_seq": {
+            "comment": "작성자 user seq",
+            "required": true
+        },
+        "title": {
+            "comment": "제목",
+            "required": true
+        },
+        "category": {
+            "comment": "카테고리",
+            "type": ["notice", "blog", "faq", "news"],
+            "default": "blog"
+        },
+        "status": {
+            "comment": "게시 상태",
+            "type": ["draft", "published", "archived"],
+            "default": "draft"
+        },
+        "published_at": {
+            "comment": "게시일시 (*_at → DATETIME 자동 추론)"
+        },
+        "view_count": {
+            "comment": "조회 수 (*_count → INT 자동 추론)"
+        }
+    },
+    "fields": {
+        "content": {
+            "type": "longtext",
+            "comment": "게시글 본문",
+            "required": true
+        },
+        "summary": {
+            "type": "text",
+            "comment": "요약 (없으면 본문 앞 200자 자동 생성)"
+        },
+        "meta": {
+            "comment": "SEO / 부가 메타데이터 그룹 (중첩 fields 예제)",
+            "fields": {
+                "og_title": {
+                    "type": "varchar(200)",
+                    "comment": "OG 제목 (미입력 시 title 사용)"
+                },
+                "og_image_url": {
+                    "type": "varchar(500)",
+                    "comment": "OG 이미지 URL"
+                },
+                "tags_json": {
+                    "type": "json",
+                    "comment": "태그 목록 (JSON 배열)"
+                }
+            }
+        }
+    },
+    "history_ttl": 1095,
+    "hard_delete": false
+}

package/template/samples/entities/07_license_scope.json

@@ -0,0 +1,52 @@
+{
+    "name": "exchange_rate",
+    "description": "license_scope: false 예제 — 전 라이선스 공용 기준 데이터 (환율). license_seq 컬럼 없이 모든 테넌트가 동일 데이터 공유",
+    "license_scope": false,
+    "index": {
+        "base_currency": {
+            "comment": "기준 통화 (ISO 4217)",
+            "type": "varchar(3)",
+            "required": true
+        },
+        "quote_currency": {
+            "comment": "환산 통화 (ISO 4217)",
+            "type": "varchar(3)",
+            "required": true
+        },
+        "rate": {
+            "comment": "환산 비율 (*_rate → 자동추론 없음, decimal 명시)",
+            "type": "decimal",
+            "required": true
+        },
+        "effective_date": {
+            "comment": "적용일 (*_date → DATE 자동 추론)",
+            "required": true
+        },
+        "source": {
+            "comment": "환율 출처",
+            "type": ["ecb", "openexchangerates", "manual"],
+            "default": "manual"
+        }
+    },
+    "cache": {
+        "enabled": true,
+        "ttl_seconds": 3600
+    },
+    "unique": [["base_currency", "quote_currency", "effective_date"]],
+    "reset_defaults": [
+        {
+            "base_currency": "USD",
+            "quote_currency": "KRW",
+            "rate": 1350.0,
+            "effective_date": "2025-01-01",
+            "source": "manual"
+        },
+        {
+            "base_currency": "EUR",
+            "quote_currency": "KRW",
+            "rate": 1480.0,
+            "effective_date": "2025-01-01",
+            "source": "manual"
+        }
+    ]
+}

package/template/samples/entities/08_hook_sql.json

@@ -0,0 +1,52 @@
+{
+    "name": "user_point",
+    "description": "SQL 훅 예제 — INSERT/UPDATE 시 자동 감사 로그 기록 (실행형) + SELECT 결과 주입 (조회형)",
+    "index": {
+        "user_seq": {
+            "comment": "사용자 seq",
+            "required": true,
+            "unique": true
+        },
+        "point": {
+            "comment": "보유 포인트",
+            "type": "uint"
+        },
+        "grade": {
+            "comment": "등급",
+            "type": ["bronze", "silver", "gold", "platinum"],
+            "default": "bronze"
+        },
+        "updated_at": {
+            "comment": "마지막 포인트 변경일시 (*_at → DATETIME 자동 추론)"
+        }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "comment": "포인트 생성 이력 기록 (실행형 SQL 훅)",
+                "type": "sql",
+                "query": "INSERT INTO point_history (user_seq, delta, reason, created_time) VALUES (?, ?, ?, NOW())",
+                "params": ["${new.user_seq}", "${new.point}", "initial_grant"],
+                "async": false
+            }
+        ],
+        "after_update": [
+            {
+                "comment": "포인트 변경 이력 기록 (실행형 SQL 훅)",
+                "type": "sql",
+                "query": "INSERT INTO point_history (user_seq, delta, reason, created_time) VALUES (?, ?, ?, NOW())",
+                "params": ["${new.user_seq}", "${new.point}", "update"],
+                "async": true
+            }
+        ],
+        "after_get": [
+            {
+                "comment": "최근 포인트 변경 이력 5건 주입 (조회형 SQL 훅)",
+                "type": "sql",
+                "query": "SELECT delta, reason, created_time FROM point_history WHERE user_seq = ? ORDER BY created_time DESC LIMIT 5",
+                "params": ["${new.user_seq}"],
+                "assign_to": "recent_history"
+            }
+        ]
+    }
+}

package/template/samples/entities/09_hook_entity.json

@@ -0,0 +1,65 @@
+{
+    "name": "post",
+    "description": "entity 훅 예제 — after_get/after_list 시 관련 엔티티 데이터를 자동 주입",
+    "index": {
+        "author_seq": {
+            "comment": "작성자 user seq",
+            "required": true
+        },
+        "title": {
+            "comment": "제목",
+            "required": true
+        },
+        "status": {
+            "comment": "상태",
+            "type": ["draft", "published", "hidden"],
+            "default": "draft"
+        },
+        "comment_count": {
+            "comment": "댓글 수 (*_count → INT 자동 추론)"
+        },
+        "like_count": {
+            "comment": "좋아요 수 (*_count → INT 자동 추론)"
+        },
+        "published_at": {
+            "comment": "게시일시 (*_at → DATETIME 자동 추론)"
+        }
+    },
+    "hooks": {
+        "after_get": [
+            {
+                "comment": "게시글 조회 시 작성자 프로필 자동 주입",
+                "type": "entity",
+                "entity": "user",
+                "action": "get",
+                "conditions": {
+                    "seq": "${new.author_seq}"
+                },
+                "assign_to": "author"
+            },
+            {
+                "comment": "게시글 조회 시 최근 댓글 10개 자동 주입",
+                "type": "entity",
+                "entity": "comment",
+                "action": "list",
+                "conditions": {
+                    "post_seq": "${new.seq}",
+                    "status": "visible"
+                },
+                "assign_to": "comments"
+            }
+        ],
+        "after_list": [
+            {
+                "comment": "목록 조회 시 각 게시글에 작성자 이름 주입",
+                "type": "entity",
+                "entity": "user",
+                "action": "get",
+                "conditions": {
+                    "seq": "${new.author_seq}"
+                },
+                "assign_to": "author"
+            }
+        ]
+    }
+}

package/template/samples/entities/10_hook_submit_delete.json

@@ -0,0 +1,78 @@
+{
+    "name": "project",
+    "description": "submit & delete 훅 예제 — 프로젝트 생성 시 기본 태스크 자동 생성, 삭제 시 연관 데이터 정리",
+    "index": {
+        "owner_seq": {
+            "comment": "프로젝트 소유자 user seq",
+            "required": true
+        },
+        "name": {
+            "comment": "프로젝트명",
+            "required": true
+        },
+        "status": {
+            "comment": "진행 상태",
+            "type": ["planning", "active", "on_hold", "completed", "cancelled"],
+            "default": "planning"
+        },
+        "due_date": {
+            "comment": "마감일 (*_date → DATE 자동 추론)"
+        },
+        "task_count": {
+            "comment": "태스크 수 (*_count → INT 자동 추론)"
+        }
+    },
+    "fields": {
+        "description": {
+            "type": "text",
+            "comment": "프로젝트 설명"
+        }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "comment": "프로젝트 생성 시 기본 태스크 3개 자동 생성 (submit 훅)",
+                "type": "submit",
+                "entity": "task",
+                "data": {
+                    "project_seq": "${new.seq}",
+                    "title": "요구사항 분석",
+                    "status": "todo",
+                    "priority": "high"
+                }
+            },
+            {
+                "comment": "프로젝트 멤버에 소유자 자동 추가 (submit 훅 Upsert)",
+                "type": "submit",
+                "entity": "project_member",
+                "match": {
+                    "project_seq": "${new.seq}",
+                    "user_seq": "${new.owner_seq}"
+                },
+                "data": {
+                    "project_seq": "${new.seq}",
+                    "user_seq": "${new.owner_seq}",
+                    "role": "owner"
+                }
+            }
+        ],
+        "after_delete": [
+            {
+                "comment": "프로젝트 삭제 시 모든 태스크 삭제 (delete 훅)",
+                "type": "delete",
+                "entity": "task",
+                "match": {
+                    "project_seq": "${old.seq}"
+                }
+            },
+            {
+                "comment": "프로젝트 삭제 시 멤버 목록 삭제 (delete 훅)",
+                "type": "delete",
+                "entity": "project_member",
+                "match": {
+                    "project_seq": "${old.seq}"
+                }
+            }
+        ]
+    }
+}

package/template/samples/entities/11_hook_webhook.json

@@ -0,0 +1,84 @@
+{
+    "name": "payment",
+    "description": "webhook 훅 예제 — 결제 완료/환불 시 외부 정산 서비스 실시간 통보",
+    "index": {
+        "order_seq": {
+            "comment": "주문 seq",
+            "required": true
+        },
+        "user_seq": {
+            "comment": "결제자 user seq",
+            "required": true
+        },
+        "amount": {
+            "comment": "결제 금액 (*_amount → DECIMAL(15,2) 자동 추론)",
+            "required": true
+        },
+        "method": {
+            "comment": "결제 수단",
+            "type": ["card", "bank_transfer", "virtual_account", "point"],
+            "required": true
+        },
+        "status": {
+            "comment": "결제 상태",
+            "type": ["pending", "paid", "cancelled", "refunded"],
+            "default": "pending"
+        },
+        "paid_at": {
+            "comment": "결제 완료일시 (*_at → DATETIME 자동 추론)"
+        }
+    },
+    "fields": {
+        "pg_transaction_id": {
+            "type": "varchar(100)",
+            "comment": "PG사 거래 ID"
+        },
+        "failure_reason": {
+            "type": "text",
+            "comment": "결제 실패 사유"
+        }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "comment": "결제 생성 시 정산 서버로 비동기 통보 (webhook 훅)",
+                "type": "webhook",
+                "url": "https://settlement.internal/hooks/payment-created",
+                "method": "POST",
+                "headers": {
+                    "Authorization": "Bearer ${ctx.webhook_secret}",
+                    "Content-Type": "application/json"
+                },
+                "body": {
+                    "payment_seq": "${new.seq}",
+                    "order_seq": "${new.order_seq}",
+                    "user_seq": "${new.user_seq}",
+                    "amount": "${new.amount}",
+                    "method": "${new.method}",
+                    "status": "${new.status}"
+                },
+                "async": true,
+                "timeout": 5000
+            }
+        ],
+        "after_update": [
+            {
+                "comment": "결제 상태 변경(환불 등) 시 정산 서버에 동기 통보 (webhook 훅)",
+                "type": "webhook",
+                "url": "https://settlement.internal/hooks/payment-updated",
+                "method": "POST",
+                "headers": {
+                    "Authorization": "Bearer ${ctx.webhook_secret}"
+                },
+                "body": {
+                    "payment_seq": "${new.seq}",
+                    "old_status": "${old.status}",
+                    "new_status": "${new.status}",
+                    "amount": "${new.amount}"
+                },
+                "async": false,
+                "timeout": 8000
+            }
+        ]
+    }
+}

package/template/samples/entities/12_hook_push.json

@@ -0,0 +1,73 @@
+{
+    "name": "delivery",
+    "description": "push 훅 예제 — 배송 상태 변경 시 고객에게 푸시 알림 전송 (FCM / APNs 공통, 다단계 상태 알림)",
+    "index": {
+        "order_seq": {
+            "comment": "주문 seq",
+            "required": true
+        },
+        "customer_seq": {
+            "comment": "고객 user seq",
+            "required": true
+        },
+        "tracking_number": {
+            "comment": "운송장 번호",
+            "unique": true
+        },
+        "carrier": {
+            "comment": "택배사",
+            "type": ["cj", "lotte", "hanjin", "post", "direct"],
+            "default": "cj"
+        },
+        "status": {
+            "comment": "배송 상태",
+            "type": [
+                "ready",
+                "picked_up",
+                "in_transit",
+                "out_for_delivery",
+                "delivered",
+                "failed"
+            ],
+            "default": "ready"
+        },
+        "estimated_date": {
+            "comment": "예상 도착일 (*_date → DATE 자동 추론)"
+        },
+        "delivered_at": {
+            "comment": "배송 완료일시 (*_at → DATETIME 자동 추론)"
+        }
+    },
+    "hooks": {
+        "after_insert": [
+            {
+                "comment": "배송 시작 푸시 알림",
+                "type": "push",
+                "target_account_seq": "customer_seq",
+                "title": "배송 시작",
+                "push_body": "주문 #${new.order_seq}의 배송이 시작되었습니다. 운송장: ${new.tracking_number}",
+                "push_data": {
+                    "action": "delivery_started",
+                    "delivery_seq": "${new.seq}",
+                    "tracking_number": "${new.tracking_number}"
+                }
+            }
+        ],
+        "after_update": [
+            {
+                "comment": "배송 상태 변경 시 푸시 알림",
+                "type": "push",
+                "target_account_seq": "customer_seq",
+                "title": "배송 상태 업데이트",
+                "push_body": "배송 상태가 '${new.status}'(으)로 변경되었습니다. 운송장: ${new.tracking_number}",
+                "push_data": {
+                    "action": "delivery_status_changed",
+                    "delivery_seq": "${new.seq}",
+                    "old_status": "${old.status}",
+                    "new_status": "${new.status}",
+                    "tracking_number": "${new.tracking_number}"
+                }
+            }
+        ]
+    }
+}

package/template/samples/entities/13_read_only.json

@@ -0,0 +1,54 @@
+{
+    "name": "activity_log",
+    "description": "read_only 예제 — API를 통한 수정·삭제가 불가하고 서버 내부(훅/SP) 로만 기록되는 감사 로그",
+    "read_only": true,
+    "hard_delete": true,
+    "history_ttl": 0,
+    "index": {
+        "actor_seq": {
+            "comment": "행위자 user seq (null = 시스템)"
+        },
+        "entity_name": {
+            "comment": "대상 엔티티명",
+            "required": true
+        },
+        "entity_seq": {
+            "comment": "대상 레코드 seq"
+        },
+        "action": {
+            "comment": "수행된 작업",
+            "type": [
+                "INSERT",
+                "UPDATE",
+                "DELETE",
+                "LOGIN",
+                "LOGOUT",
+                "EXPORT",
+                "IMPORT"
+            ],
+            "required": true
+        },
+        "ip_address": {
+            "comment": "요청 IP",
+            "type": "varchar(45)"
+        },
+        "result_code": {
+            "comment": "결과 코드 (HTTP 상태)",
+            "type": "int"
+        }
+    },
+    "fields": {
+        "before_snapshot": {
+            "type": "json",
+            "comment": "변경 전 데이터 스냅샷"
+        },
+        "after_snapshot": {
+            "type": "json",
+            "comment": "변경 후 데이터 스냅샷"
+        },
+        "detail": {
+            "type": "text",
+            "comment": "작업 상세 설명"
+        }
+    }
+}

package/template/samples/entities/14_optimistic_lock.json

@@ -0,0 +1,29 @@
+{
+    "name": "inventory",
+    "description": "optimistic_lock 예제 — 동시 수정 충돌 방지가 필요한 재고 엔티티",
+    "optimistic_lock": true,
+    "index": {
+        "product_seq": {
+            "comment": "상품 seq",
+            "required": true,
+            "unique": true
+        },
+        "warehouse_code": {
+            "comment": "창고 코드",
+            "required": true
+        },
+        "qty_available": {
+            "comment": "가용 재고 수량 (*_qty → INT 자동 추론)"
+        },
+        "qty_reserved": {
+            "comment": "예약된 재고 수량 (*_qty → INT 자동 추론)"
+        },
+        "location": {
+            "comment": "창고 내 위치 (예: A-01-03)"
+        },
+        "last_stocked_at": {
+            "comment": "마지막 입고일시 (*_at → DATETIME 자동 추론)"
+        }
+    },
+    "unique": [["product_seq", "warehouse_code"]]
+}