Browser extensions

A Browser extension is a reusable Chromium .crx package stored by BCTRL. Import an extension from a Chrome Web Store detail URL or upload a CRX package, then reference its ID in browser Runtime configuration.

Import an extension

Import from a Chrome Web Store detail URL:

1
const extension = await bctrl.browserExtensions.import({
2
  url: "https://chromewebstore.google.com/detail/example/extension-id",
3
  name: "Checkout helper",
4
});
5
6
console.log(extension.id, extension.name, extension.version);

Or upload a CRX package directly:

1
const extension = await bctrl.browserExtensions.upload({
2
  file: new Blob([crxBytes], { type: "application/x-chrome-extension" }),
3
  name: "Checkout helper",
4
});

The upload name is optional. When omitted, BCTRL uses the extension manifest name.

Load an extension in a Runtime

Pass stored extension IDs in the browser Runtime configuration:

1
const runtime = await bctrl.runtimes.create({
2
  config: {
3
    extensionIds: [extension.id],
4
  },
5
});

Extensions are loaded when the browser starts. To change the extension list on a profile-backed Runtime, update its configuration while it is stopped, then start it again:

1
await bctrl.runtimes.update(runtime.id, {
2
  config: {
3
    extensionIds: [extension.id],
4
  },
5
});
6
7
await bctrl.runtimes.start(runtime.id);

See Runtimes for the complete browser configuration shape.

List extensions

1
for await (const item of bctrl.browserExtensions.iter({
2
  source: "url",
3
})) {
4
  console.log(item.id, item.name, item.version, item.profileCount);
5
}

Available filters are:

list() returns one cursor page. iter() follows all pages automatically.

Rename and delete

1
const current = await bctrl.browserExtensions.get(extension.id);
2
3
await bctrl.browserExtensions.update(extension.id, {
4
  name: "Checkout automation helper",
5
});
6
7
await bctrl.browserExtensions.delete(extension.id);

Delete an extension when it should no longer be available to new Runtime starts. Remove it from Runtime configuration first; deletion can be rejected while the extension is still in use.

Extension fields