@wlloyalty/wll-react-sdk 1.0.4 → 1.0.7

package/dist/index.d.ts

@@ -1,9 +1,606 @@
-export * from './components/atoms';
-export * from './components/molecules';
-export * from './components/organisms';
-export * from './context/WllSdkContext';
-export * from './types/common';
-export * from './types/section';
-export * from './types/theme';
-export * from './types/tile';
-export * from './types/wll';
+import * as React from 'react';
+import React__default, { ReactNode, FC } from 'react';
+import { ViewStyle, ImageSourcePropType, StyleProp, View, TextProps as TextProps$1, TextStyle, ImageProps } from 'react-native';
+import * as LucideIcons from 'lucide-react';
+
+declare const sizes: {
+    borderRadiusSm: number;
+    borderRadiusLg: number;
+    borderRadiusButton: number;
+    borderRadiusRounded: number;
+    sm: number;
+    md: number;
+    lg: number;
+};
+
+type PercentageKey = 5 | 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 95;
+type DerivedColors = {
+    [K in PercentageKey]: string;
+};
+
+type BaseThemeObject = {
+    accent: string;
+    background: string;
+    errorPrimary: string;
+    negative: string;
+    pageButtonBackground: string;
+    pageButtonText: string;
+    positive: string;
+    primary: string;
+    surface: string;
+    surfaceText: string;
+    text: string;
+};
+type DerivedProperties = {
+    accentText: string;
+    derivedBackground: string;
+    primaryText: string;
+    positiveText: string;
+    negativeText: string;
+    derivedSurfaceText: DerivedColors;
+    derivedSurface: DerivedColors;
+    alphaDerivedPrimary: DerivedColors;
+    alphaDerivedText: DerivedColors;
+};
+type ThemeObject = BaseThemeObject & DerivedProperties & {
+    readonly sizes: typeof sizes;
+};
+type ThemeContextType = {
+    theme: ThemeObject;
+    setTheme: (theme: ThemeObject) => void;
+};
+type ThemeProviderProps = {
+    children: ReactNode;
+    theme?: Partial<BaseThemeObject>;
+};
+type Variant = 'primary' | 'accent' | 'positive' | 'negative';
+type Size = 'sm' | 'md' | 'lg';
+
+type ButtonProps = {
+    title: string;
+    onPress: () => void;
+    variant: Variant;
+};
+declare const Button: React.FC<ButtonProps>;
+
+type Justify = 'start' | 'end' | 'center' | 'between' | 'around' | 'evenly';
+type Align = 'start' | 'end' | 'center' | 'stretch';
+type ColumnProps = {
+    children: React.ReactNode;
+    justify?: Justify;
+    align?: Align;
+    direction?: FlexDirection;
+    style?: ViewStyle;
+};
+type FlexDirection = 'column' | 'row' | 'column-reverse' | 'row-reverse';
+declare const Column: React.FC<ColumnProps>;
+
+type IconName = keyof typeof LucideIcons;
+type IconProps = {
+    name: IconName;
+    color?: string;
+    size?: number;
+    strokeWidth?: number;
+};
+declare const Icon: React.FC<IconProps>;
+
+type Badge = {
+    id: string;
+    name: string;
+    description: string;
+    artworkUrl: string;
+    createdAt: string;
+    updatedAt: string;
+};
+declare class Reward {
+    id?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    name?: string;
+    pictureUrl?: string;
+    description?: string;
+    price?: number;
+    value?: number;
+    priority?: number;
+    availability?: Availability;
+    purchasable?: boolean;
+    tier?: string;
+    summary?: string;
+    redemptionMessage?: string;
+    visibilityCriteria?: string;
+}
+type RewardCategory = {
+    name: string;
+    priority: number;
+    type: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    description: string | null;
+    metadata: any | null;
+    pictureUrl: string;
+};
+type Availability = {
+    start: string;
+    end: string;
+};
+type Effectivity = {
+    start: string;
+    end: string;
+};
+type TierType = {
+    id: string;
+    name: string;
+    description?: string | null;
+    artworkUrl?: string | null;
+    priority: number;
+    pointsRequirement?: number;
+    calculation?: string;
+    accumulationPeriod?: string;
+    effectivity?: Effectivity;
+    createdAt?: string;
+    updatedAt?: string;
+    earnedPoints?: number;
+    attained?: boolean;
+};
+
+declare enum UrlTarget {
+    sameWindow = "SAME_WINDOW",
+    newWindow = "NEW_WINDOW"
+}
+declare enum TierTileType {
+    currentTier = "CURRENT",
+    specificTier = "SPECIFIC"
+}
+declare enum ProgressType {
+    Name = "NAME",
+    Points = "POINTS"
+}
+declare enum TileType {
+    Banner = "BANNER",
+    Points = "POINTS",
+    Content = "CONTENT",
+    Reward = "REWARD",
+    Badge = "BADGE",
+    RewardCategory = "REWARD_CATEGORY",
+    Tier = "TIER"
+}
+declare enum TileHeight {
+    Half = "HALF",
+    Full = "FULL"
+}
+type ProgessType = 'NAME' | 'POINTS';
+declare class BannerTileConfig {
+    artworkUrl?: string | null;
+    title?: string | null;
+    description?: string | null;
+    ctaText?: string | null;
+    ctaLink?: string | null;
+    ctaLinkTarget?: UrlTarget;
+}
+declare class PointsTileConfig {
+    title?: string | null;
+    multiplier?: number;
+    prefix?: string | null;
+    suffix?: string | null;
+    artworkUrl?: string | null;
+    points?: number;
+}
+declare class ContentTileConfig {
+    title?: string | null;
+    description?: string | null;
+    artworkUrl?: string | null;
+    linkURL?: string | null;
+}
+declare class RewardTileConfig {
+    rewardId: string;
+    showPrice: boolean;
+    showArtwork?: boolean;
+    showDetails?: boolean;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    pictureUrl: string;
+    value: number;
+    price: number;
+    priority: number;
+    availability: Availability;
+    purchasable: boolean;
+    tier: string | null;
+    category: RewardCategory;
+    discounts: any[];
+    summary: string | null;
+    redemptionMessage: string | null;
+    visibilityCriteria: string | null;
+    type: 'VOUCHER';
+    codeType: 'HUMAN' | 'OTP';
+    code: string | null;
+    purchaseExpiration: string | null;
+    hideCode: boolean;
+    notificationConfig: any | null;
+    artworkUrl: string;
+    pointsMultiplier: string;
+    pointsPrefix: string | null;
+    pointsSuffix: string | null;
+}
+declare enum BadgeTileType {
+    Specific = "SPECIFIC",
+    Latest = "LATEST_EARNED"
+}
+declare class BadgeTileConfig {
+    type: BadgeTileType;
+    badgeId: string;
+    internalName?: string;
+    defaultLocale: string;
+    priority: number;
+    internalDescription?: string | null;
+    status?: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    details?: BadgeDetail[];
+    count: number;
+    name: string;
+    locale: string;
+    description: string;
+    artworkUrl: string;
+    emptyBadgeMessage?: string;
+    emptyBadgeArtworkUrl?: string;
+    awardedDatePrefix?: string;
+    badgeNotEarnedMessage?: string;
+}
+type BadgeDetail = {
+    name: string;
+    locale: string;
+    description: string;
+    artworkUrl: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    emptyBadgeMessage?: string;
+    emptyBadgeArtworkUrl?: string;
+    awardedDatePrefix?: string;
+    badgeNotEarnedMessage?: string;
+};
+declare class RewardCategoryTileConfig {
+    showName: boolean;
+    rewardCategoryId: string;
+    artworkUrl: string;
+    name: string;
+}
+declare class TierTileConfig {
+    progressType: ProgressType;
+    pointsMultiplier?: number;
+    pointsPrefix?: string;
+    pointsSuffix?: string;
+    tier?: TierType;
+    tierId?: string;
+    targetTier?: TierType | undefined;
+    type?: TierTileType;
+    targetTierAttainingPeriod?: Date | null;
+    title: string;
+    emptyDescription?: string;
+    emptyArtworkUrl?: string;
+    pointsToTierPrefix?: string;
+    pointsToTierSuffix?: string;
+}
+type Tile = {
+    id: string | null;
+    type?: TileType;
+    active: boolean;
+    createdAt: string | null;
+    updatedAt: string | null;
+    tileHeight: TileHeight;
+    configuration: TileConfig;
+    priority: number;
+};
+declare const getConfigForTileType: (tileType: TileType) => typeof BannerTileConfig | typeof PointsTileConfig | typeof ContentTileConfig | typeof RewardTileConfig | typeof BadgeTileConfig | typeof RewardCategoryTileConfig | typeof TierTileConfig;
+type TileConfig = InstanceType<ReturnType<typeof getConfigForTileType>>;
+
+type LoadingIndicatorProps = {
+    tile: Tile;
+};
+declare const LoadingIndicator: React.FC<LoadingIndicatorProps>;
+
+type ProgressBarProps = {
+    percentage: number;
+    variant?: Variant;
+    height?: Size;
+    animationDuration?: number;
+};
+declare const ProgressBar: React.FC<ProgressBarProps>;
+
+type ProgressiveImageProps = {
+    source: ImageSourcePropType;
+    style?: StyleProp<ViewStyle>;
+    isDesaturated?: boolean;
+    [key: string]: any;
+};
+declare const ProgressiveImage: React__default.FC<ProgressiveImageProps>;
+
+type RowHeaderProps = {
+    children: React.ReactNode;
+    className?: string;
+} & React.ComponentProps<typeof View>;
+declare const RowHeader: React.FC<RowHeaderProps>;
+
+type TextVariant = 'eyebrow' | 'title' | 'description' | 'body' | 'caption' | 'label' | 'tier-requirement' | 'tier-earned';
+type TextProps = TextProps$1 & {
+    variant?: TextVariant;
+    style?: TextStyle;
+    isSurface?: boolean;
+};
+declare const Text: React.FC<TextProps>;
+
+type BaseBannerProps = {
+    tile: Tile;
+    children: React.ReactNode;
+};
+declare const BaseBanner: React.FC<BaseBannerProps>;
+
+type ImagePropsNoSource = Omit<ImageProps, 'source'>;
+
+type BaseTileProps = {
+    tile: Tile;
+    children: ReactNode;
+    style?: ViewStyle;
+};
+type BaseTileComponent = FC<BaseTileProps> & {
+    Root: FC<{
+        children: ReactNode;
+        style?: ViewStyle;
+    }>;
+    Media: FC<ImagePropsNoSource>;
+    Content: FC<{
+        children: ReactNode;
+    }>;
+    Header: FC<{
+        children?: ReactNode;
+    }>;
+    Title: FC;
+    Body: FC;
+};
+declare const BaseTile: BaseTileComponent;
+
+type TileContainerProps = {
+    tiles: Tile[];
+};
+declare const TileContainer: React.FC<TileContainerProps>;
+
+declare enum SectionType {
+    Grid = "GRID",
+    Banner = "BANNER"
+}
+type TSection = {
+    id: string;
+    name: string;
+    type: SectionType;
+    createdAt: string;
+    updatedAt: string;
+    title?: string;
+    description?: string;
+    tiles: Tile[];
+    pointsMultiplier?: number;
+    pointsPrefix?: string | null;
+    pointsSuffix?: string | null;
+    priority: number;
+    active: boolean;
+    details?: [];
+    defaultLocale: string;
+    locale: string;
+};
+
+type CarouselProps = {
+    section: TSection;
+};
+declare const Carousel: React__default.FC<CarouselProps>;
+
+type GridProps = {
+    section: TSection;
+};
+declare const Grid: React.FC<GridProps>;
+
+type ProgressIndicatorProps = {
+    currentPoints: number;
+    maxPoints: number;
+    variant?: Variant;
+    height?: Size;
+    attained?: boolean;
+};
+declare const ProgressIndicator: React.FC<ProgressIndicatorProps>;
+
+type SectionHeaderProps = {
+    title?: string;
+    description?: string;
+};
+declare const SectionHeader: React__default.FC<SectionHeaderProps>;
+
+type BadgeTileProps$1 = {
+    tile: Tile;
+};
+type BadgeTileComponent$1 = FC<BadgeTileProps$1> & {
+    Title: FC;
+    Body: FC;
+    Image: FC<ImagePropsNoSource>;
+    Chevron: FC;
+};
+declare const BadgeTile$1: BadgeTileComponent$1;
+
+type BadgeTileProps = {
+    tile: Tile;
+};
+type BadgeTileMediaProps = ImagePropsNoSource & {
+    children?: React__default.ReactNode;
+};
+type BadgeTileComponent = FC<BadgeTileProps> & {
+    Media: FC<BadgeTileMediaProps>;
+    Content: FC;
+    Title: FC;
+    Description: FC;
+    DateEarned: FC;
+    Status: FC;
+};
+declare const BadgeTile: BadgeTileComponent;
+
+type BannerTileProps = {
+    tile: Tile;
+};
+declare const BannerTile: React.FC<BannerTileProps> & {
+    Image: typeof BannerTileImage;
+    Title: typeof BannerTileTitle;
+    Description: typeof BannerTileDescription;
+    CTA: typeof BannerTileCTA;
+};
+declare const BannerTileImage: React.FC;
+declare const BannerTileTitle: React.FC;
+declare const BannerTileDescription: React.FC;
+declare const BannerTileCTA: React.FC;
+
+type ContentTileProps = {
+    tile: Tile;
+};
+type ContentTileComponent = React.FC<ContentTileProps> & {
+    Root: typeof ContentTileRoot;
+    Media: typeof ContentTileMedia;
+    Content: typeof ContentTileContent;
+    Header: typeof ContentTileHeader;
+    Body: typeof ContentTileBody;
+};
+declare const ContentTileRoot: React.FC<{
+    children: React.ReactNode;
+}>;
+declare const ContentTileMedia: React.FC;
+declare const ContentTileContent: React.FC<{
+    children: React.ReactNode;
+}>;
+declare const ContentTileHeader: React.FC;
+declare const ContentTileBody: React.FC;
+declare const ContentTile: ContentTileComponent;
+
+type GroupProps = {
+    id: string;
+};
+declare const Group: React__default.FC<GroupProps>;
+
+type PointsTileProps = {
+    tile: Tile;
+};
+declare const PointsTile: React.FC<PointsTileProps> & {
+    Title: typeof PointsTileTitle;
+    Points: typeof PointsTilePoints;
+    Image: typeof PointsTileImage;
+};
+declare const PointsTileTitle: React.FC;
+declare const PointsTilePoints: React.FC;
+type PointTileImageProps = {
+    isFullSize: boolean;
+};
+declare const PointsTileImage: React.FC<PointTileImageProps>;
+
+type RewardCategoryTileProps = {
+    tile: Tile;
+};
+declare const RewardCategoryTile: React.FC<RewardCategoryTileProps> & {
+    Header: typeof RewardCategoryHeader;
+    Background: typeof RewardCategoryBackground;
+};
+declare const RewardCategoryHeader: React.FC;
+declare const RewardCategoryBackground: React.FC;
+
+type RewardTileProps = {
+    tile: Tile;
+};
+declare const RewardTile: React.FC<RewardTileProps> & {
+    Media: typeof RewardTileMedia;
+    Title: typeof RewardTileTitle;
+    Description: typeof RewardTileDescription;
+    Points: typeof RewardTilePoints;
+    Chevron: typeof RewardTileChevron;
+    Content: typeof RewardTileContent;
+};
+declare const RewardTileMedia: React.FC;
+declare const RewardTileTitle: React.FC;
+declare const RewardTileDescription: React.FC;
+declare const RewardTilePoints: React.FC;
+declare const RewardTileContent: React.FC<{
+    children: React.ReactNode;
+}>;
+declare const RewardTileChevron: React.FC;
+
+type SectionProps = {
+    section: TSection;
+};
+declare const Section: React__default.FC<SectionProps>;
+
+type TierTileProps$1 = {
+    tile: Tile;
+};
+declare const TierTile$1: React.FC<TierTileProps$1> & {
+    Name: typeof Name;
+    Count: typeof Count;
+    Image: typeof TierTileImage;
+    Progress: typeof Progress;
+    Description: typeof Description;
+    NextName: typeof NextName;
+    NextCount: typeof NextCount;
+};
+type TierTileImageProps = {
+    isFullSize: boolean;
+};
+declare const TierTileImage: React.FC<TierTileImageProps>;
+declare const Name: React.FC;
+declare const NextName: React.FC;
+declare const Count: React.FC;
+declare const NextCount: React.FC;
+declare const Progress: React.FC;
+declare const Description: React.FC;
+
+type TierTileProps = {
+    tile: Tile;
+};
+type TierTileComponent = React.FC<TierTileProps> & {
+    Full: typeof TierTileFull;
+    Half: typeof TierTileHalf;
+    Empty: typeof TierTileEmpty;
+};
+declare const TierTileFull: React.FC<TierTileProps>;
+declare const TierTileHalf: React.FC<TierTileProps>;
+declare const TierTileEmpty: React.FC<TierTileProps>;
+declare const TierTile: TierTileComponent;
+
+type TGroup = {
+    name: string;
+    active: boolean;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    sections: TSection[];
+};
+
+type Fetcher = <T>(endpoint: string, options?: RequestInit) => Promise<APIResponse<T>>;
+type SDKConfig = {
+    apiKey: string;
+    userToken?: string;
+    fetcher?: Fetcher;
+    locale?: string;
+};
+type APIResponse<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>>;
+};
+type WllSdkProviderProps = {
+    children: React__default.ReactNode;
+    theme?: Partial<BaseThemeObject>;
+    config: SDKConfig;
+};
+declare const WllSdkProvider: React__default.FC<WllSdkProviderProps>;
+declare const useWllSdk: () => WllSdkContextType;
+
+export { type APIResponse, type Availability, type Badge, type BadgeDetail, BadgeTile$1 as BadgeTile, BadgeTileConfig, BadgeTileType, BadgeTile as BadgeTileUpdated, BannerTile, BannerTileConfig, BaseBanner, type BaseThemeObject, BaseTile, Button, Carousel, Column as Content, ContentTile, ContentTileConfig, type DerivedProperties, Grid, Group, Icon, type ImagePropsNoSource, LoadingIndicator, PointsTile, PointsTileConfig, type ProgessType, ProgressBar, ProgressIndicator, ProgressType, ProgressiveImage, Reward, type RewardCategory, RewardCategoryTile, RewardCategoryTileConfig, RewardTile, RewardTileConfig, RowHeader, type SDKConfig, Section, SectionHeader, SectionType, type Size, type TSection, Text, type ThemeContextType, type ThemeObject, type ThemeProviderProps, TierTile$1 as TierTile, TierTileConfig, TierTileType, TierTile as TierTileUpdated, type TierType, type Tile, type TileConfig, TileContainer, TileHeight, TileType, UrlTarget, type Variant, WllSdkProvider, useWllSdk };