@adobe/spacecat-shared-data-access 1.23.6 → 1.24.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.24.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.23.6...@adobe/spacecat-shared-data-access-v1.24.0) (2024-06-06)
+
+
+### Features
+
+* Add import-job.js and import-url.js to the data model layer ([#250](https://github.com/adobe/spacecat-shared/issues/250)) ([447a95e](https://github.com/adobe/spacecat-shared/commit/447a95e0c4fbb6afa630d9ba78c699974b9f5d5c))
+
 # [@adobe/spacecat-shared-data-access-v1.23.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.23.5...@adobe/spacecat-shared-data-access-v1.23.6) (2024-06-01)
 
 

package/package.json

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

package/src/dto/import-job.js

@@ -0,0 +1,63 @@
+/*
+ * 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';
+
+/**
+ * Data Transfer Object for ImportJob
+ */
+
+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(),
+    apiKey: importJob.getApiKey(),
+    options: importJob.getOptions(),
+    startTime: importJob.getStartTime(),
+    endTime: importJob.getEndTime(),
+    duration: importJob.getDuration(),
+    status: importJob.getStatus(),
+    successCount: importJob.getSuccessCount(),
+    failedCount: importJob.getFailedCount(),
+    importQueueId: importJob.getImportQueueId(),
+    GSI1PK: 'ALL_IMPORT_JOBS',
+  }),
+
+  /**
+     * Converts a DynamoDB item into an ImportJob object.
+     */
+  fromDynamoItem: (dynamoItem) => {
+    const importJobData = {
+      id: dynamoItem.id,
+      baseURL: dynamoItem.baseURL,
+      apiKey: dynamoItem.apiKey,
+      options: dynamoItem.options,
+      startTime: dynamoItem.startTime,
+      endTime: dynamoItem.endTime,
+      duration: dynamoItem.duration,
+      status: dynamoItem.status,
+      successCount: dynamoItem.successCount,
+      failedCount: dynamoItem.failedCount,
+      importQueueId: dynamoItem.importQueueId,
+    };
+
+    return createImportJob(importJobData);
+  },
+};

package/src/dto/import-url.js

@@ -0,0 +1,43 @@
+/*
+ * 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';
+
+/**
+ * Data Transfer Object for ImportUrl
+ */
+
+export const ImportUrlDto = {
+
+  /**
+     * Converts an importUrl object to a DynamoDB item
+     */
+  toDynamoItem: (importUrl) => ({
+    id: importUrl.getId(),
+    jobId: importUrl.getJobId(),
+    url: importUrl.getUrl(),
+    status: importUrl.getStatus(),
+  }),
+
+  /**
+     * Converts a DynamoDB item into an ImportUrl object
+     */
+  fromDynamoItem: (dynamoItem) => {
+    const importUrlData = {
+      id: dynamoItem.id,
+      jobId: dynamoItem.jobId,
+      url: dynamoItem.url,
+      status: dynamoItem.status,
+    };
+    return createImportUrl(importUrlData);
+  },
+};

package/src/index.d.ts

@@ -431,6 +431,87 @@ export interface Configuration {
 
 }
 
+export interface ImportJob {
+  /**
+   * Retrieves the ID of the import job.
+   */
+  getId: () => string;
+
+  /**
+   * Retrieves the apiKey of the import job.
+   */
+  getApiKey: () => string;
+
+  /**
+   * Retrieves the status of the import job.
+   */
+  getStatus: () => string;
+
+  /**
+   * Retrieves the baseURL of the import job.
+   */
+  getBaseURL: () => string;
+
+  /**
+   * Retrieves the options of the import job.
+   */
+  getOptions: () => object;
+
+  /**
+   * Retrieves the startTime of the import job.
+   */
+  getStartTime: () => string;
+
+  /**
+   * Retrieves the endTime of the import job.
+   */
+  getEndTime: () => string;
+
+  /**
+   * Retrieves the duration of the import job.
+   */
+  getDuration: () => number;
+
+  /**
+   * Retrieves the success count of the import job.
+   */
+  getSuccessCount: () => number;
+
+  /**
+   * Retrieves the failure count of the import job.
+   */
+  getFailureCount: () => number;
+
+  /**
+   * Retrieves the importQueueId of the import job.
+   */
+  getImportQueueId: () => string;
+
+}
+
+export interface ImportUrl {
+  /**
+   * Retrieves the ID of the import URL.
+   */
+    getId: () => string;
+
+  /**
+   * Retrieves the status of the import URL.
+   */
+    getStatus: () => string;
+
+  /**
+   * Retrieves the URL of the import URL.
+   */
+    getUrl: () => string;
+
+  /**
+   * Retrieves the job ID of the import URL.
+   */
+    getJobId: () => string;
+
+}
+
 export interface DataAccess {
   getAuditForSite: (
     sitedId: string,
@@ -520,6 +601,21 @@ export interface DataAccess {
   removeOrganization: (
       organizationId: string,
   ) => Promise<void>;
+  getImportJobByID: (
+    id: string,
+    ) => Promise<ImportJob | null>;
+  getImportJobsByStatus: (
+    status: string,
+    ) => Promise<ImportJob[]>;
+  createNewImportJob: (
+    importJobData: object,
+    ) => Promise<ImportJob>;
+  getImportUrlByID: (
+    id: string,
+    ) => Promise<ImportUrl | null>;
+  createNewImportUrl: (
+    importUrlData: object,
+    ) => Promise<ImportUrl>;
 
   // site candidate functions
   getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;
@@ -554,6 +650,8 @@ interface DataAccessConfig {
   tableNameSiteCandidates: string;
   tableNameConfigurations: string;
   tableNameSiteTopPages: string;
+  tableNameImportJobs: string;
+  tableNameImportUrls: string;
   indexNameAllKeyEventsBySiteId: string,
   indexNameAllSites: string;
   indexNameAllSitesOrganizations: string,
@@ -561,10 +659,12 @@ interface DataAccessConfig {
   indexNameAllLatestAuditScores: string;
   indexNameAllOrganizations: string,
   indexNameAllOrganizationsByImsOrgId: string,
+  indexNameAllImportJobsByStatus: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;
   pkAllConfigurations: string;
+  pkAllImportJobs: string;
 }
 
 export function createDataAccess(

package/src/index.js

@@ -20,6 +20,8 @@ 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 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';
@@ -28,11 +30,13 @@ const INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = 'spacecat-services-all-organi
 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 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) => {
@@ -48,6 +52,8 @@ export default function dataAccessWrapper(fn) {
         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_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,
@@ -56,6 +62,7 @@ export default function dataAccessWrapper(fn) {
         // 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,
       } = context.env;
 
       context.dataAccess = createDataAccess({
@@ -67,6 +74,8 @@ export default function dataAccessWrapper(fn) {
         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,
         indexNameAllKeyEventsBySiteId: DYNAMO_INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID,
         indexNameAllSites: DYNAMO_INDEX_NAME_ALL_SITES,
         indexNameAllOrganizations: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS,
@@ -74,10 +83,12 @@ export default function dataAccessWrapper(fn) {
         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,
         pkAllSites: PK_ALL_SITES,
         pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,
         pkAllConfigurations: PK_ALL_CONFIGURATIONS,
+        pkAllImportJobs: PK_ALL_IMPORT_JOBS,
       }, log);
     }
 

package/src/models/importer/import-job.js

@@ -0,0 +1,175 @@
+/*
+ * 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, isIsoDate, isValidUrl, isObject, isString, isNumber,
+} from '@adobe/spacecat-shared-utils';
+import { Base } from '../base.js';
+
+export const IMPORT_JOB_STATUS = {
+  RUNNING: 'RUNNING',
+  COMPLETE: 'COMPLETE',
+  FAILED: 'FAILED',
+};
+
+/**
+ * Creates a new ImportJob object.
+ *
+ * @param {Object} importJobData - The data for the ImportJob object.
+ * @returns {ImportJob} The new ImportJob object.
+ */
+const ImportJob = (data) => {
+  const self = Base(data);
+
+  self.getBaseURL = () => self.state.baseURL;
+  self.getApiKey = () => self.state.apiKey;
+  self.getOptions = () => self.state.options;
+  self.getStartTime = () => self.state.startTime;
+  self.getEndTime = () => self.state.endTime;
+  self.getDuration = () => self.state.duration;
+  self.getStatus = () => self.state.status;
+  self.getSuccessCount = () => self.state.successCount;
+  self.getFailedCount = () => self.state.failedCount;
+  self.getImportQueueId = () => self.state.importQueueId;
+
+  /**
+     * Updates the end time of the ImportJob.
+     * @param {string} endTime - The new end time.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateEndTime = (endTime) => {
+    if (!isIsoDate(endTime)) {
+      throw new Error(`Invalid end time during update: ${endTime}`);
+    }
+
+    self.state.endTime = endTime;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+     * Updates the duration of the ImportJob.
+     * @param {number} duration - The new duration.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateDuration = (duration) => {
+    if (!isNumber(duration)) {
+      throw new Error(`Invalid duration during update: ${duration}`);
+    }
+
+    self.state.duration = duration;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+     * Updates the status of the ImportJob.
+     * @param {string} status - The new status.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateStatus = (status) => {
+    if (!Object.values(IMPORT_JOB_STATUS).includes(status)) {
+      throw new Error(`Invalid Import Job status during update: ${status}`);
+    }
+
+    self.state.status = status;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+     * Updates the success count of the ImportJob.
+     * @param {number} successCount - The new success count.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateSuccessCount = (successCount) => {
+    if (!isNumber(successCount)) {
+      throw new Error(`Invalid success count during update: ${successCount}`);
+    }
+
+    self.state.successCount = successCount;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+     * Updates the failed count of the ImportJob.
+     * @param {number} failedCount - The new failed count.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateFailedCount = (failedCount) => {
+    if (!isNumber(failedCount)) {
+      throw new Error(`Invalid failed count during update: ${failedCount}`);
+    }
+
+    self.state.failedCount = failedCount;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+     * Updates the import queue id of the ImportJob.
+     * @param {string} importQueueId - The new import queue id.
+     * @returns {ImportJob} The updated ImportJob object.
+     */
+  self.updateImportQueueId = (importQueueId) => {
+    if (!hasText(importQueueId)) {
+      throw new Error(`Invalid import queue id during update: ${importQueueId}`);
+    }
+
+    self.state.importQueueId = importQueueId;
+    self.touch();
+
+    return self;
+  };
+  return Object.freeze(self);
+};
+
+/**
+ * Creates a new ImportJob object.
+ * @param {Object} importJobData - The data for the ImportJob object.
+ * @returns {ImportJob} The new ImportJob object.
+ */
+export const createImportJob = (data) => {
+  const newState = { ...data };
+
+  if (!isValidUrl(newState.baseURL)) {
+    throw new Error(`Invalid base URL: ${newState.baseURL}`);
+  }
+
+  if (!isString(newState.apiKey)) {
+    throw new Error(`Invalid API key: ${newState.apiKey}`);
+  }
+
+  if (hasText(newState.startTime) && !isIsoDate(newState.startTime)) {
+    throw new Error('"StartTime" should be a valid ISO string');
+  }
+
+  if (!hasText(newState.startTime)) {
+    newState.startTime = new Date().toISOString();
+  }
+
+  if (!Object.values(IMPORT_JOB_STATUS).includes(newState.status)) {
+    throw new Error(`Invalid Import Job status ${newState.status}`);
+  }
+
+  if (!isObject(newState.options)) {
+    throw new Error(`Invalid options: ${newState.options}`);
+  }
+
+  return ImportJob(newState);
+};

package/src/models/importer/import-url.js

@@ -0,0 +1,61 @@
+/*
+ * 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 { isValidUrl } from '@adobe/spacecat-shared-utils';
+import { Base } from '../base.js';
+import { IMPORT_JOB_STATUS } from './import-job.js';
+
+/**
+ * Creates a new ImportUrl object
+ *
+ * @param {Object} importUrlData
+ * @returns {ImportUrl}
+ */
+const ImportUrl = (data) => {
+  const self = Base(data);
+
+  self.getJobId = () => self.state.jobId;
+  self.getUrl = () => self.state.url;
+  self.getStatus = () => self.state.status;
+
+  /**
+     * Updates the status of the ImportUrl
+     */
+  self.updateStatus = (status) => {
+    if (!Object.values(IMPORT_JOB_STATUS).includes(status)) {
+      throw new Error(`Invalid Import URL status during update: ${status}`);
+    }
+
+    self.state.status = status;
+    self.touch();
+
+    return self;
+  };
+  return Object.freeze(self);
+};
+
+/**
+ * Creates a new ImportUrl object
+ */
+export const createImportUrl = (data) => {
+  const newState = { ...data };
+
+  if (!isValidUrl(newState.url)) {
+    throw new Error(`Invalid Url: ${newState.url}`);
+  }
+
+  if (!Object.values(IMPORT_JOB_STATUS).includes(newState.status)) {
+    throw new Error(`Invalid Import URL status: ${newState.status}`);
+  }
+
+  return ImportUrl(newState);
+};

package/src/service/import-job/accessPatterns.js

@@ -0,0 +1,65 @@
+/*
+ * 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 { ImportJobDto } from '../../dto/import-job.js';
+import { createImportJob } from '../../models/importer/import-job.js';
+
+/**
+ * Get Import Job by ID
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {string} id
+ * @returns {Promise<ImportJobDto> | null}
+ */
+export const getImportJobByID = async (dynamoClient, config, log, id) => {
+  const item = await dynamoClient.getItem(
+    config.tableNameImportJobs,
+    { id },
+  );
+  return item ? ImportJobDto.fromDynamoItem(item) : null;
+};
+
+/**
+ * Get Import jobs by status
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {string} status
+ * @returns {Promise<ImportJobDto[]>}
+ */
+export const getImportJobsByStatus = async (dynamoClient, config, log, status) => {
+  const items = await dynamoClient.query({
+    TableName: config.tableNameImportJobs,
+    IndexName: config.indexNameAllImportJobsByStatus,
+    KeyConditionExpression: 'GSI1PK = :gsi1pk AND status = :status',
+    ExpressionAttributeValues: {
+      ':gsi1pk': config.pkAllImportJobs,
+      ':status': status,
+    },
+  });
+  return items.map((item) => ImportJobDto.fromDynamoItem(item));
+};
+
+/**
+ * Creates a new Import Job
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {Object} importJobData
+ * @returns {Promise<ImportJobDto>}
+ */
+export const createNewImportJob = async (dynamoClient, config, log, importJobData) => {
+  const importJob = createImportJob(importJobData);
+  await dynamoClient.putItem(config.tableNameImportJobs, ImportJobDto.toDynamoItem(importJob));
+  return importJob;
+};

package/src/service/import-job/index.js

@@ -0,0 +1,38 @@
+/*
+ * 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 {
+  createNewImportJob,
+  getImportJobByID,
+  getImportJobsByStatus,
+} from './accessPatterns.js';
+
+export const importJobFunctions = (dynamoClient, config, log) => ({
+  getImportJobByID: (id) => getImportJobByID(
+    dynamoClient,
+    config,
+    log,
+    id,
+  ),
+  getImportJobsByStatus: (status) => getImportJobsByStatus(
+    dynamoClient,
+    config,
+    log,
+    status,
+  ),
+  createNewImportJob: (importJobData) => createNewImportJob(
+    dynamoClient,
+    config,
+    log,
+    importJobData,
+  ),
+});

package/src/service/import-url/accessPatterns.js

@@ -0,0 +1,47 @@
+/*
+ * 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 { ImportUrlDto } from '../../dto/import-url.js';
+import { createImportUrl } from '../../models/importer/import-url.js';
+
+/**
+ * Get import url by ID
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {string} id
+ * @returns {Promise<ImportUrlDto> | null}
+ */
+export const getImportUrlById = async (dynamoClient, config, log, id) => {
+  const item = await dynamoClient.getItem(
+    config.tableNameImportUrls,
+    { id },
+  );
+  return item ? ImportUrlDto.fromDynamoItem(item) : null;
+};
+
+/**
+ * Create a new Import Url
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {Object} importUrlData
+ * @returns {Promise<ImportUrlDto>}
+ */
+export const createNewImportUrl = async (dynamoClient, config, log, importUrlData) => {
+  const importUrl = createImportUrl(importUrlData);
+  await dynamoClient.putItem(
+    config.tableNameImportUrls,
+    ImportUrlDto.toDynamoItem(importUrl),
+  );
+  return importUrl;
+};

package/src/service/import-url/index.js

@@ -0,0 +1,28 @@
+/*
+ * 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 { getImportUrlById, createNewImportUrl } from './accessPatterns.js';
+
+export const importUrlFunctions = (dynamoClient, config, log) => ({
+  getImportUrlById: (id) => getImportUrlById(
+    dynamoClient,
+    config,
+    log,
+    id,
+  ),
+  createNewImportUrl: (importUrlData) => createNewImportUrl(
+    dynamoClient,
+    config,
+    log,
+    importUrlData,
+  ),
+});

package/src/service/index.js

@@ -18,6 +18,8 @@ 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';
 
 /**
  * Creates a data access object.
@@ -25,6 +27,7 @@ import { siteTopPagesFunctions } from './site-top-pages/index.js';
  * @param {{pkAllSites: string, pkAllLatestAudits: string, indexNameAllLatestAuditScores: string,
  * tableNameAudits: string,tableNameLatestAudits: string, indexNameAllSitesOrganizations: string,
  * tableNameSites: string, tableNameOrganizations: string, indexNameAllSites: string,
+ * tableNameImportJobs: string, pkAllImportJobs: string, indexNameAllImportJobs: string,
  * tableNameSiteTopPages: string, indexNameAllOrganizations: string,
  * indexNameAllOrganizationsByImsOrgId: string, pkAllOrganizations: string}} config configuration
  * @param {Logger} log logger
@@ -40,6 +43,8 @@ export const createDataAccess = (config, log = console) => {
   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);
 
   return {
     ...auditFuncs,
@@ -49,5 +54,7 @@ export const createDataAccess = (config, log = console) => {
     ...organizationFuncs,
     ...configurationFuncs,
     ...siteTopPagesFuncs,
+    ...importJobFuncs,
+    ...importUrlFuncs,
   };
 };