@grabjs/superapp-sdk 2.0.0-beta.53 → 2.0.0-beta.54

package/dist/index.d.ts

@@ -191,29 +191,29 @@ export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
 export declare type BackResult = void;
 
 /**
- * Base class for all JSBridge modules.
+ * Base class for all modules.
  *
  * @group Core
  *
  * @remarks
- * On construction, the class wraps the JSBridge module on `window` (e.g., `WrappedContainerModule`).
+ * On construction, the class wraps the module on `window` (e.g., `WrappedContainerModule`).
  * This code must run on the Grab SuperApp's webview to function correctly.
  *
  * @public
  */
 export declare class BaseModule {
     /**
-     * The module name used to identify the JSBridge module.
+     * The module name.
      */
     private readonly name;
     /**
-     * Logger scoped to this module (e.g. `[SuperAppSDK][ContainerModule.setTitle] ...`).
+     * Logger scoped to this module.
      *
      * @protected
      */
     protected readonly logger: Logger;
     /**
-     * Returns the wrapped JSBridge module from the global `window` object.
+     * Returns the wrapped module from the global `window` object.
      *
      * @returns The wrapped module instance with native method bindings.
      *
@@ -224,7 +224,7 @@ export declare class BaseModule {
      * Creates a new module instance and wraps it on the global `window` object.
      *
      * @param moduleName - The name of the module (e.g., "ContainerModule", "ProfileModule").
-     * @throws Error when the bridge SDK fails to wrap the module.
+     * @throws Error when the module fails to initialize.
      */
     constructor(moduleName: string);
     /**
@@ -241,10 +241,9 @@ export declare class BaseModule {
      * Checks whether the current app version supports this method.
      *
      * @remarks
-     * Returns 501 if not running in the Grab app, 426 if the version check fails,
-     * or `null` if the method is supported.
+     * Returns `501` status code if not running in the Grab app, `426` status code if the version check fails. Otherwise, returns `null`.
      *
-     * @param isSupported - A function receiving the detected app info, returning true if supported.
+     * @param isSupported - A function receiving the detected app info, returning `true` if supported.
      * @returns An error response, or `null` if supported.
      *
      * @protected
@@ -257,116 +256,44 @@ export declare class BaseModule {
         error: string;
     } | null;
     /**
-     * Invokes a JSBridge method.
+     * Invokes a method.
      *
      * @remarks
-     * - Always checks if running in Grab app (returns 501 if not).
+     * - Always checks if running in Grab app (returns `501` status code if not).
      * - All errors are reported via the `status_code` field; this method never rejects.
-     * - For streaming methods, use `invokeStream` instead.
      *
      * @param options - The invoke options including method name and params.
-     * @returns A promise resolving to the JSBridge response.
+     * @returns A promise resolving to the SDK response.
      *
      * @protected
      */
-    protected invoke(options: InvokeOptions): Promise<BridgeResponse>;
+    protected invoke(options: ModuleInvokeOptions): Promise<SDKResponse>;
     /**
-     * Creates a BridgeStream that immediately emits an error response.
-     * Used for 501, 426, and 500 error scenarios in invokeStream.
+     * Creates a {@link SDKStream} that immediately emits an error response.
      *
-     * @returns A BridgeStream that emits the error and immediately completes.
+     * @returns A {@link SDKStream} that immediately emits an error response.
      *
      * @private
      */
     private createErrorStream;
     /**
-     * Invokes a JSBridge streaming method that returns a `BridgeStream`.
+     * Invokes a streaming method that returns a {@link SDKStream}.
      *
      * @remarks
-     * - Always checks if running in Grab app (returns 501 error response if not).
-     * - Returns a `BridgeStream` that can be subscribed to or awaited for the first value.
+     * - Always checks if running in Grab app (returns `501` status code if not).
+     * - Returns a {@link SDKStream} 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.
      *
      * @param options - The invoke options including method name and params.
-     * @returns A `BridgeStream` for receiving continuous data from the JSBridge.
+     * @returns A {@link SDKStream} for receiving continuous data.
      *
      * @protected
      */
-    protected invokeStream(options: InvokeOptions): BridgeStream;
+    protected invokeStream(options: ModuleInvokeOptions): SDKStream;
 }
 
 /**
- * Base response type for all JSBridge calls.
- *
- * @group Core
- *
- * @remarks
- * Every response has a numeric `status_code`. Success responses (200) carry `result`;
- * error responses (4xx/5xx) carry `error`. Use the type guards ({@link isSuccess},
- * {@link isError}, etc.) to narrow to a specific shape.
- *
- * Per-module response types (e.g., `ScanQRCodeResponse`) are derived from their valibot
- * schemas via `v.InferOutput` and form proper discriminated unions — enabling precise
- * TypeScript narrowing while this base type serves as the internal contract.
- *
- * @public
- */
-export declare type BridgeResponse = {
-    /** HTTP-style status code indicating the outcome of the JSBridge method call */
-    status_code: number;
-    /** The result data from the JSBridge method, present on 200 responses */
-    result?: unknown;
-    /** Error message, present on 4xx/5xx responses */
-    error?: string;
-};
-
-/**
- * A stream for receiving continuous data from JSBridge methods (e.g., location updates).
- *
- * @group Core
- *
- * @remarks
- * Provides both Observable-like and Promise-like interfaces:
- * - Use `subscribe()` to receive all values over time
- * - Use `then()` or `await` to receive only the first value
- *
- * Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
- *
- * @typeParam T - The response type emitted by the stream.
- *
- * @public
- */
-export declare type BridgeStream<T extends BridgeResponse = BridgeResponse> = Readonly<{
-    /**
-     * Subscribe to receive stream data.
-     *
-     * @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
-     * @returns A `Subscription` to terminate the stream when needed.
-     */
-    subscribe: (handlers?: BridgeStreamHandlers<T>) => Subscription;
-}> & PromiseLike<T>;
-
-/**
- * Callbacks for handling stream events.
- *
- * @group Core
- *
- * @remarks
- * Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
- *
- * @typeParam T - The response type emitted by the stream.
- *
- * @public
- */
-export declare type BridgeStreamHandlers<T extends BridgeResponse = BridgeResponse> = Readonly<{
-    /** Called with each new value from the stream. */
-    next?: (data: T) => unknown;
-    /** Called when the stream ends and no more data will arrive. */
-    complete?: () => unknown;
-}>;
-
-/**
- * JSBridge module for accessing the device camera.
+ * SDK module for accessing the device camera via `JSBridge`.
  *
  * @group Modules
  * @category Camera
@@ -411,7 +338,7 @@ export declare class CameraModule extends BaseModule {
      * // Initialize the camera module
      * const camera = new CameraModule();
      *
-     * // Scan the QR code
+     * // Scan a QR code
      * const response = await camera.scanQRCode({ title: 'Scan Payment QR' });
      *
      * // Handle the response
@@ -443,7 +370,7 @@ export declare class CameraModule extends BaseModule {
 }
 
 /**
- * JSBridge module for triggering native payment flows.
+ * SDK module for triggering native payment flows via `JSBridge`.
  *
  * @group Modules
  * @category Checkout
@@ -542,7 +469,7 @@ export declare class CheckoutModule extends BaseModule {
  * @category Identity
  *
  * @remarks
- * This response returns status code `204` when artifacts are successfully cleared.
+ * This response returns status code `204` when artifacts are cleared successfully.
  *
  * @public
  */
@@ -658,7 +585,7 @@ export declare const ContainerAnalyticsEventState: {
 };
 
 /**
- * JSBridge module for controlling the WebView container.
+ * SDK module for controlling the WebView container via `JSBridge`.
  *
  * @group Modules
  * @category Container
@@ -1103,7 +1030,7 @@ export declare class ContainerModule extends BaseModule {
      */
     sendAnalyticsEvent(request: SendAnalyticsEventRequest): Promise<SendAnalyticsEventResponse>;
     /**
-     * Check if the web app is connected to the Grab SuperApp via JSBridge.
+     * Check if the web app is connected to the Grab SuperApp via `JSBridge`.
      *
      * @remarks
      * Call this method to verify the connection status before using other features.
@@ -1176,7 +1103,7 @@ export declare class ContainerModule extends BaseModule {
 }
 
 /**
- * JSBridge module for querying native device information.
+ * SDK module for querying native device information via `JSBridge`.
  *
  * @group Modules
  * @category Device
@@ -1264,7 +1191,7 @@ export declare class DeviceModule extends BaseModule {
  * - `204`: No splash screen shown, or it was closed successfully.
  * - `400`: Invalid input (Grablet / client validation error).
  * - `403`: Missing consent for the required OAuth scope.
- * - `500`: Unexpected error while invoking the native bridge.
+ * - `500`: Unexpected error while invoking `JSBridge`.
  * - `501`: Not in the Grab app WebView environment.
  *
  * @example
@@ -1320,7 +1247,7 @@ export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectS
 }, undefined>], undefined>;
 
 /**
- * Request parameters for downloading a file via native bridge.
+ * Request parameters for downloading a file through `JSBridge`.
  *
  * @group Modules
  * @category File
@@ -1395,7 +1322,7 @@ export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
  * @category File
  *
  * @remarks
- * This is a void result type as successful downloads return status code 204 with no content.
+ * This is a void result type as successful downloads return status code `204` with no content.
  *
  * @public
  */
@@ -1575,7 +1502,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
 }, undefined>;
 
 /**
- * JSBridge module for downloading files to the user's device.
+ * SDK module for downloading files to the user's device via `JSBridge`.
  *
  * @group Modules
  * @category File
@@ -1606,7 +1533,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
 export declare class FileModule extends BaseModule {
     constructor();
     /**
-     * Downloads a file via the native bridge.
+     * Downloads a file through `JSBridge`.
      *
      * @param request - File information, including URL and target file name. See {@link DownloadFileRequest}.
      *
@@ -1939,7 +1866,7 @@ export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema
 }, undefined>], undefined>;
 
 /**
- * The ISO country code string returned from the native bridge.
+ * The ISO country code string returned from `JSBridge`.
  *
  * @group Modules
  * @category Location
@@ -2612,25 +2539,25 @@ export declare type HasAccessToResult = InferOutput<typeof HasAccessToResultSche
 export declare const HasAccessToResultSchema: v.BooleanSchema<undefined>;
 
 /**
- * Type guard to check if a JSBridge response has a defined result (not null or undefined).
+ * Type guard to check if an SDK response has a `result` that is neither `null` nor `undefined`.
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response has a result that is neither null nor undefined, false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response has a `result` that is neither `null` nor `undefined`, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
- * if (isSuccess(response) && hasResult(response)) {
- *   // response.result is guaranteed to be defined
+ * if (isOk(response) && hasResult(response)) {
+ *   // response narrowed to status code `200` variant, and `result` is available
  *   console.log('Result:', response.result);
  * }
  * ```
  *
  * @public
  */
-export declare function hasResult<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function hasResult<T extends SDKResponse>(response: T): response is Extract<T, {
     result: NonNullable<unknown>;
 }>;
 
@@ -2770,7 +2697,7 @@ export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
 export declare type HideRefreshButtonResult = void;
 
 /**
- * JSBridge module for authenticating users via GrabID.
+ * SDK module for authenticating users with GrabID via `JSBridge`.
  *
  * @group Modules
  * @category Identity
@@ -2943,7 +2870,7 @@ export declare class IdentityModule extends BaseModule {
      * Determines whether to use web-based consent flow based on app version and environment.
      *
      * @param request - The authorization request containing the environment setting.
-     * @returns True if web consent should be used, false for native consent.
+     * @returns `true` if web consent should be used, `false` for native consent.
      *
      * @internal
      */
@@ -2959,7 +2886,7 @@ export declare class IdentityModule extends BaseModule {
      */
     private performWebAuthorization;
     /**
-     * Performs native in-app OAuth2 authorization using the JSBridge.
+     * Performs native in-app OAuth2 authorization using `JSBridge`.
      *
      * @param invokeParams - The authorization parameters.
      *
@@ -3057,38 +2984,25 @@ export declare class IdentityModule extends BaseModule {
 }
 
 /**
- * Options for invoking a JSBridge method.
- *
- * @group Core
- *
- * @public
- */
-export declare interface InvokeOptions {
-    /** The name of the JSBridge method to invoke */
-    method: string;
-    /** The parameters to pass to the method */
-    params?: unknown;
-}
-
-/**
- * Type guard to check if a JSBridge response is a client error (4xx status codes).
+ * Type guard to check if an SDK response has a client error status code (`400`, `401`, `403`, `404`, `424`, `426`).
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response is a client error (400-499), false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response is a client error, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
  * if (isClientError(response)) {
- *   console.error('Client error:', response.error);
+ *   // response narrowed to client error variants, `error` is available
+ *   console.error(response.error);
  * }
  * ```
  *
  * @public
  */
-export declare function isClientError<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isClientError<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 400 | 401 | 403 | 404 | 424 | 426;
 }>;
 
@@ -3160,27 +3074,25 @@ export declare const IsConnectedResultSchema: v.ObjectSchema<{
 }, undefined>;
 
 /**
- * Type guard to check if a JSBridge response is an error (4xx or 5xx status codes).
+ * Type guard to check if an SDK response has an error status code (`400`, `401`, `403`, `404`, `424`, `426`, `500`, `501`).
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response is any error (4xx or 5xx), false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response is an error, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
  * if (isError(response)) {
- *   // response narrowed to error variants — error: string is guaranteed
- *   console.error('Error:', response.error);
- * } else {
- *   console.log('Success!');
+ *   // response narrowed to error variants, `error` is available
+ *   console.error(response.error);
  * }
  * ```
  *
  * @public
  */
-export declare function isError<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isError<T extends SDKResponse>(response: T): response is Extract<T, {
     error: string;
 }>;
 
@@ -3262,116 +3174,145 @@ export declare type IsEsimSupportedResult = InferOutput<typeof IsEsimSupportedRe
 export declare const IsEsimSupportedResultSchema: v.BooleanSchema<undefined>;
 
 /**
- * Type guard to check if a JSBridge response is a 302 Found redirect.
+ * Type guard to check if an SDK response has a `302` status code.
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response has status code 302, false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response has `302` status code, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const response = await someBridgeMethod();
+ * if (isFound(response)) {
+ *   // response narrowed to status code `302` variant
+ *   console.log('Redirecting...');
+ * }
+ * ```
  *
  * @public
  */
-export declare function isFound<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isFound<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 302;
 }>;
 
 /**
- * Type guard to check if a JSBridge response is a 204 No Content (operation succeeded with no result).
+ * Type guard to check if an SDK response has a `204` status code.
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response has status code 204, false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response has `204` status code, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const response = await someBridgeMethod();
+ * if (isNoContent(response)) {
+ *   // response narrowed to status code `204` variant, `result` is not available
+ *   console.log('No content');
+ * }
+ * ```
  *
  * @public
  */
-export declare function isNoContent<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isNoContent<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 204;
 }>;
 
 /**
- * Type guard to check if a JSBridge response is a 200 OK (operation succeeded with a result).
+ * Type guard to check if an SDK response has a `200` status code.
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response has status code 200, false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response has `200` status code, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const response = await someBridgeMethod();
+ * if (isOk(response)) {
+ *   // response narrowed to status code `200` variant, `result` is available
+ *   console.log(response.result);
+ * }
+ * ```
  *
  * @public
  */
-export declare function isOk<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isOk<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 200;
 }>;
 
 /**
- * Type guard to check if a JSBridge response is a redirect (status code 302).
+ * Type guard to check if an SDK response has a `302` status code.
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response is a redirect (302), false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response is a redirect, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
  * if (isRedirection(response)) {
+ *   // response narrowed to status code `302` variant
  *   console.log('Redirecting...');
  * }
  * ```
  *
  * @public
  */
-export declare function isRedirection<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isRedirection<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 302;
 }>;
 
 /**
- * Type guard to check if a JSBridge response is a server error (5xx status codes).
+ * Type guard to check if an SDK response has a server error status code (`500`, `501`).
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response is a server error (500-599), false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response is a server error, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
  * if (isServerError(response)) {
- *   console.error('Server error:', response.error);
+ *   // response narrowed to server error variants, `error` is available
+ *   console.error(response.error);
  * }
  * ```
  *
  * @public
  */
-export declare function isServerError<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isServerError<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 500 | 501;
 }>;
 
 /**
- * Type guard to check if a JSBridge response is successful (2xx status codes).
+ * Type guard to check if an SDK response has a success status code (`200`, `204`).
  *
  * @group Type Guards
  *
- * @param response - The JSBridge response to check
- * @returns True if the response is successful (200-299), false otherwise
+ * @param response - The SDK response to check
+ * @returns `true` if the response is successful, `false` otherwise
  *
  * @example
  * ```typescript
  * const response = await someBridgeMethod();
  * if (isSuccess(response)) {
- *   // response narrowed to success variants — result is available
- *   console.log(response.result);
+ *   // response narrowed to success variants
+ *   console.log(response);
  * }
  * ```
  *
  * @public
  */
-export declare function isSuccess<T extends BridgeResponse>(response: T): response is Extract<T, {
+export declare function isSuccess<T extends SDKResponse>(response: T): response is Extract<T, {
     status_code: 200 | 204;
 }>;
 
 /**
- * JSBridge module for accessing device locale settings.
+ * SDK module for accessing device locale settings via `JSBridge`.
  *
  * @group Modules
  * @category Locale
@@ -3433,7 +3374,7 @@ export declare class LocaleModule extends BaseModule {
 }
 
 /**
- * JSBridge module for accessing device location services.
+ * SDK module for accessing device location services via `JSBridge`.
  *
  * @group Modules
  * @category Location
@@ -3507,11 +3448,11 @@ export declare class LocationModule extends BaseModule {
      * @requiredOAuthScope mobile.geolocation
      *
      * @remarks
-     * This method returns a `BridgeStream` that continuously emits location updates.
+     * This method returns an `SDKStream` that continuously emits location updates.
      * Remember to call `unsubscribe()` on the subscription when you no longer need updates
      * to conserve battery and free resources.
      *
-     * @returns A `BridgeStream` that emits location updates as the device location changes.
+     * @returns An `SDKStream` that emits location updates as the device location changes.
      * Use `subscribe()` to listen for updates, or `await` to get the first value only. See {@link ObserveLocationChangeResponse}.
      *
      * @example
@@ -3608,7 +3549,7 @@ export declare class Logger {
 }
 
 /**
- * JSBridge module for playing DRM-protected media content.
+ * SDK module for playing DRM-protected media content via `JSBridge`.
  *
  * @group Modules
  * @category Media
@@ -3729,7 +3670,21 @@ export declare class MediaModule extends BaseModule {
 }
 
 /**
- * JSBridge module for making network requests via the native bridge.
+ * Options for invoking an SDK method.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare interface ModuleInvokeOptions {
+    /** The name of the SDK method to invoke */
+    method: string;
+    /** The parameters to pass to the method */
+    params?: unknown;
+}
+
+/**
+ * SDK module for making network requests through the native layer via `JSBridge`.
  *
  * @group Modules
  * @category Network
@@ -3762,7 +3717,7 @@ export declare class MediaModule extends BaseModule {
 export declare class NetworkModule extends BaseModule {
     constructor();
     /**
-     * Sends a network request via the native bridge.
+     * Sends a network request through `JSBridge`.
      *
      * @param request - The network request parameters including endpoint, method, headers, query, body, and timeout. See {@link SendRequest}.
      *
@@ -3807,15 +3762,15 @@ export declare class NetworkModule extends BaseModule {
  * @category Media
  *
  * @remarks
- * This is a `BridgeStream` that can be:
+ * This is an `SDKStream` that can be:
  * - Subscribed to via `.subscribe()` for continuous updates
  * - Awaited via `await` to get the first value only
  *
- * The stream can emit status codes 200 (event data), 500 (server error), or 501 (not implemented).
+ * The stream can emit status codes `200` (event data), `500` (server error), or `501` (not implemented).
  *
  * @public
  */
-export declare type ObserveDRMPlaybackResponse = BridgeStream<InferOutput<typeof ObserveDRMPlaybackResponseSchema>>;
+export declare type ObserveDRMPlaybackResponse = SDKStream<InferOutput<typeof ObserveDRMPlaybackResponseSchema>>;
 
 /**
  * @group Modules
@@ -3846,7 +3801,7 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
  * @category Location
  *
  * @remarks
- * This is a `BridgeStream` that can be:
+ * This is an `SDKStream` that can be:
  * - Subscribed to via `.subscribe()` for continuous updates
  * - Awaited via `await` to get the first value only
  *
@@ -3854,7 +3809,7 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
  *
  * @public
  */
-export declare type ObserveLocationChangeResponse = BridgeStream<GetCoordinateResponse>;
+export declare type ObserveLocationChangeResponse = SDKStream<GetCoordinateResponse>;
 
 /**
  * Response when notifying content loaded.
@@ -4040,7 +3995,7 @@ export declare type OpenExternalLinkResult = void;
 export declare type Platform = 'Android' | 'iOS';
 
 /**
- * JSBridge module for controlling platform navigation.
+ * SDK module for controlling platform navigation via `JSBridge`.
  *
  * @group Modules
  * @category Platform
@@ -4163,7 +4118,7 @@ export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema
 export declare type PlayDRMContentResult = void;
 
 /**
- * JSBridge module for accessing user profile information.
+ * SDK module for accessing user profile information via `JSBridge`.
  *
  * @group Modules
  * @category Profile
@@ -4652,7 +4607,7 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
 }, undefined>;
 
 /**
- * JSBridge module for checking and refreshing API access permissions.
+ * SDK module for checking and refreshing API access permissions via `JSBridge`.
  *
  * @group Modules
  * @category Scope
@@ -4683,9 +4638,9 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
 export declare class ScopeModule extends BaseModule {
     constructor();
     /**
-     * Checks if the current client has access to a specific JSBridge API method.
+     * Checks if the current client has access to a specific `JSBridge` API method.
      *
-     * @param module - The name of the bridge module to check access for (e.g., 'CameraModule').
+     * @param module - The name of the SDK module to check access for (e.g., 'CameraModule').
      * @param method - The method name within the module to check access for (e.g., 'scanQRCode').
      *
      * @returns Whether the MiniApp has permission to access the specified method. See {@link HasAccessToResponse}.
@@ -4746,6 +4701,143 @@ export declare class ScopeModule extends BaseModule {
     reloadScopes(): Promise<ReloadScopesResponse>;
 }
 
+/**
+ * Client error status codes for SDK error responses.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare type SDKClientErrorStatusCode = 400 | 401 | 403 | 404 | 424 | 426;
+
+/**
+ * SDK error status code response with a `error` message.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare interface SDKErrorResponse<C extends SDKErrorStatusCode> {
+    readonly status_code: C;
+    readonly error: string;
+}
+
+/**
+ * Error status codes for SDK error responses.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare type SDKErrorStatusCode = SDKClientErrorStatusCode | SDKServerErrorStatusCode;
+
+/**
+ * SDK `204` status code response.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare interface SDKNoContentResponse {
+    readonly status_code: 204;
+}
+
+/**
+ * SDK `200` status code response with a typed `result` payload.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare interface SDKOkResponse<T> {
+    readonly status_code: 200;
+    readonly result: T;
+}
+
+/**
+ * SDK `302` status code response.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare interface SDKRedirectResponse {
+    readonly status_code: 302;
+}
+
+/**
+ * Base SDK response shape.
+ *
+ * @group Core
+ *
+ * @remarks
+ * Use the type guards to narrow to a specific shape.
+ *
+ * @public
+ */
+export declare type SDKResponse = {
+    /** HTTP-style status code indicating the outcome of the SDK method call */
+    status_code: number;
+    /** The result data from the SDK method, present on 200 status code responses */
+    result?: unknown;
+    /** Error message, present on error status code responses */
+    error?: string;
+};
+
+/**
+ * Server error status codes for SDK error responses.
+ *
+ * @group Core
+ *
+ * @public
+ */
+export declare type SDKServerErrorStatusCode = 500 | 501;
+
+/**
+ * A stream for receiving continuous data from SDK methods (e.g., location updates).
+ *
+ * @group Core
+ *
+ * @remarks
+ * Provides both Observable-like and Promise-like interfaces:
+ * - Use `subscribe()` to receive all values over time
+ * - Use `then()` or `await` to receive only the first value
+ *
+ * Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
+ *
+ * @typeParam T - The response type emitted by the stream.
+ *
+ * @public
+ */
+export declare type SDKStream<T extends SDKResponse = SDKResponse> = Readonly<{
+    /**
+     * Subscribe to receive stream data.
+     *
+     * @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
+     * @returns A `Subscription` to terminate the stream when needed.
+     */
+    subscribe: (handlers?: SDKStreamHandlers<T>) => Subscription;
+}> & PromiseLike<T>;
+
+/**
+ * Callbacks for handling stream events.
+ *
+ * @group Core
+ *
+ * @remarks
+ * Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
+ *
+ * @typeParam T - The response type emitted by the stream.
+ *
+ * @public
+ */
+export declare type SDKStreamHandlers<T extends SDKResponse = SDKResponse> = Readonly<{
+    /** Called with each new value from the stream. */
+    next?: (data: T) => unknown;
+    /** Called when the stream ends and no more data will arrive. */
+    complete?: () => unknown;
+}>;
+
 /**
  * Request parameters for sending analytics events.
  *
@@ -4975,7 +5067,7 @@ export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
  *
  * @remarks
  * The result type is `Record<string, unknown>` as response bodies are always
- * returned as objects. String responses from the native bridge are automatically
+ * returned as objects. String responses from `JSBridge` are automatically
  * parsed to JSON.
  *
  * @public
@@ -5580,7 +5672,7 @@ export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
 export declare type ShowRefreshButtonResult = void;
 
 /**
- * JSBridge module for controlling the native splash / Lottie loading screen.
+ * SDK module for controlling the native splash / Lottie loading screen via `JSBridge`.
  *
  * @group Modules
  * @category Splash Screen
@@ -5636,7 +5728,7 @@ export declare class SplashScreenModule extends BaseModule {
 }
 
 /**
- * JSBridge module for persisting key-value data to native storage.
+ * SDK module for persisting key-value data to native storage via `JSBridge`.
  *
  * @group Modules
  * @category Storage
@@ -6018,7 +6110,7 @@ export declare class StorageModule extends BaseModule {
 }
 
 /**
- * Controls an active stream subscription. Call `unsubscribe()` to stop receiving data.
+ * Controls an active stream subscription.
  *
  * @group Core
  *
@@ -6029,14 +6121,14 @@ export declare class StorageModule extends BaseModule {
  * @public
  */
 export declare type Subscription = Readonly<{
-    /** Returns true if this subscription has been terminated. */
+    /** Returns `true` if this subscription has been terminated. */
     isUnsubscribed: () => boolean;
     /** Terminates the subscription. No further data will be received. */
     unsubscribe: () => unknown;
 }>;
 
 /**
- * JSBridge module for opening URLs in the device's system browser.
+ * SDK module for opening URLs in the device's system browser via `JSBridge`.
  *
  * @group Modules
  * @category System WebView Kit
@@ -6270,7 +6362,7 @@ export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.O
 }, undefined>], undefined>;
 
 /**
- * JSBridge module for reading user-related attributes from native code.
+ * SDK module for reading user-related attributes from native code via `JSBridge`.
  *
  * @group Modules
  * @category User Attributes
@@ -6481,14 +6573,14 @@ export declare interface Version {
 }
 
 /**
- * Generic interface for all native JSBridge module wrappers.
+ * Generic interface for all SDK module wrappers exposed through `JSBridge`.
  *
  * @group Core
  *
  * @public
  */
 export declare interface WrappedModule {
-    invoke(method: string, params?: unknown): BridgeStream | Promise<BridgeResponse>;
+    invoke(method: string, params?: unknown): SDKStream | Promise<SDKResponse>;
 }
 
 export { }