@wlloyalty/wll-react-sdk 1.0.10 → 1.0.20

package/README.md

@@ -1,8 +1,101 @@
-## Compatibility
+# Loyalty Tiles SDK
 
-This library is compatible with:
+> A React SDK for building customisable loyalty experiences with configurable tiles, themes, and navigation
 
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![React Support](https://img.shields.io/badge/React-18.0.0+-61DAFB?logo=react&logoColor=white)](https://reactjs.org/)
+[![React Native Support](https://img.shields.io/badge/React%20Native-0.70--0.72-61DAFB?logo=react&logoColor=white)](https://reactnative.dev/)
+
+## ✨ Features
+
+- 🎨 **Flexible Theming** - Full control over visual styling with automatic color derivation and responsive design system
+- 🧩 **Composable Tiles** - Pre-built components for rewards, points, badges, and tiers that work together seamlessly
+- 🔌 **Platform Agnostic** - Bring your own navigation and network layer to integrate with any React application
+- 📱 **Mobile First** - Responsive components optimized for both mobile and desktop experiences
+- 🔒 **Secure by Design** - Built-in support for custom API integration through your own backend proxy
+- ⚡ **Easy Integration** - Simple setup with customisable configuration for navigation, theming, and API handling
+
+## 📚 Documentation
+
+- [Getting Started Guide](https://wll-react-sdk.vercel.app/guide/getting-started)
+- [Component Library](https://wll-react-sdk.vercel.app/components/)
+- [Live Storybook Demo](https://66c36701bb14ec551f38279c-ueompbfvfq.chromatic.com/)
+
+## 🚀 Quick Start
+
+```bash
+# npm
+npm install @wll/react-sdk
+
+# yarn
+yarn add @wll/react-sdk
+```
+
+## 💻 System Requirements
+
+The SDK is compatible with:
 - React: ^18.0.0
 - React Native: >=0.70.0 <0.73.0
 
-Please ensure your project's React and React Native versions fall within these ranges for optimal compatibility.
+Please ensure your project meets these version requirements for optimal compatibility.
+
+## 🤝 Contributing
+
+We welcome contributions! This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification to ensure consistent commit messages and automated versioning.
+
+### Commit Message Format
+
+```
+type(scope?): subject
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+| Type | Description |
+|------|-------------|
+| `feat` | New features (e.g., `feat(auth): add Google OAuth login`) |
+| `fix` | Bug fixes (e.g., `fix(api): correct rate limiting logic`) |
+| `hotfix` | Critical bug fixes requiring immediate deployment |
+| `docs` | Documentation changes |
+| `style` | Code style changes (formatting, etc) |
+| `refactor` | Code changes that neither fix bugs nor add features |
+| `perf` | Performance improvements |
+| `test` | Adding or updating tests |
+| `build` | Changes to build system or dependencies |
+| `ci` | Changes to CI configuration |
+| `chore` | Other changes that don't modify src or test files |
+| `revert` | Reverting previous changes |
+| `wip` | Work in progress |
+
+### Development Workflow
+
+We use several tools to maintain code quality:
+- **Commitlint**: Validates commit message format
+- **Commitizen**: Interactive commit message formatter
+- **Husky**: Git hooks for enforcing conventions
+
+```bash
+# Make a commit using the interactive tool
+yarn commit
+
+# Reinstall git hooks if needed
+yarn prepare
+```
+
+## 📄 License
+
+MIT License - See [LICENSE](LICENSE) for more information.
+
+Copyright (c) 2024 WLL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+## 🆘 Support
+
+- [Documentation](https://wll-react-sdk.vercel.app/)
+- [Issues](https://github.com/white-label-loyalty/wll-react-sdk/issues)

package/dist/index.d.ts

@@ -144,8 +144,8 @@ type TierType = {
     attained?: boolean;
 };
 
-declare enum UrlTarget {
-    sameWindow = "SAME_WINDOW",
+declare enum CTALinkTarget {
+    sameWindow = "SAME_FRAME",
     newWindow = "NEW_WINDOW"
 }
 declare enum TierTileType {
@@ -176,7 +176,7 @@ declare class BannerTileConfig {
     description?: string | null;
     ctaText?: string | null;
     ctaLink?: string | null;
-    ctaLinkTarget?: UrlTarget;
+    ctaLinkTarget?: CTALinkTarget;
 }
 declare class PointsTileConfig {
     title?: string | null;
@@ -190,7 +190,8 @@ declare class ContentTileConfig {
     title?: string | null;
     body?: string | null;
     artworkUrl?: string | null;
-    linkURL?: string | null;
+    ctaLinkTarget?: CTALinkTarget;
+    ctaLink?: string | null;
 }
 declare class RewardTileConfig {
     rewardId: string;
@@ -447,12 +448,12 @@ type BannerTileProps = {
     tile: Tile;
 };
 declare const BannerTile: React.FC<BannerTileProps> & {
-    Image: typeof BannerTileImage;
+    Media: typeof BannerTileMedia;
     Title: typeof BannerTileTitle;
     Description: typeof BannerTileDescription;
     CTA: typeof BannerTileCTA;
 };
-declare const BannerTileImage: React.FC;
+declare const BannerTileMedia: React.FC;
 declare const BannerTileTitle: React.FC;
 declare const BannerTileDescription: React.FC;
 declare const BannerTileCTA: React.FC;
@@ -578,6 +579,19 @@ type TGroup = {
     sections: TSection[];
 };
 
+type NavigationHandlerParams = {
+    target: string;
+    windowTarget: string;
+};
+type NavigationConfig = {
+    navigationHandlers?: {
+        external?: (params: NavigationHandlerParams) => void;
+        internal?: (params: NavigationHandlerParams) => void;
+        modal?: (params: NavigationHandlerParams) => void;
+    };
+    baseUrl?: string;
+};
+
 type Fetcher = <T>(endpoint: string, options?: RequestInit) => Promise<APIResponse<T>>;
 type SDKConfig = {
     apiKey: string;
@@ -594,13 +608,15 @@ type WllSdkContextType = ThemeContextType & {
     getGroupByID: (id: string) => Promise<APIResponse<TGroup>>;
     getSectionByID: (id: string) => Promise<APIResponse<TSection>>;
     getTileByID: (id: string) => Promise<APIResponse<Tile>>;
+    handleNavigation: (link: string, target: CTALinkTarget) => void;
 };
 type WllSdkProviderProps = {
     children: React__default.ReactNode;
     theme?: Partial<BaseThemeObject>;
     config: SDKConfig;
+    navigationConfig?: NavigationConfig;
 };
 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 };
+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, CTALinkTarget, 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, type Variant, WllSdkProvider, useWllSdk };