@adobe/spacecat-shared-utils 1.14.5 → 1.15.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [@adobe/spacecat-shared-utils-v1.15.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.14.6...@adobe/spacecat-shared-utils-v1.15.0) (2024-05-14)
+
+
+### Bug Fixes
+
+* convert spacecat-data-access to a regular dependency for utils ([486933c](https://github.com/adobe/spacecat-shared/commit/486933c6a8aeeb3fc5249ad21d92cb8bfedad059))
+* **deps:** update external fixes ([#221](https://github.com/adobe/spacecat-shared/issues/221)) ([13e72c3](https://github.com/adobe/spacecat-shared/commit/13e72c36433dd62058275475acb46a03bd307f91))
+* **deps:** update external fixes ([#225](https://github.com/adobe/spacecat-shared/issues/225)) ([ffb3e3d](https://github.com/adobe/spacecat-shared/commit/ffb3e3d216dd05bafaa7ab26f83ae1c3f0c4d391))
+* **deps:** update external fixes ([#228](https://github.com/adobe/spacecat-shared/issues/228)) ([ef2ab41](https://github.com/adobe/spacecat-shared/commit/ef2ab41a9175ec5ba8ec7e2830898e9db01fb2b6))
+
+
+### Features
+
+* resolve customer secret names ([#229](https://github.com/adobe/spacecat-shared/issues/229)) ([cbf6e1d](https://github.com/adobe/spacecat-shared/commit/cbf6e1db1a2f938a8287b27dd8bde509c1282088))
+
+# [@adobe/spacecat-shared-utils-v1.14.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.14.5...@adobe/spacecat-shared-utils-v1.14.6) (2024-04-25)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#215](https://github.com/adobe/spacecat-shared/issues/215)) ([4227263](https://github.com/adobe/spacecat-shared/commit/4227263b6bc917982d361cd621c7001c4ee1fa56))
+
 # [@adobe/spacecat-shared-utils-v1.14.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.14.4...@adobe/spacecat-shared-utils-v1.14.5) (2024-04-16)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.14.5",
+  "version": "1.15.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",
@@ -30,21 +30,19 @@
     "access": "public"
   },
   "devDependencies": {
-    "@adobe/helix-shared-wrap": "2.0.1",
+    "@adobe/helix-shared-wrap": "2.0.2",
     "chai": "4.4.1",
-    "chai-as-promised": "7.1.1",
+    "chai-as-promised": "7.1.2",
     "husky": "9.0.11",
     "nock": "13.5.4",
-    "sinon": "17.0.1",
+    "sinon": "17.0.2",
     "sinon-chai": "3.7.0"
   },
   "dependencies": {
     "@adobe/fetch": "4.1.2",
-    "@aws-sdk/client-s3": "3.554.0",
-    "@aws-sdk/client-sqs": "3.554.0",
+    "@adobe/spacecat-shared-data-access": "^1.2",
+    "@aws-sdk/client-s3": "3.574.0",
+    "@aws-sdk/client-sqs": "3.574.0",
     "@json2csv/plainjs": "7.0.6"
-  },
-  "peerDependencies": {
-    "@adobe/spacecat-shared-data-access": "1.x"
   }
 }

package/src/helpers.js

@@ -36,6 +36,23 @@ export function resolveSecretsName(opts, ctx, defaultPath) {
   return `${defaultPath}/${funcVersion}`;
 }
 
+/**
+ * Resolves the name of the customer secrets based on the baseURL.
+ * @param {string} baseURL - The base URL to resolve the customer secrets name from.
+ * @param {Object} ctx - The context object containing the function version.
+ * @returns {string} - The resolved secret name.
+ */
+export function resolveCustomerSecretsName(baseURL, ctx) {
+  const basePath = '/helix-deploy/spacecat-services/customer-secrets';
+  let customer;
+  try {
+    customer = new URL(baseURL).host.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase();
+  } catch (e) {
+    throw new Error('Invalid baseURL: must be a valid URL');
+  }
+  return resolveSecretsName({}, ctx, `${basePath}/${customer}`);
+}
+
 export function isAuditsDisabled(site, organization, auditType) {
   // return early if all audits are disabled for the organization
   if (organization.getAuditConfig().auditsDisabled()) {
@@ -58,15 +75,15 @@ export function isAuditsDisabled(site, organization, auditType) {
 }
 
 /**
-* Generates a CSV file from the provided JSON data.
-*
-* Each key-value pair in the JSON objects
-* corresponds to a column and its value in the CSV. The output is a UTF-8
-* encoded Buffer that represents the CSV file content.
-*
-* @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.
-*/
+ * Generates a CSV file from the provided JSON data.
+ *
+ * Each key-value pair in the JSON objects
+ * corresponds to a column and its value in the CSV. The output is a UTF-8
+ * encoded Buffer that represents the CSV file content.
+ *
+ * @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.
+ */
 export function generateCSVFile(data) {
   const json2csvParser = new Parser();
   return Buffer.from(json2csvParser.parse(data), 'utf-8');

package/src/index.d.ts

@@ -38,10 +38,10 @@ export function isValidUrl(urlString: string): boolean;
 export function dateAfterDays(days: number, dateString: string): Date;
 
 export function sqsWrapper(fn: (message: object, context: object) => Promise<Response>):
-    (request: object, context: object) => Promise<Response>;
+  (request: object, context: object) => Promise<Response>;
 
 export function sqsEventAdapter(fn: (message: object, context: object) => Promise<Response>):
-    (request: object, context: object) => Promise<Response>;
+  (request: object, context: object) => Promise<Response>;
 
 /**
  * Prepends 'https://' schema to the URL if it's not already present.
@@ -109,6 +109,23 @@ declare function composeAuditURL(url: string): Promise<string>;
  */
 declare function isAuditsDisabled(site: object, organization: object, auditType?: string): boolean
 
+/**
+ * Resolves the name of the secret based on the function version.
+ * @param {Object} opts - The options object, not used in this implementation.
+ * @param {Object} ctx - The context object containing the function version.
+ * @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;
+
+/**
+ * Resolves the name of the customer secrets based on the baseURL.
+ * @param {string} baseURL - The base URL to resolve the customer secrets name from.
+ * @param {Object} ctx - The context object containing the function version.
+ * @returns {string} - The resolved secret name.
+ */
+declare function resolveCustomerSecretsName(baseURL: string, ctx: object): string;
+
 /**
  * Generates a CSV file from the provided JSON data.
  *

package/src/index.js

@@ -30,6 +30,7 @@ export {
 export {
   isAuditsDisabled,
   resolveSecretsName,
+  resolveCustomerSecretsName,
   generateCSVFile,
 } from './helpers.js';