@apps-in-toss/web-framework 0.0.8 → 0.0.10

package/dist/closeView.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @public
+ * @tag BedrockModule
+ * @category BedrockModules
+ * @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/dist/config/index.d.ts

@@ -1,73 +1,60 @@
-import { Permission, OAuthScope } from '@apps-in-toss/framework/plugins';
-import { BedrockConfigResponse } from 'react-native-bedrock/config';
-import { z } from 'zod';
-
-declare const AppsInTossConfigSchema: z.ZodObject<{
-    appName: z.ZodString;
-    web: z.ZodObject<{
-        port: z.ZodNumber;
-        commands: z.ZodObject<{
-            dev: z.ZodString;
-            build: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            dev: string;
-            build: string;
-        }, {
-            dev: string;
-            build: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        port: number;
-        commands: {
-            dev: string;
-            build: string;
-        };
-    }, {
-        port: number;
-        commands: {
-            dev: string;
-            build: string;
-        };
-    }>;
-    permissions: z.ZodArray<z.ZodType<Permission, z.ZodTypeDef, Permission>, "many">;
-    outdir: z.ZodDefault<z.ZodString>;
-    oauth: z.ZodObject<{
-        scopes: z.ZodArray<z.ZodType<OAuthScope, z.ZodTypeDef, OAuthScope>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        scopes: OAuthScope[];
-    }, {
-        scopes: OAuthScope[];
-    }>;
-}, "strip", z.ZodTypeAny, {
-    permissions: Permission[];
-    oauth: {
-        scopes: OAuthScope[];
-    };
+type PermissionReadWrite = 'read' | 'write';
+type PermissionAccess = 'access';
+type ClipboardPermission = {
+    name: 'clipboard';
+    access: PermissionReadWrite;
+};
+type GeolocationPermission = {
+    name: 'geolocation';
+    access: PermissionAccess;
+};
+type ContactsPermission = {
+    name: 'contacts';
+    access: PermissionReadWrite;
+};
+type PhotosPermission = {
+    name: 'photos';
+    access: PermissionReadWrite;
+};
+type CameraPermission = {
+    name: 'camera';
+    access: PermissionAccess;
+};
+type Permission = ClipboardPermission | GeolocationPermission | ContactsPermission | PhotosPermission | CameraPermission;
+/**
+ * OAuth 인증시 사용할 수 있는 Scope 값이에요.
+ *
+ * - `user_name`: 유저 이름이에요.
+ * - `user_phone`: 유저 휴대폰 번호예요.
+ * - `user_birthday`: 유저 생년월일이에요.
+ * - `user_ci`: 유저를 식별하는 키인 CI(Connection Information) 값이에요.
+ * - `user_gender`: 유저의 성별이에요.
+ * - `user_nationality`: 유저의 국적이에요.
+ * - `user_email`: 유저의 이메일이에요. 토스 회원의 email이 존재하지 않는 경우 null 응답을 반환해요.
+ */
+type OAuthScope = 'user_name' | 'user_phone' | 'user_birthday' | 'user_ci' | 'user_gender' | 'user_nationality' | 'user_email';
+interface AppsInTossWebConfig {
     appName: string;
-    outdir: string;
     web: {
+        /**
+         * @default 'localhost'
+         */
+        host?: string;
         port: number;
         commands: {
             dev: string;
             build: string;
         };
     };
-}, {
     permissions: Permission[];
     oauth: {
         scopes: OAuthScope[];
     };
-    appName: string;
-    web: {
-        port: number;
-        commands: {
-            dev: string;
-            build: string;
-        };
-    };
-    outdir?: string | undefined;
-}>;
-type AppsInTossConfig = z.infer<typeof AppsInTossConfigSchema>;
-declare const defineConfig: (config: z.input<typeof AppsInTossConfigSchema>) => Promise<BedrockConfigResponse>;
+    /**
+     * @default 'dist'
+     */
+    outdir?: string;
+}
+declare const defineConfig: (config: AppsInTossWebConfig) => AppsInTossWebConfig;
 
-export { type AppsInTossConfig, defineConfig };
+export { type AppsInTossWebConfig, defineConfig };