@grabjs/superapp-sdk 2.0.0-beta.23 → 2.0.0-beta.29

package/README.md

@@ -12,125 +12,24 @@ Each module encapsulates a specific domain of functionality, offering strongly-t
 - **Streaming Support** — Real-time data streams for location updates and media events
 - **Automatic Fallbacks** — Graceful degradation when native features are unavailable
 
-## Installation
-
-### NPM (ES Modules)
-
-```bash
-npm install @grabjs/superapp-sdk
-```
-
-```typescript
-import { ContainerModule, LocationModule } from '@grabjs/superapp-sdk';
-```
-
-### CDN (UMD Bundle)
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const { ContainerModule, LocationModule } = window.SuperAppSDK;
-</script>
-```
-
-## Usage
-
-### Basic Module Initialization
-
-All modules are instantiated with a simple constructor call:
-
-```typescript
-import { ContainerModule, LocationModule, IdentityModule } from '@grabjs/superapp-sdk';
-
-// Initialize modules
-const container = new ContainerModule();
-const location = new LocationModule();
-const identity = new IdentityModule();
-```
-
-### Handling Responses
-
-All SDK methods return a standardized response with HTTP-style status codes:
-
-```typescript
-import { CameraModule } from '@grabjs/superapp-sdk';
-
-const camera = new CameraModule();
-const response = await camera.scanQRCode({ title: 'Scan Payment QR' });
-
-switch (response.status_code) {
-  case 200:
-    // Successfully scanned - result contains the QR code data
-    console.log('QR Code scanned:', response.result.qrCode);
-    break;
-  case 204:
-    // User cancelled the scanning operation
-    console.log('Scanning cancelled');
-    break;
-  case 400:
-    // Bad request - invalid request parameters
-    console.error('Invalid request:', response.error);
-    break;
-  case 403:
-    // Camera permission not granted to the Grab app
-    console.error('Camera permission denied:', response.error);
-    break;
-  case 501:
-    // Not implemented - not running in Grab app
-    console.error('Requires Grab SuperApp environment');
-    break;
-  default:
-    console.error('Unexpected error:', response);
-}
-```
-
-### Working with Streams
-
-Some modules provide streaming methods for real-time data:
-
-```typescript
-import { LocationModule } from '@grabjs/superapp-sdk';
-
-const location = new LocationModule();
-
-// Subscribe to location updates
-const stream = location.observeLocationChange();
-
-const subscription = stream.subscribe({
-  next: (response) => {
-    if (response.status_code === 200) {
-      console.log('Location:', response.result);
-    }
-  },
-  complete: () => {
-    console.log('Stream ended');
-  },
-});
-
-// Unsubscribe when done
-subscription.unsubscribe();
-```
-
 ## Available Modules
 
-- **[ContainerModule](https://grab.github.io/superapp-sdk/classes/ContainerModule.html)** — Control the WebView container UI and lifecycle (header, loading indicators, analytics, connection verification)
-
-- **[IdentityModule](https://grab.github.io/superapp-sdk/classes/IdentityModule.html)** — Authenticate users via GrabID OAuth2/OIDC with PKCE support
-
-- **[LocationModule](https://grab.github.io/superapp-sdk/classes/LocationModule.html)** — Access device location services and subscribe to location updates
-
-- **[StorageModule](https://grab.github.io/superapp-sdk/classes/StorageModule.html)** — Persist key-value data locally with type-safe storage
-
 - **[CameraModule](https://grab.github.io/superapp-sdk/classes/CameraModule.html)** — Access device camera capabilities for QR code scanning
 
 - **[CheckoutModule](https://grab.github.io/superapp-sdk/classes/CheckoutModule.html)** — Trigger native checkout flows for payment processing
 
+- **[ContainerModule](https://grab.github.io/superapp-sdk/classes/ContainerModule.html)** — Control the WebView container UI and lifecycle (header, loading indicators, analytics, connection verification)
+
 - **[DeviceCapabilityModule](https://grab.github.io/superapp-sdk/classes/DeviceCapabilityModule.html)** — Query device hardware capabilities
 
 - **[FileModule](https://grab.github.io/superapp-sdk/classes/FileModule.html)** — Handle file operations including downloading from remote URLs
 
+- **[IdentityModule](https://grab.github.io/superapp-sdk/classes/IdentityModule.html)** — Authenticate users via GrabID OAuth2/OIDC with PKCE support
+
 - **[LocaleModule](https://grab.github.io/superapp-sdk/classes/LocaleModule.html)** — Access device locale and localization settings
 
+- **[LocationModule](https://grab.github.io/superapp-sdk/classes/LocationModule.html)** — Access device location services and subscribe to location updates
+
 - **[MediaModule](https://grab.github.io/superapp-sdk/classes/MediaModule.html)** — Handle media playback including DRM-protected content
 
 - **[PlatformModule](https://grab.github.io/superapp-sdk/classes/PlatformModule.html)** — Access platform information and navigation controls
@@ -139,56 +38,16 @@ subscription.unsubscribe();
 
 - **[ScopeModule](https://grab.github.io/superapp-sdk/classes/ScopeModule.html)** — Manage permission scopes from GrabID
 
-- **[SystemWebViewKitModule](https://grab.github.io/superapp-sdk/classes/SystemWebViewKitModule.html)** — Handle system WebView operations and external browser redirections
+- **[SplashScreenModule](https://grab.github.io/superapp-sdk/classes/SplashScreenModule.html)** — Control the native splash/loading screen
 
-- **[UserAttributesModule](https://grab.github.io/superapp-sdk/classes/UserAttributesModule.html)** — Access user attribute data
-
-> **Important:** Always call `ScopeModule.reloadScopes()` after an OAuth redirect to load the latest permissions from GrabID. Without this, module methods may return 403 errors even when permissions have been granted.
-
-## Response Status Codes
-
-The SDK uses HTTP-style status codes for all responses:
-
-| Code  | Type              | Description                                         |
-| ----- | ----------------- | --------------------------------------------------- |
-| `200` | OK                | Request successful, `result` contains response data |
-| `204` | No Content        | Request successful, no data returned                |
-| `302` | Redirect          | OAuth redirect in progress                          |
-| `400` | Bad Request       | Invalid request parameters                          |
-| `401` | Unauthorized      | Authentication required                             |
-| `403` | Forbidden         | Insufficient permissions for this operation         |
-| `404` | Not Found         | Resource not found                                  |
-| `424` | Failed Dependency | Underlying native request failed                    |
-| `426` | Upgrade Required  | Requires newer Grab app version                     |
-| `500` | Internal Error    | Unexpected SDK error                                |
-| `501` | Not Implemented   | Method requires Grab SuperApp environment           |
-
-## Type Guards
-
-The SDK provides type guards for response validation:
-
-```typescript
-import { isSuccess, isErrorResponse, isClientError, isServerError } from '@grabjs/superapp-sdk';
-
-const response = await someModule.someMethod();
-
-if (isSuccess(response)) {
-  // TypeScript knows response.result is available
-  console.log(response.result);
-}
-
-if (isErrorResponse(response)) {
-  // TypeScript knows response.error is available
-  console.error(response.error);
-}
-```
-
-## Best Practices
+- **[StorageModule](https://grab.github.io/superapp-sdk/classes/StorageModule.html)** — Persist key-value data locally with type-safe storage
 
-2. **Handle all status codes** in your switch statements, including unexpected ones.
+- **[SystemWebViewKitModule](https://grab.github.io/superapp-sdk/classes/SystemWebViewKitModule.html)** — Handle system WebView operations and external browser redirections
 
-3. **Use type guards** for cleaner response handling and better type inference.
+- **[UserAttributesModule](https://grab.github.io/superapp-sdk/classes/UserAttributesModule.html)** — Access user attribute data
 
-4. **Call `reloadScopes()` when your MiniApp launches and after OAuth** before accessing protected resources.
+## Documentation
 
-5. **Unsubscribe from streams** when your component unmounts or you no longer need updates.
+- [Setup Guide](https://grab.github.io/superapp-sdk/documents/Setup.html) — installation, importing, environment requirements
+- [Core Concepts](https://grab.github.io/superapp-sdk/documents/Core_Concepts.html) — response pattern, status codes, type guards
+- [Integration Guide](https://grab.github.io/superapp-sdk/documents/Integration_Guide.html) — initialization sequence, permission handling, navigation