https://github.com/plasmohq/edge-addons-api

🐓 Edge Addons API Library for nodejs
https://github.com/plasmohq/edge-addons-api

addon browser-extension edge

Last synced: about 1 month ago
JSON representation

🐓 Edge Addons API Library for nodejs

• Host: GitHub
• URL: https://github.com/plasmohq/edge-addons-api
• Owner: PlasmoHQ
• License: mit
• Created: 2022-03-24T17:02:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T07:12:50.000Z (7 months ago)
• Last Synced: 2024-05-21T08:34:39.182Z (7 months ago)
• Topics: addon, browser-extension, edge
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@plasmo-corp/ewu
• Size: 138 KB
• Stars: 16
• Watchers: 2
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


  

    

  





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



# 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`, `clientSecret`, and `accessTokenUrl` 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,

  clientSecret,

  accessTokenUrl

})

await client.submit({

  filePath: "./dist/my-extension.zip",

  notes: "Developer notes"

})

```

## License

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