yt-uikit 0.10.2 → 0.10.3

package/dist/esm/components/Loyalty/types.d.ts

@@ -0,0 +1,369 @@
+import { CouponTemplate } from "./WaysToRedeem";
+export interface LoyaltyProfileProps {
+    isMobile?: boolean;
+    previewMode?: boolean;
+    bannerBackground?: string;
+    bannerBackgroundType?: 'shape' | 'static';
+    bannerImage?: string;
+    bannerTextColor?: string;
+    bannerTextAlignment?: 'start' | 'center' | 'end';
+    showWatermark?: boolean;
+    watermarkColor?: string;
+    themePrimaryColor?: string;
+    themeContrastColor?: string;
+    themeSecondaryColor?: string;
+    themeSecondaryContrastColor?: string;
+    themeBackgroundColor?: string;
+    themeTextColor?: string;
+    themeAccentColor?: string;
+    widgetOpen?: boolean;
+    widgetPosition?: 'start' | 'center' | 'end';
+    widgetRoundedCorners?: boolean;
+    ctaPrimaryColor?: string;
+    ctaPrimaryContrastColor?: string;
+    ctaBorderColor?: string;
+    ctaSecondaryColor?: string;
+    ctaSecondaryContrastColor?: string;
+    ctaShowIcon?: boolean;
+    ctaBorderRadius?: string;
+    showWaysToEarn?: boolean;
+    showWCoinValue?: boolean;
+    showReferral?: boolean;
+    showTransactions?: boolean;
+    showVipSection?: boolean;
+    showLogo?: boolean;
+    brandName?: string;
+    headingEyebrow?: string;
+    userGreeting?: string;
+    balanceCoins?: number | string;
+    maxRedeemableCoins?: number | string;
+    coinValInr?: number | string;
+    currencyCode?: string;
+    tokenName?: string;
+    brandLogoUrl?: string;
+    rateTitle?: string;
+    rateSub?: string;
+    couponHeading?: string;
+    couponCode?: string;
+    couponImage?: string;
+    onCouponAvail: (couponTemplateId: number) => Promise<CouponAvailResponse>;
+    couponList?: CouponTemplate[];
+    referralLink?: string;
+    userRewardTier?: UserRewardTier;
+    brandRewardTiers?: RewardTier[];
+    userData?: UserData;
+    activityRewards?: BrandActivityRewardSettings;
+    brandRewardProgram: BrandRewardProgram;
+    onBirthdayUpdate: (date: string) => Promise<boolean>;
+    onSocialClick: (url: string, type: string) => Promise<boolean>;
+    isLoading: boolean;
+    onWaysToRedeem?: () => void;
+    onClose?: () => void;
+    onLogout?: () => void;
+}
+export interface RewardsModalProps {
+    isLoading?: boolean;
+    themeBackgroundColor?: string;
+    themeTextColor?: string;
+    themeAccentColor?: string;
+    bannerBackground?: string;
+    bannerBackgroundType?: 'shape' | 'static';
+    bannerImage?: string;
+    bannerTextColor?: string;
+    watermarkColor?: string;
+    widgetRoundedCorners?: boolean;
+    guestWidgetImage?: string;
+    bannerTextAlignment?: 'start' | 'center' | 'end';
+    showWatermark?: boolean;
+    showLogo?: boolean;
+    logourl?: string;
+    guestGreeting?: string;
+    existingUserGreeting?: string;
+    phone?: string;
+    email?: string;
+    emailRequired?: boolean;
+    validatePhone?: (newVal: boolean) => void;
+    setEmailRequired?: (newVal: boolean) => void;
+    onPhoneChange?: (newVal: string) => void;
+    onEmailChange?: (newVal: string) => void;
+    onClose?: () => void;
+    onRegister?: (val?: string) => Promise<boolean>;
+    handleChangeNumber?: () => void;
+    handleResendOtp?: () => void;
+    handleSessionDetected?: () => void;
+    onSendOTP?: () => Promise<boolean>;
+    isSessionDetected?: boolean;
+    authType?: 'default' | 'phone' | 'ytAuth' | 'email';
+    formFilled?: boolean;
+    redirectUrl?: string;
+    ctaTitle?: string;
+    ctaMainColor?: string;
+    ctaMainContrastColor?: string;
+    ctaPrimaryColor?: string;
+    ctaPrimaryContrastColor?: string;
+    registerLink?: string;
+    brandTitle?: string;
+    brandLogoUrl?: string;
+    widgetOpen?: boolean;
+    heading?: string;
+    subcopy?: string;
+    termsHref?: string;
+    privacyHref?: string;
+    styleVars?: Record<string, string>;
+    countryCode?: string;
+    isMobilePreview?: boolean;
+    viewportMode?: "auto" | "mobile" | "desktop";
+}
+export interface AvailableDiscount {
+    discountCode: string;
+    discountValueInInr: string;
+    __entity?: 'Discount' | string;
+}
+export interface CatalogDealsProductsPayload {
+    productGid: string;
+    variantGid: string;
+}
+export interface CustomBenefitPayload {
+    title: string;
+    value?: string;
+    description?: string;
+    icon?: string;
+}
+export interface RewardTier {
+    id: number;
+    name: string;
+    brandId: number;
+    rewardMultiplier: number;
+    redemptionMultiplier: number;
+    rewardTierCriteria: "ltv" | "loyalty_points" | "payment" | null;
+    minimumLtvRequired: number | null;
+    minimumLoyaltyPointsRequired: number | null;
+    loyaltyRewardMultiplier: number | null;
+    birthdayRewardMultiplier: number | null;
+    socialTwitterRewardMultiplier: number | null;
+    socialInstagramRewardMultiplier: number | null;
+    socialFacebookRewardMultiplier: number | null;
+    socialYoutubeRewardMultiplier: number | null;
+    referrerOrderRewardMultiplier: number | null;
+    icon: string | null;
+    benefits: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    expiresInDays: number | null;
+    membershipEligibilityProductId: string | null;
+    shopifyCustomerTags: {
+        tags: string[];
+    };
+    isActive: boolean;
+    couponTemplateId: number | null;
+    purchaseValueMethod?: "order_count" | "purchase_value" | null;
+    paidMethod?: "purchase_in_cash" | "purchase_in_points" | null;
+    period?: "lifetime" | "annual" | "custom" | null;
+    periodDurationInMonths?: number | null;
+    continuationCriteria?: number | null;
+    minimumOrderCountRequired?: number | null;
+    minimumOrderValueRequired?: number | null;
+    minimumCashRequired?: number | null;
+    minimumPointsRequired?: number | null;
+    tierThemeColor?: string | null;
+    widgetVisibility?: boolean | null;
+    membershipTierProductTitle?: string | null;
+    membershipTierProductDescription?: string | null;
+    membershipTierProductMedia?: string | null;
+    customBenefits?: CustomBenefitPayload[] | null;
+    catalogDealsProducts?: CatalogDealsProductsPayload[];
+}
+export type UserRewardTier = {
+    currentPoints?: number;
+    totalOrders?: number;
+    currentLtv?: number;
+    currentTier: RewardTier | null;
+    nextTier: RewardTier | null;
+};
+export interface UserData {
+    id: number;
+    points: number;
+    aggregatedPoints: number;
+    previouslyOrdered: boolean;
+    __entity?: 'UserBrandLink' | string;
+    availableDiscount?: AvailableDiscount | null;
+    hasSetBirthday: boolean;
+    hasFollowedOnInstagram: boolean;
+    hasLikedOnFacebook: boolean;
+    hasSharedOnFacebook: boolean;
+    hasFollowedOnTwitter: boolean;
+    hasSubscribedOnYoutube: boolean;
+    hasClickedOnCustomLink: boolean;
+    hasAvailedFirstOrderReward: boolean;
+    hasAvailedSecondOrderReward: boolean;
+}
+export interface BrandRewardProgram {
+    id: number;
+    brandId: number;
+    programStatus: boolean;
+    programIcon: string;
+    programAuthType: string;
+    programTitle: string;
+    programVisibility: boolean;
+    pointsValueInInr: number;
+    coinName: string;
+    organizationIdSync: boolean;
+    orderCreditCriteria: string;
+    orderCreditStatus: boolean;
+    orderCreditType: string;
+    orderCreditValue: number;
+    orderCreditMethodRestriction: string;
+    orderCreditProductRestriction: any[];
+    coinExpirationPeriod: number;
+    redemptionMethod: string;
+    redemptionValue: number;
+    redemptionStatus: boolean;
+    redemptionIcon: string;
+    redemptionMaxPoints: number;
+    redemptionMovRequired: number;
+    redemptionCodeCombination: boolean;
+    orderRewardCreditReversal: boolean;
+    orderRewardRedemtionReversal: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    __entity: string;
+}
+export interface CreditOnActivitiesProperties {
+    customLink: ActivityProperty;
+    twitterLike: ActivityProperty;
+    youtubeLike: ActivityProperty;
+    facebookLike: ActivityProperty;
+    referralRewardConfig?: ReferralRewardConfig;
+    signUpReward: SignUpRewardProperty;
+    twitterShare: ActivityProperty;
+    youtubeShare: ActivityProperty;
+    facebookShare: ActivityProperty;
+    instagramLike: ActivityProperty;
+    twitterFollow: ActivityProperty;
+    birthdayReward: BirthdayRewardProperty;
+    facebookFollow: ActivityProperty;
+    feedbackReward: FeedbackRewardProperty;
+    instagramFollow: ActivityProperty;
+    firstOrderReward: FirstOrderRewardProperty;
+    secondOrderReward: SecondOrderRewardProperty;
+    youtubeSubscription: ActivityProperty;
+}
+export interface SignUpRewardProperty extends WidgetActivityProperty {
+    restrictOnReferralReward?: boolean;
+}
+export interface FeedbackRewardProperty extends WidgetActivityProperty {
+    creditCriteria?: string;
+    url?: string;
+    limitToOneTimePerOrder?: boolean;
+}
+export interface FirstOrderRewardProperty extends WidgetActivityProperty {
+    type?: string;
+    restrictFirstOrderReward?: boolean;
+    restrictOnReferralReward?: boolean;
+}
+export interface SecondOrderRewardProperty extends WidgetActivityProperty {
+    type?: string;
+    restrictPurchaseReward?: boolean;
+}
+export interface BrandActivityRewardSettings {
+    id: number;
+    brandId: number;
+    programId: number;
+    creditOnActivitiesProperties: CreditOnActivitiesProperties;
+    creditOnSignupValue: number | null;
+    creditOnFirstOrderValue: number | null;
+    creditOnSecondOrderValue: number | null;
+    creditOnFeedbackValue: number | null;
+    creditOnBirthdayValue: number | null;
+    creditOnInstagramFollowValue: number | null;
+    creditOnInstagramShareValue: number | null;
+    creditOnInstagramLikeValue: number | null;
+    creditOnFacebookFollowValue: number | null;
+    creditOnFacebookShareValue: number | null;
+    creditOnFacebookLikeValue: number | null;
+    creditOnTwitterFollowValue: number | null;
+    creditOnTwitterShareValue: number | null;
+    creditOnTwitterLikeValue: number | null;
+    creditOnYouTubeSubscriptionValue: number | null;
+    creditOnYouTubeLikeValue: number | null;
+    creditOnYouTubeShareValue: number | null;
+    creditOnCustomLinkValue: number | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    __entity: string;
+}
+export interface ActivityProperty {
+    url?: string;
+    icon?: string;
+    status?: boolean;
+    enabled?: boolean;
+    offerTitle?: string;
+}
+export interface WidgetActivityProperty {
+    icon?: string;
+    status?: boolean;
+    enabled?: boolean;
+    offerTitle?: string;
+    widgetVisibility?: boolean;
+}
+export interface BirthdayRewardProperty extends WidgetActivityProperty {
+    type?: string;
+}
+export interface ReferralRewardConfig {
+    enabled?: boolean;
+    shareMethod?: "referral_code" | "referral_url";
+    codePrefix?: string;
+    campaignVisibility?: "ways_to_earn" | "details" | "both";
+    offerTitle?: string;
+    offerIcon?: string;
+    customizeReferralSectionContent?: boolean;
+    referrerReward?: ReferralRewardDetails;
+    refereeReward?: ReferralRewardDetails;
+}
+export interface ReferralRewardDetails {
+    enabled?: boolean;
+    method?: "points" | "discount_code" | "freebie";
+    completionCriteria?: "signup" | "purchase" | "first_order";
+    pointsConfig?: {
+        points: number;
+    } | null;
+    discountConfig?: {
+        type: "percentage_off" | "fixed_amount" | "referee_order_value";
+        value: number;
+        expiresInDays?: number | null;
+        appliesTo: {
+            type: "all_products" | "collections";
+            collectionIds?: string[];
+        };
+    } | null;
+    freebieConfig?: {
+        freebieType?: string;
+    } | null;
+}
+export interface CouponAvailResponse {
+    discountCode: string;
+    discountValueInInr: number;
+    expiresAt: string;
+    shopifyStoreId: string;
+    brandId: number;
+    userId: number;
+    couponTemplateId: number;
+    discountType: string;
+    shopifyDiscountCodeId: string;
+    creationMethod: string;
+    discountPercentage: number | null;
+    expiredAt: string | null;
+    discountUsageCount: number | null;
+    isUsed: boolean;
+    minPurchaseAmount: number | null;
+    freeProductId: number | null;
+    metafieldId: number | null;
+    metafieldJsonValue: any | null;
+    discountId: number;
+    isActive: boolean;
+    deletedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/esm/components/index.d.ts

@@ -3,7 +3,12 @@ export { default as SpinnerWheel } from "./SpinnerWheel";
 export { default as Cart } from "./Cart";
 export { default as Bundle } from "./BundleBlock";
 export { default as BundleLoader } from "./BundleBlock/Loader";
+export { LoyaltyProfile as LoyaltyScreen } from "./Loyalty";
+export { LoyaltyLauncher as LoyaltyLauncher } from "./Loyalty";
+export { RewardsModal as RewardsModal } from "./Loyalty";
+export { LoyaltyWidget as LoyaltyWidget } from "./Loyalty";
 export { LoyaltyProductCatalog as LoyaltyProductCatalog } from "./Loyalty";
+export { PointEarnBadge as PointEarnBadge } from "./Loyalty";
 export type { LoyaltyProductCatalogConfig, LoyaltyCatalogProduct, LoyaltyCatalogTier, LoyaltyCatalogFilter, CatalogDisplayMode, CatalogTextAlignment, } from "./Loyalty";
 export { default as LoyaltyPageBlock, LoyaltyPageConfigType, LoyaltyPageProps, } from "./LoyaltyPageBlock/LoyaltyPageBlock";
 export { default as ProductOffers, ProductsOffersConfigType, CartCheckpoint, } from "./ProductOffersBlock/ProductsOffers";