@gengage/assistant-fe 0.4.20 → 0.5.0

package/dist/simbut/index.d.ts

@@ -1,22 +0,0 @@
-import { BaseWidget } from '../common/widget-base.js';
-import { PageContext } from '../common/types.js';
-import { GengageChat } from '../chat/index.js';
-import { SimButWidgetConfig } from './types.js';
-export declare class GengageSimBut extends BaseWidget<SimButWidgetConfig> {
-    private _button;
-    private _inlineFrame;
-    private _label;
-    protected onInit(config: SimButWidgetConfig): Promise<void>;
-    private _createInlineCard;
-    protected onUpdate(_context: Partial<PageContext>): void;
-    hide(): void;
-    show(): void;
-    protected _cleanupRoot(): void;
-    protected onShow(): void;
-    protected onHide(): void;
-    protected onDestroy(): void;
-    /** Optional hook for wiring overlay chat after initialization. */
-    setChat(chat: GengageChat | null): void;
-}
-export declare function createSimButWidget(): GengageSimBut;
-export type { SimButWidgetConfig, SimButI18n, SimButInlineCardConfig, SimButLayout } from './types.js';

package/dist/simbut/locales.d.ts

@@ -1,3 +0,0 @@
-import { SimButI18n } from './types.js';
-export declare const SIMBUT_I18N_TR: SimButI18n;
-export declare const SIMBUT_I18N_EN: SimButI18n;

package/dist/simbut/types.d.ts

@@ -1,43 +0,0 @@
-import { BaseWidgetConfig } from '../common/types.js';
-import { GengageChat } from '../chat/index.js';
-export interface SimButI18n {
-    findSimilarLabel: string;
-}
-export type SimButLayout = 'overlay' | 'inline-card';
-export interface SimButInlineCardConfig {
-    title?: string;
-    description?: string;
-    imageUrl?: string;
-    imageAlt?: string;
-}
-export interface SimButWidgetConfig extends BaseWidgetConfig {
-    /**
-     * Product image element, or its `position: relative` wrapper.
-     * The button is absolutely positioned inside this element and does not take layout space.
-     */
-    mountTarget: HTMLElement | string;
-    /** Visual layout. Defaults to the existing product-image overlay pill. */
-    layout?: SimButLayout;
-    /** Content used by `layout: 'inline-card'`. Ignored for overlay layout. */
-    inlineCard?: SimButInlineCardConfig;
-    /**
-     * Product SKU. Falls back to `pageContext.sku`, including overlay context updates.
-     */
-    sku?: string;
-    /** Optional product image URL passed to custom `onFindSimilar`; chat actions use SKU when available. */
-    imageUrl?: string;
-    /**
-     * Chat instance used to open chat and send `findSimilar`. `initOverlayWidgets` wires this automatically.
-     */
-    chat?: GengageChat | null;
-    /**
-     * Overrides the default click behavior, for example for a custom integration.
-     * When defined, `chat` is not used.
-     */
-    onFindSimilar?: (detail: {
-        sku: string;
-        imageUrl?: string;
-    }) => void;
-    locale?: string;
-    i18n?: Partial<SimButI18n>;
-}

package/dist/simrel/api.d.ts

@@ -1,25 +0,0 @@
-import { NormalizedProduct } from '../common/protocol-adapter.js';
-import { ChatTransportConfig } from '../common/api-paths.js';
-export interface SimilarProductsRequest {
-    account_id: string;
-    session_id: string;
-    correlation_id: string;
-    sku: string;
-    domain?: string;
-    limit?: number;
-    output_language?: string;
-}
-export interface ProductGroupingsRequest {
-    account_id: string;
-    session_id: string;
-    correlation_id: string;
-    skus: string[];
-    output_language?: string;
-}
-export interface ProductGroup {
-    name: string;
-    highlight?: string;
-    products: NormalizedProduct[];
-}
-export declare function fetchSimilarProducts(request: SimilarProductsRequest, transport: ChatTransportConfig, signal?: AbortSignal): Promise<NormalizedProduct[]>;
-export declare function fetchProductGroupings(request: ProductGroupingsRequest, transport: ChatTransportConfig, signal?: AbortSignal): Promise<ProductGroup[]>;

package/dist/simrel/catalog.d.ts

@@ -1,110 +0,0 @@
-import { z } from 'zod';
-export declare const ProductGridSchema: z.ZodObject<{
-    layout: z.ZodOptional<z.ZodEnum<{
-        grid: "grid";
-        carousel: "carousel";
-    }>>;
-    columns: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-export declare const ProductCardSchema: z.ZodObject<{
-    product: z.ZodObject<{
-        sku: z.ZodString;
-        name: z.ZodString;
-        imageUrl: z.ZodOptional<z.ZodString>;
-        price: z.ZodOptional<z.ZodString>;
-        originalPrice: z.ZodOptional<z.ZodString>;
-        discountPercent: z.ZodOptional<z.ZodNumber>;
-        url: z.ZodString;
-        brand: z.ZodOptional<z.ZodString>;
-        rating: z.ZodOptional<z.ZodNumber>;
-        reviewCount: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>;
-    index: z.ZodNumber;
-    discountType: z.ZodOptional<z.ZodEnum<{
-        "strike-through": "strike-through";
-        badge: "badge";
-    }>>;
-}, z.core.$strip>;
-export declare const AddToCartButtonSchema: z.ZodObject<{
-    sku: z.ZodString;
-    label: z.ZodOptional<z.ZodString>;
-    cartCode: z.ZodString;
-}, z.core.$strip>;
-export declare const QuickActionsSchema: z.ZodObject<{
-    actions: z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        action: z.ZodObject<{
-            title: z.ZodString;
-            type: z.ZodString;
-            payload: z.ZodOptional<z.ZodUnknown>;
-        }, z.core.$strip>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export declare const EmptyStateSchema: z.ZodObject<{
-    message: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export declare const simRelCatalog: {
-    readonly components: {
-        readonly ProductGrid: {
-            readonly schema: z.ZodObject<{
-                layout: z.ZodOptional<z.ZodEnum<{
-                    grid: "grid";
-                    carousel: "carousel";
-                }>>;
-                columns: z.ZodOptional<z.ZodNumber>;
-            }, z.core.$strip>;
-            readonly description: "Outer grid or carousel container for similar products.";
-        };
-        readonly ProductCard: {
-            readonly schema: z.ZodObject<{
-                product: z.ZodObject<{
-                    sku: z.ZodString;
-                    name: z.ZodString;
-                    imageUrl: z.ZodOptional<z.ZodString>;
-                    price: z.ZodOptional<z.ZodString>;
-                    originalPrice: z.ZodOptional<z.ZodString>;
-                    discountPercent: z.ZodOptional<z.ZodNumber>;
-                    url: z.ZodString;
-                    brand: z.ZodOptional<z.ZodString>;
-                    rating: z.ZodOptional<z.ZodNumber>;
-                    reviewCount: z.ZodOptional<z.ZodNumber>;
-                }, z.core.$strip>;
-                index: z.ZodNumber;
-                discountType: z.ZodOptional<z.ZodEnum<{
-                    "strike-through": "strike-through";
-                    badge: "badge";
-                }>>;
-            }, z.core.$strip>;
-            readonly description: "A single product card with image, title, price, and actions.";
-        };
-        readonly AddToCartButton: {
-            readonly schema: z.ZodObject<{
-                sku: z.ZodString;
-                label: z.ZodOptional<z.ZodString>;
-                cartCode: z.ZodString;
-            }, z.core.$strip>;
-            readonly description: "Add-to-cart CTA rendered inside or below a product card.";
-        };
-        readonly QuickActions: {
-            readonly schema: z.ZodObject<{
-                actions: z.ZodArray<z.ZodObject<{
-                    label: z.ZodString;
-                    action: z.ZodObject<{
-                        title: z.ZodString;
-                        type: z.ZodString;
-                        payload: z.ZodOptional<z.ZodUnknown>;
-                    }, z.core.$strip>;
-                }, z.core.$strip>>;
-            }, z.core.$strip>;
-            readonly description: "A row of quick-action buttons below product info.";
-        };
-        readonly EmptyState: {
-            readonly schema: z.ZodObject<{
-                message: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>;
-            readonly description: "Empty state shown when no similar products are available.";
-        };
-    };
-};
-export type SimRelCatalog = typeof simRelCatalog;
-export type SimRelComponentName = keyof SimRelCatalog['components'];

package/dist/simrel/components/GroupTabs.d.ts

@@ -1,24 +0,0 @@
-import { NormalizedProduct } from '../../common/protocol-adapter.js';
-import { ProductGroup } from '../api.js';
-import { SimRelI18n } from '../types.js';
-export interface GroupTabsOptions {
-    groups: ProductGroup[];
-    discountType?: 'strike-through' | 'badge';
-    onClick: (product: NormalizedProduct) => void;
-    onAddToCart: (params: {
-        sku: string;
-        quantity: number;
-        cartCode: string;
-    }) => void;
-    renderCard?: (product: NormalizedProduct, index: number) => string;
-    renderCardElement?: (product: NormalizedProduct, index: number) => HTMLElement | null;
-    i18n?: SimRelI18n;
-    /** ProductGrid `columns`: number of cards per desktop row. */
-    columns?: number;
-    /** User changed grouping tab (click or keyboard). */
-    onGroupingActivate?: (detail: {
-        grouping_label: string;
-        grouping_index: number;
-    }) => void;
-}
-export declare function renderGroupTabs(options: GroupTabsOptions): HTMLElement;

package/dist/simrel/components/ProductCard.d.ts

@@ -1,19 +0,0 @@
-import { NormalizedProduct } from '../../common/protocol-adapter.js';
-import { SimRelI18n } from '../types.js';
-import { PriceFormatConfig } from '../../common/price-formatter.js';
-export interface ProductCardOptions {
-    product: NormalizedProduct;
-    index: number;
-    discountType?: 'strike-through' | 'badge';
-    onClick: (product: NormalizedProduct) => void;
-    onAddToCart: (params: {
-        sku: string;
-        quantity: number;
-        cartCode: string;
-    }) => void;
-    renderCard?: (product: NormalizedProduct, index: number) => string;
-    renderCardElement?: (product: NormalizedProduct, index: number) => HTMLElement | null;
-    i18n?: SimRelI18n;
-    pricing?: PriceFormatConfig;
-}
-export declare function renderProductCard(options: ProductCardOptions): HTMLElement;

package/dist/simrel/components/ProductGrid.d.ts

@@ -1,17 +0,0 @@
-import { NormalizedProduct } from '../../common/protocol-adapter.js';
-import { SimRelI18n } from '../types.js';
-export interface ProductGridOptions {
-    products: NormalizedProduct[];
-    columns?: number;
-    discountType?: 'strike-through' | 'badge';
-    onClick: (product: NormalizedProduct) => void;
-    onAddToCart: (params: {
-        sku: string;
-        quantity: number;
-        cartCode: string;
-    }) => void;
-    renderCard?: (product: NormalizedProduct, index: number) => string;
-    renderCardElement?: (product: NormalizedProduct, index: number) => HTMLElement | null;
-    i18n?: SimRelI18n;
-}
-export declare function renderProductGrid(options: ProductGridOptions): HTMLElement;

package/dist/simrel/components/renderUISpec.d.ts

@@ -1,7 +0,0 @@
-import { UISpecDomRegistry, UISpecDomUnknownRenderer } from '../../common/renderer/index.js';
-import { UISpec } from '../../common/types.js';
-import { SimRelUISpecRenderContext } from '../types.js';
-export type SimRelUISpecRegistry = UISpecDomRegistry<SimRelUISpecRenderContext>;
-export declare const defaultSimRelUnknownUISpecRenderer: UISpecDomUnknownRenderer<SimRelUISpecRenderContext>;
-export declare function createDefaultSimRelUISpecRegistry(): SimRelUISpecRegistry;
-export declare function renderSimRelUISpec(spec: UISpec, context: SimRelUISpecRenderContext, registry?: SimRelUISpecRegistry, unknownRenderer?: UISpecDomUnknownRenderer<SimRelUISpecRenderContext>): HTMLElement;

package/dist/simrel/index.d.ts

@@ -1,5 +0,0 @@
-export * from './runtime.js';
-export { createSimRelRenderer } from './renderers/default.js';
-export type { SimRelFieldPath, SimRelRendererFields, SimRelRendererLabels, SimRelRendererMedia, SimRelRendererOptions, } from './renderers/default.js';
-export { simRelCatalog } from './catalog.js';
-export type { SimRelCatalog, SimRelComponentName } from './catalog.js';

package/dist/simrel/locales/en.d.ts

@@ -1,2 +0,0 @@
-import { SimRelI18n } from '../types.js';
-export declare const SIMREL_I18N_EN: SimRelI18n;

package/dist/simrel/locales/index.d.ts

@@ -1,5 +0,0 @@
-import { SimRelI18n } from '../types.js';
-import { SIMREL_I18N_TR } from './tr.js';
-import { SIMREL_I18N_EN } from './en.js';
-export declare function resolveSimRelLocale(locale?: string): SimRelI18n;
-export { SIMREL_I18N_TR, SIMREL_I18N_EN };

package/dist/simrel/locales/tr.d.ts

@@ -1,2 +0,0 @@
-import { SimRelI18n } from '../types.js';
-export declare const SIMREL_I18N_TR: SimRelI18n;

package/dist/simrel/renderers/default.d.ts

@@ -1,40 +0,0 @@
-import { PriceFormatConfig } from '../../common/price-formatter.js';
-import { SimilarProduct, SimRelRendererConfig } from '../types.js';
-export type SimRelFieldPath = string | readonly string[];
-export interface SimRelRendererLabels {
-    cta?: string;
-    productInfo?: string;
-    customBadgeAlt?: string;
-    review?: (count: number) => string;
-    imageDot?: (index: number) => string;
-    previousPromotion?: string;
-    nextPromotion?: string;
-    specialPriceBadgeAlt?: string;
-}
-export interface SimRelRendererFields {
-    images?: SimRelFieldPath[];
-    subtitle?: SimRelFieldPath[];
-    promotions?: SimRelFieldPath[];
-    warranties?: SimRelFieldPath[];
-    productInfoUrl?: SimRelFieldPath[];
-    discountReason?: SimRelFieldPath[];
-    specialPrice?: SimRelFieldPath[];
-    customBadgeFacets?: SimRelFieldPath[];
-    customBadgeText?: SimRelFieldPath[];
-    customBadgeImageUrl?: SimRelFieldPath[];
-}
-export interface SimRelRendererMedia {
-    promotionIconUrl?: string;
-    specialPriceBadgeUrl?: string;
-    imageUrlTransform?: (url: string, product: SimilarProduct) => string;
-    customBadgeImageUrl?: (product: SimilarProduct, labelText: string) => string | null | undefined;
-}
-export interface SimRelRendererOptions {
-    labels?: SimRelRendererLabels;
-    fields?: SimRelRendererFields;
-    media?: SimRelRendererMedia;
-    warrantyPromotionPattern?: RegExp;
-    specialPricePattern?: RegExp;
-    pricing?: PriceFormatConfig | undefined;
-}
-export declare function createSimRelRenderer(options?: SimRelRendererOptions): SimRelRendererConfig;

package/dist/simrel/runtime.d.ts

@@ -1,59 +0,0 @@
-import { PageContext } from '../common/types.js';
-import { NormalizedProduct } from '../common/protocol-adapter.js';
-import { BaseWidget } from '../common/widget-base.js';
-import { SimRelWidgetConfig } from './types.js';
-/**
- * Similar / related products widget for product pages.
- * Fetches AI-powered product recommendations and renders them as a scrollable grid.
- *
- * @example
- * ```ts
- * import { GengageSimRel, bootstrapSession } from '@gengage/assistant-fe';
- *
- * const simrel = new GengageSimRel();
- * await simrel.init({
- *   accountId: 'mystore',
- *   middlewareUrl: '<backend service location provided for your Gengage account>',
- *   sku: '12345',
- *   mountTarget: '#similar-products',
- *   session: { sessionId: bootstrapSession() },
- *   onAddToCart: ({ sku, quantity }) => cart.add(sku, quantity),
- * });
- * ```
- */
-export declare class GengageSimRel extends BaseWidget<SimRelWidgetConfig> {
-    private _abortController;
-    private _contentEl;
-    private _lastSku;
-    /** Number of products returned from the last successful fetch. Used to allow
-     *  retry when the same SKU previously produced an empty result set. */
-    private _lastResultCount;
-    private _i18n;
-    protected onInit(config: SimRelWidgetConfig): Promise<void>;
-    protected onUpdate(context: Partial<PageContext>): void;
-    protected onShow(): void;
-    protected onHide(): void;
-    protected onDestroy(): void;
-    _handleProductClick(product: NormalizedProduct): void;
-    _handleAddToCart(params: {
-        sku: string;
-        quantity: number;
-        cartCode: string;
-    }): void;
-    private _abort;
-    private _isSuperseded;
-    private _emitSimilarProductsImpression;
-    private _resolveRequestTimeoutMs;
-    private _fetchAndRender;
-    private _clampGridColumns;
-    private _resolveI18n;
-    private _resolveUISpecRegistry;
-    private _buildRenderContext;
-    private _renderUISpec;
-    private _buildProductsSpec;
-    private _buildGroupsSpec;
-}
-export declare function createSimRelWidget(): GengageSimRel;
-export type { SimRelWidgetConfig, SimilarProduct, SimRelUIComponents, SimRelI18n, SimRelUISpecRenderContext, SimRelRendererConfig, } from './types.js';
-export { renderSimRelUISpec, createDefaultSimRelUISpecRegistry, defaultSimRelUnknownUISpecRenderer, } from './components/renderUISpec.js';
-export type { SimRelUISpecRegistry } from './components/renderUISpec.js';

package/dist/simrel/types.d.ts

@@ -1,141 +0,0 @@
-import { BaseWidgetConfig, ActionPayload } from '../common/types.js';
-import { UISpecRendererOverrides } from '../common/renderer/index.js';
-export interface SimRelWidgetConfig extends BaseWidgetConfig {
-    /** Product SKU to find similar items for. Required. */
-    sku: string;
-    /** Where to render the product grid. Required. */
-    mountTarget: HTMLElement | string;
-    /** Called when "Add to cart" is tapped on a product card. */
-    onAddToCart?: (params: import('../common/types.js').AddToCartParams) => void;
-    /**
-     * Called when the user taps a product card (navigation intent).
-     * Return false to prevent the widget's default navigation.
-     */
-    onProductClick?: (product: SimilarProduct) => boolean | void;
-    /**
-     * Called just before navigating to a product page.
-     * Use to call window.gengage.chat.saveSession() for cross-page session continuity.
-     */
-    onProductNavigate?: (url: string, sku: string, sessionId: string | null) => void;
-    /** Forwarded to your analytics layer. */
-    onAnalyticsEvent?: (event: string, data: Record<string, unknown>) => void;
-    /**
-     * Override the default product card template.
-     *
-     * ⚠️ XSS WARNING: This function returns a raw HTML string injected into the DOM.
-     * You MUST sanitize any user-controlled data (e.g. product names from the API)
-     * using DOMPurify or a similar library before returning.
-     *
-     * Glov/Gengage accepts no responsibility for XSS vulnerabilities introduced
-     * by unsafe renderCard implementations.
-     */
-    renderCard?: (product: SimilarProduct, index: number) => string;
-    /**
-     * Override the default product card with a full DOM element.
-     * Unlike `renderCard` (HTML string), this returns an HTMLElement,
-     * allowing interactive elements (event listeners, state, etc.).
-     * Takes precedence over `renderCard` when both are provided.
-     */
-    renderCardElement?: (product: SimilarProduct, index: number) => HTMLElement | null;
-    /** Show the first slot as a "special" card (e.g. a promo or bundle). */
-    useSpecialCard?: boolean;
-    renderSpecialCard?: (product: SimilarProduct) => string | null;
-    discountType?: 'strike-through' | 'badge';
-    /**
-     * Number of product cards per desktop row (1-12). Default: 4.
-     * Narrow screens (<=768px) keep the horizontally scrollable carousel behavior.
-     */
-    gridColumns?: number;
-    /** Client-side abort cap for similar-products and grouping requests. Defaults to 120 seconds. */
-    requestTimeoutMs?: number;
-    domain?: string;
-    /** Locale key for SDK defaults (for example 'tr', 'en'). */
-    locale?: string;
-    i18n?: Partial<SimRelI18n>;
-    renderer?: SimRelRendererConfig;
-}
-export interface SimilarProduct {
-    sku: string;
-    name: string;
-    imageUrl?: string;
-    price?: string;
-    originalPrice?: string;
-    discountPercent?: number;
-    url: string;
-    brand?: string;
-    rating?: number;
-    reviewCount?: number;
-    cartCode?: string;
-    inStock?: boolean;
-    /** Pass-through bag for backend fields not consumed by the SDK. */
-    extras?: Record<string, unknown>;
-}
-export interface SimRelI18n {
-    similarProductsAriaLabel: string;
-    emptyStateMessage: string;
-    addToCartButton: string;
-    ctaLabel: string;
-    outOfStockLabel: string;
-    decreaseLabel: string;
-    increaseLabel: string;
-    /** Inline error message shown when similar products fail to load. */
-    errorLoadingMessage: string;
-    /** Retry button label shown alongside the error message. */
-    retryButtonText: string;
-    /**
-     * @deprecated Prefer `pricing` config on the widget for locale-aware formatting.
-     * Kept for backwards compatibility with existing custom integrations.
-     */
-    priceSuffix: string;
-    scrollTabsLeft?: string;
-    scrollTabsRight?: string;
-}
-export interface SimRelUISpecRenderContext {
-    onClick: (product: SimilarProduct) => void;
-    onAddToCart: (params: import('../common/types.js').AddToCartParams) => void;
-    /** Fires when the shopper selects a grouping tab (not the initial tab mount). */
-    onGroupingActivate?: (detail: {
-        grouping_label: string;
-        grouping_index: number;
-    }) => void;
-    onAction?: (action: ActionPayload) => void;
-    discountType?: 'strike-through' | 'badge';
-    renderCard?: (product: SimilarProduct, index: number) => string;
-    renderCardElement?: (product: SimilarProduct, index: number) => HTMLElement | null;
-    i18n: SimRelI18n;
-    pricing?: import('../common/price-formatter.js').PriceFormatConfig;
-    /** Used when the ui_spec `ProductGrid` omits `columns` (widget `gridColumns`). */
-    gridColumns?: number;
-}
-export type SimRelRendererConfig = UISpecRendererOverrides<SimRelUISpecRenderContext>;
-export interface SimRelUIComponents {
-    /** The outer grid/carousel container. */
-    ProductGrid: {
-        layout?: 'grid' | 'carousel';
-        columns?: number;
-    };
-    /** A single product card in the grid. */
-    ProductCard: {
-        product: SimilarProduct;
-        index: number;
-        discountType?: 'strike-through' | 'badge';
-    };
-    /** Add-to-cart button inside a card. */
-    AddToCartButton: {
-        sku: string;
-        label?: string;
-        /** Cart code / variant identifier. */
-        cartCode: string;
-    };
-    /** A "quick action" row of buttons below the product info. */
-    QuickActions: {
-        actions: Array<{
-            label: string;
-            action: ActionPayload;
-        }>;
-    };
-    /** Empty state shown when no similar products are found. */
-    EmptyState: {
-        message?: string;
-    };
-}