@adobe/spacecat-shared-data-access 1.61.18 → 2.0.0

package/src/service/organizations/accessPatterns.js

@@ -1,160 +0,0 @@
-/*
- * 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';
-import { removeSitesForOrganization } from '../sites/accessPatterns.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;
-};
-
-/**
- * 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.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @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 log.
- * @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 log.
- * @param {string} organizationId - The ID of the organization to remove.
- * @returns {Promise<void>}
- */
-export const removeOrganization = async (
-  dynamoClient,
-  config,
-  log,
-  organizationId,
-) => {
-  try {
-    await removeSitesForOrganization(dynamoClient, config, log, organizationId);
-
-    await dynamoClient.removeItem(config.tableNameOrganizations, { id: organizationId });
-  } catch (error) {
-    log.error(`Error removing organization: ${error.message}`);
-    throw error;
-  }
-};

package/src/service/organizations/index.js

@@ -1,51 +0,0 @@
-/*
- * 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,
-  getOrganizationByImsOrgID,
-} from './accessPatterns.js';
-
-export const organizationFunctions = (dynamoClient, config, log) => ({
-  getOrganizations: () => getOrganizations(dynamoClient, config),
-  getOrganizationByID: (organizationId) => getOrganizationByID(
-    dynamoClient,
-    config,
-    organizationId,
-  ),
-  getOrganizationByImsOrgID: (imsOrgId) => getOrganizationByImsOrgID(
-    dynamoClient,
-    config,
-    imsOrgId,
-  ),
-  addOrganization: (organizationData) => addOrganization(
-    dynamoClient,
-    config,
-    log,
-    organizationData,
-  ),
-  updateOrganization: (organizationData) => updateOrganization(
-    dynamoClient,
-    config,
-    log,
-    organizationData,
-  ),
-  removeOrganization: (organizationId) => removeOrganization(
-    dynamoClient,
-    config,
-    log,
-    organizationId,
-  ),
-});

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

@@ -1,112 +0,0 @@
-/*
- * 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 { 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.tableNameSiteCandidates,
-  });
-
-  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.
- * @param {DataAccessConfig} config - The data access config.
- * @param {string} baseURL - base url of the site candidate.
- * @return {Promise<Readonly<Boolean>>} A promise that resolves to true if site candidate exist
- */
-export const exists = async (dynamoClient, config, baseURL) => {
-  const dynamoItem = await dynamoClient.getItem(config.tableNameSiteCandidates, { 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.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the log object
- * @param {object} siteCandidateData - The site candidate data.
- * @returns {Promise<Readonly<SiteCandidate>>} newly created site candidate if hadn't created before
- */
-export const upsertSiteCandidate = async (
-  dynamoClient,
-  config,
-  log,
-  siteCandidateData,
-) => {
-  const siteCandidate = createSiteCandidate(siteCandidateData);
-  const siteCandidateExists = await exists(dynamoClient, config, siteCandidate.getBaseURL());
-
-  if (siteCandidateExists) {
-    log.info(`Ignoring the site candidate with base url ${siteCandidate.getBaseURL()} because it already exists`);
-    return siteCandidate;
-  }
-
-  await dynamoClient.putItem(
-    config.tableNameSiteCandidates,
-    SiteCandidateDto.toDynamoItem(siteCandidate),
-  );
-
-  return siteCandidate;
-};
-
-/**
- * Updates a site candidate.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {SiteCandidate} siteCandidate - The site candidate object to be updated.
- * @returns {Promise<Readonly<Site>>} - The updated site candidate.
- */
-export const updateSiteCandidate = async (
-  dynamoClient,
-  config,
-  siteCandidate,
-) => {
-  const siteCandidateExists = await exists(dynamoClient, config, siteCandidate.getBaseURL());
-
-  if (!siteCandidateExists) {
-    throw new Error(`Site candidate with base url ${siteCandidate.getBaseURL()} does not exist`);
-  }
-
-  await dynamoClient.putItem(
-    config.tableNameSiteCandidates,
-    SiteCandidateDto.toDynamoItem(siteCandidate),
-  );
-
-  return siteCandidate;
-};

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

@@ -1,48 +0,0 @@
-/*
- * 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 {
-  getSiteCandidates,
-  getSiteCandidateByBaseURL,
-  upsertSiteCandidate,
-  exists,
-  updateSiteCandidate,
-} from './accessPatterns.js';
-
-export const siteCandidateFunctions = (dynamoClient, config, log) => ({
-  getSiteCandidates: () => getSiteCandidates(
-    dynamoClient,
-    config,
-  ),
-  getSiteCandidateByBaseURL: (baseURL) => getSiteCandidateByBaseURL(
-    dynamoClient,
-    config,
-    log,
-    baseURL,
-  ),
-  upsertSiteCandidate: (siteCandidateData) => upsertSiteCandidate(
-    dynamoClient,
-    config,
-    log,
-    siteCandidateData,
-  ),
-  siteCandidateExists: (baseUrl) => exists(
-    dynamoClient,
-    config,
-    baseUrl,
-  ),
-  updateSiteCandidate: (siteCandidateData) => updateSiteCandidate(
-    dynamoClient,
-    config,
-    siteCandidateData,
-  ),
-});

package/src/service/site-top-pages/accessPatterns.js

@@ -1,83 +0,0 @@
-/*
- * 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 } from '@adobe/spacecat-shared-utils';
-
-import { createSiteTopPage } from '../../models/site-top-page.js';
-import { padWithZeros, SiteTopPageDto } from '../../dto/site-top-page.js';
-
-export const getTopPagesForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  source,
-  geo,
-) => {
-  const queryParams = {
-    TableName: config.tableNameSiteTopPages,
-    KeyConditionExpression: 'siteId = :siteId',
-    ExpressionAttributeValues: { ':siteId': siteId },
-    ScanIndexForward: false,
-  };
-
-  if (hasText(source)) {
-    if (hasText(geo)) {
-      queryParams.KeyConditionExpression += ' AND begins_with(SK, :sourceGeo)';
-      queryParams.ExpressionAttributeValues[':sourceGeo'] = `${source}#${geo}#`;
-    } else {
-      queryParams.KeyConditionExpression += ' AND begins_with(SK, :source)';
-      queryParams.ExpressionAttributeValues[':source'] = `${source}#`;
-    }
-  }
-
-  const dynamoItems = await dynamoClient.query(queryParams);
-
-  return dynamoItems.map((item) => SiteTopPageDto.fromDynamoItem(item));
-};
-
-export const addSiteTopPage = async (
-  dynamoClient,
-  config,
-  log,
-  siteTopPageData,
-) => {
-  const newSiteTopPage = createSiteTopPage(siteTopPageData);
-
-  await dynamoClient.putItem(
-    config.tableNameSiteTopPages,
-    SiteTopPageDto.toDynamoItem(newSiteTopPage),
-  );
-
-  return newSiteTopPage;
-};
-
-export const removeSiteTopPages = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  source,
-  geo,
-) => {
-  const siteTopPages = await getTopPagesForSite(dynamoClient, config, log, siteId, source, geo);
-
-  const removePromises = siteTopPages.map((siteTopPage) => dynamoClient.removeItem(
-    config.tableNameSiteTopPages,
-    {
-      siteId: siteTopPage.getSiteId(),
-      SK: `${siteTopPage.getSource()}#${siteTopPage.getGeo()}#${padWithZeros(siteTopPage.getTraffic())}`,
-    },
-  ));
-
-  await Promise.all(removePromises);
-};

package/src/service/site-top-pages/index.js

@@ -1,42 +0,0 @@
-/*
- * 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 {
-  addSiteTopPage,
-  getTopPagesForSite,
-  removeSiteTopPages,
-} from './accessPatterns.js';
-
-export const siteTopPagesFunctions = (dynamoClient, config, log) => ({
-  getTopPagesForSite: (siteId, source, geo) => getTopPagesForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    source,
-    geo,
-  ),
-  addSiteTopPage: (siteTopPageData) => addSiteTopPage(
-    dynamoClient,
-    config,
-    log,
-    siteTopPageData,
-  ),
-  removeSiteTopPages: (siteId, source, geo) => removeSiteTopPages(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    source,
-    geo,
-  ),
-});