@shoppexio/storefront 1.0.97 → 1.0.100

package/dist/index.d.ts

@@ -1,27 +1,11 @@
+import * as src from 'src';
 import { NavigationMenuSlot } from '@shoppex/contracts/navigation';
 export { NavigationMenuSlot } from '@shoppex/contracts/navigation';
 import { StorefrontDeliveryType } from '@shoppex/contracts/storefront-delivery-type';
-import * as src from 'src';
 import { createApiClient } from '@shoppex/contracts/api-client';
 import { CustomerWarrantyClaimWire, CustomerPortalAffiliateCreateLinkWire, CustomerPortalDashboardWire, CustomerPortalPaginatedInvoicesWire, CustomerPortalInvoiceDetailWire, CustomerLoyaltyWire, CustomerLoyaltyRedeemWire, CustomerWarrantyListWire, CustomerPortalNotificationPreferencesWire } from '@shoppex/contracts/customer-account-wire';
 export { CATALOG_UNIT_PRICE_DECIMAL_PLACES, CATALOG_UNIT_PRICE_FORMAT_OPTIONS, PAYABLE_AMOUNT_DECIMAL_PLACES, roundPayableAmount } from '@shoppex/contracts/catalog-unit-price';
 
-interface CacheStats {
-    hits: number;
-    misses: number;
-    pendingRequests: number;
-    entries: number;
-}
-declare function getCacheStats(): CacheStats;
-declare function clearCache(): void;
-declare function invalidateCache(prefixOrKey: string): void;
-
-/**
- * Formatting Utilities
- */
-declare function createFormatter(currency?: string, locale?: string): Intl.NumberFormat;
-declare function formatPrice(amount: number | string, currency?: string, locale?: string): string;
-
 /**
  * SDK Configuration Types
  */
@@ -360,6 +344,16 @@ interface Product {
      */
     addons_required?: boolean;
     price_variants?: PriceVariant[];
+    /**
+     * The methods every option of this product can be paid with (shop methods
+     * narrowed by the product's and its variants' restriction), same shape as
+     * `shop.payment_methods`. Only the shop catalog payload carries it.
+     */
+    payment_methods?: Array<{
+        id: string;
+        label: string;
+        kind: 'card' | 'wallet' | 'crypto';
+    }>;
     volume_discounts?: unknown;
     custom_fields?: string | unknown[] | null;
     categories?: ProductCategory[];
@@ -457,10 +451,14 @@ interface ProductVariant {
     is_featured?: boolean;
     isFeatured?: boolean;
     /**
-     * A private option, sold only through its direct link. The server lists it
-     * only on `getProduct(id, { variant })` naming it, never in product lists.
-     * Absent on servers older than private variants.
+     * Who may see and buy this option. `private` is sold only through its direct
+     * link: the server lists it only on `getProduct(id, { variant })` naming it,
+     * never in product lists. `on_hold` is listed but cannot be bought (show it
+     * as unavailable, not sold out); the server refuses it in carts and checkout.
+     * Absent on servers older than variant visibility.
      */
+    visibility?: 'public' | 'on_hold' | 'private';
+    /** @deprecated Read `visibility`; true when it is `private`. Removed in a later release. */
     is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
@@ -521,10 +519,14 @@ interface PriceVariant {
     is_featured?: boolean;
     isFeatured?: boolean;
     /**
-     * A private option, sold only through its direct link. The server lists it
-     * only on `getProduct(id, { variant })` naming it, never in product lists.
-     * Absent on servers older than private variants.
+     * Who may see and buy this option. `private` is sold only through its direct
+     * link: the server lists it only on `getProduct(id, { variant })` naming it,
+     * never in product lists. `on_hold` is listed but cannot be bought (show it
+     * as unavailable, not sold out); the server refuses it in carts and checkout.
+     * Absent on servers older than variant visibility.
      */
+    visibility?: 'public' | 'on_hold' | 'private';
+    /** @deprecated Read `visibility`; true when it is `private`. Removed in a later release. */
     is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
@@ -1153,6 +1155,17 @@ interface CartQuote {
     eligible_bundle_deals: EligibleBundleDeal[];
     /** Per-line effective bounds and sellability — see CartQuoteLine. Absent on older backends. */
     lines?: CartQuoteLine[];
+    /**
+     * The methods this cart can be paid with, in `shop.payment_methods` shape:
+     * the shop's methods narrowed by every line's product restriction, the same
+     * rule checkout applies. Draw the cart's "Pay with" row from this, not from
+     * the shop list. Absent on older backends.
+     */
+    payment_methods?: Array<{
+        id: string;
+        label: string;
+        kind: 'card' | 'wallet' | 'crypto';
+    }>;
     /**
      * TRUE when this cart already exceeds the shop's configured checkout maximum.
      *
@@ -1182,6 +1195,86 @@ interface CartStats {
     total_price_is_estimate: boolean;
 }
 
+declare function getCartCoupon(): string | null;
+declare function getCartCouponSource(): CartCodeSource | null;
+declare function setCartCoupon(coupon: string | null | undefined, source?: CartCodeSource): string | null;
+declare function clearCartCoupon(): void;
+declare function getCart(): CartItem[];
+/** Resolve a cart line_id for product+variant. When multiple configs exist, returns the first line. */
+declare function resolveCartLineId(productId: string, variantId: string, cart?: CartItem[]): string;
+declare function getCartItemCount(): number;
+declare function addToCart(productId: string, variantId: string, quantity?: number, options?: CartAddOptions): void;
+declare function setCartItem(productId: string, variantId: string, quantity?: number, options?: CartAddOptions): void;
+/**
+ * Patch one cart line.
+ *
+ * TRI-STATE BOUNDS: `min_quantity`/`max_quantity` accept `null` to DELETE the
+ * stored bound — see {@link CartItemUpdate}. `undefined` (or an absent key)
+ * leaves it alone, which is why a removed ceiling needs its own spelling.
+ *
+ * NO-OP UPDATES DO NOT WRITE. An update that leaves the cart byte-identical
+ * returns without touching storage: no metadata bump, no `version` increment,
+ * and — because the storage write is what other tabs observe — no `storage`
+ * event. Writing anyway made an ineffective heal indistinguishable from a real
+ * cart change, and two tabs healing the same line could hand the event back and
+ * forth indefinitely. Line-shape healing of a legacy stored row is NOT this
+ * function's job: `normalizeCartItems` clamps and repairs on every READ, which
+ * is the chokepoint every access already flows through.
+ */
+declare function updateCartItem(lineId: string, updates: CartItemUpdate): void;
+declare function removeFromCart(lineId: string): void;
+/**
+ * Discards the cart entirely — and with it the proof that describes it.
+ *
+ * PAYMENT PATH. `latestQuoteToken` is evidence about a specific cart, and this
+ * is the one mutation after which that cart does not exist in any form. Held
+ * across the clear, the proof outlives its subject: a caller that clears and
+ * re-adds (Buy Now REPLACES the cart) hands `/from-cart` a token bound to the
+ * previous cart's hash, which is refused as `quote_token_stale` — a hand-off
+ * dead-ended by a proof nobody asked for. And with no re-quote in between there
+ * is nothing to replace it with, so the retry is refused identically.
+ *
+ * Only this path clears it. Every OTHER mutation turns one cart into another
+ * cart, where a proof that no longer matches is the server's to refuse: it
+ * answers `quote_token_stale`, the surfaces re-quote, and the buyer approves the
+ * new total. Dropping the proof there instead would silently remove the approved
+ * -total ceiling from a checkout that raced the re-quote, which is the failure
+ * the token exists to prevent.
+ */
+declare function clearCart(): void;
+declare function createCartBackup(): void;
+declare function restoreCartFromBackup(): boolean;
+declare function mergeBaskets(items: CartBasketMergeLine[]): CartItem[];
+declare function moveBasketItem(fromProductId: string, fromVariantId: string, toProductId: string, toVariantId: string): void;
+declare function validateCartIntegrity(): boolean;
+declare function getCartStats(): CartStats;
+/** @internal — read by checkout(); exported only across module boundaries. */
+declare function getLatestQuoteToken(): string | null;
+declare function quoteCart(coupon?: string, currency?: string): Promise<src.SDKResponse<CartQuote>>;
+
+/**
+ * SDK Configuration Management
+ */
+
+declare function getConfig(): ShoppexConfig;
+declare function isInitialized(): boolean;
+
+interface CacheStats {
+    hits: number;
+    misses: number;
+    pendingRequests: number;
+    entries: number;
+}
+declare function getCacheStats(): CacheStats;
+declare function clearCache(): void;
+declare function invalidateCache(prefixOrKey: string): void;
+
+/**
+ * Formatting Utilities
+ */
+declare function createFormatter(currency?: string, locale?: string): Intl.NumberFormat;
+declare function formatPrice(amount: number | string, currency?: string, locale?: string): string;
+
 /**
  * Pages Module
  *
@@ -1482,63 +1575,6 @@ declare function buildCheckoutUrl(couponOrOptions?: string | CheckoutOptions, op
  */
 declare function buildCheckoutUrlSync(): never;
 
-declare function getCartCoupon(): string | null;
-declare function getCartCouponSource(): CartCodeSource | null;
-declare function setCartCoupon(coupon: string | null | undefined, source?: CartCodeSource): string | null;
-declare function clearCartCoupon(): void;
-declare function getCart(): CartItem[];
-/** Resolve a cart line_id for product+variant. When multiple configs exist, returns the first line. */
-declare function resolveCartLineId(productId: string, variantId: string, cart?: CartItem[]): string;
-declare function getCartItemCount(): number;
-declare function addToCart(productId: string, variantId: string, quantity?: number, options?: CartAddOptions): void;
-declare function setCartItem(productId: string, variantId: string, quantity?: number, options?: CartAddOptions): void;
-/**
- * Patch one cart line.
- *
- * TRI-STATE BOUNDS: `min_quantity`/`max_quantity` accept `null` to DELETE the
- * stored bound — see {@link CartItemUpdate}. `undefined` (or an absent key)
- * leaves it alone, which is why a removed ceiling needs its own spelling.
- *
- * NO-OP UPDATES DO NOT WRITE. An update that leaves the cart byte-identical
- * returns without touching storage: no metadata bump, no `version` increment,
- * and — because the storage write is what other tabs observe — no `storage`
- * event. Writing anyway made an ineffective heal indistinguishable from a real
- * cart change, and two tabs healing the same line could hand the event back and
- * forth indefinitely. Line-shape healing of a legacy stored row is NOT this
- * function's job: `normalizeCartItems` clamps and repairs on every READ, which
- * is the chokepoint every access already flows through.
- */
-declare function updateCartItem(lineId: string, updates: CartItemUpdate): void;
-declare function removeFromCart(lineId: string): void;
-/**
- * Discards the cart entirely — and with it the proof that describes it.
- *
- * PAYMENT PATH. `latestQuoteToken` is evidence about a specific cart, and this
- * is the one mutation after which that cart does not exist in any form. Held
- * across the clear, the proof outlives its subject: a caller that clears and
- * re-adds (Buy Now REPLACES the cart) hands `/from-cart` a token bound to the
- * previous cart's hash, which is refused as `quote_token_stale` — a hand-off
- * dead-ended by a proof nobody asked for. And with no re-quote in between there
- * is nothing to replace it with, so the retry is refused identically.
- *
- * Only this path clears it. Every OTHER mutation turns one cart into another
- * cart, where a proof that no longer matches is the server's to refuse: it
- * answers `quote_token_stale`, the surfaces re-quote, and the buyer approves the
- * new total. Dropping the proof there instead would silently remove the approved
- * -total ceiling from a checkout that raced the re-quote, which is the failure
- * the token exists to prevent.
- */
-declare function clearCart(): void;
-declare function createCartBackup(): void;
-declare function restoreCartFromBackup(): boolean;
-declare function mergeBaskets(items: CartBasketMergeLine[]): CartItem[];
-declare function moveBasketItem(fromProductId: string, fromVariantId: string, toProductId: string, toVariantId: string): void;
-declare function validateCartIntegrity(): boolean;
-declare function getCartStats(): CartStats;
-/** @internal — read by checkout(); exported only across module boundaries. */
-declare function getLatestQuoteToken(): string | null;
-declare function quoteCart(coupon?: string, currency?: string): Promise<src.SDKResponse<CartQuote>>;
-
 /**
  * Products Module
  *
@@ -1600,18 +1636,13 @@ declare function getStoreBannerUrl(): Promise<string | null>;
 type ApiClient = ReturnType<typeof createApiClient>;
 /**
  * Return a typed OpenAPI client bound to the SDK's configured API base URL.
- * The client is cached per base URL and recreated when the SDK is re-initialized
- * against a different host.
+ * The client is cached for the config object it was built from: every init
+ * creates a new config object, so a re-init rebuilds it. Keyed here instead of
+ * reset from `initConfig`, so `core/config.ts` (which every SDK user loads)
+ * does not import this module and its `openapi-fetch` dependency.
  */
 declare function getTypedClient(token?: string): ApiClient;
 
-/**
- * SDK Configuration Management
- */
-
-declare function getConfig(): ShoppexConfig;
-declare function isInitialized(): boolean;
-
 /**
  * SDK Error Classes
  */
@@ -2161,14 +2192,6 @@ declare const shoppex: {
     resellerOrder: typeof resellerOrder;
     resellerWallet: typeof resellerWallet;
     resellerApiKeys: typeof resellerApiKeys;
-    init: {
-        (storeSlug: string, options?: src.ShoppexInitOptions): void;
-        (options: src.ShoppexInitOptions & {
-            storeId: string;
-        }): void;
-    };
-    isInitialized: typeof isInitialized;
-    getConfig: typeof getConfig;
     client: typeof getTypedClient;
     getStore: typeof getStore;
     getStorefront: typeof getStorefront;
@@ -2179,38 +2202,12 @@ declare const shoppex: {
     getStorefrontProductsPage: typeof getStorefrontProductsPage;
     getProduct: typeof getProduct;
     getCategories: typeof getCategories;
-    getCart: typeof getCart;
-    getCartItemCount: typeof getCartItemCount;
-    getCartCoupon: typeof getCartCoupon;
-    getCartCouponSource: typeof getCartCouponSource;
-    setCartCoupon: typeof setCartCoupon;
-    clearCartCoupon: typeof clearCartCoupon;
-    addToCart: typeof addToCart;
-    setCartItem: typeof setCartItem;
-    updateCartItem: typeof updateCartItem;
-    removeFromCart: typeof removeFromCart;
-    clearCart: typeof clearCart;
-    createCartBackup: typeof createCartBackup;
-    restoreCartFromBackup: typeof restoreCartFromBackup;
-    mergeBaskets: typeof mergeBaskets;
-    moveBasketItem: typeof moveBasketItem;
-    getCartStats: typeof getCartStats;
-    validateCartIntegrity: typeof validateCartIntegrity;
-    quoteCart: typeof quoteCart;
-    getLatestQuoteToken: typeof getLatestQuoteToken;
-    resolveCartLineId: typeof resolveCartLineId;
     checkout: typeof checkout;
     buildCheckoutUrl: typeof buildCheckoutUrl;
     buildCheckoutUrlSync: typeof buildCheckoutUrlSync;
     getRequestedCheckoutCurrency: typeof getRequestedCheckoutCurrency;
-    captureAffiliateFromUrl: typeof captureAffiliateFromUrl;
     validateAffiliateCode: typeof validateAffiliateCode;
     applyAffiliateCode: typeof applyAffiliateCode;
-    getAffiliateCode: typeof getAffiliateCode;
-    getStoredAffiliate: typeof getStoredAffiliate;
-    setAffiliateCode: typeof setAffiliateCode;
-    clearAffiliateCode: typeof clearAffiliateCode;
-    trackAffiliateEvent: typeof trackAffiliateEvent;
     validateCoupon: typeof validateCoupon;
     getShopReviews: typeof getShopReviews;
     getShopReviewsPage: typeof src.getShopReviewsPage;
@@ -2225,8 +2222,6 @@ declare const shoppex: {
     getMenuBySlot: typeof src.getMenuBySlot;
     getMenuByTitle: typeof src.getMenuByTitle;
     getMenuSlotTitles: typeof src.getMenuSlotTitles;
-    trackPageView: typeof src.trackPageView;
-    trackCartActivity: typeof src.trackCartActivity;
     getStorefrontOnlineUsers: typeof src.getStorefrontOnlineUsers;
     getStorefrontRecentSales: typeof src.getStorefrontRecentSales;
     touchStorefrontPresence: typeof src.touchStorefrontPresence;
@@ -2239,6 +2234,42 @@ declare const shoppex: {
     fetchPublishedThemeSettings: typeof src.fetchPublishedThemeSettings;
     resolveDefaults: typeof src.resolveDefaults;
     mergeSettings: typeof src.mergeSettings;
+    init: {
+        (storeSlug: string, options?: src.ShoppexInitOptions): void;
+        (options: src.ShoppexInitOptions & {
+            storeId: string;
+        }): void;
+    };
+    isInitialized: typeof isInitialized;
+    getConfig: typeof getConfig;
+    getCart: typeof getCart;
+    getCartItemCount: typeof getCartItemCount;
+    getCartCoupon: typeof getCartCoupon;
+    getCartCouponSource: typeof getCartCouponSource;
+    setCartCoupon: typeof setCartCoupon;
+    clearCartCoupon: typeof clearCartCoupon;
+    addToCart: typeof addToCart;
+    setCartItem: typeof setCartItem;
+    updateCartItem: typeof updateCartItem;
+    removeFromCart: typeof removeFromCart;
+    clearCart: typeof clearCart;
+    createCartBackup: typeof createCartBackup;
+    restoreCartFromBackup: typeof restoreCartFromBackup;
+    mergeBaskets: typeof mergeBaskets;
+    moveBasketItem: typeof moveBasketItem;
+    getCartStats: typeof getCartStats;
+    validateCartIntegrity: typeof validateCartIntegrity;
+    quoteCart: typeof quoteCart;
+    getLatestQuoteToken: typeof getLatestQuoteToken;
+    resolveCartLineId: typeof resolveCartLineId;
+    captureAffiliateFromUrl: typeof captureAffiliateFromUrl;
+    getAffiliateCode: typeof getAffiliateCode;
+    getStoredAffiliate: typeof getStoredAffiliate;
+    setAffiliateCode: typeof setAffiliateCode;
+    clearAffiliateCode: typeof clearAffiliateCode;
+    trackAffiliateEvent: typeof trackAffiliateEvent;
+    trackPageView: typeof src.trackPageView;
+    trackCartActivity: typeof src.trackCartActivity;
 };
 
 export { type AffiliateValidation, ApiError, type ApiResponse, type BlockDefinition, type BlockInstance, type BuyerRewardActivityItem, type BuyerRewards, CURRENCY_UNAVAILABLE_ERROR_CODE, type CartAddOptions, type CartAddon, type CartAppliedDiscount, type CartBasketMergeLine, type CartCodeSource, CartError, type CartItem, type CartItemUpdate, type CartLineIdentityInput, type CartMetadata, type CartPayload, type CartQuote, type CartQuoteLine, type CartStats, type Category, CheckoutCreateError, type CheckoutOptions, type CheckoutResult, type CouponValidation, type CouponValidationOptions, type CursorPagination, type CustomFieldDefinition, type CustomerAffiliateLinkInput, type CustomerEmailPreferencesPatch, type CustomerInvoicePdf, type CustomerNotificationPreferencesPatch, type CustomerProfilePatch, type CustomerSubscriptionCancelOptions, type CustomerTicketPayload, type EligibleBundleDeal, type EligibleBundleDealProduct, type EligibleCartDeal, type Feedback, type Invoice, type InvoiceProduct, type Menu, type MenuItem, NetworkError, NotInitializedError, PRODUCT_FILTER_UNSUPPORTED, type Page, type PageLayout, type PriceVariant, type Product, type ProductAddon, type ProductBundle, type ProductBundleProduct, type ProductCategory, type ProductDescriptionTab, type ProductFaq, type ProductFeedback, type ProductGroup, type ProductImage, type ProductVariant, type PublishedBuilderSettings, type PublishedThemeSettingsPayload, type ResellerCatalogQuery, type ResellerOrderItem, type ResellerOrdersQuery, type ResolvedThemeSettings, type RewardActionType, type RewardGrantStatus, type RewardProgramSummary, type RewardProgramTeaserItem, type RewardReason, type SDKResponse, type SearchOptions, type SectionDefinition, type SettingField, type Shop, type ShopFeedback, type ShopReviewsPage, type ShopReviewsSummary, type ShopTheme, type ShoppexConfig, ShoppexError, type ShoppexInitOptions, type StorefrontAddon, type StorefrontAddonBootstrap, type StorefrontAnnouncementBarAddon, type StorefrontCatalogSearchItem, type StorefrontContactTicketInput, type StorefrontContactTicketResult, type StorefrontCountdownBarAddon, type StorefrontCouponPopupModalAddon, type StorefrontCustomField, type StorefrontData, type StorefrontItem, type StorefrontOnlineUsers, type StorefrontPromoInfoCardAddon, type StorefrontRecentPurchasePopupAddon, type StorefrontRecentSaleEntry, type StorefrontRecentSales, type StorefrontSearchFilterOptions, type StorefrontSocialLinks, type Subscription, type SubscriptionFlags, type SubscriptionInterval, type ThemeBlockManifest, type ThemeConfig, type TrustedChecks, ValidationError, acceptResellerInvite, addFavorite, affiliate, affiliateStats, applyForReseller, buildStorefrontContactMessage, buildStorefrontCustomFieldPayload, buildStorefrontProductLookup, cancelSubscription, claimWarranty, collectProductSearchHaystack, computeCartLineId, createAffiliateLink, createTicket, dashboard, shoppex as default, emailPreferences, enrollAsReseller, ensureCartLineId, favorites, fetchPublishedBuilderSettings, fetchPublishedThemeSettings, filterProductsBySearchQuery, getMenu, getMenuBySlot, getMenuByTitle, getMenuSlotTitles, getMenus, getMergedStorefrontProducts, getShopReviewsPage, getStorefrontGroupProducts, getStorefrontOnlineUsers, getStorefrontRecentSales, groupMatchesSearchQuery, invoicePdf, isProductInStock, isProductOutOfStock, isStorefrontCheckboxCustomFieldValueChecked, isVariantOutOfStock, logout, loyalty, me, mergeSettings, normalizeSearchQuery, normalizeStorefrontCustomFields, notificationPreferences, order, orders, pauseSubscription, productMatchesSearchQuery, quoteResellerOrder, redeemLoyaltyPoints, removeAvatar, removeFavorite, replyToTicket, requestOtp, reseller, resellerApiKeys, resellerCatalog, resellerOrder, resellerOrders, resellerWallet, resetLicenseHwid, resolveDefaults, resolveDisplayStock, resolveStorefrontApiBaseUrl, resolveStorefrontSocialLinks, resolveVariantStockValue, resumeSubscription, revokeAllSessions, revokeSession, searchMergedStorefrontCatalog, searchMergedStorefrontCatalogItems, sessions, shoppex, stripHtmlFromText, submitStorefrontContactTicket, subscriptionBillingHistory, ticket, touchStorefrontPresence, trackCartActivity, trackPageView, undoSubscriptionCancel, updateAvatar, updateEmailPreferences, updateNotificationPreferences, updateProfile, validateStorefrontCustomFieldValue, verifyOtp, warranties };