@simfinity/constellation-client 1.0.12 → 1.0.14

package/dist/index.cjs

@@ -31,39 +31,41 @@ var WebClient = class {
     this.sessionId = null;
     this.config = config;
   }
-  /**
-   * Retrieve the list of available tools:
-   * Tools, or functions, can be exposed to & added to the model's context, allowing it
-   * to use them during the session as part of its response creation process. In order to add
-   * a tool to the session context, it must be listed (by name) at session creation time
-   * (see startSession(...) function)
-   *
-   * @remarks
-   * Tools are remote functions exposed by MCP servers and integrated by the constellation server
-   *
-   * @exception
-   * This method throws new Error(...) if unable to execute successfully for any reason.
-   */
-  async fetchSupportedTools() {
-    const response = await fetch(`${this.config.sessionEndpoint}/supported_tools`, {
-      method: "GET",
-      headers: {
-        "Authorization": `Bearer ${this.config.key}`,
-        "Content-Type": "application/json",
-        "Accept": "application/json"
-      }
-    });
-    if (!response.ok) {
-      throw new Error(`Could not fetch the list of available tools
-[${response.status}:${response.statusText}]`);
-    }
-    try {
-      const result = await response.json();
-      return result != null ? result : [];
-    } catch (error) {
-      throw `Failed to read session create response: ${error}`;
-    }
-  }
+  /*    /!**
+       * Retrieve the list of available tools:
+       * Tools, or functions, can be exposed to & added to the model's context, allowing it
+       * to use them during the session as part of its response creation process. In order to add
+       * a tool to the session context, it must be listed (by name) at session creation time
+       * (see startSession(...) function)
+       *
+       * @remarks
+       * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+       *
+       * @exception
+       * This method throws new Error(...) if unable to execute successfully for any reason.
+       *!/
+      public async fetchSupportedTools(): Promise<ToolDescription[]> {
+          const response = await fetch(`${this.config.sessionEndpoint}/supported_tools`, {
+              method: 'GET',
+              headers: {
+                  'Authorization': `Bearer ${this.config.key}`,
+                  'Content-Type': 'application/json',
+                  'Accept': 'application/json'
+              }
+          });
+  
+          if (!response.ok) {
+              throw new Error(`Could not fetch the list of available tools\n[${response.status}:${response.statusText}]`)
+          }
+  
+          try {
+              const result: ToolDescription[] = await response.json();
+              return result ?? [];
+          }
+          catch(error) {
+              throw `Failed to read session create response: ${error}`;
+          }
+      }*/
   /**
    * Start a persistent chat room on the server, allowing for re-connection,
    * when the streaming connection is lost. Once a session was started it must
@@ -72,16 +74,17 @@ var WebClient = class {
    * @remarks
    * A session MUST exist first in order to connect the stream next.
    *
+   * @param voiceEnabled whether this Model-session can receive & produce audio as well as text
+   * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+   *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession() {
-    var _a;
+  async startSession(voiceEnabled, voiceName) {
     const prepareBody = {
       llmProvider: this.config.llm,
-      audioEnabled: (_a = this.config.voiceEnabled) != null ? _a : false,
-      voiceName: this.config.voiceName,
-      includeTools: this.config.tools
+      audioEnabled: voiceEnabled,
+      voiceName
     };
     const response = await fetch(`${this.config.sessionEndpoint}/prepare_session`, {
       method: "POST",

package/dist/index.d.cts

@@ -10,10 +10,6 @@ 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
@@ -23,7 +19,6 @@ type LlmType = "openai";
  *     key: "some-secret-key"
  *     llm: "openai",
  *     model: "gpt-4o-realtime-preview-2024-12-17",
- *     voiceEnabled: false,
  * }
  * ```
  */
@@ -33,9 +28,6 @@ interface WebClientConfig {
     key: string;
     llm: LlmType;
     model: string;
-    voiceEnabled?: boolean;
-    voiceName?: string;
-    tools?: string[];
 }
 /**
  * System settings influencing the model behavior:
@@ -101,20 +93,6 @@ declare class WebClient {
     private ws;
     private sessionId;
     constructor(config: WebClientConfig);
-    /**
-     * Retrieve the list of available tools:
-     * Tools, or functions, can be exposed to & added to the model's context, allowing it
-     * to use them during the session as part of its response creation process. In order to add
-     * a tool to the session context, it must be listed (by name) at session creation time
-     * (see startSession(...) function)
-     *
-     * @remarks
-     * Tools are remote functions exposed by MCP servers and integrated by the constellation server
-     *
-     * @exception
-     * This method throws new Error(...) if unable to execute successfully for any reason.
-     */
-    fetchSupportedTools(): Promise<ToolDescription[]>;
     /**
      * Start a persistent chat room on the server, allowing for re-connection,
      * when the streaming connection is lost. Once a session was started it must
@@ -123,10 +101,13 @@ declare class WebClient {
      * @remarks
      * A session MUST exist first in order to connect the stream next.
      *
+     * @param voiceEnabled whether this Model-session can receive & produce audio as well as text
+     * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+     *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(): Promise<void>;
+    startSession(voiceEnabled: boolean, voiceName?: string): 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,10 +10,6 @@ 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
@@ -23,7 +19,6 @@ type LlmType = "openai";
  *     key: "some-secret-key"
  *     llm: "openai",
  *     model: "gpt-4o-realtime-preview-2024-12-17",
- *     voiceEnabled: false,
  * }
  * ```
  */
@@ -33,9 +28,6 @@ interface WebClientConfig {
     key: string;
     llm: LlmType;
     model: string;
-    voiceEnabled?: boolean;
-    voiceName?: string;
-    tools?: string[];
 }
 /**
  * System settings influencing the model behavior:
@@ -101,20 +93,6 @@ declare class WebClient {
     private ws;
     private sessionId;
     constructor(config: WebClientConfig);
-    /**
-     * Retrieve the list of available tools:
-     * Tools, or functions, can be exposed to & added to the model's context, allowing it
-     * to use them during the session as part of its response creation process. In order to add
-     * a tool to the session context, it must be listed (by name) at session creation time
-     * (see startSession(...) function)
-     *
-     * @remarks
-     * Tools are remote functions exposed by MCP servers and integrated by the constellation server
-     *
-     * @exception
-     * This method throws new Error(...) if unable to execute successfully for any reason.
-     */
-    fetchSupportedTools(): Promise<ToolDescription[]>;
     /**
      * Start a persistent chat room on the server, allowing for re-connection,
      * when the streaming connection is lost. Once a session was started it must
@@ -123,10 +101,13 @@ declare class WebClient {
      * @remarks
      * A session MUST exist first in order to connect the stream next.
      *
+     * @param voiceEnabled whether this Model-session can receive & produce audio as well as text
+     * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+     *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(): Promise<void>;
+    startSession(voiceEnabled: boolean, voiceName?: string): 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

@@ -5,39 +5,41 @@ var WebClient = class {
     this.sessionId = null;
     this.config = config;
   }
-  /**
-   * Retrieve the list of available tools:
-   * Tools, or functions, can be exposed to & added to the model's context, allowing it
-   * to use them during the session as part of its response creation process. In order to add
-   * a tool to the session context, it must be listed (by name) at session creation time
-   * (see startSession(...) function)
-   *
-   * @remarks
-   * Tools are remote functions exposed by MCP servers and integrated by the constellation server
-   *
-   * @exception
-   * This method throws new Error(...) if unable to execute successfully for any reason.
-   */
-  async fetchSupportedTools() {
-    const response = await fetch(`${this.config.sessionEndpoint}/supported_tools`, {
-      method: "GET",
-      headers: {
-        "Authorization": `Bearer ${this.config.key}`,
-        "Content-Type": "application/json",
-        "Accept": "application/json"
-      }
-    });
-    if (!response.ok) {
-      throw new Error(`Could not fetch the list of available tools
-[${response.status}:${response.statusText}]`);
-    }
-    try {
-      const result = await response.json();
-      return result != null ? result : [];
-    } catch (error) {
-      throw `Failed to read session create response: ${error}`;
-    }
-  }
+  /*    /!**
+       * Retrieve the list of available tools:
+       * Tools, or functions, can be exposed to & added to the model's context, allowing it
+       * to use them during the session as part of its response creation process. In order to add
+       * a tool to the session context, it must be listed (by name) at session creation time
+       * (see startSession(...) function)
+       *
+       * @remarks
+       * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+       *
+       * @exception
+       * This method throws new Error(...) if unable to execute successfully for any reason.
+       *!/
+      public async fetchSupportedTools(): Promise<ToolDescription[]> {
+          const response = await fetch(`${this.config.sessionEndpoint}/supported_tools`, {
+              method: 'GET',
+              headers: {
+                  'Authorization': `Bearer ${this.config.key}`,
+                  'Content-Type': 'application/json',
+                  'Accept': 'application/json'
+              }
+          });
+  
+          if (!response.ok) {
+              throw new Error(`Could not fetch the list of available tools\n[${response.status}:${response.statusText}]`)
+          }
+  
+          try {
+              const result: ToolDescription[] = await response.json();
+              return result ?? [];
+          }
+          catch(error) {
+              throw `Failed to read session create response: ${error}`;
+          }
+      }*/
   /**
    * Start a persistent chat room on the server, allowing for re-connection,
    * when the streaming connection is lost. Once a session was started it must
@@ -46,16 +48,17 @@ var WebClient = class {
    * @remarks
    * A session MUST exist first in order to connect the stream next.
    *
+   * @param voiceEnabled whether this Model-session can receive & produce audio as well as text
+   * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+   *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession() {
-    var _a;
+  async startSession(voiceEnabled, voiceName) {
     const prepareBody = {
       llmProvider: this.config.llm,
-      audioEnabled: (_a = this.config.voiceEnabled) != null ? _a : false,
-      voiceName: this.config.voiceName,
-      includeTools: this.config.tools
+      audioEnabled: voiceEnabled,
+      voiceName
     };
     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.12",
+  "version": "1.0.14",
   "type": "module",
   "exports": {
     ".": {