@plasmohq/bms

Browser Market Submit

A nodejs library from plasmo to deploy browser extensions to multiple stores. It is made to be used in bpp

Supported stores:

• Chrome Web Store
• Firefox Add-ons
• Edge Add-ons
• Opera Add-ons

Core packages used

• @plasmo-corp/cwu - for uploading extensions to Chrome Web Store.
• @plasmo-corp/mwu - for signing and uploading extensions to Firefox Addon API.
• @plasmo-corp/ewu - for uploading and publishing extensions to Edge Add-ons API.
• Puppeteer - for uploading extensions to Opera Add-ons store.

Installing

npm i -D @plasmo-corp/bms
# or
pnpm i -D @plasmo-corp/bms
# or
yarn add -D @plasmo-corp/bms

Usage

Following this doc to gather the tokens necessary for the deployment, OR use bpp's json schema which provides intellisense on editors such as vscode. To use the json schema, create a keys.json file in vscode with the following content:

{
  "$schema": "https://raw.githubusercontent.com/PlasmoHQ/bpp/v2/keys.schema.json"
}

Then, the nodejs API can be consumed as follows:

import {
  deployChrome,
  deployEdge,
  deployFirefox,
  deployOpera,
} from "@plasmo-corp/bms"

deployChrome({
  extId: "EXT_ID",
  refreshToken: "refreshToken",
  clientId: "clientId",
  zip: "dist/some-zip-v{version}.zip",
  verbose: false
})

deployFirefox({
  extId: "EXT_ID",
  apiKey: "api_key",
  apiSecret: "api_secret",
  zip: "dist/some-zip-v{version}.zip",
  verbose: false
})

deployEdge({
  clientId: "aaaaaaa-aaaa-bbbb-cccc-dddddddddddd",
  clientSecret: "abcdefg",
  productId: "aaaaaaa-aaaa-bbbb-cccc-dddddddddddd",
  accessTokenUrl: "https://login.microsoftonline.com/aaaaaaa-aaaa-bbbb-cccc-dddddddddddd/oauth2/v2.0/token",
  zip: "dist/some-zip-v{version}.zip",
  notes: "Changes for reviewers",
  verbose: false
})

deployOpera({
  packageId: "123456",
  sessionid: "sessionid_value",
  csrftoken: "csrftoken_value",
  zip: "dist/some-zip-v{version}.zip",
  changelog: "Some changes",
  verbose: false
})

Support

Join the Discord channel!

Acknowledgment

This library was inspired by:

• web-ext-deploy by avi12
  • The documentation and API of bms is largely inspired by web-ext-deploy.
• chrome-webstore-upload-cli by fregante
• web-ext by mozilla

License

MIT ⭐ Plasmo Corp.