@iheartjane/dm-sdk 2.24.1

package/dist/smartSort-DJFM0D_n.d.ts

@@ -0,0 +1,1075 @@
+declare enum AdMode {
+    All = "all",
+    Default = "default",
+    Off = "off"
+}
+declare enum AppMode {
+    Bloom = "bloom",
+    Default = "default",
+    Embedded = "embedded",
+    FramelessEmbed = "framelessEmbed",
+    Headless = "headless",
+    Kiosk = "kiosk",
+    OperatorEmbed = "operatorEmbed",
+    WhiteLabel = "whiteLabel"
+}
+declare enum IntendedDisplay {
+    Desktop = "desktop",
+    Kiosk = "kiosk",
+    Mobile = "mobile"
+}
+declare enum JaneDeviceIdSentinel {
+    UserOptOut = "user-opt-out"
+}
+declare enum PageContextEnum {
+    Featured = "featured",
+    Midgrid = "midgrid"
+}
+declare enum Placement {
+    BestSelling = "best_selling",
+    BrandSpecials = "brand_specials",
+    BuyAgainRow = "buy_again_row",
+    CartToppers = "cart_toppers",
+    CustomImageRow = "custom_image_row",
+    FeaturedRow = "featured_row",
+    MenuDynamicRow = "menu_dynamic_row",
+    MenuInline = "menu_inline",
+    MenuInlineTable = "menu_inline_table",
+    MenuTopRow = "menu_top_row",
+    PdpRow = "pdp_row",
+    Sale = "sale",
+    Specials = "specials",
+    VirtualBudtenderSearch = "virtual_budtender_search"
+}
+declare enum ProductKindEnum {
+    Edible = "edible",
+    Extract = "extract",
+    Flower = "flower",
+    Gear = "gear",
+    Grow = "grow",
+    Merch = "merch",
+    PreRoll = "pre-roll",
+    Tincture = "tincture",
+    Topical = "topical",
+    Vape = "vape"
+}
+declare enum ReviewSortEnum {
+    Rating = "rating",
+    Recent = "recent",
+    Upvote = "upvote"
+}
+declare enum SearchSortEnum {
+    BestSellerRank = "best-seller-rank",
+    CategoryAndNameAsc = "category-and-name-asc",
+    Default = "default",
+    PriceAsc = "price-asc",
+    PriceDesc = "price-desc",
+    PriceEighthOunceAsc = "price-eighth-ounce-asc",
+    PriceEighthOunceDesc = "price-eighth-ounce-desc",
+    PriceGramAsc = "price-gram-asc",
+    PriceGramDesc = "price-gram-desc",
+    PriceHalfGramAsc = "price-half-gram-asc",
+    PriceHalfGramDesc = "price-half-gram-desc",
+    PriceHalfOunceAsc = "price-half-ounce-asc",
+    PriceHalfOunceDesc = "price-half-ounce-desc",
+    PriceOunceAsc = "price-ounce-asc",
+    PriceOunceDesc = "price-ounce-desc",
+    PriceQuarterOunceAsc = "price-quarter-ounce-asc",
+    PriceQuarterOunceDesc = "price-quarter-ounce-desc",
+    PriceTwoGramAsc = "price-two-gram-asc",
+    PriceTwoGramDesc = "price-two-gram-desc",
+    Rating = "rating",
+    Recommendation = "recommendation",
+    ThcPotencyAsc = "thc-potency-asc",
+    ThcPotencyDesc = "thc-potency-desc"
+}
+declare enum SessionEventCategory {
+    Edible = "edible",
+    Extract = "extract",
+    Flower = "flower",
+    PreRoll = "pre-roll",
+    Vape = "vape"
+}
+interface BrandSpecials {
+    placement: Placement;
+    /**
+     * The title of the brand specials
+     */
+    title?: string;
+}
+interface BrandSpecialsPlacementResponse {
+    placement?: Placement;
+    specials?: BrandSpecials[];
+    title?: string;
+}
+type Click = {
+    /**
+     * Distinct identifier
+     */
+    distinctId?: string;
+    /**
+     * Should be true if the click ads the product to the cart
+     */
+    isAddToCart?: boolean;
+    /**
+     * Jane device identifier
+     */
+    janeDeviceId: string;
+    /**
+     * Jane store identifier
+     */
+    storeId: number;
+} & Engagement;
+interface ConversionExternalProduct {
+    posProductId: string;
+    price: number;
+    quantity: number;
+}
+interface CustomImageData$1 {
+    headline: string;
+    image_url: string;
+    intended_display: IntendedDisplay;
+    logo_url: string;
+    overlay_color: string;
+    position_x: number;
+    position_y: number;
+    scale_number: number;
+    text_color: string;
+}
+interface Engagement {
+    /**
+     * Ad token
+     */
+    adToken?: string;
+    /**
+     * Kevel token
+     */
+    kevelToken?: string;
+    /**
+     * MyHigh identifier
+     */
+    myHighD?: string;
+    /**
+     * Product ID
+     */
+    productId: number;
+}
+type FilterContext = KindFilterContext;
+interface Impression {
+    /**
+     * Distinct identifier
+     */
+    distinctId?: string;
+    /**
+     * @minItems 1
+     */
+    engagements: Engagement[];
+    /**
+     * Jane device identifier
+     */
+    janeDeviceId: string;
+}
+interface KindFilterContext {
+    kind: ProductKindEnum[];
+}
+interface PageProduct {
+    object_id: string;
+    search_attributes?: Record<string, unknown>;
+}
+interface PageResponse {
+    products?: PageProduct[];
+}
+type PlacementResponse = BrandSpecialsPlacementResponse | ProductsPlacementResponse | SpecialsPlacementResponse;
+interface Product {
+    ad_token: string;
+    flight_id?: number;
+    kevel_token?: string;
+    my_high_d?: string;
+    object_id: string;
+    price_id?: string;
+    product_id: number;
+    search_attributes?: Record<string, unknown>;
+    store_id: number;
+}
+interface ProductReviewsResponse$1 {
+    aggregate: ReviewAggregate;
+    product_id: number;
+    reviews: Review[];
+    total_count: number;
+}
+interface ProductsPlacementResponse {
+    creative_ids?: number[];
+    /**
+     * @deprecated true
+     */
+    custom_image_data?: CustomImageData$1;
+    custom_images?: CustomImageData$1[];
+    nb_hits?: number;
+    placement?: Placement;
+    products?: Product[];
+    row_id?: number;
+    search_facets?: Record<string, Record<string, number>>;
+    title?: string;
+}
+interface Review {
+    activities?: string[];
+    avatar?: number;
+    comment?: string;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    feelings?: string[];
+    has_comment: boolean;
+    id: number;
+    nickname?: string;
+    product_id: number;
+    rating: number;
+    store_id?: number;
+    store_name?: string;
+    /**
+     * @format date-time
+     */
+    updated_at: string;
+    upvote_count: number;
+}
+interface ReviewAggregate {
+    activities_distribution?: ReviewDistribution;
+    average_rating: number;
+    distribution: ReviewDistribution;
+    feelings_distribution?: ReviewDistribution;
+    review_count: number;
+}
+type ReviewDistribution = Record<string, number>;
+type SessionEvent = ({
+    type: 'clickedAddToCart';
+} & Omit<SessionEventClickedAddToCart, 'type'>) | ({
+    type: 'filteredCategory';
+} & SessionEventFilteredCategory) | ({
+    type: 'viewedProduct';
+} & Omit<SessionEventViewedProduct, 'type'>);
+type SessionEventClickedAddToCart = SessionEventClickedAddToCartPOSProduct | SessionEventClickedAddToCartProduct;
+interface SessionEventClickedAddToCartPOSProduct {
+    posProductId: string;
+    productId?: never;
+    storeId: number;
+}
+interface SessionEventClickedAddToCartProduct {
+    posProductId?: never;
+    productId: number;
+    storeId: number;
+}
+interface SessionEventFilteredCategory {
+    category: SessionEventCategory;
+    storeId: number;
+}
+type SessionEventViewedProduct = SessionEventViewedProductPOSProduct | SessionEventViewedProductProduct;
+interface SessionEventViewedProductPOSProduct {
+    posProductId: string;
+    productId?: never;
+    storeId: number;
+}
+interface SessionEventViewedProductProduct {
+    posProductId?: never;
+    productId: number;
+    storeId: number;
+}
+interface SpecialResponse {
+    description?: string;
+    specialId?: number;
+    title?: string;
+}
+interface SpecialsPlacementResponse {
+    placement?: Placement;
+    specials?: SpecialResponse[];
+    title?: string;
+}
+type VirtualBudtenderProduct = {
+    /**
+     * AI-generated explanation for why this product matches the query
+     *
+     * @example This product contains CBD which is known for its calming effects and may help with sleep
+     */
+    reasoning?: string;
+    /**
+     * Relevance score for this product (0 to 10)
+     *
+     * @example 8.5
+     * @format float
+     * @maximum 10
+     * @minimum 0
+     */
+    score?: number;
+} & Product;
+interface VirtualBudtenderQuery {
+    /**
+     * Human-readable display text for the query
+     *
+     * @example Help me sleep
+     */
+    displayText: string;
+    /**
+     * The natural language query string
+     *
+     * @example help me sleep
+     */
+    query: string;
+}
+interface VirtualBudtenderSearchResponse {
+    /**
+     * AI-generated response in HTML format
+     *
+     * @example <p>Based on your request for sleep help, I recommend these products...</p>
+     */
+    htmlResponse: string;
+    /**
+     * AI-generated response in markdown format
+     *
+     * @example Based on your request for sleep help, I recommend these products that contain CBD and indica strains...
+     */
+    markdownResponse: string;
+    /**
+     * List of products matching the query
+     */
+    products: VirtualBudtenderProduct[];
+    /**
+     * The original query that was searched
+     *
+     * @example help me sleep
+     */
+    query: string;
+    /**
+     * Total number of products found
+     *
+     * @example 15
+     * @minimum 0
+     */
+    totalResults: number;
+    /**
+     * Raw AI-generated response without formatting
+     *
+     * @example Based on your request for sleep help, I recommend these products that contain CBD and indica strains...
+     */
+    unformattedResponse: string;
+}
+
+/**
+ * Configuration options for the Jane DM SDK client.
+ */
+type JaneDMConfig = JaneDMInternalConfig & JaneDMPublicConfig;
+/**
+ * Tracking identifiers for a user
+ */
+interface JaneDMIdentifiers {
+    /**
+     * A unique identifier, UUID, representing the device visiting the site
+     */
+    jdid: string;
+    /**
+     * @internal
+     */
+    mixpanelDistinctId?: string;
+    /**
+     * Optional unique identifier for an external pos authenticated user
+     */
+    posUserId?: string;
+    /**
+     * Optional unique identifier for a Jane authenticated user
+     */
+    userId?: number;
+}
+/**
+ * Internal configuration options for the Jane DM SDK client.
+ * Should never be set by the consumer of the SDK.
+ *
+ * **Modification of these fields will result in unexpected behavior.**
+ * @internal
+ */
+interface JaneDMInternalConfig {
+    /**
+     * The context in which the DM placements should be served in
+     *
+     * Should never be set by the consumer of the SDK
+     *
+     * @default 'headless'
+     * @internal
+     */
+    appMode?: AppMode;
+    /**
+     * Endpoint used for tracking events
+     *
+     * The default value is the same as the endpoint
+     *
+     * Should never be set by the consumer of the SDK
+     * @internal
+     */
+    eventsEndpoint?: string;
+    /**
+     * Endpoint used for fetching the page data
+     *
+     * The default value is the same as the endpoint
+     *
+     * Should never be set by the consumer of the SDK
+     * @internal
+     */
+    pageEndpoint?: string;
+    /**
+     * Skip automatic onLoad call in SmartSort constructor
+     *
+     * When true, prevents automatic fingerprint collection and session events
+     * on SmartSort instantiation. Use this when you need manual control over
+     * when onLoad is triggered.
+     *
+     * Should never be set by the consumer of the SDK
+     *
+     * @default false
+     * @internal
+     */
+    skipAutoSmartSortOnLoad?: boolean;
+    /**
+     * This is an internal field used for tracking the source of the SDK
+     *
+     * Should never be set by the consumer of the SDK
+     *
+     * @default 'sdk'
+     * @internal
+     */
+    source?: string;
+}
+/**
+ * Public configuration options for the Jane DM SDK client.
+ */
+interface JaneDMPublicConfig {
+    /**
+     * Key that enables access to the DM API.
+     *
+     * Reach out to a Jane representative to learn more about how to obtain an API key.
+     */
+    apiKey: string;
+    /**
+     * The endpoint to use for the DM API
+     * @default 'https://dmerch.iheartjane.com'
+     */
+    endpoint?: string;
+    /**
+     * Identifiers object for user tracking purposes
+     */
+    identifier?: JaneDMIdentifiers;
+}
+type RequiredConfig = Required<JaneDMConfig>;
+
+type Facets = Record<string, Record<string, number>>;
+
+/**
+ * Default page size used across paginated resources when the caller does
+ * not specify one. Matches the server-side default.
+ */
+declare const DEFAULT_PAGE_SIZE = 50;
+/**
+ * Shared shape for every paginated iterator in the SDK. Yields items
+ * one at a time by default; `.pages` exposes an iterator over whole
+ * page envelopes for callers that need page-level data during traversal.
+ *
+ * Internal: not re-exported from the public SDK entry point. Consumers
+ * use the concrete per-resource iterable types (e.g.
+ * `ProductReviewsIterable`).
+ */
+interface PaginatedIterable<TItem, TResponse> extends AsyncIterable<TItem> {
+    pages: AsyncIterable<TResponse>;
+}
+/**
+ * Shared shape for every paginated response in the SDK. Per-resource
+ * types extend this with domain-specific fields (e.g. aggregates) at
+ * the top level.
+ *
+ * Internal: not re-exported from the public SDK entry point. Consumers
+ * use the concrete per-resource types (e.g. `ProductReviewsResponse`).
+ */
+interface PaginatedResponse<TItem> {
+    items: TItem[];
+    pagination: PaginationInfo;
+}
+/**
+ * Pagination metadata included on every paginated response envelope.
+ *
+ * Use this shape when typing your own pagination UI components
+ * (e.g. a page selector, next/prev buttons, or an infinite-scroll
+ * "load more" control).
+ */
+interface PaginationInfo {
+    /**
+     * The page that was returned. 1-indexed.
+     */
+    currentPage: number;
+    /**
+     * `true` when another page exists after `currentPage`.
+     */
+    hasNextPage: boolean;
+    /**
+     * `true` when a page exists before `currentPage`.
+     */
+    hasPreviousPage: boolean;
+    /**
+     * The size of the current page, echoing the requested `pageSize`.
+     */
+    pageSize: number;
+    /**
+     * Total number of items across every page, matching the filter.
+     */
+    totalCount: number;
+    /**
+     * `Math.ceil(totalCount / pageSize)`, floored to 1 so empty result
+     * sets still have at least one page.
+     */
+    totalPages: number;
+}
+
+/**
+ * Filter/config props accepted by `fetchProductReviews`.
+ */
+interface FetchProductReviewsProps {
+    activities?: string[];
+    feelings?: string[];
+    /**
+     * When `true`, restricts results to reviews that have a non-empty
+     * comment. Every aggregate in the response (counts, average, star
+     * distribution, feeling/activity tag distributions) is computed over
+     * only the commented reviews.
+     *
+     * Omit (or `false`) for no filter — both are equivalent, since `false`
+     * is a no-op server-side. The SDK drops `false` from the request body
+     * to keep the payload minimal.
+     */
+    hasComment?: boolean;
+    /**
+     * 1-indexed. Defaults to 1.
+     */
+    page?: number;
+    pageSize?: number;
+    productId: number;
+    ratings?: number[];
+    sort?: ReviewSortEnum;
+}
+/**
+ * Filter/config props accepted by `iterateProductReviews`. Identical to
+ * `FetchProductReviewsProps` except `page` is omitted — the iterator
+ * always starts at page 1 and advances until the server reports no
+ * more pages.
+ */
+type IterateProductReviewsProps = Omit<FetchProductReviewsProps, 'page'>;
+interface ProductReview {
+    activities?: string[];
+    avatar?: number;
+    comment?: string;
+    createdAt: string;
+    feelings?: string[];
+    hasComment: boolean;
+    id: number;
+    nickname?: string;
+    productId: number;
+    rating: number;
+    storeId?: number;
+    storeName?: string;
+    updatedAt: string;
+    upvoteCount: number;
+}
+interface ProductReviewsAggregate {
+    activitiesDistribution?: Record<string, number>;
+    averageRating: number;
+    distribution: Record<string, number>;
+    feelingsDistribution?: Record<string, number>;
+    reviewCount: number;
+}
+/**
+ * Async iterable returned by `JaneDM.iterateProductReviews`. Yields
+ * individual reviews by default; use `.pages` to iterate over whole
+ * page envelopes.
+ *
+ * @see [Pagination guide](https://dm-sdk-docs.iheartjane.com/app/pagination).
+ */
+type ProductReviewsIterable = PaginatedIterable<ProductReview, ProductReviewsResponse>;
+/**
+ * Envelope returned by `JaneDM.fetchProductReviews`. Extends the SDK's
+ * shared paginated-response shape with review-specific fields.
+ *
+ * @see {@link PaginationInfo} for the `pagination` field shape.
+ * @see [Pagination guide](https://dm-sdk-docs.iheartjane.com/app/pagination).
+ */
+interface ProductReviewsResponse extends PaginatedResponse<ProductReview> {
+    aggregate: ProductReviewsAggregate;
+    productId: number;
+}
+
+/**
+ * @deprecated Use `SearchSortEnum.best_seller_sort` instead
+ */
+declare const bestSellerRank = "best-seller-rank";
+/**
+ * @deprecated Use `SearchSortEnum.category_and_name_asc` instead
+ */
+declare const categoryAndNameAsc = "category-and-name-asc";
+/**
+ * @deprecated Use `SearchSortEnum.default` instead
+ */
+declare const defaultOrder = "default";
+/**
+ * @deprecated Use `SearchSortEnum.price_asc` instead
+ */
+declare const priceAsc = "price-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_desc` instead
+ */
+declare const priceDesc = "price-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_eighth_ounce_asc` instead
+ */
+declare const priceEighthOunceAsc = "price-eighth-ounce-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_eighth_ounce_desc` instead
+ */
+declare const priceEighthOunceDesc = "price-eighth-ounce-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_gram_asc` instead
+ */
+declare const priceGramAsc = "price-gram-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_gram_desc` instead
+ */
+declare const priceGramDesc = "price-gram-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_half_gram_asc` instead
+ */
+declare const priceHalfGramAsc = "price-half-gram-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_half_gram_desc` instead
+ */
+declare const priceHalfGramDesc = "price-half-gram-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_half_ounce_asc` instead
+ */
+declare const priceHalfOunceAsc = "price-half-ounce-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_half_ounce_desc` instead
+ */
+declare const priceHalfOunceDesc = "price-half-ounce-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_ounce_asc` instead
+ */
+declare const priceOunceAsc = "price-ounce-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_ounce_desc` instead
+ */
+declare const priceOunceDesc = "price-ounce-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_quarter_ounce_asc` instead
+ */
+declare const priceQuarterOunceAsc = "price-quarter-ounce-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_quarter_ounce_desc` instead
+ */
+declare const priceQuarterOunceDesc = "price-quarter-ounce-desc";
+/**
+ * @deprecated Use `SearchSortEnum.price_two_gram_asc` instead
+ */
+declare const priceTwoGramAsc = "price-two-gram-asc";
+/**
+ * @deprecated Use `SearchSortEnum.price_two_gram_desc` instead
+ */
+declare const priceTwoGramDesc = "price-two-gram-desc";
+/**
+ * @deprecated Use `SearchSortEnum.rating` instead
+ */
+declare const rating = "rating";
+/**
+ * @deprecated Use `SearchSortEnum.recommendation` instead
+ */
+declare const recommendation = "recommendation";
+/**
+ * @deprecated Use `SearchSortEnum.thc_potency_asc` instead
+ */
+declare const thcPotencyAsc = "thc-potency-asc";
+/**
+ * @deprecated Use `SearchSortEnum.thc_potency_desc` instead
+ */
+declare const thcPotencyDesc = "thc-potency-desc";
+declare const searchSorts: readonly ["best-seller-rank", "category-and-name-asc", "default", "price-asc", "price-desc", "price-eighth-ounce-asc", "price-eighth-ounce-desc", "price-gram-asc", "price-gram-desc", "price-half-gram-asc", "price-half-gram-desc", "price-half-ounce-asc", "price-half-ounce-desc", "price-ounce-asc", "price-ounce-desc", "price-quarter-ounce-asc", "price-quarter-ounce-desc", "price-two-gram-asc", "price-two-gram-desc", "rating", "recommendation", "thc-potency-asc", "thc-potency-desc"];
+/**
+ * @deprecated Use `SearchSortEnum` instead
+ */
+type SearchSort = (typeof searchSorts)[number];
+
+interface CustomImageData {
+    headline: string;
+    imageUrl: string;
+    intendedDisplay: IntendedDisplay;
+    logoUrl: string;
+    overlayColor: string;
+    positionX: number;
+    positionY: number;
+    scaleNumber: number;
+    textColor: string;
+}
+/**
+ * Properties to fetch by a single store id.
+ */
+interface FetchByStoreIdProps {
+    /**
+     * The store ID to use for the placement.
+     * @deprecated Use `storeIds` instead
+     */
+    storeId: number;
+    storeIds?: never;
+}
+/**
+ * Properties to fetch by many store ids.
+ */
+interface FetchByStoreIdsProps {
+    storeId?: never;
+    /**
+     * The store IDs to use for the placement.
+     */
+    storeIds: number[];
+}
+/**
+ * Properties to fetch a CartTopperRow by POS product IDs.
+ */
+interface FetchCartTopperRowByPosProductId {
+    cartProductIds?: never;
+    /**
+     * The POS IDs of the products present in the cart.
+     */
+    posCartProductIds: string[];
+}
+/**
+ * Properties to fetch a CartTopperRow by product IDs.
+ */
+interface FetchCartTopperRowByProductProps {
+    /**
+     * The IDs of the products present in the cart.
+     */
+    cartProductIds: number[];
+    posCartProductIds?: never;
+}
+/**
+ * Properties to fetch a CartTopperRow.
+ */
+type FetchCartTopperRowProps = {
+    /**
+     * Product attributes that will be returned in the search results.
+     */
+    searchAttributes: string[];
+    /**
+     * The store ID to use for the placement.
+     */
+    storeId: number;
+} & (FetchCartTopperRowByPosProductId | FetchCartTopperRowByProductProps);
+/**
+ * Properties to fetch a CustomImageRow.
+ */
+interface FetchCustomImageRowProps {
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * A filter string to be applied to the search results, such as
+     * `'kind:flower'`.
+     */
+    searchFilter?: string;
+    /**
+     * The store ID to use for the placement.
+     */
+    storeId: number;
+}
+/**
+ * Properties to fetch a MenuRow.
+ * @internal
+ */
+type FetchMenuRowProps = {
+    /**
+     * The ad mode to use for the placement.
+     *
+     * @default AdMode.Default
+     */
+    adMode?: AdMode;
+    /**
+     * If false, the products will not be deduped across stores.
+     */
+    distinctByProduct?: boolean;
+    /**
+     * Metadata passed through data warehouse
+     * @internal
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The number of columns of products that are displayed in the placement.
+     */
+    numColumns?: number;
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * A filter string to be applied to the search results, such as
+     * `'kind:flower'`.
+     */
+    searchFilter?: string;
+    searchQuery?: string;
+    /**
+     * The sort order to apply to the search results.
+     */
+    searchSort: SearchSort | SearchSortEnum;
+} & (FetchByStoreIdProps | FetchByStoreIdsProps);
+/**
+ * Properties to fetch a MenuTopRow.
+ */
+type FetchMenuTopRowProps<AdditionalTypes = object> = {
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * A filter string to be applied to the search results, such as
+     * `'kind:flower'`.
+     */
+    searchFilter?: string;
+    /**
+     * The store ID to use for the placement.
+     */
+    storeId: number;
+} & AdditionalTypes;
+interface FetchRecommendedPDPRowByPosProductId {
+    /**
+     * POS Product ID of the product being viewed.
+     */
+    posProductId: string;
+    productId?: never;
+}
+interface FetchRecommendedPDPRowByProductId {
+    posProductId?: never;
+    /**
+     * Product ID of the product being viewed.
+     */
+    productId: number;
+}
+/**
+ * Properties to fetch a PDPRow.
+ */
+type FetchRecommendedPDPRowProps = {
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * The store ID to use for the placement.
+     */
+    storeId: number;
+} & (FetchRecommendedPDPRowByPosProductId | FetchRecommendedPDPRowByProductId);
+/**
+ * Properties to fetch a RecommendedRow
+ */
+interface FetchRecommendedRowProps {
+    /**
+     * The ad mode to use for the placement.
+     *
+     * @default AdMode.Default
+     */
+    adMode?: AdMode;
+    /**
+     * Structured filter contexts to apply to the search results.
+     * Supports filtering by product kind.
+     * @example
+     * ```typescript
+     * filterContext: [{ kind: ['flower', 'edible', 'vape'] }]
+     * ```
+     */
+    filterContext?: FilterContext[];
+    /**
+     * Page context indicating where the placement appears.
+     * Defaults to 'featured' if not specified.
+     * @example
+     * ```typescript
+     * pageContext: 'featured'  // or 'midgrid'
+     * ```
+     */
+    pageContext?: PageContextEnum;
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * The store ID to use for the placement.
+     */
+    storeId: number;
+}
+/**
+ * Properties to fetch a SmartSort instance.
+ */
+type FetchRecommendedSortProps = {
+    /**
+     * If true, no ads are displayed in the placement.
+     */
+    disableAds?: boolean;
+    /**
+     * If false, the products will not be deduped across stores.
+     */
+    distinctByProduct?: boolean;
+    /**
+     * The maximum number of products to display in the placement.
+     */
+    maxProducts?: number;
+    /**
+     * Metadata passed through data warehouse
+     * @internal
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The number of columns of products that are displayed in the placement.
+     */
+    numColumns?: number;
+    /**
+     * The number of products to fetch in each page.
+     */
+    pageSize?: number;
+    /**
+     * A list of attributes to be returned in the search results, such as
+     * `['product_id', 'name']`.
+     */
+    searchAttributes: string[];
+    /**
+     * A list of search facets to be returned in the search results, such as
+     * `['kind']`.
+     */
+    searchFacets?: string[];
+    /**
+     * A filter string to be applied to the search results, such as
+     * `'kind:flower'`.
+     */
+    searchFilter?: string;
+    searchQuery?: string;
+    /**
+     * The sort order to apply to the search results.
+     */
+    searchSort: SearchSort | SearchSortEnum;
+} & (FetchByStoreIdProps | FetchByStoreIdsProps);
+/**
+ * Cached product in the SmartSort placement
+ * The key difference between a Cached and a regular `SmartSortProduct`
+ * is the hydration of the `attributes` property.
+ * Cached products do not have this attribute while `SmartSortProducts` do.
+ * @internal
+ */
+interface SmartSortCachedProductProps {
+    clickPayload: Click;
+    clickUrl: string;
+    impressPayload: Impression;
+    impressUrl: string;
+    isSponsored: boolean;
+    objectId: string;
+}
+/**
+ * The SmartSortClickIntent is used to determine if the click
+ * event should be treated as an "add to cart" event.
+ *
+ */
+interface SmartSortClickIntent {
+    /**
+     * When set to true, the click event will be treated as an "add to cart" event.
+     *
+     * @default false
+     */
+    isAddToCart?: boolean;
+}
+/**
+ * Data structure used to request the next set of products when loading
+ * the next page of a SmartSort placement.
+ */
+interface SmartSortNextPageProps {
+    pageSize: number;
+    searchAttributes: string[];
+}
+/**
+ * Properties to create a `SmartSortProduct` instance.
+ */
+interface SmartSortProductProps<ProductShape extends object = Record<string, unknown>> extends SmartSortCachedProductProps {
+    attributes: ProductShape;
+    hasBeenImpressed?: boolean;
+}
+/**
+ * Properties to recreate a `SmartSort` instance.
+ * These properties should be passed **unmodified** to the constructor.
+ */
+interface SmartSortProps<ProductShape extends object = Record<string, unknown>> {
+    /**
+     * Cached products for the placement. This field is used internally to
+     * improve the performance of the placement.
+     * @internal
+     */
+    cachedProducts: SmartSortCachedProductProps[];
+    /**
+     * Jane configuration object.
+     * @internal
+     */
+    config: RequiredConfig;
+    /**
+     * The creative IDs associated with the placement
+     */
+    creativeIds?: number[];
+    /**
+     * The custom images for the placement. Always an array; empty when the
+     * placement returns no custom images.
+     */
+    customImages?: CustomImageData[];
+    /**
+     * Parameters to request the next page of the placement.
+     */
+    nextPageProps: SmartSortNextPageProps;
+    /**
+     * URL where the next set of products can be fetched from.
+     */
+    nextPageUrl: string;
+    /**
+     * The placement type of the current instance.
+     */
+    placement?: Placement;
+    /**
+     * The products to display in the placement
+     */
+    products: SmartSortProductProps<ProductShape>[];
+    /**
+     * The row id of the placement.
+     */
+    rowId?: number | undefined;
+    /**
+     * A map of search facets for this placement.
+     * @example
+     * ```json
+     * {
+     *   "category": {
+     *     "sativa": 20,
+     *     "indica": 10,
+     *   },
+     *   "kind": {
+     *     "flower": 31,
+     *     "vape": 5,
+     *   },
+     * }
+     * ```
+     */
+    searchFacets?: Record<string, Record<string, number>>;
+    /**
+     * The title of the placement
+     */
+    title?: string | undefined;
+    /**
+     * Total number of products available
+     */
+    totalProducts: number;
+}
+
+export { priceEighthOunceDesc as $, AdMode as A, type JaneDMConfig as B, type Click as C, DEFAULT_PAGE_SIZE as D, type JaneDMIdentifiers as E, type FilterContext as F, JaneDeviceIdSentinel as G, type PaginationInfo as H, type Impression as I, type JaneDMPublicConfig as J, ProductKindEnum as K, type ProductReview as L, type ProductReviewsAggregate as M, ReviewSortEnum as N, type SearchSort as O, Placement as P, type SmartSortNextPageProps as Q, type RequiredConfig as R, SearchSortEnum as S, type VirtualBudtenderSearchResponse as T, bestSellerRank as U, type VirtualBudtenderQuery as V, categoryAndNameAsc as W, defaultOrder as X, priceAsc as Y, priceDesc as Z, priceEighthOunceAsc as _, PageContextEnum as a, priceGramAsc as a0, priceGramDesc as a1, priceHalfGramAsc as a2, priceHalfGramDesc as a3, priceHalfOunceAsc as a4, priceHalfOunceDesc as a5, priceOunceAsc as a6, priceOunceDesc as a7, priceQuarterOunceAsc as a8, priceQuarterOunceDesc as a9, priceTwoGramAsc as aa, priceTwoGramDesc as ab, rating as ac, recommendation as ad, searchSorts as ae, thcPotencyAsc as af, thcPotencyDesc as ag, type PlacementResponse as ah, type Product as ai, type ProductReviewsResponse$1 as aj, type ProductsPlacementResponse as ak, type PageResponse as al, type CustomImageData$1 as am, type CustomImageData as b, type SmartSortProductProps as c, type SmartSortClickIntent as d, type SmartSortProps as e, type ConversionExternalProduct as f, type SessionEvent as g, type JaneDMInternalConfig as h, type FetchCartTopperRowProps as i, type FetchCustomImageRowProps as j, type Facets as k, type FetchMenuRowProps as l, type FetchMenuTopRowProps as m, type FetchProductReviewsProps as n, type ProductReviewsResponse as o, type FetchRecommendedPDPRowProps as p, type FetchRecommendedRowProps as q, type FetchRecommendedSortProps as r, type IterateProductReviewsProps as s, type ProductReviewsIterable as t, AppMode as u, type FetchCartTopperRowByPosProductId as v, type FetchCartTopperRowByProductProps as w, type FetchRecommendedPDPRowByPosProductId as x, type FetchRecommendedPDPRowByProductId as y, IntendedDisplay as z };