@cloudparse/up-miniapps-sdk 0.5.3 → 0.5.4

package/dist/index.d.cts

@@ -331,6 +331,13 @@ interface ScrollConfig {
         loadingMore?: boolean;
     };
 }
+/**
+ * Result of a `sdk.media.saveImage` call.
+ */
+interface ISaveImageResult {
+    /** Whether the image was saved successfully. */
+    success: boolean;
+}
 /**
  * Edge insets representing padding or margins around a component, typically used for layout purposes.
  */
@@ -535,6 +542,13 @@ type BridgeMessageType = {
     type: "STOP_LOCATION_STREAM";
     payload?: never;
     callbackId: string;
+} | {
+    type: "SAVE_IMAGE";
+    payload: {
+        base64: string;
+        filename?: string;
+    };
+    callbackId: string;
 } | {
     type: string;
     payload: unknown;
@@ -1206,6 +1220,20 @@ declare class MiniAppSDK {
             (type: "profile", fields: (keyof IUserProfile)[]): Promise<boolean>;
         };
     }>;
+    /**
+     * Media & Gallery integration.
+     */
+    readonly media: Readonly<{
+        /**
+         * Saves a base64-encoded image to the device's photo gallery via the Host Shell.
+         * A plain browser `<a download>` does not work inside the native WebView (no
+         * download manager is wired up) — this is the only way to persist an image
+         * generated inside a Mini-App (e.g. a QR code) to the device.
+         * @param base64 Base64-encoded image data, with or without the `data:image/...;base64,` prefix.
+         * @param filename Suggested filename (without extension).
+         */
+        saveImage: (base64: string, filename?: string) => Promise<ISaveImageResult>;
+    }>;
     /**
      * Payments integration.
      */
@@ -1385,4 +1413,4 @@ declare class MiniAppSDK {
  */
 declare const sdk: MiniAppSDK;
 
-export { type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type CenterCallbackParams, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, 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, 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, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTrimmedRoute, useUserLocation };
+export { type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type CenterCallbackParams, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, 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, 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, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTrimmedRoute, useUserLocation };

package/dist/index.d.ts

@@ -331,6 +331,13 @@ interface ScrollConfig {
         loadingMore?: boolean;
     };
 }
+/**
+ * Result of a `sdk.media.saveImage` call.
+ */
+interface ISaveImageResult {
+    /** Whether the image was saved successfully. */
+    success: boolean;
+}
 /**
  * Edge insets representing padding or margins around a component, typically used for layout purposes.
  */
@@ -535,6 +542,13 @@ type BridgeMessageType = {
     type: "STOP_LOCATION_STREAM";
     payload?: never;
     callbackId: string;
+} | {
+    type: "SAVE_IMAGE";
+    payload: {
+        base64: string;
+        filename?: string;
+    };
+    callbackId: string;
 } | {
     type: string;
     payload: unknown;
@@ -1206,6 +1220,20 @@ declare class MiniAppSDK {
             (type: "profile", fields: (keyof IUserProfile)[]): Promise<boolean>;
         };
     }>;
+    /**
+     * Media & Gallery integration.
+     */
+    readonly media: Readonly<{
+        /**
+         * Saves a base64-encoded image to the device's photo gallery via the Host Shell.
+         * A plain browser `<a download>` does not work inside the native WebView (no
+         * download manager is wired up) — this is the only way to persist an image
+         * generated inside a Mini-App (e.g. a QR code) to the device.
+         * @param base64 Base64-encoded image data, with or without the `data:image/...;base64,` prefix.
+         * @param filename Suggested filename (without extension).
+         */
+        saveImage: (base64: string, filename?: string) => Promise<ISaveImageResult>;
+    }>;
     /**
      * Payments integration.
      */
@@ -1385,4 +1413,4 @@ declare class MiniAppSDK {
  */
 declare const sdk: MiniAppSDK;
 
-export { type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type CenterCallbackParams, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, 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, 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, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTrimmedRoute, useUserLocation };
+export { type BridgeMessageType, BridgeMocker, type BridgeMockerProps, type CenterCallbackParams, type CustomControl, DebugConsole, type DebugConsoleProps, type DeclarativeJourneyOptions, type DrawerState, type EtaData, type FidelityTransactionTypeType, type FlyToParams, GeolocationEvent, GlobalEvent, type HapticStyleType, type IBridgeEnvelope, type IContextState, type IEdgeInsets, type IFidelityBalance, type IFidelityHistoryParams, type IFidelityTransaction, type IInitializationOptions, type IInitializationResponse, type ILocationData, type INetworkOptions, type INetworkResponse, type IPaymentRequest, 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, 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, sdk as default, renderMap, sdk, useIsMocked, useJourney, useLiveRouting, useMapControls, useMockLocation, useRoute, useTrimmedRoute, useUserLocation };

package/dist/index.js

@@ -3278,7 +3278,7 @@ function renderMap(containerId, props = {}) {
 }
 
 // package.json
-var version = "0.5.3";
+var version = "0.5.4";
 
 // src/sdk.ts
 function deepFreeze(obj) {
@@ -3387,6 +3387,20 @@ var MiniAppSDK = class {
       return this.bridge.send("REQUEST_PERMISSION", { fields, type });
     })
   });
+  /**
+   * Media & Gallery integration.
+   */
+  media = Object.freeze({
+    /**
+     * Saves a base64-encoded image to the device's photo gallery via the Host Shell.
+     * A plain browser `<a download>` does not work inside the native WebView (no
+     * download manager is wired up) — this is the only way to persist an image
+     * generated inside a Mini-App (e.g. a QR code) to the device.
+     * @param base64 Base64-encoded image data, with or without the `data:image/...;base64,` prefix.
+     * @param filename Suggested filename (without extension).
+     */
+    saveImage: (base64, filename) => this.bridge.send("SAVE_IMAGE", { base64, filename })
+  });
   /**
    * Payments integration.
    */