@cloudparse/up-miniapps-sdk 0.6.8 → 0.7.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import React__default, { ReactNode } from 'react';
+import React__default, { ReactNode, TouchEvent } from 'react';
 import { R as RouteResponse, a as RouteStep, b as RouteRequest, c as RoutingBackendConfig } from './index-B9dDciJq.cjs';
 export { C as ClearRouteRequest, D as DrawRouteRequest, h as handleClearRoute, d as handleDrawRoute, e as handleRouteRequest } from './index-B9dDciJq.cjs';
 import { ViewState, StyleSpecification, ImmutableLike } from '@vis.gl/react-maplibre';
@@ -211,6 +211,37 @@ interface IFidelityTransaction {
     /** Type of transaction */
     type: FidelityTransactionTypeType;
 }
+/**
+ * Achievement Types
+ */
+/**
+ * A player's progress towards a single named Achievement. The Hub tracks a
+ * raw in-app action count per Achievement `slug` (reported server-to-server
+ * by each mini-app's own backend — never by this SDK, see `sdk.achievement`/
+ * `sdk.achievements` doc comments in `sdk.ts`) and auto-credits UP+XP once
+ * `playerActionCount` reaches `totalActionCount`. This is a read-only view
+ * for rendering progress (e.g. a progress bar) — there is no "claim" step.
+ */
+interface IAchievement {
+    /** Unique slug identifying the Achievement (e.g. "explore-5-pois"). */
+    slug: string;
+    /** Display title. */
+    title: string;
+    /** Display description. */
+    description: string;
+    /** The player's current raw in-app action count towards this Achievement. */
+    playerActionCount: number;
+    /** The action count required to complete this Achievement. */
+    totalActionCount: number;
+    /** UP points credited automatically once completed. */
+    upReward: number;
+    /** XP credited automatically once completed. */
+    xpReward: number;
+    /** Whether `playerActionCount` has reached `totalActionCount`. */
+    completed: boolean;
+    /** Optional illustration/icon URL. */
+    imageUrl?: string;
+}
 /**
  * The initialization options required to set up the Mini-App SDK.
  */
@@ -553,6 +584,16 @@ type BridgeMessageType = {
     type: "GET_FIDELITY_HISTORY";
     payload: IFidelityHistoryParams;
     callbackId: string;
+} | {
+    type: "GET_ACHIEVEMENT";
+    payload: {
+        slug: string;
+    };
+    callbackId: string;
+} | {
+    type: "GET_ACHIEVEMENTS";
+    payload?: unknown;
+    callbackId: string;
 } | {
     type: "EXIT";
     payload?: unknown;
@@ -1259,6 +1300,12 @@ interface SwipeCarouselProps {
 }
 declare const SwipeCarousel: ({ items, activeId, onActiveChange, peek, gap, className, itemClassName, axisPriority, verticalDrag, overscan, visibleOverscan, }: SwipeCarouselProps) => React.JSX.Element;
 
+declare const useTapAction: (action: () => void) => {
+    onClick: () => void;
+    onTouchEnd: (e: TouchEvent<HTMLElement>) => void;
+    onTouchStart: (e: TouchEvent<HTMLElement>) => void;
+};
+
 declare class MiniAppSDK {
     /**
      * Map services.
@@ -1565,6 +1612,19 @@ declare class MiniAppSDK {
      * Returns `null` before the first successful `initialize()`/context push.
      */
     getEnv<T extends Record<string, unknown> = Record<string, unknown>>(): T | null;
+    /**
+     * Fetches a single Achievement's current progress by slug — read-only, for
+     * rendering things like a progress bar. Progress is reported server-side
+     * by the mini-app's own backend calling the Hub's M2M endpoint directly;
+     * there is no corresponding "report progress" method on this SDK.
+     * @param slug Unique slug identifying the Achievement.
+     */
+    achievement(slug: string): Promise<IAchievement>;
+    /**
+     * Fetches every Achievement (with current progress) visible to this
+     * mini-app — read-only, same boundary as {@link MiniAppSDK.achievement}.
+     */
+    achievements(): Promise<IAchievement[]>;
     /**
      * Registers a callback for a specific event from the native shell.
      * @param event The name of the event to listen for.
@@ -1825,4 +1885,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 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, 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, 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

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import React__default, { ReactNode } from 'react';
+import React__default, { ReactNode, TouchEvent } from 'react';
 import { R as RouteResponse, a as RouteStep, b as RouteRequest, c as RoutingBackendConfig } from './index-B9dDciJq.js';
 export { C as ClearRouteRequest, D as DrawRouteRequest, h as handleClearRoute, d as handleDrawRoute, e as handleRouteRequest } from './index-B9dDciJq.js';
 import { ViewState, StyleSpecification, ImmutableLike } from '@vis.gl/react-maplibre';
@@ -211,6 +211,37 @@ interface IFidelityTransaction {
     /** Type of transaction */
     type: FidelityTransactionTypeType;
 }
+/**
+ * Achievement Types
+ */
+/**
+ * A player's progress towards a single named Achievement. The Hub tracks a
+ * raw in-app action count per Achievement `slug` (reported server-to-server
+ * by each mini-app's own backend — never by this SDK, see `sdk.achievement`/
+ * `sdk.achievements` doc comments in `sdk.ts`) and auto-credits UP+XP once
+ * `playerActionCount` reaches `totalActionCount`. This is a read-only view
+ * for rendering progress (e.g. a progress bar) — there is no "claim" step.
+ */
+interface IAchievement {
+    /** Unique slug identifying the Achievement (e.g. "explore-5-pois"). */
+    slug: string;
+    /** Display title. */
+    title: string;
+    /** Display description. */
+    description: string;
+    /** The player's current raw in-app action count towards this Achievement. */
+    playerActionCount: number;
+    /** The action count required to complete this Achievement. */
+    totalActionCount: number;
+    /** UP points credited automatically once completed. */
+    upReward: number;
+    /** XP credited automatically once completed. */
+    xpReward: number;
+    /** Whether `playerActionCount` has reached `totalActionCount`. */
+    completed: boolean;
+    /** Optional illustration/icon URL. */
+    imageUrl?: string;
+}
 /**
  * The initialization options required to set up the Mini-App SDK.
  */
@@ -553,6 +584,16 @@ type BridgeMessageType = {
     type: "GET_FIDELITY_HISTORY";
     payload: IFidelityHistoryParams;
     callbackId: string;
+} | {
+    type: "GET_ACHIEVEMENT";
+    payload: {
+        slug: string;
+    };
+    callbackId: string;
+} | {
+    type: "GET_ACHIEVEMENTS";
+    payload?: unknown;
+    callbackId: string;
 } | {
     type: "EXIT";
     payload?: unknown;
@@ -1259,6 +1300,12 @@ interface SwipeCarouselProps {
 }
 declare const SwipeCarousel: ({ items, activeId, onActiveChange, peek, gap, className, itemClassName, axisPriority, verticalDrag, overscan, visibleOverscan, }: SwipeCarouselProps) => React.JSX.Element;
 
+declare const useTapAction: (action: () => void) => {
+    onClick: () => void;
+    onTouchEnd: (e: TouchEvent<HTMLElement>) => void;
+    onTouchStart: (e: TouchEvent<HTMLElement>) => void;
+};
+
 declare class MiniAppSDK {
     /**
      * Map services.
@@ -1565,6 +1612,19 @@ declare class MiniAppSDK {
      * Returns `null` before the first successful `initialize()`/context push.
      */
     getEnv<T extends Record<string, unknown> = Record<string, unknown>>(): T | null;
+    /**
+     * Fetches a single Achievement's current progress by slug — read-only, for
+     * rendering things like a progress bar. Progress is reported server-side
+     * by the mini-app's own backend calling the Hub's M2M endpoint directly;
+     * there is no corresponding "report progress" method on this SDK.
+     * @param slug Unique slug identifying the Achievement.
+     */
+    achievement(slug: string): Promise<IAchievement>;
+    /**
+     * Fetches every Achievement (with current progress) visible to this
+     * mini-app — read-only, same boundary as {@link MiniAppSDK.achievement}.
+     */
+    achievements(): Promise<IAchievement[]>;
     /**
      * Registers a callback for a specific event from the native shell.
      * @param event The name of the event to listen for.
@@ -1825,4 +1885,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 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, 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, 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 };