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

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

@@ -1,161 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / DeviceCapabilityModule
-
-# Class: DeviceCapabilityModule
-
-JSBridge module for querying native device capability information.
-
-## Remarks
-
-Provides access to device capability checks 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 { DeviceCapabilityModule } from '@grabjs/superapp-sdk';
-const deviceCapabilityModule = new DeviceCapabilityModule();
-```
-
-**CDN (UMD):**
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const deviceCapabilityModule = new SuperAppSDK.DeviceCapabilityModule();
-</script>
-```
-
-## No Inherit Doc
-
-## Extends
-
-- [`BaseModule`](BaseModule.md)
-
-## Constructors
-
-### Constructor
-
-> **new DeviceCapabilityModule**(): `DeviceCapabilityModule`
-
-#### Returns
-
-`DeviceCapabilityModule`
-
-#### 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)
-
-***
-
-### isEsimSupported()
-
-> **isEsimSupported**(): `Promise`\<[`IsEsimSupportedResponse`](../type-aliases/IsEsimSupportedResponse.md)\>
-
-Checks whether the current device supports eSIM.
-
-#### Returns
-
-`Promise`\<[`IsEsimSupportedResponse`](../type-aliases/IsEsimSupportedResponse.md)\>
-
-Whether eSIM is supported on the current device.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the device capability module
-const deviceCapabilityModule = new DeviceCapabilityModule();
-
-// Check eSIM support
-const response = await deviceCapabilityModule.isEsimSupported();
-
-switch (response.status_code) {
-  case 200:
-    console.log('eSIM supported:', response.result);
-    break;
-  case 501:
-    console.log('Not in Grab app:', response.error);
-    break;
-  default:
-    console.log('Unexpected status code:', response);
-}
-```

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

@@ -1,178 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / FileModule
-
-# Class: FileModule
-
-JSBridge module for downloading files to the user's device.
-
-## Remarks
-
-Initiates native file download handling in the Grab app using a file URL and file name.
-This code must run on the Grab SuperApp's webview to function correctly.
-
-## Examples
-
-**ES Module:**
-```typescript
-import { FileModule } from '@grabjs/superapp-sdk';
-const fileModule = new FileModule();
-```
-
-**CDN (UMD):**
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const fileModule = new SuperAppSDK.FileModule();
-</script>
-```
-
-## No Inherit Doc
-
-## Extends
-
-- [`BaseModule`](BaseModule.md)
-
-## Constructors
-
-### Constructor
-
-> **new FileModule**(): `FileModule`
-
-#### Returns
-
-`FileModule`
-
-#### Overrides
-
-[`BaseModule`](BaseModule.md).[`constructor`](BaseModule.md#constructor)
-
-## Methods
-
-### downloadFile()
-
-> **downloadFile**(`request`: [`DownloadFileRequest`](../type-aliases/DownloadFileRequest.md)): `Promise`\<[`DownloadFileResponse`](../type-aliases/DownloadFileResponse.md)\>
-
-Downloads a file via the native bridge.
-
-#### Parameters
-
-##### request
-
-[`DownloadFileRequest`](../type-aliases/DownloadFileRequest.md)
-
-File information, including URL and target file name.
-
-#### Returns
-
-`Promise`\<[`DownloadFileResponse`](../type-aliases/DownloadFileResponse.md)\>
-
-Download operation result.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the file module
-const fileModule = new FileModule();
-
-// Download the file
-const response = await fileModule.downloadFile({
-  fileUrl: 'https://example.com/report.pdf',
-  fileName: 'report.pdf',
-});
-
-switch (response.status_code) {
-  case 204:
-    console.log('File downloaded successfully');
-    break;
-  case 400:
-    console.log('Bad request:', response.error);
-    break;
-  case 500:
-    console.log('Internal server error:', response.error);
-    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/classes/IdentityModule.md

@@ -1,299 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / IdentityModule
-
-# Class: IdentityModule
-
-JSBridge module for authenticating users via GrabID.
-
-## Remarks
-
-Handles OAuth2/OIDC authentication flows with PKCE support, enabling MiniApps to obtain user identity tokens.
-Supports both native in-app consent and web-based fallback flows.
-This code must run on the Grab SuperApp's webview to function correctly.
-
-## Examples
-
-**ES Module:**
-```typescript
-import { IdentityModule } from '@grabjs/superapp-sdk';
-const identity = new IdentityModule();
-```
-
-**CDN (UMD):**
-```html
-<script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
-<script>
-  const identity = new SuperAppSDK.IdentityModule();
-</script>
-```
-
-## No Inherit Doc
-
-## Extends
-
-- [`BaseModule`](BaseModule.md)
-
-## Constructors
-
-### Constructor
-
-> **new IdentityModule**(): `IdentityModule`
-
-#### Returns
-
-`IdentityModule`
-
-#### Overrides
-
-[`BaseModule`](BaseModule.md).[`constructor`](BaseModule.md#constructor)
-
-## Methods
-
-### authorize()
-
-> **authorize**(`request`: [`AuthorizeRequest`](../type-aliases/AuthorizeRequest.md)): `Promise`\<[`AuthorizeResponse`](../type-aliases/AuthorizeResponse.md)\>
-
-Initiates an OAuth2 authorization flow with PKCE (Proof Key for Code Exchange).
-This method handles both native in-app consent and web-based fallback flows.
-
-#### Parameters
-
-##### request
-
-[`AuthorizeRequest`](../type-aliases/AuthorizeRequest.md)
-
-Authorization parameters including client ID, redirect URI, scope, and environment.
-
-#### Returns
-
-`Promise`\<[`AuthorizeResponse`](../type-aliases/AuthorizeResponse.md)\>
-
-The authorization result, containing the authorization code on success or redirect status.
-
-#### Remarks
-
-**Important Note on redirectUri and responseMode:**
-
-The actual `redirectUri` used during authorization may differ from the one you provide,
-depending on the flow:
-
-- `responseMode: 'in_place'` when native flow is available: Uses the current page URL
-  (normalized) as the `redirectUri`, overriding your provided value
-- `responseMode: 'in_place'` falling back to web flow if native flow is not available:
-  Uses your provided `redirectUri`
-- `responseMode: 'redirect'`: Always uses your provided `redirectUri`
-
-To ensure successful token exchange (which requires matching `redirectUri` values),
-always retrieve the actual `redirectUri` from `getAuthorizationArtifacts()`
-after authorization completes.
-
-**Consent Selection Rules (Native vs Web):**
-
-- If the user agent does not match the Grab app pattern, the SDK uses web consent
-- If the app version in the user agent is below 5.396.0 (iOS or Android),
-  the SDK uses web consent
-- For supported versions, the SDK attempts native consent first and falls back to
-  web on specific native errors (400, 401, 403)
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the identity module
-const identityModule = new IdentityModule();
-
-// Initiate authorization with redirect mode
-const response = await identityModule.authorize({
-  clientId: 'your-client-id',
-  redirectUri: 'https://your-app.com/callback',
-  scope: 'openid profile',
-  environment: 'production',
-  responseMode: 'redirect'
-  });
-
-switch (response.status_code) {
-  case 200:
-    // Authorization successful (in_place mode with native flow)
-    console.log('Auth Code:', response.result.code);
-    console.log('State:', response.result.state);
-    break;
-  case 302:
-    // Redirect in progress (web flow with responseMode: 'redirect')
-    // The page will be redirected to the authorization URL
-    console.log('Redirecting to authorization...');
-    break;
-  case 204:
-    // User cancelled or flow completed without result data
-    console.log('Authorization cancelled or no content');
-    break;
-  case 400:
-    // Authorization failed
-    console.error('Auth error:', response.error);
-    break;
-  default:
-    console.log('Unexpected status code:', response);
-}
-```
-
-***
-
-### clearAuthorizationArtifacts()
-
-> **clearAuthorizationArtifacts**(): `Promise`\<[`ResponseStatusCode204`](../type-aliases/ResponseStatusCode204.md)\>
-
-Clears all stored PKCE authorization artifacts from local storage.
-This should be called after a successful token exchange or when you need to
-reset the authorization state (e.g., on error or logout).
-
-#### Returns
-
-`Promise`\<[`ResponseStatusCode204`](../type-aliases/ResponseStatusCode204.md)\>
-
-Confirmation that the authorization artifacts have been cleared.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the identity module
-const identityModule = new IdentityModule();
-
-// Clear stored authorization artifacts after successful token exchange
-const response = await identityModule.clearAuthorizationArtifacts();
-
-if (response.status_code === 204) {
-  console.log('Authorization artifacts cleared');
-}
-```
-
-***
-
-### getAuthorizationArtifacts()
-
-> **getAuthorizationArtifacts**(): `Promise`\<[`GetAuthorizationArtifactsResponse`](../type-aliases/GetAuthorizationArtifactsResponse.md)\>
-
-Retrieves stored PKCE authorization artifacts from local storage.
-These artifacts are used to complete the OAuth2 authorization code exchange.
-
-#### Returns
-
-`Promise`\<[`GetAuthorizationArtifactsResponse`](../type-aliases/GetAuthorizationArtifactsResponse.md)\>
-
-The stored PKCE artifacts including state, code verifier, nonce, and redirect URI.
-
-#### Remarks
-
-**Important:** The `redirectUri` returned by this method is the actual redirect URI
-that was sent to the authorization server. This may differ from the `redirectUri`
-you provided to `authorize()` if you used `responseMode: 'in_place'` with native flow.
-You must use this returned `redirectUri` for token exchange to ensure OAuth compliance.
-
-#### Example
-
-**Simple usage**
-```typescript
-// Initialize the identity module
-const identityModule = new IdentityModule();
-
-// Retrieve stored authorization artifacts after authorization redirect
-const response = await identityModule.getAuthorizationArtifacts();
-
-switch (response.status_code) {
-  case 200:
-    // All artifacts present - proceed with token exchange
-    const { state, codeVerifier, nonce, redirectUri } = response.result;
-    console.log('State:', state);
-    console.log('Code Verifier:', codeVerifier);
-    console.log('Nonce:', nonce);
-    console.log('Redirect URI:', redirectUri);
-    break;
-  case 204:
-    // No artifacts yet - user hasn't authorized
-    console.log('No authorization artifacts found. Authorization has not been initiated.');
-    break;
-  case 400:
-    // Inconsistent state - possible data corruption
-    console.error('Authorization artifacts error:', 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)