@wlloyalty/wll-react-sdk 1.4.8 → 1.4.9

package/dist/index.d.ts

@@ -21,6 +21,34 @@ declare const sizes: {
     readonly xxxxl: 40;
     readonly xxxxxl: 60;
 };
+declare const commonStyles: {
+    emptyContainer: {
+        flex: number;
+        justifyContent: "center";
+        alignItems: "center";
+    };
+};
+declare const defaultTheme: BaseThemeObject;
+/**
+ * Creates appropriate directional margin styles for both web and native platforms.
+ * Handles RTL layouts correctly across platforms by using the I18nManager.
+ *
+ * @param value - The margin value to apply
+ * @returns An object with the appropriate margin style property
+ */
+declare const getDirectionalMargin: (value: number) => {
+    marginLeft: number;
+    marginRight?: undefined;
+    marginEnd?: undefined;
+} | {
+    marginRight: number;
+    marginLeft?: undefined;
+    marginEnd?: undefined;
+} | {
+    marginEnd: number;
+    marginLeft?: undefined;
+    marginRight?: undefined;
+};
 
 /**
  * Adds optional children to any component props.
@@ -109,7 +137,8 @@ declare enum TileType {
     Badge = "BADGE",
     RewardCategory = "REWARD_CATEGORY",
     Tier = "TIER",
-    Roundup = "ROUND_UP_BALANCE"
+    Roundup = "ROUND_UP_BALANCE",
+    Venue = "VENUE"
 }
 declare enum TileHeight {
     Half = "HALF",
@@ -188,6 +217,12 @@ declare class RewardTileConfig {
     pointsPrefix: string | null;
     pointsSuffix: string | null;
 }
+declare class VenueTileConfig {
+    venueId: string;
+    name: string;
+    artworkUrl: string;
+    description: string;
+}
 declare enum BadgeTileType {
     Specific = "SPECIFIC",
     Latest = "LATEST_EARNED"
@@ -261,7 +296,7 @@ type Tile = {
     configuration: TileConfig;
     priority: number;
 };
-declare const getConfigForTileType: (tileType: TileType) => typeof BannerTileConfig | typeof PointsTileConfig | typeof ContentTileConfig | typeof RewardTileConfig | typeof BadgeTileConfig | typeof RewardCategoryTileConfig | typeof TierTileConfig;
+declare const getConfigForTileType: (tileType: TileType) => typeof BannerTileConfig | typeof PointsTileConfig | typeof ContentTileConfig | typeof RewardTileConfig | typeof VenueTileConfig | typeof BadgeTileConfig | typeof RewardCategoryTileConfig | typeof TierTileConfig;
 type TileConfig = InstanceType<ReturnType<typeof getConfigForTileType>>;
 type TileSizeInfo = {
     isFullSize: boolean;
@@ -595,17 +630,17 @@ type WithTileFetchingProps = {
 type BadgeTileProps = {
     tile: Tile;
 };
-declare const _default$6: (props: Omit<BadgeTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$7: (props: Omit<BadgeTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type BannerTileProps = {
     tile: Tile;
 };
-declare const _default$5: (props: Omit<BannerTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$6: (props: Omit<BannerTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type ContentTileProps = {
     tile: Tile;
 };
-declare const _default$4: (props: Omit<ContentTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$5: (props: Omit<ContentTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type TGroup = {
     name: string;
@@ -638,17 +673,17 @@ declare const Group: ({ id, enablePullToRefresh, onRefresh }: GroupProps) => Rea
 type PointsTileProps = {
     tile: Tile;
 };
-declare const _default$3: (props: Omit<PointsTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$4: (props: Omit<PointsTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type RewardCategoryTileProps = {
     tile: Tile;
 };
-declare const _default$2: (props: Omit<RewardCategoryTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$3: (props: Omit<RewardCategoryTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type RewardTileProps = {
     tile: Tile;
 };
-declare const _default$1: (props: Omit<RewardTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$2: (props: Omit<RewardTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type SectionProps = {
     section?: TSection;
@@ -680,7 +715,12 @@ declare const TierTile: TierTileComponent;
 type RoundupTileProps = {
     tile: Tile;
 };
-declare const _default: (props: Omit<RoundupTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+declare const _default$1: (props: Omit<RoundupTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
+
+type VenueTileProps = {
+    tile: Tile;
+};
+declare const _default: (props: Omit<VenueTileProps, "tile"> & WithTileFetchingProps) => React__default.JSX.Element;
 
 type NavigationType = 'external' | 'internal' | 'modal';
 type NavigationHandlerParams = {
@@ -699,11 +739,50 @@ type NavigationConfig = {
     baseUrl?: string;
 };
 
+/**
+ * Type definition for event callback functions
+ * @typedef {function} EventCallback
+ * @param {any} [data] - Optional data passed with the event
+ */
+type EventCallback = (data?: any) => void;
 /**
  * Supported event types for the SDK event system
  * @typedef {string} EventTypes
  */
 type EventTypes = 'GROUP_DATA_CHANGED' | 'SECTION_DATA_CHANGED' | 'TILE_DATA_CHANGED' | string;
+/**
+ * A simple event emitter for handling SDK events
+ * Provides a pub-sub mechanism for components to communicate
+ */
+declare class EventEmitter {
+    /**
+     * Map of event types to arrays of callback functions
+     * @private
+     */
+    private events;
+    /**
+     * Subscribe to an event
+     * @param {EventTypes} event - The event type to subscribe to
+     * @param {EventCallback} callback - The callback function to execute when the event is emitted
+     * @returns {Function} An unsubscribe function that removes this callback when called
+     */
+    on(event: EventTypes, callback: EventCallback): () => void;
+    /**
+     * Emit an event with optional data
+     * @param {EventTypes} event - The event type to emit
+     * @param {any} [data] - Optional data to pass to the event callbacks
+     */
+    emit(event: EventTypes, data?: any): void;
+    /**
+     * Remove all event listeners
+     * Use this method to clean up when the event emitter is no longer needed
+     */
+    clear(): void;
+}
+/**
+ * Singleton instance of the EventEmitter for use throughout the SDK
+ */
+declare const sdkEventEmitter: EventEmitter;
 
 declare enum CoreApiUrl {
     PRODUCTION_EU = "https://api.core.wlloyalty.net/v1",
@@ -720,18 +799,18 @@ type SDKConfig = {
     locale?: string;
     coreApiUrl: AllowedCoreApiUrl;
 };
-type Fetcher = <T>(endpoint: string, options?: RequestInit) => Promise<APIResponse<T>>;
-type APIResponse<T> = {
+type Fetcher = <T>(endpoint: string, options?: RequestInit) => Promise<APIResponse$1<T>>;
+type APIResponse$1<T> = {
     status: 'success' | 'error';
     data: T | null;
     error?: string;
 };
 type WllSdkContextType = ThemeContextType & {
-    getGroupByID: (id: string) => Promise<APIResponse<TGroup>>;
-    getSectionByID: (id: string) => Promise<APIResponse<TSection>>;
-    getTileByID: (id: string) => Promise<APIResponse<Tile>>;
+    getGroupByID: (id: string) => Promise<APIResponse$1<TGroup>>;
+    getSectionByID: (id: string) => Promise<APIResponse$1<TSection>>;
+    getTileByID: (id: string) => Promise<APIResponse$1<Tile>>;
     handleNavigation: (link: string, target: CTALinkTarget) => Promise<void>;
-    refreshGroup: (id: string) => Promise<APIResponse<TGroup>>;
+    refreshGroup: (id: string) => Promise<APIResponse$1<TGroup>>;
     notifyDataChange: (eventType: EventTypes, data?: any) => void;
     subscribeToDataChange: (eventType: EventTypes, callback: (data?: any) => void) => () => void;
 } & Readonly<{
@@ -765,4 +844,179 @@ declare function usePullToRefresh({ onRefresh, refreshing: externalRefreshing, }
     handleRefresh: () => Promise<void>;
 };
 
-export { type APIResponse, type Align, type AllowedCoreApiUrl, type Availability, type Badge, type BadgeDetail, _default$6 as BadgeTile, BadgeTileConfig, BadgeTileType, _default$5 as BannerTile, BannerTileConfig, BaseBanner, type BaseThemeObject, BaseTile, Button, CTALinkTarget, Carousel, CarouselNavButton, Chip, Column, _default$4 as ContentTile, ContentTileConfig, CoreApiUrl, type DerivedColors, type DerivedProperties, type DesaturationType, type FlexDirection, FullFlex, Grid, Group, Icon, type ImagePropsNoSource, Indicator, type Justify, Layout, type LayoutProps$1 as LayoutProps, LoadingIndicator, type NavigationConfig, type NavigationType, type PercentageKey, _default$3 as PointsTile, PointsTileConfig, type ProgessType, ProgressBar, ProgressIndicator, ProgressType, ProgressiveImage, Reward, type RewardCategory, _default$2 as RewardCategoryTile, RewardCategoryTileConfig, _default$1 as RewardTile, RewardTileConfig, _default as RoundupTile, RoundupTileConfig, Row, type SDKConfig, Section, SectionHeader, SectionType, type Size, Skeleton, Spacer, StatusVariant, type TGroup, type TSection, Text, type ThemeContextType, type ThemeObject, type ThemeProviderProps, TierTileConfig, TierTileType, TierTile as TierTileUpdated, type TierType, type Tile, type TileConfig, TileContainer, TileHeight, type TileSizeInfo, TileType, type Variant, WllSdkProvider, alignMap, justifyMap, useInvalidateData, usePullToRefresh, useWllSdk };
+declare const IS_WEB: boolean;
+declare const IS_IOS: boolean;
+declare const IS_ANDROID: boolean;
+declare const IS_MOBILE: boolean;
+declare const IS_DESKTOP: boolean;
+declare const SCREEN_WIDTH: number;
+declare const SCREEN_HEIGHT: number;
+
+declare const DIMENSION_MODES: {
+    DESKTOP: "desktop";
+    TABLET: "tablet";
+    MOBILE: "mobile";
+};
+declare const TABLET_SCREEN_WIDTH = 768;
+declare const SMALL_SCREEN_WIDTH = 480;
+
+declare const COLOR_CONSTANTS: {
+    readonly MINIMUM_CONTRAST_RATIO: 2;
+    readonly DEFAULT_LIGHTNESS_ADJUSTMENT: 0.2;
+    readonly DESATURATION_LIGHTEN_AMOUNT: 0.2 | 0.8;
+    readonly DEFAULT_COLOR: "#FFFFFF";
+};
+
+declare const GRID_GAP = 16;
+
+declare const MAX_WIDTH = 1080;
+declare const SLIDE_WIDTH = 1080;
+declare const BUTTON_SIZE = 42;
+
+type APIResponse<T> = {
+    status: 'success' | 'fail' | 'error';
+    data: T | null;
+    error?: string;
+};
+declare const useCreateRequestOptions: (config: SDKConfig) => (options?: RequestInit) => {
+    headers: Headers;
+    body?: BodyInit | null;
+    cache?: RequestCache;
+    credentials?: RequestCredentials;
+    integrity?: string;
+    keepalive?: boolean;
+    method?: string;
+    mode?: RequestMode;
+    priority?: RequestPriority;
+    redirect?: RequestRedirect;
+    referrer?: string;
+    referrerPolicy?: ReferrerPolicy;
+    signal?: AbortSignal | null;
+    window?: null;
+} | undefined;
+declare const useMakeRequest: (config: SDKConfig) => <T>(url: string) => Promise<APIResponse<T>>;
+declare const createResourceGetter: (resource: string, includeHydrate?: boolean) => (config: SDKConfig) => (id: string) => Promise<APIResponse<unknown>>;
+declare const useGetGroupByID: (config: SDKConfig) => (id: string) => Promise<APIResponse<unknown>>;
+declare const useGetSectionByID: (config: SDKConfig) => (id: string) => Promise<APIResponse<unknown>>;
+declare const useGetTileByID: (config: SDKConfig) => (id: string) => Promise<APIResponse<unknown>>;
+
+type ThemeName = 'default' | 'dark' | 'modern' | 'warm' | 'forest' | 'sunset';
+declare const themes: Record<ThemeName, BaseThemeObject>;
+declare const themeItems: Array<{
+    value: ThemeName;
+    title: string;
+}>;
+
+/**
+ * Validates a theme object to ensure all required colors are present and valid
+ * @param theme - Partial theme object to validate
+ * @returns Boolean indicating if theme is valid
+ */
+declare const validateTheme: (theme: Partial<BaseThemeObject>) => boolean;
+/**
+ * Returns a derived color based on the background darkness
+ * @param color - Base color to derive from
+ * @returns Derived color string or default color if invalid
+ */
+declare const getDerivedColor: (color: string) => string;
+/**
+ * Determines the most readable text color (black or white) for a given background
+ * @param backgroundColor - Background color to check against
+ * @returns Hex color string for text
+ */
+declare const getReadableTextColor: (backgroundColor: string) => string;
+/**
+ * Generates a set of colors with varying lightness based on the base color
+ * @param color - Base color to derive from
+ * @returns Object containing derived colors at different lightness levels
+ */
+declare const getDerivedColorPercentages: (color: string) => DerivedColors;
+/**
+ * Generates a set of colors with varying alpha values
+ * @param color - Base color to derive from
+ * @returns Object containing derived colors at different alpha levels
+ */
+declare const getAlphaDerivedColors: (color: string) => DerivedColors;
+/**
+ * Determines if a color should be desaturated based on type and count
+ * @param type - Type of desaturation to apply
+ * @param count - Count value affecting desaturation
+ * @returns Boolean indicating if color should be desaturated
+ */
+declare const shouldDesaturate: (type: DesaturationType, count: number) => boolean;
+/**
+ * Desaturates a color and lightens it
+ * @param color - Color to desaturate
+ * @returns Desaturated color string or default color if invalid
+ */
+declare const desaturateColor: (color: string) => string;
+/**
+ * Gets the appropriate state color based on type and count
+ * @param baseColor - Base color to process
+ * @param type - Type of state
+ * @param count - Count affecting the state
+ * @returns Processed color string
+ */
+declare const getStateColor: (baseColor: string, type: DesaturationType, count: number) => string;
+
+/**
+ * Sorts tiles by priority (higher priority first) and maintains original order for equal priorities
+ * @param tiles Array of tiles to sort
+ * @returns Sorted array of tiles
+ */
+declare const sortByPriority: <T extends Pick<Tile, "priority">>(tiles: T[]) => T[];
+/**
+ * Transforms locale to a locale that is supported by the browser
+ * @param locale Two-letter locale code to transform (en, fr, etc.)
+ * @returns Full locale string (e.g., en-GB, fr-FR)
+ */
+declare const transformLocale: (locale?: string | null) => string;
+/**
+ * Formats a date string to a localized date string based on user locale
+ * @param date Date string to format
+ * @param userLocale User's locale (defaults to 'en')
+ * @returns Formatted date string or fallback message
+ */
+declare const handleLastEarnedDate: (date?: string, userLocale?: string) => string;
+
+declare const getResponsiveValue: (desktopValue: number, mobileValue: number, isDesktop: boolean, isTablet: boolean) => number;
+declare const useResponsiveValue: (desktopValue: number, mobileValue: number, isDesktop: boolean, isTablet: boolean) => number;
+
+type DimensionMode = 'desktop' | 'tablet' | 'mobile';
+type WindowDimensions = {
+    width: number;
+    height: number;
+};
+
+declare function getDimensionMode(window: WindowDimensions): DimensionMode;
+declare function useResponsive(): {
+    dimensionMode: DimensionMode;
+    isDesktop: boolean;
+    isTablet: boolean;
+    isMobile: boolean;
+};
+
+declare const useTileSize: (tile: Tile) => {
+    isFullSize: boolean;
+    isHalfSize: boolean;
+};
+
+type UseGroupRefreshProps = {
+    id: string;
+    enabled?: boolean;
+    setGroupData: (g: TGroup) => void;
+};
+declare const useGroupRefresh: ({ id, enabled, setGroupData, }: UseGroupRefreshProps) => void;
+
+type UseInitialGroupFetchProps = {
+    id: string;
+    setGroupData: (group: TGroup) => void;
+};
+declare const useInitialGroupFetch: ({ id, setGroupData, }: UseInitialGroupFetchProps) => {
+    isLoading: boolean;
+    error: string | null;
+};
+
+declare const useNavigation: (config: NavigationConfig) => (link: string, ctaTarget: CTALinkTarget) => Promise<void>;
+
+export { type APIResponse$1 as APIResponse, type Align, type AllowedCoreApiUrl, type Availability, BUTTON_SIZE, type Badge, type BadgeDetail, _default$7 as BadgeTile, BadgeTileConfig, BadgeTileType, _default$6 as BannerTile, BannerTileConfig, BaseBanner, type BaseThemeObject, BaseTile, Button, COLOR_CONSTANTS, CTALinkTarget, Carousel, CarouselNavButton, Chip, Column, _default$5 as ContentTile, ContentTileConfig, CoreApiUrl, DIMENSION_MODES, type DerivedColors, type DerivedProperties, type DesaturationType, type EventCallback, EventEmitter, type EventTypes, type FlexDirection, FullFlex, GRID_GAP, Grid, Group, IS_ANDROID, IS_DESKTOP, IS_IOS, IS_MOBILE, IS_WEB, Icon, type ImagePropsNoSource, Indicator, type Justify, Layout, type LayoutProps$1 as LayoutProps, LoadingIndicator, MAX_WIDTH, type NavigationConfig, type NavigationType, type PercentageKey, _default$4 as PointsTile, PointsTileConfig, type ProgessType, ProgressBar, ProgressIndicator, ProgressType, ProgressiveImage, Reward, type RewardCategory, _default$3 as RewardCategoryTile, RewardCategoryTileConfig, _default$2 as RewardTile, RewardTileConfig, _default$1 as RoundupTile, RoundupTileConfig, Row, SCREEN_HEIGHT, SCREEN_WIDTH, type SDKConfig, SLIDE_WIDTH, SMALL_SCREEN_WIDTH, Section, SectionHeader, SectionType, type Size, Skeleton, Spacer, StatusVariant, TABLET_SCREEN_WIDTH, type TGroup, type TSection, Text, type ThemeContextType, type ThemeName, type ThemeObject, type ThemeProviderProps, TierTileConfig, TierTileType, TierTile as TierTileUpdated, type TierType, type Tile, type TileConfig, TileContainer, TileHeight, type TileSizeInfo, TileType, type Variant, _default as VenueTile, VenueTileConfig, WllSdkProvider, alignMap, commonStyles, createResourceGetter, defaultTheme, desaturateColor, getAlphaDerivedColors, getDerivedColor, getDerivedColorPercentages, getDimensionMode, getDirectionalMargin, getReadableTextColor, getResponsiveValue, getStateColor, handleLastEarnedDate, justifyMap, sdkEventEmitter, shouldDesaturate, sizes, sortByPriority, themeItems, themes, transformLocale, useCreateRequestOptions, useGetGroupByID, useGetSectionByID, useGetTileByID, useGroupRefresh, useInitialGroupFetch, useInvalidateData, useMakeRequest, useNavigation, usePullToRefresh, useResponsive, useResponsiveValue, useTileSize, useWllSdk, validateTheme };