@apps-in-toss/web-framework 0.0.0-dev.1744801739343 → 0.0.0-dev.1752049503789

package/dist-web/getDeviceId.d.ts

@@ -1,31 +0,0 @@
-/**
- * @public
- * @category 환경 확인
- * @kind function
- * @name getDeviceId
- * @description
- * 사용 중인 기기의 고유 식별자를 문자열로 반환해요.
- *
- * 이 함수는 현재 사용 중인 기기의 고유 식별자를 문자열로 반환해요. 기기별로 설정이나 데이터를 저장하거나 사용자의 기기를 식별해서 로그를 기록하고 분석하는 데 사용할 수 있어요. 같은 사용자의 여러 기기를 구분하는 데도 유용해요.
- *
- * @returns {string} 기기의 고유 식별자를 나타내는 문자열이에요.
- *
- * @example
- * ### 기기 고유 식별자 가져오기
- *
- * ```tsx
- * import { getDeviceId } from '@apps-in-toss/web-framework';
- * 
- *
- * function MyPage() {
- *   const id = getDeviceId();
- *
- *   return (
- *     <span>사용자의 기기 고유 식별자: {id}</span>
- *   );
- * }
- * ```
- */
-export declare function getDeviceId(): string;
-
-export {};

package/dist-web/getLocale.d.ts

@@ -1,30 +0,0 @@
-/**
- * @public
- * @category 언어
- * @kind function
- * @name getLocale
- * @description
- * 사용자의 로케일(locale) 정보를 반환해요. 네이티브 모듈에서 로케일 정보를 가져올 수 없을 때는 기본값으로 'ko-KR'을 반환합니다. 앱의 현지화 및 언어 설정과 관련된 기능을 구현할 때 사용하세요.
- *
- * @returns {string} 사용자의 로케일 정보를 반환해요.
- *
- * @example
- * ### 현재 사용자의 로케일 정보 가져오기
- *
- * ```tsx
- * import { getLocale } from '@apps-in-toss/web-framework';
- * 
- *
- * function MyPage() {
- *  const locale = getLocale();
- *
- *  return (
- *    <span>사용자의 로케일 정보: {locale}</span>
- *  )
- * }
- *
- * ```
- */
-export declare function getLocale(): string;
-
-export {};

package/dist-web/getNetworkStatus.d.ts

@@ -1,54 +0,0 @@
-export type NetworkStatus = "OFFLINE" | "WIFI" | "2G" | "3G" | "4G" | "5G" | "WWAN" | "UNKNOWN";
-/**
- * @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 { getNetworkStatus, NetworkStatus } from '@apps-in-toss/web-framework';
- *
- * function GetNetworkStatus() {
- *   const [status, setStatus] = useState<NetworkStatus | ''>('');
- *
- *   useEffect(() => {
- *     async function fetchStatus() {
- *       const networkStatus = await getNetworkStatus();
- *       setStatus(networkStatus);
- *     }
- *
- *     fetchStatus();
- *   }, []);
- *
- *   return (
- *     <div>
- *       <span>현재 네트워크 상태: {status}</span>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function getNetworkStatus(): Promise<NetworkStatus>;
-
-export {};

package/dist-web/getOperationalEnvironment.d.ts

@@ -1,35 +0,0 @@
-/**
- * @public
- * @category 환경 확인
- * @kind function
- * @name getOperationalEnvironment
- * @description
- * 현재 실행 중인 앱의 운영 환경을 확인해요.
- * 토스 앱에서 실행 중이라면 `'toss'`, 샌드박스 환경에서 실행 중이라면 `'sandbox'`를 반환해요.
- *
- * 운영 환경은 앱이 실행되는 컨텍스트를 의미하며, 특정 기능의 사용 가능 여부를 판단하는 데 활용할 수 있어요.
- *
- * @returns {'toss' | 'sandbox'}
- * 현재 운영 환경을 나타내는 문자열이에요.
- * - `'toss'`: 토스 앱에서 실행 중이에요.
- * - `'sandbox'`: 샌드박스 환경에서 실행 중이에요.
- *
- * @example
- * ### 현재 운영 환경 확인하기
- *
- * ```tsx
- * import { getOperationalEnvironment } from '@apps-in-toss/web-framework';
- * 
- *
- * function EnvironmentInfo() {
- *   const environment = getOperationalEnvironment();
- *
- *   return (
- *     <span>현재 운영 환경: {environment}</span>
- *   );
- * }
- * ```
- */
-export declare function getOperationalEnvironment(): "toss" | "sandbox";
-
-export {};

package/dist-web/getPlatformOS.d.ts

@@ -1,35 +0,0 @@
-/**
- * @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/web-framework';
- * import { Text } 'react-native';
- *
- * function Page() {
- *   const platform = getPlatformOS();
- *
- *   return <span>현재 플랫폼: {platform}</span>;
- * }
- * ```
- */
-export declare function getPlatformOS(): "ios" | "android";
-
-export {};

package/dist-web/getSchemeUri.d.ts

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

package/dist-web/getTossAppVersion.d.ts

@@ -1,31 +0,0 @@
-/**
- * @public
- * @category 환경 확인
- * @name getTossAppVersion
- * @description 토스 앱 버전을 가져옵니다. 예를 들어, `5.206.0`과 같은 형태로 반환돼요. 토스 앱 버전을 로그로 남기거나, 특정 기능이 특정 버전 이상에서만 실행될 때 사용돼요.
- * @signature
- * ```typescript
- * function getTossAppVersion(): string
- * ```
- *
- * @returns {string} 토스 앱 버전
- *
- * @example
- *
- *
- * ### 토스 앱 버전 확인하기
- *
- * ```tsx
- * import { getTossAppVersion } from '@apps-in-toss/web-framework';
- * 
- *
- * export function TossAppVersionPage() {
- *  return (
- *   <span>{getTossAppVersion()}</span>
- *  )
- * }
- * ```
- */
-export declare function getTossAppVersion(): string;
-
-export {};

package/dist-web/openCamera.d.ts

@@ -1,78 +0,0 @@
-/**
- * 사진 조회 결과를 나타내는 타입이에요.
- */
-export interface ImageResponse {
-	/** 가져온 사진의 고유 ID예요. */
-	id: string;
-	/** 사진의 데이터 URI예요. `base64` 옵션이 `true`인 경우 Base64 문자열로 반환돼요. */
-	dataUri: string;
-}
-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 { openCamera } from '@apps-in-toss/web-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 (
- *     <div>
- *       {image ? (
- *         <Image source={{ uri: imageUri }} style={{ width: 200, height: 200 }} />
- *       ) : (
- *         <span>사진이 없어요</span>
- *       )}
- *       <input type="button" value="사진 촬영하기" onClick={handlePress} />
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function openCamera(options?: OpenCameraOptions): Promise<ImageResponse>;
-
-export {};

package/dist-web/openURL.d.ts

@@ -1,38 +0,0 @@
-/**
- * @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/web-framework';
- * 
- *
- * function Page() {
- *   const handlePress = () => {
- *     openURL('https://google.com');
- *   };
- *
- *   return <input type="button" value="구글 웹사이트 열기" onClick={handlePress} />;
- * }
- * ```
- */
-export declare function openURL(url: string): Promise<any>;
-
-export {};

package/dist-web/setClipboardText.d.ts

@@ -1,32 +0,0 @@
-/**
- * @public
- * @category 클립보드
- * @name setClipboardText
- * @description 텍스트를 클립보드에 복사해서 사용자가 다른 곳에 붙여 넣기 할 수 있어요.
- * @param {Promise<void>} text - 클립보드에 복사할 텍스트예요. 문자열 형식으로 입력해요.
- *
- * @example
- * ### 텍스트를 클립보드에 복사하기
- *
- * ```tsx
- * 
- * import { setClipboardText } from '@apps-in-toss/web-framework';
- *
- * // '복사' 버튼을 누르면 "복사할 텍스트"가 클립보드에 복사돼요.
- * function CopyButton() {
- *   const handleCopy = async () => {
- *     try {
- *       await setClipboardText('복사할 텍스트');
- *       console.log('텍스트가 복사됐어요!');
- *     } catch (error) {
- *       console.error('텍스트 복사에 실패했어요:', error);
- *     }
- *   };
- *
- *   return <input type="button" value="복사" onClick={handleCopy} />;
- * }
- * ```
- */
-export declare function setClipboardText(text: string): Promise<void>;
-
-export {};

package/dist-web/setIosSwipeGestureEnabled.d.ts

@@ -1,39 +0,0 @@
-/**
- * @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/web-framework';
- * 
- *
- * function Page() {
- *  return (
- *    <>
- *     <input type="button" value="스와이프 끄기" onClick={() => setIosSwipeGestureEnabled({ isEnabled: false })} />
- *     <input type="button" value="스와이프 켜기" onClick={() => setIosSwipeGestureEnabled({ isEnabled: true })} />
- *    </>
- *  );
- * }
- * ```
- *
- */
-export declare function setIosSwipeGestureEnabled(options: {
-	isEnabled: boolean;
-}): Promise<void>;
-
-export {};

package/dist-web/setScreenAwakeMode.d.ts

@@ -1,68 +0,0 @@
-/**
- * @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 { setScreenAwakeMode } from '@apps-in-toss/web-framework';
- *
- * function SetScreenAwakeMode() {
- *   return (
- *     <input type="button"
- *       value="화면 항상 켜기"
- *       onClick={() => {
- *         setScreenAwakeMode({ enabled: true });
- *       }}
- *     />
- *   );
- * }
- * ```
- *
- * ### 화면 항상 켜짐 모드 복구하기
- * 특정 화면을 벗어날 때 이전 상태로 복구하려면 다음과 같이 `useEffect`를 사용하세요.
- *
- * ```tsx
- * import { useEffect } from 'react';
- * import { setScreenAwakeMode, cleanUp } from '@apps-in-toss/web-framework';
- *
- * function MediaScreen() {
- *   useEffect(() => {
- *     setScreenAwakeMode({ enabled: true });
- *
- *     return () => {
- *       setScreenAwakeMode({ enabled: false }); // 설정을 이전 상태로 복구해요.
- *     };
- *   }, []);
- *
- *   return <span>미디어 콘텐츠를 감상하는 화면</span>;
- * }
- * ```
- */
-export declare function setScreenAwakeMode(options: {
-	enabled: boolean;
-}): Promise<{
-	enabled: boolean;
-}>;
-
-export {};

package/dist-web/setSecureScreen.d.ts

@@ -1,33 +0,0 @@
-/**
- * @public
- * @name setSecureScreen
- * @category 화면 제어
- * @kind function
- * @description
- * 화면 캡쳐를 차단해서 민감한 정보가 유출되지 않도록 보호하거나, 필요할 경우 캡쳐를 허용하도록 설정해요. 예를 들어 보안이 중요한 화면에서 사용할 수 있어요.
- *
- * @param {object} options 화면 캡쳐 설정 옵션이에요.
- * @param {boolean} options.enabled 화면 캡쳐를 차단할지 여부를 설정해요. `true`면 캡쳐를 차단하고, `false`면 허용해요.
- * @returns {enabled: boolean} 현재 설정된 캡쳐 차단 상태를 반환해요.
- *
- * @example
- * ### 캡쳐 허용 상태 변경하기
- *
- * ```tsx
- * 
- * import { setSecureScreen } from '@apps-in-toss/web-framework';
- *
- * function SetSecureScreen() {
- *  return <input type="button" value="캡쳐 막기" onClick={async () => {
- *    await setSecureScreen({ enabled: true });
- *  }} />;
- * }
- * ```
- */
-export declare function setSecureScreen(options: {
-	enabled: boolean;
-}): Promise<{
-	enabled: boolean;
-}>;
-
-export {};

package/dist-web/share.d.ts

@@ -1,36 +0,0 @@
-/**
- * @public
- * @category 공유
- * @kind function
- * @name share
- * @description
- * 사용자가 콘텐츠를 다른 사람과 공유할 수 있도록 네이티브 공유 시트를 표시해요.
- * `options.message` 속성에 공유할 메시지를 전달하면, 사용자가 선택할 수 있는 앱 목록이 표시돼요.
- * 예를 들어, 사용자가 텍스트 메시지를 공유하거나 메모 앱에 저장하려고 할 때 유용해요.
- * @param {object} options - 공유할 메시지를 담은 객체예요.
- * @param {string} options.message - 공유할 텍스트 문자열이에요. 예를 들어, "안녕하세요! 이 내용을 공유합니다."
- *
- * @example
- * ### 공유하기 기능 구현하기
- *
- * 아래는 버튼을 클릭하면 메시지를 공유하는 간단한 예제예요.
- *
- * ```tsx
- * import { share } from '@apps-in-toss/web-framework';
- * 
- *
- * function MyPage() {
- *   return (
- *     <input type="button"
- *       value="공유"
- *       onClick={() => share({ message: '공유할 메시지입니다.' })}
- *     />
- *   );
- * }
- * ```
- */
-export declare function share(message: {
-	message: string;
-}): Promise<void>;
-
-export {};