@adobe/spacecat-shared-data-access 1.29.1 → 1.30.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@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)
+
+
+### Bug Fixes
+
+* [#268](https://github.com/adobe/spacecat-shared/issues/268) Import URL entities need a REDIRECT status, and additional properties for reporting ([#269](https://github.com/adobe/spacecat-shared/issues/269)) ([88bb491](https://github.com/adobe/spacecat-shared/commit/88bb49105a9b0a9cd297fe9667aff1df24bcee03))
+
 # [@adobe/spacecat-shared-data-access-v1.29.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.29.0...@adobe/spacecat-shared-data-access-v1.29.1) (2024-06-15)
 
 

package/package.json

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

package/src/dto/import-url.js

@@ -26,6 +26,9 @@ export const ImportUrlDto = {
     jobId: importUrl.getJobId(),
     url: importUrl.getUrl(),
     status: importUrl.getStatus(),
+    reason: importUrl.getReason(),
+    path: importUrl.getPath(),
+    file: importUrl.getFile(),
   }),
 
   /**
@@ -37,6 +40,9 @@ export const ImportUrlDto = {
       jobId: dynamoItem.jobId,
       url: dynamoItem.url,
       status: dynamoItem.status,
+      reason: dynamoItem.reason,
+      path: dynamoItem.path,
+      file: dynamoItem.file,
     };
     return createImportUrl(importUrlData);
   },

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/importer/import-url.js

@@ -10,12 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
-import { isValidUrl } from '@adobe/spacecat-shared-utils';
+import { hasText, isValidUrl } from '@adobe/spacecat-shared-utils';
 import { Base } from '../base.js';
 import { ImportJobStatus } from './import-job.js';
 
 export const ImportUrlStatus = {
   PENDING: 'PENDING',
+  REDIRECT: 'REDIRECT',
   ...ImportJobStatus,
 };
 
@@ -31,11 +32,16 @@ const ImportUrl = (data) => {
   self.getJobId = () => self.state.jobId;
   self.getUrl = () => self.state.url;
   self.getStatus = () => self.state.status;
+  self.getReason = () => self.state.reason;
+  // Absolute path to the resource that is being imported for the given URL
+  self.getPath = () => self.state.path;
+  // Resulting path and filename of the imported .docx file
+  self.getFile = () => self.state.file;
 
   /**
-     * Updates the status of the ImportUrl
-     */
-  self.updateStatus = (status) => {
+   * Updates the status of the ImportUrl
+   */
+  self.setStatus = (status) => {
     if (!Object.values(ImportUrlStatus).includes(status)) {
       throw new Error(`Invalid Import URL status during update: ${status}`);
     }
@@ -45,6 +51,47 @@ const ImportUrl = (data) => {
 
     return self;
   };
+
+  /**
+   * Updates the reason that the import of this URL was not successful
+   */
+  self.setReason = (reason) => {
+    if (!hasText(reason)) {
+      return self; // no-op
+    }
+
+    self.state.reason = reason;
+    self.touch();
+    return self;
+  };
+
+  /**
+   * Updates the path of the ImportUrl
+   */
+  self.setPath = (path) => {
+    if (!hasText(path)) {
+      return self; // no-op
+    }
+
+    self.state.path = path;
+    self.touch();
+    return self;
+  };
+
+  /**
+   * Updates the file of the ImportUrl. This is the path and file name of the file which
+   * was imported.
+   */
+  self.setFile = (file) => {
+    if (!hasText(file)) {
+      return self; // no-op
+    }
+
+    self.state.file = file;
+    self.touch();
+    return self;
+  };
+
   return Object.freeze(self);
 };
 

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;