@wlloyalty/wll-react-sdk 1.0.12 → 1.0.20

package/README.md

@@ -1,15 +1,49 @@
-## 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.
 
-## Commit Convention
+## 🤝 Contributing
 
-This repository follows [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages to ensure consistent commits and automated versioning. Each commit message should be structured as follows:
+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
@@ -20,40 +54,48 @@ type(scope?): subject
 ```
 
 ### Types
-- `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, missing semi colons, 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
-
-### Scope
-The scope is optional and represents the section of the codebase the commit modifies (e.g., `auth`, `api`, `ui`).
-
-### Commit Tools
-We use several tools to enforce this convention:
-
-- **Commitlint**: Checks if your commit messages meet the conventional commit format
-- **Commitizen**: CLI tool to help format commit messages
-- **Husky**: Git hooks to enforce commit message format
-
-To make a commit using the interactive commit tool:
+| 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
-```
 
-### Local Setup
-If you're setting up the repository locally, the commit hooks will be installed automatically when you run `yarn install`. However, if you need to reinstall the hooks, you can run:
-
-```bash
+# Reinstall git hooks if needed
 yarn prepare
 ```
 
-This ensures that all commits follow our conventions and maintains a clean, readable git history.
+## 📄 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

@@ -448,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;

package/dist/index.js

@@ -19339,21 +19339,21 @@ var BannerTile = function (_a) {
   var tile = _a.tile;
   return /*#__PURE__*/React__namespace.createElement(BaseBanner, {
     tile: tile
-  }, /*#__PURE__*/React__namespace.createElement(BannerTile.Image, null), /*#__PURE__*/React__namespace.createElement(View$2, {
+  }, /*#__PURE__*/React__namespace.createElement(BannerTile.Media, null), /*#__PURE__*/React__namespace.createElement(View$2, {
     style: styles$a.slideContent
   }, /*#__PURE__*/React__namespace.createElement(BannerTile.Title, null), /*#__PURE__*/React__namespace.createElement(BannerTile.Description, null), /*#__PURE__*/React__namespace.createElement(BannerTile.CTA, null)));
 };
-var BannerTileImage = function () {
+var BannerTileMedia = function () {
   var configuration = useBannerContext().configuration;
   var artworkUrl = configuration.artworkUrl;
   if (!artworkUrl) return null;
   return /*#__PURE__*/React__namespace.createElement(View$2, {
-    style: styles$a.imageContainer
+    style: styles$a.mediaContainer
   }, /*#__PURE__*/React__namespace.createElement(ProgressiveImage, {
     source: {
       uri: artworkUrl
     },
-    style: styles$a.image
+    style: styles$a.media
   }));
 };
 var BannerTileTitle = function () {
@@ -19407,14 +19407,14 @@ var styles$a = StyleSheet$1.create({
   slideContent: createResponsiveStyle({
     flex: 1
   }),
-  imageContainer: createResponsiveStyle({
+  mediaContainer: createResponsiveStyle({
     width: '20%',
     aspectRatio: 1,
     position: 'relative',
     overflow: 'hidden',
     marginRight: [8, 8, 24]
   }),
-  image: {
+  media: {
     position: 'absolute',
     width: '100%',
     height: '100%',
@@ -19430,7 +19430,7 @@ var styles$a = StyleSheet$1.create({
     marginBottom: [12, 12, 32]
   })
 });
-BannerTile.Image = BannerTileImage;
+BannerTile.Media = BannerTileMedia;
 BannerTile.Title = BannerTileTitle;
 BannerTile.Description = BannerTileDescription;
 BannerTile.CTA = BannerTileCTA;