@appstorys/react-web 1.1.2 → 1.1.3

package/dist/index.d.mts

@@ -1,4 +1,20 @@
-import React from 'react';
+import * as React from 'react';
+import React__default from 'react';
+
+interface WidgetProps {
+    position?: string;
+    leftPadding?: number;
+    rightPadding?: number;
+}
+/**
+ * Web widget component mirroring RN Widgets.tsx implementation
+ * - Accepts optional position, leftPadding, rightPadding props
+ * - Fetches single campaign via useCampaigns hook
+ * - Renders carousel with auto-advance (full) or manual scroll (half)
+ * - Supports static images and Lottie animations
+ * - Portals into host element if position target found
+ */
+declare const Widget: React__default.FC<WidgetProps>;
 
 type CampaignType = 'BAN' | 'FLT' | 'PIP' | 'SUR' | 'CSAT' | 'WID' | 'MOD' | 'BTS' | 'SCRT' | 'STR' | 'TLTP' | 'TTP';
 interface CrossButtonConfig {
@@ -41,7 +57,11 @@ interface BaseCampaign {
     trigger_event?: TriggerEvent;
     position?: string;
     screen?: string;
+    priority?: number;
     details: any;
+    isTesting?: boolean;
+    testUsers?: string[];
+    display_trigger?: boolean;
 }
 interface CampaignBanner extends BaseCampaign {
     campaign_type: 'BAN';
@@ -853,11 +873,11 @@ interface InitializationOptions {
     navigateToScreen?: (screen: string) => void;
 }
 
-declare const Banner: React.FC;
+declare const Banner: React__default.FC;
 
-declare const Pip: React.FC;
+declare const Pip: React__default.FC;
 
-declare const Floater: React.FC;
+declare const Floater: React__default.FC;
 
 declare function personalizeText(text: string): string;
 
@@ -867,29 +887,17 @@ declare global {
     }
 }
 
-declare const Story: React.FC;
+declare const Story: React__default.FC;
 
-interface WidgetProps {
-    position?: string;
-}
-/**
- * Simple web widget component mirroring RN Widgets.tsx implementation
- * - Accepts optional position prop
- * - Fetches single campaign via useCampaigns hook
- * - Renders carousel with auto-advance (full) or manual scroll (half)
- * - Portals into host element if position target found
- */
-declare const Widget: React.FC<WidgetProps>;
+declare const Tooltip: React__default.FC;
 
-declare const Tooltip: React.FC;
+declare const BottomSheet: React__default.FC;
 
-declare const BottomSheet: React.FC;
+declare const Csat: React__default.FC;
 
-declare const Csat: React.FC;
+declare const Survey: React__default.FC;
 
-declare const Survey: React.FC;
-
-declare const Modal: React.FC;
+declare const Modal: React__default.FC;
 
 interface TrackableProps {
     /**
@@ -899,7 +907,7 @@ interface TrackableProps {
      * its own root DOM node.
      */
     id: string;
-    children: React.ReactNode;
+    children: React__default.ReactNode;
 }
 /**
  * Wraps any child (native element or custom component) in a zero-layout-impact
@@ -911,7 +919,7 @@ interface TrackableProps {
  *     <SomeThirdPartyButton>Checkout</SomeThirdPartyButton>
  *   </Trackable>
  */
-declare const Trackable: React.FC<TrackableProps>;
+declare const Trackable: React__default.FC<TrackableProps>;
 
 interface VariantDetails {
     id?: string;
@@ -930,6 +938,33 @@ declare function selectVariantByWeight(variants: VariantsMap, campaignId?: strin
 declare function resolveCampaignVariant<T extends Campaign>(campaign: T): T;
 declare function getCampaignVariantId(campaign: Campaign): string | undefined;
 
+declare const DEFAULT_OVERLAY_PRIORITIES: Record<string, number>;
+declare const BASE_OVERLAY_Z_INDEX = 10000;
+interface ResolvedPriority {
+    priority: number;
+    hasExplicitPriority: boolean;
+}
+/**
+ * Parses the campaign priority. Backend sends 1-indexed priority (starting from 1).
+ * If no valid positive priority is specified in JSON, falls back to the default overlay rank.
+ */
+declare function parseCampaignPriority(campaign: any): ResolvedPriority;
+/**
+ * Compares two campaigns for priority order.
+ * - Explicit priorities take precedence on ties.
+ * - Lower priority number (1, 2, 3...) indicates higher priority ranking.
+ */
+declare function compareCampaignPriority(a: any, b: any): number;
+/**
+ * Stably sorts an array of campaigns by priority (highest priority first).
+ */
+declare function sortCampaignsByPriority<T extends Campaign>(campaigns: T[]): T[];
+/**
+ * Computes the dynamic z-index for an overlay campaign.
+ * Stacking order matches priority ranks (Rank 1 at back, Rank 10 at top front).
+ */
+declare function getCampaignZIndex(campaign?: any, fallbackType?: CampaignType | string, baseZIndex?: number): number;
+
 declare class AppStorys {
     private state;
     private navigateToScreen?;
@@ -955,8 +990,10 @@ declare class AppStorys {
     set visibility(isVisible: boolean);
     private ensureInitialized;
     personalizeText(text: string): string;
+    Widget: React.FC<WidgetProps>;
+    Widgets: React.FC<WidgetProps>;
 }
 
 declare const instance: AppStorys;
 
-export { instance as AppStorys, type AppStorysStore, type Attributes, Banner, type BaseCampaign, BottomSheet, type BottomSheetElement, type Campaign, type CampaignBanner, type CampaignBottomSheet, type CampaignCsat, type CampaignModal, type CampaignStory, type CampaignSurvey, type CampaignTooltip, type CampaignType, type CampaignWidget, type CrossButtonConfig, Csat, type CsatCampaignDetails, type CsatSpacing, type CsatTextStyle, Floater, type InitializationOptions, Modal, type ModalCampaignDetails, type ModalContent, type ModalCtaRedirection, type ModalCtaStyle, type ModalItem, type ModalItemStyling, type ModalMediaType, type ModalTextStyle, Pip, SdkState, Story, type StoryGroupStyling, type StorySlide, type StorySlideCta, type StorySlideCtaBorderRadius, type StorySlideCtaContainer, type StorySlideCtaText, type StorySlideStyling, Survey, type SurveyCampaignDetails, type SurveyOptionColors, type SurveyOptionStyle, type SurveySlide, type SurveySlideLogicRule, type SurveyTextStyle, type SurveyThankYouButtonConfig, Tooltip, type TooltipItem, type TooltipStyling, Trackable, type TrackableProps, type TriggerEvent, type TriggerEventConfig, type TriggerEventObject, type VariantDetails, type VariantsMap, Widget, type WidgetImage, getCampaignVariantId, getVariantId, hasVariants, personalizeText, resolveCampaignVariant, selectVariantByWeight };
+export { instance as AppStorys, type AppStorysStore, type Attributes, BASE_OVERLAY_Z_INDEX, Banner, type BaseCampaign, BottomSheet, type BottomSheetElement, type Campaign, type CampaignBanner, type CampaignBottomSheet, type CampaignCsat, type CampaignModal, type CampaignStory, type CampaignSurvey, type CampaignTooltip, type CampaignType, type CampaignWidget, type CrossButtonConfig, Csat, type CsatCampaignDetails, type CsatSpacing, type CsatTextStyle, DEFAULT_OVERLAY_PRIORITIES, Floater, type InitializationOptions, Modal, type ModalCampaignDetails, type ModalContent, type ModalCtaRedirection, type ModalCtaStyle, type ModalItem, type ModalItemStyling, type ModalMediaType, type ModalTextStyle, Pip, type ResolvedPriority, SdkState, Story, type StoryGroupStyling, type StorySlide, type StorySlideCta, type StorySlideCtaBorderRadius, type StorySlideCtaContainer, type StorySlideCtaText, type StorySlideStyling, Survey, type SurveyCampaignDetails, type SurveyOptionColors, type SurveyOptionStyle, type SurveySlide, type SurveySlideLogicRule, type SurveyTextStyle, type SurveyThankYouButtonConfig, Tooltip, type TooltipItem, type TooltipStyling, Trackable, type TrackableProps, type TriggerEvent, type TriggerEventConfig, type TriggerEventObject, type VariantDetails, type VariantsMap, Widget, type WidgetImage, type WidgetProps, Widget as Widgets, compareCampaignPriority, getCampaignVariantId, getCampaignZIndex, getVariantId, hasVariants, parseCampaignPriority, personalizeText, resolveCampaignVariant, selectVariantByWeight, sortCampaignsByPriority };

package/dist/index.d.ts

@@ -1,4 +1,20 @@
-import React from 'react';
+import * as React from 'react';
+import React__default from 'react';
+
+interface WidgetProps {
+    position?: string;
+    leftPadding?: number;
+    rightPadding?: number;
+}
+/**
+ * Web widget component mirroring RN Widgets.tsx implementation
+ * - Accepts optional position, leftPadding, rightPadding props
+ * - Fetches single campaign via useCampaigns hook
+ * - Renders carousel with auto-advance (full) or manual scroll (half)
+ * - Supports static images and Lottie animations
+ * - Portals into host element if position target found
+ */
+declare const Widget: React__default.FC<WidgetProps>;
 
 type CampaignType = 'BAN' | 'FLT' | 'PIP' | 'SUR' | 'CSAT' | 'WID' | 'MOD' | 'BTS' | 'SCRT' | 'STR' | 'TLTP' | 'TTP';
 interface CrossButtonConfig {
@@ -41,7 +57,11 @@ interface BaseCampaign {
     trigger_event?: TriggerEvent;
     position?: string;
     screen?: string;
+    priority?: number;
     details: any;
+    isTesting?: boolean;
+    testUsers?: string[];
+    display_trigger?: boolean;
 }
 interface CampaignBanner extends BaseCampaign {
     campaign_type: 'BAN';
@@ -853,11 +873,11 @@ interface InitializationOptions {
     navigateToScreen?: (screen: string) => void;
 }
 
-declare const Banner: React.FC;
+declare const Banner: React__default.FC;
 
-declare const Pip: React.FC;
+declare const Pip: React__default.FC;
 
-declare const Floater: React.FC;
+declare const Floater: React__default.FC;
 
 declare function personalizeText(text: string): string;
 
@@ -867,29 +887,17 @@ declare global {
     }
 }
 
-declare const Story: React.FC;
+declare const Story: React__default.FC;
 
-interface WidgetProps {
-    position?: string;
-}
-/**
- * Simple web widget component mirroring RN Widgets.tsx implementation
- * - Accepts optional position prop
- * - Fetches single campaign via useCampaigns hook
- * - Renders carousel with auto-advance (full) or manual scroll (half)
- * - Portals into host element if position target found
- */
-declare const Widget: React.FC<WidgetProps>;
+declare const Tooltip: React__default.FC;
 
-declare const Tooltip: React.FC;
+declare const BottomSheet: React__default.FC;
 
-declare const BottomSheet: React.FC;
+declare const Csat: React__default.FC;
 
-declare const Csat: React.FC;
+declare const Survey: React__default.FC;
 
-declare const Survey: React.FC;
-
-declare const Modal: React.FC;
+declare const Modal: React__default.FC;
 
 interface TrackableProps {
     /**
@@ -899,7 +907,7 @@ interface TrackableProps {
      * its own root DOM node.
      */
     id: string;
-    children: React.ReactNode;
+    children: React__default.ReactNode;
 }
 /**
  * Wraps any child (native element or custom component) in a zero-layout-impact
@@ -911,7 +919,7 @@ interface TrackableProps {
  *     <SomeThirdPartyButton>Checkout</SomeThirdPartyButton>
  *   </Trackable>
  */
-declare const Trackable: React.FC<TrackableProps>;
+declare const Trackable: React__default.FC<TrackableProps>;
 
 interface VariantDetails {
     id?: string;
@@ -930,6 +938,33 @@ declare function selectVariantByWeight(variants: VariantsMap, campaignId?: strin
 declare function resolveCampaignVariant<T extends Campaign>(campaign: T): T;
 declare function getCampaignVariantId(campaign: Campaign): string | undefined;
 
+declare const DEFAULT_OVERLAY_PRIORITIES: Record<string, number>;
+declare const BASE_OVERLAY_Z_INDEX = 10000;
+interface ResolvedPriority {
+    priority: number;
+    hasExplicitPriority: boolean;
+}
+/**
+ * Parses the campaign priority. Backend sends 1-indexed priority (starting from 1).
+ * If no valid positive priority is specified in JSON, falls back to the default overlay rank.
+ */
+declare function parseCampaignPriority(campaign: any): ResolvedPriority;
+/**
+ * Compares two campaigns for priority order.
+ * - Explicit priorities take precedence on ties.
+ * - Lower priority number (1, 2, 3...) indicates higher priority ranking.
+ */
+declare function compareCampaignPriority(a: any, b: any): number;
+/**
+ * Stably sorts an array of campaigns by priority (highest priority first).
+ */
+declare function sortCampaignsByPriority<T extends Campaign>(campaigns: T[]): T[];
+/**
+ * Computes the dynamic z-index for an overlay campaign.
+ * Stacking order matches priority ranks (Rank 1 at back, Rank 10 at top front).
+ */
+declare function getCampaignZIndex(campaign?: any, fallbackType?: CampaignType | string, baseZIndex?: number): number;
+
 declare class AppStorys {
     private state;
     private navigateToScreen?;
@@ -955,8 +990,10 @@ declare class AppStorys {
     set visibility(isVisible: boolean);
     private ensureInitialized;
     personalizeText(text: string): string;
+    Widget: React.FC<WidgetProps>;
+    Widgets: React.FC<WidgetProps>;
 }
 
 declare const instance: AppStorys;
 
-export { instance as AppStorys, type AppStorysStore, type Attributes, Banner, type BaseCampaign, BottomSheet, type BottomSheetElement, type Campaign, type CampaignBanner, type CampaignBottomSheet, type CampaignCsat, type CampaignModal, type CampaignStory, type CampaignSurvey, type CampaignTooltip, type CampaignType, type CampaignWidget, type CrossButtonConfig, Csat, type CsatCampaignDetails, type CsatSpacing, type CsatTextStyle, Floater, type InitializationOptions, Modal, type ModalCampaignDetails, type ModalContent, type ModalCtaRedirection, type ModalCtaStyle, type ModalItem, type ModalItemStyling, type ModalMediaType, type ModalTextStyle, Pip, SdkState, Story, type StoryGroupStyling, type StorySlide, type StorySlideCta, type StorySlideCtaBorderRadius, type StorySlideCtaContainer, type StorySlideCtaText, type StorySlideStyling, Survey, type SurveyCampaignDetails, type SurveyOptionColors, type SurveyOptionStyle, type SurveySlide, type SurveySlideLogicRule, type SurveyTextStyle, type SurveyThankYouButtonConfig, Tooltip, type TooltipItem, type TooltipStyling, Trackable, type TrackableProps, type TriggerEvent, type TriggerEventConfig, type TriggerEventObject, type VariantDetails, type VariantsMap, Widget, type WidgetImage, getCampaignVariantId, getVariantId, hasVariants, personalizeText, resolveCampaignVariant, selectVariantByWeight };
+export { instance as AppStorys, type AppStorysStore, type Attributes, BASE_OVERLAY_Z_INDEX, Banner, type BaseCampaign, BottomSheet, type BottomSheetElement, type Campaign, type CampaignBanner, type CampaignBottomSheet, type CampaignCsat, type CampaignModal, type CampaignStory, type CampaignSurvey, type CampaignTooltip, type CampaignType, type CampaignWidget, type CrossButtonConfig, Csat, type CsatCampaignDetails, type CsatSpacing, type CsatTextStyle, DEFAULT_OVERLAY_PRIORITIES, Floater, type InitializationOptions, Modal, type ModalCampaignDetails, type ModalContent, type ModalCtaRedirection, type ModalCtaStyle, type ModalItem, type ModalItemStyling, type ModalMediaType, type ModalTextStyle, Pip, type ResolvedPriority, SdkState, Story, type StoryGroupStyling, type StorySlide, type StorySlideCta, type StorySlideCtaBorderRadius, type StorySlideCtaContainer, type StorySlideCtaText, type StorySlideStyling, Survey, type SurveyCampaignDetails, type SurveyOptionColors, type SurveyOptionStyle, type SurveySlide, type SurveySlideLogicRule, type SurveyTextStyle, type SurveyThankYouButtonConfig, Tooltip, type TooltipItem, type TooltipStyling, Trackable, type TrackableProps, type TriggerEvent, type TriggerEventConfig, type TriggerEventObject, type VariantDetails, type VariantsMap, Widget, type WidgetImage, type WidgetProps, Widget as Widgets, compareCampaignPriority, getCampaignVariantId, getCampaignZIndex, getVariantId, hasVariants, parseCampaignPriority, personalizeText, resolveCampaignVariant, selectVariantByWeight, sortCampaignsByPriority };