@connekz/connekz-agent 0.9.0 → 0.12.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@connekz/connekz-agent",
   "private": false,
   "type": "module",
-  "version": "0.9.0",
+  "version": "0.12.0",
   "description": "A package for Connekz clients to integrate Connekz Agent into their applications.",
   "main": "dist/connekz-agent.umd.js",
   "module": "dist/connekz-agent.es.js",
@@ -88,6 +88,7 @@
     "typescript": "~5.8.0",
     "typescript-eslint": "^8.31.1",
     "vite": "^6.2.4",
+    "vite-plugin-dts": "^4.5.4",
     "vite-plugin-vue-devtools": "^7.7.2",
     "vue-tsc": "^2.2.8"
   }

package/types.d.ts

@@ -1,60 +1,110 @@
-// src/index.d.ts
-import 'unfonts.css';
+export type ToolCallPayload = {
+  arguments: Record<string, any>;
+  name: string;
+};
+
+/**
+ * Enum for voice agent statuses
+ */
+export enum VoiceAgentStatus {
+  DISCONNECTED = 'DISCONNECTED',
+  STOPPED = 'STOPPED',
+  INITIATING = 'INITIATING',
+  LISTENING = 'LISTENING',
+  SPEAKING = 'SPEAKING',
+  SLEEPING = 'SLEEPING',
+  USER_SPEAKING = 'USER_SPEAKING',
+  THINKING = 'THINKING',
+  EXECUTING = 'EXECUTING',
+  ERROR = 'ERROR',
+  IDLE = 'IDLE',
+}
 
-// Alias AppProps as ConnekzChatOptions
-export type ConnekzChatOptions = {
-  clientId: string;
-  clientSecret: string;
+export interface ConnekzConversation {
+  role: 'user' | 'ai';
+  message: string;
+  at: string; // ISO date string
+  conversationId: number;
+  forcedDisplay?: boolean; // Whether force to display this message
+}
+
+// Export types for consumers of the package
+export type ConnekzOptions = {
+  clientId: string; // Client ID for the connekz instance
+  clientSecret: string; // Client secret for the connekz instance
+  chatWindow?: {
+    mountElementId: string;
+    disableTalkMode?: boolean;
+    disableChatMode?: boolean;
+  } | undefined;
+  aiSphere?: {
+    mountElementId: string;
+    themeColor?: string;
+  };
+  transcription?: {
+    mountElementId: string;
+  };
+  connekzControls?: {
+    mountElementId: string;
+  }
   userIdentity?: string;
-  baseUrl?: string;
+  baseUrl?: string; // Base URL for the connekz instance
 };
 
-// Define the props interface for App.vue
-export interface AppProps {
-  sampleProperty: string; // Sample property for now
+export type ConnekzAgentStatus = VoiceAgentStatus;
+export type ConnekzTranscript = ConnekzConversation;
+export type ConnekzToolCallPayload = ToolCallPayload;
+
+// New: Subscription types
+export type Unsubscriber = () => void;
+export interface SocketSubscribeAPI {
+  onIsConnectingChange: (cb: (value: boolean) => void) => Unsubscriber;
+  onIsConnectedChange: (cb: (value: boolean) => void) => Unsubscriber;
 }
 
-// Define the emits type for App.vue
-export type AppEmits = {
-  'sample-event': (value: string) => void;
-};
+export interface AgentSubscribeAPI {
+  onAgentStatusChange: (cb: (value: VoiceAgentStatus) => void) => Unsubscriber;
+  onMicStatusChange: (cb: (value: 'active' | 'muted') => void) => Unsubscriber;
+  onUserWaveformUpdate: (cb: (value: number) => void) => Unsubscriber;
+  onAgentWaveformUpdate: (cb: (value: number) => void) => Unsubscriber;
+  onTranscriptUpdate: (cb: (value: readonly ConnekzConversation[]) => void) => Unsubscriber;
+  onToolCall: (cb: (payload: ConnekzToolCallPayload) => Promise<string>) => Unsubscriber;
+}
 
-// Define the exposed functions interface for App.vue
-export interface AppExposed {
-  sampleExposeFunction: (message: string) => void;
+// Headless Socket API exposure (initial values + actions + subs)
+export interface ConnekzSocketAPI {
+  connect: (force?: boolean) => void;
+  disconnect: () => void;
+  cleanup: () => void;
+  subscribe: SocketSubscribeAPI;
 }
 
-// Export types for consumers of the package
-export type { AppProps, AppExposed, AppEmits };
+// Headless Voice Agent API exposure (initial values + actions + subs)
+export interface VoiceAgentAPI {
+  startAgent: () => Promise<void>;
+  stopAgent: () => void;
+  makeSleep: () => void;
+  injectMessage: (messageText: string) => void;
+  startCaptureTest: () => void;
+  stopCaptureTest: () => void;
+  playCapturedAudio: () => void;
+  toggleMic: () => void;
+  subscribe: AgentSubscribeAPI;
+}
 
 // Define the return type of initConnekzChat
-export interface ConnekzChatInstance extends AppEmits, AppExposed {
+export interface ConnekzInstance {
   unmount: () => void;
+  connekzSocket: ConnekzSocketAPI;
+  connekzAgent: VoiceAgentAPI;
 }
 
 /**
  * Initializes the Connekz chat widget in a specified DOM element.
- * @param divId - The ID of the parent div where the chat widget will be mounted.
+ *
  * @param options - Configuration options for the chat widget.
  * @returns An instance of the chat widget with methods to interact with it.
  */
-export default function initConnekzChat(divId: string, options: ConnekzChatOptions): ConnekzChatInstance;
-
-declare module '@connekz/connekz-agent';
-
-declare module '*.webp' {
-  const value: string;
-  export default value;
-}
-
-declare module '*.png' {
-  const value: string;
-  export default value;
-}
-
-declare module '*.svg' {
-  const value: string;
-  export default value;
-}
+export default function initConnekz(options: ConnekzOptions): ConnekzInstance;
 
-export type GenericColors = 'neutral' | 'primary' | 'secondary' | 'accent' | 'info' | 'success' | 'warning' | 'error';
+declare module '@connekz/connekz-agent';