electron-native-speech 0.1.3 → 0.1.5

package/README.md

@@ -0,0 +1,139 @@
+# electron-native-speech
+
+Core TypeScript API for native speech transcription in Electron.
+
+This package provides the shared types and high-level API:
+
+- `getSpeechAvailability()`
+- `transcribeFile()`
+- `createSpeechSession()`
+
+On macOS, it installs and auto-loads the bundled backend at runtime.
+
+## Install
+
+```bash
+npm install electron-native-speech
+```
+
+That single package install is the supported path for normal users.
+
+## When to use this package
+
+Use this package when you want:
+
+- the core speech API and types
+- direct access from Node or the Electron main process
+- a shared abstraction for custom backends or tests
+
+For Electron preload and main-process wiring, import the helpers from this package:
+
+- `electron-native-speech/preload`
+- `electron-native-speech/main-handlers`
+
+## Usage
+
+### File transcription
+
+```ts
+import { getSpeechAvailability, transcribeFile } from "electron-native-speech"
+
+const availability = await getSpeechAvailability()
+if (!availability.available) {
+  throw new Error(availability.reason ?? "Speech recognition unavailable")
+}
+
+const result = await transcribeFile({
+  filePath: "/absolute/path/to/recording.mp3",
+  locale: "en-US",
+})
+
+for (const segment of result.segments) {
+  console.log(`[${segment.startMs}ms - ${segment.endMs}ms] ${segment.text}`)
+}
+```
+
+### Live microphone
+
+```ts
+import { createSpeechSession } from "electron-native-speech"
+
+const session = await createSpeechSession()
+
+const offResult = session.on("result", (result) => {
+  console.log(result.text, result.isFinal ? "(final)" : "(interim)")
+})
+
+const offError = session.on("error", (error) => {
+  console.error(error.code, error.message)
+})
+
+await session.start({
+  locale: "en-US",
+  interimResults: true,
+  continuous: true,
+})
+
+// later
+await session.stop()
+await session.dispose()
+offResult()
+offError()
+```
+
+## API
+
+### `getSpeechAvailability()`
+
+```ts
+getSpeechAvailability(): Promise<SpeechAvailability>
+```
+
+Checks whether a supported backend is present and speech recognition is available.
+
+### `transcribeFile(options)`
+
+```ts
+transcribeFile(options: FileTranscriptionOptions): Promise<FileTranscriptionResult>
+```
+
+Recognizes speech from a local audio or video file.
+
+### `createSpeechSession()`
+
+```ts
+createSpeechSession(): Promise<SpeechSession>
+```
+
+Creates a live microphone recognition session.
+
+## Custom backends and tests
+
+This package also exports:
+
+- `setBackend()`
+- `resetBackend()`
+- `SpeechRecognitionError`
+- all public speech types
+
+That is useful if you want to inject a mock backend in tests or provide your own implementation.
+
+## Platform support
+
+- macOS 13+
+- Electron 28+
+- Node.js 18+
+
+Windows and Linux backends are not published yet.
+
+## Electron apps
+
+For a complete Electron integration with `contextIsolation: true`, use:
+
+- `electron-native-speech` for the shared API and runtime
+- `electron-native-speech/preload` for the preload bridge
+- `electron-native-speech/main-handlers` for IPC wiring in the main process
+
+Full documentation and examples:
+
+- https://github.com/varaprasadreddy9676/electron-native-speech

package/dist/backend-loader.js

@@ -22,7 +22,7 @@ function getBackend() {
             return _backend;
         }
         catch {
-            (0, errors_1.throwSpeechError)("unavailable", "macOS speech backend not found. Run: npm install electron-native-speech-backend-macos");
+            (0, errors_1.throwSpeechError)("unavailable", "macOS speech backend not found. Reinstall electron-native-speech and verify dependencies were installed.");
         }
     }
     (0, errors_1.throwSpeechError)("unavailable", `Platform "${platform}" is not yet supported. electron-native-speech currently supports macOS.`);

package/dist/backend-loader.js.map

@@ -1 +1 @@
-{"version":3,"file":"backend-loader.js","sourceRoot":"","sources":["../src/backend-loader.ts"],"names":[],"mappings":";;AAUA,gCAuBC;AAGD,gCAEC;AAED,oCAKC;AA5CD,qCAA2C;AAE3C,IAAI,QAAQ,GAA0B,IAAI,CAAA;AAE1C;;;;GAIG;AACH,SAAgB,UAAU;IACxB,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAA;IAE7B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;IAEjC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,iEAAiE;YACjE,MAAM,GAAG,GAAG,OAAO,CAAC,sCAAsC,CAAC,CAAA;YAC3D,QAAQ,GAAG,IAAI,GAAG,CAAC,kBAAkB,EAAoB,CAAA;YACzD,OAAO,QAAQ,CAAA;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,IAAA,yBAAgB,EACd,aAAa,EACb,uFAAuF,CACxF,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAA,yBAAgB,EACd,aAAa,EACb,aAAa,QAAQ,0EAA0E,CAChG,CAAA;AACH,CAAC;AAED,+CAA+C;AAC/C,SAAgB,UAAU,CAAC,OAAuB;IAChD,QAAQ,GAAG,OAAO,CAAA;AACpB,CAAC;AAED,SAAgB,YAAY;IAC1B,IAAI,QAAQ,EAAE,CAAC;QACb,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IACpC,CAAC;IACD,QAAQ,GAAG,IAAI,CAAA;AACjB,CAAC"}
+{"version":3,"file":"backend-loader.js","sourceRoot":"","sources":["../src/backend-loader.ts"],"names":[],"mappings":";;AAUA,gCAuBC;AAGD,gCAEC;AAED,oCAKC;AA5CD,qCAA2C;AAE3C,IAAI,QAAQ,GAA0B,IAAI,CAAA;AAE1C;;;;GAIG;AACH,SAAgB,UAAU;IACxB,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAA;IAE7B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;IAEjC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,iEAAiE;YACjE,MAAM,GAAG,GAAG,OAAO,CAAC,sCAAsC,CAAC,CAAA;YAC3D,QAAQ,GAAG,IAAI,GAAG,CAAC,kBAAkB,EAAoB,CAAA;YACzD,OAAO,QAAQ,CAAA;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,IAAA,yBAAgB,EACd,aAAa,EACb,0GAA0G,CAC3G,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAA,yBAAgB,EACd,aAAa,EACb,aAAa,QAAQ,0EAA0E,CAChG,CAAA;AACH,CAAC;AAED,+CAA+C;AAC/C,SAAgB,UAAU,CAAC,OAAuB;IAChD,QAAQ,GAAG,OAAO,CAAA;AACpB,CAAC;AAED,SAAgB,YAAY;IAC1B,IAAI,QAAQ,EAAE,CAAC;QACb,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IACpC,CAAC;IACD,QAAQ,GAAG,IAAI,CAAA;AACjB,CAAC"}

package/dist/main-handlers.d.ts

@@ -0,0 +1,3 @@
+import type { IpcMain, WebContents } from "electron";
+export declare function registerSpeechHandlers(ipcMain: IpcMain, webContents: WebContents): () => void;
+//# sourceMappingURL=main-handlers.d.ts.map

package/dist/main-handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main-handlers.d.ts","sourceRoot":"","sources":["../src/main-handlers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEpD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,MAAM,IAAI,CAO7F"}

package/dist/main-handlers.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSpeechHandlers = registerSpeechHandlers;
+function registerSpeechHandlers(ipcMain, webContents) {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const mod = require("electron-native-speech-preload/main-handlers");
+    return mod.registerSpeechHandlers(ipcMain, webContents);
+}
+//# sourceMappingURL=main-handlers.js.map

package/dist/main-handlers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main-handlers.js","sourceRoot":"","sources":["../src/main-handlers.ts"],"names":[],"mappings":";;AAEA,wDAOC;AAPD,SAAgB,sBAAsB,CAAC,OAAgB,EAAE,WAAwB;IAC/E,iEAAiE;IACjE,MAAM,GAAG,GAAG,OAAO,CAAC,8CAA8C,CAEjE,CAAA;IAED,OAAO,GAAG,CAAC,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;AACzD,CAAC"}

package/dist/preload.d.ts

@@ -0,0 +1,18 @@
+import type { FileTranscriptionOptions, FileTranscriptionResult, LiveSpeechResult, SpeechAvailability, SpeechError, SpeechSessionStartOptions, SpeechSessionState } from "./types";
+type SessionEventType = "result" | "error" | "state";
+type SessionListener<T extends SessionEventType> = T extends "result" ? (result: LiveSpeechResult) => void : T extends "error" ? (error: SpeechError) => void : T extends "state" ? (state: SpeechSessionState) => void : never;
+export interface RendererSpeechSession {
+    on<T extends SessionEventType>(event: T, listener: SessionListener<T>): () => void;
+    start(options?: SpeechSessionStartOptions): Promise<void>;
+    stop(): Promise<void>;
+    abort(): Promise<void>;
+    dispose(): Promise<void>;
+}
+export interface ElectronSpeechAPI {
+    getSpeechAvailability(): Promise<SpeechAvailability>;
+    transcribeFile(options: FileTranscriptionOptions): Promise<FileTranscriptionResult>;
+    createSpeechSession(): RendererSpeechSession;
+}
+export declare function exposeElectronSpeech(key?: string): void;
+export {};
+//# sourceMappingURL=preload.d.ts.map

package/dist/preload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preload.d.ts","sourceRoot":"","sources":["../src/preload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,yBAAyB,EACzB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAEhB,KAAK,gBAAgB,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAA;AACpD,KAAK,eAAe,CAAC,CAAC,SAAS,gBAAgB,IAC7C,CAAC,SAAS,QAAQ,GAAG,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GACrD,CAAC,SAAS,OAAO,GAAG,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAChD,CAAC,SAAS,OAAO,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GACvD,KAAK,CAAA;AAET,MAAM,WAAW,qBAAqB;IACpC,EAAE,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAA;IAClF,KAAK,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpD,cAAc,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACnF,mBAAmB,IAAI,qBAAqB,CAAA;CAC7C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,SAAmB,GAAG,IAAI,CAOjE"}

package/dist/preload.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exposeElectronSpeech = exposeElectronSpeech;
+function exposeElectronSpeech(key = "electronSpeech") {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const mod = require("electron-native-speech-preload");
+    mod.exposeElectronSpeech(key);
+}
+//# sourceMappingURL=preload.js.map

package/dist/preload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preload.js","sourceRoot":"","sources":["../src/preload.ts"],"names":[],"mappings":";;AA+BA,oDAOC;AAPD,SAAgB,oBAAoB,CAAC,GAAG,GAAG,gBAAgB;IACzD,iEAAiE;IACjE,MAAM,GAAG,GAAG,OAAO,CAAC,gCAAgC,CAEnD,CAAA;IAED,GAAG,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;AAC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-native-speech",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Native OS speech transcription for Electron apps — fast, local, no cloud required",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,6 +8,24 @@
     ".": {
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./preload": {
+      "require": "./dist/preload.js",
+      "types": "./dist/preload.d.ts"
+    },
+    "./main-handlers": {
+      "require": "./dist/main-handlers.js",
+      "types": "./dist/main-handlers.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "preload": [
+        "dist/preload.d.ts"
+      ],
+      "main-handlers": [
+        "dist/main-handlers.d.ts"
+      ]
     }
   },
   "files": [
@@ -40,8 +58,8 @@
       "optional": true
     }
   },
-  "optionalDependencies": {
-    "electron-native-speech-backend-macos": ">=0.1.5",
-    "electron-native-speech-preload": ">=0.1.3"
+  "dependencies": {
+    "electron-native-speech-backend-macos": "^0.1.6",
+    "electron-native-speech-preload": "^0.1.4"
   }
 }