@shoppexio/storefront-react 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -529,11 +529,96 @@ interface SdkCustomerSubscription {
         can_manage_payment_method: boolean;
     };
     /**
-     * The hosted checkout of the open renewal invoice, when a renewal payment is
-     * due. A plain link: the invoice already exists, so following it creates
-     * nothing. Optional only for deploy order; a missing value reads as null.
+     * The day an unpaid renewal's hold ends the subscription (PAST_DUE: access is
+     * off until the buyer pays). Null without a hold; optional only for deploy order.
      */
-    renewal_checkout_url?: string | null;
+    hold_ends_at?: string | null;
+    /**
+     * Set to end without renewing (cancelled at the period end, or a voided
+     * renewal): the instant it ends. Null while it renews; optional only for deploy order.
+     */
+    ends_at?: string | null;
+    /**
+     * The open renewal invoice: what it costs, the day to pay by, and its hosted
+     * checkout. A plain link: the invoice already exists, so following it creates
+     * nothing. Null when nothing is open; optional only for deploy order.
+     */
+    open_renewal?: SdkCustomerOpenRenewal | null;
+    /**
+     * The open pause: `scheduled` while the plan still runs until `starts_at`, then
+     * `paused`. Null without one; optional only for deploy order (an older SDK strips it).
+     */
+    pause?: SdkCustomerPause | null;
+    /** What a new pause would be; null when the buyer cannot pause now. Optional for deploy order. */
+    pause_options?: SdkCustomerPauseOptions | null;
+    /** Set only when every pause of the last 12 months is used. Optional for deploy order. */
+    pause_limit?: {
+        pauses_per_year: number;
+        available_again_at: string;
+    } | null;
+    /** The Discord roles a pause takes ([] none); null when not known. Optional for deploy order. */
+    pause_access_roles?: string[] | null;
+    /** The running coupon term; null without one. Optional for deploy order. */
+    discount?: SdkCustomerSubscriptionDiscount | null;
+}
+/**
+ * `SubscriptionCouponTermView` on the dashboard wire: the code, what it takes off each payment,
+ * the payments it still discounts, and what the renewals cost. Every amount is the renewal-pricing
+ * function's, in `currency`.
+ */
+interface SdkCustomerSubscriptionDiscount {
+    code: string;
+    discount_type: 'PERCENTAGE' | 'FIXED';
+    /** The percent, or the fixed amount. */
+    discount_value: string;
+    /** The cap on one payment's discount; null without one. */
+    max_discount: string | null;
+    currency: string;
+    duration: 'ONCE' | 'REPEATING' | 'FOREVER';
+    /** ONCE: 1, REPEATING: N, FOREVER: null (every payment). */
+    payments_total: number | null;
+    /** Discounted payments completed; an open or voided renewal does not count. */
+    payments_used: number;
+    /** A discounted renewal. */
+    discounted_amount: string;
+    /** A renewal at the plan price, once the term ends. */
+    full_amount: string;
+    /** What each discounted renewal saves. */
+    discount_amount: string;
+    /** What the next renewal charges: `discounted_amount`, or `full_amount` once every discounted payment is issued. */
+    next_amount: string;
+}
+/** Why a buyer pauses (`SUBSCRIPTION_PAUSE_REASONS`). */
+type SdkCustomerPauseReason = 'taking_a_break' | 'too_expensive' | 'not_using' | 'not_working' | 'other';
+/** `PauseWire` on the dashboard wire. ISO instants. */
+interface SdkCustomerPause {
+    state: 'scheduled' | 'paused';
+    starts_at: string;
+    /** Null: paused until someone resumes it (merchant and Developer API pauses). */
+    resume_at: string | null;
+    reason: SdkCustomerPauseReason | null;
+}
+/** `BuyerPauseView.pause_options`: the start, the lengths with their resume dates, and the pauses left after this one. */
+interface SdkCustomerPauseOptions {
+    starts_at: string;
+    lengths: Array<{
+        days: 7 | 14 | 30 | 60 | 90;
+        resume_at: string;
+    }>;
+    reason_enabled: boolean;
+    pauses_left_after: number;
+}
+/** An open renewal invoice of a subscription (`CustomerOpenRenewal` on the dashboard wire). */
+interface SdkCustomerOpenRenewal {
+    uniqid: string;
+    amount: string;
+    currency: string;
+    /** ISO instant: renewal date plus the shop's time to pay, or the hold end while on hold. */
+    pay_by: string;
+    pay_url: string;
+    /** The plan this invoice bills, which differs from `plan` while a scheduled interval change waits for it. */
+    interval: string;
+    interval_count: number;
 }
 /** One earned reward. `created_at` and `expires_at` are epoch SECONDS. */
 interface SdkCustomerRewardActivity {
@@ -814,6 +899,12 @@ interface SdkCustomerOrderDetail {
     taxPercentage: string;
     currency: string;
     createdAt: string;
+    /** The goods went to a gift recipient or wait for a reveal; absent from a backend older than the field. */
+    deliveryWithheld?: boolean;
+    /** What became of money an expired order took: NONE when none was recorded; null unless EXPIRED. */
+    expiredPayment?: 'NONE' | 'IN_REVIEW' | 'HELD' | 'SETTLED' | 'REFUNDED' | null;
+    /** When the paying attempt completed; kept on a disputed order, so the status decides whether it reads as paid. */
+    paidAt?: string | null;
     lineItems: Array<{
         id: string;
         productTitle: string;
@@ -822,6 +913,8 @@ interface SdkCustomerOrderDetail {
         quantity: number;
         total: string;
         deliveryText: string | null;
+        /** When the line was delivered; null until it was. */
+        deliveredAt: string | null;
         deliveryStatus: SdkCustomerDeliveryStatus;
         deliverySummary: SdkCustomerDeliverySummary | null;
     }>;
@@ -1072,6 +1165,8 @@ interface ShoppexSdk {
         page?: number;
         limit?: number;
         status?: string;
+        /** One order-list group of the buyer status table: "paid" holds COMPLETED and AWAITING_STOCK. */
+        statusGroup?: 'awaiting_payment' | 'paid' | 'refunded';
         search?: string;
     }): Promise<SdkResponse<SdkCustomerOrderPage>>;
     /** One order, by the `uniqid` the list rows carry. */
@@ -1105,7 +1200,12 @@ interface ShoppexSdk {
         cancel_at_period_end?: boolean;
         reason?: string | null;
     }): Promise<SdkResponse<unknown>>;
-    pauseSubscription(uniqid: string): Promise<SdkResponse<unknown>>;
+    /** Pauses from `pause_options.starts_at` for one of its lengths, with a reason when the shop asks for one. */
+    pauseSubscription(uniqid: string, options?: {
+        length_days?: 7 | 14 | 30 | 60 | 90;
+        reason?: SdkCustomerPauseReason | null;
+    }): Promise<SdkResponse<unknown>>;
+    /** "Resume now" on a paused plan; "Don't pause" on a scheduled pause. */
     resumeSubscription(uniqid: string): Promise<SdkResponse<unknown>>;
     /** The buyer's saved products. */
     favorites(): Promise<SdkResponse<unknown>>;
@@ -1478,6 +1578,11 @@ interface StorefrontPriceVariant {
         unit: SubscriptionIntervalUnit;
         count: number;
     } | null;
+    /**
+     * The option's own trial (`'none'`: the option has no trial); null starts it
+     * with the product's (`subscriptionForVariant`).
+     */
+    ownTrial: SubscriptionTrial | 'none' | null;
 }
 interface VolumeDiscountRule {
     quantity: number;
@@ -1657,7 +1762,7 @@ type YouReceive = {
 };
 declare function resolveYouReceive(product: Pick<StorefrontProduct, 'deliverable' | 'unitLabelSingular'>): YouReceive | null;
 /**
- * How often a subscription product is charged, and how long it is free first.
+ * How often a subscription product is charged, and the trial it starts with.
  *
  * PARITY CONTRACT. The Easy lane derives the same three facts from the same
  * flat wire fields in
@@ -1676,24 +1781,38 @@ interface ProductSubscription {
     intervalUnit: SubscriptionIntervalUnit | null;
     /** Intervals per charge, at least 1. */
     intervalCount: number;
-    /** Free-trial length in days; 0 when the merchant set none. */
-    trialDays: number;
+    /** The trial the plan starts with; null when it has none. */
+    trial: SubscriptionTrial | null;
 }
+/**
+ * A free trial, or a paid intro: `price` in `currency` (the product currency,
+ * as the wire states it) for the first `days`. The trial checkout bills
+ * (`resolveProductTrial`).
+ */
+type SubscriptionTrial = {
+    kind: 'free';
+    days: number;
+} | {
+    kind: 'paid';
+    days: number;
+    price: number;
+    currency: string;
+};
 /** The cadence as it reads next to a price: "per month", "every 3 months". */
 declare function formatSubscriptionCadence(subscription: ProductSubscription): string;
-/** "7-day free trial" — the plan charges nothing for those days. */
-declare function formatSubscriptionTrial(subscription: ProductSubscription): string;
+/**
+ * "7-day free trial" for a free trial, "$4.99 for 7 days" for a paid intro
+ * (`formatAmount` prints its price); empty when the plan has no trial.
+ */
+declare function formatSubscriptionTrial(subscription: ProductSubscription, formatAmount: (amount: number, currency: string) => string): string;
 /**
  * The subscription as the selected option bills it: an option with its own
  * interval (`billing_interval`, stored with its count or not at all) is charged
- * at that cadence, every other one at the product's.
+ * at that cadence, every other one at the product's. An option with its own
+ * trial ("No trial" included) starts with it, every other one with the
+ * product's: the rule checkout's `resolveProductTrial` applies.
  */
-declare function subscriptionForVariant(subscription: ProductSubscription, variant: {
-    billingInterval: {
-        unit: SubscriptionIntervalUnit;
-        count: number;
-    } | null;
-} | null | undefined): ProductSubscription;
+declare function subscriptionForVariant(subscription: ProductSubscription, variant: Pick<StorefrontPriceVariant, 'billingInterval' | 'ownTrial'> | null | undefined): ProductSubscription;
 /**
  * What a product image shows, from the backend's pixel analysis. `art` is a
  * cover, artwork or photo; `logo` is a flat mark, drawn on a contrasting plate.
@@ -3615,4 +3734,4 @@ declare function useOnlineUserCount(): number | null;
  */
 declare function resolveProductVideoEmbedSrc(value: unknown): string | null;
 
-export { ACCOUNT_ARTIFACT_CAPABILITIES, ACCOUNT_PATH, ACCOUNT_PATH_ALIAS, ACCOUNT_ROUTE_MESSAGE_KEYS, ACCOUNT_STOREFRONT_ROUTES, ACCOUNT_TABS, type AccountRouteMessageKey, type AccountRouteParts, type AccountTab, type AccountView, type BuyBoxVariantModel, CATALOG_PAGE_SIZE, CATALOG_SORTS, CATALOG_SORT_LABELS, type CartBoundsHeal, CartProvider, type CartQuoteLineBounds, type CartTotals, type CartView, type CartViewLine, type CatalogCardModel, type CatalogPage, type CatalogSort, type CheckoutFieldGroup, type CheckoutFieldValues, type CheckoutFields, type ContactFormValues, type ContactSubmissionContext, DEFAULT_ACCOUNT_TAB, DEFAULT_LOW_STOCK_THRESHOLD, DELIVERY_TIME_UNITS, type DeliveryPromise, type DeliveryTimeUnit, FAVORITES_CHANGED_EVENT, type FavoriteToggleResult, type FavoritesApi, FavoritesProvider, type FavoritesSnapshot, type FavoritesStatus, type FavoritesStore, type FavoritesTransport, type GroupCardModel, IMPLEMENTED_ACCOUNT_TABS, type ImplementedAccountTab, type LicenseStatement, type LicenseTerm, type LinePricing, MAX_PAY_WHAT_YOU_WANT_PRICE, type MenuNavLink, type MenuSlot, type NavLink, type NavigationLinks, PRODUCT_BADGE_ICON_NAMES, type PagedShopReviewsState, type ProductAddon, type ProductAutomaticDeal, type ProductBadge, type ProductBadgeIconName, type ProductBundle, type ProductBundleItem, type ProductCardModel, type ProductCategoryRef, type ProductContentTab, type ProductCustomField, type ProductDeliverable, type ProductDeliveryType, type ProductDetailModel, type ProductFaq, type ProductImage, type ProductImageKind, type ProductRatingModel, type ProductServiceStatus, type ProductSubscription, type ProductType, QUOTE_UNAVAILABLE_CHECKOUT_ERROR, type RatingStars, type ResellerProgramSummary, type RewardProgramItem, type RewardProgramSummary, SERVICE_STATES, SERVING_CONTEXT_HINT, SHOP_REVIEW_PAGE_SIZE, STOREFRONT_SORT_KEYS, type SdkCartAddOptions, type SdkCartAddon, type SdkCartAppliedDiscount, type SdkCartCodeSource, type SdkCartItem, type SdkCartQuote, type SdkCartQuoteLine, type SdkCheckoutResult, type SdkCustomerAffiliateLedgerStatus, type SdkCustomerAffiliateLink, type SdkCustomerAffiliateLinkCreated, type SdkCustomerAffiliateRates, type SdkCustomerAffiliateSummary, type SdkCustomerDashboard, type SdkCustomerDashboardOrder, type SdkCustomerDeliverable, type SdkCustomerDeliveryStatus, type SdkCustomerDeliverySummary, type SdkCustomerFileAccess, type SdkCustomerInvoicePdf, type SdkCustomerLicense, type SdkCustomerLoyalty, type SdkCustomerLoyaltyRedeem, type SdkCustomerLoyaltyTransactionType, type SdkCustomerNotificationPreferences, type SdkCustomerOrderDetail, type SdkCustomerOrderPage, type SdkCustomerOrderReview, type SdkCustomerOrderSummary, type SdkCustomerRewardActivity, type SdkCustomerRewards, type SdkCustomerSubscription, type SdkCustomerTicketSummary, type SdkCustomerWarranty, type SdkCustomerWarrantyClaim, type SdkCustomerWarrantyClaimStatus, type SdkCustomerWarrantyList, type SdkCustomerWarrantyStatus, type SdkEligibleCartDeal, type SdkInitOptions, type SdkMenu, type SdkMenuItem, type SdkPage, type SdkRecentSaleEntry, type SdkResponse, type SdkShopReview, type SdkShopReviewsSummary, type ServiceState, type ShopPageFaqItem, type ShopPageModel, type ShopPageState, type ShopReview, type ShopReviewLabels, type ShopReviewsPageResult, type ShopReviewsState, type ShoppexSdk, type SocialLink, type SocialNetwork, type StatusPageEntry, type StatusPageModel, type StockAlertRequest, type StockAlertResult, type StockChip, type StockTone, type StorefrontAddon, type StorefrontCatalog, type StorefrontCategory, type StorefrontData, type StorefrontGroup, type StorefrontListingItem, type StorefrontPaymentMethod, type StorefrontPaymentMethodKind, type StorefrontPriceVariant, type StorefrontProduct, StorefrontProvider, type StorefrontSettings, type StorefrontShop, type StorefrontShopStats, type StorefrontSortKey, type SubscriptionIntervalUnit, type SupportChannel, type VolumeDiscountRule, type YouReceive, accountOrderHref, accountRouteMessage, accountTabHref, accountTabLabelKey, addonChoiceMissing, averageRating, badgesForCard, badgesForProductPage, buildCartTotals, buildCartView, buildCustomFieldPayload, buildInitialCheckoutFieldValues, buildProductDetail, buildStatusPageModel, buildStorefrontCatalog, calculateDisplayLineTotal, calculateLinePricing, canRequestStockAlert, canonicalAccountPath, checkoutFieldKey, checkoutFieldWriteRepriced, checkoutNeedsDetails, clampQuantity, clearRecoveredQuoteCheckoutError, createFavoritesStore, filterCatalogCards, findStorefrontProduct, firstOptionalString, flattenMerchantHtmlToText, formatCompactCount, formatDeliveryTime, formatLicenseTerm, formatMoney, formatSubscriptionCadence, formatSubscriptionTrial, getAuthoredContent, getBuyerCurrency, getProductGroups, getProducts, getShoppex, getStorefrontAddons, getStorefrontCategories, getStorefrontListing, getStorefrontSettings, getStorefrontShop, hasInjectedStorefrontData, isAccountTab, isBlankMerchantHtml, isCardSoldOut, isCheckboxValueChecked, isImplementedAccountTab, isProductSoldOut, isRecord, isSelectionSoldOut, loadLatestWrittenReviews, loadShopPage, loadShopReviewsPage, missingRequiredCheckoutValues, notifyFavoritesChanged, optionalBoolean, optionalString, optionalStringWithDefault, paginateCatalogCards, parseAccountPath, parseCartQuoteLines, parseEnum, parseFiniteNumber, parseProductBadges, parseServiceStatus, parseStorefrontSortKey, readCheckoutNeedsDetails, readStorefrontData, requestStockAlert, requireArray, requireBoolean, requireNumber, requireRecord, requireString, requireStringFromKeys, requireUnknownRecord, resolveAccountView, resolveBadgeForeground, resolveCartBoundsHeals, resolveCategorySelection, resolveCheckoutFields, resolveDeliveryPromise, resolveDisplayStock, resolveHideStockCounter, resolveLicenseTerm, resolveMenuLinksForSlot, resolvePayWhatYouWantMinimum, resolveProductVideoEmbedSrc, resolveQuantityBounds, resolveSupportChannels, resolveUnsellableLineIds, resolveVariantStock, resolveYouReceive, reviewsForProduct, roundCurrency, sanitizeMerchantHtml, sdkFavoritesTransport, sortCatalogCards, startCartMutation, stripMerchantHtmlImages, submitContactTicket, subscriptionForVariant, toShopReviews, toStarCount, useCart, useFavorites, useNavigationLinks, useOnlineUserCount, usePagedShopReviews, useShopReviews, useStorefront, validateCheckoutFieldValue, validateCheckoutFields, validateContactSubmission, withRequiredAddons };
+export { ACCOUNT_ARTIFACT_CAPABILITIES, ACCOUNT_PATH, ACCOUNT_PATH_ALIAS, ACCOUNT_ROUTE_MESSAGE_KEYS, ACCOUNT_STOREFRONT_ROUTES, ACCOUNT_TABS, type AccountRouteMessageKey, type AccountRouteParts, type AccountTab, type AccountView, type BuyBoxVariantModel, CATALOG_PAGE_SIZE, CATALOG_SORTS, CATALOG_SORT_LABELS, type CartBoundsHeal, CartProvider, type CartQuoteLineBounds, type CartTotals, type CartView, type CartViewLine, type CatalogCardModel, type CatalogPage, type CatalogSort, type CheckoutFieldGroup, type CheckoutFieldValues, type CheckoutFields, type ContactFormValues, type ContactSubmissionContext, DEFAULT_ACCOUNT_TAB, DEFAULT_LOW_STOCK_THRESHOLD, DELIVERY_TIME_UNITS, type DeliveryPromise, type DeliveryTimeUnit, FAVORITES_CHANGED_EVENT, type FavoriteToggleResult, type FavoritesApi, FavoritesProvider, type FavoritesSnapshot, type FavoritesStatus, type FavoritesStore, type FavoritesTransport, type GroupCardModel, IMPLEMENTED_ACCOUNT_TABS, type ImplementedAccountTab, type LicenseStatement, type LicenseTerm, type LinePricing, MAX_PAY_WHAT_YOU_WANT_PRICE, type MenuNavLink, type MenuSlot, type NavLink, type NavigationLinks, PRODUCT_BADGE_ICON_NAMES, type PagedShopReviewsState, type ProductAddon, type ProductAutomaticDeal, type ProductBadge, type ProductBadgeIconName, type ProductBundle, type ProductBundleItem, type ProductCardModel, type ProductCategoryRef, type ProductContentTab, type ProductCustomField, type ProductDeliverable, type ProductDeliveryType, type ProductDetailModel, type ProductFaq, type ProductImage, type ProductImageKind, type ProductRatingModel, type ProductServiceStatus, type ProductSubscription, type ProductType, QUOTE_UNAVAILABLE_CHECKOUT_ERROR, type RatingStars, type ResellerProgramSummary, type RewardProgramItem, type RewardProgramSummary, SERVICE_STATES, SERVING_CONTEXT_HINT, SHOP_REVIEW_PAGE_SIZE, STOREFRONT_SORT_KEYS, type SdkCartAddOptions, type SdkCartAddon, type SdkCartAppliedDiscount, type SdkCartCodeSource, type SdkCartItem, type SdkCartQuote, type SdkCartQuoteLine, type SdkCheckoutResult, type SdkCustomerAffiliateLedgerStatus, type SdkCustomerAffiliateLink, type SdkCustomerAffiliateLinkCreated, type SdkCustomerAffiliateRates, type SdkCustomerAffiliateSummary, type SdkCustomerDashboard, type SdkCustomerDashboardOrder, type SdkCustomerDeliverable, type SdkCustomerDeliveryStatus, type SdkCustomerDeliverySummary, type SdkCustomerFileAccess, type SdkCustomerInvoicePdf, type SdkCustomerLicense, type SdkCustomerLoyalty, type SdkCustomerLoyaltyRedeem, type SdkCustomerLoyaltyTransactionType, type SdkCustomerNotificationPreferences, type SdkCustomerOpenRenewal, type SdkCustomerOrderDetail, type SdkCustomerOrderPage, type SdkCustomerOrderReview, type SdkCustomerOrderSummary, type SdkCustomerPause, type SdkCustomerPauseOptions, type SdkCustomerPauseReason, type SdkCustomerRewardActivity, type SdkCustomerRewards, type SdkCustomerSubscription, type SdkCustomerSubscriptionDiscount, type SdkCustomerTicketSummary, type SdkCustomerWarranty, type SdkCustomerWarrantyClaim, type SdkCustomerWarrantyClaimStatus, type SdkCustomerWarrantyList, type SdkCustomerWarrantyStatus, type SdkEligibleCartDeal, type SdkInitOptions, type SdkMenu, type SdkMenuItem, type SdkPage, type SdkRecentSaleEntry, type SdkResponse, type SdkShopReview, type SdkShopReviewsSummary, type ServiceState, type ShopPageFaqItem, type ShopPageModel, type ShopPageState, type ShopReview, type ShopReviewLabels, type ShopReviewsPageResult, type ShopReviewsState, type ShoppexSdk, type SocialLink, type SocialNetwork, type StatusPageEntry, type StatusPageModel, type StockAlertRequest, type StockAlertResult, type StockChip, type StockTone, type StorefrontAddon, type StorefrontCatalog, type StorefrontCategory, type StorefrontData, type StorefrontGroup, type StorefrontListingItem, type StorefrontPaymentMethod, type StorefrontPaymentMethodKind, type StorefrontPriceVariant, type StorefrontProduct, StorefrontProvider, type StorefrontSettings, type StorefrontShop, type StorefrontShopStats, type StorefrontSortKey, type SubscriptionIntervalUnit, type SubscriptionTrial, type SupportChannel, type VolumeDiscountRule, type YouReceive, accountOrderHref, accountRouteMessage, accountTabHref, accountTabLabelKey, addonChoiceMissing, averageRating, badgesForCard, badgesForProductPage, buildCartTotals, buildCartView, buildCustomFieldPayload, buildInitialCheckoutFieldValues, buildProductDetail, buildStatusPageModel, buildStorefrontCatalog, calculateDisplayLineTotal, calculateLinePricing, canRequestStockAlert, canonicalAccountPath, checkoutFieldKey, checkoutFieldWriteRepriced, checkoutNeedsDetails, clampQuantity, clearRecoveredQuoteCheckoutError, createFavoritesStore, filterCatalogCards, findStorefrontProduct, firstOptionalString, flattenMerchantHtmlToText, formatCompactCount, formatDeliveryTime, formatLicenseTerm, formatMoney, formatSubscriptionCadence, formatSubscriptionTrial, getAuthoredContent, getBuyerCurrency, getProductGroups, getProducts, getShoppex, getStorefrontAddons, getStorefrontCategories, getStorefrontListing, getStorefrontSettings, getStorefrontShop, hasInjectedStorefrontData, isAccountTab, isBlankMerchantHtml, isCardSoldOut, isCheckboxValueChecked, isImplementedAccountTab, isProductSoldOut, isRecord, isSelectionSoldOut, loadLatestWrittenReviews, loadShopPage, loadShopReviewsPage, missingRequiredCheckoutValues, notifyFavoritesChanged, optionalBoolean, optionalString, optionalStringWithDefault, paginateCatalogCards, parseAccountPath, parseCartQuoteLines, parseEnum, parseFiniteNumber, parseProductBadges, parseServiceStatus, parseStorefrontSortKey, readCheckoutNeedsDetails, readStorefrontData, requestStockAlert, requireArray, requireBoolean, requireNumber, requireRecord, requireString, requireStringFromKeys, requireUnknownRecord, resolveAccountView, resolveBadgeForeground, resolveCartBoundsHeals, resolveCategorySelection, resolveCheckoutFields, resolveDeliveryPromise, resolveDisplayStock, resolveHideStockCounter, resolveLicenseTerm, resolveMenuLinksForSlot, resolvePayWhatYouWantMinimum, resolveProductVideoEmbedSrc, resolveQuantityBounds, resolveSupportChannels, resolveUnsellableLineIds, resolveVariantStock, resolveYouReceive, reviewsForProduct, roundCurrency, sanitizeMerchantHtml, sdkFavoritesTransport, sortCatalogCards, startCartMutation, stripMerchantHtmlImages, submitContactTicket, subscriptionForVariant, toShopReviews, toStarCount, useCart, useFavorites, useNavigationLinks, useOnlineUserCount, usePagedShopReviews, useShopReviews, useStorefront, validateCheckoutFieldValue, validateCheckoutFields, validateContactSubmission, withRequiredAddons };

package/dist/index.js

@@ -575,13 +575,21 @@ function formatSubscriptionCadence(subscription) {
   const noun = SUBSCRIPTION_INTERVAL_NOUNS[unit];
   return subscription.intervalCount === 1 ? `per ${noun}` : `every ${subscription.intervalCount} ${noun}s`;
 }
-function formatSubscriptionTrial(subscription) {
-  const days = subscription.trialDays;
-  return days > 0 ? `${days}-day free trial` : "";
+function formatSubscriptionTrial(subscription, formatAmount) {
+  const trial = subscription.trial;
+  if (!trial) return "";
+  if (trial.kind === "free") return `${trial.days}-day free trial`;
+  return `${formatAmount(trial.price, trial.currency)} for ${trial.days} ${trial.days === 1 ? "day" : "days"}`;
 }
 function subscriptionForVariant(subscription, variant) {
   const own = variant?.billingInterval;
-  return own ? { ...subscription, intervalUnit: own.unit, intervalCount: own.count } : subscription;
+  const ownTrial = variant?.ownTrial;
+  if (!own && !ownTrial) return subscription;
+  return {
+    ...subscription,
+    ...own ? { intervalUnit: own.unit, intervalCount: own.count } : {},
+    ...ownTrial ? { trial: ownTrial === "none" ? null : ownTrial } : {}
+  };
 }
 function parseSubscription(product, productType) {
   if (productType !== "SUBSCRIPTION") return null;
@@ -591,7 +599,7 @@ function parseSubscription(product, productType) {
   return {
     intervalUnit: unit,
     intervalCount: count,
-    trialDays: normalizePositiveDays(product.trial_period) ?? 0
+    trial: parseTrial(product)
   };
 }
 function parseVariantBillingInterval(variant) {
@@ -599,6 +607,21 @@ function parseVariantBillingInterval(variant) {
   const count = normalizePositiveDays(variant.billing_interval_count);
   return unit && count ? { unit, count } : null;
 }
+function parseTrial(record) {
+  const days = record.trial_days;
+  if (typeof days !== "number" || !Number.isInteger(days) || days < 1) return null;
+  if (record.trial_kind === "free") return { kind: "free", days };
+  const price = typeof record.trial_price === "string" ? Number(record.trial_price) : Number.NaN;
+  if (record.trial_kind === "paid" && price > 0 && typeof record.trial_price_currency === "string") {
+    return { kind: "paid", days, price, currency: record.trial_price_currency };
+  }
+  return null;
+}
+function parseVariantTrial(variant) {
+  const kind = variant.trial_kind;
+  if (kind !== "none" && kind !== "free" && kind !== "paid") return null;
+  return parseTrial(variant) ?? "none";
+}
 var PAYMENT_METHOD_KINDS = ["card", "wallet", "crypto"];
 function parsePaymentMethods(value) {
   if (!Array.isArray(value)) {
@@ -1025,6 +1048,7 @@ function parsePriceVariants(value, productContext) {
       description: optionalString(variant.description),
       license: parseVariantLicense(variant),
       billingInterval: parseVariantBillingInterval(variant),
+      ownTrial: parseVariantTrial(variant),
       price: unitPrice,
       baseUnitPrice: unitPrice,
       stock: normalizeStock(variant.stock, `${context}.stock`),