bitsnap-react 1.8.0 → 1.9.0

package/dist/index.d.mts

@@ -1,12 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { A as AnalyticsOption, l as Instrument } from './instrument-C_abZLHk.mjs';
 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';
 export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, CreateReturnInput, Environment, LegacyCreateReturnInput, LegacyReturnsTexts, LegacyReturnsTheme, ReturnsAppearanceProvider, ReturnsChallenge, ReturnsCodeStep, ReturnsCodeStepProps, ReturnsConfirmation, ReturnsConfirmationProps, ReturnsEmailStep, ReturnsEmailStepProps, ReturnsEnvironment, ReturnsEnvironmentInput, ReturnsMyReturnDetail, ReturnsMyReturnDetailProps, ReturnsMyReturnsList, ReturnsMyReturnsListProps, ReturnsOrderDetail, ReturnsOrderDetailProps, ReturnsOrderList, ReturnsOrderListProps, ReturnsProvider, ReturnsProviderProps, ReturnsResult, ReturnsResultProps, ReturnsSessionStatus, ReturnsTextsInput, SelectedReturnLine, UseCreateReturnResult, UseMyReturnResult, UseMyReturnsResult, UseReturnOrdersResult, UseReturnSessionResult, UseReturnableOrderResult, useCreateReturn, useMyReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder, useReturnsAppearance, useReturnsSlot, useReturnsText } from './returns.mjs';
 export { b as RETURNS_SLOT_NAMES, R as ReturnsAppearance, c as ReturnsAppearanceElements, d as ReturnsAppearanceTokens, e as ReturnsSlotAppearance, f as ReturnsSlotName, h as ReturnsTextKey, a as ReturnsTexts, g as ReturnsTheme } from './texts-tQtAGJCT.mjs';
 import { ReactNode } from 'react';
 import z__default from 'zod';
-import { P as PanelProps, G as GetThemeOutput } from './types-PSBBDdQm.mjs';
-export { a as PanelLoginProps, b as PanelScreen, c as PanelSearchParamsType } from './types-PSBBDdQm.mjs';
+import { P as PanelProps, G as GetThemeOutput } from './types-D_WnqwR_.mjs';
+export { a as PanelLoginProps, b as PanelScreen, c as PanelSearchParamsType } from './types-D_WnqwR_.mjs';
 import './models.mjs';
 import '@bufbuild/protobuf/wkt';
 import '@bufbuild/protobuf';
@@ -34,6 +35,12 @@ type Props$3 = {
         };
     }[];
     onClick?: () => Promise<void>;
+    /**
+     * Usage statistics for your Bitsnap dashboard (Apple Pay clicks and
+     * results). On by default; `false` turns it off. Inside `<BitsnapCheckout>`
+     * the checkout's setting applies unless this is given.
+     */
+    analytics?: AnalyticsOption;
 };
 declare function Wrapper$2(props: Props$3): react_jsx_runtime.JSX.Element;
 
@@ -146,8 +153,15 @@ type BitsnapCartProps = {
      * whatever the locale; omitted keys keep the `pl`/`en` defaults.
      */
     texts?: Partial<CheckoutTexts>;
+    /**
+     * Usage statistics for your Bitsnap dashboard (cart opened, checkout
+     * started, add to cart). On by default; `false` turns it off. An object
+     * lets you forward every event: `{ onEvent }`. Nothing is stored on the
+     * visitor's device.
+     */
+    analytics?: AnalyticsOption;
 };
-declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
+declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, analytics, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
 
 type Props$2 = {
     test?: boolean;
@@ -166,6 +180,12 @@ type Props$2 = {
             [key: string]: string | undefined;
         };
     }[];
+    /**
+     * Usage statistics for your Bitsnap dashboard. On by default; `false` turns
+     * it off. Inside `<BitsnapCheckout>` the checkout's setting applies unless
+     * this is given.
+     */
+    analytics?: AnalyticsOption;
 };
 declare function Wrapper$1(props: Props$2): react_jsx_runtime.JSX.Element;
 
@@ -299,10 +319,21 @@ interface NotificationsComponentPublicProps {
      * Custom CSS class names for various component sections (for easier styling).
      */
     className?: ComponentClassNames;
+    /**
+     * Public project ID used for usage statistics. Defaults to the one set by
+     * `<BitsnapCheckout projectID>`.
+     */
+    projectID?: string;
+    /**
+     * Usage statistics for your Bitsnap dashboard (sign-ups). On by default;
+     * `false` turns it off. An object lets you forward every event:
+     * `{ onEvent }`. Nothing is stored on the visitor's device.
+     */
+    analytics?: AnalyticsOption;
 }
 
 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;
+declare function Wrapper({ slug, userID, productID, projectID, analytics, projectName, projectLogo, projectLogoDark, groups, isManaging, texts, showQRCode, showPhoneInput, hiddenGroupIds, className, }: Props$1): react_jsx_runtime.JSX.Element;
 
 type ErrTypes = "internal" | "badInput" | "notFound";
 type Err = {
@@ -414,6 +445,8 @@ declare namespace Bitsnap {
         name?: string;
         price?: number;
         currency?: string;
+        /** Where `add_to_cart` is reported. Defaults to the mounted `<BitsnapCheckout>`. */
+        analytics?: Instrument;
     }): Promise<Err | undefined>;
     function showCart(): void;
     function hideCart(): void;
@@ -431,15 +464,22 @@ declare function createCheckout(request: LinkRequest & {
 declare function getReferenceIfPossible(): string | undefined;
 declare function injectReferenceToRequestIfNeeded(request: LinkRequest): LinkRequest;
 
-declare const PanelLogin: () => react_jsx_runtime.JSX.Element;
+declare const PanelLogin: ({ analytics, }?: {
+    analytics?: AnalyticsOption;
+}) => react_jsx_runtime.JSX.Element;
 
-declare const PanelPage: ({ returnsAppearance, returnsTexts, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts">) => react_jsx_runtime.JSX.Element;
+declare const PanelPage: ({ returnsAppearance, returnsTexts, analytics, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts" | "analytics">) => react_jsx_runtime.JSX.Element;
 
 interface Props {
     orderID: string;
     initialEmail?: string;
     accessToken?: string;
     onBack?: () => void;
+    /**
+     * Usage statistics for your Bitsnap dashboard (order viewed). Inside
+     * `<Panel>` or `<PanelProvider>` their setting applies unless this is given.
+     */
+    analytics?: AnalyticsOption;
 }
 declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
 
@@ -461,6 +501,13 @@ declare function getAllowedReturnOrigins(): string[];
 
 declare const PanelProvider: React.FC<{
     children: React.ReactNode;
+    /**
+     * Usage statistics for your Bitsnap dashboard (panel logins, orders viewed,
+     * downloads, course progress). On by default; `false` turns it off. An
+     * object lets you forward every event: `{ onEvent }`. Nothing is stored on
+     * the visitor's device.
+     */
+    analytics?: AnalyticsOption;
 }>;
 declare const usePanelConfig: () => PanelConfig;
 
@@ -469,4 +516,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 CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, 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, 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, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, 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, 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 };

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { A as AnalyticsOption, l as Instrument } from './instrument-C_abZLHk.js';
 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';
 export { BitsnapReturns, BitsnapReturnsProps, BitsnapReturnsProvider, BitsnapReturnsProviderProps, CreateReturnInput, Environment, LegacyCreateReturnInput, LegacyReturnsTexts, LegacyReturnsTheme, ReturnsAppearanceProvider, ReturnsChallenge, ReturnsCodeStep, ReturnsCodeStepProps, ReturnsConfirmation, ReturnsConfirmationProps, ReturnsEmailStep, ReturnsEmailStepProps, ReturnsEnvironment, ReturnsEnvironmentInput, ReturnsMyReturnDetail, ReturnsMyReturnDetailProps, ReturnsMyReturnsList, ReturnsMyReturnsListProps, ReturnsOrderDetail, ReturnsOrderDetailProps, ReturnsOrderList, ReturnsOrderListProps, ReturnsProvider, ReturnsProviderProps, ReturnsResult, ReturnsResultProps, ReturnsSessionStatus, ReturnsTextsInput, SelectedReturnLine, UseCreateReturnResult, UseMyReturnResult, UseMyReturnsResult, UseReturnOrdersResult, UseReturnSessionResult, UseReturnableOrderResult, useCreateReturn, useMyReturn, useMyReturns, useReturnOrders, useReturnSession, useReturnableOrder, useReturnsAppearance, useReturnsSlot, useReturnsText } from './returns.js';
 export { b as RETURNS_SLOT_NAMES, R as ReturnsAppearance, c as ReturnsAppearanceElements, d as ReturnsAppearanceTokens, e as ReturnsSlotAppearance, f as ReturnsSlotName, h as ReturnsTextKey, a as ReturnsTexts, g as ReturnsTheme } from './texts-CIEFbJTN.js';
 import { ReactNode } from 'react';
 import z__default from 'zod';
-import { P as PanelProps, G as GetThemeOutput } from './types-BTm_ZolC.js';
-export { a as PanelLoginProps, b as PanelScreen, c as PanelSearchParamsType } from './types-BTm_ZolC.js';
+import { P as PanelProps, G as GetThemeOutput } from './types-BaqLJYuq.js';
+export { a as PanelLoginProps, b as PanelScreen, c as PanelSearchParamsType } from './types-BaqLJYuq.js';
 import './models.js';
 import '@bufbuild/protobuf/wkt';
 import '@bufbuild/protobuf';
@@ -34,6 +35,12 @@ type Props$3 = {
         };
     }[];
     onClick?: () => Promise<void>;
+    /**
+     * Usage statistics for your Bitsnap dashboard (Apple Pay clicks and
+     * results). On by default; `false` turns it off. Inside `<BitsnapCheckout>`
+     * the checkout's setting applies unless this is given.
+     */
+    analytics?: AnalyticsOption;
 };
 declare function Wrapper$2(props: Props$3): react_jsx_runtime.JSX.Element;
 
@@ -146,8 +153,15 @@ type BitsnapCartProps = {
      * whatever the locale; omitted keys keep the `pl`/`en` defaults.
      */
     texts?: Partial<CheckoutTexts>;
+    /**
+     * Usage statistics for your Bitsnap dashboard (cart opened, checkout
+     * started, add to cart). On by default; `false` turns it off. An object
+     * lets you forward every event: `{ onEvent }`. Nothing is stored on the
+     * visitor's device.
+     */
+    analytics?: AnalyticsOption;
 };
-declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
+declare function BitsnapCart({ projectID, locale, children, onVisibleChange, className, numberOfProductsInCartOptions, appearance, texts, analytics, }: BitsnapCartProps): react_jsx_runtime.JSX.Element;
 
 type Props$2 = {
     test?: boolean;
@@ -166,6 +180,12 @@ type Props$2 = {
             [key: string]: string | undefined;
         };
     }[];
+    /**
+     * Usage statistics for your Bitsnap dashboard. On by default; `false` turns
+     * it off. Inside `<BitsnapCheckout>` the checkout's setting applies unless
+     * this is given.
+     */
+    analytics?: AnalyticsOption;
 };
 declare function Wrapper$1(props: Props$2): react_jsx_runtime.JSX.Element;
 
@@ -299,10 +319,21 @@ interface NotificationsComponentPublicProps {
      * Custom CSS class names for various component sections (for easier styling).
      */
     className?: ComponentClassNames;
+    /**
+     * Public project ID used for usage statistics. Defaults to the one set by
+     * `<BitsnapCheckout projectID>`.
+     */
+    projectID?: string;
+    /**
+     * Usage statistics for your Bitsnap dashboard (sign-ups). On by default;
+     * `false` turns it off. An object lets you forward every event:
+     * `{ onEvent }`. Nothing is stored on the visitor's device.
+     */
+    analytics?: AnalyticsOption;
 }
 
 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;
+declare function Wrapper({ slug, userID, productID, projectID, analytics, projectName, projectLogo, projectLogoDark, groups, isManaging, texts, showQRCode, showPhoneInput, hiddenGroupIds, className, }: Props$1): react_jsx_runtime.JSX.Element;
 
 type ErrTypes = "internal" | "badInput" | "notFound";
 type Err = {
@@ -414,6 +445,8 @@ declare namespace Bitsnap {
         name?: string;
         price?: number;
         currency?: string;
+        /** Where `add_to_cart` is reported. Defaults to the mounted `<BitsnapCheckout>`. */
+        analytics?: Instrument;
     }): Promise<Err | undefined>;
     function showCart(): void;
     function hideCart(): void;
@@ -431,15 +464,22 @@ declare function createCheckout(request: LinkRequest & {
 declare function getReferenceIfPossible(): string | undefined;
 declare function injectReferenceToRequestIfNeeded(request: LinkRequest): LinkRequest;
 
-declare const PanelLogin: () => react_jsx_runtime.JSX.Element;
+declare const PanelLogin: ({ analytics, }?: {
+    analytics?: AnalyticsOption;
+}) => react_jsx_runtime.JSX.Element;
 
-declare const PanelPage: ({ returnsAppearance, returnsTexts, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts">) => react_jsx_runtime.JSX.Element;
+declare const PanelPage: ({ returnsAppearance, returnsTexts, analytics, }?: Pick<PanelProps, "returnsAppearance" | "returnsTexts" | "analytics">) => react_jsx_runtime.JSX.Element;
 
 interface Props {
     orderID: string;
     initialEmail?: string;
     accessToken?: string;
     onBack?: () => void;
+    /**
+     * Usage statistics for your Bitsnap dashboard (order viewed). Inside
+     * `<Panel>` or `<PanelProvider>` their setting applies unless this is given.
+     */
+    analytics?: AnalyticsOption;
 }
 declare function PublicOrderPage(props: Props): react_jsx_runtime.JSX.Element;
 
@@ -461,6 +501,13 @@ declare function getAllowedReturnOrigins(): string[];
 
 declare const PanelProvider: React.FC<{
     children: React.ReactNode;
+    /**
+     * Usage statistics for your Bitsnap dashboard (panel logins, orders viewed,
+     * downloads, course progress). On by default; `false` turns it off. An
+     * object lets you forward every event: `{ onEvent }`. Nothing is stored on
+     * the visitor's device.
+     */
+    analytics?: AnalyticsOption;
 }>;
 declare const usePanelConfig: () => PanelConfig;
 
@@ -469,4 +516,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 CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, 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, 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, CHECKOUT_SLOT_NAMES, type CheckoutAppearance, type CheckoutAppearanceElements, type CheckoutAppearanceTokens, type CheckoutSlotAppearance, type CheckoutSlotName, type CheckoutTexts, type CheckoutTheme, type ComponentClassNames, type CustomizationTexts, 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, 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 };