Introduction

Typed Chrome Webstore API to upload/publish extensions and downloading crx file

Installation

npm install typed-chrome-webstore-api

How to use

See https://developer.chrome.com/webstore/using_webstore_api to understand methods meaning and know how to get client_id, client_secret and refresh_token strings needed for authentication.

To work with Webstore API you need to get token first:

1const fetchToken = require('typed-chrome-webstore-api').fetchToken;
2const token = fetchToken('clientId', 'clientSecret', 'refreshToken');

Then create WebstoreApi instance initialized with token:

1const WebstoreApi = require('typed-chrome-webstore-api').WebstoreApi;
2const api = new WebstoreApi(token);

Upload new extension

1// Any Readable stream or Buffer
2const zip = fs.createReadStream('./mypackage.zip');
3// Result format is defined as IWebstoreResource in d.ts file 
4const result = await api.upload(zip);

Upload existed extension

appId is the ID of the existing Web Store item (could be found in admin panel)

1// Any Readable stream or Buffer
2const zip = fs.createReadStream('./mypackage.zip');
3// Result format is defined as IWebstoreResource in .d.ts file 
4const result = await api.upload(zip, appId);

Check uploaded app/extension status

1// Result format is defined as IWebstoreResource in .d.ts file 
2const result = await api.get(appId);

Publish item

1// 'default' or 'trustedTesters', defined in PublishTarget enum in .d.ts file
2const target = 'default';
3// Result format is defined as IPublishResponse in .d.ts file 
4const result = await api.publish(appId, target);

Be aware of API's undocumented behaviour. For example, extension had a version = '1.10.0' Then we successfully published a new one with version = '1.20.0' (status = 'OK') 'get upload' request returns version '1.20.0' after it. But this version is still in publishing progress Now we are publishing '1.30.0' but 'publish' and request fails with 500 error, but (!) actually Our version have been accepted, and after some time out extension increases it's version to '1.30.0'!

Get Licenses

1const result = await api.getLicenses(appId, userId);

Get User Licenses

1const result = await api.getUserLicenses(appId);

Get Payments

1const result = await api.getPayments(itemId);

Download extension crx

This feature is experimental because of API is not documented

1// A bit ugly, looks better if you use TypeScript :)
2const downloadCrx = require('typed-chrome-webstore-api').DownloadCrx.downloadCrx;
3const fs = require('fs');
4
5const fstream = fs.createWriteStream('file.crx');
6const readStream = await downloadCrx('extensionId');
7readStream.pipe(fstream);

downloadCrx() also accepts additional options, look at downloadCrx.d.ts file for details

Licence

MIT License