@apps-in-toss/web-bridge 0.0.24

package/build/setScreenAwakeMode.d.ts

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

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

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

package/build/startUpdateLocation.d.ts

@@ -0,0 +1,183 @@
+
+
+export interface EventEmitterSchema<K extends string, P extends unknown[]> {
+	name: K;
+	params: P;
+}
+declare 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 StartUpdateLocationOptions {
+	/**
+	 * 위치 정확도를 설정해요.
+	 */
+	accuracy: Accuracy;
+	/**
+	 * 위치 업데이트 주기를 밀리초(ms) 단위로 설정해요.
+	 */
+	timeInterval: number;
+	/**
+	 * 위치 변경 거리를 미터(m) 단위로 설정해요.
+	 */
+	distanceInterval: number;
+}
+export interface StartUpdateLocationSubscription extends EmitterSubscription {
+	remove: () => Promise<void>;
+}
+/**
+ * @name UpdateLocationEventEmitter
+ * @kind typedef
+ * @description
+ * 디바이스의 위치 정보 변경을 감지해요
+ * @extends {EventEmitterSchema<'updateLocation', [Location]>}
+ */
+export interface UpdateLocationEventEmitter extends EventEmitterSchema<"updateLocation", [
+	Location
+]> {
+}
+/**
+ * @public
+ * @category 위치 정보
+ * @name startUpdateLocation
+ * @description  디바이스의 위치 정보를 지속적으로 감지하고, 위치가 변경되면 콜백을 실행하는 함수예요. 콜백 함수를 등록하면 위치가 변경될 때마다 자동으로 호출돼요.
+ * 실시간 위치 추적이 필요한 기능을 구현할 때 사용할 수 있어요. 예를 들어 지도 앱에서 사용자의 현재 위치를 실시간으로 업데이트할 때, 운동 앱에서 사용자의 이동 거리를 기록할 때 등이에요.
+ * 위치 업데이트 주기와 정확도를 조정해 배터리 소모를 최소화하면서도 필요한 정보를 얻을 수 있어요.
+ *
+ * @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/framework/Types/Location.html)을 참고해주세요.
+ *
+ * @example
+ * ### 위치 정보 변경 감지하기
+ *
+ * ```tsx
+ * import React, { useState, useEffect } from 'react';
+ * 
+ * import { startUpdateLocation } from '@apps-in-toss/web-framework';
+ *
+ * // 위치 정보 변경 감지하기
+ * function LocationWatcher() {
+ *   const [location, setLocation] = useState(null);
+ *
+ *   useEffect(() => {
+ *     return startUpdateLocation({
+ *       options: {
+ *         accuracy: Accuracy.Balanced,
+ *         timeInterval: 3000,
+ *         distanceInterval: 10,
+ *       },
+ *       onEvent: (location) => {
+ *         setLocation(location);
+ *       },
+ *       onError: (error) => {
+ *         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>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function startUpdateLocation(eventParams: {
+	onEvent: (response: Location) => void;
+	onError: (error: unknown) => void;
+	options: StartUpdateLocationOptions;
+}): () => void;
+
+export {};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@apps-in-toss/web-bridge",
+  "type": "module",
+  "version": "0.0.24",
+  "description": "Web Bridge for Apps In Toss",
+  "scripts": {
+    "prepack": "yarn build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "build": "echo 'no build'",
+    "sync-bridge": "bridgepack build"
+  },
+  "main": "./build/index.js",
+  "module": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    }
+  },
+  "files": [
+    "build"
+  ],
+  "devDependencies": {
+    "@apps-in-toss-internal/bridgepack": "0.0.24",
+    "@apps-in-toss/bridge-core": "0.0.24",
+    "@apps-in-toss/framework": "0.0.24",
+    "react-native-bedrock": "0.0.23",
+    "tsup": "^8.3.5",
+    "typescript": "4.9.5",
+    "vitest": "^3.1.2"
+  },
+  "peerDependencies": {
+    "@apps-in-toss/bridge-core": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "8a48e0a264315e510cc8e15b0db89b29e679a9ce"
+}