@wlloyalty/wll-react-sdk 1.0.10 → 1.0.12

package/README.md

@@ -6,3 +6,54 @@ This library is compatible with:
 - 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.
+
+## Commit Convention
+
+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:
+
+```
+type(scope?): subject
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### 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:
+```bash
+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
+yarn prepare
+```
+
+This ensures that all commits follow our conventions and maintains a clean, readable git history.

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;
@@ -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 };