@vocalstack/js-sdk 2.0.0-alpha.3 → 2.0.0-alpha.4

package/README.md

@@ -53,7 +53,7 @@ npm install @vocalstack/js-sdk
 | recording | one take inside a broadcast or a transcription | `vs.recordings` |
 | job | a file or link recording's transcription work | `vs.jobs` |
 
-The other groups: `vs.corrections`, `vs.shareLinks`, `vs.voices`,
+The other groups: `vs.corrections`, `vs.shareLinks`, `vs.speakers`, `vs.voices`,
 `vs.search`, `vs.me`, `vs.languages`, `vs.rtmp`, `vs.events`, `vs.meta`.
 Method names follow the document's `operationId`s (`broadcasts.startRecording`
 is `POST /v1/broadcasts/{id}/recordings`); lists return arrays.
@@ -127,7 +127,7 @@ Browser microphone capture ships as `@vocalstack/js-sdk/mic`
 ## Binary answers
 
 `recordings.export`, `recordings.clip`, `recordings.voiceClip`, `jobs.preview`,
-`voices.preview`, `voices.clonePreview` and `voices.sample` return the
+`voices.preview`, `speakers.voicePreview` and `speakers.sample` return the
 `Response` itself: `.text()`, `.arrayBuffer()` or stream it.
 `recordings.audioUrl` returns the signed media URL.
 

package/SKILL.md

@@ -223,7 +223,7 @@ try {
 - The other groups: `vs.transcriptions` (`list`, `get`, `update`, `archive`,
   `restore`, `purge`, `listShareLinks`, `createShareLink`), `vs.recordings`
   (`get`, `summarize`, `summary`, `translation`, `audioUrl`, `subscribe` for a
-  live transcript feed), `vs.corrections`, `vs.shareLinks`, `vs.voices`,
+  live transcript feed), `vs.corrections`, `vs.shareLinks`, `vs.speakers`, `vs.voices`,
   `vs.broadcasts`, `vs.me` (`get`, `usage`), `vs.languages`,
   `vs.rtmp`, `vs.events`, `vs.meta`. Each method is named after its operation
   in the OpenAPI document (`transcriptions.create` is `POST /v1/transcriptions`).

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { type ClientOptions } from './http.js';
 import { Realtime } from './realtime.js';
-import { Billing, Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Tags, Transcriptions, Voices } from './resources.js';
+import { Billing, Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Speakers, Tags, Transcriptions, Voices } from './resources.js';
 export type { ClientOptions, CallOptions, ReadAs, Query } from './http.js';
 export { DEFAULT_BASE_URL } from './http.js';
 export { VocalStackError } from './errors.js';
@@ -13,7 +13,7 @@ export type { ConnectOptions, TranscribeOptions, RealtimeTranscript } from './re
 export { Subscription } from './subscription.js';
 export type { SubscribeOptions, SubscriptionEvent } from './subscription.js';
 export type { WsLike } from './ws.js';
-export { Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Tags, Transcriptions, Voices, playableFormat, } from './resources.js';
+export { Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Speakers, Tags, Transcriptions, Voices, playableFormat, } from './resources.js';
 export type { AudioKind, MediaAuth, MediaFormat, RenderVoice, VoicesChoice } from './resources.js';
 export type { ConnectToken, ConnectTokenInput, CreateTranscriptionInput, LifecycleFilter, Me, PageOptions, RecordingPageOptions, SearchOptions, TranscriptionFilters, Upload, UsageChargesOptions, UsageOptions } from './resources.js';
 export type * from '@vocalstack/contract';
@@ -28,6 +28,7 @@ export declare class VocalStack {
     readonly corrections: Corrections;
     readonly shareLinks: ShareLinks;
     readonly tags: Tags;
+    readonly speakers: Speakers;
     readonly voices: Voices;
     readonly search: Search;
     readonly me: MeApi;

package/dist/index.js

@@ -1,12 +1,12 @@
 import { Transport } from './http.js';
 import { Realtime } from './realtime.js';
-import { Billing, Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Tags, Transcriptions, Voices, } from './resources.js';
+import { Billing, Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Speakers, Tags, Transcriptions, Voices, } from './resources.js';
 export { DEFAULT_BASE_URL } from './http.js';
 export { VocalStackError } from './errors.js';
 export { RealtimeSession } from './realtime.js';
 export { Realtime, applySentence } from './realtime.js';
 export { Subscription } from './subscription.js';
-export { Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Tags, Transcriptions, Voices, playableFormat, } from './resources.js';
+export { Broadcasts, Connect, Corrections, Events, Jobs, Languages, MeApi, Meta, Recordings, Rtmp, Search, ShareLinks, Speakers, Tags, Transcriptions, Voices, playableFormat, } from './resources.js';
 export class VocalStack {
     baseUrl;
     realtime;
@@ -17,6 +17,7 @@ export class VocalStack {
     corrections;
     shareLinks;
     tags;
+    speakers;
     voices;
     search;
     me;
@@ -37,6 +38,7 @@ export class VocalStack {
         this.corrections = new Corrections(t);
         this.shareLinks = new ShareLinks(t);
         this.tags = new Tags(t);
+        this.speakers = new Speakers(t);
         this.voices = new Voices(t);
         this.search = new Search(t);
         this.me = new MeApi(t);

package/dist/resources.d.ts

@@ -1,4 +1,4 @@
-import type { AppStreamKey, AudioSourceCheck, AutoTopUpSettings, AutoTopUpView, BillingDetails, BillingView, CheckPromoCode, CheckoutView, CreateCheckout, LowBalanceAlertSettings, LowBalanceAlertView, PaymentDocument, PaymentMethodList, PaymentPage, PortalLink, PromoCodeView, SetInterval, SubscriptionView, YearlyOptIn, UsageChargePage, UsageReport, Broadcast, Correction, CorrectionBatch, CorrectionPage, CreateAppStreamKey, CreateAudioSource, CreateLiveTranscription, CreateBroadcast, CreateShareLink, CreateTag, CreateTranscription, CreateVoiceFromSpeaker, CreatedAppStreamKey, ChargePage, ExportFormat, ClientApp, ClientPolicy, Health, LanguageLists, LedgerPage, LinkProbe, PatchVoice, PlanList, PublishGrant, Recording, RecordingEvent, RecordingEvents, RecordingPage, RetranscribeLine, RtmpStatus, SearchResults, VectorResults, SettingsPatch, ShareLink, SharedTranscript, StartRecording, StartJob, SummaryStatus, Tag, TagTranscriptions, Transcription, TranscriptionJob, TranscriptionPage, TranscriptSnapshot, UpdateBroadcast, UpdateTag, UpdateTranscription, UpdateShareLink, UploadRecording, Voice, VoiceCatalogue, VoiceTrack, ManyResult } from '@vocalstack/contract';
+import type { AppStreamKey, AudioSourceCheck, AutoTopUpSettings, AutoTopUpView, BillingDetails, BillingView, CheckPromoCode, CheckoutView, CreateCheckout, LowBalanceAlertSettings, LowBalanceAlertView, PaymentDocument, PaymentMethodList, PaymentPage, PortalLink, PromoCodeView, SetInterval, SubscriptionView, YearlyOptIn, UsageChargePage, UsageReport, Broadcast, Correction, CorrectionBatch, CorrectionPage, CreateAppStreamKey, CreateAudioSource, CreateLiveTranscription, CreateBroadcast, CreateShareLink, CreateTag, CreateTranscription, CreateSpeaker, CreateSpeakerFromAppearance, CreatedAppStreamKey, ChargePage, ExportFormat, ClientApp, ClientPolicy, Health, LanguageLists, LedgerPage, LinkProbe, PatchSpeaker, PlanList, PublishGrant, Recording, RecordingEvent, RecordingEvents, RecordingPage, RetranscribeLine, RtmpStatus, SearchResults, VectorResults, SettingsPatch, ShareLink, SharedTranscript, StartRecording, StartJob, SummaryStatus, Tag, TagTranscriptions, Transcription, TranscriptionJob, TranscriptionPage, TranscriptSnapshot, UpdateBroadcast, UpdateTag, UpdateTranscription, UpdateShareLink, UploadRecording, Speaker, VoiceCatalogue, VoiceTrack, ManyResult } from '@vocalstack/contract';
 import { Transport, type CallOptions, type ReadAs } from './http.js';
 import { RealtimeSession, type ConnectOptions } from './realtime.js';
 import { Subscription, type SubscribeOptions } from './subscription.js';
@@ -72,6 +72,7 @@ export declare class Transcriptions extends ParentResource<Transcription, Update
     probe(url: string): Promise<LinkProbe>;
     attachBroadcast(id: string, broadcastId: string): Promise<Transcription>;
     detachBroadcast(id: string, broadcastId: string): Promise<Transcription>;
+    nameAppearance(id: string, appearance: number, name: string | null): Promise<void>;
 }
 export declare class Recordings {
     #private;
@@ -146,7 +147,6 @@ export declare class Recordings {
         token: string;
         expiresAt: string;
     }>;
-    nameSpeaker(id: string, speaker: number, name: string | null): Promise<void>;
     events(id: string, opts?: {
         after?: number;
         limit?: number;
@@ -213,33 +213,39 @@ export declare class Tags {
     delete(id: string): Promise<void>;
     tagTranscriptions(id: string, req: TagTranscriptions): Promise<Tag>;
 }
-export declare class Voices {
+export declare class Speakers {
     #private;
     constructor(t: Transport);
     list(opts?: {
         lifecycle?: 'active' | 'archived';
-    }): Promise<Voice[]>;
-    get(id: string): Promise<Voice>;
-    archive(id: string): Promise<Voice>;
-    restore(id: string): Promise<Voice>;
+    }): Promise<Speaker[]>;
+    get(id: string): Promise<Speaker>;
+    archive(id: string): Promise<Speaker>;
+    restore(id: string): Promise<Speaker>;
     archiveMany(ids: string[]): Promise<ManyResult>;
     restoreMany(ids: string[]): Promise<ManyResult>;
     deleteMany(ids: string[]): Promise<ManyResult>;
-    create(req: {
-        name: string;
+    create(req: CreateSpeaker & {
         sample?: Upload;
-        sampleUrl?: string;
         fileName?: string;
-        gender?: 'male' | 'female';
-        color?: string;
-        draft?: boolean;
-    }, call?: CallOptions): Promise<Voice>;
-    createFromSpeaker(req: Omit<CreateVoiceFromSpeaker, 'consent'>, call?: CallOptions): Promise<Voice>;
+    }, call?: CallOptions): Promise<Speaker>;
+    createFromAppearance(req: CreateSpeakerFromAppearance, call?: CallOptions): Promise<Speaker>;
     setConsent(id: string, consent: 'granted' | 'refused', opts?: {
         name?: string;
-    }): Promise<Voice>;
-    update(id: string, patch: PatchVoice): Promise<Voice>;
+    }): Promise<Speaker>;
+    update(id: string, patch: PatchSpeaker): Promise<Speaker>;
     delete(id: string): Promise<void>;
+    voicePreview(id: string, opts?: {
+        lang?: string;
+        format?: 'ogg' | 'caf';
+        recording?: string;
+        asOwner?: boolean;
+    } & ReadAs): Promise<Response>;
+    sample(id: string): Promise<Response>;
+}
+export declare class Voices {
+    #private;
+    constructor(t: Transport);
     available(lang: string, opts?: {
         recording?: string;
         asOwner?: boolean;
@@ -247,13 +253,6 @@ export declare class Voices {
     preview(voice: string, lang: string, opts?: {
         format?: 'ogg' | 'caf';
     }): Promise<Response>;
-    clonePreview(id: string, opts?: {
-        lang?: string;
-        format?: 'ogg' | 'caf';
-        recording?: string;
-        asOwner?: boolean;
-    } & ReadAs): Promise<Response>;
-    sample(id: string): Promise<Response>;
 }
 export interface SearchOptions extends Omit<TranscriptionFilters, 'lifecycle' | 'q' | 'broadcast'> {
     broadcasts?: string[];

package/dist/resources.js

@@ -152,6 +152,9 @@ export class Transcriptions extends ParentResource {
     detachBroadcast(id, broadcastId) {
         return this.t.json('DELETE', this.p(id, `/broadcasts/${seg(broadcastId)}`));
     }
+    async nameAppearance(id, appearance, name) {
+        await this.t.json('PUT', this.p(id, `/appearances/${seg(appearance)}`), { body: { name } });
+    }
 }
 export class Recordings {
     #t;
@@ -278,9 +281,6 @@ export class Recordings {
     mediaToken(id) {
         return this.#t.json('GET', this.#p(id, '/media-token'));
     }
-    async nameSpeaker(id, speaker, name) {
-        await this.#t.json('PUT', this.#p(id, `/speakers/${seg(speaker)}`), { body: { name } });
-    }
     events(id, opts = {}) {
         return allPages(async (cursor) => {
             const r = await this.eventsPage(id, cursor ? { cursor, limit: opts.limit } : { after: opts.after, limit: opts.limit });
@@ -417,54 +417,70 @@ export class Tags {
         return this.#t.json('POST', `/v1/tags/${seg(id)}/transcriptions`, { body: req });
     }
 }
-export class Voices {
+export class Speakers {
     #t;
     constructor(t) {
         this.#t = t;
     }
     async list(opts = {}) {
-        const r = await this.#t.json('GET', '/v1/voices', { query: { lifecycle: opts.lifecycle } });
-        return r.voices ?? [];
+        const r = await this.#t.json('GET', '/v1/speakers', { query: { lifecycle: opts.lifecycle } });
+        return r.speakers ?? [];
     }
     get(id) {
-        return this.#t.json('GET', `/v1/voices/${seg(id)}`);
+        return this.#t.json('GET', `/v1/speakers/${seg(id)}`);
     }
     archive(id) {
-        return this.#t.json('POST', `/v1/voices/${seg(id)}/archive`);
+        return this.#t.json('POST', `/v1/speakers/${seg(id)}/archive`);
     }
     restore(id) {
-        return this.#t.json('POST', `/v1/voices/${seg(id)}/restore`);
+        return this.#t.json('POST', `/v1/speakers/${seg(id)}/restore`);
     }
     archiveMany(ids) {
-        return this.#t.json('POST', '/v1/voices/archive', { body: { ids } });
+        return this.#t.json('POST', '/v1/speakers/archive', { body: { ids } });
     }
     restoreMany(ids) {
-        return this.#t.json('POST', '/v1/voices/restore', { body: { ids } });
+        return this.#t.json('POST', '/v1/speakers/restore', { body: { ids } });
     }
     deleteMany(ids) {
-        return this.#t.json('POST', '/v1/voices/delete', { body: { ids } });
+        return this.#t.json('POST', '/v1/speakers/delete', { body: { ids } });
     }
     async create(req, call = {}) {
         const { sample, fileName, ...meta } = req;
         const form = new FormData();
-        form.append('meta', JSON.stringify({ consent: !meta.draft, ...meta }));
+        form.append('meta', JSON.stringify(meta));
         if (sample !== undefined) {
             const { blob, name } = await toBlob(sample);
             form.append('sample', blob, fileName ?? name ?? 'sample.webm');
         }
-        return this.#t.json('POST', '/v1/voices', { body: form, ...call });
+        return this.#t.json('POST', '/v1/speakers', { body: form, ...call });
     }
-    createFromSpeaker(req, call = {}) {
-        return this.#t.json('POST', '/v1/voices/from-speaker', { body: { consent: true, ...req }, ...call });
+    createFromAppearance(req, call = {}) {
+        return this.#t.json('POST', '/v1/speakers/from-appearance', { body: req, ...call });
     }
     setConsent(id, consent, opts = {}) {
-        return this.#t.json('POST', `/v1/voices/${seg(id)}/consent`, { body: { consent, ...opts } });
+        return this.#t.json('POST', `/v1/speakers/${seg(id)}/consent`, { body: { consent, ...opts } });
     }
     update(id, patch) {
-        return this.#t.json('PATCH', `/v1/voices/${seg(id)}`, { body: patch });
+        return this.#t.json('PATCH', `/v1/speakers/${seg(id)}`, { body: patch });
     }
     async delete(id) {
-        await this.#t.json('DELETE', `/v1/voices/${seg(id)}`);
+        await this.#t.json('DELETE', `/v1/speakers/${seg(id)}`);
+    }
+    voicePreview(id, opts = {}) {
+        return this.#t.raw('GET', `/v1/speakers/${seg(id)}/preview`, {
+            headers: { accept: '*/*' },
+            query: { ...listenerQuery(opts), lang: opts.lang, format: opts.format, recording: opts.recording },
+            anonymous: opts.asOwner === false,
+        });
+    }
+    sample(id) {
+        return this.#t.raw('GET', `/v1/speakers/${seg(id)}/sample`, { headers: { accept: '*/*' } });
+    }
+}
+export class Voices {
+    #t;
+    constructor(t) {
+        this.#t = t;
     }
     available(lang, opts = {}) {
         return this.#t.json('GET', '/v1/voices/available', {
@@ -475,16 +491,6 @@ export class Voices {
     preview(voice, lang, opts = {}) {
         return this.#t.raw('GET', '/v1/voices/preview', { headers: { accept: '*/*' }, query: { voice, lang, format: opts.format } });
     }
-    clonePreview(id, opts = {}) {
-        return this.#t.raw('GET', `/v1/voices/${seg(id)}/preview`, {
-            headers: { accept: '*/*' },
-            query: { ...listenerQuery(opts), lang: opts.lang, format: opts.format, recording: opts.recording },
-            anonymous: opts.asOwner === false,
-        });
-    }
-    sample(id) {
-        return this.#t.raw('GET', `/v1/voices/${seg(id)}/sample`, { headers: { accept: '*/*' } });
-    }
 }
 export class Search {
     #t;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocalstack/js-sdk",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.4",
   "description": "VocalStack speech API SDK for Node and browsers: one client (VocalStack) grouped by resource, typed from the generated contract, with realtime WebSocket streaming.",
   "license": "MIT",
   "type": "module",
@@ -29,7 +29,7 @@
     "test": "node --test test/*.test.mjs"
   },
   "dependencies": {
-    "@vocalstack/contract": "1.0.0-alpha.3",
+    "@vocalstack/contract": "1.0.0-alpha.4",
     "ws": "^8.18.0"
   },
   "devDependencies": {

package/skills/vocalstack/SKILL.md

@@ -223,7 +223,7 @@ try {
 - The other groups: `vs.transcriptions` (`list`, `get`, `update`, `archive`,
   `restore`, `purge`, `listShareLinks`, `createShareLink`), `vs.recordings`
   (`get`, `summarize`, `summary`, `translation`, `audioUrl`, `subscribe` for a
-  live transcript feed), `vs.corrections`, `vs.shareLinks`, `vs.voices`,
+  live transcript feed), `vs.corrections`, `vs.shareLinks`, `vs.speakers`, `vs.voices`,
   `vs.broadcasts`, `vs.me` (`get`, `usage`), `vs.languages`,
   `vs.rtmp`, `vs.events`, `vs.meta`. Each method is named after its operation
   in the OpenAPI document (`transcriptions.create` is `POST /v1/transcriptions`).