Electron Builder

@wvb/electron-builder integrates Webview Bundle with electron-builder packaging. It hooks electron-builder's afterPack step to install your builtin .wvb bundles into the packaged app's resources, so the bundles @wvb/electron serves at runtime ship with the app. You still configure electron-builder to keep the native @wvb/node addon out of the ASAR archive. Read the Electron guide first for the runtime setup, and see Electron Forge for the Forge equivalent.

What it does

At package time the plugin resolves your Webview Bundle config, installs the builtin bundles (downloaded from a remote target or packed from local workspaces via @wvb/cli), stages them under <root>/.wvb/builtin/bundles/<platform>-<arch>, then copies them into the packaged app's Resources/<bundlesDir> directory. That is exactly where @wvb/electron reads builtin bundles from when packaged (process.resourcesPath/bundles), so the runtime picks them up with no extra wiring.

The plugin requires electron-builder 24+ (declared as an optional peer dependency) and pulls in @wvb/cli and @wvb/config to resolve and pack bundles.

Configure the plugin

Wrap your electron-builder config with withWebviewBundle(...) (alias withWvb). It composes the afterPack hook for you while preserving any existing function-valued afterPack.

import { withWebviewBundle } from '@wvb/electron-builder';

export default withWebviewBundle({
  appId: 'com.example.app',
  asar: true,
  mac: { target: 'dmg' },
});

Pass plugin options as a second argument:

import { withWebviewBundle } from '@wvb/electron-builder';

export default withWebviewBundle(
  {
    appId: 'com.example.app',
    asar: true,
  },
  {
    bundlesDir: 'bundles',
    channel: 'beta',
  }
);

If you prefer to wire the hook yourself, use the raw factory webviewBundleAfterPack(options?) (alias wvbAfterPack), which returns an electron-builder afterPack function. The package also exports resolveResourcesPath(ctx), which returns the packaged app's resources directory for a given build context.

Options

Both @wvb/electron-builder and @wvb/electron-forge share these options:

When builtin.target is not set, the plugin defaults to a remote target using the resolved remote endpoint. bundlesDir must be a relative path with no .. segments. See configuration for the underlying builtin and remote config, and Building a remote for the install source.

Keep the native addon out of the ASAR

@wvb/electron depends on @wvb/node, a native N-API addon (a .node binary). When asar: true, electron-builder packs node_modules into the ASAR archive, and native binaries cannot be loaded from inside ASAR. Use asarUnpack to unpack the addon so it loads at runtime:

{
  "asar": true,
  "asarUnpack": ["**/node_modules/@wvb/node/**"]
}

The plugin handles installing the builtin bundles, so you do not need extraResources for them. If you stage .wvb files yourself instead of using the plugin, ship the directory as an extra resource so it lands in Resources/bundles:

{
  "extraResources": [{ "from": "bundles", "to": "bundles" }]
}