@adobe/spacecat-shared-data-access 2.14.1 → 2.15.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [@adobe/spacecat-shared-data-access-v2.15.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.14.1...@adobe/spacecat-shared-data-access-v2.15.0) (2025-04-17)
+
+
+### Bug Fixes
+
+* completionUrl not sent to content scraper and introduce skip property ([#685](https://github.com/adobe/spacecat-shared/issues/685)) ([4d89a29](https://github.com/adobe/spacecat-shared/commit/4d89a297495fa69ebbcc0429ed879b2edafbd760))
+
+
+### Features
+
+* Add contentAiConfig validation to Config class ([#686](https://github.com/adobe/spacecat-shared/issues/686)) ([077fbbd](https://github.com/adobe/spacecat-shared/commit/077fbbd583f5567c265fe47e724ea5ce9f1a722d))
+
 # [@adobe/spacecat-shared-data-access-v2.14.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.14.0...@adobe/spacecat-shared-data-access-v2.14.1) (2025-04-15)
 
 

package/README.md

@@ -184,6 +184,28 @@ export const main = wrap(run)
 
 Contributions to `spacecat-shared-data-access` are welcome. Please adhere to the standard Git workflow and submit pull requests for proposed changes.
 
+## Local Development and Testing
+
+### Testing with Dependent Projects Before Merging
+
+When making changes to this package, you can test them in dependent projects (like `spacecat-api-service`) before merging using the following approach:
+
+1. Commit and push your changes to a branch in this repository
+2. Get the commit ID of your push
+3. In your dependent project, temporarily modify the package.json dependency:
+
+   ```json
+   // From:
+   "@adobe/spacecat-shared-data-access": "2.13.1",
+   
+   // To:
+   "@adobe/spacecat-shared-data-access": "https://gitpkg.now.sh/adobe/spacecat-shared/packages/spacecat-shared-data-access?YOUR_COMMIT_ID",
+   ```
+
+4. Run `npm install` in your dependent project
+5. Test your changes
+6. Once testing is complete and your PR is merged, update the dependent project to use the released version
+
 ## License
 
 Licensed under the Apache-2.0 License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "2.14.1",
+  "version": "2.15.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/audit/audit.model.js

@@ -104,6 +104,7 @@ class Audit extends BaseModel {
       formatPayload: (stepResult, auditContext) => ({
         type: stepResult.type,
         siteId: stepResult.siteId,
+        allowCache: true,
         auditContext,
       }),
     },
@@ -117,6 +118,7 @@ class Audit extends BaseModel {
        * @param {string} stepResult.siteId - The site ID. Will be used as the job ID.
        * @param {string} stepResult.processingType - The scraping processing type to trigger.
        * @param {object} auditContext - The audit context.
+       * @param {object} context - The context object.
        * @param {object} auditContext.next - The next audit step to run.
        * @param {string} auditContext.auditId - The audit ID.
        * @param {string} auditContext.auditType - The audit type.
@@ -124,10 +126,13 @@ class Audit extends BaseModel {
        *
        * @returns {object} - The formatted payload.
        */
-      formatPayload: (stepResult, auditContext) => ({
+      formatPayload: (stepResult, auditContext, context) => ({
         urls: stepResult.urls,
         jobId: stepResult.siteId,
         processingType: stepResult.processingType || 'default',
+        skipMessage: false,
+        allowCache: true,
+        completionQueueUrl: stepResult.completionQueueUrl || context.env?.AUDIT_RESULTS_QUEUE_URL,
         auditContext,
       }),
     },

package/src/models/site/config.js

@@ -107,6 +107,9 @@ export const configSchema = Joi.object({
     headers: Joi.object().pattern(Joi.string(), Joi.string()),
     overrideBaseURL: Joi.string().uri().optional(),
   }).optional(),
+  contentAiConfig: Joi.object({
+    index: Joi.string().required(),
+  }).optional(),
   handlers: Joi.object().pattern(Joi.string(), Joi.object({
     mentions: Joi.object().pattern(Joi.string(), Joi.array().items(Joi.string())),
     excludedURLs: Joi.array().items(Joi.string()),
@@ -136,6 +139,7 @@ export const configSchema = Joi.object({
 export const DEFAULT_CONFIG = {
   slack: {},
   handlers: {},
+  contentAiConfig: {},
 };
 
 // Function to validate incoming configuration
@@ -158,6 +162,7 @@ export const Config = (data = {}) => {
   self.isInternalCustomer = () => state?.slack?.workspace === 'internal';
   self.getSlackMentions = (type) => state?.handlers?.[type]?.mentions?.slack;
   self.getHandlerConfig = (type) => state?.handlers?.[type];
+  self.getContentAiConfig = () => state?.contentAiConfig;
   self.getHandlers = () => state.handlers;
   self.getImports = () => state.imports;
   self.getExcludedURLs = (type) => state?.handlers?.[type]?.excludedURLs;
@@ -277,6 +282,7 @@ Config.fromDynamoItem = (dynamoItem) => Config(dynamoItem);
 Config.toDynamoItem = (config) => ({
   slack: config.getSlackConfig(),
   handlers: config.getHandlers(),
+  contentAiConfig: config.getContentAiConfig(),
   imports: config.getImports(),
   fetchConfig: config.getFetchConfig(),
   brandConfig: config.getBrandConfig(),