bitsnap-react 1.6.1 → 1.7.1

package/dist/index.d.mts

@@ -1,8 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CSSProperties, ReactNode } from 'react';
+import { S as SlotAppearance, A as AppearanceElements } from './appearance-core-Dt2grZdl.mjs';
+export { PRODUCT_LIST_SLOT_NAMES, ProductList, ProductListAppearance, ProductListAppearanceElements, ProductListAppearanceTokens, ProductListData, ProductListItemContext, ProductListProps, ProductListSlotAppearance, ProductListSlotName, ProductListTextKey, ProductListTexts, ProductListTheme, PublicListProduct, UseProductsOptions, UseProductsResult, formatProductPrice, useProducts } from './catalog.mjs';
+import { ReturnsAppearance, ReturnsTexts } from './returns.mjs';
+export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, CreateReturnInput, Environment, LegacyCreateReturnInput, LegacyReturnsTexts, LegacyReturnsTheme, RETURNS_SLOT_NAMES, ReturnsAppearanceElements, ReturnsAppearanceProvider, ReturnsAppearanceTokens, ReturnsChallenge, ReturnsCodeStep, ReturnsCodeStepProps, ReturnsConfirmation, ReturnsConfirmationProps, ReturnsEmailStep, ReturnsEmailStepProps, ReturnsEnvironment, ReturnsEnvironmentInput, ReturnsMyReturnDetail, ReturnsMyReturnDetailProps, ReturnsMyReturnsList, ReturnsMyReturnsListProps, ReturnsOrderDetail, ReturnsOrderDetailProps, ReturnsOrderList, ReturnsOrderListProps, ReturnsProvider, ReturnsProviderProps, ReturnsResult, ReturnsResultProps, ReturnsSessionStatus, ReturnsSlotAppearance, ReturnsSlotName, ReturnsTextKey, ReturnsTextsInput, ReturnsTheme, SelectedReturnLine, UseCreateReturnResult, UseMyReturnResult, UseMyReturnsResult, UseReturnOrdersResult, UseReturnSessionResult, UseReturnableOrderResult, useCreateReturn, useMyReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder, useReturnsAppearance, useReturnsSlot, useReturnsText } from './returns.mjs';
+import { ReactNode } from 'react';
 import z__default from 'zod';
-export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, Environment, useCreateReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder } from './returns.mjs';
-import '@tanstack/react-query';
+import './models.mjs';
 import '@bufbuild/protobuf/wkt';
 import '@bufbuild/protobuf';
 
@@ -85,13 +88,8 @@ type CheckoutAppearanceTokens = {
  */
 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"];
 type CheckoutSlotName = (typeof CHECKOUT_SLOT_NAMES)[number];
-type CheckoutSlotAppearance = {
-    /** Merged after the built-in classes with `cn`, so Tailwind conflicts resolve. */
-    className?: string;
-    /** Merged after the built-in inline styles. */
-    style?: CSSProperties;
-};
-type CheckoutAppearanceElements = Partial<Record<CheckoutSlotName, CheckoutSlotAppearance>>;
+type CheckoutSlotAppearance = SlotAppearance;
+type CheckoutAppearanceElements = AppearanceElements<CheckoutSlotName>;
 type CheckoutAppearance = {
     /**
      * `"dark"` keeps the current presentation, `"light"` applies the light preset.
@@ -104,6 +102,28 @@ type CheckoutAppearance = {
     elements?: CheckoutAppearanceElements;
 };
 
+/**
+ * Every string the checkout renders. Pass a partial object through the
+ * `texts` prop of `BitsnapCheckout` to override any of them, whatever the
+ * locale.
+ */
+type CheckoutTexts = {
+    /** Drawer title. */
+    cart: string;
+    /** Shown when the cart has no products. */
+    emptyCart: string;
+    /** Label next to the total price. */
+    total: string;
+    /** Delivery note next to the total price. */
+    delivery: string;
+    /** Country selector placeholder. */
+    chooseCountry: string;
+    /** Checkout button label. */
+    nextStep: string;
+    /** Error shown when some products are out of stock. */
+    unavailableProducts: string;
+};
+
 type BitsnapCartProps = {
     projectID: string;
     locale?: string;
@@ -119,8 +139,13 @@ type BitsnapCartProps = {
      * current presentation; every token and element slot is partial.
      */
     appearance?: CheckoutAppearance;
+    /**
+     * Optional text overrides. Any key given here replaces the built-in string
+     * whatever the locale; omitted keys keep the `pl`/`en` defaults.
+     */
+    texts?: Partial<CheckoutTexts>;
 };
-declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
+declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
 
 type Props$2 = {
     test?: boolean;
@@ -378,6 +403,11 @@ declare const linkRequestSchema: z__default.ZodObject<{
 }, z__default.core.$strip>;
 
 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`).
+     */
     function addProductToCart(id: string, quantity?: number, metadata?: Record<string, string | undefined>, args?: {
         name?: string;
         price?: number;
@@ -401,16 +431,6 @@ declare function injectReferenceToRequestIfNeeded(request: LinkRequest): LinkReq
 
 declare const PanelLogin: () => react_jsx_runtime.JSX.Element;
 
-declare const PanelPage: () => react_jsx_runtime.JSX.Element;
-
-interface Props {
-    orderID: string;
-    initialEmail?: string;
-    accessToken?: string;
-    onBack?: () => void;
-}
-declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
-
 interface GetThemeOutput {
     logoURL?: string;
     logoDarkURL?: string;
@@ -419,22 +439,41 @@ interface GetThemeOutput {
         brandDark?: string;
     };
 }
-type PanelScreen = "products" | "notifications" | "profile" | "plans" | "orders" | "order-details";
+type PanelScreen = "products" | "notifications" | "profile" | "plans" | "orders" | "order-details" | "returns" | "return-details";
 type PanelSearchParamsType = {
     product?: string;
     state: PanelScreen;
     orderId?: string;
+    returnId?: string;
 };
 interface PanelProps {
     projectID: string;
     theme?: GetThemeOutput;
     loginURL: string;
+    /**
+     * Appearance of the Returns screen. When omitted, `buttonBackground`,
+     * `focusRing` and a readable `buttonForeground` are derived from
+     * `theme.colors.brand`.
+     */
+    returnsAppearance?: ReturnsAppearance;
+    /** Text overrides of the Returns screen. */
+    returnsTexts?: Partial<ReturnsTexts>;
 }
 interface PanelLoginProps {
     projectID: string;
     theme?: GetThemeOutput;
 }
 
+declare const PanelPage: ({ returnsAppearance, returnsTexts, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts">) => react_jsx_runtime.JSX.Element;
+
+interface Props {
+    orderID: string;
+    initialEmail?: string;
+    accessToken?: string;
+    onBack?: () => void;
+}
+declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
+
 interface PanelConfig {
     projectID?: string;
     loginURL?: string;
@@ -461,4 +500,4 @@ declare function persistReturnURL(returnURL: string | null): void;
 declare function readPersistedReturnURL(): string | null;
 declare function buildAccessTokenRedirect(returnURL: string, accessToken: string): string;
 
-export { Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, type GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, type PanelLoginProps, type PanelProps, PanelProvider, type PanelScreen, type PanelSearchParamsType, 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 { Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, type GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, type PanelLoginProps, type PanelProps, PanelProvider, type PanelScreen, type PanelSearchParamsType, type PublicNotificationGroup, PublicOrderPage, ReturnsAppearance, ReturnsTexts, 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 };

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CSSProperties, ReactNode } from 'react';
+import { S as SlotAppearance, A as AppearanceElements } from './appearance-core-Dt2grZdl.js';
+export { PRODUCT_LIST_SLOT_NAMES, ProductList, ProductListAppearance, ProductListAppearanceElements, ProductListAppearanceTokens, ProductListData, ProductListItemContext, ProductListProps, ProductListSlotAppearance, ProductListSlotName, ProductListTextKey, ProductListTexts, ProductListTheme, PublicListProduct, UseProductsOptions, UseProductsResult, formatProductPrice, useProducts } from './catalog.js';
+import { ReturnsAppearance, ReturnsTexts } from './returns.js';
+export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, CreateReturnInput, Environment, LegacyCreateReturnInput, LegacyReturnsTexts, LegacyReturnsTheme, RETURNS_SLOT_NAMES, ReturnsAppearanceElements, ReturnsAppearanceProvider, ReturnsAppearanceTokens, ReturnsChallenge, ReturnsCodeStep, ReturnsCodeStepProps, ReturnsConfirmation, ReturnsConfirmationProps, ReturnsEmailStep, ReturnsEmailStepProps, ReturnsEnvironment, ReturnsEnvironmentInput, ReturnsMyReturnDetail, ReturnsMyReturnDetailProps, ReturnsMyReturnsList, ReturnsMyReturnsListProps, ReturnsOrderDetail, ReturnsOrderDetailProps, ReturnsOrderList, ReturnsOrderListProps, ReturnsProvider, ReturnsProviderProps, ReturnsResult, ReturnsResultProps, ReturnsSessionStatus, ReturnsSlotAppearance, ReturnsSlotName, ReturnsTextKey, ReturnsTextsInput, ReturnsTheme, SelectedReturnLine, UseCreateReturnResult, UseMyReturnResult, UseMyReturnsResult, UseReturnOrdersResult, UseReturnSessionResult, UseReturnableOrderResult, useCreateReturn, useMyReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder, useReturnsAppearance, useReturnsSlot, useReturnsText } from './returns.js';
+import { ReactNode } from 'react';
 import z__default from 'zod';
-export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, Environment, useCreateReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder } from './returns.js';
-import '@tanstack/react-query';
+import './models.js';
 import '@bufbuild/protobuf/wkt';
 import '@bufbuild/protobuf';
 
@@ -85,13 +88,8 @@ type CheckoutAppearanceTokens = {
  */
 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"];
 type CheckoutSlotName = (typeof CHECKOUT_SLOT_NAMES)[number];
-type CheckoutSlotAppearance = {
-    /** Merged after the built-in classes with `cn`, so Tailwind conflicts resolve. */
-    className?: string;
-    /** Merged after the built-in inline styles. */
-    style?: CSSProperties;
-};
-type CheckoutAppearanceElements = Partial<Record<CheckoutSlotName, CheckoutSlotAppearance>>;
+type CheckoutSlotAppearance = SlotAppearance;
+type CheckoutAppearanceElements = AppearanceElements<CheckoutSlotName>;
 type CheckoutAppearance = {
     /**
      * `"dark"` keeps the current presentation, `"light"` applies the light preset.
@@ -104,6 +102,28 @@ type CheckoutAppearance = {
     elements?: CheckoutAppearanceElements;
 };
 
+/**
+ * Every string the checkout renders. Pass a partial object through the
+ * `texts` prop of `BitsnapCheckout` to override any of them, whatever the
+ * locale.
+ */
+type CheckoutTexts = {
+    /** Drawer title. */
+    cart: string;
+    /** Shown when the cart has no products. */
+    emptyCart: string;
+    /** Label next to the total price. */
+    total: string;
+    /** Delivery note next to the total price. */
+    delivery: string;
+    /** Country selector placeholder. */
+    chooseCountry: string;
+    /** Checkout button label. */
+    nextStep: string;
+    /** Error shown when some products are out of stock. */
+    unavailableProducts: string;
+};
+
 type BitsnapCartProps = {
     projectID: string;
     locale?: string;
@@ -119,8 +139,13 @@ type BitsnapCartProps = {
      * current presentation; every token and element slot is partial.
      */
     appearance?: CheckoutAppearance;
+    /**
+     * Optional text overrides. Any key given here replaces the built-in string
+     * whatever the locale; omitted keys keep the `pl`/`en` defaults.
+     */
+    texts?: Partial<CheckoutTexts>;
 };
-declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
+declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
 
 type Props$2 = {
     test?: boolean;
@@ -378,6 +403,11 @@ declare const linkRequestSchema: z__default.ZodObject<{
 }, z__default.core.$strip>;
 
 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`).
+     */
     function addProductToCart(id: string, quantity?: number, metadata?: Record<string, string | undefined>, args?: {
         name?: string;
         price?: number;
@@ -401,16 +431,6 @@ declare function injectReferenceToRequestIfNeeded(request: LinkRequest): LinkReq
 
 declare const PanelLogin: () => react_jsx_runtime.JSX.Element;
 
-declare const PanelPage: () => react_jsx_runtime.JSX.Element;
-
-interface Props {
-    orderID: string;
-    initialEmail?: string;
-    accessToken?: string;
-    onBack?: () => void;
-}
-declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
-
 interface GetThemeOutput {
     logoURL?: string;
     logoDarkURL?: string;
@@ -419,22 +439,41 @@ interface GetThemeOutput {
         brandDark?: string;
     };
 }
-type PanelScreen = "products" | "notifications" | "profile" | "plans" | "orders" | "order-details";
+type PanelScreen = "products" | "notifications" | "profile" | "plans" | "orders" | "order-details" | "returns" | "return-details";
 type PanelSearchParamsType = {
     product?: string;
     state: PanelScreen;
     orderId?: string;
+    returnId?: string;
 };
 interface PanelProps {
     projectID: string;
     theme?: GetThemeOutput;
     loginURL: string;
+    /**
+     * Appearance of the Returns screen. When omitted, `buttonBackground`,
+     * `focusRing` and a readable `buttonForeground` are derived from
+     * `theme.colors.brand`.
+     */
+    returnsAppearance?: ReturnsAppearance;
+    /** Text overrides of the Returns screen. */
+    returnsTexts?: Partial<ReturnsTexts>;
 }
 interface PanelLoginProps {
     projectID: string;
     theme?: GetThemeOutput;
 }
 
+declare const PanelPage: ({ returnsAppearance, returnsTexts, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts">) => react_jsx_runtime.JSX.Element;
+
+interface Props {
+    orderID: string;
+    initialEmail?: string;
+    accessToken?: string;
+    onBack?: () => void;
+}
+declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
+
 interface PanelConfig {
     projectID?: string;
     loginURL?: string;
@@ -461,4 +500,4 @@ declare function persistReturnURL(returnURL: string | null): void;
 declare function readPersistedReturnURL(): string | null;
 declare function buildAccessTokenRedirect(returnURL: string, accessToken: string): string;
 
-export { Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, type GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, type PanelLoginProps, type PanelProps, PanelProvider, type PanelScreen, type PanelSearchParamsType, 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 { Wrapper$2 as ApplePayButton, type Props$3 as ApplePayButtonProps, Bitsnap, type BitsnapCartProps, BitsnapCart as BitsnapCheckout, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, type GetThemeOutput, Wrapper$1 as GooglePayButton, type Props$2 as GooglePayButtonProps, type LinkRequest, type NotificationGroup, Wrapper as NotificationsComponent, type Props$1 as NotificationsComponentProps, type NotificationsComponentPublicProps, PanelPage as Panel, type PanelConfig, PanelLogin, type PanelLoginProps, type PanelProps, PanelProvider, type PanelScreen, type PanelSearchParamsType, type PublicNotificationGroup, PublicOrderPage, ReturnsAppearance, ReturnsTexts, 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 };