@adobe/spacecat-shared-google-client 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-google-client-v1.0.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.0.0...@adobe/spacecat-shared-google-client-v1.0.1) (2024-05-21)
+
+
+### Bug Fixes
+
+* google client interface ([#235](https://github.com/adobe/spacecat-shared/issues/235)) ([9e0dc2c](https://github.com/adobe/spacecat-shared/commit/9e0dc2cdc080411597f47319b5dcc2bedf764ada))
+
 # @adobe/spacecat-shared-google-client-v1.0.0 (2024-05-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-google-client",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Shared modules of the Spacecat Services - Google Client",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -16,16 +16,12 @@ import { OAuth2Client } from 'google-auth-library';
 export default class GoogleClient {
   /**
    * Static factory method to create an instance of GoogleClient.
+   *
    * @param {UniversalContext} context - An object containing the AWS Lambda context information
-   * @param {object} config - The configuration object:
-   * {
-   *   ACCESS_TOKEN: string,
-   *   REFRESH_TOKEN: string,
-   *   EXPIRATION: number,
-   * }
+   * @param {string} url - The URL of the site to be audited.
    * @returns An instance of GoogleClient.
    */
-  static createFrom(context: UniversalContext, config: object): GoogleClient;
+  static createFrom(context: UniversalContext, url: string): GoogleClient;
 
   /**
    * Constructor for creating an instance of GoogleClient.
@@ -36,13 +32,14 @@ export default class GoogleClient {
 
   /**
    * Retrieves the Google Search Console data for the specified date range.
+   *
    * @param baseURL - The base URL of the site to be audited.
    * @param startDate - The start date of the date range.
    * @param endDate - The end date of the date range.
    * @param dimensions - The dimensions to be included in the report.
    * this parameter is optional and defaults to ['date'],
    * which means that the report will be grouped by date.
-   * @returns {Promise<Response>} The Google Search Console data.
+   * @returns {Promise<JSON>} The Google Search Console data.
    * Format: {
    *   "rows": [
    *     {
@@ -63,12 +60,12 @@ export default class GoogleClient {
     startDate: Date,
     endDate: Date,
     dimensions: string[]
-  ): Promise<Response>;
+  ): Promise<JSON>;
 
   /**
    * Lists all sites available to the authenticated user in Google Search Console.
    *
-   * @returns {Promise<Response>} A promise that resolves to the result of the list sites operation.
+   * @returns {Promise<JSON>} A promise that resolves to the result of the list sites operation.
    * @throws {Error} If an error occurs while retrieving the sites.
    * Format: {
    *  "data": {
@@ -81,5 +78,5 @@ export default class GoogleClient {
    *  }
    *}
    * */
-  listSites(): Promise<Response>;
+  listSites(): Promise<JSON>;
 }