@breeze.blue/sdk 0.17.0 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.18.0
+
+- Create asynchronous speech jobs with word timestamps and read timing from completed job results.
+
 ## 0.17.0
 
 - Generate synchronous speech or stream audio with word timestamps and safe stream cleanup.

package/README.md

@@ -436,7 +436,8 @@ console.log(metadataOptions.accentCodesByLanguage.en);
 
 Voice listings keep the published default of stable creation-time order from
 newest to oldest. Use `{ sort: "trend", voiceType: "default" }` for the shared
-Daily Trend order. Search queries remain relevance-ranked; Trend is only a
+Daily Trend order. Eligible voices not yet ranked follow the snapshot members;
+returned page tokens pin the initial supplemental candidates. Search queries remain relevance-ranked; Trend is only a
 weak prior within the same relevance tier.
 
 Breeze voice creation is always two steps: produce a **preview**, let the
@@ -609,3 +610,5 @@ Pass `voiceSettings: { volume: 1.5 }` to apply a request-level linear amplitude
 Stream audio and word/token timestamps with `client.textToSpeech.streamWithTimestamps(...)`. Use `for await` to consume chunks containing `audioBase64` and `wordTimestamps`; breaking iteration closes the stream. Decode the audio separately and merge repeated word indices. See [Speech timing](https://docs.breezeblue.ai/guides/speech-timing) for complete examples and timing semantics.
 
 For a complete response, use `client.textToSpeech.convertWithTimestamps(...)`. It returns base64 audio, its content type, and the full word/token timestamp list. Decode the audio before saving or playback. See [Speech timing](https://docs.breezeblue.ai/guides/speech-timing) and [Convert with timestamps](https://docs.breezeblue.ai/api-reference/text-to-speech/convert-with-timestamps).
+
+For background generation with timing, use `client.textToSpeech.createJobWithTimestamps(...)`. Poll with `client.generationJobs.get(jobId)`; a ready job includes `wordTimestamps` and the audio download URL.

package/dist/client.d.ts

@@ -26,6 +26,7 @@ declare class TextToSpeechResource {
     constructor(client: BreezeBlueClient);
     convert(voiceId: string, request: TextToSpeechRequest, options?: AudioRequestOptions): Promise<AudioResponse>;
     createJob(voiceId: string, request: TextToSpeechRequest, options?: AudioRequestOptions): Promise<AsyncTextToSpeechJob>;
+    createJobWithTimestamps(voiceId: string, request: TextToSpeechRequest, options?: AudioRequestOptions): Promise<AsyncTextToSpeechJob>;
     stream(voiceId: string, request: TextToSpeechRequest, options?: StreamTextToSpeechOptions): Promise<AudioResponse>;
     convertWithTimestamps(voiceId: string, request: TextToSpeechRequest, options?: AudioRequestOptions): Promise<SpeechWithTimestamps>;
     streamWithTimestamps(voiceId: string, request: TextToSpeechRequest & {

package/dist/client.js

@@ -113,6 +113,9 @@ class TextToSpeechResource {
     createJob(voiceId, request, options = {}) {
         return this.client.requestJson("POST", `/v1/text-to-speech/${encodeURIComponent(voiceId)}`, { outputFormat: options.outputFormat, delivery: "async" }, request, options);
     }
+    createJobWithTimestamps(voiceId, request, options = {}) {
+        return this.client.requestJson("POST", `/v1/text-to-speech/${encodeURIComponent(voiceId)}/with-timestamps`, { outputFormat: options.outputFormat, delivery: "async" }, request, options);
+    }
     stream(voiceId, request, options = {}) {
         return this.client.requestAudio("POST", `/v1/text-to-speech/${encodeURIComponent(voiceId)}/stream`, {
             outputFormat: options.outputFormat,

package/dist/types.d.ts

@@ -1,4 +1,5 @@
-import type { VoiceAccent, VoiceAge, VoiceGender, VoiceLanguageCode, VoiceTone } from "./voice-metadata.js";
+import type { WordTimestamp } from "./timestamps.js";
+import type { VoiceAccent, VoiceWritableAccent, VoiceAge, VoiceGender, VoiceLanguageCode, VoiceTone } from "./voice-metadata.js";
 export type JsonObject = Record<string, unknown>;
 export type BreezeBlueFetch = typeof fetch;
 export interface BreezeBlueClientOptions {
@@ -276,6 +277,7 @@ export interface GenerationJobError {
     detail: string;
 }
 export interface GenerationJob {
+    wordTimestamps?: WordTimestamp[];
     generationJobId: string;
     historyItemId: string;
     status: string;
@@ -359,7 +361,7 @@ export interface VoiceMetadataOptions {
     ageCodes: VoiceAge[];
     toneCodes: VoiceTone[];
     toneMaxItems: number;
-    accentCodesByLanguage: Record<VoiceLanguageCode, VoiceAccent[]>;
+    accentCodesByLanguage: Record<VoiceLanguageCode, VoiceWritableAccent[]>;
 }
 export interface VoiceRandomParams {
     /** Only pick from voices whose saved audio language matches this code. */
@@ -375,6 +377,7 @@ export interface VoiceSearchParams {
     age?: VoiceAge[];
     tone?: VoiceTone[];
     accent?: VoiceAccent;
+    accentMode?: "all" | "unmarked";
     origin?: "designed" | "cloned" | string;
     voiceType?: "all" | "default" | "personal" | string;
     sort?: "created_at_unix" | "name" | "trend" | string;
@@ -418,7 +421,7 @@ export interface VoiceEditRequest {
     gender?: VoiceGender | null;
     age?: VoiceAge | null;
     tone?: VoiceTone[];
-    accent?: VoiceAccent | null;
+    accent?: VoiceWritableAccent | null;
     file?: UploadData | UploadFile;
     files?: Array<UploadData | UploadFile>;
 }
@@ -480,7 +483,7 @@ export interface SaveVoiceRequest {
     gender?: VoiceGender | null;
     age?: VoiceAge | null;
     tone?: VoiceTone[];
-    accent?: VoiceAccent | null;
+    accent?: VoiceWritableAccent | null;
 }
 export interface HistoryItem {
     historyItemId: string;

package/dist/version.d.ts

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

package/dist/version.js

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

package/dist/voice-metadata.d.ts

@@ -5,10 +5,14 @@ export declare const VOICE_LANGUAGE_CODES: readonly ["af", "ar", "bg", "bn", "bs
 export declare const VOICE_TONE_MAX_ITEMS: 3;
 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"];
+    readonly zh: readonly ["mandarin_northeastern", "mandarin_shaanxi", "mandarin_shanghai", "mandarin_sichuan", "mandarin_henan", "mandarin_beijing", "mandarin_taiwan", "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 VoiceLanguageCode = (typeof VOICE_LANGUAGE_CODES)[number];
-export type VoiceAccent = (typeof VOICE_ACCENT_CODES_BY_LANGUAGE)[keyof typeof VOICE_ACCENT_CODES_BY_LANGUAGE][number];
+export declare const VOICE_LEGACY_ACCENT_CODES_BY_LANGUAGE: {
+    readonly zh: readonly ["mandarin_guangdong", "mandarin_yunnan"];
+};
+export type VoiceWritableAccent = (typeof VOICE_ACCENT_CODES_BY_LANGUAGE)[keyof typeof VOICE_ACCENT_CODES_BY_LANGUAGE][number];
+export type VoiceAccent = VoiceWritableAccent | "mandarin_guangdong" | "mandarin_yunnan";

package/dist/voice-metadata.js

@@ -6,5 +6,6 @@ export const VOICE_LANGUAGE_CODES = ["af", "ar", "bg", "bn", "bs", "ca", "cs", "
 export const VOICE_TONE_MAX_ITEMS = 3;
 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"],
+    zh: ["mandarin_northeastern", "mandarin_shaanxi", "mandarin_shanghai", "mandarin_sichuan", "mandarin_henan", "mandarin_beijing", "mandarin_taiwan", "cantonese"],
 };
+export const VOICE_LEGACY_ACCENT_CODES_BY_LANGUAGE = { "zh": ["mandarin_guangdong", "mandarin_yunnan"] };

package/package.json

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