@adobe/spacecat-shared-data-access 1.61.19 → 2.0.1

package/src/index.js

@@ -12,40 +12,9 @@
 
 import { createDataAccess } from './service/index.js';
 
-export { ImportJobStatus, ImportUrlStatus, ImportOptions } from './models/importer/import-constants.js';
+export * from './service/index.js';
 
 const TABLE_NAME_DATA = 'spacecat-services-data-dev';
-const TABLE_NAME_AUDITS = 'spacecat-services-audits-dev';
-const TABLE_NAME_KEY_EVENTS = 'spacecat-services-key-events';
-const TABLE_NAME_LATEST_AUDITS = 'spacecat-services-latest-audits-dev';
-const TABLE_NAME_SITES = 'spacecat-services-sites-dev';
-const TABLE_NAME_SITE_CANDIDATES = 'spacecat-services-site-candidates-dev';
-const TABLE_NAME_ORGANIZATIONS = 'spacecat-services-organizations-dev';
-const TABLE_NAME_CONFIGURATIONS = 'spacecat-services-configurations-dev';
-const TABLE_NAME_SITE_TOP_PAGES = 'spacecat-services-site-top-pages-dev';
-const TABLE_NAME_IMPORT_JOBS = 'spacecat-services-import-jobs-dev';
-const TABLE_NAME_IMPORT_URLS = 'spacecat-services-import-urls-dev';
-const TABLE_NAME_EXPERIMENTS = 'spacecat-services-experiments-dev';
-const TABLE_NAME_API_KEYS = 'spacecat-services-api-keys-dev';
-
-const INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID = 'spacecat-services-key-events-by-site-id';
-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';
-const INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = 'spacecat-services-all-import-jobs-by-status-dev';
-const INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = 'spacecat-services-all-import-jobs-by-date-range-dev';
-const INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS = 'spacecat-services-all-import-urls-by-job-id-and-status-dev';
-const INDEX_NAME_API_KEY_BY_HASHED_API_KEY = 'spacecat-services-api-key-by-hashed-api-key-dev';
-const INDEX_NAME_API_KEY_BY_IMS_USER_ID_AND_IMS_ORG_ID = 'spacecat-services-api-key-by-ims-user-id-and-ims-org-id-dev';
-
-const PK_ALL_SITES = 'ALL_SITES';
-const PK_ALL_CONFIGURATIONS = 'ALL_CONFIGURATIONS';
-const PK_ALL_ORGANIZATIONS = 'ALL_ORGANIZATIONS';
-const PK_ALL_LATEST_AUDITS = 'ALL_LATEST_AUDITS';
-const PK_ALL_IMPORT_JOBS = 'ALL_IMPORT_JOBS';
 
 export default function dataAccessWrapper(fn) {
   return async (request, context) => {
@@ -54,72 +23,13 @@ export default function dataAccessWrapper(fn) {
 
       const {
         DYNAMO_TABLE_NAME_DATA = TABLE_NAME_DATA,
-        DYNAMO_TABLE_NAME_AUDITS = TABLE_NAME_AUDITS,
-        DYNAMO_TABLE_NAME_KEY_EVENTS = TABLE_NAME_KEY_EVENTS,
-        DYNAMO_TABLE_NAME_LATEST_AUDITS = TABLE_NAME_LATEST_AUDITS,
-        DYNAMO_TABLE_NAME_SITES = TABLE_NAME_SITES,
-        DYNAMO_TABLE_NAME_SITE_CANDIDATES = TABLE_NAME_SITE_CANDIDATES,
-        DYNAMO_TABLE_NAME_ORGANIZATIONS = TABLE_NAME_ORGANIZATIONS,
-        DYNAMO_TABLE_NAME_CONFIGURATIONS = TABLE_NAME_CONFIGURATIONS,
-        DYNAMO_TABLE_NAME_SITE_TOP_PAGES = TABLE_NAME_SITE_TOP_PAGES,
-        DYNAMO_TABLE_NAME_IMPORT_JOBS = TABLE_NAME_IMPORT_JOBS,
-        DYNAMO_TABLE_NAME_IMPORT_URLS = TABLE_NAME_IMPORT_URLS,
-        DYNAMO_TABLE_NAME_EXPERIMENTS = TABLE_NAME_EXPERIMENTS,
-        DYNAMO_TABLE_NAME_API_KEYS = TABLE_NAME_API_KEYS,
-        DYNAMO_INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID = INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID,
-        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,
-        // 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,
-        DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
-        DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
-        DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS =
-        INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
-        DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_API_KEY = INDEX_NAME_API_KEY_BY_HASHED_API_KEY,
-        DYNAMO_INDEX_NAME_API_KEY_BY_IMS_USER_ID_AND_IMS_ORG_ID =
-        INDEX_NAME_API_KEY_BY_IMS_USER_ID_AND_IMS_ORG_ID,
       } = context.env;
 
       context.dataAccess = createDataAccess({
         tableNameData: DYNAMO_TABLE_NAME_DATA,
-        tableNameAudits: DYNAMO_TABLE_NAME_AUDITS,
-        tableNameKeyEvents: DYNAMO_TABLE_NAME_KEY_EVENTS,
-        tableNameLatestAudits: DYNAMO_TABLE_NAME_LATEST_AUDITS,
-        tableNameOrganizations: DYNAMO_TABLE_NAME_ORGANIZATIONS,
-        tableNameSites: DYNAMO_TABLE_NAME_SITES,
-        tableNameSiteCandidates: DYNAMO_TABLE_NAME_SITE_CANDIDATES,
-        tableNameConfigurations: DYNAMO_TABLE_NAME_CONFIGURATIONS,
-        tableNameSiteTopPages: DYNAMO_TABLE_NAME_SITE_TOP_PAGES,
-        tableNameImportJobs: DYNAMO_TABLE_NAME_IMPORT_JOBS,
-        tableNameImportUrls: DYNAMO_TABLE_NAME_IMPORT_URLS,
-        tableNameExperiments: DYNAMO_TABLE_NAME_EXPERIMENTS,
-        tableNameApiKeys: DYNAMO_TABLE_NAME_API_KEYS,
-        indexNameAllKeyEventsBySiteId: DYNAMO_INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID,
-        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,
-        indexNameAllImportJobsByStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
-        indexNameAllImportJobsByDateRange: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
-        indexNameImportUrlsByJobIdAndStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
-        indexNameApiKeyByHashedApiKey: DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_API_KEY,
-        indexNameApiKeyByImsUserIdAndImsOrgId:
-        DYNAMO_INDEX_NAME_API_KEY_BY_IMS_USER_ID_AND_IMS_ORG_ID,
-        pkAllSites: PK_ALL_SITES,
-        pkAllOrganizations: PK_ALL_ORGANIZATIONS,
-        pkAllLatestAudits: PK_ALL_LATEST_AUDITS,
-        pkAllConfigurations: PK_ALL_CONFIGURATIONS,
-        pkAllImportJobs: PK_ALL_IMPORT_JOBS,
       }, log);
     }
 
     return fn(request, context);
   };
 }
-
-export * from './v2/index.js';

package/src/{v2 → models}/index.d.ts

@@ -10,6 +10,17 @@
  * governing permissions and limitations under the License.
  */
 
-export type * from './errors/index.d.ts';
-export type * from './models/index.d.ts';
-export type * from './util/index.d.ts';
+export type * from './audit';
+export type * from './configuration';
+export type * from './base';
+export type * from './experiment';
+export type * from './import-job';
+export type * from './import-url';
+export type * from './key-event';
+export type * from './latest-audit';
+export type * from './opportunity';
+export type * from './organization';
+export type * from './site';
+export type * from './site-candidate';
+export type * from './site-top-page';
+export type * from './suggestion';

package/src/{v2/models → models}/organization/organization.schema.js

@@ -14,7 +14,7 @@
 
 import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
-import { Config, DEFAULT_CONFIG, validateConfiguration } from '../../../models/site/config.js';
+import { Config, DEFAULT_CONFIG, validateConfiguration } from '../site/config.js';
 import SchemaBuilder from '../base/schema.builder.js';
 import Organization from './organization.model.js';
 import OrganizationCollection from './organization.collection.js';

package/src/{v2/models → models}/site/site.schema.js

@@ -19,7 +19,7 @@ import {
   isValidUrl,
 } from '@adobe/spacecat-shared-utils';
 
-import { Config, DEFAULT_CONFIG, validateConfiguration } from '../../../models/site/config.js';
+import { Config, DEFAULT_CONFIG, validateConfiguration } from './config.js';
 import SchemaBuilder from '../base/schema.builder.js';
 
 import Site from './site.model.js';

package/src/service/index.d.ts

@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+
+interface DataAccessConfig {
+  tableNameData: string;
+}
+
+export function createDataAccess(
+  config: DataAccessConfig,
+  logger: object,
+): object;

package/src/service/index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Adobe. All rights reserved.
+ * 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
@@ -10,26 +10,16 @@
  * governing permissions and limitations under the License.
  */
 
-import { createClient } from '@adobe/spacecat-shared-dynamo';
 import { DynamoDB } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
-
 import AWSXray from 'aws-xray-sdk';
 import { Service } from 'electrodb';
 
-import EntityRegistry from '../v2/models/base/entity.registry.js';
+import { EntityRegistry } from '../models/index.js';
 
-import { auditFunctions } from './audits/index.js';
-import { keyEventFunctions } from './key-events/index.js';
-import { siteFunctions } from './sites/index.js';
-import { siteCandidateFunctions } from './site-candidates/index.js';
-import { organizationFunctions } from './organizations/index.js';
-import { configurationFunctions } from './configurations/index.js';
-import { siteTopPagesFunctions } from './site-top-pages/index.js';
-import { importJobFunctions } from './import-job/index.js';
-import { importUrlFunctions } from './import-url/index.js';
-import { experimentFunctions } from './experiments/index.js';
-import { apiKeyFunctions } from './api-key/index.js';
+export * from '../errors/index.js';
+export * from '../models/index.js';
+export * from '../util/index.js';
 
 const createRawClient = (client = undefined) => {
   const dbClient = client || AWSXray.captureAWSv3Client(new DynamoDB());
@@ -74,39 +64,9 @@ const createElectroService = (client, config, log) => {
  * @returns {object} data access object
  */
 export const createDataAccess = (config, log = console, client = undefined) => {
-  const dynamoClient = createClient(log, client);
-
-  const auditFuncs = auditFunctions(dynamoClient, config, log);
-  const keyEventFuncs = keyEventFunctions(dynamoClient, config, log);
-  const siteFuncs = siteFunctions(dynamoClient, config, log);
-  const siteCandidateFuncs = siteCandidateFunctions(dynamoClient, config, log);
-  const organizationFuncs = organizationFunctions(dynamoClient, config, log);
-  const configurationFuncs = configurationFunctions(dynamoClient, config);
-  const siteTopPagesFuncs = siteTopPagesFunctions(dynamoClient, config);
-  const importJobFuncs = importJobFunctions(dynamoClient, config, log);
-  const importUrlFuncs = importUrlFunctions(dynamoClient, config, log);
-  const experimentFuncs = experimentFunctions(dynamoClient, config, log);
-  const apiKeyFuncs = apiKeyFunctions(dynamoClient, config, log);
-
-  // electro-based data access objects
   const rawClient = createRawClient(client);
   const electroService = createElectroService(rawClient, config, log);
   const entityRegistry = new EntityRegistry(electroService, log);
-  const collections = entityRegistry.getCollections();
 
-  return {
-    ...auditFuncs,
-    ...keyEventFuncs,
-    ...siteFuncs,
-    ...siteCandidateFuncs,
-    ...organizationFuncs,
-    ...configurationFuncs,
-    ...siteTopPagesFuncs,
-    ...importJobFuncs,
-    ...importUrlFuncs,
-    ...experimentFuncs,
-    ...apiKeyFuncs,
-    // electro-based data access objects
-    ...collections,
-  };
+  return entityRegistry.getCollections();
 };

package/src/dto/api-key.js

@@ -1,58 +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 { createApiKey } from '../models/api-key/api-key.js';
-
-export const ApiKeyDto = {
-
-  /**
-     * Converts an ApiKey object into a DynamoDB item.
-     * @param apiKey
-     * @returns {{createdAt: string, name: string, imsUserId: string,
-     * scopes: array<object>, revokedAt: string, deletedAt: string,
-     * hashedApiKey: string, imsOrgId: string, expiresAt: string}}
-     */
-  toDynamoItem: (apiKey) => ({
-    id: apiKey.getId(),
-    hashedApiKey: apiKey.getHashedApiKey(),
-    name: apiKey.getName(),
-    imsUserId: apiKey.getImsUserId(),
-    imsOrgId: apiKey.getImsOrgId(),
-    createdAt: apiKey.getCreatedAt(),
-    expiresAt: apiKey.getExpiresAt(),
-    revokedAt: apiKey.getRevokedAt(),
-    deletedAt: apiKey.getDeletedAt(),
-    scopes: apiKey.getScopes(),
-  }),
-
-  /**
-     * Converts a DynamoDB item into an ApiKey object.
-     * @param dynamoItem
-     * @returns {ApiKey}
-     */
-  fromDynamoItem: (dynamoItem) => {
-    const apiKeyData = {
-      id: dynamoItem.id,
-      hashedApiKey: dynamoItem.hashedApiKey,
-      name: dynamoItem.name,
-      imsUserId: dynamoItem.imsUserId,
-      imsOrgId: dynamoItem.imsOrgId,
-      createdAt: dynamoItem.createdAt,
-      expiresAt: dynamoItem.expiresAt,
-      revokedAt: dynamoItem.revokedAt,
-      deletedAt: dynamoItem.deletedAt,
-      scopes: dynamoItem.scopes,
-    };
-
-    return createApiKey(apiKeyData);
-  },
-};

package/src/dto/audit.js

@@ -1,80 +0,0 @@
-/*
- * Copyright 2023 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 { createAudit } from '../models/audit.js';
-import { convertDateToEpochSeconds, parseEpochToDate } from './dto-utils.js';
-
-/**
- * Data transfer object for Audit.
- */
-export const AuditDto = {
-  /**
-   * Converts an Audit object into a DynamoDB item.
-   * @param {Readonly<Audit>} audit - Audit object.
-   * @param {boolean} isLatestAudit - If true, returns the latest audit flavor.
-   * @returns {{siteId, auditedAt, auditResult, auditType, expiresAt, fullAuditRef, SK: string}}
-   */
-  toDynamoItem: (audit, isLatestAudit = false) => {
-    const GSI1PK = 'ALL_LATEST_AUDITS';
-    let GSI1SK;
-
-    if (audit.isError()) {
-      GSI1SK = `${audit.getAuditType()}#error`;
-    } else {
-      GSI1SK = `${audit.getAuditType()}#${Object.values(audit.getScores()).join('#')}`;
-    }
-
-    const latestAuditProps = isLatestAudit ? {
-      GSI1PK,
-      GSI1SK,
-      ...(isObject(audit.getPreviousAuditResult())
-          && { previousAuditResult: audit.getPreviousAuditResult() }),
-    } : {};
-
-    return {
-      id: audit.getId(),
-      siteId: audit.getSiteId(),
-      auditedAt: audit.getAuditedAt(),
-      auditResult: audit.getAuditResult(),
-      auditType: audit.getAuditType(),
-      expiresAt: convertDateToEpochSeconds(audit.getExpiresAt()),
-      fullAuditRef: audit.getFullAuditRef(),
-      isLive: audit.isLive(),
-      SK: `${audit.getAuditType()}#${audit.getAuditedAt()}`,
-      ...latestAuditProps,
-    };
-  },
-
-  /**
-   * Converts a DynamoDB item into an Audit object.
-   * @param {object} dynamoItem - DynamoDB item.
-   * @returns {Readonly<Audit>} Audit object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const auditData = {
-      id: dynamoItem.id,
-      siteId: dynamoItem.siteId,
-      auditedAt: dynamoItem.auditedAt,
-      auditResult: dynamoItem.auditResult,
-      auditType: dynamoItem.auditType,
-      expiresAt: parseEpochToDate(dynamoItem.expiresAt),
-      fullAuditRef: dynamoItem.fullAuditRef,
-      isLive: dynamoItem.isLive,
-      ...(isObject(dynamoItem.previousAuditResult)
-          && { previousAuditResult: dynamoItem.previousAuditResult }),
-    };
-
-    return createAudit(auditData);
-  },
-};

package/src/dto/configuration.js

@@ -1,49 +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 { createConfiguration } from '../models/configuration.js';
-
-/**
- * Data transfer object for Configuration.
- */
-export const ConfigurationDto = {
-  /**
-     * Converts a DynamoDB item into a Configuration object.
-     * @param {object } dynamoItem - DynamoDB item.
-     * @returns {Readonly<Configuration>} Configuration object.
-     */
-  fromDynamoItem: (dynamoItem) => {
-    const configurationData = {
-      version: dynamoItem.version,
-      queues: dynamoItem.queues,
-      jobs: dynamoItem.jobs,
-      handlers: dynamoItem.handlers,
-      slackRoles: dynamoItem.slackRoles,
-    };
-
-    return createConfiguration(configurationData);
-  },
-
-  /**
-     * Converts a Configuration object into a DynamoDB item.
-     * @param {Readonly<Configuration>} configuration - Configuration object.
-     * @returns {object} DynamoDB item.
-     */
-  toDynamoItem: (configuration) => ({
-    PK: 'ALL_CONFIGURATIONS',
-    version: configuration.getVersion(),
-    queues: configuration.getQueues(),
-    jobs: configuration.getJobs(),
-    handlers: configuration.getHandlers(),
-    slackRoles: configuration.getSlackRoles(),
-  }),
-};

package/src/dto/dto-utils.js

@@ -1,30 +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.
- */
-
-/**
- * Parse the given Epoch timestamp, in seconds, to a Date object.
- * @param {number} epochInSeconds - The Epoch timestamp in seconds.
- * @returns {Date} A new Date object set to the given timestamp.
- */
-export function parseEpochToDate(epochInSeconds) {
-  const milliseconds = epochInSeconds * 1000;
-  return new Date(milliseconds);
-}
-
-/**
- * Convert the given Date object to an Epoch timestamp, in seconds.
- * @param {Date} date - The Date object to convert.
- * @returns {number} The Epoch timestamp in seconds.
- */
-export function convertDateToEpochSeconds(date) {
-  return Math.floor(date.getTime() / 1000);
-}

package/src/dto/experiment.js

@@ -1,66 +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 { createExperiment } from '../models/experiment.js';
-
-/**
- * Data transfer object for Experiment.
- */
-export const ExperimentDto = {
-  /**
-   * Converts an Experiment object into a DynamoDB item.
-   * @param {Readonly<Experiment>} experiment - Experiment object.
-   * @returns {{siteId, id, name, url, status, type, startDate, endDate,
-   * variants, updatedAt, updatedBy, conversionEventName, conversionEventValue}}
-   */
-  toDynamoItem: (experiment) => ({
-    siteId: experiment.getSiteId(),
-    experimentId: experiment.getExperimentId(),
-    name: experiment.getName(),
-    url: experiment.getUrl(),
-    status: experiment.getStatus(),
-    type: experiment.getType(),
-    startDate: experiment.getStartDate(),
-    endDate: experiment.getEndDate(),
-    variants: experiment.getVariants(),
-    updatedAt: experiment.getUpdatedAt(),
-    updatedBy: experiment.getUpdatedBy(),
-    conversionEventName: experiment.getConversionEventName(),
-    conversionEventValue: experiment.getConversionEventValue(),
-    SK: `${experiment.getExperimentId()}#${experiment.getUrl()}`,
-  }),
-
-  /**
-   * Converts a DynamoDB item into Experiment object;
-   * @param {object } dynamoItem - DynamoDB item.
-   * @returns {Readonly<Experiment>} Experiment object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const experiment = {
-      siteId: dynamoItem.siteId,
-      experimentId: dynamoItem.experimentId,
-      name: dynamoItem.name,
-      url: dynamoItem.url,
-      status: dynamoItem.status,
-      type: dynamoItem.type,
-      startDate: dynamoItem.startDate,
-      endDate: dynamoItem.endDate,
-      variants: dynamoItem.variants,
-      updatedAt: dynamoItem.updatedAt,
-      updatedBy: dynamoItem.updatedBy,
-      conversionEventName: dynamoItem.conversionEventName,
-      conversionEventValue: dynamoItem.conversionEventValue,
-    };
-
-    return createExperiment(experiment);
-  },
-};

package/src/dto/import-job.js

@@ -1,76 +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 { createImportJob } from '../models/importer/import-job.js';
-
-/**
- * The ImportJobDto is a helper that can convert an ImportJob object to a DynamoDB item and
- * vice versa.
- */
-export const ImportJobDto = {
-
-  /**
-   * Converts an ImportJob object into a DynamoDB item.
-   * @param importJob
-   * @returns {{duration: *, baseURL: *, failedCount: *, apiKey: *,
-   *      options: *, successCount: *, importQueueId: *, startTime: *, id: *,
-   *      endTime: *, status: *}}
-   */
-  toDynamoItem: (importJob) => ({
-    id: importJob.getId(),
-    baseURL: importJob.getBaseURL(),
-    hashedApiKey: importJob.getHashedApiKey(),
-    options: importJob.getOptions(),
-    startTime: importJob.getStartTime(),
-    endTime: importJob.getEndTime(),
-    duration: importJob.getDuration(),
-    status: importJob.getStatus(),
-    urlCount: importJob.getUrlCount(),
-    successCount: importJob.getSuccessCount(),
-    failedCount: importJob.getFailedCount(),
-    redirectCount: importJob.getRedirectCount(),
-    importQueueId: importJob.getImportQueueId(),
-    initiatedBy: importJob.getInitiatedBy(),
-    hasCustomHeaders: importJob.hasCustomHeaders(),
-    hasCustomImportJs: importJob.hasCustomImportJs(),
-    GSI1PK: 'ALL_IMPORT_JOBS',
-  }),
-
-  /**
-   * Converts a DynamoDB item into an ImportJob object.
-   * @param {object} dynamoItem - The DynamoDB item to convert.
-   * @returns {ImportJob} - The ImportJob object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const importJobData = {
-      id: dynamoItem.id,
-      baseURL: dynamoItem.baseURL,
-      hashedApiKey: dynamoItem.hashedApiKey,
-      options: dynamoItem.options,
-      startTime: dynamoItem.startTime,
-      endTime: dynamoItem.endTime,
-      duration: dynamoItem.duration,
-      status: dynamoItem.status,
-      urlCount: dynamoItem.urlCount,
-      successCount: dynamoItem.successCount,
-      failedCount: dynamoItem.failedCount,
-      redirectCount: dynamoItem.redirectCount,
-      importQueueId: dynamoItem.importQueueId,
-      initiatedBy: dynamoItem.initiatedBy,
-      hasCustomHeaders: dynamoItem.hasCustomHeaders,
-      hasCustomImportJs: dynamoItem.hasCustomImportJs,
-    };
-
-    return createImportJob(importJobData);
-  },
-
-};

package/src/dto/import-url.js

@@ -1,55 +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 { createImportUrl } from '../models/importer/import-url.js';
-import { convertDateToEpochSeconds, parseEpochToDate } from './dto-utils.js';
-
-/**
- * The ImportUrlDto is a helper that can convert an ImportUrl object to a DynamoDB item and
- * vice versa.
- */
-export const ImportUrlDto = {
-
-  /**
-   * Converts an ImportUrl object to a DynamoDB item.
-   * @returns {object} The new DynamoDB item.
-   */
-  toDynamoItem: (importUrl) => ({
-    id: importUrl.getId(),
-    jobId: importUrl.getJobId(),
-    url: importUrl.getUrl(),
-    status: importUrl.getStatus(),
-    reason: importUrl.getReason(),
-    path: importUrl.getPath(),
-    file: importUrl.getFile(),
-    expiresAt: convertDateToEpochSeconds(importUrl.getExpiresAt()),
-  }),
-
-  /**
-   * Converts a DynamoDB item into an ImportUrl object.
-   * @param {object} dynamoItem - The DynamoDB item to convert.
-   * @returns {ImportUrl} - The ImportUrl object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const importUrlData = {
-      id: dynamoItem.id,
-      jobId: dynamoItem.jobId,
-      url: dynamoItem.url,
-      status: dynamoItem.status,
-      reason: dynamoItem.reason,
-      path: dynamoItem.path,
-      file: dynamoItem.file,
-      expiresAt: parseEpochToDate(dynamoItem.expiresAt),
-    };
-    return createImportUrl(importUrlData);
-  },
-};