create-entity-app-server 0.0.3

package/src/app/plugins/alimtalk/providers/nhn.ts

@@ -0,0 +1,254 @@
+/**
+ * NHN Cloud 알림톡 프로바이더 어댑터
+ *
+ * API: https://api-alimtalk.cloud.toast.com/alimtalk/v2.3/appkeys/{appKey}/messages
+ *      https://api-alimtalk.cloud.toast.com/friendtalk/v2.3/appkeys/{appKey}/messages
+ * X-Secret-Key 헤더 인증, JSON POST
+ * 친구톡 시 이미지, 와이드 아이템 리스트, 캐러셀 전체 지원
+ */
+
+import type {
+    AlimtalkClient,
+    AlimtalkProviderConfig,
+    AlimtalkRequest,
+    AlimtalkResult,
+    FriendTalkRequest,
+    FriendTalkResult,
+    FRIENDTALK_TYPE_WIDE_ITEM_LIST as _,
+    FRIENDTALK_TYPE_CAROUSEL as __,
+} from "../types/index.ts";
+import {
+    FRIENDTALK_TYPE_WIDE_ITEM_LIST,
+    FRIENDTALK_TYPE_CAROUSEL,
+} from "../types/index.ts";
+
+export class NHNClient implements AlimtalkClient {
+    private readonly appKey: string;
+    private readonly secretKey: string;
+    private readonly senderKey: string;
+
+    /** NHNClient 인스턴스를 초기화한다 */
+    constructor(cfg: AlimtalkProviderConfig) {
+        if (!cfg.app_key || !cfg.secret_key) {
+            throw new Error(
+                "nhn alimtalk: app_key and secret_key are required",
+            );
+        }
+        this.appKey = cfg.app_key;
+        this.secretKey = cfg.secret_key;
+        this.senderKey = cfg.sender_key;
+    }
+
+    /** 프로바이더 이름을 반환한다 */
+    name(): string {
+        return "nhn_cloud";
+    }
+
+    /** 알림톡 발송 API를 호출한다 */
+    async send(req: AlimtalkRequest): Promise<AlimtalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        const recipient: Record<string, unknown> = {
+            recipientNo: req.receiver,
+            templateParameter: req.variables,
+        };
+
+        // 버튼
+        if (req.buttons && req.buttons.length > 0) {
+            recipient.buttons = req.buttons.map((b) => {
+                const bm: Record<string, unknown> = {
+                    ordering: b.ordering,
+                    type: b.type,
+                    name: b.name,
+                };
+                if (b.link_mobile) bm.linkMo = b.link_mobile;
+                if (b.link_pc) bm.linkPc = b.link_pc;
+                if (b.scheme_ios) bm.schemeIos = b.scheme_ios;
+                if (b.scheme_android) bm.schemeAndroid = b.scheme_android;
+                return bm;
+            });
+        }
+
+        const body = {
+            senderKey,
+            templateCode: req.templateCode,
+            recipientList: [recipient],
+        };
+
+        const url = `https://api-alimtalk.cloud.toast.com/alimtalk/v2.3/appkeys/${this.appKey}/messages`;
+
+        const resp = await fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json;charset=UTF-8",
+                "X-Secret-Key": this.secretKey,
+            },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(30_000),
+        });
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `nhn alimtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as {
+            header?: {
+                resultCode?: number;
+                resultMessage?: string;
+                isSuccessful?: boolean;
+            };
+            message?: { requestId?: string };
+        };
+
+        if (!result.header?.isSuccessful) {
+            throw new Error(
+                `nhn alimtalk: send failed: ${result.header?.resultMessage ?? "unknown"}`,
+            );
+        }
+
+        return {
+            providerMsgId: result.message?.requestId ?? "",
+            statusCode: String(result.header?.resultCode ?? 0),
+            requestId: result.message?.requestId ?? "",
+        };
+    }
+
+    /** 친구톡 발송 API를 호출한다 */
+    async sendFriendTalk(req: FriendTalkRequest): Promise<FriendTalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        const recipient: Record<string, unknown> = {
+            recipientNo: req.receiver,
+            content: req.content,
+            isAd: req.isAd,
+        };
+
+        // 이미지
+        if (req.imageUrl) {
+            recipient.imageUrl = req.imageUrl;
+            if (req.imageLink) recipient.imageLink = req.imageLink;
+        }
+
+        // 버튼
+        if (req.buttons && req.buttons.length > 0) {
+            recipient.buttons = req.buttons.map((b) => {
+                const bm: Record<string, unknown> = {
+                    ordering: b.ordering,
+                    type: b.type,
+                    name: b.name,
+                };
+                if (b.link_mobile) bm.linkMo = b.link_mobile;
+                if (b.link_pc) bm.linkPc = b.link_pc;
+                if (b.scheme_ios) bm.schemeIos = b.scheme_ios;
+                if (b.scheme_android) bm.schemeAndroid = b.scheme_android;
+                return bm;
+            });
+        }
+
+        // 와이드 아이템 리스트
+        if (
+            req.msgType === FRIENDTALK_TYPE_WIDE_ITEM_LIST &&
+            req.header &&
+            req.items?.length
+        ) {
+            recipient.header = req.header;
+            recipient.item = {
+                list: req.items.map((item) => {
+                    const im: Record<string, unknown> = {
+                        title: item.title,
+                        imageUrl: item.image_url,
+                        linkMo: item.link_mobile,
+                    };
+                    if (item.link_pc) im.linkPc = item.link_pc;
+                    if (item.scheme_ios) im.schemeIos = item.scheme_ios;
+                    if (item.scheme_android)
+                        im.schemeAndroid = item.scheme_android;
+                    return im;
+                }),
+            };
+        }
+
+        // 캐러셀
+        if (req.msgType === FRIENDTALK_TYPE_CAROUSEL && req.carousel) {
+            const carouselList = req.carousel.items.map((ci) => {
+                const card: Record<string, unknown> = {
+                    header: ci.header,
+                    message: ci.message,
+                    attachment: {
+                        image: {
+                            imageUrl: ci.image_url,
+                            imageLink: ci.image_link ?? "",
+                        },
+                    },
+                };
+                if (ci.buttons?.length) {
+                    (card.attachment as Record<string, unknown>).buttons =
+                        ci.buttons.map((b) => ({
+                            name: b.name,
+                            type: b.type,
+                            linkMo: b.link_mobile,
+                            linkPc: b.link_pc ?? "",
+                        }));
+                }
+                return card;
+            });
+
+            const carousel: Record<string, unknown> = { list: carouselList };
+            if (req.carousel.tail) {
+                carousel.tail = {
+                    linkMo: req.carousel.tail.link_mobile,
+                    linkPc: req.carousel.tail.link_pc ?? "",
+                };
+            }
+            recipient.carousel = carousel;
+        }
+
+        const body = {
+            senderKey,
+            recipientList: [recipient],
+        };
+
+        const url = `https://api-alimtalk.cloud.toast.com/friendtalk/v2.3/appkeys/${this.appKey}/messages`;
+
+        const resp = await fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json;charset=UTF-8",
+                "X-Secret-Key": this.secretKey,
+            },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(30_000),
+        });
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `nhn friendtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as {
+            header?: {
+                resultCode?: number;
+                resultMessage?: string;
+                isSuccessful?: boolean;
+            };
+            message?: { requestId?: string };
+        };
+
+        if (!result.header?.isSuccessful) {
+            throw new Error(
+                `nhn friendtalk: send failed: ${result.header?.resultMessage ?? "unknown"}`,
+            );
+        }
+
+        return {
+            providerMsgId: result.message?.requestId ?? "",
+            statusCode: String(result.header?.resultCode ?? 0),
+            requestId: result.message?.requestId ?? "",
+        };
+    }
+}

package/src/app/plugins/alimtalk/providers/ppurio.ts

@@ -0,0 +1,145 @@
+/**
+ * 뿌리오(Ppurio) 알림톡 프로바이더 어댑터
+ *
+ * API: https://api.ppurio.com/v1/kakao/send
+ *      https://api.ppurio.com/v1/kakao/friend/send
+ * Bearer token 인증, JSON POST
+ */
+
+import type {
+    AlimtalkClient,
+    AlimtalkProviderConfig,
+    AlimtalkRequest,
+    AlimtalkResult,
+    FriendTalkRequest,
+    FriendTalkResult,
+} from "../types/index.ts";
+
+export class PpurioClient implements AlimtalkClient {
+    private readonly account: string;
+    private readonly apiKey: string;
+    private readonly senderKey: string;
+
+    /** PpurioClient 인스턴스를 초기화한다 */
+    constructor(cfg: AlimtalkProviderConfig) {
+        if (!cfg.account || !cfg.api_key) {
+            throw new Error(
+                "ppurio alimtalk: account and api_key are required",
+            );
+        }
+        this.account = cfg.account;
+        this.apiKey = cfg.api_key;
+        this.senderKey = cfg.sender_key;
+    }
+
+    /** 프로바이더 이름을 반환한다 */
+    name(): string {
+        return "ppurio";
+    }
+
+    /** 알림톡 발송 API를 호출한다 */
+    async send(req: AlimtalkRequest): Promise<AlimtalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        const body = {
+            account: this.account,
+            senderKey,
+            templateCode: req.templateCode,
+            receivers: [
+                {
+                    to: req.receiver,
+                    templateParameter: req.variables,
+                },
+            ],
+        };
+
+        const resp = await fetch("https://api.ppurio.com/v1/kakao/send", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.apiKey}`,
+            },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(30_000),
+        });
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `ppurio alimtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as {
+            code?: number;
+            requestId?: string;
+        };
+
+        return {
+            providerMsgId: result.requestId ?? "",
+            statusCode: String(result.code ?? resp.status),
+            requestId: result.requestId ?? "",
+        };
+    }
+
+    /** 친구톡 발송 API를 호출한다 */
+    async sendFriendTalk(req: FriendTalkRequest): Promise<FriendTalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        const receiver: Record<string, unknown> = {
+            to: req.receiver,
+            content: req.content,
+        };
+        if (req.imageUrl) {
+            receiver.imageUrl = req.imageUrl;
+            if (req.imageLink) receiver.imageLink = req.imageLink;
+        }
+
+        const body: Record<string, unknown> = {
+            account: this.account,
+            senderKey,
+            isAd: req.isAd,
+            receivers: [receiver],
+        };
+
+        if (req.buttons && req.buttons.length > 0) {
+            body.buttons = req.buttons.map((b) => ({
+                type: b.type,
+                name: b.name,
+                ...(b.link_mobile ? { linkMo: b.link_mobile } : {}),
+                ...(b.link_pc ? { linkPc: b.link_pc } : {}),
+            }));
+        }
+
+        const resp = await fetch(
+            "https://api.ppurio.com/v1/kakao/friend/send",
+            {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${this.apiKey}`,
+                },
+                body: JSON.stringify(body),
+                signal: AbortSignal.timeout(30_000),
+            },
+        );
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `ppurio friendtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as {
+            code?: number;
+            requestId?: string;
+        };
+
+        return {
+            providerMsgId: result.requestId ?? "",
+            statusCode: String(result.code ?? resp.status),
+            requestId: result.requestId ?? "",
+        };
+    }
+}

package/src/app/plugins/alimtalk/providers/solapi.ts

@@ -0,0 +1,145 @@
+/**
+ * Solapi(CoolSMS 차세대) 알림톡 프로바이더 어댑터
+ *
+ * API: https://api.solapi.com/kakao/v2/messages
+ * HMAC-SHA256 인증, JSON POST
+ */
+
+import { buildSolapiAuthorization } from "../../providers/solapi-auth.ts";
+import type {
+    AlimtalkClient,
+    AlimtalkProviderConfig,
+    AlimtalkRequest,
+    AlimtalkResult,
+    FriendTalkRequest,
+    FriendTalkResult,
+} from "../types/index.ts";
+
+export class SolapiClient implements AlimtalkClient {
+    private readonly apiKey: string;
+    private readonly apiSecret: string;
+    private readonly senderKey: string;
+
+    /** SolapiClient 인스턴스를 초기화한다 */
+    constructor(cfg: AlimtalkProviderConfig) {
+        if (!cfg.api_key || !cfg.api_secret) {
+            throw new Error(
+                "solapi alimtalk: api_key and api_secret are required",
+            );
+        }
+        this.apiKey = cfg.api_key;
+        this.apiSecret = cfg.api_secret;
+        this.senderKey = cfg.sender_key;
+    }
+
+    /** 프로바이더 이름을 반환한다 */
+    name(): string {
+        return "solapi";
+    }
+
+    /** HMAC-SHA256 인증 헤더를 생성한다 */
+    private buildAuth(): string {
+        return buildSolapiAuthorization(this.apiKey, this.apiSecret)
+            .authorization;
+    }
+
+    /** 알림톡 발송 API를 호출한다 */
+    async send(req: AlimtalkRequest): Promise<AlimtalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        // #{var} 형식으로 변환
+        const variables: Record<string, string> = {};
+        for (const [k, v] of Object.entries(req.variables ?? {})) {
+            variables[`#{${k}}`] = v;
+        }
+
+        const body = {
+            messages: [
+                {
+                    to: req.receiver,
+                    kakaoOptions: {
+                        pfId: senderKey,
+                        templateId: req.templateCode,
+                        variables,
+                    },
+                },
+            ],
+        };
+
+        const resp = await fetch("https://api.solapi.com/kakao/v2/messages", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: this.buildAuth(),
+            },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(30_000),
+        });
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `solapi alimtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as { groupId?: string };
+
+        return {
+            providerMsgId: result.groupId ?? "",
+            statusCode: String(resp.status),
+            requestId: "",
+        };
+    }
+
+    /** 친구톡 발송 API를 호출한다 */
+    async sendFriendTalk(req: FriendTalkRequest): Promise<FriendTalkResult> {
+        const senderKey = req.senderKey || this.senderKey;
+
+        const kakaoOptions: Record<string, unknown> = { pfId: senderKey };
+        if (req.imageUrl) kakaoOptions.imageUrl = req.imageUrl;
+        if (req.isAd) kakaoOptions.adFlag = true;
+
+        if (req.buttons && req.buttons.length > 0) {
+            kakaoOptions.buttons = req.buttons.map((b) => ({
+                buttonType: b.type,
+                buttonName: b.name,
+                ...(b.link_mobile ? { linkMo: b.link_mobile } : {}),
+                ...(b.link_pc ? { linkPc: b.link_pc } : {}),
+            }));
+        }
+
+        const msg: Record<string, unknown> = {
+            to: req.receiver,
+            kakaoOptions,
+        };
+        if (req.content) msg.text = req.content;
+
+        const body = { messages: [msg] };
+
+        const resp = await fetch("https://api.solapi.com/kakao/v2/messages", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: this.buildAuth(),
+            },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(30_000),
+        });
+
+        const respBody = await resp.text();
+        if (resp.status >= 400) {
+            throw new Error(
+                `solapi friendtalk: send failed (status=${resp.status}): ${respBody}`,
+            );
+        }
+
+        const result = JSON.parse(respBody) as { groupId?: string };
+
+        return {
+            providerMsgId: result.groupId ?? "",
+            statusCode: String(resp.status),
+            requestId: "",
+        };
+    }
+}

package/src/app/plugins/alimtalk/routes.ts

@@ -0,0 +1,15 @@
+/**
+ * 알림톡 라우트 테이블
+ * 등록 경로: /api/v1/alimtalk/*
+ */
+
+import type { FastifyInstance } from "fastify";
+import * as h from "./handlers";
+
+/** 알림톡 라우트를 등록한다 */
+export default async function alimtalkRoutes(app: FastifyInstance) {
+    app.post("/send", h.send);
+    app.get("/status/:seq", h.getStatus);
+    app.get("/templates", h.listTemplates);
+    app.post("/webhook/:provider", h.webhook);
+}