@voiceinput/core 0.1.0-beta.1

package/dist/index.d.ts

@@ -0,0 +1,179 @@
+import { VoiceInputError, VoiceInputError as VoiceInputError$1, VoiceInputErrorCode, VoiceInputErrorOptions, VoiceInputProviderV1, VoiceTranscriptionOptions } from "@voiceinput/provider";
+//#region src/text-engine/types.d.ts
+type VoiceInputTextTarget = HTMLInputElement | HTMLTextAreaElement;
+type VoiceInputInterimBehavior = "inline" | "expose";
+type VoiceInputTextSpanState = "provisional" | "finalized" | "frozen" | "transformed";
+interface VoiceInputTextSelection {
+  readonly start: number;
+  readonly end: number;
+  readonly direction: "forward" | "backward" | "none";
+}
+interface VoiceInputTextSpan {
+  readonly id: number;
+  readonly start: number;
+  readonly end: number;
+  readonly text: string;
+  readonly state: VoiceInputTextSpanState;
+}
+interface VoiceInputTextEngineSnapshot {
+  readonly value: string;
+  readonly selection: VoiceInputTextSelection | null;
+  readonly interimTranscript: string;
+  readonly spans: readonly VoiceInputTextSpan[];
+}
+/**
+ * Connects the engine's immediate shadow value to controlled application state.
+ *
+ * `getValue` supplies the value when a target is attached. `onValueChange`
+ * requests an application update but is not expected to commit synchronously.
+ * Pass each value committed by the application to
+ * `reconcileControlledValue` on the text engine.
+ */
+interface VoiceInputControlledTextBinding {
+  getValue(): string;
+  onValueChange(value: string): void;
+  /** Notify through a native input event instead of the binding callback. */
+  dispatchInput?: boolean;
+}
+type VoiceInputTransformTranscript = (text: string) => PromiseLike<string> | string;
+interface VoiceInputTextLimit {
+  readonly type: "text-limit";
+  readonly maxLength: number;
+  readonly text: string;
+  readonly insertedText: string;
+  readonly source: "interim" | "final" | "transform";
+}
+type VoiceInputTextEngineEvent = VoiceInputTextLimit | {
+  type: "target-unavailable" | "reset";
+};
+interface CreateVoiceInputTextEngineOptions {
+  interimBehavior?: VoiceInputInterimBehavior;
+  controlled?: VoiceInputControlledTextBinding;
+  transformTranscript?: VoiceInputTransformTranscript;
+  transformTimeoutMs?: number;
+}
+interface VoiceInputTextCompletion {
+  readonly processing: boolean;
+  readonly result: Promise<readonly VoiceInputError$1[]>;
+}
+interface VoiceInputTextEngine {
+  getSnapshot(): VoiceInputTextEngineSnapshot;
+  setTarget(target: VoiceInputTextTarget | null): void;
+  captureSelection(): VoiceInputTextSelection | null;
+  reconcileControlledValue(value: string): void;
+  updateOptions(options: Omit<CreateVoiceInputTextEngineOptions, "controlled">): void;
+  begin(): void;
+  applyInterim(text: string, segmentId?: string): void;
+  applyFinal(text: string, segmentId?: string): void;
+  complete(): VoiceInputTextCompletion;
+  cancel(): void;
+  undo(): void;
+  redo(): void;
+  isWritable(): boolean;
+  subscribe(listener: (event: VoiceInputTextEngineEvent) => void): () => void;
+  destroy(): void;
+}
+//#endregion
+//#region src/text-engine.d.ts
+declare function createVoiceInputTextEngine(options?: CreateVoiceInputTextEngineOptions): VoiceInputTextEngine;
+//#endregion
+//#region src/session.d.ts
+type VoiceInputStatus = "idle" | "requesting-permission" | "connecting" | "listening" | "stopping" | "processing" | "error";
+type VoiceInputStopReason = "user" | "max-duration" | "replaced" | "max-length" | "target-unavailable" | "backgrounded";
+interface VoiceInputSnapshot {
+  readonly status: VoiceInputStatus;
+  readonly transcript: string;
+  readonly interimTranscript: string;
+  readonly finalTranscript: string;
+  readonly error: VoiceInputError | null;
+}
+type VoiceInputSessionEvent = VoiceInputTextLimit | {
+  type: "status-change";
+  previousStatus: VoiceInputStatus;
+  status: VoiceInputStatus;
+} | {
+  type: "interim";
+  text: string;
+  segmentId: string;
+  transcript: string;
+  transcriptChanged: boolean;
+} | {
+  type: "final";
+  text: string;
+  segmentId: string;
+  transcript: string;
+  transcriptChanged: boolean;
+  finalTranscriptChanged: boolean;
+} | {
+  type: "duration-warning";
+  remainingMs: number;
+  maxDurationMs: number;
+} | {
+  type: "stop";
+  reason: VoiceInputStopReason;
+} | {
+  type: "cancel";
+} | {
+  type: "speech-start";
+} | {
+  type: "speech-end";
+} | {
+  type: "error";
+  error: VoiceInputError;
+};
+interface VoiceAudioSourcePrepareOptions {
+  sampleRate: number;
+  abortSignal: AbortSignal;
+  onAcquired?(): void;
+}
+interface PreparedVoiceAudioSource {
+  readonly stream: ReadableStream<Int16Array>;
+  start(): PromiseLike<void> | void;
+  stop(): PromiseLike<void> | void;
+  abort(reason?: unknown): void;
+}
+interface VoiceAudioSource {
+  prepare(options: VoiceAudioSourcePrepareOptions): PromiseLike<PreparedVoiceAudioSource>;
+}
+interface CreateVoiceInputSessionOptions extends VoiceTranscriptionOptions {
+  provider: VoiceInputProviderV1;
+  audioSource: VoiceAudioSource;
+  textEngine?: VoiceInputTextEngine;
+  maxDurationMs?: number;
+  connectionTimeoutMs?: number;
+}
+interface VoiceInputSession {
+  getSnapshot(): VoiceInputSnapshot;
+  subscribe(listener: (event: VoiceInputSessionEvent) => void): () => void;
+  /** Applies to the next recording; a running session keeps its configuration. */
+  updateOptions(options: Omit<CreateVoiceInputSessionOptions, "textEngine">): void;
+  start(): Promise<void>;
+  stop(reason?: VoiceInputStopReason): Promise<void>;
+  cancel(): Promise<void>;
+  toggle(): Promise<void>;
+}
+declare function createVoiceInputSession(options: CreateVoiceInputSessionOptions): VoiceInputSession;
+//#endregion
+//#region src/browser-audio.d.ts
+type BrowserVoiceInputCapability = "secure-context" | "media-devices" | "get-user-media" | "audio-context" | "audio-worklet";
+interface BrowserVoiceInputSupport {
+  readonly isSupported: boolean;
+  readonly missingCapabilities: readonly BrowserVoiceInputCapability[];
+}
+interface CreateBrowserAudioSourceOptions {
+  /** Additional microphone constraints. VoiceInput always requests mono audio. */
+  constraints?: MediaTrackConstraints;
+  /** Duration of each emitted PCM16 frame. Defaults to 20 milliseconds. */
+  frameDurationMs?: number;
+  /** Self-hosted AudioWorklet module URL. The Blob-backed module is used by default. */
+  workletModuleUrl?: string | URL;
+}
+declare function getBrowserVoiceInputSupport(): BrowserVoiceInputSupport;
+declare function createBrowserAudioSource(options?: CreateBrowserAudioSourceOptions): VoiceAudioSource;
+declare function normalizeBrowserAudioError(error: unknown): VoiceInputError$1;
+//#endregion
+//#region src/audio-worklet-source.d.ts
+declare const AUDIO_WORKLET_SOURCE: string;
+//#endregion
+export { type BrowserVoiceInputCapability, type BrowserVoiceInputSupport, type CreateBrowserAudioSourceOptions, type CreateVoiceInputSessionOptions, type CreateVoiceInputTextEngineOptions, type PreparedVoiceAudioSource, AUDIO_WORKLET_SOURCE as VOICE_INPUT_AUDIO_WORKLET_SOURCE, type VoiceAudioSource, type VoiceAudioSourcePrepareOptions, type VoiceInputControlledTextBinding, VoiceInputError, type VoiceInputErrorCode, type VoiceInputErrorOptions, type VoiceInputInterimBehavior, type VoiceInputSession, type VoiceInputSessionEvent, type VoiceInputSnapshot, type VoiceInputStatus, type VoiceInputStopReason, type VoiceInputTextCompletion, type VoiceInputTextEngine, type VoiceInputTextEngineEvent, type VoiceInputTextEngineSnapshot, type VoiceInputTextLimit, type VoiceInputTextSelection, type VoiceInputTextSpan, type VoiceInputTextSpanState, type VoiceInputTextTarget, type VoiceInputTransformTranscript, createBrowserAudioSource, createVoiceInputSession, createVoiceInputTextEngine, getBrowserVoiceInputSupport, normalizeBrowserAudioError };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/text-engine/types.ts","../src/text-engine.ts","../src/session.ts","../src/browser-audio.ts","../src/audio-worklet-source.ts"],"mappings":";;KAEY,uBAAuB,mBAAmB;KAC1C;KACA;UAGK;WACN;WACA;WACA;;UAGM;WACN;WACA;WACA;WACA;WACA,OAAO;;UAGD;WACN;WACA,WAAW;WACX;WACA,gBAAgB;;;;;;;;;;UAWV;EACf;EACA,cAAc;;EAEd;;KAGU,iCACV,iBACG;UAEY;WACN;WACA;WACA;WACA;WACA;;KAGC,4BACV;EAAwB;;UAET;EACf,kBAAkB;EAClB,aAAa;EACb,sBAAsB;EACtB;;UAGe;WACN;WACA,QAAQ,iBAAiB;;UAGnB;EACf,eAAe;EACf,UAAU,QAAQ;EAClB,oBAAoB;EACpB,yBAAyB;EACzB,cACE,SAAS,KAAK;EAEhB;EACA,aAAa,cAAc;EAC3B,WAAW,cAAc;EACzB,YAAY;EACZ;EACA;EACA;EACA;EACA,UAAU,WAAW,OAAO;EAC5B;;;;iBC7Dc,2BACd,UAAS,oCACR;;;KCDS;KASA;UAQK;WACN,QAAQ;WACR;WACA;WACA;WACA,OAAO;;KAGN,yBACR;EAEE;EACA,gBAAgB;EAChB,QAAQ;;EAGR;EACA;EACA;EACA;EACA;;EAGA;EACA;EACA;EACA;EACA;EACA;;EAGA;EACA;EACA;;EAEA;EAAc,QAAQ;;EACtB;;EACA;;EACA;;EACA;EAAe,OAAO;;UAEX;EACf;EACA,aAAa;EACb;;UAGe;WACN,QAAQ,eAAe;EAChC,SAAS;EACT,QAAQ;EACR,MAAM;;UAGS;EACf,QACE,SAAS,iCACR,YAAY;;UAGA,uCAAuC;EACtD,UAAU;EACV,aAAa;EACb,aAAa;EACb;EACA;;UAGe;EACf,eAAe;EACf,UAAU,WAAW,OAAO;;EAE5B,cACE,SAAS,KAAK;EAEhB,SAAS;EACT,KAAK,SAAS,uBAAuB;EACrC,UAAU;EACV,UAAU;;iBA0BI,wBACd,SAAS,iCACR;;;KCvIS;UAOK;WACN;WACA,8BAA8B;;UAGxB;;EAEf,cAAc;;EAEd;;EAEA,4BAA4B;;iBAGd,+BAA+B;iBAyC/B,yBACd,UAAS,kCACR;iBAqSa,2BAA2B,iBAAiB;;;cCpL/C"}