@apps-in-toss/web-framework 0.0.11 → 0.0.13

package/dist/prebuilt/prod.json

@@ -2,13 +2,13 @@
   {
     "platform": "ios",
     "totalModuleCount": 360,
-    "duration": 406.73562500000025,
-    "size": 130489
+    "duration": 407.6906250000002,
+    "size": 130797
   },
   {
     "platform": "android",
     "totalModuleCount": 360,
-    "duration": 407.8052090000001,
-    "size": 130235
+    "duration": 406.40241600000013,
+    "size": 130533
   }
 ]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apps-in-toss/web-framework",
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Web Framework for Apps In Toss",
   "scripts": {
     "prepack": "yarn build",
@@ -50,7 +50,7 @@
     "config.d.ts"
   ],
   "devDependencies": {
-    "@apps-in-toss/framework": "0.0.11",
+    "@apps-in-toss/framework": "0.0.13",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7",
     "@babel/plugin-proposal-numeric-separator": "^7.16.7",
@@ -95,11 +95,11 @@
     "zod": "^3.24.1"
   },
   "dependencies": {
-    "@apps-in-toss/cli": "0.0.11",
+    "@apps-in-toss/cli": "0.0.13",
     "@babel/core": "7.23.9"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d0dfa84af3118a71ea3705c440e639fb5b1a010b"
+  "gitHead": "c5fa235b136ffaefc7687b35b473de5f6a1dca6f"
 }

package/src-web/fetchAlbumPhotos.d.ts

@@ -41,6 +41,8 @@ export interface FetchAlbumPhotosOptions {
  * 
  * import { fetchAlbumPhotos } from '@apps-in-toss/web-framework';
  *
+ * const base64 = true;
+ *
  * // 앨범 사진 목록을 가져와 화면에 표시하는 컴포넌트
  * function AlbumPhotoList() {
  *   const [albumPhotos, setAlbumPhotos] = useState([]);
@@ -48,7 +50,7 @@ export interface FetchAlbumPhotosOptions {
  *   const handlePress = async () => {
  *     try {
  *       const response = await fetchAlbumPhotos({
- *         base64: true,
+ *         base64,
  *         maxWidth: 360,
  *       });
  *       setAlbumPhotos((prev) => ([...prev, ...response]));
@@ -59,9 +61,12 @@ export interface FetchAlbumPhotosOptions {
  *
  *   return (
  *     <div>
- *       {albumPhotos.map((image) => (
- *         <img src={`data:image/jpeg;base64,${image.dataUri}`} key={image.id} />
- *       ))}
+ *       {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>
  *   );

package/src-web/fetchContacts.d.ts

@@ -22,17 +22,36 @@ export interface ContactEntity {
  * - `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 } from '@apps-in-toss/web-framework';
+ * import { fetchContacts, ContactEntity } from '@apps-in-toss/web-framework';
  *
  * // 특정 문자열을 포함한 연락처 목록을 가져와 화면에 표시하는 컴포넌트
  * function ContactsList() {
- *   const [contacts, setContacts] = useState({
+ *   const [contacts, setContacts] = useState<{
+ *     result: ContactEntity[];
+ *     nextOffset: number | null;
+ *     done: boolean;
+ *   }>({
  *     result: [],
  *     nextOffset: null,
  *     done: false,
@@ -48,7 +67,7 @@ export interface ContactEntity {
  *       const response = await fetchContacts({
  *         size: 10,
  *         offset: contacts.nextOffset ?? 0,
- *         query: { contains: '홍길동' },
+ *         query: { contains: '김' },
  *       });
  *       setContacts((prev) => ({
  *         result: [...prev.result, ...response.result],

package/src-web/openCamera.d.ts

@@ -42,23 +42,28 @@ export interface OpenCameraOptions {
  * 
  * import { openCamera } from '@apps-in-toss/web-framework';
  *
+ * const base64 = true;
+ *
  * // 카메라를 실행하고 촬영된 이미지를 화면에 표시하는 컴포넌트
  * function Camera() {
  *   const [image, setImage] = useState(null);
  *
  *   const handlePress = async () => {
  *     try {
- *       const response = await openCamera({ base64: true });
+ *       const response = await openCamera({ base64 });
  *       setImage(response);
  *     } catch (error) {
  *       console.error('사진을 가져오는 데 실패했어요:', error);
  *     }
  *   };
  *
+ *   // base64 형식으로 반환된 이미지를 표시하려면 데이터 URL 스키마 Prefix를 붙여야해요.
+ *   const imageUri = base64 ? 'data:image/jpeg;base64,' + image.dataUri : image.dataUri;
+ *
  *   return (
  *     <div>
  *       {image ? (
- *         <img src={`data:image/jpeg;base64,${image.dataUri}`} style={{ width: 200, height: 200 }} />
+ *         <Image source={{ uri: imageUri }} style={{ width: 200, height: 200 }} />
  *       ) : (
  *         <span>사진이 없어요</span>
  *       )}