@breeze.blue/sdk 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## Unreleased
+## 0.10.0
+
+- Added typed Voice Metadata codes and camelCase response fields for gender,
+  age, tone, and accent. `voices.edit(...)` uses `null` or an empty tone array
+  to clear metadata, and `voices.savePreview(...)` accepts metadata when saving
+  a preview.
 
 ## 0.9.0
 

package/README.md

@@ -450,17 +450,31 @@ const saved = await client.voices.savePreview({
   generatedVoiceId,
   voiceName: "Documentary narrator",
   languageCode: "en",
+  gender: "neutral",
+  age: "middle_aged",
+  tone: ["warm", "articulate"],
+  accent: "american",
 });
 ```
 
 Edit, tune settings, or delete a saved voice:
 
 ```ts
-await client.voices.edit(saved.voiceId, { name: "Renamed narrator", languageCode: "en" });
+await client.voices.edit(saved.voiceId, {
+  name: "Renamed narrator",
+  languageCode: "en",
+  tone: ["calm", "measured"],
+});
+// null clears nullable metadata; [] clears tone. Omitted fields remain unchanged.
+await client.voices.edit(saved.voiceId, { accent: null, tone: [] });
 await client.voices.editSettings(saved.voiceId, { guidanceScale: 1.2 });
 await client.voices.delete(saved.voiceId);
 ```
 
+Voice Metadata uses stable code values. `gender`, `age`, and `accent` may be
+`null`; `tone` contains up to three distinct codes. English and Chinese use
+different accent code sets, and other languages require `accent: null`.
+
 ## History, Models, and Account
 
 ```ts

package/dist/client.js

@@ -1547,6 +1547,10 @@ class VoicesResource {
             visibility: request.visibility,
             playedNotSelectedVoiceIds: request.playedNotSelectedVoiceIds,
             languageCode: request.languageCode,
+            gender: request.gender,
+            age: request.age,
+            tone: request.tone,
+            accent: request.accent,
         }, options);
     }
 }
@@ -1696,11 +1700,28 @@ function voiceEditForm(request) {
     appendOptional(form, "primary_category_code", request.primaryCategoryCode);
     appendOptional(form, "visibility", request.visibility);
     appendOptional(form, "language_code", request.languageCode);
+    appendNullable(form, "gender", request.gender);
+    appendNullable(form, "age", request.age);
+    if (request.tone !== undefined) {
+        if (request.tone.length === 0) {
+            form.append("tone", "");
+        }
+        else {
+            for (const tone of request.tone)
+                form.append("tone", tone);
+        }
+    }
+    appendNullable(form, "accent", request.accent);
     for (const file of normalizeFiles(request.file, request.files, { required: false })) {
         appendFile(form, "files", file);
     }
     return form;
 }
+function appendNullable(form, key, value) {
+    if (value === undefined)
+        return;
+    form.set(key, value ?? "");
+}
 function appendOptional(form, key, value) {
     if (value === undefined)
         return;

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { BreezeBlueAPIError, BreezeBlueAuthenticationError, BreezeBlueBadRequest
 export { BreezeBlueClient, ManagedRealtimeTextToSpeechConnection, RealtimeTextToSpeechConnection, } from "./client.js";
 export { SDK_NAME, SDK_VERSION } from "./version.js";
 export type * from "./types.js";
+export * from "./voice-metadata.js";

package/dist/index.js

@@ -2,3 +2,4 @@ export { AudioResponse } from "./audio.js";
 export { BreezeBlueAPIError, BreezeBlueAuthenticationError, BreezeBlueBadRequestError, BreezeBlueConfigurationError, BreezeBlueConflictError, BreezeBlueError, BreezeBlueForbiddenError, BreezeBlueGenerationNotReadyError, BreezeBlueInsufficientCreditsError, BreezeBlueNotFoundError, BreezeBlueRateLimitError, BreezeBlueRealtimeError, BreezeBlueServiceUnavailableError, BreezeBlueUpstreamError, BreezeBlueValidationError, } from "./errors.js";
 export { BreezeBlueClient, ManagedRealtimeTextToSpeechConnection, RealtimeTextToSpeechConnection, } from "./client.js";
 export { SDK_NAME, SDK_VERSION } from "./version.js";
+export * from "./voice-metadata.js";

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { VoiceAccent, VoiceAge, VoiceGender, VoiceTone } from "./voice-metadata.js";
 export type JsonObject = Record<string, unknown>;
 export type BreezeBlueFetch = typeof fetch;
 export interface BreezeBlueClientOptions {
@@ -310,6 +311,10 @@ export interface Voice {
     primaryCategoryCode?: string | null;
     visibility?: string | null;
     languageCode: string;
+    gender: VoiceGender | null;
+    age: VoiceAge | null;
+    tone: VoiceTone[];
+    accent: VoiceAccent | null;
     [key: string]: unknown;
 }
 export interface SavedVoice {
@@ -322,6 +327,10 @@ export interface SavedVoice {
     primaryCategoryCode?: string | null;
     visibility?: string | null;
     languageCode: string;
+    gender: VoiceGender | null;
+    age: VoiceAge | null;
+    tone: VoiceTone[];
+    accent: VoiceAccent | null;
 }
 export interface VoiceList {
     voices: Voice[];
@@ -372,6 +381,10 @@ export interface VoiceEditRequest {
     primaryCategoryCode?: string;
     visibility?: "private" | "public" | string;
     languageCode?: string;
+    gender?: VoiceGender | null;
+    age?: VoiceAge | null;
+    tone?: VoiceTone[];
+    accent?: VoiceAccent | null;
     file?: UploadData | UploadFile;
     files?: Array<UploadData | UploadFile>;
 }
@@ -406,6 +419,10 @@ export interface SaveVoiceRequest {
     visibility?: "private" | "public" | string;
     playedNotSelectedVoiceIds?: string[];
     languageCode?: string;
+    gender?: VoiceGender | null;
+    age?: VoiceAge | null;
+    tone?: VoiceTone[];
+    accent?: VoiceAccent | null;
 }
 export interface HistoryItem {
     historyItemId: string;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.9.0";
+export declare const SDK_VERSION = "0.10.0";
 export declare const SDK_NAME = "@breeze.blue/sdk";

package/dist/version.js

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "0.9.0";
+export const SDK_VERSION = "0.10.0";
 export const SDK_NAME = "@breeze.blue/sdk";

package/dist/voice-metadata.d.ts

@@ -0,0 +1,11 @@
+export declare const VOICE_GENDER_CODES: readonly ["male", "female", "neutral"];
+export declare const VOICE_AGE_CODES: readonly ["child", "young", "middle_aged", "old"];
+export declare const VOICE_TONE_CODES: readonly ["warm", "calm", "bright", "gentle", "energetic", "authoritative", "sincere", "weary", "precise", "refined", "urgent", "friendly", "articulate", "steady", "playful", "compassionate", "reflective", "measured", "rhythmic", "passionate"];
+export declare const VOICE_ACCENT_CODES_BY_LANGUAGE: {
+    readonly en: readonly ["american", "british", "scottish", "irish", "australian", "canadian", "us_southern", "us_new_york", "indian", "south_african", "russian", "japanese", "korean", "chinese"];
+    readonly zh: readonly ["mandarin_guangdong", "mandarin_northeastern", "mandarin_shaanxi", "mandarin_shanghai", "mandarin_sichuan", "mandarin_yunnan", "mandarin_henan", "cantonese"];
+};
+export type VoiceGender = (typeof VOICE_GENDER_CODES)[number];
+export type VoiceAge = (typeof VOICE_AGE_CODES)[number];
+export type VoiceTone = (typeof VOICE_TONE_CODES)[number];
+export type VoiceAccent = (typeof VOICE_ACCENT_CODES_BY_LANGUAGE)[keyof typeof VOICE_ACCENT_CODES_BY_LANGUAGE][number];

package/dist/voice-metadata.js

@@ -0,0 +1,8 @@
+// Generated from contracts/voice-metadata.json. Do not edit manually.
+export const VOICE_GENDER_CODES = ["male", "female", "neutral"];
+export const VOICE_AGE_CODES = ["child", "young", "middle_aged", "old"];
+export const VOICE_TONE_CODES = ["warm", "calm", "bright", "gentle", "energetic", "authoritative", "sincere", "weary", "precise", "refined", "urgent", "friendly", "articulate", "steady", "playful", "compassionate", "reflective", "measured", "rhythmic", "passionate"];
+export const VOICE_ACCENT_CODES_BY_LANGUAGE = {
+    en: ["american", "british", "scottish", "irish", "australian", "canadian", "us_southern", "us_new_york", "indian", "south_african", "russian", "japanese", "korean", "chinese"],
+    zh: ["mandarin_guangdong", "mandarin_northeastern", "mandarin_shaanxi", "mandarin_shanghai", "mandarin_sichuan", "mandarin_yunnan", "mandarin_henan", "cantonese"],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breeze.blue/sdk",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "ESM-first TypeScript SDK for the Breeze Blue Developer API.",
   "license": "MIT",
   "author": "Breeze Blue <support@breeze.blue>",