@lystech/core 3.0.142 → 3.0.143

package/dist/index.d.ts

@@ -12,6 +12,28 @@ import { RefetchOptions } from '@tanstack/react-query';
 import { RefetchQueryFilters } from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 
+export declare type ActivePromotion = {
+    campaignUID: string;
+    name: string;
+    description: string | null;
+    discountLabel: string;
+    startsAt: string | null;
+    endsAt: string | null;
+    banner: boolean;
+    bannerText: string | null;
+    countdown: boolean;
+    badge: string | null;
+    scope: "all" | "selection";
+    collections: string[];
+};
+
+export declare type ActivePromotions = {
+    now: string;
+    campaigns: ActivePromotion[];
+    /** Par UID de produit : le prix promotionnel décidé par le serveur. */
+    products: Record<string, ProductPromotion>;
+};
+
 export declare type AppliedPromoCodeType = {
     promoCodeObject: PromoCodeType;
     finalTotalPrice: number;
@@ -197,6 +219,9 @@ declare type AuthUserProfileProps = {
 
 export declare const axiosInstance: AxiosInstance;
 
+/** Les campagnes à annoncer en bannière, pour cette collection (ou toute la boutique). */
+export declare function bannersFor(data: ActivePromotions | null | undefined, collectionUID?: string | null): ActivePromotion[];
+
 export declare function BecomeMember({ title, intro, successUrl, cancelUrl, renderAction, onChoosePlan, onLoginRequired, }: BecomeMemberProps): JSX.Element | null;
 
 export declare type BecomeMemberProps = {
@@ -549,6 +574,8 @@ declare interface GenericCardProps {
     pending?: boolean;
 }
 
+export declare function getActivePromotions(): Promise<ActivePromotions>;
+
 export declare function getFeaturedImages(): Promise<ImageType[]>;
 
 export declare function getLoyaltyRewards(): Promise<LoyaltyRewards>;
@@ -844,10 +871,31 @@ declare type OrderBreakdown = {
         name: string;
         productType: string;
         quantity: number;
+        /** Prix unitaire PAYÉ (promotionnel quand une campagne est retenue). */
         itemPrice: number;
         stackPrice: number;
+        /** Présents quand une campagne de promotion baisse le prix de la ligne. */
+        regularPrice?: number;
+        campaignUID?: string;
+        campaignName?: string;
+        campaignStacking?: "exclusive" | "stack";
     }[];
     totalPrice: number;
+    /** Campagnes de promotion retenues (déjà déduites du sous-total). */
+    appliedCampaigns?: {
+        campaignUID: string;
+        name: string;
+        savings: number;
+        stacking: "exclusive" | "stack";
+    }[];
+    campaignSavings?: number;
+    /** Un code ou un avantage plus avantageux a écarté la promotion (un seul rabais par commande). */
+    campaignNotApplied?: string;
+    /** Codes valides mais écartés, avec la raison. */
+    promoNotApplied?: {
+        code: string;
+        reason: string;
+    }[];
     totalItems: number;
     finalPriceWithoutShipping?: number;
     finalPriceIncludingShippingAndFees?: number;
@@ -1056,6 +1104,17 @@ export declare type PostType = {
     fk_createdByAuthKey?: string;
 };
 
+declare type Priced = {
+    UID?: any;
+    itemPrice?: number;
+    itemRealCost?: number;
+    promo?: PromoInfo;
+    /** Prix d'origine gardé pour défaire la promotion (idempotence). */
+    promoBasePrice?: number;
+    promoBaseRealCost?: number;
+    [key: string]: any;
+};
+
 declare interface ProductPopupProps {
     product: CartProduct & {
         variants?: any[];
@@ -1071,6 +1130,19 @@ declare interface ProductPopupProps {
     onClose: () => void;
 }
 
+export declare type ProductPromotion = {
+    regularPrice: number;
+    promoPrice: number;
+    campaignUID: string;
+    campaignName: string;
+    /** Pastille (« -20 % ») ; null : la boutique n'en veut pas. */
+    badge: string | null;
+    /** Montrer le prix courant barré à côté du prix promotionnel. */
+    strikethrough: boolean;
+    endsAt: string | null;
+    stacking: "exclusive" | "stack";
+};
+
 declare type ProductProp = {
     prop_UID: string;
     prop_value_UID: string;
@@ -1098,6 +1170,29 @@ declare type ProgressiveWebAppContextType = {
     installProgressiveWebApp: () => Promise<void>;
 };
 
+/** La pastille d'un produit en promotion (« -20 % »). */
+export declare function PromoBadge({ label, className }: {
+    label?: string | null;
+    className?: string;
+}): JSX.Element | null;
+
+export declare function PromoBanner({ promotion, onElapsed, className }: PromoBannerProps): JSX.Element | null;
+
+export declare interface PromoBannerProps {
+    promotion: Pick<ActivePromotion, "campaignUID" | "name" | "bannerText" | "discountLabel" | "endsAt" | "countdown">;
+    onElapsed?: () => void;
+    className?: string;
+}
+
+/**
+ * Les bannières des campagnes actives (celles que la boutique a choisi
+ * d'annoncer), pour une collection ou toute la boutique. Rien sans campagne.
+ */
+export declare function PromoBanners({ collectionUID, className }: {
+    collectionUID?: string | null;
+    className?: string;
+}): JSX.Element | null;
+
 export declare function PromoCodeTag({ promoCode, showExpireInfo, onClick, isApplied, onRemove, }: Props_14): JSX.Element;
 
 export declare type PromoCodeType = {
@@ -1114,6 +1209,18 @@ export declare type PromoCodeType = {
     target: string;
 };
 
+export declare type PromoInfo = {
+    campaignUID: string;
+    campaignName: string;
+    badge: string | null;
+    endsAt: string | null;
+    regularPrice: number;
+};
+
+export declare const promotionKeys: {
+    active: (org: string, user: string) => readonly ["promotions-active", string, string];
+};
+
 declare type Props = {
     children: default_2.ReactNode;
     organization?: string;
@@ -1404,7 +1511,7 @@ export declare interface ShopCatalogCollection {
     [key: string]: any;
 }
 
-export declare function ShopCatalogPage({ collections, selectedCollection, soldoutProductUIDs, renderProductCard, renderBanner, primaryColor, secondaryColor, itemsPerPage, defaultShowFilters, onCollectionClick, filtersText, allText, }: ShopCatalogPageProps): JSX.Element;
+export declare function ShopCatalogPage({ collections, selectedCollection, soldoutProductUIDs, renderProductCard, renderBanner, primaryColor, secondaryColor, itemsPerPage, defaultShowFilters, onCollectionClick, filtersText, allText, promotions, }: ShopCatalogPageProps): JSX.Element;
 
 export declare interface ShopCatalogPageProps {
     collections: ShopCatalogCollection[];
@@ -1419,6 +1526,14 @@ export declare interface ShopCatalogPageProps {
     onCollectionClick?: (collection: ShopCatalogCollection) => void;
     filtersText?: string;
     allText?: string;
+    /**
+     * Campagnes de promotion (défaut : oui). Chaque produit passé à
+     * `renderProductCard` porte alors le prix décidé par le serveur
+     * (`itemPrice` = prix promotionnel, `itemRealCost` = prix barré,
+     * `promo.badge` = pastille), et les bannières s'affichent au-dessus.
+     * Sans campagne active : rien ne change.
+     */
+    promotions?: boolean;
 }
 
 export declare interface ShopCatalogProduct {
@@ -1472,6 +1587,8 @@ declare type ShopProductCardProps = {
             keyUID: string;
             name: string;
         }[];
+        /** Posé par withPromotion : campagne en cours (prix décidé par le serveur). */
+        promo?: PromoInfo;
     };
     onClick?: () => void;
 };
@@ -1844,6 +1961,13 @@ export declare const usePopup: () => ProviderType;
 
 export declare const useProgressiveWebApp: () => ProgressiveWebAppContextType;
 
+export declare function usePromotions(enabled?: boolean): {
+    data: ActivePromotions | undefined;
+    loading: boolean;
+    error: unknown;
+    refetch: () => void;
+};
+
 export declare const usePushNotifications: () => PushNotificationContextType;
 
 /**
@@ -1896,6 +2020,13 @@ export declare const useUserRoleDetails: (authKey: string, organizationSubdomain
 
 export declare function validatePromoCode(code: string, products: any[]): Promise<AppliedPromoCodeType>;
 
+export declare function withPromotion<T extends Priced>(product: T, promos?: Record<string, ProductPromotion> | null): T;
+
+/** Une collection (et les variantes de ses produits) aux prix de la promotion. */
+export declare function withPromotionsInCollection<C extends {
+    products?: any[];
+} | undefined | null>(collection: C, data?: ActivePromotions | null): C;
+
 
 export * from "@lystech/sections";