@luzmo/analytics-components-kit 1.0.3-beta.4 → 1.0.3-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luzmo/analytics-components-kit",
-  "version": "1.0.3-beta.4",
+  "version": "1.0.3-beta.6",
   "type": "module",
   "main": "./components/index.js",
   "module": "./components/index.js",
@@ -309,7 +309,7 @@
     "@lit/react": "^1.0.6",
     "@lit/task": "^1.0.1",
     "@luzmo/icons": "^1.0.1-alpha.33",
-    "@luzmo/lucero": "^1.0.1-alpha.77",
+    "@luzmo/lucero": "^1.0.1-alpha.78",
     "colorjs.io": "^0.5.2",
     "lit": "^3.3.1",
     "react": "^18.0.0 || ^19.0.0",

package/react/components/ai-chat/stream/index.ts

@@ -0,0 +1 @@
+export * from './types';

package/react/components/ai-chat/stream/types.ts

@@ -0,0 +1,29 @@
+import type { ProgressTreeNode } from '@luzmo/lucero/progress-steps';
+import type { AiSampleChart, ChatMessage } from '../../../types';
+import type { DashboardStatePayload, LuzmoDashboardGeneratedEventDetail } from '../ai-prompt-types';
+
+export interface StreamHandlerCallbacks {
+  onConversationIdChange: (conversationId: string) => void;
+  onProgress: (progress: ProgressTreeNode) => void;
+  onProgressCollapsed: (collapsed: boolean) => void;
+  onMessageUpdate: (message: ChatMessage) => void;
+  dispatchChartGenerated: (detail: AiSampleChart) => void;
+  dispatchDashboardGenerated: (detail: LuzmoDashboardGeneratedEventDetail) => void;
+  dispatchResponseReceived: (message: ChatMessage, done: boolean) => void;
+  getConversationId: () => string | null;
+}
+
+export interface StreamHandlerState {
+  progressCollapsed: boolean;
+  dashboardSnapshot: DashboardStatePayload | null;
+  dashboardName: Record<string, string> | undefined;
+  interruptQuestion: string | null;
+  /** Latest item chart payload from streaming `asset_delta` events (aiprompt item agent). */
+  itemSnapshot: Record<string, unknown> | null;
+}
+
+export interface StreamHandlerContext {
+  aiMessage: ChatMessage;
+  callbacks: StreamHandlerCallbacks;
+  state: StreamHandlerState;
+}

package/react/components/ai-chat.component.ts

@@ -7,33 +7,33 @@ const LuzmoAiChatComponent = createComponent({
   elementClass: LuzmoAiChatClass,
   react: React,
   events: {
-    onLuzmoResponseReceived: 'luzmo-response-received' as EventName<CustomEvent>,
-    onLuzmoChartGenerated: 'luzmo-chart-generated' as EventName<CustomEvent>,
     onLuzmoMessageSent: 'luzmo-message-sent' as EventName<CustomEvent>,
-    onLuzmoRestoreRequested: 'luzmo-restore-requested' as EventName<CustomEvent>,
     onLuzmoDatasetsChanged: 'luzmo-datasets-changed' as EventName<CustomEvent>,
-    onLuzmoPromptSubmitted: 'luzmo-prompt-submitted' as EventName<CustomEvent>
+    onLuzmoChartGenerated: 'luzmo-chart-generated' as EventName<CustomEvent>,
+    onLuzmoDashboardGenerated: 'luzmo-dashboard-generated' as EventName<CustomEvent>,
+    onLuzmoResponseReceived: 'luzmo-response-received' as EventName<CustomEvent>,
+    onLuzmoConversationIdChanged: 'luzmo-conversation-id-changed' as EventName<CustomEvent>
   }
 });
 
 /**
  * React wrapper for <luzmo-ai-chat>
  *
- * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
- * @event onLuzmoChartGenerated - Fired when the AI generates a chart (includes generatedChart in response)
  * @event onLuzmoMessageSent - Fired when a user sends a message
- * @event onLuzmoRestoreRequested - Fired when a restore action is triggered in external mode
- * @event onLuzmoPromptSubmitted - Fired when request-mode is set to external so the host can execute the API request lifecycle.
+ * @event onLuzmoChartGenerated - Fired when agent is `item` and a chart asset is ready
+ * @event onLuzmoDashboardGenerated - Fired when agent is `dashboard` and a dashboard asset is ready
+ * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
+ * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  */
 export const LuzmoAiChat = LuzmoAiChatComponent as ReactWebComponent<
   LuzmoAiChatClass,
   {
-    onLuzmoResponseReceived: EventName<CustomEvent>;
-    onLuzmoChartGenerated: EventName<CustomEvent>;
     onLuzmoMessageSent: EventName<CustomEvent>;
-    onLuzmoRestoreRequested: EventName<CustomEvent>;
     onLuzmoDatasetsChanged: EventName<CustomEvent>;
-    onLuzmoPromptSubmitted: EventName<CustomEvent>;
+    onLuzmoChartGenerated: EventName<CustomEvent>;
+    onLuzmoDashboardGenerated: EventName<CustomEvent>;
+    onLuzmoResponseReceived: EventName<CustomEvent>;
+    onLuzmoConversationIdChanged: EventName<CustomEvent>;
   }
 >;
 

package/react/esm/components/ai-chat/stream/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/react/esm/components/ai-chat/stream/index.js

@@ -0,0 +1 @@
+export * from './types';

package/react/esm/components/ai-chat/stream/types.d.ts

@@ -0,0 +1,26 @@
+import type { ProgressTreeNode } from '@luzmo/lucero/progress-steps';
+import type { AiSampleChart, ChatMessage } from '../../../types';
+import type { DashboardStatePayload, LuzmoDashboardGeneratedEventDetail } from '../ai-prompt-types';
+export interface StreamHandlerCallbacks {
+    onConversationIdChange: (conversationId: string) => void;
+    onProgress: (progress: ProgressTreeNode) => void;
+    onProgressCollapsed: (collapsed: boolean) => void;
+    onMessageUpdate: (message: ChatMessage) => void;
+    dispatchChartGenerated: (detail: AiSampleChart) => void;
+    dispatchDashboardGenerated: (detail: LuzmoDashboardGeneratedEventDetail) => void;
+    dispatchResponseReceived: (message: ChatMessage, done: boolean) => void;
+    getConversationId: () => string | null;
+}
+export interface StreamHandlerState {
+    progressCollapsed: boolean;
+    dashboardSnapshot: DashboardStatePayload | null;
+    dashboardName: Record<string, string> | undefined;
+    interruptQuestion: string | null;
+    /** Latest item chart payload from streaming `asset_delta` events (aiprompt item agent). */
+    itemSnapshot: Record<string, unknown> | null;
+}
+export interface StreamHandlerContext {
+    aiMessage: ChatMessage;
+    callbacks: StreamHandlerCallbacks;
+    state: StreamHandlerState;
+}

package/react/esm/components/ai-chat/stream/types.js

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

package/react/esm/components/ai-chat.component.d.ts

@@ -3,19 +3,19 @@ import { LuzmoAiChat as LuzmoAiChatClass } from '@luzmo/analytics-components-kit
 /**
  * React wrapper for <luzmo-ai-chat>
  *
- * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
- * @event onLuzmoChartGenerated - Fired when the AI generates a chart (includes generatedChart in response)
  * @event onLuzmoMessageSent - Fired when a user sends a message
- * @event onLuzmoRestoreRequested - Fired when a restore action is triggered in external mode
- * @event onLuzmoPromptSubmitted - Fired when request-mode is set to external so the host can execute the API request lifecycle.
+ * @event onLuzmoChartGenerated - Fired when agent is `item` and a chart asset is ready
+ * @event onLuzmoDashboardGenerated - Fired when agent is `dashboard` and a dashboard asset is ready
+ * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
+ * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  */
 export declare const LuzmoAiChat: ReactWebComponent<LuzmoAiChatClass, {
-    onLuzmoResponseReceived: EventName<CustomEvent>;
-    onLuzmoChartGenerated: EventName<CustomEvent>;
     onLuzmoMessageSent: EventName<CustomEvent>;
-    onLuzmoRestoreRequested: EventName<CustomEvent>;
     onLuzmoDatasetsChanged: EventName<CustomEvent>;
-    onLuzmoPromptSubmitted: EventName<CustomEvent>;
+    onLuzmoChartGenerated: EventName<CustomEvent>;
+    onLuzmoDashboardGenerated: EventName<CustomEvent>;
+    onLuzmoResponseReceived: EventName<CustomEvent>;
+    onLuzmoConversationIdChanged: EventName<CustomEvent>;
 }>;
 /** The underlying custom element type for LuzmoAiChat */
 export type LuzmoAiChatElement = LuzmoAiChatClass;

package/react/esm/components/ai-chat.component.js

@@ -6,21 +6,21 @@ const LuzmoAiChatComponent = createComponent({
     elementClass: LuzmoAiChatClass,
     react: React,
     events: {
-        onLuzmoResponseReceived: 'luzmo-response-received',
-        onLuzmoChartGenerated: 'luzmo-chart-generated',
         onLuzmoMessageSent: 'luzmo-message-sent',
-        onLuzmoRestoreRequested: 'luzmo-restore-requested',
         onLuzmoDatasetsChanged: 'luzmo-datasets-changed',
-        onLuzmoPromptSubmitted: 'luzmo-prompt-submitted'
+        onLuzmoChartGenerated: 'luzmo-chart-generated',
+        onLuzmoDashboardGenerated: 'luzmo-dashboard-generated',
+        onLuzmoResponseReceived: 'luzmo-response-received',
+        onLuzmoConversationIdChanged: 'luzmo-conversation-id-changed'
     }
 });
 /**
  * React wrapper for <luzmo-ai-chat>
  *
- * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
- * @event onLuzmoChartGenerated - Fired when the AI generates a chart (includes generatedChart in response)
  * @event onLuzmoMessageSent - Fired when a user sends a message
- * @event onLuzmoRestoreRequested - Fired when a restore action is triggered in external mode
- * @event onLuzmoPromptSubmitted - Fired when request-mode is set to external so the host can execute the API request lifecycle.
+ * @event onLuzmoChartGenerated - Fired when agent is `item` and a chart asset is ready
+ * @event onLuzmoDashboardGenerated - Fired when agent is `dashboard` and a dashboard asset is ready
+ * @event onLuzmoResponseReceived - Fired when an AI text response is received. For chart responses, this event is only fired if the response includes a `message` field. For error responses, this event is always fired with the error explanation.
+ * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  */
 export const LuzmoAiChat = LuzmoAiChatComponent;

package/types/ai-chat.types.d.ts

@@ -35,7 +35,7 @@ export interface LuzmoChart {
     update?: boolean;
     aichartId?: string;
 }
-export interface AISampleChart {
+export interface AiSampleChart {
     error?: string;
     generatedChart: Record<string, unknown> & {
         feedback: unknown;

package/components/ai-chat/request-contract.d.ts

@@ -1,56 +0,0 @@
-import type { Dataset, LuzmoChart } from '../../types';
-export interface AiMessageRequestBody {
-    key: string;
-    token: string;
-    action: 'create';
-    version: string;
-    properties: {
-        content: {
-            role: 'user';
-            content: string;
-        };
-        conversation_id?: string;
-    };
-    options: {
-        available_datasets: string[];
-        dataset_id?: string;
-        chart?: Record<string, unknown>;
-        model_preference: 'performance' | 'quality';
-        stream?: boolean;
-    };
-}
-export interface AiMessageDeleteRequestBody {
-    key: string;
-    token: string;
-    action: 'delete';
-    version: string;
-    properties: {
-        restore_to_message_id: string;
-    };
-}
-export interface BuildAiMessageRequestOptions {
-    prompt: string;
-    datasetIds: string[];
-    authKey: string;
-    authToken: string;
-    conversationId: string | null;
-    chart: LuzmoChart | null;
-    modelPreference: 'performance' | 'quality';
-    apiVersion?: string;
-    stream?: boolean;
-}
-export interface LuzmoPromptSubmittedEventDetail {
-    prompt: string;
-    selectedDatasets: Dataset[];
-    datasetIds: string[];
-    request: AiMessageRequestBody;
-    url: string;
-}
-export interface LuzmoRestoreRequestedEventDetail {
-    apiMessageId: string;
-    messageIndex: number;
-    request: AiMessageDeleteRequestBody;
-    url: string;
-}
-export declare function buildAiMessageRequest(options: BuildAiMessageRequestOptions): AiMessageRequestBody;
-export declare function buildAiMessageDeleteRequest(restoreToMessageId: string, authKey: string, authToken: string, apiVersion?: string): AiMessageDeleteRequestBody;