@adobe/spacecat-shared-data-access 1.45.0 → 1.45.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.45.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.45.1...@adobe/spacecat-shared-data-access-v1.45.2) (2024-09-25)
+
+
+### Bug Fixes
+
+* Add a unit test for imports.write_all_domains scope ([#384](https://github.com/adobe/spacecat-shared/issues/384)) ([800ec89](https://github.com/adobe/spacecat-shared/commit/800ec89532cc83f32290ced2b91f1af4fcccb44a))
+
+# [@adobe/spacecat-shared-data-access-v1.45.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.45.0...@adobe/spacecat-shared-data-access-v1.45.1) (2024-09-24)
+
+
+### Bug Fixes
+
+* SITES-25634 [Importer] Expose hasCustomImportJs and hasCustomHeaders as two new fields on a import job ([#381](https://github.com/adobe/spacecat-shared/issues/381)) ([b90a7c5](https://github.com/adobe/spacecat-shared/commit/b90a7c5623af90924a2122dbc10077f989a8550b))
+
 # [@adobe/spacecat-shared-data-access-v1.45.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.44.5...@adobe/spacecat-shared-data-access-v1.45.0) (2024-09-24)
 
 

package/package.json

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

package/src/dto/import-job.js

@@ -40,6 +40,8 @@ export const ImportJobDto = {
     redirectCount: importJob.getRedirectCount(),
     importQueueId: importJob.getImportQueueId(),
     initiatedBy: importJob.getInitiatedBy(),
+    hasCustomHeaders: importJob.hasCustomHeaders(),
+    hasCustomImportJs: importJob.hasCustomImportJs(),
     GSI1PK: 'ALL_IMPORT_JOBS',
   }),
 
@@ -64,6 +66,8 @@ export const ImportJobDto = {
       redirectCount: dynamoItem.redirectCount,
       importQueueId: dynamoItem.importQueueId,
       initiatedBy: dynamoItem.initiatedBy,
+      hasCustomHeaders: dynamoItem.hasCustomHeaders,
+      hasCustomImportJs: dynamoItem.hasCustomImportJs,
     };
 
     return createImportJob(importJobData);

package/src/index.d.ts

@@ -535,6 +535,16 @@ export interface ImportJob {
    * Retrieves the initiatedBy metadata (name, imsOrgId, imsUserId, userAgent) of the import job.
    */
   getInitiatedBy: () => object;
+
+  /**
+   * Indicates if the import job has custom headers.
+   */
+  hasCustomHeaders: () => boolean;
+
+  /**
+   * Indicates if the import job has custom import js.
+   */
+  hasCustomImportJs: () => boolean;
 }
 
 export interface ImportUrl {

package/src/models/importer/import-job.js

@@ -11,7 +11,7 @@
  */
 
 import {
-  hasText, isIsoDate, isValidUrl, isObject, isString, isNumber, isInteger,
+  hasText, isIsoDate, isValidUrl, isObject, isString, isNumber, isInteger, isBoolean,
 } from '@adobe/spacecat-shared-utils';
 import { Base } from '../base.js';
 import { ImportJobStatus, ImportOptions } from './import-constants.js';
@@ -39,6 +39,8 @@ const ImportJob = (data) => {
   self.getRedirectCount = () => self.state.redirectCount;
   self.getImportQueueId = () => self.state.importQueueId;
   self.getInitiatedBy = () => self.state.initiatedBy;
+  self.hasCustomHeaders = () => self.state.hasCustomHeaders || false;
+  self.hasCustomImportJs = () => self.state.hasCustomImportJs || false;
 
   /**
    * Updates the state of the ImportJob.
@@ -147,6 +149,29 @@ const ImportJob = (data) => {
     },
   );
 
+  /**
+   * Update the hasCustomHeaders value to true if the ImportJob has custom headers, false otherwise.
+   * @param {boolean} hasCustomHeaders - The new value for hasCustomHeaders.
+   * @return {ImportJob} The updated ImportJob object.
+   */
+  self.updateHasCustomHeaders = (hasCustomHeaders) => updateState('hasCustomHeaders', hasCustomHeaders, (value) => {
+    if (!isBoolean(value)) {
+      throw new Error(`Invalid hasCustomHeaders value: ${value}`);
+    }
+  });
+
+  /**
+   * Update the hasCustomImportJs value to true if the ImportJob has custom import js, false
+   * otherwise.
+   * @param {boolean} hasCustomImportJs - The new value for hasCustomImportJs.
+   * @return {ImportJob} The updated ImportJob object.
+   */
+  self.updateHasCustomImportJs = (hasCustomImportJs) => updateState('hasCustomImportJs', hasCustomImportJs, (value) => {
+    if (!isBoolean(value)) {
+      throw new Error(`Invalid hasCustomImportJs value: ${value}`);
+    }
+  });
+
   return Object.freeze(self);
 };
 
@@ -215,5 +240,13 @@ export const createImportJob = (data) => {
     });
   }
 
+  if (newState.hasCustomImportJs && !isBoolean(newState.hasCustomImportJs)) {
+    throw new Error(`Invalid hasCustomImportJs value: ${newState.hasCustomImportJs}`);
+  }
+
+  if (newState.hasCustomHeaders && !isBoolean(newState.hasCustomHeaders)) {
+    throw new Error(`Invalid hasCustomHeaders value: ${newState.hasCustomHeaders}`);
+  }
+
   return ImportJob(newState);
 };