@apps-in-toss/web-bridge 0.0.24

package/build/getLocale.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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/build/getNetworkStatus.d.ts

@@ -0,0 +1,54 @@
+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/build/getOperationalEnvironment.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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/build/getPlatformOS.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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/build/getSchemeUri.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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/build/getTossAppVersion.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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/build/getTossShareLink.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @public
+ * @category 공유
+ * @kind function
+ * @name getTossShareLink
+ * @description
+ * `getTossShareLink` 함수는 사용자가 지정한 경로를 토스 앱에서 열 수 있는 공유 링크를 반환해요.
+ * 이 링크를 다른 사람과 공유하면 토스 앱이 실행되면서 지정한 경로로 진입해요. 토스앱이 없는 사람은 iOS 일 때는 앱스토어로 이동하고, Android 일 때는 플레이스토어로 이동해요.
+ *
+ * 경로는 토스 앱 내부 특정 화면을 나타내는 딥링크(deep link) 형식이어야 해요.
+ * 예를 들어 `intoss://<앱 이름>`이나 `intoss://<앱 이름>/about?name=test`처럼 작성해요.
+ *
+ * 이 함수를 사용하면 `deep_link_value`를 포함한 완성된 공유 링크를 만들 수 있어요.
+ *
+ * @param path - 딥링크로 열고 싶은 경로예요. `intoss://`로 시작하는 문자열이어야 해요.
+ * @returns {Promise<string>} `deep_link_value`가 포함된 토스 공유 링크를 반환해요.
+ *
+ * @example
+ * ```tsx
+ * import { share } from '@apps-in-toss/web-framework';
+ * import { getTossShareLink } from '@apps-in-toss/web-framework';
+ *
+ * // '/' 경로를 딥링크로 포함한 토스 공유 링크를 생성해요.
+ * const tossLink = await getTossShareLink('intoss://my-app');
+ *
+ * // 생성한 링크를 메시지로 공유해요.
+ * await share({ message: tossLink });
+ * ```
+ */
+export declare function getTossShareLink(path: string): Promise<string>;
+
+export {};