@maxim_mazurok/gapi.client.safebrowsing-v5 0.0.20230923

package/index.d.ts

@@ -0,0 +1,98 @@
+/* Type definitions for non-npm package Safe Browsing API v5 0.0 */
+// Project: https://developers.google.com/safe-browsing/
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://safebrowsing.googleapis.com/$discovery/rest?version=v5
+// Revision: 20230923
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Safe Browsing API v5 */
+    function load(urlOrObject: "https://safebrowsing.googleapis.com/$discovery/rest?version=v5"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "safebrowsing", version: "v5"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "safebrowsing", version: "v5", callback: () => any): void;
+
+    namespace safebrowsing {
+        interface GoogleSecuritySafebrowsingV5FullHash {
+            /** The matching full hash. This is the SHA256 hash. The length will be exactly 32 bytes. */
+            fullHash?:
+                string;
+            /** Unordered list. A repeated field identifying the details relevant to this full hash. */
+            fullHashDetails?:
+                GoogleSecuritySafebrowsingV5FullHashFullHashDetail[];
+        }
+        interface GoogleSecuritySafebrowsingV5FullHashFullHashDetail {
+            /** Unordered list. Additional attributes about those full hashes. This may be empty. */
+            attributes?:
+                string[];
+            /** The type of threat. This field will never be empty. */
+            threatType?:
+                string;
+        }
+        interface GoogleSecuritySafebrowsingV5SearchHashesResponse {
+            /**
+             * The client-side cache duration. The client shall add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix
+             * queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this
+             * fact should also be cached by the client. Important: the client must not assume that the server will return the same cache duration for all responses. The server may choose
+             * different cache durations for different responses depending on the situation.
+             */
+            cacheDuration?:
+                string;
+            /** Unordered list. The unordered list of full hashes found. */
+            fullHashes?:
+                GoogleSecuritySafebrowsingV5FullHash[];
+        }
+        interface HashesResource {
+            /** Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136 */
+            search(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** Required. The hash prefixes to be looked up. */
+                hashPrefixes?:
+                    string | string[];
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<GoogleSecuritySafebrowsingV5SearchHashesResponse>;
+        }
+
+        const hashes: HashesResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.safebrowsing-v5",
+  "version": "0.0.20230923",
+  "description": "TypeScript typings for Safe Browsing API v5",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery-v1": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,52 @@
+# 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](https://developers.google.com/safe-browsing/).
+
+## 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:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://safebrowsing.googleapis.com/$discovery/rest?version=v5', () => {
+  // now we can use:
+  // gapi.client.safebrowsing
+});
+```
+
+```typescript
+// 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: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136
+*/
+await gapi.client.safebrowsing.hashes.search({  });
+```

package/tests.ts

@@ -0,0 +1,22 @@
+/* This is stub file for gapi.client.safebrowsing-v5 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20230923
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://safebrowsing.googleapis.com/$discovery/rest?version=v5');
+    /** now we can use gapi.client.safebrowsing */
+
+    run();
+
+    async function run() {
+        /** Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136 */
+        await gapi.client.safebrowsing.hashes.search({
+            hashPrefixes: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}