entity-server-client 0.3.2 → 1.0.1

package/src/mixins/push.ts

@@ -1,109 +0,0 @@
-import type {
-    EntityListParams,
-    EntityListResult,
-    RegisterPushDeviceOptions,
-} from "../types";
-import type { GConstructor, EntityServerClientBase } from "../client/base";
-
-// entity submit을 가진 base 타입 (EntityMixin 적용 후)
-type WithSubmit = EntityServerClientBase & {
-    submit(
-        entity: string,
-        data: Record<string, unknown>,
-        opts?: { transactionId?: string; skipHooks?: boolean },
-    ): Promise<{ ok: boolean; seq: number }>;
-    list<T = unknown>(
-        entity: string,
-        params?: EntityListParams,
-    ): Promise<{ ok: boolean; data: EntityListResult<T> }>;
-};
-
-export function PushMixin<TBase extends GConstructor<WithSubmit>>(Base: TBase) {
-    return class PushMixinClass extends Base {
-        // ─── 푸시 submit 래퍼 ────────────────────────────────────────────────
-
-        /**
-         * 푸시 관련 엔티티로 payload를 전송(Submit)합니다.
-         * 내부적으로 `submit()` 메서드를 호출합니다.
-         */
-        push(
-            pushEntity: string,
-            payload: Record<string, unknown>,
-            opts: { transactionId?: string } = {},
-        ): Promise<{ ok: boolean; seq: number }> {
-            return this.submit(pushEntity, payload, opts);
-        }
-
-        // ─── 푸시 디바이스 관리 ───────────────────────────────────────────────
-
-        /** 푸시 로그 엔티티 목록을 조회합니다. */
-        pushLogList<T = unknown>(
-            params: EntityListParams = {},
-        ): Promise<{ ok: boolean; data: EntityListResult<T> }> {
-            return this.list<T>("push_log", params);
-        }
-
-        /** 계정의 푸시 디바이스를 등록합니다. */
-        registerPushDevice(
-            accountSeq: number,
-            deviceId: string,
-            pushToken: string,
-            opts: RegisterPushDeviceOptions = {},
-        ): Promise<{ ok: boolean; seq: number }> {
-            const {
-                platform,
-                deviceType,
-                browser,
-                browserVersion,
-                pushEnabled = true,
-                transactionId,
-            } = opts;
-            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 },
-            );
-        }
-
-        /** 디바이스 레코드의 푸시 토큰을 갱신합니다. */
-        updatePushDeviceToken(
-            deviceSeq: number,
-            pushToken: string,
-            opts: { pushEnabled?: boolean; transactionId?: string } = {},
-        ): Promise<{ ok: boolean; seq: number }> {
-            const { pushEnabled = true, transactionId } = opts;
-            return this.submit(
-                "account_device",
-                {
-                    seq: deviceSeq,
-                    push_token: pushToken,
-                    push_enabled: pushEnabled,
-                },
-                { transactionId },
-            );
-        }
-
-        /** 디바이스의 푸시 수신을 비활성화합니다. */
-        disablePushDevice(
-            deviceSeq: number,
-            opts: { transactionId?: string } = {},
-        ): Promise<{ ok: boolean; seq: number }> {
-            return this.submit(
-                "account_device",
-                { seq: deviceSeq, push_enabled: false },
-                { transactionId: opts.transactionId },
-            );
-        }
-    };
-}

package/src/mixins/smtp.ts

@@ -1,20 +0,0 @@
-import type { SmtpSendRequest } from "../types";
-import type { GConstructor, EntityServerClientBase } from "../client/base";
-
-export function SmtpMixin<TBase extends GConstructor<EntityServerClientBase>>(
-    Base: TBase,
-) {
-    return class SmtpMixinClass extends Base {
-        // ─── SMTP 메일 발송 ───────────────────────────────────────────────────
-
-        /** SMTP로 메일을 발송합니다. */
-        smtpSend(req: SmtpSendRequest): Promise<{ ok: boolean; seq: number }> {
-            return this._request("POST", "/v1/smtp/send", req);
-        }
-
-        /** SMTP 발송 상태를 조회합니다. */
-        smtpStatus(seq: number): Promise<{ ok: boolean; status: string }> {
-            return this._request("POST", `/v1/smtp/status/${seq}`, {});
-        }
-    };
-}

package/src/mixins/utils.ts

@@ -1,106 +0,0 @@
-import type { QRCodeOptions, BarcodeOptions, Pdf2PngOptions } from "../types";
-import type { GConstructor, EntityServerClientBase } from "../client/base";
-
-export function UtilsMixin<TBase extends GConstructor<EntityServerClientBase>>(
-    Base: TBase,
-) {
-    return class UtilsMixinClass extends Base {
-        // ─── Utils (QR / 바코드) ──────────────────────────────────────────────
-
-        /**
-         * QR 코드 PNG를 생성합니다. `ArrayBuffer`를 반환합니다.
-         *
-         * ```ts
-         * const buf = await client.qrcode("https://example.com");
-         * const blob = new Blob([buf], { type: "image/png" });
-         * img.src = URL.createObjectURL(blob);
-         * ```
-         */
-        qrcode(
-            content: string,
-            opts: QRCodeOptions = {},
-        ): Promise<ArrayBuffer> {
-            return this._requestBinary("POST", "/v1/utils/qrcode", {
-                content,
-                ...opts,
-            });
-        }
-
-        /**
-         * QR 코드를 base64/data URI JSON으로 반환합니다.
-         *
-         * ```ts
-         * const { data_uri } = await client.qrcodeBase64("https://example.com");
-         * img.src = data_uri;
-         * ```
-         */
-        qrcodeBase64(
-            content: string,
-            opts: QRCodeOptions = {},
-        ): Promise<{ ok: boolean; data: string; data_uri: string }> {
-            return this._request("POST", "/v1/utils/qrcode/base64", {
-                content,
-                ...opts,
-            });
-        }
-
-        /** QR 코드를 ASCII 아트 텍스트로 반환합니다. */
-        qrcodeText(
-            content: string,
-            opts: QRCodeOptions = {},
-        ): Promise<{ ok: boolean; text: string }> {
-            return this._request("POST", "/v1/utils/qrcode/text", {
-                content,
-                ...opts,
-            });
-        }
-
-        /**
-         * 바코드 PNG를 생성합니다. `ArrayBuffer`를 반환합니다.
-         *
-         * ```ts
-         * const buf = await client.barcode("1234567890128", { type: "ean13" });
-         * ```
-         */
-        barcode(
-            content: string,
-            opts: BarcodeOptions = {},
-        ): Promise<ArrayBuffer> {
-            return this._requestBinary("POST", "/v1/utils/barcode", {
-                content,
-                ...opts,
-            });
-        }
-
-        /**
-         * PDF를 PNG 이미지로 변환합니다.
-         *
-         * 단일 페이지 요청이면 `image/png` ArrayBuffer,
-         * 다중 페이지 요청이면 `application/zip` ArrayBuffer를 반환합니다.
-         *
-         * ```ts
-         * const buf = await client.pdf2png(pdfArrayBuffer, { dpi: 200 });
-         * ```
-         */
-        pdf2png(
-            pdfData: ArrayBuffer | Uint8Array<ArrayBuffer>,
-            opts: Pdf2PngOptions = {},
-        ): Promise<ArrayBuffer> {
-            const form = new FormData();
-            form.append(
-                "file",
-                new Blob([pdfData], { type: "application/pdf" }),
-                "document.pdf",
-            );
-            const params = new URLSearchParams();
-            if (opts.dpi != null) params.set("dpi", String(opts.dpi));
-            if (opts.firstPage != null)
-                params.set("first_page", String(opts.firstPage));
-            if (opts.lastPage != null)
-                params.set("last_page", String(opts.lastPage));
-            const qs = params.toString();
-            const path = "/v1/utils/pdf2png" + (qs ? `?${qs}` : "");
-            return this._requestFormBinary("POST", path, form);
-        }
-    };
-}

package/src/packet.ts

@@ -1,84 +0,0 @@
-// @ts-ignore
-import { xchacha20poly1305 } from "@noble/ciphers/chacha";
-// @ts-ignore
-import { sha256 } from "@noble/hashes/sha2";
-// @ts-ignore
-import { hkdf } from "@noble/hashes/hkdf";
-
-export const PACKET_KEY_SIZE = 32;
-export const PACKET_MAGIC_MIN = 2;
-export const PACKET_MAGIC_RANGE = 14;
-export const PACKET_NONCE_SIZE = 24;
-export const PACKET_TAG_SIZE = 16;
-export const PACKET_HKDF_SALT = "entity-server:hkdf:v1";
-export const PACKET_INFO_LABEL = "entity-server:packet-encryption";
-
-function toUint8Array(data: ArrayBuffer | Uint8Array): Uint8Array {
-    return data instanceof Uint8Array ? data : new Uint8Array(data);
-}
-
-export function derivePacketKey(
-    source: string,
-    infoLabel = PACKET_INFO_LABEL,
-): Uint8Array {
-    return hkdf(
-        sha256,
-        new TextEncoder().encode(source),
-        new TextEncoder().encode(PACKET_HKDF_SALT),
-        new TextEncoder().encode(infoLabel),
-        PACKET_KEY_SIZE,
-    );
-}
-
-export function packetMagicLenFromKey(
-    key: ArrayBuffer | Uint8Array,
-    magicMin = PACKET_MAGIC_MIN,
-    magicRange = PACKET_MAGIC_RANGE,
-): number {
-    const keyBytes = toUint8Array(key);
-    if (keyBytes.length < PACKET_KEY_SIZE) return magicMin;
-    return magicMin + (keyBytes[PACKET_KEY_SIZE - 1]! % magicRange);
-}
-
-export function encryptPacket(
-    plaintext: ArrayBuffer | Uint8Array,
-    key: ArrayBuffer | Uint8Array,
-    magicMin = PACKET_MAGIC_MIN,
-    magicRange = PACKET_MAGIC_RANGE,
-): Uint8Array {
-    const plaintextBytes = toUint8Array(plaintext);
-    const keyBytes = toUint8Array(key);
-    const magicLen = packetMagicLenFromKey(keyBytes, magicMin, magicRange);
-    const magic = crypto.getRandomValues(new Uint8Array(magicLen));
-    const nonce = crypto.getRandomValues(new Uint8Array(PACKET_NONCE_SIZE));
-    const cipher = xchacha20poly1305(keyBytes, nonce);
-    const ciphertext = cipher.encrypt(plaintextBytes);
-    const result = new Uint8Array(
-        magicLen + PACKET_NONCE_SIZE + ciphertext.length,
-    );
-
-    result.set(magic, 0);
-    result.set(nonce, magicLen);
-    result.set(ciphertext, magicLen + PACKET_NONCE_SIZE);
-    return result;
-}
-
-export function decryptPacket(
-    buffer: ArrayBuffer | Uint8Array,
-    key: ArrayBuffer | Uint8Array,
-    magicMin = PACKET_MAGIC_MIN,
-    magicRange = PACKET_MAGIC_RANGE,
-): Uint8Array {
-    const data = toUint8Array(buffer);
-    const keyBytes = toUint8Array(key);
-    const magicLen = packetMagicLenFromKey(keyBytes, magicMin, magicRange);
-
-    if (data.length < magicLen + PACKET_NONCE_SIZE + PACKET_TAG_SIZE) {
-        throw new Error("Encrypted packet too short");
-    }
-
-    const nonce = data.slice(magicLen, magicLen + PACKET_NONCE_SIZE);
-    const ciphertext = data.slice(magicLen + PACKET_NONCE_SIZE);
-    const cipher = xchacha20poly1305(keyBytes, nonce);
-    return cipher.decrypt(ciphertext);
-}

package/tests/packet.test.mjs

@@ -1,50 +0,0 @@
-import test from "node:test";
-import assert from "node:assert/strict";
-
-import {
-    derivePacketKey,
-    packetMagicLenFromKey,
-    encryptPacket,
-    decryptPacket,
-    PACKET_MAGIC_MIN,
-    PACKET_MAGIC_RANGE,
-    PACKET_NONCE_SIZE,
-    PACKET_TAG_SIZE,
-} from "../dist/packet.js";
-
-test("packet core roundtrips plaintext", () => {
-    const key = derivePacketKey("packet-test-token");
-    const payload = new TextEncoder().encode(
-        JSON.stringify({ ok: true, message: "hello" }),
-    );
-
-    const encrypted = encryptPacket(payload, key);
-    const decrypted = decryptPacket(encrypted, key);
-
-    assert.equal(
-        new TextDecoder().decode(decrypted),
-        JSON.stringify({ ok: true, message: "hello" }),
-    );
-});
-
-test("packet core derives a stable magic length from key", () => {
-    const key = derivePacketKey("packet-test-token");
-    const magicLen = packetMagicLenFromKey(key);
-
-    assert.ok(magicLen >= PACKET_MAGIC_MIN);
-    assert.ok(magicLen < PACKET_MAGIC_MIN + PACKET_MAGIC_RANGE);
-    assert.equal(magicLen, packetMagicLenFromKey(key));
-});
-
-test("encrypted packet has expected minimum shape", () => {
-    const key = derivePacketKey("packet-test-token");
-    const payload = new TextEncoder().encode("abc");
-    const magicLen = packetMagicLenFromKey(key);
-
-    const encrypted = encryptPacket(payload, key);
-
-    assert.ok(
-        encrypted.length >=
-            magicLen + PACKET_NONCE_SIZE + PACKET_TAG_SIZE + payload.length,
-    );
-});

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2022",
-        "module": "ESNext",
-        "moduleResolution": "Bundler",
-        "declaration": true,
-        "outDir": "dist",
-        "strict": true,
-        "skipLibCheck": true
-    },
-    "include": [
-        "src"
-    ]
-}