Skip to content

grab/superapp-sdk / skills

grabjs-superapp-sdk

Verified

API reference for `@grabjs/superapp-sdk`. Use when building a MiniApp that runs in the Grab SuperApp WebView and needs to call native features (camera, payments, authorization, authentication, permission, location, device storage, container UI customization) via the Grab `JSBridge`. Keywords: miniapp, webview, android, ios, jsbridge, grab, superapp.

references/modules/LocationModule.md

View on GitHub
# LocationModule

## API Reference

SDK module for accessing device location services via `JSBridge`.

| Method | Returns | Description |
| :--- | :--- | :--- |
| `getCoordinate()` | `Promise<GetCoordinateResponse>` | Get the current geographic coordinates of the device. |
| `getCountryCode()` | `Promise<GetCountryCodeResponse>` | Get the country code based on the device's current location. |
| `observeLocationChange()` | `ObserveLocationChangeResponse` | Subscribe to location change updates from the device. |

## `getCoordinate`

Get the current geographic coordinates of the device.

**OAuth Scope:** mobile.geolocation

**Signature:** `getCoordinate(): Promise<GetCoordinateResponse>`

This method can return the following `status_code` values:
- `200` (OK): Coordinates retrieved successfully. The `result` contains GetCoordinateResult.
- `403` (Forbidden): Client is not authorized to access location data.
- `424` (Failed Dependency): Dependency error occurred while retrieving coordinates.
- `500` (Internal Server Error): An unexpected error occurred.
- `501` (Not Implemented): Requires Grab app environment.

```typescript
import { LocationModule, isSuccess, isError } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Get current coordinates
const response = await location.getCoordinate();

// Handle the response
if (isSuccess(response)) {
  console.log('Coordinates:', response.result.latitude, response.result.longitude);
} else if (isError(response)) {
  switch (response.status_code) {
    case 403:
      console.log('No permission to access location');
      // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
      break;
    default:
      console.error(`Error ${response.status_code}: ${response.error}`);
  }
} else {
  console.error('Unhandled response');
}
```

## `getCountryCode`

Get the country code based on the device's current location.

**OAuth Scope:** mobile.geolocation

**Signature:** `getCountryCode(): Promise<GetCountryCodeResponse>`

This method can return the following `status_code` values:
- `200` (OK): Country code retrieved successfully. The `result` contains GetCountryCodeResult.
- `204` (No Content): Country code not available.
- `403` (Forbidden): Client is not authorized to access location data.
- `424` (Failed Dependency): Dependency error occurred while resolving country code.
- `500` (Internal Server Error): An unexpected error occurred.
- `501` (Not Implemented): Requires Grab app environment.

```typescript
import { LocationModule, isSuccess, isError } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Get country code
const response = await location.getCountryCode();

// Handle the response
if (isSuccess(response)) {
  console.log('Country code:', response.result);
} else if (isError(response)) {
  switch (response.status_code) {
    case 403:
      console.log('No permission to access location');
      // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
      break;
    default:
      console.error(`Error ${response.status_code}: ${response.error}`);
  }
} else {
  console.error('Unhandled response');
}
```

## `observeLocationChange`

Subscribe to location change updates from the device.

**OAuth Scope:** mobile.geolocation

**Signature:** `observeLocationChange(): ObserveLocationChangeResponse`

This stream can emit the following `status_code` values:
- `200` (OK): Stream emitted a location update. The `result` contains GetCoordinateResult.
- `400` (Bad Request): Stream emitted an invalid request error.
- `403` (Forbidden): Stream emitted an authorization error.
- `424` (Failed Dependency): Stream emitted a dependency error.
- `500` (Internal Server Error): Stream emitted an unexpected error.
- `501` (Not Implemented): Requires Grab app environment.

```typescript
import { LocationModule, isSuccess, isError } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Subscribe to location changes
const subscription = location.observeLocationChange().subscribe({
  next: (response) => {
    if (isSuccess(response)) {
      console.log('Location updated:', response.result.latitude, response.result.longitude);
    } else if (isError(response)) {
      switch (response.status_code) {
        case 403:
          console.log('No permission to access location');
          // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
          break;
        default:
          console.error(`Error ${response.status_code}: ${response.error}`);
      }
    }
  },
  complete: () => console.log('Location stream completed')
});

// Later, to stop receiving updates:
subscription.unsubscribe();
```
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall