@gengage/assistant-fe 0.4.20 → 0.5.0

package/dist/qna/catalog.d.ts

@@ -1,73 +0,0 @@
-import { z } from 'zod';
-export declare const ActionButtonSchema: z.ZodObject<{
-    label: z.ZodString;
-    action: z.ZodObject<{
-        title: z.ZodString;
-        type: z.ZodString;
-        payload: z.ZodOptional<z.ZodUnknown>;
-    }, z.core.$strip>;
-    variant: z.ZodOptional<z.ZodEnum<{
-        primary: "primary";
-        outline: "outline";
-        ghost: "ghost";
-    }>>;
-}, z.core.$strip>;
-export declare const ButtonRowSchema: z.ZodObject<{
-    orientation: z.ZodOptional<z.ZodEnum<{
-        horizontal: "horizontal";
-        vertical: "vertical";
-    }>>;
-    wrap: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export declare const TextInputSchema: z.ZodObject<{
-    placeholder: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-    ctaLabel: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export declare const QuestionHeadingSchema: z.ZodObject<{
-    text: z.ZodString;
-}, z.core.$strip>;
-export declare const qnaCatalog: {
-    readonly components: {
-        readonly ActionButton: {
-            readonly schema: z.ZodObject<{
-                label: z.ZodString;
-                action: z.ZodObject<{
-                    title: z.ZodString;
-                    type: z.ZodString;
-                    payload: z.ZodOptional<z.ZodUnknown>;
-                }, z.core.$strip>;
-                variant: z.ZodOptional<z.ZodEnum<{
-                    primary: "primary";
-                    outline: "outline";
-                    ghost: "ghost";
-                }>>;
-            }, z.core.$strip>;
-            readonly description: "A single clickable QNA action button.";
-        };
-        readonly ButtonRow: {
-            readonly schema: z.ZodObject<{
-                orientation: z.ZodOptional<z.ZodEnum<{
-                    horizontal: "horizontal";
-                    vertical: "vertical";
-                }>>;
-                wrap: z.ZodOptional<z.ZodBoolean>;
-            }, z.core.$strip>;
-            readonly description: "Container for a group of QNA action buttons.";
-        };
-        readonly TextInput: {
-            readonly schema: z.ZodObject<{
-                placeholder: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-                ctaLabel: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>;
-            readonly description: "Free-text input with rotating placeholder and CTA button.";
-        };
-        readonly QuestionHeading: {
-            readonly schema: z.ZodObject<{
-                text: z.ZodString;
-            }, z.core.$strip>;
-            readonly description: "A heading displayed above the QNA button group.";
-        };
-    };
-};
-export type QNACatalog = typeof qnaCatalog;
-export type QNAComponentName = keyof QNACatalog['components'];

package/dist/qna/components/ButtonRow.d.ts

@@ -1,15 +0,0 @@
-import { ActionPayload } from '../../common/types.js';
-export interface ButtonRowOptions {
-    actions: Array<{
-        title: string;
-        type: string;
-        payload?: unknown;
-    }>;
-    onAction: (action: ActionPayload) => void;
-    ctaText?: string;
-    defaultCtaText?: string;
-    onOpenChat?: () => void;
-    orientation?: 'horizontal' | 'vertical';
-    quickQuestionsAriaLabel?: string;
-}
-export declare function renderButtonRow(options: ButtonRowOptions): HTMLElement;

package/dist/qna/components/TextInput.d.ts

@@ -1,11 +0,0 @@
-import { ActionPayload } from '../../common/types.js';
-export interface TextInputOptions {
-    placeholders?: string | string[];
-    ctaLabel?: string;
-    defaultInputPlaceholder?: string;
-    askQuestionAriaLabel?: string;
-    sendButtonText?: string;
-    sendQuestionAriaLabel?: string;
-    onSubmit: (action: ActionPayload) => void;
-}
-export declare function renderTextInput(options: TextInputOptions): HTMLElement;

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

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

package/dist/qna/index.d.ts

@@ -1,3 +0,0 @@
-export * from './runtime.js';
-export { qnaCatalog } from './catalog.js';
-export type { QNACatalog, QNAComponentName } from './catalog.js';

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

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

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

@@ -1,5 +0,0 @@
-import { QNAI18n } from '../types.js';
-import { QNA_I18N_TR } from './tr.js';
-import { QNA_I18N_EN } from './en.js';
-export declare function resolveQnaLocale(locale?: string): QNAI18n;
-export { QNA_I18N_TR, QNA_I18N_EN };

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

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

package/dist/qna/normalize-ui-specs.d.ts

@@ -1,15 +0,0 @@
-import { PageContext, UISpec } from '../common/types.js';
-import { QNAI18n } from './types.js';
-/** SKUs to send with the product-context quick pill (`user_message` + sku_list). */
-export type MergeQuickPillsOptions = {
-    skuList?: string[] | undefined;
-};
-/**
- * Resolve SKU list for QNA → chat payloads: current PDP sku, or `visible_skus` on listings.
- */
-export declare function resolveQnaSkuListForPayload(pageContext: PageContext | undefined): string[] | undefined;
-/**
- * Removes standalone hero `ActionButton` blocks for `findSimilar` (e.g. from `text_image`)
- * and merges a product-context quick question pill instead (same row as other questions).
- */
-export declare function mergeStandaloneFindSimilarIntoQuickPills(specs: UISpec[], i18n: QNAI18n, options?: MergeQuickPillsOptions): UISpec[];

package/dist/qna/runtime.d.ts

@@ -1,62 +0,0 @@
-import { ActionPayload, PageContext } from '../common/types.js';
-import { BaseWidget } from '../common/widget-base.js';
-import { QNAWidgetConfig } from './types.js';
-/**
- * Contextual Q&A action buttons for product pages.
- * Renders quick-action buttons that open the chat widget with a pre-built query.
- *
- * @example
- * ```ts
- * import { GengageQNA, wireQNAToChat, bootstrapSession } from '@gengage/assistant-fe';
- *
- * const qna = new GengageQNA();
- * await qna.init({
- *   accountId: 'mystore',
- *   middlewareUrl: '<backend service location provided for your Gengage account>',
- *   mountTarget: '#qna-section',
- *   pageContext: { pageType: 'pdp', sku: '12345' },
- *   session: { sessionId: bootstrapSession() },
- * });
- * wireQNAToChat(); // Wire button clicks to chat.openWithAction()
- * ```
- */
-export declare class GengageQNA extends BaseWidget<QNAWidgetConfig> {
-    private _abortController;
-    private _debounceTimer;
-    private _contentEl;
-    private _lastSku;
-    private _i18n;
-    protected onInit(config: QNAWidgetConfig): Promise<void>;
-    protected onUpdate(context: Partial<PageContext>): void;
-    protected onShow(): void;
-    protected onHide(): void;
-    protected onDestroy(): void;
-    private _abort;
-    /** `headerTitle` wins over deprecated `headingTitle`. */
-    private _resolvedQnaHeaderTitle;
-    /** Clean up TextInput placeholder rotation timers to prevent interval leaks. */
-    private _cleanupTextInputTimers;
-    private _fetchAndRender;
-    private _createLoadingIndicator;
-    private _resolveI18n;
-    private _createChrome;
-    private _resolveUISpecRegistry;
-    private _renderUISpec;
-    private _specIncludesType;
-    private _buildFallbackActionsSpec;
-    /**
-     * Free-text field when the launcher stream has no TextInput. Sits above the pills by
-     * default; set `inputAfterPills: true` in config to place it after.
-     */
-    private _insertStandaloneInputBeforePills;
-    private _appendStandaloneInput;
-    private _handleAction;
-    private _handleOpenChat;
-    private _showTransitionIndicator;
-    _actionHandler: (action: ActionPayload) => void;
-    _openChatHandler: () => void;
-}
-export declare function createQNAWidget(): GengageQNA;
-export type { QNAWidgetConfig, QNAUIComponents, QNAI18n, QNAChromeLayout, QNAChromeConfig, QNAUISpecRenderContext, QNARendererConfig, } from './types.js';
-export { renderQnaUISpec, createDefaultQnaUISpecRegistry, defaultQnaUnknownUISpecRenderer, } from './components/renderUISpec.js';
-export type { QNAUISpecRegistry } from './components/renderUISpec.js';

package/dist/qna/types.d.ts

@@ -1,98 +0,0 @@
-import { BaseWidgetConfig, ActionPayload } from '../common/types.js';
-import { UISpecRendererOverrides } from '../common/renderer/index.js';
-export interface QNAWidgetConfig extends BaseWidgetConfig {
-    /** Where to mount the QNA buttons container. Required. */
-    mountTarget: HTMLElement | string;
-    /** Optional SDK-owned outer chrome for merchant PDP prompts. Defaults to no chrome. */
-    chrome?: QNAChromeConfig;
-    /** CTA label for the "open chat" pill/button (default: 'Ask something else'). */
-    ctaText?: string;
-    /** Hide the CTA button inside the quick-question button row.
-     *  Useful when a TextInput is already visible and the CTA would be redundant. */
-    hideButtonRowCta?: boolean;
-    /** Placeholder text cycling inside the free-text input.
-     *  Set to `true` to use fetched action titles as rotating placeholders. */
-    inputPlaceholder?: string | string[] | true;
-    /** When true, the standalone input is placed after the question pills instead of before them. */
-    inputAfterPills?: boolean;
-    /** Locale key for SDK defaults (for example 'tr', 'en'). */
-    locale?: string;
-    i18n?: Partial<QNAI18n>;
-    renderer?: QNARendererConfig;
-    /** Show a static question above the rotating buttons. */
-    showStaticQuestion?: boolean;
-    staticQuestionText?: string;
-    /**
-     * Title above the Q&A module (e.g. "Koçtaş'a Sor", "Teknosa'ya Sor").
-     * When set, overrides the stream `QuestionHeading` text from the backend.
-     * Overlay defaults: `qna.headerTitle` → `qna.headingTitle` (deprecated) → `chat.headerTitle`.
-     */
-    headerTitle?: string;
-    /**
-     * @deprecated Use `headerTitle` — same behavior.
-     */
-    headingTitle?: string;
-    /** Called when a QNA action button is clicked. */
-    onActionSelected?: (action: ActionPayload) => void;
-    /** Called when the open-chat CTA is clicked. */
-    onOpenChat?: () => void;
-}
-export interface QNAI18n {
-    quickQuestionsAriaLabel: string;
-    askQuestionAriaLabel: string;
-    defaultInputPlaceholder: string;
-    sendButton: string;
-    sendQuestionAriaLabel: string;
-    defaultCtaText: string;
-    redirectingToChat: string;
-    /**
-     * Replaces the standalone backend “similar products” hero with this quick question pill
-     * (user_message, not findSimilar).
-     */
-    productContextQuickPillLabel: string;
-}
-export type QNAChromeLayout = 'default' | 'side-image';
-export interface QNAChromeConfig {
-    /** Optional chrome layout. `side-image` keeps the QNA body in the content column beside the image. */
-    layout?: QNAChromeLayout;
-    title?: string;
-    subtitle?: string;
-    imageUrl?: string;
-    imageAlt?: string;
-    /** Optional CSS padding value applied to the chrome image. */
-    imagePadding?: string;
-    startButtonLabel?: string;
-}
-export interface QNAUISpecRenderContext {
-    onAction: (action: ActionPayload) => void;
-    onOpenChat?: () => void;
-    ctaText?: string;
-    inputPlaceholder?: string | string[];
-    i18n: QNAI18n;
-    /** When set (from `QNAWidgetConfig.headerTitle` / `headingTitle`), replaces QuestionHeading `text` from the stream. */
-    headingTitleOverride?: string;
-}
-export type QNARendererConfig = UISpecRendererOverrides<QNAUISpecRenderContext>;
-export interface QNAUIComponents {
-    /** A single QNA action button. */
-    ActionButton: {
-        label: string;
-        action: ActionPayload;
-        /** Visual variant for the button. */
-        variant?: 'primary' | 'outline' | 'ghost';
-    };
-    /** The container holding all action buttons. */
-    ButtonRow: {
-        orientation?: 'horizontal' | 'vertical';
-        wrap?: boolean;
-    };
-    /** Free-text input field with rotating placeholder text. */
-    TextInput: {
-        placeholder?: string | string[];
-        ctaLabel?: string;
-    };
-    /** A heading or label above the buttons. */
-    QuestionHeading: {
-        text: string;
-    };
-}