electron-ipc-helper.adapter.assemblyscript 0.1.0

@electron-ipc-helper/adapter-assemblyscript

Optional AssemblyScript / WebAssembly adapter for electron-ipc-helper.

Bridges AssemblyScript WASM module exports into typed IPC handlers that slot directly into the existing defineIpcApi / exposeApiToRenderer pipeline — with zero mandatory runtime dependencies.

Why a separate package?

The core electron-ipc-helper is intentionally lean. AssemblyScript support is an advanced, optional use-case; keeping it separate:

• Keeps the core bundle small for users who don't need WASM.
• Allows the adapter to evolve independently.
• Makes the optional dependency on @assemblyscript/loader explicit.

Installation

npm install @electron-ipc-helper/adapter-assemblyscript
# peer deps (if not already installed)
npm install electron-ipc-helper electron

Quick start

// main.ts
import { createAssemblyScriptAdapter, asc } from '@electron-ipc-helper/adapter-assemblyscript';
import { defineIpcApi } from 'electron-ipc-helper';
import { exposeApiToRenderer } from 'electron-ipc-helper/preload';

// 1. Define the schema (mirrors your AssemblyScript exports)
const schema = {
  add:   asc.fn(['i32', 'i32'], 'i32'),
  greet: asc.fn(['string'], 'string'),
};

// 2. Load the WASM module and create typed handlers
const adapter = await createAssemblyScriptAdapter('./math.wasm', schema);

// 3. Register IPC handlers on ipcMain
const api = defineIpcApi(adapter.handlers);

// 4. Expose to renderer via contextBridge (in preload.ts)
exposeApiToRenderer(api);

// renderer.ts
const result = await window.api.add(3, 4);        // => 7
const msg   = await window.api.greet('World');    // => 'Hello, World!'

API reference

createAssemblyScriptAdapter(source, schema, options?)

Loads a WASM module and returns typed async handlers.

Returns Promise<AssemblyScriptAdapter<S>>:

interface AssemblyScriptAdapter<S> {
  handlers: InferAscHandlers<S>;   // Pass to defineIpcApi()
  instance: WebAssembly.Instance;  // The raw WASM instance
  runtime: AscRuntimeExports | null;
  dispose(): void;
}

AssemblyScriptPlugin

Lifecycle-managed plugin for use with PluginHost:

import { PluginHost } from 'electron-ipc-helper/plugins';
import { AssemblyScriptPlugin } from '@electron-ipc-helper/adapter-assemblyscript';

const host = new PluginHost();
host.register(new AssemblyScriptPlugin({
  name: 'math',
  source: './math.wasm',
  schema: { add: asc.fn(['i32', 'i32'], 'i32') },
  onReady: (api) => { /* store api reference */ },
}));

await host.init();   // loads WASM, registers IPC handlers
await host.start();
// on shutdown:
await host.stop();
await host.dispose();

wrapLoaderInstance(loaderExports)

Compatibility shim for @assemblyscript/loader:

import { instantiate } from '@assemblyscript/loader';
import { wrapLoaderInstance, createAssemblyScriptAdapter } from '@electron-ipc-helper/adapter-assemblyscript';

const { exports } = await instantiate(fs.readFileSync('./math.wasm'));
const adapter = await createAssemblyScriptAdapter(
  wrapLoaderInstance(exports),
  schema,
  { warnOnMissingRuntime: false },
);

Supported types

Migrating from the old import path

In electron-ipc-helper@0.1.x a compatibility shim re-exports this package from electron-ipc-helper/adapters/assemblyscript. That shim is deprecated and will be removed in the next major release.

Update your imports:

// ❌ Old (deprecated)
import { createAssemblyScriptAdapter } from 'electron-ipc-helper/adapters/assemblyscript';

// ✅ New
import { createAssemblyScriptAdapter } from '@electron-ipc-helper/adapter-assemblyscript';

License

MIT