@adobe/spacecat-shared-data-access 1.29.2 → 1.31.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.31.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.30.0...@adobe/spacecat-shared-data-access-v1.31.0) (2024-06-20)
+
+
+### Features
+
+* overwrite broken-backlinks ([#270](https://github.com/adobe/spacecat-shared/issues/270)) ([62256f2](https://github.com/adobe/spacecat-shared/commit/62256f2f750a97ada3d6b624b0ec50865589f39f))
+
+# [@adobe/spacecat-shared-data-access-v1.30.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.29.2...@adobe/spacecat-shared-data-access-v1.30.0) (2024-06-19)
+
+
+### Features
+
+* introduce organic keywords for ahrefs client and top keyword in top pages ([#257](https://github.com/adobe/spacecat-shared/issues/257)) ([371f1c4](https://github.com/adobe/spacecat-shared/commit/371f1c475870fd2aac833f925236237a8b25c026))
+
 # [@adobe/spacecat-shared-data-access-v1.29.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.29.1...@adobe/spacecat-shared-data-access-v1.29.2) (2024-06-18)
 
 

package/package.json

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

package/src/dto/site-top-page.js

@@ -26,6 +26,7 @@ export const SiteTopPageDto = {
     siteId: siteTopPage.getSiteId(),
     url: siteTopPage.getURL(),
     traffic: siteTopPage.getTraffic(),
+    topKeyword: siteTopPage.getTopKeyword(),
     source: siteTopPage.getSource(),
     geo: siteTopPage.getGeo(),
     importedAt: siteTopPage.getImportedAt(),
@@ -34,13 +35,16 @@ export const SiteTopPageDto = {
 
   /**
    * Converts a DynamoDB item into a SiteTopPage object.
-   * @param {{siteId, url, traffic, source, geo, importedAt, SK: string}} item - DynamoDB item.
+   * @param {
+   *   {siteId, url, traffic, topKeyword, source, geo, importedAt, SK: string}
+   * } item - DynamoDB item.
    * @returns {SiteTopPage}
    */
   fromDynamoItem: (item) => createSiteTopPage({
     siteId: item.siteId,
     url: item.url,
     traffic: item.traffic,
+    topKeyword: item.topKeyword,
     source: item.source,
     geo: item.geo,
     importedAt: item.importedAt,

package/src/index.d.ts

@@ -347,6 +347,12 @@ export interface SiteTopPage {
    */
   getTraffic: () => number;
 
+  /**
+   * Retrieves the keyword that brings the most organic traffic to the page.
+   * @returns {string} The keyword.
+   */
+  getTopKeyword: () => string;
+
   /**
    * Retrieves the source of the site top page.
    * @returns {string} The source.

package/src/models/site/audit-config-type.js

@@ -14,6 +14,7 @@ const AuditConfigType = (data = {}) => {
   const state = {
     disabled: data.disabled || false,
     excludedURLs: data.excludedURLs || [],
+    manualOverwrites: data.manualOverwrites || [],
   };
 
   const self = {
@@ -22,6 +23,10 @@ const AuditConfigType = (data = {}) => {
     updateExcludedURLs: (excludeURLs) => {
       state.excludedURLs = excludeURLs;
     },
+    getManualOverwrites: () => state.manualOverwrites,
+    updateManualOverwrites: (manualOverwrites) => {
+      state.manualOverwrites = manualOverwrites;
+    },
     updateDisabled: (newValue) => {
       state.disabled = newValue;
     },
@@ -34,6 +39,7 @@ AuditConfigType.fromDynamoItem = (dynamoItem) => {
   const auditConfigTypeData = {
     disabled: dynamoItem.disabled,
     excludedURLs: dynamoItem.excludedURLs,
+    manualOverwrites: dynamoItem.manualOverwrites,
   };
   return AuditConfigType(auditConfigTypeData);
 };
@@ -41,6 +47,7 @@ AuditConfigType.fromDynamoItem = (dynamoItem) => {
 AuditConfigType.toDynamoItem = (auditConfigType) => ({
   disabled: auditConfigType.disabled(),
   excludedURLs: auditConfigType.getExcludedURLs(),
+  manualOverwrites: auditConfigType.getManualOverwrites(),
 });
 
 export default AuditConfigType;

package/src/models/site/config.js

@@ -31,6 +31,10 @@ export const configSchema = Joi.object({
       Joi.object({
         disabled: Joi.boolean().optional(),
         excludedURLs: Joi.array().items(Joi.string()).optional(),
+        manualOverwrites: Joi.array().items(Joi.object({
+          brokenTargetURL: Joi.string().optional(),
+          targetURL: Joi.string().optional(),
+        })).optional(),
       }).unknown(true),
     ).unknown(true),
   }).unknown(true),

package/src/models/site-top-page.js

@@ -23,6 +23,7 @@ const SiteTopPage = (data = {}) => {
   self.getSiteId = () => self.state.siteId;
   self.getURL = () => self.state.url;
   self.getTraffic = () => self.state.traffic;
+  self.getTopKeyword = () => self.state.topKeyword;
   self.getSource = () => self.state.source.toLowerCase();
   self.getGeo = () => self.state.geo;
   self.getImportedAt = () => self.state.importedAt;