@adobe/spacecat-shared-google-client 1.1.18 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-google-client-v1.2.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.1.19...@adobe/spacecat-shared-google-client-v1.2.0) (2024-08-20)
+
+
+### Features
+
+* introduce url inspect in google client ([#326](https://github.com/adobe/spacecat-shared/issues/326)) ([eb9e8ae](https://github.com/adobe/spacecat-shared/commit/eb9e8ae67f7a95ca5e4abb993f8b625400735312))
+
+# [@adobe/spacecat-shared-google-client-v1.1.19](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.1.18...@adobe/spacecat-shared-google-client-v1.1.19) (2024-08-19)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#332](https://github.com/adobe/spacecat-shared/issues/332)) ([b2bb2a4](https://github.com/adobe/spacecat-shared/commit/b2bb2a4dd1a0995c36cd2b64510b7c4e0e05436f))
+
 # [@adobe/spacecat-shared-google-client-v1.1.18](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.1.17...@adobe/spacecat-shared-google-client-v1.1.18) (2024-08-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-google-client",
-  "version": "1.1.18",
+  "version": "1.2.0",
   "description": "Shared modules of the Spacecat Services - Google Client",
   "type": "module",
   "main": "src/index.js",
@@ -34,16 +34,16 @@
     "@adobe/helix-universal": "5.0.5",
     "@adobe/spacecat-shared-http-utils": "1.1.4",
     "@adobe/spacecat-shared-utils": "1.15.1",
-    "@aws-sdk/client-secrets-manager": "3.624.0",
+    "@aws-sdk/client-secrets-manager": "3.632.0",
     "google-auth-library": "9.13.0",
-    "googleapis": "140.0.1"
+    "googleapis": "142.0.0"
   },
   "devDependencies": {
-    "chai": "4.5.0",
+    "chai": "5.1.1",
     "chai-as-promised": "8.0.0",
     "nock": "13.5.4",
     "sinon": "18.0.0",
-    "sinon-chai": "3.7.0",
+    "sinon-chai": "4.0.0",
     "typescript": "5.5.4"
   }
 }

package/src/index.d.ts

@@ -63,6 +63,13 @@ export default class GoogleClient {
     startRow?: number
   ): Promise<JSON>;
 
+  /**
+   * Retrieves the Google Search Console data for the specified url.
+   * @param url - The URL of the site to be inspected
+   * @returns {Promise<JSON>} The Google Search Console data.
+   */
+  urlInspect(url: string): Promise<JSON>;
+
   /**
    * Lists all sites available to the authenticated user in Google Search Console.
    *

package/src/index.js

@@ -17,9 +17,11 @@ import {
   composeAuditURL,
   isArray,
   isInteger,
-  isValidDate, isValidUrl,
+  isValidDate,
+  isValidUrl,
   resolveCustomerSecretsName,
 } from '@adobe/spacecat-shared-utils';
+import { fetch as httpFetch } from './utils.js';
 
 export default class GoogleClient {
   static async createFrom(context, baseURL) {
@@ -148,6 +150,38 @@ export default class GoogleClient {
     }
   }
 
+  async urlInspect(url) {
+    if (!isValidUrl(url)) {
+      throw new Error(`Error inspecting URL: Invalid URL format (${url})`);
+    }
+
+    await this.#refreshTokenIfExpired();
+
+    const apiEndpoint = 'https://searchconsole.googleapis.com/v1/urlInspection/index:inspect';
+
+    const response = await httpFetch(apiEndpoint, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${this.authClient.credentials.access_token}`,
+      },
+      body: JSON.stringify({
+        inspectionUrl: url,
+        siteUrl: this.siteUrl,
+      }),
+    });
+
+    if (!response.ok) {
+      throw new Error(`Error inspecting URL ${url}. Returned status ${response.status}`);
+    }
+
+    try {
+      return await response.json();
+    } catch (e) {
+      throw new Error(`Error parsing result of inspecting URL ${url}: ${e.message}`);
+    }
+  }
+
   async listSites() {
     await this.#refreshTokenIfExpired();
 

package/src/utils.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { context as h2, h1 } from '@adobe/fetch';
+
+/* c8 ignore next 3 */
+export const { fetch } = process.env.HELIX_FETCH_FORCE_HTTP1
+  ? h1()
+  : h2();