@adobe/spacecat-shared-data-access 1.42.0 → 1.43.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.43.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.43.0...@adobe/spacecat-shared-data-access-v1.43.1) (2024-08-22)
+
+
+### Bug Fixes
+
+* add Scoped API Key docs ([#342](https://github.com/adobe/spacecat-shared/issues/342)) ([2fbf707](https://github.com/adobe/spacecat-shared/commit/2fbf707dfeff914dc47ae1f9860629873927e03e))
+
+# [@adobe/spacecat-shared-data-access-v1.43.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.42.0...@adobe/spacecat-shared-data-access-v1.43.0) (2024-08-21)
+
+
+### Features
+
+* add initiatedBy attribute to import job ([#341](https://github.com/adobe/spacecat-shared/issues/341)) ([8a7634c](https://github.com/adobe/spacecat-shared/commit/8a7634c68cf0df01a71abc5d99a17519869f3c45))
+
 # [@adobe/spacecat-shared-data-access-v1.42.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.41.8...@adobe/spacecat-shared-data-access-v1.42.0) (2024-08-20)
 
 

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.42.0",
+  "version": "1.43.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
+  "engines": {
+    "node": "^20.0.0 <21.0.0",
+    "npm": "^10.0.0 <11.0.0"
+  },
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "scripts": {
@@ -40,7 +44,7 @@
   "devDependencies": {
     "chai": "5.1.1",
     "chai-as-promised": "8.0.0",
-    "dynamo-db-local": "8.0.0",
+    "dynamo-db-local": "9.2.0",
     "sinon": "18.0.0",
     "sinon-chai": "4.0.0"
   }

package/src/dto/import-job.js

@@ -38,6 +38,7 @@ export const ImportJobDto = {
     successCount: importJob.getSuccessCount(),
     failedCount: importJob.getFailedCount(),
     importQueueId: importJob.getImportQueueId(),
+    initiatedBy: importJob.getInitiatedBy(),
     GSI1PK: 'ALL_IMPORT_JOBS',
   }),
 
@@ -58,6 +59,7 @@ export const ImportJobDto = {
       successCount: dynamoItem.successCount,
       failedCount: dynamoItem.failedCount,
       importQueueId: dynamoItem.importQueueId,
+      initiatedBy: dynamoItem.initiatedBy,
     };
 
     return createImportJob(importJobData);

package/src/index.d.ts

@@ -510,6 +510,11 @@ export interface ImportJob {
    */
   getImportQueueId: () => string;
 
+  /**
+   * Retrieves the initiatedBy metadata (name, imsOrgId, imsUserId, userAgent) of the import job.
+   */
+  getInitiatedBy: () => object;
+
 }
 
 export interface ImportUrl {

package/src/models/api-key.js

@@ -15,8 +15,18 @@ import {
 } from '@adobe/spacecat-shared-utils';
 import { Base } from './base.js';
 
-const scopeNames = ['sites.read_all', 'sites.write_all', 'organizations.read_all', 'organizations.write_all',
-  'audits.read_all', 'audits.write_all', 'imports.read', 'imports.write', 'imports.read_all'];
+// List of known scope names that can be used with scoped API keys
+const scopeNames = [
+  'sites.read_all',
+  'sites.write_all',
+  'organizations.read_all',
+  'organizations.write_all',
+  'audits.read_all',
+  'audits.write_all',
+  'imports.read',
+  'imports.write',
+  'imports.read_all',
+];
 
 const ApiKey = (data) => {
   const self = Base(data);

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

@@ -41,6 +41,7 @@ const ImportJob = (data) => {
   self.getSuccessCount = () => self.state.successCount;
   self.getFailedCount = () => self.state.failedCount;
   self.getImportQueueId = () => self.state.importQueueId;
+  self.getInitiatedBy = () => self.state.initiatedBy;
 
   /**
      * Updates the end time of the ImportJob.