@adobe/spacecat-shared-data-access 2.42.0 → 2.43.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.43.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.43.0...@adobe/spacecat-shared-data-access-v2.43.1) (2025-08-04)
+
+
+### Bug Fixes
+
+* mark formSource optional in SiteTopForm model ([#884](https://github.com/adobe/spacecat-shared/issues/884)) ([7ea285b](https://github.com/adobe/spacecat-shared/commit/7ea285b59809e4983ec6337b9544be57ed62148e))
+
+# [@adobe/spacecat-shared-data-access-v2.43.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.42.0...@adobe/spacecat-shared-data-access-v2.43.0) (2025-07-30)
+
+
+### Features
+
+* Add `'never'` to job intervals ([#885](https://github.com/adobe/spacecat-shared/issues/885)) ([#886](https://github.com/adobe/spacecat-shared/issues/886)) ([07a92ce](https://github.com/adobe/spacecat-shared/commit/07a92ce2659e27a85058d1d40942ec7e8b8897e3))
+
 # [@adobe/spacecat-shared-data-access-v2.42.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.41.0...@adobe/spacecat-shared-data-access-v2.42.0) (2025-07-29)
 
 

package/package.json

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

package/src/models/configuration/configuration.model.js

@@ -31,6 +31,7 @@ class Configuration extends BaseModel {
   };
 
   static JOB_INTERVALS = {
+    NEVER: 'never', // allows to enable imports without scheduling them.
     EVERY_HOUR: 'every-hour',
     DAILY: 'daily',
     WEEKLY: 'weekly',

package/src/models/site-top-form/site-top-form.collection.js

@@ -22,6 +22,49 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class SiteTopFormCollection extends BaseCollection {
+  /**
+   * Override create method to validate URL presence and handle optional formSource
+   * @param {Object} item - The data for the entity to be created
+   * @param {Object} [options] - Additional options for the creation process
+   * @returns {Promise<BaseModel>} - A promise that resolves to the created model instance
+   * @throws {Error} - Throws an error if URL is not present
+   */
+  async create(item, options = {}) {
+    if (!hasText(item?.url)) {
+      throw new Error('URL is required and cannot be empty');
+    }
+
+    // If formSource is not provided or empty, set it as empty string (default value)
+    const processedItem = {
+      ...item,
+      formSource: hasText(item.formSource) ? item.formSource : '',
+    };
+
+    return super.create(processedItem, options);
+  }
+
+  /**
+   * Override createMany method to validate URLs and handle optional formSource
+   * @param {Array<Object>} newItems - An array of data for the entities to be created
+   * @param {BaseModel} [parent] - Optional parent entity
+   * @returns {Promise<Object>} - A promise that resolves to created and error items
+   */
+  async createMany(newItems, parent = null) {
+    // Validate and process items
+    const processedItems = newItems.map((item) => {
+      if (!hasText(item?.url)) {
+        throw new Error('URL is required and cannot be empty for all items');
+      }
+
+      return {
+        ...item,
+        formSource: hasText(item.formSource) ? item.formSource : '',
+      };
+    });
+
+    return super.createMany(processedItems, parent);
+  }
+
   async removeForSiteId(siteId, source) {
     if (!hasText(siteId)) {
       throw new Error('SiteId is required');
@@ -42,20 +85,81 @@ class SiteTopFormCollection extends BaseCollection {
     }
   }
 
-  async removeByUrlAndFormSource(url, formSource) {
+  /**
+   * Remove forms by URL and optional formSource
+   * @param {string} url - The URL to match
+   * @param {string} [formSource] - The formSource to match (optional, defaults to empty string)
+   * @returns {Promise<void>}
+   */
+  async removeByUrlAndFormSource(url, formSource = '') {
     if (!hasText(url)) {
       throw new Error('URL is required');
     }
-    if (!hasText(formSource)) {
-      throw new Error('FormSource is required');
-    }
 
-    const formToRemove = await this.findByUrlAndFormSource(url, formSource);
+    // Handle both cases: when formSource is provided and when it's not
+    let formToRemove;
+
+    if (hasText(formSource)) {
+      formToRemove = await this.findByUrlAndFormSource(url, formSource);
+    } else {
+      // Find forms by URL where formSource is empty string (default)
+      formToRemove = await this.findByUrlAndFormSource(url, '');
+    }
 
     if (formToRemove) {
       await this.removeByIds([formToRemove.getId()]);
     }
   }
+
+  /**
+   * Find forms by URL, handling optional formSource
+   * @param {string} url - The URL to search for
+   * @param {string} [formSource] - The formSource to search for
+   *    (optional, defaults to empty string)
+   * @returns {Promise<BaseModel|null>} - The found form or null
+   */
+  async findByUrlAndFormSource(url, formSource = '') {
+    if (!hasText(url)) {
+      throw new Error('URL is required');
+    }
+
+    try {
+      const searchFormSource = hasText(formSource) ? formSource : '';
+
+      // First try to find with the provided formSource
+      let indexKeys = {
+        url,
+        formSource: searchFormSource,
+      };
+
+      let result = await this.findByIndexKeys(indexKeys, {
+        index: 'spacecat-data-gsi2pk-gsi2sk',
+      });
+
+      // If not found and searching for empty string, also try with null
+      // This handles legacy data that might have null formSource
+      if (!result && searchFormSource === '') {
+        try {
+          indexKeys = {
+            url,
+            formSource: null,
+          };
+
+          result = await this.findByIndexKeys(indexKeys, {
+            index: 'spacecat-data-gsi2pk-gsi2sk',
+          });
+        } catch (legacyError) {
+          // If the null search also fails, ignore and return the original null result
+          this.log.debug(`Legacy null formSource search failed: ${legacyError.message}`);
+        }
+      }
+
+      return result;
+    } catch (error) {
+      this.log.error(`Failed to find form by URL and formSource: ${error.message}`);
+      return null;
+    }
+  }
 }
 
 export default SiteTopFormCollection;

package/src/models/site-top-form/site-top-form.schema.js

@@ -40,7 +40,8 @@ const schema = new SchemaBuilder(SiteTopForm, SiteTopFormCollection)
   })
   .addAttribute('formSource', {
     type: 'string',
-    required: true,
+    required: false,
+    default: '',
   })
   .addAttribute('traffic', {
     type: 'number',