@appboxo/web-sdk 1.3.0 → 1.3.1

package/README.md

@@ -47,6 +47,7 @@ const sdk = new AppboxoWebSDK({
   sandboxMode?: boolean;  // Optional, default: false
   debug?: boolean;       // Optional, default: false. When true, enables all console logs for debugging. When false, no console logs are output.
   locale?: string;       // Optional, locale/language code (e.g., 'en', 'en-US', 'ru', 'zh-CN')
+  isDesktop?: boolean;   // Optional, default: false. When true, API calls to fetch miniapp settings will include is_desktop=true parameter
   onGetAuthCode?: () => Promise<string>; // Optional, for automatic auth code retrieval
   onGetAuthTokens?: () => Promise<LoginResponse>; // Optional, for direct auth tokens
   onPaymentRequest?: (params: PaymentRequest) => Promise<PaymentResponse>; // Optional, for handling payment requests
@@ -179,6 +180,37 @@ The locale is passed to the miniapp via `InitData.data.locale` on the next `AppB
 - If you call `setLocale()` after the miniapp has already loaded, the locale will be included in the next InitData request. The miniapp may need to reload or request InitData again to receive the updated locale.
 - To ensure the locale is available immediately, set it during SDK initialization or before calling `mount()`.
 
+### Desktop Mode
+
+When `isDesktop: true` is set, the SDK will include `is_desktop=true` parameter when fetching miniapp settings from the API. This allows the backend to return desktop-specific configurations.
+
+```typescript
+const sdk = new AppboxoWebSDK({
+  clientId: "your-client-id",
+  appId: "your-app-id",
+  isDesktop: true  // Enable desktop mode
+});
+```
+
+When enabled, API calls to `/miniapps/{appId}/settings/` will include the `is_desktop=true` query parameter:
+```
+GET /miniapps/{appId}/settings/?client_id={clientId}&is_desktop=true
+```
+
+### Logout
+
+The `logout()` method clears the host app's storage and SDK's internal authentication data.
+
+```typescript
+sdk.logout();
+```
+
+**Important Notes:**
+- This only clears the **host app's** `localStorage` and `sessionStorage`
+- Miniapp's storage is separate (different origin) and cannot be cleared from the host app due to browser security restrictions
+- The SDK will send a logout notification to the miniapp via `postMessage`, allowing the miniapp to clear its own storage if it listens for the event
+- SDK's internal `authCode` and `authTokens` are also cleared
+
 ## Methods
 
 | Method | Description |
@@ -194,6 +226,7 @@ The locale is passed to the miniapp via `InitData.data.locale` on the next `AppB
 | `onEvent(type, handler)` | Register custom event handler |
 | `onLoginComplete(callback)` | Login completion callback |
 | `onPaymentComplete(callback)` | Payment completion callback |
+| `logout()` | Clear host app's localStorage, sessionStorage, and SDK's internal auth data |
 | `destroy()` | Clean up resources |
 
 ## Events

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appboxo/web-sdk",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Boxo Desktop Host App SDK for handling miniapp events",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",