@adobe/spacecat-shared-data-access 1.11.0 → 1.13.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.13.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.12.0...@adobe/spacecat-shared-data-access-v1.13.0) (2024-01-30)
+
+
+### Features
+
+* introduce default config for organic-keywords report (SITES-19317) ([#118](https://github.com/adobe/spacecat-shared/issues/118)) ([4301556](https://github.com/adobe/spacecat-shared/commit/430155645e1452760bf2818d70a0faae2fb8db12))
+
+# [@adobe/spacecat-shared-data-access-v1.12.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.11.0...@adobe/spacecat-shared-data-access-v1.12.0) (2024-01-29)
+
+
+### Features
+
+* add getSitesByOrganizationIDWithLatestAudits query ([d3a8f8c](https://github.com/adobe/spacecat-shared/commit/d3a8f8cc2148229aecec3df277e298a3f0746865))
+
 # [@adobe/spacecat-shared-data-access-v1.11.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.10.5...@adobe/spacecat-shared-data-access-v1.11.0) (2024-01-29)
 
 

package/package.json

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

package/src/models/audit.js

@@ -15,6 +15,7 @@ import { Base } from './base.js';
 
 export const AUDIT_TYPE_404 = '404';
 export const AUDIT_TYPE_BROKEN_BACKLINKS = 'broken-backlinks';
+export const AUDIT_TYPE_ORGANIC_KEYWORDS = 'organic-keywords';
 export const AUDIT_TYPE_CWV = 'cwv';
 export const AUDIT_TYPE_LHS_DESKTOP = 'lhs-desktop';
 export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
@@ -24,6 +25,7 @@ const EXPIRES_IN_DAYS = 30;
 const AUDIT_TYPE_PROPERTIES = {
   [AUDIT_TYPE_404]: [],
   [AUDIT_TYPE_BROKEN_BACKLINKS]: [],
+  [AUDIT_TYPE_ORGANIC_KEYWORDS]: [],
   [AUDIT_TYPE_CWV]: [],
   [AUDIT_TYPE_LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
   [AUDIT_TYPE_LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],

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

@@ -11,16 +11,21 @@
  */
 
 import AuditConfigType from './audit-config-type.js';
-import { AUDIT_TYPE_BROKEN_BACKLINKS } from '../audit.js';
+import {
+  AUDIT_TYPE_BROKEN_BACKLINKS,
+  AUDIT_TYPE_ORGANIC_KEYWORDS,
+} from '../audit.js';
 
 const AUDIT_TYPE_DISABLED_DEFAULTS = {
   [AUDIT_TYPE_BROKEN_BACKLINKS]: true,
+  [AUDIT_TYPE_ORGANIC_KEYWORDS]: true,
 };
 
 function getAuditTypeConfigs(auditTypeConfigs, auditsDisabled) {
   if (!auditTypeConfigs || Object.keys(auditTypeConfigs).length === 0) {
     return {
       [AUDIT_TYPE_BROKEN_BACKLINKS]: AuditConfigType({ disabled: true }),
+      [AUDIT_TYPE_ORGANIC_KEYWORDS]: AuditConfigType({ disabled: true }),
     };
   }
   return Object.entries(auditTypeConfigs || {}).reduce((acc, [key, value]) => {

package/src/service/sites/accessPatterns.js

@@ -266,6 +266,51 @@ export const getSitesByOrganizationID = async (
   return dynamoItems.map((dynamoItem) => SiteDto.fromDynamoItem(dynamoItem));
 };
 
+/**
+ * Retrieves sites by organizationId with their latest audit. Sites without a latest
+ * audit will not be included in the result.
+ * The sites are sorted by their latest audit scores in ascending order by default.
+ * The sortAuditsAscending parameter can be used to change the sort order.
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {string} auditType - The type of audits to retrieve for the sites.
+ * @param {string} organizationId - The organizationId to retrieve the sites.
+ * @param {boolean} [sortAuditsAscending=true] - Determines if the audits should be sorted in
+ * ascending order.
+ * to retrieve.
+ * @return {Promise<Readonly<Site>[]>} A promise that resolves to an array of sites with their
+ * latest audit.
+ */
+export const getSitesByOrganizationIDWithLatestAudits = async (
+  dynamoClient,
+  config,
+  log,
+  organizationId,
+  auditType,
+  sortAuditsAscending = true,
+) => {
+  const [sites, latestAudits] = await Promise.all([
+    getSitesByOrganizationID(dynamoClient, config, organizationId),
+    getLatestAudits(dynamoClient, config, log, auditType, sortAuditsAscending),
+  ]);
+
+  const sitesMap = new Map(sites.map((site) => [site.getId(), site]));
+  const orderedSites = [];
+
+  // Append just sites with a latest audit in the sorted order
+  latestAudits.forEach((audit) => {
+    const site = sitesMap.get(audit.getSiteId());
+    if (site) {
+      site.setAudits([audit]);
+      orderedSites.push(site);
+      sitesMap.delete(site.getId()); // Remove the site from the map to avoid adding it again
+    }
+  });
+
+  return orderedSites;
+};
+
 /**
  * Retrieves a site by its ID.
  *

package/src/service/sites/index.js

@@ -19,7 +19,7 @@ import {
   getSiteByID,
   getSites,
   getSitesByDeliveryType,
-  getSitesByOrganizationID,
+  getSitesByOrganizationID, getSitesByOrganizationIDWithLatestAudits,
   getSitesToAudit,
   getSitesWithLatestAudit,
   removeSite,
@@ -58,6 +58,18 @@ export const siteFunctions = (dynamoClient, config, log) => ({
     sortAuditsAscending,
     deliveryType,
   ),
+  getSitesByOrganizationIDWithLatestAudits: (
+    organizationId,
+    auditType,
+    sortAuditsAscending,
+  ) => getSitesByOrganizationIDWithLatestAudits(
+    dynamoClient,
+    config,
+    log,
+    organizationId,
+    auditType,
+    sortAuditsAscending,
+  ),
   getSiteByBaseURL: (baseUrl) => getSiteByBaseURL(
     dynamoClient,
     config,