bitsnap-react 1.12.0 → 1.13.0

package/dist/index.d.mts

@@ -97,7 +97,7 @@ type CheckoutAppearanceTokens = {
  * Stable slot names. They are exposed as `data-bitsnap-checkout-slot`
  * attributes so they can also be targeted from plain CSS.
  */
-declare const CHECKOUT_SLOT_NAMES: readonly ["root", "overlay", "panel", "header", "title", "closeButton", "productList", "product", "productImage", "productName", "productPrice", "quantityControl", "quantityInput", "quantityButton", "removeButton", "summary", "totalLabel", "totalValue", "deliveryText", "summaryNote", "countryLabel", "countryTrigger", "countryDropdown", "countrySearch", "countryOption", "paymentButtons", "checkoutButton", "emptyState", "error", "skeleton"];
+declare const CHECKOUT_SLOT_NAMES: readonly ["root", "overlay", "panel", "header", "title", "closeButton", "productList", "product", "productImage", "productName", "productPrice", "quantityControl", "quantityInput", "quantityButton", "removeButton", "summary", "totalLabel", "totalValue", "deliveryText", "summaryNote", "countryLabel", "countryTrigger", "countryDropdown", "countrySearch", "countryOption", "paymentButtons", "paymentMethods", "paymentMethodOption", "checkoutButton", "emptyState", "error", "skeleton"];
 type CheckoutSlotName = (typeof CHECKOUT_SLOT_NAMES)[number];
 type CheckoutSlotAppearance = SlotAppearance;
 type CheckoutAppearanceElements = AppearanceElements<CheckoutSlotName>;
@@ -185,6 +185,28 @@ type CheckoutTexts = {
     loadFailed: string;
     /** Button that loads the cart again. */
     retry: string;
+    /** Heading of the payment method choice (shown only when the shop offers paying by hand). */
+    paymentMethodLegend: string;
+    /** Option that pays through the shop's online gateway. */
+    paymentMethodOnline: string;
+    /** Hint under the online option. */
+    paymentMethodOnlineDescription: string;
+    /** Manual option when the seller takes bank transfers only. */
+    paymentMethodManualTransfer: string;
+    /** Manual option when the seller takes BLIK transfers to a phone number only. */
+    paymentMethodManualBlik: string;
+    /** Manual option when the seller takes both. */
+    paymentMethodManualBoth: string;
+    /** What paying by hand means: the details come after the order is placed. */
+    paymentMethodManualDescription: string;
+    /** Shown with a selected manual option that includes BLIK to a phone number. */
+    paymentMethodManualBlikNote: string;
+    /** Cash on delivery option. */
+    paymentMethodCod: string;
+    /** Hint under the cash on delivery option. */
+    paymentMethodCodDescription: string;
+    /** Error shown when the shop refused cash on delivery for the order. */
+    paymentMethodCodUnavailable: string;
 };
 
 type BitsnapCartProps = {
@@ -398,6 +420,29 @@ type Err = {
 };
 declare function Err(message: string, type?: ErrTypes, data?: unknown): Err;
 
+/**
+ * The buyer's choice between paying online, paying the seller by hand (bank
+ * transfer or "BLIK przelew na telefon") and paying the courier on delivery,
+ * offered when the seller turned on "show at checkout" for the manual payment
+ * gateway or offers cash on delivery.
+ *
+ * `POST /public-commerce/payment-methods` takes the body of `/buy` and answers
+ * `{ success: true, choice: null }` (nothing to choose) or
+ * `{ success: true, choice: { methods, manualAccountTypes } }`. The pick goes
+ * to `/buy` as `paymentMethod`. Anything else (an old backend, an error, a
+ * timeout) counts as "nothing to choose", so the cart buys as before.
+ */
+
+/** `cod` is cash on delivery: the buyer pays the courier (Poland only, shipped carts). */
+type PaymentMethod = "online" | "manual" | "cod";
+type ManualAccountType = "bankTransfer" | "blik";
+type PaymentMethodChoice = {
+    /** In the seller's order (cash on delivery last); the first one is selected by default. */
+    methods: PaymentMethod[];
+    /** How the manual option is paid; decides its label. */
+    manualAccountTypes: ManualAccountType[];
+};
+
 declare function setLocale(locale?: string): void;
 declare function getLocale(): string;
 
@@ -482,6 +527,11 @@ declare const linkRequestSchema: z__default.ZodObject<{
         answer: z__default.ZodOptional<z__default.ZodBoolean>;
     }, z__default.core.$strip>>>;
     blikCode: z__default.ZodOptional<z__default.ZodString>;
+    paymentMethod: z__default.ZodOptional<z__default.ZodEnum<{
+        online: "online";
+        manual: "manual";
+        cod: "cod";
+    }>>;
     couponCode: z__default.ZodOptional<z__default.ZodString>;
     redirect: z__default.ZodOptional<z__default.ZodObject<{
         successURL: z__default.ZodOptional<z__default.ZodString>;
@@ -511,6 +561,13 @@ declare namespace Bitsnap {
     function showCart(): void;
     function hideCart(): void;
 }
+/**
+ * Whether the buyer may choose between paying online, paying the seller by
+ * transfer / BLIK to a phone number and paying on delivery, for the cart
+ * `/buy` would get. `null`
+ * means nothing to choose, also when the request fails.
+ */
+declare function getPaymentMethodChoice(request: LinkRequest): Promise<PaymentMethodChoice | null>;
 declare function createPaymentURL(request: LinkRequest): Promise<Err | {
     projectId?: string | undefined;
     orderId?: string | undefined;
@@ -596,4 +653,4 @@ declare function persistReturnURL(returnURL: string | null): void;
 declare function readPersistedReturnURL(): string | null;
 declare function buildAccessTokenRedirect(returnURL: string, accessToken: string): string;
 
-export { AnalyticsOption, Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, type BuyErrorData, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CreateCheckoutResult, type CustomizationTexts, GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, ITEM_IDS_NOT_FOUND, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, PanelProps, PanelProvider, type PublicNotificationGroup, PublicOrderPage, buildAccessTokenRedirect, createCheckout, createPaymentURL, getAllowedReturnOrigins, getLocale, getPanelConfig, getReferenceIfPossible, getReturnURLFromSearch, injectReferenceToRequestIfNeeded, persistReturnURL, readPersistedReturnURL, setAllowedReturnOrigins, setCustomHost, setHost, setLocale, setLoginURL, setPanelConfig, setProjectID as setPanelProjectID, setProjectID$1 as setProjectID, setTheme, usePanelConfig };
+export { AnalyticsOption, Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, type BuyErrorData, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CreateCheckoutResult, type CustomizationTexts, GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, ITEM_IDS_NOT_FOUND, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, PanelProps, PanelProvider, type PublicNotificationGroup, PublicOrderPage, buildAccessTokenRedirect, createCheckout, createPaymentURL, getAllowedReturnOrigins, getLocale, getPanelConfig, getPaymentMethodChoice, getReferenceIfPossible, getReturnURLFromSearch, injectReferenceToRequestIfNeeded, persistReturnURL, readPersistedReturnURL, setAllowedReturnOrigins, setCustomHost, setHost, setLocale, setLoginURL, setPanelConfig, setProjectID as setPanelProjectID, setProjectID$1 as setProjectID, setTheme, usePanelConfig };

package/dist/index.d.ts

@@ -97,7 +97,7 @@ type CheckoutAppearanceTokens = {
  * Stable slot names. They are exposed as `data-bitsnap-checkout-slot`
  * attributes so they can also be targeted from plain CSS.
  */
-declare const CHECKOUT_SLOT_NAMES: readonly ["root", "overlay", "panel", "header", "title", "closeButton", "productList", "product", "productImage", "productName", "productPrice", "quantityControl", "quantityInput", "quantityButton", "removeButton", "summary", "totalLabel", "totalValue", "deliveryText", "summaryNote", "countryLabel", "countryTrigger", "countryDropdown", "countrySearch", "countryOption", "paymentButtons", "checkoutButton", "emptyState", "error", "skeleton"];
+declare const CHECKOUT_SLOT_NAMES: readonly ["root", "overlay", "panel", "header", "title", "closeButton", "productList", "product", "productImage", "productName", "productPrice", "quantityControl", "quantityInput", "quantityButton", "removeButton", "summary", "totalLabel", "totalValue", "deliveryText", "summaryNote", "countryLabel", "countryTrigger", "countryDropdown", "countrySearch", "countryOption", "paymentButtons", "paymentMethods", "paymentMethodOption", "checkoutButton", "emptyState", "error", "skeleton"];
 type CheckoutSlotName = (typeof CHECKOUT_SLOT_NAMES)[number];
 type CheckoutSlotAppearance = SlotAppearance;
 type CheckoutAppearanceElements = AppearanceElements<CheckoutSlotName>;
@@ -185,6 +185,28 @@ type CheckoutTexts = {
     loadFailed: string;
     /** Button that loads the cart again. */
     retry: string;
+    /** Heading of the payment method choice (shown only when the shop offers paying by hand). */
+    paymentMethodLegend: string;
+    /** Option that pays through the shop's online gateway. */
+    paymentMethodOnline: string;
+    /** Hint under the online option. */
+    paymentMethodOnlineDescription: string;
+    /** Manual option when the seller takes bank transfers only. */
+    paymentMethodManualTransfer: string;
+    /** Manual option when the seller takes BLIK transfers to a phone number only. */
+    paymentMethodManualBlik: string;
+    /** Manual option when the seller takes both. */
+    paymentMethodManualBoth: string;
+    /** What paying by hand means: the details come after the order is placed. */
+    paymentMethodManualDescription: string;
+    /** Shown with a selected manual option that includes BLIK to a phone number. */
+    paymentMethodManualBlikNote: string;
+    /** Cash on delivery option. */
+    paymentMethodCod: string;
+    /** Hint under the cash on delivery option. */
+    paymentMethodCodDescription: string;
+    /** Error shown when the shop refused cash on delivery for the order. */
+    paymentMethodCodUnavailable: string;
 };
 
 type BitsnapCartProps = {
@@ -398,6 +420,29 @@ type Err = {
 };
 declare function Err(message: string, type?: ErrTypes, data?: unknown): Err;
 
+/**
+ * The buyer's choice between paying online, paying the seller by hand (bank
+ * transfer or "BLIK przelew na telefon") and paying the courier on delivery,
+ * offered when the seller turned on "show at checkout" for the manual payment
+ * gateway or offers cash on delivery.
+ *
+ * `POST /public-commerce/payment-methods` takes the body of `/buy` and answers
+ * `{ success: true, choice: null }` (nothing to choose) or
+ * `{ success: true, choice: { methods, manualAccountTypes } }`. The pick goes
+ * to `/buy` as `paymentMethod`. Anything else (an old backend, an error, a
+ * timeout) counts as "nothing to choose", so the cart buys as before.
+ */
+
+/** `cod` is cash on delivery: the buyer pays the courier (Poland only, shipped carts). */
+type PaymentMethod = "online" | "manual" | "cod";
+type ManualAccountType = "bankTransfer" | "blik";
+type PaymentMethodChoice = {
+    /** In the seller's order (cash on delivery last); the first one is selected by default. */
+    methods: PaymentMethod[];
+    /** How the manual option is paid; decides its label. */
+    manualAccountTypes: ManualAccountType[];
+};
+
 declare function setLocale(locale?: string): void;
 declare function getLocale(): string;
 
@@ -482,6 +527,11 @@ declare const linkRequestSchema: z__default.ZodObject<{
         answer: z__default.ZodOptional<z__default.ZodBoolean>;
     }, z__default.core.$strip>>>;
     blikCode: z__default.ZodOptional<z__default.ZodString>;
+    paymentMethod: z__default.ZodOptional<z__default.ZodEnum<{
+        online: "online";
+        manual: "manual";
+        cod: "cod";
+    }>>;
     couponCode: z__default.ZodOptional<z__default.ZodString>;
     redirect: z__default.ZodOptional<z__default.ZodObject<{
         successURL: z__default.ZodOptional<z__default.ZodString>;
@@ -511,6 +561,13 @@ declare namespace Bitsnap {
     function showCart(): void;
     function hideCart(): void;
 }
+/**
+ * Whether the buyer may choose between paying online, paying the seller by
+ * transfer / BLIK to a phone number and paying on delivery, for the cart
+ * `/buy` would get. `null`
+ * means nothing to choose, also when the request fails.
+ */
+declare function getPaymentMethodChoice(request: LinkRequest): Promise<PaymentMethodChoice | null>;
 declare function createPaymentURL(request: LinkRequest): Promise<Err | {
     projectId?: string | undefined;
     orderId?: string | undefined;
@@ -596,4 +653,4 @@ declare function persistReturnURL(returnURL: string | null): void;
 declare function readPersistedReturnURL(): string | null;
 declare function buildAccessTokenRedirect(returnURL: string, accessToken: string): string;
 
-export { AnalyticsOption, Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, type BuyErrorData, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CreateCheckoutResult, type CustomizationTexts, GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, ITEM_IDS_NOT_FOUND, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, PanelProps, PanelProvider, type PublicNotificationGroup, PublicOrderPage, buildAccessTokenRedirect, createCheckout, createPaymentURL, getAllowedReturnOrigins, getLocale, getPanelConfig, getReferenceIfPossible, getReturnURLFromSearch, injectReferenceToRequestIfNeeded, persistReturnURL, readPersistedReturnURL, setAllowedReturnOrigins, setCustomHost, setHost, setLocale, setLoginURL, setPanelConfig, setProjectID as setPanelProjectID, setProjectID$1 as setProjectID, setTheme, usePanelConfig };
+export { AnalyticsOption, Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, type BuyErrorData, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CreateCheckoutResult, type CustomizationTexts, GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, ITEM_IDS_NOT_FOUND, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, PanelProps, PanelProvider, type PublicNotificationGroup, PublicOrderPage, buildAccessTokenRedirect, createCheckout, createPaymentURL, getAllowedReturnOrigins, getLocale, getPanelConfig, getPaymentMethodChoice, getReferenceIfPossible, getReturnURLFromSearch, injectReferenceToRequestIfNeeded, persistReturnURL, readPersistedReturnURL, setAllowedReturnOrigins, setCustomHost, setHost, setLocale, setLoginURL, setPanelConfig, setProjectID as setPanelProjectID, setProjectID$1 as setProjectID, setTheme, usePanelConfig };