@vocalstack/player 0.0.0-stage → 0.1.0-alpha.0

package/dist/data/context.d.ts

@@ -0,0 +1,60 @@
+import { type ReactNode } from 'react';
+import { VocalStack, type Recording, type TranscriptionJob, type ReadAs } from '@vocalstack/js-sdk';
+import type { MediaCred } from '../core/audio';
+import { type ErrorLike } from './errors';
+export declare const DEFAULT_API = "https://api.vocalstack.com";
+export interface PlayerApi {
+    client: VocalStack;
+    origin: string;
+    owner: boolean;
+    shareCode: string | null;
+    listen: Listen | null;
+    bearer: () => Promise<string | undefined>;
+    cred: MediaCred;
+    readAs: ReadAs;
+}
+export interface PlayerSource {
+    key: string;
+    code: string | null;
+    transcriptionId: string | null;
+    name: string;
+    recording: Recording;
+    job: TranscriptionJob | null;
+    allowDownload: boolean;
+    allowExport: boolean;
+    allowTranslate: boolean;
+    sharedBy: string | null;
+}
+export declare function usePlayerApi(): PlayerApi;
+export declare function PlayerApiProvider({ value, children }: {
+    value: PlayerApi;
+    children: ReactNode;
+}): import("react").JSX.Element;
+export declare function isTranscriptionId(id: string): boolean;
+export type TokenSource = string | (() => string | undefined | null | Promise<string | undefined | null>);
+export interface Listen {
+    transcriptionId: string;
+    recordingId: string;
+    token: string;
+}
+export interface ApiOptions {
+    id: string;
+    token?: TokenSource | null;
+    baseUrl?: string | null;
+    listen?: Listen | null;
+}
+export declare function useApi(o: ApiOptions): PlayerApi;
+export declare function withMedia(api: PlayerApi, media: string | null): PlayerApi;
+export declare function loadSource(api: PlayerApi, id: string): Promise<PlayerSource>;
+export declare function useSource(api: PlayerApi, id: string): {
+    source: PlayerSource | null;
+    gone: boolean;
+    error: ErrorLike | null;
+    reload: () => void;
+};
+export declare function useMediaToken(api: PlayerApi, recordingId: string | null): string | null;
+export declare function apiFetch(api: PlayerApi, path: string, init?: {
+    method?: string;
+    body?: unknown;
+    query?: Record<string, string | undefined>;
+}): Promise<Response>;

package/dist/data/errors.d.ts

@@ -0,0 +1,9 @@
+export interface ErrorLike {
+    message: string;
+    code?: string;
+    status?: number;
+    details?: any;
+}
+export declare const GENERIC: string;
+export declare const OFFLINE = "Can't reach VocalStack. Check your connection.";
+export declare function describe(e: unknown): ErrorLike;

package/dist/data/i18n.d.ts

@@ -0,0 +1,425 @@
+export type I18nKey = keyof typeof I18N.English;
+export type Strings = Record<I18nKey, string>;
+export declare const I18N: {
+    English: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+    Spanish: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+    French: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+    Japanese: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+    Romanian: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+    Portuguese: {
+        vcFor: string;
+        vcMute: string;
+        vcUnmute: string;
+        vcMuted: string;
+        vcShared: string;
+        vcUsedBy: string;
+        vcUnknownSpk: string;
+        vcUse: string;
+        vcGetting: string;
+        vcSample: string;
+        vcPreview: string;
+        vcMale: string;
+        vcFemale: string;
+        vcSynth: string;
+        origAudio: string;
+        vcCloned: string;
+        vcBadge: string;
+        vcNone: string;
+        vcNoVoice: string;
+        vcSheet: string;
+        vcNeutral: string;
+        vcWarm: string;
+        searchPlaceholder: string;
+        noise: string;
+        newLines: string;
+        live: string;
+        ended: string;
+        waiting: string;
+        corrected: string;
+        hostLine: string;
+        langLabel: string;
+        langCount: string;
+        read: string;
+        listen: string;
+        watch: string;
+        waitTitle: string;
+        waitBody: string;
+        english: string;
+        playing: string;
+        ready: string;
+        readyNote: string;
+        voiceMeta: string;
+        voice: string;
+        sheetTitle: string;
+        done: string;
+        search: string;
+        sheetNote: string;
+        moreLangs: string;
+        confTitle: string;
+        confBody: string;
+        confMid: string;
+        confHigh: string;
+        settings: string;
+        setOrig: string;
+        setTheme: string;
+        light: string;
+        dark: string;
+        setConf: string;
+        setConfHint1: string;
+        setConfMid: string;
+        setConfSep: string;
+        setConfLow: string;
+        setConfHint2: string;
+        behindLive: string;
+        behindNote: string;
+        shareLabel: string;
+        copy: string;
+        copied: string;
+    };
+};
+export declare function strings(name?: string | null): Strings;

package/dist/data/prefs.d.ts

@@ -0,0 +1,14 @@
+import type { LanguageLists } from '@vocalstack/js-sdk';
+export declare function useStored<T>(key: string, fallback: T): [T, (v: T) => void];
+export declare function forgetRecentLang(code: string): void;
+export declare function useRecentLangs(): [string[], (code: string | null) => void];
+export declare function pickerLanguages(langs: LanguageLists | null, kind: 'transcription' | 'translation' | 'voice'): {
+    code: string;
+    label: string;
+    native: string;
+    flag: string;
+    voice: boolean;
+}[];
+export declare function useSidePins(id: string): [string[], (v: string[]) => void];
+export declare const COL_W = 352;
+export declare function useColW(id: string): [number, (v: number | null) => void];

package/dist/data/transcript.d.ts

@@ -0,0 +1,27 @@
+import type { LanguageLists } from '@vocalstack/js-sdk';
+import { type Model } from '../core/transcript';
+import { describe, type ErrorLike } from './errors';
+export { describe, type ErrorLike };
+export declare function useLanguages(): LanguageLists | null;
+export declare function useAsync<T>(fn: () => Promise<T>, deps: unknown[]): {
+    data: T | null;
+    error: ErrorLike | null;
+    reload: () => void;
+};
+export declare function useTranscript(recordingId: string | null, opts: {
+    lang?: string | null;
+    voice?: string | null;
+    onState?: (s: string, reason?: string) => void;
+    onFrame?: (f: any) => void;
+}): {
+    model: Model;
+    connected: boolean;
+    error: ErrorLike | null;
+    notFound: boolean;
+    clearError: () => void;
+    setLanguage: (lang: string | null) => void;
+    mergeTranslations: (lang: string, made: Record<string, string>) => void;
+    translating: boolean;
+    translateFailed: string | null;
+    shownLang: string | null;
+};

package/dist/data/tx.d.ts

@@ -0,0 +1,37 @@
+import type { ExportFormat, TranscriptionJob } from '@vocalstack/js-sdk';
+import { type MediaCred } from '../core/audio';
+import type { PlayerApi } from './context';
+export type TxRowStatus = 'queued' | 'cropping' | 'transcribing' | 'done' | 'failed' | 'stopped' | 'live';
+export interface TxProgress {
+    state: TranscriptionJob['state'];
+    processedS: number;
+    totalS: number | null;
+    segmentsDone: number;
+    segmentsTotal: number | null;
+    pct: number;
+    error?: string | null;
+}
+export declare function rowStatusOf(state: TranscriptionJob['state'] | undefined | null): TxRowStatus;
+export declare function progressOf(job: TranscriptionJob | null): TxProgress | null;
+export declare const segsLabel: (p: TxProgress | null, fallbackDone: number) => string;
+export declare function jobLengthS(job: TranscriptionJob | null | undefined, progress?: TxProgress | null): number | null;
+export declare const TX_FORMATS: {
+    key: ExportFormat;
+    name: string;
+    ext: string;
+    note: string;
+    icon: string;
+}[];
+export declare function saveUrl(url: string): void;
+export declare function saveWhenReady(url: string): Promise<void>;
+export declare function exportTranscript(api: PlayerApi, recordingId: string, key: ExportFormat, opts?: {
+    lang?: string | null;
+}): Promise<void>;
+export declare function downloadVoiceTrack(api: PlayerApi, opts: {
+    recordingId: string;
+    lang: string;
+    voiceKey: string;
+    cred: MediaCred;
+    request: () => Promise<unknown>;
+    timeoutMs?: number;
+}): Promise<void>;

package/dist/data/voicePreview.d.ts

@@ -0,0 +1,15 @@
+import { type ErrorLike } from './errors';
+export interface PreviewableVoice {
+    id: string;
+    previewUrl?: string;
+}
+export declare function useVoicePreview(lang: string | null): {
+    armId: string | null;
+    sampleId: string | null;
+    dlId: string | null;
+    error: ErrorLike | null;
+    clearError: () => void;
+    arm: (v: PreviewableVoice) => void;
+    stop: () => void;
+    reset: () => void;
+};