# @plasmohq/edge-addons-api

> Microsoft Edge Addons API for Node.js

Latest version **2.0.0** (published 2025-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @plasmohq/edge-addons-api
pnpm add @plasmohq/edge-addons-api
yarn add @plasmohq/edge-addons-api
bun add @plasmohq/edge-addons-api
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-01-07 |
| First published | 2022-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=16.14 |
| Dependencies | 1 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Plasmo Corp. |
| Maintainers | louisgv, stayfun_ |
| Keywords | edge, webstore, upload, add-ons |

## Links

- npm: https://www.npmjs.com/package/@plasmohq/edge-addons-api
- Repository: https://github.com/PlasmoHQ/edge-addons-api
- Homepage: https://github.com/PlasmoHQ/edge-addons-api#readme
- Issues: https://github.com/PlasmoHQ/edge-addons-api/issues
- npm.io page: https://npm.io/package/@plasmohq/edge-addons-api

## Dependencies (1)

- [got](https://npm.io/package/got.md) 14.4.4

## Recent versions

- 2.0.0 (latest) — 2025-01-07
- 1.5.0 — 2024-11-13
- 1.4.0 — 2024-03-07
- 1.3.2 — 2023-06-21
- 1.3.1 — 2023-06-07
- 1.3.0 — 2023-05-28
- 1.2.0 — 2023-03-30
- 1.1.1 — 2023-01-16
- 1.1.0 — 2022-11-05
- 1.0.2 — 2022-09-25
- 1.0.1 — 2022-06-16
- 1.0.0 — 2022-05-17

## README

<p align="center">
  <a href="https://plasmo.com">
    <img alt="plasmo logo banner" width="75%" src="https://www.plasmo.com/assets/banner-black-on-white.png" />
  </a>
</p>

<p align="center">
  <a aria-label="License" href="./LICENSE">
    <img alt="See License" src="https://img.shields.io/npm/l/@plasmohq/edge-addons-api"/>
  </a>
  <a aria-label="NPM" href="https://www.npmjs.com/package/@plasmohq/edge-addons-api">
    <img alt="NPM Install" src="https://img.shields.io/npm/v/@plasmohq/edge-addons-api?logo=npm"/>
  </a>
  <a aria-label="Twitter" href="https://www.twitter.com/plasmohq">
    <img alt="Follow PlasmoHQ on Twitter" src="https://img.shields.io/twitter/follow/plasmohq?logo=twitter"/>
  </a>
  <a aria-label="Twitch Stream" href="https://www.twitch.tv/plasmohq">
    <img alt="Watch our Live DEMO every Friday" src="https://img.shields.io/twitch/status/plasmohq?logo=twitch&logoColor=white"/>
  </a>
  <a aria-label="Discord" href="https://www.plasmo.com/s/d">
    <img alt="Join our Discord for support and chat about our projects" src="https://img.shields.io/discord/946290204443025438?logo=discord&logoColor=white"/>
  </a>
  <a aria-label="Build status" href="https://github.com/PlasmoHQ/bpp/actions">
    <img alt="typescript-action status" src="https://github.com/PlasmoHQ/bpp/workflows/build-test/badge.svg"/>
  </a>
</p>

# Microsoft Edge Addons API for NodeJS

A tiny but powerful module from [plasmo](https://www.plasmo.com/) to publish browser add-ons to the [Microsoft Edge Web Store](https://microsoftedge.microsoft.com/addons/Microsoft-Edge-Extensions-Home).

This module uses [got](https://github.com/sindresorhus/got) to upload, check status, and submit an extension to the Microsoft Edge Webstore, using the [Microsoft Edge Add-ons API](https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/api/using-addons-api).

Features include:

- TypeScript API
- ESM (if you need cjs, please file an issue)
- Pinned dependencies, updated via renovatebot

## Installation

```
npm install --save-dev @plasmohq/edge-addons-api
```

## Usage

### Authentication

You'll need to get a `productId`, `clientId`, and `apiKey` for your project.

You can get these for your project by following the [Microsoft Edge Add-Ons API guide](https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/api/using-addons-api).

### Node.js API

```ts
import { EdgeAddonsAPI } from "@plasmohq/edge-addons-api"

const client = new EdgeAddonsAPI({
  productId,
  clientId,
  apiKey
})

await client.submit({
  filePath: "./dist/my-extension.zip",
  notes: "Developer notes"
})
```

## License

[MIT](./license) 🖖 [Plasmo](https://www.plasmo.com)

---
_Source: https://npm.io/package/@plasmohq/edge-addons-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._