@apps-in-toss/web-bridge 1.0.3 → 1.1.0

package/built/setClipboardText.d.ts

@@ -1,16 +1,36 @@
+export type SetClipboardText = (text: string) => Promise<void>;
+type PermissionStatus$1 = "notDetermined" | "denied" | "allowed";
+export type PermissionDialogFunction = () => Promise<Exclude<PermissionStatus$1, "notDetermined">>;
+export type GetPermissionFunction = () => Promise<PermissionStatus$1>;
+export type PermissionFunctionWithDialog<T extends (...args: any[]) => any> = T & {
+	getPermission: GetPermissionFunction;
+	openPermissionDialog: PermissionDialogFunction;
+};
 /**
  * @public
  * @category 클립보드
  * @name setClipboardText
  * @description 텍스트를 클립보드에 복사해서 사용자가 다른 곳에 붙여 넣기 할 수 있어요.
  * @param {Promise<void>} text - 클립보드에 복사할 텍스트예요. 문자열 형식으로 입력해요.
+ * @property [openPermissionDialog] - 클립보드 쓰기 권한을 다시 요청하는 다이얼로그를 표시해요. 사용자는 "허용", "한 번만 허용", "안하기" 중 하나를 선택할 수 있어요. "허용"이나 "한 번만 허용"을 선택하면 `allowed`를 반환하고, "안하기"를 선택하면 `denied`를 반환해요.
+ * @property [getPermission] - 클립보드 쓰기 권한의 현재 상태를 반환해요. `allowed`는 사용자가 클립보드 쓰기 권한을 허용한 상태예요. `denied`는 사용자가 클립보드 쓰기 권한을 거부한 상태예요. `notDetermined`는 클립보드 쓰기 권한 요청을 한 번도 하지 않은 상태예요.
+ *
+ * @signature
+ * ```typescript
+ * function setClipboardText(text: string): Promise<void>;
+ * ```
  *
  * @example
  * ### 텍스트를 클립보드에 복사하기
  *
+ * 텍스트를 클립보드에 복사하는 예제예요.
+ * "권한 확인하기"버튼을 눌러서 현재 클립보드 쓰기 권한을 확인해요.
+ * 사용자가 권한을 거부했거나 시스템에서 권한이 제한된 경우에는 [`SetClipboardTextPermissionError`](/react-native/reference/types/권한/SetClipboardTextPermissionError)를 반환해요.
+ * "권한 요청하기"버튼을 눌러서 클립보드 쓰기 권한을 요청할 수 있어요.
+ *
  * ```tsx
+ * import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/web-framework';
  * 
- * import { setClipboardText } from '@apps-in-toss/web-framework';
  *
  * // '복사' 버튼을 누르면 "복사할 텍스트"가 클립보드에 복사돼요.
  * function CopyButton() {
@@ -19,14 +39,34 @@
  *       await setClipboardText('복사할 텍스트');
  *       console.log('텍스트가 복사됐어요!');
  *     } catch (error) {
- *       console.error('텍스트 복사에 실패했어요:', error);
+ *       if (error instanceof SetClipboardTextPermissionError) {
+ *         // 텍스트 쓰기 권한 거부됨
+ *       }
  *     }
  *   };
  *
- *   return <input type="button" value="복사" onClick={handleCopy} />;
+ *   return (
+ *     <>
+ *       <input type="button" value="복사" onClick={handleCopy} />
+ *       <input type="button"
+ *         value="권한 확인하기"
+ *         onClick={async () => {
+ *           const permission = await setClipboardText.getPermission();
+ *           Alert.alert(permission);
+ *         }}
+ *       />
+ *       <input type="button"
+ *         value="권한 요청하기"
+ *         onClick={async () => {
+ *           const permission = await setClipboardText.openPermissionDialog();
+ *           Alert.alert(permission);
+ *         }}
+ *       />
+ *     </>
+ *   );
  * }
  * ```
  */
-export declare function setClipboardText(text: string): Promise<void>;
+export declare const setClipboardText: PermissionFunctionWithDialog<SetClipboardText>;
 
 export {};

package/built/startUpdateLocation.d.ts

@@ -1,9 +1,3 @@
-
-
-export interface EventEmitterSchema<K extends string, P extends unknown[]> {
-	name: K;
-	params: P;
-}
 declare enum Accuracy {
 	/**
 	 * 오차범위 3KM 이내
@@ -95,8 +89,17 @@ export interface StartUpdateLocationOptions {
 	 */
 	distanceInterval: number;
 }
-export interface StartUpdateLocationSubscription extends EmitterSubscription {
-	remove: () => Promise<void>;
+export type StartUpdateLocationEventParams = {
+	onEvent: (response: Location$1) => void;
+	onError: (error: unknown) => void;
+	options: StartUpdateLocationOptions;
+};
+type PermissionStatus$1 = "notDetermined" | "denied" | "allowed";
+export type PermissionDialogFunction = () => Promise<Exclude<PermissionStatus$1, "notDetermined">>;
+export type GetPermissionFunction = () => Promise<PermissionStatus$1>;
+export interface EventEmitterSchema<K extends string, P extends unknown[]> {
+	name: K;
+	params: P;
 }
 /**
  * @name UpdateLocationEventEmitter
@@ -115,26 +118,46 @@ export type UpdateLocationEventEmitter = EventEmitterSchema<"updateLocation", [
  * 실시간 위치 추적이 필요한 기능을 구현할 때 사용할 수 있어요. 예를 들어 지도 앱에서 사용자의 현재 위치를 실시간으로 업데이트할 때, 운동 앱에서 사용자의 이동 거리를 기록할 때 등이에요.
  * 위치 업데이트 주기와 정확도를 조정해 배터리 소모를 최소화하면서도 필요한 정보를 얻을 수 있어요.
  *
+ *
+ * @param {(error: unknown) => void} onError 위치 정보 감지에 실패했을 때 호출되는 콜백 함수예요.
+ * @param {(location: Location) => void} onEvent 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/react-native/reference/native-modules/Types/Location.html)을 참고해주세요.
  * @param {StartUpdateLocationOptions} options - 위치 정보 감지에 필요한 설정 객체에요.
  * @param {number} [options.accuracy] 위치 정확도를 설정해요.
  * @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
  * @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
- * @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/react-native/reference/native-modules/Types/Location.html)을 참고해주세요.
+ *
+ * @property [openPermissionDialog] - 위치 정보 권한을 다시 요청하는 다이얼로그를 표시해요. 사용자는 "허용", "한 번만 허용", "안하기" 중 하나를 선택할 수 있어요. "허용"이나 "한 번만 허용"을 선택하면 `allowed`를 반환하고, "안하기"를 선택하면 `denied`를 반환해요.
+ * @property [getPermission] - 위치 정보 권한의 현재 상태를 반환해요. `allowed`는 사용자가 위치 정보 권한을 허용한 상태예요. `denied`는 사용자가 위치 정보 권한을 거부한 상태예요. `notDetermined`는 위치 정보 권한 요청을 한 번도 하지 않은 상태예요.
+ *
+ * @signature
+ * ```typescript
+ * function startUpdateLocation(options: {
+ *   onError: (error: unknown) => void;
+ *   onEvent: (location: Location) => void;
+ *   options: StartUpdateLocationOptions;
+ * }): () => void;
+ * ```
  *
  * @example
  * ### 위치 정보 변경 감지하기
  *
+ * 위치 정보가 변경되는것을 감지하는 예제예요. "위치 정보 변경 감지하기"를 눌러서 감지할 수 있어요.
+ *
+ * "권한 확인하기"버튼을 눌러서 현재 위치 정보 변경 감지 권한을 확인해요.
+ * 사용자가 권한을 거부했거나 시스템에서 권한이 제한된 경우에는 [`StartUpdateLocationPermissionError`](/react-native/reference/types/권한/StartUpdateLocationPermissionError)를 반환해요.
+ * "권한 요청하기"버튼을 눌러서 위치 정보 변경 감지 권한을 요청할 수 있어요.
+ *
  * ```tsx
- * import React, { useState, useEffect } from 'react';
+ * import { Accuracy, Location, startUpdateLocation, StartUpdateLocationPermissionError } from '@apps-in-toss/web-framework';
+ * import { useCallback, useState } from 'react';
  * 
- * import { startUpdateLocation } from '@apps-in-toss/web-framework';
  *
  * // 위치 정보 변경 감지하기
  * function LocationWatcher() {
- *   const [location, setLocation] = useState(null);
+ *   const [location, setLocation] = useState<Location | null>(null);
  *
- *   useEffect(() => {
- *     return startUpdateLocation({
+ *   const handlePress = useCallback(() => {
+ *     startUpdateLocation({
  *       options: {
  *         accuracy: Accuracy.Balanced,
  *         timeInterval: 3000,
@@ -144,32 +167,52 @@ export type UpdateLocationEventEmitter = EventEmitterSchema<"updateLocation", [
  *         setLocation(location);
  *       },
  *       onError: (error) => {
+ *         if (error instanceof StartUpdateLocationPermissionError) {
+ *           // 위치 정보 변경 감지 권한 없음
+ *         }
  *         console.error('위치 정보를 가져오는데 실패했어요:', error);
  *       },
  *     });
  *   }, []);
  *
- *   if (location == null) {
- *     return <span>위치 정보를 가져오는 중이에요...</span>;
- *   }
- *
  *   return (
  *     <div>
- *       <span>위도: {location.coords.latitude}</span>
- *       <span>경도: {location.coords.longitude}</span>
- *       <span>위치 정확도: {location.coords.accuracy}m</span>
- *       <span>높이: {location.coords.altitude}m</span>
- *       <span>고도 정확도: {location.coords.altitudeAccuracy}m</span>
- *       <span>방향: {location.coords.heading}°</span>
+ *       {location != null && (
+ *         <>
+ *           <span>위도: {location.coords.latitude}</span>
+ *           <span>경도: {location.coords.longitude}</span>
+ *           <span>위치 정확도: {location.coords.accuracy}m</span>
+ *           <span>높이: {location.coords.altitude}m</span>
+ *           <span>고도 정확도: {location.coords.altitudeAccuracy}m</span>
+ *           <span>방향: {location.coords.heading}°</span>
+ *         </>
+ *       )}
+ *
+ *       <input type="button" value="위치 정보 변경 감지하기" onClick={handlePress} />
+ *
+ *       <input type="button"
+ *         value="권한 확인하기"
+ *         onClick={async () => {
+ *           const permission = await startUpdateLocation.getPermission();
+ *           Alert.alert(permission);
+ *         }}
+ *       />
+ *       <input type="button"
+ *         value="권한 요청하기"
+ *         onClick={async () => {
+ *           const permission = await startUpdateLocation.openPermissionDialog();
+ *           Alert.alert(permission);
+ *         }}
+ *       />
  *     </div>
  *   );
  * }
  * ```
  */
-export declare function startUpdateLocation(eventParams: {
-	onEvent: (response: Location$1) => void;
-	onError: (error: unknown) => void;
-	options: StartUpdateLocationOptions;
-}): () => void;
+export declare function startUpdateLocation(eventParams: StartUpdateLocationEventParams): () => void;
+export declare namespace startUpdateLocation {
+	var openPermissionDialog: PermissionDialogFunction;
+	var getPermission: GetPermissionFunction;
+}
 
 export {};

package/built/types.d.ts

@@ -1,110 +1,3 @@
-type PermissionStatus$1 = "notDetermined" | "denied" | "allowed";
-export type PermissionAccess = "read" | "write" | "access";
-type PermissionName$1 = "clipboard" | "contacts" | "photos" | "geolocation" | "camera";
 export type Primitive = string | number | boolean | null | undefined | symbol;
-/**
- * @public
- * @category 위치 정보
- * @name Accuracy
- * @description 위치 정확도 옵션이에요.
- */
-export declare enum Accuracy {
-	/**
-	 * 오차범위 3KM 이내
-	 */
-	Lowest = 1,
-	/**
-	 * 오차범위 1KM 이내
-	 */
-	Low = 2,
-	/**
-	 * 오차범위 몇 백미터 이내
-	 */
-	Balanced = 3,
-	/**
-	 * 오차범위 10M 이내
-	 */
-	High = 4,
-	/**
-	 * 가장 높은 정확도
-	 */
-	Highest = 5,
-	/**
-	 * 네비게이션을 위한 최고 정확도
-	 */
-	BestForNavigation = 6
-}
-/**
- * @public
- * @category 위치 정보
- * @name Location
- * @description 위치 정보를 나타내는 객체예요.
- */
-interface Location$1 {
-	/**
-	 * Android에서만 지원하는 옵션이에요.
-	 *
-	 * - `FINE`: 정확한 위치
-	 * - `COARSE`: 대략적인 위치
-	 *
-	 * @see https://developer.android.com/codelabs/approximate-location
-	 */
-	accessLocation?: "FINE" | "COARSE";
-	/**
-	 * 위치가 업데이트된 시점의 유닉스 타임스탬프예요.
-	 */
-	timestamp: number;
-	/**
-	 * @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/react-native/reference/native-modules/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 ImageResponse {
-	/** 가져온 사진의 고유 ID예요. */
-	id: string;
-	/** 사진의 데이터 URI예요. `base64` 옵션이 `true`인 경우 Base64 문자열로 반환돼요. */
-	dataUri: string;
-}
-
-export {
-	Location$1 as Location,
-	PermissionName$1 as PermissionName,
-	PermissionStatus$1 as PermissionStatus,
-};
 
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apps-in-toss/web-bridge",
   "type": "module",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Web Bridge for Apps In Toss",
   "scripts": {
     "prepack": "yarn build",
@@ -27,9 +27,12 @@
   "files": [
     "built"
   ],
+  "dependencies": {
+    "@apps-in-toss/types": "1.1.0"
+  },
   "devDependencies": {
-    "@apps-in-toss/bridge-core": "1.0.3",
-    "@apps-in-toss/framework": "1.0.3",
+    "@apps-in-toss/bridge-core": "1.1.0",
+    "@apps-in-toss/framework": "1.1.0",
     "@swc/core": "^1.12.7",
     "picocolors": "^1.1.1",
     "ts-morph": "^26.0.0",
@@ -43,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "380ad5f697a176bcc6adae409153fa43e700d053"
+  "gitHead": "614cfd1ee039b44cd6efeb94cefac18ed3c0e6c3"
 }