@mpgd/game-services 0.10.0 → 0.11.0

package/dist/apps-in-toss-partner-api.d.ts

@@ -0,0 +1,48 @@
+import type { NotificationTemplateData } from './notification-delivery';
+export declare const appsInTossPartnerApiBaseUrl = "https://apps-in-toss-api.toss.im";
+export declare const defaultAppsInTossPartnerApiTimeoutMs = 10000;
+/** Compatible with a Cloudflare mTLS certificate binding (`env.BINDING.fetch`). */
+export interface AppsInTossMutualTlsFetcher {
+  fetch(input: string, init?: RequestInit): Promise<Response>;
+}
+export type AppsInTossMessageRecipient = {
+  readonly type: 'anonymous';
+  readonly key: string;
+} | {
+  readonly type: 'toss-user';
+  readonly key: string;
+};
+export interface SendAppsInTossFunctionalMessageInput {
+  readonly recipient: AppsInTossMessageRecipient;
+  readonly templateSetCode: string;
+  readonly context: NotificationTemplateData;
+  readonly signal?: AbortSignal;
+}
+export interface AppsInTossFunctionalMessageResult {
+  readonly messageCount: number;
+  readonly sentPushCount: number;
+  readonly sentInboxCount: number;
+  readonly sentSmsCount: number;
+  readonly sentAlimtalkCount: number;
+  readonly sentFriendtalkCount: number;
+  readonly contentIds: readonly string[];
+}
+export interface AppsInTossPartnerApiClient {
+  verifyAnonymousKey(input: {
+    readonly anonymousKey: string;
+    readonly signal?: AbortSignal;
+  }): Promise<boolean>;
+  sendFunctionalMessage(input: SendAppsInTossFunctionalMessageInput): Promise<AppsInTossFunctionalMessageResult>;
+}
+export interface CreateAppsInTossPartnerApiClientInput {
+  readonly mtls: AppsInTossMutualTlsFetcher;
+  readonly baseUrl?: string;
+  readonly timeoutMs?: number;
+}
+export declare class AppsInTossPartnerApiError extends Error {
+  readonly status: number;
+  readonly code?: string | undefined;
+  readonly name = "AppsInTossPartnerApiError";
+  constructor(message: string, status: number, code?: string | undefined, options?: ErrorOptions);
+}
+export declare function createAppsInTossPartnerApiClient(input: CreateAppsInTossPartnerApiClientInput): AppsInTossPartnerApiClient;

package/dist/apps-in-toss-partner-api.js

@@ -0,0 +1,282 @@
+export const appsInTossPartnerApiBaseUrl = 'https://apps-in-toss-api.toss.im';
+export const defaultAppsInTossPartnerApiTimeoutMs = 10000;
+const verifyAnonymousKeyPath = 'api-partner/v1/apps-in-toss/users/anon-key/verify';
+const sendFunctionalMessagePath = 'api-partner/v1/apps-in-toss/messenger/send-message';
+const maximumResponseBodyBytes = 256 * 1024;
+export class AppsInTossPartnerApiError extends Error {
+    status;
+    code;
+    name = 'AppsInTossPartnerApiError';
+    constructor(message, status, code, options) {
+        super(message, options);
+        this.status = status;
+        this.code = code;
+    }
+}
+export function createAppsInTossPartnerApiClient(input) {
+    const baseUrl = normalizeBaseUrl(input.baseUrl ?? appsInTossPartnerApiBaseUrl);
+    const timeoutMs = normalizeTimeout(input.timeoutMs);
+    return {
+        async verifyAnonymousKey(request) {
+            const anonymousKey = normalizeIdentifier(request.anonymousKey, 'anonymousKey');
+            const response = await postJson({
+                mtls: input.mtls,
+                url: new URL(verifyAnonymousKeyPath, baseUrl).href,
+                headers: { 'x-anon-key': anonymousKey },
+                body: undefined,
+                timeoutMs,
+                ...(request.signal === undefined ? {} : { signal: request.signal }),
+            });
+            if (response.status === 401) {
+                return false;
+            }
+            const envelope = requireSuccessEnvelope(response);
+            if (envelope.success !== 'true') {
+                throw new AppsInTossPartnerApiError('Apps in Toss returned an invalid anonymous-key verification response.', response.status);
+            }
+            return true;
+        },
+        async sendFunctionalMessage(request) {
+            const recipient = normalizeRecipient(request.recipient);
+            const templateSetCode = normalizeIdentifier(request.templateSetCode, 'templateSetCode');
+            const response = await postJson({
+                mtls: input.mtls,
+                url: new URL(sendFunctionalMessagePath, baseUrl).href,
+                headers: recipient.type === 'anonymous'
+                    ? { 'x-anon-key': recipient.key }
+                    : { 'x-toss-user-key': recipient.key },
+                body: {
+                    templateSetCode,
+                    context: normalizeContext(request.context),
+                },
+                timeoutMs,
+                ...(request.signal === undefined ? {} : { signal: request.signal }),
+            });
+            const envelope = requireSuccessEnvelope(response);
+            return parseFunctionalMessageResult(envelope.success, response.status);
+        },
+    };
+}
+async function postJson(input) {
+    const timeout = createTimeoutSignal(input.signal, input.timeoutMs);
+    try {
+        // The documented anonymous-key verification request uses an empty body
+        // while still declaring application/json.
+        const requestBody = input.body === undefined ? '' : JSON.stringify(input.body);
+        const headers = new Headers({
+            accept: 'application/json',
+            'content-type': 'application/json',
+            ...input.headers,
+        });
+        let response;
+        let text;
+        try {
+            response = await input.mtls.fetch(input.url, {
+                method: 'POST',
+                headers,
+                body: requestBody,
+                signal: timeout.signal,
+            });
+            text = await readBoundedResponseText(response);
+        }
+        catch (error) {
+            throw normalizeTransportError(error, input.signal, timeout.signal);
+        }
+        let body;
+        try {
+            body = text.length === 0 ? undefined : JSON.parse(text);
+        }
+        catch {
+            throw new AppsInTossPartnerApiError('Apps in Toss returned a non-JSON response.', response.status);
+        }
+        return { status: response.status, ok: response.ok, body };
+    }
+    finally {
+        timeout.cleanup();
+    }
+}
+function normalizeTransportError(error, upstream, effective) {
+    if (error instanceof AppsInTossPartnerApiError) {
+        return error;
+    }
+    if (effective.aborted && upstream?.aborted !== true) {
+        return new AppsInTossPartnerApiError('Apps in Toss partner API request timed out.', 0, 'TIMEOUT', { cause: error });
+    }
+    if (upstream?.aborted === true) {
+        return new AppsInTossPartnerApiError('Apps in Toss partner API request was aborted.', 0, 'ABORTED', { cause: error });
+    }
+    return new AppsInTossPartnerApiError('Apps in Toss partner API transport failed.', 0, 'TRANSPORT_ERROR', { cause: error });
+}
+async function readBoundedResponseText(response) {
+    const declaredLength = response.headers.get('content-length');
+    if (declaredLength !== null
+        && /^\d+$/u.test(declaredLength)
+        && Number(declaredLength) > maximumResponseBodyBytes) {
+        throw responseTooLarge(response.status);
+    }
+    if (response.body === null) {
+        return '';
+    }
+    const reader = response.body.getReader();
+    const chunks = [];
+    let byteLength = 0;
+    try {
+        while (true) {
+            const chunk = await reader.read();
+            if (chunk.done) {
+                break;
+            }
+            byteLength += chunk.value.byteLength;
+            if (byteLength > maximumResponseBodyBytes) {
+                await reader.cancel().catch(() => { });
+                throw responseTooLarge(response.status);
+            }
+            chunks.push(chunk.value);
+        }
+    }
+    finally {
+        reader.releaseLock();
+    }
+    const bytes = new Uint8Array(byteLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+        bytes.set(chunk, offset);
+        offset += chunk.byteLength;
+    }
+    try {
+        return new TextDecoder('utf-8', { fatal: true }).decode(bytes);
+    }
+    catch {
+        throw new AppsInTossPartnerApiError('Apps in Toss returned a non-UTF-8 response.', response.status);
+    }
+}
+function responseTooLarge(status) {
+    return new AppsInTossPartnerApiError('Apps in Toss response exceeded the maximum accepted size.', status);
+}
+function requireSuccessEnvelope(response) {
+    if (!isRecord(response.body)) {
+        throw new AppsInTossPartnerApiError('Apps in Toss returned an invalid response envelope.', response.status);
+    }
+    if (response.ok && response.body.resultType === 'SUCCESS') {
+        return response.body;
+    }
+    const error = isRecord(response.body.error) ? response.body.error : undefined;
+    const code = typeof error?.errorCode === 'string' ? error.errorCode : undefined;
+    const reason = typeof error?.reason === 'string'
+        ? error.reason.slice(0, 1024)
+        : 'Apps in Toss partner API request failed.';
+    throw new AppsInTossPartnerApiError(reason, response.status, code);
+}
+function parseFunctionalMessageResult(input, status) {
+    if (!isRecord(input)) {
+        throw new AppsInTossPartnerApiError('Apps in Toss returned an invalid message result.', status);
+    }
+    return {
+        messageCount: requireCount(input.msgCount, 'msgCount', status),
+        sentPushCount: requireCount(input.sentPushCount, 'sentPushCount', status),
+        sentInboxCount: requireCount(input.sentInboxCount, 'sentInboxCount', status),
+        sentSmsCount: requireCount(input.sentSmsCount, 'sentSmsCount', status),
+        sentAlimtalkCount: requireCount(input.sentAlimtalkCount, 'sentAlimtalkCount', status),
+        sentFriendtalkCount: requireCount(input.sentFriendtalkCount, 'sentFriendtalkCount', status),
+        contentIds: readContentIds(input.detail),
+    };
+}
+function readContentIds(detail) {
+    if (!isRecord(detail)) {
+        return [];
+    }
+    const ids = new Set();
+    for (const channel of ['sentPush', 'sentInbox', 'sentSms', 'sentAlimtalk', 'sentFriendtalk']) {
+        const entries = detail[channel];
+        if (!Array.isArray(entries)) {
+            continue;
+        }
+        for (const entry of entries) {
+            if (isRecord(entry) && typeof entry.contentId === 'string' && entry.contentId.length > 0) {
+                ids.add(entry.contentId);
+            }
+        }
+    }
+    return [...ids];
+}
+function requireCount(value, field, status) {
+    if (!Number.isSafeInteger(value) || value < 0) {
+        throw new AppsInTossPartnerApiError(`Apps in Toss returned an invalid ${field}.`, status);
+    }
+    return value;
+}
+function normalizeRecipient(input) {
+    if (input.type !== 'anonymous' && input.type !== 'toss-user') {
+        throw new TypeError('AIT message recipient type is invalid.');
+    }
+    return { type: input.type, key: normalizeIdentifier(input.key, 'recipient.key') };
+}
+function normalizeContext(input) {
+    const entries = Object.entries(input);
+    if (entries.length > 128) {
+        throw new TypeError('AIT message context cannot contain more than 128 values.');
+    }
+    const output = Object.create(null);
+    for (const [key, value] of entries) {
+        const normalizedKey = normalizeIdentifier(key, 'context key');
+        if (typeof value !== 'string'
+            && typeof value !== 'number'
+            && typeof value !== 'boolean') {
+            throw new TypeError(`AIT message context value is invalid: ${normalizedKey}`);
+        }
+        if (typeof value === 'number' && !Number.isFinite(value)) {
+            throw new TypeError(`AIT message context number is invalid: ${normalizedKey}`);
+        }
+        output[normalizedKey] = value;
+    }
+    return output;
+}
+function normalizeIdentifier(value, field) {
+    const normalized = value.trim();
+    if (normalized.length === 0
+        || normalized.length > 2048
+        || /[\p{Cc}\p{Cf}]/u.test(normalized)) {
+        throw new TypeError(`${field} must contain 1 to 2048 characters without control or format characters.`);
+    }
+    return normalized;
+}
+function normalizeBaseUrl(input) {
+    const url = new URL(input);
+    if (url.protocol !== 'https:'
+        || url.username.length > 0
+        || url.password.length > 0
+        || url.search.length > 0
+        || url.hash.length > 0) {
+        throw new TypeError('AIT partner API baseUrl must be a credential-free HTTPS URL.');
+    }
+    url.pathname = url.pathname.endsWith('/') ? url.pathname : `${url.pathname}/`;
+    return url;
+}
+function normalizeTimeout(value) {
+    const timeoutMs = value ?? defaultAppsInTossPartnerApiTimeoutMs;
+    if (!Number.isFinite(timeoutMs) || timeoutMs <= 0 || timeoutMs > 60000) {
+        throw new TypeError('AIT partner API timeoutMs must be between 1 and 60000.');
+    }
+    return timeoutMs;
+}
+function createTimeoutSignal(upstream, timeoutMs) {
+    const controller = new AbortController();
+    const abortFromUpstream = () => controller.abort(upstream?.reason);
+    if (upstream?.aborted === true) {
+        abortFromUpstream();
+    }
+    else {
+        upstream?.addEventListener('abort', abortFromUpstream, { once: true });
+    }
+    const timer = globalThis.setTimeout(() => controller.abort(new Error('Apps in Toss partner API request timed out.')), timeoutMs);
+    return {
+        signal: controller.signal,
+        cleanup() {
+            globalThis.clearTimeout(timer);
+            upstream?.removeEventListener('abort', abortFromUpstream);
+        },
+    };
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './admob-ssv.js';
 export * from './app-store-verifier';
 export * from './apps-in-toss-evidence-verification';
+export * from './apps-in-toss-partner-api';
 export * from './client';
 export * from './contract';
 export * from './evidence-verification';

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './admob-ssv.js';
 export * from './app-store-verifier';
 export * from './apps-in-toss-evidence-verification';
+export * from './apps-in-toss-partner-api';
 export * from './client';
 export * from './contract';
 export * from './evidence-verification';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/game-services",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Client, contract, server, store, and test helpers for authoritative mpgd game services.",
   "license": "MIT",
   "repository": {
@@ -53,6 +53,10 @@
       "types": "./dist/apps-in-toss-evidence-verification-conformance.d.ts",
       "default": "./dist/apps-in-toss-evidence-verification-conformance.js"
     },
+    "./apps-in-toss-partner-api": {
+      "types": "./dist/apps-in-toss-partner-api.d.ts",
+      "default": "./dist/apps-in-toss-partner-api.js"
+    },
     "./client": {
       "types": "./dist/client.d.ts",
       "default": "./dist/client.js"
@@ -122,9 +126,9 @@
     "@orpc/client": "2.0.0-beta.14",
     "@orpc/contract": "2.0.0-beta.14",
     "@orpc/server": "2.0.0-beta.14",
-    "@mpgd/catalog": "0.5.0",
-    "@mpgd/platform": "0.7.0",
-    "@mpgd/analytics": "0.3.7"
+    "@mpgd/catalog": "0.5.1",
+    "@mpgd/analytics": "0.3.8",
+    "@mpgd/platform": "0.8.0"
   },
   "devDependencies": {
     "ttsc": "0.18.4",
@@ -140,6 +144,6 @@
     "lint": "ttsc --noEmit",
     "format": "ttsc format",
     "fix": "ttsc fix",
-    "test": "cd ../.. && node tools/run-ttsx.mjs packages/game-services/src/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/runtime.test.ts && node tools/run-ttsx.mjs packages/game-services/src/types.test.ts && node tools/run-ttsx.mjs packages/game-services/src/server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/platform-order.test.ts && node tools/run-ttsx.mjs packages/game-services/src/progress-link.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notification-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/admob-ssv.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-verifier.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-evidence-verification-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-durability-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-transport.test.ts"
+    "test": "cd ../.. && node tools/run-ttsx.mjs packages/game-services/src/client.test.ts && node tools/run-ttsx.mjs packages/game-services/src/runtime.test.ts && node tools/run-ttsx.mjs packages/game-services/src/types.test.ts && node tools/run-ttsx.mjs packages/game-services/src/server.test.ts && node tools/run-ttsx.mjs packages/game-services/src/google-play-purchase.test.ts && node tools/run-ttsx.mjs packages/game-services/src/platform-order.test.ts && node tools/run-ttsx.mjs packages/game-services/src/progress-link.test.ts && node tools/run-ttsx.mjs packages/game-services/src/notification-delivery.test.ts && node tools/run-ttsx.mjs packages/game-services/src/admob-ssv.test.ts && node tools/run-ttsx.mjs packages/game-services/src/app-store-verifier.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-evidence-verification-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/apps-in-toss-partner-api.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-durability-conformance.test.ts && node tools/run-ttsx.mjs packages/game-services/src/verified-leaderboard-transport.test.ts"
   }
 }