pika-shared 1.4.0 → 1.4.2

package/dist/types/chatbot/webcomp-types.d.mts

@@ -0,0 +1,326 @@
+import { UploadStatus } from '../upload-types.mjs';
+import { ShowToastFn, ChatUser, RecordOrUndef, UserAwsCredentials, WidgetRenderingContextType, ShareSessionState, UserPrefs, ChatAppMode, IUserWidgetDataStoreState, CustomDataUiRepresentation, ChatAppOverridableFeatures, TagDefinition, TagDefinitionWidget, ChatSession, UserDataOverrideSettings, ChatMessageForRendering, ChatApp, InvokeAgentAsComponentOptions, WidgetMetadata, WidgetAction } from './chatbot-types.mjs';
+import '@aws-sdk/client-bedrock-agent-runtime';
+import '@aws-sdk/client-bedrock-agentcore';
+
+/**
+ * Note!!! The interfaces in this file are meant to expose public functionality to the web component authors.
+ * They are not meant to be exhaustive or complete.
+ */
+
+type SidebarState = any;
+type Snippet = any;
+/** Declare global event map for pika context request */
+declare global {
+    interface HTMLElementEventMap {
+        'pika-wc-context-request': PikaWCContextRequestEvent;
+    }
+}
+interface IIdentityState {
+    readonly fullName: string;
+    readonly initials: string;
+    readonly user: ChatUser<RecordOrUndef>;
+    readonly isSiteAdmin: boolean;
+    readonly isInternalUser: boolean;
+    readonly isContentAdmin: boolean;
+    getUserAwsCredentials(): Promise<UserAwsCredentials | undefined>;
+}
+interface IAppState {
+    readonly showToast: ShowToastFn;
+    readonly identity: IIdentityState;
+    readonly isMobile: boolean;
+}
+/**
+ * Widget Metadata API - scoped to a specific widget instance.
+ * Returned by getWidgetMetadataAPI() and bound to the widget's instanceId.
+ *
+ * This API allows widgets to register and update their display metadata (title and actions)
+ * which the parent app uses to render context-appropriate chrome.
+ *
+ * @example
+ * ```js
+ * const ctx = await getPikaContext($host());
+ * const metadata = ctx.chatAppState.getWidgetMetadataAPI('weather', 'favorite-cities', ctx.instanceId, ctx.renderingContext);
+ *
+ * metadata.setMetadata({
+ *   title: 'Favorite Cities',
+ *   actions: [
+ *     { id: 'refresh', title: 'Refresh', iconSvg: '<svg>...</svg>', callback: () => refresh() }
+ *   ]
+ * });
+ * ```
+ */
+interface IWidgetMetadataAPI {
+    /**
+     * Register or update complete metadata (title and actions).
+     * Replaces any previously registered metadata for this widget instance.
+     *
+     * @param metadata - The metadata to register
+     *
+     * @example
+     * ```js
+     * metadata.setMetadata({
+     *   title: 'Weather Comparison',
+     *   actions: [
+     *     { id: 'refresh', title: 'Refresh', iconSvg: '<svg>...</svg>', callback: () => refresh() },
+     *     { id: 'settings', title: 'Settings', iconSvg: '<svg>...</svg>', callback: () => showSettings() }
+     *   ]
+     * });
+     * ```
+     */
+    setMetadata(metadata: WidgetMetadata): void;
+    /**
+     * Update just the widget title without affecting actions.
+     *
+     * @param title - The new title
+     *
+     * @example
+     * ```js
+     * metadata.updateTitle(`Temperature Trend - ${newCity}`);
+     * ```
+     */
+    updateTitle(title: string): void;
+    /**
+     * Update a specific action's properties (e.g., disable/enable).
+     * Only updates the properties provided in `updates`.
+     *
+     * @param actionId - The ID of the action to update
+     * @param updates - Partial properties to update (cannot change id or callback)
+     *
+     * @example
+     * ```js
+     * // Disable the refresh button during loading
+     * metadata.updateAction('refresh', { disabled: true });
+     *
+     * // Re-enable it after loading
+     * metadata.updateAction('refresh', { disabled: false });
+     * ```
+     */
+    updateAction(actionId: string, updates: Partial<Omit<WidgetAction, 'id' | 'callback'>>): void;
+    /**
+     * Add a new action button dynamically.
+     *
+     * @param action - The action to add
+     *
+     * @example
+     * ```js
+     * if (userHasPremium) {
+     *   metadata.addAction({
+     *     id: 'export',
+     *     title: 'Export data',
+     *     iconSvg: '<svg>...</svg>',
+     *     callback: () => exportData()
+     *   });
+     * }
+     * ```
+     */
+    addAction(action: WidgetAction): void;
+    /**
+     * Remove an action button.
+     *
+     * @param actionId - The ID of the action to remove
+     *
+     * @example
+     * ```js
+     * metadata.removeAction('export');
+     * ```
+     */
+    removeAction(actionId: string): void;
+    /**
+     * Set the loading status for the widget.
+     *
+     * @param loading - Whether the widget is loading
+     * @param loadingMsg - The message to display while loading
+     *
+     * @example
+     * ```js
+     * metadata.setLoadingStatus(true, 'Loading...');
+     * ```
+     */
+    setLoadingStatus(loading: boolean, loadingMsg?: string): void;
+}
+interface IChatAppState {
+    readonly entityFeatureEnabled: boolean;
+    readonly shareCurrentSessionState: ShareSessionState;
+    readonly showToast: ShowToastFn;
+    readonly userPrefs: IUserPrefsState;
+    readonly mode: ChatAppMode;
+    /**
+     * Get component-specific storage scoped to this component (scope.tag) and current user.
+     * Max 400KB per component.
+     */
+    getUserWidgetDataStoreState(scope: string, tag: string): IUserWidgetDataStoreState;
+    readonly customDataUiRepresentation: CustomDataUiRepresentation | undefined;
+    readonly features: ChatAppOverridableFeatures;
+    readonly tagDefs: TagDefinition<TagDefinitionWidget>[];
+    readonly userIsContentAdmin: boolean;
+    readonly userNeedsToProvideDataOverrides: boolean;
+    readonly isViewingContentForAnotherUser: boolean;
+    readonly currentSessionIsSharedBySomeoneElse: boolean;
+    readonly currentShareId: string | undefined;
+    readonly currentSessionIsReadOnly: boolean;
+    readonly sortedChatSessions: ChatSession<RecordOrUndef>[];
+    readonly userDataOverrideSettings: UserDataOverrideSettings;
+    readonly enableFileUpload: boolean;
+    readonly chatSessions: ChatSession<RecordOrUndef>[];
+    readonly waitingForFirstStreamedResponse: boolean;
+    readonly isStreamingResponseNow: boolean;
+    readonly isInterimSession: boolean;
+    readonly currentSession: ChatSession<RecordOrUndef>;
+    readonly currentSessionMessages: ChatMessageForRendering[];
+    readonly inputFiles: IUploadInstance[];
+    readonly newSession: boolean;
+    readonly chatInput: string;
+    readonly chatApp: ChatApp;
+    readonly retrievingMessages: boolean;
+    readonly pageTitle: string | undefined;
+    setCurrentSessionById(sessionId: string): void;
+    removeFile(s3Key: string): void;
+    startNewChatSession(): void;
+    refreshChatSessions(): Promise<void>;
+    downloadFile(s3Key: string): Promise<void>;
+    refreshMessagesForCurrentSession(): Promise<void>;
+    sendMessage(): Promise<void>;
+    getMessageByMessageId(messageId: string): ChatMessageForRendering | undefined;
+    uploadFiles(files: File[]): Promise<void>;
+    initializeData(): Promise<void>;
+    renderTag(tagId: string, context: 'spotlight' | 'inline' | 'dialog' | 'canvas', data?: Record<string, any>): Promise<void>;
+    closeCanvas(): void;
+    closeDialog(): void;
+    /**
+     * Invoke the agent directly from a web component using the 'chat-app-component' invocation mode.
+     * This allows components to make out-of-band requests to the LLM without creating user sessions.
+     *
+     * The component must have a tag definition with `componentAgentInstructionsMd` that
+     * includes instructions for the specified `instructionName`.
+     *
+     * @param scope - The scope of the tag definition (e.g., 'weather')
+     * @param tag - The tag name (e.g., 'favorite-cities')
+     * @param instructionName - The key in the tag definition's componentAgentInstructionsMd
+     * @param userMessage - The message/query to send to the agent
+     * @param options - Optional streaming callbacks and configuration
+     * @returns Promise that resolves to the parsed JSON response from the agent
+     * @throws Error if the request fails or response cannot be parsed
+     *
+     * @example
+     * Simple usage:
+     * ```typescript
+     * const weatherData = await chatAppState.invokeAgentAsComponent<{ temperature: number, condition: string }>(
+     *   'weather',
+     *   'favorite-cities',
+     *   'get-weather',
+     *   'Get current weather for San Francisco'
+     * );
+     * ```
+     *
+     * With streaming callbacks:
+     * ```typescript
+     * const data = await chatAppState.invokeAgentAsComponent<WeatherData>(
+     *   'weather',
+     *   'favorite-cities',
+     *   'get-weather',
+     *   'Get weather for NYC',
+     *   {
+     *     onThinking: (text) => console.log('Thinking:', text),
+     *     onToolCall: (call) => console.log('Calling tool:', call.name)
+     *   }
+     * );
+     * ```
+     */
+    invokeAgentAsComponent<T = any>(scope: string, tag: string, instructionName: string, userMessage: string, options?: InvokeAgentAsComponentOptions): Promise<T>;
+    /**
+     * Get a scoped metadata API for registering widget title and actions.
+     * Call this once during widget initialization to get an API bound to this widget instance.
+     *
+     * The metadata you register will be used by the parent app to render context-appropriate chrome:
+     * - **Spotlight**: Small title bar overlay with icon + title + action menu
+     * - **Canvas**: Full title bar with all action buttons + close
+     * - **Dialog**: Title in header, actions as buttons in footer
+     * - **Inline**: No chrome rendered (widget manages own UI)
+     *
+     * **IMPORTANT**: You MUST pass instanceId and renderingContext from the PikaWCContext.
+     * These values are automatically set during component injection.
+     *
+     * @param scope - Widget scope (e.g., 'weather', 'pika')
+     * @param tag - Widget tag (e.g., 'favorite-cities')
+     * @param instanceId - Unique instance ID from context.instanceId (set during injection)
+     * @param renderingContext - Rendering context from context.renderingContext (set during injection)
+     * @returns Scoped API for this widget instance
+     *
+     * @example
+     * Correct usage (always pass context values):
+     * ```js
+     * const ctx = await getPikaContext($host());
+     * const metadata = ctx.chatAppState.getWidgetMetadataAPI(
+     *   'weather',
+     *   'favorite-cities',
+     *   ctx.instanceId,  // REQUIRED - set during injection
+     *   ctx.renderingContext       // REQUIRED - set during injection
+     * );
+     *
+     * metadata.setMetadata({
+     *   title: 'Favorite Cities',
+     *   actions: [
+     *     {
+     *       id: 'refresh',
+     *       title: 'Refresh weather data',
+     *       lucideIconName: 'refresh-cw',  // MUST be lowercase kebab-case
+     *       callback: async () => {
+     *         loading = true;
+     *         await fetchWeatherData();
+     *         loading = false;
+     *       }
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    getWidgetMetadataAPI(scope: string, tag: string, instanceId: string, renderingContext: WidgetRenderingContextType): IWidgetMetadataAPI;
+}
+interface IUserPrefsState {
+    readonly initialized: boolean;
+    readonly prefs: UserPrefs | undefined;
+    refreshPrefsFromServer(): Promise<void>;
+    getPref<T>(key: string): Promise<T | undefined>;
+    modifyPref(key: string, value: unknown): Promise<void>;
+}
+interface IUploadInstance {
+    readonly s3Key: string;
+    readonly file: File | undefined;
+    readonly fileName: string;
+    readonly size: number;
+    readonly lastModified: number;
+    readonly type: string;
+    readonly xhr: XMLHttpRequest;
+    readonly status: {
+        status: UploadStatus['status'];
+        progress?: number;
+        error?: string;
+    };
+}
+/**
+ * This is the context object that is passed to the web component when it is rendered.
+ */
+interface PikaWCContext {
+    appState: IAppState;
+    renderingContext: WidgetRenderingContextType;
+    chatAppState: IChatAppState;
+    chatAppId: string;
+    /**
+     * Unique instance ID for this component instance.
+     * Set by injectChatAppWebComponent() and used by getWidgetMetadataAPI().
+     */
+    instanceId: string;
+    /** Arbitrary data to be passed to the widget. */
+    dataForWidget: Record<string, any>;
+}
+type PikaWCContextWithoutInstanceId = Omit<PikaWCContext, 'instanceId'>;
+type PikaWCContextRequestCallbackFn = (contextRequest: PikaWCContext) => void;
+interface PikaWCContextRequestDetail {
+    callback: PikaWCContextRequestCallbackFn;
+}
+interface PikaWCContextRequestEvent extends CustomEvent<PikaWCContextRequestDetail> {
+    detail: PikaWCContextRequestDetail;
+}
+
+export type { IAppState, IChatAppState, IIdentityState, IUploadInstance, IUserPrefsState, IWidgetMetadataAPI, PikaWCContext, PikaWCContextRequestCallbackFn, PikaWCContextRequestDetail, PikaWCContextRequestEvent, PikaWCContextWithoutInstanceId, SidebarState, Snippet };

package/dist/types/chatbot/webcomp-types.d.ts

@@ -0,0 +1,326 @@
+import { UploadStatus } from '../upload-types.js';
+import { ShowToastFn, ChatUser, RecordOrUndef, UserAwsCredentials, WidgetRenderingContextType, ShareSessionState, UserPrefs, ChatAppMode, IUserWidgetDataStoreState, CustomDataUiRepresentation, ChatAppOverridableFeatures, TagDefinition, TagDefinitionWidget, ChatSession, UserDataOverrideSettings, ChatMessageForRendering, ChatApp, InvokeAgentAsComponentOptions, WidgetMetadata, WidgetAction } from './chatbot-types.js';
+import '@aws-sdk/client-bedrock-agent-runtime';
+import '@aws-sdk/client-bedrock-agentcore';
+
+/**
+ * Note!!! The interfaces in this file are meant to expose public functionality to the web component authors.
+ * They are not meant to be exhaustive or complete.
+ */
+
+type SidebarState = any;
+type Snippet = any;
+/** Declare global event map for pika context request */
+declare global {
+    interface HTMLElementEventMap {
+        'pika-wc-context-request': PikaWCContextRequestEvent;
+    }
+}
+interface IIdentityState {
+    readonly fullName: string;
+    readonly initials: string;
+    readonly user: ChatUser<RecordOrUndef>;
+    readonly isSiteAdmin: boolean;
+    readonly isInternalUser: boolean;
+    readonly isContentAdmin: boolean;
+    getUserAwsCredentials(): Promise<UserAwsCredentials | undefined>;
+}
+interface IAppState {
+    readonly showToast: ShowToastFn;
+    readonly identity: IIdentityState;
+    readonly isMobile: boolean;
+}
+/**
+ * Widget Metadata API - scoped to a specific widget instance.
+ * Returned by getWidgetMetadataAPI() and bound to the widget's instanceId.
+ *
+ * This API allows widgets to register and update their display metadata (title and actions)
+ * which the parent app uses to render context-appropriate chrome.
+ *
+ * @example
+ * ```js
+ * const ctx = await getPikaContext($host());
+ * const metadata = ctx.chatAppState.getWidgetMetadataAPI('weather', 'favorite-cities', ctx.instanceId, ctx.renderingContext);
+ *
+ * metadata.setMetadata({
+ *   title: 'Favorite Cities',
+ *   actions: [
+ *     { id: 'refresh', title: 'Refresh', iconSvg: '<svg>...</svg>', callback: () => refresh() }
+ *   ]
+ * });
+ * ```
+ */
+interface IWidgetMetadataAPI {
+    /**
+     * Register or update complete metadata (title and actions).
+     * Replaces any previously registered metadata for this widget instance.
+     *
+     * @param metadata - The metadata to register
+     *
+     * @example
+     * ```js
+     * metadata.setMetadata({
+     *   title: 'Weather Comparison',
+     *   actions: [
+     *     { id: 'refresh', title: 'Refresh', iconSvg: '<svg>...</svg>', callback: () => refresh() },
+     *     { id: 'settings', title: 'Settings', iconSvg: '<svg>...</svg>', callback: () => showSettings() }
+     *   ]
+     * });
+     * ```
+     */
+    setMetadata(metadata: WidgetMetadata): void;
+    /**
+     * Update just the widget title without affecting actions.
+     *
+     * @param title - The new title
+     *
+     * @example
+     * ```js
+     * metadata.updateTitle(`Temperature Trend - ${newCity}`);
+     * ```
+     */
+    updateTitle(title: string): void;
+    /**
+     * Update a specific action's properties (e.g., disable/enable).
+     * Only updates the properties provided in `updates`.
+     *
+     * @param actionId - The ID of the action to update
+     * @param updates - Partial properties to update (cannot change id or callback)
+     *
+     * @example
+     * ```js
+     * // Disable the refresh button during loading
+     * metadata.updateAction('refresh', { disabled: true });
+     *
+     * // Re-enable it after loading
+     * metadata.updateAction('refresh', { disabled: false });
+     * ```
+     */
+    updateAction(actionId: string, updates: Partial<Omit<WidgetAction, 'id' | 'callback'>>): void;
+    /**
+     * Add a new action button dynamically.
+     *
+     * @param action - The action to add
+     *
+     * @example
+     * ```js
+     * if (userHasPremium) {
+     *   metadata.addAction({
+     *     id: 'export',
+     *     title: 'Export data',
+     *     iconSvg: '<svg>...</svg>',
+     *     callback: () => exportData()
+     *   });
+     * }
+     * ```
+     */
+    addAction(action: WidgetAction): void;
+    /**
+     * Remove an action button.
+     *
+     * @param actionId - The ID of the action to remove
+     *
+     * @example
+     * ```js
+     * metadata.removeAction('export');
+     * ```
+     */
+    removeAction(actionId: string): void;
+    /**
+     * Set the loading status for the widget.
+     *
+     * @param loading - Whether the widget is loading
+     * @param loadingMsg - The message to display while loading
+     *
+     * @example
+     * ```js
+     * metadata.setLoadingStatus(true, 'Loading...');
+     * ```
+     */
+    setLoadingStatus(loading: boolean, loadingMsg?: string): void;
+}
+interface IChatAppState {
+    readonly entityFeatureEnabled: boolean;
+    readonly shareCurrentSessionState: ShareSessionState;
+    readonly showToast: ShowToastFn;
+    readonly userPrefs: IUserPrefsState;
+    readonly mode: ChatAppMode;
+    /**
+     * Get component-specific storage scoped to this component (scope.tag) and current user.
+     * Max 400KB per component.
+     */
+    getUserWidgetDataStoreState(scope: string, tag: string): IUserWidgetDataStoreState;
+    readonly customDataUiRepresentation: CustomDataUiRepresentation | undefined;
+    readonly features: ChatAppOverridableFeatures;
+    readonly tagDefs: TagDefinition<TagDefinitionWidget>[];
+    readonly userIsContentAdmin: boolean;
+    readonly userNeedsToProvideDataOverrides: boolean;
+    readonly isViewingContentForAnotherUser: boolean;
+    readonly currentSessionIsSharedBySomeoneElse: boolean;
+    readonly currentShareId: string | undefined;
+    readonly currentSessionIsReadOnly: boolean;
+    readonly sortedChatSessions: ChatSession<RecordOrUndef>[];
+    readonly userDataOverrideSettings: UserDataOverrideSettings;
+    readonly enableFileUpload: boolean;
+    readonly chatSessions: ChatSession<RecordOrUndef>[];
+    readonly waitingForFirstStreamedResponse: boolean;
+    readonly isStreamingResponseNow: boolean;
+    readonly isInterimSession: boolean;
+    readonly currentSession: ChatSession<RecordOrUndef>;
+    readonly currentSessionMessages: ChatMessageForRendering[];
+    readonly inputFiles: IUploadInstance[];
+    readonly newSession: boolean;
+    readonly chatInput: string;
+    readonly chatApp: ChatApp;
+    readonly retrievingMessages: boolean;
+    readonly pageTitle: string | undefined;
+    setCurrentSessionById(sessionId: string): void;
+    removeFile(s3Key: string): void;
+    startNewChatSession(): void;
+    refreshChatSessions(): Promise<void>;
+    downloadFile(s3Key: string): Promise<void>;
+    refreshMessagesForCurrentSession(): Promise<void>;
+    sendMessage(): Promise<void>;
+    getMessageByMessageId(messageId: string): ChatMessageForRendering | undefined;
+    uploadFiles(files: File[]): Promise<void>;
+    initializeData(): Promise<void>;
+    renderTag(tagId: string, context: 'spotlight' | 'inline' | 'dialog' | 'canvas', data?: Record<string, any>): Promise<void>;
+    closeCanvas(): void;
+    closeDialog(): void;
+    /**
+     * Invoke the agent directly from a web component using the 'chat-app-component' invocation mode.
+     * This allows components to make out-of-band requests to the LLM without creating user sessions.
+     *
+     * The component must have a tag definition with `componentAgentInstructionsMd` that
+     * includes instructions for the specified `instructionName`.
+     *
+     * @param scope - The scope of the tag definition (e.g., 'weather')
+     * @param tag - The tag name (e.g., 'favorite-cities')
+     * @param instructionName - The key in the tag definition's componentAgentInstructionsMd
+     * @param userMessage - The message/query to send to the agent
+     * @param options - Optional streaming callbacks and configuration
+     * @returns Promise that resolves to the parsed JSON response from the agent
+     * @throws Error if the request fails or response cannot be parsed
+     *
+     * @example
+     * Simple usage:
+     * ```typescript
+     * const weatherData = await chatAppState.invokeAgentAsComponent<{ temperature: number, condition: string }>(
+     *   'weather',
+     *   'favorite-cities',
+     *   'get-weather',
+     *   'Get current weather for San Francisco'
+     * );
+     * ```
+     *
+     * With streaming callbacks:
+     * ```typescript
+     * const data = await chatAppState.invokeAgentAsComponent<WeatherData>(
+     *   'weather',
+     *   'favorite-cities',
+     *   'get-weather',
+     *   'Get weather for NYC',
+     *   {
+     *     onThinking: (text) => console.log('Thinking:', text),
+     *     onToolCall: (call) => console.log('Calling tool:', call.name)
+     *   }
+     * );
+     * ```
+     */
+    invokeAgentAsComponent<T = any>(scope: string, tag: string, instructionName: string, userMessage: string, options?: InvokeAgentAsComponentOptions): Promise<T>;
+    /**
+     * Get a scoped metadata API for registering widget title and actions.
+     * Call this once during widget initialization to get an API bound to this widget instance.
+     *
+     * The metadata you register will be used by the parent app to render context-appropriate chrome:
+     * - **Spotlight**: Small title bar overlay with icon + title + action menu
+     * - **Canvas**: Full title bar with all action buttons + close
+     * - **Dialog**: Title in header, actions as buttons in footer
+     * - **Inline**: No chrome rendered (widget manages own UI)
+     *
+     * **IMPORTANT**: You MUST pass instanceId and renderingContext from the PikaWCContext.
+     * These values are automatically set during component injection.
+     *
+     * @param scope - Widget scope (e.g., 'weather', 'pika')
+     * @param tag - Widget tag (e.g., 'favorite-cities')
+     * @param instanceId - Unique instance ID from context.instanceId (set during injection)
+     * @param renderingContext - Rendering context from context.renderingContext (set during injection)
+     * @returns Scoped API for this widget instance
+     *
+     * @example
+     * Correct usage (always pass context values):
+     * ```js
+     * const ctx = await getPikaContext($host());
+     * const metadata = ctx.chatAppState.getWidgetMetadataAPI(
+     *   'weather',
+     *   'favorite-cities',
+     *   ctx.instanceId,  // REQUIRED - set during injection
+     *   ctx.renderingContext       // REQUIRED - set during injection
+     * );
+     *
+     * metadata.setMetadata({
+     *   title: 'Favorite Cities',
+     *   actions: [
+     *     {
+     *       id: 'refresh',
+     *       title: 'Refresh weather data',
+     *       lucideIconName: 'refresh-cw',  // MUST be lowercase kebab-case
+     *       callback: async () => {
+     *         loading = true;
+     *         await fetchWeatherData();
+     *         loading = false;
+     *       }
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    getWidgetMetadataAPI(scope: string, tag: string, instanceId: string, renderingContext: WidgetRenderingContextType): IWidgetMetadataAPI;
+}
+interface IUserPrefsState {
+    readonly initialized: boolean;
+    readonly prefs: UserPrefs | undefined;
+    refreshPrefsFromServer(): Promise<void>;
+    getPref<T>(key: string): Promise<T | undefined>;
+    modifyPref(key: string, value: unknown): Promise<void>;
+}
+interface IUploadInstance {
+    readonly s3Key: string;
+    readonly file: File | undefined;
+    readonly fileName: string;
+    readonly size: number;
+    readonly lastModified: number;
+    readonly type: string;
+    readonly xhr: XMLHttpRequest;
+    readonly status: {
+        status: UploadStatus['status'];
+        progress?: number;
+        error?: string;
+    };
+}
+/**
+ * This is the context object that is passed to the web component when it is rendered.
+ */
+interface PikaWCContext {
+    appState: IAppState;
+    renderingContext: WidgetRenderingContextType;
+    chatAppState: IChatAppState;
+    chatAppId: string;
+    /**
+     * Unique instance ID for this component instance.
+     * Set by injectChatAppWebComponent() and used by getWidgetMetadataAPI().
+     */
+    instanceId: string;
+    /** Arbitrary data to be passed to the widget. */
+    dataForWidget: Record<string, any>;
+}
+type PikaWCContextWithoutInstanceId = Omit<PikaWCContext, 'instanceId'>;
+type PikaWCContextRequestCallbackFn = (contextRequest: PikaWCContext) => void;
+interface PikaWCContextRequestDetail {
+    callback: PikaWCContextRequestCallbackFn;
+}
+interface PikaWCContextRequestEvent extends CustomEvent<PikaWCContextRequestDetail> {
+    detail: PikaWCContextRequestDetail;
+}
+
+export type { IAppState, IChatAppState, IIdentityState, IUploadInstance, IUserPrefsState, IWidgetMetadataAPI, PikaWCContext, PikaWCContextRequestCallbackFn, PikaWCContextRequestDetail, PikaWCContextRequestEvent, PikaWCContextWithoutInstanceId, SidebarState, Snippet };

package/dist/types/chatbot/webcomp-types.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=webcomp-types.js.map
+//# sourceMappingURL=webcomp-types.js.map

package/dist/types/chatbot/webcomp-types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"webcomp-types.js"}

package/dist/types/chatbot/webcomp-types.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=webcomp-types.mjs.map
+//# sourceMappingURL=webcomp-types.mjs.map

package/dist/types/chatbot/webcomp-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"webcomp-types.mjs"}