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

package/api-reference/markdown/classes/SystemWebViewKitModule.md

@@ -1,177 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SystemWebViewKitModule
-
-# Class: SystemWebViewKitModule
-
-JSBridge module for opening URLs in the device's system browser.
-
-## Remarks
-
-Allows MiniApps to redirect users to external content using the native system webview.
-This code must run on the Grab SuperApp's webview to function correctly.
-
-## Examples
-
-**ES Module:**
-```typescript
-import { SystemWebViewKitModule } from '@grabjs/superapp-sdk';
-const webViewKit = new SystemWebViewKitModule();
-```
-
-**CDN (UMD):**
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const webViewKit = new SuperAppSDK.SystemWebViewKitModule();
-</script>
-```
-
-## No Inherit Doc
-
-## Extends
-
-- [`BaseModule`](BaseModule.md)
-
-## Constructors
-
-### Constructor
-
-> **new SystemWebViewKitModule**(): `SystemWebViewKitModule`
-
-#### Returns
-
-`SystemWebViewKitModule`
-
-#### Overrides
-
-[`BaseModule`](BaseModule.md).[`constructor`](BaseModule.md#constructor)
-
-## Methods
-
-### invoke()
-
-> **invoke**\<`T`\>(`options`: [`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>): `Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
-
-Invokes a JSBridge method with optional app validation and response transformation.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### options
-
-[`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>
-
-The invoke options including method name, params, validation, and transformation.
-
-#### Returns
-
-`Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
-
-A promise resolving to the JSBridge response.
-
-#### Remarks
-
-- Always checks if running in Grab app (returns 501 if not).
-- When `isSupported` returns false, returns 426 (Upgrade Required).
-- When `transformResponse` is provided, applies it to successful responses.
-- All errors are reported via the `status_code` field; this method never rejects.
-- For streaming methods, use `invokeStream` instead.
-
-#### Inherited from
-
-[`BaseModule`](BaseModule.md).[`invoke`](BaseModule.md#invoke)
-
-***
-
-### invokeStream()
-
-> **invokeStream**\<`T`\>(`options`: [`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>): [`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-Invokes a JSBridge streaming method that returns a `BridgeStream`.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### options
-
-[`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>
-
-The invoke options including method name, params, and validation.
-
-#### Returns
-
-[`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-A `BridgeStream` for receiving continuous data from the JSBridge.
-
-#### Remarks
-
-- Always checks if running in Grab app (returns 501 error response if not).
-- When `isSupported` returns false, returns 426 error response.
-- Returns a `BridgeStream` that can be subscribed to or awaited for the first value.
-- All errors are reported via error responses in the stream; this method never rejects.
-
-#### Inherited from
-
-[`BaseModule`](BaseModule.md).[`invokeStream`](BaseModule.md#invokestream)
-
-***
-
-### redirectToSystemWebView()
-
-> **redirectToSystemWebView**(`request`: [`RedirectToSystemWebViewRequest`](../type-aliases/RedirectToSystemWebViewRequest.md)): `Promise`\<[`RedirectToSystemWebViewResponse`](../type-aliases/RedirectToSystemWebViewResponse.md)\>
-
-Opens a URL in the device's system web browser or web view.
-
-#### Parameters
-
-##### request
-
-[`RedirectToSystemWebViewRequest`](../type-aliases/RedirectToSystemWebViewRequest.md)
-
-The URL to open in the system web view.
-
-#### Returns
-
-`Promise`\<[`RedirectToSystemWebViewResponse`](../type-aliases/RedirectToSystemWebViewResponse.md)\>
-
-Confirmation of whether the redirect to system web view was successful.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the system web view kit module
-const systemWebViewKitModule = new SystemWebViewKitModule();
-
-// Open a URL in system web view
-const response = await systemWebViewKitModule.redirectToSystemWebView({
-  url: 'https://www.example.com'
-});
-
-switch (response.status_code) {
-  case 200:
-    console.log('Redirect initiated successfully');
-    break;
-  case 400:
-    console.log('Could not redirect:', response.error);
-    break;
-  case 424:
-    console.log('Dependency error:', response.error);
-    break;
-  case 501:
-    console.log('Not in Grab app:', response.error);
-    break;
-  default:
-    console.log('Unexpected status code:', response);
-}
-```

package/api-reference/markdown/classes/UserAttributesModule.md

@@ -1,164 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / UserAttributesModule
-
-# Class: UserAttributesModule
-
-JSBridge module for reading user-related attributes from native code.
-
-## Remarks
-
-Provides access to user and traveller attributes exposed by the native Grab app bridge.
-This code must run on the Grab SuperApp's webview to function correctly.
-
-## Examples
-
-**ES Module:**
-```typescript
-import { UserAttributesModule } from '@grabjs/superapp-sdk';
-const userAttributesModule = new UserAttributesModule();
-```
-
-**CDN (UMD):**
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const userAttributesModule = new SuperAppSDK.UserAttributesModule();
-</script>
-```
-
-## No Inherit Doc
-
-## Extends
-
-- [`BaseModule`](BaseModule.md)
-
-## Constructors
-
-### Constructor
-
-> **new UserAttributesModule**(): `UserAttributesModule`
-
-#### Returns
-
-`UserAttributesModule`
-
-#### Overrides
-
-[`BaseModule`](BaseModule.md).[`constructor`](BaseModule.md#constructor)
-
-## Methods
-
-### getSelectedTravelDestination()
-
-> **getSelectedTravelDestination**(): `Promise`\<[`GetSelectedTravelDestinationResponse`](../type-aliases/GetSelectedTravelDestinationResponse.md)\>
-
-Returns the currently selected travel destination as a lowercase ISO 3166-1 alpha-2 country code.
-
-#### Returns
-
-`Promise`\<[`GetSelectedTravelDestinationResponse`](../type-aliases/GetSelectedTravelDestinationResponse.md)\>
-
-The selected travel destination lowercase ISO 3166-1 alpha-2 country code when available.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the user attributes module
-const userAttributesModule = new UserAttributesModule();
-
-// Read the selected travel destination
-const response = await userAttributesModule.getSelectedTravelDestination();
-
-switch (response.status_code) {
-  case 200:
-    console.log('Selected travel destination code:', response.result);
-    break;
-  case 204:
-    console.log('Selected travel destination is not available');
-    break;
-  case 501:
-    console.log('Not in Grab app:', response.error);
-    break;
-  default:
-    console.log('Unexpected status code:', response);
-}
-```
-
-***
-
-### invoke()
-
-> **invoke**\<`T`\>(`options`: [`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>): `Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
-
-Invokes a JSBridge method with optional app validation and response transformation.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### options
-
-[`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>
-
-The invoke options including method name, params, validation, and transformation.
-
-#### Returns
-
-`Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
-
-A promise resolving to the JSBridge response.
-
-#### Remarks
-
-- Always checks if running in Grab app (returns 501 if not).
-- When `isSupported` returns false, returns 426 (Upgrade Required).
-- When `transformResponse` is provided, applies it to successful responses.
-- All errors are reported via the `status_code` field; this method never rejects.
-- For streaming methods, use `invokeStream` instead.
-
-#### Inherited from
-
-[`BaseModule`](BaseModule.md).[`invoke`](BaseModule.md#invoke)
-
-***
-
-### invokeStream()
-
-> **invokeStream**\<`T`\>(`options`: [`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>): [`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-Invokes a JSBridge streaming method that returns a `BridgeStream`.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### options
-
-[`InvokeOptions`](../interfaces/InvokeOptions.md)\<`T`\>
-
-The invoke options including method name, params, and validation.
-
-#### Returns
-
-[`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-A `BridgeStream` for receiving continuous data from the JSBridge.
-
-#### Remarks
-
-- Always checks if running in Grab app (returns 501 error response if not).
-- When `isSupported` returns false, returns 426 error response.
-- Returns a `BridgeStream` that can be subscribed to or awaited for the first value.
-- All errors are reported via error responses in the stream; this method never rejects.
-
-#### Inherited from
-
-[`BaseModule`](BaseModule.md).[`invokeStream`](BaseModule.md#invokestream)

package/api-reference/markdown/functions/isClientError.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / isClientError
-
-# Function: isClientError()
-
-> **isClientError**\<`T`\>(`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>): `response is BridgeClientError`
-
-Type guard to check if a JSBridge response is a client error (4xx status codes).
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### response
-
-[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-The JSBridge response to check
-
-## Returns
-
-`response is BridgeClientError`
-
-True if the response is a client error (400, 401, 403, 404, 424, 426), false otherwise
-
-## Example
-
-```typescript
-const response = await someBridgeMethod();
-if (isClientError(response)) {
-  // response is narrowed to BridgeClientError
-  console.error('Client error:', response.error);
-}
-```

package/api-reference/markdown/functions/isErrorResponse.md

@@ -1,40 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / isErrorResponse
-
-# Function: isErrorResponse()
-
-> **isErrorResponse**\<`T`\>(`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>): `response is BridgeError`
-
-Type guard to check if a JSBridge response is an error (4xx or 5xx status codes).
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### response
-
-[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-The JSBridge response to check
-
-## Returns
-
-`response is BridgeError`
-
-True if the response is any error (4xx or 5xx), false otherwise
-
-## Example
-
-```typescript
-const response = await someBridgeMethod();
-if (isErrorResponse(response)) {
-  // response is narrowed to BridgeError
-  console.error('Error:', response.error);
-} else {
-  // response is successful or redirect
-  console.log('Success!');
-}
-```

package/api-reference/markdown/functions/isRedirection.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / isRedirection
-
-# Function: isRedirection()
-
-> **isRedirection**\<`T`\>(`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>): `response is ResponseStatusCode302`
-
-Type guard to check if a JSBridge response is a redirect (status code 302).
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### response
-
-[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-The JSBridge response to check
-
-## Returns
-
-`response is ResponseStatusCode302`
-
-True if the response is a redirect (302), false otherwise
-
-## Example
-
-```typescript
-const response = await someBridgeMethod();
-if (isRedirection(response)) {
-  // response is narrowed to BridgeRedirection
-  console.log('Redirecting...');
-}
-```

package/api-reference/markdown/functions/isServerError.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / isServerError
-
-# Function: isServerError()
-
-> **isServerError**\<`T`\>(`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>): `response is BridgeServerError`
-
-Type guard to check if a JSBridge response is a server error (5xx status codes).
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### response
-
-[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-The JSBridge response to check
-
-## Returns
-
-`response is BridgeServerError`
-
-True if the response is a server error (500, 501), false otherwise
-
-## Example
-
-```typescript
-const response = await someBridgeMethod();
-if (isServerError(response)) {
-  // response is narrowed to BridgeServerError
-  console.error('Server error:', response.error);
-}
-```

package/api-reference/markdown/functions/isSuccess.md

@@ -1,39 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / isSuccess
-
-# Function: isSuccess()
-
-> **isSuccess**\<`T`\>(`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>): `response is BridgeSuccessResponse<T>`
-
-Type guard to check if a JSBridge response is successful (status codes 200 or 204).
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### response
-
-[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
-
-The JSBridge response to check
-
-## Returns
-
-`response is BridgeSuccessResponse<T>`
-
-True if the response is successful (200 or 204), false otherwise
-
-## Example
-
-```typescript
-const response = await someBridgeMethod();
-if (isSuccess(response)) {
-  // response is narrowed to BridgeSuccessResponse<T>
-  if (response.status_code === 200) {
-    console.log(response.result);
-  }
-}
-```