@apps-in-toss/web-bridge 0.0.31 → 0.0.33

package/build/bridge.d.ts

@@ -21,7 +21,10 @@ export * from './eventLog.js';
 export * from './getTossShareLink.js';
 export * from './setDeviceOrientation.js';
 export * from './saveBase64Data.js';
+export * from './getGameCenterGameProfile.js';
 export * from './getOperationalEnvironment.js';
+export * from './openGameCenterLeaderboard.js';
+export * from './submitGameCenterLeaderBoardScore.js';
 export * from './getTossAppVersion.js';
 export * from './getDeviceId.js';
 export * from './startUpdateLocation.js';

package/build/bridge.js

@@ -1 +1 @@
-import{createAsyncBridge,createConstantBridge,createEventBridge}from"@apps-in-toss/bridge-core";var createEvents=function(){return{emit:function emit(event,args){for(var callbacks=this.events[event]||[],i=0,length=callbacks.length;i<length;i++){callbacks[i](args)}},events:{},on:function on(event,cb){var _this=this;var _this_events,_event;((_this_events=this.events)[_event=event]||(_this_events[_event]=[])).push(cb);return function(){var _this_events_event;_this.events[event]=(_this_events_event=_this.events[event])===null||_this_events_event===void 0?void 0:_this_events_event.filter(function(i){return cb!==i})}}}};if(typeof window!=="undefined"){window.__BEDROCK_NATIVE_EMITTER=createEvents()}export var closeView=createAsyncBridge("closeView");export var generateHapticFeedback=createAsyncBridge("generateHapticFeedback");export var share=createAsyncBridge("share");export var setSecureScreen=createAsyncBridge("setSecureScreen");export var setScreenAwakeMode=createAsyncBridge("setScreenAwakeMode");export var getNetworkStatus=createAsyncBridge("getNetworkStatus");export var setIosSwipeGestureEnabled=createAsyncBridge("setIosSwipeGestureEnabled");export var openURL=createAsyncBridge("openURL");export var getLocale=createConstantBridge("getLocale");export var getSchemeUri=createConstantBridge("getSchemeUri");export var getPlatformOS=createConstantBridge("getPlatformOS");export var setClipboardText=createAsyncBridge("setClipboardText");export var getClipboardText=createAsyncBridge("getClipboardText");export var fetchContacts=createAsyncBridge("fetchContacts");export var fetchAlbumPhotos=createAsyncBridge("fetchAlbumPhotos");export var Accuracy=function(Accuracy){Accuracy[Accuracy["Lowest"]=1]="Lowest";Accuracy[Accuracy["Low"]=2]="Low";Accuracy[Accuracy["Balanced"]=3]="Balanced";Accuracy[Accuracy["High"]=4]="High";Accuracy[Accuracy["Highest"]=5]="Highest";Accuracy[Accuracy["BestForNavigation"]=6]="BestForNavigation";return Accuracy}({});export var getCurrentLocation=createAsyncBridge("getCurrentLocation");export var openCamera=createAsyncBridge("openCamera");export var appLogin=createAsyncBridge("appLogin");export var checkoutPayment=createAsyncBridge("checkoutPayment");export var eventLog=createAsyncBridge("eventLog");export var getTossShareLink=createAsyncBridge("getTossShareLink");export var setDeviceOrientation=createAsyncBridge("setDeviceOrientation");export var saveBase64Data=createAsyncBridge("saveBase64Data");export var getOperationalEnvironment=createConstantBridge("getOperationalEnvironment");export var getTossAppVersion=createConstantBridge("getTossAppVersion");export var getDeviceId=createConstantBridge("getDeviceId");export var startUpdateLocation=createEventBridge("startUpdateLocation");
+import{createAsyncBridge,createConstantBridge,createEventBridge}from"@apps-in-toss/bridge-core";var createEvents=function(){return{emit:function emit(event,args){for(var callbacks=this.events[event]||[],i=0,length=callbacks.length;i<length;i++){callbacks[i](args)}},events:{},on:function on(event,cb){var _this=this;var _this_events,_event;((_this_events=this.events)[_event=event]||(_this_events[_event]=[])).push(cb);return function(){var _this_events_event;_this.events[event]=(_this_events_event=_this.events[event])===null||_this_events_event===void 0?void 0:_this_events_event.filter(function(i){return cb!==i})}}}};if(typeof window!=="undefined"){window.__BEDROCK_NATIVE_EMITTER=createEvents()}export var closeView=createAsyncBridge("closeView");export var generateHapticFeedback=createAsyncBridge("generateHapticFeedback");export var share=createAsyncBridge("share");export var setSecureScreen=createAsyncBridge("setSecureScreen");export var setScreenAwakeMode=createAsyncBridge("setScreenAwakeMode");export var getNetworkStatus=createAsyncBridge("getNetworkStatus");export var setIosSwipeGestureEnabled=createAsyncBridge("setIosSwipeGestureEnabled");export var openURL=createAsyncBridge("openURL");export var getLocale=createConstantBridge("getLocale");export var getSchemeUri=createConstantBridge("getSchemeUri");export var getPlatformOS=createConstantBridge("getPlatformOS");export var setClipboardText=createAsyncBridge("setClipboardText");export var getClipboardText=createAsyncBridge("getClipboardText");export var fetchContacts=createAsyncBridge("fetchContacts");export var fetchAlbumPhotos=createAsyncBridge("fetchAlbumPhotos");export var Accuracy=function(Accuracy){Accuracy[Accuracy["Lowest"]=1]="Lowest";Accuracy[Accuracy["Low"]=2]="Low";Accuracy[Accuracy["Balanced"]=3]="Balanced";Accuracy[Accuracy["High"]=4]="High";Accuracy[Accuracy["Highest"]=5]="Highest";Accuracy[Accuracy["BestForNavigation"]=6]="BestForNavigation";return Accuracy}({});export var getCurrentLocation=createAsyncBridge("getCurrentLocation");export var openCamera=createAsyncBridge("openCamera");export var appLogin=createAsyncBridge("appLogin");export var checkoutPayment=createAsyncBridge("checkoutPayment");export var eventLog=createAsyncBridge("eventLog");export var getTossShareLink=createAsyncBridge("getTossShareLink");export var setDeviceOrientation=createAsyncBridge("setDeviceOrientation");export var saveBase64Data=createAsyncBridge("saveBase64Data");export var getGameCenterGameProfile=createAsyncBridge("getGameCenterGameProfile");export var getOperationalEnvironment=createConstantBridge("getOperationalEnvironment");export var openGameCenterLeaderboard=createAsyncBridge("openGameCenterLeaderboard");export var submitGameCenterLeaderBoardScore=createAsyncBridge("submitGameCenterLeaderBoardScore");export var getTossAppVersion=createConstantBridge("getTossAppVersion");export var getDeviceId=createConstantBridge("getDeviceId");export var startUpdateLocation=createEventBridge("startUpdateLocation");

package/build/getGameCenterGameProfile.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @category 게임센터
+ * @name GameCenterGameProfileResponse
+ * @description 토스게임센터 프로필을 가져온 결과 타입이에요.
+ * 앱에 프로필이 없는 경우, `statusCode`가 `'PROFILE_NOT_FOUND'`이고 다른 정보는 없어요.
+ * 프로필이 있는 경우 `statusCode`가 `'SUCCESS'`이고, 닉네임과 프로필 이미지 주소가 함께 제공돼요.
+ * @property {string} statusCode 프로필 조회 결과 상태예요. `'SUCCESS'` 또는 `'PROFILE_NOT_FOUND'` 중 하나예요.
+ * @property {string} [nickname] 프로필 닉네임이에요. `statusCode`가 `'SUCCESS'`일 때만 있어요.
+ * @property {string} [profileImageUri] 프로필 이미지 URL이에요. `statusCode`가 `'SUCCESS'`일 때만 있어요.
+ */
+export type GameCenterGameProfileResponse = {
+	statusCode: "PROFILE_NOT_FOUND";
+} | {
+	statusCode: "SUCCESS";
+	nickname: string;
+	profileImageUri: string;
+};
+/**
+ * @category 게임센터
+ * @name getGameCenterGameProfile
+ * @description 토스게임센터 프로필 정보를 가져와요.
+ * 사용자가 프로필을 만들지 않았다면 `statusCode`가 `'PROFILE_NOT_FOUND'`인 응답이 반환돼요.
+ * 앱 버전이 최소 지원 버전(안드로이드 5.221.0, iOS 5.221.0)보다 낮으면 `undefined`를 반환해요.
+ * @returns {Promise<GameCenterGameProfileResponse | undefined>} 프로필 정보 또는 `undefined`를 반환해요.
+ *
+ * @example
+ * ### 게임센터 프로필 가져오기
+ * ```tsx
+ * import { getGameCenterGameProfile } from './getGameCenterGameProfile';
+ * import { useState } from 'react';
+ * 
+ *
+ * function GameProfile() {
+ *   const [profile, setProfile] = useState<GameCenterGameProfileResponse | null>(null);
+ *
+ *   const handlePress = async () => {
+ *     try {
+ *       const result = await getGameCenterGameProfile();
+ *       if (result) {
+ *         setProfile(result);
+ *       }
+ *     } catch (error) {
+ *       console.error('게임센터 프로필 가져오기에 실패했어요.', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <input type="button" value="게임센터 프로필 가져오기" onClick={handlePress} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function getGameCenterGameProfile(): Promise<GameCenterGameProfileResponse | undefined>;
+
+export {};

package/build/index.d.ts

@@ -154,7 +154,7 @@ declare const IAP: {
      */
     createOneTimePurchaseOrder: (args_0: {
         productId: string;
-    }, args_1: IapCreateOneTimePurchaseOrderResult) => Promise<any>;
+    }) => Promise<IapCreateOneTimePurchaseOrderResult>;
     /**
      * @public
      * @category 인앱결제
@@ -539,4 +539,119 @@ interface AppsInTossGlobals {
 }
 declare const getAppsInTossGlobals: () => AppsInTossGlobals;
 
-export { type AppsInTossEvent, type AppsInTossGlobals, type BedrockEvent, GoogleAdMob, IAP, type IapCreateOneTimePurchaseOrderResult, type IapProductListItem, Storage, appsInTossEvent, bedrockEvent, env, getAppsInTossGlobals, getSafeAreaInsets, isMinVersionSupported };
+type TdsEvent = {
+    navigationAccessoryEvent: {
+        onEvent: (data: {
+            id: string;
+        }) => void;
+        onError?: (error: Error) => void;
+        options: undefined;
+    };
+};
+/**
+ * @public
+ * @category TDS
+ * @name tdsEvent
+ * @description 토스 이벤트를 사용해요.
+ * @property {typeof addEventListener} [addEventListener] 이벤트를 추가해요.
+ */
+declare const tdsEvent: {
+    /**
+     * @public
+     * @category TDS
+     * @name addEventListener
+     * @description 이벤트를 추가해요.
+     * @param {string} event 이벤트 이름예요.
+     * @param {TdsEvent[K]['onEvent']} onEvent 이벤트 핸들러예요.
+     * @param {TdsEvent[K]['onError']} onError 이벤트 에러 핸들러예요.
+     * @param {TdsEvent[K]['options']} options 이벤트 옵션예요.
+     * @returns {void} 이벤트를 추가했을 때 아무 값도 반환하지 않아요.
+     * @example
+     * ### 네비게이션 악세서리 이벤트 추가하기
+     * ```tsx
+     * import { tdsEvent } from '@apps-in-toss/framework';
+     *
+     * tdsEvent.addEventListener('navigationAccessoryEvent', {
+     *   onEvent: ({ id }) => {
+     *     if(id === 'heart') {
+     *       router.push('/heart');
+     *     }
+     *   },
+     * });
+     * ```
+     */
+    addEventListener: <K extends keyof TdsEvent>(event: K, { onEvent, onError, options, }: {
+        onEvent: TdsEvent[K]["onEvent"];
+        onError?: TdsEvent[K]["onError"];
+        options?: TdsEvent[K]["options"];
+    }) => () => void;
+};
+
+type AddAccessoryButtonOptions = {
+    id: string;
+    type: 'icon';
+    name: string;
+    alt: string;
+} | {
+    type: 'icon-double';
+    color?: string;
+    leftIconName: string;
+    leftIconAlt: string;
+    rightIconName: string;
+    rightIconAlt: string;
+    id: [string, string];
+};
+/**
+ * @public
+ * @category 파트너
+ * @name partner
+ * @description 파트너 기능을 사용해요.
+ * @property {typeof addAccessoryButton} [addAccessoryButton] 상단 네비게이션의 악세서리 버튼을 추가해요.
+ */
+declare const partner: {
+    /**
+     * @public
+     * @category 파트너
+     * @name addAccessoryButton
+     * @description 상단 네비게이션의 악세서리 버튼을 추가해요. callback에 대한 정의는 `tdsEvent.addEventListener("navigationAccessoryEvent", callback)`를 참고해주세요.
+     * @param {AddAccessoryButtonOptions} options - 악세서리 버튼의 고유 ID예요.
+     * @returns {void} 악세서리 버튼을 추가했을 때 아무 값도 반환하지 않아요.
+     * @example
+     * ```tsx
+     * import { partner } from '@apps-in-toss/framework';
+     *
+     * partner.addAccessoryButton({
+     *   id: 'heart',
+     *   type: 'icon',
+     *   name: 'icon-heart-mono',
+     *   alt: '하트',
+     * });
+     *
+     * partner.addAccessoryButton({
+     *   id: ['heart', 'heart2'],
+     *   type: 'icon-double',
+     *   leftIconName: 'icon-heart-mono',
+     *   leftIconAlt: '하트',
+     *   rightIconName: 'icon-heart-mono',
+     *   rightIconAlt: '하트',
+     * });
+     * ```
+     */
+    addAccessoryButton: (args_0: AddAccessoryButtonOptions) => Promise<void>;
+    /**
+     * @public
+     * @category 파트너
+     * @name removeAccessoryButton
+     * @description 상단 네비게이션의 악세서리 버튼을 제거해요.
+     * @returns {void} 악세서리 버튼을 제거했을 때 아무 값도 반환하지 않아요.
+     * @example
+     * ```tsx
+     * import { partner } from '@apps-in-toss/framework';
+     *
+     * partner.removeAccessoryButton();
+     * ```
+     */
+    removeAccessoryButton: () => Promise<void>;
+};
+
+export { type AddAccessoryButtonOptions, type AppsInTossEvent, type AppsInTossGlobals, type BedrockEvent, GoogleAdMob, IAP, type IapCreateOneTimePurchaseOrderResult, type IapProductListItem, Storage, type TdsEvent, appsInTossEvent, bedrockEvent, env, getAppsInTossGlobals, getSafeAreaInsets, isMinVersionSupported, partner, tdsEvent };

package/build/index.js

@@ -121,7 +121,7 @@ function getSafeAreaInsets() {
 }
 
 // src/googleAdMob.ts
-import { createEventBridge, createConstantBridge as createConstantBridge2 } from "@apps-in-toss/bridge-core";
+import { createConstantBridge as createConstantBridge2, createEventBridge } from "@apps-in-toss/bridge-core";
 var GoogleAdMob = {
   /**
    * @public
@@ -542,6 +542,93 @@ var getAppsInTossGlobals = () => {
     brandBridgeColorMode: brandBridgeColorMode()
   };
 };
+
+// src/tdsEvent.ts
+import { createEventBridge as createEventBridge4 } from "@apps-in-toss/bridge-core";
+var tdsEvent = {
+  /**
+   * @public
+   * @category TDS
+   * @name addEventListener
+   * @description 이벤트를 추가해요.
+   * @param {string} event 이벤트 이름예요.
+   * @param {TdsEvent[K]['onEvent']} onEvent 이벤트 핸들러예요.
+   * @param {TdsEvent[K]['onError']} onError 이벤트 에러 핸들러예요.
+   * @param {TdsEvent[K]['options']} options 이벤트 옵션예요.
+   * @returns {void} 이벤트를 추가했을 때 아무 값도 반환하지 않아요.
+   * @example
+   * ### 네비게이션 악세서리 이벤트 추가하기
+   * ```tsx
+   * import { tdsEvent } from '@apps-in-toss/framework';
+   *
+   * tdsEvent.addEventListener('navigationAccessoryEvent', {
+   *   onEvent: ({ id }) => {
+   *     if(id === 'heart') {
+   *       router.push('/heart');
+   *     }
+   *   },
+   * });
+   * ```
+   */
+  addEventListener: (event, {
+    onEvent,
+    onError,
+    options
+  }) => createEventBridge4(event)({
+    onEvent,
+    onError: onError ?? (() => {
+    }),
+    options
+  })
+};
+
+// src/partner.ts
+import { createAsyncBridge as createAsyncBridge3 } from "@apps-in-toss/bridge-core";
+var partner = {
+  /**
+   * @public
+   * @category 파트너
+   * @name addAccessoryButton
+   * @description 상단 네비게이션의 악세서리 버튼을 추가해요. callback에 대한 정의는 `tdsEvent.addEventListener("navigationAccessoryEvent", callback)`를 참고해주세요.
+   * @param {AddAccessoryButtonOptions} options - 악세서리 버튼의 고유 ID예요.
+   * @returns {void} 악세서리 버튼을 추가했을 때 아무 값도 반환하지 않아요.
+   * @example
+   * ```tsx
+   * import { partner } from '@apps-in-toss/framework';
+   *
+   * partner.addAccessoryButton({
+   *   id: 'heart',
+   *   type: 'icon',
+   *   name: 'icon-heart-mono',
+   *   alt: '하트',
+   * });
+   *
+   * partner.addAccessoryButton({
+   *   id: ['heart', 'heart2'],
+   *   type: 'icon-double',
+   *   leftIconName: 'icon-heart-mono',
+   *   leftIconAlt: '하트',
+   *   rightIconName: 'icon-heart-mono',
+   *   rightIconAlt: '하트',
+   * });
+   * ```
+   */
+  addAccessoryButton: createAsyncBridge3("addAccessoryButton"),
+  /**
+   * @public
+   * @category 파트너
+   * @name removeAccessoryButton
+   * @description 상단 네비게이션의 악세서리 버튼을 제거해요.
+   * @returns {void} 악세서리 버튼을 제거했을 때 아무 값도 반환하지 않아요.
+   * @example
+   * ```tsx
+   * import { partner } from '@apps-in-toss/framework';
+   *
+   * partner.removeAccessoryButton();
+   * ```
+   */
+  removeAccessoryButton: createAsyncBridge3("removeAccessoryButton")
+};
 export {
   GoogleAdMob,
   IAP,
@@ -551,5 +638,7 @@ export {
   env,
   getAppsInTossGlobals,
   getSafeAreaInsets,
-  isMinVersionSupported
+  isMinVersionSupported,
+  partner,
+  tdsEvent
 };

package/build/openGameCenterLeaderboard.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @public
+ * @category 게임센터
+ * @name openGameCenterLeaderboard
+ * @description 게임센터 리더보드 웹뷰를 열어요.
+ * 앱 버전이 최소 지원 버전(`5.221.0`)보다 낮으면 아무 동작도 하지 않고 `undefined`를 반환해요.
+ * 게임센터를 사용하는 사용자는 반드시 최소 지원 버전 이상이어야 게임을 실행할 수 있어요.
+ * @returns 리더보드 웹뷰를 호출해요. 앱 버전이 낮으면 아무 동작도 하지 않고 `undefined`를 반환해요.
+ *
+ * @example
+ * 
+ * import { openGameCenterLeaderboard } from '@apps-in-toss/web-framework';
+ *
+ * // '리더보드' 버튼을 누르면 게임센터 리더보드 웹뷰가 열려요.
+ * function LeaderboardButton() {
+ *   const onClick = () => {
+ *     openGameCenterLeaderboard();
+ *   };
+ *
+ *   return <input type="button" value="리더보드 웹뷰 호출" onClick={onClick} />;
+ * }
+ */
+export declare function openGameCenterLeaderboard(): Promise<void>;
+
+export {};

package/build/submitGameCenterLeaderBoardScore.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @public
+ * @category 게임센터
+ * @name SubmitGameCenterLeaderBoardScoreResponse
+ * @description
+ * 토스게임센터 리더보드에 점수를 제출한 결과 정보를 담아서 반환해요. 반환된 정보를 사용해서 점수 제출 결과에 따라 적절한 에러 처리를 할 수 있어요.
+ * @property {'SUCCESS' | 'LEADERBOARD_NOT_FOUND' | 'PROFILE_NOT_FOUND' | 'UNPARSABLE_SCORE'} statusCode
+ * 점수 제출 결과를 나타내는 상태 코드예요.
+ * - `'SUCCESS'`: 점수 제출이 성공했어요.
+ * - `'LEADERBOARD_NOT_FOUND'`: `gameId`에 해당하는 리더보드를 찾을 수 없어요.
+ * - `'PROFILE_NOT_FOUND'`: 사용자의 프로필이 없어요.
+ * - `'UNPARSABLE_SCORE'`: 점수를 해석할 수 없어요. 점수는 실수(float) 형태의 문자열로 전달해야 해요.
+ */
+export interface SubmitGameCenterLeaderBoardScoreResponse {
+	statusCode: "SUCCESS" | "LEADERBOARD_NOT_FOUND" | "PROFILE_NOT_FOUND" | "UNPARSABLE_SCORE";
+}
+/**
+ * @public
+ * @category 게임센터
+ * @name submitGameCenterLeaderBoardScore
+ * @description
+ * 사용자의 게임 점수를 토스게임센터 리더보드에 제출해요. 이 기능으로 사용자의 점수를 공식 리더보드에 기록하고 다른 사용자와 비교할 수 있어요.
+ * @param {string} params.score
+ * 제출할 게임 점수예요. 실수 형태의 숫자를 문자열로 전달해야 해요. 예를들어 `"123.45"` 또는 `"9999"` 예요.
+ * @returns {Promise<SubmitGameCenterLeaderBoardScoreResponse | undefined>}
+ * 점수 제출 결과를 반환해요. 앱 버전이 최소 지원 버전보다 낮으면 아무 동작도 하지 않고 `undefined`를 반환해요.
+ *
+ * @example
+ * ### 게임 점수를 토스게임센터 리더보드에 제출하기
+ * ```tsx
+ * 
+ * import { submitGameCenterLeaderBoardScore } from '@apps-in-toss/web-framework';
+ *
+ * function GameCenterLeaderBoardScoreSubmitButton() {
+ *   async function handlePress() {
+ *     try {
+ *       const result = await submitGameCenterLeaderBoardScore({ score: '123.45' });
+ *
+ *       if (!result) {
+ *         console.warn('지원하지 않는 앱 버전이에요.');
+ *         return;
+ *       }
+ *
+ *       if (result.statusCode === 'SUCCESS') {
+ *         console.log('점수 제출 성공!');
+ *       } else {
+ *         console.error('점수 제출 실패:', result.statusCode);
+ *       }
+ *     } catch (error) {
+ *       console.error('점수 제출 중 오류가 발생했어요.', error);
+ *     }
+ *   }
+ *
+ *   return (
+ *     <input type="button" onClick={handlePress}>점수 제출하기</button>
+ *   );
+ * }
+ * ```
+ */
+export declare function submitGameCenterLeaderBoardScore(params: {
+	score: string;
+}): Promise<SubmitGameCenterLeaderBoardScoreResponse | undefined>;
+
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apps-in-toss/web-bridge",
   "type": "module",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "Web Bridge for Apps In Toss",
   "scripts": {
     "prepack": "yarn build",
@@ -23,9 +23,9 @@
     "build"
   ],
   "devDependencies": {
-    "@apps-in-toss-internal/bridgepack": "0.0.31",
-    "@apps-in-toss/bridge-core": "0.0.31",
-    "@apps-in-toss/framework": "0.0.31",
+    "@apps-in-toss-internal/bridgepack": "0.0.33",
+    "@apps-in-toss/bridge-core": "0.0.33",
+    "@apps-in-toss/framework": "0.0.33",
     "react-native-bedrock": "0.0.25",
     "tsup": "^8.3.5",
     "typescript": "4.9.5",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d4fa62f4014162182181b9911e0a2912fdec318d"
+  "gitHead": "6b7e58eea07536c97dee1de3ae03e565c726f619"
 }