Fix websocket default values

cheshire-cat-ai · Feb 29, 2024 · 648db68 · 648db68
1 parent c25c1c5
commit 648db68
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 15 deletions.
diff --git a/.changeset/ten-bobcats-rescue.md b/.changeset/ten-bobcats-rescue.md
@@ -0,0 +1,5 @@
+---
+"ccat-api": patch
+---
+
+Fix websocket default values
diff --git a/api/client.ts b/api/client.ts
@@ -37,25 +37,26 @@ export class CatClient {
  }
 
  private initWebSocket() {
- const socketSettings = this.config.ws = {
+ const wsConfig = this.config.ws = {
  delay: 3000,
- path: 'ws',
+ path: '/ws',
  retries: 3,
+ query: '',
  ...this.config.ws
  } satisfies WebSocketSettings
  const user = this.config.user ?? 'user'
- this.ws = new WebSocket(`${this.url}/${socketSettings.path}/${user}${socketSettings.query}`)
+ this.ws = new WebSocket(`${this.url}${wsConfig.path}/${user}${wsConfig.query}`)
  this.ws.onopen = () => {
  this.connectedHandler?.()
  }
  this.ws.onclose = () => {
  if (!this.explicitlyClosed) {
  this.retried += 1
- if (socketSettings.retries < 0 || this.retried < socketSettings.retries) {
- setTimeout(() => this.initWebSocket(), socketSettings.delay)
- } else socketSettings.onFailed?.({
+ if (wsConfig.retries < 0 || this.retried < wsConfig.retries) {
+ setTimeout(() => this.initWebSocket(), wsConfig.delay)
+ } else wsConfig.onFailed?.({
  name: 'FailedRetry',
- description: `Failed to connect WebSocket after ${socketSettings.retries} retries.`
+ description: `Failed to connect WebSocket after ${wsConfig.retries} retries.`
  })
  }
  this.disconnectedHandler?.()

diff --git a/api/utils.ts b/api/utils.ts
@@ -1,11 +1,12 @@
 export interface WebSocketSettings {
  /** 
  * Websocket path to use to communicate with the CCat 
- * @default 'ws'
+ * @default '/ws'
  */
  path?: string
  /** 
  * The query to append to the URL. It should start with a question mark.
+ * @example '?token=123'
  * @default ''
  */
  query?: string
@@ -27,7 +28,9 @@ export interface WebSocketSettings {
 }
 
 export interface CatSettings {
- /** The URL to which connect to the Cat */
+ /** The URL to which connect to the Cat 
+ * @example 'localhost'
+ */
  baseUrl: string
  /** 
  * The key to authenticate the Cat endpoints

diff --git a/dist/index.d.mts b/dist/index.d.mts
@@ -509,7 +509,7 @@ declare class CCatAPI {
 interface WebSocketSettings {
  /**
  * Websocket path to use to communicate with the CCat
- * @default 'ws'
+ * @default '/ws'
  */
  path?: string;
  /**

diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -509,7 +509,7 @@ declare class CCatAPI {
 interface WebSocketSettings {
  /**
  * Websocket path to use to communicate with the CCat
- * @default 'ws'
+ * @default '/ws'
  */
  path?: string;
  /**

diff --git a/dist/index.js b/dist/index.js
@@ -1120,12 +1120,13 @@ var CatClient = class {
  initWebSocket() {
  const socketSettings = this.config.ws = {
  delay: 3e3,
- path: "ws",
+ path: "/ws",
  retries: 3,
+ query: "",
  ...this.config.ws
  };
  const user = this.config.user ?? "user";
- this.ws = new import_isomorphic_ws.default(`${this.url}/${socketSettings.path}/${user}${socketSettings.query}`);
+ this.ws = new import_isomorphic_ws.default(`${this.url}${socketSettings.path}/${user}${socketSettings.query ?? ""}`);
  this.ws.onopen = () => {
  this.connectedHandler?.();
  };

diff --git a/dist/index.mjs b/dist/index.mjs
@@ -1076,12 +1076,13 @@ var CatClient = class {
  initWebSocket() {
  const socketSettings = this.config.ws = {
  delay: 3e3,
- path: "ws",
+ path: "/ws",
  retries: 3,
+ query: "",
  ...this.config.ws
  };
  const user = this.config.user ?? "user";
- this.ws = new WebSocket(`${this.url}/${socketSettings.path}/${user}${socketSettings.query}`);
+ this.ws = new WebSocket(`${this.url}${socketSettings.path}/${user}${socketSettings.query ?? ""}`);
  this.ws.onopen = () => {
  this.connectedHandler?.();
  };