@adobe/spacecat-shared-data-access 1.6.4 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.7.0...@adobe/spacecat-shared-data-access-v1.8.0) (2024-01-18)
+
+
+### Features
+
+* add broken-backlinks audit type (SITES-18417) ([#86](https://github.com/adobe/spacecat-shared/issues/86)) ([b16c366](https://github.com/adobe/spacecat-shared/commit/b16c3667808221958ff4a526512cb89c3cd0bbcb))
+
+# [@adobe/spacecat-shared-data-access-v1.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.6.4...@adobe/spacecat-shared-data-access-v1.7.0) (2024-01-18)
+
+
+### Features
+
+* set isLiveToggledAt ([#85](https://github.com/adobe/spacecat-shared/issues/85)) ([cefc093](https://github.com/adobe/spacecat-shared/commit/cefc0938385b9fa079d24c24f03b21651a0999cc))
+
 # [@adobe/spacecat-shared-data-access-v1.6.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.6.3...@adobe/spacecat-shared-data-access-v1.6.4) (2024-01-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.6.4",
+  "version": "1.8.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",

package/src/dto/site.js

@@ -29,6 +29,7 @@ export const SiteDto = {
     gitHubURL: site.getGitHubURL() || '',
     imsOrgId: site.getImsOrgId() || '',
     isLive: site.isLive(),
+    isLiveToggledAt: site.getIsLiveToggledAt(),
     createdAt: site.getCreatedAt(),
     updatedAt: site.getUpdatedAt(),
     GSI1PK: 'ALL_SITES',
@@ -48,6 +49,7 @@ export const SiteDto = {
       gitHubURL: dynamoItem.gitHubURL,
       imsOrgId: dynamoItem.imsOrgId,
       isLive: dynamoItem.isLive,
+      isLiveToggledAt: dynamoItem.isLiveToggledAt,
       createdAt: dynamoItem.createdAt,
       updatedAt: dynamoItem.updatedAt,
       auditConfig: dynamoItem.auditConfig,

package/src/index.d.ts

@@ -185,6 +185,12 @@ export interface Site {
    */
   isLive: () => boolean;
 
+  /**
+   * The timestamp when the site was last toggled to live or non-live.
+   * @returns {string} The timestamp when the site was last toggled to live or non-live.
+   */
+  getIsLiveToggledAt: () => string;
+
   /**
    * Updates the list of audits for the site.
    * @param {Audit[]} audits The new list of audits.

package/src/models/audit.js

@@ -13,6 +13,7 @@
 import { hasText, isIsoDate, isObject } from '@adobe/spacecat-shared-utils';
 import { Base } from './base.js';
 
+export const AUDIT_TYPE_BROKEN_BACKLINKS = 'broken-backlinks';
 export const AUDIT_TYPE_CWV = 'cwv';
 export const AUDIT_TYPE_LHS_DESKTOP = 'lhs-desktop';
 export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
@@ -20,6 +21,7 @@ export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
 const EXPIRES_IN_DAYS = 30;
 
 const AUDIT_TYPE_PROPERTIES = {
+  [AUDIT_TYPE_BROKEN_BACKLINKS]: [],
   [AUDIT_TYPE_CWV]: [],
   [AUDIT_TYPE_LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
   [AUDIT_TYPE_LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],
@@ -36,7 +38,7 @@ const validateScores = (auditResult, auditType) => {
     return true;
   }
 
-  if (!isObject(auditResult.scores)) {
+  if (auditType !== AUDIT_TYPE_BROKEN_BACKLINKS && !isObject(auditResult.scores)) {
     throw new Error(`Missing scores property for audit type '${auditType}'`);
   }
 

package/src/models/site.js

@@ -39,6 +39,7 @@ const Site = (data = {}) => {
   self.getGitHubURL = () => self.state.gitHubURL;
   self.getImsOrgId = () => self.state.imsOrgId;
   self.isLive = () => self.state.isLive;
+  self.getIsLiveToggledAt = () => self.state.isLiveToggledAt;
 
   // TODO: updating the baseURL is not supported yet, it will require a transact write
   //  on dynamodb (put then delete) since baseURL is part of the primary key, something like:
@@ -143,6 +144,7 @@ const Site = (data = {}) => {
    */
   self.toggleLive = () => {
     self.state.isLive = !self.state.isLive;
+    self.state.isLiveToggledAt = new Date().toISOString();
     return self;
   };