@adobe/spacecat-shared-data-access 1.58.2 → 1.59.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.59.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.58.2...@adobe/spacecat-shared-data-access-v1.59.0) (2024-12-11)
+
+
+### Features
+
+* **data-access:** get site candidates ([#486](https://github.com/adobe/spacecat-shared/issues/486)) ([f45032d](https://github.com/adobe/spacecat-shared/commit/f45032dbcd3ea1e8cdfc2066f523b4a1690b5da4))
+
 # [@adobe/spacecat-shared-data-access-v1.58.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.58.1...@adobe/spacecat-shared-data-access-v1.58.2) (2024-12-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.58.2",
+  "version": "1.59.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -34,7 +34,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@adobe/spacecat-shared-dynamo": "1.3.50",
+    "@adobe/spacecat-shared-dynamo": "1.4.0",
     "@adobe/spacecat-shared-utils": "1.23.1",
     "@aws-sdk/client-dynamodb": "3.705.0",
     "@aws-sdk/lib-dynamodb": "3.705.0",

package/src/index.d.ts

@@ -872,6 +872,7 @@ export interface DataAccess {
   ) => Promise<ApiKey | null>;
 
   // site candidate functions
+  getSiteCandidates: () => Promise<SiteCandidate[]>;
   getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;
   upsertSiteCandidate: (siteCandidateDate: object) => Promise<SiteCandidate>;
   siteCandidateExists: (baseURL: string) => Promise<boolean>;

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

@@ -14,6 +14,21 @@ import { isObject } from '@adobe/spacecat-shared-utils';
 import { createSiteCandidate } from '../../models/site-candidate.js';
 import { SiteCandidateDto } from '../../dto/site-candidate.js';
 
+/**
+ * Retrieves all site candidates.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @returns {Promise<Readonly<Site>[]>} A promise that resolves to an array of all site candidates.
+ */
+export const getSiteCandidates = async (dynamoClient, config) => {
+  const dynamoItems = await dynamoClient.scan({
+    TableName: config.tableNameSites,
+  });
+
+  return dynamoItems.map((dynamoItem) => SiteCandidateDto.fromDynamoItem(dynamoItem));
+};
+
 /**
  * Checks if a site candidate exists in site candidates table using base url
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.

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

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