@maxim_mazurok/gapi.client.verifiedaccess-v1 0.0.20220519

package/index.d.ts

@@ -0,0 +1,175 @@
+/* Type definitions for non-npm package Chrome Verified Access API v1 0.0 */
+// Project: https://developers.google.com/chrome/verified-access
+// 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
+// TypeScript Version: 2.8
+
+// 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://verifiedaccess.googleapis.com/$discovery/rest?version=v1
+// Revision: 20220519
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Chrome Verified Access API v1 */
+    function load(urlOrObject: "https://verifiedaccess.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "verifiedaccess", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "verifiedaccess", version: "v1", callback: () => any): void;
+
+    namespace verifiedaccess {
+        interface Challenge {
+            /** Challenge generated with the old signing key (this will only be present during key rotation) */
+            alternativeChallenge?: SignedData;
+            /** Generated challenge */
+            challenge?: SignedData;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface Empty {
+        }
+        interface SignedData {
+            /** The data to be signed. */
+            data?: string;
+            /** The signature of the data field. */
+            signature?: string;
+        }
+        interface VerifyChallengeResponseRequest {
+            /** The generated response to the challenge */
+            challengeResponse?: SignedData;
+            /**
+             * Service can optionally provide identity information about the device or user associated with the key. For an EMK, this value is the enrolled domain. For an EUK, this value is the
+             * user's email address. If present, this value will be checked against contents of the response, and verification will fail if there is no match.
+             */
+            expectedIdentity?: string;
+        }
+        interface VerifyChallengeResponseResult {
+            /** Device enrollment id is returned in this field (for the machine response only). */
+            deviceEnrollmentId?: string;
+            /** Device permanent id is returned in this field (for the machine response only). */
+            devicePermanentId?: string;
+            /**
+             * Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the
+             * option to include CSR is now available for both user and machine responses)
+             */
+            signedPublicKeyAndChallenge?: string;
+            /**
+             * For EMCert check, device permanent id is returned here. For EUCert check, signed_public_key_and_challenge [base64 encoded] is returned if present, otherwise empty string is
+             * returned. This field is deprecated, please use device_permanent_id or signed_public_key_and_challenge fields.
+             */
+            verificationOutput?: string;
+        }
+        interface ChallengeResource {
+            /** CreateChallenge API */
+            create(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;
+                /** 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 body */
+                resource: Empty;
+            }): Request<Challenge>;
+            create(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;
+                /** 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;
+            },
+            body: Empty): Request<Challenge>;
+            /** VerifyChallengeResponse API */
+            verify(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;
+                /** 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 body */
+                resource: VerifyChallengeResponseRequest;
+            }): Request<VerifyChallengeResponseResult>;
+            verify(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;
+                /** 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;
+            },
+            body: VerifyChallengeResponseRequest): Request<VerifyChallengeResponseResult>;
+        }
+
+        const challenge: ChallengeResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.verifiedaccess-v1",
+  "version": "0.0.20220519",
+  "description": "TypeScript typings for Chrome Verified Access API v1",
+  "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": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,78 @@
+# TypeScript typings for Chrome Verified Access API v1
+
+API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network
+For detailed description please check [documentation](https://developers.google.com/chrome/verified-access).
+
+## Installing
+
+Install typings for Chrome Verified Access API:
+
+```
+npm install @types/gapi.client.verifiedaccess-v1 --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://verifiedaccess.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.verifiedaccess
+});
+```
+
+```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('verifiedaccess', 'v1', () => {
+  // now we can use:
+  // gapi.client.verifiedaccess
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // Verify your enterprise credentials
+      'https://www.googleapis.com/auth/verifiedaccess',
+    ],
+    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 Verified Access API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+CreateChallenge API
+*/
+await gapi.client.verifiedaccess.challenge.create({  });
+
+/*
+VerifyChallengeResponse API
+*/
+await gapi.client.verifiedaccess.challenge.verify({  });
+```

package/tests.ts

@@ -0,0 +1,46 @@
+/* This is stub file for gapi.client.verifiedaccess-v1 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: 20220519
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://verifiedaccess.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.verifiedaccess */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** Verify your enterprise credentials */
+        'https://www.googleapis.com/auth/verifiedaccess',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /** CreateChallenge API */
+        await gapi.client.verifiedaccess.challenge.create({
+        }, {
+        });
+        /** VerifyChallengeResponse API */
+        await gapi.client.verifiedaccess.challenge.verify({
+        }, {
+            challengeResponse: {
+                data: "Test string",
+                signature: "Test string",
+            },
+            expectedIdentity: "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
+    }
+}