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

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.25.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.24.0...@adobe/spacecat-shared-data-access-v1.25.0) (2024-06-07)
+
+
+### Features
+
+* Add update queries for import-job and import-url entites ([#254](https://github.com/adobe/spacecat-shared/issues/254)) ([d1cba93](https://github.com/adobe/spacecat-shared/commit/d1cba93c2ce1073426dc8333142a8d8fd81017ea))
+
 # [@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)
 
 

package/package.json

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

package/src/index.d.ts

@@ -610,12 +610,18 @@ export interface DataAccess {
   createNewImportJob: (
     importJobData: object,
     ) => Promise<ImportJob>;
+  updateImportJob: (
+    importJob: ImportJob,
+    ) => Promise<ImportJob>;
   getImportUrlByID: (
     id: string,
     ) => Promise<ImportUrl | null>;
   createNewImportUrl: (
     importUrlData: object,
     ) => Promise<ImportUrl>;
+  updateImportUrl: (
+    importUrl: ImportUrl,
+    ) => Promise<ImportUrl>;
 
   // site candidate functions
   getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;

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

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
+import { isObject } from '@adobe/spacecat-shared-utils';
 import { ImportJobDto } from '../../dto/import-job.js';
 import { createImportJob } from '../../models/importer/import-job.js';
 
@@ -63,3 +64,22 @@ export const createNewImportJob = async (dynamoClient, config, log, importJobDat
   await dynamoClient.putItem(config.tableNameImportJobs, ImportJobDto.toDynamoItem(importJob));
   return importJob;
 };
+
+/**
+ * Updates an Import Job
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {ImportJobDto} importJob
+ */
+export const updateImportJob = async (dynamoClient, config, log, importJob) => {
+  const existingImportJob = await getImportJobByID(dynamoClient, config, log, importJob.getId());
+
+  if (!isObject(existingImportJob)) {
+    throw new Error(`Import Job with id: ${importJob.getId()} does not exist`);
+  }
+
+  await dynamoClient.putItem(config.tableNameImportJobs, ImportJobDto.toDynamoItem(importJob));
+
+  return importJob;
+};

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

@@ -14,6 +14,7 @@ import {
   createNewImportJob,
   getImportJobByID,
   getImportJobsByStatus,
+  updateImportJob,
 } from './accessPatterns.js';
 
 export const importJobFunctions = (dynamoClient, config, log) => ({
@@ -35,4 +36,10 @@ export const importJobFunctions = (dynamoClient, config, log) => ({
     log,
     importJobData,
   ),
+  updateImportJob: (importJobData) => updateImportJob(
+    dynamoClient,
+    config,
+    log,
+    importJobData,
+  ),
 });

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

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
+import { isObject } from '@adobe/spacecat-shared-utils';
 import { ImportUrlDto } from '../../dto/import-url.js';
 import { createImportUrl } from '../../models/importer/import-url.js';
 
@@ -45,3 +46,28 @@ export const createNewImportUrl = async (dynamoClient, config, log, importUrlDat
   );
   return importUrl;
 };
+
+/**
+ * Update an existing Import Url
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {Object} importUrl
+ * @returns {ImportUrlDto}
+ */
+export const updateImportUrl = async (dynamoClient, config, log, importUrl) => {
+  const existingImportUrl = await getImportUrlById(
+    dynamoClient,
+    config,
+    log,
+    importUrl.getId(),
+  );
+
+  if (!isObject(existingImportUrl)) {
+    throw new Error(`Import Url with ID:${importUrl.getId()} does not exist`);
+  }
+
+  await dynamoClient.putItem(config.tableNameImportUrls, ImportUrlDto.toDynamoItem(importUrl));
+
+  return importUrl;
+};

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

@@ -10,7 +10,11 @@
  * governing permissions and limitations under the License.
  */
 
-import { getImportUrlById, createNewImportUrl } from './accessPatterns.js';
+import {
+  getImportUrlById,
+  createNewImportUrl,
+  updateImportUrl,
+} from './accessPatterns.js';
 
 export const importUrlFunctions = (dynamoClient, config, log) => ({
   getImportUrlById: (id) => getImportUrlById(
@@ -25,4 +29,10 @@ export const importUrlFunctions = (dynamoClient, config, log) => ({
     log,
     importUrlData,
   ),
+  updateImportUrl: (importUrl) => updateImportUrl(
+    dynamoClient,
+    config,
+    log,
+    importUrl,
+  ),
 });