@apps-in-toss/web-bridge 0.0.24

package/README.md

@@ -0,0 +1,3 @@
+# @apps-in-toss/web-bridge
+
+Analytics for Apps In Toss

package/build/appLogin.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @public
+ * @category 로그인
+ * @name appLogin
+ * @description 토스 인증으로 로그인해요. 로그인이 완료되면 다시 토스 앱으로 이동해요.
+ * @example
+ *
+ * ### 토스 인증을 통해 로그인을 하는 예제
+ *
+ * ```tsx
+ * 
+ * import { appLogin } from '@apps-in-toss/web-framework';
+ *
+ * function Page() {
+ *   const handleLogin = async () => {
+ *     const { authorizationCode, referrer } = await appLogin();
+ *
+ *     // 획득한 인가 코드(`authorizationCode`)와 `referrer`를 서버로 전달해요.
+ *   }
+ *
+ *   return <input type="button" value="로그인" onClick={handleLogin} />;
+ * }
+ * ```
+ */
+export declare function appLogin(): Promise<{
+	authorizationCode: string;
+	referrer: "DEFAULT" | "SANDBOX";
+}>;
+
+export {};

package/build/bridge.d.ts

@@ -0,0 +1,25 @@
+export * from './closeView';
+export * from './generateHapticFeedback';
+export * from './share';
+export * from './setSecureScreen';
+export * from './setScreenAwakeMode';
+export * from './getNetworkStatus';
+export * from './setIosSwipeGestureEnabled';
+export * from './openURL';
+export * from './getLocale';
+export * from './getSchemeUri';
+export * from './getPlatformOS';
+export * from './setClipboardText';
+export * from './getClipboardText';
+export * from './fetchContacts';
+export * from './fetchAlbumPhotos';
+export * from './getCurrentLocation';
+export * from './openCamera';
+export * from './appLogin';
+export * from './checkoutPayment';
+export * from './eventLog';
+export * from './getTossShareLink';
+export * from './getOperationalEnvironment';
+export * from './getTossAppVersion';
+export * from './getDeviceId';
+export * from './startUpdateLocation';

package/build/bridge.js

@@ -0,0 +1 @@
+import{createAsyncBridge,createConstantBridge,createEventBridge}from"@apps-in-toss/bridge-core";var createEvents=function(){return{emit:function emit(event,args){for(var callbacks=this.events[event]||[],i=0,length=callbacks.length;i<length;i++){callbacks[i](args)}},events:{},on:function on(event,cb){var _this=this;var _this_events,_event;((_this_events=this.events)[_event=event]||(_this_events[_event]=[])).push(cb);return function(){var _this_events_event;_this.events[event]=(_this_events_event=_this.events[event])===null||_this_events_event===void 0?void 0:_this_events_event.filter(function(i){return cb!==i})}}}};if(typeof window!=="undefined"){window.__BEDROCK_NATIVE_EMITTER=createEvents()}export var closeView=createAsyncBridge("closeView");export var generateHapticFeedback=createAsyncBridge("generateHapticFeedback");export var share=createAsyncBridge("share");export var setSecureScreen=createAsyncBridge("setSecureScreen");export var setScreenAwakeMode=createAsyncBridge("setScreenAwakeMode");export var getNetworkStatus=createAsyncBridge("getNetworkStatus");export var setIosSwipeGestureEnabled=createAsyncBridge("setIosSwipeGestureEnabled");export var openURL=createAsyncBridge("openURL");export var getLocale=createConstantBridge("getLocale");export var getSchemeUri=createConstantBridge("getSchemeUri");export var getPlatformOS=createConstantBridge("getPlatformOS");export var setClipboardText=createAsyncBridge("setClipboardText");export var getClipboardText=createAsyncBridge("getClipboardText");export var fetchContacts=createAsyncBridge("fetchContacts");export var fetchAlbumPhotos=createAsyncBridge("fetchAlbumPhotos");export var Accuracy=function(Accuracy){Accuracy[Accuracy["Lowest"]=1]="Lowest";Accuracy[Accuracy["Low"]=2]="Low";Accuracy[Accuracy["Balanced"]=3]="Balanced";Accuracy[Accuracy["High"]=4]="High";Accuracy[Accuracy["Highest"]=5]="Highest";Accuracy[Accuracy["BestForNavigation"]=6]="BestForNavigation";return Accuracy}({});export var getCurrentLocation=createAsyncBridge("getCurrentLocation");export var openCamera=createAsyncBridge("openCamera");export var appLogin=createAsyncBridge("appLogin");export var checkoutPayment=createAsyncBridge("checkoutPayment");export var eventLog=createAsyncBridge("eventLog");export var getTossShareLink=createAsyncBridge("getTossShareLink");export var getOperationalEnvironment=createConstantBridge("getOperationalEnvironment");export var getTossAppVersion=createConstantBridge("getTossAppVersion");export var getDeviceId=createConstantBridge("getDeviceId");export var startUpdateLocation=createEventBridge("startUpdateLocation");

package/build/checkoutPayment.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @public
+ * @category 토스페이
+ * @name CheckoutPaymentOptions
+ * @description 토스페이 결제창을 띄울 때 필요한 옵션이에요.
+ * @property {string} payToken 결제 토큰이에요.
+ */
+export interface CheckoutPaymentOptions {
+	/**
+	 * 결제 토큰이에요.
+	 */
+	payToken: string;
+}
+/**
+ * @public
+ * @category 토스페이
+ * @name CheckoutPaymentResult
+ * @description 토스페이 결제창에서 사용자가 인증에 성공했는지 여부예요.
+ * @property {boolean} success 인증이 성공했는지 여부예요.
+ * @property {string} [reason] 인증이 실패했을 경우의 이유예요.
+ */
+export interface CheckoutPaymentResult {
+	/**
+	 * 인증이 성공했는지 여부예요.
+	 */
+	success: boolean;
+	/**
+	 * 인증이 실패했을 경우의 이유예요.
+	 */
+	reason?: string;
+}
+/**
+ * @public
+ * @category 토스페이
+ * @name checkoutPayment
+ * @description 토스페이 결제창을 띄우고, 사용자 인증을 수행해요. 인증이 완료되면 성공 여부를 반환해요.
+ *
+ * 이 함수는 결제창을 통해 사용자 인증만 해요. 실제 결제 처리는 인증 성공 후 서버에서 별도로 해야 해요.
+ *
+ * @param {CheckoutPaymentOptions} options 결제창을 띄울 때 필요한 옵션이에요.
+ * @returns {Promise<CheckoutPaymentResult>} 인증 성공 여부를 포함한 결과를 반환해요.
+ *
+ * @example
+ *
+ * ### 토스페이 결제창 띄우고 인증 처리하기
+ *
+ * ```tsx
+ * import { TossPay } from '@apps-in-toss/web-framework';
+ *
+ * async function handlePayment() {
+ *   try {
+ *     // 실제 구현 시 결제 생성 역할을 하는 API 엔드포인트로 대체해주세요.
+ *     const { payToken } = await fetch('/my-api/payment/create').then(res => res.json());
+ *
+ *     const { success, reason } = await TossPay.checkoutPayment({ payToken });
+ *
+ *     if (success) {
+ *       // 실제 구현 시 결제를 실행하는 API 엔드포인트로 대체해주세요.
+ *       await fetch('/my-api/payment/execute', {
+ *         method: 'POST',
+ *         body: JSON.stringify({ payToken }),
+ *         headers: { 'Content-Type': 'application/json' },
+ *       });
+ *     } else {
+ *       console.log('인증 실패:', reason);
+ *     }
+ *   } catch (error) {
+ *     console.error('결제 인증 중 오류가 발생했어요:', error);
+ *   }
+ * }
+ * ```
+ */
+export declare function checkoutPayment(options: CheckoutPaymentOptions): Promise<CheckoutPaymentResult>;
+
+export {};

package/build/closeView.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @public
+ * @category 화면 제어
+ * @kind function
+ * @name closeView
+ * @description 현재 화면을 닫는 함수에요. 예를 들어, "닫기" 버튼을 눌러서 서비스를 종료할 때 사용할 수 있어요.
+ * @returns {Promise<void>}
+ *
+ * @example
+ * ### 닫기 버튼을 눌러 화면 닫기
+ *
+ * ```tsx
+ * 
+ * import { closeView } from '@apps-in-toss/web-framework';
+ *
+ * function CloseButton() {
+ *  return <input type="button" value="닫기" onClick={closeView} />;
+ * }
+ * ```
+ */
+export declare function closeView(): Promise<void>;
+
+export {};

package/build/eventLog.d.ts

@@ -0,0 +1,44 @@
+export type Primitive = string | number | boolean | null | undefined | symbol;
+export interface EventLogParams {
+	log_name: string;
+	log_type: "debug" | "info" | "warn" | "error" | "screen" | "impression" | "click";
+	params: Record<string, Primitive>;
+}
+/**
+ * @category 로깅
+ * @kind function
+ * @name eventLog
+ * @description
+ * 이벤트 로그를 기록하는 함수예요.
+ *
+ * 이 함수는 앱 내에서 발생하는 다양한 이벤트를 로깅하는 데 사용돼요. 디버깅, 정보 제공, 경고, 오류 등 다양한 유형의 로그를 기록할 수 있어요. 샌드박스 환경에서는 콘솔에 로그가 출력되고, 실제 환경에서는 로그 시스템에 기록돼요.
+ *
+ * @param {Object} params 로그 기록에 필요한 매개변수 객체예요.
+ * @param {string} params.log_name 로그의 이름이에요.
+ * @param {'debug' | 'info' | 'warn' | 'error' | 'screen' | 'impression' | 'click'} params.log_type 로그의 유형이에요.
+ * @param {Record<string, Primitive>} params.params 로그에 포함할 추가 매개변수 객체예요.
+ *
+ * @returns {Promise<void>} 로그 기록이 완료되면 해결되는 Promise예요.
+ *
+ * @example
+ * ### 이벤트 로그 기록하기
+ *
+ * ```tsx
+ * import { eventLog } from '@apps-in-toss/web-framework';
+ *
+ * function logUserAction() {
+ *   eventLog({
+ *     log_name: 'user_action',
+ *     log_type: 'info',
+ *     params: {
+ *       action: 'button_click',
+ *       screen: 'main',
+ *       userId: 12345
+ *     }
+ *   });
+ * }
+ * ```
+ */
+export declare function eventLog(params: EventLogParams): Promise<void>;
+
+export {};

package/build/fetchAlbumPhotos.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 사진 조회 결과를 나타내는 타입이에요.
+ */
+export interface ImageResponse {
+	/** 가져온 사진의 고유 ID예요. */
+	id: string;
+	/** 사진의 데이터 URI예요. `base64` 옵션이 `true`인 경우 Base64 문자열로 반환돼요. */
+	dataUri: string;
+}
+/**
+ * 앨범 사진을 조회할 때 사용하는 옵션 타입이에요.
+ */
+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 { fetchAlbumPhotos } from '@apps-in-toss/web-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 (
+ *     <div>
+ *       {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} />;
+ *       })}
+ *       <input type="button" value="앨범 가져오기" onClick={handlePress} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function fetchAlbumPhotos(options: FetchAlbumPhotosOptions): Promise<ImageResponse[]>;
+
+export {};

package/build/fetchContacts.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 연락처 정보를 나타내는 타입이에요.
+ */
+export interface ContactEntity {
+	/** 연락처 이름이에요. */
+	name: string;
+	/** 연락처 전화번호로, 문자열 형식이에요. */
+	phoneNumber: string;
+}
+/**
+ * @public
+ * @category 연락처
+ * @name fetchContacts
+ * @description 사용자의 연락처 목록을 페이지 단위로 가져오는 함수예요.
+ * @param size - 한 번에 가져올 연락처 개수예요. 예를 들어, 10을 전달하면 최대 10개의 연락처를 가져와요.
+ * @param offset - 가져올 연락처의 시작 지점이에요. 처음 호출할 때는 `0`을 전달해야 해요. 이후에는 이전 호출에서 반환된 `nextOffset` 값을 사용해요.
+ * @param query - 추가적인 필터링 옵션이에요.
+ * @param query.contains - 이름에 특정 문자열이 포함된 연락처만 가져오고 싶을 때 사용해요. 이 값을 전달하지 않으면 모든 연락처를 가져와요.
+ * @returns {Promise<{result: { name: string; phoneNumber: string }[]; nextOffset: number | null; done: boolean}>}
+ * 연락처 목록과 페이지네이션 정보를 포함한 객체를 반환해요.
+ * - `result`: 가져온 연락처 목록이에요.
+ * - `nextOffset`: 다음 호출에 사용할 오프셋 값이에요. 더 가져올 연락처가 없으면 `null`이에요.
+ * - `done`: 모든 연락처를 다 가져왔는지 여부를 나타내요. 모두 가져왔다면 `true`예요.
+ *
+ * @signature
+ * ```typescript
+ * function fetchContacts({ size, offset, query }: {
+ *  size: number;
+ *  offset: number;
+ *  query?: {
+ *    contains?: string;
+ *  };
+ * }): Promise<{
+ *  result: ContactEntity[];
+ *  nextOffset: number | null;
+ *  done: boolean;
+ *  }>;
+ * ```
+ *
+ * @example
+ * ### 특정 문자열이 포함된 연락처 목록 가져오기
+ *
+ * ```tsx
+ * import React, { useState } from 'react';
+ * 
+ * import { fetchContacts, ContactEntity } from '@apps-in-toss/web-framework';
+ *
+ * // 특정 문자열을 포함한 연락처 목록을 가져와 화면에 표시하는 컴포넌트
+ * function ContactsList() {
+ *   const [contacts, setContacts] = useState<{
+ *     result: ContactEntity[];
+ *     nextOffset: number | null;
+ *     done: boolean;
+ *   }>({
+ *     result: [],
+ *     nextOffset: null,
+ *     done: false,
+ *   });
+ *
+ *   const handlePress = async () => {
+ *     try {
+ *       if (contacts.done) {
+ *         console.log('모든 연락처를 가져왔어요.');
+ *         return;
+ *       }
+ *
+ *       const response = await fetchContacts({
+ *         size: 10,
+ *         offset: contacts.nextOffset ?? 0,
+ *         query: { contains: '김' },
+ *       });
+ *       setContacts((prev) => ({
+ *         result: [...prev.result, ...response.result],
+ *         nextOffset: response.nextOffset,
+ *         done: response.done,
+ *       }));
+ *     } catch (error) {
+ *       console.error('연락처를 가져오는 데 실패했어요:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       {contacts.result.map((contact, index) => (
+ *         <span key={index}>{contact.name}: {contact.phoneNumber}</span>
+ *       ))}
+ *       <input type="button"
+ *         value={contacts.done ? '모든 연락처를 가져왔어요.' : '다음 연락처 가져오기'}
+ *         disabled={contacts.done}
+ *         onClick={handlePress}
+ *       />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function fetchContacts({ size, offset, query, }: {
+	size: number;
+	offset: number;
+	query?: {
+		contains?: string;
+	};
+}): Promise<{
+	result: ContactEntity[];
+	nextOffset: number | null;
+	done: boolean;
+}>;
+
+export {};

package/build/generateHapticFeedback.d.ts

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

package/build/getClipboardText.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @public
+ * @category 클립보드
+ * @name getClipboardText
+ * @description 클립보드에 저장된 텍스트를 가져오는 함수예요. 복사된 텍스트를 읽어서 다른 작업에 활용할 수 있어요.
+ * @returns {Promise<string>} - 클립보드에 저장된 텍스트를 반환해요. 클립보드에 텍스트가 없으면 빈 문자열을 반환해요.
+ *
+ * @example
+ * ### 클립보드의 텍스트 가져오기
+ *
+ * ```tsx
+ * import React, { useState } from 'react';
+ * 
+ * import { getClipboardText } from '@apps-in-toss/web-framework';
+ *
+ * // '붙여넣기' 버튼을 누르면 클립보드에 저장된 텍스트를 가져와 화면에 표시해요.
+ * function PasteButton() {
+ *   const [text, setText] = useState('');
+ *
+ *   const handlePress = async () => {
+ *     try {
+ *       const clipboardText = await getClipboardText();
+ *       setText(clipboardText || '클립보드에 텍스트가 없어요.');
+ *     } catch (error) {
+ *       console.error('클립보드에서 텍스트를 가져오지 못했어요:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <span>{text}</span>
+ *       <input type="button" value="붙여넣기" onClick={handlePress} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function getClipboardText(): Promise<string>;
+
+export {};

package/build/getCurrentLocation.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @public
+ * @category 위치 정보
+ * @name Accuracy
+ * @description 위치 정확도 옵션이에요.
+ */
+export enum Accuracy {
+	/**
+	 * 오차범위 3KM 이내
+	 */
+	Lowest = 1,
+	/**
+	 * 오차범위 1KM 이내
+	 */
+	Low,
+	/**
+	 * 오차범위 몇 백미터 이내
+	 */
+	Balanced,
+	/**
+	 * 오차범위 10M 이내
+	 */
+	High,
+	/**
+	 * 가장 높은 정확도
+	 */
+	Highest,
+	/**
+	 * 네비게이션을 위한 최고 정확도
+	 */
+	BestForNavigation
+}
+/**
+ * @public
+ * @category 위치 정보
+ * @name Location
+ * @description 위치 정보를 나타내는 객체예요.
+ */
+export interface Location {
+	/**
+	 * Android에서만 지원하는 옵션이에요.
+	 *
+	 * - `FINE`: 정확한 위치
+	 * - `COARSE`: 대략적인 위치
+	 *
+	 * @see https://developer.android.com/codelabs/approximate-location
+	 */
+	accessLocation?: "FINE" | "COARSE";
+	/**
+	 * 위치가 업데이트된 시점의 유닉스 타임스탬프예요.
+	 */
+	timestamp: number;
+	/**
+	 * @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/react-native/reference/framework/Types/LocationCoords.html)을 참고해주세요.
+	 */
+	coords: LocationCoords;
+}
+/**
+ * @public
+ * @category 위치 정보
+ * @name LocationCoords
+ * @description 세부 위치 정보를 나타내는 객체예요.
+ */
+export interface LocationCoords {
+	/**
+	 * 위도
+	 */
+	latitude: number;
+	/**
+	 * 경도
+	 */
+	longitude: number;
+	/**
+	 * 높이
+	 */
+	altitude: number;
+	/**
+	 * 위치 정확도
+	 */
+	accuracy: number;
+	/**
+	 * 고도 정확도
+	 */
+	altitudeAccuracy: number;
+	/**
+	 * 방향
+	 */
+	heading: number;
+}
+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/framework/Types/Location.html)을 참고해주세요.
+ *
+ * @example
+ * ### 디바이스의 현재 위치 정보 가져오기
+ *
+ * ```tsx
+ * import React, { useState } from 'react';
+ * 
+ * import { getCurrentLocation } from '@apps-in-toss/web-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 (
+ *     <div>
+ *       {position ? (
+ *         <span>위치: {position.coords.latitude}, {position.coords.longitude}</span>
+ *       ) : (
+ *         <span>위치 정보를 아직 가져오지 않았어요</span>
+ *       )}
+ *       <input type="button" value="현재 위치 정보 가져오기" onClick={handlePress} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function getCurrentLocation(options: GetCurrentLocationOptions): Promise<Location>;
+
+export {};

package/build/getDeviceId.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 {};