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

package/api-reference/markdown/type-aliases/BridgeStreamHandlers.md

@@ -1,25 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / BridgeStreamHandlers
-
-# Type Alias: BridgeStreamHandlers\<Codes, T\>
-
-> **BridgeStreamHandlers**\<`Codes`, `T`\> = `Readonly`\<\{ `complete?`: () => `unknown`; `next?`: (`data`: [`BridgeResponse`](BridgeResponse.md)\<`Codes`, `T`\>) => `unknown`; \}\>
-
-Callbacks for handling stream events.
-
-## Type Parameters
-
-### Codes
-
-`Codes` *extends* [`BridgeStatusCode`](BridgeStatusCode.md) = [`BridgeStatusCode`](BridgeStatusCode.md)
-
-The status codes that can be emitted by the stream.
-
-### T
-
-`T` = `void`
-
-The type of data emitted by the stream.
-
-## Remarks
-
-Pass these to `subscribe()` to receive data via `next` and completion via `complete`.

package/api-reference/markdown/type-aliases/BridgeSuccessResponse.md

@@ -1,14 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / BridgeSuccessResponse
-
-# Type Alias: BridgeSuccessResponse\<T\>
-
-> **BridgeSuccessResponse**\<`T`\> = [`ResponseStatusCode200`](ResponseStatusCode200.md)\<`T`\> \| [`ResponseStatusCode204`](ResponseStatusCode204.md)
-
-Union type representing all successful JSBridge responses.
-Includes status codes 200 (with result data) and 204 (no content).
-
-## Type Parameters
-
-### T
-
-`T`

package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResponse.md

@@ -1,18 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ClearAuthorizationArtifactsResponse
-
-# Type Alias: ClearAuthorizationArtifactsResponse
-
-> **ClearAuthorizationArtifactsResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204`, [`ClearAuthorizationArtifactsResult`](ClearAuthorizationArtifactsResult.md)\>
-
-Response when clearing stored authorization artifacts.
-
-## Remarks
-
-This response returns status code `204` when artifacts are successfully cleared.
-
-## Example
-
-**Success response (204):**
-```typescript
-{ status_code: 204 }
-```

package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ClearAuthorizationArtifactsResult
-
-# Type Alias: ClearAuthorizationArtifactsResult
-
-> **ClearAuthorizationArtifactsResult** = `void`
-
-Result object for clearing authorization artifacts.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/CloseResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / CloseResponse
-
-# Type Alias: CloseResponse
-
-> **CloseResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`CloseResult`](CloseResult.md)\>
-
-Response when closing the container.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Container closed successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/CloseResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / CloseResult
-
-# Type Alias: CloseResult
-
-> **CloseResult** = `void`
-
-Result when closing the container.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/DRMContentConfig.md

@@ -1,34 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DRMContentConfig
-
-# Type Alias: DRMContentConfig
-
-> **DRMContentConfig** = `Record`\<`string`, `unknown`\>
-
-DRM content configuration for playback.
-
-## Remarks
-
-Configuration object containing DRM license information, content URLs, and playback settings.
-The exact structure depends on the DRM provider (e.g., FairPlay, Widevine).
-
-## Examples
-
-**Widevine DRM configuration:**
-```typescript
-{
-  contentId: 'movie-123',
-  licenseUrl: 'https://license.example.com/widevine',
-  contentUrl: 'https://cdn.example.com/video.mp4',
-  headers: { 'Authorization': 'Bearer token123' }
-}
-```
-
-**FairPlay DRM configuration:**
-```typescript
-{
-  assetId: 'content-456',
-  certificateUrl: 'https://fairplay.example.com/cert',
-  licenseUrl: 'https://fairplay.example.com/license',
-  contentUrl: 'https://cdn.example.com/video.m3u8'
-}
-```

package/api-reference/markdown/type-aliases/DRMPlaybackEvent.md

@@ -1,43 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DRMPlaybackEvent
-
-# Type Alias: DRMPlaybackEvent
-
-> **DRMPlaybackEvent** = \{ `data?`: `Record`\<`string`, `unknown`\>; `eventType`: `"started"` \| `"paused"` \| `"ended"` \| `"error"`; \}
-
-Result object for DRM playback events.
-
-## Examples
-
-**Playback started event:**
-```typescript
-{ eventType: 'started' }
-```
-
-**Playback paused event:**
-```typescript
-{ eventType: 'paused' }
-```
-
-**Playback error event:**
-```typescript
-{
-  eventType: 'error',
-  data: { errorCode: 'DRM_LICENSE_ERROR', message: 'License expired' }
-}
-```
-
-## Properties
-
-### data?
-
-> `optional` **data**: `Record`\<`string`, `unknown`\>
-
-Additional event data as key-value pairs.
-
-***
-
-### eventType
-
-> **eventType**: `"started"` \| `"paused"` \| `"ended"` \| `"error"`
-
-The type of playback event.

package/api-reference/markdown/type-aliases/DownloadFileRequest.md

@@ -1,32 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DownloadFileRequest
-
-# Type Alias: DownloadFileRequest
-
-> **DownloadFileRequest** = \{ `fileName`: `string`; `fileUrl`: `string`; \}
-
-Request parameters for downloading a file via native bridge.
-
-## Example
-
-```typescript
-{
-  fileUrl: 'https://example.com/report.pdf',
-  fileName: 'report.pdf'
-}
-```
-
-## Properties
-
-### fileName
-
-> **fileName**: `string`
-
-The desired name for the downloaded file.
-
-***
-
-### fileUrl
-
-> **fileUrl**: `string`
-
-The URL of the file to download.

package/api-reference/markdown/type-aliases/DownloadFileResponse.md

@@ -1,48 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DownloadFileResponse
-
-# Type Alias: DownloadFileResponse
-
-> **DownloadFileResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204` \| `400` \| `500` \| `501`, [`DownloadFileResult`](DownloadFileResult.md)\>
-
-Response when requesting a native file download.
-
-## Remarks
-
-This response can have the following status codes:
-- `204`: File downloaded successfully.
-- `400`: Invalid request parameters such as invalid file URL, invalid domain, or missing file name.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (204):**
-```typescript
-{
-  status_code: 204
-}
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Invalid request'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/DownloadFileResult.md

@@ -1,11 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DownloadFileResult
-
-# Type Alias: DownloadFileResult
-
-> **DownloadFileResult** = `void`
-
-Result data structure for file download operations.
-
-## Remarks
-
-This is a void result type as successful downloads return status code 204 with no content.

package/api-reference/markdown/type-aliases/ErrorResponse.md

@@ -1,32 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ErrorResponse
-
-# Type Alias: ErrorResponse\<Code\>
-
-> **ErrorResponse**\<`Code`\> = \{ `error`: `string`; `status_code`: `Code`; \}
-
-Generic error response shape with a specific status code.
-Used as the base for all error response types (4xx and 5xx).
-
-## Type Parameters
-
-### Code
-
-`Code` *extends* `number`
-
-The HTTP status code (e.g., 400, 401, 500)
-
-## Properties
-
-### error
-
-> **error**: `string`
-
-Error message if the call failed
-
-***
-
-### status\_code
-
-> **status\_code**: `Code`
-
-HTTP-style status code indicating the outcome of the JSBridge method call

package/api-reference/markdown/type-aliases/FetchEmailResponse.md

@@ -1,58 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / FetchEmailResponse
-
-# Type Alias: FetchEmailResponse
-
-> **FetchEmailResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `426` \| `500` \| `501`, [`FetchEmailResult`](FetchEmailResult.md)\>
-
-Response when fetching the user's email.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Email fetched successfully. The `result` contains the email address.
-- `400`: Invalid request - the request was malformed.
-- `426`: Upgrade Required - feature requires Grab app version 5.399 or above.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{
-  status_code: 200,
-  result: { email: 'user@example.com' }
-}
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Invalid request'
-}
-```
-
-**Upgrade Required response (426):**
-```typescript
-{
-  status_code: 426,
-  error: 'Upgrade Required: This method requires Grab app version 5.399.0 or above on iOS'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/FetchEmailResult.md

@@ -1,21 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / FetchEmailResult
-
-# Type Alias: FetchEmailResult
-
-> **FetchEmailResult** = \{ `email`: `string`; \}
-
-Result object containing the user's email address.
-
-## Example
-
-```typescript
-{ email: 'user@example.com' }
-```
-
-## Properties
-
-### email
-
-> **email**: `string`
-
-The user's email address.

package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResponse.md

@@ -1,42 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetAuthorizationArtifactsResponse
-
-# Type Alias: GetAuthorizationArtifactsResponse
-
-> **GetAuthorizationArtifactsResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `204` \| `400`, [`GetAuthorizationArtifactsResult`](GetAuthorizationArtifactsResult.md)\>
-
-Response when retrieving stored authorization artifacts.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: All artifacts present. The `result` contains the PKCE artifacts needed for token exchange.
-- `204`: No artifacts yet - authorization has not been initiated.
-- `400`: Inconsistent state - possible data corruption in storage.
-
-## Examples
-
-**Success response (200) - all artifacts present:**
-```typescript
-{
-  status_code: 200,
-  result: {
-    state: 'csrf-state-xyz789',
-    codeVerifier: 'code-verifier-123',
-    nonce: 'nonce-abc',
-    redirectUri: 'https://your-app.com/callback'
-  }
-}
-```
-
-**No content response (204) - no artifacts:**
-```typescript
-{ status_code: 204 }
-```
-
-**Bad request response (400) - inconsistent state:**
-```typescript
-{
-  status_code: 400,
-  error: 'Inconsistent authorization artifacts in storage'
-}
-```

package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResult.md

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetAuthorizationArtifactsResult
-
-# Type Alias: GetAuthorizationArtifactsResult
-
-> **GetAuthorizationArtifactsResult** = \{ `codeVerifier`: `string`; `nonce`: `string`; `redirectUri`: `string`; `state`: `string`; \}
-
-Result object containing the stored PKCE authorization artifacts.
-These are used to complete the OAuth2 authorization code exchange.
-
-## Examples
-
-**All artifacts present:**
-```typescript
-{
-  state: 'csrf-state-xyz789',
-  codeVerifier: 'code-verifier-123',
-  nonce: 'nonce-abc',
-  redirectUri: 'https://your-app.com/callback'
-}
-```
-
-**No artifacts (null):**
-```typescript
-null
-```
-
-## Properties
-
-### codeVerifier
-
-> **codeVerifier**: `string`
-
-The code verifier for PKCE.
-
-***
-
-### nonce
-
-> **nonce**: `string`
-
-The nonce used in the authorization request.
-
-***
-
-### redirectUri
-
-> **redirectUri**: `string`
-
-The redirect URI used in the authorization request.
-
-***
-
-### state
-
-> **state**: `string`
-
-The state parameter used in the authorization request.

package/api-reference/markdown/type-aliases/GetBooleanRequest.md

@@ -1,21 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetBooleanRequest
-
-# Type Alias: GetBooleanRequest
-
-> **GetBooleanRequest** = \{ `key`: `string`; \}
-
-Request parameters for getting a boolean value from storage.
-
-## Example
-
-```typescript
-{ key: 'isDarkMode' }
-```
-
-## Properties
-
-### key
-
-> **key**: `string`
-
-The key to retrieve the value for.

package/api-reference/markdown/type-aliases/GetBooleanResponse.md

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetBooleanResponse
-
-# Type Alias: GetBooleanResponse
-
-> **GetBooleanResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`GetBooleanResult`](GetBooleanResult.md)\>
-
-Response when getting a boolean value.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Value retrieved successfully. The `result` contains the boolean value or null if not found.
-- `400`: Missing required parameters - key not provided.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200) - value exists:**
-```typescript
-{
-  status_code: 200,
-  result: { value: true }
-}
-```
-
-**Success response (200) - value not found:**
-```typescript
-{
-  status_code: 200,
-  result: { value: null }
-}
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Missing required parameters'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/GetBooleanResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetBooleanResult
-
-# Type Alias: GetBooleanResult
-
-> **GetBooleanResult** = \{ `value`: `boolean` \| `null`; \}
-
-Result object containing the boolean value.
-
-## Examples
-
-**Value exists:**
-```typescript
-{ value: true }
-```
-
-**Value not found:**
-```typescript
-{ value: null }
-```
-
-## Properties
-
-### value
-
-> **value**: `boolean` \| `null`
-
-The stored boolean value, or null if not found.

package/api-reference/markdown/type-aliases/GetCoordinateResponse.md

@@ -1,49 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetCoordinateResponse
-
-# Type Alias: GetCoordinateResponse
-
-> **GetCoordinateResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `424` \| `500` \| `501`, [`GetCoordinateResult`](GetCoordinateResult.md)\>
-
-Response when getting the device coordinates.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Coordinates retrieved successfully. The `result` contains latitude and longitude.
-- `424`: GeoKit error - location services unavailable or permission denied.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200) - Singapore coordinates:**
-```typescript
-{
-  status_code: 200,
-  result: { lat: 1.3521, lng: 103.8198 }
-}
-```
-
-**Failed dependency response (424) - GeoKit error:**
-```typescript
-{
-  status_code: 424,
-  error: 'GeoKit error'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/GetCoordinateResult.md

@@ -1,29 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetCoordinateResult
-
-# Type Alias: GetCoordinateResult
-
-> **GetCoordinateResult** = \{ `lat`: `number`; `lng`: `number`; \}
-
-Result object containing the geographic coordinates.
-
-## Example
-
-```typescript
-{ lat: 1.3521, lng: 103.8198 }
-```
-
-## Properties
-
-### lat
-
-> **lat**: `number`
-
-Latitude in degrees
-
-***
-
-### lng
-
-> **lng**: `number`
-
-Longitude in degrees