@adobe/spacecat-shared-utils 1.66.0 → 1.67.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.67.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.66.1...@adobe/spacecat-shared-utils-v1.67.0) (2025-10-29)
+
+
+### Features
+
+* added a11y-assistive type to extractor ([#1067](https://github.com/adobe/spacecat-shared/issues/1067)) ([79d0326](https://github.com/adobe/spacecat-shared/commit/79d0326fef06341d6243f3979659ccc904f59d14))
+
+# [@adobe/spacecat-shared-utils-v1.66.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.66.0...@adobe/spacecat-shared-utils-v1.66.1) (2025-10-28)
+
+
+### Bug Fixes
+
+* remove cyclic deps in shared ([#1053](https://github.com/adobe/spacecat-shared/issues/1053)) ([acbbc93](https://github.com/adobe/spacecat-shared/commit/acbbc93f8c961fdef55edb5e7947958456538586))
+
 # [@adobe/spacecat-shared-utils-v1.66.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.65.0...@adobe/spacecat-shared-utils-v1.66.0) (2025-10-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.66.0",
+  "version": "1.67.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "exports": {
@@ -53,9 +53,7 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.2.3",
-    "@adobe/spacecat-shared-ims-client": "1.8.3",
     "@aws-sdk/client-s3": "3.917.0",
-    "@aws-sdk/client-secrets-manager": "3.917.0",
     "@aws-sdk/client-sqs": "3.917.0",
     "@json2csv/plainjs": "7.0.6",
     "aws-xray-sdk": "3.11.0",

package/src/index.d.ts

@@ -13,6 +13,8 @@
 import { Request, RequestOptions, Response } from '@adobe/fetch';
 import type { ISOCalendarWeek } from './calendar-week-helper.js';
 
+export { AUTHORING_TYPES, DELIVERY_TYPES } from './aem.js';
+
 /** UTILITY FUNCTIONS */
 export function arrayEquals<T>(a: T[], b: T[]): boolean;
 
@@ -67,42 +69,42 @@ export function sqsEventAdapter(fn: (message: object, context: object) => Promis
  * @param url - The URL to modify.
  * @returns The URL with 'https://' schema prepended.
  */
-declare function prependSchema(url: string): string;
+export declare function prependSchema(url: string): string;
 
 /**
  * Strips the port number from the end of the URL.
  * @param url - The URL to modify.
  * @returns The URL with the port removed.
  */
-declare function stripPort(url: string): string;
+export declare function stripPort(url: string): string;
 
 /**
  * Strips the trailing dot from the end of the URL.
  * @param url - The URL to modify.
  * @returns The URL with the trailing dot removed.
  */
-declare function stripTrailingDot(url: string): string;
+export declare function stripTrailingDot(url: string): string;
 
 /**
  * Strips the trailing slash from the end of the URL.
  * @param url - The URL to modify.
  * @returns The URL with the trailing slash removed.
  */
-declare function stripTrailingSlash(url: string): string;
+export declare function stripTrailingSlash(url: string): string;
 
 /**
  * Strips 'www.' from the beginning of the URL if present.
  * @param url - The URL to modify.
  * @returns The URL with 'www.' removed.
  */
-declare function stripWWW(url: string): string;
+export declare function stripWWW(url: string): string;
 
 /**
  * Composes a base URL by applying a series of transformations to the given domain.
  * @param domain - The domain to compose the base URL from.
  * @returns The composed base URL.
  */
-declare function composeBaseURL(domain: string): string;
+export declare function composeBaseURL(domain: string): string;
 
 /**
  * Composes an audit URL by applying a series of transformations to the given url.
@@ -110,7 +112,7 @@ declare function composeBaseURL(domain: string): string;
  * @param {string} [userAgent] - Optional user agent to use in the audit URL.
  * @returns a promise that resolves the composed audit URL.
  */
-declare function composeAuditURL(url: string, userAgent?: string): Promise<string>;
+export declare function composeAuditURL(url: string, userAgent?: string): Promise<string>;
 
 /**
  * Resolves the name of the secret based on the function version.
@@ -119,7 +121,7 @@ declare function composeAuditURL(url: string, userAgent?: string): Promise<strin
  * @param {string} defaultPath - The default path for the secret.
  * @returns {string} - The resolved secret name.
  */
-declare function resolveSecretsName(opts: object, ctx: object, defaultPath: string): string;
+export declare function resolveSecretsName(opts: object, ctx: object, defaultPath: string): string;
 
 /**
  * Resolves the name of the customer secrets based on the baseURL.
@@ -127,7 +129,7 @@ declare function resolveSecretsName(opts: object, ctx: object, defaultPath: stri
  * @param {Object} ctx - The context object containing the function version.
  * @returns {string} - The resolved secret name.
  */
-declare function resolveCustomerSecretsName(baseURL: string, ctx: object): string;
+export declare function resolveCustomerSecretsName(baseURL: string, ctx: object): string;
 
 /**
  * Retrieves the RUM domain key for the specified base URL from the customer secrets.
@@ -137,7 +139,7 @@ declare function resolveCustomerSecretsName(baseURL: string, ctx: object): strin
  * @returns {Promise<string>} - A promise that resolves to the RUM domain key.
  * @throws {Error} Throws an error if no domain key is found for the specified base URL.
  */
-declare function getRUMDomainKey(baseURL: string, ctx: object): Promise<string>;
+export declare function getRUMDomainKey(baseURL: string, ctx: object): Promise<string>;
 
 /**
  * Generates a CSV file from the provided JSON data.
@@ -149,7 +151,7 @@ declare function getRUMDomainKey(baseURL: string, ctx: object): Promise<string>;
  * @param {Object[]} data - An array of JSON objects to be converted into CSV format.
  * @returns {Buffer} A Buffer containing the CSV formatted data, encoded in UTF-8.
  */
-declare function generateCSVFile(data: object[]): Buffer;
+export declare function generateCSVFile(data: object[]): Buffer;
 
 /**
  * Replaces placeholders in the prompt content with their corresponding values.
@@ -158,7 +160,7 @@ declare function generateCSVFile(data: object[]): Buffer;
  * @param {Object} placeholders - The placeholders and their values.
  * @returns {string} - The content with placeholders replaced.
  */
-declare function replacePlaceholders(content: string, placeholders: object): string;
+export declare function replacePlaceholders(content: string, placeholders: object): string;
 
 /**
  * Function to support reading static file
@@ -168,7 +170,7 @@ declare function replacePlaceholders(content: string, placeholders: object): str
  * @param {String} filename - The path of the prompt file.
  * @returns {Promise<string|null>} - A promise that resolves to a string with the prompt content.
  */
-declare function getStaticContent(placeholders: object, filename: string):
+export declare function getStaticContent(placeholders: object, filename: string):
   Promise<string | null>;
 
 /**
@@ -181,7 +183,7 @@ declare function getStaticContent(placeholders: object, filename: string):
  * @returns {Promise<string|null>} - A promise that resolves to a string with the prompt content,
  * or null if an error occurs.
  */
-declare function getPrompt(placeholders: object, filename: string, log: object):
+export declare function getPrompt(placeholders: object, filename: string, log: object):
   Promise<string | null>;
 
 /**
@@ -194,7 +196,7 @@ declare function getPrompt(placeholders: object, filename: string, log: object):
  * @returns {Promise<string|null>} - A promise that resolves to a string with the query content,
  * or null if an error occurs.
  */
-declare function getQuery(placeholders: object, filename: string, log: object):
+export declare function getQuery(placeholders: object, filename: string, log: object):
   Promise<string | null>;
 
 /**
@@ -202,7 +204,7 @@ declare function getQuery(placeholders: object, filename: string, log: object):
  * @param {Object[]} formVitals - An array of form vitals.
  * @returns {Object[]} - An array of high-form-view-low-form-conversion metrics.
  */
-declare function getHighFormViewsLowConversionMetrics(formVitals: object[]):
+export declare function getHighFormViewsLowConversionMetrics(formVitals: object[]):
   object[];
 
 /**
@@ -210,7 +212,7 @@ declare function getHighFormViewsLowConversionMetrics(formVitals: object[]):
  * @param {Object[]} formVitals - An array of form vitals.
  * @returns {Object[]} - An array of high-page-view-low-form-view metrics.
  */
-declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[]):
+export declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[]):
   object[];
 
 /**
@@ -218,7 +220,7 @@ declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[]):
  * @param {Object[]} formVitals - An array of form vitals.
  * @returns {Object[]} - An array of high-page-view-low-form-ctr metrics.
  */
-declare function getHighPageViewsLowFormCtrMetrics(formVitals: object[]):
+export declare function getHighPageViewsLowFormCtrMetrics(formVitals: object[]):
   object[];
 
 /**
@@ -262,8 +264,6 @@ export function tracingFetch(url: string | Request, options?: RequestOptions): P
 
 export const SPACECAT_USER_AGENT: string;
 
-export function retrievePageAuthentication(site: object, context: object): Promise<string>;
-
 export function prettifyLogForwardingConfig(payload: object): object;
 
 export function isoCalendarWeek(date: Date): ISOCalendarWeek;

package/src/index.js

@@ -86,8 +86,6 @@ export {
   FORMS_AUDIT_INTERVAL,
 } from './formcalc.js';
 
-export { retrievePageAuthentication, getAccessToken } from './auth.js';
-
 export {
   getDateRanges,
   getLastNumberOfWeeks,

package/src/url-extractors.js

@@ -41,6 +41,7 @@ function extractUrlsFromSuggestion(opts) {
           }
         }
         break;
+      case OPPORTUNITY_TYPES.A11Y_ASSISTIVE:
       case OPPORTUNITY_TYPES.ACCESSIBILITY:
       case OPPORTUNITY_TYPES.COLOR_CONTRAST:
       case OPPORTUNITY_TYPES.STRUCTURED_DATA:

package/src/auth.js

@@ -1,80 +0,0 @@
-/*
- * 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 AWSXray from 'aws-xray-sdk';
-import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
-import { ImsPromiseClient } from '@adobe/spacecat-shared-ims-client';
-import { isString } from './functions.js';
-import { resolveCustomerSecretsName } from './helpers.js';
-import { AUTHORING_TYPES, DELIVERY_TYPES } from './aem.js';
-
-/**
- * @import {type Site} from "@adobe/spacecat-shared-data-access/src/models/site/index.js"
- */
-
-/**
- * Get an access token by exchanging a promise token using IMS Promise Client.
- * @param {object} context - The context object containing environment variables.
- * @param {string} promiseToken - The promise token to exchange for an access token.
- * @return {Promise<object>} - A promise that resolves to the access token response.
- */
-export async function getAccessToken(context, promiseToken) {
-  const imsClient = ImsPromiseClient.createFrom(
-    context,
-    ImsPromiseClient.CLIENT_TYPE.CONSUMER,
-  );
-
-  const token = await imsClient.exchangeToken(
-    promiseToken,
-    !!context.env?.AUTOFIX_CRYPT_SECRET && !!context.env?.AUTOFIX_CRYPT_SALT,
-  );
-
-  return token.access_token;
-}
-
-/**
- * Retrieves the page authentication token for a given site.
- *
- * @param {Site} site - The site to retrieve authentication for
- * @param {object} context - The context object
- * @param {object} authOptions - The authentication options
- * @returns {Promise<string>} - The authentication token or access token
- * @throws {Error} - If secret is not found or token is missing
- */
-export async function retrievePageAuthentication(site, context, authOptions = {}) {
-  const CS_TYPES = [AUTHORING_TYPES.CS, AUTHORING_TYPES.CS_CW];
-  if (site
-    && (CS_TYPES.includes(site.getAuthoringType())
-      || site.getDeliveryType() === DELIVERY_TYPES.AEM_CS)
-    && authOptions.promiseToken) {
-    return getAccessToken(context, authOptions.promiseToken.promise_token);
-  }
-
-  const baseURL = site.getBaseURL();
-  const customerSecret = resolveCustomerSecretsName(baseURL, context);
-  const secretsManagerClient = new SecretsManagerClient({});
-  const secretsClient = AWSXray.captureAWSv3Client(secretsManagerClient);
-  const command = new GetSecretValueCommand({ SecretId: customerSecret });
-
-  const response = await secretsClient.send(command);
-  if (!response.SecretString) {
-    throw new Error(`No secret string found for ${customerSecret}`);
-  }
-
-  const secrets = JSON.parse(response.SecretString);
-
-  if (!isString(secrets.PAGE_AUTH_TOKEN)) {
-    throw new Error(`Missing 'PAGE_AUTH_TOKEN' in secrets for ${customerSecret}`);
-  }
-
-  return secrets.PAGE_AUTH_TOKEN;
-}