@apps-in-toss/native-modules 1.0.2 → 1.1.0

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

@@ -1,88 +0,0 @@
-import { AppsInTossModule } from './AppsInTossModule';
-import { requestPermission } from './requestPermission';
-import { ImageResponse } from '../../types';
-
-const DEFAULT_MAX_COUNT = 10;
-const DEFAULT_MAX_WIDTH = 1024;
-
-/**
- * 앨범 사진을 조회할 때 사용하는 옵션 타입이에요.
- */
-export interface FetchAlbumPhotosOptions {
-  /** 가져올 사진의 최대 개수를 설정해요. 숫자를 입력하고 기본값은 10이에요. */
-  maxCount?: number;
-  /** 사진의 최대 폭을 제한해요. 단위는 픽셀이고 기본값은 1024이에요. */
-  maxWidth?: number;
-  /** 이미지를 base64 형식으로 반환할지 설정해요. 기본값은 `false`예요. */
-  base64?: boolean;
-}
-
-/**
- * @public
- * @category 사진
- * @name fetchAlbumPhotos
- * @description
- * 사용자의 앨범에서 사진 목록을 불러오는 함수예요.
- * 최대 개수와 해상도를 설정할 수 있고 갤러리 미리보기, 이미지 선택 기능 등에 활용할 수 있어요.
- *
- * @param options - 조회 옵션을 담은 객체예요.
- * @param {number} [options.maxCount=10] 가져올 사진의 최대 개수를 설정해요. 숫자로 입력하며 기본값은 10이에요.
- * @param {number} [options.maxWidth=1024] 사진의 최대 폭을 제한해요. 단위는 픽셀이며 기본값은 `1024`이에요.
- * @param {boolean} [options.base64=false] 이미지를 base64 형식으로 반환할지 설정해요. 기본값은 `false`예요.
- * @returns {Promise<ImageResponse[]>}
- * 앨범 사진의 고유 ID와 데이터 URI를 포함한 배열을 반환해요.
- *
- * @example
- * ### 사진의 최대 폭을 360px로 제한하여 가져오기
- *
- * ```tsx
- * import React, { useState } from 'react';
- * import { View, Image, Button } from 'react-native';
- * import { fetchAlbumPhotos } from '@apps-in-toss/framework';
- *
- * const base64 = true;
- *
- * // 앨범 사진 목록을 가져와 화면에 표시하는 컴포넌트
- * function AlbumPhotoList() {
- *   const [albumPhotos, setAlbumPhotos] = useState([]);
- *
- *   const handlePress = async () => {
- *     try {
- *       const response = await fetchAlbumPhotos({
- *         base64,
- *         maxWidth: 360,
- *       });
- *       setAlbumPhotos((prev) => ([...prev, ...response]));
- *     } catch (error) {
- *       console.error('앨범을 가져오는 데 실패했어요:', error);
- *     }
- *   };
- *
- *   return (
- *     <View>
- *       {albumPhotos.map((image) => {
- *         // base64 형식으로 반환된 이미지를 표시하려면 데이터 URL 스키마 Prefix를 붙여야해요.
- *         const imageUri = base64 ? 'data:image/jpeg;base64,' + image.dataUri : image.dataUri;
- *
- *         return <Image source={{ uri: imageUri }} key={image.id} />;
- *       })}
- *       <Button title="앨범 가져오기" onPress={handlePress} />
- *     </View>
- *   );
- * }
- * ```
- */
-export async function fetchAlbumPhotos(options: FetchAlbumPhotosOptions): Promise<ImageResponse[]> {
-  const permissionStatus = await requestPermission({ name: 'photos', access: 'read' });
-  if (permissionStatus === 'denied') {
-    throw new Error('사진첩 권한이 거부되었어요.');
-  }
-
-  const albumPhotos = await AppsInTossModule.fetchAlbumPhotos({
-    ...options,
-    maxCount: options.maxCount ?? DEFAULT_MAX_COUNT,
-    maxWidth: options.maxWidth ?? DEFAULT_MAX_WIDTH,
-  });
-
-  return albumPhotos;
-}

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

@@ -1,47 +0,0 @@
-import { AppsInTossModule } from './AppsInTossModule';
-import { requestPermission } from './requestPermission';
-
-/**
- * @public
- * @category 클립보드
- * @name getClipboardText
- * @description 클립보드에 저장된 텍스트를 가져오는 함수예요. 복사된 텍스트를 읽어서 다른 작업에 활용할 수 있어요.
- * @returns {Promise<string>} - 클립보드에 저장된 텍스트를 반환해요. 클립보드에 텍스트가 없으면 빈 문자열을 반환해요.
- *
- * @example
- * ### 클립보드의 텍스트 가져오기
- *
- * ```tsx
- * import React, { useState } from 'react';
- * import { View, Text, Button } from 'react-native';
- * import { getClipboardText } from '@apps-in-toss/framework';
- *
- * // '붙여넣기' 버튼을 누르면 클립보드에 저장된 텍스트를 가져와 화면에 표시해요.
- * function PasteButton() {
- *   const [text, setText] = useState('');
- *
- *   const handlePress = async () => {
- *     try {
- *       const clipboardText = await getClipboardText();
- *       setText(clipboardText || '클립보드에 텍스트가 없어요.');
- *     } catch (error) {
- *       console.error('클립보드에서 텍스트를 가져오지 못했어요:', error);
- *     }
- *   };
- *
- *   return (
- *     <View>
- *       <Text>{text}</Text>
- *       <Button title="붙여넣기" onPress={handlePress} />
- *     </View>
- *   );
- * }
- * ```
- */
-export async function getClipboardText(): Promise<string> {
-  const permissionStatus = await requestPermission({ name: 'clipboard', access: 'read' });
-  if (permissionStatus === 'denied') {
-    throw new Error('클립보드 읽기 권한이 거부되었어요.');
-  }
-  return AppsInTossModule.getClipboardText({});
-}

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

@@ -1,65 +0,0 @@
-import { AppsInTossModule } from './AppsInTossModule';
-import { requestPermission } from './requestPermission';
-import type { Accuracy, Location } from '../../types';
-
-export interface GetCurrentLocationOptions {
-  /**
-   * 위치 정보를 가져올 정확도 수준이에요.
-   */
-  accuracy: Accuracy;
-}
-/**
- * @public
- * @category 위치 정보
- * @name getCurrentLocation
- * @description 디바이스의 현재 위치 정보를 가져오는 함수예요.
- * 위치 기반 서비스를 구현할 때 사용되고, 한 번만 호출되어 현재 위치를 즉시 반환해요.
- * 예를 들어 지도 앱에서 사용자의 현재 위치를 한 번만 가져올 때, 날씨 앱에서 사용자의 위치를 기반으로 기상 정보를 제공할 때, 매장 찾기 기능에서 사용자의 위치를 기준으로 가까운 매장을 검색할 때 사용하면 유용해요.
- *
- * @param {GetCurrentLocationOptions} options 위치 정보를 가져올 때 사용하는 옵션 객체예요.
- * @param {Accuracy} [options.accuracy] 위치 정보의 정확도 수준이에요. 정확도는 `Accuracy` 타입으로 설정돼요.
- * @returns {Promise<Location>} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/react-native/reference/native-modules/Types/Location.html)을 참고해주세요.
- *
- * @example
- * ### 디바이스의 현재 위치 정보 가져오기
- *
- * ```tsx
- * import React, { useState } from 'react';
- * import { View, Text, Button } from 'react-native';
- * import { getCurrentLocation } from '@apps-in-toss/framework';
- *
- * // 현재 위치 정보를 가져와 화면에 표시하는 컴포넌트
- * function CurrentPosition() {
- *   const [position, setPosition] = useState(null);
- *
- *   const handlePress = async () => {
- *     try {
- *       const response = await getCurrentLocation({ accuracy: Accuracy.Balanced });
- *       setPosition(response);
- *     } catch (error) {
- *       console.error('위치 정보를 가져오는 데 실패했어요:', error);
- *     }
- *   };
- *
- *   return (
- *     <View>
- *       {position ? (
- *         <Text>위치: {position.coords.latitude}, {position.coords.longitude}</Text>
- *       ) : (
- *         <Text>위치 정보를 아직 가져오지 않았어요</Text>
- *       )}
- *       <Button title="현재 위치 정보 가져오기" onPress={handlePress} />
- *     </View>
- *   );
- * }
- * ```
- */
-export async function getCurrentLocation(options: GetCurrentLocationOptions): Promise<Location> {
-  const permissionStatus = await requestPermission({ name: 'geolocation', access: 'access' });
-  if (permissionStatus === 'denied') {
-    throw new Error('위치 권한이 거부되었어요.');
-  }
-  const position = await AppsInTossModule.getCurrentLocation(options);
-
-  return position;
-}

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

@@ -1,81 +0,0 @@
-import { AppsInTossModule } from './AppsInTossModule';
-import { requestPermission } from './requestPermission';
-import type { ImageResponse } from '../../types';
-
-export interface OpenCameraOptions {
-  /**
-   * 이미지를 Base64 형식으로 반환할지 여부를 나타내는 불리언 값이에요.
-   *
-   * 기본값: `false`.
-   */
-  base64?: boolean;
-  /**
-   * 이미지의 최대 너비를 나타내는 숫자 값이에요.
-   *
-   * 기본값: `1024`.
-   */
-  maxWidth?: number;
-}
-
-/**
- * @public
- * @category 카메라
- * @name openCamera
- * @description 카메라를 실행해서 촬영된 이미지를 반환하는 함수예요.
- * @param {OpenCameraOptions} options - 카메라 실행 시 사용되는 옵션 객체예요.
- * @param {boolean} [options.base64=false] - 이미지를 Base64 형식으로 반환할지 여부를 나타내는 불리언 값이에요. 기본값은 `false`예요. `true`로 설정하면 `dataUri` 대신 Base64 인코딩된 문자열을 반환해요.
- * @param {number} [options.maxWidth=1024] - 이미지의 최대 너비를 나타내는 숫자 값이에요. 기본값은 `1024`예요.
- * @returns {Promise<ImageResponse>}
- * 촬영된 이미지 정보를 포함한 객체를 반환해요. 반환 객체의 구성은 다음과 같아요:
- * - `id`: 이미지의 고유 식별자예요.
- * - `dataUri`: 이미지 데이터를 표현하는 데이터 URI예요.
- *
- * @example
- * ### 카메라 실행 후 촬영된 사진 가져오기
- *
- * ```tsx
- * import React, { useState } from 'react';
- * import { View, Text, Button, Image } from 'react-native';
- * import { openCamera } from '@apps-in-toss/framework';
- *
- * const base64 = true;
- *
- * // 카메라를 실행하고 촬영된 이미지를 화면에 표시하는 컴포넌트
- * function Camera() {
- *   const [image, setImage] = useState(null);
- *
- *   const handlePress = async () => {
- *     try {
- *       const response = await openCamera({ base64 });
- *       setImage(response);
- *     } catch (error) {
- *       console.error('사진을 가져오는 데 실패했어요:', error);
- *     }
- *   };
- *
- *   // base64 형식으로 반환된 이미지를 표시하려면 데이터 URL 스키마 Prefix를 붙여야해요.
- *   const imageUri = base64 ? 'data:image/jpeg;base64,' + image.dataUri : image.dataUri;
- *
- *   return (
- *     <View>
- *       {image ? (
- *         <Image source={{ uri: imageUri }} style={{ width: 200, height: 200 }} />
- *       ) : (
- *         <Text>사진이 없어요</Text>
- *       )}
- *       <Button title="사진 촬영하기" onPress={handlePress} />
- *     </View>
- *   );
- * }
- * ```
- */
-export async function openCamera(options?: OpenCameraOptions): Promise<ImageResponse> {
-  const permissionStatus = await requestPermission({ name: 'camera', access: 'access' });
-  if (permissionStatus === 'denied') {
-    throw new Error('카메라 권한이 거부되었어요.');
-  }
-
-  const photo = await AppsInTossModule.openCamera({ base64: false, maxWidth: 1024, ...options });
-
-  return photo;
-}

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

@@ -1,39 +0,0 @@
-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 });
-}