@apps-in-toss/web-bridge 0.0.39 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/built/bridge.d.ts +33 -0
  2. package/built/bridge.js +1 -0
  3. package/{build → built}/closeView.d.ts +1 -1
  4. package/{build → built}/contactsViral.d.ts +5 -4
  5. package/{build → built}/fetchContacts.d.ts +20 -22
  6. package/{build → built}/generateHapticFeedback.d.ts +2 -2
  7. package/{build → built}/getCurrentLocation.d.ts +5 -17
  8. package/{build → built}/getLocale.d.ts +1 -1
  9. package/{build → built}/getNetworkStatus.d.ts +1 -1
  10. package/{build → built}/getPlatformOS.d.ts +1 -1
  11. package/{build → built}/getSchemeUri.d.ts +1 -1
  12. package/built/index.cjs +680 -0
  13. package/built/index.d.cts +657 -0
  14. package/{build → built}/index.d.ts +8 -8
  15. package/{build → built}/index.js +4 -4
  16. package/built/onVisibilityChangedByTransparentServiceWeb.d.ts +21 -0
  17. package/{build → built}/openURL.d.ts +1 -1
  18. package/{build → built}/setIosSwipeGestureEnabled.d.ts +1 -1
  19. package/{build → built}/setScreenAwakeMode.d.ts +2 -2
  20. package/{build → built}/setSecureScreen.d.ts +1 -1
  21. package/{build → built}/share.d.ts +1 -1
  22. package/{build → built}/startUpdateLocation.d.ts +5 -11
  23. package/built/types.d.ts +110 -0
  24. package/package.json +21 -15
  25. package/build/bridge.d.ts +0 -31
  26. package/build/bridge.js +0 -1
  27. /package/{build → built}/appLogin.d.ts +0 -0
  28. /package/{build → built}/checkoutPayment.d.ts +0 -0
  29. /package/{build → built}/eventLog.d.ts +0 -0
  30. /package/{build → built}/fetchAlbumPhotos.d.ts +0 -0
  31. /package/{build → built}/getClipboardText.d.ts +0 -0
  32. /package/{build → built}/getDeviceId.d.ts +0 -0
  33. /package/{build → built}/getGameCenterGameProfile.d.ts +0 -0
  34. /package/{build → built}/getOperationalEnvironment.d.ts +0 -0
  35. /package/{build → built}/getTossAppVersion.d.ts +0 -0
  36. /package/{build → built}/getTossShareLink.d.ts +0 -0
  37. /package/{build → built}/openCamera.d.ts +0 -0
  38. /package/{build → built}/openGameCenterLeaderboard.d.ts +0 -0
  39. /package/{build → built}/saveBase64Data.d.ts +0 -0
  40. /package/{build → built}/setClipboardText.d.ts +0 -0
  41. /package/{build → built}/setDeviceOrientation.d.ts +0 -0
  42. /package/{build → built}/submitGameCenterLeaderBoardScore.d.ts +0 -0
@@ -0,0 +1,657 @@
1
+ export * from './bridge';
2
+ export * from '@apps-in-toss/bridge-core';
3
+ import { LoadAdMobInterstitialAdEvent, LoadAdMobInterstitialAdOptions, ShowAdMobInterstitialAdEvent, ShowAdMobInterstitialAdOptions, LoadAdMobRewardedAdEvent, LoadAdMobRewardedAdOptions, ShowAdMobRewardedAdEvent, ShowAdMobRewardedAdOptions } from '@apps-in-toss/framework';
4
+
5
+ /**
6
+ * @public
7
+ * @category 저장소
8
+ * @name Storage
9
+ * @description 네이티브의 저장소를 사용해요.
10
+ * @property {typeof getItem} [getItem] 모바일 앱의 로컬 저장소에서 아이템을 가져오는 함수예요. 자세한 내용은 [getItem](/react-native/reference/framework/저장소/getItem)을 참고하세요.
11
+ * @property {typeof setItem} [setItem] 모바일 앱의 로컬 저장소에 아이템을 저장하는 함수예요. 자세한 내용은 [setItem](/react-native/reference/framework/저장소/setItem)을 참고하세요.
12
+ * @property {typeof removeItem} [removeItem] 모바일 앱의 로컬 저장소에서 아이템을 삭제하는 함수예요. 자세한 내용은 [removeItem](/react-native/reference/framework/저장소/removeItem)을 참고하세요.
13
+ * @property {typeof clearItems} [clearItems] 모바일 앱의 로컬 저장소를 초기화하는 함수예요. 자세한 내용은 [clearItems](/react-native/reference/framework/저장소/clearItems)을 참고하세요.
14
+ */
15
+ declare const Storage: {
16
+ /**
17
+ * @public
18
+ * @category 저장소
19
+ * @name getItem
20
+ * @description 모바일 앱의 로컬 저장소에서 문자열 데이터를 가져와요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
21
+ * @param {string} key - 가져올 아이템의 키를 입력해요.
22
+ * @returns {Promise<string | null>} 지정한 키에 저장된 문자열 값을 반환해요. 값이 없으면 `null`을 반환해요.
23
+ * @example
24
+ *
25
+ * ### `my-key`에 저장된 아이템 가져오기
26
+ * ```ts
27
+ * const value = await Storage.getItem('my-key');
28
+ * console.log(value); // 'value'
29
+ * ```
30
+ */
31
+ getItem: (args_0: string) => Promise<string | null>;
32
+ /**
33
+ * @public
34
+ * @category 저장소
35
+ * @name setItem
36
+ * @description 모바일 앱의 로컬 저장소에 문자열 데이터를 저장해요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
37
+ * @param {string} key - 저장할 아이템의 키를 입력해요.
38
+ * @param {string} value - 저장할 아이템의 값을 입력해요.
39
+ * @returns {Promise<void>} 아이템을 성공적으로 저장하면 아무 값도 반환하지 않아요.
40
+ * @example
41
+ *
42
+ * ### `my-key`에 아이템 저장하기
43
+ * ```ts
44
+ * import { Storage } from '@apps-in-toss/framework';
45
+ *
46
+ * await Storage.setItem('my-key', 'value');
47
+ * ```
48
+ */
49
+ setItem: (args_0: string, args_1: string) => Promise<void>;
50
+ /**
51
+ * @public
52
+ * @category 저장소
53
+ * @name removeItem
54
+ * @description 모바일 앱의 로컬 저장소에서 특정 키에 해당하는 아이템을 삭제해요.
55
+ * @param {string} key - 삭제할 아이템의 키를 입력해요.
56
+ * @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않아요.
57
+ * @example
58
+ *
59
+ * ### `my-key`에 저장된 아이템 삭제하기
60
+ * ```ts
61
+ * import { Storage } from '@apps-in-toss/framework';
62
+ *
63
+ * await Storage.removeItem('my-key');
64
+ * ```
65
+ */
66
+ removeItem: (args_0: string) => Promise<void>;
67
+ /**
68
+ * @public
69
+ * @category 저장소
70
+ * @name clearItems
71
+ * @description 모바일 앱의 로컬 저장소의 모든 아이템을 삭제해요.
72
+ * @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않고 저장소가 초기화돼요.
73
+ * @example
74
+ *
75
+ * ### 저장소 초기화하기
76
+ * ```ts
77
+ * import { Storage } from '@apps-in-toss/framework';
78
+ *
79
+ * await Storage.clearItems();
80
+ * ```
81
+ */
82
+ clearItems: (args_0: void) => Promise<void>;
83
+ };
84
+
85
+ /**
86
+ * @public
87
+ * @category 인앱결제
88
+ * @name IapCreateOneTimePurchaseOrderResult
89
+ * @description 인앱결제 1건이 완료되면 결제 세부 정보와 상품 정보를 담아 반환해요. 반환된 정보로 결제한 상품의 정보를 화면에 표시할 수 있어요.
90
+ * @property {string} orderId - 결제 주문 ID이에요. 결제 완료 후 [결제 상태를 조회](https://developers-apps-in-toss.toss.im/api/getIapOrderStatus.html)할 때 사용해요.
91
+ * @property {string} displayName - 화면에 표시할 상품 이름이에요.
92
+ * @property {string} displayAmount - 통화 단위가 포함된 가격 정보예요. 예를 들어 `1,000원`으로 가격과 통화가 함께 표시돼요.
93
+ * @property {number} amount - 상품 가격 숫자 값이에요. 화폐 단위와 쉼표를 제외한 순수 숫자예요. 예를 들어 `1000`으로 표시돼요.
94
+ * @property {string} currency - [ISO 4217 표준](https://ko.wikipedia.org/wiki/ISO_4217)에 따른 상품 가격 통화 단위예요. 예를 들어 원화는 `KRW`, 달러는 `USD`로 표시돼요.
95
+ * @property {number} fraction - 가격을 표시할 때 소수점 아래 몇 자리까지 보여줄지 정하는 값이에요. 예를 들어 달러는 소수점 둘째 자리까지 보여줘서 `2`, 원화는 소수점이 필요 없어서 `0`이에요
96
+ * @property {string | null} miniAppIconUrl - 미니앱 아이콘 이미지의 URL이에요. 아이콘은 앱인토스 콘솔에서 설정한 이미지예요. 콘솔에서 아이콘을 등록하지 않았다면 `null`로 반환돼요.
97
+ */
98
+ interface IapCreateOneTimePurchaseOrderResult {
99
+ orderId: string;
100
+ displayName: string;
101
+ displayAmount: string;
102
+ amount: number;
103
+ currency: string;
104
+ fraction: number;
105
+ miniAppIconUrl: string | null;
106
+ }
107
+ /**
108
+ * @public
109
+ * @category 인앱결제
110
+ * @name IapProductListItem
111
+ * @description 인앱결제로 구매할 수 있는 상품 하나의 정보를 담은 객체예요. 상품 목록을 화면에 표시할 때 사용해요.
112
+ * @property {string} sku - 상품의 고유 ID예요. [IAP.createOneTimePurchaseOrder](https://developers-apps-in-toss.toss.im/bedrock/reference/framework/%EC%9D%B8%EC%95%B1%20%EA%B2%B0%EC%A0%9C/createOneTimePurchaseOrder.html)를 호출할때 사용하는 `productId`와 동일한 값이에요.
113
+ * @property {string} displayName - 화면에 표시할 상품 이름이에요. 상품 이름은 앱인토스 콘솔에서 설정한 값이에요.
114
+ * @property {string} displayAmount - 통화 단위가 포함된 가격 정보예요. 예를 들어 `1,000원`으로 가격과 통화가 함께 표시돼요.
115
+ * @property {string} iconUrl - 상품 아이콘 이미지의 URL이에요. 아이콘은 앱인토스 콘솔에서 설정한 이미지예요.
116
+ * @property {string} description - 상품에 대한 설명이에요. 설명은 앱인토스 콘솔에서 설정한 값이에요.
117
+ */
118
+ interface IapProductListItem {
119
+ sku: string;
120
+ displayAmount: string;
121
+ displayName: string;
122
+ iconUrl: string;
123
+ description: string;
124
+ }
125
+ /**
126
+ * @public
127
+ * @category 인앱결제
128
+ * @name IAP
129
+ * @description 인앱결제 관련 기능을 모은 객체예요. 단건 인앱결제 주문서 이동과 상품 목록 조회 기능을 제공해요.
130
+ * @property {typeof createOneTimePurchaseOrder} [createOneTimePurchaseOrder] 특정 인앱결제 주문서 페이지로 이동해요. 자세한 내용은 [createOneTimePurchaseOrder](https://developers-apps-in-toss.toss.im/bedrock/reference/framework/%EC%9D%B8%EC%95%B1%20%EA%B2%B0%EC%A0%9C/getProductItemList.html) 문서를 참고하세요.
131
+ * @property {typeof getProductItemList} [getProductItemList] 인앱결제로 구매할 수 있는 상품 목록을 가져와요. 자세한 내용은 [getProductItemList](https://developers-apps-in-toss.toss.im/bedrock/reference/framework/%EC%9D%B8%EC%95%B1%20%EA%B2%B0%EC%A0%9C/createOneTimePurchaseOrder.html) 문서를 참고하세요.
132
+ */
133
+ declare const IAP: {
134
+ /**
135
+ * @public
136
+ * @category 인앱결제
137
+ * @name iapCreateOneTimePurchaseOrder
138
+ * @description
139
+ * 특정 인앱결제 주문서 페이지로 이동해요. 사용자가 상품 구매 버튼을 누르는 상황 등에 사용할 수 있어요. 사용자의 결제는 이동한 페이지에서 진행돼요. 만약 결제 중에 에러가 발생하면 에러 유형에 따라 에러 페이지로 이동해요.
140
+ * @param {IapCreateOneTimePurchaseOrderOptions} params - 인앱결제를 생성할 때 필요한 정보예요.
141
+ * @param {string} params.productId - 주문할 상품의 ID예요.
142
+ * @returns {Promise<IapCreateOneTimePurchaseOrderResult | undefined>} 결제에 성공하면 결제 결과 객체를 반환해요. 앱 버전이 최소 지원 버전(안드로이드 5.219.0, iOS 5.219.0)보다 낮으면 인앱결제를 실행할 수 없어서 `undefined`를 반환해요.
143
+ *
144
+ * @throw {code: "INVALID_PRODUCT_ID"} - 유효하지 않은 상품 ID이거나, 해당 상품이 존재하지 않을 때 발생해요.
145
+ * @throw {code: "PAYMENT_PENDING"} - 사용자가 요청한 결제가 아직 승인을 기다리고 있을 때 발생해요.
146
+ * @throw {code: "NETWORK_ERROR"} - 서버 내부 문제로 요청을 처리할 수 없을 때 발생해요.
147
+ * @throw {code: "INVALID_USER_ENVIRONMENT"} - 특정 기기, 계정 또는 설정 환경에서 구매할 수 없는 상품일 때 발생해요.
148
+ * @throw {code: "ITEM_ALREADY_OWNED"} - 사용자가 이미 구매한 상품을 다시 구매하려고 할 때 발생해요.
149
+ * @throw {code: "APP_MARKET_VERIFICATION_FAILED"} - 사용자가 결제를 완료했지만, 앱스토어에서 사용자 정보 검증에 실패했을 때 발생해요. 사용자가 앱스토어에 문의해서 환불을 요청해야해요.
150
+ * @throw {code: "TOSS_SERVER_VERIFICATION_FAILED"} - 사용자가 결제를 완료했지만, 서버 전송에 실패해서 결제 정보를 저장할 수 없을 때 발생해요.
151
+ * @throw {code: "INTERNAL_ERROR"} - 서버 내부 문제로 요청을 처리할 수 없을 때 발생해요.
152
+ * @throw {code: "KOREAN_ACCOUNT_ONLY"} - iOS 환경에서 사용자의 계정이 한국 계정이 아닐 때 발생해요.
153
+ * @throw {code: "USER_CANCELED"} - 사용자가 결제를 완료하지 않고 주문서 페이지를 이탈했을 때 발생해요.
154
+ */
155
+ createOneTimePurchaseOrder: (args_0: {
156
+ productId: string;
157
+ }) => Promise<IapCreateOneTimePurchaseOrderResult>;
158
+ /**
159
+ * @public
160
+ * @category 인앱결제
161
+ * @name iapGetProductItemList
162
+ * @description 인앱결제로 구매할 수 있는 상품 목록을 가져와요. 상품 목록 화면에 진입할 때 호출해요.
163
+ * @returns {Promise<{ products: IapProductListItem[] } | undefined>} 상품 목록을 포함한 객체를 반환해요. 앱 버전이 최소 지원 버전(안드로이드 5.219.0, iOS 5.219.0)보다 낮으면 `undefined`를 반환해요.
164
+ */
165
+ getProductItemList: () => Promise<{
166
+ products: IapProductListItem[];
167
+ }>;
168
+ };
169
+
170
+ declare function getSafeAreaInsets(): {
171
+ top: number;
172
+ bottom: number;
173
+ };
174
+
175
+ declare const GoogleAdMob: {
176
+ /**
177
+ * @public
178
+ * @category 광고
179
+ * @name loadAdMobInterstitialAd
180
+ * @description 앱 화면 전체를 덮는 전면 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
181
+ * @param {LoadAdMobInterstitialAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
182
+ * @param {LoadAdMobInterstitialAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
183
+ * @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 전면 광고용 ID를 입력해요.
184
+ * @param {(event: LoadAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobInterstitialAdEvent](/react-native/reference/framework/광고/LoadAdMobInterstitialAdEvent.html)를 참고하세요.
185
+ * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
186
+ * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
187
+ *
188
+ * @example
189
+ * ### 뷰 진입 시 전면광고 불러오기
190
+ * ```tsx
191
+ * import { GoogleAdMob } from '@apps-in-toss/framework';
192
+ * import { useEffect } from 'react';
193
+ * import { View, Text } from 'react-native';
194
+ *
195
+ * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
196
+ *
197
+ * function Page() {
198
+ * useEffect(() => {
199
+ * if (GoogleAdMob.loadAdMobInterstitialAd.isSupported() !== true) {
200
+ * return;
201
+ * }
202
+ *
203
+ * const cleanup = GoogleAdMob.loadAdMobInterstitialAd({
204
+ * options: {
205
+ * adUnitId: AD_UNIT_ID,
206
+ * },
207
+ * onEvent: (event) => {
208
+ * switch (event.type) {
209
+ * case 'loaded':
210
+ * console.log('광고 로드 성공', event.data);
211
+ * break;
212
+ *
213
+ * case 'clicked':
214
+ * console.log('광고 클릭');
215
+ * break;
216
+ *
217
+ * case 'dismissed':
218
+ * console.log('광고 닫힘');
219
+ * break;
220
+ *
221
+ * case 'failedToShow':
222
+ * console.log('광고 보여주기 실패');
223
+ * break;
224
+ *
225
+ * case 'impression':
226
+ * console.log('광고 노출');
227
+ * break;
228
+ *
229
+ * case 'show':
230
+ * console.log('광고 컨텐츠 보여졌음');
231
+ * break;
232
+ * }
233
+ * },
234
+ * onError: (error) => {
235
+ * console.error('광고 불러오기 실패', error);
236
+ * },
237
+ * });
238
+ *
239
+ * return cleanup;
240
+ * }, []);
241
+ *
242
+ * return (
243
+ * <View>
244
+ * <Text>Page</Text>
245
+ * </View>
246
+ * );
247
+ * }
248
+ * ```
249
+ */
250
+ loadAdMobInterstitialAd: ((args: {
251
+ onEvent: (data: LoadAdMobInterstitialAdEvent) => void;
252
+ onError: (error: Error) => void;
253
+ options?: LoadAdMobInterstitialAdOptions | undefined;
254
+ }) => () => void) & {
255
+ isSupported: () => boolean;
256
+ };
257
+ /**
258
+ * @public
259
+ * @category 광고
260
+ * @name showAdMobInterstitialAd
261
+ * @description 앱 화면 전체를 덮는 전면 광고를 사용자에게 노출해요. 이 함수는 `loadAdMobInterstitialAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
262
+ * @param {ShowAdMobInterstitialAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와과 광고의 동작에 대한 콜백을 설정할 수 있어요.
263
+ * @param {ShowAdMobInterstitialAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
264
+ * @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobInterstitialAd` 로 불러온 전면 광고용 ID를 입력해요.
265
+ * @param {(event: ShowAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobInterstitialAdEvent](/react-native/reference/framework/광고/ShowAdMobInterstitialAdEvent.html)를 참고하세요.
266
+ * @param {(reason: unknown) => void} [params.onError] 광고를 노출하지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
267
+ * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
268
+ *
269
+ * @example
270
+ * ### 버튼 눌러 불러온 전면 광고 보여주기
271
+ * ```tsx
272
+ * import { GoogleAdMob } from '@apps-in-toss/framework';
273
+ * import { View, Text, Button } from 'react-native';
274
+ *
275
+ * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
276
+ *
277
+ * function Page() {
278
+ * const handlePress = () => {
279
+ * if (GoogleAdMob.showAdMobInterstitialAd.isSupported() !== true) {
280
+ * return;
281
+ * }
282
+ *
283
+ * GoogleAdMob.showAdMobInterstitialAd({
284
+ * options: {
285
+ * adUnitId: AD_UNIT_ID,
286
+ * },
287
+ * onEvent: (event) => {
288
+ * switch (event.type) {
289
+ * case 'requested':
290
+ * console.log('광고 보여주기 요청 완료');
291
+ * break;
292
+ * }
293
+ * },
294
+ * onError: (error) => {
295
+ * console.error('광고 보여주기 실패', error);
296
+ * },
297
+ * });
298
+ * }
299
+ *
300
+ * return (
301
+ * <Button onPress={handlePress} title="광고 보기" />
302
+ * );
303
+ * }
304
+ * ```
305
+ */
306
+ showAdMobInterstitialAd: ((args: {
307
+ onEvent: (data: ShowAdMobInterstitialAdEvent) => void;
308
+ onError: (error: Error) => void;
309
+ options?: ShowAdMobInterstitialAdOptions | undefined;
310
+ }) => () => void) & {
311
+ isSupported: () => boolean;
312
+ };
313
+ /**
314
+ * @public
315
+ * @category 광고
316
+ * @name loadAdMobRewardedAd
317
+ * @description 사용자가 광고를 끝까지 시청하면 리워드를 제공할 수 있는 보상형 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
318
+ * @param {LoadAdMobRewardedAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
319
+ * @param {LoadAdMobRewardedAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
320
+ * @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 보상형 광고용 ID를 입력해요.
321
+ * @param {(event: LoadAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobRewardedAdEvent](/react-native/reference/framework/광고/LoadAdMobRewardedAdEvent.html)를 참고하세요.
322
+ * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
323
+ * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
324
+ *
325
+ * @example
326
+ * ### 뷰 진입 시 보상형 광고 불러오기
327
+ * ```tsx
328
+ * import { GoogleAdMob } from '@apps-in-toss/framework';
329
+ * import { useEffect } from 'react';
330
+ * import { View, Text } from 'react-native';
331
+ *
332
+ * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
333
+ *
334
+ * function Page() {
335
+ * useEffect(() => {
336
+ * if (GoogleAdMob.loadAdMobRewardedAd.isSupported() !== true) {
337
+ * return;
338
+ * }
339
+ *
340
+ * const cleanup = GoogleAdMob.loadAdMobRewardedAd({
341
+ * options: {
342
+ * adUnitId: AD_UNIT_ID,
343
+ * },
344
+ * onEvent: (event) => {
345
+ * switch (event.type) {
346
+ * case 'loaded':
347
+ * console.log('광고 로드 성공', event.data);
348
+ * break;
349
+ *
350
+ * case 'clicked':
351
+ * console.log('광고 클릭');
352
+ * break;
353
+ *
354
+ * case 'dismissed':
355
+ * console.log('광고 닫힘');
356
+ * break;
357
+ *
358
+ * case 'failedToShow':
359
+ * console.log('광고 보여주기 실패');
360
+ * break;
361
+ *
362
+ * case 'impression':
363
+ * console.log('광고 노출');
364
+ * break;
365
+ *
366
+ * case 'show':
367
+ * console.log('광고 컨텐츠 보여졌음');
368
+ * break;
369
+ *
370
+ * case 'userEarnedReward':
371
+ * console.log('사용자가 광고 시청을 완료했음');
372
+ * break;
373
+ * }
374
+ * },
375
+ * onError: (error) => {
376
+ * console.error('광고 불러오기 실패', error);
377
+ * },
378
+ * });
379
+ *
380
+ * return cleanup;
381
+ * }, []);
382
+ *
383
+ * return (
384
+ * <View>
385
+ * <Text>Page</Text>
386
+ * </View>
387
+ * );
388
+ * }
389
+ * ```
390
+ */
391
+ loadAdMobRewardedAd: ((args: {
392
+ onEvent: (data: LoadAdMobRewardedAdEvent) => void;
393
+ onError: (error: Error) => void;
394
+ options?: LoadAdMobRewardedAdOptions | undefined;
395
+ }) => () => void) & {
396
+ isSupported: () => boolean;
397
+ };
398
+ /**
399
+ * @public
400
+ * @category 광고
401
+ * @name showAdMobRewardedAd
402
+ * @description 사용자가 광고를 끝까지 보면 리워드를 받을 수 있도록, 보상형 광고를 화면에 보여줘요. 이 함수는 `loadAdMobRewardedAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
403
+ * @param {ShowAdMobRewardedAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
404
+ * @param {ShowAdMobRewardedAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
405
+ * @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobRewardedAd` 로 불러온 보상형 광고용 ID를 입력해요.
406
+ * @param {(event: ShowAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobRewardedAdEvent](/react-native/reference/framework/광고/ShowAdMobRewardedAdEvent.html)를 참고하세요.
407
+ * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
408
+ * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
409
+ *
410
+ * @example
411
+ * ### 버튼 눌러 불러온 보상형 광고 보여주기
412
+ * ```tsx
413
+ * import { GoogleAdMob } from '@apps-in-toss/framework';
414
+ * import { View, Text, Button } from 'react-native';
415
+ *
416
+ * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
417
+ *
418
+ * function Page() {
419
+ * const handlePress = () => {
420
+ * if (GoogleAdMob.showAdMobRewardedAd.isSupported() !== true) {
421
+ * return;
422
+ * }
423
+ *
424
+ * GoogleAdMob.showAdMobRewardedAd({
425
+ * options: {
426
+ * adUnitId: AD_UNIT_ID,
427
+ * },
428
+ * onEvent: (event) => {
429
+ * switch (event.type) {
430
+ * case 'requested':
431
+ * console.log('광고 보여주기 요청 완료');
432
+ * break;
433
+ * }
434
+ * },
435
+ * onError: (error) => {
436
+ * console.error('광고 보여주기 실패', error);
437
+ * },
438
+ * });
439
+ * }
440
+ *
441
+ * return (
442
+ * <Button onPress={handlePress} title="광고 보기" />
443
+ * );
444
+ * }
445
+ * ```
446
+ */
447
+ showAdMobRewardedAd: ((args: {
448
+ onEvent: (data: ShowAdMobRewardedAdEvent) => void;
449
+ onError: (error: Error) => void;
450
+ options?: ShowAdMobRewardedAdOptions | undefined;
451
+ }) => () => void) & {
452
+ isSupported: () => boolean;
453
+ };
454
+ };
455
+
456
+ type GraniteEvent = {
457
+ backEvent: {
458
+ onEvent: () => void;
459
+ onError?: (error: Error) => void;
460
+ options?: void;
461
+ };
462
+ };
463
+ declare const graniteEvent: {
464
+ addEventListener: <K extends keyof GraniteEvent>(event: K, { onEvent, onError, options, }: {
465
+ onEvent: GraniteEvent[K]["onEvent"];
466
+ onError?: GraniteEvent[K]["onError"];
467
+ options?: GraniteEvent[K]["options"];
468
+ }) => () => void;
469
+ };
470
+
471
+ /**
472
+ * @public
473
+ * @category 환경 확인
474
+ * @kind function
475
+ * @name isMinVersionSupported
476
+ * @description
477
+ * 현재 토스 앱 버전이 지정한 최소 버전 이상인지 확인해요.
478
+ *
479
+ * 이 함수는 현재 실행 중인 토스 앱의 버전이 파라미터로 전달된 최소 버전 요구사항을 충족하는지 확인해요. 특정 기능이 최신 버전에서만 동작할 때, 사용자에게 앱 업데이트를 안내할 수 있어요.
480
+ *
481
+ * @param {Object} minVersions 플랫폼별 최소 버전 요구사항을 지정하는 객체예요.
482
+ * @param {(`${number}.${number}.${number}` | 'always' | 'never')} minVersions.android 안드로이드 플랫폼의 최소 버전 요구사항이에요.
483
+ * @param {(`${number}.${number}.${number}` | 'always' | 'never')} minVersions.ios iOS 플랫폼의 최소 버전 요구사항이에요.
484
+ * @returns {boolean} 현재 앱 버전이 최소 버전 이상이면 true, 그렇지 않으면 false를 반환해요.
485
+ *
486
+ * @example
487
+ * ### 앱 버전 확인하기
488
+ *
489
+ * ```tsx
490
+ * import { isMinVersionSupported } from '@apps-in-toss/framework';
491
+ * import { Text, View } from 'react-native';
492
+ *
493
+ * function VersionCheck() {
494
+ * const isSupported = isMinVersionSupported({
495
+ * android: '1.2.0',
496
+ * ios: '1.3.0'
497
+ * });
498
+ *
499
+ * return (
500
+ * <View>
501
+ * {!isSupported && (
502
+ * <Text>최신 버전으로 업데이트가 필요해요.</Text>
503
+ * )}
504
+ * </View>
505
+ * );
506
+ * }
507
+ * ```
508
+ */
509
+ declare function isMinVersionSupported(minVersions: {
510
+ android: `${number}.${number}.${number}` | 'always' | 'never';
511
+ ios: `${number}.${number}.${number}` | 'always' | 'never';
512
+ }): boolean;
513
+
514
+ type AppsInTossEvent = {
515
+ entryMessageExited: {
516
+ onEvent: () => void;
517
+ onError?: (error: Error) => void;
518
+ options: undefined;
519
+ };
520
+ };
521
+ declare const appsInTossEvent: {
522
+ addEventListener: <K extends keyof AppsInTossEvent>(event: K, { onEvent, onError, options, }: {
523
+ onEvent: AppsInTossEvent[K]["onEvent"];
524
+ onError?: AppsInTossEvent[K]["onError"];
525
+ options?: AppsInTossEvent[K]["options"];
526
+ }) => () => void;
527
+ };
528
+
529
+ declare const env: {
530
+ getDeploymentId: () => string;
531
+ };
532
+
533
+ interface AppsInTossGlobals {
534
+ deploymentId: string;
535
+ brandDisplayName: string;
536
+ brandIcon: string;
537
+ brandPrimaryColor: string;
538
+ brandBridgeColorMode: 'basic' | 'inverted';
539
+ }
540
+ declare const getAppsInTossGlobals: () => AppsInTossGlobals;
541
+
542
+ type TdsEvent = {
543
+ navigationAccessoryEvent: {
544
+ onEvent: (data: {
545
+ id: string;
546
+ }) => void;
547
+ onError?: (error: Error) => void;
548
+ options: undefined;
549
+ };
550
+ };
551
+ /**
552
+ * @public
553
+ * @category TDS
554
+ * @name tdsEvent
555
+ * @description 토스 이벤트를 사용해요.
556
+ * @property {typeof addEventListener} [addEventListener] 이벤트를 추가해요.
557
+ */
558
+ declare const tdsEvent: {
559
+ /**
560
+ * @public
561
+ * @category TDS
562
+ * @name addEventListener
563
+ * @description 이벤트를 추가해요.
564
+ * @param {string} event 이벤트 이름예요.
565
+ * @param {TdsEvent[K]['onEvent']} onEvent 이벤트 핸들러예요.
566
+ * @param {TdsEvent[K]['onError']} onError 이벤트 에러 핸들러예요.
567
+ * @param {TdsEvent[K]['options']} options 이벤트 옵션예요.
568
+ * @returns {void} 이벤트를 추가했을 때 아무 값도 반환하지 않아요.
569
+ * @example
570
+ * ### 네비게이션 악세서리 이벤트 추가하기
571
+ * ```tsx
572
+ * import { tdsEvent } from '@apps-in-toss/framework';
573
+ *
574
+ * tdsEvent.addEventListener('navigationAccessoryEvent', {
575
+ * onEvent: ({ id }) => {
576
+ * if(id === 'heart') {
577
+ * router.push('/heart');
578
+ * }
579
+ * },
580
+ * });
581
+ * ```
582
+ */
583
+ addEventListener: <K extends keyof TdsEvent>(event: K, { onEvent, onError, options, }: {
584
+ onEvent: TdsEvent[K]["onEvent"];
585
+ onError?: TdsEvent[K]["onError"];
586
+ options?: TdsEvent[K]["options"];
587
+ }) => () => void;
588
+ };
589
+
590
+ type AddAccessoryButtonOptions = {
591
+ id: string;
592
+ type: 'icon';
593
+ name: string;
594
+ alt: string;
595
+ } | {
596
+ type: 'icon-double';
597
+ color?: string;
598
+ leftIconName: string;
599
+ leftIconAlt: string;
600
+ rightIconName: string;
601
+ rightIconAlt: string;
602
+ id: [string, string];
603
+ };
604
+ /**
605
+ * @public
606
+ * @category 파트너
607
+ * @name partner
608
+ * @description 파트너 기능을 사용해요.
609
+ * @property {typeof addAccessoryButton} [addAccessoryButton] 상단 네비게이션의 악세서리 버튼을 추가해요.
610
+ */
611
+ declare const partner: {
612
+ /**
613
+ * @public
614
+ * @category 파트너
615
+ * @name addAccessoryButton
616
+ * @description 상단 네비게이션의 악세서리 버튼을 추가해요. callback에 대한 정의는 `tdsEvent.addEventListener("navigationAccessoryEvent", callback)`를 참고해주세요.
617
+ * @param {AddAccessoryButtonOptions} options - 악세서리 버튼의 고유 ID예요.
618
+ * @returns {void} 악세서리 버튼을 추가했을 때 아무 값도 반환하지 않아요.
619
+ * @example
620
+ * ```tsx
621
+ * import { partner } from '@apps-in-toss/framework';
622
+ *
623
+ * partner.addAccessoryButton({
624
+ * id: 'heart',
625
+ * type: 'icon',
626
+ * name: 'icon-heart-mono',
627
+ * alt: '하트',
628
+ * });
629
+ *
630
+ * partner.addAccessoryButton({
631
+ * id: ['heart', 'heart2'],
632
+ * type: 'icon-double',
633
+ * leftIconName: 'icon-heart-mono',
634
+ * leftIconAlt: '하트',
635
+ * rightIconName: 'icon-heart-mono',
636
+ * rightIconAlt: '하트',
637
+ * });
638
+ * ```
639
+ */
640
+ addAccessoryButton: (args_0: AddAccessoryButtonOptions) => Promise<void>;
641
+ /**
642
+ * @public
643
+ * @category 파트너
644
+ * @name removeAccessoryButton
645
+ * @description 상단 네비게이션의 악세서리 버튼을 제거해요.
646
+ * @returns {void} 악세서리 버튼을 제거했을 때 아무 값도 반환하지 않아요.
647
+ * @example
648
+ * ```tsx
649
+ * import { partner } from '@apps-in-toss/framework';
650
+ *
651
+ * partner.removeAccessoryButton();
652
+ * ```
653
+ */
654
+ removeAccessoryButton: () => Promise<void>;
655
+ };
656
+
657
+ export { type AddAccessoryButtonOptions, type AppsInTossEvent, type AppsInTossGlobals, GoogleAdMob, type GraniteEvent, IAP, type IapCreateOneTimePurchaseOrderResult, type IapProductListItem, Storage, type TdsEvent, appsInTossEvent, env, getAppsInTossGlobals, getSafeAreaInsets, graniteEvent, isMinVersionSupported, partner, tdsEvent };