@hartl-services/medusa-storefront 0.0.0-stage → 0.2.0

package/dist/browser/index.d.ts

@@ -0,0 +1,946 @@
+import type { HttpTypes } from "@medusajs/types";
+import type { Stripe } from "@stripe/stripe-js";
+import type { Translate } from "../core/i18n.js";
+import type { ReportError } from "../core/report-error.js";
+import type { StorefrontActions } from "./actions.js";
+export type { StorefrontActions } from "./actions.js";
+export type { CredentialedMedusaClient } from "./client.js";
+export type { ApplyCheckoutCouponOptions, CaptureAffiliateReferralInput } from "./affiliate-referral.js";
+export type { UnwrapMedusaAction, UnwrapMedusaActionOptions } from "./unwrap-medusa-action.js";
+export type { RefreshCartAfterMutation } from "./cart-refresh.js";
+export type { BrowserQueryOptions } from "./query-options.js";
+export { affiliateQueryKeys, medusaQueryKeys } from "./query-keys.js";
+export { invalidateAffiliateQueries, invalidateCommerceQueries, resetCustomerScopedQueries } from "./query-invalidation.js";
+export { applyCheckoutCouponWithClient, captureAffiliateReferralAfterCartRefreshWithClient, captureAffiliateReferralWithClient, removeCapturedAffiliateReferral, resolveCouponLabelsWithClient, runAffiliateReferralCapture, waitForAffiliateReferralCapture, } from "./affiliate-referral.js";
+export { endMedusaBrowserSessionWithClient, startMedusaBrowserSessionWithClient } from "./browser-session.js";
+export { canReachOtherTabs, openAccountVerificationChannel, parseAccountVerificationMessage, postAccountVerificationMessage } from "./account-verification-channel.js";
+export type { AccountVerificationMessage } from "./account-verification-channel.js";
+/**
+ * What the shop does on top of a storefront event (tracking, its own UI
+ * state). Called by the package hooks once the event happened; never throw.
+ */
+export interface StorefrontCallbacks {
+    /** A variant was added to the cart (one unit). */
+    onAddedToCart?: (variant: HttpTypes.StoreProductVariant) => void;
+    /** The checkout page showed a cart (once per page view). */
+    onCheckoutStarted?: (cart: HttpTypes.StoreCart) => void;
+    /** The customer picked a payment method type in the payment form, e.g. "card". */
+    onPaymentMethodSelected?: (type: string) => void;
+    /** The customer logged out; runs last, after the session ended. */
+    onLoggedOut?: () => void;
+}
+export interface StorefrontBrowserConfig {
+    /** The public Medusa URL (the browser's, never an internal host). */
+    publicBackendUrl: string;
+    publishableKey: string | undefined;
+    /** The shop's `"use server"` wrappers of the server functions. */
+    actions: StorefrontActions;
+    t: Translate;
+    reportError: ReportError;
+    /** Base path of the shop's Route Handlers (partner portal reads). Default `/api`. */
+    apiBasePath?: string;
+    /** sessionStorage key prefix of the fresh-order marker. */
+    freshOrderKeyPrefix: string;
+    callbacks?: StorefrontCallbacks;
+    /** Stripe's publishable key (the payment step shows "not configured" without it). */
+    stripePublishableKey?: string;
+    /** Where the checkout sends the customer after the order; default `/{countryCode}/order/{orderId}/confirmed`. */
+    orderConfirmedPath?: (countryCode: string, orderId: string) => string;
+}
+/**
+ * The storefront's browser side: the credentialed Medusa client, cart and
+ * referral calls, react-query options and invalidation. Create it once at
+ * module level in the shop (`storefront.client.ts`); the module state it
+ * relies on (pending refunded-cart replacements, in-flight referral captures)
+ * is shared by the whole page.
+ */
+export declare function createStorefrontBrowser(config: StorefrontBrowserConfig): {
+    actions: StorefrontActions;
+    t: Translate;
+    reportError: ReportError;
+    reportCheckoutError: (error: unknown, context?: Record<string, unknown>) => void;
+    createCredentialedMedusaClient: () => import("./client.js").CredentialedMedusaClient;
+    startMedusaBrowserSession: (token: string) => Promise<void>;
+    endMedusaBrowserSession: () => Promise<void>;
+    unwrapMedusaAction: import("./unwrap-medusa-action.js").UnwrapMedusaAction;
+    cart: {
+        createCart: (data: HttpTypes.StoreCreateCart) => Promise<HttpTypes.StoreCart>;
+        replaceRefundedCart(cart: HttpTypes.StoreCart): Promise<HttpTypes.StoreCart | null>;
+        addCartLineItem: (cartId: string, data: HttpTypes.StoreAddCartLineItem) => Promise<HttpTypes.StoreCart>;
+        updateCartLineItem(cartId: string, lineItemId: string, data: HttpTypes.StoreUpdateCartLineItem): Promise<HttpTypes.StoreCart>;
+        removeCartLineItem(cartId: string, lineItemId: string): Promise<HttpTypes.StoreLineItemDeleteResponse>;
+        updateCart(cartId: string, data: HttpTypes.StoreUpdateCart): Promise<HttpTypes.StoreCart>;
+        addCartShippingMethod(cartId: string, data: HttpTypes.StoreAddCartShippingMethods): Promise<HttpTypes.StoreCart>;
+        addCartPromotion(cartId: string, data: HttpTypes.StoreCartAddPromotion): Promise<HttpTypes.StoreCart>;
+        removeCartPromotion(cartId: string, data: HttpTypes.StoreCartRemovePromotion): Promise<HttpTypes.StoreCart>;
+        initiateCartPayment(cartId: string, data: HttpTypes.StoreInitializePaymentSession): Promise<HttpTypes.StorePaymentCollection>;
+        checkCartCompletion(cartId: string): Promise<{
+            cart_id: string;
+            ready: true;
+        }>;
+        completeCart(cartId: string): Promise<HttpTypes.StoreCompleteCartResponse>;
+        addProductToCart({ activeCart, quantity, regionId, variantId }: {
+            activeCart: Pick<HttpTypes.StoreCart, "id"> | null;
+            quantity?: number;
+            regionId: string;
+            variantId: string;
+        }): Promise<Pick<HttpTypes.StoreCart, "id">>;
+    };
+    referral: {
+        runAffiliateReferralCapture: typeof import("./affiliate-referral.js").runAffiliateReferralCapture;
+        waitForAffiliateReferralCapture: typeof import("./affiliate-referral.js").waitForAffiliateReferralCapture;
+        removeCapturedAffiliateReferral: typeof import("./affiliate-referral.js").removeCapturedAffiliateReferral;
+        captureAffiliateReferral: (input: import("./affiliate-referral.js").CaptureAffiliateReferralInput) => Promise<{
+            status: "captured" | "replaced" | "ignored_existing_assignment" | "kept_existing";
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }>;
+        captureAffiliateReferralAfterCartRefresh: (slug: string, refreshActiveCart: () => Promise<Pick<HttpTypes.StoreCart, "id"> | null | undefined>) => Promise<{
+            status: "captured" | "replaced" | "ignored_existing_assignment" | "kept_existing";
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }>;
+        applyCheckoutCoupon: (cartId: string, code: string, options: import("./affiliate-referral.js").ApplyCheckoutCouponOptions) => Promise<{
+            cart: HttpTypes.StoreCart;
+            kind: "promotion";
+            response?: undefined;
+        } | {
+            kind: "affiliate";
+            response: {
+                status: "captured" | "replaced" | "ignored_existing_assignment" | "kept_existing" | "pending_email_validation" | "expired" | "coupon_already_redeemed";
+                referral: {
+                    id: string;
+                    source: "link" | "coupon";
+                    status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                    affiliate: {
+                        id: string;
+                        status: "active";
+                    };
+                    captured_at: string;
+                    expires_at: string;
+                } | null;
+                discount_applied: boolean;
+                message?: string | undefined;
+            };
+            cart?: undefined;
+        }>;
+        getAffiliateCartReferral: (cartId: string) => Promise<{
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }>;
+        resolveCouponLabels: (codes: string[]) => Promise<{
+            labels: {
+                code: string;
+                label: string;
+                discount_percentage: number;
+            }[];
+        }>;
+    };
+    region: {
+        getRegionForCountryClient(countryCode: string): Promise<HttpTypes.StoreRegion | null>;
+    };
+    queries: {
+        activeCart: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreCart | null, Error, HttpTypes.StoreCart | null, readonly ["medusa", "cart", "active"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreCart | null, readonly ["medusa", "cart", "active"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "cart", "active"], HttpTypes.StoreCart | null, Error>;
+        customer: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreCustomerResponse | null, Error, HttpTypes.StoreCustomerResponse | null, readonly ["medusa", "customer"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreCustomerResponse | null, readonly ["medusa", "customer"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "customer"], HttpTypes.StoreCustomerResponse | null, Error>;
+        shippingOptions: (cartId: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreShippingOptionListResponse, Error, HttpTypes.StoreShippingOptionListResponse, readonly ["medusa", "shipping-options", string]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreShippingOptionListResponse, readonly ["medusa", "shipping-options", string], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "shipping-options", string], HttpTypes.StoreShippingOptionListResponse, Error>;
+        paymentProviders: (regionId: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StorePaymentProviderListResponse, Error, HttpTypes.StorePaymentProviderListResponse, readonly ["medusa", "payment-providers", string]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StorePaymentProviderListResponse, readonly ["medusa", "payment-providers", string], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "payment-providers", string], HttpTypes.StorePaymentProviderListResponse, Error>;
+        region: (countryCode: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreRegion | null, Error, HttpTypes.StoreRegion | null, readonly ["medusa", "region", string]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreRegion | null, readonly ["medusa", "region", string], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "region", string], HttpTypes.StoreRegion | null, Error>;
+        storeRegions: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreRegionListResponse, Error, HttpTypes.StoreRegionListResponse, readonly ["medusa", "regions"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreRegionListResponse, readonly ["medusa", "regions"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "regions"], HttpTypes.StoreRegionListResponse, Error>;
+        pluginFeatures: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../core/plugin-features.js").PluginFeatureMap, Error, import("../core/plugin-features.js").PluginFeatureMap, readonly ["medusa", "plugin-features"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<import("../core/plugin-features.js").PluginFeatureMap, readonly ["medusa", "plugin-features"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "plugin-features"], import("../core/plugin-features.js").PluginFeatureMap, Error>;
+        documents: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            documents: {
+                id: string;
+                kind: "invoice" | "cancellation" | "credit_note";
+                number: string;
+                order_display_id: number | null;
+                issued_at: string;
+                total: {
+                    amount: string;
+                    currency_code: string;
+                };
+            }[];
+        }, Error, {
+            documents: {
+                id: string;
+                kind: "invoice" | "cancellation" | "credit_note";
+                number: string;
+                order_display_id: number | null;
+                issued_at: string;
+                total: {
+                    amount: string;
+                    currency_code: string;
+                };
+            }[];
+        }, readonly ["medusa", "documents"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                documents: {
+                    id: string;
+                    kind: "invoice" | "cancellation" | "credit_note";
+                    number: string;
+                    order_display_id: number | null;
+                    issued_at: string;
+                    total: {
+                        amount: string;
+                        currency_code: string;
+                    };
+                }[];
+            }, readonly ["medusa", "documents"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "documents"], {
+            documents: {
+                id: string;
+                kind: "invoice" | "cancellation" | "credit_note";
+                number: string;
+                order_display_id: number | null;
+                issued_at: string;
+                total: {
+                    amount: string;
+                    currency_code: string;
+                };
+            }[];
+        }, Error>;
+        orders: ({ limit, offset }?: {
+            limit?: number | undefined;
+            offset?: number | undefined;
+        }) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreOrderListResponse, Error, HttpTypes.StoreOrderListResponse, readonly ["medusa", "orders", {
+            limit: number;
+            offset: number;
+        }]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreOrderListResponse, readonly ["medusa", "orders", {
+                limit: number;
+                offset: number;
+            }], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "orders", {
+            limit: number;
+            offset: number;
+        }], HttpTypes.StoreOrderListResponse, Error>;
+        orderDetail: (orderId: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<HttpTypes.StoreOrder | null, Error, HttpTypes.StoreOrder | null, readonly ["medusa", "orders", "detail", string]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<HttpTypes.StoreOrder | null, readonly ["medusa", "orders", "detail", string], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "orders", "detail", string], HttpTypes.StoreOrder | null, Error>;
+        customerPasswordPolicy: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            min_length: number;
+            require_mixed_case: boolean;
+            require_digit: boolean;
+            require_symbol: boolean;
+        }, Error, {
+            min_length: number;
+            require_mixed_case: boolean;
+            require_digit: boolean;
+            require_symbol: boolean;
+        }, readonly ["medusa", "customer-password-policy"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                min_length: number;
+                require_mixed_case: boolean;
+                require_digit: boolean;
+                require_symbol: boolean;
+            }, readonly ["medusa", "customer-password-policy"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "customer-password-policy"], {
+            min_length: number;
+            require_mixed_case: boolean;
+            require_digit: boolean;
+            require_symbol: boolean;
+        }, Error>;
+        customerTaxIdentifications: (isEnabled: boolean) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            identifications: {
+                customer_address_id: string;
+                status: "eligible" | "ineligible" | "unavailable" | "invalid";
+                verified: boolean;
+                vat_number: string;
+                company_name: string;
+                validated_at: string;
+            }[];
+        }, Error, {
+            identifications: {
+                customer_address_id: string;
+                status: "eligible" | "ineligible" | "unavailable" | "invalid";
+                verified: boolean;
+                vat_number: string;
+                company_name: string;
+                validated_at: string;
+            }[];
+        }, readonly ["medusa", "tax-identifications"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                identifications: {
+                    customer_address_id: string;
+                    status: "eligible" | "ineligible" | "unavailable" | "invalid";
+                    verified: boolean;
+                    vat_number: string;
+                    company_name: string;
+                    validated_at: string;
+                }[];
+            }, readonly ["medusa", "tax-identifications"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["medusa", "tax-identifications"], {
+            identifications: {
+                customer_address_id: string;
+                status: "eligible" | "ineligible" | "unavailable" | "invalid";
+                verified: boolean;
+                vat_number: string;
+                company_name: string;
+                validated_at: string;
+            }[];
+        }, Error>;
+        affiliateContext: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            portal_state: "no_application";
+        } | {
+            portal_state: "pending";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "pending";
+            };
+        } | {
+            portal_state: "rejected";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "rejected";
+            };
+        } | {
+            portal_state: "active";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "active";
+            };
+        } | {
+            portal_state: "inactive";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "inactive";
+            };
+        }, Error, {
+            portal_state: "no_application";
+        } | {
+            portal_state: "pending";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "pending";
+            };
+        } | {
+            portal_state: "rejected";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "rejected";
+            };
+        } | {
+            portal_state: "active";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "active";
+            };
+        } | {
+            portal_state: "inactive";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "inactive";
+            };
+        }, readonly ["affiliate", "context"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                portal_state: "no_application";
+            } | {
+                portal_state: "pending";
+                application: {
+                    id: string;
+                    requested_slug: string | null;
+                    created_at: string;
+                    status: "pending";
+                };
+            } | {
+                portal_state: "rejected";
+                application: {
+                    id: string;
+                    requested_slug: string | null;
+                    created_at: string;
+                    status: "rejected";
+                };
+            } | {
+                portal_state: "active";
+                affiliate: {
+                    id: string;
+                    commission_rate: number;
+                    own_order_discount_rate: number;
+                    effective_customer_discount_rate: number;
+                    activated_at: string | null;
+                    inactivated_at: string | null;
+                    status: "active";
+                };
+            } | {
+                portal_state: "inactive";
+                affiliate: {
+                    id: string;
+                    commission_rate: number;
+                    own_order_discount_rate: number;
+                    effective_customer_discount_rate: number;
+                    activated_at: string | null;
+                    inactivated_at: string | null;
+                    status: "inactive";
+                };
+            }, readonly ["affiliate", "context"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "context"], {
+            portal_state: "no_application";
+        } | {
+            portal_state: "pending";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "pending";
+            };
+        } | {
+            portal_state: "rejected";
+            application: {
+                id: string;
+                requested_slug: string | null;
+                created_at: string;
+                status: "rejected";
+            };
+        } | {
+            portal_state: "active";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "active";
+            };
+        } | {
+            portal_state: "inactive";
+            affiliate: {
+                id: string;
+                commission_rate: number;
+                own_order_discount_rate: number;
+                effective_customer_discount_rate: number;
+                activated_at: string | null;
+                inactivated_at: string | null;
+                status: "inactive";
+            };
+        }, Error>;
+        affiliateCartReferral: (cartId: string, isEnabled: boolean) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }, Error, {
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }, readonly ["affiliate", "cart-referral", string]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                referral: {
+                    id: string;
+                    source: "link" | "coupon";
+                    status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                    affiliate: {
+                        id: string;
+                        status: "active";
+                    };
+                    captured_at: string;
+                    expires_at: string;
+                } | null;
+            }, readonly ["affiliate", "cart-referral", string], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "cart-referral", string], {
+            referral: {
+                id: string;
+                source: "link" | "coupon";
+                status: "active" | "replaced" | "ignored_existing_assignment" | "pending_email_validation" | "consumed" | "expired" | "invalidated";
+                affiliate: {
+                    id: string;
+                    status: "active";
+                };
+                captured_at: string;
+                expires_at: string;
+            } | null;
+        }, Error>;
+        couponLabels: (codes: string[], isEnabled: boolean) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            labels: {
+                code: string;
+                label: string;
+                discount_percentage: number;
+            }[];
+        }, Error, {
+            labels: {
+                code: string;
+                label: string;
+                discount_percentage: number;
+            }[];
+        }, readonly ["affiliate", "coupon-labels", string[]]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                labels: {
+                    code: string;
+                    label: string;
+                    discount_percentage: number;
+                }[];
+            }, readonly ["affiliate", "coupon-labels", string[]], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "coupon-labels", string[]], {
+            labels: {
+                code: string;
+                label: string;
+                discount_percentage: number;
+            }[];
+        }, Error>;
+        affiliateSlugs: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            slugs: {
+                id: string;
+                slug: string;
+                active: boolean;
+                is_primary: boolean;
+                created_at: string;
+                updated_at: string;
+                referral_url: string;
+            }[];
+        }, Error, {
+            slugs: {
+                id: string;
+                slug: string;
+                active: boolean;
+                is_primary: boolean;
+                created_at: string;
+                updated_at: string;
+                referral_url: string;
+            }[];
+        }, readonly ["affiliate", "slugs"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                slugs: {
+                    id: string;
+                    slug: string;
+                    active: boolean;
+                    is_primary: boolean;
+                    created_at: string;
+                    updated_at: string;
+                    referral_url: string;
+                }[];
+            }, readonly ["affiliate", "slugs"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "slugs"], {
+            slugs: {
+                id: string;
+                slug: string;
+                active: boolean;
+                is_primary: boolean;
+                created_at: string;
+                updated_at: string;
+                referral_url: string;
+            }[];
+        }, Error>;
+        affiliateCouponCodes: (query: import("@hartl-services/medusa-contracts/types/affiliate-store").ListStoreAffiliateCouponCodesRequest) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            coupon_codes: {
+                id: string;
+                code: string;
+                status: "active" | "revoked" | "affiliate_inactive" | "provisioning" | "provisioning_failed";
+                origin: "default" | "manual" | "rotation";
+                created_at: string;
+                revoked_at: string | null;
+            }[];
+            count: number;
+            limit: number;
+            offset: number;
+        }, Error, {
+            coupon_codes: {
+                id: string;
+                code: string;
+                status: "active" | "revoked" | "affiliate_inactive" | "provisioning" | "provisioning_failed";
+                origin: "default" | "manual" | "rotation";
+                created_at: string;
+                revoked_at: string | null;
+            }[];
+            count: number;
+            limit: number;
+            offset: number;
+        }, readonly ["affiliate", "coupon-codes", {
+            status?: "enabled" | "revoked" | undefined;
+            limit?: string | number | undefined;
+            offset?: string | number | undefined;
+        }]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                coupon_codes: {
+                    id: string;
+                    code: string;
+                    status: "active" | "revoked" | "affiliate_inactive" | "provisioning" | "provisioning_failed";
+                    origin: "default" | "manual" | "rotation";
+                    created_at: string;
+                    revoked_at: string | null;
+                }[];
+                count: number;
+                limit: number;
+                offset: number;
+            }, readonly ["affiliate", "coupon-codes", {
+                status?: "enabled" | "revoked" | undefined;
+                limit?: string | number | undefined;
+                offset?: string | number | undefined;
+            }], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "coupon-codes", {
+            status?: "enabled" | "revoked" | undefined;
+            limit?: string | number | undefined;
+            offset?: string | number | undefined;
+        }], {
+            coupon_codes: {
+                id: string;
+                code: string;
+                status: "active" | "revoked" | "affiliate_inactive" | "provisioning" | "provisioning_failed";
+                origin: "default" | "manual" | "rotation";
+                created_at: string;
+                revoked_at: string | null;
+            }[];
+            count: number;
+            limit: number;
+            offset: number;
+        }, Error>;
+        affiliateCommissions: (query: import("@hartl-services/medusa-contracts/types/affiliate-store").PartnerPortalCommissionsRequest) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            from: string;
+            to: string;
+            count: number;
+            limit: number;
+            offset: number;
+            totals: {
+                currency_code: string;
+                direct_commission_amount: number;
+                referral_commission_amount: number;
+                correction_amount: number;
+                net_commission_amount: number;
+                commission_base_amount: number;
+                attributed_order_count: number;
+                commissioned_order_count: number;
+            }[];
+            commissions: {
+                id: string;
+                type: "order_commission" | "refund_correction" | "cancellation_correction" | "manual_correction" | "affiliate_referral_bonus" | "affiliate_own_order_referrer_bonus";
+                occurred_at: string;
+                order_id: string | null;
+                base_amount_net: number;
+                commission_amount: number;
+                currency_code: string;
+            }[];
+        }, Error, {
+            from: string;
+            to: string;
+            count: number;
+            limit: number;
+            offset: number;
+            totals: {
+                currency_code: string;
+                direct_commission_amount: number;
+                referral_commission_amount: number;
+                correction_amount: number;
+                net_commission_amount: number;
+                commission_base_amount: number;
+                attributed_order_count: number;
+                commissioned_order_count: number;
+            }[];
+            commissions: {
+                id: string;
+                type: "order_commission" | "refund_correction" | "cancellation_correction" | "manual_correction" | "affiliate_referral_bonus" | "affiliate_own_order_referrer_bonus";
+                occurred_at: string;
+                order_id: string | null;
+                base_amount_net: number;
+                commission_amount: number;
+                currency_code: string;
+            }[];
+        }, readonly ["affiliate", "commissions", {
+            from?: string | undefined;
+            to?: string | undefined;
+            limit?: string | number | undefined;
+            offset?: string | number | undefined;
+        }]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                from: string;
+                to: string;
+                count: number;
+                limit: number;
+                offset: number;
+                totals: {
+                    currency_code: string;
+                    direct_commission_amount: number;
+                    referral_commission_amount: number;
+                    correction_amount: number;
+                    net_commission_amount: number;
+                    commission_base_amount: number;
+                    attributed_order_count: number;
+                    commissioned_order_count: number;
+                }[];
+                commissions: {
+                    id: string;
+                    type: "order_commission" | "refund_correction" | "cancellation_correction" | "manual_correction" | "affiliate_referral_bonus" | "affiliate_own_order_referrer_bonus";
+                    occurred_at: string;
+                    order_id: string | null;
+                    base_amount_net: number;
+                    commission_amount: number;
+                    currency_code: string;
+                }[];
+            }, readonly ["affiliate", "commissions", {
+                from?: string | undefined;
+                to?: string | undefined;
+                limit?: string | number | undefined;
+                offset?: string | number | undefined;
+            }], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "commissions", {
+            from?: string | undefined;
+            to?: string | undefined;
+            limit?: string | number | undefined;
+            offset?: string | number | undefined;
+        }], {
+            from: string;
+            to: string;
+            count: number;
+            limit: number;
+            offset: number;
+            totals: {
+                currency_code: string;
+                direct_commission_amount: number;
+                referral_commission_amount: number;
+                correction_amount: number;
+                net_commission_amount: number;
+                commission_base_amount: number;
+                attributed_order_count: number;
+                commissioned_order_count: number;
+            }[];
+            commissions: {
+                id: string;
+                type: "order_commission" | "refund_correction" | "cancellation_correction" | "manual_correction" | "affiliate_referral_bonus" | "affiliate_own_order_referrer_bonus";
+                occurred_at: string;
+                order_id: string | null;
+                base_amount_net: number;
+                commission_amount: number;
+                currency_code: string;
+            }[];
+        }, Error>;
+        affiliateConsignmentInventory: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            period_start: string;
+            inventory: {
+                inventory_item_id: string;
+                batch_id: string | null;
+                expected_quantity: number;
+            }[];
+        }, Error, {
+            period_start: string;
+            inventory: {
+                inventory_item_id: string;
+                batch_id: string | null;
+                expected_quantity: number;
+            }[];
+        }, readonly ["affiliate", "consignment", "inventory"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                period_start: string;
+                inventory: {
+                    inventory_item_id: string;
+                    batch_id: string | null;
+                    expected_quantity: number;
+                }[];
+            }, readonly ["affiliate", "consignment", "inventory"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "consignment", "inventory"], {
+            period_start: string;
+            inventory: {
+                inventory_item_id: string;
+                batch_id: string | null;
+                expected_quantity: number;
+            }[];
+        }, Error>;
+        affiliateConsignmentReports: () => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+            reports: {
+                id: string;
+                affiliate_id: string;
+                period_start: string;
+                period_end: string;
+                status: "rejected" | "draft" | "approved" | "submitted";
+                draft_order_id: string | null;
+                order_id: string | null;
+                submitted_at: string | null;
+                lines: {
+                    id: string;
+                    inventory_item_id: string;
+                    batch_id: string | null;
+                    expected_quantity: number;
+                    counted_quantity: number;
+                    proposed_sale_quantity: number;
+                    confirmed_sale_quantity: number;
+                    requires_admin_clarification: boolean;
+                    non_sale_reason: string | null;
+                    resolved_unit_price: number | null;
+                    discounted_line_total: number | null;
+                    currency_code: string | null;
+                }[];
+            }[];
+        }, Error, {
+            reports: {
+                id: string;
+                affiliate_id: string;
+                period_start: string;
+                period_end: string;
+                status: "rejected" | "draft" | "approved" | "submitted";
+                draft_order_id: string | null;
+                order_id: string | null;
+                submitted_at: string | null;
+                lines: {
+                    id: string;
+                    inventory_item_id: string;
+                    batch_id: string | null;
+                    expected_quantity: number;
+                    counted_quantity: number;
+                    proposed_sale_quantity: number;
+                    confirmed_sale_quantity: number;
+                    requires_admin_clarification: boolean;
+                    non_sale_reason: string | null;
+                    resolved_unit_price: number | null;
+                    discounted_line_total: number | null;
+                    currency_code: string | null;
+                }[];
+            }[];
+        }, readonly ["affiliate", "consignment", "reports"]>, "queryFn"> & {
+            queryFn?: import("@tanstack/react-query").QueryFunction<{
+                reports: {
+                    id: string;
+                    affiliate_id: string;
+                    period_start: string;
+                    period_end: string;
+                    status: "rejected" | "draft" | "approved" | "submitted";
+                    draft_order_id: string | null;
+                    order_id: string | null;
+                    submitted_at: string | null;
+                    lines: {
+                        id: string;
+                        inventory_item_id: string;
+                        batch_id: string | null;
+                        expected_quantity: number;
+                        counted_quantity: number;
+                        proposed_sale_quantity: number;
+                        confirmed_sale_quantity: number;
+                        requires_admin_clarification: boolean;
+                        non_sale_reason: string | null;
+                        resolved_unit_price: number | null;
+                        discounted_line_total: number | null;
+                        currency_code: string | null;
+                    }[];
+                }[];
+            }, readonly ["affiliate", "consignment", "reports"], never> | undefined;
+        } & import("@tanstack/react-query").QueryKeyWithDataTag<readonly ["affiliate", "consignment", "reports"], {
+            reports: {
+                id: string;
+                affiliate_id: string;
+                period_start: string;
+                period_end: string;
+                status: "rejected" | "draft" | "approved" | "submitted";
+                draft_order_id: string | null;
+                order_id: string | null;
+                submitted_at: string | null;
+                lines: {
+                    id: string;
+                    inventory_item_id: string;
+                    batch_id: string | null;
+                    expected_quantity: number;
+                    counted_quantity: number;
+                    proposed_sale_quantity: number;
+                    confirmed_sale_quantity: number;
+                    requires_admin_clarification: boolean;
+                    non_sale_reason: string | null;
+                    resolved_unit_price: number | null;
+                    discounted_line_total: number | null;
+                    currency_code: string | null;
+                }[];
+            }[];
+        }, Error>;
+    };
+    affiliateApiPaths: {
+        commissions: string;
+        consignmentInventory: string;
+        consignmentReports: string;
+        context: string;
+        couponCodes: string;
+        slugs: string;
+    };
+    callbacks: StorefrontCallbacks;
+    /** Link to the shop's document download Route Handler (`api/documents/[id]/download`). */
+    documentDownloadHref: (documentId: string) => string;
+    getStripe: () => Promise<Stripe | null> | null;
+    hasStripe: boolean;
+    orderConfirmedPath: (countryCode: string, orderId: string) => string;
+    refreshCartAfterMutation: (queryClient: import("@tanstack/react-query").QueryClient, cartId?: string) => Promise<HttpTypes.StoreCart | null>;
+    freshOrder: {
+        markFreshOrder(orderId: string): void;
+        takeFreshOrder(orderId: string): boolean;
+    };
+    imageUrls: {
+        resolveMedusaImageUrl(url: string | null | undefined): string;
+        isMedusaHostedImageUrl(url: string): boolean;
+    };
+};
+export type StorefrontBrowser = ReturnType<typeof createStorefrontBrowser>;