@elizaos/capacitor-bun-runtime 2.0.11-beta.7

package/src/definitions.ts

@@ -0,0 +1,152 @@
+/**
+ * @elizaos/capacitor-bun-runtime — iOS embedded Bun-shape JS runtime.
+ *
+ * Hosts a JavaScriptCore JSContext on a dedicated worker thread. The native
+ * plugin either starts a bundled full Bun engine framework or installs the
+ * `__ELIZA_BRIDGE__` host functions for the compatibility JSContext path.
+ * The full-engine ABI lives in packages/native/bun-runtime/BRIDGE_CONTRACT.md.
+ *
+ * The plugin exposes a tiny surface to the React UI: start the runtime,
+ * send messages, check status, and stop it. Everything else flows over the
+ * `ui_post_message` / `ui_register_handler` channel inside the native side.
+ */
+
+export interface StartOptions {
+  /**
+   * Runtime engine selection:
+   * - "auto" (default): use a bundled full Bun engine when present. The
+   *   JSContext compatibility fallback is for development/sideload builds only;
+   *   iOS store local mode must request "bun" and fail if the engine is missing.
+   * - "bun": require ElizaBunEngine.framework and fail if it is missing.
+   * - "compat": force the JSContext compatibility bridge for development.
+   */
+  engine?: "auto" | "bun" | "compat";
+  /**
+   * Path to the agent bundle JavaScript file. When omitted, the runtime
+   * loads the staged iOS agent payload from `public/agent/agent-bundle.js`
+   * in the main app bundle resources. Legacy JSContext development bundles
+   * named `agent-bundle-ios.js` are still probed for compatibility.
+   * Use this only for development overrides.
+   */
+  bundlePath?: string;
+  /**
+   * Optional polyfill prefix loaded before the agent bundle. When omitted,
+   * the runtime loads `eliza-polyfill-prefix.js` from the main app bundle
+   * resources, or falls back to a minimal embedded prefix.
+   */
+  polyfillPath?: string;
+  /**
+   * Initial environment variables visible to the agent via `env_get` / `env_keys`.
+   */
+  env?: Record<string, string>;
+  /**
+   * argv vector exposed to the agent via `argv()`. Defaults to
+   * `["bun", "public/agent/agent-bundle.js"]`.
+   */
+  argv?: string[];
+}
+
+export interface StartResult {
+  ok: boolean;
+  error?: string;
+  /** Version string emitted by `__ELIZA_BRIDGE_VERSION__`. */
+  bridgeVersion?: string;
+}
+
+export interface SendMessageOptions {
+  message: string;
+  /** Optional conversation/thread identifier passed through to the agent. */
+  conversationId?: string;
+}
+
+export interface SendMessageResult {
+  reply: string;
+}
+
+export interface GetStatusResult {
+  ready: boolean;
+  /** Active runtime engine: full Bun framework or compatibility bridge. */
+  engine?: "bun" | "compat";
+  /** Currently loaded llama model path, if any. */
+  model?: string;
+  /** Last observed generation throughput. */
+  tokensPerSecond?: number;
+  /** Bridge version string, e.g. "v1". */
+  bridgeVersion?: string;
+}
+
+/**
+ * Generic call surface for any UI handler the agent has registered via
+ * `bridge.ui_register_handler`. The React UI passes a method name and args;
+ * the native plugin dispatches into the JSContext and returns the result.
+ */
+export interface CallOptions {
+  method: string;
+  args?: unknown;
+}
+
+export interface CallResult {
+  result: unknown;
+}
+
+export interface LocalTtsStatusResult {
+  ready: boolean;
+  status: "assets-ready" | "engine-ready" | "ready" | "missing" | "unavailable";
+  message: string;
+  modelId?: string;
+  bundleDir?: string;
+}
+
+export interface LocalTtsDiagnosticsOptions {
+  bundleDir?: string;
+  probe?: boolean;
+  text?: string;
+}
+
+export interface LocalTtsDiagnosticsResult {
+  available: boolean;
+  selectedBundleDir?: string;
+  modelId?: string;
+  message?: string;
+  [key: string]: unknown;
+}
+
+export interface SynthesizeLocalTtsOptions {
+  text: string;
+  bundleDir?: string;
+  speakerPresetId?: string;
+  voice?: string;
+  voiceId?: string;
+  maxSamples?: number;
+  play?: boolean;
+}
+
+export interface SynthesizeLocalTtsResult {
+  audioBase64?: string;
+  contentType: "audio/wav";
+  sampleRate: number;
+  samples: number;
+  durationMs: number;
+  modelId?: string;
+  played?: boolean;
+}
+
+export interface ElizaBunRuntimePlugin {
+  start(options: StartOptions): Promise<StartResult>;
+  sendMessage(options: SendMessageOptions): Promise<SendMessageResult>;
+  getStatus(): Promise<GetStatusResult>;
+  stop(): Promise<void>;
+  getLocalTtsStatus(): Promise<LocalTtsStatusResult>;
+  getLocalTtsDiagnostics(
+    options?: LocalTtsDiagnosticsOptions,
+  ): Promise<LocalTtsDiagnosticsResult>;
+  synthesizeLocalTts(
+    options: SynthesizeLocalTtsOptions,
+  ): Promise<SynthesizeLocalTtsResult>;
+  /**
+   * Invoke an arbitrary UI handler that the agent has registered via
+   * `bridge.ui_register_handler`. Useful for routing arbitrary RPC-style
+   * traffic from the React UI into the agent.
+   */
+  call(options: CallOptions): Promise<CallResult>;
+}

package/src/index.d.ts

@@ -0,0 +1,9 @@
+import type { ElizaBunRuntimePlugin } from "./definitions";
+export * from "./definitions";
+/**
+ * The native plugin is registered under the JS name `ElizaBunRuntime`. The
+ * Swift class in `ios/Sources/ElizaBunRuntimePlugin/ElizaBunRuntimePlugin.swift`
+ * exposes the matching `jsName`.
+ */
+export declare const ElizaBunRuntime: ElizaBunRuntimePlugin;
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE3D,cAAc,eAAe,CAAC;AAE9B;;;;GAIG;AACH,eAAO,MAAM,eAAe,uBAK3B,CAAC"}

package/src/index.ts

@@ -0,0 +1,16 @@
+import { registerPlugin } from "@capacitor/core";
+import type { ElizaBunRuntimePlugin } from "./definitions";
+
+export * from "./definitions";
+
+/**
+ * The native plugin is registered under the JS name `ElizaBunRuntime`. The
+ * Swift class in `ios/Sources/ElizaBunRuntimePlugin/ElizaBunRuntimePlugin.swift`
+ * exposes the matching `jsName`.
+ */
+export const ElizaBunRuntime = registerPlugin<ElizaBunRuntimePlugin>(
+  "ElizaBunRuntime",
+  {
+    web: () => import("./web").then((m) => new m.ElizaBunRuntimeWeb()),
+  },
+);

package/src/web.d.ts

@@ -0,0 +1,19 @@
+import { WebPlugin } from "@capacitor/core";
+import type { CallOptions, CallResult, ElizaBunRuntimePlugin, GetStatusResult, LocalTtsDiagnosticsOptions, LocalTtsDiagnosticsResult, LocalTtsStatusResult, SendMessageOptions, SendMessageResult, SynthesizeLocalTtsOptions, SynthesizeLocalTtsResult, StartOptions, StartResult } from "./definitions";
+/**
+ * Web fallback for `@elizaos/capacitor-bun-runtime`.
+ *
+ * Browser environments do not host the native runtime. This implementation
+ * reports an unavailable status and throws clear errors for runtime calls.
+ */
+export declare class ElizaBunRuntimeWeb extends WebPlugin implements ElizaBunRuntimePlugin {
+    start(_options: StartOptions): Promise<StartResult>;
+    sendMessage(_options: SendMessageOptions): Promise<SendMessageResult>;
+    getStatus(): Promise<GetStatusResult>;
+    stop(): Promise<void>;
+    getLocalTtsStatus(): Promise<LocalTtsStatusResult>;
+    getLocalTtsDiagnostics(_options?: LocalTtsDiagnosticsOptions): Promise<LocalTtsDiagnosticsResult>;
+    synthesizeLocalTts(_options: SynthesizeLocalTtsOptions): Promise<SynthesizeLocalTtsResult>;
+    call(_options: CallOptions): Promise<CallResult>;
+}
+//# sourceMappingURL=web.d.ts.map

package/src/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,qBAAqB,EACrB,eAAe,EACf,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,yBAAyB,EACzB,wBAAwB,EACxB,YAAY,EACZ,WAAW,EACZ,MAAM,eAAe,CAAC;AAEvB;;;;;GAKG;AACH,qBAAa,kBACX,SAAQ,SACR,YAAW,qBAAqB;IAE1B,KAAK,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAQnD,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMrE,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IAIrC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,iBAAiB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IASlD,sBAAsB,CAC1B,QAAQ,CAAC,EAAE,0BAA0B,GACpC,OAAO,CAAC,yBAAyB,CAAC;IAQ/B,kBAAkB,CACtB,QAAQ,EAAE,yBAAyB,GAClC,OAAO,CAAC,wBAAwB,CAAC;IAM9B,IAAI,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;CAGvD"}

package/src/web.ts

@@ -0,0 +1,80 @@
+import { WebPlugin } from "@capacitor/core";
+import type {
+  CallOptions,
+  CallResult,
+  ElizaBunRuntimePlugin,
+  GetStatusResult,
+  LocalTtsDiagnosticsOptions,
+  LocalTtsDiagnosticsResult,
+  LocalTtsStatusResult,
+  SendMessageOptions,
+  SendMessageResult,
+  SynthesizeLocalTtsOptions,
+  SynthesizeLocalTtsResult,
+  StartOptions,
+  StartResult,
+} from "./definitions";
+
+/**
+ * Web fallback for `@elizaos/capacitor-bun-runtime`.
+ *
+ * Browser environments do not host the native runtime. This implementation
+ * reports an unavailable status and throws clear errors for runtime calls.
+ */
+export class ElizaBunRuntimeWeb
+  extends WebPlugin
+  implements ElizaBunRuntimePlugin
+{
+  async start(_options: StartOptions): Promise<StartResult> {
+    return {
+      ok: false,
+      error:
+        "ElizaBunRuntime is not available on web. Run on an iOS device or simulator.",
+    };
+  }
+
+  async sendMessage(_options: SendMessageOptions): Promise<SendMessageResult> {
+    throw this.unavailable(
+      "ElizaBunRuntime.sendMessage is unavailable on web.",
+    );
+  }
+
+  async getStatus(): Promise<GetStatusResult> {
+    return { ready: false };
+  }
+
+  async stop(): Promise<void> {
+    return;
+  }
+
+  async getLocalTtsStatus(): Promise<LocalTtsStatusResult> {
+    return {
+      ready: false,
+      status: "unavailable",
+      message:
+        "ElizaBunRuntime local TTS is not available on web. Run on an iOS device or simulator.",
+    };
+  }
+
+  async getLocalTtsDiagnostics(
+    _options?: LocalTtsDiagnosticsOptions,
+  ): Promise<LocalTtsDiagnosticsResult> {
+    return {
+      available: false,
+      message:
+        "ElizaBunRuntime local TTS diagnostics are not available on web. Run on an iOS device or simulator.",
+    };
+  }
+
+  async synthesizeLocalTts(
+    _options: SynthesizeLocalTtsOptions,
+  ): Promise<SynthesizeLocalTtsResult> {
+    throw this.unavailable(
+      "ElizaBunRuntime.synthesizeLocalTts is unavailable on web.",
+    );
+  }
+
+  async call(_options: CallOptions): Promise<CallResult> {
+    throw this.unavailable("ElizaBunRuntime.call is unavailable on web.");
+  }
+}