create-entity-server 0.0.9 → 0.0.15

package/template/samples/java/EntityServerClient.java

@@ -195,6 +195,110 @@ public class EntityServerClient {
         return request("POST", "/v1/entity/" + entity + "/rollback/" + historySeq, null);
     }
 
+    /** 푸시 발송 트리거 엔티티에 submit합니다. */
+    public String push(String pushEntity, String payloadJson) throws IOException {
+        return push(pushEntity, payloadJson, null);
+    }
+
+    /** 푸시 발송 트리거 엔티티에 submit합니다. (트랜잭션 지원) */
+    public String push(String pushEntity, String payloadJson, String transactionId) throws IOException {
+        return submit(pushEntity, payloadJson, transactionId);
+    }
+
+    /** push_log 목록 조회 헬퍼 */
+    public String pushLogList() throws IOException {
+        return pushLogList(1, 20, null);
+    }
+
+    /** push_log 목록 조회 헬퍼 */
+    public String pushLogList(int page, int limit, String orderBy) throws IOException {
+        return list("push_log", page, limit, orderBy);
+    }
+
+    /** account_device 디바이스 등록/갱신 헬퍼 (push_token 단일 필드) */
+    public String registerPushDevice(
+        long accountSeq,
+        String deviceId,
+        String pushToken,
+        String platform,
+        String deviceType,
+        boolean pushEnabled,
+        String transactionId
+    ) throws IOException {
+        StringBuilder payload = new StringBuilder("{");
+        payload.append("\"id\":").append(jsonString(deviceId));
+        payload.append(",\"account_seq\":").append(accountSeq);
+        payload.append(",\"push_token\":").append(jsonString(pushToken));
+        payload.append(",\"push_enabled\":").append(pushEnabled);
+        if (platform != null && !platform.isBlank()) {
+            payload.append(",\"platform\":").append(jsonString(platform));
+        }
+        if (deviceType != null && !deviceType.isBlank()) {
+            payload.append(",\"device_type\":").append(jsonString(deviceType));
+        }
+        payload.append("}");
+
+        return submit("account_device", payload.toString(), transactionId);
+    }
+
+    /** account_device.seq 기준 push_token 갱신 헬퍼 */
+    public String updatePushDeviceToken(
+        long deviceSeq,
+        String pushToken,
+        boolean pushEnabled,
+        String transactionId
+    ) throws IOException {
+        String payload = "{" +
+            "\"seq\":" + deviceSeq +
+            ",\"push_token\":" + jsonString(pushToken) +
+            ",\"push_enabled\":" + pushEnabled +
+            "}";
+        return submit("account_device", payload, transactionId);
+    }
+
+    /** account_device.seq 기준 푸시 수신 비활성화 헬퍼 */
+    public String disablePushDevice(long deviceSeq, String transactionId) throws IOException {
+        String payload = "{" +
+            "\"seq\":" + deviceSeq +
+            ",\"push_enabled\":false" +
+            "}";
+        return submit("account_device", payload, transactionId);
+    }
+
+    /**
+     * 요청 본문을 읽어 JSON 문자열로 반환합니다.
+     * - application/octet-stream: 암호 패킷 복호화
+     * - 그 외: 평문 JSON 문자열 반환
+     */
+    public String readRequestBody(byte[] rawBody, String contentType, boolean requireEncrypted) throws IOException {
+        String lowered = contentType == null ? "" : contentType.toLowerCase();
+        boolean isEncrypted = lowered.contains("application/octet-stream");
+
+        if (requireEncrypted && !isEncrypted) {
+            throw new IOException("Encrypted request required: Content-Type must be application/octet-stream");
+        }
+
+        if (isEncrypted) {
+            if (rawBody == null || rawBody.length == 0) {
+                throw new IOException("Encrypted request body is empty");
+            }
+            try {
+                return decryptPacket(rawBody);
+            } catch (Exception e) {
+                throw new IOException("Packet decryption failed: " + e.getMessage(), e);
+            }
+        }
+
+        if (rawBody == null || rawBody.length == 0) {
+            return "{}";
+        }
+        return new String(rawBody, StandardCharsets.UTF_8);
+    }
+
+    public String readRequestBody(byte[] rawBody, String contentType) throws IOException {
+        return readRequestBody(rawBody, contentType, false);
+    }
+
     // ─── 내부 ─────────────────────────────────────────────────────────────────
 
     private String request(String method, String path, String body) throws IOException {
@@ -301,4 +405,17 @@ public class EntityServerClient {
         String v = System.getenv(key);
         return (v != null && !v.isBlank()) ? v : defaultValue;
     }
+
+    private static String jsonString(String value) {
+        if (value == null) {
+            return "null";
+        }
+        String escaped = value
+            .replace("\\", "\\\\")
+            .replace("\"", "\\\"")
+            .replace("\n", "\\n")
+            .replace("\r", "\\r")
+            .replace("\t", "\\t");
+        return "\"" + escaped + "\"";
+    }
 }

package/template/samples/kotlin/EntityServerClient.kt

@@ -118,6 +118,92 @@ class EntityServerClient(
     fun rollback(entity: String, historySeq: Long): JSONObject =
         request("POST", "/v1/entity/$entity/rollback/$historySeq")
 
+    /** 푸시 발송 트리거 엔티티에 submit합니다. */
+    fun push(pushEntity: String, payload: JSONObject, transactionId: String? = null): JSONObject =
+        submit(pushEntity, payload, transactionId)
+
+    /** push_log 목록 조회 헬퍼 */
+    fun pushLogList(page: Int = 1, limit: Int = 20): JSONObject =
+        list("push_log", page, limit)
+
+    /** account_device 디바이스 등록/갱신 헬퍼 (push_token 단일 필드) */
+    fun registerPushDevice(
+        accountSeq: Long,
+        deviceId: String,
+        pushToken: String,
+        platform: String? = null,
+        deviceType: String? = null,
+        pushEnabled: Boolean = true,
+        transactionId: String? = null,
+    ): JSONObject {
+        val payload = JSONObject().apply {
+            put("id", deviceId)
+            put("account_seq", accountSeq)
+            put("push_token", pushToken)
+            put("push_enabled", pushEnabled)
+            if (!platform.isNullOrBlank()) put("platform", platform)
+            if (!deviceType.isNullOrBlank()) put("device_type", deviceType)
+        }
+        return submit("account_device", payload, transactionId)
+    }
+
+    /** account_device.seq 기준 push_token 갱신 헬퍼 */
+    fun updatePushDeviceToken(
+        deviceSeq: Long,
+        pushToken: String,
+        pushEnabled: Boolean = true,
+        transactionId: String? = null,
+    ): JSONObject =
+        submit(
+            "account_device",
+            JSONObject().apply {
+                put("seq", deviceSeq)
+                put("push_token", pushToken)
+                put("push_enabled", pushEnabled)
+            },
+            transactionId,
+        )
+
+    /** account_device.seq 기준 푸시 수신 비활성화 헬퍼 */
+    fun disablePushDevice(
+        deviceSeq: Long,
+        transactionId: String? = null,
+    ): JSONObject =
+        submit(
+            "account_device",
+            JSONObject().apply {
+                put("seq", deviceSeq)
+                put("push_enabled", false)
+            },
+            transactionId,
+        )
+
+    /**
+     * 요청 본문을 읽어 JSON으로 반환합니다.
+     * - application/octet-stream: 암호 패킷 복호화
+     * - 그 외: 평문 JSON 파싱
+     */
+    fun readRequestBody(
+        rawBody: ByteArray,
+        contentType: String = "application/json",
+        requireEncrypted: Boolean = false,
+    ): JSONObject {
+        val lowered = contentType.lowercase()
+        val isEncrypted = lowered.contains("application/octet-stream")
+
+        if (requireEncrypted && !isEncrypted) {
+            error("Encrypted request required: Content-Type must be application/octet-stream")
+        }
+
+        if (isEncrypted) {
+            if (rawBody.isEmpty()) error("Encrypted request body is empty")
+            return JSONObject(decryptPacket(rawBody))
+        }
+
+        if (rawBody.isEmpty()) return JSONObject()
+        return JSONObject(String(rawBody, Charsets.UTF_8))
+    }
+
     // ─── 내부 ─────────────────────────────────────────────────────────
 
     private fun request(method: String, path: String, bodyStr: String = "", extraHeaders: Map<String, String> = emptyMap()): JSONObject {

package/template/samples/node/src/EntityServerClient.js

@@ -178,6 +178,122 @@ export class EntityServerClient {
         );
     }
 
+    /** 푸시 발송 트리거 엔티티에 submit합니다. */
+    push(pushEntity, payload, { transactionId } = {}) {
+        return this.submit(pushEntity, payload, { transactionId });
+    }
+
+    /** push_log 목록 조회 헬퍼 */
+    pushLogList({ page = 1, limit = 20, orderBy } = {}) {
+        return this.list("push_log", { page, limit, orderBy });
+    }
+
+    /** account_device 디바이스 등록/갱신 헬퍼 (push_token 단일 필드) */
+    registerPushDevice(
+        accountSeq,
+        deviceId,
+        pushToken,
+        {
+            platform,
+            deviceType,
+            browser,
+            browserVersion,
+            pushEnabled = true,
+            transactionId,
+        } = {},
+    ) {
+        return this.submit(
+            "account_device",
+            {
+                id: deviceId,
+                account_seq: accountSeq,
+                push_token: pushToken,
+                push_enabled: pushEnabled,
+                ...(platform ? { platform } : {}),
+                ...(deviceType ? { device_type: deviceType } : {}),
+                ...(browser ? { browser } : {}),
+                ...(browserVersion ? { browser_version: browserVersion } : {}),
+            },
+            { transactionId },
+        );
+    }
+
+    /** account_device.seq 기준 push_token 갱신 헬퍼 */
+    updatePushDeviceToken(
+        deviceSeq,
+        pushToken,
+        { pushEnabled = true, transactionId } = {},
+    ) {
+        return this.submit(
+            "account_device",
+            {
+                seq: deviceSeq,
+                push_token: pushToken,
+                push_enabled: pushEnabled,
+            },
+            { transactionId },
+        );
+    }
+
+    /** account_device.seq 기준 푸시 수신 비활성화 헬퍼 */
+    disablePushDevice(deviceSeq, { transactionId } = {}) {
+        return this.submit(
+            "account_device",
+            {
+                seq: deviceSeq,
+                push_enabled: false,
+            },
+            { transactionId },
+        );
+    }
+
+    /**
+     * 요청 본문을 읽어 JSON으로 반환합니다.
+     * - application/octet-stream: 암호 패킷 복호화
+     * - 그 외: 평문 JSON 파싱
+     */
+    readRequestBody(
+        body,
+        contentType = "application/json",
+        { requireEncrypted = false } = {},
+    ) {
+        const lowered = String(contentType || "").toLowerCase();
+        const isEncrypted = lowered.includes("application/octet-stream");
+
+        if (requireEncrypted && !isEncrypted) {
+            throw new Error(
+                "Encrypted request required: Content-Type must be application/octet-stream",
+            );
+        }
+
+        if (isEncrypted) {
+            if (body == null) {
+                throw new Error("Encrypted request body is empty");
+            }
+
+            if (body instanceof ArrayBuffer) {
+                return this.#decryptPacket(body);
+            }
+
+            if (ArrayBuffer.isView(body)) {
+                const view = body;
+                const sliced = view.buffer.slice(
+                    view.byteOffset,
+                    view.byteOffset + view.byteLength,
+                );
+                return this.#decryptPacket(sliced);
+            }
+
+            throw new Error(
+                "Encrypted request body must be ArrayBuffer, Buffer, or Uint8Array",
+            );
+        }
+
+        if (body == null || body === "") return {};
+        if (typeof body === "object") return body;
+        return JSON.parse(String(body));
+    }
+
     // ─── 내부 ─────────────────────────────────────────────────────────────────
 
     async #request(method, path, body, extraHeaders = {}) {

package/template/samples/php/ci4/Config/EntityServer.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+class EntityServer extends BaseConfig
+{
+    public string $baseUrl = 'http://localhost:47200';
+    public string $apiKey = '';
+    public string $hmacSecret = '';
+    public int $timeout = 10;
+    public int $magicLen = 4;
+    public bool $requireEncryptedRequest = true;
+}

package/template/samples/php/ci4/Controllers/EntityController.php

@@ -0,0 +1,202 @@
+<?php
+
+namespace App\Controllers;
+
+use App\Controllers\BaseController;
+use App\Libraries\EntityServer;
+
+/**
+ * EntityServer CRUD를 CI4 컨트롤러에서 공통으로 사용하는 베이스 컨트롤러.
+ *
+ * 사용법:
+ *  class ProductController extends EntityController {
+ *      protected string $entity = 'product';
+ *  }
+ */
+abstract class EntityController extends BaseController
+{
+    protected EntityServer $es;
+
+    /** 대상 엔티티명 (하위 컨트롤러에서 지정) */
+    protected string $entity = '';
+
+    /**
+     * 푸시 트리거용 엔티티명 (기본: 시스템 엔티티 push_msg)
+     *
+     * 주의: push 인프라 필수 엔티티는 account_device / push_msg / push_log 이며,
+     * 이 값은 "어떤 엔티티 insert로 push hook를 트리거할지"를 결정합니다.
+     */
+    protected string $pushEntity = 'push_msg';
+
+    /** pushEntity에서 수신자를 가리키는 필드명 */
+    protected string $pushTargetField = 'account_seq';
+
+    public function __construct()
+    {
+        $this->es = new EntityServer();
+    }
+
+    /** GET /{entity}/list?page=1&limit=20 */
+    public function list(): string
+    {
+        $page  = (int) ($this->request->getGet('page') ?? 1);
+        $limit = (int) ($this->request->getGet('limit') ?? 20);
+
+        $result = $this->es->list($this->entity, [
+            'page'  => $page,
+            'limit' => $limit,
+        ]);
+
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** GET /{entity}/get/(:num) */
+    public function get(int $seq): string
+    {
+        $result = $this->es->get($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** POST /{entity}/query */
+    public function query(): string
+    {
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        $filter = $body['filter'] ?? [];
+        $params = [
+            'page'  => $body['page'] ?? 1,
+            'limit' => $body['limit'] ?? 20,
+        ];
+
+        $result = $this->es->query($this->entity, $filter, $params);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * POST /{entity}/submit
+     * POST /{entity}/submit/(:num)  (seq route param을 body에 주입)
+     */
+    public function submit(?int $seq = null): string
+    {
+        try {
+            $data = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        if ($seq !== null) {
+            $data['seq'] = $seq;
+        }
+
+        $result = $this->es->submit($this->entity, $data);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** DELETE /{entity}/delete/(:num) */
+    public function delete(int $seq): string
+    {
+        $result = $this->es->delete($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** GET /{entity}/history/(:num) */
+    public function history(int $seq): string
+    {
+        $result = $this->es->history($this->entity, $seq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /** POST /{entity}/rollback/(:num) */
+    public function rollback(int $historySeq): string
+    {
+        $result = $this->es->rollback($this->entity, $historySeq);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * POST /{entity}/push
+     *
+     * push hook가 연결된 엔티티(push_msg 등)에 submit하여 푸시를 발행합니다.
+     * 요청 예:
+     * {
+     *   "account_seq": 1,
+     *   "title": "알림 제목",
+     *   "message": "알림 본문",
+     *   "ref_entity": "order",
+     *   "ref_seq": 123,
+     *   "data": {"order_seq": "123"}
+     * }
+     */
+    public function push(): string
+    {
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
+        $target = (int) ($body[$this->pushTargetField] ?? 0);
+        if ($target <= 0) {
+            return $this->response->setStatusCode(400)
+                ->setJSON([
+                    'ok'      => false,
+                    'message' => sprintf('%s required', $this->pushTargetField),
+                ])
+                ->getBody();
+        }
+
+        $title = (string) ($body['title'] ?? '');
+        $message = (string) ($body['message'] ?? $body['body'] ?? '');
+
+        $payload = [
+            $this->pushTargetField => $target,
+            'title'                => $title,
+            'message'              => $message,
+        ];
+
+        if (isset($body['ref_entity'])) {
+            $payload['ref_entity'] = (string) $body['ref_entity'];
+        }
+        if (isset($body['ref_seq'])) {
+            $payload['ref_seq'] = (int) $body['ref_seq'];
+        }
+        if (isset($body['data']) && is_array($body['data'])) {
+            $payload['data'] = $body['data'];
+        }
+
+        $result = $this->es->push($this->pushEntity, $payload);
+        return $this->response->setJSON($result)->getBody();
+    }
+
+    /**
+     * GET /{entity}/push-log/list?page=1&limit=20&account_seq=1
+     */
+    public function pushLogList(): string
+    {
+        $page  = (int) ($this->request->getGet('page') ?? 1);
+        $limit = (int) ($this->request->getGet('limit') ?? 20);
+
+        $params = [
+            'page'  => $page,
+            'limit' => $limit,
+        ];
+
+        $accountSeq = (int) ($this->request->getGet('account_seq') ?? 0);
+        if ($accountSeq > 0) {
+            $params['account_seq'] = $accountSeq;
+        }
+
+        $result = $this->es->pushLogList($params);
+        return $this->response->setJSON($result)->getBody();
+    }
+}

package/template/samples/php/ci4/Controllers/ProductController.php

@@ -2,81 +2,14 @@
 
 namespace App\Controllers;
 
-use App\Controllers\BaseController;
-use App\Libraries\EntityServer;
-
 /**
- * EntityServer 라이브러리를 사용하는 CI4 컨트롤러 예시
+ * Product 전용 컨트롤러 예시.
+ * 기본 CRUD는 EntityController를 상속받아 그대로 사용하고,
+ * 확장 기능(order)만 이 컨트롤러에서 구현합니다.
  */
-class ProductController extends BaseController
+class ProductController extends EntityController
 {
-    private EntityServer $es;
-
-    public function __construct()
-    {
-        $this->es = new EntityServer();
-    }
-
-    /** GET /products */
-    public function index(): string
-    {
-        $page   = (int) ($this->request->getGet('page')  ?? 1);
-        $limit  = (int) ($this->request->getGet('limit') ?? 20);
-        $result = $this->es->list('product', ['page' => $page, 'limit' => $limit]);
-
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** GET /products/(:num) */
-    public function show(int $seq): string
-    {
-        $result = $this->es->get('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** POST /products/search */
-    public function search(): string
-    {
-        $body   = $this->request->getJSON(true);
-        $filter = $body['filter'] ?? [];
-        $params = ['page' => $body['page'] ?? 1, 'limit' => $body['limit'] ?? 20];
-
-        // 필터 예: [['field' => 'category', 'op' => 'eq', 'value' => 'electronics']]
-        $result = $this->es->query('product', $filter, $params);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** POST /products */
-    public function create(): string
-    {
-        $data   = $this->request->getJSON(true);
-        // seq 없이 submit → 생성
-        $result = $this->es->submit('product', $data);
-        return $this->response->setStatusCode(201)->setJSON($result)->getBody();
-    }
-
-    /** PUT /products/(:num) */
-    public function update(int $seq): string
-    {
-        $data        = $this->request->getJSON(true);
-        $data['seq'] = $seq; // seq 포함 → 수정
-        $result      = $this->es->submit('product', $data);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** DELETE /products/(:num) */
-    public function delete(int $seq): string
-    {
-        $result = $this->es->delete('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
-
-    /** GET /products/(:num)/history */
-    public function history(int $seq): string
-    {
-        $result = $this->es->history('product', $seq);
-        return $this->response->setJSON($result)->getBody();
-    }
+    protected string $entity = 'product';
 
     /**
      * POST /products/order
@@ -90,7 +23,14 @@ class ProductController extends BaseController
      */
     public function order(): string
     {
-        $body        = $this->request->getJSON(true);
+        try {
+            $body = $this->es->readRequestBody($this->request);
+        } catch (\Throwable $e) {
+            return $this->response->setStatusCode(400)
+                ->setJSON(['ok' => false, 'message' => $e->getMessage()])
+                ->getBody();
+        }
+
         $productSeq  = (int) ($body['product_seq'] ?? 0);
         $qty         = (int) ($body['qty']         ?? 1);
         $buyer       = $body['buyer'] ?? '';
@@ -101,16 +41,16 @@ class ProductController extends BaseController
                 ->getBody();
         }
 
-        $this->es->transStart(); // 서버 큐 등록, 이후 submit / delete 시 큐에씀임
+        $this->es->transStart(); // 서버 큐 등록, 이후 submit / delete 는 큐에 적재
 
         try {
             // 1) 상품 조회 후 재고 차감
-            $product = $this->es->get('product', $productSeq);
+            $product = $this->es->get($this->entity, $productSeq);
             $stock   = (int) ($product['data']['stock'] ?? 0);
             if ($stock < $qty) {
                 throw new \RuntimeException('재고 부족');
             }
-            $this->es->submit('product', [
+            $this->es->submit($this->entity, [
                 'seq'   => $productSeq,
                 'stock' => $stock - $qty,
             ]);