TypeScript typings for Safe Browsing API v5

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API. For detailed description please check documentation.

Installing

Install typings for Safe Browsing API:

npm install @types/gapi.client.safebrowsing-v5 --save-dev

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://safebrowsing.googleapis.com/$discovery/rest?version=v5',
  () => {
    // now we can use:
    // gapi.client.safebrowsing
  },
);

// 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('safebrowsing', 'v5', () => {
  // now we can use:
  // gapi.client.safebrowsing
});

After that you can use Safe Browsing API resources:

/*
Searches for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).
*/
await gapi.client.safebrowsing.hashes.search({});

/*
Gets the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.
*/
await gapi.client.safebrowsing.hashList.get({name: 'name'});

/*
Gets multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.
*/
await gapi.client.safebrowsing.hashLists.batchGet({});

/*
Lists hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.
*/
await gapi.client.safebrowsing.hashLists.list({});

/*
Searches for URLs matching known threats. Each URL and it's host-suffix and path-prefix expressions (up to a limited depth) are checked. This means that the response may contain URLs that were not included in the request, but are expressions of the requested URLs.
*/
await gapi.client.safebrowsing.urls.search({});

For provenance information see Provenance section on NPM