@constructor-io/constructorio-ui-pia 2.11.0 → 2.12.0

package/lib/mjs/hooks/mocks/agent.js

@@ -1,173 +0,0 @@
-import { AgentRequestError } from '../../errors';
-// Create URL for PIA API
-function createAgentUrl({ itemId, threadId, variationId, question, isStreaming = false, options, parameters = {}, }) {
-    const { apiKey, agentServiceUrl, clientId, sessionId, userId, segments, version } = options;
-    if (!agentServiceUrl)
-        throw new Error('Agent service URL is required');
-    let baseUrl = `${agentServiceUrl}/v1/item_questions`;
-    if (question) {
-        baseUrl += `/${encodeURIComponent(question)}/answer`;
-    }
-    if (isStreaming) {
-        baseUrl += '/streaming';
-    }
-    const url = new URL(baseUrl);
-    url.searchParams.append('item_id', itemId);
-    url.searchParams.append('key', apiKey);
-    if (threadId) {
-        url.searchParams.append('thread_id', threadId);
-    }
-    if (variationId) {
-        url.searchParams.append('variation_id', variationId);
-    }
-    if (clientId) {
-        url.searchParams.append('i', clientId);
-    }
-    if (sessionId != null) {
-        url.searchParams.append('s', String(sessionId));
-    }
-    if (userId) {
-        url.searchParams.append('ui', userId);
-    }
-    if (version) {
-        url.searchParams.append('c', version);
-    }
-    if (segments?.length) {
-        segments.forEach((segment) => url.searchParams.append('us', segment));
-    }
-    // Any additional parameters
-    Object.entries(parameters).forEach(([key, value]) => {
-        if (value !== undefined) {
-            url.searchParams.append(key, String(value));
-        }
-    });
-    return url.toString();
-}
-// Map camelCase SuggestedQuestionsParameters to snake_case query params expected by the API
-function mapSuggestedQuestionsParams(params) {
-    const result = {};
-    if (params.numResults !== undefined)
-        result.num_results = params.numResults;
-    return result;
-}
-class MockAgent {
-    options;
-    constructor(options) {
-        this.options = options;
-    }
-    async getSuggestedQuestions({ itemId, variationId, threadId, parameters = {}, requestParameters = {}, }) {
-        if (!itemId)
-            throw new Error('Item ID is required');
-        if (!this.options.apiKey)
-            throw new Error('API key is required');
-        const url = createAgentUrl({
-            itemId,
-            variationId,
-            threadId,
-            options: this.options,
-            parameters: { ...requestParameters, ...mapSuggestedQuestionsParams(parameters) },
-        });
-        try {
-            const response = await fetch(url);
-            if (!response.ok)
-                throw new AgentRequestError(response.status);
-            const data = await response.json();
-            return data;
-        }
-        catch (error) {
-            // Rethrow untouched so the status code and the original stack survive.
-            if (error instanceof Error)
-                throw error;
-            throw new Error(String(error));
-        }
-    }
-    async getAnswerResults({ itemId, variationId, threadId, question, parameters = {}, }) {
-        if (!itemId)
-            throw new Error('Item ID is required');
-        if (!question)
-            throw new Error('Question is required');
-        if (!this.options.apiKey)
-            throw new Error('API key is required');
-        const url = createAgentUrl({
-            itemId,
-            threadId,
-            variationId,
-            question,
-            options: this.options,
-            parameters,
-        });
-        try {
-            const response = await fetch(url);
-            if (!response.ok)
-                throw new AgentRequestError(response.status);
-            const data = await response.json();
-            return data;
-        }
-        catch (error) {
-            // Rethrow untouched so the status code and the original stack survive.
-            if (error instanceof Error)
-                throw error;
-            throw new Error(String(error));
-        }
-    }
-    /**
-     * Fetches one set of recommendations, in the shape the pod renders.
-     *
-     * Recommendations are not available yet: there is no endpoint to ask, so nothing is requested and
-     * an empty result is returned. The pod renders nothing in that state, which leaves whatever the
-     * retailer already had in that slot showing through. Supply a `cioClient` with your own
-     * `agent.getRecs` to drive the pod from your own data in the meantime.
-     *
-     * `props` is still declared, because it is the contract a caller's own `getRecs` implements and
-     * `useRecsPod` passes it - there is simply nothing here to send it to yet.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async getRecs(props) {
-        return { title: '', items: null, refinement: null, status: 'complete' };
-    }
-    async getAnswerResultsStream({ itemId, threadId, variationId, question, parameters, onStart, onMessage, onEnd, }) {
-        if (!itemId)
-            throw new Error('Item ID is required');
-        if (!question)
-            throw new Error('Question is required');
-        if (!this.options.apiKey)
-            throw new Error('API key is required');
-        const url = createAgentUrl({
-            itemId,
-            threadId,
-            variationId,
-            question,
-            isStreaming: true,
-            options: this.options,
-            parameters,
-        });
-        try {
-            const eventSource = new EventSource(url);
-            eventSource.addEventListener('open', (event) => {
-                const data = JSON.parse(event.data);
-                if (onStart)
-                    onStart(data);
-            });
-            eventSource.addEventListener('message', (event) => {
-                const data = JSON.parse(event.data);
-                if (onMessage)
-                    onMessage(data);
-            });
-            eventSource.addEventListener('end', (event) => {
-                const data = JSON.parse(event.data);
-                if (onEnd)
-                    onEnd(data);
-                eventSource.close();
-            });
-            eventSource.onerror = () => {
-                eventSource.close();
-                throw new Error('Unexpected error occurred. Please try again.');
-            };
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            throw new Error(errorMessage);
-        }
-    }
-}
-export default MockAgent;

package/lib/mjs/hooks/mocks/types.js

@@ -1 +0,0 @@
-export {};

package/lib/types/hooks/mocks/MockConstructorIOClient.d.ts

@@ -1,14 +0,0 @@
-import { ConstructorClientOptions } from '@constructor-io/constructorio-client-javascript';
-import { Recommendations, Browse, Search, Tracker, Quizzes } from '@constructor-io/constructorio-client-javascript/lib/types/constructorio';
-import MockAgent from './agent';
-declare class MockConstructorIOClient {
-    options: ConstructorClientOptions;
-    search: Search;
-    browse: Browse;
-    recommendations: Recommendations;
-    tracker: Tracker;
-    quizzes: Quizzes;
-    agent: MockAgent;
-    constructor(options: ConstructorClientOptions);
-}
-export default MockConstructorIOClient;

package/lib/types/hooks/mocks/agent.d.ts

@@ -1,23 +0,0 @@
-import { ConstructorClientOptions } from '@constructor-io/constructorio-client-javascript';
-import { QuestionResponse, GetSuggestedQuestionsProps, GetAnswerResultsStreamProps, GetAnswerResultsProps, GetAnswerResultsResponse } from './types';
-import { GetRecsProps, RecsResult } from '../../types';
-declare class MockAgent {
-    options: ConstructorClientOptions;
-    constructor(options: ConstructorClientOptions);
-    getSuggestedQuestions({ itemId, variationId, threadId, parameters, requestParameters, }: GetSuggestedQuestionsProps): Promise<QuestionResponse>;
-    getAnswerResults({ itemId, variationId, threadId, question, parameters, }: GetAnswerResultsProps): Promise<GetAnswerResultsResponse>;
-    /**
-     * Fetches one set of recommendations, in the shape the pod renders.
-     *
-     * Recommendations are not available yet: there is no endpoint to ask, so nothing is requested and
-     * an empty result is returned. The pod renders nothing in that state, which leaves whatever the
-     * retailer already had in that slot showing through. Supply a `cioClient` with your own
-     * `agent.getRecs` to drive the pod from your own data in the meantime.
-     *
-     * `props` is still declared, because it is the contract a caller's own `getRecs` implements and
-     * `useRecsPod` passes it - there is simply nothing here to send it to yet.
-     */
-    getRecs(props: GetRecsProps): Promise<RecsResult>;
-    getAnswerResultsStream({ itemId, threadId, variationId, question, parameters, onStart, onMessage, onEnd, }: GetAnswerResultsStreamProps): Promise<void>;
-}
-export default MockAgent;

package/lib/types/hooks/mocks/types.d.ts

@@ -1,77 +0,0 @@
-import { ConstructorClientOptions, ItemData } from '@constructor-io/constructorio-client-javascript';
-export type SuggestedQuestionsParameters = {
-    numResults?: number;
-};
-export type AgentUrlProps = {
-    itemId: string;
-    variationId?: string;
-    /** Thread ID for conversation context. Must be a valid UUID (e.g., "550e8400-e29b-41d4-a716-446655440000") */
-    threadId?: string;
-    question?: string;
-    isStreaming?: boolean;
-    options: ConstructorClientOptions;
-    parameters?: Record<string, string | number | boolean>;
-};
-export type GetSuggestedQuestionsProps = {
-    itemId: string;
-    variationId?: string;
-    /** Thread ID for conversation context. Must be a valid UUID (e.g., "550e8400-e29b-41d4-a716-446655440000") */
-    threadId?: string;
-    parameters?: SuggestedQuestionsParameters;
-    /** Extra query parameters appended verbatim to the request (e.g. `ef-*` test cell params). */
-    requestParameters?: Record<string, string | number | boolean>;
-};
-export interface Question {
-    value: string;
-}
-export interface QuestionResponse {
-    questions: Array<Question>;
-}
-export type GetAnswerResultsProps = {
-    itemId: string;
-    variationId?: string;
-    /** Thread ID for conversation context. Must be a valid UUID (e.g., "550e8400-e29b-41d4-a716-446655440000") */
-    threadId?: string;
-    question: string;
-    parameters?: Record<string, any>;
-};
-export type GetAnswerResultsStreamProps = GetAnswerResultsProps & {
-    onStart?: (event: StreamStartEvent) => void;
-    onMessage?: (event: StreamMessageEvent) => void;
-    onEnd?: (event: StreamEndEvent) => void;
-};
-/** Defines loose types for response-related types to account for future changes to API schema */
-export interface ApiItemVariation extends Record<string, any> {
-    value: string;
-    data?: ItemData;
-}
-export interface ApiItem extends Record<string, any> {
-    value: string;
-    matched_terms: Array<string>;
-    data: ItemData;
-    variations?: Array<ApiItemVariation> | null;
-    variations_map?: Record<string, any> | Array<Record<string, any>> | null;
-}
-export interface AnswerItemResults {
-    request?: Record<string, any>;
-    response: {
-        results: Array<ApiItem>;
-    };
-}
-export interface GetAnswerResultsResponse {
-    qna_result_id: string;
-    value: string;
-    item_results?: AnswerItemResults;
-    follow_up_questions?: Array<Question>;
-    thread_id?: string;
-}
-export interface StreamStartEvent {
-    qna_result_id: string;
-}
-export interface StreamMessageEvent {
-    qna_result_id: string;
-    text: string;
-}
-export interface StreamEndEvent {
-    qna_result_id: string;
-}