transcribe-cpp 0.0.4 → 0.0.5

package/README.md

@@ -200,6 +200,45 @@ N-API addon, so `cmake-js` does not apply) and installs into `prebuilds/<tuple>/
 which the loader finds automatically. Requires `cmake` and a C/C++ toolchain.
 You can also point `TRANSCRIBE_LIBRARY` at any `libtranscribe` you built.
 
+## Packaging an app (Electron / Tauri)
+
+The native code ships as a self-contained `@transcribe-cpp/<platform>` package
+(the shared library plus its sibling ggml libs / backend modules, in one
+directory). Because npm resolution is transitive, your app can locate that
+directory at *build* time — there is nothing special to wire through.
+`artifactDir()` returns it **without loading the library** (no dlopen), which is
+exactly what a bundler/pack step needs:
+
+```js
+import { artifactDir } from "transcribe-cpp";
+import * as fs from "node:fs";
+
+const dir = artifactDir();
+const lib =
+  process.platform === "win32" ? "transcribe.dll"
+  : process.platform === "darwin" ? "libtranscribe.dylib"
+  : "libtranscribe.so";
+
+// HARD-FAIL if the artifact is missing/empty: better to break the build than
+// ship a silently broken installer that crashes at first transcribe() call.
+if (!fs.existsSync(`${dir}/${lib}`)) {
+  throw new Error(`native library not found in ${dir}; the platform package is not bundled`);
+}
+// copy `dir` into your app resources, or feed it to your bundler config…
+```
+
+The native files are real binaries, so they must not be packed into an asar
+archive. With **electron-builder**, unpack the platform packages:
+
+```jsonc
+// package.json → "build"
+{ "asarUnpack": ["node_modules/@transcribe-cpp/**"] }
+```
+
+For a **Tauri** app whose native bits come from the Rust crate instead, see that
+crate's "Packaging a distributable" section — there the artifact dir is exposed
+to your `build.rs` as `DEP_TRANSCRIBE_CPP_RUNTIME_DIR`.
+
 ## Waived requirements
 
 - **Per-field ABI layout is not waived** (unlike Rust/Swift): TypeScript has no
@@ -211,5 +250,5 @@ You can also point `TRANSCRIBE_LIBRARY` at any `libtranscribe` you built.
 
 ## License
 
-MIT. Bundled native packages include third-party license texts (ggml and any
-bundled backend runtimes).
+MIT. Bundled native packages include third-party license texts (ggml, miniz,
+and any bundled backend runtimes).

package/dist/index.d.ts

@@ -17,6 +17,19 @@ export declare function version(): {
     headerHash: string;
 };
 export declare function libraryPath(): string;
+/**
+ * The directory holding the native library and its sibling ggml libs / backend
+ * modules — resolved WITHOUT loading the library (no dlopen, no ABI check, no
+ * backend init), unlike every other entry point here.
+ *
+ * This is the build/packaging hook: call it from a bundler config or pack step
+ * to copy the native artifacts into your installer (Electron `asarUnpack`, Tauri
+ * `resources`, etc.). Resolution follows the same order as the runtime loader
+ * (`TRANSCRIBE_LIBRARY` → the `@transcribe-cpp/<platform>` package → a local
+ * prebuild → the dev tree) and throws if nothing is found. For runtime use,
+ * `libraryPath()` returns the resolved library path of the *loaded* binding.
+ */
+export declare function artifactDir(): string;
 export declare function getAvailableBackends(): BackendInfo[];
 export declare function backendAvailable(backend: Backend): boolean;
 export declare class Session {

package/dist/index.js

@@ -6,6 +6,7 @@
  * backend discovery, log routing, and cooperative cancellation.
  */
 import { native, setLogHandler } from "./native.js";
+import { resolveLibrary } from "./loader.js";
 import * as g from "./_generated.js";
 import { Aborted, Busy, exceptionForStatus, InvalidArgument, ModelLoadError, NotImplementedByModel, OutputTruncated, TranscribeError, UnsupportedRequest, } from "./errors.js";
 export * from "./types.js";
@@ -216,6 +217,21 @@ export function version() {
 export function libraryPath() {
     return native().libraryPath;
 }
+/**
+ * The directory holding the native library and its sibling ggml libs / backend
+ * modules — resolved WITHOUT loading the library (no dlopen, no ABI check, no
+ * backend init), unlike every other entry point here.
+ *
+ * This is the build/packaging hook: call it from a bundler config or pack step
+ * to copy the native artifacts into your installer (Electron `asarUnpack`, Tauri
+ * `resources`, etc.). Resolution follows the same order as the runtime loader
+ * (`TRANSCRIBE_LIBRARY` → the `@transcribe-cpp/<platform>` package → a local
+ * prebuild → the dev tree) and throws if nothing is found. For runtime use,
+ * `libraryPath()` returns the resolved library path of the *loaded* binding.
+ */
+export function artifactDir() {
+    return resolveLibrary().artifactDir;
+}
 const DEVICE_TYPE_NAMES = {
     [g.TRANSCRIBE_DEVICE_TYPE_CPU]: "cpu",
     [g.TRANSCRIBE_DEVICE_TYPE_GPU]: "gpu",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transcribe-cpp",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "TypeScript/Node.js bindings for transcribe.cpp — a C/C++ speech-to-text library built on ggml",
   "type": "module",
   "exports": {
@@ -51,11 +51,11 @@
     "koffi": "^3.0.2"
   },
   "optionalDependencies": {
-    "@transcribe-cpp/darwin-arm64-metal": "0.0.4",
-    "@transcribe-cpp/darwin-x64-cpu": "0.0.4",
-    "@transcribe-cpp/linux-x64-cpu-vulkan": "0.0.4",
-    "@transcribe-cpp/linux-arm64-cpu-vulkan": "0.0.4",
-    "@transcribe-cpp/win32-x64-cpu-vulkan": "0.0.4"
+    "@transcribe-cpp/darwin-arm64-metal": "0.0.5",
+    "@transcribe-cpp/darwin-x64-cpu": "0.0.5",
+    "@transcribe-cpp/linux-x64-cpu-vulkan": "0.0.5",
+    "@transcribe-cpp/linux-arm64-cpu-vulkan": "0.0.5",
+    "@transcribe-cpp/win32-x64-cpu-vulkan": "0.0.5"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",