@lystech/core 3.0.140 → 3.0.141

package/dist/index.d.ts

@@ -197,6 +197,42 @@ declare type AuthUserProfileProps = {
 
 export declare const axiosInstance: AxiosInstance;
 
+export declare function BecomeMember({ title, intro, successUrl, cancelUrl, renderAction, onChoosePlan, onLoginRequired, }: BecomeMemberProps): JSX.Element | null;
+
+export declare type BecomeMemberProps = {
+    title?: string;
+    intro?: string;
+    /** Retour après paiement Stripe (défaut : la page courante). */
+    successUrl?: string;
+    cancelUrl?: string;
+    /**
+     * Bouton de paiement PROPRE à la boutique pour un plan non relié à un prix
+     * Stripe (ex. son propre bouton de paiement). Prime sur `onChoosePlan`.
+     */
+    renderAction?: (plan: LoyaltyPlan, ctx: {
+        renew: boolean;
+    }) => ReactNode;
+    /** Paiement hors Stripe (PayPal, page dédiée…) pour un plan non relié à Stripe. */
+    onChoosePlan?: (plan: LoyaltyPlan) => void;
+    /** Le client n'est pas connecté : mener à la connexion. */
+    onLoginRequired?: () => void;
+};
+
+export declare type BenefitView = {
+    benefitUID: string;
+    name: string;
+    description: string | null;
+    kind: "percent_off" | "amount_off" | "free_shipping" | "perk";
+    value: number;
+    minSubtotal: number;
+    minItems: number;
+    effectLabel: string;
+    audienceLabel: string;
+    audienceMode?: "everyone" | "loggedIn" | "members" | "nonMembers" | "plans";
+    planUIDs: string[];
+    endsOn: string | null;
+};
+
 declare type BillProduct = {
     UID: string;
     billUID?: string;
@@ -221,6 +257,12 @@ declare type BillProduct = {
     lastOrderedOn: string;
 };
 
+export declare function BirthdayForm({ title }: BirthdayFormProps): JSX.Element | null;
+
+export declare type BirthdayFormProps = {
+    title?: string;
+};
+
 declare interface CardItem {
     label: default_2.ReactNode;
     labelIcon?: default_2.ReactNode;
@@ -509,6 +551,16 @@ declare interface GenericCardProps {
 
 export declare function getFeaturedImages(): Promise<ImageType[]>;
 
+export declare function getLoyaltyRewards(): Promise<LoyaltyRewards>;
+
+export declare function getMyBenefits(): Promise<MyBenefits>;
+
+export declare function getMyBirthday(): Promise<MyBirthday>;
+
+export declare function getMyLoyalty(): Promise<MyLoyalty>;
+
+export declare function getMyLoyaltyLedger(limit?: number): Promise<LedgerRow[]>;
+
 export declare function getSinglePostBySlug(slug: string): Promise<PostType>;
 
 export declare function getUserPromoCodes(): Promise<PromoCodeType[]>;
@@ -529,6 +581,18 @@ export declare type ImageType = {
 
 export declare function InstallPwaButton({ size, visible, forceVisible, text, knowMoreUrl, knowMoreText, onAction, onPopupClose }: Props_9): JSX.Element | null;
 
+export declare type LedgerRow = {
+    id: number;
+    delta: number;
+    kind: "earn" | "reverse" | "redeem" | "expire" | "adjust" | "bonus" | "migration" | string;
+    sourceType: string;
+    sourceRef: string | null;
+    availableOn: string;
+    createdOn: string;
+    note: string | null;
+    createdBy: string | null;
+};
+
 declare type Line = {
     UID: string;
     quantity: number;
@@ -544,6 +608,102 @@ declare type Line = {
  */
 export declare function LoadingCircle(): JSX.Element;
 
+export declare function LoyaltyAccount({ hideBirthday, hideBecomeMember, hideCodes, ...buy }: LoyaltyAccountProps): JSX.Element;
+
+export declare type LoyaltyAccountProps = Pick<BecomeMemberProps, "successUrl" | "cancelUrl" | "onChoosePlan" | "onLoginRequired" | "renderAction"> & {
+    /** Masquer les codes personnels (si la boutique les montre déjà ailleurs). */
+    hideCodes?: boolean;
+    /** Masquer « Mon anniversaire » (si la boutique le gère ailleurs). */
+    hideBirthday?: boolean;
+    /** Masquer « Devenir membre ». */
+    hideBecomeMember?: boolean;
+};
+
+export declare const loyaltyKeys: {
+    me: (org: string, user: string) => readonly ["loyalty-me", string, string];
+    ledger: (org: string, user: string) => readonly ["loyalty-ledger", string, string];
+    rewards: (org: string, user: string) => readonly ["loyalty-rewards", string, string];
+    benefits: (org: string, user: string) => readonly ["loyalty-benefits", string, string];
+    birthday: (org: string, user: string) => readonly ["loyalty-birthday", string, string];
+};
+
+export declare type LoyaltyMembership = {
+    planUID: string;
+    planName: string | null;
+    source: "paypal_legacy" | "manual" | "gift" | "stripe";
+    ref: string;
+    startsOn: string | null;
+    endsOn: string | null;
+    status: MembershipStatus_2;
+    isActive: boolean;
+};
+
+export declare type LoyaltyPlan = {
+    UID: string;
+    name: string | null;
+    description: string | null;
+    price: number | null;
+    durationDays: number | null;
+    rank: number;
+    badgeLabel: string | null;
+    badgeColor: string | null;
+    pointsMultiplier: number;
+    /** Proposé sur « Devenir membre ». */
+    isPublic: boolean;
+    /** Achat en ligne par Stripe possible si non nul. */
+    stripePriceId: string | null;
+};
+
+export declare function LoyaltyPoints({ title, showRewards, historyPreview }: LoyaltyPointsProps): JSX.Element | null;
+
+export declare type LoyaltyPointsProps = {
+    title?: string;
+    /** Afficher les récompenses échangeables (défaut : oui). */
+    showRewards?: boolean;
+    /** Lignes d'historique visibles avant « Voir tout » (défaut : 8). */
+    historyPreview?: number;
+};
+
+export declare type LoyaltyPointsSummary = {
+    enabled: boolean;
+    label: string;
+    balance: number;
+    pending: number;
+    lastEarnOn: string | null;
+    expiresOn: string | null;
+};
+
+export declare type LoyaltyRewards = {
+    enabled: boolean;
+    pointsLabel?: string;
+    balance: number | null;
+    next: {
+        reward: {
+            name: string;
+            costPoints: number;
+        };
+        missing: number;
+    } | null;
+    rewards: LoyaltyRewardView[];
+};
+
+export declare type LoyaltyRewardView = {
+    rewardUID: string;
+    name: string;
+    description: string | null;
+    costPoints: number;
+    effect: "percent_off" | "amount_off" | "free_shipping";
+    value: number;
+    effectLabel: string;
+    minSubtotal: number;
+    validityDays: number;
+    redeemable: {
+        ok: boolean;
+        reason?: string;
+        message?: string;
+    };
+};
+
 /** Les adresses que le serveur peut écrire dans un courriel. */
 export declare const LYSTECH_AUTH_ROUTE_PATHS: readonly ["/account/activation/:token", "/account/reset-password/:token", "/suivi/:token"];
 
@@ -559,6 +719,54 @@ export declare function LystechNotFoundPage({ homePath, homeLabel, }?: {
     homeLabel?: string;
 }): JSX.Element;
 
+export declare function MemberBenefits({ title, onBecomeMember, showCodes }: MemberBenefitsProps): JSX.Element | null;
+
+export declare type MemberBenefitsProps = {
+    title?: string;
+    onBecomeMember?: () => void;
+    /** Montrer « Mes codes personnels » (défaut : oui). */
+    showCodes?: boolean;
+};
+
+export declare function MembershipBadge({ label, color }: {
+    label: string;
+    color?: string | null;
+}): JSX.Element;
+
+export declare type MembershipState = {
+    loading: boolean;
+    error: unknown;
+    isLoggedIn: boolean;
+    isMember: boolean;
+    /** A eu une adhésion, plus aucune active. */
+    wasMember: boolean;
+    activePlanUIDs: string[];
+    /** Adhésions actives, avec les réglages de leur plan (badge, rang). */
+    active: Array<LoyaltyMembership & {
+        plan: LoyaltyPlan | null;
+    }>;
+    /** Une entrée par plan déjà eu (active ou non). */
+    memberships: LoyaltyMembership[];
+    /** Tous les plans de la boutique (triés par rang). */
+    plans: LoyaltyPlan[];
+    /** Plans proposés sur « Devenir membre » (isPublic). */
+    availablePlans: LoyaltyPlan[];
+    hasPlan: (planUID: string) => boolean;
+    program: MyLoyalty["program"] | null;
+    points: MyLoyalty["points"];
+    refetch: () => void;
+};
+
+export declare function MembershipStatus({ title, onBecomeMember }: MembershipStatusProps): JSX.Element | null;
+
+declare type MembershipStatus_2 = "active" | "grace" | "canceled_pending" | "expired";
+
+export declare type MembershipStatusProps = {
+    title?: string;
+    /** Mène à « Devenir membre » (ou à la page de la boutique qui le montre). */
+    onBecomeMember?: () => void;
+};
+
 declare type MessageParams = {
     type: "error" | "success" | "warning";
     message: string;
@@ -593,6 +801,43 @@ declare type ModalPopupProps = {
     onFinishOpen?: () => void;
 };
 
+export declare type MyBenefits = {
+    enabled: boolean;
+    mine: BenefitView[];
+    others: BenefitView[];
+    codes: PersonalCode[];
+};
+
+export declare type MyBirthday = {
+    birthday: string | null;
+    year?: number | null;
+    month?: number;
+    day?: number;
+    source: string | null;
+    changeAllowedOn: string | null;
+};
+
+export declare type MyLoyalty = {
+    isLoggedIn: boolean;
+    isMember: boolean;
+    wasMember: boolean;
+    activePlanUIDs: string[];
+    /** Une entrée par plan (l'adhésion qui compte). */
+    memberships: LoyaltyMembership[];
+    /** Tout l'historique, la plus récente d'abord. */
+    history: LoyaltyMembership[];
+    plans: LoyaltyPlan[];
+    program: {
+        enabled: boolean;
+        pointsLabel: string;
+        earnDescription: string | null;
+        featuredPlanUID: string | null;
+        /** Le programme offre un cadeau d'anniversaire. */
+        birthdayEnabled?: boolean;
+    };
+    points: LoyaltyPointsSummary | null;
+};
+
 declare type OrderBreakdown = {
     products: {
         UID: string;
@@ -752,6 +997,16 @@ export declare type PaypalInfoType = {
     enabled: boolean;
 };
 
+export declare type PersonalCode = {
+    id: number;
+    code: string;
+    description: string | null;
+    effectLabel: string;
+    minSubtotal: number;
+    expireOn: string;
+    usesLeft: number;
+};
+
 export declare function PolitiqueAndConditionPage(): JSX.Element;
 
 export declare type PolitiqueAndConditionsType = {
@@ -1100,6 +1355,18 @@ declare type PushNotificationContextType = {
 
 export { QueryClient }
 
+export declare function redeemLoyaltyReward(rewardUID: string, requestId: string): Promise<RedeemResult>;
+
+export declare type RedeemResult = {
+    ok: true;
+    code: string;
+    promoCodeId: number;
+    expireOn: string;
+    costPoints: number;
+    balance: number;
+    replayed: boolean;
+};
+
 export declare function registerNewUser(user: RegisterUserType): Promise<AxiosResponse<any, any>>;
 
 declare type RegisterUserType = {
@@ -1111,6 +1378,15 @@ declare type RegisterUserType = {
     birthday?: string;
 };
 
+export declare function saveMyBirthday(b: {
+    day: number;
+    month: number;
+    year?: number | null;
+}): Promise<{
+    success: boolean;
+    birthday: string;
+}>;
+
 export declare interface ShopCatalogCollection {
     UID: string;
     collectionName: string;
@@ -1506,8 +1782,18 @@ export declare const useInvitedToOrders: (email: string, organization?: string)
     fetchStatus: FetchStatus;
 };
 
+export declare function useLoyaltyLedger(enabled?: boolean): UseQueryResult<LedgerRow[], unknown>;
+
+export declare function useLoyaltyRewards(enabled?: boolean): UseQueryResult<LoyaltyRewards, unknown>;
+
 export declare const useLystechPolitiqueAndConditions: () => UseQueryResult<PolitiqueAndConditionsType[], unknown>;
 
+export declare function useMembership(): MembershipState;
+
+export declare function useMyBenefits(enabled?: boolean): UseQueryResult<MyBenefits, unknown>;
+
+export declare function useMyBirthday(enabled?: boolean): UseQueryResult<MyBirthday, unknown>;
+
 export declare const useOptionalLocation: () => Location_2<any>;
 
 export declare const useOptionalNavigate: () => NavigateFunction | ((to: string | number, options?: {
@@ -1588,6 +1874,11 @@ export declare type UserSubscription = {
     rewards?: SubscriptionReward[];
 };
 
+export declare function useSectionsSession(): {
+    cle: string | null;
+    entetes: Record<string, string> | undefined;
+};
+
 export declare const useSinglePost: (slug: string, organization: string) => UseQueryResult<PostType, unknown>;
 
 export declare const useTheme: () => ThemeContextType;