bitsnap-react 1.11.1 → 1.12.1

package/dist/index.d.mts

@@ -28,6 +28,8 @@ type Props$3 = {
         name: string;
         id: string;
         price: number;
+        /** Currency of `price` (minor units); defaults to PLN. */
+        currency?: string;
         quantity: number;
         isDeliverable?: boolean;
         metadata?: {
@@ -95,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", "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>;
@@ -145,6 +147,60 @@ type CheckoutTexts = {
     currencyUnsupported: string;
     /** Error shown when a price changed after the product was added. */
     priceChanged: string;
+    /** Accessible name of the close button of the drawer. */
+    close: string;
+    /** Remove button of a cart line (also read together with the product name). */
+    remove: string;
+    /** Accessible name of the quantity control and its input. */
+    quantity: string;
+    /** Accessible name of the "+" quantity button. */
+    increaseQuantity: string;
+    /** Accessible name of the "-" quantity button. */
+    decreaseQuantity: string;
+    /** Accessible name of the cart button when it only shows an icon. */
+    openCart: string;
+    /** Hidden label of the number of products badge; the number is appended after a colon. */
+    cartItemsCount: string;
+    /** Label before the lowest price of the last 30 days; the price is appended. */
+    lowestPrice30Days: string;
+    /** Shown instead of the lowest price when the price has no history. */
+    noPriceHistory: string;
+    /** Error shown when redirecting to the payment failed. */
+    redirectFailed: string;
+    /** Error shown when a subscription is added to the cart. */
+    subscriptionUnsupported: string;
+    /** Country search placeholder. */
+    searchCountry: string;
+    /** Shown when the country search has no match. */
+    noCountriesFound: string;
+    /** Hint under the checkout button when no country is chosen. */
+    countryRequired: string;
+    /** Title of the Apple Pay and Google Pay sheet total. */
+    paymentForCart: string;
+    /** Coupon label in the Google Pay sheet; the code is appended. */
+    coupon: string;
+    /** Note under the cart total. */
+    extrasCalculatedNext: string;
+    /** Error shown when the products of the cart could not be loaded. */
+    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;
 };
 
 type BitsnapCartProps = {
@@ -358,6 +414,27 @@ type Err = {
 };
 declare function Err(message: string, type?: ErrTypes, data?: unknown): Err;
 
+/**
+ * The buyer's choice between paying online and paying the seller by hand
+ * (bank transfer or "BLIK przelew na telefon"), offered when the seller turned
+ * on "show at checkout" for the manual payment gateway.
+ *
+ * `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.
+ */
+
+type PaymentMethod = "online" | "manual";
+type ManualAccountType = "bankTransfer" | "blik";
+type PaymentMethodChoice = {
+    /** In the seller's order; 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;
 
@@ -442,6 +519,10 @@ 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";
+    }>>;
     couponCode: z__default.ZodOptional<z__default.ZodString>;
     redirect: z__default.ZodOptional<z__default.ZodObject<{
         successURL: z__default.ZodOptional<z__default.ZodString>;
@@ -454,8 +535,14 @@ declare namespace Bitsnap {
      * Adds a product or variant to the cart. Returns an `Err` instead of adding
      * anything when the backend does not know the id
      * (`item-ids-not-found`, with the unknown ids in `data`).
+     *
+     * `args.url` is the product page: the cart links the item's image and name
+     * to it. A relative URL is resolved against the current page; only `http`
+     * and `https` links are kept.
      */
     function addProductToCart(id: string, quantity?: number, metadata?: Record<string, string | undefined>, args?: {
+        /** Product page the cart item links to. */
+        url?: string;
         name?: string;
         price?: number;
         currency?: string;
@@ -465,7 +552,15 @@ declare namespace Bitsnap {
     function showCart(): void;
     function hideCart(): void;
 }
+/**
+ * Whether the buyer may choose between paying online and paying the seller by
+ * transfer / BLIK to a phone number, 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;
     url: string;
 }>;
 /**
@@ -548,4 +643,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

@@ -28,6 +28,8 @@ type Props$3 = {
         name: string;
         id: string;
         price: number;
+        /** Currency of `price` (minor units); defaults to PLN. */
+        currency?: string;
         quantity: number;
         isDeliverable?: boolean;
         metadata?: {
@@ -95,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", "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>;
@@ -145,6 +147,60 @@ type CheckoutTexts = {
     currencyUnsupported: string;
     /** Error shown when a price changed after the product was added. */
     priceChanged: string;
+    /** Accessible name of the close button of the drawer. */
+    close: string;
+    /** Remove button of a cart line (also read together with the product name). */
+    remove: string;
+    /** Accessible name of the quantity control and its input. */
+    quantity: string;
+    /** Accessible name of the "+" quantity button. */
+    increaseQuantity: string;
+    /** Accessible name of the "-" quantity button. */
+    decreaseQuantity: string;
+    /** Accessible name of the cart button when it only shows an icon. */
+    openCart: string;
+    /** Hidden label of the number of products badge; the number is appended after a colon. */
+    cartItemsCount: string;
+    /** Label before the lowest price of the last 30 days; the price is appended. */
+    lowestPrice30Days: string;
+    /** Shown instead of the lowest price when the price has no history. */
+    noPriceHistory: string;
+    /** Error shown when redirecting to the payment failed. */
+    redirectFailed: string;
+    /** Error shown when a subscription is added to the cart. */
+    subscriptionUnsupported: string;
+    /** Country search placeholder. */
+    searchCountry: string;
+    /** Shown when the country search has no match. */
+    noCountriesFound: string;
+    /** Hint under the checkout button when no country is chosen. */
+    countryRequired: string;
+    /** Title of the Apple Pay and Google Pay sheet total. */
+    paymentForCart: string;
+    /** Coupon label in the Google Pay sheet; the code is appended. */
+    coupon: string;
+    /** Note under the cart total. */
+    extrasCalculatedNext: string;
+    /** Error shown when the products of the cart could not be loaded. */
+    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;
 };
 
 type BitsnapCartProps = {
@@ -358,6 +414,27 @@ type Err = {
 };
 declare function Err(message: string, type?: ErrTypes, data?: unknown): Err;
 
+/**
+ * The buyer's choice between paying online and paying the seller by hand
+ * (bank transfer or "BLIK przelew na telefon"), offered when the seller turned
+ * on "show at checkout" for the manual payment gateway.
+ *
+ * `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.
+ */
+
+type PaymentMethod = "online" | "manual";
+type ManualAccountType = "bankTransfer" | "blik";
+type PaymentMethodChoice = {
+    /** In the seller's order; 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;
 
@@ -442,6 +519,10 @@ 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";
+    }>>;
     couponCode: z__default.ZodOptional<z__default.ZodString>;
     redirect: z__default.ZodOptional<z__default.ZodObject<{
         successURL: z__default.ZodOptional<z__default.ZodString>;
@@ -454,8 +535,14 @@ declare namespace Bitsnap {
      * Adds a product or variant to the cart. Returns an `Err` instead of adding
      * anything when the backend does not know the id
      * (`item-ids-not-found`, with the unknown ids in `data`).
+     *
+     * `args.url` is the product page: the cart links the item's image and name
+     * to it. A relative URL is resolved against the current page; only `http`
+     * and `https` links are kept.
      */
     function addProductToCart(id: string, quantity?: number, metadata?: Record<string, string | undefined>, args?: {
+        /** Product page the cart item links to. */
+        url?: string;
         name?: string;
         price?: number;
         currency?: string;
@@ -465,7 +552,15 @@ declare namespace Bitsnap {
     function showCart(): void;
     function hideCart(): void;
 }
+/**
+ * Whether the buyer may choose between paying online and paying the seller by
+ * transfer / BLIK to a phone number, 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;
     url: string;
 }>;
 /**
@@ -548,4 +643,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 };