@adobe/spacecat-shared-data-access 1.7.0 → 1.9.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.9.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.8.0...@adobe/spacecat-shared-data-access-v1.9.0) (2024-01-18)
+
+
+### Features
+
+* data model for organizations ([944be83](https://github.com/adobe/spacecat-shared/commit/944be83c9f19e3acee9bb17352b3058fe6578a69))
+
+# [@adobe/spacecat-shared-data-access-v1.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.7.0...@adobe/spacecat-shared-data-access-v1.8.0) (2024-01-18)
+
+
+### Features
+
+* add broken-backlinks audit type (SITES-18417) ([#86](https://github.com/adobe/spacecat-shared/issues/86)) ([b16c366](https://github.com/adobe/spacecat-shared/commit/b16c3667808221958ff4a526512cb89c3cd0bbcb))
+
 # [@adobe/spacecat-shared-data-access-v1.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.6.4...@adobe/spacecat-shared-data-access-v1.7.0) (2024-01-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",
@@ -33,6 +33,8 @@
     "@adobe/spacecat-shared-utils": "1.2.0",
     "@aws-sdk/client-dynamodb": "3.490.0",
     "@aws-sdk/lib-dynamodb": "3.490.0",
+    "@types/joi": "17.2.3",
+    "joi": "17.11.0",
     "uuid": "9.0.1"
   },
   "devDependencies": {

package/src/dto/organization.js

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { Config } from '../models/site/config.js';
+import { createOrganization } from '../models/organization.js';
+
+/**
+ * Data transfer object for Organization.
+ */
+export const OrganizationDto = {
+  /**
+     * Converts an Organization object into a DynamoDB item.
+     * @param {Readonly<Organization>} organization - Organization object.
+     * @returns {{createdAt, baseURL, GSI1PK: string, id, imsOrgId, updatedAt}}
+     */
+  toDynamoItem: (organization) => ({
+    id: organization.getId(),
+    name: organization.getName(),
+    imsOrgId: organization.getImsOrgId(),
+    createdAt: organization.getCreatedAt(),
+    updatedAt: organization.getUpdatedAt(),
+    GSI1PK: 'ALL_ORGANIZATIONS',
+    config: Config.toDynamoItem(organization.getConfig()),
+  }),
+
+  /**
+     * Converts a DynamoDB item into a Organization object.
+     * @param {object } dynamoItem - DynamoDB item.
+     * @returns {Readonly<Organization>} Organization object.
+     */
+  fromDynamoItem: (dynamoItem) => {
+    const organizationData = {
+      id: dynamoItem.id,
+      name: dynamoItem.name,
+      imsOrgId: dynamoItem.imsOrgId,
+      createdAt: dynamoItem.createdAt,
+      updatedAt: dynamoItem.updatedAt,
+      config: dynamoItem.config,
+    };
+
+    return createOrganization(organizationData);
+  },
+};

package/src/dto/site.js

@@ -12,6 +12,7 @@
 
 import { createSite } from '../models/site.js';
 import AuditConfig from '../models/site/audit-config.js';
+import { Config } from '../models/site/config.js';
 
 /**
  * Data transfer object for Site.
@@ -20,20 +21,21 @@ export const SiteDto = {
   /**
    * Converts a Site object into a DynamoDB item.
    * @param {Readonly<Site>} site - Site object.
-   * @returns {{createdAt, baseURL, GSI1PK: string, id, imsOrgId, updatedAt}}
+   * @returns {{createdAt, baseURL, GSI1PK: string, id, organizationId, updatedAt}}
    */
   toDynamoItem: (site) => ({
     id: site.getId(),
     baseURL: site.getBaseURL(),
     deliveryType: site.getDeliveryType(),
     gitHubURL: site.getGitHubURL() || '',
-    imsOrgId: site.getImsOrgId() || '',
+    organizationId: site.getOrganizationId() || '',
     isLive: site.isLive(),
     isLiveToggledAt: site.getIsLiveToggledAt(),
     createdAt: site.getCreatedAt(),
     updatedAt: site.getUpdatedAt(),
     GSI1PK: 'ALL_SITES',
     auditConfig: AuditConfig.toDynamoItem(site.getAuditConfig()),
+    config: Config.toDynamoItem(site.getConfig()),
   }),
 
   /**
@@ -47,12 +49,13 @@ export const SiteDto = {
       baseURL: dynamoItem.baseURL,
       deliveryType: dynamoItem.deliveryType,
       gitHubURL: dynamoItem.gitHubURL,
-      imsOrgId: dynamoItem.imsOrgId,
+      organizationId: dynamoItem.organizationId,
       isLive: dynamoItem.isLive,
       isLiveToggledAt: dynamoItem.isLiveToggledAt,
       createdAt: dynamoItem.createdAt,
       updatedAt: dynamoItem.updatedAt,
       auditConfig: dynamoItem.auditConfig,
+      config: dynamoItem.config,
     };
 
     return createSite(siteData);

package/src/index.d.ts

@@ -96,6 +96,10 @@ export interface AuditConfigType {
   disabled: () => boolean;
 }
 
+export interface Config {
+
+}
+
 /**
  * AuditConfig defines the structure for the overall audit configuration of a site.
  */
@@ -150,10 +154,10 @@ export interface Site {
   getGitHubURL: () => string;
 
   /**
-   * Retrieves the IMS Organization ID associated with the site.
-   * @returns {string} The IMS Org ID.
+   * Retrieves the Organization ID associated with the site.
+   * @returns {string} The Org ID.
    */
-  getImsOrgId: () => string;
+  getOrganizationId: () => string;
 
   /**
    * Retrieves the creation timestamp of the site.
@@ -173,6 +177,12 @@ export interface Site {
    */
   getAuditConfig: () => AuditConfig;
 
+  /**
+   * Retrieves the current configuration for the site.
+   * @returns {Config} The current configuration.
+   */
+  getConfig: () => Config;
+
   /**
    * Retrieves the audits associated with the site.
    * @returns {Audit[]} The list of audits.
@@ -213,10 +223,48 @@ export interface Site {
 
   /**
    * Updates the IMS Org ID of the site.
-   * @param {string} imsOrgId The new IMS Org ID.
+   * @param {string} organizationId The new Org ID.
    * @returns {Site} The updated site instance.
    */
-  updateImsOrgId: (imsOrgId: string) => Site;
+  updateOrganizationId: (organizationId: string) => Site;
+}
+
+export interface Organization {
+  /**
+   * Retrieves the ID of the site.
+   * @returns {string} The site ID.
+   */
+  getId: () => string;
+
+  /**
+   * Retrieves the base URL of the site.
+   * @returns {string} The base URL.
+   */
+  getName: () => string;
+
+  /**
+   * Retrieves the IMS Organization ID associated with the site.
+   * @returns {string} The IMS Org ID.
+   */
+  getImsOrgId: () => string;
+
+  /**
+   * Retrieves the creation timestamp of the site.
+   * @returns {string} The creation timestamp.
+   */
+  getCreatedAt: () => string;
+
+  /**
+   * Retrieves the last update timestamp of the site.
+   * @returns {string} The last update timestamp.
+   */
+  getUpdatedAt: () => string;
+
+  /**
+   * Retrieves the current audit configuration for the site.
+   * @returns {Config} The current audit configuration.
+   */
+  getConfig: () => Config;
 }
 
 export interface DataAccess {
@@ -257,6 +305,9 @@ export interface DataAccess {
     sortAuditsAscending?: boolean,
     deliveryType?: string,
   ) => Promise<Site[]>;
+  getSitesByOrganizationID: (
+      organizationId: string,
+  ) => Promise<Organization[]>
   getSiteByBaseURL: (
     baseUrl: string,
   ) => Promise<Site | null>;
@@ -285,17 +336,35 @@ export interface DataAccess {
   removeSite: (
     siteId: string,
   ) => Promise<void>;
+  getOrganizations:
+      () => Promise<Organization[]>;
+  getOrganizationByID: (
+      organizationID: string,
+  ) => Promise<Organization | null>;
+  addOrganization: (
+      organizationData: object,
+  ) => Promise<Organization>;
+  updateOrganization: (
+      organization: Organization,
+  ) => Promise<Organization>;
+  removeRemoveOrganization: (
+      organizationId: string,
+  ) => Promise<void>;
 }
 
 interface DataAccessConfig {
   tableNameAudits: string;
   tableNameLatestAudits: string;
+  tableNameOrganizations: string,
   tableNameSites: string;
   indexNameAllSites: string;
+  indexNameAllSitesOrganizations: string,
   indexNameAllSitesByDeliveryType: string;
   indexNameAllLatestAuditScores: string;
+  indexNameAllOrganizations: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
+  pkAllOrganizations: string;
 }
 
 export function createDataAccess(

package/src/index.js

@@ -15,12 +15,16 @@ import { createDataAccess } from './service/index.js';
 const TABLE_NAME_AUDITS = 'spacecat-services-audits-dev';
 const TABLE_NAME_LATEST_AUDITS = 'spacecat-services-latest-audits-dev';
 const TABLE_NAME_SITES = 'spacecat-services-sites-dev';
+const TABLE_NAME_ORGANIZATIONS = 'spacecat-services-organizations-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_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';
 
 const PK_ALL_SITES = 'ALL_SITES';
+const PK_ALL_ORGANIZATIONS = 'ALL_ORGANIZATIONS';
 const PK_ALL_LATEST_AUDITS = 'ALL_LATEST_AUDITS';
 
 export default function dataAccessWrapper(fn) {
@@ -32,19 +36,26 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_TABLE_NAME_AUDITS = TABLE_NAME_AUDITS,
         DYNAMO_TABLE_NAME_LATEST_AUDITS = TABLE_NAME_LATEST_AUDITS,
         DYNAMO_TABLE_NAME_SITES = TABLE_NAME_SITES,
+        DYNAMO_TABLE_NAME_ORGANIZATIONS = TABLE_NAME_ORGANIZATIONS,
         DYNAMO_INDEX_NAME_ALL_SITES = INDEX_NAME_ALL_SITES,
         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,
+        DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS = INDEX_NAME_ALL_SITES_ORGANIZATIONS,
       } = context.env;
 
       context.dataAccess = createDataAccess({
         tableNameAudits: DYNAMO_TABLE_NAME_AUDITS,
         tableNameLatestAudits: DYNAMO_TABLE_NAME_LATEST_AUDITS,
+        tableNameOrganizations: DYNAMO_TABLE_NAME_ORGANIZATIONS,
         tableNameSites: DYNAMO_TABLE_NAME_SITES,
         indexNameAllSites: DYNAMO_INDEX_NAME_ALL_SITES,
+        indexNameOrganizations: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS,
         indexNameAllSitesByDeliveryType: DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
         indexNameAllLatestAuditScores: DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
+        indexNameAllSitesOrganizations: DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS,
         pkAllSites: PK_ALL_SITES,
+        pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,
       }, log);
     }

package/src/models/audit.js

@@ -13,6 +13,7 @@
 import { hasText, isIsoDate, isObject } from '@adobe/spacecat-shared-utils';
 import { Base } from './base.js';
 
+export const AUDIT_TYPE_BROKEN_BACKLINKS = 'broken-backlinks';
 export const AUDIT_TYPE_CWV = 'cwv';
 export const AUDIT_TYPE_LHS_DESKTOP = 'lhs-desktop';
 export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
@@ -20,6 +21,7 @@ export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
 const EXPIRES_IN_DAYS = 30;
 
 const AUDIT_TYPE_PROPERTIES = {
+  [AUDIT_TYPE_BROKEN_BACKLINKS]: [],
   [AUDIT_TYPE_CWV]: [],
   [AUDIT_TYPE_LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
   [AUDIT_TYPE_LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],
@@ -36,7 +38,7 @@ const validateScores = (auditResult, auditType) => {
     return true;
   }
 
-  if (!isObject(auditResult.scores)) {
+  if (auditType !== AUDIT_TYPE_BROKEN_BACKLINKS && !isObject(auditResult.scores)) {
     throw new Error(`Missing scores property for audit type '${auditType}'`);
   }
 

package/src/models/organization.js

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { hasText, isObject } from '@adobe/spacecat-shared-utils';
+
+import { Base } from './base.js';
+import { Config, DEFAULT_CONFIG } from './site/config.js';
+
+/**
+ * Creates a new Organization.
+ *
+ * @param {object} data - organization data
+ * @returns {Readonly<Organization>} organization - new organization
+ */
+const Organization = (data = {}) => {
+  const self = Base(data);
+
+  self.getConfig = () => self.state.config;
+  self.getName = () => self.state.name;
+  self.getImsOrgId = () => self.state.imsOrgId;
+
+  /**
+     * Updates the IMS Org ID belonging to the organization.
+     * @param {string} imsOrgId - The IMS Org ID.
+     * @return {Base} The updated organization.
+     */
+  self.updateImsOrgId = (imsOrgId) => {
+    if (!hasText(imsOrgId)) {
+      throw new Error('IMS Org ID must be provided');
+    }
+
+    self.state.imsOrgId = imsOrgId;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+ * Updates the organization name.
+ * @param {string} name - The name of the organization.
+ * @return {Base} The updated organization.
+ */
+  self.updateName = (name) => {
+    if (!hasText(name)) {
+      throw new Error('Org name must be provided');
+    }
+
+    self.state.name = name;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+ * Updates the organization config.
+ * @param {string} config - The Org config.
+ * @return {Base} The updated organization.
+ */
+  self.updateConfig = (config) => {
+    if (!isObject(config)) {
+      throw new Error('Config must be provided');
+    }
+
+    self.state.config = Config.toDynamoItem(config);
+    self.touch();
+
+    return self;
+  };
+  return Object.freeze(self);
+};
+
+/**
+ * Creates a new Organization.
+ *
+ * @param {object} data - organization data
+ * @returns {Readonly<Organization>} organization - new organization
+ */
+export const createOrganization = (data) => {
+  const newState = { ...data };
+
+  if (!isObject(newState.config)) {
+    newState.config = { ...DEFAULT_CONFIG };
+  }
+  if (!hasText(newState.name)) {
+    throw new Error('Org name must be provided');
+  }
+
+  newState.config = Config(newState.config);
+
+  return Organization(newState);
+};

package/src/models/site/config.js

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import Joi from 'joi';
+
+export const configSchema = Joi.object({
+  slack: Joi.object({
+    workspace: Joi.string(),
+    channel: Joi.string(),
+  }),
+  alerts: Joi.array().items(Joi.object({
+    type: Joi.string(),
+    byOrg: Joi.boolean(),
+    mentions: Joi.array().items(Joi.object({ slack: Joi.array().items(Joi.string()) })),
+  })),
+});
+
+export const DEFAULT_CONFIG = {
+  slack: {
+  },
+  alerts: [],
+};
+
+// Function to validate incoming configuration
+function validateConfiguration(config) {
+  const { error, value } = configSchema.validate(config);
+
+  if (error) {
+    throw new Error(`Configuration validation error: ${error.message}`);
+  }
+
+  return value; // Validated and sanitized configuration
+}
+
+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 self = {
+    alerts: state.alerts,
+    slack: state.slack,
+  };
+
+  return Object.freeze(self);
+};
+
+Config.fromDynamoItem = (dynamoItem) => Config(dynamoItem);
+
+Config.toDynamoItem = (config) => validateConfiguration(config);

package/src/models/site.js

@@ -10,10 +10,11 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+import { isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
 
 import { Base } from './base.js';
 import AuditConfig from './site/audit-config.js';
+import { Config, DEFAULT_CONFIG } from './site/config.js';
 
 export const DELIVERY_TYPES = {
   AEM_CS: 'aem_cs',
@@ -35,9 +36,10 @@ const Site = (data = {}) => {
   self.getAuditConfig = () => self.state.auditConfig;
   self.getAudits = () => self.state.audits;
   self.getBaseURL = () => self.state.baseURL;
+  self.getConfig = () => self.state.config;
   self.getDeliveryType = () => self.state.deliveryType;
   self.getGitHubURL = () => self.state.gitHubURL;
-  self.getImsOrgId = () => self.state.imsOrgId;
+  self.getOrganizationId = () => self.state.organizationId;
   self.isLive = () => self.state.isLive;
   self.getIsLiveToggledAt = () => self.state.isLiveToggledAt;
 
@@ -118,16 +120,12 @@ const Site = (data = {}) => {
   };
 
   /**
-   * Updates the IMS Org ID belonging to the site.
-   * @param {string} imsOrgId - The IMS Org ID.
+   * Updates the organizationId the site belongs to.
+   * @param {string} organizationId - The Org ID.
    * @return {Base} The updated site.
    */
-  self.updateImsOrgId = (imsOrgId) => {
-    if (!hasText(imsOrgId)) {
-      throw new Error('IMS Org ID must be provided');
-    }
-
-    self.state.imsOrgId = imsOrgId;
+  self.updateOrganizationId = (organizationId) => {
+    self.state.organizationId = organizationId;
     self.touch();
 
     return self;
@@ -186,5 +184,11 @@ export const createSite = (data) => {
 
   newState.auditConfig = AuditConfig(newState.auditConfig);
 
+  if (!isObject(newState.config)) {
+    newState.config = { ...DEFAULT_CONFIG };
+  }
+
+  newState.config = Config(newState.config);
+
   return Site(newState);
 };

package/src/service/index.js

@@ -13,11 +13,15 @@
 import { createClient } from '@adobe/spacecat-shared-dynamo';
 import { auditFunctions } from './audits/index.js';
 import { siteFunctions } from './sites/index.js';
+import { organizationFunctions } from './organizations/index.js';
 
 /**
  * Creates a data access object.
  *
- * @param {DataAccessConfig} config configuration
+ * @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
  * @param {Logger} log logger
  * @returns {object} data access object
  */
@@ -26,9 +30,11 @@ export const createDataAccess = (config, log = console) => {
 
   const auditFuncs = auditFunctions(dynamoClient, config, log);
   const siteFuncs = siteFunctions(dynamoClient, config, log);
+  const organizationFuncs = organizationFunctions(dynamoClient, config, log);
 
   return {
     ...auditFuncs,
     ...siteFuncs,
+    ...organizationFuncs,
   };
 };

package/src/service/organizations/accessPatterns.js

@@ -0,0 +1,131 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { isObject } from '@adobe/spacecat-shared-utils';
+
+import { createOrganization } from '../../models/organization.js';
+import { OrganizationDto } from '../../dto/organization.js';
+
+/**
+ * Retrieves all organizations.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @returns {Promise<Readonly<Organization>[]>} A promise that resolves to an array of all
+ * organizations.
+ */
+export const getOrganizations = async (dynamoClient, config) => {
+  const dynamoItems = await dynamoClient.query({
+    TableName: config.tableNameOrganizations,
+    IndexName: config.indexNameAllOrganizations,
+    KeyConditionExpression: 'GSI1PK = :gsi1pk',
+    ExpressionAttributeValues: {
+      ':gsi1pk': config.pkAllOrganizations,
+    },
+  });
+
+  return dynamoItems.map((dynamoItem) => OrganizationDto.fromDynamoItem(dynamoItem));
+};
+
+export const getOrganizationByID = async (
+  dynamoClient,
+  config,
+  organizationId,
+) => {
+  const dynamoItem = await dynamoClient.getItem(
+    config.tableNameOrganizations,
+    { id: organizationId },
+  );
+
+  return isObject(dynamoItem) ? OrganizationDto.fromDynamoItem(dynamoItem) : null;
+};
+
+/**
+ * Adds an organization.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {object} organizationData - The organization data.
+ * @returns {Promise<Readonly<Organization>>}
+ */
+export const addOrganization = async (
+  dynamoClient,
+  config,
+  log,
+  organizationData,
+) => {
+  const organization = createOrganization(organizationData);
+
+  await dynamoClient.putItem(
+    config.tableNameOrganizations,
+    OrganizationDto.toDynamoItem(organization),
+  );
+
+  return organization;
+};
+
+/**
+ * Updates an organization.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {Organization} organization - The organization.
+ * @returns {Promise<Readonly<Organization>>} - The updated organization.
+ */
+export const updateOrganization = async (
+  dynamoClient,
+  config,
+  log,
+  organization,
+) => {
+  const existingOrganization = await getOrganizationByID(
+    dynamoClient,
+    config,
+    organization.getId(),
+  );
+
+  if (!isObject(existingOrganization)) {
+    throw new Error('Organization not found');
+  }
+
+  await dynamoClient.putItem(
+    config.tableNameOrganizations,
+    OrganizationDto.toDynamoItem(organization),
+  );
+
+  return organization;
+};
+
+/**
+ * Removes an organization.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {string} organizationId - The ID of the organization to remove.
+ * @returns {Promise<void>}
+ */
+export const removeOrganization = async (
+  dynamoClient,
+  config,
+  log,
+  organizationId,
+) => {
+  try {
+    await dynamoClient.removeItem(config.tableNameOrganizations, { id: organizationId });
+  } catch (error) {
+    log.error(`Error removing organization: ${error.message}`);
+    throw error;
+  }
+};

package/src/service/organizations/index.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import {
+  getOrganizations,
+  getOrganizationByID,
+  addOrganization,
+  updateOrganization,
+  removeOrganization,
+} from './accessPatterns.js';
+
+export const organizationFunctions = (dynamoClient, config, log) => ({
+  getOrganizations: () => getOrganizations(dynamoClient, config),
+  getOrganizationByID: (organizationId) => getOrganizationByID(
+    dynamoClient,
+    config,
+    organizationId,
+  ),
+  addOrganization: (organizationData) => addOrganization(
+    dynamoClient,
+    config,
+    log,
+    organizationData,
+  ),
+  updateOrganization: (organizationData) => updateOrganization(
+    dynamoClient,
+    config,
+    log,
+    organizationData,
+  ),
+  removeOrganization: (organizationId) => removeOrganization(
+    dynamoClient,
+    config,
+    log,
+    organizationId,
+  ),
+});

package/src/service/sites/accessPatterns.js

@@ -247,6 +247,24 @@ export const getSiteByBaseURLWithLatestAudit = async (
   auditType,
 ) => getSiteByBaseURLWithAuditInfo(dynamoClient, config, log, baseUrl, auditType, true);
 
+export const getSitesByOrganizationID = async (
+  dynamoClient,
+  config,
+  organizationId,
+) => {
+  const dynamoItems = await dynamoClient.query({
+    TableName: config.tableNameSites,
+    IndexName: config.indexNameAllSitesOrganizations,
+    KeyConditionExpression: 'organizationId = :organizationId',
+    ExpressionAttributeValues: {
+      ':organizationId': organizationId,
+    },
+    Limit: 1,
+  });
+
+  return dynamoItems.map((dynamoItem) => SiteDto.fromDynamoItem(dynamoItem));
+};
+
 /**
  * Retrieves a site by its ID.
  *

package/src/service/sites/index.js

@@ -17,7 +17,7 @@ import {
   getSiteByBaseURLWithAudits,
   getSiteByBaseURLWithLatestAudit,
   getSiteByID,
-  getSites, getSitesByDeliveryType,
+  getSites, getSitesByDeliveryType, getSitesByOrganizationID,
   getSitesToAudit,
   getSitesWithLatestAudit, removeSite,
   updateSite,
@@ -33,6 +33,11 @@ export const siteFunctions = (dynamoClient, config, log) => ({
     config,
     deliveryType,
   ),
+  getSitesByOrganizationID: (organizationId) => getSitesByOrganizationID(
+    dynamoClient,
+    config,
+    organizationId,
+  ),
   getSitesToAudit: () => getSitesToAudit(
     dynamoClient,
     config,