@adobe/spacecat-shared-utils 1.60.0 → 1.61.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.61.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.60.0...@adobe/spacecat-shared-utils-v1.61.0) (2025-10-23)
+
+
+### Features
+
+* SITES-36623 added url extraction for opportunities and suggestions ([#1038](https://github.com/adobe/spacecat-shared/issues/1038)) ([1e16802](https://github.com/adobe/spacecat-shared/commit/1e16802b8189f64cc71c9ecc8d0c100c350408f7))
+
 # [@adobe/spacecat-shared-utils-v1.60.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.59.4...@adobe/spacecat-shared-utils-v1.60.0) (2025-10-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.60.0",
+  "version": "1.61.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "exports": {

package/src/constants.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2025 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.
+ */
+
+const OPPORTUNITY_TYPES = {
+  // Core Audit Types
+  ACCESSIBILITY: 'accessibility',
+  ALT_TEXT: 'alt-text',
+  BROKEN_BACKLINKS: 'broken-backlinks',
+  BROKEN_INTERNAL_LINKS: 'broken-internal-links',
+  CANONICAL: 'canonical',
+  CWV: 'cwv',
+  HEADINGS: 'headings',
+  HREFLANG: 'hreflang',
+  INVALID_OR_MISSING_METADATA: 'meta-tags',
+  NOTFOUND: '404',
+  PRERENDER: 'prerender',
+  SECURITY_CSP: 'security-csp',
+  SECURITY_VULNERABILITIES: 'security-vulnerabilities',
+  SITEMAP: 'sitemap',
+  STRUCTURED_DATA: 'structured-data',
+
+  // Custom Audit Types (not in shared AUDIT_TYPES)
+  LLM_BLOCKED: 'llm-blocked',
+  REDIRECT_CHAINS: 'redirect-chains',
+  SECURITY_PERMISSIONS: 'security-permissions',
+  SECURITY_PERMISSIONS_REDUNDANT: 'security-permissions-redundant',
+  SITEMAP_PRODUCT_COVERAGE: 'sitemap-product-coverage',
+
+  // Experimentation Opportunities
+  HIGH_ORGANIC_LOW_CTR: 'high-organic-low-ctr',
+  RAGECLICK: 'rageclick',
+  HIGH_INORGANIC_HIGH_BOUNCE_RATE: 'high-inorganic-high-bounce-rate',
+
+  // Forms Opportunities
+  HIGH_FORM_VIEWS_LOW_CONVERSIONS: 'high-form-views-low-conversions',
+  HIGH_PAGE_VIEWS_LOW_FORM_NAV: 'high-page-views-low-form-nav',
+  HIGH_PAGE_VIEWS_LOW_FORM_VIEWS: 'high-page-views-low-form-views',
+  FORM_ACCESSIBILITY: 'form-accessibility',
+
+  // Geo Brand Presence
+  DETECT_GEO_BRAND_PRESENCE: 'detect:geo-brand-presence',
+  DETECT_GEO_BRAND_PRESENCE_DAILY: 'detect:geo-brand-presence-daily',
+  GEO_BRAND_PRESENCE_TRIGGER_REFRESH: 'geo-brand-presence-trigger-refresh',
+  GUIDANCE_GEO_FAQ: 'guidance:geo-faq',
+
+  // Accessibility Sub-types
+  A11Y_ASSISTIVE: 'a11y-assistive',
+  COLOR_CONTRAST: 'a11y-color-contrast',
+
+  // Security
+  SECURITY_XSS: 'security-xss',
+
+  // Generic Opportunity
+  GENERIC_OPPORTUNITY: 'generic-opportunity',
+
+  // Paid Cookie Consent
+  PAID_COOKIE_CONSENT: 'paid-cookie-consent',
+};
+
+export {
+  OPPORTUNITY_TYPES,
+};

package/src/index.d.ts

@@ -272,6 +272,28 @@ export function isoCalendarWeekSunday(date: Date): Date;
 
 export function isoCalendarWeekMonday(date: Date): Date;
 
+/**
+ * Extracts URLs from a suggestion based on the opportunity type.
+ * @param opts - Options object
+ * @param opts.opportunity - The opportunity object
+ * @param opts.suggestion - The suggestion object
+ * @returns An array of extracted URLs
+ */
+export function extractUrlsFromSuggestion(opts: {
+  opportunity: any;
+  suggestion: any;
+}): string[];
+
+/**
+ * Extracts URLs from an opportunity based on the opportunity type.
+ * @param opts - Options object
+ * @param opts.opportunity - The opportunity object
+ * @returns An array of extracted URLs
+ */
+export function extractUrlsFromOpportunity(opts: {
+  opportunity: any;
+}): string[];
+
 export * as llmoConfig from './llmo-config.js';
 export * as schemas from './schemas.js';
 

package/src/index.js

@@ -68,6 +68,11 @@ export {
   urlMatchesFilter,
 } from './url-helpers.js';
 
+export {
+  extractUrlsFromOpportunity,
+  extractUrlsFromSuggestion,
+} from './url-extractors.js';
+
 export { getStoredMetrics, storeMetrics } from './metrics-store.js';
 
 export { s3Wrapper } from './s3.js';

package/src/url-extractors.js

@@ -0,0 +1,183 @@
+/*
+ * Copyright 2025 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 { OPPORTUNITY_TYPES } from './constants.js';
+
+/**
+ * Function to extract the URL from a suggestion based on a particular type
+ * @param {*} suggestion
+ */
+function extractUrlsFromSuggestion(opts) {
+  const {
+    opportunity,
+    suggestion,
+  } = opts;
+
+  const urls = [];
+
+  try {
+    const opportunityType = opportunity.getType();
+    const data = suggestion.getData ? suggestion.getData() : suggestion.data;
+
+    switch (opportunityType) {
+      case OPPORTUNITY_TYPES.ALT_TEXT:
+        {
+          const recommendations = data?.recommendations;
+          if (Array.isArray(recommendations)) {
+            recommendations.forEach((rec) => {
+              if (rec.pageUrl && typeof rec.pageUrl === 'string') {
+                urls.push(rec.pageUrl);
+              }
+            });
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.ACCESSIBILITY:
+      case OPPORTUNITY_TYPES.COLOR_CONTRAST:
+      case OPPORTUNITY_TYPES.STRUCTURED_DATA:
+      case OPPORTUNITY_TYPES.CANONICAL:
+      case OPPORTUNITY_TYPES.HREFLANG:
+      case OPPORTUNITY_TYPES.HEADINGS:
+      case OPPORTUNITY_TYPES.INVALID_OR_MISSING_METADATA:
+      case OPPORTUNITY_TYPES.SITEMAP_PRODUCT_COVERAGE:
+        {
+          const url = data?.url;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.CWV:
+        {
+          const { type } = data;
+          const url = data?.url;
+          if (type === 'url' && url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.REDIRECT_CHAINS:
+        {
+          const sourceUrl = data?.sourceUrl;
+          if (sourceUrl && typeof sourceUrl === 'string') {
+            urls.push(sourceUrl);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.SECURITY_XSS:
+        {
+          const url = data?.link;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.SECURITY_CSP:
+        {
+          const findings = data?.findings;
+          if (Array.isArray(findings)) {
+            findings.forEach((finding) => {
+              if (finding.url && typeof finding.url === 'string') {
+                urls.push(finding.url);
+              }
+            });
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.SECURITY_PERMISSIONS:
+        {
+          const url = data?.path;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.BROKEN_BACKLINKS:
+      case OPPORTUNITY_TYPES.BROKEN_INTERNAL_LINKS:
+        {
+          const url = data?.url_to;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.SITEMAP:
+        {
+          const url = data?.pageUrl;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      default:
+        break;
+    }
+  } catch (error) {
+    // Silently handle errors and return empty array
+  }
+  return urls;
+}
+
+/**
+ * Function to extract the URL from an opportunity based on a particular type
+ * @param {*} opportunity
+ */
+function extractUrlsFromOpportunity(opts) {
+  const {
+    opportunity,
+  } = opts;
+  const urls = [];
+
+  try {
+    const opportunityType = opportunity.getType();
+    const data = opportunity.getData ? opportunity.getData() : opportunity.data;
+
+    switch (opportunityType) {
+      case OPPORTUNITY_TYPES.HIGH_ORGANIC_LOW_CTR:
+        {
+          const url = data?.page;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.HIGH_FORM_VIEWS_LOW_CONVERSIONS:
+      case OPPORTUNITY_TYPES.HIGH_PAGE_VIEWS_LOW_FORM_NAV:
+      case OPPORTUNITY_TYPES.HIGH_PAGE_VIEWS_LOW_FORM_VIEWS:
+        {
+          const url = data?.form;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      case OPPORTUNITY_TYPES.FORM_ACCESSIBILITY:
+        {
+          const url = data?.url;
+          if (url && typeof url === 'string') {
+            urls.push(url);
+          }
+        }
+        break;
+      default:
+        break;
+    }
+  } catch (error) {
+    // Silently handle errors and return empty array
+  }
+  return urls;
+}
+
+export {
+  extractUrlsFromSuggestion,
+  extractUrlsFromOpportunity,
+};