@apps-in-toss/native-modules 0.0.0-dev.1752115036458 → 0.0.0-dev.1757056983098

package/src/AppsInTossModule/native-modules/storage.ts

@@ -0,0 +1,100 @@
+import { AppsInTossModule } from './AppsInTossModule';
+
+/**
+ * @public
+ * @category 저장소
+ * @name getItem
+ * @description 모바일 앱의 로컬 저장소에서 문자열 데이터를 가져와요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
+ * @param {string} key - 가져올 아이템의 키를 입력해요.
+ * @returns {Promise<string | null>} 지정한 키에 저장된 문자열 값을 반환해요. 값이 없으면 `null`을 반환해요.
+ * @example
+ *
+ * ### `my-key`에 저장된 아이템 가져오기
+ * ```ts
+ * const value = await Storage.getItem('my-key');
+ * console.log(value); // 'value'
+ * ```
+ */
+function getItem(key: string): Promise<string | null> {
+  return AppsInTossModule.getStorageItem({ key });
+}
+
+/**
+ * @public
+ * @category 저장소
+ * @name setItem
+ * @description 모바일 앱의 로컬 저장소에 문자열 데이터를 저장해요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
+ * @param {string} key - 저장할 아이템의 키를 입력해요.
+ * @param {string} value - 저장할 아이템의 값을 입력해요.
+ * @returns {Promise<void>} 아이템을 성공적으로 저장하면 아무 값도 반환하지 않아요.
+ * @example
+ *
+ * ### `my-key`에 아이템 저장하기
+ * ```ts
+ * import { Storage } from '@apps-in-toss/framework';
+ *
+ * await Storage.setItem('my-key', 'value');
+ * ```
+ */
+function setItem(key: string, value: string): Promise<void> {
+  return AppsInTossModule.setStorageItem({
+    key,
+    value,
+  });
+}
+
+/**
+ * @public
+ * @category 저장소
+ * @name removeItem
+ * @description 모바일 앱의 로컬 저장소에서 특정 키에 해당하는 아이템을 삭제해요.
+ * @param {string} key - 삭제할 아이템의 키를 입력해요.
+ * @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않아요.
+ * @example
+ *
+ * ### `my-key`에 저장된 아이템 삭제하기
+ * ```ts
+ * import { Storage } from '@apps-in-toss/framework';
+ *
+ * await Storage.removeItem('my-key');
+ * ```
+ */
+function removeItem(key: string): Promise<void> {
+  return AppsInTossModule.removeStorageItem({ key });
+}
+
+/**
+ * @public
+ * @category 저장소
+ * @name clearItems
+ * @description 모바일 앱의 로컬 저장소의 모든 아이템을 삭제해요.
+ * @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않고 저장소가 초기화돼요.
+ * @example
+ *
+ * ### 저장소 초기화하기
+ * ```ts
+ * import { Storage } from '@apps-in-toss/framework';
+ *
+ * await Storage.clearItems();
+ * ```
+ */
+function clearItems(): Promise<void> {
+  return AppsInTossModule.clearStorage({});
+}
+
+/**
+ * @public
+ * @category 저장소
+ * @name Storage
+ * @description 네이티브의 저장소를 사용해요.
+ * @property {typeof getItem} [getItem] 모바일 앱의 로컬 저장소에서 아이템을 가져오는 함수예요. 자세한 내용은 [getItem](/react-native/reference/native-modules/저장소/getItem.html)을 참고하세요.
+ * @property {typeof setItem} [setItem] 모바일 앱의 로컬 저장소에 아이템을 저장하는 함수예요. 자세한 내용은 [setItem](/react-native/reference/native-modules/저장소/setItem.html)을 참고하셰요.
+ * @property {typeof removeItem} [removeItem] 모바일 앱의 로컬 저장소에서 아이템을 삭제하는 함수예요. 자세한 내용은 [removeItem](/react-native/reference/native-modules/저장소/removeItem.html)을 참고하세요.
+ * @property {typeof clearItems} [clearItems] 모바일 앱의 로컬 저장소를 초기화하는 함수예요. 자세한 내용은 [clearItems](/react-native/reference/native-modules/저장소/clearItems.html)을 참고하세요.
+ */
+export const Storage = {
+  getItem,
+  setItem,
+  removeItem,
+  clearItems,
+};

package/src/AppsInTossModule/native-modules/submitGameCenterLeaderBoardScore.ts

@@ -0,0 +1,74 @@
+import { AppsInTossModule } from './AppsInTossModule';
+import { isMinVersionSupported } from './isMinVersionSupported';
+import { GAME_CENTER_MIN_VERSION } from '../constants';
+
+/**
+ * @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 { Button } from 'react-native';
+ * import { submitGameCenterLeaderBoardScore } from '@apps-in-toss/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 (
+ *     <Button onPress={handlePress}>점수 제출하기</Button>
+ *   );
+ * }
+ * ```
+ */
+
+export async function submitGameCenterLeaderBoardScore(params: { score: string }) {
+  const isSupported = isMinVersionSupported(GAME_CENTER_MIN_VERSION);
+
+  if (!isSupported) {
+    return;
+  }
+
+  return AppsInTossModule.submitGameCenterLeaderBoardScore(params);
+}

package/src/AppsInTossModule/native-modules/tossCore.ts

@@ -0,0 +1,29 @@
+import { NativeModules } from 'react-native';
+import { getOperationalEnvironment } from './getOperationalEnvironment';
+import { isMinVersionSupported } from './isMinVersionSupported';
+
+const TossCoreModule: {
+  eventLog: (params: {
+    params: {
+      log_name: string;
+      log_type: string;
+      params: Record<string, unknown>;
+    };
+  }) => Promise<void>;
+} = NativeModules.TossCoreModule;
+
+export function tossCoreEventLog(params: { log_name: string; log_type: string; params: Record<string, unknown> }) {
+  const supported = isMinVersionSupported({ ios: '5.210.0', android: '5.210.0' });
+  const isSandbox = getOperationalEnvironment() === 'sandbox';
+  if (!supported || isSandbox) {
+    return;
+  }
+
+  TossCoreModule.eventLog({
+    params: {
+      log_name: params.log_name,
+      log_type: params.log_type,
+      params: params.params,
+    },
+  });
+}

package/src/BedrockModule/native-modules/core/BedrockCoreModule.ts

@@ -0,0 +1,8 @@
+import { NativeModules } from 'react-native';
+
+interface BedrockCoreModule {
+  addListener: (eventType: string) => void;
+  removeListeners: (count: number) => void;
+}
+
+export const BedrockCoreModule: BedrockCoreModule = NativeModules.BedrockCoreModule;

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

@@ -0,0 +1,4 @@
+/** Bridges API */
+export * from './natives';
+export { BedrockModule } from './natives/BedrockModule';
+export { BedrockCoreModule } from './core/BedrockCoreModule';

package/src/BedrockModule/native-modules/natives/BedrockModule.ts

@@ -0,0 +1,20 @@
+import { NativeModules } from 'react-native';
+import type { HapticFeedbackOptions } from './generateHapticFeedback/types';
+import type { NetworkStatus } from './getNetworkStatus/types';
+
+interface BedrockModule {
+  closeView: () => void;
+  generateHapticFeedback: (options: HapticFeedbackOptions) => Promise<void>;
+  share: (message: { message: string }) => void;
+  setSecureScreen: (options: { enabled: boolean }) => Promise<{ enabled: boolean }>;
+  setScreenAwakeMode: (options: { enabled: boolean }) => Promise<{ enabled: boolean }>;
+  getNetworkStatus: () => Promise<NetworkStatus>;
+  setIosSwipeGestureEnabled: ({ isEnabled }: { isEnabled: boolean }) => Promise<void>;
+  deviceId: string;
+  DeviceInfo: {
+    locale: string;
+  };
+  schemeUri: string;
+}
+
+export const BedrockModule: BedrockModule = NativeModules.BedrockModule;

package/src/BedrockModule/native-modules/natives/closeView.ts

@@ -0,0 +1,25 @@
+import { BedrockModule } from './BedrockModule';
+
+/**
+ * @public
+ * @category 화면 제어
+ * @kind function
+ * @name closeView
+ * @description 현재 화면을 닫는 함수에요. 예를 들어, "닫기" 버튼을 눌러서 서비스를 종료할 때 사용할 수 있어요.
+ * @returns {Promise<void>}
+ *
+ * @example
+ * ### 닫기 버튼을 눌러 화면 닫기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { closeView } from '@apps-in-toss/native-modules';
+ *
+ * function CloseButton() {
+ *  return <Button title="닫기" onPress={closeView} />;
+ * }
+ * ```
+ */
+export async function closeView() {
+  return BedrockModule.closeView();
+}

package/src/BedrockModule/native-modules/natives/generateHapticFeedback/index.ts

@@ -0,0 +1,27 @@
+import { HapticFeedbackOptions, HapticFeedbackType } from './types';
+import { BedrockModule } from '../BedrockModule';
+
+/**
+ * @public
+ * @category 인터렉션
+ * @name generateHapticFeedback
+ * @description 디바이스에 햅틱 진동을 일으키는 함수예요. 예를 들어, 버튼 터치나 화면전환에 드라마틱한 효과를 주고 싶을 때 사용할 수 있어요. [HapticFeedbackOptions](/react-native/reference/native-modules/인터렉션/HapticFeedbackOptions.html)에서 진동타입을 확인해 보세요.
+ * @returns {void}
+ *
+ * @example
+ * ### 버튼을 눌러 햅틱 일으키기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { generateHapticFeedback } from '@apps-in-toss/native-modules';
+ *
+ * function GenerateHapticFeedback() {
+ *  return <Button title="햅틱" onPress={() => { generateHapticFeedback( { type: "tickWeak"}) }} />;
+ * }
+ * ```
+ */
+export function generateHapticFeedback(options: HapticFeedbackOptions) {
+  return BedrockModule.generateHapticFeedback(options);
+}
+
+export type { HapticFeedbackType };

package/src/BedrockModule/native-modules/natives/generateHapticFeedback/types.ts

@@ -0,0 +1,38 @@
+export type HapticFeedbackType =
+  | 'tickWeak'
+  | 'tap'
+  | 'tickMedium'
+  | 'softMedium'
+  | 'basicWeak'
+  | 'basicMedium'
+  | 'success'
+  | 'error'
+  | 'wiggle'
+  | 'confetti';
+
+/**
+ * @public
+ * @category 인터렉션
+ * @name HapticFeedbackOptions
+ * @description
+ * generateHapticFeedback 함수에 전달할 햅틱진동의 타입을 나타내요. 진동타입의 종류는 다음과 같아요.
+ * ```typescript
+ * type HapticFeedbackType =
+ * | "tickWeak"
+ * | "tap"
+ * | "tickMedium"
+ * | "softMedium"
+ * | "basicWeak"
+ * | "basicMedium"
+ * | "success"
+ * | "error"
+ * | "wiggle"
+ * | "confetti";
+ * ```
+ * @typedef { type: HapticFeedbackType } HapticFeedbackOptions
+ * @typedef { "tickWeak" | "tap" | "tickMedium" | "softMedium" | "basicWeak" | "basicMedium" | "success" | "error" | "wiggle" | "confetti" } HapticFeedbackType
+ *
+ */
+export interface HapticFeedbackOptions {
+  type: HapticFeedbackType;
+}

package/src/BedrockModule/native-modules/natives/getLocale.ts

@@ -0,0 +1,46 @@
+import { Platform } from 'react-native';
+import { BedrockModule } from './BedrockModule';
+
+/**
+ * @public
+ * @category 언어
+ * @kind function
+ * @name getLocale
+ * @description
+ * 사용자의 로케일(locale) 정보를 반환해요. 네이티브 모듈에서 로케일 정보를 가져올 수 없을 때는 기본값으로 'ko-KR'을 반환합니다. 앱의 현지화 및 언어 설정과 관련된 기능을 구현할 때 사용하세요.
+ *
+ * @returns {string} 사용자의 로케일 정보를 반환해요.
+ *
+ * @example
+ * ### 현재 사용자의 로케일 정보 가져오기
+ *
+ * ```tsx
+ * import { getLocale } from '@apps-in-toss/native-modules';
+ * import { Text } from 'react-native';
+ *
+ * function MyPage() {
+ *  const locale = getLocale();
+ *
+ *  return (
+ *    <Text>사용자의 로케일 정보: {locale}</Text>
+ *  )
+ * }
+ *
+ * ```
+ */
+export function getLocale() {
+  const locale = BedrockModule?.DeviceInfo?.locale ?? 'ko-KR';
+
+  if (Platform.OS === 'android') {
+    return replaceUnderbarToHypen(locale);
+  }
+
+  return locale;
+}
+
+/**
+ * android 에서 언더바(`_`) 로 구분되고 있어서, 이를 하이픈(`-`)으로 변경합니다.
+ */
+function replaceUnderbarToHypen(locale: string) {
+  return locale.replace(/_/g, '-');
+}

package/src/BedrockModule/native-modules/natives/getNetworkStatus/index.ts

@@ -0,0 +1,59 @@
+import type { NetworkStatus } from './types';
+import { BedrockModule } from '../BedrockModule';
+
+/**
+ * @public
+ * @category 네트워크
+ * @kind function
+ * @name getNetworkStatus
+ * @description
+ * 디바이스의 현재 네트워크 연결 상태를 가져오는 함수예요.
+ * 반환 값은 `NetworkStatus` 타입으로, 인터넷 연결 여부와 연결 유형(Wi-Fi, 모바일 데이터 등)을 나타내요. 값은 다음 중 하나예요.
+ *
+ * - `OFFLINE`: 인터넷에 연결되지 않은 상태예요.
+ * - `WIFI`: Wi-Fi에 연결된 상태예요.
+ * - `2G`: 2G 네트워크에 연결된 상태예요.
+ * - `3G`: 3G 네트워크에 연결된 상태예요.
+ * - `4G`: 4G 네트워크에 연결된 상태예요.
+ * - `5G`: 5G 네트워크에 연결된 상태예요.
+ * - `WWAN`: 인터넷은 연결되었지만, 연결 유형(Wi-Fi, 2G~5G)을 알 수 없는 상태예요. 이 상태는 iOS에서만 확인할 수 있어요.
+ * - `UNKNOWN`: 인터넷 연결 상태를 알 수 없는 상태예요. 이 상태는 안드로이드에서만 확인할 수 있어요.
+ *
+ * @returns {Promise<NetworkStatus>} 네트워크 상태를 반환해요.
+ *
+ * @example
+ * ### 현재 네트워크 상태 가져오기
+ *
+ * 네트워크 연결 상태를 가져와 화면에 표시하는 예제예요.
+ *
+ * ```tsx
+ * import { useState, useEffect } from 'react';
+ * import { Text, View } from 'react-native';
+ * import { getNetworkStatus, NetworkStatus } from '@apps-in-toss/native-modules';
+ *
+ * function GetNetworkStatus() {
+ *   const [status, setStatus] = useState<NetworkStatus | ''>('');
+ *
+ *   useEffect(() => {
+ *     async function fetchStatus() {
+ *       const networkStatus = await getNetworkStatus();
+ *       setStatus(networkStatus);
+ *     }
+ *
+ *     fetchStatus();
+ *   }, []);
+ *
+ *   return (
+ *     <View>
+ *       <Text>현재 네트워크 상태: {status}</Text>
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export function getNetworkStatus(): Promise<NetworkStatus> {
+  return BedrockModule.getNetworkStatus();
+}
+
+/** export type */
+export type { NetworkStatus };

package/src/BedrockModule/native-modules/natives/getNetworkStatus/types.ts

@@ -0,0 +1 @@
+export type NetworkStatus = 'OFFLINE' | 'WIFI' | '2G' | '3G' | '4G' | '5G' | 'WWAN' | 'UNKNOWN';

package/src/BedrockModule/native-modules/natives/getPlatformOS.ts

@@ -0,0 +1,37 @@
+import { Platform } from 'react-native';
+
+/**
+ * @public
+ * @kind function
+ * @category 환경 확인
+ *
+ * @name getPlatformOS
+ * @signature
+ * ```typescript
+ * function getPlatformOS(): 'ios' | 'android';
+ * ```
+ *
+ * @description
+ * 현재 실행 중인 플랫폼을 확인하는 함수예요.
+ * 이 함수는 `react-native`의 [`Platform.OS`](https://reactnative.dev/docs/0.72/platform#os) 값을 기반으로 동작하며, `ios` 또는 `android` 중 하나의 문자열을 반환해요.
+ *
+ * @returns {'ios' | 'android'} 현재 실행 중인 플랫폼
+ *
+ * @example
+ *
+ * ### 현재 실행중인 OS 플랫폼 확인하기
+ *
+ * ```tsx
+ * import { getPlatformOS } from '@apps-in-toss/native-modules';
+ * import { Text } 'react-native';
+ *
+ * function Page() {
+ *   const platform = getPlatformOS();
+ *
+ *   return <Text>현재 플랫폼: {platform}</Text>;
+ * }
+ * ```
+ */
+export function getPlatformOS(): 'ios' | 'android' {
+  return Platform.OS as 'ios' | 'android';
+}

package/src/BedrockModule/native-modules/natives/getSchemeUri.ts

@@ -0,0 +1,27 @@
+import { BedrockModule } from './BedrockModule';
+
+/**
+ * @public
+ * @name getSchemeUri
+ * @category 환경 확인
+ * @kind function
+ * @description 처음에 화면에 진입한 스킴 값이에요. 페이지 이동으로 인한 URI 변경은 반영되지 않아요.
+ * @returns {string} 처음에 화면에 진입한 스킴 값을 반환해요.
+ *
+ * @example
+ * ### 처음 진입한 스킴 값 가져오기
+ *
+ * ```tsx
+ * import { getSchemeUri } from '@apps-in-toss/native-modules';
+ * import { Text } from 'react-native';
+ *
+ * function MyPage() {
+ *  const schemeUri = getSchemeUri();
+ *
+ *  return <Text>처음에 화면에 진입한 스킴 값: {schemeUri}</Text>
+ * }
+ * ```
+ */
+export function getSchemeUri() {
+  return BedrockModule.schemeUri;
+}

package/src/BedrockModule/native-modules/natives/index.ts

@@ -0,0 +1,11 @@
+export * from './closeView';
+export * from './getLocale';
+export * from './getSchemeUri';
+export * from './generateHapticFeedback';
+export * from './share';
+export * from './setSecureScreen';
+export * from './setScreenAwakeMode';
+export * from './getNetworkStatus';
+export * from './setIosSwipeGestureEnabled';
+export * from './openURL';
+export * from './getPlatformOS';

package/src/BedrockModule/native-modules/natives/openURL.ts

@@ -0,0 +1,40 @@
+import { Linking } from 'react-native';
+
+/**
+ * @public
+ * @kind function
+ * @category 화면 이동
+ *
+ * @name openURL
+ * @signature
+ * ```typescript
+ * function openURL(url: string): Promise<any>;
+ * ```
+ *
+ * @description
+ * 지정된 URL을 기기의 기본 브라우저나 관련 앱에서 열어요.
+ * 이 함수는 `react-native`의 [`Linking.openURL`](https://reactnative.dev/docs/0.72/linking#openurl) 메서드를 사용하여 URL을 열어요.
+ *
+ * @param {string} url 열고자 하는 URL 주소
+ * @returns {Promise<any>} URL이 성공적으로 열렸을 때 해결되는 Promise
+ *
+ * @example
+ *
+ * ### 외부 URL 열기
+ *
+ * ```tsx
+ * import { openURL } from '@apps-in-toss/native-modules';
+ * import { Button } from 'react-native';
+ *
+ * function Page() {
+ *   const handlePress = () => {
+ *     openURL('https://google.com');
+ *   };
+ *
+ *   return <Button title="구글 웹사이트 열기" onPress={handlePress} />;
+ * }
+ * ```
+ */
+export function openURL(url: string): Promise<any> {
+  return Linking.openURL(url);
+}

package/src/BedrockModule/native-modules/natives/setIosSwipeGestureEnabled.ts

@@ -0,0 +1,43 @@
+import { BedrockModule } from './BedrockModule';
+
+/**
+ * @public
+ * @category 화면 제어
+ * @name setIosSwipeGestureEnabled
+ * @description
+ * `setIosSwipeGestureEnabled` 함수는 iOS에서 화면을 스와이프하여 뒤로가기 기능을 활성화하거나 비활성화할 수 있어요.
+ *
+ * @param {object} options 스와이프하여 뒤로가기 기능을 활성화하거나 비활성화하는 옵션이에요.
+ * @param {boolean} options.isEnabled 화면을 스와이프하여 뒤로가기 기능을 활성화하거나 비활성화할 수 있어요. `true`를 설정하면 스와이프로 뒤로갈 수 있고, `false`를 설정하면 스와이프 뒤로가기 기능이 비활성화돼요.
+ *
+ * @returns {void}
+ *
+ * @example
+ *
+ * ### iOS에서 화면 스와이프로 뒤로가기 기능을 활성화하거나 비활성화하기
+ *
+ * **스와이프 끄기** 버튼을 눌러 화면 스와이프로 뒤로가기 기능을 비활성화하거나, **스와이프 켜기** 버튼을 눌러 화면 스와이프로 뒤로가기 기능을 활성화할 수 있어요.
+ *
+ *
+ * ```tsx
+ * import { setIosSwipeGestureEnabled } from '@apps-in-toss/native-modules';
+ * import { Button } from 'react-native';
+ *
+ * function Page() {
+ *  return (
+ *    <>
+ *     <Button title="스와이프 끄기" onPress={() => setIosSwipeGestureEnabled({ isEnabled: false })} />
+ *     <Button title="스와이프 켜기" onPress={() => setIosSwipeGestureEnabled({ isEnabled: true })} />
+ *    </>
+ *  );
+ * }
+ * ```
+ *
+ */
+export async function setIosSwipeGestureEnabled(options: { isEnabled: boolean }) {
+  if (BedrockModule.setIosSwipeGestureEnabled == null) {
+    return;
+  }
+
+  return BedrockModule.setIosSwipeGestureEnabled(options);
+}

package/src/BedrockModule/native-modules/natives/setScreenAwakeMode.ts

@@ -0,0 +1,66 @@
+import { BedrockModule } from './BedrockModule';
+
+/**
+ * @public
+ * @category 화면 제어
+ * @kind function
+ * @name setScreenAwakeMode
+ * @description
+ * `setScreenAwakeMode` 함수는 화면이 항상 켜져 있도록 설정하거나 해제하는 기능을 제공해요.
+ * 이 기능은 웹툰, 동영상, 문서 읽기 등 화면을 지속해서 켜두어야 하는 상황에서 유용해요.
+ *
+ * `enabled` 옵션을 `true`로 설정하면 화면이 꺼지지 않게 유지하고,  `false`로 설정하면 기본 화면 보호기 시간에 따라 화면이 꺼져요.  특히, 이 함수는 앱 전체에 영향을 미치므로 특정 화면에서만 사용하려면 화면을 벗어날 때 이전 상태로 복구하는 추가 작업이 필요해요.
+ *
+ * 예를 들어, 미디어 콘텐츠 감상 화면에서는 항상 켜짐 모드를 활성화하고, 화면을 떠날 때 설정을 복구해서 불필요한 배터리 소모를 방지할 수 있어요.
+ *
+ * 다만, 앱에서 벗어나는 상황에서는 항상 켜짐 모드가 비활성화될 수 있으니 주의해야 해요.
+ *
+ * @param {object} options 화면 항상 켜짐 모드의 설정 값이에요.
+ * @param {boolean} options.enabled 화면 항상 켜짐 모드를 켜거나 끄는 옵션이에요.
+ * `true`로 설정하면 화면이 항상 켜지고, `false`로 설정하면 화면 보호기 시간에 따라 꺼져요.
+ *
+ * @returns {object} 현재 화면 항상 켜짐 모드의 설정 상태를 반환해요.
+ * @returns {boolean} enabled 화면 항상 켜짐 모드가 켜져 있는지 여부를 나타내는 값이에요.
+ *
+ * @example
+ * ### 화면 항상 켜짐 모드 설정하기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { setScreenAwakeMode } from '@apps-in-toss/native-modules';
+ *
+ * function SetScreenAwakeMode() {
+ *   return (
+ *     <Button
+ *       title="화면 항상 켜기"
+ *       onPress={() => {
+ *         setScreenAwakeMode({ enabled: true });
+ *       }}
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * ### 화면 항상 켜짐 모드 복구하기
+ * 특정 화면을 벗어날 때 이전 상태로 복구하려면 다음과 같이 `useEffect`를 사용하세요.
+ *
+ * ```tsx
+ * import { useEffect } from 'react';
+ * import { setScreenAwakeMode, cleanUp } from '@apps-in-toss/native-modules';
+ *
+ * function MediaScreen() {
+ *   useEffect(() => {
+ *     setScreenAwakeMode({ enabled: true });
+ *
+ *     return () => {
+ *       setScreenAwakeMode({ enabled: false }); // 설정을 이전 상태로 복구해요.
+ *     };
+ *   }, []);
+ *
+ *   return <Text>미디어 콘텐츠를 감상하는 화면</Text>;
+ * }
+ * ```
+ */
+export async function setScreenAwakeMode(options: { enabled: boolean }) {
+  return BedrockModule.setScreenAwakeMode(options);
+}