@elizaos/capacitor-swabble 1.0.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,218 @@
+import type { PluginListenerHandle } from "@capacitor/core";
+/**
+ * Configuration for voice wake detection
+ */
+export interface SwabbleConfig {
+    /** Wake word triggers (e.g., ["eliza"]) */
+    triggers: string[];
+    /** Minimum gap after trigger before command starts (seconds) */
+    minPostTriggerGap?: number;
+    /** Minimum command length in characters */
+    minCommandLength?: number;
+    /** Locale identifier for speech recognition (e.g., "en-US") */
+    locale?: string;
+    /** Audio sample rate in Hz (default: 16000) */
+    sampleRate?: number;
+    /** Whisper.cpp model size for desktop (optional) */
+    modelSize?: "tiny" | "base" | "small" | "medium" | "large";
+}
+/**
+ * Options for starting voice wake detection
+ */
+export interface SwabbleStartOptions {
+    /** Configuration for wake word detection */
+    config: SwabbleConfig;
+}
+/**
+ * Result of starting voice wake detection
+ */
+export interface SwabbleStartResult {
+    /** Whether voice wake started successfully */
+    started: boolean;
+    /** Error message if start failed */
+    error?: string;
+}
+/**
+ * Wake word detection event
+ */
+export interface SwabbleWakeWordEvent {
+    /** The detected wake word */
+    wakeWord: string;
+    /** The command text following the wake word */
+    command: string;
+    /** Full transcript text */
+    transcript: string;
+    /** Time gap between wake word and command start */
+    postGap: number;
+    /** Confidence score (0-1) if available */
+    confidence?: number;
+}
+/**
+ * Speech segment with timing information
+ */
+export interface SwabbleSpeechSegment {
+    /** Segment text */
+    text: string;
+    /** Start time in seconds from audio start */
+    start: number;
+    /** Duration in seconds */
+    duration: number;
+    /** Whether this is a final (non-partial) result */
+    isFinal: boolean;
+}
+/**
+ * Transcript event with full text and segments
+ */
+export interface SwabbleTranscriptEvent {
+    /** Full transcript text */
+    transcript: string;
+    /** Individual speech segments with timing */
+    segments: SwabbleSpeechSegment[];
+    /** Whether this is a final (non-partial) result */
+    isFinal: boolean;
+    /** Confidence score (0-1) if available */
+    confidence?: number;
+}
+/**
+ * Voice wake state change event
+ */
+export interface SwabbleStateEvent {
+    /** Current state */
+    state: "idle" | "listening" | "processing" | "error";
+    /** Reason for state change */
+    reason?: string;
+}
+/**
+ * Audio level event for visualization
+ */
+export interface SwabbleAudioLevelEvent {
+    /** Audio level (0-1) */
+    level: number;
+    /** Peak level since last event */
+    peak: number;
+}
+/**
+ * Error event
+ */
+export interface SwabbleErrorEvent {
+    /** Error code */
+    code: string;
+    /** Error message */
+    message: string;
+    /** Whether the system will attempt to recover */
+    recoverable: boolean;
+}
+/**
+ * Permission status
+ */
+export interface SwabblePermissionStatus {
+    /** Microphone permission status */
+    microphone: "granted" | "denied" | "prompt";
+    /** Speech recognition permission status */
+    speechRecognition: "granted" | "denied" | "prompt" | "not_supported";
+}
+/**
+ * Swabble Plugin Interface
+ *
+ * Provides voice wake word detection and speech-to-text capabilities.
+ * Uses native Speech framework on iOS/macOS, SpeechRecognizer on Android,
+ * and Whisper.cpp on desktop (Linux/Windows via Electrobun).
+ */
+export interface SwabblePlugin {
+    /**
+     * Start voice wake detection
+     *
+     * @param options - Configuration options
+     * @returns Promise resolving to start result
+     */
+    start(options: SwabbleStartOptions): Promise<SwabbleStartResult>;
+    /**
+     * Stop voice wake detection
+     *
+     * @returns Promise that resolves when stopped
+     */
+    stop(): Promise<void>;
+    /**
+     * Check if voice wake is currently active
+     *
+     * @returns Promise resolving to active status
+     */
+    isListening(): Promise<{
+        listening: boolean;
+    }>;
+    /**
+     * Get current configuration
+     *
+     * @returns Promise resolving to current config
+     */
+    getConfig(): Promise<{
+        config: SwabbleConfig | null;
+    }>;
+    /**
+     * Update configuration while running
+     *
+     * @param options - New configuration
+     * @returns Promise that resolves when updated
+     */
+    updateConfig(options: {
+        config: Partial<SwabbleConfig>;
+    }): Promise<void>;
+    /**
+     * Check permission status
+     *
+     * @returns Promise resolving to permission status
+     */
+    checkPermissions(): Promise<SwabblePermissionStatus>;
+    /**
+     * Request required permissions
+     *
+     * @returns Promise resolving to permission status after request
+     */
+    requestPermissions(): Promise<SwabblePermissionStatus>;
+    /**
+     * Get list of available audio input devices
+     *
+     * @returns Promise resolving to device list
+     */
+    getAudioDevices(): Promise<{
+        devices: Array<{
+            id: string;
+            name: string;
+            isDefault: boolean;
+        }>;
+    }>;
+    /**
+     * Set the audio input device
+     *
+     * @param options - Device ID to use
+     * @returns Promise that resolves when set
+     */
+    setAudioDevice(options: {
+        deviceId: string;
+    }): Promise<void>;
+    /**
+     * Add a listener for wake word detection
+     */
+    addListener(eventName: "wakeWord", listenerFunc: (event: SwabbleWakeWordEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Add a listener for transcript updates
+     */
+    addListener(eventName: "transcript", listenerFunc: (event: SwabbleTranscriptEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Add a listener for state changes
+     */
+    addListener(eventName: "stateChange", listenerFunc: (event: SwabbleStateEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Add a listener for audio level updates
+     */
+    addListener(eventName: "audioLevel", listenerFunc: (event: SwabbleAudioLevelEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Add a listener for errors
+     */
+    addListener(eventName: "error", listenerFunc: (event: SwabbleErrorEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners
+     */
+    removeAllListeners(): Promise<void>;
+}
+//# sourceMappingURL=definitions.d.ts.map

package/dist/esm/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,MAAM,EAAE,aAAa,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,oBAAoB;IACpB,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAC;IACrD,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mCAAmC;IACnC,UAAU,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5C,2CAA2C;IAC3C,iBAAiB,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,eAAe,CAAC;CACtE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEjE;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAE/C;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC;QAAE,MAAM,EAAE,aAAa,GAAG,IAAI,CAAA;KAAE,CAAC,CAAC;IAEvD;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEvD;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC;QACzB,OAAO,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KAClE,CAAC,CAAC;IAEH;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,UAAU,EACrB,YAAY,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,GAClD,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,YAAY,EACvB,YAAY,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,GACpD,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,aAAa,EACxB,YAAY,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAC/C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,YAAY,EACvB,YAAY,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,GACpD,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,OAAO,EAClB,YAAY,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAC/C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC"}

package/dist/esm/definitions.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { SwabblePlugin } from "./definitions";
+export * from "./definitions";
+export declare const Swabble: SwabblePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,cAAc,eAAe,CAAC;AAI9B,eAAO,MAAM,OAAO,eAElB,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { registerPlugin } from "@capacitor/core";
+export * from "./definitions";
+const loadWeb = () => import("./web").then((m) => new m.SwabbleWeb());
+export const Swabble = registerPlugin("Swabble", {
+    web: loadWeb,
+});

package/dist/esm/web.d.ts

@@ -0,0 +1,54 @@
+import { WebPlugin } from "@capacitor/core";
+import type { SwabbleConfig, SwabblePermissionStatus, SwabbleStartOptions, SwabbleStartResult } from "./definitions";
+export declare class SwabbleWeb extends WebPlugin {
+    private recognition;
+    private config;
+    private wakeGate;
+    private isActive;
+    private segments;
+    private audioContext;
+    private analyser;
+    private mediaStream;
+    private levelInterval;
+    private captureStream;
+    private captureContext;
+    private captureProcessor;
+    private bridgeSubscriptions;
+    private usingNativeIpc;
+    private getRendererRpc;
+    private subscribeDesktopEvent;
+    private invokeDesktopRequest;
+    private setupNativeListeners;
+    private removeNativeListeners;
+    private startNativeAudioCapture;
+    private computeRms;
+    private computePeak;
+    private stopNativeAudioCapture;
+    start(options: SwabbleStartOptions): Promise<SwabbleStartResult>;
+    private handleSpeechResult;
+    private startAudioLevelMonitoring;
+    private stopAudioLevelMonitoring;
+    stop(): Promise<void>;
+    isListening(): Promise<{
+        listening: boolean;
+    }>;
+    getConfig(): Promise<{
+        config: SwabbleConfig | null;
+    }>;
+    updateConfig(options: {
+        config: Partial<SwabbleConfig>;
+    }): Promise<void>;
+    checkPermissions(): Promise<SwabblePermissionStatus>;
+    requestPermissions(): Promise<SwabblePermissionStatus>;
+    getAudioDevices(): Promise<{
+        devices: Array<{
+            id: string;
+            name: string;
+            isDefault: boolean;
+        }>;
+    }>;
+    setAudioDevice(_options: {
+        deviceId: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=web.d.ts.map

package/dist/esm/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EAEvB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AA6JvB,qBAAa,UAAW,SAAQ,SAAS;IACvC,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,YAAY,CAA6B;IACjD,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,aAAa,CAA+C;IAGpE,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,gBAAgB,CAAoC;IAC5D,OAAO,CAAC,mBAAmB,CAAyB;IACpD,OAAO,CAAC,cAAc,CAAS;IAE/B,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,qBAAqB;YAQf,oBAAoB;IAQlC,OAAO,CAAC,oBAAoB;IAuC5B,OAAO,CAAC,qBAAqB;YAOf,uBAAuB;IA+CrC,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAWxB,KAAK,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmFtE,OAAO,CAAC,kBAAkB;YAqCZ,yBAAyB;IAyBvC,OAAO,CAAC,wBAAwB;IAY1B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAwBrB,WAAW,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC;IAI9C,SAAS,IAAI,OAAO,CAAC;QAAE,MAAM,EAAE,aAAa,GAAG,IAAI,CAAA;KAAE,CAAC;IAItD,YAAY,CAAC,OAAO,EAAE;QAC1B,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBX,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IA4BpD,kBAAkB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAetD,eAAe,IAAI,OAAO,CAAC;QAC/B,OAAO,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KAClE,CAAC;IAgBI,cAAc,CAAC,QAAQ,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAOpE"}