updates/formatting

Author: michelle0927

components/google_search_console/actions/retrieve-site-performance-data/retrieve-site-performance-data.mjs

@@ -1,27 +1,27 @@
-
 /**
  * Fetches performance data (clicks, impressions, etc.) for a verified site
  * via the Google Search Console Search Analytics API.
- * 
+ *
  * Full usage docs in README.md
  */
 
-
 import { axios } from "@pipedream/platform";
 import gsConsole from "../../google_search_console.app.mjs";
-import {removeCustomPropFields, trimIfString } from "../../common/utils.mjs"
+import {
+  removeCustomPropFields, trimIfString,
+} from "../../common/utils.mjs";
 
-/* 
-  Define prop metadata separately, including custom fields used for extended validation 
+/*
+  Define prop metadata separately, including custom fields used for extended validation
   and runtime behavior.
 
-  These extended fields (like `extendedType`, `postBody`, etc.) are not part of the standard 
+  These extended fields (like `extendedType`, `postBody`, etc.) are not part of the standard
   Pipedream prop schema.
 
   A helper function (`removeCustomPropFields`) will later strip these non-standard fields,
   returning only valid Pipedream props for use in the UI.
 
-  Keeping the full metadata in closure allows access to helpful context (e.g. validation rules) 
+  Keeping the full metadata in closure allows access to helpful context (e.g. validation rules)
   during runtime.
 */
 const propsMeta = {
@@ -55,15 +55,25 @@ const propsMeta = {
     type: "string",
     label: "Search Type",
     optional: true,
-    options: ["web", "image", "video", "news", "googleNews", "discover"],
+    options: [
+      "web",
+      "image",
+      "video",
+      "news",
+      "googleNews",
+      "discover",
+    ],
     default: "web",
     postBody: true,
   },
   aggregationType: {
     type: "string",
     label: "Aggregation Type",
     optional: true,
-    options: ["auto", "byPage"],
+    options: [
+      "auto",
+      "byPage",
+    ],
     postBody: true,
   },
   rowLimit: {
@@ -89,34 +99,33 @@ const propsMeta = {
     type: "string",
     label: "Data State",
     optional: true,
-    options: ["all", "final"],
+    options: [
+      "all",
+      "final",
+    ],
     default: "final",
     postBody: true,
   },
-
-
-
 };
 
 export default {
   name: "Retrieve Site Performance Data",
   description: "Fetches search analytics from Google Search Console for a verified site.",
-  key: "retrieve-site-performance-data",
-  version: "0.0.2",
+  key: "google_search_console-retrieve-site-performance-data",
+  version: "0.0.1",
   type: "action",
   props: {
     gsConsole,
     // Remove non-standard fields and expose only valid props to Pipedream UI
     ...removeCustomPropFields(propsMeta),
   },
 
-
   //=================== RUN ==============================
   //======================================================
 
   async run({ $ }) {
 
-  /* 
+    /*
       `dimensionFilterGroups` is expected to be an object.
       If a JSON string is passed instead (e.g. from UI input), attempt to parse it.
       - Returns parsed object if successful
@@ -131,24 +140,24 @@ export default {
     // Accumulator for non-blocking input warnings
     const warnings = [];
 
-     /*
+    /*
       This loop:
       - Trims and validates all defined props
       - Skips empty optional fields
       - Accumulates non-blocking warnings
       - Adds valid props to the POST request payload (`body`) if marked with `postBody: true`
     */
-    for (let propName in propsMeta){
+    for (let propName in propsMeta) {
 
       // Just for convenience.
       const meta = propsMeta[propName];
 
-       // Trim the value if it's a string
-       this[propName] = trimIfString(this[propName]);
+      // Trim the value if it's a string
+      this[propName] = trimIfString(this[propName]);
 
       // Skip if the prop is optional and empty (null, undefined, or blank string)
-      if (meta.optional === true && ((this[propName] ?? '') === '')) continue;
-      
+      if (meta.optional === true && ((this[propName] ?? "") === "")) continue;
+
       // Validate input (may throw or return warning messages)
       const validationResult = this.gsConsole.validateUserInput(meta, this[propName]);
 
@@ -166,24 +175,23 @@ export default {
     let response;
 
     try {
-        response = await axios($, {
-          method: "POST",
-          url: `https://searchconsole.googleapis.com/webmasters/v3/sites/${encodeURIComponent(url)}/searchAnalytics/query`,
-          headers: {
-            Authorization: `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
-            "Content-Type": "application/json",
-          },
-          data: body,
-       })
+      response = await axios($, {
+        method: "POST",
+        url: `https://searchconsole.googleapis.com/webmasters/v3/sites/${encodeURIComponent(url)}/searchAnalytics/query`,
+        headers: {
+          "Authorization": `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
+          "Content-Type": "application/json",
+        },
+        data: body,
+      });
 
     } catch (error) {
-       // Identify if the error was thrown by internal validation or by the API call
+      // Identify if the error was thrown by internal validation or by the API call
       const thrower = this.gsConsole.checkWhoThrewError(error);
-                                            
+
       throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));
-    
     };
-    
+
     // Output summary and any warnings for the user
     $.export("$summary", ` Fetched ${response.rows?.length || 0} rows of data. ` + warnings.join("\n- "));
     return response;

components/google_search_console/actions/submit-url-for-indexing/submit-url-for-indexing.mjs

@@ -5,39 +5,35 @@
 
 import { axios } from "@pipedream/platform";
 import gsConsole from "../../google_search_console.app.mjs";
-import { trimIfString } from "../../common/utils.mjs"
+import { trimIfString } from "../../common/utils.mjs";
 
-
- 
 export default {
 
   name: "Submit URL for Indexing",
   description: "Sends a URL update notification to the Google Indexing API",
-  key: "submit-url-for-indexing",
+  key: "google_search_console-submit-url-for-indexing",
   version: "0.0.1",
   type: "action",
   props: {
     gsConsole,
-    siteUrl : {
-      type: "string", 
-      label: "URL for indexing", 
-      description: "URL to be submitted for indexing"
+    siteUrl: {
+      type: "string",
+      label: "URL for indexing",
+      description: "URL to be submitted for indexing",
     },
   },
 
-
   //=================== RUN ==============================
   //======================================================
 
-
   async run({ $ }) {
 
     this.siteUrl = trimIfString(this.siteUrl);
 
     // Accumulator for non-blocking warnings
     let warnings = [];
 
-      /*
+    /*
       Validate the submitted site URL.
       - May throw if invalid
       - May return warnings for issues like suspicious characters
@@ -46,7 +42,6 @@ export default {
 
     if (urlCheck.warnings) warnings.push(...urlCheck.warnings);
 
-
     // Prepare the API response object
     let response;
 
@@ -56,8 +51,7 @@ export default {
         method: "POST",
         url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
         headers: {
-
-          Authorization: `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
+          "Authorization": `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
           "Content-Type": "application/json",
         },
         data: {
@@ -74,13 +68,13 @@ export default {
         Helps distinguish between coding issues vs API issues.
       */
       const thrower = gsConsole.methods.checkWhoThrewError(error);
-                                                  
+
       throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));
-          
+
     };
     // Output a summary message and any accumulated warnings
     $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("\n- "));
-     // Return the raw API response
+    // Return the raw API response
     return response;
   },
 };