@adobe/spacecat-shared-data-access 1.16.0 → 1.17.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.17.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.17.0...@adobe/spacecat-shared-data-access-v1.17.1) (2024-02-15)
+
+
+### Bug Fixes
+
+* generify site and organization config ([0ec8ee1](https://github.com/adobe/spacecat-shared/commit/0ec8ee1445e389c47d6ece436853e5b4c105ca93))
+
+# [@adobe/spacecat-shared-data-access-v1.17.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.16.0...@adobe/spacecat-shared-data-access-v1.17.0) (2024-02-14)
+
+
+### Features
+
+* get organization by IMS org ID ([#153](https://github.com/adobe/spacecat-shared/issues/153)) ([541e7e7](https://github.com/adobe/spacecat-shared/commit/541e7e721cb21e977b59b19cf53dfb7ba460905f))
+
 # [@adobe/spacecat-shared-data-access-v1.16.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.15.6...@adobe/spacecat-shared-data-access-v1.16.0) (2024-02-14)
 
 

package/package.json

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

package/src/index.d.ts

@@ -413,6 +413,9 @@ export interface DataAccess {
   getOrganizationByID: (
       organizationID: string,
   ) => Promise<Organization | null>;
+  getOrganizationByImsOrgID: (
+      imsOrgID: string,
+  ) => Promise<Organization | null>;
   addOrganization: (
       organizationData: object,
   ) => Promise<Organization>;
@@ -446,6 +449,7 @@ interface DataAccessConfig {
   indexNameAllSitesByDeliveryType: string;
   indexNameAllLatestAuditScores: string;
   indexNameAllOrganizations: string,
+  indexNameAllOrganizationsByImsOrgId: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;

package/src/index.js

@@ -21,6 +21,7 @@ const TABLE_NAME_CONFIGURATIONS = 'spacecat-services-configurations-dev';
 
 const INDEX_NAME_ALL_SITES = 'spacecat-services-all-sites-dev';
 const INDEX_NAME_ALL_ORGANIZATIONS = 'spacecat-services-all-organizations-dev';
+const INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = 'spacecat-services-all-organizations-by-ims-org-id-dev';
 const INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = 'spacecat-services-all-sites-by-delivery-type-dev';
 const INDEX_NAME_ALL_LATEST_AUDIT_SCORES = 'spacecat-services-all-latest-audit-scores-dev';
 const INDEX_NAME_ALL_SITES_ORGANIZATIONS = 'spacecat-services-all-sites-organizations-dev';
@@ -46,6 +47,8 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
         DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES = INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
         DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS = INDEX_NAME_ALL_ORGANIZATIONS,
+        // eslint-disable-next-line max-len
+        DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID,
         DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS = INDEX_NAME_ALL_SITES_ORGANIZATIONS,
       } = context.env;
 
@@ -58,6 +61,7 @@ export default function dataAccessWrapper(fn) {
         tableNameConfigurations: DYNAMO_TABLE_NAME_CONFIGURATIONS,
         indexNameAllSites: DYNAMO_INDEX_NAME_ALL_SITES,
         indexNameAllOrganizations: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS,
+        indexNameAllOrganizationsByImsOrgId: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID,
         indexNameAllSitesByDeliveryType: DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
         indexNameAllLatestAuditScores: DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
         indexNameAllSitesOrganizations: DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS,

package/src/models/organization.js

@@ -92,10 +92,15 @@ export const createOrganization = (data) => {
   if (!isObject(newState.config)) {
     newState.config = { ...DEFAULT_CONFIG };
   }
+
   if (!hasText(newState.name)) {
     throw new Error('Org name must be provided');
   }
 
+  if (!hasText(newState.imsOrgId)) {
+    newState.imsOrgId = DEFAULT_ORGANIZATION_ID;
+  }
+
   newState.config = Config(newState.config);
 
   return Organization(newState);

package/src/models/site/config.js

@@ -43,18 +43,9 @@ function validateConfiguration(config) {
 
 export const Config = (data = {}) => {
   const validConfig = validateConfiguration(data);
-  const state = {
-    slack: {
-      ...(validConfig?.slack?.channel ? { channel: validConfig?.slack?.channel } : {}),
-      ...(validConfig?.slack?.workspace ? { workspace: validConfig?.slack?.workspace } : {}),
-    },
-    alerts: validConfig.alerts || [],
-  };
+  const state = { ...validConfig };
 
-  const self = {
-    alerts: state.alerts,
-    slack: state.slack,
-  };
+  const self = { ...state };
 
   return Object.freeze(self);
 };

package/src/service/index.js

@@ -23,7 +23,8 @@ import { configurationFunctions } from './configurations/index.js';
  * @param {{pkAllSites: string, pkAllLatestAudits: string, indexNameAllLatestAuditScores: string,
  * tableNameAudits: string,tableNameLatestAudits: string, indexNameAllSitesOrganizations: string,
  * tableNameSites: string, tableNameOrganizations: string, indexNameAllSites: string,
- * indexNameAllOrganizations: string, pkAllOrganizations: string}} config configuration
+ * indexNameAllOrganizations: string, indexNameAllOrganizationsByImsOrgId: string,
+ * pkAllOrganizations: string}} config configuration
  * @param {Logger} log logger
  * @returns {object} data access object
  */

package/src/service/organizations/accessPatterns.js

@@ -50,6 +50,32 @@ export const getOrganizationByID = async (
   return isObject(dynamoItem) ? OrganizationDto.fromDynamoItem(dynamoItem) : null;
 };
 
+/**
+ * Retrieves an organization by its IMS org ID.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {string} imsOrgId - Organization identifier on IMS, in the format of {id}@AdobeOrg
+ * @returns {Promise<Readonly<Organization>>} A promise that resolves to an organization, if found.
+ */
+export const getOrganizationByImsOrgID = async (
+  dynamoClient,
+  config,
+  imsOrgId,
+) => {
+  const dynamoItems = await dynamoClient.query({
+    TableName: config.tableNameOrganizations,
+    IndexName: config.indexNameAllOrganizationsByImsOrgId,
+    KeyConditionExpression: 'imsOrgId = :imsOrgId',
+    ExpressionAttributeValues: {
+      ':imsOrgId': imsOrgId,
+    },
+    Limit: 1,
+  });
+
+  return dynamoItems.length > 0 ? OrganizationDto.fromDynamoItem(dynamoItems[0]) : null;
+};
+
 /**
  * Adds an organization.
  *

package/src/service/organizations/index.js

@@ -15,6 +15,7 @@ import {
   addOrganization,
   updateOrganization,
   removeOrganization,
+  getOrganizationByImsOrgID,
 } from './accessPatterns.js';
 
 export const organizationFunctions = (dynamoClient, config, log) => ({
@@ -24,6 +25,11 @@ export const organizationFunctions = (dynamoClient, config, log) => ({
     config,
     organizationId,
   ),
+  getOrganizationByImsOrgID: (imsOrgId) => getOrganizationByImsOrgID(
+    dynamoClient,
+    config,
+    imsOrgId,
+  ),
   addOrganization: (organizationData) => addOrganization(
     dynamoClient,
     config,