@adobe/spacecat-shared-data-access 1.25.1 → 1.26.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.26.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.25.1...@adobe/spacecat-shared-data-access-v1.26.0) (2024-06-10)
+
+
+### Features
+
+* Add PENDING status for import URL entities ([#259](https://github.com/adobe/spacecat-shared/issues/259)) ([031194c](https://github.com/adobe/spacecat-shared/commit/031194cb91434ae66bc3870e63e29167ea94de8f)), closes [#258](https://github.com/adobe/spacecat-shared/issues/258)
+
 # [@adobe/spacecat-shared-data-access-v1.25.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.25.0...@adobe/spacecat-shared-data-access-v1.25.1) (2024-06-08)
 
 

package/package.json

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

package/src/index.d.ts

@@ -677,3 +677,13 @@ export function createDataAccess(
   config: DataAccessConfig,
   logger: object,
 ): DataAccess;
+
+export interface ImportJobStatus {
+  RUNNING: string,
+  COMPLETE: string,
+  FAILED: string,
+}
+
+export interface ImportUrlStatus extends ImportJobStatus {
+  PENDING: string,
+}

package/src/index.js

@@ -11,6 +11,8 @@
  */
 
 import { createDataAccess } from './service/index.js';
+import { ImportJobStatus } from './models/importer/import-job.js';
+import { ImportUrlStatus } from './models/importer/import-url.js';
 
 const TABLE_NAME_AUDITS = 'spacecat-services-audits-dev';
 const TABLE_NAME_KEY_EVENTS = 'spacecat-services-key-events';
@@ -95,3 +97,8 @@ export default function dataAccessWrapper(fn) {
     return fn(request, context);
   };
 }
+
+export {
+  ImportJobStatus,
+  ImportUrlStatus,
+};

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

@@ -15,7 +15,7 @@ import {
 } from '@adobe/spacecat-shared-utils';
 import { Base } from '../base.js';
 
-export const IMPORT_JOB_STATUS = {
+export const ImportJobStatus = {
   RUNNING: 'RUNNING',
   COMPLETE: 'COMPLETE',
   FAILED: 'FAILED',
@@ -79,7 +79,7 @@ const ImportJob = (data) => {
      * @returns {ImportJob} The updated ImportJob object.
      */
   self.updateStatus = (status) => {
-    if (!Object.values(IMPORT_JOB_STATUS).includes(status)) {
+    if (!Object.values(ImportJobStatus).includes(status)) {
       throw new Error(`Invalid Import Job status during update: ${status}`);
     }
 
@@ -163,7 +163,7 @@ export const createImportJob = (data) => {
     newState.startTime = new Date().toISOString();
   }
 
-  if (!Object.values(IMPORT_JOB_STATUS).includes(newState.status)) {
+  if (!Object.values(ImportJobStatus).includes(newState.status)) {
     throw new Error(`Invalid Import Job status ${newState.status}`);
   }
 

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

@@ -12,7 +12,12 @@
 
 import { isValidUrl } from '@adobe/spacecat-shared-utils';
 import { Base } from '../base.js';
-import { IMPORT_JOB_STATUS } from './import-job.js';
+import { ImportJobStatus } from './import-job.js';
+
+export const ImportUrlStatus = {
+  PENDING: 'PENDING',
+  ...ImportJobStatus,
+};
 
 /**
  * Creates a new ImportUrl object
@@ -31,7 +36,7 @@ const ImportUrl = (data) => {
      * Updates the status of the ImportUrl
      */
   self.updateStatus = (status) => {
-    if (!Object.values(IMPORT_JOB_STATUS).includes(status)) {
+    if (!Object.values(ImportUrlStatus).includes(status)) {
       throw new Error(`Invalid Import URL status during update: ${status}`);
     }
 
@@ -53,7 +58,7 @@ export const createImportUrl = (data) => {
     throw new Error(`Invalid Url: ${newState.url}`);
   }
 
-  if (!Object.values(IMPORT_JOB_STATUS).includes(newState.status)) {
+  if (!Object.values(ImportUrlStatus).includes(newState.status)) {
     throw new Error(`Invalid Import URL status: ${newState.status}`);
   }