@apps-in-toss/native-modules 0.0.0-dev.1752049503789 → 1.0.0

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

@@ -0,0 +1,54 @@
+import { AppsInTossModule } from './AppsInTossModule';
+import { PermissionAccess, PermissionName, PermissionStatus } from '../../types';
+
+/**
+ * @category AppsInTossModules
+ * @name openPermissionDialog
+ * @description 권한 요청 다이얼로그를 표시하는 함수예요. 사용자는 이 다이얼로그에서 특정 권한을 허용하거나 거부할 수 있어요.
+ * @param permission.name {PermissionName} 요청할 권한의 이름이에요. 예를 들어 `clipboard`는 클립보드 접근 권한을, `camera`는 카메라 접근 권한을 나타내요.
+ * @param permission.access {PermissionAccess} 요청할 권한의 접근 유형이에요. 예를 들어 `read`는 읽기 권한, `write`는 쓰기 권한을 의미해요.
+ * @returns {Promise<'allowed' | 'denied'>} 권한의 현재 상태를 반환해요. 반환값은 다음 중 하나예요:
+ * - `allowed`: 권한이 허용된 상태예요.
+ * - `denied`: 권한이 거부된 상태예요.
+ *
+ * @example
+ * ### 클립보드 읽기 권한 다이얼로그 열기
+ *
+ * ```tsx
+ * import React, { useState } from 'react';
+ * import { View, Text, Button } from 'react-native';
+ * import { openPermissionDialog, type PermissionStatus } from '@apps-in-toss/framework';
+ *
+ * function PermissionRequest() {
+ *   const [permission, setPermission] = useState<PermissionStatus | null>(null);
+ *
+ *   const handleRequestPermission = async () => {
+ *     try {
+ *       // 클립보드 읽기 권한을 요청하는 다이얼로그를 표시해요.
+ *       const status = await openPermissionDialog({
+ *         name: 'clipboard',
+ *         access: 'read',
+ *       });
+ *       setPermission(status); // 권한 상태를 업데이트해요.
+ *     } catch (error) {
+ *       console.error('권한 요청 중 오류가 발생했어요:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <View>
+ *       <Text>
+ *         클립보드 읽기 권한 상태: {permission ? permission : '아직 요청하지 않음'}
+ *       </Text>
+ *       <Button title="권한 요청하기" onPress={handleRequestPermission} />
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export function openPermissionDialog(permission: {
+  name: PermissionName;
+  access: PermissionAccess;
+}): Promise<Exclude<PermissionStatus, 'notDetermined'>> {
+  return AppsInTossModule.openPermissionDialog(permission);
+}

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

@@ -0,0 +1,63 @@
+import { getPermission } from './getPermission';
+import { openPermissionDialog } from './openPermissionDialog';
+import { PermissionAccess, PermissionName, PermissionStatus } from '../../types';
+
+/**
+ * @category PermissionManagement
+ * @name requestPermission
+ * @description 특정 권한을 요청하는 함수예요. 이미 허용되었거나 거부된 권한 상태를 확인한 뒤, 필요할 때 권한 요청 다이얼로그를 표시해요.
+ * @param permission.name {PermissionName} 요청할 권한의 이름이에요. 예를 들어 `clipboard`는 클립보드 접근 권한을, `camera`는 카메라 접근 권한을 나타내요.
+ * @param permission.access {PermissionAccess} 요청할 권한의 접근 유형이에요. 예를 들어 `read`는 읽기 권한, `write`는 쓰기 권한을 의미해요.
+ * @returns {Promise<'allowed' | 'denied'>} 사용자가 선택한 최종 권한 상태를 반환해요.
+ * 반환값은 다음 중 하나예요:
+ * - `allowed`: 권한이 허용된 경우
+ * - `denied`: 권한이 거부된 경우
+ *
+ * @example
+ * ### 클립보드 읽기 권한 요청하기
+ *
+ * ```tsx
+ * import React, { useState } from 'react';
+ * import { View, Text, Button } from 'react-native';
+ * import { requestPermission, type PermissionStatus } from '@apps-in-toss/framework';
+ *
+ * function PermissionRequest() {
+ *   const [permissionStatus, setPermissionStatus] = useState<PermissionStatus | null>(null);
+ *
+ *   const handleRequestPermission = async () => {
+ *     try {
+ *       // 클립보드 읽기 권한을 요청해요.
+ *       const permissionStatus = await requestPermission({
+ *         name: 'clipboard', // 권한 이름: 클립보드
+ *         access: 'read', // 접근 유형: 읽기
+ *       });
+ *       setPermissionStatus(permissionStatus); // 최종 권한 상태를 저장해요.
+ *     } catch (error) {
+ *       console.error('권한 요청 중 오류가 발생했어요:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <View>
+ *       <Text>
+ *         클립보드 읽기 권한 상태: {permissionStatus ? permissionStatus : '아직 요청하지 않음'}
+ *       </Text>
+ *       <Button title="권한 요청하기" onPress={handleRequestPermission} />
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export async function requestPermission(permission: {
+  name: PermissionName;
+  access: PermissionAccess;
+}): Promise<Exclude<PermissionStatus, 'notDetermined'>> {
+  const permissionStatus = await getPermission(permission);
+  switch (permissionStatus) {
+    case 'allowed':
+    case 'denied':
+      return permissionStatus;
+    default:
+      return openPermissionDialog(permission);
+  }
+}

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

@@ -0,0 +1,57 @@
+import { AppsInTossModule } from './AppsInTossModule';
+import { isMinVersionSupported } from './isMinVersionSupported';
+
+export interface SaveBase64DataParams {
+  data: string;
+  fileName: string;
+  mimeType: string;
+}
+
+/**
+ * @public
+ * @category 데이터
+ * @name saveBase64Data
+ * @description 문자열로 인코딩된 Base64 데이터를 지정한 파일 이름과 MIME 타입으로 사용자 기기에 저장해요. 이미지, 텍스트, PDF 등 다양한 형식의 데이터를 저장할 수 있어요.
+ * @param {SaveBase64DataParams} params - 저장할 데이터와 파일 정보를 담은 객체예요.
+ * @param {string} params.data - Base64 형식으로 인코딩된 데이터 문자열이에요.
+ * @param {string} params.fileName - 저장할 파일 이름이에요. 확장자도 같이 붙여줘야해요. 예를 들어, 'example.png'로 저장할 수 있어요. 
+ * @param {string} params.mimeType - 저장할 파일의 MIME 타입이에요. 예를 들어 'image/png' 로 지정하면 이미지, 'application/pdf'는 PDF 파일이에요. 자세한 내용은 [MIME 문서](https://developer.mozilla.org/ko/docs/Web/HTTP/Guides/MIME_types)를 참고해주세요.
+ *
+ * @example
+ * ### Base64 이미지 데이터를 사용자 기기에 저장하기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { saveBase64Data } from '@apps-in-toss/framework';
+ *
+ * // '저장' 버튼을 누르면 이미지가 사용자 기기에 저장돼요.
+ * function SaveButton() {
+ *   const handleSave = async () => {
+ *     try {
+ *       await saveBase64Data({
+ *         data: 'iVBORw0KGgo...',
+ *         fileName: 'some-photo.png',
+ *         mimeType: 'image/png',
+ *       });
+ *     } catch (error) {
+ *       console.error('데이터 저장에 실패했어요:', error);
+ *     }
+ *   };
+ *
+ *   return <Button title="저장" onPress={handleSave} />;
+ * }
+ * ```
+ */
+export async function saveBase64Data(params: SaveBase64DataParams) {
+  const isSupported = isMinVersionSupported({
+    android: '5.218.0',
+    ios: '5.216.0',
+  });
+
+  if (!isSupported) {
+    console.warn('saveBase64Data is not supported in this app version');
+    return;
+  }
+
+  await AppsInTossModule.saveBase64Data(params);
+}

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

@@ -0,0 +1,39 @@
+import { AppsInTossModule } from './AppsInTossModule';
+import { requestPermission } from './requestPermission';
+
+/**
+ * @public
+ * @category 클립보드
+ * @name setClipboardText
+ * @description 텍스트를 클립보드에 복사해서 사용자가 다른 곳에 붙여 넣기 할 수 있어요.
+ * @param {Promise<void>} text - 클립보드에 복사할 텍스트예요. 문자열 형식으로 입력해요.
+ *
+ * @example
+ * ### 텍스트를 클립보드에 복사하기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { setClipboardText } from '@apps-in-toss/framework';
+ *
+ * // '복사' 버튼을 누르면 "복사할 텍스트"가 클립보드에 복사돼요.
+ * function CopyButton() {
+ *   const handleCopy = async () => {
+ *     try {
+ *       await setClipboardText('복사할 텍스트');
+ *       console.log('텍스트가 복사됐어요!');
+ *     } catch (error) {
+ *       console.error('텍스트 복사에 실패했어요:', error);
+ *     }
+ *   };
+ *
+ *   return <Button title="복사" onPress={handleCopy} />;
+ * }
+ * ```
+ */
+export async function setClipboardText(text: string): Promise<void> {
+  const permissionStatus = await requestPermission({ name: 'clipboard', access: 'write' });
+  if (permissionStatus === 'denied') {
+    throw new Error('클립보드 쓰기 권한이 거부되었어요.');
+  }
+  return AppsInTossModule.setClipboardText({ text });
+}

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

@@ -0,0 +1,74 @@
+import { AppsInTossModule } from './AppsInTossModule';
+import { isMinVersionSupported } from './isMinVersionSupported';
+
+/**
+ * @public
+ * @category 화면 제어
+ * @kind function
+ * @name setDeviceOrientation
+ * @description
+ * `setDeviceOrientation` 함수는 기기의 화면 방향을 설정하는 기능을 제공해요.
+ * 이 기능은 특정 화면에서 가로 모드나 세로 모드를 강제로 지정해야 할 때 유용해요.
+ *
+ * `type` 옵션을 통해 원하는 화면 방향을 지정할 수 있어요. 특히, 이 함수는 앱 전체에 영향을 미치므로
+ * 특정 화면에서만 사용하려면 화면을 벗어날 때 이전 상태로 복구하는 추가 작업이 필요해요.
+ *
+ * 예를 들어, 동영상 감상 화면에서는 가로 모드를 강제하고, 화면을 떠날 때 설정을 복구해서
+ * 다른 화면들의 방향 설정에 영향을 주지 않도록 할 수 있어요.
+ *
+ * @param {object} options 화면 방향 설정 값이에요.
+ * @param {string} options.type 화면 방향을 지정하는 옵션이에요.
+ * 'portrait' | 'landscape' 중 하나를 선택할 수 있어요.
+ *
+ * @returns {Promise<void>} 화면 방향 설정이 완료되면 해결되는 Promise를 반환해요.
+ *
+ * @example
+ * ### 화면 방향 설정하기
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { setDeviceOrientation } from '@apps-in-toss/framework';
+ *
+ * function SetDeviceOrientation() {
+ *   return (
+ *     <Button
+ *       title="가로 모드로 변경"
+ *       onPress={() => {
+ *         setDeviceOrientation({ type: 'landscape' });
+ *       }}
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * ### 화면 방향 복구하기
+ * 특정 화면을 벗어날 때 이전 상태로 복구하려면 다음과 같이 `useEffect`를 사용하세요.
+ *
+ * ```tsx
+ * import { useEffect } from 'react';
+ * import { setDeviceOrientation } from '@apps-in-toss/framework';
+ *
+ * function VideoScreen() {
+ *   useEffect(() => {
+ *     setDeviceOrientation({ type: 'landscape' });
+ *
+ *     return () => {
+ *       setDeviceOrientation({ type: 'portrait' }); // 설정을 이전 상태로 복구해요.
+ *     };
+ *   }, []);
+ *
+ *   return <Text>동영상을 감상하는 화면</Text>;
+ * }
+ * ```
+ */
+export async function setDeviceOrientation(options: { type: 'portrait' | 'landscape' }): Promise<void> {
+  const isSupported = isMinVersionSupported({
+    android: '5.215.0',
+    ios: '5.215.0',
+  });
+  if (!isSupported) {
+    return;
+  }
+
+  return AppsInTossModule.setDeviceOrientation(options);
+}

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, '-');
+}