@adobe/spacecat-shared-data-access 1.33.1 → 1.34.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.34.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.34.0...@adobe/spacecat-shared-data-access-v1.34.1) (2024-06-29)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#279](https://github.com/adobe/spacecat-shared/issues/279)) ([4710607](https://github.com/adobe/spacecat-shared/commit/471060797fac55649ff0c0ea24129bdd421d46b2))
+
+# [@adobe/spacecat-shared-data-access-v1.34.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.33.1...@adobe/spacecat-shared-data-access-v1.34.0) (2024-06-28)
+
+
+### Features
+
+* add helix config to site/candidates ([#277](https://github.com/adobe/spacecat-shared/issues/277)) ([5ed489d](https://github.com/adobe/spacecat-shared/commit/5ed489dc84cb594689092e1f0019dd83d3647039))
+
 # [@adobe/spacecat-shared-data-access-v1.33.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.33.0...@adobe/spacecat-shared-data-access-v1.33.1) (2024-06-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.33.1",
+  "version": "1.34.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",
@@ -31,8 +31,8 @@
   "dependencies": {
     "@adobe/spacecat-shared-dynamo": "1.2.5",
     "@adobe/spacecat-shared-utils": "1.2.0",
-    "@aws-sdk/client-dynamodb": "3.602.0",
-    "@aws-sdk/lib-dynamodb": "3.602.0",
+    "@aws-sdk/client-dynamodb": "3.606.0",
+    "@aws-sdk/lib-dynamodb": "3.606.0",
     "@types/joi": "17.2.3",
     "joi": "17.13.3",
     "uuid": "10.0.0"

package/src/dto/site-candidate.js

@@ -23,6 +23,7 @@ export const SiteCandidateDto = {
    */
   toDynamoItem: (siteCandidate) => ({
     baseURL: siteCandidate.getBaseURL(),
+    hlxConfig: siteCandidate.getHlxConfig(),
     siteId: siteCandidate.getSiteId(),
     source: siteCandidate.getSource(),
     status: siteCandidate.getStatus(),
@@ -39,6 +40,7 @@ export const SiteCandidateDto = {
   fromDynamoItem: (dynamoItem) => {
     const siteCandidateData = {
       baseURL: dynamoItem.baseURL,
+      hlxConfig: dynamoItem.hlxConfig,
       siteId: dynamoItem.siteId,
       source: dynamoItem.source,
       status: dynamoItem.status,

package/src/dto/site.js

@@ -28,6 +28,7 @@ export const SiteDto = {
     baseURL: site.getBaseURL(),
     deliveryType: site.getDeliveryType(),
     gitHubURL: site.getGitHubURL() || '',
+    hlxConfig: site.getHlxConfig(),
     organizationId: site.getOrganizationId() || '',
     isLive: site.isLive(),
     isLiveToggledAt: site.getIsLiveToggledAt(),
@@ -49,6 +50,7 @@ export const SiteDto = {
       baseURL: dynamoItem.baseURL,
       deliveryType: dynamoItem.deliveryType,
       gitHubURL: dynamoItem.gitHubURL,
+      hlxConfig: dynamoItem.hlxConfig,
       organizationId: dynamoItem.organizationId,
       isLive: dynamoItem.isLive,
       isLiveToggledAt: dynamoItem.isLiveToggledAt,

package/src/models/site-candidate.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, isValidUrl } from '@adobe/spacecat-shared-utils';
+import { hasText, isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
 
 import { Base } from './base.js';
 
@@ -43,6 +43,7 @@ const SiteCandidate = (data = {}) => {
   delete self.state.id; // no id property used in SiteCandidate modal
 
   self.getBaseURL = () => self.state.baseURL;
+  self.getHlxConfig = () => self.state.hlxConfig;
   self.getSiteId = () => self.state.siteId;
   self.getSource = () => self.state.source;
   self.getStatus = () => self.state.status;
@@ -54,6 +55,12 @@ const SiteCandidate = (data = {}) => {
     return self;
   };
 
+  self.setHlxConfig = (hlxConfig) => {
+    self.state.hlxConfig = hlxConfig;
+    self.touch();
+    return self;
+  };
+
   self.setSource = (source) => {
     self.state.source = source;
     self.touch();
@@ -88,6 +95,14 @@ export const createSiteCandidate = (data) => {
     throw new Error(`Base URL must be a valid URL: ${newState.baseURL}`);
   }
 
+  if (newState.hlxConfig && !isObject(newState.hlxConfig)) {
+    throw new Error(`HLX Config must be an object: ${newState.hlxConfig}`);
+  }
+
+  if (!newState.hlxConfig) {
+    newState.hlxConfig = {};
+  }
+
   if (!hasText(newState.updatedBy)) {
     newState.updatedBy = DEFAULT_UPDATED_BY;
   }

package/src/models/site.js

@@ -40,6 +40,7 @@ const Site = (data = {}) => {
   self.getConfig = () => self.state.config;
   self.getDeliveryType = () => self.state.deliveryType;
   self.getGitHubURL = () => self.state.gitHubURL;
+  self.getHlxConfig = () => self.state.hlxConfig;
   self.getOrganizationId = () => self.state.organizationId;
   self.isLive = () => self.state.isLive;
   self.getIsLiveToggledAt = () => self.state.isLiveToggledAt;
@@ -136,6 +137,23 @@ const Site = (data = {}) => {
     return self;
   };
 
+  /**
+   * Updates the Helix Configuration for this site.
+   * @param {object} hlxConfig - The Helix Configuration.
+   * @throws {Error} If the provided Helix Configuration is not an object.
+   * @return {Base} The updated site.
+   */
+  self.updateHlxConfig = (hlxConfig) => {
+    if (!isObject(hlxConfig)) {
+      throw new Error('HLX Config must be an object');
+    }
+
+    self.state.hlxConfig = hlxConfig;
+    self.touch();
+
+    return self;
+  };
+
   /**
    * Updates the organizationId the site belongs to.
    * @param {string} organizationId - The Org ID.
@@ -179,6 +197,14 @@ export const createSite = (data) => {
     throw new Error(`Base URL must be a valid URL: ${newState.baseURL}`);
   }
 
+  if (newState.hlxConfig && !isObject(newState.hlxConfig)) {
+    throw new Error(`HLX Config must be an object: ${newState.hlxConfig}`);
+  }
+
+  if (!newState.hlxConfig) {
+    newState.hlxConfig = {};
+  }
+
   if (!hasText(newState.organizationId)) {
     newState.organizationId = DEFAULT_ORGANIZATION_ID;
   }