@seams/voice-capture 0.67.1 → 0.68.1

package/dist/example/example.js

@@ -9,7 +9,7 @@ configureVoiceCapture({ assetBase: '../assets/' });
 const ENROLLMENT_PHRASES = [
   'My voice is my signature for this wallet.',
   'I send money only when I say so.',
-  'Seams, please learn how I sound today.',
+  'Please learn how I sound today.',
 ];
 
 const log = document.querySelector('#log');
@@ -18,7 +18,13 @@ const detector = () => (document.querySelector('#level').checked ? 'level' : 'mo
 
 /** Shows one sentence, records it and returns its WAV, or null when the person closed the card. */
 async function recordSentence(sentence, signal) {
-  const surface = openPhraseCard({ sentence, signal, detector: detector(), frame: { parent } });
+  const surface = openPhraseCard({
+    sentence,
+    signal,
+    detector: detector(),
+    autoStart: document.querySelector('#auto').checked,
+    frame: { parent },
+  });
   try {
     const recording = await surface.record();
     if (recording.kind === 'cancelled') return null;

package/dist/example/index.html

@@ -17,6 +17,7 @@
       <h1>voice-capture</h1>
       <p>This page uses only <code>@seams/voice-capture</code>. The audio stays in the page.</p>
       <label><input type="checkbox" id="level" /> Record with no model download (the detector <code>level</code>)</label>
+      <label><input type="checkbox" id="auto" /> Start the recording with no press on Record (<code>autoStart</code>)</label>
       <div class="row">
         <button class="start" id="sentence">Record one sentence</button>
         <button class="start" id="enroll">Record three enrollment phrases</button>

package/dist/types/card/index.d.ts

@@ -1,4 +1,4 @@
-export { openPhraseCard, type PhraseCardFrame, type PhraseCardInput } from './surface';
+export { openPhraseCard, type PhraseCardControl, type PhraseCardControls, type PhraseCardFrame, type PhraseCardInput, } from './surface';
 export type { PhraseCheckView, PhraseChoice, PhraseRecording, PhraseResultView, PhraseSegmentState, PhraseSurface, PhraseText, PhraseView, } from './types';
 export { leaveSurface, VoicePrompt, type PhraseDisplay, type PromptChange } from './prompt';
 export { PhraseCard, type HandedOverRows, type PromptCopy } from './phraseCard';

package/dist/types/card/prompt.d.ts

@@ -46,10 +46,11 @@ export declare class VoicePrompt {
     /** The text to show for a phrase, such as the phrase with its commas. */
     display?: PhraseDisplay);
     /**
-     * In an app's dialog with a step before this card, the corner control returns to that step.
-     * It still ends the card as cancelled; the Wallet tells the app that the person went back.
+     * In an app's dialog with a step before this card, Back in the leading corner returns to that
+     * step. With `close`, Close stays in the trailing corner and ends the whole dialog; without it,
+     * Back takes Close's place. Each one ends the card as cancelled. The result is the Back control.
      */
-    showBack(): void;
+    showBack(close: boolean): HTMLButtonElement;
     /**
      * Moves the rows to a new state. The rows whose content changes fade out together, take their
      * new content and fade in one after another; the other rows stay still. A change that comes

package/dist/types/card/ribbon.d.ts

@@ -27,6 +27,8 @@ export declare class VoiceRibbon {
     private stopped;
     constructor(document: Document, checking?: VoiceCheckingStyle);
     readonly readLevel: () => number;
+    /** The voice line's width now: 1, or the theme's `voiceLineWidth`. */
+    private lineWidth;
     setPhase(phase: RibbonPhase): void;
     /**
      * Closes the ring into the success seal; resolves when the check is drawn.

package/dist/types/card/rowMotion.d.ts

@@ -0,0 +1,5 @@
+export declare const ROW_OUT_MS = 150;
+export declare const ROW_IN_MS = 200;
+export declare const ROW_IN_DELAY_MS = 20;
+export declare const ROW_STAGGER_MS = 30;
+export declare const ROW_EASE = "cubic-bezier(0.2, 0, 0, 1)";

package/dist/types/card/surface.d.ts

@@ -6,19 +6,35 @@ export type PhraseCardFrame = Readonly<{
     parent?: HTMLElement;
     /** More class names for the surface element, such as the host's theme class. */
     className?: string;
-    /** Shows the Back control of the prompt. */
-    back?: boolean;
+    /**
+     * The corner controls of the card. `close` (default): Close in the trailing corner. `back`: Back
+     * in the leading corner, in place of Close. `back_and_close`: both. Each one, and Escape, ends
+     * the card as cancelled.
+     */
+    controls?: PhraseCardControls;
+    /** Runs when the person presses Back or Close, before the card ends. Escape is not a press. */
+    pressed?(control: PhraseCardControl): void;
     /** The host sizes its frame to the surface, so the card follows the frame. */
     hugged?: boolean;
     /** Runs when the surface is in the document. Its return value runs when the surface closes. */
     mounted?(element: HTMLElement): (() => void) | void;
 }>;
+/** The corner controls of a phrase card. */
+export type PhraseCardControls = 'close' | 'back' | 'back_and_close';
+/** One corner control of a phrase card. */
+export type PhraseCardControl = 'back' | 'close';
 export type PhraseCardInput = Readonly<{
     sentence: string;
     signal: AbortSignal;
     frame?: PhraseCardFrame;
     /** The speech detector of the recordings. Default: `model`. */
     detector?: VoiceRecordingOptions['detector'];
+    /**
+     * The first recording starts when the caller asks for it, with no press on Record. Use it
+     * when the person just asked for this card, with a click or a key. If the browser does not
+     * start audio without a press, the card stays with its Record button.
+     */
+    autoStart?: boolean;
 }>;
 /**
  * Shows the given sentence in the prompt. The surface records clips with the quality check, and

package/dist/types/card/visual.d.ts

@@ -1,5 +1,8 @@
+import { type VoiceBeamColorVariant } from 'voice-glow';
 import type { VoiceActivityEvent } from '../microphone';
 import { type VoiceCheckingStyle } from './ribbon';
+/** The theme's `voiceBeam`, the name of a Beam palette, or the default one. */
+export declare function beamPalette(value: string): VoiceBeamColorVariant;
 /** Shared by enrollment, unlock and signing. The recorder remains the only audio owner. */
 export declare class VoiceVisual {
     readonly element: SVGSVGElement;

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { configureVoiceCapture, type VoiceCaptureConfig, type VoiceMicrophonePreference, type VoiceMicrophonePreferenceStore, } from './config';
-export { recordVoice, requireVoiceForeground, requireVoiceUserAction, voiceQualityMessage, InsufficientVoiceAudioError, type VoiceActivityEvent, type VoiceCaptureEvent, type VoiceCaptureObserver, type VoiceCaptureQuality, type VoiceRecordingOptions, type VoiceRecordingResult, } from './microphone';
+export { recordVoice, requireVoiceForeground, requireVoiceUserAction, voiceQualityMessage, InsufficientVoiceAudioError, VoiceUserActionNeededError, type VoiceActivityEvent, type VoiceCaptureEvent, type VoiceCaptureObserver, type VoiceCaptureQuality, type VoiceRecordingOptions, type VoiceRecordingResult, } from './microphone';
 export { openVoiceMicrophone, rememberVoiceMicrophone, useSystemVoiceMicrophone, VoiceMicrophoneInterruptedError, type VoiceMicrophone, } from './microphoneInput';
 export { endPauseMs, expectedSpeechMs } from './speechPause';
 export { createVoiceActivity, levelDetector, voiceActivityModel, type SpeechDetector, } from './voiceActivity';

package/dist/types/microphone.d.ts

@@ -73,6 +73,13 @@ export type VoiceRecordingOptions = Readonly<{
 export declare function requireVoiceUserAction(): void;
 /** Throws unless the page is visible and has the focus. */
 export declare function requireVoiceForeground(): void;
+/**
+ * The browser starts audio only after the person acts on the page (a click or a key). A
+ * recording that starts by itself gets this error, and the caller then shows its Record control.
+ */
+export declare class VoiceUserActionNeededError extends Error {
+    constructor();
+}
 /**
  * Records one utterance at 16 kHz. The recording ends after a pause, or after 8 s. A recording
  * with less than 0.6 s of speech is `insufficient_audio`. The samples hold the speech with 0.2 s

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seams/voice-capture",
-  "version": "0.67.1",
+  "version": "0.68.1",
   "type": "module",
   "description": "Records one spoken sentence in the browser, with speech detection, a quality check and a phrase card",
   "license": "Apache-2.0",