@apps-in-toss/native-modules 2.4.2 → 2.4.4

package/dist/bridges-meta.json

@@ -73,7 +73,7 @@
   },
   {
     "identifier": "eventLog",
-    "dts": "export type Primitive = string | number | boolean | null | undefined | symbol;\nexport interface EventLogParams {\n\tlog_name: string;\n\tlog_type: \"debug\" | \"info\" | \"warn\" | \"error\" | \"event\" | \"screen\" | \"impression\" | \"click\";\n\tparams: Record<string, Primitive>;\n}\n/**\n * @category 로깅\n * @kind function\n * @name eventLog\n * @description\n * 이벤트 로그를 기록하는 함수예요.\n *\n * 이 함수는 앱 내에서 발생하는 다양한 이벤트를 로깅하는 데 사용돼요. 디버깅, 정보 제공, 경고, 오류 등 다양한 유형의 로그를 기록할 수 있어요. 샌드박스 환경에서는 콘솔에 로그가 출력되고, 실제 환경에서는 로그 시스템에 기록돼요.\n *\n * @param {Object} params 로그 기록에 필요한 매개변수 객체예요.\n * @param {string} params.log_name 로그의 이름이에요.\n * @param {'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click'} params.log_type 로그의 유형이에요.\n * @param {Record<string, Primitive>} params.params 로그에 포함할 추가 매개변수 객체예요.\n *\n * @returns {Promise<void>} 로그 기록이 완료되면 해결되는 Promise예요.\n *\n * @example\n * ### 이벤트 로그 기록하기\n *\n * ```tsx\n * import { eventLog } from '@apps-in-toss/framework';\n *\n * function logUserAction() {\n *   eventLog({\n *     log_name: 'user_action',\n *     log_type: 'info',\n *     params: {\n *       action: 'button_click',\n *       screen: 'main',\n *       userId: 12345\n *     }\n *   });\n * }\n * ```\n */\nexport declare function eventLog(params: EventLogParams): Promise<void>;\n\nexport {};\n"
+    "dts": "export type Primitive = string | number | boolean | null | undefined | symbol;\nexport interface EventLogParams {\n\tlog_name: string;\n\tlog_type: \"debug\" | \"info\" | \"warn\" | \"error\" | \"event\" | \"screen\" | \"impression\" | \"click\" | \"popup\";\n\tparams: Record<string, Primitive>;\n}\n/**\n * @category 로깅\n * @kind function\n * @name eventLog\n * @description\n * 이벤트 로그를 기록하는 함수예요.\n *\n * 이 함수는 앱 내에서 발생하는 다양한 이벤트를 로깅하는 데 사용돼요. 디버깅, 정보 제공, 경고, 오류 등 다양한 유형의 로그를 기록할 수 있어요. 샌드박스 환경에서는 콘솔에 로그가 출력되고, 실제 환경에서는 로그 시스템에 기록돼요.\n *\n * @param {Object} params 로그 기록에 필요한 매개변수 객체예요.\n * @param {string} params.log_name 로그의 이름이에요.\n * @param {'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click'} params.log_type 로그의 유형이에요.\n * @param {Record<string, Primitive>} params.params 로그에 포함할 추가 매개변수 객체예요.\n *\n * @returns {Promise<void>} 로그 기록이 완료되면 해결되는 Promise예요.\n *\n * @example\n * ### 이벤트 로그 기록하기\n *\n * ```tsx\n * import { eventLog } from '@apps-in-toss/framework';\n *\n * function logUserAction() {\n *   eventLog({\n *     log_name: 'user_action',\n *     log_type: 'info',\n *     params: {\n *       action: 'button_click',\n *       screen: 'main',\n *       userId: 12345\n *     }\n *   });\n * }\n * ```\n */\nexport declare function eventLog(params: EventLogParams): Promise<void>;\n\nexport {};\n"
   },
   {
     "identifier": "getTossShareLink",
@@ -107,9 +107,13 @@
     "identifier": "submitGameCenterLeaderBoardScore",
     "dts": "/**\n * @public\n * @category 게임센터\n * @name SubmitGameCenterLeaderBoardScoreResponse\n * @description\n * 토스게임센터 리더보드에 점수를 제출한 결과 정보를 담아서 반환해요. 반환된 정보를 사용해서 점수 제출 결과에 따라 적절한 에러 처리를 할 수 있어요.\n * @property {'SUCCESS' | 'LEADERBOARD_NOT_FOUND' | 'PROFILE_NOT_FOUND' | 'UNPARSABLE_SCORE'} statusCode\n * 점수 제출 결과를 나타내는 상태 코드예요.\n * - `'SUCCESS'`: 점수 제출이 성공했어요.\n * - `'LEADERBOARD_NOT_FOUND'`: `gameId`에 해당하는 리더보드를 찾을 수 없어요.\n * - `'PROFILE_NOT_FOUND'`: 사용자의 프로필이 없어요.\n * - `'UNPARSABLE_SCORE'`: 점수를 해석할 수 없어요. 점수는 실수(float) 형태의 문자열로 전달해야 해요.\n */\nexport interface SubmitGameCenterLeaderBoardScoreResponse {\n\tstatusCode: \"SUCCESS\" | \"LEADERBOARD_NOT_FOUND\" | \"PROFILE_NOT_FOUND\" | \"UNPARSABLE_SCORE\";\n}\n/**\n * @public\n * @category 게임센터\n * @name submitGameCenterLeaderBoardScore\n * @description\n * 사용자의 게임 점수를 토스게임센터 리더보드에 제출해요. 이 기능으로 사용자의 점수를 공식 리더보드에 기록하고 다른 사용자와 비교할 수 있어요.\n * @param {string} params.score\n * 제출할 게임 점수예요. 실수 형태의 숫자를 문자열로 전달해야 해요. 예를들어 `\"123.45\"` 또는 `\"9999\"` 예요.\n * @returns {Promise<SubmitGameCenterLeaderBoardScoreResponse | undefined>}\n * 점수 제출 결과를 반환해요. 앱 버전이 최소 지원 버전보다 낮으면 아무 동작도 하지 않고 `undefined`를 반환해요.\n *\n * @example\n * ### 게임 점수를 토스게임센터 리더보드에 제출하기\n * ```tsx\n * import { Button } from 'react-native';\n * import { submitGameCenterLeaderBoardScore } from '@apps-in-toss/framework';\n *\n * function GameCenterLeaderBoardScoreSubmitButton() {\n *   async function handlePress() {\n *     try {\n *       const result = await submitGameCenterLeaderBoardScore({ score: '123.45' });\n *\n *       if (!result) {\n *         console.warn('지원하지 않는 앱 버전이에요.');\n *         return;\n *       }\n *\n *       if (result.statusCode === 'SUCCESS') {\n *         console.log('점수 제출 성공!');\n *       } else {\n *         console.error('점수 제출 실패:', result.statusCode);\n *       }\n *     } catch (error) {\n *       console.error('점수 제출 중 오류가 발생했어요.', error);\n *     }\n *   }\n *\n *   return (\n *     <Button onPress={handlePress}>점수 제출하기</Button>\n *   );\n * }\n * ```\n */\nexport declare function submitGameCenterLeaderBoardScore(params: {\n\tscore: string;\n}): Promise<SubmitGameCenterLeaderBoardScoreResponse | undefined>;\n\nexport {};\n"
   },
+  {
+    "identifier": "getUserKey",
+    "dts": "export interface GetUserKeySuccessResponse {\n\thash: string;\n\ttype: \"HASH\";\n}\nexport interface GetUserKeyErrorResponse {\n\ttype: \"NOT_AVAILABLE\";\n}\nexport type GetUserKeyResponse = GetUserKeySuccessResponse | GetUserKeyErrorResponse;\n/**\n * @public\n * @name getUserKey\n * @description\n * 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.\n * @returns {Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>}\n * 사용자 키 조회 결과를 반환해요.\n * - `GetUserKeySuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.\n * - `'ERROR'`: 알 수 없는 오류가 발생했어요.\n * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.\n *\n * @example\n * ```tsx\n * // react-native\n * import { Button } from 'react-native';\n * import { getUserKey } from '@apps-in-toss/framework';\n *\n * function UserKeyButton() {\n *   async function handlePress() {\n *     const result = await getUserKey();\n *\n *     if (!result) {\n *       console.warn('지원하지 않는 앱 버전이에요.');\n *       return;\n *     }\n *\n *     if (result === 'ERROR') {\n *       console.error('사용자 키 조회 중 오류가 발생했어요.');\n *       return;\n *     }\n *\n *     if (result.type === 'HASH') {\n *       console.log('사용자 키:', result.hash);\n *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.\n *     }\n *   }\n *\n *   return (\n *     <Button onPress={handlePress} title=\"유저 키 가져오기\" />\n *   );\n * }\n * ```\n *\n * @example\n * ```tsx\n * // webview\n * import { getUserKey } from '@apps-in-toss/web-framework';\n *\n * function UserKeyButton() {\n *   async function handleClick() {\n *     const result = await getUserKey();\n *\n *     if (!result) {\n *       console.warn('지원하지 않는 앱 버전이에요.');\n *       return;\n *     }\n *\n *     if (result === 'ERROR') {\n *       console.error('사용자 키 조회 중 오류가 발생했어요.');\n *       return;\n *     }\n *\n *     if (result.type === 'HASH') {\n *       console.log('사용자 키:', result.hash);\n *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.\n *     }\n *   }\n *\n *   return (\n *     <button onClick={handleClick}>유저 키 가져오기</button>\n *   );\n * }\n * ```\n */\nexport declare function getUserKey(): Promise<GetUserKeySuccessResponse | \"ERROR\" | undefined>;\n\nexport {};\n"
+  },
   {
     "identifier": "getUserKeyForGame",
-    "dts": "export interface GetUserKeyForGameSuccessResponse {\n\thash: string;\n\ttype: \"HASH\";\n}\nexport interface GetUserKeyForGameErrorResponse {\n\ttype: \"NOT_AVAILABLE\";\n}\nexport type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyForGameErrorResponse;\n/**\n * @public\n * @category 게임\n * @name getUserKeyForGame\n * @description\n * 게임 카테고리 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.\n * 게임 카테고리가 아닌 미니앱에서 호출하면 `'INVALID_CATEGORY'`를 반환해요.\n * @returns {Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>}\n * 사용자 키 조회 결과를 반환해요.\n * - `GetUserKeyForGameSuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.\n * - `'INVALID_CATEGORY'`: 게임 카테고리가 아닌 미니앱에서 호출했어요.\n * - `'ERROR'`: 알 수 없는 오류가 발생했어요.\n * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.\n *\n * @example\n * ```tsx\n * // react-native\n * import { Button } from 'react-native';\n * import { getUserKeyForGame } from '@apps-in-toss/framework';\n *\n * function GameUserKeyButton() {\n *   async function handlePress() {\n *       const result = await getUserKeyForGame();\n *\n *       if (!result) {\n *         console.warn('지원하지 않는 앱 버전이에요.');\n *         return;\n *       }\n *\n *       if (result === 'INVALID_CATEGORY') {\n *         console.error('게임 카테고리가 아닌 미니앱이에요.');\n *         return;\n *       }\n *\n *       if (result === 'ERROR') {\n *         console.error('사용자 키 조회 중 오류가 발생했어요.');\n *         return;\n *       }\n *\n *       if (result.type === 'HASH') {\n *         console.log('사용자 키:', result.hash);\n *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.\n *       }\n *   }\n *\n *   return (\n *     <Button onPress={handlePress} title=\"유저 키 가져오기\" />\n *   );\n * }\n * ```\n *\n * @example\n * ```tsx\n * // webview\n * import { getUserKeyForGame } from '@apps-in-toss/web-framework';\n *\n * function GameUserKeyButton() {\n *   async function handleClick() {\n *       const result = await getUserKeyForGame();\n *\n *       if (!result) {\n *         console.warn('지원하지 않는 앱 버전이에요.');\n *         return;\n *       }\n *\n *       if (result === 'INVALID_CATEGORY') {\n *         console.error('게임 카테고리가 아닌 미니앱이에요.');\n *         return;\n *       }\n *\n *       if (result === 'ERROR') {\n *         console.error('사용자 키 조회 중 오류가 발생했어요.');\n *         return;\n *       }\n *\n *       if (result.type === 'HASH') {\n *         console.log('사용자 키:', result.hash);\n *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.\n *       }\n *   }\n *\n *   return (\n *     <button onClick={handleClick}>유저 키 가져오기</button>\n *   );\n * }\n * ```\n */\nexport declare function getUserKeyForGame(): Promise<GetUserKeyForGameSuccessResponse | \"INVALID_CATEGORY\" | \"ERROR\" | undefined>;\n\nexport {};\n"
+    "dts": "export interface GetUserKeySuccessResponse {\n\thash: string;\n\ttype: \"HASH\";\n}\nexport interface GetUserKeyErrorResponse {\n\ttype: \"NOT_AVAILABLE\";\n}\nexport type GetUserKeyResponse = GetUserKeySuccessResponse | GetUserKeyErrorResponse;\n/**\n * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeySuccessResponse}를 사용해주세요.\n */\nexport type GetUserKeyForGameSuccessResponse = GetUserKeySuccessResponse;\n/**\n * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyErrorResponse}를 사용해주세요.\n */\nexport type GetUserKeyForGameErrorResponse = GetUserKeyErrorResponse;\n/**\n * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyResponse}를 사용해주세요.\n */\nexport type GetUserKeyForGameResponse = GetUserKeyResponse;\n/**\n *\n * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link getUserKey}를 사용해주세요.\n */\nexport declare function getUserKeyForGame(): Promise<GetUserKeyForGameSuccessResponse | \"INVALID_CATEGORY\" | \"ERROR\" | undefined>;\n\nexport {};\n"
   },
   {
     "identifier": "grantPromotionReward",

package/dist/index.cjs

@@ -51,6 +51,7 @@ __export(index_exports, {
   getServerTime: () => getServerTime,
   getTossAppVersion: () => getTossAppVersion,
   getTossShareLink: () => getTossShareLink,
+  getUserKey: () => getUserKey,
   getUserKeyForGame: () => getUserKeyForGame,
   grantPromotionReward: () => grantPromotionReward,
   grantPromotionRewardForGame: () => grantPromotionRewardForGame,
@@ -888,7 +889,7 @@ var GAME_CENTER_MIN_VERSION = {
   android: "5.221.0",
   ios: "5.221.0"
 };
-var GAME_USER_KEY_MIN_VERSION = {
+var USER_KEY_MIN_VERSION = {
   android: "5.232.0",
   ios: "5.232.0"
 };
@@ -938,9 +939,9 @@ async function submitGameCenterLeaderBoardScore(params) {
   return safePostMessage("submitGameCenterLeaderBoardScore", params);
 }
 
-// src/MiniAppModule/native-modules/getUserKeyForGame.ts
-async function getUserKeyForGame() {
-  const isSupported = isMinVersionSupported(GAME_USER_KEY_MIN_VERSION);
+// src/MiniAppModule/native-modules/getUserKey.ts
+async function getUserKey() {
+  const isSupported = isMinVersionSupported(USER_KEY_MIN_VERSION);
   if (!isSupported) {
     return;
   }
@@ -949,15 +950,17 @@ async function getUserKeyForGame() {
     if (response.type === "HASH") {
       return response;
     }
-    if (response.type === "NOT_AVAILABLE") {
-      return "INVALID_CATEGORY";
-    }
     return "ERROR";
-  } catch (_) {
+  } catch {
     return "ERROR";
   }
 }
 
+// src/MiniAppModule/native-modules/getUserKeyForGame.ts
+async function getUserKeyForGame() {
+  return getUserKey();
+}
+
 // src/MiniAppModule/native-modules/grantPromotionReward.ts
 function isGrantPromotionRewardError(error) {
   return typeof error === "object" && error !== null && "code" in error && typeof error.code === "string" && "message" in error && typeof error.message === "string";
@@ -1220,6 +1223,7 @@ var INTERNAL__module = {
   getServerTime,
   getTossAppVersion,
   getTossShareLink,
+  getUserKey,
   getUserKeyForGame,
   grantPromotionReward,
   grantPromotionRewardForGame,

package/dist/index.d.cts

@@ -168,25 +168,22 @@ type GameCenterGameProfileResponse = {
  */
 declare function getGameCenterGameProfile(): Promise<GameCenterGameProfileResponse | undefined>;
 
-interface GetUserKeyForGameSuccessResponse {
+interface GetUserKeySuccessResponse {
     hash: string;
     type: 'HASH';
 }
-interface GetUserKeyForGameErrorResponse {
+interface GetUserKeyErrorResponse {
     type: 'NOT_AVAILABLE';
 }
-type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyForGameErrorResponse;
+type GetUserKeyResponse = GetUserKeySuccessResponse | GetUserKeyErrorResponse;
 /**
  * @public
- * @category 게임
- * @name getUserKeyForGame
+ * @name getUserKey
  * @description
- * 게임 카테고리 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
- * 게임 카테고리가 아닌 미니앱에서 호출하면 `'INVALID_CATEGORY'`를 반환해요.
- * @returns {Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>}
+ * 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
+ * @returns {Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>}
  * 사용자 키 조회 결과를 반환해요.
- * - `GetUserKeyForGameSuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
- * - `'INVALID_CATEGORY'`: 게임 카테고리가 아닌 미니앱에서 호출했어요.
+ * - `GetUserKeySuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
  * - `'ERROR'`: 알 수 없는 오류가 발생했어요.
  * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.
  *
@@ -194,31 +191,26 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * ```tsx
  * // react-native
  * import { Button } from 'react-native';
- * import { getUserKeyForGame } from '@apps-in-toss/framework';
+ * import { getUserKey } from '@apps-in-toss/framework';
  *
- * function GameUserKeyButton() {
+ * function UserKeyButton() {
  *   async function handlePress() {
- *       const result = await getUserKeyForGame();
+ *     const result = await getUserKey();
  *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
- *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
  *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
  *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
  *   }
  *
  *   return (
@@ -230,31 +222,26 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * @example
  * ```tsx
  * // webview
- * import { getUserKeyForGame } from '@apps-in-toss/web-framework';
+ * import { getUserKey } from '@apps-in-toss/web-framework';
  *
- * function GameUserKeyButton() {
+ * function UserKeyButton() {
  *   async function handleClick() {
- *       const result = await getUserKeyForGame();
- *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
+ *     const result = await getUserKey();
  *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
  *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
  *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
  *   }
  *
  *   return (
@@ -263,6 +250,24 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * }
  * ```
  */
+declare function getUserKey(): Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>;
+
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeySuccessResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameSuccessResponse = GetUserKeySuccessResponse;
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyErrorResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameErrorResponse = GetUserKeyErrorResponse;
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameResponse = GetUserKeyResponse;
+/**
+ *
+ * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link getUserKey}를 사용해주세요.
+ */
 declare function getUserKeyForGame(): Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>;
 
 interface GrantPromotionRewardForGameSuccessResponse {
@@ -1104,6 +1109,7 @@ interface AsyncMethodsMap {
     appsInTossSignTossCert: (params: AppsInTossSignTossCertParams) => Promise<void>;
     getGameCenterGameProfile: (params: CompatiblePlaceholderArgument) => Promise<GameCenterGameProfileResponse | undefined>;
     getUserKeyForGame: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyForGameResponse | undefined>;
+    getUserKey: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyResponse | undefined>;
     grantPromotionRewardForGame: (params: {
         promotionCode: string;
         amount: number;
@@ -1763,7 +1769,7 @@ type Primitive = string | number | boolean | null | undefined | symbol;
 
 interface EventLogParams {
     log_name: string;
-    log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click';
+    log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click' | 'popup';
     params: Record<string, Primitive>;
 }
 /**
@@ -3310,4 +3316,4 @@ declare const INTERNAL__module: {
     tossCoreEventLog: typeof tossCoreEventLog;
 };
 
-export { type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type GameCenterGameProfileResponse, type GetUserKeyForGameErrorResponse, type GetUserKeyForGameResponse, type GetUserKeyForGameSuccessResponse, GoogleAdMob, type GrantPromotionRewardErrorResponse, type GrantPromotionRewardErrorResult, type GrantPromotionRewardForGameErrorResponse, type GrantPromotionRewardForGameErrorResult, type GrantPromotionRewardForGameResponse, type GrantPromotionRewardForGameSuccessResponse, type GrantPromotionRewardResponse, type GrantPromotionRewardSuccessResponse, type HapticFeedbackType, IAP, INTERNAL__appBridgeHandler, INTERNAL__module, type IapCreateOneTimePurchaseOrderOptions, type IapCreateOneTimePurchaseOrderResult, type IapCreateSubscriptionPurchaseOrderResult, type IapProductListItem, type IapSubscriptionInfoResult, type NetworkStatus, type NonConsumableProductListItem, type Primitive, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openURL, processProductGrant, requestOneTimePurchase, requestReview, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };
+export { type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type GameCenterGameProfileResponse, type GetUserKeyErrorResponse, type GetUserKeyForGameErrorResponse, type GetUserKeyForGameResponse, type GetUserKeyForGameSuccessResponse, type GetUserKeyResponse, type GetUserKeySuccessResponse, GoogleAdMob, type GrantPromotionRewardErrorResponse, type GrantPromotionRewardErrorResult, type GrantPromotionRewardForGameErrorResponse, type GrantPromotionRewardForGameErrorResult, type GrantPromotionRewardForGameResponse, type GrantPromotionRewardForGameSuccessResponse, type GrantPromotionRewardResponse, type GrantPromotionRewardSuccessResponse, type HapticFeedbackType, IAP, INTERNAL__appBridgeHandler, INTERNAL__module, type IapCreateOneTimePurchaseOrderOptions, type IapCreateOneTimePurchaseOrderResult, type IapCreateSubscriptionPurchaseOrderResult, type IapProductListItem, type IapSubscriptionInfoResult, type NetworkStatus, type NonConsumableProductListItem, type Primitive, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKey, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openURL, processProductGrant, requestOneTimePurchase, requestReview, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };

package/dist/index.d.ts

@@ -168,25 +168,22 @@ type GameCenterGameProfileResponse = {
  */
 declare function getGameCenterGameProfile(): Promise<GameCenterGameProfileResponse | undefined>;
 
-interface GetUserKeyForGameSuccessResponse {
+interface GetUserKeySuccessResponse {
     hash: string;
     type: 'HASH';
 }
-interface GetUserKeyForGameErrorResponse {
+interface GetUserKeyErrorResponse {
     type: 'NOT_AVAILABLE';
 }
-type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyForGameErrorResponse;
+type GetUserKeyResponse = GetUserKeySuccessResponse | GetUserKeyErrorResponse;
 /**
  * @public
- * @category 게임
- * @name getUserKeyForGame
+ * @name getUserKey
  * @description
- * 게임 카테고리 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
- * 게임 카테고리가 아닌 미니앱에서 호출하면 `'INVALID_CATEGORY'`를 반환해요.
- * @returns {Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>}
+ * 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
+ * @returns {Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>}
  * 사용자 키 조회 결과를 반환해요.
- * - `GetUserKeyForGameSuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
- * - `'INVALID_CATEGORY'`: 게임 카테고리가 아닌 미니앱에서 호출했어요.
+ * - `GetUserKeySuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
  * - `'ERROR'`: 알 수 없는 오류가 발생했어요.
  * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.
  *
@@ -194,31 +191,26 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * ```tsx
  * // react-native
  * import { Button } from 'react-native';
- * import { getUserKeyForGame } from '@apps-in-toss/framework';
+ * import { getUserKey } from '@apps-in-toss/framework';
  *
- * function GameUserKeyButton() {
+ * function UserKeyButton() {
  *   async function handlePress() {
- *       const result = await getUserKeyForGame();
+ *     const result = await getUserKey();
  *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
- *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
  *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
  *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
  *   }
  *
  *   return (
@@ -230,31 +222,26 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * @example
  * ```tsx
  * // webview
- * import { getUserKeyForGame } from '@apps-in-toss/web-framework';
+ * import { getUserKey } from '@apps-in-toss/web-framework';
  *
- * function GameUserKeyButton() {
+ * function UserKeyButton() {
  *   async function handleClick() {
- *       const result = await getUserKeyForGame();
- *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
+ *     const result = await getUserKey();
  *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
  *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
  *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
  *   }
  *
  *   return (
@@ -263,6 +250,24 @@ type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyFo
  * }
  * ```
  */
+declare function getUserKey(): Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>;
+
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeySuccessResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameSuccessResponse = GetUserKeySuccessResponse;
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyErrorResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameErrorResponse = GetUserKeyErrorResponse;
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyResponse}를 사용해주세요.
+ */
+type GetUserKeyForGameResponse = GetUserKeyResponse;
+/**
+ *
+ * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link getUserKey}를 사용해주세요.
+ */
 declare function getUserKeyForGame(): Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>;
 
 interface GrantPromotionRewardForGameSuccessResponse {
@@ -1104,6 +1109,7 @@ interface AsyncMethodsMap {
     appsInTossSignTossCert: (params: AppsInTossSignTossCertParams) => Promise<void>;
     getGameCenterGameProfile: (params: CompatiblePlaceholderArgument) => Promise<GameCenterGameProfileResponse | undefined>;
     getUserKeyForGame: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyForGameResponse | undefined>;
+    getUserKey: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyResponse | undefined>;
     grantPromotionRewardForGame: (params: {
         promotionCode: string;
         amount: number;
@@ -1763,7 +1769,7 @@ type Primitive = string | number | boolean | null | undefined | symbol;
 
 interface EventLogParams {
     log_name: string;
-    log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click';
+    log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click' | 'popup';
     params: Record<string, Primitive>;
 }
 /**
@@ -3310,4 +3316,4 @@ declare const INTERNAL__module: {
     tossCoreEventLog: typeof tossCoreEventLog;
 };
 
-export { type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type GameCenterGameProfileResponse, type GetUserKeyForGameErrorResponse, type GetUserKeyForGameResponse, type GetUserKeyForGameSuccessResponse, GoogleAdMob, type GrantPromotionRewardErrorResponse, type GrantPromotionRewardErrorResult, type GrantPromotionRewardForGameErrorResponse, type GrantPromotionRewardForGameErrorResult, type GrantPromotionRewardForGameResponse, type GrantPromotionRewardForGameSuccessResponse, type GrantPromotionRewardResponse, type GrantPromotionRewardSuccessResponse, type HapticFeedbackType, IAP, INTERNAL__appBridgeHandler, INTERNAL__module, type IapCreateOneTimePurchaseOrderOptions, type IapCreateOneTimePurchaseOrderResult, type IapCreateSubscriptionPurchaseOrderResult, type IapProductListItem, type IapSubscriptionInfoResult, type NetworkStatus, type NonConsumableProductListItem, type Primitive, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openURL, processProductGrant, requestOneTimePurchase, requestReview, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };
+export { type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type GameCenterGameProfileResponse, type GetUserKeyErrorResponse, type GetUserKeyForGameErrorResponse, type GetUserKeyForGameResponse, type GetUserKeyForGameSuccessResponse, type GetUserKeyResponse, type GetUserKeySuccessResponse, GoogleAdMob, type GrantPromotionRewardErrorResponse, type GrantPromotionRewardErrorResult, type GrantPromotionRewardForGameErrorResponse, type GrantPromotionRewardForGameErrorResult, type GrantPromotionRewardForGameResponse, type GrantPromotionRewardForGameSuccessResponse, type GrantPromotionRewardResponse, type GrantPromotionRewardSuccessResponse, type HapticFeedbackType, IAP, INTERNAL__appBridgeHandler, INTERNAL__module, type IapCreateOneTimePurchaseOrderOptions, type IapCreateOneTimePurchaseOrderResult, type IapCreateSubscriptionPurchaseOrderResult, type IapProductListItem, type IapSubscriptionInfoResult, type NetworkStatus, type NonConsumableProductListItem, type Primitive, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKey, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openURL, processProductGrant, requestOneTimePurchase, requestReview, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };

package/dist/index.js

@@ -808,7 +808,7 @@ var GAME_CENTER_MIN_VERSION = {
   android: "5.221.0",
   ios: "5.221.0"
 };
-var GAME_USER_KEY_MIN_VERSION = {
+var USER_KEY_MIN_VERSION = {
   android: "5.232.0",
   ios: "5.232.0"
 };
@@ -858,9 +858,9 @@ async function submitGameCenterLeaderBoardScore(params) {
   return safePostMessage("submitGameCenterLeaderBoardScore", params);
 }
 
-// src/MiniAppModule/native-modules/getUserKeyForGame.ts
-async function getUserKeyForGame() {
-  const isSupported = isMinVersionSupported(GAME_USER_KEY_MIN_VERSION);
+// src/MiniAppModule/native-modules/getUserKey.ts
+async function getUserKey() {
+  const isSupported = isMinVersionSupported(USER_KEY_MIN_VERSION);
   if (!isSupported) {
     return;
   }
@@ -869,15 +869,17 @@ async function getUserKeyForGame() {
     if (response.type === "HASH") {
       return response;
     }
-    if (response.type === "NOT_AVAILABLE") {
-      return "INVALID_CATEGORY";
-    }
     return "ERROR";
-  } catch (_) {
+  } catch {
     return "ERROR";
   }
 }
 
+// src/MiniAppModule/native-modules/getUserKeyForGame.ts
+async function getUserKeyForGame() {
+  return getUserKey();
+}
+
 // src/MiniAppModule/native-modules/grantPromotionReward.ts
 function isGrantPromotionRewardError(error) {
   return typeof error === "object" && error !== null && "code" in error && typeof error.code === "string" && "message" in error && typeof error.message === "string";
@@ -1139,6 +1141,7 @@ export {
   getServerTime,
   getTossAppVersion,
   getTossShareLink,
+  getUserKey,
   getUserKeyForGame,
   grantPromotionReward,
   grantPromotionRewardForGame,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apps-in-toss/native-modules",
   "type": "module",
-  "version": "2.4.2",
+  "version": "2.4.4",
   "description": "Native Modules for Apps In Toss",
   "scripts": {
     "typecheck": "tsc --noEmit",
@@ -42,7 +42,7 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@apps-in-toss/types": "2.4.2",
+    "@apps-in-toss/types": "2.4.4",
     "brick-module": "0.5.0",
     "es-toolkit": "^1.39.3"
   },

package/src/MiniAppModule/constants.ts

@@ -5,7 +5,7 @@ export const GAME_CENTER_MIN_VERSION = {
   ios: '5.221.0',
 } as const;
 
-export const GAME_USER_KEY_MIN_VERSION = {
+export const USER_KEY_MIN_VERSION = {
   android: '5.232.0',
   ios: '5.232.0',
 } as const;

package/src/MiniAppModule/native-modules/eventLog.ts

@@ -12,7 +12,7 @@ function normalizeParams(params: Record<string, Primitive>): Record<string, stri
 
 export interface EventLogParams {
   log_name: string;
-  log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click';
+  log_type: 'debug' | 'info' | 'warn' | 'error' | 'event' | 'screen' | 'impression' | 'click' | 'popup';
   params: Record<string, Primitive>;
 }
 

package/src/MiniAppModule/native-modules/getUserKey.ts

@@ -0,0 +1,107 @@
+import { isMinVersionSupported } from './isMinVersionSupported';
+import { safePostMessage } from '../../natives';
+import { USER_KEY_MIN_VERSION } from '../constants';
+
+export interface GetUserKeySuccessResponse {
+  hash: string;
+  type: 'HASH';
+}
+
+export interface GetUserKeyErrorResponse {
+  type: 'NOT_AVAILABLE';
+}
+
+export type GetUserKeyResponse = GetUserKeySuccessResponse | GetUserKeyErrorResponse;
+
+/**
+ * @public
+ * @name getUserKey
+ * @description
+ * 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
+ * @returns {Promise<GetUserKeySuccessResponse | 'ERROR' | undefined>}
+ * 사용자 키 조회 결과를 반환해요.
+ * - `GetUserKeySuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
+ * - `'ERROR'`: 알 수 없는 오류가 발생했어요.
+ * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.
+ *
+ * @example
+ * ```tsx
+ * // react-native
+ * import { Button } from 'react-native';
+ * import { getUserKey } from '@apps-in-toss/framework';
+ *
+ * function UserKeyButton() {
+ *   async function handlePress() {
+ *     const result = await getUserKey();
+ *
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
+ *
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
+ *
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
+ *   }
+ *
+ *   return (
+ *     <Button onPress={handlePress} title="유저 키 가져오기" />
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // webview
+ * import { getUserKey } from '@apps-in-toss/web-framework';
+ *
+ * function UserKeyButton() {
+ *   async function handleClick() {
+ *     const result = await getUserKey();
+ *
+ *     if (!result) {
+ *       console.warn('지원하지 않는 앱 버전이에요.');
+ *       return;
+ *     }
+ *
+ *     if (result === 'ERROR') {
+ *       console.error('사용자 키 조회 중 오류가 발생했어요.');
+ *       return;
+ *     }
+ *
+ *     if (result.type === 'HASH') {
+ *       console.log('사용자 키:', result.hash);
+ *       // 여기에서 사용자 키를 사용해 데이터를 관리할 수 있어요.
+ *     }
+ *   }
+ *
+ *   return (
+ *     <button onClick={handleClick}>유저 키 가져오기</button>
+ *   );
+ * }
+ * ```
+ */
+export async function getUserKey(): Promise<GetUserKeySuccessResponse | 'ERROR' | undefined> {
+  const isSupported = isMinVersionSupported(USER_KEY_MIN_VERSION);
+
+  if (!isSupported) {
+    return;
+  }
+
+  try {
+    const response = (await safePostMessage('getUserKeyForGame', {})) as GetUserKeyResponse;
+    if (response.type === 'HASH') {
+      return response;
+    }
+
+    return 'ERROR';
+  } catch {
+    return 'ERROR';
+  }
+}

package/src/MiniAppModule/native-modules/getUserKeyForGame.ts

@@ -1,125 +1,26 @@
-import { isMinVersionSupported } from './isMinVersionSupported';
-import { safePostMessage } from '../../natives';
-import { GAME_USER_KEY_MIN_VERSION } from '../constants';
+import { getUserKey, GetUserKeyErrorResponse, GetUserKeyResponse, GetUserKeySuccessResponse } from './getUserKey';
 
-export interface GetUserKeyForGameSuccessResponse {
-  hash: string;
-  type: 'HASH';
-}
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeySuccessResponse}를 사용해주세요.
+ */
+export type GetUserKeyForGameSuccessResponse = GetUserKeySuccessResponse;
 
-export interface GetUserKeyForGameErrorResponse {
-  type: 'NOT_AVAILABLE';
-}
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyErrorResponse}를 사용해주세요.
+ */
+export type GetUserKeyForGameErrorResponse = GetUserKeyErrorResponse;
 
-export type GetUserKeyForGameResponse = GetUserKeyForGameSuccessResponse | GetUserKeyForGameErrorResponse;
+/**
+ * @deprecated 이 타입은 더 이상 사용되지 않습니다. 대신 {@link GetUserKeyResponse}를 사용해주세요.
+ */
+export type GetUserKeyForGameResponse = GetUserKeyResponse;
 
 /**
- * @public
- * @category 게임
- * @name getUserKeyForGame
- * @description
- * 게임 카테고리 미니앱에서 사용자의 고유 키를 가져와요. 이 키를 사용해서 사용자를 식별하고 게임 데이터를 관리할 수 있어요.
- * 게임 카테고리가 아닌 미니앱에서 호출하면 `'INVALID_CATEGORY'`를 반환해요.
- * @returns {Promise<GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined>}
- * 사용자 키 조회 결과를 반환해요.
- * - `GetUserKeyForGameSuccessResponse`: 사용자 키 조회에 성공했어요. `{ type: 'HASH', hash: string }` 형태로 반환돼요.
- * - `'INVALID_CATEGORY'`: 게임 카테고리가 아닌 미니앱에서 호출했어요.
- * - `'ERROR'`: 알 수 없는 오류가 발생했어요.
- * - `undefined`: 앱 버전이 최소 지원 버전보다 낮아요.
- *
- * @example
- * ```tsx
- * // react-native
- * import { Button } from 'react-native';
- * import { getUserKeyForGame } from '@apps-in-toss/framework';
- *
- * function GameUserKeyButton() {
- *   async function handlePress() {
- *       const result = await getUserKeyForGame();
- *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
- *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
  *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
- *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
- *   }
- *
- *   return (
- *     <Button onPress={handlePress} title="유저 키 가져오기" />
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // webview
- * import { getUserKeyForGame } from '@apps-in-toss/web-framework';
- *
- * function GameUserKeyButton() {
- *   async function handleClick() {
- *       const result = await getUserKeyForGame();
- *
- *       if (!result) {
- *         console.warn('지원하지 않는 앱 버전이에요.');
- *         return;
- *       }
- *
- *       if (result === 'INVALID_CATEGORY') {
- *         console.error('게임 카테고리가 아닌 미니앱이에요.');
- *         return;
- *       }
- *
- *       if (result === 'ERROR') {
- *         console.error('사용자 키 조회 중 오류가 발생했어요.');
- *         return;
- *       }
- *
- *       if (result.type === 'HASH') {
- *         console.log('사용자 키:', result.hash);
- *         // 여기에서 사용자 키를 사용해 게임 데이터를 관리할 수 있어요.
- *       }
- *   }
- *
- *   return (
- *     <button onClick={handleClick}>유저 키 가져오기</button>
- *   );
- * }
- * ```
+ * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link getUserKey}를 사용해주세요.
  */
 export async function getUserKeyForGame(): Promise<
   GetUserKeyForGameSuccessResponse | 'INVALID_CATEGORY' | 'ERROR' | undefined
 > {
-  const isSupported = isMinVersionSupported(GAME_USER_KEY_MIN_VERSION);
-
-  if (!isSupported) {
-    return;
-  }
-
-  try {
-    const response = (await safePostMessage('getUserKeyForGame', {})) as GetUserKeyForGameResponse;
-    if (response.type === 'HASH') {
-      return response;
-    }
-    if (response.type === 'NOT_AVAILABLE') {
-      return 'INVALID_CATEGORY';
-    }
-    return 'ERROR';
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  } catch (_) {
-    return 'ERROR';
-  }
+  return getUserKey();
 }

package/src/MiniAppModule/native-modules/index.ts

@@ -37,6 +37,7 @@ export * from './storage';
 export * from './openGameCenterLeaderboard';
 export * from './getGameCenterGameProfile';
 export * from './submitGameCenterLeaderBoardScore';
+export * from './getUserKey';
 export * from './getUserKeyForGame';
 export * from './grantPromotionReward';
 export * from './grantPromotionRewardForGame';

package/src/MiniAppModule/postMessage.ts

@@ -10,6 +10,7 @@ import type {
 import type { AppsInTossSignTossCertParams } from './native-modules/appsInTossSignTossCert';
 import type { CheckoutPaymentOptions, CheckoutPaymentResult } from './native-modules/checkoutPayment';
 import type { GameCenterGameProfileResponse } from './native-modules/getGameCenterGameProfile';
+import type { GetUserKeyResponse } from './native-modules/getUserKey';
 import type { GetUserKeyForGameResponse } from './native-modules/getUserKeyForGame';
 import type { GrantPromotionRewardForGameResponse } from './native-modules/grantPromotionRewardForGame';
 import type { IapCreateOneTimePurchaseOrderResult, IapSubscriptionInfoResult } from './native-modules/iap';
@@ -72,6 +73,7 @@ export interface AsyncMethodsMap {
     params: CompatiblePlaceholderArgument
   ) => Promise<GameCenterGameProfileResponse | undefined>;
   getUserKeyForGame: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyForGameResponse | undefined>;
+  getUserKey: (params: CompatiblePlaceholderArgument) => Promise<GetUserKeyResponse | undefined>;
   grantPromotionRewardForGame: (params: {
     promotionCode: string;
     amount: number;

package/src/async-bridges.ts

@@ -28,6 +28,7 @@ export * from './MiniAppModule/native-modules/appsInTossSignTossCert';
 export * from './MiniAppModule/native-modules/getGameCenterGameProfile';
 export * from './MiniAppModule/native-modules/openGameCenterLeaderboard';
 export * from './MiniAppModule/native-modules/submitGameCenterLeaderBoardScore';
+export * from './MiniAppModule/native-modules/getUserKey';
 export * from './MiniAppModule/native-modules/getUserKeyForGame';
 export * from './MiniAppModule/native-modules/grantPromotionReward';
 export * from './MiniAppModule/native-modules/grantPromotionRewardForGame';