Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fregante/chrome-webstore-upload
Upload Chrome Extensions to the Chrome Web Store
https://github.com/fregante/chrome-webstore-upload
Last synced: about 2 months ago
JSON representation
Upload Chrome Extensions to the Chrome Web Store
- Host: GitHub
- URL: https://github.com/fregante/chrome-webstore-upload
- Owner: fregante
- License: mit
- Created: 2016-05-22T20:26:12.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T10:21:37.000Z (8 months ago)
- Last Synced: 2024-05-01T21:17:26.171Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 66.4 KB
- Stars: 347
- Watchers: 8
- Forks: 48
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# chrome-webstore-upload
> A small node.js module to upload/publish extensions to the [Chrome Web Store](https://chrome.google.com/webstore/category/extensions).
If you're looking to upload/publish from the CLI, then use [chrome-webstore-upload-cli](https://github.com/fregante/chrome-webstore-upload-cli).
## Install
```
npm install --save-dev chrome-webstore-upload
```
## Setup
You will need a Google API `clientId`, `clientSecret` and `refreshToken`. Use [the guide]( https://github.com/fregante/chrome-webstore-upload-keys).
## Usage
All methods return a promise.
### Create a new client
```javascript
import chromeWebstoreUpload from 'chrome-webstore-upload';
const store = chromeWebstoreUpload({
extensionId: 'ecnglinljpjkbgmdpeiglonddahpbkeb',
clientId: 'xxxxxxxxxx',
clientSecret: 'xxxxxxxxxx',
refreshToken: 'xxxxxxxxxx',
});
```
### Upload to existing extension
```javascript
import fs from 'fs';
const myZipFile = fs.createReadStream('./mypackage.zip');
const token = 'xxxx'; // optional. One will be fetched if not provided
const response = await store.uploadExisting(myZipFile, token);
// response is a Resource Representation
// https://developer.chrome.com/webstore/webstore_api/items#resource
```
### Publish extension
```javascript
const target = 'default'; // optional. Can also be 'trustedTesters'
const token = 'xxxx'; // optional. One will be fetched if not provided
const deployPercentage = 25; // optional. Will default to 100%.
const response = await store.publish(target, token, deployPercentage);
// response is documented here:
// https://developer.chrome.com/webstore/webstore_api/items#publish
```
### Get a Chrome Web Store item
```javascript
const projection = "DRAFT"; // optional. Can also be 'PUBLISHED' but only "DRAFT" is supported at this time.
const token = "xxxx"; // optional. One will be fetched if not provided
const response = await store.get(projection, token);
// response is documented here:
// https://developer.chrome.com/docs/webstore/webstore_api/items#get
```
### Fetch token
```javascript
const token = store.fetchToken();
// token is astring
```
## Tips
- If you plan to upload _and_ publish at the same time, use the `fetchToken` method, and pass it to both `uploadExisting` and `publish` as the optional second parameter. This will avoid those methods making duplicate calls for new tokens.
## Related
- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration. Chrome and Firefox
- [webext-dynamic-content-scripts](https://github.com/fregante/webext-dynamic-content-scripts) - Automatically registers your content_scripts on domains added via permission.request
- [Awesome-WebExtensions](https://github.com/fregante/Awesome-WebExtensions) - A curated list of awesome resources for WebExtensions development.
- [More…](https://github.com/fregante/webext-fun)