@adobe/spacecat-shared-data-access 1.1.6 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.2.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.1.6...@adobe/spacecat-shared-data-access-v1.2.0) (2023-12-05)
+
+
+### Features
+
+* introduce getSiteByID ([#36](https://github.com/adobe-rnd/spacecat-shared/issues/36)) ([5677f76](https://github.com/adobe-rnd/spacecat-shared/commit/5677f76d11d97f2a2afd878e0ada7cad22fd1f03))
+
 # [@adobe/spacecat-shared-data-access-v1.1.6](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.1.5...@adobe/spacecat-shared-data-access-v1.1.6) (2023-12-05)
 
 

package/package.json

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

package/src/index.d.ts

@@ -81,6 +81,9 @@ export interface DataAccess {
     baseUrl: string,
     auditType: string,
   ) => Promise<Site | null>;
+  getSiteByID: (
+    siteId: string,
+  ) => Promise<Site | null>;
   addSite: (
     siteData: object,
   ) => Promise<Site>;

package/src/service/sites/accessPatterns.js

@@ -42,16 +42,16 @@ export const getSites = async (dynamoClient, config) => {
 };
 
 /**
- * Retrieves a list of base URLs for all sites.
+ * Retrieves a list of site IDs of all sites.
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @returns {Promise<Array<string>>} A promise that resolves to an array of base URLs for all sites.
+ * @returns {Promise<Array<string>>} A promise that resolves to an array of site IDs of all sites.
  */
 export const getSitesToAudit = async (dynamoClient, config) => {
   const sites = await getSites(dynamoClient, config);
 
-  return sites.map((site) => site.getBaseURL());
+  return sites.map((site) => site.getId());
 };
 
 /**
@@ -117,11 +117,7 @@ export const getSiteByBaseURL = async (
     Limit: 1,
   });
 
-  if (dynamoItems.length === 0) {
-    return null;
-  }
-
-  return SiteDto.fromDynamoItem(dynamoItems[0]);
+  return dynamoItems.length > 0 ? SiteDto.fromDynamoItem(dynamoItems[0]) : null;
 };
 
 /**
@@ -209,6 +205,27 @@ export const getSiteByBaseURLWithLatestAudit = async (
   auditType,
 ) => getSiteByBaseURLWithAuditInfo(dynamoClient, config, log, baseUrl, auditType, true);
 
+/**
+ * Retrieves a site by its ID.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {string} siteId - The ID of the site to retrieve.
+ * @returns {Promise<Readonly<Site>|null>} A promise that resolves to the site object if found,
+ * otherwise null.
+ */
+export const getSiteByID = async (
+  dynamoClient,
+  config,
+  log,
+  siteId,
+) => {
+  const dynamoItem = await dynamoClient.getItem(config.tableNameSites, { id: siteId });
+
+  return isObject(dynamoItem) ? SiteDto.fromDynamoItem(dynamoItem) : null;
+};
+
 /**
  * Adds a site.
  *

package/src/service/sites/index.js

@@ -16,6 +16,7 @@ import {
   getSiteByBaseURLWithAuditInfo,
   getSiteByBaseURLWithAudits,
   getSiteByBaseURLWithLatestAudit,
+  getSiteByID,
   getSites,
   getSitesToAudit,
   getSitesWithLatestAudit, removeSite,
@@ -44,6 +45,12 @@ export const siteFunctions = (dynamoClient, config, log) => ({
     log,
     baseUrl,
   ),
+  getSiteByID: (siteId) => getSiteByID(
+    dynamoClient,
+    config,
+    log,
+    siteId,
+  ),
   getSiteByBaseURLWithAuditInfo: (baseUrl, auditType, latestOnly) => getSiteByBaseURLWithAuditInfo(
     dynamoClient,
     config,