kugelaudio 0.1.2 → 0.1.5

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to the KugelAudio JavaScript/TypeScript SDK will be document
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.3] - 2024-12-25
+
+### Fixed
+- Fixed WebSocket authentication: now correctly uses `master_key` query param when `isMasterKey: true` is set, instead of always using `api_key`
+- Added both `X-API-Key` header and `Authorization: Bearer` header for HTTP requests
+
 ## [0.1.0] - 2024-12-17
 
 ### Added

package/dist/index.d.mts

@@ -151,8 +151,12 @@ interface StreamCallbacks {
  * KugelAudio client options.
  */
 interface KugelAudioOptions {
-    /** Your KugelAudio API key */
+    /** Your KugelAudio API key or JWT token */
     apiKey: string;
+    /** Whether apiKey is a master key (for internal/server-side use). Master keys bypass billing. */
+    isMasterKey?: boolean;
+    /** Whether apiKey is a JWT token (for user authentication). Takes precedence over isMasterKey. */
+    isToken?: boolean;
     /** API base URL (default: https://api.kugelaudio.com) */
     apiUrl?: string;
     /** TTS server URL (default: https://eu.kugelaudio.com) */
@@ -210,6 +214,10 @@ declare class TTSResource {
      * Returns complete audio after all chunks are received.
      */
     generate(options: GenerateOptions): Promise<AudioResponse>;
+    /**
+     * Build the WebSocket URL with appropriate auth param.
+     */
+    private buildWsUrl;
     /**
      * Get or create a WebSocket connection for connection pooling.
      * This avoids the ~220ms connect overhead on each request.
@@ -270,6 +278,8 @@ declare class TTSResource {
  */
 declare class KugelAudio {
     private _apiKey;
+    private _isMasterKey;
+    private _isToken;
     private _apiUrl;
     private _ttsUrl;
     private _timeout;
@@ -282,6 +292,10 @@ declare class KugelAudio {
     constructor(options: KugelAudioOptions);
     /** Get API key */
     get apiKey(): string;
+    /** Check if using master key authentication */
+    get isMasterKey(): boolean;
+    /** Check if using JWT token authentication */
+    get isToken(): boolean;
     /** Get TTS URL */
     get ttsUrl(): string;
     /**

package/dist/index.d.ts

@@ -151,8 +151,12 @@ interface StreamCallbacks {
  * KugelAudio client options.
  */
 interface KugelAudioOptions {
-    /** Your KugelAudio API key */
+    /** Your KugelAudio API key or JWT token */
     apiKey: string;
+    /** Whether apiKey is a master key (for internal/server-side use). Master keys bypass billing. */
+    isMasterKey?: boolean;
+    /** Whether apiKey is a JWT token (for user authentication). Takes precedence over isMasterKey. */
+    isToken?: boolean;
     /** API base URL (default: https://api.kugelaudio.com) */
     apiUrl?: string;
     /** TTS server URL (default: https://eu.kugelaudio.com) */
@@ -210,6 +214,10 @@ declare class TTSResource {
      * Returns complete audio after all chunks are received.
      */
     generate(options: GenerateOptions): Promise<AudioResponse>;
+    /**
+     * Build the WebSocket URL with appropriate auth param.
+     */
+    private buildWsUrl;
     /**
      * Get or create a WebSocket connection for connection pooling.
      * This avoids the ~220ms connect overhead on each request.
@@ -270,6 +278,8 @@ declare class TTSResource {
  */
 declare class KugelAudio {
     private _apiKey;
+    private _isMasterKey;
+    private _isToken;
     private _apiUrl;
     private _ttsUrl;
     private _timeout;
@@ -282,6 +292,10 @@ declare class KugelAudio {
     constructor(options: KugelAudioOptions);
     /** Get API key */
     get apiKey(): string;
+    /** Check if using master key authentication */
+    get isMasterKey(): boolean;
+    /** Check if using JWT token authentication */
+    get isToken(): boolean;
     /** Get TTS URL */
     get ttsUrl(): string;
     /**

package/dist/index.js

@@ -248,13 +248,27 @@ var TTSResource = class {
       rtf: finalStats ? finalStats.rtf : 0
     };
   }
+  /**
+   * Build the WebSocket URL with appropriate auth param.
+   */
+  buildWsUrl() {
+    const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
+    let authParam;
+    if (this.client.isToken) {
+      authParam = "token";
+    } else if (this.client.isMasterKey) {
+      authParam = "master_key";
+    } else {
+      authParam = "api_key";
+    }
+    return `${wsUrl}/ws/tts?${authParam}=${this.client.apiKey}`;
+  }
   /**
    * Get or create a WebSocket connection for connection pooling.
    * This avoids the ~220ms connect overhead on each request.
    */
   async getConnection() {
-    const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
-    const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
+    const url = this.buildWsUrl();
     if (this.wsConnection && this.wsUrl === url && this.wsConnection.readyState === WebSocket.OPEN) {
       return this.wsConnection;
     }
@@ -385,8 +399,7 @@ var TTSResource = class {
    */
   streamWithoutPooling(options, callbacks) {
     return new Promise((resolve, reject) => {
-      const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
-      const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
+      const url = this.buildWsUrl();
       const ws = new WebSocket(url);
       ws.onopen = () => {
         callbacks.onOpen?.();
@@ -485,6 +498,8 @@ var KugelAudio = class {
       throw new Error("API key is required");
     }
     this._apiKey = options.apiKey;
+    this._isMasterKey = options.isMasterKey || false;
+    this._isToken = options.isToken || false;
     this._apiUrl = (options.apiUrl || DEFAULT_API_URL).replace(/\/$/, "");
     this._ttsUrl = (options.ttsUrl || this._apiUrl).replace(/\/$/, "");
     this._timeout = options.timeout || 6e4;
@@ -496,6 +511,14 @@ var KugelAudio = class {
   get apiKey() {
     return this._apiKey;
   }
+  /** Check if using master key authentication */
+  get isMasterKey() {
+    return this._isMasterKey;
+  }
+  /** Check if using JWT token authentication */
+  get isToken() {
+    return this._isToken;
+  }
   /** Get TTS URL */
   get ttsUrl() {
     return this._ttsUrl;

package/dist/index.mjs

@@ -212,13 +212,27 @@ var TTSResource = class {
       rtf: finalStats ? finalStats.rtf : 0
     };
   }
+  /**
+   * Build the WebSocket URL with appropriate auth param.
+   */
+  buildWsUrl() {
+    const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
+    let authParam;
+    if (this.client.isToken) {
+      authParam = "token";
+    } else if (this.client.isMasterKey) {
+      authParam = "master_key";
+    } else {
+      authParam = "api_key";
+    }
+    return `${wsUrl}/ws/tts?${authParam}=${this.client.apiKey}`;
+  }
   /**
    * Get or create a WebSocket connection for connection pooling.
    * This avoids the ~220ms connect overhead on each request.
    */
   async getConnection() {
-    const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
-    const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
+    const url = this.buildWsUrl();
     if (this.wsConnection && this.wsUrl === url && this.wsConnection.readyState === WebSocket.OPEN) {
       return this.wsConnection;
     }
@@ -349,8 +363,7 @@ var TTSResource = class {
    */
   streamWithoutPooling(options, callbacks) {
     return new Promise((resolve, reject) => {
-      const wsUrl = this.client.ttsUrl.replace("https://", "wss://").replace("http://", "ws://");
-      const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
+      const url = this.buildWsUrl();
       const ws = new WebSocket(url);
       ws.onopen = () => {
         callbacks.onOpen?.();
@@ -449,6 +462,8 @@ var KugelAudio = class {
       throw new Error("API key is required");
     }
     this._apiKey = options.apiKey;
+    this._isMasterKey = options.isMasterKey || false;
+    this._isToken = options.isToken || false;
     this._apiUrl = (options.apiUrl || DEFAULT_API_URL).replace(/\/$/, "");
     this._ttsUrl = (options.ttsUrl || this._apiUrl).replace(/\/$/, "");
     this._timeout = options.timeout || 6e4;
@@ -460,6 +475,14 @@ var KugelAudio = class {
   get apiKey() {
     return this._apiKey;
   }
+  /** Check if using master key authentication */
+  get isMasterKey() {
+    return this._isMasterKey;
+  }
+  /** Check if using JWT token authentication */
+  get isToken() {
+    return this._isToken;
+  }
   /** Get TTS URL */
   get ttsUrl() {
     return this._ttsUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kugelaudio",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "Official JavaScript/TypeScript SDK for KugelAudio TTS API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/client.ts

@@ -159,14 +159,30 @@ class TTSResource {
   }
 
   /**
-   * Get or create a WebSocket connection for connection pooling.
-   * This avoids the ~220ms connect overhead on each request.
+   * Build the WebSocket URL with appropriate auth param.
    */
-  private async getConnection(): Promise<WebSocket> {
+  private buildWsUrl(): string {
     const wsUrl = this.client.ttsUrl
       .replace('https://', 'wss://')
       .replace('http://', 'ws://');
-    const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
+    // Use token param for JWT tokens, master_key for master keys (bypasses billing), api_key for regular keys
+    let authParam: string;
+    if (this.client.isToken) {
+      authParam = 'token';
+    } else if (this.client.isMasterKey) {
+      authParam = 'master_key';
+    } else {
+      authParam = 'api_key';
+    }
+    return `${wsUrl}/ws/tts?${authParam}=${this.client.apiKey}`;
+  }
+
+  /**
+   * Get or create a WebSocket connection for connection pooling.
+   * This avoids the ~220ms connect overhead on each request.
+   */
+  private async getConnection(): Promise<WebSocket> {
+    const url = this.buildWsUrl();
 
     // Return existing connection if valid
     if (
@@ -338,11 +354,7 @@ class TTSResource {
     callbacks: StreamCallbacks
   ): Promise<void> {
     return new Promise((resolve, reject) => {
-      const wsUrl = this.client.ttsUrl
-        .replace('https://', 'wss://')
-        .replace('http://', 'ws://');
-      const url = `${wsUrl}/ws/tts?api_key=${this.client.apiKey}`;
-
+      const url = this.buildWsUrl();
       const ws = new WebSocket(url);
 
       ws.onopen = () => {
@@ -475,6 +487,8 @@ class TTSResource {
  */
 export class KugelAudio {
   private _apiKey: string;
+  private _isMasterKey: boolean;
+  private _isToken: boolean;
   private _apiUrl: string;
   private _ttsUrl: string;
   private _timeout: number;
@@ -492,6 +506,8 @@ export class KugelAudio {
     }
 
     this._apiKey = options.apiKey;
+    this._isMasterKey = options.isMasterKey || false;
+    this._isToken = options.isToken || false;
     this._apiUrl = (options.apiUrl || DEFAULT_API_URL).replace(/\/$/, '');
     // If ttsUrl not specified, use apiUrl (backend proxies to TTS server)
     this._ttsUrl = (options.ttsUrl || this._apiUrl).replace(/\/$/, '');
@@ -507,6 +523,16 @@ export class KugelAudio {
     return this._apiKey;
   }
 
+  /** Check if using master key authentication */
+  get isMasterKey(): boolean {
+    return this._isMasterKey;
+  }
+
+  /** Check if using JWT token authentication */
+  get isToken(): boolean {
+    return this._isToken;
+  }
+
   /** Get TTS URL */
   get ttsUrl(): string {
     return this._ttsUrl;

package/src/types.ts

@@ -163,8 +163,12 @@ export interface StreamCallbacks {
  * KugelAudio client options.
  */
 export interface KugelAudioOptions {
-  /** Your KugelAudio API key */
+  /** Your KugelAudio API key or JWT token */
   apiKey: string;
+  /** Whether apiKey is a master key (for internal/server-side use). Master keys bypass billing. */
+  isMasterKey?: boolean;
+  /** Whether apiKey is a JWT token (for user authentication). Takes precedence over isMasterKey. */
+  isToken?: boolean;
   /** API base URL (default: https://api.kugelaudio.com) */
   apiUrl?: string;
   /** TTS server URL (default: https://eu.kugelaudio.com) */