@apps-in-toss/native-modules 2.6.2 → 2.7.1

package/dist/bridges-meta.json

@@ -143,6 +143,10 @@
     "identifier": "getServerTime",
     "dts": "/**\n * @public\n * @category 시간\n * @name getServerTime\n * @description\n * 토스 앱 서버의 현재 시간을 Unix timestamp 형식으로 가져와요.\n * 디바이스 시간이 아닌 서버 기준 시간을 반환하므로 클라이언트 시간 조작에 따른 보상 중복 수령 등의 치팅을 방지할 수 있어요.\n *\n * @returns {Promise<number | undefined>} 서버 시간을 Unix timestamp 밀리초 단위로 반환해요. (예: 1705123456789) 지원하지 않는 버전에서는 `undefined`를 반환해요.\n * @property {() => boolean} isSupported 현재 앱 버전이 이 기능을 지원하는지 확인하는 함수예요.\n *\n * @example\n * ```tsx\n * import { getServerTime } from '@apps-in-toss/framework';\n *\n * async function checkRewardEligibility() {\n *   // 버전 체크를 먼저 수행하는 것을 권장해요\n *   if (!getServerTime.isSupported()) {\n *     console.log('이 기능은 지원되지 않는 버전입니다.');\n *     return;\n *   }\n *\n *   const serverTime = await getServerTime();\n *   const rewardDeadline = 1705200000000;\n *\n *   if (serverTime && serverTime > rewardDeadline) {\n *     console.log('보상 수령 기간이 지났습니다.');\n *   }\n * }\n * ```\n */\nexport declare function getServerTime(): Promise<number | undefined>;\nexport declare namespace getServerTime {\n\tvar isSupported: () => boolean;\n}\n\nexport {};\n"
   },
+  {
+    "identifier": "getConsentedUserData",
+    "dts": "/**\n * @public\n * @category 사용자 데이터\n * @name GetConsentedUserDataErrorCode\n * @description `getConsentedUserData` 호출이 실패했을 때 반환될 수 있는 에러 코드예요.\n */\nexport type GetConsentedUserDataErrorCode = \"USER_DECLINED\" | \"UNAVAILABLE\" | \"TERMS_NOT_SET\" | \"INVALID_REQUEST\" | \"CANCELED\" | \"CONSENTED_USER_DATA_AGREEMENT_FAILED\" | \"CONSENTED_USER_DATA_INVALID_DATA\";\n/**\n * @public\n * @category 사용자 데이터\n * @name GetConsentedUserDataOptions\n * @description 사용자 동의 기반 데이터를 요청할 때 사용하는 옵션이에요.\n * @property {string} consentedUserDataKey - 서버가 사용자 데이터 제공 동의문과 데이터 묶음을 찾을 때 쓰는 key예요. 예: `cud_delivery`.\n * @property {boolean} [shouldRequestAgreementWhenUserDeclined=false] - `USER_DECLINED` 상태에서도 다시 약관 웹뷰를 띄울지 여부예요. 기본값은 `false`예요.\n */\nexport interface GetConsentedUserDataOptions {\n\tconsentedUserDataKey: string;\n\tshouldRequestAgreementWhenUserDeclined?: boolean;\n}\nexport type ConsentedUserDataKey = \"USER_NAME\" | \"USER_GENDER\" | \"USER_NATIONALITY\" | \"USER_BIRTHDAY\" | \"USER_PHONE\" | \"USER_ADDRESS\" | \"USER_EMAIL\" | \"USER_CONSUMPTION_HISTORY\";\n/**\n * @public\n * @category 사용자 데이터\n * @name ConsentedUserData\n * @description 사용자가 동의한 후 서버에서 제공하는 데이터예요. 요청한 항목에 해당하는 키만 포함될 수 있어요.\n */\nexport type ConsentedUserData = Partial<Record<ConsentedUserDataKey, string>>;\n/**\n * @public\n * @category 사용자 데이터\n * @name getConsentedUserData\n * @description\n * 사용자 동의 기반 데이터를 요청해요.\n * 동의가 필요한 경우 약관 웹뷰를 띄우고, 동의가 완료되면 서버에서 조회한 데이터를 반환해요.\n *\n * @param {GetConsentedUserDataOptions} options - 동의 데이터 요청 옵션이에요.\n * @returns {Promise<ConsentedUserData | undefined>} 서버에서 제공하는 사용자 데이터를 반환해요. 토스앱 버전이 `5.264.0` 미만이면 `undefined`를 반환해요.\n *\n * @throws\n * - {code: `USER_DECLINED`}: 사용자가 명시적으로 거부했고 재요청 옵션이 없거나, 약관 웹뷰에서 동의를 거부한 경우예요.\n * - {code: `UNAVAILABLE`}: 서버가 사용자 동의 여부를 판단할 수 없는 경우예요.\n * - {code: `TERMS_NOT_SET`}: 미니앱에 사용자 데이터 제공 동의문이 설정되지 않은 경우예요.\n * - {code: `INVALID_REQUEST`}: `consentedUserDataKey`가 비어 있거나, `termsUrl`이 없거나, HTTPS 회사 도메인이 아닌 경우예요.\n * - {code: `CANCELED`}: 약관 웹뷰가 결과를 보내기 전에 닫힌 경우예요.\n * - {code: `CONSENTED_USER_DATA_AGREEMENT_FAILED`}: 약관 웹뷰 처리 중 오류가 발생한 경우예요.\n * - {code: `CONSENTED_USER_DATA_INVALID_DATA`}: `PROVIDED`인데 `data`가 없거나, 동의 성공 후 재조회 결과가 `PROVIDED`가 아닌 경우예요.\n *\n * @example\n * ```tsx\n * import { getConsentedUserData } from '@apps-in-toss/framework';\n *\n * async function fetchDeliveryUserData() {\n *   try {\n *     const data = await getConsentedUserData({\n *       consentedUserDataKey: 'cud_delivery',\n *     });\n *\n *     console.log('사용자 이름:', data?.USER_NAME);\n *     console.log('전화번호:', data?.USER_PHONE);\n *   } catch (error) {\n *     console.error('동의 데이터 조회 실패:', error);\n *   }\n * }\n * ```\n */\nexport declare function getConsentedUserData(options: GetConsentedUserDataOptions): Promise<Partial<Record<ConsentedUserDataKey, string>> | undefined>;\n\nexport {};\n"
+  },
   {
     "identifier": "requestReview",
     "dts": "/**\n * @public\n * @category 리뷰\n * @name requestReview\n * @description\n * 유저에게 미니앱 리뷰를 요청해요.\n *\n * @property {() => boolean} isSupported 현재 앱 버전이 이 기능을 지원하는지 확인하는 함수예요.\n */\nexport declare function requestReview(): Promise<void>;\nexport declare namespace requestReview {\n\tvar isSupported: () => boolean;\n}\n\nexport {};\n"

package/dist/index.cjs

@@ -40,6 +40,7 @@ __export(index_exports, {
   generateHapticFeedback: () => generateHapticFeedback,
   getAnonymousKey: () => getAnonymousKey,
   getClipboardText: () => getClipboardText,
+  getConsentedUserData: () => getConsentedUserData,
   getCurrentLocation: () => getCurrentLocation,
   getDeviceId: () => getDeviceId,
   getGameCenterGameProfile: () => getGameCenterGameProfile,
@@ -1125,6 +1126,15 @@ async function getServerTime() {
 }
 getServerTime.isSupported = () => isMinVersionSupported(GET_SERVER_TIME_MIN_VERSION);
 
+// src/MiniAppModule/native-modules/getConsentedUserData.ts
+async function getConsentedUserData(options) {
+  const isSupported = isMinVersionSupported({ ios: "5.264.0", android: "5.264.0" });
+  if (!isSupported) {
+    return void 0;
+  }
+  return safePostMessage("getConsentedUserData", options);
+}
+
 // src/MiniAppModule/native-modules/requestReview.ts
 var MIN_VERSION2 = { android: "5.253.0", ios: "5.253.0" };
 async function requestReview() {
@@ -1298,6 +1308,7 @@ var INTERNAL__module = {
   generateHapticFeedback,
   getAnonymousKey,
   getClipboardText,
+  getConsentedUserData,
   getCurrentLocation,
   getDeviceId,
   getGameCenterGameProfile,

package/dist/index.d.cts

@@ -273,6 +273,73 @@ type GetAnonymousKeyResponse = GetAnonymousKeySuccessResponse;
  */
 declare function getAnonymousKey(): Promise<GetAnonymousKeySuccessResponse | 'ERROR' | undefined>;
 
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataErrorCode
+ * @description `getConsentedUserData` 호출이 실패했을 때 반환될 수 있는 에러 코드예요.
+ */
+type GetConsentedUserDataErrorCode = 'USER_DECLINED' | 'UNAVAILABLE' | 'TERMS_NOT_SET' | 'INVALID_REQUEST' | 'CANCELED' | 'CONSENTED_USER_DATA_AGREEMENT_FAILED' | 'CONSENTED_USER_DATA_INVALID_DATA';
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataOptions
+ * @description 사용자 동의 기반 데이터를 요청할 때 사용하는 옵션이에요.
+ * @property {string} consentedUserDataKey - 서버가 사용자 데이터 제공 동의문과 데이터 묶음을 찾을 때 쓰는 key예요. 예: `cud_delivery`.
+ * @property {boolean} [shouldRequestAgreementWhenUserDeclined=false] - `USER_DECLINED` 상태에서도 다시 약관 웹뷰를 띄울지 여부예요. 기본값은 `false`예요.
+ */
+interface GetConsentedUserDataOptions {
+    consentedUserDataKey: string;
+    shouldRequestAgreementWhenUserDeclined?: boolean;
+}
+type ConsentedUserDataKey = 'USER_NAME' | 'USER_GENDER' | 'USER_NATIONALITY' | 'USER_BIRTHDAY' | 'USER_PHONE' | 'USER_ADDRESS' | 'USER_EMAIL' | 'USER_CONSUMPTION_HISTORY';
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name ConsentedUserData
+ * @description 사용자가 동의한 후 서버에서 제공하는 데이터예요. 요청한 항목에 해당하는 키만 포함될 수 있어요.
+ */
+type ConsentedUserData = Partial<Record<ConsentedUserDataKey, string>>;
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name getConsentedUserData
+ * @description
+ * 사용자 동의 기반 데이터를 요청해요.
+ * 동의가 필요한 경우 약관 웹뷰를 띄우고, 동의가 완료되면 서버에서 조회한 데이터를 반환해요.
+ *
+ * @param {GetConsentedUserDataOptions} options - 동의 데이터 요청 옵션이에요.
+ * @returns {Promise<ConsentedUserData | undefined>} 서버에서 제공하는 사용자 데이터를 반환해요. 토스앱 버전이 `5.264.0` 미만이면 `undefined`를 반환해요.
+ *
+ * @throws
+ * - {code: `USER_DECLINED`}: 사용자가 명시적으로 거부했고 재요청 옵션이 없거나, 약관 웹뷰에서 동의를 거부한 경우예요.
+ * - {code: `UNAVAILABLE`}: 서버가 사용자 동의 여부를 판단할 수 없는 경우예요.
+ * - {code: `TERMS_NOT_SET`}: 미니앱에 사용자 데이터 제공 동의문이 설정되지 않은 경우예요.
+ * - {code: `INVALID_REQUEST`}: `consentedUserDataKey`가 비어 있거나, `termsUrl`이 없거나, HTTPS 회사 도메인이 아닌 경우예요.
+ * - {code: `CANCELED`}: 약관 웹뷰가 결과를 보내기 전에 닫힌 경우예요.
+ * - {code: `CONSENTED_USER_DATA_AGREEMENT_FAILED`}: 약관 웹뷰 처리 중 오류가 발생한 경우예요.
+ * - {code: `CONSENTED_USER_DATA_INVALID_DATA`}: `PROVIDED`인데 `data`가 없거나, 동의 성공 후 재조회 결과가 `PROVIDED`가 아닌 경우예요.
+ *
+ * @example
+ * ```tsx
+ * import { getConsentedUserData } from '@apps-in-toss/framework';
+ *
+ * async function fetchDeliveryUserData() {
+ *   try {
+ *     const data = await getConsentedUserData({
+ *       consentedUserDataKey: 'cud_delivery',
+ *     });
+ *
+ *     console.log('사용자 이름:', data?.USER_NAME);
+ *     console.log('전화번호:', data?.USER_PHONE);
+ *   } catch (error) {
+ *     console.error('동의 데이터 조회 실패:', error);
+ *   }
+ * }
+ * ```
+ */
+declare function getConsentedUserData(options: GetConsentedUserDataOptions): Promise<Partial<Record<ConsentedUserDataKey, string>> | undefined>;
+
 /**
  * @category 게임센터
  * @name GameCenterGameProfileResponse
@@ -1433,6 +1500,7 @@ interface AsyncMethodsMap {
     getServerTime: (params: CompatiblePlaceholderArgument) => Promise<{
         serverTime: number;
     }>;
+    getConsentedUserData: (params: GetConsentedUserDataOptions) => Promise<ConsentedUserData>;
     shareWithScheme: (params: {
         schemeURL: string;
     }) => Promise<void>;
@@ -3604,4 +3672,4 @@ declare const INTERNAL__module: {
     tossCoreEventLog: typeof tossCoreEventLog;
 };
 
-export { type AlbumItemResponse, type AlbumItemType, type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type FetchAlbumItemsOptions, type GameCenterGameProfileResponse, type GetAnonymousKeyResponse, type GetAnonymousKeySuccessResponse, 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 NotificationAgreementResult, type OpenPDFViewerParams, type OpenPDFViewerResult, type Primitive, type RequestNotificationAgreementOptions, type RequestTossPayPaysBillingOptions, type RequestTossPayPaysBillingResult, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openURL, processProductGrant, requestNotificationAgreement, requestOneTimePurchase, requestReview, requestSubscriptionPurchase, requestTossPayPaysBilling, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };
+export { type AlbumItemResponse, type AlbumItemType, type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsentedUserData, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type FetchAlbumItemsOptions, type GameCenterGameProfileResponse, type GetAnonymousKeyResponse, type GetAnonymousKeySuccessResponse, type GetConsentedUserDataErrorCode, type GetConsentedUserDataOptions, 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 NotificationAgreementResult, type OpenPDFViewerParams, type OpenPDFViewerResult, type Primitive, type RequestNotificationAgreementOptions, type RequestTossPayPaysBillingOptions, type RequestTossPayPaysBillingResult, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getClipboardText, getConsentedUserData, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openURL, processProductGrant, requestNotificationAgreement, requestOneTimePurchase, requestReview, requestSubscriptionPurchase, requestTossPayPaysBilling, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };

package/dist/index.d.ts

@@ -273,6 +273,73 @@ type GetAnonymousKeyResponse = GetAnonymousKeySuccessResponse;
  */
 declare function getAnonymousKey(): Promise<GetAnonymousKeySuccessResponse | 'ERROR' | undefined>;
 
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataErrorCode
+ * @description `getConsentedUserData` 호출이 실패했을 때 반환될 수 있는 에러 코드예요.
+ */
+type GetConsentedUserDataErrorCode = 'USER_DECLINED' | 'UNAVAILABLE' | 'TERMS_NOT_SET' | 'INVALID_REQUEST' | 'CANCELED' | 'CONSENTED_USER_DATA_AGREEMENT_FAILED' | 'CONSENTED_USER_DATA_INVALID_DATA';
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataOptions
+ * @description 사용자 동의 기반 데이터를 요청할 때 사용하는 옵션이에요.
+ * @property {string} consentedUserDataKey - 서버가 사용자 데이터 제공 동의문과 데이터 묶음을 찾을 때 쓰는 key예요. 예: `cud_delivery`.
+ * @property {boolean} [shouldRequestAgreementWhenUserDeclined=false] - `USER_DECLINED` 상태에서도 다시 약관 웹뷰를 띄울지 여부예요. 기본값은 `false`예요.
+ */
+interface GetConsentedUserDataOptions {
+    consentedUserDataKey: string;
+    shouldRequestAgreementWhenUserDeclined?: boolean;
+}
+type ConsentedUserDataKey = 'USER_NAME' | 'USER_GENDER' | 'USER_NATIONALITY' | 'USER_BIRTHDAY' | 'USER_PHONE' | 'USER_ADDRESS' | 'USER_EMAIL' | 'USER_CONSUMPTION_HISTORY';
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name ConsentedUserData
+ * @description 사용자가 동의한 후 서버에서 제공하는 데이터예요. 요청한 항목에 해당하는 키만 포함될 수 있어요.
+ */
+type ConsentedUserData = Partial<Record<ConsentedUserDataKey, string>>;
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name getConsentedUserData
+ * @description
+ * 사용자 동의 기반 데이터를 요청해요.
+ * 동의가 필요한 경우 약관 웹뷰를 띄우고, 동의가 완료되면 서버에서 조회한 데이터를 반환해요.
+ *
+ * @param {GetConsentedUserDataOptions} options - 동의 데이터 요청 옵션이에요.
+ * @returns {Promise<ConsentedUserData | undefined>} 서버에서 제공하는 사용자 데이터를 반환해요. 토스앱 버전이 `5.264.0` 미만이면 `undefined`를 반환해요.
+ *
+ * @throws
+ * - {code: `USER_DECLINED`}: 사용자가 명시적으로 거부했고 재요청 옵션이 없거나, 약관 웹뷰에서 동의를 거부한 경우예요.
+ * - {code: `UNAVAILABLE`}: 서버가 사용자 동의 여부를 판단할 수 없는 경우예요.
+ * - {code: `TERMS_NOT_SET`}: 미니앱에 사용자 데이터 제공 동의문이 설정되지 않은 경우예요.
+ * - {code: `INVALID_REQUEST`}: `consentedUserDataKey`가 비어 있거나, `termsUrl`이 없거나, HTTPS 회사 도메인이 아닌 경우예요.
+ * - {code: `CANCELED`}: 약관 웹뷰가 결과를 보내기 전에 닫힌 경우예요.
+ * - {code: `CONSENTED_USER_DATA_AGREEMENT_FAILED`}: 약관 웹뷰 처리 중 오류가 발생한 경우예요.
+ * - {code: `CONSENTED_USER_DATA_INVALID_DATA`}: `PROVIDED`인데 `data`가 없거나, 동의 성공 후 재조회 결과가 `PROVIDED`가 아닌 경우예요.
+ *
+ * @example
+ * ```tsx
+ * import { getConsentedUserData } from '@apps-in-toss/framework';
+ *
+ * async function fetchDeliveryUserData() {
+ *   try {
+ *     const data = await getConsentedUserData({
+ *       consentedUserDataKey: 'cud_delivery',
+ *     });
+ *
+ *     console.log('사용자 이름:', data?.USER_NAME);
+ *     console.log('전화번호:', data?.USER_PHONE);
+ *   } catch (error) {
+ *     console.error('동의 데이터 조회 실패:', error);
+ *   }
+ * }
+ * ```
+ */
+declare function getConsentedUserData(options: GetConsentedUserDataOptions): Promise<Partial<Record<ConsentedUserDataKey, string>> | undefined>;
+
 /**
  * @category 게임센터
  * @name GameCenterGameProfileResponse
@@ -1433,6 +1500,7 @@ interface AsyncMethodsMap {
     getServerTime: (params: CompatiblePlaceholderArgument) => Promise<{
         serverTime: number;
     }>;
+    getConsentedUserData: (params: GetConsentedUserDataOptions) => Promise<ConsentedUserData>;
     shareWithScheme: (params: {
         schemeURL: string;
     }) => Promise<void>;
@@ -3604,4 +3672,4 @@ declare const INTERNAL__module: {
     tossCoreEventLog: typeof tossCoreEventLog;
 };
 
-export { type AlbumItemResponse, type AlbumItemType, type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type FetchAlbumItemsOptions, type GameCenterGameProfileResponse, type GetAnonymousKeyResponse, type GetAnonymousKeySuccessResponse, 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 NotificationAgreementResult, type OpenPDFViewerParams, type OpenPDFViewerResult, type Primitive, type RequestNotificationAgreementOptions, type RequestTossPayPaysBillingOptions, type RequestTossPayPaysBillingResult, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getClipboardText, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openURL, processProductGrant, requestNotificationAgreement, requestOneTimePurchase, requestReview, requestSubscriptionPurchase, requestTossPayPaysBilling, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };
+export { type AlbumItemResponse, type AlbumItemType, type AppsInTossSignTossCertParams, type CheckoutPaymentOptions, type CheckoutPaymentResult, type CompletedOrRefundedOrdersResult, type ConsentedUserData, type ConsumableProductListItem, type ContactsViralParams, type CreateSubscriptionPurchaseOrderOptions, type EventLogParams, type FetchAlbumItemsOptions, type GameCenterGameProfileResponse, type GetAnonymousKeyResponse, type GetAnonymousKeySuccessResponse, type GetConsentedUserDataErrorCode, type GetConsentedUserDataOptions, 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 NotificationAgreementResult, type OpenPDFViewerParams, type OpenPDFViewerResult, type Primitive, type RequestNotificationAgreementOptions, type RequestTossPayPaysBillingOptions, type RequestTossPayPaysBillingResult, type SaveBase64DataParams, Storage, type SubmitGameCenterLeaderBoardScoreResponse, type SubscriptionProductListItem, TossPay, type UpdateLocationEventEmitter, appLogin, appsInTossEvent, appsInTossSignTossCert, checkoutPayment, closeView, contactsViral, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getClipboardText, getConsentedUserData, getCurrentLocation, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPlatformOS, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, grantPromotionReward, grantPromotionRewardForGame, iapCreateOneTimePurchaseOrder, isMinVersionSupported, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openURL, processProductGrant, requestNotificationAgreement, requestOneTimePurchase, requestReview, requestSubscriptionPurchase, requestTossPayPaysBilling, safePostMessage, safeSyncPostMessage, saveBase64Data, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, shareWithScheme, startUpdateLocation, submitGameCenterLeaderBoardScore };

package/dist/index.js

@@ -1039,6 +1039,15 @@ async function getServerTime() {
 }
 getServerTime.isSupported = () => isMinVersionSupported(GET_SERVER_TIME_MIN_VERSION);
 
+// src/MiniAppModule/native-modules/getConsentedUserData.ts
+async function getConsentedUserData(options) {
+  const isSupported = isMinVersionSupported({ ios: "5.264.0", android: "5.264.0" });
+  if (!isSupported) {
+    return void 0;
+  }
+  return safePostMessage("getConsentedUserData", options);
+}
+
 // src/MiniAppModule/native-modules/requestReview.ts
 var MIN_VERSION2 = { android: "5.253.0", ios: "5.253.0" };
 async function requestReview() {
@@ -1211,6 +1220,7 @@ export {
   generateHapticFeedback,
   getAnonymousKey,
   getClipboardText,
+  getConsentedUserData,
   getCurrentLocation,
   getDeviceId,
   getGameCenterGameProfile,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apps-in-toss/native-modules",
   "type": "module",
-  "version": "2.6.2",
+  "version": "2.7.1",
   "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.6.2",
+    "@apps-in-toss/types": "2.7.1",
     "brick-module": "0.5.2",
     "es-toolkit": "^1.39.3"
   },

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

@@ -0,0 +1,96 @@
+import { isMinVersionSupported } from './isMinVersionSupported';
+import { safePostMessage } from '../../natives';
+
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataErrorCode
+ * @description `getConsentedUserData` 호출이 실패했을 때 반환될 수 있는 에러 코드예요.
+ */
+export type GetConsentedUserDataErrorCode =
+  | 'USER_DECLINED'
+  | 'UNAVAILABLE'
+  | 'TERMS_NOT_SET'
+  | 'INVALID_REQUEST'
+  | 'CANCELED'
+  | 'CONSENTED_USER_DATA_AGREEMENT_FAILED'
+  | 'CONSENTED_USER_DATA_INVALID_DATA';
+
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name GetConsentedUserDataOptions
+ * @description 사용자 동의 기반 데이터를 요청할 때 사용하는 옵션이에요.
+ * @property {string} consentedUserDataKey - 서버가 사용자 데이터 제공 동의문과 데이터 묶음을 찾을 때 쓰는 key예요. 예: `cud_delivery`.
+ * @property {boolean} [shouldRequestAgreementWhenUserDeclined=false] - `USER_DECLINED` 상태에서도 다시 약관 웹뷰를 띄울지 여부예요. 기본값은 `false`예요.
+ */
+export interface GetConsentedUserDataOptions {
+  consentedUserDataKey: string;
+  shouldRequestAgreementWhenUserDeclined?: boolean;
+}
+
+type ConsentedUserDataKey =
+  | 'USER_NAME'
+  | 'USER_GENDER'
+  | 'USER_NATIONALITY'
+  | 'USER_BIRTHDAY'
+  | 'USER_PHONE'
+  | 'USER_ADDRESS'
+  | 'USER_EMAIL'
+  | 'USER_CONSUMPTION_HISTORY';
+
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name ConsentedUserData
+ * @description 사용자가 동의한 후 서버에서 제공하는 데이터예요. 요청한 항목에 해당하는 키만 포함될 수 있어요.
+ */
+export type ConsentedUserData = Partial<Record<ConsentedUserDataKey, string>>;
+
+/**
+ * @public
+ * @category 사용자 데이터
+ * @name getConsentedUserData
+ * @description
+ * 사용자 동의 기반 데이터를 요청해요.
+ * 동의가 필요한 경우 약관 웹뷰를 띄우고, 동의가 완료되면 서버에서 조회한 데이터를 반환해요.
+ *
+ * @param {GetConsentedUserDataOptions} options - 동의 데이터 요청 옵션이에요.
+ * @returns {Promise<ConsentedUserData | undefined>} 서버에서 제공하는 사용자 데이터를 반환해요. 토스앱 버전이 `5.264.0` 미만이면 `undefined`를 반환해요.
+ *
+ * @throws
+ * - {code: `USER_DECLINED`}: 사용자가 명시적으로 거부했고 재요청 옵션이 없거나, 약관 웹뷰에서 동의를 거부한 경우예요.
+ * - {code: `UNAVAILABLE`}: 서버가 사용자 동의 여부를 판단할 수 없는 경우예요.
+ * - {code: `TERMS_NOT_SET`}: 미니앱에 사용자 데이터 제공 동의문이 설정되지 않은 경우예요.
+ * - {code: `INVALID_REQUEST`}: `consentedUserDataKey`가 비어 있거나, `termsUrl`이 없거나, HTTPS 회사 도메인이 아닌 경우예요.
+ * - {code: `CANCELED`}: 약관 웹뷰가 결과를 보내기 전에 닫힌 경우예요.
+ * - {code: `CONSENTED_USER_DATA_AGREEMENT_FAILED`}: 약관 웹뷰 처리 중 오류가 발생한 경우예요.
+ * - {code: `CONSENTED_USER_DATA_INVALID_DATA`}: `PROVIDED`인데 `data`가 없거나, 동의 성공 후 재조회 결과가 `PROVIDED`가 아닌 경우예요.
+ *
+ * @example
+ * ```tsx
+ * import { getConsentedUserData } from '@apps-in-toss/framework';
+ *
+ * async function fetchDeliveryUserData() {
+ *   try {
+ *     const data = await getConsentedUserData({
+ *       consentedUserDataKey: 'cud_delivery',
+ *     });
+ *
+ *     console.log('사용자 이름:', data?.USER_NAME);
+ *     console.log('전화번호:', data?.USER_PHONE);
+ *   } catch (error) {
+ *     console.error('동의 데이터 조회 실패:', error);
+ *   }
+ * }
+ * ```
+ */
+export async function getConsentedUserData(options: GetConsentedUserDataOptions) {
+  const isSupported = isMinVersionSupported({ ios: '5.264.0', android: '5.264.0' });
+
+  if (!isSupported) {
+    return undefined;
+  }
+
+  return safePostMessage('getConsentedUserData', options);
+}

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

@@ -54,6 +54,7 @@ export * from './appsInTossSignTossCert';
 export * from './getGroupId';
 export * from './shareWithScheme';
 export * from './getServerTime';
+export * from './getConsentedUserData';
 export * from './requestReview';
 export * from './requestNotificationAgreement';
 

package/src/MiniAppModule/postMessage.ts

@@ -11,6 +11,7 @@ import type { AppsInTossSignTossCertParams } from './native-modules/appsInTossSi
 import type { CheckoutPaymentOptions, CheckoutPaymentResult } from './native-modules/checkoutPayment';
 import type { AlbumItemResponse, FetchAlbumItemsOptions } from './native-modules/fetchAlbumItems';
 import type { GetAnonymousKeyResponse } from './native-modules/getAnonymousKey';
+import type { ConsentedUserData, GetConsentedUserDataOptions } from './native-modules/getConsentedUserData';
 import type { GameCenterGameProfileResponse } from './native-modules/getGameCenterGameProfile';
 import type { GetUserKeyForGameResponse } from './native-modules/getUserKeyForGame';
 import type { GrantPromotionRewardForGameResponse } from './native-modules/grantPromotionRewardForGame';
@@ -105,6 +106,7 @@ export interface AsyncMethodsMap {
   getIsTossLoginIntegratedService: (params: object) => Promise<boolean | undefined>;
 
   getServerTime: (params: CompatiblePlaceholderArgument) => Promise<{ serverTime: number }>;
+  getConsentedUserData: (params: GetConsentedUserDataOptions) => Promise<ConsentedUserData>;
   shareWithScheme: (params: { schemeURL: string }) => Promise<void>;
   requestMiniAppReview: (params: { title: string }) => Promise<void>;
   requestNotificationAgreement: (params: RequestNotificationAgreementOptions) => Promise<void>;

package/src/async-bridges.ts

@@ -37,4 +37,5 @@ export * from './MiniAppModule/native-modules/grantPromotionReward';
 export * from './MiniAppModule/native-modules/grantPromotionRewardForGame';
 export * from './MiniAppModule/native-modules/getIsTossLoginIntegratedService';
 export * from './MiniAppModule/native-modules/getServerTime';
+export * from './MiniAppModule/native-modules/getConsentedUserData';
 export * from './MiniAppModule/native-modules/requestReview';