create-entity-app-server 0.0.3 → 0.0.4

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

@@ -1,220 +0,0 @@
-/**
- * DB Example 핸들러 — Kysely DB 직접 접속 예제
- *
- * 이 파일은 Gateway에서 DB에 직접 접속하는 방법을 보여줍니다.
- * req.server.db 가 Kysely<Database> 인스턴스이므로
- * 체이닝 방식으로 타입 안전한 쿼리를 작성할 수 있습니다.
- *
- * ⚠ 주의: database.json 이 설정되어 있어야 동작합니다.
- *   설정되지 않으면 req.server.db 가 null 이므로 503 에러를 반환합니다.
- */
-
-import type { FastifyRequest, FastifyReply } from "fastify";
-import {
-    ok,
-    fail,
-    sql,
-    dbConn,
-    NotFoundError,
-    BadRequestError,
-} from "@gateway/api";
-import type {
-    CreateUserBody,
-    UpdateUserBody,
-    SearchUsersQuery,
-    UserIdParams,
-} from "./types/index.ts";
-// models/users.ts 에서 Database 확장 선언을 로드합니다.
-// 이 import가 있어야 dbConn().selectFrom("users") 에 UsersTable 타입이 적용됩니다.
-import "./models/users.ts";
-
-// ─────────────────────────────────────────────────
-// 기본 CRUD 예제
-// ─────────────────────────────────────────────────
-
-/**
- * GET /example/users
- * 사용자 목록 조회 (기본 SELECT)
- */
-export async function listUsers(req: FastifyRequest, reply: FastifyReply) {
-    const conn = dbConn();
-
-    const users = await conn
-        .selectFrom("users")
-        .select(["seq", "name", "email", "status", "created_time"])
-        .orderBy("seq", "desc")
-        .limit(50)
-        .execute();
-
-    return reply.send(ok(users));
-}
-
-/**
- * GET /example/users/:id
- * 사용자 단건 조회
- */
-export async function getUser(
-    req: FastifyRequest<{ Params: UserIdParams }>,
-    reply: FastifyReply,
-) {
-    const conn = dbConn();
-    const { id } = req.params;
-
-    const user = await conn
-        .selectFrom("users")
-        .selectAll()
-        .where("seq", "=", Number(id))
-        .executeTakeFirst();
-
-    if (!user) {
-        throw new NotFoundError(`User ${id} not found`);
-    }
-
-    return reply.send(ok(user));
-}
-
-/**
- * POST /example/users
- * 사용자 생성 (INSERT)
- */
-export async function createUser(
-    req: FastifyRequest<{ Body: CreateUserBody }>,
-    reply: FastifyReply,
-) {
-    const conn = dbConn();
-    const { name, email, status = "active" } = req.body;
-
-    const result = await conn
-        .insertInto("users")
-        .values({ name, email, status, data: "{}" })
-        .executeTakeFirst();
-
-    return reply.code(201).send(
-        ok({
-            insertId: Number(result.insertId),
-            name,
-            email,
-            status,
-        }),
-    );
-}
-
-/**
- * PUT /example/users/:id
- * 사용자 수정 (UPDATE)
- */
-export async function updateUser(
-    req: FastifyRequest<{ Params: UserIdParams; Body: UpdateUserBody }>,
-    reply: FastifyReply,
-) {
-    const conn = dbConn();
-    const { id } = req.params;
-    const updates = req.body;
-
-    if (!updates || Object.keys(updates).length === 0) {
-        throw new BadRequestError("No fields to update");
-    }
-
-    const result = await conn
-        .updateTable("users")
-        .set(updates)
-        .where("seq", "=", Number(id))
-        .executeTakeFirst();
-
-    if (Number(result.numUpdatedRows) === 0) {
-        throw new NotFoundError(`User ${id} not found`);
-    }
-
-    return reply.send(ok({ id: Number(id), ...updates }));
-}
-
-/**
- * DELETE /example/users/:id
- * 사용자 삭제 (DELETE)
- */
-export async function deleteUser(
-    req: FastifyRequest<{ Params: UserIdParams }>,
-    reply: FastifyReply,
-) {
-    const conn = dbConn();
-    const { id } = req.params;
-
-    const result = await conn
-        .deleteFrom("users")
-        .where("seq", "=", Number(id))
-        .executeTakeFirst();
-
-    if (Number(result.numDeletedRows) === 0) {
-        throw new NotFoundError(`User ${id} not found`);
-    }
-
-    return reply.send(ok({ deleted: true, id: Number(id) }));
-}
-
-// ─────────────────────────────────────────────────
-// 고급 쿼리 예제
-// ─────────────────────────────────────────────────
-
-/**
- * GET /example/stats
- * 통계 조회 — raw SQL (sql 태그드 리터럴) 예제
- *
- * 복잡한 집계 쿼리나 Database 인터페이스에 등록하지 않은 테이블은
- * sql`` 태그를 사용하여 raw SQL로 처리합니다.
- */
-export async function getStats(req: FastifyRequest, reply: FastifyReply) {
-    const conn = dbConn();
-
-    // sql<T>`` 에서 T는 결과 행의 타입
-    const { rows } = await sql<{ status: string; count: number }>`
-        SELECT status, COUNT(*) as count
-        FROM users
-        GROUP BY status
-        ORDER BY count DESC
-    `.execute(conn);
-
-    if (rows.length === 0) {
-        return reply.send(fail("No stats available"));
-    }
-
-    return reply.send(ok(rows));
-}
-
-/**
- * GET /example/search?q=john&status=active&limit=20&offset=0
- * 동적 조건 검색 — 조건부 where 체이닝 예제
- */
-export async function searchUsers(
-    req: FastifyRequest<{ Querystring: SearchUsersQuery }>,
-    reply: FastifyReply,
-) {
-    const conn = dbConn();
-    const { q, status, limit = 20, offset = 0 } = req.query;
-
-    let query = conn
-        .selectFrom("users")
-        .select(["seq", "name", "email", "status", "created_time"]);
-
-    // 검색어가 있으면 이름 또는 이메일에서 LIKE 검색
-    if (q) {
-        query = query.where((eb: any) =>
-            eb.or([
-                eb("name", "like", `%${q}%`),
-                eb("email", "like", `%${q}%`),
-            ]),
-        );
-    }
-
-    // 상태 필터
-    if (status) {
-        query = query.where("status", "=", status);
-    }
-
-    const users = await query
-        .orderBy("seq", "desc")
-        .limit(limit)
-        .offset(offset)
-        .execute();
-
-    return reply.send(ok(users));
-}

package/src/app/routes/example-db/models/account-ext.ts

@@ -1,33 +0,0 @@
-/**
- * account-ext.ts 예제 — 기존 테이블에 플러그인 필드를 추가하는 방법
- *
- * Go 서버가 관리하는 account 테이블의 data JSON blob에
- * 플러그인이 자체 필드를 저장할 때, 타입 안전성을 위해
- * 아래처럼 AccountExtensions를 확장합니다.
- *
- * 실제로 DB를 직접 쓰는 경우에만 필요합니다.
- * Go API를 통해 account를 읽고 쓴다면 필요하지 않습니다.
- */
-
-// AccountExtensions 확장 예제
-// declare module "@gateway/api" {
-//     interface AccountExtensions {
-//         my_plugin_enabled?: boolean;   // 플러그인 활성화 여부
-//         my_plugin_data?: string;       // 플러그인 저장 데이터
-//     }
-// }
-// export {};
-
-// AccountTable 자체를 확장하는 예제 (인덱스 컬럼 추가 시)
-// declare module "@gateway/api" {
-//     interface Database {
-//         account: import("kysely").Selectable<{
-//             seq: number;
-//             email: string;
-//             my_index_column: string | null;
-//         }>;
-//     }
-// }
-// export {};
-
-export {};

package/src/app/routes/example-db/models/users.ts

@@ -1,30 +0,0 @@
-/**
- * users 테이블 타입 — Kysely DB 직접 쿼리용
- *
- * DB를 직접 쓸 때만 models/ 폴더에 테이블 타입을 정의합니다.
- * declare module로 Database에 등록하면 dbConn().selectFrom("users")에서
- * 자동완성 + 타입 체크가 적용됩니다.
- *
- * @see https://kysely.dev/docs/getting-started#types
- */
-
-import type { Generated } from "kysely";
-
-/** users 테이블 타입 */
-export interface UsersTable {
-    seq: Generated<number>; // PK, auto_increment
-    name: string | null; // 이름
-    email: string; // 이메일 (unique)
-    status: Generated<"active" | "inactive" | null>; // 상태
-    data: Generated<string>; // JSON blob
-    created_time: Generated<string>; // 생성 시각
-    updated_time: Generated<string>; // 수정 시각
-}
-
-declare module "@gateway/api" {
-    interface Database {
-        users: UsersTable;
-    }
-}
-
-export {};

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

@@ -1,23 +0,0 @@
-/**
- * DB Example 라우트 테이블
- * 등록 경로: /api/v1/example-db/*
- *
- * Kysely를 사용한 DB 직접 접속 예제입니다.
- * 실제 프로젝트에서는 이 폴더를 복사하여 새 라우트를 만들 수 있습니다.
- */
-
-import type { FastifyInstance } from "fastify";
-import * as h from "./handlers.ts";
-
-export default async function dbExampleRoutes(app: FastifyInstance) {
-    // ── 기본 CRUD ──────────────────────────────
-    app.get("/users", h.listUsers);
-    app.get("/users/:id", h.getUser);
-    app.post("/users", h.createUser);
-    app.put("/users/:id", h.updateUser);
-    app.delete("/users/:id", h.deleteUser);
-
-    // ── 고급 쿼리 ─────────────────────────────
-    app.get("/stats", h.getStats);
-    app.get("/search", h.searchUsers);
-}

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

@@ -1,21 +0,0 @@
-import type { CreateUserBody, UpdateUserBody } from "./user.ts";
-import type { SearchUsersQuery } from "./query.ts";
-
-export const defaultCreateUserBody: CreateUserBody = {
-    name: "",
-    email: "",
-    status: "active",
-};
-
-export const defaultUpdateUserBody: UpdateUserBody = {
-    name: undefined,
-    email: undefined,
-    status: undefined,
-};
-
-export const defaultSearchUsersQuery: SearchUsersQuery = {
-    q: undefined,
-    status: undefined,
-    limit: 20,
-    offset: 0,
-};

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

@@ -1,4 +0,0 @@
-export type { CreateUserBody, UpdateUserBody } from "./user.ts";
-export type { UserIdParams } from "./params.ts";
-export type { SearchUsersQuery } from "./query.ts";
-export * from "./defaults.ts";

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

@@ -1,3 +0,0 @@
-export interface UserIdParams {
-    id: string;
-}

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

@@ -1,6 +0,0 @@
-export interface SearchUsersQuery {
-    q?: string;
-    status?: "active" | "inactive";
-    limit?: number;
-    offset?: number;
-}

package/src/app/routes/example-db/types/user.ts

@@ -1,11 +0,0 @@
-export interface CreateUserBody {
-    name: string;
-    email: string;
-    status?: "active" | "inactive";
-}
-
-export interface UpdateUserBody {
-    name?: string;
-    email?: string;
-    status?: "active" | "inactive";
-}

package/src/app/routes/example-es/config.json

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

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

@@ -1,216 +0,0 @@
-/**
- * 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

@@ -1,24 +0,0 @@
-/**
- * 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

@@ -1,30 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

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

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

@@ -1,12 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

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