bitsnap-react 1.4.15 → 1.6.0

package/dist/index.d.ts

@@ -0,0 +1,464 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CSSProperties, 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 '@bufbuild/protobuf/wkt';
+import '@bufbuild/protobuf';
+
+type AppleButtonType = "plain" | "add-money" | "book" | "buy" | "check-out" | "continue" | "contribute" | "donate" | "order" | "pay" | "reload" | "rent" | "set-up" | "subscribe" | "support" | "tip" | "top-up";
+type ColorType = "black" | "white" | "white-outline";
+type Props$3 = {
+    style?: {
+        width?: string;
+        height?: string;
+        borderRadius?: string;
+        padding?: string;
+        boxSizing?: string;
+    };
+    buttonType?: AppleButtonType;
+    colorType?: ColorType;
+    items: {
+        name: string;
+        id: string;
+        price: number;
+        quantity: number;
+        isDeliverable?: boolean;
+        metadata?: {
+            [key: string]: string | undefined;
+        };
+    }[];
+    onClick?: () => Promise<void>;
+};
+declare function Wrapper$2(props: Props$3): react_jsx_runtime.JSX.Element;
+
+/**
+ * Checkout appearance API.
+ *
+ * `CheckoutAppearance` is resolved once per render into plain data: a theme
+ * name, the tokens that are actually in effect, the per-slot overrides and the
+ * inline style that both theme boundaries (the drawer root and the portalled
+ * country dropdown) have to receive. Everything here is pure so it can be
+ * tested without a DOM.
+ *
+ * Backward compatibility: the resolver never invents values. A token is only
+ * present in the resolved output when the caller provided it or when the
+ * caller explicitly selected a theme preset, so every unset token keeps falling
+ * back to the value the checkout renders today (see `checkout.css`).
+ */
+type CheckoutTheme = "dark" | "light";
+type CheckoutAppearanceTokens = {
+    /** Checkout wide font family. The library never loads fonts. */
+    fontFamily?: string;
+    /** Base font size of the checkout. */
+    fontSize?: string;
+    /** Panel background. */
+    background?: string;
+    /** Raised surfaces: country dropdown, search bar, loading skeletons. */
+    surface?: string;
+    /** Main text color. */
+    foreground?: string;
+    /** Secondary text: empty cart, delivery info, country label, search input. */
+    mutedForeground?: string;
+    /** Borders: country trigger, dropdown, product separators. */
+    border?: string;
+    /** Checkout button background. */
+    buttonBackground?: string;
+    /** Checkout button text. */
+    buttonForeground?: string;
+    /** Checkout button background on hover. */
+    buttonHoverBackground?: string;
+    /** Hover and selected surfaces: close button, country options. */
+    hoverSurface?: string;
+    /** Focus ring color. Also applied to shared UI primitives through `--ring`. */
+    focusRing?: string;
+    /** Error and unavailable state color. */
+    error?: string;
+    /** Drawer backdrop color. */
+    overlay?: string;
+    /** Corner radius, applied through `--radius`. */
+    radius?: string;
+};
+/**
+ * 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"];
+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 CheckoutAppearance = {
+    /**
+     * `"dark"` keeps the current presentation, `"light"` applies the light preset.
+     * Omitted means `"dark"`.
+     */
+    theme?: CheckoutTheme;
+    /** Partial overrides. Anything omitted keeps today's value. */
+    tokens?: CheckoutAppearanceTokens;
+    /** Per element `className`/`style` overrides. */
+    elements?: CheckoutAppearanceElements;
+};
+
+type BitsnapCartProps = {
+    projectID: string;
+    locale?: string;
+    children?: React.ReactNode;
+    onVisibleChange?: (isVisible: boolean) => void;
+    className?: string;
+    numberOfProductsInCartOptions?: {
+        style?: React.CSSProperties;
+        isVisible?: boolean;
+    };
+    /**
+     * Optional checkout appearance. Omitting it (or passing `{}`) keeps the
+     * current presentation; every token and element slot is partial.
+     */
+    appearance?: CheckoutAppearance;
+};
+declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
+
+type Props$2 = {
+    test?: boolean;
+    buttonSizeMode?: "static" | "fill";
+    buttonColor?: "white" | "black";
+    style?: {
+        width?: string;
+    };
+    items: {
+        name: string;
+        id: string;
+        price: number;
+        quantity: number;
+        isDeliverable?: boolean;
+        metadata?: {
+            [key: string]: string | undefined;
+        };
+    }[];
+};
+declare function Wrapper$1(props: Props$2): react_jsx_runtime.JSX.Element;
+
+type PublicNotificationGroup = {
+    id: string;
+    isOn?: boolean;
+};
+type NotificationGroup = {
+    id: string;
+    name: string;
+    description?: string;
+    howOften?: string;
+    isOn?: boolean;
+};
+interface CustomizationTexts {
+    title?: string | null;
+    description?: string | null;
+    managingDescription?: string;
+    formTitle?: string;
+    formEmailLabel?: string;
+    formPhoneLabel?: string;
+    formPhoneOptional?: string;
+    formEmailPlaceholder?: string;
+    formPhonePlaceholder?: string;
+    formSubmitButton?: string;
+    formSuccessMessage?: string;
+    agreementText?: string | ReactNode;
+    qrCodeTitle?: string;
+    qrCodeSubtitle?: string;
+    qrCodeScanText?: string;
+    groupsNoSelectionWarning?: string;
+    groupsTitle?: string;
+    groupsSelectAllButton?: string;
+    groupsUpdateButton?: string;
+    groupsUpdateSuccess?: string;
+    manageDataTitle?: string;
+    manageDataDescription?: string;
+    manageDataUnsubscribeButton?: string;
+    manageDataUnsubscribeDescription?: string;
+    manageDataUpdatedMessage?: string;
+    loginEmailLabel?: string;
+    loginEmailPlaceholder?: string;
+    loginSendCodeButton?: string;
+    loginIHaveCode?: string;
+    loginSendingButton?: string;
+    loginCodeLabel?: string;
+    loginCodeSentMessage?: string;
+    loginChangeEmailButton?: string;
+    loginResendCodeButton?: string;
+    loginInvalidEmailError?: string;
+    loginSlugRequiredError?: string;
+    loginVerificationFailedError?: string;
+    loginInvalidCodeError?: string;
+    loginSendEmailError?: string;
+    loginVerifyCodeError?: string;
+    loginResendEmailError?: string;
+    loginTitle?: string;
+    loginDescription?: string;
+}
+interface ComponentClassNames {
+    container?: string;
+    header?: string;
+    headerTitle?: string;
+    headerLogo?: string;
+    headerDescription?: string;
+    groupsContainer?: string;
+    groupsList?: string;
+    groupItem?: string;
+    qrCodeSection?: string;
+    qrCodeTitle?: string;
+    qrCodeContainer?: string;
+    formSection?: string;
+    formTitle?: string;
+    formContainer?: string;
+    manageDataSection?: string;
+    manageDataTitle?: string;
+}
+/**
+ * Props for the NotificationsComponentPublic component.
+ */
+interface NotificationsComponentPublicProps {
+    /**
+     * Unique identifier for the project (if not provided, productID will be used via CartProvider).
+     */
+    slug?: string;
+    /**
+     * Unique identifier for the user.
+     */
+    userID?: string;
+    /**
+     * Project ID (alternative to slug, used if slug is not provided).
+     */
+    productID?: string;
+    /**
+     * Name of the project, displayed in the component.
+     */
+    projectName?: string;
+    /**
+     * URL or path to the project's logo (light mode).
+     */
+    projectLogo?: string;
+    /**
+     * URL or path to the project's logo (dark mode).
+     */
+    projectLogoDark?: string;
+    /**
+     * Array of notification groups that the user can subscribe to. If you will provide group, we will not show all possible public groups from dashboard.
+     */
+    groups?: PublicNotificationGroup[];
+    /**
+     * If true, the component is rendered in "manage my notifications" mode.
+     */
+    isManaging?: boolean;
+    /**
+     * Custom texts used throughout the component for i18n or personalisation.
+     */
+    texts?: CustomizationTexts;
+    /**
+     * If true, show the QR code section that allows users to get a mobile app.
+     */
+    showQRCode?: boolean;
+    /**
+     * If true, show the phone input in the notification form.
+     */
+    showPhoneInput?: boolean;
+    /**
+     * List of group IDs to hide from the selection interface.
+     */
+    hiddenGroupIds?: string[];
+    /**
+     * Custom CSS class names for various component sections (for easier styling).
+     */
+    className?: ComponentClassNames;
+}
+
+type Props$1 = NotificationsComponentPublicProps;
+declare function Wrapper({ slug, userID, productID, projectName, projectLogo, projectLogoDark, groups, isManaging, texts, showQRCode, showPhoneInput, hiddenGroupIds, className, }: Props$1): react_jsx_runtime.JSX.Element;
+
+type ErrTypes = "internal" | "badInput" | "notFound";
+type Err = {
+    ERR: true;
+    error: unknown;
+    type?: ErrTypes;
+    data?: unknown;
+};
+declare function Err(message: string, type?: ErrTypes, data?: unknown): Err;
+
+declare function setLocale(locale?: string): void;
+declare function getLocale(): string;
+
+declare function setProjectID$1(projectID: string): void;
+
+declare function setCustomHost(host: string): void;
+
+declare enum BillingPeriod {
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    QUARTERLY = "quarterly",
+    SEMI_ANNUALLY = "semi-annually",
+    ANNUALLY = "annually"
+}
+type LinkRequest = z__default.infer<typeof linkRequestSchema>;
+declare const linkRequestSchema: z__default.ZodObject<{
+    locale: z__default.ZodOptional<z__default.ZodString>;
+    askForAddress: z__default.ZodOptional<z__default.ZodBoolean>;
+    askForPhone: z__default.ZodOptional<z__default.ZodBoolean>;
+    askForNote: z__default.ZodOptional<z__default.ZodBoolean>;
+    askForNip: z__default.ZodOptional<z__default.ZodBoolean>;
+    delivery: z__default.ZodOptional<z__default.ZodArray<z__default.ZodObject<{
+        name: z__default.ZodString;
+        desc: z__default.ZodOptional<z__default.ZodString>;
+        min: z__default.ZodNumber;
+        max: z__default.ZodNumber;
+        price: z__default.ZodPipe<z__default.ZodNumber, z__default.ZodTransform<number, number>>;
+    }, z__default.core.$strip>>>;
+    deliveryMethod: z__default.ZodOptional<z__default.ZodString>;
+    details: z__default.ZodOptional<z__default.ZodObject<{
+        email: z__default.ZodOptional<z__default.ZodString>;
+        name: z__default.ZodOptional<z__default.ZodString>;
+        lastName: z__default.ZodOptional<z__default.ZodString>;
+        phone: z__default.ZodOptional<z__default.ZodString>;
+        address: z__default.ZodOptional<z__default.ZodObject<{
+            name: z__default.ZodOptional<z__default.ZodString>;
+            line1: z__default.ZodOptional<z__default.ZodString>;
+            line2: z__default.ZodOptional<z__default.ZodString>;
+            city: z__default.ZodOptional<z__default.ZodString>;
+            zipCode: z__default.ZodOptional<z__default.ZodString>;
+            country: z__default.ZodOptional<z__default.ZodString>;
+        }, z__default.core.$strip>>;
+        billingAddress: z__default.ZodOptional<z__default.ZodObject<{
+            nip: z__default.ZodOptional<z__default.ZodString>;
+            name: z__default.ZodOptional<z__default.ZodString>;
+            line1: z__default.ZodOptional<z__default.ZodString>;
+            line2: z__default.ZodOptional<z__default.ZodString>;
+            city: z__default.ZodOptional<z__default.ZodString>;
+            zipCode: z__default.ZodOptional<z__default.ZodString>;
+        }, z__default.core.$strip>>;
+    }, z__default.core.$strip>>;
+    countries: z__default.ZodOptional<z__default.ZodArray<z__default.ZodString>>;
+    items: z__default.ZodArray<z__default.ZodObject<{
+        id: z__default.ZodString;
+        quantity: z__default.ZodNumber;
+        priceVersion: z__default.ZodOptional<z__default.ZodString>;
+        name: z__default.ZodOptional<z__default.ZodString>;
+        description: z__default.ZodOptional<z__default.ZodString>;
+        imageURL: z__default.ZodOptional<z__default.ZodString>;
+        price: z__default.ZodOptional<z__default.ZodNumber>;
+        currency: z__default.ZodOptional<z__default.ZodString>;
+        recurring: z__default.ZodOptional<z__default.ZodObject<{
+            billingPeriod: z__default.ZodEnum<{
+                daily: BillingPeriod.DAILY;
+                weekly: BillingPeriod.WEEKLY;
+                monthly: BillingPeriod.MONTHLY;
+                quarterly: BillingPeriod.QUARTERLY;
+                "semi-annually": BillingPeriod.SEMI_ANNUALLY;
+                annually: BillingPeriod.ANNUALLY;
+            }>;
+            trialDays: z__default.ZodOptional<z__default.ZodNumber>;
+            subscriptionSchedule: z__default.ZodOptional<z__default.ZodNumber>;
+        }, z__default.core.$strip>>;
+    }, z__default.core.$strip>>;
+    metadata: z__default.ZodOptional<z__default.ZodRecord<z__default.ZodString, z__default.ZodString>>;
+    additionalAgreements: z__default.ZodOptional<z__default.ZodArray<z__default.ZodObject<{
+        id: z__default.ZodOptional<z__default.ZodString>;
+        name: z__default.ZodString;
+        description: z__default.ZodOptional<z__default.ZodString>;
+        required: z__default.ZodDefault<z__default.ZodBoolean>;
+        answer: z__default.ZodOptional<z__default.ZodBoolean>;
+    }, z__default.core.$strip>>>;
+    blikCode: z__default.ZodOptional<z__default.ZodString>;
+    couponCode: z__default.ZodOptional<z__default.ZodString>;
+    redirect: z__default.ZodOptional<z__default.ZodObject<{
+        successURL: z__default.ZodOptional<z__default.ZodString>;
+        cancelURL: z__default.ZodOptional<z__default.ZodString>;
+    }, z__default.core.$strip>>;
+}, z__default.core.$strip>;
+
+declare namespace Bitsnap {
+    function addProductToCart(id: string, quantity?: number, metadata?: Record<string, string | undefined>, args?: {
+        name?: string;
+        price?: number;
+        currency?: string;
+    }): Promise<Err | undefined>;
+    function showCart(): void;
+    function hideCart(): void;
+}
+declare function createPaymentURL(request: LinkRequest): Promise<Err | {
+    url: string;
+}>;
+declare function createCheckout(request: LinkRequest & {
+    apiKey?: string;
+    testMode?: boolean;
+}): Promise<{
+    status: string;
+    redirectURL: string;
+}>;
+declare function getReferenceIfPossible(): string | undefined;
+declare function injectReferenceToRequestIfNeeded(request: LinkRequest): LinkRequest;
+
+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;
+    colors?: {
+        brand?: string;
+        brandDark?: string;
+    };
+}
+type PanelScreen = "products" | "notifications" | "profile" | "plans" | "orders" | "order-details";
+type PanelSearchParamsType = {
+    product?: string;
+    state: PanelScreen;
+    orderId?: string;
+};
+interface PanelProps {
+    projectID: string;
+    theme?: GetThemeOutput;
+    loginURL: string;
+}
+interface PanelLoginProps {
+    projectID: string;
+    theme?: GetThemeOutput;
+}
+
+interface PanelConfig {
+    projectID?: string;
+    loginURL?: string;
+    theme?: GetThemeOutput;
+    host?: string;
+    allowedReturnOrigins: string[];
+}
+declare function setPanelConfig(newConfig: Partial<PanelConfig>): void;
+declare function getPanelConfig(): PanelConfig;
+declare function setProjectID(projectID: string): void;
+declare function setTheme(theme: GetThemeOutput): void;
+declare function setLoginURL(loginURL: string): void;
+declare function setHost(host: string): void;
+declare function setAllowedReturnOrigins(origins: string[]): void;
+declare function getAllowedReturnOrigins(): string[];
+
+declare const PanelProvider: React.FC<{
+    children: React.ReactNode;
+}>;
+declare const usePanelConfig: () => PanelConfig;
+
+declare function getReturnURLFromSearch(search: string): string | null;
+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 };