TypeScript typings for Chrome Web Store API v2

The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them. For detailed description please check documentation.

Installing

Install typings for Chrome Web Store API:

npm install @types/gapi.client.chromewebstore-v2 --save-dev

TypeScript 6.0+

TypeScript 6.0 changed types to default to []. You must now explicitly list type packages in tsconfig.json:

{
  "compilerOptions": {
    "types": [
      "gapi",
      "gapi.auth2",
      "gapi.client",
      "gapi.client.chromewebstore-v2"
    ]
  }
}

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://chromewebstore.googleapis.com/$discovery/rest?version=v2',
  () => {
    // now we can use:
    // gapi.client.chromewebstore
  },
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('chromewebstore', 'v2', () => {
  // now we can use:
  // gapi.client.chromewebstore
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, update, or publish your Chrome Web Store extensions, themes, apps, and licences you have access to
    'https://www.googleapis.com/auth/chromewebstore',

    // See and download your Chrome Web Store extensions and apps, and see licenses you have access to
    'https://www.googleapis.com/auth/chromewebstore.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);

After that you can use Chrome Web Store API resources:

/*
Upload a new package to an existing item.
*/
await gapi.client.chromewebstore.media.upload({name: 'name'});

For provenance information see Provenance section on NPM