create-entity-app-server 0.0.3

package/src/app/routes/example-es/handlers.ts

@@ -0,0 +1,216 @@
+/**
+ * Entity Server Example 핸들러 — entityServer 클라이언트 사용 예제
+ *
+ * 이 파일은 Gateway에서 Entity Server에 접속하여 엔티티 CRUD를 수행하는 방법을 보여줍니다.
+ * entityServer 는 @gateway/api 에서 import 하며 Entity Server의 REST API를 호출합니다.
+ *
+ * ⚠ 주의: .env 에 ENTITY_SERVER_URL, ENTITY_API_KEY 이 설정되어 있어야 합니다.
+ *   사용하는 엔티티(예: "post")는 entities/ 폴더에 JSON 정의가 필요합니다.
+ */
+
+import type { FastifyRequest, FastifyReply } from "fastify";
+import { ok, fail, entityServer, NotFoundError } from "@gateway/api";
+import type {
+    CreatePostBody,
+    UpdatePostBody,
+    SeqParams,
+    SearchPostsQuery,
+    HistoryQuery,
+} from "./types/index.ts";
+
+// 엔티티 이름 — entities/post.json 에 정의된 엔티티
+const ENTITY = "post";
+
+// ─────────────────────────────────────────────────
+// 기본 CRUD 예제
+// ─────────────────────────────────────────────────
+
+/**
+ * GET /example-es/posts?page=1&limit=20
+ * 게시글 목록 조회 (list)
+ */
+export async function listPosts(
+    req: FastifyRequest<{ Querystring: SearchPostsQuery }>,
+    reply: FastifyReply,
+) {
+    const { page = 1, limit = 20, orderBy, orderDir } = req.query;
+
+    const resp = await entityServer.list(ENTITY, {
+        page,
+        limit,
+        orderBy,
+        orderDir,
+    });
+
+    return reply.send(ok(resp.data));
+}
+
+/**
+ * GET /example-es/posts/:seq
+ * 게시글 단건 조회 (get)
+ */
+export async function getPost(
+    req: FastifyRequest<{ Params: SeqParams }>,
+    reply: FastifyReply,
+) {
+    const seq = Number(req.params.seq);
+
+    const resp = await entityServer.get(ENTITY, seq);
+    if (!resp.data) {
+        throw new NotFoundError(`Post ${seq} not found`);
+    }
+
+    return reply.send(ok(resp.data));
+}
+
+/**
+ * POST /example-es/posts
+ * 게시글 생성 (submit — seq 없으면 INSERT)
+ */
+export async function createPost(
+    req: FastifyRequest<{ Body: CreatePostBody }>,
+    reply: FastifyReply,
+) {
+    const { title, content, category = "general" } = req.body;
+
+    const resp = await entityServer.submit(ENTITY, {
+        title,
+        content,
+        category,
+        status: "draft",
+    });
+
+    return reply.code(201).send(ok({ seq: resp.seq }));
+}
+
+/**
+ * PUT /example-es/posts/:seq
+ * 게시글 수정 (submit — seq 있으면 UPDATE)
+ */
+export async function updatePost(
+    req: FastifyRequest<{ Params: SeqParams; Body: UpdatePostBody }>,
+    reply: FastifyReply,
+) {
+    const seq = Number(req.params.seq);
+    const updates = req.body;
+
+    const resp = await entityServer.submit(ENTITY, {
+        seq,
+        ...updates,
+    });
+
+    return reply.send(ok({ seq: resp.seq }));
+}
+
+/**
+ * DELETE /example-es/posts/:seq
+ * 게시글 삭제 (soft delete)
+ */
+export async function deletePost(
+    req: FastifyRequest<{ Params: SeqParams }>,
+    reply: FastifyReply,
+) {
+    const seq = Number(req.params.seq);
+
+    const resp = await entityServer.delete(ENTITY, seq);
+
+    return reply.send(ok({ deleted: resp.deleted }));
+}
+
+// ─────────────────────────────────────────────────
+// 고급 예제
+// ─────────────────────────────────────────────────
+
+/**
+ * GET /example-es/posts/search?q=keyword&category=tech&status=published
+ * 게시글 검색 (query — 조건 기반 검색)
+ */
+export async function searchPosts(
+    req: FastifyRequest<{ Querystring: SearchPostsQuery }>,
+    reply: FastifyReply,
+) {
+    const { q, category, status, page = 1, limit = 20 } = req.query;
+
+    // conditions 동적 구성
+    const conditions: Record<string, unknown> = {};
+    if (category) conditions.category = category;
+    if (status) conditions.status = status;
+    if (q) conditions.title = q; // title 필드에서 검색 (엔티티 인덱스 필드)
+
+    const resp = await entityServer.list(ENTITY, {
+        page,
+        limit,
+        conditions,
+    });
+
+    if (resp.data.items.length === 0) {
+        return reply.send(fail("No posts found"));
+    }
+
+    return reply.send(ok(resp.data));
+}
+
+/**
+ * POST /example-es/posts/:seq/publish
+ * 게시글 발행 — 트랜잭션 예제
+ *
+ * 게시글 상태를 published로 변경하고,
+ * publish_log 엔티티에 발행 기록을 남기는 것을 하나의 트랜잭션으로 처리합니다.
+ */
+export async function publishPost(
+    req: FastifyRequest<{ Params: SeqParams }>,
+    reply: FastifyReply,
+) {
+    const seq = Number(req.params.seq);
+
+    // 트랜잭션 시작
+    const txId = await entityServer.transStart();
+
+    try {
+        // 1) 게시글 상태 변경
+        await entityServer.submit(
+            ENTITY,
+            {
+                seq,
+                status: "published",
+                published_time: new Date().toISOString(),
+            },
+            { transactionId: txId },
+        );
+
+        // 2) 발행 로그 기록 (publish_log 엔티티가 있다고 가정)
+        await entityServer.submit(
+            "publish_log",
+            {
+                post_seq: seq,
+                action: "publish",
+                created_time: new Date().toISOString(),
+            },
+            { transactionId: txId },
+        );
+
+        // 커밋
+        const result = await entityServer.transCommit(txId);
+        return reply.send(ok({ published: true, results: result.results }));
+    } catch (err) {
+        // 롤백
+        await entityServer.transRollback(txId).catch(() => {});
+        throw err;
+    }
+}
+
+/**
+ * GET /example-es/posts/:seq/history?page=1&limit=10
+ * 게시글 변경 이력 조회 (history)
+ */
+export async function getPostHistory(
+    req: FastifyRequest<{ Params: SeqParams; Querystring: HistoryQuery }>,
+    reply: FastifyReply,
+) {
+    const seq = Number(req.params.seq);
+    const { page = 1, limit = 10 } = req.query;
+
+    const resp = await entityServer.history(ENTITY, seq, { page, limit });
+
+    return reply.send(ok(resp.data));
+}

package/src/app/routes/example-es/routes.ts

@@ -0,0 +1,24 @@
+/**
+ * Entity Server Example 라우트 테이블
+ * 등록 경로: /api/v1/example-es/*
+ *
+ * entityServer 클라이언트를 사용한 Entity Server CRUD 예제입니다.
+ * 실제 프로젝트에서는 이 폴더를 복사하여 새 라우트를 만들 수 있습니다.
+ */
+
+import type { FastifyInstance } from "fastify";
+import * as h from "./handlers.ts";
+
+export default async function esExampleRoutes(app: FastifyInstance) {
+    // ── 기본 CRUD ──────────────────────────────
+    app.get("/posts", h.listPosts);
+    app.get("/posts/:seq", h.getPost);
+    app.post("/posts", h.createPost);
+    app.put("/posts/:seq", h.updatePost);
+    app.delete("/posts/:seq", h.deletePost);
+
+    // ── 고급: 검색, 트랜잭션, 이력 ─────────────
+    app.get("/posts/search", h.searchPosts);
+    app.post("/posts/:seq/publish", h.publishPost);
+    app.get("/posts/:seq/history", h.getPostHistory);
+}

package/src/app/routes/example-es/types/defaults.ts

@@ -0,0 +1,30 @@
+import type { CreatePostBody, UpdatePostBody } from "./post.ts";
+import type { SearchPostsQuery, HistoryQuery } from "./query.ts";
+
+export const defaultCreatePostBody: CreatePostBody = {
+    title: "",
+    content: "",
+    category: "general",
+};
+
+export const defaultUpdatePostBody: UpdatePostBody = {
+    title: undefined,
+    content: undefined,
+    category: undefined,
+    status: undefined,
+};
+
+export const defaultSearchPostsQuery: SearchPostsQuery = {
+    q: undefined,
+    category: undefined,
+    status: undefined,
+    page: 1,
+    limit: 20,
+    orderBy: undefined,
+    orderDir: "DESC",
+};
+
+export const defaultHistoryQuery: HistoryQuery = {
+    page: 1,
+    limit: 10,
+};

package/src/app/routes/example-es/types/index.ts

@@ -0,0 +1,4 @@
+export type { CreatePostBody, UpdatePostBody } from "./post.ts";
+export type { SeqParams } from "./params.ts";
+export type { SearchPostsQuery, HistoryQuery } from "./query.ts";
+export * from "./defaults.ts";

package/src/app/routes/example-es/types/params.ts

@@ -0,0 +1,3 @@
+export interface SeqParams {
+    seq: string;
+}

package/src/app/routes/example-es/types/post.ts

@@ -0,0 +1,12 @@
+export interface CreatePostBody {
+    title: string;
+    content: string;
+    category?: string;
+}
+
+export interface UpdatePostBody {
+    title?: string;
+    content?: string;
+    category?: string;
+    status?: "draft" | "published";
+}

package/src/app/routes/example-es/types/query.ts

@@ -0,0 +1,14 @@
+export interface SearchPostsQuery {
+    q?: string;
+    category?: string;
+    status?: string;
+    page?: number;
+    limit?: number;
+    orderBy?: string;
+    orderDir?: "ASC" | "DESC";
+}
+
+export interface HistoryQuery {
+    page?: number;
+    limit?: number;
+}

package/src/app/routes/funeral/config.json

@@ -0,0 +1,5 @@
+{
+    "enabled": false,
+    "deploy": false,
+    "minify": false
+}

package/src/app/routes/funeral/entities/funeral.json

@@ -0,0 +1,77 @@
+{
+    "name": "funeral",
+    "description": "funeral 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "isolated": "license",
+    "fields": {
+        "check_in_date": {
+            "index": true,
+            "comment": "입실 일시",
+            "type": "datetime"
+        },
+        "deceased_name": {
+            "index": true,
+            "comment": "고인명",
+            "required": true
+        },
+        "encoffin_date": {
+            "index": true,
+            "comment": "입관 일시",
+            "type": "datetime"
+        },
+        "funeral_date": {
+            "index": true,
+            "comment": "발인 일시",
+            "type": "datetime"
+        },
+        "gender": {
+            "index": true,
+            "comment": "성별",
+            "type": [
+                "남",
+                "여"
+            ]
+        },
+        "religion": {
+            "index": true,
+            "comment": "종교",
+            "type": [
+                "불교",
+                "기독교",
+                "천주교",
+                "원불교",
+                "무교",
+                "기타"
+            ]
+        },
+        "rest_date": {
+            "index": true,
+            "comment": "안치 일시",
+            "type": "datetime"
+        },
+        "status": {
+            "index": true,
+            "comment": "장례 진행 상태",
+            "type": [
+                "waiting",
+                "in_progress",
+                "completed",
+                "cancelled"
+            ],
+            "default": "waiting",
+            "required": true
+        },
+        "age": {
+            "comment": "향년",
+            "type": "int"
+        },
+        "cause_of_death": {
+            "comment": "사망 원인"
+        },
+        "deceased_address": {
+            "comment": "고인 주소"
+        },
+        "room_seq": {
+            "required": true
+        }
+    }
+}

package/src/app/routes/funeral/entities/funeral_docs.json

@@ -0,0 +1,36 @@
+{
+    "name": "funeral_docs",
+    "description": "funeral_docs 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "isolated": "license",
+    "fields": {
+        "funeral_seq": {
+            "index": true,
+            "comment": "장례 seq",
+            "required": true
+        },
+        "has_bus_order": {
+            "index": true,
+            "comment": "버스 주문 확인",
+            "default": false
+        },
+        "has_death_certificate": {
+            "index": true,
+            "comment": "사망진단서 확인",
+            "default": false
+        },
+        "has_florist_order": {
+            "index": true,
+            "comment": "제단/현화 주문 확인",
+            "default": false
+        },
+        "has_resident_card": {
+            "index": true,
+            "comment": "주민등록증 확인",
+            "default": false
+        },
+        "has_cremation_permit": {
+            "comment": "화장 허가서 확인",
+            "default": false
+        }
+    }
+}

package/src/app/routes/funeral/entities/funeral_mourner.json

@@ -0,0 +1,31 @@
+{
+    "name": "funeral_mourner",
+    "description": "funeral_mourner 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "isolated": "license",
+    "fields": {
+        "funeral_seq": {
+            "index": true,
+            "comment": "장례 seq",
+            "required": true
+        },
+        "is_chief": {
+            "index": true,
+            "comment": "주상주 여부",
+            "default": false
+        },
+        "name": {
+            "index": true,
+            "comment": "상주명",
+            "required": true
+        },
+        "phone": {
+            "index": true,
+            "hash": true,
+            "comment": "연락처",
+            "type": "phone"
+        },
+        "relationship": {
+            "comment": "고인과의 관계"
+        }
+    }
+}

package/src/app/routes/funeral/entities/funeral_order.json

@@ -0,0 +1,48 @@
+{
+    "name": "funeral_order",
+    "description": "funeral_order 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "isolated": "license",
+    "fields": {
+        "funeral_seq": {
+            "index": true,
+            "comment": "장례 seq",
+            "required": true
+        },
+        "order_date": {
+            "index": true,
+            "comment": "주문 일시",
+            "type": "datetime"
+        },
+        "order_type": {
+            "index": true,
+            "comment": "주문 유형",
+            "type": [
+                "food",
+                "supply",
+                "service",
+                "rental",
+                "other"
+            ],
+            "required": true
+        },
+        "status": {
+            "index": true,
+            "comment": "주문 상태",
+            "type": [
+                "pending",
+                "confirmed",
+                "completed",
+                "cancelled"
+            ],
+            "default": "pending"
+        },
+        "total_amount": {
+            "index": true,
+            "comment": "주문 금액",
+            "required": true
+        },
+        "order_memo": {
+            "comment": "주문 메모"
+        }
+    }
+}

package/src/app/routes/funeral/entities/funeral_room.json

@@ -0,0 +1,61 @@
+{
+    "name": "funeral_room",
+    "description": "funeral_room 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "fields": {
+        "floor": {
+            "index": true,
+            "comment": "층수",
+            "type": "int",
+            "default": 1
+        },
+        "funeral_seq": {
+            "index": true,
+            "comment": "장례 seq",
+            "required": true
+        },
+        "room_name": {
+            "index": true,
+            "comment": "호실 이름",
+            "required": true
+        },
+        "room_number": {
+            "index": true,
+            "comment": "호실 번호",
+            "required": true,
+            "unique": true
+        },
+        "room_type": {
+            "index": true,
+            "comment": "호실 유형",
+            "type": [
+                "일반",
+                "특실",
+                "VIP"
+            ],
+            "default": "일반"
+        },
+        "sort_order": {
+            "index": true,
+            "comment": "정렬 순서",
+            "type": "int",
+            "default": 0
+        },
+        "status": {
+            "index": true,
+            "comment": "사용 상태",
+            "type": [
+                "empty",
+                "occupied",
+                "reserved",
+                "cleaning",
+                "maintenance"
+            ],
+            "default": "empty",
+            "required": true
+        },
+        "capacity": {
+            "comment": "수용 인원",
+            "type": "int"
+        }
+    }
+}

package/src/app/routes/funeral/entities/funeral_schedule.json

@@ -0,0 +1,39 @@
+{
+    "name": "funeral_schedule",
+    "description": "funeral_schedule 엔티티. 사용자 환경에 맞게 fields를 자유롭게 확장할 수 있습니다.",
+    "isolated": "license",
+    "fields": {
+        "check_in_date": {
+            "index": true,
+            "comment": "입실 일시",
+            "type": "datetime"
+        },
+        "encoffin_date": {
+            "index": true,
+            "comment": "입관 일시",
+            "type": "datetime"
+        },
+        "funeral_date": {
+            "index": true,
+            "comment": "발인 일시",
+            "type": "datetime"
+        },
+        "funeral_seq": {
+            "index": true,
+            "comment": "장례 seq",
+            "required": true
+        },
+        "rest_date": {
+            "index": true,
+            "comment": "안치 일시",
+            "type": "datetime"
+        },
+        "burial_location": {
+            "comment": "안장지"
+        },
+        "cremation_date": {
+            "comment": "화장 일시",
+            "type": "datetime"
+        }
+    }
+}

package/src/app/routes/funeral/routes.ts

@@ -0,0 +1,32 @@
+/**
+ * Funeral 라우트 플러그인
+ *
+ * 자동 로더가 `app/routes/funeral/routes.ts`를 탐색하여
+ * prefix `/api/v1/funeral` 으로 등록한다.
+ *
+ * 엔티티:
+ *   - funeral   — 장례 기본 정보
+ *   - room      — 빈소
+ *   - schedule  — 장례 일정
+ *   - mourner   — 상주
+ *   - order     — 조문 순서/접수
+ *   - docs      — 장례 관련 문서
+ */
+
+import type { FastifyInstance } from "fastify";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import { logger, ensurePluginEntities } from "@gateway/api";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default async function funeralRoutes(
+    app: FastifyInstance,
+): Promise<void> {
+    await ensurePluginEntities(__dirname).catch((err) =>
+        logger.warn({ err }, "funeral: ensureEntities failed"),
+    );
+
+    // TODO: 장례 라우트 핸들러 추가
+    void app;
+}

package/src/app/routes/health/config.json

@@ -0,0 +1,5 @@
+{
+    "enabled": true,
+    "deploy": false,
+    "minify": false
+}