@grabjs/superapp-sdk

Overview

The SuperApp SDK enables web developers to build MiniApps that run within the Grab SuperApp WebView. It provides a type-safe bridge for communication between web applications and native Android/iOS capabilities.

Each module encapsulates a specific domain of functionality, offering strongly-typed APIs with consistent response patterns.

Key Features

• Type-Safe APIs — Full TypeScript support with comprehensive type definitions
• Modular Architecture — Import only the modules you need
• Consistent Response Pattern — All methods return standardized bridge responses with HTTP-style status codes
• Streaming Support — Real-time data streams for location updates and media events
• Automatic Fallbacks — Graceful degradation when native features are unavailable

Available Modules

• CameraModule — Access device camera capabilities for QR code scanning

• CheckoutModule — Trigger native checkout flows for payment processing

• ContainerModule — Control the WebView container UI and lifecycle (header, loading indicators, analytics, connection verification)

• DeviceModule — Query device hardware capabilities

• FileModule — Handle file operations including downloading from remote URLs

• IdentityModule — Authenticate users via GrabID OAuth2/OIDC with PKCE support

• LocaleModule — Access device locale and localization settings

• LocationModule — Access device location services and subscribe to location updates

• MediaModule — Handle media playback including DRM-protected content

• PlatformModule — Access platform information and navigation controls

• ProfileModule — Access user profile information including email

• ScopeModule — Manage permission scopes from GrabID

• SplashScreenModule — Control the native splash/loading screen

• StorageModule — Persist key-value data locally with type-safe storage

• SystemWebViewKitModule — Handle system WebView operations and external browser redirections

• UserAttributesModule — Access user attribute data

Documentation

• Setup Guide — installation, importing, environment requirements
• Core Concepts — response pattern, status codes, type guards
• Integration Guide — initialization sequence, permission handling, navigation
• AI-Assisted Development — using AI skills for faster development