@retaila/shared-types 1.1.97 → 1.1.103

package/dist/index.d.mts

@@ -2250,4 +2250,380 @@ interface UpdateStoreTemplateDTO {
     isActive?: boolean;
 }
 
-export { type Account, type AccountAiCreditTransaction, type AccountAiCredits, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountCurrencyConfig, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountExchangeRate, type AccountExchangeRateListResponse, type AccountExchangeRateMetadata, type AccountExchangeRateQueryDto, type AccountExchangeRateResponse, AccountExchangeRateType, type AccountExchangeRateWithEffectiveRate, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, type AccountPaymentMethod, AccountPaymentMethodStatus, AccountStatus, type Address, type AdminOrderStatusChangeDto, AiCreditSource, AiCreditTransactionReason, AiCreditType, type AiCreditsBalance, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, type ButtonStyle, type Campaign, type CampaignBudget, CampaignBudgetType, type CampaignBudgetUsage, CampaignStatus, type Cart, type CartConfirmDto, type CartDeliveryMethod, type CartDeliveryMethodAdjustment, type CartDeliveryMethodCreateData, type CartDeliveryMethodCreateDto, type CartDeliveryMethodFindParams, type CartDeliveryMethodResponse, type CartDeliveryMethodUpdateData, type CartDeliveryMethodUpdateDto, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, type CartLineItemAdjustment, type CartPromotion, CartSource, CartStatus, type CartUpdateDto, type CreateAccountDeliveryOptionDTO, type CreateAccountExchangeRateDto, type CreateDeliveryOptionDto, type CreateExchangeRateDto, type CreateFulfillmentDto, type CreateFulfillmentItemDto, type CreatePromotionDTO, type CreateStoreTemplateDTO, Currency, type CurrencyConversion, type Customer, CustomerStatus, type CustomerUpsertDto, DayOfWeek, DeliveryType, type DeliveryZoneInput, type EffectiveExchangeRate, type ExchangeRate, type ExchangeRateListResponse, type ExchangeRateMetadata, type ExchangeRateQueryDto, type ExchangeRateResponse, type Fulfillment, type FulfillmentDeliveryOption, type FulfillmentItem, type FulfillmentLabel, type FulfillmentLabelCreateData, type FulfillmentLabelUpdateData, type FulfillmentProviderAdapter, type FulfillmentProviderContext, type FulfillmentProviderCreateInput, type FulfillmentProviderCreateOutput, type FulfillmentProviderKey, type FulfillmentProviderProcessWebhookInput, type FulfillmentProviderProcessWebhookOutput, type FulfillmentRecollectionCapabilities, type FulfillmentRecollectionConfig, type FulfillmentRecollectionMode, type FulfillmentRecollectionSchedule, FulfillmentStatus, type GeoZone, type GeoZoneInput, GeoZoneStatus, type Integration, IntegrationCategory, type IntegrationDeliveryZone, IntegrationDeliveryZoneStatus, IntegrationStatus, type MapPosition, type Media, MediaType, type NextStatusAction, type Order, type OrderCreateFromCartDto, type OrderDeliveryMethod, type OrderDeliveryMethodAdjustment, type OrderDeliveryMethodCreateData, type OrderDeliveryMethodUpdateData, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, type OrderLineItemAdjustment, OrderPaymentStatus, type OrderPromotion, OrderSource, OrderStatus, type Payment, type PaymentCardBrand, PaymentCardBrandKey, type PaymentConversion, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, PaymentStatus, type Phone, type PickupLocation, type Product, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, ProductVariantStatus, type Promotion, type PromotionApplicationMethod, type PromotionApplicationMethodInput, type PromotionApplicationMethodPromotionRule, PromotionApplicationType, type PromotionListFilters, type PromotionPromotionRule, type PromotionRule, type PromotionRuleInput, PromotionRuleOperator, type PromotionRuleValue, PromotionStatus, PromotionTargetType, PromotionType, PubSubTopics, type RoundingConfig, RoundingMethod, RoundingRule, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StatusFlow, type StoreBanner, StoreBannerStatus, type StoreCustomization, type StoreCustomizationComponentSettings, type StoreCustomizationLayoutComponent, type StoreCustomizationPage, type StoreCustomizationPageComponent, type StoreCustomizationSeo, type StoreCustomizationThemeButtons, type StoreCustomizationThemeColors, type StoreCustomizationThemeTypography, type StorePage, StorePageStatus, StorePageType, type StoreSettings, type StoreTemplate, type StoreTemplateMocks, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type ThemeConfig, type UpdateAccountDeliveryOptionDTO, type UpdateAccountExchangeRateAllDto, type UpdateAccountExchangeRateDto, type UpdateExchangeRateDto, type UpdateFulfillmentDto, type UpdatePromotionDTO, type UpdateStoreTemplateDTO, type Webhook, type WebhookPayload, getAccountPaymentMethodStatusInfo, getCurrencySymbol, getFulfillmentStatusInfo, getIntegrationCategoryName, getOrderPaymentStatusInfo, getOrderStatusInfo, getPaymentCardBrand, getPaymentStatusInfo, getProductStatusInfo, parsePriceFormatPattern };
+/**
+ * Traffic source types
+ */
+declare enum TrafficSource {
+    DIRECT = "direct",
+    ORGANIC = "organic",
+    PAID = "paid",
+    REFERRAL = "referral",
+    SOCIAL = "social",
+    EMAIL = "email",
+    OTHER = "other"
+}
+/**
+ * Device types
+ */
+declare enum DeviceType {
+    DESKTOP = "desktop",
+    MOBILE = "mobile",
+    TABLET = "tablet"
+}
+/**
+ * Page types for categorization
+ */
+declare enum PageType {
+    HOME = "home",
+    CATALOG = "catalog",
+    PRODUCT = "product",
+    CART = "cart",
+    CHECKOUT = "checkout",
+    ORDER_CONFIRMATION = "order_confirmation",
+    PAGE = "page",
+    SEARCH = "search",
+    OTHER = "other"
+}
+/**
+ * Event types for analytics tracking
+ */
+declare enum AnalyticsEventType {
+    SESSION_START = "session_start",
+    SESSION_END = "session_end",
+    PAGE_VIEW = "page_view",
+    PRODUCT_VIEW = "product_view",
+    PRODUCT_LIST_VIEW = "product_list_view",
+    PRODUCT_SEARCH = "product_search",
+    ADD_TO_CART = "add_to_cart",
+    REMOVE_FROM_CART = "remove_from_cart",
+    UPDATE_CART_QUANTITY = "update_cart_quantity",
+    CHECKOUT_START = "checkout_start",
+    CHECKOUT_STEP = "checkout_step",
+    CHECKOUT_COMPLETE = "checkout_complete",
+    PURCHASE = "purchase",
+    CLICK = "click",
+    SCROLL = "scroll"
+}
+/**
+ * Funnel steps for sales funnel analysis
+ */
+declare enum FunnelStep {
+    VISIT = "visit",
+    PRODUCT_VIEW = "product_view",
+    ADD_TO_CART = "add_to_cart",
+    CHECKOUT_START = "checkout_start",
+    CHECKOUT_COMPLETE = "checkout_complete",
+    PURCHASE = "purchase"
+}
+/**
+ * Analytics Session - Tracks a user visit session
+ */
+interface AnalyticsSession extends BaseEntityWithAccount {
+    visitorId: string;
+    cartId?: string;
+    customerId?: string;
+    startedAt: Date;
+    endedAt?: Date;
+    duration?: number;
+    lastActivityAt: Date;
+    source: TrafficSource;
+    medium?: string;
+    campaign?: string;
+    content?: string;
+    term?: string;
+    referrer?: string;
+    referrerDomain?: string;
+    landingPage: string;
+    exitPage?: string;
+    pageviews: number;
+    events: number;
+    device: DeviceType;
+    browser?: string;
+    browserVersion?: string;
+    os?: string;
+    osVersion?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+    country?: string;
+    region?: string;
+    city?: string;
+    isConverted: boolean;
+    conversionValue: number;
+    orderId?: string;
+}
+/**
+ * Analytics Event - Individual user action
+ */
+interface AnalyticsEvent extends BaseEntityWithAccount {
+    sessionId: string;
+    visitorId: string;
+    eventType: AnalyticsEventType;
+    eventData?: Record<string, any>;
+    pageUrl: string;
+    pageTitle?: string;
+    pageType?: PageType;
+    productId?: string;
+    productVariantId?: string;
+    productSku?: string;
+    categoryId?: string;
+    cartId?: string;
+    orderId?: string;
+    value?: number;
+    currency?: string;
+    timestamp: Date;
+}
+/**
+ * Analytics Pageview - Page view tracking
+ */
+interface AnalyticsPageview extends BaseEntityWithAccount {
+    sessionId: string;
+    visitorId: string;
+    pageUrl: string;
+    pageTitle?: string;
+    pageType: PageType;
+    referrerUrl?: string;
+    timeOnPage?: number;
+    scrollDepth?: number;
+    timestamp: Date;
+}
+/**
+ * Analytics Funnel Step - Aggregated funnel data
+ */
+interface AnalyticsFunnelStep extends BaseEntityWithAccount {
+    date: Date;
+    step: FunnelStep;
+    count: number;
+    uniqueVisitors: number;
+    conversionFromPrevious?: number;
+}
+/**
+ * DTO for creating/updating a session
+ */
+interface CreateAnalyticsSessionDto {
+    visitorId: string;
+    cartId?: string;
+    customerId?: string;
+    landingPage: string;
+    source: TrafficSource;
+    medium?: string;
+    campaign?: string;
+    content?: string;
+    term?: string;
+    referrer?: string;
+    referrerDomain?: string;
+    device: DeviceType;
+    browser?: string;
+    browserVersion?: string;
+    os?: string;
+    osVersion?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+}
+/**
+ * DTO for tracking an event
+ */
+interface TrackEventDto {
+    sessionId: string;
+    visitorId: string;
+    eventType: AnalyticsEventType;
+    eventData?: Record<string, any>;
+    pageUrl: string;
+    pageTitle?: string;
+    pageType?: PageType;
+    productId?: string;
+    productVariantId?: string;
+    productSku?: string;
+    categoryId?: string;
+    cartId?: string;
+    orderId?: string;
+    value?: number;
+    currency?: string;
+}
+/**
+ * DTO for tracking a pageview
+ */
+interface TrackPageviewDto {
+    sessionId: string;
+    visitorId: string;
+    pageUrl: string;
+    pageTitle?: string;
+    pageType: PageType;
+    referrerUrl?: string;
+}
+/**
+ * DTO for session heartbeat (keep alive)
+ */
+interface SessionHeartbeatDto {
+    sessionId: string;
+    visitorId: string;
+    currentPage?: string;
+    scrollDepth?: number;
+    timeOnPage?: number;
+    pageviewId?: string;
+}
+/**
+ * Real-time analytics data
+ */
+interface RealtimeAnalytics {
+    activeVisitors: number;
+    activeSessions: ActiveSession[];
+    recentEvents: RecentEvent[];
+    pageviewsLastHour: number;
+    conversionsLastHour: number;
+    revenueLastHour: number;
+}
+interface ActiveSession {
+    sessionId: string;
+    visitorId: string;
+    currentPage: string;
+    pageType: PageType;
+    device: DeviceType;
+    source: TrafficSource;
+    startedAt: Date;
+    pageviews: number;
+}
+interface RecentEvent {
+    eventType: AnalyticsEventType;
+    pageUrl: string;
+    productName?: string;
+    value?: number;
+    timestamp: Date;
+}
+/**
+ * Overview analytics for a period
+ */
+interface AnalyticsOverview {
+    totalVisits: number;
+    uniqueVisitors: number;
+    newVisitors: number;
+    returningVisitors: number;
+    totalPageviews: number;
+    avgSessionDuration: number;
+    avgPagesPerSession: number;
+    bounceRate: number;
+    totalConversions: number;
+    conversionRate: number;
+    totalRevenue: number;
+    avgOrderValue: number;
+    visitsPop?: number;
+    conversionsPop?: number;
+    revenuePop?: number;
+}
+/**
+ * Traffic sources breakdown
+ */
+interface TrafficSourcesData {
+    sources: TrafficSourceItem[];
+    total: number;
+}
+interface TrafficSourceItem {
+    source: TrafficSource;
+    visits: number;
+    uniqueVisitors: number;
+    conversions: number;
+    conversionRate: number;
+    revenue: number;
+    percentage: number;
+}
+/**
+ * Sales funnel data
+ */
+interface FunnelData {
+    steps: FunnelStepData[];
+    overallConversionRate: number;
+}
+interface FunnelStepData {
+    step: FunnelStep;
+    label: string;
+    count: number;
+    uniqueVisitors: number;
+    conversionRate: number;
+    dropoffRate: number;
+}
+/**
+ * Campaign performance
+ */
+interface CampaignPerformance {
+    campaigns: CampaignData[];
+    total: {
+        visits: number;
+        conversions: number;
+        revenue: number;
+    };
+}
+interface CampaignData {
+    campaign: string;
+    source: string;
+    medium: string;
+    visits: number;
+    uniqueVisitors: number;
+    conversions: number;
+    conversionRate: number;
+    revenue: number;
+    avgOrderValue: number;
+}
+/**
+ * Top pages data
+ */
+interface TopPagesData {
+    pages: PageData[];
+}
+interface PageData {
+    pageUrl: string;
+    pageTitle: string;
+    pageType: PageType;
+    views: number;
+    uniqueViews: number;
+    avgTimeOnPage: number;
+    bounceRate: number;
+    exitRate: number;
+}
+/**
+ * Product analytics
+ */
+interface ProductAnalyticsData {
+    products: ProductAnalyticsItem[];
+}
+interface ProductAnalyticsItem {
+    productId: string;
+    productName: string;
+    sku: string;
+    views: number;
+    addToCarts: number;
+    purchases: number;
+    viewToCartRate: number;
+    cartToPurchaseRate: number;
+    revenue: number;
+}
+/**
+ * Historical data point for charts
+ */
+interface HistoricalDataPoint {
+    date: string;
+    visits: number;
+    uniqueVisitors: number;
+    pageviews: number;
+    conversions: number;
+    revenue: number;
+}
+/**
+ * Query parameters for analytics endpoints
+ */
+interface AnalyticsQueryParams {
+    startDate: string;
+    endDate: string;
+    compareWithPrevious?: boolean;
+    source?: TrafficSource;
+    device?: DeviceType;
+    campaign?: string;
+}
+/**
+ * Pagination for analytics lists
+ */
+interface AnalyticsPagination {
+    page: number;
+    limit: number;
+    total: number;
+}
+
+export { type Account, type AccountAiCreditTransaction, type AccountAiCredits, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountCurrencyConfig, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountExchangeRate, type AccountExchangeRateListResponse, type AccountExchangeRateMetadata, type AccountExchangeRateQueryDto, type AccountExchangeRateResponse, AccountExchangeRateType, type AccountExchangeRateWithEffectiveRate, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, type AccountPaymentMethod, AccountPaymentMethodStatus, AccountStatus, type ActiveSession, type Address, type AdminOrderStatusChangeDto, AiCreditSource, AiCreditTransactionReason, AiCreditType, type AiCreditsBalance, type AnalyticsEvent, AnalyticsEventType, type AnalyticsFunnelStep, type AnalyticsOverview, type AnalyticsPageview, type AnalyticsPagination, type AnalyticsQueryParams, type AnalyticsSession, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, type ButtonStyle, type Campaign, type CampaignBudget, CampaignBudgetType, type CampaignBudgetUsage, type CampaignData, type CampaignPerformance, CampaignStatus, type Cart, type CartConfirmDto, type CartDeliveryMethod, type CartDeliveryMethodAdjustment, type CartDeliveryMethodCreateData, type CartDeliveryMethodCreateDto, type CartDeliveryMethodFindParams, type CartDeliveryMethodResponse, type CartDeliveryMethodUpdateData, type CartDeliveryMethodUpdateDto, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, type CartLineItemAdjustment, type CartPromotion, CartSource, CartStatus, type CartUpdateDto, type CreateAccountDeliveryOptionDTO, type CreateAccountExchangeRateDto, type CreateAnalyticsSessionDto, type CreateDeliveryOptionDto, type CreateExchangeRateDto, type CreateFulfillmentDto, type CreateFulfillmentItemDto, type CreatePromotionDTO, type CreateStoreTemplateDTO, Currency, type CurrencyConversion, type Customer, CustomerStatus, type CustomerUpsertDto, DayOfWeek, DeliveryType, type DeliveryZoneInput, DeviceType, type EffectiveExchangeRate, type ExchangeRate, type ExchangeRateListResponse, type ExchangeRateMetadata, type ExchangeRateQueryDto, type ExchangeRateResponse, type Fulfillment, type FulfillmentDeliveryOption, type FulfillmentItem, type FulfillmentLabel, type FulfillmentLabelCreateData, type FulfillmentLabelUpdateData, type FulfillmentProviderAdapter, type FulfillmentProviderContext, type FulfillmentProviderCreateInput, type FulfillmentProviderCreateOutput, type FulfillmentProviderKey, type FulfillmentProviderProcessWebhookInput, type FulfillmentProviderProcessWebhookOutput, type FulfillmentRecollectionCapabilities, type FulfillmentRecollectionConfig, type FulfillmentRecollectionMode, type FulfillmentRecollectionSchedule, FulfillmentStatus, type FunnelData, FunnelStep, type FunnelStepData, type GeoZone, type GeoZoneInput, GeoZoneStatus, type HistoricalDataPoint, type Integration, IntegrationCategory, type IntegrationDeliveryZone, IntegrationDeliveryZoneStatus, IntegrationStatus, type MapPosition, type Media, MediaType, type NextStatusAction, type Order, type OrderCreateFromCartDto, type OrderDeliveryMethod, type OrderDeliveryMethodAdjustment, type OrderDeliveryMethodCreateData, type OrderDeliveryMethodUpdateData, OrderDeliveryType, type OrderItem, type OrderItemSnapshot, type OrderLineItemAdjustment, OrderPaymentStatus, type OrderPromotion, OrderSource, OrderStatus, type PageData, PageType, type Payment, type PaymentCardBrand, PaymentCardBrandKey, type PaymentConversion, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderCaptureInput, type PaymentProviderCaptureOutput, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, PaymentStatus, type Phone, type PickupLocation, type Product, type ProductAnalyticsData, type ProductAnalyticsItem, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, ProductVariantStatus, type Promotion, type PromotionApplicationMethod, type PromotionApplicationMethodInput, type PromotionApplicationMethodPromotionRule, PromotionApplicationType, type PromotionListFilters, type PromotionPromotionRule, type PromotionRule, type PromotionRuleInput, PromotionRuleOperator, type PromotionRuleValue, PromotionStatus, PromotionTargetType, PromotionType, PubSubTopics, type RealtimeAnalytics, type RecentEvent, type RoundingConfig, RoundingMethod, RoundingRule, type SessionHeartbeatDto, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StatusFlow, type StoreBanner, StoreBannerStatus, type StoreCustomization, type StoreCustomizationComponentSettings, type StoreCustomizationLayoutComponent, type StoreCustomizationPage, type StoreCustomizationPageComponent, type StoreCustomizationSeo, type StoreCustomizationThemeButtons, type StoreCustomizationThemeColors, type StoreCustomizationThemeTypography, type StorePage, StorePageStatus, StorePageType, type StoreSettings, type StoreTemplate, type StoreTemplateMocks, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type ThemeConfig, type TopPagesData, type TrackEventDto, type TrackPageviewDto, TrafficSource, type TrafficSourceItem, type TrafficSourcesData, type UpdateAccountDeliveryOptionDTO, type UpdateAccountExchangeRateAllDto, type UpdateAccountExchangeRateDto, type UpdateExchangeRateDto, type UpdateFulfillmentDto, type UpdatePromotionDTO, type UpdateStoreTemplateDTO, type Webhook, type WebhookPayload, getAccountPaymentMethodStatusInfo, getCurrencySymbol, getFulfillmentStatusInfo, getIntegrationCategoryName, getOrderPaymentStatusInfo, getOrderStatusInfo, getPaymentCardBrand, getPaymentStatusInfo, getProductStatusInfo, parsePriceFormatPattern };