@simfinity/constellation-client 1.0.10 → 1.0.11

package/README.md

@@ -33,6 +33,7 @@ const client = new WebClient({
      key: "my-key",
      llm: "openai",
      model: "gpt-4o-realtime-preview-2024-12-17",
+     voiceEnabled: true,
 });
 
 try {
@@ -83,6 +84,9 @@ export interface WebClientConfig {
      key:    string;
      llm:    LlmType;
      model:  string;
+     voiceEnabled?: boolean;
+     voiceName?: string;
+     tools?: string[];
 }
 ```
 

package/dist/index.cjs

@@ -72,20 +72,16 @@ var WebClient = class {
    * @remarks
    * A session MUST exist first in order to connect the stream next.
    *
-   * @param audioEnabled whether this session can receive & produce audio as well as text
-   * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
-   * @param tools a list of tool names to be included in this session. These must be matching the
-   *              names returned by 'fetchAvailableTools()'.
-   *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession(audioEnabled, voiceName, tools = []) {
+  async startSession() {
+    var _a;
     const prepareBody = {
       llmProvider: this.config.llm,
-      audioEnabled,
-      voiceName,
-      includeTools: tools
+      audioEnabled: (_a = this.config.voiceEnabled) != null ? _a : false,
+      voiceName: this.config.voiceName,
+      includeTools: this.config.tools
     };
     const response = await fetch(`${this.config.sessionEndpoint}/prepare_session`, {
       method: "POST",

package/dist/index.d.cts

@@ -10,6 +10,10 @@ type LlmType = "openai";
  * @key : Simfinity API secret key granting access to the server API
  * @llm : which LLM service to connect to
  * @model : depends on the LLM service. This is the model name as define by the LLM service
+ * @voiceEnabled whether this session can receive & produce audio as well as text. Default is false.
+ * @voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+ * @tools a list of tool names to be included in this session. These must be matching the
+ *              names returned by 'fetchAvailableTools()'.
  *
  * @example
  * ```TypeScript
@@ -18,7 +22,8 @@ type LlmType = "openai";
  *     streamingEndpoint: "wss://simfinity.constellation.com:30003",
  *     key: "some-secret-key"
  *     llm: "openai",
- *     model: "gpt-4o-realtime-preview-2024-12-17"
+ *     model: "gpt-4o-realtime-preview-2024-12-17",
+ *     voiceEnabled: false,
  * }
  * ```
  */
@@ -28,6 +33,9 @@ interface WebClientConfig {
     key: string;
     llm: LlmType;
     model: string;
+    voiceEnabled?: boolean;
+    voiceName?: string;
+    tools?: string[];
 }
 /**
  * System settings influencing the model behavior:
@@ -115,15 +123,10 @@ declare class WebClient {
      * @remarks
      * A session MUST exist first in order to connect the stream next.
      *
-     * @param audioEnabled whether this session can receive & produce audio as well as text
-     * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
-     * @param tools a list of tool names to be included in this session. These must be matching the
-     *              names returned by 'fetchAvailableTools()'.
-     *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(audioEnabled: boolean, voiceName?: string, tools?: string[]): Promise<void>;
+    startSession(): Promise<void>;
     /**
      * Close an opened, persistent chat room, effectively killing the streaming as well if still opened.
      * If there is no active session, this method does nothing.

package/dist/index.d.ts

@@ -10,6 +10,10 @@ type LlmType = "openai";
  * @key : Simfinity API secret key granting access to the server API
  * @llm : which LLM service to connect to
  * @model : depends on the LLM service. This is the model name as define by the LLM service
+ * @voiceEnabled whether this session can receive & produce audio as well as text. Default is false.
+ * @voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+ * @tools a list of tool names to be included in this session. These must be matching the
+ *              names returned by 'fetchAvailableTools()'.
  *
  * @example
  * ```TypeScript
@@ -18,7 +22,8 @@ type LlmType = "openai";
  *     streamingEndpoint: "wss://simfinity.constellation.com:30003",
  *     key: "some-secret-key"
  *     llm: "openai",
- *     model: "gpt-4o-realtime-preview-2024-12-17"
+ *     model: "gpt-4o-realtime-preview-2024-12-17",
+ *     voiceEnabled: false,
  * }
  * ```
  */
@@ -28,6 +33,9 @@ interface WebClientConfig {
     key: string;
     llm: LlmType;
     model: string;
+    voiceEnabled?: boolean;
+    voiceName?: string;
+    tools?: string[];
 }
 /**
  * System settings influencing the model behavior:
@@ -115,15 +123,10 @@ declare class WebClient {
      * @remarks
      * A session MUST exist first in order to connect the stream next.
      *
-     * @param audioEnabled whether this session can receive & produce audio as well as text
-     * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
-     * @param tools a list of tool names to be included in this session. These must be matching the
-     *              names returned by 'fetchAvailableTools()'.
-     *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(audioEnabled: boolean, voiceName?: string, tools?: string[]): Promise<void>;
+    startSession(): Promise<void>;
     /**
      * Close an opened, persistent chat room, effectively killing the streaming as well if still opened.
      * If there is no active session, this method does nothing.

package/dist/index.js

@@ -46,20 +46,16 @@ var WebClient = class {
    * @remarks
    * A session MUST exist first in order to connect the stream next.
    *
-   * @param audioEnabled whether this session can receive & produce audio as well as text
-   * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
-   * @param tools a list of tool names to be included in this session. These must be matching the
-   *              names returned by 'fetchAvailableTools()'.
-   *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession(audioEnabled, voiceName, tools = []) {
+  async startSession() {
+    var _a;
     const prepareBody = {
       llmProvider: this.config.llm,
-      audioEnabled,
-      voiceName,
-      includeTools: tools
+      audioEnabled: (_a = this.config.voiceEnabled) != null ? _a : false,
+      voiceName: this.config.voiceName,
+      includeTools: this.config.tools
     };
     const response = await fetch(`${this.config.sessionEndpoint}/prepare_session`, {
       method: "POST",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simfinity/constellation-client",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "type": "module",
   "exports": {
     ".": {