@adobe/spacecat-shared-data-access 1.15.0 → 1.15.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.15.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.15.0...@adobe/spacecat-shared-data-access-v1.15.1) (2024-02-07)
+
+
+### Bug Fixes
+
+* retrieve site candidate by base url ([#140](https://github.com/adobe/spacecat-shared/issues/140)) ([b37cb0b](https://github.com/adobe/spacecat-shared/commit/b37cb0b1948f87e0e791cfec1e2b1fef9c0abb07))
+
 # [@adobe/spacecat-shared-data-access-v1.15.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.14.1...@adobe/spacecat-shared-data-access-v1.15.0) (2024-02-06)
 
 

package/README.md

@@ -73,6 +73,7 @@ The module provides two main DAOs:
 - `removeSite`
 
 ### Site Candidate Functions
+- `getSiteCandidateByBaseURL`
 - `upsertSiteCandidate`
 - `siteCandidateExists`
 - `updateSiteCandidate`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.15.0",
+  "version": "1.15.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",
@@ -40,7 +40,7 @@
   "devDependencies": {
     "chai": "4.4.1",
     "chai-as-promised": "7.1.1",
-    "dynamo-db-local": "7.3.0",
+    "dynamo-db-local": "8.0.0",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0"
   }

package/src/dto/site-candidate.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { createSiteCandidate } from '../models/site-candidate.js';
+
 /**
  * Data transfer object for Site Candidate.
  */
@@ -28,4 +30,23 @@ export const SiteCandidateDto = {
     updatedAt: siteCandidate.getUpdatedAt(),
     updatedBy: siteCandidate.getUpdatedBy(),
   }),
+
+  /**
+   * Converts a DynamoDB item into Site Candidate object;
+   * @param {object } dynamoItem - DynamoDB item.
+   * @returns {Readonly<SiteCandidate>} SiteCandidate object.
+   */
+  fromDynamoItem: (dynamoItem) => {
+    const siteCandidateData = {
+      baseURL: dynamoItem.baseURL,
+      siteId: dynamoItem.siteId,
+      source: dynamoItem.source,
+      status: dynamoItem.status,
+      createdAt: dynamoItem.createdAt,
+      updatedAt: dynamoItem.updatedAt,
+      updatedBy: dynamoItem.updatedBy,
+    };
+
+    return createSiteCandidate(siteCandidateData);
+  },
 };

package/src/index.d.ts

@@ -403,6 +403,7 @@ export interface DataAccess {
   ) => Promise<void>;
 
   // site candidate functions
+  getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;
   upsertSiteCandidate: (siteCandidateDate: object) => Promise<SiteCandidate>;
   siteCandidateExists: (baseURL: string) => Promise<boolean>;
   updateSiteCandidate: (siteCandidate: SiteCandidate) => Promise<SiteCandidate>;

package/src/service/site-candidates/accessPatterns.js

@@ -27,6 +27,17 @@ export const exists = async (dynamoClient, config, baseURL) => {
   return isObject(dynamoItem);
 };
 
+export const getSiteCandidateByBaseURL = async (
+  dynamoClient,
+  config,
+  log,
+  baseURL,
+) => {
+  const dynamoItem = await dynamoClient.getItem(config.tableNameSiteCandidates, { baseURL });
+
+  return isObject(dynamoItem) ? SiteCandidateDto.fromDynamoItem(dynamoItem) : null;
+};
+
 /**
  * Upserts a site candidate.
  *

package/src/service/site-candidates/index.js

@@ -11,12 +11,19 @@
  */
 
 import {
+  getSiteCandidateByBaseURL,
   upsertSiteCandidate,
   exists,
   updateSiteCandidate,
 } from './accessPatterns.js';
 
 export const siteCandidateFunctions = (dynamoClient, config, log) => ({
+  getSiteCandidateByBaseURL: (baseURL) => getSiteCandidateByBaseURL(
+    dynamoClient,
+    config,
+    log,
+    baseURL,
+  ),
   upsertSiteCandidate: (siteCandidateData) => upsertSiteCandidate(
     dynamoClient,
     config,