@grabjs/superapp-sdk 1.8.10 → 2.0.0-beta.7

package/docs/LocaleModule.md

@@ -1,51 +0,0 @@
-# LocaleModule
-
-## Description
-
-Will return current locale information
-
-## Supported Languages
-
-| Language          | Locale |
-| ----------------- | ------ |
-| English           | en     |
-| Indonesia         | id     |
-| Chinese           | zh     |
-| Malaysia          | ms     |
-| Thai              | th     |
-| Vietnamese        | vi     |
-| Burmese (Zawgyi)  | zg     |
-| Burmese (Unicode) | my     |
-| Khmer             | km     |
-
-## Methods
-
-### 1. Get language locale
-
-**Method name**: `getLanguageLocaleIdentifier`
-
-**Arguments**: `None`
-
-**Return type**
-
-| Type   | Description                            |
-| ------ | -------------------------------------- |
-| String | Locale identifier. Example: "en", "id" |
-
-**Code example**
-
-```javascript
-import { LocaleModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const localeModule = new LocaleModule()
-
-localeModule.getLanguageLocaleIdentifier({})
-  .then({ result, error }) => {
-    if (!!result) {
-      const locale = result;
-    } else if (!!error) {
-      // Some error happened. Use default language.
-    }
-  }
-```

package/docs/LocationModule.md

@@ -1,172 +0,0 @@
-# LocationModule
-
-## Description
-
-Will return current user position
-
-## Methods
-
-### 1. Get current user coordinate
-
-**Method name**: `getCoordinate`
-
-**Scopes to be requested**: `mobile.geolocation`
-
-**Arguments**: `None`
-
-**Return type**
-
-| Name      | Type   | Description                                                 |
-| --------- | ------ | ----------------------------------------------------------- |
-| latitude  | Double | Latitude is horizontal line described for earth coordinates |
-| longitude | Double | Longitude is vertical line described for earth coordinates  |
-
-**Code example**
-
-```javascript
-import { LocationModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const locationModule = new LocationModule()
-
-locationModule.getCoordinate({})
-  .then({ result, error }) => {
-    if (!!result) {
-      const { latitude, longitude } = result;
-    } else if (!!error) {
-      // Some error happened.
-    }
-  }
-```
-
-### 2. Stream current user coordinates
-
-**Method name**: `observeLocationChange`
-
-**Scopes to be requested**: `mobile.geolocation`
-
-**Arguments**: `None`
-
-**Return type**
-
-| Name      | Type   | Description                                                 |
-| --------- | ------ | ----------------------------------------------------------- |
-| latitude  | Double | Latitude is horizontal line described for earth coordinates |
-| longitude | Double | Longitude is vertical line described for earth coordinates  |
-
-**Code example**
-
-```javascript
-import { LocationModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const locationModule = new LocationModule();
-
-// Unsubscribe from this subscription to terminate the stream.
-const subscription = locationModule.observeLocationChange({}).subscribe({
-  next: ({ result, error }) => {
-    if (!!result) {
-      const { latitude, longitude } = result;
-    } else if (!!error) {
-      // Some error happened.
-    }
-  },
-  complete: () => {
-    // Completion logic for when the stream completes.
-  }
-});
-```
-
-### 3. Get current user country code
-
-**Method name**: `getCountryCode`
-
-**Scopes to be requested**: `mobile.geolocation`
-
-**Arguments**: `None`
-
-**Return type**
-
-| Name        | Type   | Description                    |
-| ----------- | ------ | ------------------------------ |
-| countryCode | String | country code (e.g., "SG", "ID", "MY") |
-
-**Code example**
-
-```javascript
-import { LocationModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const locationModule = new LocationModule()
-
-locationModule.getCountryCode({})
-  .then((response) => {
-    switch (response.status_code) {
-      case 200:
-        // Success - country code retrieved
-        console.log('Country code:', response.result);
-        break;
-      case 204:
-        // No result - location is undefined or might be uncovered by location service data
-        console.log('No result - location is undefined or uncovered by location service');
-        break;
-      case 403:
-        // Permission denied - mobile.geolocation scope not granted
-        console.log('Location access denied:', response.error);
-        break;
-      case 424:
-        // Location service has issue/unaccessible
-        console.log('Location service unavailable:', response.error);
-        break;
-      default:
-        // Handle other potential status codes
-        console.log('Error:', response.error);
-    }
-  });
-```
-
-## Response Format
-
-The location methods return an object with different structures based on the result:
-
-### Success Response (Status Code 200)
-```javascript
-{
-  "status_code": 200,
-  "result": "SG" // The country code (e.g., "SG", "ID", "MY")
-}
-```
-
-### No Result Response (Status Code 204)
-```javascript
-{
-  "status_code": 204
-  // No result property
-  // No error property
-}
-```
-
-### Error Response (Status Code 403)
-```javascript
-{
-  "status_code": 403,
-  "error": "Location access denied"
-  // No result property
-}
-```
-
-### Error Response (Status Code 424)
-```javascript
-{
-  "status_code": 424,
-  "error": "Determining country code from coordinates fails"
-  // No result property
-}
-```
-
-## Status Codes
-
-- `200`: Successfully retrieved country code
-- `204`: No result (location is undefined or uncovered by location service or in ocean area)
-- `403`: Location access denied (mobile.geolocation scope not granted)
-- `424`: Location service unavailable/unaccessible

package/docs/MediaModule.md

@@ -1,97 +0,0 @@
-# What is MediaModule ?
-
-`MediaModule` This module will open a media player
-
-## Methods
-
-### 1. To play DRM content
-
-#### Method name
-
-```javascript
-playDRMContent(data);
-```
-
-#### Params
-
-| Name | Type      | Description           |
-| ---- | --------- | --------------------- |
-| data | VideoData | Response from backend |
-
-#### VideoData
-
-| Name        | Type   | Description              |
-| ----------- | ------ | ------------------------ |
-| content     | url    | Content URL for playback |
-| certificate | url    | DRM certificate URL      |
-| license     | url    | DRM licence URL          |
-| titleId     | string | Playback item identifier |
-
-#### Return type
-
-A data stream emitting events on the video playback status.
-
-| Name     | Type   | Description                                    |
-| -------- | ------ | ---------------------------------------------- |
-| type     | string | Type of the event. Refer to the event types    |
-| titleId  | string | Playback item identifier                       |
-| length   | int    | Length of the video (in seconds)               |
-| position | int    | The current position of the video (in seconds) |
-
-The types of events are as follows:
-
-| EventType         | Description                           |
-| ----------------- | ------------------------------------- |
-| START_PLAYBACK    | Emitted when the video starts playing |
-| STOP_PLAYBACK     | Emitted when the video stops playing  |
-| PROGRESS_PLAYBACK | Emitted every 10 seconds              |
-
-#### Code example
-
-```javascript
-import { MediaModule } from '@grabjs/superapp-sdk';
-
-const mediaModule = new MediaModule();
-
-try {
-  // This is for backward compatibility, since older app
-  // versions do not support this syntax.
-  mediaModule
-    .playDRMContent({
-      content: 'content-url-here',
-      certificate: 'certificate-url-here',
-      license: 'license-url-here',
-      titleId: 'title-id-here'
-    })
-    .subscribe({
-      next: ({ result, error, status_code }) => {
-        if (!!result) {
-          const { type, titleId, length, position } = result;
-
-          // Do what we want with the data here.
-        } else if (!!error) {
-          // Handle error here.
-        }
-      },
-      complete: () => {
-        // Completion logic here when the stream stops.
-      }
-    });
-} catch (e) {
-  // Fallback to old way to ensure the video still plays.
-}
-```
-
-#### Response example
-
-```json
-{
-  "status_code": 200,
-  "result": {
-    "type": "PROGRESS_PLAYBACK",
-    "titleId": "2o23asdf1asd123",
-    "length": 3600,
-    "position": 1800
-  }
-}
-```

package/docs/PlatformModule.md

@@ -1,33 +0,0 @@
-# PlatformModule
-## Description
-
-PlatformKit provides API to navigate back to host application.
-
-## Methods
-### 1. Close the current and go back to host application
-
-**Method name**: `back`
-
-
-**Arguments**: `None`
-
-**Return type**
-
-`None`
-
-**Code example**
-```javascript
-import { PlatformModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const platformModule = new PlatformModule()
-
-platformModule.back({})
-  .then({ result, error }) => {
-    if (!!result) {
-      // There is a valid result.
-    } else if (!!error) {
-      // Some error happened.
-    }
-  }
-```

package/docs/ProfileModule.md

@@ -1,136 +0,0 @@
-# ProfileModule
-
-## Description
-
-The ProfileModule provides functionality related to user profile information.
-
-## Methods
-
-### 1. Fetch Email
-
-**Method name**: `fetchEmail`
-
-**Scopes to be requested**: `mobile.profile`
-
-**Description**
-
-This is used to fetch the verified email of the user. If the user does not have a verified email, the method will return a `status_code` of `204`.
-
-**Arguments**
-
-None
-
-**Return type**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| result | Object \| null | Result of the fetch email operation. Returns `null` if no verified email is found (204). |
-| error | String \| null | Error message if the operation fails |
-| status_code | Number | HTTP status code for the operation |
-
-**Result Object Properties**
-
-When `status_code` is `200`, the result object contains:
-
-| Property | Type | Description |
-| --- | --- | --- |
-| email | String | The verified email address of the user |
-
-**Status Codes**
-
-- **200**: Success, verified email found and returned in `result`
-- **204**: No verified email found for the user
-- **400**: Client error (e.g. invalid request)
-- **500**: Internal server error
-
-**Code example**
-
-```javascript
-import { ProfileModule } from "@grabjs/superapp-sdk";
-
-// Ideally, initialize this only once and reuse across app.
-const profileModule = new ProfileModule();
-
-const { result, error, status_code } = await profileModule.fetchEmail();
-
-if (status_code === 200 && result) {
-  console.log("User email:", result.email);
-} else if (status_code === 204) {
-  console.log("User does not have a verified email.");
-} else if (error) {
-  console.error("Fetch email error:", error);
-}
-```
-
-### 2. Verify Email
-
-**Method name**: `verifyEmail`
-
-**Scopes to be requested**: `mobile.profile`
-
-**Description**
-
-Trigger email capture bottom sheet and OTP verification. If the user closes the verify OTP bottom sheet, the method will return a `status_code` of `204`.
-
-Successful verification will also update the email address for the user on Grab.
-
-**Arguments**
-
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| request | Object | Yes | Request parameters for email verification |
-
-**Request Object Properties**
-
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| email | String | No | Email address for verification. Native bottom sheet will be displayed with this email address if not empty (User can edit before proceeding) |
-| skipUserInput | Boolean | No | If set to `true`, and email is not empty, trigger the verify OTP bottom sheet directly. |
-
-**Return type**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| result | Object \| null | Result of the verify email operation. Returns `null` if the user cancels (204). |
-| error | String \| null | Error message if the operation fails |
-| status_code | Number | HTTP status code for the operation |
-
-**Result Object Properties**
-
-When `status_code` is `200`, the result object contains:
-
-| Property | Type | Description |
-| --- | --- | --- |
-| email | String | The verified email address of the user |
-
-**Status Codes**
-
-- **200**: Success, email verified and returned in `result`
-- **204**: User closed the native bottom sheet
-- **400**: Client error (e.g. invalid email format)
-- **403**: Unauthorised
-- **500**: Internal server error
-
-**Code example**
-
-```javascript
-import { ProfileModule } from "@grabjs/superapp-sdk";
-
-// Ideally, initialize this only once and reuse across app.
-const profileModule = new ProfileModule();
-
-const request = {
-  email: "test@example.com",
-  skipUserInput: false
-};
-
-const { result, error, status_code } = await profileModule.verifyEmail(request);
-
-if (status_code === 200 && result) {
-  console.log("Verified email:", result.email);
-} else if (status_code === 204) {
-  console.log("User closed the bottom sheet.");
-} else if (error) {
-  console.error("Verify email error:", error);
-}
-```

package/docs/ScopeModule.md

@@ -1,68 +0,0 @@
-# ScopeModule
-
-## Description
-
-Access scope control related API.
-
-## Methods
-
-### 1. Check if current client has access to specific API
-
-**Method name**: `hasAccessTo`
-
-**Arguments**
-
-| Name   | Type   | Description        |
-| ------ | ------ | ------------------ |
-| module | String | Bridge module name |
-| method | String | Method name        |
-
-**Return type**
-
-`Boolean`
-
-**Code example**
-
-```javascript
-import { ScopeModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const scopeModule = new ScopeModule()
-
-scopeModule.hasAccessTo({ module, method })
-  .then({ result, error }) => {
-    if (!!result) {
-      // There is a valid result.
-    } else if (!!error) {
-      // Some error happened.
-    }
-  }
-```
-
-### 2. Request to reload consented scopes for current client
-
-**Method name**: `reloadScopes`
-
-**Arguments**: `None`
-
-**Return type**
-
-`Void`
-
-**Code example**
-
-```javascript
-import { ScopeModule } from '@grab/superapp-sdk';
-
-// Ideally, initialize this only one and reuse across app.
-const scopeModule = new ScopeModule()
-
-scopeModule.reloadScopes({})
-  .then({ status_code, error }) => {
-    if (`${status_code}`.startsWith('20')) {
-      // The operation succeeded.
-    } else if (!!error) {
-      // Some error happened.
-    }
-  }
-```