@behio/storefront-sdk 0.29.0 → 0.30.0

package/dist/{chunk-CXKZLKUY.js → chunk-NG46DR3A.js}

@@ -146,6 +146,7 @@ var BehioStorefront = class {
     this.quotes = new QuotesModule(this);
     this.addresses = new AddressModule(this);
     this.shipping = new ShippingModule(this);
+    this.newsletter = new NewsletterModule(this);
   }
   // --- Public methods ---
   /**
@@ -958,6 +959,14 @@ var CustomerModule = class {
   async deleteAddress(addressId) {
     return this.client.request("DELETE", `/customer/addresses/${addressId}`);
   }
+  /**
+   * Loyalty program summary for the logged-in customer (points balance +
+   * value, current tier, next-tier progress, point ratio, referral code,
+   * recent transactions). Requires an authenticated customer session.
+   */
+  async getLoyalty() {
+    return this.client.request("GET", "/customer/loyalty");
+  }
 };
 var PagesModule = class {
   constructor(client) {
@@ -1121,6 +1130,40 @@ var ShippingModule = class {
       { body: input }
     );
   }
+  /**
+   * List pickup points (parcel shops / lockers) for a method that has
+   * `supportsPickupPoints`. Filter with `query` (name / city / zip) for a
+   * "find your branch" box. Send the chosen point's `externalId` back as
+   * `checkout.pickupPointId`.
+   */
+  async getPickupPoints(input) {
+    const query = { methodId: input.methodId };
+    if (input.query) query.query = input.query;
+    if (input.country) query.country = input.country;
+    if (input.limit != null) query.limit = String(input.limit);
+    return this.client.request(
+      "GET",
+      "/catalog/shipping/pickup-points",
+      { query }
+    );
+  }
+};
+var NewsletterModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async subscribe(input) {
+    return this.client.request("POST", "/newsletter/subscribe", {
+      body: input,
+      auth: false
+    });
+  }
+  async unsubscribe(email) {
+    return this.client.request("POST", "/newsletter/unsubscribe", {
+      body: { email },
+      auth: false
+    });
+  }
 };
 
 

package/dist/{chunk-TN5C6CAB.mjs → chunk-O7HDB5R4.mjs}

@@ -146,6 +146,7 @@ var BehioStorefront = class {
     this.quotes = new QuotesModule(this);
     this.addresses = new AddressModule(this);
     this.shipping = new ShippingModule(this);
+    this.newsletter = new NewsletterModule(this);
   }
   // --- Public methods ---
   /**
@@ -958,6 +959,14 @@ var CustomerModule = class {
   async deleteAddress(addressId) {
     return this.client.request("DELETE", `/customer/addresses/${addressId}`);
   }
+  /**
+   * Loyalty program summary for the logged-in customer (points balance +
+   * value, current tier, next-tier progress, point ratio, referral code,
+   * recent transactions). Requires an authenticated customer session.
+   */
+  async getLoyalty() {
+    return this.client.request("GET", "/customer/loyalty");
+  }
 };
 var PagesModule = class {
   constructor(client) {
@@ -1121,6 +1130,40 @@ var ShippingModule = class {
       { body: input }
     );
   }
+  /**
+   * List pickup points (parcel shops / lockers) for a method that has
+   * `supportsPickupPoints`. Filter with `query` (name / city / zip) for a
+   * "find your branch" box. Send the chosen point's `externalId` back as
+   * `checkout.pickupPointId`.
+   */
+  async getPickupPoints(input) {
+    const query = { methodId: input.methodId };
+    if (input.query) query.query = input.query;
+    if (input.country) query.country = input.country;
+    if (input.limit != null) query.limit = String(input.limit);
+    return this.client.request(
+      "GET",
+      "/catalog/shipping/pickup-points",
+      { query }
+    );
+  }
+};
+var NewsletterModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async subscribe(input) {
+    return this.client.request("POST", "/newsletter/subscribe", {
+      body: input,
+      auth: false
+    });
+  }
+  async unsubscribe(email) {
+    return this.client.request("POST", "/newsletter/unsubscribe", {
+      body: { email },
+      auth: false
+    });
+  }
 };
 
 export {

package/dist/{client-BQroQWyY.d.mts → client-CJ_CoUIh.d.mts}

@@ -34,6 +34,53 @@ interface PaginatedResponse<T> {
 interface MessageResponse {
     message: string;
 }
+/** How the shop wants the newsletter opt-in rendered at checkout. */
+type NewsletterOptInDefault = "CHECKED" | "UNCHECKED" | "HIDDEN";
+/** How sold-out products behave in the catalog. */
+type StockBehavior = "HIDE" | "BACKORDER" | "SHOW_SOLD_OUT";
+/**
+ * Merchant-configured checkout & cart rules the storefront MUST honour so the
+ * shop behaves exactly as it was configured in the admin. Mirrors the backend
+ * Eshop settings; the server also enforces the enforceable rules, so these are
+ * for UX (render required fields, consent checkboxes, cart limits, free-shipping
+ * progress) rather than a security boundary.
+ */
+interface CheckoutSettings {
+    /** Guests may order without an account (also on ShopInfo for back-compat). */
+    allowGuestCheckout: boolean;
+    /** Checkout requires a logged-in / registered account. */
+    requireAccount: boolean;
+    /** New registrations wait for merchant approval before ordering (B2B). */
+    requireRegistrationApproval: boolean;
+    /** Phone number is a required checkout field. */
+    requirePhone: boolean;
+    /** Tax id (IČO/DIČ) is a required checkout field. */
+    requireTaxId: boolean;
+    /** Customer may leave an order note. */
+    allowOrderNote: boolean;
+    /** Discount / coupon codes may be applied in the cart. */
+    allowDiscountCodes: boolean;
+    /** Terms & conditions consent checkbox is required to place an order. */
+    requireTermsConsent: boolean;
+    /** GDPR / privacy consent checkbox is required to place an order. */
+    requireGdprConsent: boolean;
+    /** Default state of the newsletter opt-in on the checkout (or hide it). */
+    newsletterOptInDefault: NewsletterOptInDefault;
+    /** Minimum order value in the shop default currency, or null when unset. */
+    minOrderValue: number | null;
+    /** Maximum order value in the shop default currency, or null when unset. */
+    maxOrderValue: number | null;
+    /** Free-shipping threshold (shop default currency) for the cart progress bar. */
+    freeShippingThreshold: number | null;
+    /** Minimum number of items required in the cart to check out. */
+    minItemsInCart: number;
+    /** Maximum quantity of a single product per order, or null when unlimited. */
+    maxItemsPerProduct: number | null;
+    /** How sold-out products behave (HIDE / BACKORDER / SHOW_SOLD_OUT). */
+    stockBehavior: StockBehavior;
+    /** Google Places address autocomplete is enabled; mount the UX when true. */
+    addressAutocompleteEnabled: boolean;
+}
 interface ShopInfo {
     id: string;
     name: string;
@@ -56,6 +103,25 @@ interface ShopInfo {
      * than hardcoded template config.
      */
     quotesEnabled: boolean;
+    /** Full merchant checkout & cart contract. Honour these in cart + checkout. */
+    checkout: CheckoutSettings;
+}
+interface NewsletterSubscribeInput {
+    email: string;
+    /** Preferred locale (ISO-639-1) captured at signup. */
+    locale?: string;
+    /** Where the opt-in came from, e.g. "footer" or "checkout". */
+    source?: string;
+    /** Honeypot: keep empty. A filled value is treated as a bot and ignored. */
+    website?: string;
+}
+interface NewsletterSubscribeResult {
+    success: boolean;
+    /** True when this email was already an active subscriber. */
+    alreadySubscribed: boolean;
+}
+interface NewsletterUnsubscribeResult {
+    success: boolean;
 }
 interface ShopSeo {
     locale: string;
@@ -532,6 +598,12 @@ interface CheckoutAddress {
     firstName: string;
     lastName: string;
     company?: string;
+    /** Company registration number (IČO). Required when `ShopInfo.checkout`
+     *  requires tax ids; loosely validated (6-12 digits). */
+    companyId?: string;
+    /** VAT id (DIČ). Required alongside `companyId` when tax ids are required;
+     *  loosely validated (optional 2-letter country prefix + 6-12 digits). */
+    vatId?: string;
     street: string;
     city: string;
     zip: string;
@@ -550,6 +622,15 @@ interface CheckoutInput {
     email: string;
     phone?: string;
     customerNote?: string;
+    /**
+     * Legal / marketing consent echoed from the checkout checkboxes. Render the
+     * boxes from `ShopInfo.checkout` (requireTermsConsent / requireGdprConsent /
+     * newsletterOptInDefault) and send the customer's choice. The backend rejects
+     * the order when a required consent is not `true`.
+     */
+    termsConsent?: boolean;
+    gdprConsent?: boolean;
+    newsletterOptIn?: boolean;
     /**
      * Chosen shipping method. Required whenever the eshop has at least one
      * enabled shipping method — the backend rejects the order without it.
@@ -563,7 +644,19 @@ interface CheckoutInput {
      * or foreign quote is rejected.
      */
     shippingQuoteId?: string;
+    /**
+     * Chosen pickup point `externalId` from `shipping.getPickupPoints()`.
+     * REQUIRED when the resolved shipping method has `supportsPickupPoints`;
+     * the backend rejects the order without it. Snapshotted onto the order.
+     */
+    pickupPointId?: string;
     paymentMethodId?: string;
+    /**
+     * Loyalty points to redeem on this order. Validated server-side against the
+     * customer's actual balance and the program's redemption cap; ignored for
+     * guests. See `customer.getLoyalty()` for the available balance.
+     */
+    redeemLoyaltyPoints?: number;
 }
 type OrderStatus = (typeof OrderStatuses)[keyof typeof OrderStatuses];
 type PaymentStatus = (typeof PaymentStatuses)[keyof typeof PaymentStatuses];
@@ -890,6 +983,122 @@ interface ShippingQuote extends ShippingMethodSummary {
     /** Quote expiry (epoch ms). Null for fixed-price methods. */
     expiresAt: number | null;
 }
+/**
+ * A pickup point (parcel shop / locker) for a shipping method with
+ * `supportsPickupPoints`. Fetch with `behio.shipping.getPickupPoints()`,
+ * then send the chosen `externalId` as `checkout.pickupPointId`.
+ */
+interface PickupPoint {
+    /** Carrier-native id. Send this back as `checkout.pickupPointId`. */
+    externalId: string;
+    name: string;
+    street: string | null;
+    city: string;
+    zip: string;
+    country: string;
+    latitude: number | null;
+    longitude: number | null;
+    cashOnDelivery: boolean;
+    cardPayment: boolean;
+    /** Per-day opening hours; empty when the provider gives none. */
+    openingHours: PickupPointHours[];
+}
+/** One day's opening-hours block for a pickup point. */
+interface PickupPointHours {
+    /** Provider-native day key (e.g. weekday name or index). */
+    day: string;
+    /** Morning open time. */
+    from1: string | null;
+    /** Morning close time. */
+    to1: string | null;
+    /** Afternoon open time. */
+    from2: string | null;
+    /** Afternoon close time. */
+    to2: string | null;
+}
+/** Input for `behio.shipping.getPickupPoints()`. */
+interface PickupPointsInput {
+    /** Shipping method id (must have `supportsPickupPoints`). */
+    methodId: string;
+    /** Free-text search over name / city / zip. */
+    query?: string;
+    /** ISO 3166-1 alpha-2 country filter; defaults to the method's first
+     *  allowed country or CZ. */
+    country?: string;
+    /** Max results (default 30, capped at 100). */
+    limit?: number;
+}
+/** Public terms of the eshop's loyalty program. */
+interface LoyaltyProgram {
+    name: string;
+    pointName: string;
+    pointNamePlural: string;
+    /** 1 point = `pointValueRatio` currency units. */
+    pointValueRatio: number;
+    currency: string;
+    minRedemptionPoints: number;
+    maxRedemptionPercent: number;
+    combineWithDiscounts: boolean;
+    description: string | null;
+    iconUrl: string | null;
+}
+interface LoyaltyBalance {
+    currentPoints: number;
+    /** `currentPoints` valued in the program currency. */
+    currentPointsValue: number;
+    lifetimePointsEarned: number;
+    lifetimePointsRedeemed: number;
+    lifetimeSpend: number;
+}
+interface LoyaltyTier {
+    name: string;
+    slug: string;
+    color: string | null;
+    earnMultiplier: number;
+    /** Tier perks (human-readable perk lines), or null when the tier has none. */
+    perks: LoyaltyTierPerks | null;
+}
+/** Perks attached to a loyalty tier. */
+interface LoyaltyTierPerks {
+    /** Human-readable perk lines shown on the tier. */
+    list: string[];
+}
+interface LoyaltyNextTier {
+    name: string;
+    slug: string;
+    color: string | null;
+    thresholdType: string;
+    thresholdValue: number;
+    currentValue: number;
+    remaining: number;
+    /** 0-100 progress toward this tier. */
+    progressPercent: number;
+}
+interface LoyaltyTransaction {
+    type: string;
+    /** Positive = earned, negative = redeemed / expired. */
+    points: number;
+    balanceAfter: number;
+    eventType: string | null;
+    description: string | null;
+    createdAt: number;
+}
+/**
+ * Loyalty summary for the logged-in customer. `hasProgram` is false when the
+ * eshop runs no program; `enrolled` is false when the customer has not yet
+ * joined (then `program` still carries the public terms so you can render a
+ * "join and earn" CTA).
+ */
+interface LoyaltySummary {
+    hasProgram: boolean;
+    enrolled: boolean;
+    program: LoyaltyProgram | null;
+    balance: LoyaltyBalance | null;
+    currentTier: LoyaltyTier | null;
+    nextTier: LoyaltyNextTier | null;
+    referralCode: string | null;
+    transactions: LoyaltyTransaction[];
+}
 interface CrossSellItem {
     productId: string;
     slug: string | null;
@@ -909,6 +1118,9 @@ interface CrossSellItem {
     stockCached: number;
     /** Convenience flag: `stockCached > 0`. */
     inStock: boolean;
+    /** Merchant-editable note ("proč se to hodí") resolved for the requested
+     * locale (falls back to the eshop default language). `null` when unset. */
+    note?: string | null;
 }
 interface ActivePromotion {
     id: string;
@@ -1142,6 +1354,7 @@ declare class BehioStorefront {
     readonly quotes: QuotesModule;
     readonly addresses: AddressModule;
     readonly shipping: ShippingModule;
+    readonly newsletter: NewsletterModule;
     /**
      * Called by the analytics tracker when the visitor grants (id) or revokes
      * (null) analytics consent. When set, requests carry the X-Behio-Vid header
@@ -1503,6 +1716,12 @@ declare class CustomerModule {
     updateAddress(addressId: string, data: Partial<CustomerAddress>): Promise<SdkResult<CustomerAddress>>;
     /** Delete address */
     deleteAddress(addressId: string): Promise<SdkResult<void>>;
+    /**
+     * Loyalty program summary for the logged-in customer (points balance +
+     * value, current tier, next-tier progress, point ratio, referral code,
+     * recent transactions). Requires an authenticated customer session.
+     */
+    getLoyalty(): Promise<SdkResult<LoyaltySummary>>;
 }
 declare class PagesModule {
     private client;
@@ -1642,6 +1861,29 @@ declare class ShippingModule {
     quote(input: ShippingQuoteInput): Promise<SdkResult<{
         items: ShippingQuote[];
     }>>;
+    /**
+     * List pickup points (parcel shops / lockers) for a method that has
+     * `supportsPickupPoints`. Filter with `query` (name / city / zip) for a
+     * "find your branch" box. Send the chosen point's `externalId` back as
+     * `checkout.pickupPointId`.
+     */
+    getPickupPoints(input: PickupPointsInput): Promise<SdkResult<{
+        items: PickupPoint[];
+    }>>;
+}
+/**
+ * First-party newsletter opt-in. Use for the footer signup block and the
+ * checkout newsletter checkbox (render its default from
+ * `ShopInfo.checkout.newsletterOptInDefault`). Subscribing is idempotent and
+ * re-activates a previously unsubscribed email. Pass the hidden `website`
+ * honeypot field straight through from your form: a filled value is silently
+ * accepted but stored nowhere.
+ */
+declare class NewsletterModule {
+    private client;
+    constructor(client: BehioStorefront);
+    subscribe(input: NewsletterSubscribeInput): Promise<SdkResult<NewsletterSubscribeResult>>;
+    unsubscribe(email: string): Promise<SdkResult<NewsletterUnsubscribeResult>>;
 }
 
-export { type MessageResponse as $, type AddressSuggestion as A, type BehioStorefrontConfig as B, type Category as C, type ReturnRequest as D, type SubmitReturnInput as E, type FilterField as F, type GiftCardBalance as G, type CookieConsent as H, type CookieConsentInput as I, type SubmitQuoteInput as J, type BackInStockSubscription as K, type AddToCartInput as L, type Menu as M, type AuthTokens as N, type OrderListItem as O, type ProductsQuery as P, type QuoteRequest as Q, type RegisterInput as R, type ShopInfo as S, BehioApiError as T, type BundleItem as U, type CartDiscount as V, type WishlistItem as W, type CartItem as X, type CheckoutAddress as Y, type FulfillmentStatus as Z, type LoginInput as _, BehioStorefront as a, type OrderItem as a0, type OrderStatus as a1, type PaymentStatus as a2, type ProductPrice as a3, type ProductReview as a4, type ProductVariant as a5, type AddressType as a6, AddressTypes as a7, type BadgeTone as a8, type BehioErrorCode as a9, type RequestInterceptor as aA, type RequestInterceptorConfig as aB, type ResponseInterceptor as aC, type ResponseInterceptorData as aD, type ReturnRequestItem as aE, type ReturnStatusItem as aF, type ReturnableOrderItem as aG, type SdkError as aH, type SdkResult as aI, type ShippingMethodSummary as aJ, type ShippingQuote as aK, type ShippingQuoteInput as aL, type ShopScript as aM, type ShopScriptPlacement as aN, type ShopScriptType as aO, err as aP, ok as aQ, toSdkError as aR, type BehioEventHandler as aa, type BehioEventType as ab, BehioNetworkError as ac, type CartBundleLine as ad, type CartBundleLineItem as ae, type CartItemProduct as af, type CartPromotion as ag, type CheckoutPaymentMethod as ah, type DataGroupFieldType as ai, FulfillmentStatuses as aj, type GiftCardSummary as ak, type MenuItem as al, type MenuItemRef as am, type MenuItemType as an, type OrderStatusHistory as ao, OrderStatuses as ap, type OrderTracking as aq, type PageAttachment as ar, PaymentStatuses as as, type ProductMedia as at, type ProductMediaVariant as au, ProductSort as av, type ProductSortValue as aw, type ProductVolumePrice as ax, type QuoteItem as ay, type RegisterResult as az, type PaginatedResponse as b, type ProductListItem as c, type ProductDetail as d, type CategoryDetail as e, type ProductLabel as f, type Cart as g, type CustomerProfile as h, type CustomerAddress as i, type AddressDetail as j, type OrderDetail as k, type OrderAccessRequestResponse as l, type OrderAccessVerifyResponse as m, type CheckoutInput as n, type PageDetail as o, type Page as p, type ShopScripts as q, type ShopSeo as r, type Bundle as s, type ProductGroup as t, type CrossSellItem as u, type ActivePromotion as v, type ProductReviewsResponse as w, type SubmitReviewInput as x, type ReturnableOrder as y, type ReturnStatus as z };
+export { type BundleItem as $, type AddressSuggestion as A, type BehioStorefrontConfig as B, type Category as C, type ProductReviewsResponse as D, type SubmitReviewInput as E, type FilterField as F, type GiftCardBalance as G, type ReturnableOrder as H, type ReturnStatus as I, type ReturnRequest as J, type SubmitReturnInput as K, type LoyaltySummary as L, type Menu as M, type NewsletterSubscribeResult as N, type OrderListItem as O, type ProductsQuery as P, type CookieConsent as Q, type RegisterInput as R, type ShopInfo as S, type CookieConsentInput as T, type QuoteRequest as U, type SubmitQuoteInput as V, type WishlistItem as W, type BackInStockSubscription as X, type AddToCartInput as Y, type AuthTokens as Z, BehioApiError as _, BehioStorefront as a, type ShopScript as a$, type CartDiscount as a0, type CartItem as a1, type CheckoutAddress as a2, type FulfillmentStatus as a3, type LoginInput as a4, type MessageResponse as a5, type OrderItem as a6, type OrderStatus as a7, type PaymentStatus as a8, type ProductPrice as a9, type MenuItemType as aA, type NewsletterOptInDefault as aB, type OrderStatusHistory as aC, OrderStatuses as aD, type OrderTracking as aE, type PageAttachment as aF, PaymentStatuses as aG, type PickupPointHours as aH, type ProductMedia as aI, type ProductMediaVariant as aJ, ProductSort as aK, type ProductSortValue as aL, type ProductVolumePrice as aM, type QuoteItem as aN, type RegisterResult as aO, type RequestInterceptor as aP, type RequestInterceptorConfig as aQ, type ResponseInterceptor as aR, type ResponseInterceptorData as aS, type ReturnRequestItem as aT, type ReturnStatusItem as aU, type ReturnableOrderItem as aV, type SdkError as aW, type SdkResult as aX, type ShippingMethodSummary as aY, type ShippingQuote as aZ, type ShippingQuoteInput as a_, type ProductReview as aa, type ProductVariant as ab, type AddressType as ac, AddressTypes as ad, type BadgeTone as ae, type BehioErrorCode as af, type BehioEventHandler as ag, type BehioEventType as ah, BehioNetworkError as ai, type CartBundleLine as aj, type CartBundleLineItem as ak, type CartItemProduct as al, type CartPromotion as am, type CheckoutPaymentMethod as an, type CheckoutSettings as ao, type DataGroupFieldType as ap, FulfillmentStatuses as aq, type GiftCardSummary as ar, type LoyaltyBalance as as, type LoyaltyNextTier as at, type LoyaltyProgram as au, type LoyaltyTier as av, type LoyaltyTierPerks as aw, type LoyaltyTransaction as ax, type MenuItem as ay, type MenuItemRef as az, type PaginatedResponse as b, type ShopScriptPlacement as b0, type ShopScriptType as b1, type StockBehavior as b2, err as b3, ok as b4, toSdkError as b5, type ProductListItem as c, type ProductDetail as d, type CategoryDetail as e, type ProductLabel as f, type Cart as g, type CustomerProfile as h, type CustomerAddress as i, type AddressDetail as j, type PickupPointsInput as k, type PickupPoint as l, type NewsletterSubscribeInput as m, type NewsletterUnsubscribeResult as n, type OrderDetail as o, type OrderAccessRequestResponse as p, type OrderAccessVerifyResponse as q, type CheckoutInput as r, type PageDetail as s, type Page as t, type ShopScripts as u, type ShopSeo as v, type Bundle as w, type ProductGroup as x, type CrossSellItem as y, type ActivePromotion as z };