@usethrottle/checkout-react 2.1.0 → 2.2.0

package/dist/index.d.cts

@@ -1,5 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { CSSProperties, RefObject, ReactNode } from 'react';
+import { CurrencyCode } from '@usethrottle/money';
+import * as money from '@usethrottle/money';
+export { money };
+export { CURRENCIES, CurrencyCode, MoneyValue, UnknownCurrencyError, currencySymbol, formatMoney, isKnownCurrency, minorUnitsOf, moneyValue, parseMoney, toDecimalString, toMinor } from '@usethrottle/money';
 import { CartSessionCart, AddLineItemInput, UpdateLineItemInput, SelectShippingInput, CheckoutHandoffInput, CheckoutHandoff, SelectedShipping } from '@usethrottle/cart';
 
 /**
@@ -42,7 +46,7 @@ type ThrottleEvent = {
     subscriptionIds?: string[];
     /** v1.4 additive — order total in minor units, for analytics purchase events. */
     total?: number;
-    currency?: string;
+    currency?: CurrencyCode;
     lineItems?: ThrottleCompletedLineItem[];
 } | {
     type: 'throttle.cancelled';
@@ -151,9 +155,13 @@ interface ThrottleEmbedProps {
         subscriptionId?: string;
         /** Every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
         subscriptionIds?: string[];
-        /** Order total in minor units — fire `gtag`/`fbq` purchase events with value = total / 100. */
+        /**
+         * Order total in minor units — fire `gtag`/`fbq` purchase events with
+         * value = `toDecimalString(total, currency)` (the currency's own exponent:
+         * JPY has none, KWD has three).
+         */
         total?: number;
-        currency?: string;
+        currency?: CurrencyCode;
         lineItems?: ThrottleCompletedLineItem[];
     }) => void;
     onFailed?: (evt: {
@@ -221,9 +229,14 @@ declare function useThrottleEvents({ iframeRef, expectedOrigin, onMessage }: Use
 interface UseCartSessionOptions {
     /** Application UUID. */
     applicationId: string;
-    /** Workspace environment UUID the publishable token was minted for. */
+    /** Workspace environment UUID the quote token was minted for. */
     environmentId: string;
-    /** Publishable storefront quote token (`pk_…`). */
+    /**
+     * Storefront quote token (`qt_…`), from the dashboard Shipping & Tax page or
+     * `POST /api/v1/shipping-tax/quote-tokens`. Tokens minted before `qt_` start
+     * with `pk_` and keep working. A `pk_` publishable API key is a different
+     * credential and is refused (`401 invalid_quote_token`).
+     */
     quoteToken: string;
     baseUrl?: string;
     /**
@@ -284,7 +297,7 @@ declare function useCartSession(options: UseCartSessionOptions): UseCartSessionR
  */
 type ThrottleCheckoutStatus = 'idle' | 'loading' | 'recovering' | 'ready' | 'error';
 interface CheckoutTotals {
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     shippingTotal: number;
@@ -561,9 +574,9 @@ interface SecureCardCompleteResult {
     orderId: string;
     orderNumber: string;
     paymentId: string;
-    /** Minor units (cents). */
+    /** Minor units of `currency`. */
     total: number;
-    currency: string;
+    currency: CurrencyCode;
     status: string;
     paymentStatus: string;
 }

package/dist/index.d.ts

@@ -1,5 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { CSSProperties, RefObject, ReactNode } from 'react';
+import { CurrencyCode } from '@usethrottle/money';
+import * as money from '@usethrottle/money';
+export { money };
+export { CURRENCIES, CurrencyCode, MoneyValue, UnknownCurrencyError, currencySymbol, formatMoney, isKnownCurrency, minorUnitsOf, moneyValue, parseMoney, toDecimalString, toMinor } from '@usethrottle/money';
 import { CartSessionCart, AddLineItemInput, UpdateLineItemInput, SelectShippingInput, CheckoutHandoffInput, CheckoutHandoff, SelectedShipping } from '@usethrottle/cart';
 
 /**
@@ -42,7 +46,7 @@ type ThrottleEvent = {
     subscriptionIds?: string[];
     /** v1.4 additive — order total in minor units, for analytics purchase events. */
     total?: number;
-    currency?: string;
+    currency?: CurrencyCode;
     lineItems?: ThrottleCompletedLineItem[];
 } | {
     type: 'throttle.cancelled';
@@ -151,9 +155,13 @@ interface ThrottleEmbedProps {
         subscriptionId?: string;
         /** Every subscription the checkout created, in line order. `subscriptionId` is set only when there is exactly one. */
         subscriptionIds?: string[];
-        /** Order total in minor units — fire `gtag`/`fbq` purchase events with value = total / 100. */
+        /**
+         * Order total in minor units — fire `gtag`/`fbq` purchase events with
+         * value = `toDecimalString(total, currency)` (the currency's own exponent:
+         * JPY has none, KWD has three).
+         */
         total?: number;
-        currency?: string;
+        currency?: CurrencyCode;
         lineItems?: ThrottleCompletedLineItem[];
     }) => void;
     onFailed?: (evt: {
@@ -221,9 +229,14 @@ declare function useThrottleEvents({ iframeRef, expectedOrigin, onMessage }: Use
 interface UseCartSessionOptions {
     /** Application UUID. */
     applicationId: string;
-    /** Workspace environment UUID the publishable token was minted for. */
+    /** Workspace environment UUID the quote token was minted for. */
     environmentId: string;
-    /** Publishable storefront quote token (`pk_…`). */
+    /**
+     * Storefront quote token (`qt_…`), from the dashboard Shipping & Tax page or
+     * `POST /api/v1/shipping-tax/quote-tokens`. Tokens minted before `qt_` start
+     * with `pk_` and keep working. A `pk_` publishable API key is a different
+     * credential and is refused (`401 invalid_quote_token`).
+     */
     quoteToken: string;
     baseUrl?: string;
     /**
@@ -284,7 +297,7 @@ declare function useCartSession(options: UseCartSessionOptions): UseCartSessionR
  */
 type ThrottleCheckoutStatus = 'idle' | 'loading' | 'recovering' | 'ready' | 'error';
 interface CheckoutTotals {
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     shippingTotal: number;
@@ -561,9 +574,9 @@ interface SecureCardCompleteResult {
     orderId: string;
     orderNumber: string;
     paymentId: string;
-    /** Minor units (cents). */
+    /** Minor units of `currency`. */
     total: number;
-    currency: string;
+    currency: CurrencyCode;
     status: string;
     paymentStatus: string;
 }