@beamimpact/web-sdk 1.56.3 → 1.57.1

package/dist/chunks/{openapi-spec-B4z4_CMq.esm.d.ts → utils-COGFpDER.esm.d.ts}

@@ -1,3 +1,48 @@
+import debounce from 'lodash-es/debounce';
+import isEqual from 'lodash-es/isEqual';
+
+/**
+ * Full URL string (https://abc.com/path), without trailing slash
+ */
+type TUrl$1 = string;
+type LANGUAGES = "en" | "fr" | "de" | "es" | "it" | "pl" | "ja";
+/**
+ * Basic info needed to call the Beam API.
+ * Endpoints may also require parameters such as chainId, storeId, and order/cart details.
+ */
+type BeamBaseAPIConfig = {
+    apiKey: string;
+    baseUrl?: TUrl$1;
+};
+
+declare const WIDGET_NAMES: {
+    readonly select_nonprofit: "select-nonprofit";
+    readonly redeem_transaction: "redeem-transaction";
+    readonly impact_overview: "impact-overview";
+    readonly community_impact: "community-impact";
+    readonly cumulative_impact: "cumulative-impact";
+    readonly product_details_page: "product-details-page";
+    readonly subscription_management: "subscription-management";
+    readonly subscription_impact: "subscription-impact";
+    readonly select_subscription_nonprofit: "select-subscription-nonprofit";
+    readonly social_share: "social-share";
+    readonly subscriber_select_nonprofit: "subscriber-select-nonprofit";
+};
+declare const HELPER_NAMES: {
+    cart_update: string;
+};
+
+/** Number ID */
+type TNumericId = number;
+/** String ID */
+type TId = string;
+/** Beam API key format (prefix.uuid) */
+type TApiKey = string;
+/** Full URL without trailing slash */
+type TUrl = string;
+type WidgetName = (typeof WIDGET_NAMES)[keyof typeof WIDGET_NAMES];
+type HelperName = (typeof HELPER_NAMES)[keyof typeof HELPER_NAMES];
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -889,7 +934,7 @@ interface paths {
                          */
                         lang?: "en" | "fr" | "de" | "es" | "it" | "pl" | "ja";
                         /** @enum {string} */
-                        widgetName: "select-nonprofit" | "redeem-transaction" | "post-purchase" | "subscription-management" | "select-subscription-nonprofit";
+                        widgetName: "select-nonprofit" | "redeem-transaction" | "post-purchase" | "subscription-management" | "select-subscription-nonprofit" | "subscriber-select-nonprofit";
                         /** @example 1.0 */
                         version: string;
                         cart?: {
@@ -2987,7 +3032,7 @@ interface paths {
         put: {
             parameters: {
                 query: {
-                    orderId: string;
+                    orderId: Partial<string> & Partial<number>;
                 };
             };
             responses: {
@@ -3556,7 +3601,7 @@ interface paths {
                         nonprofitId?: number;
                         isCanceled?: boolean;
                         /** @enum {string} */
-                        widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
+                        widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact" | "subscriber-select-nonprofit";
                         version?: string;
                         options?: {
                             response?: {
@@ -4118,7 +4163,7 @@ interface paths {
                         remoteSubscriptionId: string;
                         nonprofitId: number | null;
                         /** @enum {string|null} */
-                        selectionMethod?: ("dashboard" | "remote_order" | "checkout" | "subscription_management_widget") | null;
+                        selectionMethod?: ("dashboard" | "remote_order" | "checkout" | "subscription_management_widget" | "subscriber_select_nonprofit_widget") | null;
                     };
                 };
             };
@@ -4321,8 +4366,8 @@ interface paths {
                     "application/json": {
                         nonprofitId: number | null;
                         /**
-                         * Format: uuid
-                         * @description UUID of an existing selection
+                         * @description UUID
+                         * @example bqkdk-0393b-jbkdd-02difj
                          */
                         selectionId?: string | null;
                         /** @description Cart ID from partner site */
@@ -4401,7 +4446,7 @@ interface paths {
             parameters: {
                 query: {
                     chainId: number;
-                    widgetName: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
+                    widgetName: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact" | "subscriber-select-nonprofit";
                     version: string;
                 };
             };
@@ -4453,7 +4498,7 @@ interface paths {
                         /** @example 4058 */
                         chainId: number;
                         /** @enum {string} */
-                        widgetName: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
+                        widgetName: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact" | "subscriber-select-nonprofit";
                         /** @example 1.0 */
                         version: string;
                         config: {
@@ -7524,7 +7569,7 @@ interface paths {
                     storeId: number;
                     /** When set to true, draft themes are returned */
                     draftConfig?: boolean;
-                    widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
+                    widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact" | "subscriber-select-nonprofit";
                     /** The identifier for the product */
                     remoteProductIdentifier?: string;
                 };
@@ -7678,7 +7723,7 @@ interface paths {
                     storeId: number;
                     /** When set to true, draft themes are returned */
                     draftConfig?: boolean;
-                    widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
+                    widgetName?: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact" | "subscriber-select-nonprofit";
                     /** The identifier for the product */
                     remoteProductIdentifier?: string;
                 };
@@ -8089,4 +8134,545 @@ interface paths {
     };
 }
 
-export type { paths as p };
+type TCartApi = paths["/chain/findEligibleNonprofitsForCart"]["post"]["requestBody"]["content"]["application/json"]["cart"];
+type TCart = TCartApi & {
+    content: {
+        items: Record<string, any>[];
+        discounts?: Record<string, any>[] | undefined | null;
+    };
+};
+type TBeamCartLocalStorage = {
+    cartId: string;
+    beamCartId?: string;
+    subtotal: number;
+    itemCount: number;
+    currencyCode: string;
+} & TCart;
+
+declare class BeamError extends Error {
+    supportUrl: string;
+    constructor(msg?: string, { cause, name }?: {
+        cause?: any;
+        name?: string;
+    });
+}
+declare class NetworkError extends BeamError {
+    /** Fetch Response object with .ok, .status, etc.*/
+    response: Response;
+    /** If network response included JSON payload, it is parsed and available here */
+    body?: Record<string, string>;
+    constructor(response: Response, body?: Record<string, string>, msg?: string);
+}
+declare class MissingConfig extends BeamError {
+    missingConfigKeyNames: string[];
+    constructor(missingConfigKeyNames?: string[], msg?: string);
+}
+declare class LocalStorageError extends BeamError {
+    constructor(msg?: string);
+}
+declare class SetupError extends BeamError {
+    constructor(msg?: string);
+}
+
+type beamErrors_BeamError = BeamError;
+declare const beamErrors_BeamError: typeof BeamError;
+type beamErrors_LocalStorageError = LocalStorageError;
+declare const beamErrors_LocalStorageError: typeof LocalStorageError;
+type beamErrors_MissingConfig = MissingConfig;
+declare const beamErrors_MissingConfig: typeof MissingConfig;
+type beamErrors_NetworkError = NetworkError;
+declare const beamErrors_NetworkError: typeof NetworkError;
+type beamErrors_SetupError = SetupError;
+declare const beamErrors_SetupError: typeof SetupError;
+declare namespace beamErrors {
+  export {
+    beamErrors_BeamError as BeamError,
+    beamErrors_LocalStorageError as LocalStorageError,
+    beamErrors_MissingConfig as MissingConfig,
+    beamErrors_NetworkError as NetworkError,
+    beamErrors_SetupError as SetupError,
+  };
+}
+
+type TPromoCodeRequest = paths["/productDetailsPage"]["post"]["requestBody"]["content"]["application/json"]["promos"];
+type TUnvalidatedPromoRequest = NonNullable<TPromoCodeRequest>["unvalidatedPromoCodes"];
+type TPromoCodeAttribute = {
+    value: string;
+    url?: never;
+} | {
+    url: string;
+    value?: never;
+};
+type TPromoCodeResponse = paths["/productDetailsPage"]["post"]["responses"]["200"]["content"]["application/json"]["promos"];
+type TValidatedPromoResponse = NonNullable<TPromoCodeResponse>["validatedPromoCodes"];
+
+type NetworkEventDetail = {
+    url: string;
+    method: string;
+    type: "fetch";
+    response: Response;
+} | {
+    url: string;
+    method: string;
+    type: "xhr";
+    xhr: XMLHttpRequest;
+};
+/**
+ * beamnetworkcall
+ * Emitted by the Beam network listener whenever any API calls are made on the page
+ */
+declare class BeamNetworkCallEvent extends CustomEvent<NetworkEventDetail> {
+    static eventName: "beamnetworkcall";
+    constructor(detail: NetworkEventDetail);
+}
+type NonprofitSelectDetail = {
+    selectionId?: string;
+    selectedNonprofitId?: number | null;
+    nonprofitName?: string | null;
+    source?: WidgetName | null;
+    timestamp?: Date;
+};
+/**
+ * beamnonprofitselect
+ * Emitted when the end user selects a nonprofit in the Beam widget, and when the previous selection was restored
+ * automatically
+ */
+declare class BeamNonprofitSelectEvent extends CustomEvent<NonprofitSelectDetail> {
+    static eventName: "beamnonprofitselect";
+    constructor(detail: NonprofitSelectDetail);
+}
+type CartChangeDetail = TCartApi & {
+    cartId?: string;
+    subtotal?: number;
+    itemCount?: number;
+    currencyCode?: string;
+};
+/**
+ * beamcartchange
+ * Emitted when Beam detects that cart contents have changed, and when items are added to the cart for the first time
+ */
+declare class BeamCartChangeEvent extends CustomEvent<CartChangeDetail> {
+    static eventName: "beamcartchange";
+    constructor(detail: CartChangeDetail);
+}
+type CartCreatedDetail = CartChangeDetail;
+/**
+ * beamcartcreated
+ * Emitted when a cart is created in Beam for the first time, but NOT when the cart is updated
+ * Beam's cart expiration rules are used to determine when a returning visit counts as the same cart
+ */
+declare class BeamCartCreatedEvent extends CustomEvent<CartCreatedDetail> {
+    static eventName: "beamcartcreated";
+    constructor(detail: CartCreatedDetail);
+}
+type OrderCreatedDetail = {
+    orderId: TId;
+    transactionId: TId;
+    cartTotal: number;
+    currencyCode: string;
+};
+/**
+ * beamordercreated
+ * Emitted when an order is registered with Beam for the first time, but NOT on repeat visits, page refreshes, etc.
+ */
+declare class BeamOrderCreatedEvent extends CustomEvent<OrderCreatedDetail> {
+    static eventName: "beamordercreated";
+    constructor(detail: OrderCreatedDetail);
+}
+/**
+ * beamstatuschange
+ * Emitted when the Beam config object has finished initializing along with all plugins
+ */
+type BeamStatusChangeEventDetail = {
+    status: "pending";
+} | {
+    status: "error";
+    error: Error;
+} | {
+    status: "ready";
+};
+declare class BeamStatusChangeEvent extends CustomEvent<BeamStatusChangeEventDetail> {
+    static eventName: "beamstatuschange";
+    constructor(detail: BeamStatusChangeEventDetail);
+}
+type NonprofitSelectionRemovedDetail = {
+    previousNonprofitId?: number | null;
+    newNonprofitId?: number | null;
+    selectionId?: string;
+    timestamp?: Date;
+};
+/**
+ * beamnonprofitselectionremoved
+ * Emitted when the nonprofit selection is removed from deselection or due to nonprofit cohort change
+ */
+declare class BeamNonprofitSelectionRemovedEvent extends CustomEvent<NonprofitSelectionRemovedDetail> {
+    static eventName: "beamnonprofitselectionremoved";
+    constructor(detail: NonprofitSelectionRemovedDetail);
+}
+type PromoStoredDetail = {
+    promoCodes: TPromoCodeRequest;
+};
+/**
+ * Emitted when a URL with query parameters is sanitized and stored in localStorage
+ *
+ * @event beampromocodesstored
+ */
+declare class BeamPromoCodesStoredEvent extends CustomEvent<PromoStoredDetail> {
+    static eventName: string;
+    constructor(detail: PromoStoredDetail);
+}
+type WidgetStoredPromosDetail = {
+    source?: WidgetName | HelperName | null;
+};
+/**
+ * Emitted when a widget stores the url or manual promoCodes in local storage
+ *
+ * @event beamwidgetstoredpromocodes
+ */
+declare class BeamWidgetStoredPromoCodesEvent extends CustomEvent<WidgetStoredPromosDetail> {
+    static eventName: "beamwidgetstoredpromocodes";
+    constructor(detail: WidgetStoredPromosDetail);
+}
+type WidgetInitialNonprofitSyncDetail = {
+    nonprofitId?: number | null;
+    nonprofitIdChanged?: boolean;
+    selectionId?: string;
+    selectionIdChanged?: boolean;
+};
+/**
+ * [Shopify Specific] - Emitted the first time a widget restores nonprofit selection from custom attributes
+ *
+ * @event beamwidgetinitialnonprofitsync
+ */
+declare class BeamWidgetInitialNonprofitSyncEvent extends CustomEvent<WidgetInitialNonprofitSyncDetail> {
+    static eventName: "beamwidgetinitialnonprofitsync";
+    constructor(detail: WidgetInitialNonprofitSyncDetail);
+}
+type BeamWidgetInitialNonprofitSyncCancelDetail = {
+    cancelled?: boolean;
+};
+/**
+ * [Shopify Specific] - Allows WidgetInitialNonprofitSyncDetail to be cancelled asynchronously
+ *
+ * @event beamwidgetinitialnonprofitsynccancel
+ */
+declare class BeamWidgetInitialNonprofitSyncCancelEvent extends CustomEvent<BeamWidgetInitialNonprofitSyncCancelDetail> {
+    static eventName: "beamwidgetinitialnonprofitsynccancel";
+    constructor(detail: BeamWidgetInitialNonprofitSyncCancelDetail);
+}
+type BeamStatsigInitializedDetail = {
+    showBeam: boolean;
+    stableId?: string;
+};
+/**
+ * Fired when Statsig experiment assignments for Beam are initialized
+ *
+ * @event beamstatsiginitialized
+ */
+declare class BeamStatsigInitializedEvent extends CustomEvent<BeamStatsigInitializedDetail> {
+    static eventName: "beamstatsiginitialized";
+    constructor(detail: BeamStatsigInitializedDetail);
+}
+
+type events_BeamCartChangeEvent = BeamCartChangeEvent;
+declare const events_BeamCartChangeEvent: typeof BeamCartChangeEvent;
+type events_BeamCartCreatedEvent = BeamCartCreatedEvent;
+declare const events_BeamCartCreatedEvent: typeof BeamCartCreatedEvent;
+type events_BeamNetworkCallEvent = BeamNetworkCallEvent;
+declare const events_BeamNetworkCallEvent: typeof BeamNetworkCallEvent;
+type events_BeamNonprofitSelectEvent = BeamNonprofitSelectEvent;
+declare const events_BeamNonprofitSelectEvent: typeof BeamNonprofitSelectEvent;
+type events_BeamNonprofitSelectionRemovedEvent = BeamNonprofitSelectionRemovedEvent;
+declare const events_BeamNonprofitSelectionRemovedEvent: typeof BeamNonprofitSelectionRemovedEvent;
+type events_BeamOrderCreatedEvent = BeamOrderCreatedEvent;
+declare const events_BeamOrderCreatedEvent: typeof BeamOrderCreatedEvent;
+type events_BeamPromoCodesStoredEvent = BeamPromoCodesStoredEvent;
+declare const events_BeamPromoCodesStoredEvent: typeof BeamPromoCodesStoredEvent;
+type events_BeamStatsigInitializedEvent = BeamStatsigInitializedEvent;
+declare const events_BeamStatsigInitializedEvent: typeof BeamStatsigInitializedEvent;
+type events_BeamStatusChangeEvent = BeamStatusChangeEvent;
+declare const events_BeamStatusChangeEvent: typeof BeamStatusChangeEvent;
+type events_BeamWidgetInitialNonprofitSyncCancelEvent = BeamWidgetInitialNonprofitSyncCancelEvent;
+declare const events_BeamWidgetInitialNonprofitSyncCancelEvent: typeof BeamWidgetInitialNonprofitSyncCancelEvent;
+type events_BeamWidgetInitialNonprofitSyncEvent = BeamWidgetInitialNonprofitSyncEvent;
+declare const events_BeamWidgetInitialNonprofitSyncEvent: typeof BeamWidgetInitialNonprofitSyncEvent;
+type events_BeamWidgetStoredPromoCodesEvent = BeamWidgetStoredPromoCodesEvent;
+declare const events_BeamWidgetStoredPromoCodesEvent: typeof BeamWidgetStoredPromoCodesEvent;
+declare namespace events {
+  export {
+    events_BeamCartChangeEvent as BeamCartChangeEvent,
+    events_BeamCartCreatedEvent as BeamCartCreatedEvent,
+    events_BeamNetworkCallEvent as BeamNetworkCallEvent,
+    events_BeamNonprofitSelectEvent as BeamNonprofitSelectEvent,
+    events_BeamNonprofitSelectionRemovedEvent as BeamNonprofitSelectionRemovedEvent,
+    events_BeamOrderCreatedEvent as BeamOrderCreatedEvent,
+    events_BeamPromoCodesStoredEvent as BeamPromoCodesStoredEvent,
+    events_BeamStatsigInitializedEvent as BeamStatsigInitializedEvent,
+    events_BeamStatusChangeEvent as BeamStatusChangeEvent,
+    events_BeamWidgetInitialNonprofitSyncCancelEvent as BeamWidgetInitialNonprofitSyncCancelEvent,
+    events_BeamWidgetInitialNonprofitSyncEvent as BeamWidgetInitialNonprofitSyncEvent,
+    events_BeamWidgetStoredPromoCodesEvent as BeamWidgetStoredPromoCodesEvent,
+  };
+}
+
+declare const logger: {
+    error: (...args: any[]) => void;
+    log: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+};
+
+declare const initNetworkListeners: () => void;
+/**
+ * Disables Beam event dispatching from the fetch/XHR Proxies without
+ * un-patching them (un-patching is unsafe if another script wrapped
+ * fetch/XHR after us — restoring our saved reference would remove
+ * their wrapper too).
+ */
+declare const teardownNetworkListeners: () => void;
+
+/**
+ * Creates an object that has the same API as normal localStorage, but adds a beam_ prefix and apiKey postfix to keys
+ * Also adds helper methods for JSON (de-)serialization
+ */
+declare const createScopedLocalStorage: (config: {
+    apiKey: string;
+}) => {
+    readonly prefix: string;
+    readonly postfix: string;
+    getItem(key: string): string | null;
+    setItem(key: string, value: unknown): void;
+    removeItem(key: string): void;
+    /** Safely parses value as JSON and return JS object */
+    getItemJson<T = Record<string, unknown>>(key: string): T | null;
+    /** Safely stringifies value as JSON */
+    setItemJson(key: string, value: object): void;
+};
+
+declare function waitForElement(selector: string, { timeout }?: {
+    timeout?: number | undefined;
+}): Promise<Element>;
+
+declare const getCookieMap: (cookieString?: string) => Map<string, string>;
+declare const getCookieValue: (name: string) => string | undefined;
+declare const setCookieValue: (options: CookieInit) => undefined;
+declare const deleteCookieValue: (options: {
+    name: string;
+    domain?: string;
+    path?: string;
+}) => undefined;
+interface CookieInit {
+    name: string;
+    value: string;
+    path?: string;
+    domain?: string;
+    expires?: number;
+    sameSite?: "strict" | "lax" | "none";
+}
+
+declare function saveRemoteSession({ remoteSessionId, apiKey }: {
+    remoteSessionId: string;
+    apiKey?: string;
+}): void;
+declare function getRemoteSession({ apiKey }: {
+    apiKey?: string;
+}): string | null;
+
+type Func<T extends any[], R> = (...args: T) => R;
+/**
+ * Takes a function and returns a new memoized function.
+ * If the same arguments are passed to the memoized function, it will return the previously computed result.
+ * This is a "memoize once" function meaning it only compares the previous and current arguments, not historic values.
+ * Results that throw errors or return rejected Promises are not cached.
+ *
+ * @param {Function} fn - The function to be memoized.
+ * @param {(value: any) => boolean} [isEqual]- The equality function used to compare arguments.
+ * @returns {Function} - The memoized function.
+ * @param func
+ */
+declare function memoizeLast<T extends any[], R>(func: Func<T, R>, { isEqual }?: {
+    isEqual?: ((value: any, other: any) => boolean) | undefined;
+}): MemoizedLast<Func<T, R>>;
+type MemoizedLast<T extends (...args: any[]) => any> = T & {
+    /** Clears the cached args/result so the next call always executes. */
+    reset: () => void;
+};
+
+/**
+ * Retrieves all validated promo codes stored in the "beam_promo_codes" cookie and parses it
+ *
+ * @returns {TPromoCodeResponse | undefined} An array of `ValidatedPromoCode` objects if found and parsed successfully, otherwise `undefined`
+ */
+declare const getAllPromoCodesFromCookie: () => TPromoCodeResponse | undefined;
+/**
+ * Stores the validated promo codes in the "beam_promo_codes" cookie, replaces and does not merge
+ *
+ * @param {TValidatedPromoResponse} validatedPromoCodes
+ * @param {string} domain
+ */
+declare const setPromoCodeInCookie: ({ validatedPromoCodes, domain, }: {
+    validatedPromoCodes: TValidatedPromoResponse;
+    domain?: string;
+}) => void;
+/**
+ * Retrieves promo codes from localStorage, scoped by API key
+ * @param {string} apiKey API key used for storage scoping
+ * @returns {TPromoCodeRequest | null} - Returns stored promo codes object containing both
+ * validated and unvalidated codes
+ * - If no codes exist, returns a fresh object with empty arrays
+ *
+ */
+declare const getPromoCodesLocalStorage: ({ apiKey }: {
+    apiKey: string;
+}) => TPromoCodeRequest | null;
+/**
+ * Sets promo codes in localStorage
+ * @param {TPromoCodeRequest} promoCodes New promo codes to add
+ * @param {string} apiKey API key for storage scoping
+ */
+declare const setPromoCodesInLocalStorage: ({ apiKey, promoCodes, }: {
+    apiKey?: string;
+    promoCodes: Partial<TPromoCodeRequest>;
+}) => void;
+/**
+ * Merges new promo codes with existing ones and returns the combined result
+ * @param {Partial<TPromoCodeRequest>} newPromos New promo codes to add
+ * @param {string} apiKey API key for storage scoping
+ * @returns {TPromoCodeRequest} An object containing both validated and unvalidated promo codes
+ * @example
+ * const result = mergePromoCodes({
+ *   apiKey: 'beam_123',
+ *   newPromos: {
+ *     unvalidatedPromoCodes: [
+ *       { type: 'manual', attributes: { value: 'WINTER20' } },
+ *       { type: 'url', attributes: { url: 'www.example.com/?promo=HOLIDAY25' } }
+ *     ]
+ *   }
+ * });
+ */
+declare const mergeStoreAndReturnPromos: ({ newPromos, apiKey, }: {
+    newPromos: Partial<TPromoCodeRequest>;
+    apiKey: string;
+}) => TPromoCodeRequest;
+/**
+ * Formats unvalidated promo codes by determining their source and attributes
+ * The function will assign `QueryParam` as the source if a `url` exists,
+ * otherwise, it will assign `Manual` as the source
+ *
+ * @param {TPromoCodeAttribute[]} promoAttributes An array of promo attributes to be formatted
+ * @returns {TUnvalidatedPromoRequest} - An array of UnvalidatedPromoCode objects,
+ *    each with a source and attributes object
+ */
+declare const mapToUnvalidatedPromoCodes: (promoAttributes: TPromoCodeAttribute[]) => TUnvalidatedPromoRequest;
+/**
+ * @param {TPromoCodeAttribute[]} promoAttributes An array of promo attributes to be formatted
+ * @param {string} apiKey API key for storage scoping
+ * @returns {TPromoCodeRequest} An object containing both validated and unvalidated promo codes
+ */
+declare const formatStoreAndReturnPromoCodes: (promoAttributes: TPromoCodeAttribute[], apiKey: string) => TPromoCodeRequest;
+/**
+ * Extracts applicable promo codes from the cart object
+ * This function retrieves discounts stored in the cart's `content.discounts` array,
+ * filters out only the applicable promo codes, and returns them as an array of strings
+ *
+ * @param {TBeamCartLocalStorage} cart The cart object retrieved from local storage
+ * @returns {string[]} An array of applicable promo codes
+ */
+declare const getPromoCodesFromCart: (cart: TBeamCartLocalStorage) => string[];
+/**
+ * Gets promo code exclusively from Shopify discount cookie
+ * @returns {string | null} Single discount code or null if not found
+ */
+declare const getPromoCodeFromShopifyCookie: () => string | null;
+/**
+ * Safely parses a JSON string into an array of strings
+ * If parsing fails or the input is not a valid JSON array, it returns an empty array
+ *
+ * @param {string | undefined | null} jsonString The JSON string to parse
+ * @returns {string[]} The parsed array of strings or an empty array if parsing fails
+ */
+declare const parseJsonStringArray: (jsonString: string | undefined | null) => string[];
+/**
+ * Retrieves and sanitizes the current URL for storage, preserving only safe query parameters
+ *
+ * @returns {TPromoCodeAttribute} Returns an object with only the `url` property set
+ */
+declare const getSanitizedUrlForStorage: () => TPromoCodeAttribute | undefined;
+declare const promoCodesAreEqual: (a: TPromoCodeRequest, b: TPromoCodeRequest) => boolean;
+declare const isEmptyPromoData: (promos: {
+    unvalidatedPromoCodes?: unknown[];
+    validatedPromoCodes?: unknown[];
+}) => boolean;
+
+/**
+ * Clears every piece of Beam-related browser state this SDK writes, by iterating the
+ * LOCAL_STORAGE_KEYS/BEAM_COOKIE_NAMES registries (src/api-sdk/constants.ts) directly —
+ * anything added to those objects is cleared automatically, with nothing to update here.
+ *
+ * Not tied to any one integration's lifecycle (e.g. registerCartIntegration/
+ * unregisterCartIntegration) — safe to call on its own, from any integration or directly,
+ * whenever a full reset of Beam's local footprint is needed.
+ */
+declare function clearBeamStorage(config: {
+    apiKey: string;
+    domain?: string;
+}): void;
+
+type index_MemoizedLast<T extends (...args: any[]) => any> = MemoizedLast<T>;
+declare const index_clearBeamStorage: typeof clearBeamStorage;
+declare const index_createScopedLocalStorage: typeof createScopedLocalStorage;
+declare const index_debounce: typeof debounce;
+declare const index_deleteCookieValue: typeof deleteCookieValue;
+declare const index_events: typeof events;
+declare const index_formatStoreAndReturnPromoCodes: typeof formatStoreAndReturnPromoCodes;
+declare const index_getAllPromoCodesFromCookie: typeof getAllPromoCodesFromCookie;
+declare const index_getCookieMap: typeof getCookieMap;
+declare const index_getCookieValue: typeof getCookieValue;
+declare const index_getPromoCodeFromShopifyCookie: typeof getPromoCodeFromShopifyCookie;
+declare const index_getPromoCodesFromCart: typeof getPromoCodesFromCart;
+declare const index_getPromoCodesLocalStorage: typeof getPromoCodesLocalStorage;
+declare const index_getRemoteSession: typeof getRemoteSession;
+declare const index_getSanitizedUrlForStorage: typeof getSanitizedUrlForStorage;
+declare const index_initNetworkListeners: typeof initNetworkListeners;
+declare const index_isEmptyPromoData: typeof isEmptyPromoData;
+declare const index_isEqual: typeof isEqual;
+declare const index_logger: typeof logger;
+declare const index_mapToUnvalidatedPromoCodes: typeof mapToUnvalidatedPromoCodes;
+declare const index_memoizeLast: typeof memoizeLast;
+declare const index_mergeStoreAndReturnPromos: typeof mergeStoreAndReturnPromos;
+declare const index_parseJsonStringArray: typeof parseJsonStringArray;
+declare const index_promoCodesAreEqual: typeof promoCodesAreEqual;
+declare const index_saveRemoteSession: typeof saveRemoteSession;
+declare const index_setCookieValue: typeof setCookieValue;
+declare const index_setPromoCodeInCookie: typeof setPromoCodeInCookie;
+declare const index_setPromoCodesInLocalStorage: typeof setPromoCodesInLocalStorage;
+declare const index_teardownNetworkListeners: typeof teardownNetworkListeners;
+declare const index_waitForElement: typeof waitForElement;
+declare namespace index {
+  export { index_clearBeamStorage as clearBeamStorage, index_createScopedLocalStorage as createScopedLocalStorage, index_debounce as debounce, index_deleteCookieValue as deleteCookieValue, beamErrors as errors, index_events as events, index_formatStoreAndReturnPromoCodes as formatStoreAndReturnPromoCodes, index_getAllPromoCodesFromCookie as getAllPromoCodesFromCookie, index_getCookieMap as getCookieMap, index_getCookieValue as getCookieValue, index_getPromoCodeFromShopifyCookie as getPromoCodeFromShopifyCookie, index_getPromoCodesFromCart as getPromoCodesFromCart, index_getPromoCodesLocalStorage as getPromoCodesLocalStorage, index_getRemoteSession as getRemoteSession, index_getSanitizedUrlForStorage as getSanitizedUrlForStorage, index_initNetworkListeners as initNetworkListeners, index_isEmptyPromoData as isEmptyPromoData, index_isEqual as isEqual, index_logger as logger, index_mapToUnvalidatedPromoCodes as mapToUnvalidatedPromoCodes, index_memoizeLast as memoizeLast, index_mergeStoreAndReturnPromos as mergeStoreAndReturnPromos, index_parseJsonStringArray as parseJsonStringArray, index_promoCodesAreEqual as promoCodesAreEqual, index_saveRemoteSession as saveRemoteSession, index_setCookieValue as setCookieValue, index_setPromoCodeInCookie as setPromoCodeInCookie, index_setPromoCodesInLocalStorage as setPromoCodesInLocalStorage, index_teardownNetworkListeners as teardownNetworkListeners, index_waitForElement as waitForElement };
+  export type { index_MemoizedLast as MemoizedLast };
+}
+
+/**
+ * Retrieves the Beam cart ID from cookies
+ * @param CART_COOKIE_NAME - The name of the cookie that stores the Beam cart ID
+ * @returns The Beam cart ID if present in cookies or local storage, otherwise null
+ */
+declare const getBeamCartId: (CART_COOKIE_NAME: string, config: {
+    apiKey: string;
+}) => string | null;
+/**
+ * Retrieves the external cart ID
+ * @param CART_COOKIE_NAME - The name of the cookie that stores the external cart ID
+ * @returns The external cart ID if available or null if neither is available
+ */
+declare const getExternalCartId: (CART_COOKIE_NAME: string, config: {
+    apiKey: string;
+}) => string | null;
+
+declare function makeApiKeyHeader(apiKey: string): {
+    authorization: string;
+};
+
+export { BeamStatusChangeEvent as $, memoizeLast as A, BeamNonprofitSelectEvent as B, mergeStoreAndReturnPromos as C, parseJsonStringArray as D, promoCodesAreEqual as E, saveRemoteSession as F, setCookieValue as G, setPromoCodeInCookie as H, setPromoCodesInLocalStorage as I, teardownNetworkListeners as J, BeamError as O, LocalStorageError as P, MissingConfig as Q, NetworkError as R, SetupError as S, BeamCartChangeEvent as U, BeamCartCreatedEvent as V, BeamNetworkCallEvent as W, BeamNonprofitSelectionRemovedEvent as X, BeamOrderCreatedEvent as Y, BeamPromoCodesStoredEvent as Z, BeamStatsigInitializedEvent as _, index as a, BeamWidgetInitialNonprofitSyncCancelEvent as a0, BeamWidgetInitialNonprofitSyncEvent as a1, BeamWidgetStoredPromoCodesEvent as a2, getBeamCartId as a3, getExternalCartId as a4, makeApiKeyHeader as a5, events as e, initNetworkListeners as i, clearBeamStorage as j, createScopedLocalStorage as k, deleteCookieValue as l, beamErrors as m, formatStoreAndReturnPromoCodes as n, getAllPromoCodesFromCookie as o, getCookieMap as p, getCookieValue as q, getPromoCodeFromShopifyCookie as r, getPromoCodesFromCart as s, getPromoCodesLocalStorage as t, getRemoteSession as u, getSanitizedUrlForStorage as v, waitForElement as w, isEmptyPromoData as x, logger as y, mapToUnvalidatedPromoCodes as z };
+export type { paths as K, LANGUAGES as L, MemoizedLast as M, TApiKey as N, TUrl$1 as T, TNumericId as b, TId as c, TCart as d, TUrl as f, BeamBaseAPIConfig as g, TCartApi as h };