@shogo-ai/voice 1.9.13 → 2.4.1

package/dist/{organicParticlesShaders-DIva0vBO.d.ts → organicParticlesShaders-seZq7jYX.d.cts}

@@ -1,203 +1,5 @@
 import { UIMessage } from 'ai';
 
-/**
- * Shared option / result types for `useVoiceConversation` across
- * platforms. The web hook ([packages/sdk/src/voice/react]) and the
- * native hook ([packages/sdk/src/voice/native]) both export their own
- * `UseVoiceConversationOptions` / `UseVoiceConversationResult`
- * types — typically by re-exporting `BaseVoiceConversationOptions` /
- * `BaseVoiceConversationResult` from this module — so consumers can
- * import them from whichever subpath they're using.
- */
-interface BaseVoiceConversationOptions {
-    /** Name of the companion the user is talking to (passed as a dynamic variable). */
-    characterName: string;
-    /** Server path that mints an 11Labs signed URL for this user. Default: `/api/voice/signed-url`. */
-    signedUrlPath?: string;
-    /** Server path the built-in `add_memory` tool POSTs to. Default: `/api/memory/add`. */
-    memoryAddPath?: string;
-    /** Server path used to auto-inject memory context. Default: `/api/memory/retrieve`. */
-    memoryRetrievePath?: string;
-    /** Server path the transcript is POSTed to when the session ends. Default: `/api/memory/ingest`. */
-    transcriptIngestPath?: string;
-    /** Disable the built-in memory context auto-injection. Default: `true` (enabled). */
-    autoInjectMemory?: boolean;
-    /** Disable the built-in `add_memory` client tool. Default: `true` (enabled). */
-    includeMemoryTool?: boolean;
-    /**
-     * Additional client tools merged onto `add_memory`. Tools defined here with
-     * the name `add_memory` override the built-in implementation.
-     */
-    clientTools?: Record<string, (params: Record<string, unknown>) => Promise<string> | string>;
-    /**
-     * Called once per session with the accumulated transcript when the session
-     * disconnects. Defaults to POST `transcriptIngestPath`; set this to suppress
-     * or replace that behaviour.
-     */
-    onTranscript?: (transcript: string) => void | Promise<void>;
-    /**
-     * Credentials mode for built-in fetch calls.
-     *
-     * - Defaults to `same-origin` in the legacy cookie path.
-     * - Defaults to `omit` when `shogoApiKey` is provided (bearer auth is
-     *   self-contained and you don't want browsers to attach unrelated
-     *   third-party cookies cross-origin).
-     * - Explicit values always win — pass `'include'` to carry both a cookie
-     *   and the bearer in a hybrid same-origin app.
-     */
-    fetchCredentials?: RequestCredentials;
-    /**
-     * Shogo API key (`shogo_sk_*`) used to authenticate voice routes. When
-     * provided, the hook attaches `Authorization: Bearer <key>` to the
-     * signed-URL fetch and memory fetches, and appends `?projectId=` to
-     * the signed-URL path. Either `shogoApiKey` or a session cookie must
-     * be resolvable by the server — both may be passed; the server's
-     * `apiKeyOrSession` middleware picks bearer first.
-     */
-    shogoApiKey?: string;
-    /**
-     * Project id (Shogo's `projectId`). Required alongside `shogoApiKey`
-     * for Mode B voice. The server uses it to look up / provision the
-     * project's ElevenLabs agent and resolve the workspace.
-     */
-    projectId?: string;
-    /**
-     * Optional named agent to talk to. Forwarded as `?agentName=` on
-     * the signed-URL fetch and resolved server-side to a project-scoped
-     * `ProjectAgent` row (created via `shogo deploy`). When omitted,
-     * the server resolves the project's `default` agent.
-     *
-     * The same `agentName` reaches the same persona via
-     * `useChatConversation({ agentName })` — voice and chat are two
-     * transports for one agent record.
-     */
-    agentName?: string;
-    /** Called on connection errors. */
-    onError?: (error: unknown) => void;
-    /** Called on each message (user or agent) for debugging / custom UI. */
-    onMessage?: (message: {
-        source: string;
-        message: string;
-    }) => void;
-    /**
-     * Stable conversation id used to correlate this voice session with
-     * a sibling text thread (see `BaseChatConversationOptions.conversationId`).
-     *
-     * When set, forwarded to ElevenLabs as a `conversation_id` dynamic
-     * variable so the agent's prompt can reference it (`{{conversation_id}}`),
-     * and surfaced on `BaseVoiceConversationResult.conversationId` so a
-     * single bridge component can read the same value from either hook.
-     *
-     * Independent of the convai-side conversation id — see
-     * `BaseVoiceConversationResult.convaiConversationId` for that. The
-     * caller-supplied value wins on `result.conversationId` so consumers
-     * who keep their own thread store don't have to special-case the
-     * default. Optional; when omitted, `result.conversationId` mirrors
-     * the convai conversation id once the session connects.
-     */
-    conversationId?: string;
-    /**
-     * Extra dynamic variables forwarded to ElevenLabs at session start.
-     * Merged on top of the SDK's built-in variables — `character_name`,
-     * `user_context`, and `conversation_id` (when supplied) always win
-     * on collision so consumers can't accidentally override them.
-     *
-     * Typical use: surface per-user fields from the consumer's own
-     * `Companion` row (display name, relationship stage, custom greeting
-     * tokens) so the agent's prompt can reference them via
-     * `{{var_name}}`. Variables also need to be declared in the agent's
-     * `dynamic_variable_placeholders` (set at deploy time) for EL to
-     * pick up the value.
-     *
-     * Non-string values are coerced via `String(...)` before being
-     * forwarded; `null` / `undefined` values are silently dropped.
-     */
-    dynamicVariables?: Record<string, unknown> | null;
-}
-interface BaseVoiceConversationResult {
-    /**
-     * Begin a new session. Requests microphone permission and fetches a
-     * signed URL.
-     *
-     * `suppressFirstMessage` mirrors the option on `restart()` — when
-     * `true`, the new session is opened with `overrides.agent.firstMessage = ''`
-     * so the agent skips its opening greeting. Useful when the consumer
-     * is programmatically reconnecting (e.g. to deliver a one-shot spoken
-     * summary) and does not want to hear the configured intro.
-     */
-    start: (options?: {
-        suppressFirstMessage?: boolean;
-    }) => Promise<void>;
-    /** End the current session (if any). */
-    end: () => void;
-    /**
-     * Tear down the active session and immediately reconnect. Primarily
-     * used as a programmatic barge-in: ElevenLabs doesn't expose a public
-     * `interrupt()` on `useConversation`, so stopping the agent mid-
-     * utterance requires a fast disconnect + reconnect. When
-     * `suppressFirstMessage` is `true` (the default), the new session is
-     * started with `overrides.agent.firstMessage = ''` so the agent does
-     * not replay its intro. The accumulated transcript is preserved
-     * across the reconnect gap.
-     */
-    restart: (options?: {
-        suppressFirstMessage?: boolean;
-    }) => Promise<void>;
-    /** `'disconnected' | 'connecting' | 'connected'`. */
-    status: 'disconnected' | 'connecting' | 'connected';
-    /** Whether the agent is currently speaking. */
-    isSpeaking: boolean;
-    /** Whether the agent is currently listening. */
-    isListening: boolean;
-    /** Whether the microphone is currently muted (input audio is gated off). */
-    isMuted: boolean;
-    /**
-     * Toggle the microphone mute state without tearing down the session.
-     * Wraps `@elevenlabs/react` (or `@elevenlabs/react-native`)'s
-     * `setMuted`, which in turn calls `conversation.setMicMuted()`.
-     * Muting does not end the WebSocket or release the underlying media
-     * stream; it simply stops input audio from being forwarded to the
-     * server.
-     */
-    setMuted: (isMuted: boolean) => void;
-    /** For consumers who want to drive their own visualisation / lipsync. */
-    getOutputByteFrequencyData: () => Uint8Array | null;
-    /** Imperatively send a contextual update (e.g. "user navigated to X"). */
-    sendContextualUpdate: (text: string) => void;
-    /**
-     * Imperatively inject a user-role message, forcing the agent to take
-     * its next turn immediately (rather than waiting for the human to
-     * speak). Useful for out-of-band prompts like "please summarise what
-     * just happened". The injected text is *not* spoken aloud — the agent
-     * treats it as if the user said it.
-     */
-    sendUserMessage: (text: string) => void;
-    /**
-     * Low-level signal that the user is active (typing, clicking) so the
-     * agent doesn't try to fill silence. Used as a fallback nudge when we
-     * want to keep the session "warm" without forcing a full turn.
-     */
-    sendUserActivity: () => void;
-    /**
-     * Stable conversation id for cross-transport correlation. Returns the
-     * caller-supplied `BaseVoiceConversationOptions.conversationId` when
-     * one was provided; otherwise mirrors the convai conversation id once
-     * the session connects (and is `null` while disconnected).
-     *
-     * Pass this same value to `useChatConversation({ conversationId })`
-     * to stitch a text thread onto the same logical conversation.
-     */
-    conversationId: string | null;
-    /**
-     * The convai-side conversation id reported by ElevenLabs on connect.
-     * Always reflects the underlying transport id (or `null` while
-     * disconnected) regardless of whether the consumer supplied an id.
-     * Useful for log correlation against ElevenLabs dashboards even
-     * when the consumer is using their own ids on `conversationId`.
-     */
-    convaiConversationId: string | null;
-}
-
 /**
  * Shared option / result types for `useChatConversation` across
  * platforms.
@@ -413,228 +215,6 @@ interface BaseChatConversationResult {
     conversationId: string | null;
 }
 
-/**
- * Configuration surface for the `OrganicSphere` audio-reactive
- * visualization. All values are plain numbers / strings / null so the
- * whole object is JSON-serializable — save it, transport it, paste it
- * into a preset library.
- *
- * The sphere renders four eased "variations" driven by frequency bands:
- *
- *   low    → modulates time-evolution speed (drift + noise phase)
- *   volume → drives `uDisplacementStrength` (how far each vertex pushes
- *            out from the sphere surface)
- *   medium → drives `uFresnelMultiplier` (how bright the lighting pass
- *            gets near silhouette edges)
- *   high   → drives `uDistortionStrength` (large-scale warping of the
- *            underlying position field before displacement)
- *
- * Each variation has a resting `idle` value used when audio is off, a
- * `gain` multiplier applied to the band level, a `floor` minimum while
- * audio is playing, and separate attack / decay easing rates.
- *
- * Use `resolveOrganicSphereConfig(partial)` to merge a partial override
- * into the defaults; `OrganicSphere` does this internally so consumers
- * can pass any subset.
- */
-interface BandReactivity {
-    /** Resting target used when no audio source is connected. */
-    idle: number;
-    /** Multiplier applied to the normalized band level (0–1) while audio plays. */
-    gain: number;
-    /** Minimum target while audio is playing, before easing. */
-    floor: number;
-    /**
-     * Easing rate when the target rises above `current` (snappier attack
-     * at higher values; per-ms-of-frame delta, not per-frame).
-     */
-    attack: number;
-    /** Easing rate when the target falls below `current` (per-ms). */
-    decay: number;
-}
-interface OrganicSphereConfig {
-    /** Color of light A (default is a deep Shogo burnt orange). */
-    lightAColor: string;
-    /** Color of light B (default is a warm Shogo amber). */
-    lightBColor: string;
-    /** Intensity multiplier for light A. Higher = brighter contribution. */
-    lightAIntensity: number;
-    /** Intensity multiplier for light B. */
-    lightBIntensity: number;
-    /**
-     * Rim-highlight color. `null` falls back to `lightBColor`, which keeps
-     * the silhouette monochromatic and impossible to wash out to white.
-     */
-    rimColor: string | null;
-    /**
-     * Fresnel value above which the rim starts contributing. Higher →
-     * tighter rim; lower → rim bleeds across more of the surface.
-     */
-    rimThreshold: number;
-    /** Exponent on the rim falloff curve. Higher → sharper edge. */
-    rimPower: number;
-    /** Spatial frequency of the distortion noise (`uDistortionFrequency`). */
-    distortionFrequency: number;
-    /** Spatial frequency of the displacement noise (`uDisplacementFrequency`). */
-    displacementFrequency: number;
-    /** Fresnel offset — shifts where the rim and lighting gradient peak. */
-    fresnelOffset: number;
-    /** Fresnel power — steepens or softens the lighting gradient. */
-    fresnelPower: number;
-    /**
-     * Volume variation → `uDisplacementStrength`. Driven by the loudest
-     * of the first three bands (`max(l0, l1, l2)`).
-     */
-    volume: BandReactivity;
-    /** Mid-band variation → `uFresnelMultiplier`. Driven by `l1`. */
-    medium: BandReactivity;
-    /** High-band variation → `uDistortionStrength`. Driven by `l2`. */
-    high: BandReactivity;
-    /**
-     * Low-band variation → time evolution speed (how fast the noise
-     * offset scrolls). Driven by `l0`.
-     */
-    low: BandReactivity;
-    /** Camera z-position. Larger = more zoomed out. */
-    cameraZ: number;
-    /** Vertical field-of-view in degrees. */
-    fov: number;
-    /**
-     * Seed used to derive the initial "wander" offset phase, so identical
-     * audio produces identical visuals across playbacks. Any integer is
-     * fine; change it to roll a different starting pose. When `active`
-     * flips from `false` → `true`, the sphere resets to this phase.
-     */
-    seed: number;
-    /**
-     * Sphere mesh subdivisions. Higher = smoother displacement, more GPU
-     * cost. Changing at runtime triggers a scene rebuild.
-     */
-    subdivisions: number;
-    /**
-     * Device-pixel-ratio cap. `null` picks `min(devicePixelRatio, 2)`.
-     * Set to `1` for lower-end devices.
-     */
-    maxPixelRatio: number | null;
-    /**
-     * Scene clear color. `null` keeps the canvas fully transparent so the
-     * sphere blends into the host UI.
-     */
-    backgroundColor: string | null;
-}
-/**
- * Preset tuned for Shogo's Voice Mode hero — warm Shogo orange palette,
- * rim tied to `lightBColor`, camera zoomed back so the sphere reads
- * "contained" rather than "looming", reactivity values copied from
- * Bruno Simon's upstream `organic-sphere` demo so silhouettes animate
- * faithfully.
- */
-declare const DEFAULT_ORGANIC_SPHERE_CONFIG: OrganicSphereConfig;
-/**
- * Merge a partial override into `DEFAULT_ORGANIC_SPHERE_CONFIG`, doing a
- * shallow merge on the root + per-band merge on `volume/medium/high/low`
- * so consumers only need to specify what they want to change.
- */
-declare function resolveOrganicSphereConfig(partial?: Partial<OrganicSphereConfig>): OrganicSphereConfig;
-
-/**
- * Configuration surface for the `OrganicParticles` audio-reactive
- * visualization — a particle-cloud sibling of `OrganicSphere`.
- *
- * Shares the same `BandReactivity` shape and four-band model
- * (volume / medium / high / low) as the sphere, so audio-tuning muscle
- * memory carries over. What changes is the cloud-specific fields:
- *
- *   volume → radial displacement (how far the cloud bursts outward)
- *   medium → particle size boost (how puffy each point renders)
- *   high   → swirl strength (how much the cloud twists)
- *   low    → time evolution speed (noise phase drift)
- *
- * Like `OrganicSphereConfig`, everything is JSON-serializable.
- */
-
-interface OrganicParticlesConfig {
-    /**
-     * Number of particles. Changing this rebuilds the scene. Sweet spot
-     * for visual density without frame-drop is 20k–80k on a modern GPU.
-     */
-    count: number;
-    /**
-     * Inner / outer radius of the seeded spawn shell. Particles are
-     * uniformly distributed between these two radii so the cloud has
-     * perceptible thickness rather than sitting on a single sphere.
-     */
-    innerRadius: number;
-    outerRadius: number;
-    /** Spatial frequency of the Perlin noise warp. */
-    noiseFrequency: number;
-    /** Strength of the noise warp. */
-    noiseStrength: number;
-    /**
-     * Constant per-ms Y-axis rotation applied to the whole cloud,
-     * independent of audio. `0` (default) means the cloud is perfectly
-     * still when no audio plays. Positive = spin right, negative = left.
-     */
-    rotationBias: number;
-    /**
-     * Rate (per ms) at which `uTime` advances the per-particle swirl
-     * angle in the shader, independent of audio. `0` (default) = swirl
-     * only responds to audio high-band + particle height.
-     */
-    swirlTimeRate: number;
-    /**
-     * Rate (per ms) at which `uTime` advances while the cloud is idle
-     * (i.e. `active === false`). Lets the Perlin noise field keep
-     * shimmering subtly when nothing is playing so the cloud doesn't feel
-     * dead. `0` = fully frozen when paused. Default `0.0001` ≈ one full
-     * noise period every ~10 s — perceptible but not distracting.
-     */
-    idleNoiseRate: number;
-    /** Base particle size (before audio boost / perspective scaling). */
-    sizeBase: number;
-    /**
-     * Edge softness of each particle sprite, in [0, 1]. `0` = hard disc,
-     * `1` = heavy feather/plasma. ~0.6 reads as "nebula".
-     */
-    softness: number;
-    /** Overall opacity multiplier. */
-    opacity: number;
-    /** Color at the cloud core (low `vHeat`). */
-    colorCool: string;
-    /** Color at the cloud fringe (high `vHeat`). */
-    colorHot: string;
-    /** volume → radial displacement push. */
-    volume: BandReactivity;
-    /** medium → per-particle size boost. */
-    medium: BandReactivity;
-    /** high → swirl / twist amount. */
-    high: BandReactivity;
-    /** low → time evolution speed. */
-    low: BandReactivity;
-    cameraZ: number;
-    fov: number;
-    /**
-     * Seed used to generate the initial particle positions AND the wander
-     * phase. Same seed + same audio → same visual across playbacks.
-     */
-    seed: number;
-    /** `null` picks `min(devicePixelRatio, 2)`. */
-    maxPixelRatio: number | null;
-    /** Scene clear color. `null` = transparent. */
-    backgroundColor: string | null;
-}
-/**
- * Preset tuned to match the Shogo warm-orange palette used by
- * `DEFAULT_ORGANIC_SPHERE_CONFIG`, so the two modes read as siblings.
- * Count/size defaults target 60fps on mid-tier GPUs.
- */
-declare const DEFAULT_ORGANIC_PARTICLES_CONFIG: OrganicParticlesConfig;
-/**
- * Merge a partial override into `DEFAULT_ORGANIC_PARTICLES_CONFIG`,
- * with per-band shallow merges for `volume/medium/high/low`.
- */
-declare function resolveOrganicParticlesConfig(partial?: Partial<OrganicParticlesConfig>): OrganicParticlesConfig;
-
 /**
  * GLSL shaders for the `OrganicSphere` audio-reactive visualization.
  *
@@ -690,4 +270,4 @@ declare const ORGANIC_PARTICLES_VERTEX_SHADER = "\n\nvec4 permute(vec4 x){return
  */
 declare const ORGANIC_PARTICLES_FRAGMENT_SHADER = "\nprecision mediump float;\n\nuniform vec3 uColorCool;\nuniform vec3 uColorHot;\nuniform float uOpacity;\nuniform float uSoftness;\n\nvarying float vHeat;\nvarying float vSeed;\n\nvoid main() {\n  vec2 centered = gl_PointCoord - vec2(0.5);\n  float distSq = dot(centered, centered);\n  if (distSq > 0.25) discard;\n\n  // Soft circular falloff. uSoftness in [0.5, 1] controls how hard the\n  // edge is: 0.5 = sharp disc, 1 = feathered blob.\n  float innerR = 0.25 * (1.0 - uSoftness);\n  float alpha = smoothstep(0.25, innerR, distSq);\n\n  // Warm/cool gradient, with a tiny seed-based tint wobble so the cloud\n  // doesn't look banded.\n  float wobble = (vSeed - 0.5) * 0.15;\n  vec3 color = mix(uColorCool, uColorHot, clamp(vHeat + wobble, 0.0, 1.0));\n\n  gl_FragColor = vec4(color, alpha * uOpacity);\n}\n";
 
-export { type BaseVoiceConversationOptions as B, type ChatClientToolFn as C, DEFAULT_ORGANIC_PARTICLES_CONFIG as D, type OrganicSphereConfig as O, PERLIN_4D as P, type BaseVoiceConversationResult as a, type BaseChatConversationOptions as b, type BaseChatConversationResult as c, type OrganicParticlesConfig as d, type BandReactivity as e, type ChatConversationStatus as f, type ChatToolDescriptor as g, DEFAULT_ORGANIC_SPHERE_CONFIG as h, ORGANIC_PARTICLES_FRAGMENT_SHADER as i, ORGANIC_PARTICLES_VERTEX_SHADER as j, ORGANIC_SPHERE_FRAGMENT_SHADER as k, ORGANIC_SPHERE_VERTEX_SHADER as l, resolveOrganicSphereConfig as m, resolveOrganicParticlesConfig as r };
+export { type BaseChatConversationOptions as B, type ChatClientToolFn as C, ORGANIC_PARTICLES_FRAGMENT_SHADER as O, PERLIN_4D as P, type BaseChatConversationResult as a, type ChatConversationStatus as b, type ChatToolDescriptor as c, ORGANIC_PARTICLES_VERTEX_SHADER as d, ORGANIC_SPHERE_FRAGMENT_SHADER as e, ORGANIC_SPHERE_VERTEX_SHADER as f };