@cloudparse/up-miniapps-sdk 0.10.0 → 0.11.0

package/dist/index.d.cts

@@ -398,6 +398,20 @@ interface ScrollConfig {
         loadingMore?: boolean;
     };
 }
+/**
+ * Which system bars (status bar / navigation bar) to hide while this
+ * Mini-App is active. Any key omitted leaves that bar's current
+ * (host-driven) state untouched — pass only the bar(s) you want to
+ * override. The host resets to its own default the moment this Mini-App
+ * is no longer the active screen (exit, or the app being backgrounded/
+ * locked) — an override never outlives this Mini-App's own session.
+ */
+interface SystemBarsHiddenConfig {
+    /** Hide/show the physical status bar. */
+    statusBar?: boolean;
+    /** Hide/show the physical navigation bar (3-button or gesture bar). */
+    navigationBar?: boolean;
+}
 /**
  * Result of a `sdk.media.saveImage` call.
  */
@@ -658,6 +672,10 @@ type BridgeMessageType = {
     type: "SET_SCROLL_CONFIG";
     payload: ScrollConfig;
     callbackId: string;
+} | {
+    type: "SET_SYSTEM_BARS_HIDDEN";
+    payload: SystemBarsHiddenConfig;
+    callbackId: string;
 } | {
     type: "SDK_ROUTING_GETROUTE";
     payload: {
@@ -1658,6 +1676,18 @@ declare class MiniAppSDK {
          * @param config Scroll configuration for top/bottom detection.
          */
         setScrollConfig: (config: ScrollConfig) => Promise<void>;
+        /**
+         * Shows or hides the host's status bar / navigation bar while this
+         * Mini-App is active — e.g. an immersive full-bleed map or video view.
+         * Merges into any existing override: a key you omit keeps its current
+         * value, pass `false` explicitly to un-hide a bar you'd previously
+         * hidden. The host resets any override back to its own default the
+         * moment this Mini-App stops being the active screen (exit, or the
+         * app backgrounding/locking) — it never outlives this session and can
+         * never keep a bar visible during an actual lock/security screen.
+         * @param config Which bars to hide (`true`) or explicitly show (`false`).
+         */
+        setSystemBarsHidden: (config: SystemBarsHiddenConfig) => Promise<void>;
     }>;
     /**
      * Debug controls
@@ -1993,4 +2023,4 @@ interface BroadcastWsServiceClient<TMessage extends WsMessage = WsMessage> {
 declare function createWsService<TMessage extends WsMessage = WsMessage>(options: CreateChannelWsServiceOptions<TMessage>): WsServiceClient<TMessage>;
 declare function createWsService<TMessage extends WsMessage = WsMessage>(options: CreateBroadcastWsServiceOptions<TMessage>): BroadcastWsServiceClient<TMessage>;
 
-export { type ApiServiceClient, type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type BroadcastWsServiceClient, type CenterCallbackParams, type CreateApiServiceOptions, type CreateBroadcastWsServiceOptions, type CreateChannelWsServiceOptions, type CreateWsServiceOptions, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IAchievement, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IGenerateQrCodeOptions, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, type IPickImageResult, type ISaveImageResult, type IUserProfile, type LiveRoutingOptions, type LiveRoutingResult, type LocationStreamConfig, Map, MapControls, MapControlsContext, type MapControlsProps, type MapControlsState, type MapInsets, MapMenu, MapMenuDivider, type MapMenuDividerProps, MapMenuFooter, type MapMenuFooterProps, MapMenuItem, type MapMenuItemProps, type MapMenuProps, MapMenuTitle, type MapMenuTitleProps, type MapProps, type MenuItem, MiniAppSDK, MockLocationContext, type MockLocationContextType, type NetworkMethodType, type POI, PullToRefresh, type PullToRefreshIndicatorState, type PullToRefreshProps, QRScanner, type QRScannerProps, RouteLayer, type RouteLayerProps, RouteRequest, RouteResponse, RouteStep, type SDKEvent, SDKMapProvider, SDKProvider, type SDKProviderProps, type ScrollConfig, type StreamAccelerometerData, type StreamHeadingData, type StreamLocationData, type StreamUpdatePayload, type SwipeAxisPriority, SwipeCarousel, type SwipeCarouselItem, type SwipeCarouselProps, type SwipeCarouselVerticalDragConfig, UIEvent, type UseJourneyOptions, type UseJourneyResult, type UserLocationState, type WsConnectionStatus, type WsMessage, type WsServiceClient, createApiService, createWsService, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTapAction, useTrimmedRoute, useUserLocation };
+export { type ApiServiceClient, type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type BroadcastWsServiceClient, type CenterCallbackParams, type CreateApiServiceOptions, type CreateBroadcastWsServiceOptions, type CreateChannelWsServiceOptions, type CreateWsServiceOptions, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IAchievement, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IGenerateQrCodeOptions, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, type IPickImageResult, type ISaveImageResult, type IUserProfile, type LiveRoutingOptions, type LiveRoutingResult, type LocationStreamConfig, Map, MapControls, MapControlsContext, type MapControlsProps, type MapControlsState, type MapInsets, MapMenu, MapMenuDivider, type MapMenuDividerProps, MapMenuFooter, type MapMenuFooterProps, MapMenuItem, type MapMenuItemProps, type MapMenuProps, MapMenuTitle, type MapMenuTitleProps, type MapProps, type MenuItem, MiniAppSDK, MockLocationContext, type MockLocationContextType, type NetworkMethodType, type POI, PullToRefresh, type PullToRefreshIndicatorState, type PullToRefreshProps, QRScanner, type QRScannerProps, RouteLayer, type RouteLayerProps, RouteRequest, RouteResponse, RouteStep, type SDKEvent, SDKMapProvider, SDKProvider, type SDKProviderProps, type ScrollConfig, type StreamAccelerometerData, type StreamHeadingData, type StreamLocationData, type StreamUpdatePayload, type SwipeAxisPriority, SwipeCarousel, type SwipeCarouselItem, type SwipeCarouselProps, type SwipeCarouselVerticalDragConfig, type SystemBarsHiddenConfig, UIEvent, type UseJourneyOptions, type UseJourneyResult, type UserLocationState, type WsConnectionStatus, type WsMessage, type WsServiceClient, createApiService, createWsService, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTapAction, useTrimmedRoute, useUserLocation };

package/dist/index.d.ts

@@ -398,6 +398,20 @@ interface ScrollConfig {
         loadingMore?: boolean;
     };
 }
+/**
+ * Which system bars (status bar / navigation bar) to hide while this
+ * Mini-App is active. Any key omitted leaves that bar's current
+ * (host-driven) state untouched — pass only the bar(s) you want to
+ * override. The host resets to its own default the moment this Mini-App
+ * is no longer the active screen (exit, or the app being backgrounded/
+ * locked) — an override never outlives this Mini-App's own session.
+ */
+interface SystemBarsHiddenConfig {
+    /** Hide/show the physical status bar. */
+    statusBar?: boolean;
+    /** Hide/show the physical navigation bar (3-button or gesture bar). */
+    navigationBar?: boolean;
+}
 /**
  * Result of a `sdk.media.saveImage` call.
  */
@@ -658,6 +672,10 @@ type BridgeMessageType = {
     type: "SET_SCROLL_CONFIG";
     payload: ScrollConfig;
     callbackId: string;
+} | {
+    type: "SET_SYSTEM_BARS_HIDDEN";
+    payload: SystemBarsHiddenConfig;
+    callbackId: string;
 } | {
     type: "SDK_ROUTING_GETROUTE";
     payload: {
@@ -1658,6 +1676,18 @@ declare class MiniAppSDK {
          * @param config Scroll configuration for top/bottom detection.
          */
         setScrollConfig: (config: ScrollConfig) => Promise<void>;
+        /**
+         * Shows or hides the host's status bar / navigation bar while this
+         * Mini-App is active — e.g. an immersive full-bleed map or video view.
+         * Merges into any existing override: a key you omit keeps its current
+         * value, pass `false` explicitly to un-hide a bar you'd previously
+         * hidden. The host resets any override back to its own default the
+         * moment this Mini-App stops being the active screen (exit, or the
+         * app backgrounding/locking) — it never outlives this session and can
+         * never keep a bar visible during an actual lock/security screen.
+         * @param config Which bars to hide (`true`) or explicitly show (`false`).
+         */
+        setSystemBarsHidden: (config: SystemBarsHiddenConfig) => Promise<void>;
     }>;
     /**
      * Debug controls
@@ -1993,4 +2023,4 @@ interface BroadcastWsServiceClient<TMessage extends WsMessage = WsMessage> {
 declare function createWsService<TMessage extends WsMessage = WsMessage>(options: CreateChannelWsServiceOptions<TMessage>): WsServiceClient<TMessage>;
 declare function createWsService<TMessage extends WsMessage = WsMessage>(options: CreateBroadcastWsServiceOptions<TMessage>): BroadcastWsServiceClient<TMessage>;
 
-export { type ApiServiceClient, type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type BroadcastWsServiceClient, type CenterCallbackParams, type CreateApiServiceOptions, type CreateBroadcastWsServiceOptions, type CreateChannelWsServiceOptions, type CreateWsServiceOptions, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IAchievement, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IGenerateQrCodeOptions, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, type IPickImageResult, type ISaveImageResult, type IUserProfile, type LiveRoutingOptions, type LiveRoutingResult, type LocationStreamConfig, Map, MapControls, MapControlsContext, type MapControlsProps, type MapControlsState, type MapInsets, MapMenu, MapMenuDivider, type MapMenuDividerProps, MapMenuFooter, type MapMenuFooterProps, MapMenuItem, type MapMenuItemProps, type MapMenuProps, MapMenuTitle, type MapMenuTitleProps, type MapProps, type MenuItem, MiniAppSDK, MockLocationContext, type MockLocationContextType, type NetworkMethodType, type POI, PullToRefresh, type PullToRefreshIndicatorState, type PullToRefreshProps, QRScanner, type QRScannerProps, RouteLayer, type RouteLayerProps, RouteRequest, RouteResponse, RouteStep, type SDKEvent, SDKMapProvider, SDKProvider, type SDKProviderProps, type ScrollConfig, type StreamAccelerometerData, type StreamHeadingData, type StreamLocationData, type StreamUpdatePayload, type SwipeAxisPriority, SwipeCarousel, type SwipeCarouselItem, type SwipeCarouselProps, type SwipeCarouselVerticalDragConfig, UIEvent, type UseJourneyOptions, type UseJourneyResult, type UserLocationState, type WsConnectionStatus, type WsMessage, type WsServiceClient, createApiService, createWsService, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTapAction, useTrimmedRoute, useUserLocation };
+export { type ApiServiceClient, type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type BroadcastWsServiceClient, type CenterCallbackParams, type CreateApiServiceOptions, type CreateBroadcastWsServiceOptions, type CreateChannelWsServiceOptions, type CreateWsServiceOptions, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IAchievement, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IGenerateQrCodeOptions, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, type IPickImageResult, type ISaveImageResult, type IUserProfile, type LiveRoutingOptions, type LiveRoutingResult, type LocationStreamConfig, Map, MapControls, MapControlsContext, type MapControlsProps, type MapControlsState, type MapInsets, MapMenu, MapMenuDivider, type MapMenuDividerProps, MapMenuFooter, type MapMenuFooterProps, MapMenuItem, type MapMenuItemProps, type MapMenuProps, MapMenuTitle, type MapMenuTitleProps, type MapProps, type MenuItem, MiniAppSDK, MockLocationContext, type MockLocationContextType, type NetworkMethodType, type POI, PullToRefresh, type PullToRefreshIndicatorState, type PullToRefreshProps, QRScanner, type QRScannerProps, RouteLayer, type RouteLayerProps, RouteRequest, RouteResponse, RouteStep, type SDKEvent, SDKMapProvider, SDKProvider, type SDKProviderProps, type ScrollConfig, type StreamAccelerometerData, type StreamHeadingData, type StreamLocationData, type StreamUpdatePayload, type SwipeAxisPriority, SwipeCarousel, type SwipeCarouselItem, type SwipeCarouselProps, type SwipeCarouselVerticalDragConfig, type SystemBarsHiddenConfig, UIEvent, type UseJourneyOptions, type UseJourneyResult, type UserLocationState, type WsConnectionStatus, type WsMessage, type WsServiceClient, createApiService, createWsService, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTapAction, useTrimmedRoute, useUserLocation };

package/dist/index.js

@@ -3441,7 +3441,7 @@ var loadImage2 = (src) => new Promise((resolve, reject) => {
 });
 
 // package.json
-var version = "0.10.0";
+var version = "0.11.0";
 
 // src/sdk.ts
 function deepFreeze(obj) {
@@ -3722,7 +3722,19 @@ var MiniAppSDK = class {
      * Configures native scroll behaviors like Pull-to-Refresh and Infinite Scroll.
      * @param config Scroll configuration for top/bottom detection.
      */
-    setScrollConfig: (config) => this.bridge.send("SET_SCROLL_CONFIG", config)
+    setScrollConfig: (config) => this.bridge.send("SET_SCROLL_CONFIG", config),
+    /**
+     * Shows or hides the host's status bar / navigation bar while this
+     * Mini-App is active — e.g. an immersive full-bleed map or video view.
+     * Merges into any existing override: a key you omit keeps its current
+     * value, pass `false` explicitly to un-hide a bar you'd previously
+     * hidden. The host resets any override back to its own default the
+     * moment this Mini-App stops being the active screen (exit, or the
+     * app backgrounding/locking) — it never outlives this session and can
+     * never keep a bar visible during an actual lock/security screen.
+     * @param config Which bars to hide (`true`) or explicitly show (`false`).
+     */
+    setSystemBarsHidden: (config) => this.bridge.send("SET_SYSTEM_BARS_HIDDEN", config)
   });
   /**
    * Debug controls
@@ -4292,7 +4304,7 @@ var BridgeMocker = ({
           transactionId: `tx_${Math.random().toString(36).slice(2)}`
         });
       }
-      if (type === "TRIGGER_HAPTIC" || type === "EXIT" || type === "UPDATE_CONTEXT") {
+      if (type === "TRIGGER_HAPTIC" || type === "EXIT" || type === "UPDATE_CONTEXT" || type === "SET_SYSTEM_BARS_HIDDEN") {
         return Promise.resolve({ success: true });
       }
       return originalSend(type, payload);