@breeze.blue/sdk 0.3.0

package/dist/types.d.ts

@@ -0,0 +1,275 @@
+export type JsonObject = Record<string, unknown>;
+export type BreezeBlueFetch = typeof fetch;
+export interface BreezeBlueClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    fetch?: BreezeBlueFetch;
+    headers?: HeadersInit;
+    timeout?: number;
+}
+export interface RequestOptions {
+    headers?: HeadersInit;
+    signal?: AbortSignal;
+    timeout?: number;
+}
+export interface AudioRequestOptions extends RequestOptions {
+    outputFormat?: string;
+}
+export interface StreamTextToSpeechOptions extends AudioRequestOptions {
+    optimizeStreamingLatency?: number;
+    enableLogging?: boolean;
+}
+export interface VoiceSettings {
+    stability?: number;
+    similarityBoost?: number;
+    style?: number;
+    useSpeakerBoost?: boolean;
+    speed?: number;
+    guidanceScale?: number | null;
+}
+export interface PronunciationDictionaryLocator {
+    pronunciationDictionaryId: string;
+    versionId: string;
+}
+export interface TextToSpeechRequest {
+    text: string;
+    modelId?: string;
+    languageCode?: string;
+    instructions?: string;
+    voiceSettings?: VoiceSettings;
+    seed?: number;
+    pronunciationDictionaryLocators?: PronunciationDictionaryLocator[];
+    previousText?: string;
+    nextText?: string;
+    previousRequestIds?: string[];
+    nextRequestIds?: string[];
+    applyTextNormalization?: string;
+    applyLanguageTextNormalization?: boolean;
+}
+export interface AsyncTextToSpeechJob {
+    generationJobId: string;
+    historyItemId: string;
+    status: string;
+}
+export interface GenerationJobError {
+    code: string;
+    detail: string;
+}
+export interface GenerationJob {
+    generationJobId: string;
+    historyItemId: string;
+    status: string;
+    state: string;
+    source: string;
+    voiceId?: string | null;
+    voiceName?: string | null;
+    voiceCategory?: string | null;
+    modelId?: string | null;
+    text?: string | null;
+    contentType?: string | null;
+    downloadUrl?: string | null;
+    createdAt?: string | null;
+    completedAt?: string | null;
+    dateUnix?: number | null;
+    error?: GenerationJobError | null;
+    [key: string]: unknown;
+}
+export interface ModelLanguage {
+    languageId: string;
+    name: string;
+}
+export interface Model {
+    modelId: string;
+    name: string;
+    canDoTextToSpeech: boolean;
+    canDoVoiceConversion: boolean;
+    canUseStyle: boolean;
+    canUseSpeakerBoost: boolean;
+    servesProVoices: boolean;
+    languages: ModelLanguage[];
+    description: string;
+}
+export interface Voice {
+    voiceId: string;
+    name: string;
+    category: string;
+    voiceType: string;
+    labels: Record<string, string>;
+    previewUrl?: string | null;
+    settings: Required<VoiceSettings>;
+    description?: string | null;
+    createdAtUnix?: number | null;
+    [key: string]: unknown;
+}
+export interface VoiceList {
+    voices: Voice[];
+    hasMore: boolean;
+    nextPageToken?: string | null;
+    total: number;
+    page: number;
+    pageSize: number;
+}
+export interface VoiceSearchParams {
+    search?: string;
+    category?: "premade" | "generated" | "cloned" | string;
+    voiceType?: "all" | "default" | "personal" | string;
+    sort?: "created_at_unix" | "name" | string;
+    sortDirection?: "asc" | "desc";
+    nextPageToken?: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface GenericStatus {
+    status: string;
+}
+export type UploadData = Blob | ArrayBuffer | Uint8Array | string;
+export interface UploadFile {
+    data: UploadData;
+    filename?: string;
+    contentType?: string;
+}
+export interface VoiceClonePreviewRequest {
+    name: string;
+    file?: UploadData | UploadFile;
+    files?: Array<UploadData | UploadFile>;
+    description?: string;
+    labels?: Record<string, string>;
+    removeBackgroundNoise?: boolean;
+    text?: string;
+    instructions?: string;
+}
+export interface VoiceClonePreview {
+    generatedVoiceId: string;
+    requiresVerification: boolean;
+}
+export interface VoiceEditRequest {
+    name: string;
+    description?: string;
+    labels?: Record<string, string>;
+    file?: UploadData | UploadFile;
+    files?: Array<UploadData | UploadFile>;
+}
+export interface VoiceDesignRequest {
+    voiceDescription: string;
+    text?: string;
+    modelId?: string;
+    languageCode?: string;
+    autoGenerateText?: boolean;
+    loudness?: number;
+    quality?: number;
+    seed?: number;
+    guidanceScale?: number | null;
+    previewCount?: number;
+}
+export interface VoiceDesignPreview {
+    generatedVoiceId: string;
+    audioBase64: string;
+    mediaType: string;
+    durationSecs?: number | null;
+}
+export interface VoiceDesignResponse {
+    previews: VoiceDesignPreview[];
+    text: string;
+}
+export interface SaveVoiceRequest {
+    generatedVoiceId: string;
+    voiceName: string;
+    voiceDescription?: string | null;
+    labels?: Record<string, string>;
+    playedNotSelectedVoiceIds?: string[];
+}
+export interface HistoryItem {
+    historyItemId: string;
+    voiceId?: string | null;
+    voiceName?: string | null;
+    voiceCategory?: string | null;
+    modelId?: string | null;
+    text?: string | null;
+    source: string;
+    state?: string | null;
+    contentType?: string | null;
+    dateUnix?: number | null;
+    requestId?: string | null;
+    latencyMs?: number | null;
+    httpStatus?: number | null;
+    [key: string]: unknown;
+}
+export interface HistoryList {
+    history: HistoryItem[];
+    hasMore: boolean;
+    lastHistoryItemId?: string | null;
+    total: number;
+    page: number;
+    pageSize: number;
+}
+export interface HistoryListParams {
+    voiceId?: string;
+    modelId?: string;
+    search?: string;
+    source?: "TTS" | string;
+    sortDirection?: "asc" | "desc";
+    startAfterHistoryItemId?: string;
+    from?: string;
+    to?: string;
+    statusClass?: "2xx" | "4xx" | "5xx" | "other";
+    page?: number;
+    pageSize?: number;
+}
+export interface BalanceTopup {
+    topupId?: string | null;
+    amount?: number | null;
+    status?: string | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+export interface Balance {
+    balance: number;
+    balanceMillicredits?: number | null;
+    topups: BalanceTopup[];
+    [key: string]: unknown;
+}
+export interface UsageSummary {
+    requestCount: number;
+    totalTextCharacters: number;
+    totalBillableUnits: number;
+    totalCost: number;
+    totalCostMillicredits: number;
+}
+export interface UsageDailyBucket {
+    date: string;
+    requestCount: number;
+}
+export interface UsageItem {
+    id: string;
+    endpoint: string;
+    method: string;
+    status: number;
+    model?: string | null;
+    billableUnits?: number | null;
+    cost?: number | null;
+    costMillicredits?: number | null;
+    latencyMs?: number | null;
+    traceId?: string | null;
+    requestId?: string | null;
+    textCharacters?: number | null;
+    actionCode?: string | null;
+    createdAt?: string | null;
+    [key: string]: unknown;
+}
+export interface Usage {
+    windowDays?: number | null;
+    summary: UsageSummary;
+    total: number;
+    page: number;
+    pageSize: number;
+    daily: UsageDailyBucket[];
+    items: UsageItem[];
+    [key: string]: unknown;
+}
+export interface UsageParams {
+    days?: number;
+    search?: string;
+    method?: string;
+    page?: number;
+    pageSize?: number;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/version.d.ts

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

package/dist/version.js

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

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@breeze.blue/sdk",
+  "version": "0.3.0",
+  "description": "ESM-first TypeScript SDK for the Breeze Blue Developer API.",
+  "license": "MIT",
+  "author": "Breeze Blue <support@breeze.blue>",
+  "homepage": "https://breeze.blue",
+  "keywords": [
+    "audio",
+    "breeze",
+    "breeze-blue",
+    "sdk",
+    "text-to-speech",
+    "tts",
+    "voice"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "import": "./dist/node.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@types/node": "^20.19.35",
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "pnpm exec tsc -p tsconfig.json",
+    "typecheck": "pnpm exec tsc -p tsconfig.json --noEmit",
+    "test": "pnpm run build && node --test ./test/*.test.js"
+  }
+}