@apps-in-toss/framework 0.0.8 → 0.0.10

package/dist/index.d.ts

@@ -1,14 +1,26 @@
+import { ComponentType, PropsWithChildren } from 'react';
+import { InitialProps, BedrockProps } from 'react-native-bedrock';
 import { EmitterSubscription } from 'react-native';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { WebViewProps as WebViewProps$1 } from '@react-native-bedrock/native/react-native-webview';
 
+type AppsInTossProps = Pick<BedrockProps, 'context'>;
+declare function registerApp(container: ComponentType<PropsWithChildren<InitialProps>>, { context }: AppsInTossProps): (initialProps: InitialProps) => JSX.Element;
+
+declare const AppsInToss: {
+    registerApp: typeof registerApp;
+};
+
 interface EventEmitterSchema<K extends string, P extends unknown[]> {
     name: K;
     params: P;
 }
 
 /**
- * 위치 정확도 옵션이에요.
+ * @public
+ * @category 위치 정보
+ * @name Accuracy
+ * @description 위치 정확도 옵션이에요.
  */
 declare enum Accuracy {
     /**
@@ -36,6 +48,12 @@ declare enum Accuracy {
      */
     BestForNavigation = 6
 }
+/**
+ * @public
+ * @category 위치 정보
+ * @name Location
+ * @description 위치 정보를 나타내는 객체예요.
+ */
 interface Location {
     /**
      * Android에서만 지원하는 옵션이에요.
@@ -50,14 +68,42 @@ interface Location {
      * 위치가 업데이트된 시점의 유닉스 타임스탬프예요.
      */
     timestamp: number;
-    coords: {
-        latitude: number;
-        longitude: number;
-        altitude: number;
-        accuracy: number;
-        altitudeAccuracy: number;
-        heading: number;
-    };
+    /**
+     * @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/reference/framework/Types/LocationCoords.html)을 참고해주세요.
+     */
+    coords: LocationCoords;
+}
+/**
+ * @public
+ * @category 위치 정보
+ * @name LocationCoords
+ * @description 세부 위치 정보를 나타내는 객체예요.
+ */
+interface LocationCoords {
+    /**
+     * 위도
+     */
+    latitude: number;
+    /**
+     * 경도
+     */
+    longitude: number;
+    /**
+     * 높이
+     */
+    altitude: number;
+    /**
+     * 위치 정확도
+     */
+    accuracy: number;
+    /**
+     * 고도 정확도
+     */
+    altitudeAccuracy: number;
+    /**
+     * 방향
+     */
+    heading: number;
 }
 /**
  * 사진 조회 결과를 나타내는 타입이에요.
@@ -97,9 +143,7 @@ interface UpdateLocationEventEmitter extends EventEmitterSchema<'updateLocation'
 }
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 위치 정보
  * @name startUpdateLocation
  * @description  디바이스의 위치 정보를 지속적으로 감지하고, 위치가 변경되면 콜백을 실행하는 함수예요. 콜백 함수를 등록하면 위치가 변경될 때마다 자동으로 호출돼요.
  * 실시간 위치 추적이 필요한 기능을 구현할 때 사용할 수 있어요. 예를 들어 지도 앱에서 사용자의 현재 위치를 실시간으로 업데이트할 때, 운동 앱에서 사용자의 이동 거리를 기록할 때 등이에요.
@@ -109,7 +153,7 @@ interface UpdateLocationEventEmitter extends EventEmitterSchema<'updateLocation'
  * @param {number} [options.accuracy] 위치 정확도를 설정해요.
  * @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
  * @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
- * @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요.
+ * @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
  *
  * @example
  * ### 위치 정보 변경 감지하기
@@ -126,7 +170,7 @@ interface UpdateLocationEventEmitter extends EventEmitterSchema<'updateLocation'
  *   useEffect(() => {
  *     return startUpdateLocation({
  *       options: {
- *         accuracy: Accuracy.Default,
+ *         accuracy: Accuracy.Balanced,
  *         timeInterval: 3000,
  *         distanceInterval: 10,
  *       },
@@ -164,9 +208,7 @@ declare function startUpdateLocation(eventParams: {
 
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 클립보드
  * @name setClipboardText
  * @description 텍스트를 클립보드에 복사해서 사용자가 다른 곳에 붙여 넣기 할 수 있어요.
  * @param {Promise<void>} text - 클립보드에 복사할 텍스트예요. 문자열 형식으로 입력해요.
@@ -197,9 +239,7 @@ declare function setClipboardText(text: string): Promise<void>;
 
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 클립보드
  * @name getClipboardText
  * @description 클립보드에 저장된 텍스트를 가져오는 함수예요. 복사된 텍스트를 읽어서 다른 작업에 활용할 수 있어요.
  * @returns {Promise<string>} - 클립보드에 저장된 텍스트를 반환해요. 클립보드에 텍스트가 없으면 빈 문자열을 반환해요.
@@ -247,9 +287,7 @@ interface ContactEntity {
 }
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 연락처
  * @name fetchContacts
  * @description 사용자의 연락처 목록을 페이지 단위로 가져오는 함수예요.
  * @param size - 한 번에 가져올 연락처 개수예요. 예를 들어, 10을 전달하면 최대 10개의 연락처를 가져와요.
@@ -340,9 +378,7 @@ interface FetchAlbumPhotosOptions {
 }
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 사진
  * @name fetchAlbumPhotos
  * @description
  * 사용자의 앨범에서 사진 목록을 불러오는 함수예요.
@@ -352,7 +388,7 @@ interface FetchAlbumPhotosOptions {
  * @param {number} [options.maxCount=10] 가져올 사진의 최대 개수를 설정해요. 숫자로 입력하며 기본값은 10이에요.
  * @param {number} [options.maxWidth=1024] 사진의 최대 폭을 제한해요. 단위는 픽셀이며 기본값은 `1024`이에요.
  * @param {boolean} [options.base64=false] 이미지를 base64 형식으로 반환할지 설정해요. 기본값은 `false`예요.
- * @returns {Promise<AlbumResponse[]>}
+ * @returns {Promise<ImageResponse[]>}
  * 앨범 사진의 고유 ID와 데이터 URI를 포함한 배열을 반환해요.
  *
  * @example
@@ -400,9 +436,7 @@ interface GetCurrentLocationOptions {
 }
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 위치 정보
  * @name getCurrentLocation
  * @description 디바이스의 현재 위치 정보를 가져오는 함수예요.
  * 위치 기반 서비스를 구현할 때 사용되고, 한 번만 호출되어 현재 위치를 즉시 반환해요.
@@ -410,7 +444,7 @@ interface GetCurrentLocationOptions {
  *
  * @param {GetCurrentLocationOptions} options 위치 정보를 가져올 때 사용하는 옵션 객체예요.
  * @param {Accuracy} [options.accuracy] 위치 정보의 정확도 수준이에요. 정확도는 `Accuracy` 타입으로 설정돼요.
- * @returns {Promise<Location>} 디바이스의 위치 정보가 담긴 객체를 반환해요.
+ * @returns {Promise<Location>} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
  *
  * @example
  * ### 디바이스의 현재 위치 정보 가져오기
@@ -464,9 +498,7 @@ interface OpenCameraOptions {
 }
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 카메라
  * @name openCamera
  * @description 카메라를 실행해서 촬영된 이미지를 반환하는 함수예요.
  * @param {OpenCameraOptions} options - 카메라 실행 시 사용되는 옵션 객체예요.
@@ -513,17 +545,81 @@ interface OpenCameraOptions {
  */
 declare function openCamera(options?: OpenCameraOptions): Promise<ImageResponse>;
 
+/**
+ * @public
+ * @category 로그인
+ * @name appLogin
+ * @description 토스 인증으로 로그인해요. 로그인이 완료되면 다시 토스 앱으로 이동해요.
+ * @example
+ *
+ * ### 토스 인증을 통해 로그인을 하는 예제
+ *
+ * ```tsx
+ * import { Button } from 'react-native';
+ * import { appLogin } from '@apps-in-toss/framework';
+ *
+ * function Page() {
+ *   const handleLogin = async () => {
+ *     const { authorizationCode, referrer } = await appLogin();
+ *
+ *     // 획득한 인가 코드(`authorizationCode`)와 `referrer`를 서버로 전달해요.
+ *   }
+ *
+ *   return <Button title="로그인" onPress={handleLogin} />;
+ * }
+ * ```
+ */
+declare function appLogin(): Promise<{
+    authorizationCode: string;
+    referrer: "DEFAULT" | "SANDBOX";
+}>;
+
+/**
+ * @public
+ * @category 환경 확인
+ * @kind function
+ * @name getOperationalEnvironment
+ * @description
+ * 현재 실행 중인 앱의 운영 환경을 확인해요.
+ * 토스 앱에서 실행 중이라면 `'toss'`, 샌드박스 환경에서 실행 중이라면 `'sandbox'`를 반환해요.
+ *
+ * 운영 환경은 앱이 실행되는 컨텍스트를 의미하며, 특정 기능의 사용 가능 여부를 판단하는 데 활용할 수 있어요.
+ *
+ * @returns {'toss' | 'sandbox'}
+ * 현재 운영 환경을 나타내는 문자열이에요.
+ * - `'toss'`: 토스 앱에서 실행 중이에요.
+ * - `'sandbox'`: 샌드박스 환경에서 실행 중이에요.
+ *
+ * @example
+ * ### 현재 운영 환경 확인하기
+ *
+ * ```tsx
+ * import { getOperationalEnvironment } from '@apps-in-toss/framework';
+ * import { Text } from 'react-native';
+ *
+ * function EnvironmentInfo() {
+ *   const environment = getOperationalEnvironment();
+ *
+ *   return (
+ *     <Text>현재 운영 환경: {environment}</Text>
+ *   );
+ * }
+ * ```
+ */
+declare function getOperationalEnvironment(): 'toss' | 'sandbox';
+
 interface WebViewProps extends Omit<WebViewProps$1, 'source' | 'sharedCookiesEnabled' | 'thirdPartyCookiesEnabled' | 'injectedJavaScriptBeforeContentLoaded'> {
-    localhostPort?: number;
+    local: {
+        port: number;
+        host: number;
+    };
 }
-declare function WebView({ localhostPort, onMessage, ...props }: WebViewProps): react_jsx_runtime.JSX.Element;
+declare function WebView({ local, onMessage, ...props }: WebViewProps): react_jsx_runtime.JSX.Element;
 
 type UseGeolocationOptions = Omit<StartUpdateLocationOptions, 'callback'>;
 /**
  * @public
- * @tag AppsInTossModule
- * @category AppsInTossModules
- * @kind function
+ * @category 위치 정보
  * @name useGeolocation
  * @description 디바이스의 위치 정보를 반환하는 훅이에요. 위치가 변경되면 값도 변경돼요.
  * GPS 정보를 활용해 현재 위치를 감지하고, 사용자의 이동에 따라 자동으로 업데이트돼요.
@@ -534,6 +630,7 @@ type UseGeolocationOptions = Omit<StartUpdateLocationOptions, 'callback'>;
  * @param {Accuracy} [options.accuracy] 위치 정확도를 설정해요. `Accuracy.Lowest`: 오차범위 3KM 이내, `Accuracy.Low`: 오차범위 1KM 이내, `Accuracy.Balanced`: 오차범위 몇 백미터 이내, `Accuracy.High`: 오차범위 10M 이내, `Accuracy.Highest`: 가장 높은 정확도, `Accuracy.BestForNavigation`: 네비게이션을 위한 최고 정확도
  * @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
  * @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
+ * @returns {Location | null} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
  *
  * @example
  * ### 위치 정보 변경 감지하기
@@ -569,4 +666,4 @@ declare const env: {
     getDeploymentId: () => string | undefined;
 };
 
-export { Accuracy, type ContactEntity, type FetchAlbumPhotosOptions, type GetCurrentLocationOptions, type ImageResponse, type Location, type OpenCameraOptions, type StartUpdateLocationOptions, type StartUpdateLocationSubscription, type UpdateLocationEventEmitter, type UseGeolocationOptions, WebView, type WebViewProps, env, fetchAlbumPhotos, fetchContacts, getClipboardText, getCurrentLocation, openCamera, setClipboardText, startUpdateLocation, useGeolocation };
+export { Accuracy, AppsInToss, type ContactEntity, type FetchAlbumPhotosOptions, type GetCurrentLocationOptions, type ImageResponse, type Location, type LocationCoords, type OpenCameraOptions, type StartUpdateLocationOptions, type StartUpdateLocationSubscription, type UpdateLocationEventEmitter, type UseGeolocationOptions, WebView, type WebViewProps, appLogin, env, fetchAlbumPhotos, fetchContacts, getClipboardText, getCurrentLocation, getOperationalEnvironment, openCamera, setClipboardText, startUpdateLocation, useGeolocation };

package/dist/index.js

@@ -4,6 +4,32 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 
+// src/core/registerApp.tsx
+import { Bedrock } from "react-native-bedrock";
+import { jsx } from "react/jsx-runtime";
+function AppsInTossContainer(Container, { children, ...initialProps }) {
+  return /* @__PURE__ */ jsx(Container, { ...initialProps, children });
+}
+function registerApp(container, { context }) {
+  return Bedrock.registerApp(AppsInTossContainer.bind(null, container), {
+    appName: getAppName(),
+    context
+  });
+}
+function getAppName() {
+  try {
+    return global.__bedrock.app.name;
+  } catch (error) {
+    console.error("unexpected error occurred while getting app name");
+    throw error;
+  }
+}
+
+// src/core/index.ts
+var AppsInToss = {
+  registerApp
+};
+
 // src/native-event-emitter/index.ts
 var native_event_emitter_exports = {};
 __export(native_event_emitter_exports, {
@@ -86,10 +112,12 @@ function startUpdateLocation(eventParams) {
 // src/native-modules/index.ts
 var native_modules_exports = {};
 __export(native_modules_exports, {
+  appLogin: () => appLogin,
   fetchAlbumPhotos: () => fetchAlbumPhotos,
   fetchContacts: () => fetchContacts,
   getClipboardText: () => getClipboardText,
   getCurrentLocation: () => getCurrentLocation,
+  getOperationalEnvironment: () => getOperationalEnvironment,
   openCamera: () => openCamera,
   setClipboardText: () => setClipboardText
 });
@@ -147,6 +175,14 @@ async function fetchAlbumPhotos(options) {
     maxCount: options.maxCount ?? DEFAULT_MAX_COUNT,
     maxWidth: options.maxWidth ?? DEFAULT_MAX_WIDTH
   });
+  if (options.base64) {
+    return albumPhotos.map((photo) => {
+      return {
+        ...photo,
+        dataUri: `data:image/jpeg;base64,${photo.dataUri}`
+      };
+    });
+  }
   return albumPhotos;
 }
 
@@ -170,6 +206,16 @@ async function openCamera(options) {
   return photo;
 }
 
+// src/native-modules/appLogin.ts
+async function appLogin() {
+  return AppsInTossModule.appLogin({});
+}
+
+// src/native-modules/getOperationalEnvironment.ts
+function getOperationalEnvironment() {
+  return AppsInTossModule.operationalEnvironment;
+}
+
 // src/components/WebView.tsx
 import {
   WebView as OriginalWebView
@@ -178,14 +224,14 @@ import { useMemo } from "react";
 import { useBridgeHandler } from "react-native-bedrock";
 import * as bridges from "react-native-bedrock/bridges";
 import * as constantBridges from "react-native-bedrock/constants";
-import { jsx } from "react/jsx-runtime";
-function WebView({ localhostPort = 5173, onMessage, ...props }) {
+import { jsx as jsx2 } from "react/jsx-runtime";
+function WebView({ local, onMessage, ...props }) {
   const uri = useMemo(() => {
     if (__DEV__) {
-      return `http://localhost:${localhostPort}`;
+      return `http://${local.host}:${local.port}`;
     }
     return AppsInTossModule.getWebBundleURL({}).url;
-  }, [localhostPort]);
+  }, [local]);
   const handler = useBridgeHandler({
     onMessage,
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -200,7 +246,7 @@ function WebView({ localhostPort = 5173, onMessage, ...props }) {
       ...native_modules_exports
     }
   });
-  return /* @__PURE__ */ jsx(
+  return /* @__PURE__ */ jsx2(
     OriginalWebView,
     {
       ref: handler.ref,
@@ -255,12 +301,15 @@ var Accuracy2 = /* @__PURE__ */ ((Accuracy3) => {
 })(Accuracy2 || {});
 export {
   Accuracy2 as Accuracy,
+  AppsInToss,
   WebView,
+  appLogin,
   env,
   fetchAlbumPhotos,
   fetchContacts,
   getClipboardText,
   getCurrentLocation,
+  getOperationalEnvironment,
   openCamera,
   setClipboardText,
   startUpdateLocation,

package/dist/jest/index.cjs

@@ -0,0 +1,24 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/jest/index.ts
+var jest_exports = {};
+module.exports = __toCommonJS(jest_exports);
+__reExport(jest_exports, require("react-native-bedrock/jest"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("react-native-bedrock/jest")
+});

package/dist/jest/index.d.cts

@@ -0,0 +1 @@
+export * from 'react-native-bedrock/jest';

package/dist/jest/index.d.ts

@@ -0,0 +1 @@
+export * from 'react-native-bedrock/jest';

package/dist/jest/index.js

@@ -0,0 +1,4 @@
+import { createRequire } from 'module'; const require = createRequire(import.meta.url);
+
+// src/jest/index.ts
+export * from "react-native-bedrock/jest";