@adobe/spacecat-shared-utils 1.37.4 → 1.38.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.38.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.37.4...@adobe/spacecat-shared-utils-v1.38.0) (2025-05-14)
+
+
+### Features
+
+* add page authentication token retrieval functionality ([#738](https://github.com/adobe/spacecat-shared/issues/738)) ([f38fe55](https://github.com/adobe/spacecat-shared/commit/f38fe55a02aa4cc3c1c3427d938cf711f3862e01))
+
 # [@adobe/spacecat-shared-utils-v1.37.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.37.3...@adobe/spacecat-shared-utils-v1.37.4) (2025-05-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.37.4",
+  "version": "1.38.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {
@@ -47,6 +47,7 @@
   "dependencies": {
     "@adobe/fetch": "4.2.1",
     "@aws-sdk/client-s3": "3.806.0",
+    "@aws-sdk/client-secrets-manager": "3.806.0",
     "@aws-sdk/client-sqs": "3.806.0",
     "@json2csv/plainjs": "7.0.6",
     "aws-xray-sdk": "3.10.3",

package/src/auth.js

@@ -0,0 +1,49 @@
+/*
+ * 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 { isString } from './functions.js';
+import { resolveCustomerSecretsName } from './helpers.js';
+
+/**
+ * @import {type Site} from "@adobe/spacecat-shared-data-access/src/models/site/index.js"
+ */
+
+/**
+ * Retrieves the page authentication token for a given site.
+ *
+ * @param {Site} site - The site to retrieve authentication for
+ * @param {object} context - The context object
+ * @returns {Promise<string>} - The authentication token needed to access the page
+ * @throws {Error} - If secret is not found or token is missing
+ */
+export async function retrievePageAuthentication(site, context) {
+  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;
+}

package/src/index.d.ts

@@ -245,3 +245,5 @@ export function fetch(url: string | Request, options?: RequestOptions): Promise<
 export function tracingFetch(url: string | Request, options?: RequestOptions): Promise<Response>;
 
 export const SPACECAT_USER_AGENT: string;
+
+export function retrievePageAuthentication(site: object, context: object): Promise<string>;

package/src/index.js

@@ -73,3 +73,5 @@ export {
   getHighPageViewsLowFormCtrMetrics,
   FORMS_AUDIT_INTERVAL,
 } from './formcalc.js';
+
+export { retrievePageAuthentication } from './auth.js';